Whamcloud - gitweb
LU-6599 header: Change erroneous GPLv3 header to GPLv2
[fs/lustre-release.git] / lustre / include / lustre_dlm_flags.h
1 /*  -*- buffer-read-only: t -*- vi: set ro:
2  *
3  * This program is free software; you can redistribute it and/or modify
4  * it under the terms of the GNU General Public License version 2 only,
5  * as published by the Free Software Foundation.
6  *
7  * Lustre is distributed in the hope that it will be useful, but
8  * WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
10  * See the GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License along
13  * with this program.  If not, see <http://www.gnu.org/licenses/>.
14  */
15 /**
16  * \file lustre_dlm_flags.h
17  * The flags and collections of flags (masks) for \see struct ldlm_lock.
18  *
19  * \addtogroup LDLM Lustre Distributed Lock Manager
20  * @{
21  *
22  * \name flags
23  * The flags and collections of flags (masks) for \see struct ldlm_lock.
24  * @{
25  */
26 #ifndef LDLM_ALL_FLAGS_MASK
27
28 /** l_flags bits marked as "all_flags" bits */
29 #define LDLM_FL_ALL_FLAGS_MASK          0x00FFFFFFC08F932FULL
30
31 /** extent, mode, or resource changed */
32 #define LDLM_FL_LOCK_CHANGED            0x0000000000000001ULL // bit   0
33 #define ldlm_is_lock_changed(_l)        LDLM_TEST_FLAG(( _l), 1ULL <<  0)
34 #define ldlm_set_lock_changed(_l)       LDLM_SET_FLAG((  _l), 1ULL <<  0)
35 #define ldlm_clear_lock_changed(_l)     LDLM_CLEAR_FLAG((_l), 1ULL <<  0)
36
37 /**
38  * Server placed lock on granted list, or a recovering client wants the
39  * lock added to the granted list, no questions asked. */
40 #define LDLM_FL_BLOCK_GRANTED           0x0000000000000002ULL // bit   1
41 #define ldlm_is_block_granted(_l)       LDLM_TEST_FLAG(( _l), 1ULL <<  1)
42 #define ldlm_set_block_granted(_l)      LDLM_SET_FLAG((  _l), 1ULL <<  1)
43 #define ldlm_clear_block_granted(_l)    LDLM_CLEAR_FLAG((_l), 1ULL <<  1)
44
45 /**
46  * Server placed lock on conv list, or a recovering client wants the lock
47  * added to the conv list, no questions asked. */
48 #define LDLM_FL_BLOCK_CONV              0x0000000000000004ULL // bit   2
49 #define ldlm_is_block_conv(_l)          LDLM_TEST_FLAG(( _l), 1ULL <<  2)
50 #define ldlm_set_block_conv(_l)         LDLM_SET_FLAG((  _l), 1ULL <<  2)
51 #define ldlm_clear_block_conv(_l)       LDLM_CLEAR_FLAG((_l), 1ULL <<  2)
52
53 /**
54  * Server placed lock on wait list, or a recovering client wants the lock
55  * added to the wait list, no questions asked. */
56 #define LDLM_FL_BLOCK_WAIT              0x0000000000000008ULL // bit   3
57 #define ldlm_is_block_wait(_l)          LDLM_TEST_FLAG(( _l), 1ULL <<  3)
58 #define ldlm_set_block_wait(_l)         LDLM_SET_FLAG((  _l), 1ULL <<  3)
59 #define ldlm_clear_block_wait(_l)       LDLM_CLEAR_FLAG((_l), 1ULL <<  3)
60
61 /** blocking or cancel packet was queued for sending. */
62 #define LDLM_FL_AST_SENT                0x0000000000000020ULL // bit   5
63 #define ldlm_is_ast_sent(_l)            LDLM_TEST_FLAG(( _l), 1ULL <<  5)
64 #define ldlm_set_ast_sent(_l)           LDLM_SET_FLAG((  _l), 1ULL <<  5)
65 #define ldlm_clear_ast_sent(_l)         LDLM_CLEAR_FLAG((_l), 1ULL <<  5)
66
67 /**
68  * Lock is being replayed.  This could probably be implied by the fact that
69  * one of BLOCK_{GRANTED,CONV,WAIT} is set, but that is pretty dangerous. */
70 #define LDLM_FL_REPLAY                  0x0000000000000100ULL // bit   8
71 #define ldlm_is_replay(_l)              LDLM_TEST_FLAG(( _l), 1ULL <<  8)
72 #define ldlm_set_replay(_l)             LDLM_SET_FLAG((  _l), 1ULL <<  8)
73 #define ldlm_clear_replay(_l)           LDLM_CLEAR_FLAG((_l), 1ULL <<  8)
74
75 /** Don't grant lock, just do intent. */
76 #define LDLM_FL_INTENT_ONLY             0x0000000000000200ULL // bit   9
77 #define ldlm_is_intent_only(_l)         LDLM_TEST_FLAG(( _l), 1ULL <<  9)
78 #define ldlm_set_intent_only(_l)        LDLM_SET_FLAG((  _l), 1ULL <<  9)
79 #define ldlm_clear_intent_only(_l)      LDLM_CLEAR_FLAG((_l), 1ULL <<  9)
80
81 /** lock request has intent */
82 #define LDLM_FL_HAS_INTENT              0x0000000000001000ULL // bit  12
83 #define ldlm_is_has_intent(_l)          LDLM_TEST_FLAG(( _l), 1ULL << 12)
84 #define ldlm_set_has_intent(_l)         LDLM_SET_FLAG((  _l), 1ULL << 12)
85 #define ldlm_clear_has_intent(_l)       LDLM_CLEAR_FLAG((_l), 1ULL << 12)
86
87 /** flock deadlock detected */
88 #define LDLM_FL_FLOCK_DEADLOCK          0x0000000000008000ULL // bit  15
89 #define ldlm_is_flock_deadlock(_l)      LDLM_TEST_FLAG(( _l), 1ULL << 15)
90 #define ldlm_set_flock_deadlock(_l)     LDLM_SET_FLAG((  _l), 1ULL << 15)
91 #define ldlm_clear_flock_deadlock(_l)   LDLM_CLEAR_FLAG((_l), 1ULL << 15)
92
93 /** discard (no writeback) on cancel */
94 #define LDLM_FL_DISCARD_DATA            0x0000000000010000ULL // bit  16
95 #define ldlm_is_discard_data(_l)        LDLM_TEST_FLAG(( _l), 1ULL << 16)
96 #define ldlm_set_discard_data(_l)       LDLM_SET_FLAG((  _l), 1ULL << 16)
97 #define ldlm_clear_discard_data(_l)     LDLM_CLEAR_FLAG((_l), 1ULL << 16)
98
99 /** Blocked by group lock - wait indefinitely */
100 #define LDLM_FL_NO_TIMEOUT              0x0000000000020000ULL // bit  17
101 #define ldlm_is_no_timeout(_l)          LDLM_TEST_FLAG(( _l), 1ULL << 17)
102 #define ldlm_set_no_timeout(_l)         LDLM_SET_FLAG((  _l), 1ULL << 17)
103 #define ldlm_clear_no_timeout(_l)       LDLM_CLEAR_FLAG((_l), 1ULL << 17)
104
105 /**
106  * Server told not to wait if blocked. For AGL, OST will not send glimpse
107  * callback. */
108 #define LDLM_FL_BLOCK_NOWAIT            0x0000000000040000ULL // bit  18
109 #define ldlm_is_block_nowait(_l)        LDLM_TEST_FLAG(( _l), 1ULL << 18)
110 #define ldlm_set_block_nowait(_l)       LDLM_SET_FLAG((  _l), 1ULL << 18)
111 #define ldlm_clear_block_nowait(_l)     LDLM_CLEAR_FLAG((_l), 1ULL << 18)
112
113 /** return blocking lock */
114 #define LDLM_FL_TEST_LOCK               0x0000000000080000ULL // bit  19
115 #define ldlm_is_test_lock(_l)           LDLM_TEST_FLAG(( _l), 1ULL << 19)
116 #define ldlm_set_test_lock(_l)          LDLM_SET_FLAG((  _l), 1ULL << 19)
117 #define ldlm_clear_test_lock(_l)        LDLM_CLEAR_FLAG((_l), 1ULL << 19)
118
119 /**
120  * Immediatelly cancel such locks when they block some other locks. Send
121  * cancel notification to original lock holder, but expect no reply. This
122  * is for clients (like liblustre) that cannot be expected to reliably
123  * response to blocking AST. */
124 #define LDLM_FL_CANCEL_ON_BLOCK         0x0000000000800000ULL // bit  23
125 #define ldlm_is_cancel_on_block(_l)     LDLM_TEST_FLAG(( _l), 1ULL << 23)
126 #define ldlm_set_cancel_on_block(_l)    LDLM_SET_FLAG((  _l), 1ULL << 23)
127 #define ldlm_clear_cancel_on_block(_l)  LDLM_CLEAR_FLAG((_l), 1ULL << 23)
128
129 /**
130  * measure lock contention and return -EUSERS if locking contention is high */
131 #define LDLM_FL_DENY_ON_CONTENTION        0x0000000040000000ULL // bit  30
132 #define ldlm_is_deny_on_contention(_l)    LDLM_TEST_FLAG(( _l), 1ULL << 30)
133 #define ldlm_set_deny_on_contention(_l)   LDLM_SET_FLAG((  _l), 1ULL << 30)
134 #define ldlm_clear_deny_on_contention(_l) LDLM_CLEAR_FLAG((_l), 1ULL << 30)
135
136 /**
137  * These are flags that are mapped into the flags and ASTs of blocking
138  * locks Add FL_DISCARD to blocking ASTs */
139 #define LDLM_FL_AST_DISCARD_DATA        0x0000000080000000ULL // bit  31
140 #define ldlm_is_ast_discard_data(_l)    LDLM_TEST_FLAG(( _l), 1ULL << 31)
141 #define ldlm_set_ast_discard_data(_l)   LDLM_SET_FLAG((  _l), 1ULL << 31)
142 #define ldlm_clear_ast_discard_data(_l) LDLM_CLEAR_FLAG((_l), 1ULL << 31)
143
144 /**
145  * Used for marking lock as a target for -EINTR while cp_ast sleep emulation
146  * + race with upcoming bl_ast. */
147 #define LDLM_FL_FAIL_LOC                0x0000000100000000ULL // bit  32
148 #define ldlm_is_fail_loc(_l)            LDLM_TEST_FLAG(( _l), 1ULL << 32)
149 #define ldlm_set_fail_loc(_l)           LDLM_SET_FLAG((  _l), 1ULL << 32)
150 #define ldlm_clear_fail_loc(_l)         LDLM_CLEAR_FLAG((_l), 1ULL << 32)
151
152 /**
153  * Used while processing the unused list to know that we have already
154  * handled this lock and decided to skip it. */
155 #define LDLM_FL_SKIPPED                 0x0000000200000000ULL // bit  33
156 #define ldlm_is_skipped(_l)             LDLM_TEST_FLAG(( _l), 1ULL << 33)
157 #define ldlm_set_skipped(_l)            LDLM_SET_FLAG((  _l), 1ULL << 33)
158 #define ldlm_clear_skipped(_l)          LDLM_CLEAR_FLAG((_l), 1ULL << 33)
159
160 /** this lock is being destroyed */
161 #define LDLM_FL_CBPENDING               0x0000000400000000ULL // bit  34
162 #define ldlm_is_cbpending(_l)           LDLM_TEST_FLAG(( _l), 1ULL << 34)
163 #define ldlm_set_cbpending(_l)          LDLM_SET_FLAG((  _l), 1ULL << 34)
164 #define ldlm_clear_cbpending(_l)        LDLM_CLEAR_FLAG((_l), 1ULL << 34)
165
166 /** not a real flag, not saved in lock */
167 #define LDLM_FL_WAIT_NOREPROC           0x0000000800000000ULL // bit  35
168 #define ldlm_is_wait_noreproc(_l)       LDLM_TEST_FLAG(( _l), 1ULL << 35)
169 #define ldlm_set_wait_noreproc(_l)      LDLM_SET_FLAG((  _l), 1ULL << 35)
170 #define ldlm_clear_wait_noreproc(_l)    LDLM_CLEAR_FLAG((_l), 1ULL << 35)
171
172 /** cancellation callback already run */
173 #define LDLM_FL_CANCEL                  0x0000001000000000ULL // bit  36
174 #define ldlm_is_cancel(_l)              LDLM_TEST_FLAG(( _l), 1ULL << 36)
175 #define ldlm_set_cancel(_l)             LDLM_SET_FLAG((  _l), 1ULL << 36)
176 #define ldlm_clear_cancel(_l)           LDLM_CLEAR_FLAG((_l), 1ULL << 36)
177
178 /** whatever it might mean -- never transmitted? */
179 #define LDLM_FL_LOCAL_ONLY              0x0000002000000000ULL // bit  37
180 #define ldlm_is_local_only(_l)          LDLM_TEST_FLAG(( _l), 1ULL << 37)
181 #define ldlm_set_local_only(_l)         LDLM_SET_FLAG((  _l), 1ULL << 37)
182 #define ldlm_clear_local_only(_l)       LDLM_CLEAR_FLAG((_l), 1ULL << 37)
183
184 /** don't run the cancel callback under ldlm_cli_cancel_unused */
185 #define LDLM_FL_FAILED                  0x0000004000000000ULL // bit  38
186 #define ldlm_is_failed(_l)              LDLM_TEST_FLAG(( _l), 1ULL << 38)
187 #define ldlm_set_failed(_l)             LDLM_SET_FLAG((  _l), 1ULL << 38)
188 #define ldlm_clear_failed(_l)           LDLM_CLEAR_FLAG((_l), 1ULL << 38)
189
190 /** lock cancel has already been sent */
191 #define LDLM_FL_CANCELING               0x0000008000000000ULL // bit  39
192 #define ldlm_is_canceling(_l)           LDLM_TEST_FLAG(( _l), 1ULL << 39)
193 #define ldlm_set_canceling(_l)          LDLM_SET_FLAG((  _l), 1ULL << 39)
194 #define ldlm_clear_canceling(_l)        LDLM_CLEAR_FLAG((_l), 1ULL << 39)
195
196 /** local lock (ie, no srv/cli split) */
197 #define LDLM_FL_LOCAL                   0x0000010000000000ULL // bit  40
198 #define ldlm_is_local(_l)               LDLM_TEST_FLAG(( _l), 1ULL << 40)
199 #define ldlm_set_local(_l)              LDLM_SET_FLAG((  _l), 1ULL << 40)
200 #define ldlm_clear_local(_l)            LDLM_CLEAR_FLAG((_l), 1ULL << 40)
201
202 /**
203  * XXX FIXME: This is being added to b_size as a low-risk fix to the
204  * fact that the LVB filling happens _after_ the lock has been granted,
205  * so another thread can match it before the LVB has been updated.  As a
206  * dirty hack, we set LDLM_FL_LVB_READY only after we've done the LVB poop.
207  * this is only needed on LOV/OSC now, where LVB is actually used and
208  * callers must set it in input flags.
209  *
210  * The proper fix is to do the granting inside of the completion AST,
211  * which can be replaced with a LVB-aware wrapping function for OSC locks.
212  * That change is pretty high-risk, though, and would need a lot more
213  * testing. */
214 #define LDLM_FL_LVB_READY               0x0000020000000000ULL // bit  41
215 #define ldlm_is_lvb_ready(_l)           LDLM_TEST_FLAG(( _l), 1ULL << 41)
216 #define ldlm_set_lvb_ready(_l)          LDLM_SET_FLAG((  _l), 1ULL << 41)
217 #define ldlm_clear_lvb_ready(_l)        LDLM_CLEAR_FLAG((_l), 1ULL << 41)
218
219 /**
220  * A lock contributes to the known minimum size (KMS) calculation until it
221  * has finished the part of its cancelation that performs write back on its
222  * dirty pages.  It can remain on the granted list during this whole time.
223  * Threads racing to update the KMS after performing their writeback need
224  * to know to exclude each other's locks from the calculation as they walk
225  * the granted list. */
226 #define LDLM_FL_KMS_IGNORE              0x0000040000000000ULL // bit  42
227 #define ldlm_is_kms_ignore(_l)          LDLM_TEST_FLAG(( _l), 1ULL << 42)
228 #define ldlm_set_kms_ignore(_l)         LDLM_SET_FLAG((  _l), 1ULL << 42)
229 #define ldlm_clear_kms_ignore(_l)       LDLM_CLEAR_FLAG((_l), 1ULL << 42)
230
231 /** completion AST to be executed */
232 #define LDLM_FL_CP_REQD                 0x0000080000000000ULL // bit  43
233 #define ldlm_is_cp_reqd(_l)             LDLM_TEST_FLAG(( _l), 1ULL << 43)
234 #define ldlm_set_cp_reqd(_l)            LDLM_SET_FLAG((  _l), 1ULL << 43)
235 #define ldlm_clear_cp_reqd(_l)          LDLM_CLEAR_FLAG((_l), 1ULL << 43)
236
237 /** cleanup_resource has already handled the lock */
238 #define LDLM_FL_CLEANED                 0x0000100000000000ULL // bit  44
239 #define ldlm_is_cleaned(_l)             LDLM_TEST_FLAG(( _l), 1ULL << 44)
240 #define ldlm_set_cleaned(_l)            LDLM_SET_FLAG((  _l), 1ULL << 44)
241 #define ldlm_clear_cleaned(_l)          LDLM_CLEAR_FLAG((_l), 1ULL << 44)
242
243 /**
244  * optimization hint: LDLM can run blocking callback from current context
245  * w/o involving separate thread. in order to decrease cs rate */
246 #define LDLM_FL_ATOMIC_CB               0x0000200000000000ULL // bit  45
247 #define ldlm_is_atomic_cb(_l)           LDLM_TEST_FLAG(( _l), 1ULL << 45)
248 #define ldlm_set_atomic_cb(_l)          LDLM_SET_FLAG((  _l), 1ULL << 45)
249 #define ldlm_clear_atomic_cb(_l)        LDLM_CLEAR_FLAG((_l), 1ULL << 45)
250
251 /**
252  * It may happen that a client initiates two operations, e.g. unlink and
253  * mkdir, such that the server sends a blocking AST for conflicting locks
254  * to this client for the first operation, whereas the second operation
255  * has canceled this lock and is waiting for rpc_lock which is taken by
256  * the first operation. LDLM_FL_BL_AST is set by ldlm_callback_handler() in
257  * the lock to prevent the Early Lock Cancel (ELC) code from cancelling it. */
258 #define LDLM_FL_BL_AST                  0x0000400000000000ULL // bit  46
259 #define ldlm_is_bl_ast(_l)              LDLM_TEST_FLAG(( _l), 1ULL << 46)
260 #define ldlm_set_bl_ast(_l)             LDLM_SET_FLAG((  _l), 1ULL << 46)
261 #define ldlm_clear_bl_ast(_l)           LDLM_CLEAR_FLAG((_l), 1ULL << 46)
262
263 /**
264  * Set by ldlm_cancel_callback() when lock cache is dropped to let
265  * ldlm_callback_handler() return EINVAL to the server. It is used when
266  * ELC RPC is already prepared and is waiting for rpc_lock, too late to
267  * send a separate CANCEL RPC. */
268 #define LDLM_FL_BL_DONE                 0x0000800000000000ULL // bit  47
269 #define ldlm_is_bl_done(_l)             LDLM_TEST_FLAG(( _l), 1ULL << 47)
270 #define ldlm_set_bl_done(_l)            LDLM_SET_FLAG((  _l), 1ULL << 47)
271 #define ldlm_clear_bl_done(_l)          LDLM_CLEAR_FLAG((_l), 1ULL << 47)
272
273 /**
274  * Don't put lock into the LRU list, so that it is not canceled due
275  * to aging.  Used by MGC locks, they are cancelled only at unmount or
276  * by callback. */
277 #define LDLM_FL_NO_LRU                  0x0001000000000000ULL // bit  48
278 #define ldlm_is_no_lru(_l)              LDLM_TEST_FLAG(( _l), 1ULL << 48)
279 #define ldlm_set_no_lru(_l)             LDLM_SET_FLAG((  _l), 1ULL << 48)
280 #define ldlm_clear_no_lru(_l)           LDLM_CLEAR_FLAG((_l), 1ULL << 48)
281
282 /**
283  * Set for locks that failed and where the server has been notified.
284  *
285  * Protected by lock and resource locks. */
286 #define LDLM_FL_FAIL_NOTIFIED           0x0002000000000000ULL // bit  49
287 #define ldlm_is_fail_notified(_l)       LDLM_TEST_FLAG(( _l), 1ULL << 49)
288 #define ldlm_set_fail_notified(_l)      LDLM_SET_FLAG((  _l), 1ULL << 49)
289 #define ldlm_clear_fail_notified(_l)    LDLM_CLEAR_FLAG((_l), 1ULL << 49)
290
291 /**
292  * Set for locks that were removed from class hash table and will
293  * be destroyed when last reference to them is released. Set by
294  * ldlm_lock_destroy_internal().
295  *
296  * Protected by lock and resource locks. */
297 #define LDLM_FL_DESTROYED               0x0004000000000000ULL // bit  50
298 #define ldlm_is_destroyed(_l)           LDLM_TEST_FLAG(( _l), 1ULL << 50)
299 #define ldlm_set_destroyed(_l)          LDLM_SET_FLAG((  _l), 1ULL << 50)
300 #define ldlm_clear_destroyed(_l)        LDLM_CLEAR_FLAG((_l), 1ULL << 50)
301
302 /** flag whether this is a server namespace lock */
303 #define LDLM_FL_SERVER_LOCK             0x0008000000000000ULL // bit  51
304 #define ldlm_is_server_lock(_l)         LDLM_TEST_FLAG(( _l), 1ULL << 51)
305 #define ldlm_set_server_lock(_l)        LDLM_SET_FLAG((  _l), 1ULL << 51)
306 #define ldlm_clear_server_lock(_l)      LDLM_CLEAR_FLAG((_l), 1ULL << 51)
307
308 /**
309  * It's set in lock_res_and_lock() and unset in unlock_res_and_lock().
310  *
311  * NB: compared with check_res_locked(), checking this bit is cheaper.
312  * Also, spin_is_locked() is deprecated for kernel code; one reason is
313  * because it works only for SMP so user needs to add extra macros like
314  * LASSERT_SPIN_LOCKED for uniprocessor kernels. */
315 #define LDLM_FL_RES_LOCKED              0x0010000000000000ULL // bit  52
316 #define ldlm_is_res_locked(_l)          LDLM_TEST_FLAG(( _l), 1ULL << 52)
317 #define ldlm_set_res_locked(_l)         LDLM_SET_FLAG((  _l), 1ULL << 52)
318 #define ldlm_clear_res_locked(_l)       LDLM_CLEAR_FLAG((_l), 1ULL << 52)
319
320 /**
321  * It's set once we call ldlm_add_waiting_lock_res_locked() to start the
322  * lock-timeout timer and it will never be reset.
323  *
324  * Protected by lock and resource locks. */
325 #define LDLM_FL_WAITED                  0x0020000000000000ULL // bit  53
326 #define ldlm_is_waited(_l)              LDLM_TEST_FLAG(( _l), 1ULL << 53)
327 #define ldlm_set_waited(_l)             LDLM_SET_FLAG((  _l), 1ULL << 53)
328 #define ldlm_clear_waited(_l)           LDLM_CLEAR_FLAG((_l), 1ULL << 53)
329
330 /** Flag whether this is a server namespace lock. */
331 #define LDLM_FL_NS_SRV                  0x0040000000000000ULL // bit  54
332 #define ldlm_is_ns_srv(_l)              LDLM_TEST_FLAG(( _l), 1ULL << 54)
333 #define ldlm_set_ns_srv(_l)             LDLM_SET_FLAG((  _l), 1ULL << 54)
334 #define ldlm_clear_ns_srv(_l)           LDLM_CLEAR_FLAG((_l), 1ULL << 54)
335
336 /** Flag whether this lock can be reused. Used by exclusive open. */
337 #define LDLM_FL_EXCL                    0x0080000000000000ULL // bit  55
338 #define ldlm_is_excl(_l)                LDLM_TEST_FLAG(( _l), 1ULL << 55)
339 #define ldlm_set_excl(_l)               LDLM_SET_FLAG((  _l), 1ULL << 55)
340 #define ldlm_clear_excl(_l)             LDLM_CLEAR_FLAG((_l), 1ULL << 55)
341
342 /** Flag whether a lock is found on server for re-sent RPC. */
343 #define LDLM_FL_RESENT                   0x0100000000000000ULL // bit  56
344
345 /** l_flags bits marked as "ast" bits */
346 #define LDLM_FL_AST_MASK                (LDLM_FL_FLOCK_DEADLOCK         |\
347                                          LDLM_FL_AST_DISCARD_DATA)
348
349 /** l_flags bits marked as "blocked" bits */
350 #define LDLM_FL_BLOCKED_MASK            (LDLM_FL_BLOCK_GRANTED          |\
351                                          LDLM_FL_BLOCK_CONV             |\
352                                          LDLM_FL_BLOCK_WAIT)
353
354 /** l_flags bits marked as "gone" bits */
355 #define LDLM_FL_GONE_MASK               (LDLM_FL_DESTROYED              |\
356                                          LDLM_FL_FAILED)
357
358 /** l_flags bits marked as "inherit" bits */
359 /* Flags inherited from wire on enqueue/reply between client/server. */
360 /* NO_TIMEOUT flag to force ldlm_lock_match() to wait with no timeout. */
361 /* TEST_LOCK flag to not let TEST lock to be granted. */
362 #define LDLM_FL_INHERIT_MASK            (LDLM_FL_CANCEL_ON_BLOCK        |\
363                                          LDLM_FL_NO_TIMEOUT             |\
364                                          LDLM_FL_TEST_LOCK)
365
366 /** flags returned in @flags parameter on ldlm_lock_enqueue,
367  * to be re-constructed on re-send */
368 #define LDLM_FL_SRV_ENQ_MASK    (LDLM_FL_LOCK_CHANGED           |\
369                                  LDLM_FL_BLOCKED_MASK           |\
370                                  LDLM_FL_NO_TIMEOUT)
371
372 /** test for ldlm_lock flag bit set */
373 #define LDLM_TEST_FLAG(_l, _b)    (((_l)->l_flags & (_b)) != 0)
374
375 /** multi-bit test: are any of mask bits set? */
376 #define LDLM_HAVE_MASK(_l, _m)    (((_l)->l_flags & LDLM_FL_##_m##_MASK) != 0)
377
378 /** set a ldlm_lock flag bit */
379 #define LDLM_SET_FLAG(_l, _b)     ((_l)->l_flags |= (_b))
380
381 /** clear a ldlm_lock flag bit */
382 #define LDLM_CLEAR_FLAG(_l, _b)   ((_l)->l_flags &= ~(_b))
383
384 /** @} subgroup */
385 /** @} group */
386 #endif /* LDLM_ALL_FLAGS_MASK */
387