1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License, Version 1.0 only 6 * (the "License"). You may not use this file except in compliance 7 * with the License. 8 * 9 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10 * or http://www.opensolaris.org/os/licensing. 11 * See the License for the specific language governing permissions 12 * and limitations under the License. 13 * 14 * When distributing Covered Code, include this CDDL HEADER in each 15 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16 * If applicable, add the following below this CDDL HEADER, with the 17 * fields enclosed by brackets "[]" replaced with your own identifying 18 * information: Portions Copyright [yyyy] [name of copyright owner] 19 * 20 * CDDL HEADER END 21 */ 22 /* 23 * Copyright 2005 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 /* 28 * Copyright 2011 Nexenta Systems, Inc. All rights reserved. 29 */ 30 31 #ifndef _NFS_LM_H 32 #define _NFS_LM_H 33 34 /* 35 * Interface definitions for the NFSv2/v3 lock manager. 36 */ 37 38 #ifdef __cplusplus 39 extern "C" { 40 #endif 41 42 #include <sys/cred.h> 43 #include <sys/fcntl.h> 44 #include <sys/types.h> 45 #include <sys/vnode.h> 46 #include <rpc/rpc.h> 47 48 #ifdef _KERNEL 49 50 /* 51 * Common interfaces. 52 */ 53 54 struct exportinfo; 55 56 /* 57 * The numeric sysid is used to identify a host and transport. 58 * 59 * The local locking code uses (pid, sysid) to uniquely identify a process. 60 * This means that the client-side code must doctor up the sysid before 61 * registering a lock, so that the local locking code doesn't confuse a 62 * remote process with a local process just because they have the same pid. 63 * We currently do this by ORing LM_SYSID_CLIENT into the sysid before 64 * registering a lock. 65 * 66 * If you change LM_SYSID and LM_SYSID_MAX, be sure to pick values so that 67 * LM_SYSID_MAX > LM_SYSID using signed arithmetic, and don't use zero. 68 * You may also need a different way to tag lock manager locks that are 69 * registered locally. 70 */ 71 #define LM_SYSID ((sysid_t)0x0001) 72 #define LM_SYSID_MAX ((sysid_t)0x3FFF) 73 #define LM_SYSID_CLIENT ((sysid_t)0x4000) 74 #define LM_NOSYSID ((sysid_t)-1) 75 76 /* 77 * Struct used to represent a host. 78 */ 79 struct lm_sysid; 80 81 /* 82 * Given a knetconfig and network address, returns a reference to the 83 * associated lm_sysid. The 3rd argument is the hostname to assign to the 84 * lm_sysid. The 4th argument is an output parameter. It is set non-zero 85 * if the returned lm_sysid has a different protocol 86 * (knetconfig::knc_proto) than what was requested. 87 */ 88 extern struct lm_sysid *lm_get_sysid(struct knetconfig *, struct netbuf *, 89 char *, bool_t *); 90 extern void lm_rel_sysid(struct lm_sysid *); 91 92 /* 93 * Return the integer sysid for the given lm_sysid. 94 */ 95 extern sysid_t lm_sysidt(struct lm_sysid *); 96 97 extern void lm_free_config(struct knetconfig *); 98 99 extern void lm_cprsuspend(void); 100 extern void lm_cprresume(void); 101 102 /* 103 * Client-side interfaces. 104 */ 105 106 extern int lm_frlock(struct vnode *vp, int cmd, 107 struct flock64 *flk, int flag, 108 u_offset_t offset, struct cred *cr, 109 netobj *fh, struct flk_callback *); 110 extern int lm_has_sleep(const struct vnode *); 111 extern void lm_register_lock_locally(vnode_t *, 112 struct lm_sysid *, struct flock64 *, int, 113 u_offset_t); 114 extern int lm_safelock(vnode_t *, const struct flock64 *, 115 cred_t *); 116 extern int lm_safemap(const vnode_t *); 117 extern int lm_shrlock(struct vnode *vp, int cmd, 118 struct shrlock *shr, int flag, netobj *fh); 119 extern int lm4_frlock(struct vnode *vp, int cmd, 120 struct flock64 *flk, int flag, 121 u_offset_t offset, struct cred *cr, 122 netobj *fh, struct flk_callback *); 123 extern int lm4_shrlock(struct vnode *vp, int cmd, 124 struct shrlock *shr, int flag, netobj *fh); 125 126 /* 127 * Server-side interfaces. 128 */ 129 130 extern void lm_unexport(struct exportinfo *); 131 132 /* 133 * Clustering: functions to encode the nlmid of the node where this NLM 134 * server is running in the l_sysid of the flock struct or the s_sysid 135 * field of the shrlock struct (respectively). 136 */ 137 extern void lm_set_nlmid_flk(int *); 138 extern void lm_set_nlmid_shr(int32_t *); 139 /* Hook for deleting all mandatory NFSv4 file locks held by a remote client */ 140 extern void (*lm_remove_file_locks)(int); 141 142 /* 143 * The following global variable is the node id of the node where this 144 * NLM server is running. 145 */ 146 extern int lm_global_nlmid; 147 148 /* 149 * End of clustering hooks. 150 */ 151 152 /* 153 * Return non-zero if the given local vnode is in use. 154 */ 155 extern int lm_vp_active(const struct vnode *); 156 157 extern sysid_t lm_alloc_sysidt(void); 158 extern void lm_free_sysidt(sysid_t); 159 160 #endif /* _KERNEL */ 161 162 #ifdef __STDC__ 163 extern int lm_shutdown(void); 164 #else 165 extern int lm_shutdown(); 166 #endif /* __STDC__ */ 167 168 #ifdef __cplusplus 169 } 170 #endif 171 172 #endif /* _NFS_LM_H */ 173