bsd/nfs/nfs_lock.h

   1 /*-
   2  * Copyright (c) 1998 Berkeley Software Design, Inc. All rights reserved.
   3  * Redistribution and use in source and binary forms, with or without
   4  * modification, are permitted provided that the following conditions
   5  * are met:
   6  * 1. Redistributions of source code must retain the above copyright
   7  *    notice, this list of conditions and the following disclaimer.
   8  * 2. Redistributions in binary form must reproduce the above copyright
   9  *    notice, this list of conditions and the following disclaimer in the
  10  *    documentation and/or other materials provided with the distribution.
  11  * 3. Berkeley Software Design Inc's name may not be used to endorse or
  12  *    promote products derived from this software without specific prior
  13  *    written permission.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY BERKELEY SOFTWARE DESIGN INC ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL BERKELEY SOFTWARE DESIGN INC BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  *      from nfs_lock.h,v 2.2 1998/04/28 19:38:41 don Exp
  28  * $FreeBSD$
  29  */
  30
  31 #include <sys/appleapiopts.h>
  32
  33 #ifdef __APPLE_API_PRIVATE
  34
  35 /*
  36  * lockd uses the nfsclnt system call for the unique kernel services it needs.
  37  * It passes in a request structure with a version number at the start.
  38  * This prevents libc from needing to change if the information passed
  39  * between lockd and the kernel needs to change.
  40  *
  41  * If a structure changes, you must bump the version number.
  42  */
  43
  44 #include <nfs/nfsproto.h>
  45
  46 /*
  47  * The fifo where the kernel writes requests for locks on remote NFS files,
  48  * and where lockd reads these requests.  Note this is no longer hardwired
  49  * in the kernel binary - lockd passes the file descriptor down via nfsclnt()
  50  */
  51 #define _PATH_LCKFIFO   "/var/run/nfslockd"
  52
  53 /*
  54  * The structure that the kernel hands lockd for each lock request.
  55  */
  56 #define LOCKD_MSG_VERSION       3
  57 typedef struct nfs_lock_msg {
  58         int                     lm_version;             /* LOCKD_MSG version */
  59         int                     lm_flags;               /* request flags */
  60         u_int64_t               lm_xid;                 /* unique message transaction ID */
  61         struct flock            lm_fl;                  /* The lock request. */
  62         struct sockaddr_storage lm_addr;                /* The address. */
  63         size_t                  lm_fh_len;              /* The file handle length. */
  64         struct xucred           lm_cred;                /* user cred for lock req */
  65         u_int8_t                lm_fh[NFS_SMALLFH];     /* The file handle. */
  66 } LOCKD_MSG;
  67
  68 /* lm_flags */
  69 #define LOCKD_MSG_BLOCK         0x0001  /* a blocking request */
  70 #define LOCKD_MSG_TEST          0x0002  /* just a lock test */
  71 #define LOCKD_MSG_NFSV3         0x0004  /* NFSv3 request */
  72 #define LOCKD_MSG_CANCEL        0x0008  /* cancelling blocked request */
  73
  74 /* The structure used to maintain the pending request queue */
  75 typedef struct nfs_lock_msg_request {
  76         TAILQ_ENTRY(nfs_lock_msg_request) lmr_next;     /* in-kernel pending request list */
  77         int                     lmr_answered;           /* received an answer? */
  78         int                     lmr_errno;              /* return status */
  79         int                     lmr_saved_errno;        /* original return status */
  80         LOCKD_MSG               lmr_msg;                /* the message */
  81 } LOCKD_MSG_REQUEST;
  82
  83 TAILQ_HEAD(nfs_lock_msg_queue, nfs_lock_msg_request);
  84 typedef struct nfs_lock_msg_queue LOCKD_MSG_QUEUE;
  85
  86
  87 /*
  88  * The structure that lockd hands the kernel for each lock answer.
  89  */
  90 #define LOCKD_ANS_VERSION       2
  91 struct lockd_ans {
  92         int             la_version;             /* lockd_ans version */
  93         int             la_errno;               /* return status */
  94         u_int64_t       la_xid;                 /* unique message transaction ID */
  95         int             la_flags;               /* answer flags */
  96         pid_t           la_pid;                 /* pid of lock requester/owner */
  97         off_t           la_start;               /* lock starting offset */
  98         off_t           la_len;                 /* lock length */
  99         size_t          la_fh_len;              /* The file handle length. */
 100         u_int8_t        la_fh[NFS_SMALLFH];     /* The file handle. */
 101 };
 102
 103 /* la_flags */
 104 #define LOCKD_ANS_GRANTED       0x0001  /* NLM_GRANTED request */
 105 #define LOCKD_ANS_LOCK_INFO     0x0002  /* lock info valid */
 106 #define LOCKD_ANS_LOCK_EXCL     0x0004  /* lock is exclusive */
 107
 108
 109 #ifdef KERNEL
 110 void    nfs_lockinit(void);
 111 int     nfs_dolock(struct vop_advlock_args *ap);
 112 int     nfslockdans(struct proc *p, struct lockd_ans *ansp);
 113 int     nfslockdfd(struct proc *p, int fd);
 114 int     nfslockdwait(struct proc *p);
 115 #endif
 116 #endif /* __APPLE_API_PRIVATE */