xnu-6153.141.1.tar.gz

[apple/xnu.git] / bsd / sys / lockf.h

diff --git a/bsd/sys/lockf.h b/bsd/sys/lockf.h
index 23d50a18532c4175e083b1ccc15ab0356755f6dc..574ef7a706ddcecd7e037736cad775956322f7c6 100644 (file)
--- a/bsd/sys/lockf.h
+++ b/bsd/sys/lockf.h
@@ -1,15 +1,20 @@
 /*
- * Copyright (c) 2004-2005 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2004-2018 Apple Inc. All rights reserved.
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  *
- * @APPLE_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. Please obtain a copy of the License at
- * http://www.opensource.apple.com/apsl/ and read it before using this
- * file.
- * 
+ * 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,
@@ -17,8 +22,8 @@
  * 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_LICENSE_HEADER_END@
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /*
  * Copyright (c) 1991, 1993
@@ -56,7 +61,7 @@
  */
 
 #ifndef _SYS_LOCKF_H_
-#define        _SYS_LOCKF_H_
+#define _SYS_LOCKF_H_
 
 #include <sys/queue.h>
 #include <sys/cdefs.h>
@@ -68,46 +73,51 @@ struct vnode;
 MALLOC_DECLARE(M_LOCKF);
 #endif
 
+#if IMPORTANCE_INHERITANCE
+#define LF_NOT_BOOSTED  0
+#define LF_BOOSTED      1
+#endif /* IMPORTANCE_INHERITANCE */
+
 /*
  * 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);
 
-#if __DARWIN_ALIGN_POWER
-#pragma options align=power
-#endif
-
 struct lockf {
-       short   lf_flags;           /* Semantics: F_POSIX, F_FLOCK, F_WAIT */
-       short   lf_type;         /* Lock type: F_RDLCK, F_WRLCK */
-       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 */
+       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 */
 };
 
-#if __DARWIN_ALIGN_POWER
-#pragma options align=reset
-#endif
-
-/* Maximum length of sleep chains to traverse to try and detect deadlock. */
-#define MAXDEPTH 50
-
 __BEGIN_DECLS
 
-int     lf_advlock(struct vnop_advlock_args *);
+#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);
 
 #ifdef LOCKF_DEBUG
-void   lf_print(char *, struct lockf *);
-void   lf_printlist(char *, struct lockf *);
+void    lf_print(char *, struct lockf *);
+void    lf_printlist(char *, struct lockf *);
 #endif
+#endif /* KERNEL_PRIVATE */
 
 __END_DECLS