]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/sys/lockf.h
xnu-7195.50.7.100.1.tar.gz
[apple/xnu.git] / bsd / sys / lockf.h
index 0c3339c7805b3592b6948f92c74d3d149176cd33..574ef7a706ddcecd7e037736cad775956322f7c6 100644 (file)
@@ -1,25 +1,30 @@
 /*
- * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2004-2018 Apple Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
- * 
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
- * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
+ *
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
+ *
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
- * 
- * @APPLE_LICENSE_HEADER_END@
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
-/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
 /*
  * Copyright (c) 1991, 1993
  *     The Regents of the University of California.  All rights reserved.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
  *    documentation and/or other materials provided with the distribution.
- * 3. All advertising materials mentioning features or use of this software
- *    must display the following acknowledgement:
- *     This product includes software developed by the University of
- *     California, Berkeley and its contributors.
  * 4. Neither the name of the University nor the names of its contributors
  *    may be used to endorse or promote products derived from this software
  *    without specific prior written permission.
  * SUCH DAMAGE.
  *
  *     @(#)lockf.h     8.1 (Berkeley) 6/11/93
+ * $FreeBSD: src/sys/sys/lockf.h,v 1.16 2004/04/07 04:19:49 imp Exp $
  */
 
 #ifndef _SYS_LOCKF_H_
-#define        _SYS_LOCKF_H_
+#define _SYS_LOCKF_H_
+
+#include <sys/queue.h>
+#include <sys/cdefs.h>
+
+struct vnop_advlock_args;
+struct vnode;
+
+#ifdef MALLOC_DECLARE
+MALLOC_DECLARE(M_LOCKF);
+#endif
 
-#include <sys/appleapiopts.h>
+#if IMPORTANCE_INHERITANCE
+#define LF_NOT_BOOSTED  0
+#define LF_BOOSTED      1
+#endif /* IMPORTANCE_INHERITANCE */
 
-#ifdef __APPLE_API_PRIVATE
 /*
  * The lockf structure is a kernel structure which contains the information
  * associated with a byte range lock.  The lockf structures are linked into
- * the inode structure. Locks are sorted by the starting byte of the lock for
- * efficiency.
+ * the vnode structure.  Locks are sorted by the starting byte of the lock for
+ * efficiency after they have been committed; uncommitted locks are on the list
+ * head so they may quickly be accessed, and are both short lived and transient.
  */
+TAILQ_HEAD(locklist, lockf);
+
 struct lockf {
-       short   lf_flags;        /* Lock semantics: F_POSIX, F_FLOCK, F_WAIT */
-       short   lf_type;         /* Lock type: F_RDLCK, F_WRLCK */
-       off_t   lf_start;        /* The byte # of the start of the lock */
-       off_t   lf_end;          /* The byte # of the end of the lock (-1=EOF)*/
-       caddr_t lf_id;           /* The id of the resource holding the lock */
-       struct  lockf **lf_head; /* Back pointer to the head of lockf list */
-       struct  lockf *lf_next;  /* A pointer to the next lock on this inode */
-       struct  lockf *lf_block; /* The list of blocked locks */
+       short   lf_flags;           /* Semantics: F_POSIX, F_FLOCK, F_WAIT */
+       short   lf_type;            /* Lock type: F_RDLCK, F_WRLCK */
+#if IMPORTANCE_INHERITANCE
+       int     lf_boosted;         /* Is the owner of the lock boosted */
+#endif
+       off_t   lf_start;           /* Byte # of the start of the lock */
+       off_t   lf_end;             /* Byte # of the end of the lock (-1=EOF) */
+       caddr_t lf_id;              /* Id of the resource holding the lock */
+       struct  lockf **lf_head;    /* Back pointer to the head of the locf list */
+       struct  vnode *lf_vnode;    /* Back pointer to the inode */
+       struct  lockf *lf_next;     /* Pointer to the next lock on this inode */
+       struct  locklist lf_blkhd;  /* List of requests blocked on this lock */
+       TAILQ_ENTRY(lockf) lf_block;/* A request waiting for a lock */
+       struct  proc *lf_owner;     /* The proc that did the SETLK, if known */
 };
 
-/* Maximum length of sleep chains to traverse to try and detect deadlock. */
-#define MAXDEPTH 50
-
 __BEGIN_DECLS
-void    lf_addblock __P((struct lockf *, struct lockf *));
-int     lf_advlock __P((struct lockf **,
-           off_t, caddr_t, int, struct flock *, int));
-int     lf_clearlock __P((struct lockf *));
-int     lf_findoverlap __P((struct lockf *,
-           struct lockf *, int, struct lockf ***, struct lockf **));
-struct lockf *
-        lf_getblock __P((struct lockf *));
-int     lf_getlock __P((struct lockf *, struct flock *));
-int     lf_setlock __P((struct lockf *));
-void    lf_split __P((struct lockf *, struct lockf *));
-void    lf_wakelock __P((struct lockf *));
-__END_DECLS
 
-#if LOCKF_DEBUG
-extern int lockf_debug;
+#ifdef KERNEL_PRIVATE
+void    lf_init(void);
+int     lf_advlock(struct vnop_advlock_args *);
+int     lf_assert(struct vnop_advlock_args *, void **);
+void    lf_commit(void *, int);
+void    lf_abort_advlocks(vnode_t);
 
-__BEGIN_DECLS
-void   lf_print __P((char *, struct lockf *));
-void   lf_printlist __P((char *, struct lockf *));
-__END_DECLS
-#endif /* LOCKF_DEBUG */
+#ifdef LOCKF_DEBUG
+void    lf_print(char *, struct lockf *);
+void    lf_printlist(char *, struct lockf *);
+#endif
+#endif /* KERNEL_PRIVATE */
 
-#endif /* __APPLE_API_PRIVATE */
+__END_DECLS
 
 #endif /* !_SYS_LOCKF_H_ */