usr/src/uts/common/nfs/lm.h

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