bsd/nfs/nfs_lock.h

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