xref: /xnu-11417.140.69/bsd/sys/lockf.h (revision 43a90889846e00bfb5cf1d255cdc0a701a1e05a4)
1*43a90889SApple OSS Distributions /*
2*43a90889SApple OSS Distributions  * Copyright (c) 2004-2018 Apple Inc. All rights reserved.
3*43a90889SApple OSS Distributions  *
4*43a90889SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*43a90889SApple OSS Distributions  *
6*43a90889SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*43a90889SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*43a90889SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*43a90889SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*43a90889SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*43a90889SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*43a90889SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*43a90889SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*43a90889SApple OSS Distributions  *
15*43a90889SApple OSS Distributions  * Please obtain a copy of the License at
16*43a90889SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*43a90889SApple OSS Distributions  *
18*43a90889SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*43a90889SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*43a90889SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*43a90889SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*43a90889SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*43a90889SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*43a90889SApple OSS Distributions  * limitations under the License.
25*43a90889SApple OSS Distributions  *
26*43a90889SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*43a90889SApple OSS Distributions  */
28*43a90889SApple OSS Distributions /*
29*43a90889SApple OSS Distributions  * Copyright (c) 1991, 1993
30*43a90889SApple OSS Distributions  *	The Regents of the University of California.  All rights reserved.
31*43a90889SApple OSS Distributions  *
32*43a90889SApple OSS Distributions  * This code is derived from software contributed to Berkeley by
33*43a90889SApple OSS Distributions  * Scooter Morris at Genentech Inc.
34*43a90889SApple OSS Distributions  *
35*43a90889SApple OSS Distributions  * Redistribution and use in source and binary forms, with or without
36*43a90889SApple OSS Distributions  * modification, are permitted provided that the following conditions
37*43a90889SApple OSS Distributions  * are met:
38*43a90889SApple OSS Distributions  * 1. Redistributions of source code must retain the above copyright
39*43a90889SApple OSS Distributions  *    notice, this list of conditions and the following disclaimer.
40*43a90889SApple OSS Distributions  * 2. Redistributions in binary form must reproduce the above copyright
41*43a90889SApple OSS Distributions  *    notice, this list of conditions and the following disclaimer in the
42*43a90889SApple OSS Distributions  *    documentation and/or other materials provided with the distribution.
43*43a90889SApple OSS Distributions  * 4. Neither the name of the University nor the names of its contributors
44*43a90889SApple OSS Distributions  *    may be used to endorse or promote products derived from this software
45*43a90889SApple OSS Distributions  *    without specific prior written permission.
46*43a90889SApple OSS Distributions  *
47*43a90889SApple OSS Distributions  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
48*43a90889SApple OSS Distributions  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
49*43a90889SApple OSS Distributions  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
50*43a90889SApple OSS Distributions  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
51*43a90889SApple OSS Distributions  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
52*43a90889SApple OSS Distributions  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
53*43a90889SApple OSS Distributions  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
54*43a90889SApple OSS Distributions  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
55*43a90889SApple OSS Distributions  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
56*43a90889SApple OSS Distributions  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
57*43a90889SApple OSS Distributions  * SUCH DAMAGE.
58*43a90889SApple OSS Distributions  *
59*43a90889SApple OSS Distributions  *	@(#)lockf.h	8.1 (Berkeley) 6/11/93
60*43a90889SApple OSS Distributions  * $FreeBSD: src/sys/sys/lockf.h,v 1.16 2004/04/07 04:19:49 imp Exp $
61*43a90889SApple OSS Distributions  */
62*43a90889SApple OSS Distributions 
63*43a90889SApple OSS Distributions #ifndef _SYS_LOCKF_H_
64*43a90889SApple OSS Distributions #define _SYS_LOCKF_H_
65*43a90889SApple OSS Distributions 
66*43a90889SApple OSS Distributions #include <sys/queue.h>
67*43a90889SApple OSS Distributions #include <sys/cdefs.h>
68*43a90889SApple OSS Distributions #include <sys/types.h>
69*43a90889SApple OSS Distributions 
70*43a90889SApple OSS Distributions struct vnop_advlock_args;
71*43a90889SApple OSS Distributions struct vnode;
72*43a90889SApple OSS Distributions 
73*43a90889SApple OSS Distributions #if IMPORTANCE_INHERITANCE
74*43a90889SApple OSS Distributions #define LF_NOT_BOOSTED  0
75*43a90889SApple OSS Distributions #define LF_BOOSTED      1
76*43a90889SApple OSS Distributions #endif /* IMPORTANCE_INHERITANCE */
77*43a90889SApple OSS Distributions 
78*43a90889SApple OSS Distributions /*
79*43a90889SApple OSS Distributions  * The lockf structure is a kernel structure which contains the information
80*43a90889SApple OSS Distributions  * associated with a byte range lock.  The lockf structures are linked into
81*43a90889SApple OSS Distributions  * the vnode structure.  Locks are sorted by the starting byte of the lock for
82*43a90889SApple OSS Distributions  * efficiency after they have been committed; uncommitted locks are on the list
83*43a90889SApple OSS Distributions  * head so they may quickly be accessed, and are both short lived and transient.
84*43a90889SApple OSS Distributions  */
85*43a90889SApple OSS Distributions TAILQ_HEAD(locklist, lockf);
86*43a90889SApple OSS Distributions 
87*43a90889SApple OSS Distributions struct lockf {
88*43a90889SApple OSS Distributions 	short   lf_flags;           /* Semantics: F_POSIX, F_FLOCK, F_WAIT */
89*43a90889SApple OSS Distributions 	short   lf_type;            /* Lock type: F_RDLCK, F_WRLCK */
90*43a90889SApple OSS Distributions #if IMPORTANCE_INHERITANCE
91*43a90889SApple OSS Distributions 	int     lf_boosted;         /* Is the owner of the lock boosted */
92*43a90889SApple OSS Distributions #endif
93*43a90889SApple OSS Distributions 	off_t   lf_start;           /* Byte # of the start of the lock */
94*43a90889SApple OSS Distributions 	off_t   lf_end;             /* Byte # of the end of the lock (-1=EOF) */
95*43a90889SApple OSS Distributions 	caddr_t lf_id;              /* Id of the resource holding the lock */
96*43a90889SApple OSS Distributions 	struct  lockf **lf_head;    /* Back pointer to the head of the lockf list */
97*43a90889SApple OSS Distributions 	struct  vnode *lf_vnode;    /* Back pointer to the inode */
98*43a90889SApple OSS Distributions 	struct  lockf *lf_next;     /* Pointer to the next lock on this inode */
99*43a90889SApple OSS Distributions 	struct  locklist lf_blkhd;  /* List of requests blocked on this lock */
100*43a90889SApple OSS Distributions 	TAILQ_ENTRY(lockf) lf_block;/* A request waiting for a lock */
101*43a90889SApple OSS Distributions 	struct  proc *lf_owner;     /* The proc that did the SETLK, if known */
102*43a90889SApple OSS Distributions };
103*43a90889SApple OSS Distributions 
104*43a90889SApple OSS Distributions __BEGIN_DECLS
105*43a90889SApple OSS Distributions 
106*43a90889SApple OSS Distributions #ifdef KERNEL_PRIVATE
107*43a90889SApple OSS Distributions void    lf_init(void);
108*43a90889SApple OSS Distributions int     lf_advlock(struct vnop_advlock_args *);
109*43a90889SApple OSS Distributions int     lf_assert(struct vnop_advlock_args *, void **);
110*43a90889SApple OSS Distributions void    lf_commit(void *, int);
111*43a90889SApple OSS Distributions void    lf_abort_advlocks(vnode_t);
112*43a90889SApple OSS Distributions 
113*43a90889SApple OSS Distributions #ifdef LOCKF_DEBUG
114*43a90889SApple OSS Distributions void    lf_print(char *, struct lockf *);
115*43a90889SApple OSS Distributions void    lf_printlist(char *, struct lockf *);
116*43a90889SApple OSS Distributions #endif
117*43a90889SApple OSS Distributions #endif /* KERNEL_PRIVATE */
118*43a90889SApple OSS Distributions 
119*43a90889SApple OSS Distributions __END_DECLS
120*43a90889SApple OSS Distributions 
121*43a90889SApple OSS Distributions #endif /* !_SYS_LOCKF_H_ */
122