afsconfig-and-rcsid-all-around-20010705
[openafs.git] / src / venus / lock.h
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  * 
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 #ifndef __AFSLOCK_INCLUDE__
11 #define __AFSLOCK_INCLUDE__         1
12
13 /*******************************************************************\
14 *                                                                   *
15 *       Information Technology Center                               *
16 *       Carnegie-Mellon University                                  *
17 *                                                                   *
18 *                                                                   *
19 *                                                                   *
20 \*******************************************************************/
21
22 /*
23         Include file for using Vice locking routines.
24 */
25
26 /* The following macros allow multi statement macros to be defined safely, i.e.
27    - the multi statement macro can be the object of an if statement;
28    - the call to the multi statement macro may be legally followed by a semi-colon.
29    BEGINMAC and ENDMAC have been tested with both the portable C compiler and
30    Hi-C.  Both compilers were from the Palo Alto 4.2BSD software releases, and
31    both optimized out the constant loop code.  For an example of the use
32    of BEGINMAC and ENDMAC, see the definition for ReleaseWriteLock, below.
33    An alternative to this, using "if(1)" for BEGINMAC is not used because it
34    may generate worse code with pcc, and may generate warning messages with hi-C.
35 */
36
37 #define BEGINMAC do {
38 #define ENDMAC   } while (0)
39
40 struct afs_bozoLock {
41     short count;    /* count of excl locks */
42     char flags;     /* bit 1: is anyone waiting? */
43     char spare;     /* for later */
44     char *proc;     /* process holding the lock, really a struct proc * */
45 };
46
47 #define AFS_BOZONWAITING    1       /* someone is waiting for this lock */
48
49 /* all locks wait on excl_locked except for READ_LOCK, which waits on readers_reading */
50 struct afs_lock {
51     unsigned char       wait_states;    /* type of lockers waiting */
52     unsigned char       excl_locked;    /* anyone have boosted, shared or write lock? */
53     unsigned char       readers_reading;        /* # readers actually with read locks */
54     unsigned char       num_waiting;    /* probably need this soon */
55 };
56
57 #define READ_LOCK       1
58 #define WRITE_LOCK      2
59 #define SHARED_LOCK     4
60 /* this next is not a flag, but rather a parameter to Afs_Lock_Obtain */
61 #define BOOSTED_LOCK 6
62
63 /* next defines wait_states for which we wait on excl_locked */
64 #define EXCL_LOCKS (WRITE_LOCK|SHARED_LOCK)
65
66 #define ObtainReadLock(lock)\
67         if (!((lock)->excl_locked & WRITE_LOCK))\
68             (lock) -> readers_reading++;\
69         else\
70             Afs_Lock_Obtain(lock, READ_LOCK)
71
72 #define ObtainWriteLock(lock)\
73         if (!(lock)->excl_locked && !(lock)->readers_reading)\
74             (lock) -> excl_locked = WRITE_LOCK;\
75         else\
76             Afs_Lock_Obtain(lock, WRITE_LOCK)
77
78 #define ObtainSharedLock(lock)\
79         if (!(lock)->excl_locked)\
80             (lock) -> excl_locked = SHARED_LOCK;\
81         else\
82             Afs_Lock_Obtain(lock, SHARED_LOCK)
83
84 #define UpgradeSToWLock(lock)\
85         if (!(lock)->readers_reading)\
86             (lock)->excl_locked = WRITE_LOCK;\
87         else\
88             Afs_Lock_Obtain(lock, BOOSTED_LOCK)
89
90 /* this must only be called with a WRITE or boosted SHARED lock! */
91 #define ConvertWToSLock(lock)\
92         BEGINMAC\
93             (lock)->excl_locked = SHARED_LOCK; \
94             if((lock)->wait_states) \
95                 Afs_Lock_ReleaseR(lock); \
96         ENDMAC
97
98 #define ConvertWToRLock(lock) \
99         BEGINMAC\
100             (lock)->excl_locked &= ~(SHARED_LOCK | WRITE_LOCK);\
101             (lock)->readers_reading++;\
102             Afs_Lock_ReleaseR(lock);\
103         ENDMAC
104
105 #define ConvertSToRLock(lock) \
106         BEGINMAC\
107             (lock)->excl_locked &= ~(SHARED_LOCK | WRITE_LOCK);\
108             (lock)->readers_reading++;\
109             Afs_Lock_ReleaseR(lock);\
110         ENDMAC
111
112 #define ReleaseReadLock(lock)\
113         BEGINMAC\
114             if (!--(lock)->readers_reading && (lock)->wait_states)\
115                 Afs_Lock_ReleaseW(lock) ; \
116         ENDMAC
117
118 #define ReleaseWriteLock(lock)\
119         BEGINMAC\
120             (lock)->excl_locked &= ~WRITE_LOCK;\
121             if ((lock)->wait_states) Afs_Lock_ReleaseR(lock);\
122         ENDMAC
123
124 /* can be used on shared or boosted (write) locks */
125 #define ReleaseSharedLock(lock)\
126         BEGINMAC\
127             (lock)->excl_locked &= ~(SHARED_LOCK | WRITE_LOCK);\
128             if ((lock)->wait_states) Afs_Lock_ReleaseR(lock);\
129         ENDMAC
130
131 /* I added this next macro to make sure it is safe to nuke a lock -- Mike K. */
132 #define LockWaiters(lock)\
133         ((int) ((lock)->num_waiting))
134
135 #define CheckLock(lock)\
136         ((lock)->excl_locked? (int) -1 : (int) (lock)->readers_reading)
137
138 #define WriteLocked(lock)\
139         ((lock)->excl_locked & WRITE_LOCK)
140
141 /*
142
143 You can also use the lock package for handling parent locks for independently-lockable sets of
144 small objects.  The concept here is that the parent lock is at the same level in the
145 locking hierarchy as the little locks, but certain restrictions apply.
146
147 The general usage pattern is as follows.  You have a set of entries to search.  When searching it, you
148 have a "scan" lock on the table.  If you find what you're looking for, you drop the lock down
149 to a "hold" lock, lock the entry, and release the parent lock.  If you don't find what
150 you're looking for, you create the entry, downgrade the "scan" lock to a "hold" lock,
151 lock the entry and unlock the parent.
152
153 To delete an item from the table, you initially obtain a "purge" lock on the parent.  Unlike all
154 of the other parent lock modes described herein, in order to obtain a "purge" lock mode, you
155 must have released all locks on any items in the table.  Once you have obtained the parent
156 lock in "purge" mode, you should check to see if the entry is locked.  If its not locked, you
157 are free to delete the entry, knowing that no one else can attempt to obtain a lock
158 on the entry while you have the purge lock held on the parent.  Unfortunately, if it *is* locked,
159 you can not lock it yourself and wait for the other dude to release it, since the entry's locker
160 may need to lock another entry before unlocking the entry you want (which would result in
161 deadlock).  Instead, then, you must release the parent lock, and try again "later" (see Lock_Wait
162 for assistance in waiting until later). Unfortunately, this is the best locking paradigm I've yet
163 come up with.
164
165 What are the advantages to this scheme?  First, the use of the parent lock ensures that
166 two people don't try to add the same entry at the same time or delete an entry while someone
167 else is adding it.  It also ensures that when one process is deleting an entry, no one else is
168 preparing to lock the entry.  Furthermore, when obtaining a lock on a little entry, you
169 are only holding a "hold" lock on the parent lock, so that others may come in and search
170 the table during this time.  Thus it will not hold up the system if a little entry takes
171 a great deal of time to free up.
172
173 Here's how to compute the compatibility matrix:
174
175 The invariants are:
176
177 add     no deletions, additions allowed, additions will be performed, will obtain little locks
178 hold    no deletions, additions allowed, no additions will be performed, will obtain little locks
179 purge   no deletions or additions allowed, deletions will be performed, don't obtain little locks
180
181 When we compute the locking matrix, we note that hold is compatible with hold and add.
182 Add is compatible only with hold.  purge is not compatible with anything.  This is the same
183 matrix as obtained by mapping add->S, hold->read and purge->write locks.  Thus we
184 can use the locks above to solve this problem, and we do.
185
186 */
187 #endif /* __AFSLOCK_INCLUDE__ */