Commit | Line | Data |
---|---|---|
d7e09d03 PT |
1 | /* |
2 | * GPL HEADER START | |
3 | * | |
4 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. | |
5 | * | |
6 | * This program is free software; you can redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License version 2 only, | |
8 | * as published by the Free Software Foundation. | |
9 | * | |
10 | * This program is distributed in the hope that it will be useful, but | |
11 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * General Public License version 2 for more details (a copy is included | |
14 | * in the LICENSE file that accompanied this code). | |
15 | * | |
16 | * You should have received a copy of the GNU General Public License | |
17 | * version 2 along with this program; If not, see | |
6a5b99a4 | 18 | * http://www.gnu.org/licenses/gpl-2.0.html |
d7e09d03 | 19 | * |
d7e09d03 PT |
20 | * GPL HEADER END |
21 | */ | |
22 | /* | |
23 | * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved. | |
24 | * Use is subject to license terms. | |
25 | * | |
1dc563a6 | 26 | * Copyright (c) 2010, 2015, Intel Corporation. |
d7e09d03 PT |
27 | */ |
28 | /* | |
29 | * This file is part of Lustre, http://www.lustre.org/ | |
30 | * Lustre is a trademark of Sun Microsystems, Inc. | |
31 | */ | |
32 | ||
33 | /** \defgroup LDLM Lustre Distributed Lock Manager | |
34 | * | |
35 | * Lustre DLM is based on VAX DLM. | |
36 | * Its two main roles are: | |
37 | * - To provide locking assuring consistency of data on all Lustre nodes. | |
38 | * - To allow clients to cache state protected by a lock by holding the | |
39 | * lock until a conflicting lock is requested or it is expired by the LRU. | |
40 | * | |
41 | * @{ | |
42 | */ | |
43 | ||
44 | #ifndef _LUSTRE_DLM_H__ | |
45 | #define _LUSTRE_DLM_H__ | |
46 | ||
1accaadf GKH |
47 | #include "lustre_lib.h" |
48 | #include "lustre_net.h" | |
49 | #include "lustre_import.h" | |
50 | #include "lustre_handles.h" | |
51 | #include "interval_tree.h" /* for interval_node{}, ldlm_extent */ | |
52 | #include "lu_ref.h" | |
d7e09d03 | 53 | |
f2145eae BK |
54 | #include "lustre_dlm_flags.h" |
55 | ||
d7e09d03 PT |
56 | struct obd_ops; |
57 | struct obd_device; | |
58 | ||
59 | #define OBD_LDLM_DEVICENAME "ldlm" | |
60 | ||
61 | #define LDLM_DEFAULT_LRU_SIZE (100 * num_online_cpus()) | |
62 | #define LDLM_DEFAULT_MAX_ALIVE (cfs_time_seconds(36000)) | |
d7e09d03 PT |
63 | #define LDLM_DEFAULT_PARALLEL_AST_LIMIT 1024 |
64 | ||
65 | /** | |
66 | * LDLM non-error return states | |
67 | */ | |
d1777aa9 | 68 | enum ldlm_error { |
d7e09d03 | 69 | ELDLM_OK = 0, |
06563b56 | 70 | ELDLM_LOCK_MATCHED = 1, |
d7e09d03 PT |
71 | |
72 | ELDLM_LOCK_CHANGED = 300, | |
73 | ELDLM_LOCK_ABORTED = 301, | |
74 | ELDLM_LOCK_REPLACED = 302, | |
75 | ELDLM_NO_LOCK_DATA = 303, | |
76 | ELDLM_LOCK_WOULDBLOCK = 304, | |
77 | ||
78 | ELDLM_NAMESPACE_EXISTS = 400, | |
79 | ELDLM_BAD_NAMESPACE = 401 | |
d1777aa9 | 80 | }; |
d7e09d03 PT |
81 | |
82 | /** | |
83 | * LDLM namespace type. | |
84 | * The "client" type is actually an indication that this is a narrow local view | |
85 | * into complete namespace on the server. Such namespaces cannot make any | |
86 | * decisions about lack of conflicts or do any autonomous lock granting without | |
87 | * first speaking to a server. | |
88 | */ | |
89 | typedef enum { | |
90 | LDLM_NAMESPACE_SERVER = 1 << 0, | |
91 | LDLM_NAMESPACE_CLIENT = 1 << 1 | |
92 | } ldlm_side_t; | |
93 | ||
d7e09d03 PT |
94 | /** |
95 | * The blocking callback is overloaded to perform two functions. These flags | |
96 | * indicate which operation should be performed. | |
97 | */ | |
98 | #define LDLM_CB_BLOCKING 1 | |
99 | #define LDLM_CB_CANCELING 2 | |
100 | ||
101 | /** | |
102 | * \name Lock Compatibility Matrix. | |
103 | * | |
104 | * A lock has both a type (extent, flock, inode bits, or plain) and a mode. | |
105 | * Lock types are described in their respective implementation files: | |
106 | * ldlm_{extent,flock,inodebits,plain}.c. | |
107 | * | |
108 | * There are six lock modes along with a compatibility matrix to indicate if | |
109 | * two locks are compatible. | |
110 | * | |
111 | * - EX: Exclusive mode. Before a new file is created, MDS requests EX lock | |
112 | * on the parent. | |
113 | * - PW: Protective Write (normal write) mode. When a client requests a write | |
114 | * lock from an OST, a lock with PW mode will be issued. | |
115 | * - PR: Protective Read (normal read) mode. When a client requests a read from | |
116 | * an OST, a lock with PR mode will be issued. Also, if the client opens a | |
117 | * file for execution, it is granted a lock with PR mode. | |
118 | * - CW: Concurrent Write mode. The type of lock that the MDS grants if a client | |
119 | * requests a write lock during a file open operation. | |
120 | * - CR Concurrent Read mode. When a client performs a path lookup, MDS grants | |
121 | * an inodebit lock with the CR mode on the intermediate path component. | |
122 | * - NL Null mode. | |
123 | * | |
124 | * <PRE> | |
125 | * NL CR CW PR PW EX | |
126 | * NL 1 1 1 1 1 1 | |
127 | * CR 1 1 1 1 1 0 | |
128 | * CW 1 1 1 0 0 0 | |
129 | * PR 1 1 0 1 0 0 | |
130 | * PW 1 1 0 0 0 0 | |
131 | * EX 1 0 0 0 0 0 | |
132 | * </PRE> | |
133 | */ | |
134 | /** @{ */ | |
135 | #define LCK_COMPAT_EX LCK_NL | |
136 | #define LCK_COMPAT_PW (LCK_COMPAT_EX | LCK_CR) | |
137 | #define LCK_COMPAT_PR (LCK_COMPAT_PW | LCK_PR) | |
138 | #define LCK_COMPAT_CW (LCK_COMPAT_PW | LCK_CW) | |
139 | #define LCK_COMPAT_CR (LCK_COMPAT_CW | LCK_PR | LCK_PW) | |
140 | #define LCK_COMPAT_NL (LCK_COMPAT_CR | LCK_EX | LCK_GROUP) | |
141 | #define LCK_COMPAT_GROUP (LCK_GROUP | LCK_NL) | |
142 | #define LCK_COMPAT_COS (LCK_COS) | |
143 | /** @} Lock Compatibility Matrix */ | |
144 | ||
52ee0d20 | 145 | extern enum ldlm_mode lck_compat_array[]; |
d7e09d03 | 146 | |
52ee0d20 | 147 | static inline void lockmode_verify(enum ldlm_mode mode) |
d7e09d03 | 148 | { |
22ea97f0 | 149 | LASSERT(mode > LCK_MINMODE && mode < LCK_MAXMODE); |
d7e09d03 PT |
150 | } |
151 | ||
52ee0d20 OD |
152 | static inline int lockmode_compat(enum ldlm_mode exist_mode, |
153 | enum ldlm_mode new_mode) | |
d7e09d03 | 154 | { |
22ea97f0 | 155 | return (lck_compat_array[exist_mode] & new_mode); |
d7e09d03 PT |
156 | } |
157 | ||
158 | /* | |
159 | * | |
160 | * cluster name spaces | |
161 | * | |
162 | */ | |
163 | ||
164 | #define DLM_OST_NAMESPACE 1 | |
165 | #define DLM_MDS_NAMESPACE 2 | |
166 | ||
167 | /* XXX | |
168 | - do we just separate this by security domains and use a prefix for | |
169 | multiple namespaces in the same domain? | |
170 | - | |
171 | */ | |
172 | ||
173 | /** | |
174 | * Locking rules for LDLM: | |
175 | * | |
176 | * lr_lock | |
177 | * | |
178 | * lr_lock | |
179 | * waiting_locks_spinlock | |
180 | * | |
181 | * lr_lock | |
182 | * led_lock | |
183 | * | |
184 | * lr_lock | |
185 | * ns_lock | |
186 | * | |
187 | * lr_lvb_mutex | |
188 | * lr_lock | |
189 | * | |
190 | */ | |
191 | ||
192 | struct ldlm_pool; | |
193 | struct ldlm_lock; | |
194 | struct ldlm_resource; | |
195 | struct ldlm_namespace; | |
196 | ||
197 | /** | |
198 | * Operations on LDLM pools. | |
199 | * LDLM pool is a pool of locks in the namespace without any implicitly | |
200 | * specified limits. | |
201 | * Locks in the pool are organized in LRU. | |
202 | * Local memory pressure or server instructions (e.g. mempressure on server) | |
203 | * can trigger freeing of locks from the pool | |
204 | */ | |
205 | struct ldlm_pool_ops { | |
206 | /** Recalculate pool \a pl usage */ | |
207 | int (*po_recalc)(struct ldlm_pool *pl); | |
208 | /** Cancel at least \a nr locks from pool \a pl */ | |
209 | int (*po_shrink)(struct ldlm_pool *pl, int nr, | |
5802572e | 210 | gfp_t gfp_mask); |
d7e09d03 PT |
211 | }; |
212 | ||
213 | /** One second for pools thread check interval. Each pool has own period. */ | |
214 | #define LDLM_POOLS_THREAD_PERIOD (1) | |
215 | ||
216 | /** ~6% margin for modest pools. See ldlm_pool.c for details. */ | |
217 | #define LDLM_POOLS_MODEST_MARGIN_SHIFT (4) | |
218 | ||
219 | /** Default recalc period for server side pools in sec. */ | |
220 | #define LDLM_POOL_SRV_DEF_RECALC_PERIOD (1) | |
221 | ||
222 | /** Default recalc period for client side pools in sec. */ | |
223 | #define LDLM_POOL_CLI_DEF_RECALC_PERIOD (10) | |
224 | ||
225 | /** | |
226 | * LDLM pool structure to track granted locks. | |
227 | * For purposes of determining when to release locks on e.g. memory pressure. | |
228 | * This feature is commonly referred to as lru_resize. | |
229 | */ | |
230 | struct ldlm_pool { | |
700815d4 DE |
231 | /** Pool debugfs directory. */ |
232 | struct dentry *pl_debugfs_entry; | |
d7e09d03 PT |
233 | /** Pool name, must be long enough to hold compound proc entry name. */ |
234 | char pl_name[100]; | |
235 | /** Lock for protecting SLV/CLV updates. */ | |
236 | spinlock_t pl_lock; | |
237 | /** Number of allowed locks in in pool, both, client and server side. */ | |
238 | atomic_t pl_limit; | |
239 | /** Number of granted locks in */ | |
240 | atomic_t pl_granted; | |
241 | /** Grant rate per T. */ | |
242 | atomic_t pl_grant_rate; | |
243 | /** Cancel rate per T. */ | |
244 | atomic_t pl_cancel_rate; | |
245 | /** Server lock volume (SLV). Protected by pl_lock. */ | |
246 | __u64 pl_server_lock_volume; | |
247 | /** Current biggest client lock volume. Protected by pl_lock. */ | |
248 | __u64 pl_client_lock_volume; | |
249 | /** Lock volume factor. SLV on client is calculated as following: | |
c56e256d OD |
250 | * server_slv * lock_volume_factor. |
251 | */ | |
d7e09d03 PT |
252 | atomic_t pl_lock_volume_factor; |
253 | /** Time when last SLV from server was obtained. */ | |
8f83409c | 254 | time64_t pl_recalc_time; |
d7e09d03 | 255 | /** Recalculation period for pool. */ |
8f83409c | 256 | time64_t pl_recalc_period; |
d7e09d03 | 257 | /** Recalculation and shrink operations. */ |
b9c98cfa | 258 | const struct ldlm_pool_ops *pl_ops; |
d7e09d03 PT |
259 | /** Number of planned locks for next period. */ |
260 | int pl_grant_plan; | |
261 | /** Pool statistics. */ | |
262 | struct lprocfs_stats *pl_stats; | |
f2825e03 OD |
263 | |
264 | /* sysfs object */ | |
265 | struct kobject pl_kobj; | |
266 | struct completion pl_kobj_unregister; | |
d7e09d03 PT |
267 | }; |
268 | ||
7d443334 | 269 | typedef int (*ldlm_cancel_cbt)(struct ldlm_lock *lock); |
d7e09d03 PT |
270 | |
271 | /** | |
272 | * LVB operations. | |
273 | * LVB is Lock Value Block. This is a special opaque (to LDLM) value that could | |
274 | * be associated with an LDLM lock and transferred from client to server and | |
275 | * back. | |
276 | * | |
277 | * Currently LVBs are used by: | |
278 | * - OSC-OST code to maintain current object size/times | |
279 | * - layout lock code to return the layout when the layout lock is granted | |
280 | */ | |
281 | struct ldlm_valblock_ops { | |
282 | int (*lvbo_init)(struct ldlm_resource *res); | |
283 | int (*lvbo_update)(struct ldlm_resource *res, | |
284 | struct ptlrpc_request *r, | |
285 | int increase); | |
286 | int (*lvbo_free)(struct ldlm_resource *res); | |
287 | /* Return size of lvb data appropriate RPC size can be reserved */ | |
288 | int (*lvbo_size)(struct ldlm_lock *lock); | |
289 | /* Called to fill in lvb data to RPC buffer @buf */ | |
290 | int (*lvbo_fill)(struct ldlm_lock *lock, void *buf, int buflen); | |
291 | }; | |
292 | ||
293 | /** | |
294 | * LDLM pools related, type of lock pool in the namespace. | |
295 | * Greedy means release cached locks aggressively | |
296 | */ | |
4d0d6b0e | 297 | enum ldlm_appetite { |
d7e09d03 PT |
298 | LDLM_NAMESPACE_GREEDY = 1 << 0, |
299 | LDLM_NAMESPACE_MODEST = 1 << 1 | |
4d0d6b0e | 300 | }; |
d7e09d03 | 301 | |
d7e09d03 PT |
302 | struct ldlm_ns_bucket { |
303 | /** back pointer to namespace */ | |
304 | struct ldlm_namespace *nsb_namespace; | |
305 | /** | |
306 | * Estimated lock callback time. Used by adaptive timeout code to | |
307 | * avoid spurious client evictions due to unresponsiveness when in | |
308 | * fact the network or overall system load is at fault | |
309 | */ | |
310 | struct adaptive_timeout nsb_at_estimate; | |
311 | }; | |
312 | ||
313 | enum { | |
314 | /** LDLM namespace lock stats */ | |
315 | LDLM_NSS_LOCKS = 0, | |
316 | LDLM_NSS_LAST | |
317 | }; | |
318 | ||
87ba6ebf | 319 | enum ldlm_ns_type { |
bd9070cb | 320 | /** invalid type */ |
d7e09d03 PT |
321 | LDLM_NS_TYPE_UNKNOWN = 0, |
322 | /** mdc namespace */ | |
323 | LDLM_NS_TYPE_MDC, | |
324 | /** mds namespace */ | |
325 | LDLM_NS_TYPE_MDT, | |
326 | /** osc namespace */ | |
327 | LDLM_NS_TYPE_OSC, | |
328 | /** ost namespace */ | |
329 | LDLM_NS_TYPE_OST, | |
330 | /** mgc namespace */ | |
331 | LDLM_NS_TYPE_MGC, | |
332 | /** mgs namespace */ | |
333 | LDLM_NS_TYPE_MGT, | |
87ba6ebf | 334 | }; |
d7e09d03 PT |
335 | |
336 | /** | |
337 | * LDLM Namespace. | |
338 | * | |
339 | * Namespace serves to contain locks related to a particular service. | |
340 | * There are two kinds of namespaces: | |
341 | * - Server namespace has knowledge of all locks and is therefore authoritative | |
342 | * to make decisions like what locks could be granted and what conflicts | |
343 | * exist during new lock enqueue. | |
344 | * - Client namespace only has limited knowledge about locks in the namespace, | |
345 | * only seeing locks held by the client. | |
346 | * | |
347 | * Every Lustre service has one server namespace present on the server serving | |
348 | * that service. Every client connected to the service has a client namespace | |
349 | * for it. | |
350 | * Every lock obtained by client in that namespace is actually represented by | |
351 | * two in-memory locks. One on the server and one on the client. The locks are | |
352 | * linked by a special cookie by which one node can tell to the other which lock | |
353 | * it actually means during communications. Such locks are called remote locks. | |
354 | * The locks held by server only without any reference to a client are called | |
355 | * local locks. | |
356 | */ | |
357 | struct ldlm_namespace { | |
358 | /** Backward link to OBD, required for LDLM pool to store new SLV. */ | |
359 | struct obd_device *ns_obd; | |
360 | ||
361 | /** Flag indicating if namespace is on client instead of server */ | |
362 | ldlm_side_t ns_client; | |
363 | ||
364 | /** Resource hash table for namespace. */ | |
6da6eabe | 365 | struct cfs_hash *ns_rs_hash; |
d7e09d03 PT |
366 | |
367 | /** serialize */ | |
368 | spinlock_t ns_lock; | |
369 | ||
370 | /** big refcount (by bucket) */ | |
371 | atomic_t ns_bref; | |
372 | ||
373 | /** | |
374 | * Namespace connect flags supported by server (may be changed via | |
f6e42a40 | 375 | * sysfs, LRU resize may be disabled/enabled). |
d7e09d03 PT |
376 | */ |
377 | __u64 ns_connect_flags; | |
378 | ||
379 | /** Client side original connect flags supported by server. */ | |
380 | __u64 ns_orig_connect_flags; | |
381 | ||
700815d4 DE |
382 | /* namespace debugfs dir entry */ |
383 | struct dentry *ns_debugfs_entry; | |
73bb1da6 | 384 | |
d7e09d03 PT |
385 | /** |
386 | * Position in global namespace list linking all namespaces on | |
387 | * the node. | |
388 | */ | |
389 | struct list_head ns_list_chain; | |
390 | ||
391 | /** | |
392 | * List of unused locks for this namespace. This list is also called | |
393 | * LRU lock list. | |
394 | * Unused locks are locks with zero reader/writer reference counts. | |
395 | * This list is only used on clients for lock caching purposes. | |
396 | * When we want to release some locks voluntarily or if server wants | |
397 | * us to release some locks due to e.g. memory pressure, we take locks | |
398 | * to release from the head of this list. | |
399 | * Locks are linked via l_lru field in \see struct ldlm_lock. | |
400 | */ | |
401 | struct list_head ns_unused_list; | |
402 | /** Number of locks in the LRU list above */ | |
403 | int ns_nr_unused; | |
404 | ||
405 | /** | |
406 | * Maximum number of locks permitted in the LRU. If 0, means locks | |
407 | * are managed by pools and there is no preset limit, rather it is all | |
408 | * controlled by available memory on this client and on server. | |
409 | */ | |
410 | unsigned int ns_max_unused; | |
411 | /** Maximum allowed age (last used time) for locks in the LRU */ | |
412 | unsigned int ns_max_age; | |
d7e09d03 PT |
413 | |
414 | /** | |
415 | * Used to rate-limit ldlm_namespace_dump calls. | |
416 | * \see ldlm_namespace_dump. Increased by 10 seconds every time | |
417 | * it is called. | |
418 | */ | |
a649ad1d | 419 | unsigned long ns_next_dump; |
d7e09d03 | 420 | |
d7e09d03 PT |
421 | /** |
422 | * LVB operations for this namespace. | |
423 | * \see struct ldlm_valblock_ops | |
424 | */ | |
425 | struct ldlm_valblock_ops *ns_lvbo; | |
426 | ||
427 | /** | |
428 | * Used by filter code to store pointer to OBD of the service. | |
429 | * Should be dropped in favor of \a ns_obd | |
430 | */ | |
431 | void *ns_lvbp; | |
432 | ||
433 | /** | |
434 | * Wait queue used by __ldlm_namespace_free. Gets woken up every time | |
435 | * a resource is removed. | |
436 | */ | |
437 | wait_queue_head_t ns_waitq; | |
438 | /** LDLM pool structure for this namespace */ | |
439 | struct ldlm_pool ns_pool; | |
440 | /** Definition of how eagerly unused locks will be released from LRU */ | |
4d0d6b0e | 441 | enum ldlm_appetite ns_appetite; |
d7e09d03 | 442 | |
d7e09d03 PT |
443 | /** Limit of parallel AST RPC count. */ |
444 | unsigned ns_max_parallel_ast; | |
445 | ||
7d443334 JX |
446 | /** |
447 | * Callback to check if a lock is good to be canceled by ELC or | |
448 | * during recovery. | |
449 | */ | |
450 | ldlm_cancel_cbt ns_cancel; | |
d7e09d03 PT |
451 | |
452 | /** LDLM lock stats */ | |
453 | struct lprocfs_stats *ns_stats; | |
454 | ||
455 | /** | |
456 | * Flag to indicate namespace is being freed. Used to determine if | |
457 | * recalculation of LDLM pool statistics should be skipped. | |
458 | */ | |
459 | unsigned ns_stopping:1; | |
18fd8850 OD |
460 | |
461 | struct kobject ns_kobj; /* sysfs object */ | |
462 | struct completion ns_kobj_unregister; | |
d7e09d03 PT |
463 | }; |
464 | ||
d7e09d03 PT |
465 | /** |
466 | * Returns 1 if namespace \a ns supports early lock cancel (ELC). | |
467 | */ | |
468 | static inline int ns_connect_cancelset(struct ldlm_namespace *ns) | |
469 | { | |
d7e09d03 PT |
470 | return !!(ns->ns_connect_flags & OBD_CONNECT_CANCELSET); |
471 | } | |
472 | ||
473 | /** | |
474 | * Returns 1 if this namespace supports lru_resize. | |
475 | */ | |
476 | static inline int ns_connect_lru_resize(struct ldlm_namespace *ns) | |
477 | { | |
d7e09d03 PT |
478 | return !!(ns->ns_connect_flags & OBD_CONNECT_LRU_RESIZE); |
479 | } | |
480 | ||
481 | static inline void ns_register_cancel(struct ldlm_namespace *ns, | |
7d443334 | 482 | ldlm_cancel_cbt arg) |
d7e09d03 | 483 | { |
7d443334 | 484 | ns->ns_cancel = arg; |
d7e09d03 PT |
485 | } |
486 | ||
487 | struct ldlm_lock; | |
488 | ||
489 | /** Type for blocking callback function of a lock. */ | |
490 | typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock, | |
491 | struct ldlm_lock_desc *new, void *data, | |
492 | int flag); | |
493 | /** Type for completion callback function of a lock. */ | |
494 | typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, __u64 flags, | |
495 | void *data); | |
496 | /** Type for glimpse callback function of a lock. */ | |
497 | typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data); | |
d7e09d03 PT |
498 | |
499 | /** Work list for sending GL ASTs to multiple locks. */ | |
500 | struct ldlm_glimpse_work { | |
501 | struct ldlm_lock *gl_lock; /* lock to glimpse */ | |
502 | struct list_head gl_list; /* linkage to other gl work structs */ | |
503 | __u32 gl_flags;/* see LDLM_GL_WORK_* below */ | |
504 | union ldlm_gl_desc *gl_desc; /* glimpse descriptor to be packed in | |
c56e256d OD |
505 | * glimpse callback request |
506 | */ | |
d7e09d03 PT |
507 | }; |
508 | ||
509 | /** The ldlm_glimpse_work is allocated on the stack and should not be freed. */ | |
510 | #define LDLM_GL_WORK_NOFREE 0x1 | |
511 | ||
512 | /** Interval node data for each LDLM_EXTENT lock. */ | |
513 | struct ldlm_interval { | |
514 | struct interval_node li_node; /* node for tree management */ | |
c56e256d OD |
515 | struct list_head li_group; /* the locks which have the same |
516 | * policy - group of the policy | |
517 | */ | |
d7e09d03 | 518 | }; |
c9f6bb96 | 519 | |
d7e09d03 PT |
520 | #define to_ldlm_interval(n) container_of(n, struct ldlm_interval, li_node) |
521 | ||
522 | /** | |
523 | * Interval tree for extent locks. | |
524 | * The interval tree must be accessed under the resource lock. | |
525 | * Interval trees are used for granted extent locks to speed up conflicts | |
526 | * lookup. See ldlm/interval_tree.c for more details. | |
527 | */ | |
528 | struct ldlm_interval_tree { | |
529 | /** Tree size. */ | |
530 | int lit_size; | |
52ee0d20 | 531 | enum ldlm_mode lit_mode; /* lock mode */ |
d7e09d03 PT |
532 | struct interval_node *lit_root; /* actual ldlm_interval */ |
533 | }; | |
534 | ||
535 | /** Whether to track references to exports by LDLM locks. */ | |
536 | #define LUSTRE_TRACKS_LOCK_EXP_REFS (0) | |
537 | ||
538 | /** Cancel flags. */ | |
f833ee42 | 539 | enum ldlm_cancel_flags { |
d7e09d03 PT |
540 | LCF_ASYNC = 0x1, /* Cancel locks asynchronously. */ |
541 | LCF_LOCAL = 0x2, /* Cancel locks locally, not notifing server */ | |
542 | LCF_BL_AST = 0x4, /* Cancel locks marked as LDLM_FL_BL_AST | |
c56e256d OD |
543 | * in the same RPC |
544 | */ | |
f833ee42 | 545 | }; |
d7e09d03 PT |
546 | |
547 | struct ldlm_flock { | |
548 | __u64 start; | |
549 | __u64 end; | |
550 | __u64 owner; | |
551 | __u64 blocking_owner; | |
552 | struct obd_export *blocking_export; | |
553 | /* Protected by the hash lock */ | |
554 | __u32 blocking_refs; | |
555 | __u32 pid; | |
556 | }; | |
557 | ||
558 | typedef union { | |
559 | struct ldlm_extent l_extent; | |
560 | struct ldlm_flock l_flock; | |
561 | struct ldlm_inodebits l_inodebits; | |
562 | } ldlm_policy_data_t; | |
563 | ||
52ee0d20 | 564 | void ldlm_convert_policy_to_local(struct obd_export *exp, enum ldlm_type type, |
d7e09d03 PT |
565 | const ldlm_wire_policy_data_t *wpolicy, |
566 | ldlm_policy_data_t *lpolicy); | |
567 | ||
568 | enum lvb_type { | |
569 | LVB_T_NONE = 0, | |
570 | LVB_T_OST = 1, | |
571 | LVB_T_LQUOTA = 2, | |
572 | LVB_T_LAYOUT = 3, | |
573 | }; | |
574 | ||
575 | /** | |
576 | * LDLM lock structure | |
577 | * | |
578 | * Represents a single LDLM lock and its state in memory. Each lock is | |
579 | * associated with a single ldlm_resource, the object which is being | |
580 | * locked. There may be multiple ldlm_locks on a single resource, | |
581 | * depending on the lock type and whether the locks are conflicting or | |
582 | * not. | |
583 | */ | |
584 | struct ldlm_lock { | |
585 | /** | |
586 | * Local lock handle. | |
587 | * When remote side wants to tell us about a lock, they address | |
588 | * it by this opaque handle. The handle does not hold a | |
589 | * reference on the ldlm_lock, so it can be safely passed to | |
590 | * other threads or nodes. When the lock needs to be accessed | |
591 | * from the handle, it is looked up again in the lock table, and | |
592 | * may no longer exist. | |
593 | * | |
594 | * Must be first in the structure. | |
595 | */ | |
596 | struct portals_handle l_handle; | |
597 | /** | |
598 | * Lock reference count. | |
599 | * This is how many users have pointers to actual structure, so that | |
600 | * we do not accidentally free lock structure that is in use. | |
601 | */ | |
602 | atomic_t l_refc; | |
603 | /** | |
604 | * Internal spinlock protects l_resource. We should hold this lock | |
605 | * first before taking res_lock. | |
606 | */ | |
607 | spinlock_t l_lock; | |
608 | /** | |
609 | * Pointer to actual resource this lock is in. | |
610 | * ldlm_lock_change_resource() can change this. | |
611 | */ | |
612 | struct ldlm_resource *l_resource; | |
613 | /** | |
614 | * List item for client side LRU list. | |
615 | * Protected by ns_lock in struct ldlm_namespace. | |
616 | */ | |
617 | struct list_head l_lru; | |
618 | /** | |
619 | * Linkage to resource's lock queues according to current lock state. | |
620 | * (could be granted, waiting or converting) | |
621 | * Protected by lr_lock in struct ldlm_resource. | |
622 | */ | |
623 | struct list_head l_res_link; | |
624 | /** | |
625 | * Tree node for ldlm_extent. | |
626 | */ | |
627 | struct ldlm_interval *l_tree_node; | |
628 | /** | |
629 | * Per export hash of locks. | |
630 | * Protected by per-bucket exp->exp_lock_hash locks. | |
631 | */ | |
632 | struct hlist_node l_exp_hash; | |
633 | /** | |
634 | * Per export hash of flock locks. | |
635 | * Protected by per-bucket exp->exp_flock_hash locks. | |
636 | */ | |
637 | struct hlist_node l_exp_flock_hash; | |
638 | /** | |
639 | * Requested mode. | |
640 | * Protected by lr_lock. | |
641 | */ | |
52ee0d20 | 642 | enum ldlm_mode l_req_mode; |
d7e09d03 PT |
643 | /** |
644 | * Granted mode, also protected by lr_lock. | |
645 | */ | |
52ee0d20 | 646 | enum ldlm_mode l_granted_mode; |
d7e09d03 PT |
647 | /** Lock completion handler pointer. Called when lock is granted. */ |
648 | ldlm_completion_callback l_completion_ast; | |
649 | /** | |
650 | * Lock blocking AST handler pointer. | |
651 | * It plays two roles: | |
652 | * - as a notification of an attempt to queue a conflicting lock (once) | |
653 | * - as a notification when the lock is being cancelled. | |
654 | * | |
655 | * As such it's typically called twice: once for the initial conflict | |
656 | * and then once more when the last user went away and the lock is | |
657 | * cancelled (could happen recursively). | |
658 | */ | |
659 | ldlm_blocking_callback l_blocking_ast; | |
660 | /** | |
661 | * Lock glimpse handler. | |
662 | * Glimpse handler is used to obtain LVB updates from a client by | |
663 | * server | |
664 | */ | |
665 | ldlm_glimpse_callback l_glimpse_ast; | |
666 | ||
d7e09d03 PT |
667 | /** |
668 | * Lock export. | |
669 | * This is a pointer to actual client export for locks that were granted | |
670 | * to clients. Used server-side. | |
671 | */ | |
672 | struct obd_export *l_export; | |
673 | /** | |
674 | * Lock connection export. | |
675 | * Pointer to server export on a client. | |
676 | */ | |
677 | struct obd_export *l_conn_export; | |
678 | ||
679 | /** | |
680 | * Remote lock handle. | |
681 | * If the lock is remote, this is the handle of the other side lock | |
682 | * (l_handle) | |
683 | */ | |
684 | struct lustre_handle l_remote_handle; | |
685 | ||
686 | /** | |
687 | * Representation of private data specific for a lock type. | |
688 | * Examples are: extent range for extent lock or bitmask for ibits locks | |
689 | */ | |
690 | ldlm_policy_data_t l_policy_data; | |
691 | ||
692 | /** | |
f2145eae BK |
693 | * Lock state flags. Protected by lr_lock. |
694 | * \see lustre_dlm_flags.h where the bits are defined. | |
d7e09d03 PT |
695 | */ |
696 | __u64 l_flags; | |
f2145eae | 697 | |
d7e09d03 PT |
698 | /** |
699 | * Lock r/w usage counters. | |
700 | * Protected by lr_lock. | |
701 | */ | |
702 | __u32 l_readers; | |
703 | __u32 l_writers; | |
704 | /** | |
705 | * If the lock is granted, a process sleeps on this waitq to learn when | |
706 | * it's no longer in use. If the lock is not granted, a process sleeps | |
707 | * on this waitq to learn when it becomes granted. | |
708 | */ | |
709 | wait_queue_head_t l_waitq; | |
710 | ||
711 | /** | |
712 | * Seconds. It will be updated if there is any activity related to | |
713 | * the lock, e.g. enqueue the lock or send blocking AST. | |
714 | */ | |
bf6d2153 | 715 | time64_t l_last_activity; |
d7e09d03 PT |
716 | |
717 | /** | |
718 | * Time last used by e.g. being matched by lock match. | |
719 | * Jiffies. Should be converted to time if needed. | |
720 | */ | |
a649ad1d | 721 | unsigned long l_last_used; |
d7e09d03 PT |
722 | |
723 | /** Originally requested extent for the extent lock. */ | |
724 | struct ldlm_extent l_req_extent; | |
725 | ||
d7e09d03 PT |
726 | /* |
727 | * Client-side-only members. | |
728 | */ | |
729 | ||
730 | enum lvb_type l_lvb_type; | |
731 | ||
732 | /** | |
733 | * Temporary storage for a LVB received during an enqueue operation. | |
734 | */ | |
735 | __u32 l_lvb_len; | |
736 | void *l_lvb_data; | |
737 | ||
738 | /** Private storage for lock user. Opaque to LDLM. */ | |
739 | void *l_ast_data; | |
740 | ||
741 | /* | |
742 | * Server-side-only members. | |
743 | */ | |
744 | ||
745 | /** | |
746 | * Connection cookie for the client originating the operation. | |
747 | * Used by Commit on Share (COS) code. Currently only used for | |
748 | * inodebits locks on MDS. | |
749 | */ | |
750 | __u64 l_client_cookie; | |
751 | ||
752 | /** | |
753 | * List item for locks waiting for cancellation from clients. | |
754 | * The lists this could be linked into are: | |
755 | * waiting_locks_list (protected by waiting_locks_spinlock), | |
756 | * then if the lock timed out, it is moved to | |
757 | * expired_lock_thread.elt_expired_locks for further processing. | |
758 | * Protected by elt_lock. | |
759 | */ | |
760 | struct list_head l_pending_chain; | |
761 | ||
762 | /** | |
763 | * Set when lock is sent a blocking AST. Time in seconds when timeout | |
764 | * is reached and client holding this lock could be evicted. | |
765 | * This timeout could be further extended by e.g. certain IO activity | |
766 | * under this lock. | |
767 | * \see ost_rw_prolong_locks | |
768 | */ | |
a649ad1d | 769 | unsigned long l_callback_timeout; |
d7e09d03 PT |
770 | |
771 | /** Local PID of process which created this lock. */ | |
772 | __u32 l_pid; | |
773 | ||
774 | /** | |
775 | * Number of times blocking AST was sent for this lock. | |
776 | * This is for debugging. Valid values are 0 and 1, if there is an | |
777 | * attempt to send blocking AST more than once, an assertion would be | |
778 | * hit. \see ldlm_work_bl_ast_lock | |
779 | */ | |
780 | int l_bl_ast_run; | |
781 | /** List item ldlm_add_ast_work_item() for case of blocking ASTs. */ | |
782 | struct list_head l_bl_ast; | |
783 | /** List item ldlm_add_ast_work_item() for case of completion ASTs. */ | |
784 | struct list_head l_cp_ast; | |
785 | /** For ldlm_add_ast_work_item() for "revoke" AST used in COS. */ | |
786 | struct list_head l_rk_ast; | |
787 | ||
788 | /** | |
789 | * Pointer to a conflicting lock that caused blocking AST to be sent | |
790 | * for this lock | |
791 | */ | |
792 | struct ldlm_lock *l_blocking_lock; | |
793 | ||
794 | /** | |
795 | * Protected by lr_lock, linkages to "skip lists". | |
796 | * For more explanations of skip lists see ldlm/ldlm_inodebits.c | |
797 | */ | |
798 | struct list_head l_sl_mode; | |
799 | struct list_head l_sl_policy; | |
800 | ||
801 | /** Reference tracking structure to debug leaked locks. */ | |
802 | struct lu_ref l_reference; | |
803 | #if LUSTRE_TRACKS_LOCK_EXP_REFS | |
804 | /* Debugging stuff for bug 20498, for tracking export references. */ | |
805 | /** number of export references taken */ | |
806 | int l_exp_refs_nr; | |
807 | /** link all locks referencing one export */ | |
808 | struct list_head l_exp_refs_link; | |
809 | /** referenced export object */ | |
810 | struct obd_export *l_exp_refs_target; | |
811 | #endif | |
812 | /** | |
813 | * export blocking dlm lock list, protected by | |
814 | * l_export->exp_bl_list_lock. | |
815 | * Lock order of waiting_lists_spinlock, exp_bl_list_lock and res lock | |
816 | * is: res lock -> exp_bl_list_lock -> wanting_lists_spinlock. | |
817 | */ | |
818 | struct list_head l_exp_list; | |
819 | }; | |
820 | ||
821 | /** | |
822 | * LDLM resource description. | |
823 | * Basically, resource is a representation for a single object. | |
824 | * Object has a name which is currently 4 64-bit integers. LDLM user is | |
825 | * responsible for creation of a mapping between objects it wants to be | |
826 | * protected and resource names. | |
827 | * | |
828 | * A resource can only hold locks of a single lock type, though there may be | |
829 | * multiple ldlm_locks on a single resource, depending on the lock type and | |
830 | * whether the locks are conflicting or not. | |
831 | */ | |
832 | struct ldlm_resource { | |
833 | struct ldlm_ns_bucket *lr_ns_bucket; | |
834 | ||
835 | /** | |
836 | * List item for list in namespace hash. | |
837 | * protected by ns_lock | |
838 | */ | |
839 | struct hlist_node lr_hash; | |
840 | ||
841 | /** Spinlock to protect locks under this resource. */ | |
842 | spinlock_t lr_lock; | |
843 | ||
844 | /** | |
845 | * protected by lr_lock | |
c56e256d OD |
846 | * @{ |
847 | */ | |
d7e09d03 PT |
848 | /** List of locks in granted state */ |
849 | struct list_head lr_granted; | |
d7e09d03 PT |
850 | /** |
851 | * List of locks that could not be granted due to conflicts and | |
c56e256d OD |
852 | * that are waiting for conflicts to go away |
853 | */ | |
d7e09d03 PT |
854 | struct list_head lr_waiting; |
855 | /** @} */ | |
856 | ||
d7e09d03 | 857 | /** Type of locks this resource can hold. Only one type per resource. */ |
52ee0d20 | 858 | enum ldlm_type lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK,IBITS} */ |
d7e09d03 PT |
859 | |
860 | /** Resource name */ | |
861 | struct ldlm_res_id lr_name; | |
862 | /** Reference count for this resource */ | |
863 | atomic_t lr_refcount; | |
864 | ||
865 | /** | |
866 | * Interval trees (only for extent locks) for all modes of this resource | |
867 | */ | |
868 | struct ldlm_interval_tree lr_itree[LCK_MODE_NUM]; | |
869 | ||
870 | /** | |
871 | * Server-side-only lock value block elements. | |
872 | * To serialize lvbo_init. | |
873 | */ | |
874 | struct mutex lr_lvb_mutex; | |
875 | int lr_lvb_len; | |
d7e09d03 PT |
876 | |
877 | /** When the resource was considered as contended. */ | |
a649ad1d | 878 | unsigned long lr_contention_time; |
d7e09d03 PT |
879 | /** List of references to this resource. For debugging. */ |
880 | struct lu_ref lr_reference; | |
881 | ||
882 | struct inode *lr_lvb_inode; | |
883 | }; | |
884 | ||
885 | static inline bool ldlm_has_layout(struct ldlm_lock *lock) | |
886 | { | |
887 | return lock->l_resource->lr_type == LDLM_IBITS && | |
888 | lock->l_policy_data.l_inodebits.bits & MDS_INODELOCK_LAYOUT; | |
889 | } | |
890 | ||
891 | static inline char * | |
892 | ldlm_ns_name(struct ldlm_namespace *ns) | |
893 | { | |
894 | return ns->ns_rs_hash->hs_name; | |
895 | } | |
896 | ||
897 | static inline struct ldlm_namespace * | |
898 | ldlm_res_to_ns(struct ldlm_resource *res) | |
899 | { | |
900 | return res->lr_ns_bucket->nsb_namespace; | |
901 | } | |
902 | ||
903 | static inline struct ldlm_namespace * | |
904 | ldlm_lock_to_ns(struct ldlm_lock *lock) | |
905 | { | |
906 | return ldlm_res_to_ns(lock->l_resource); | |
907 | } | |
908 | ||
909 | static inline char * | |
910 | ldlm_lock_to_ns_name(struct ldlm_lock *lock) | |
911 | { | |
912 | return ldlm_ns_name(ldlm_lock_to_ns(lock)); | |
913 | } | |
914 | ||
915 | static inline struct adaptive_timeout * | |
916 | ldlm_lock_to_ns_at(struct ldlm_lock *lock) | |
917 | { | |
918 | return &lock->l_resource->lr_ns_bucket->nsb_at_estimate; | |
919 | } | |
920 | ||
921 | static inline int ldlm_lvbo_init(struct ldlm_resource *res) | |
922 | { | |
923 | struct ldlm_namespace *ns = ldlm_res_to_ns(res); | |
924 | ||
d2a13989 | 925 | if (ns->ns_lvbo && ns->ns_lvbo->lvbo_init) |
d7e09d03 PT |
926 | return ns->ns_lvbo->lvbo_init(res); |
927 | ||
928 | return 0; | |
929 | } | |
930 | ||
931 | static inline int ldlm_lvbo_size(struct ldlm_lock *lock) | |
932 | { | |
933 | struct ldlm_namespace *ns = ldlm_lock_to_ns(lock); | |
934 | ||
d2a13989 | 935 | if (ns->ns_lvbo && ns->ns_lvbo->lvbo_size) |
d7e09d03 PT |
936 | return ns->ns_lvbo->lvbo_size(lock); |
937 | ||
938 | return 0; | |
939 | } | |
940 | ||
941 | static inline int ldlm_lvbo_fill(struct ldlm_lock *lock, void *buf, int len) | |
942 | { | |
943 | struct ldlm_namespace *ns = ldlm_lock_to_ns(lock); | |
944 | ||
d2a13989 | 945 | if (ns->ns_lvbo) |
d7e09d03 | 946 | return ns->ns_lvbo->lvbo_fill(lock, buf, len); |
d2a13989 | 947 | |
d7e09d03 PT |
948 | return 0; |
949 | } | |
950 | ||
951 | struct ldlm_ast_work { | |
952 | struct ldlm_lock *w_lock; | |
953 | int w_blocking; | |
954 | struct ldlm_lock_desc w_desc; | |
955 | struct list_head w_list; | |
956 | int w_flags; | |
957 | void *w_data; | |
958 | int w_datalen; | |
959 | }; | |
960 | ||
961 | /** | |
962 | * Common ldlm_enqueue parameters | |
963 | */ | |
964 | struct ldlm_enqueue_info { | |
965 | __u32 ei_type; /** Type of the lock being enqueued. */ | |
966 | __u32 ei_mode; /** Mode of the lock being enqueued. */ | |
967 | void *ei_cb_bl; /** blocking lock callback */ | |
968 | void *ei_cb_cp; /** lock completion callback */ | |
969 | void *ei_cb_gl; /** lock glimpse callback */ | |
d7e09d03 | 970 | void *ei_cbdata; /** Data to be passed into callbacks. */ |
75ac62fc | 971 | unsigned int ei_enq_slave:1; /* whether enqueue slave stripes */ |
d7e09d03 PT |
972 | }; |
973 | ||
974 | extern struct obd_ops ldlm_obd_ops; | |
975 | ||
976 | extern char *ldlm_lockname[]; | |
8150a97f | 977 | char *ldlm_it2str(int it); |
d7e09d03 PT |
978 | |
979 | /** | |
980 | * Just a fancy CDEBUG call with log level preset to LDLM_DEBUG. | |
981 | * For the cases where we do not have actual lock to print along | |
982 | * with a debugging message that is ldlm-related | |
983 | */ | |
984 | #define LDLM_DEBUG_NOLOCK(format, a...) \ | |
b2952d62 | 985 | CDEBUG(D_DLMTRACE, "### " format "\n", ##a) |
d7e09d03 PT |
986 | |
987 | /** | |
988 | * Support function for lock information printing into debug logs. | |
989 | * \see LDLM_DEBUG | |
990 | */ | |
991 | #define ldlm_lock_debug(msgdata, mask, cdls, lock, fmt, a...) do { \ | |
992 | CFS_CHECK_STACK(msgdata, mask, cdls); \ | |
993 | \ | |
994 | if (((mask) & D_CANTMASK) != 0 || \ | |
995 | ((libcfs_debug & (mask)) != 0 && \ | |
996 | (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \ | |
997 | _ldlm_lock_debug(lock, msgdata, fmt, ##a); \ | |
a58a38ac | 998 | } while (0) |
d7e09d03 PT |
999 | |
1000 | void _ldlm_lock_debug(struct ldlm_lock *lock, | |
1001 | struct libcfs_debug_msg_data *data, | |
1002 | const char *fmt, ...) | |
70837c12 | 1003 | __printf(3, 4); |
d7e09d03 PT |
1004 | |
1005 | /** | |
1006 | * Rate-limited version of lock printing function. | |
1007 | */ | |
1008 | #define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) do { \ | |
a3ea59e0 | 1009 | static struct cfs_debug_limit_state _ldlm_cdls; \ |
d7e09d03 | 1010 | LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, &_ldlm_cdls); \ |
b2952d62 | 1011 | ldlm_lock_debug(&msgdata, mask, &_ldlm_cdls, lock, "### " fmt, ##a);\ |
d7e09d03 PT |
1012 | } while (0) |
1013 | ||
1014 | #define LDLM_ERROR(lock, fmt, a...) LDLM_DEBUG_LIMIT(D_ERROR, lock, fmt, ## a) | |
1015 | #define LDLM_WARN(lock, fmt, a...) LDLM_DEBUG_LIMIT(D_WARNING, lock, fmt, ## a) | |
1016 | ||
1017 | /** Non-rate-limited lock printing function for debugging purposes. */ | |
1018 | #define LDLM_DEBUG(lock, fmt, a...) do { \ | |
d2a13989 | 1019 | if (likely(lock)) { \ |
d7e09d03 PT |
1020 | LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_DLMTRACE, NULL); \ |
1021 | ldlm_lock_debug(&msgdata, D_DLMTRACE, NULL, lock, \ | |
b2952d62 | 1022 | "### " fmt, ##a); \ |
d7e09d03 PT |
1023 | } else { \ |
1024 | LDLM_DEBUG_NOLOCK("no dlm lock: " fmt, ##a); \ | |
1025 | } \ | |
1026 | } while (0) | |
1027 | ||
1028 | typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, __u64 *flags, | |
d1777aa9 | 1029 | int first_enq, enum ldlm_error *err, |
d7e09d03 PT |
1030 | struct list_head *work_list); |
1031 | ||
1032 | /** | |
1033 | * Return values for lock iterators. | |
1034 | * Also used during deciding of lock grants and cancellations. | |
1035 | */ | |
1036 | #define LDLM_ITER_CONTINUE 1 /* keep iterating */ | |
1037 | #define LDLM_ITER_STOP 2 /* stop iterating */ | |
1038 | ||
1039 | typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *); | |
1040 | typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *); | |
1041 | ||
1042 | /** \defgroup ldlm_iterator Lock iterators | |
1043 | * | |
1044 | * LDLM provides for a way to iterate through every lock on a resource or | |
1045 | * namespace or every resource in a namespace. | |
c56e256d OD |
1046 | * @{ |
1047 | */ | |
d7e09d03 PT |
1048 | int ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *, |
1049 | ldlm_iterator_t iter, void *data); | |
1050 | /** @} ldlm_iterator */ | |
1051 | ||
1052 | int ldlm_replay_locks(struct obd_import *imp); | |
1053 | ||
1054 | /* ldlm_flock.c */ | |
1055 | int ldlm_flock_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data); | |
1056 | ||
1057 | /* ldlm_extent.c */ | |
1058 | __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms); | |
1059 | ||
1060 | struct ldlm_callback_suite { | |
1061 | ldlm_completion_callback lcs_completion; | |
1062 | ldlm_blocking_callback lcs_blocking; | |
1063 | ldlm_glimpse_callback lcs_glimpse; | |
d7e09d03 PT |
1064 | }; |
1065 | ||
1066 | /* ldlm_lockd.c */ | |
d7e09d03 PT |
1067 | int ldlm_get_ref(void); |
1068 | void ldlm_put_ref(void); | |
d7e09d03 PT |
1069 | struct ldlm_lock *ldlm_request_lock(struct ptlrpc_request *req); |
1070 | ||
1071 | /* ldlm_lock.c */ | |
d7e09d03 PT |
1072 | void ldlm_lock2handle(const struct ldlm_lock *lock, |
1073 | struct lustre_handle *lockh); | |
1074 | struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, __u64 flags); | |
1075 | void ldlm_cancel_callback(struct ldlm_lock *); | |
1076 | int ldlm_lock_remove_from_lru(struct ldlm_lock *); | |
e8beaf67 | 1077 | int ldlm_lock_set_data(const struct lustre_handle *lockh, void *data); |
d7e09d03 PT |
1078 | |
1079 | /** | |
1080 | * Obtain a lock reference by its handle. | |
1081 | */ | |
1082 | static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h) | |
1083 | { | |
1084 | return __ldlm_handle2lock(h, 0); | |
1085 | } | |
1086 | ||
1087 | #define LDLM_LOCK_REF_DEL(lock) \ | |
1088 | lu_ref_del(&lock->l_reference, "handle", current) | |
1089 | ||
1090 | static inline struct ldlm_lock * | |
1091 | ldlm_handle2lock_long(const struct lustre_handle *h, __u64 flags) | |
1092 | { | |
1093 | struct ldlm_lock *lock; | |
1094 | ||
1095 | lock = __ldlm_handle2lock(h, flags); | |
d2a13989 | 1096 | if (lock) |
d7e09d03 PT |
1097 | LDLM_LOCK_REF_DEL(lock); |
1098 | return lock; | |
1099 | } | |
1100 | ||
1101 | /** | |
1102 | * Update Lock Value Block Operations (LVBO) on a resource taking into account | |
17891183 | 1103 | * data from request \a r |
d7e09d03 PT |
1104 | */ |
1105 | static inline int ldlm_res_lvbo_update(struct ldlm_resource *res, | |
1106 | struct ptlrpc_request *r, int increase) | |
1107 | { | |
1108 | if (ldlm_res_to_ns(res)->ns_lvbo && | |
1109 | ldlm_res_to_ns(res)->ns_lvbo->lvbo_update) { | |
1110 | return ldlm_res_to_ns(res)->ns_lvbo->lvbo_update(res, r, | |
1111 | increase); | |
1112 | } | |
1113 | return 0; | |
1114 | } | |
1115 | ||
d1777aa9 | 1116 | int ldlm_error2errno(enum ldlm_error error); |
38c3f17f | 1117 | |
d7e09d03 PT |
1118 | #if LUSTRE_TRACKS_LOCK_EXP_REFS |
1119 | void ldlm_dump_export_locks(struct obd_export *exp); | |
1120 | #endif | |
1121 | ||
1122 | /** | |
1123 | * Release a temporary lock reference obtained by ldlm_handle2lock() or | |
1124 | * __ldlm_handle2lock(). | |
1125 | */ | |
1126 | #define LDLM_LOCK_PUT(lock) \ | |
1127 | do { \ | |
1128 | LDLM_LOCK_REF_DEL(lock); \ | |
1129 | /*LDLM_DEBUG((lock), "put");*/ \ | |
1130 | ldlm_lock_put(lock); \ | |
1131 | } while (0) | |
1132 | ||
1133 | /** | |
1134 | * Release a lock reference obtained by some other means (see | |
1135 | * LDLM_LOCK_PUT()). | |
1136 | */ | |
1137 | #define LDLM_LOCK_RELEASE(lock) \ | |
1138 | do { \ | |
1139 | /*LDLM_DEBUG((lock), "put");*/ \ | |
1140 | ldlm_lock_put(lock); \ | |
1141 | } while (0) | |
1142 | ||
1143 | #define LDLM_LOCK_GET(lock) \ | |
1144 | ({ \ | |
1145 | ldlm_lock_get(lock); \ | |
1146 | /*LDLM_DEBUG((lock), "get");*/ \ | |
1147 | lock; \ | |
1148 | }) | |
1149 | ||
1150 | #define ldlm_lock_list_put(head, member, count) \ | |
1151 | ({ \ | |
1152 | struct ldlm_lock *_lock, *_next; \ | |
1153 | int c = count; \ | |
1154 | list_for_each_entry_safe(_lock, _next, head, member) { \ | |
1155 | if (c-- == 0) \ | |
1156 | break; \ | |
1157 | list_del_init(&_lock->member); \ | |
1158 | LDLM_LOCK_RELEASE(_lock); \ | |
1159 | } \ | |
1160 | LASSERT(c <= 0); \ | |
1161 | }) | |
1162 | ||
1163 | struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock); | |
1164 | void ldlm_lock_put(struct ldlm_lock *lock); | |
d7e09d03 | 1165 | void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc); |
e8beaf67 JH |
1166 | void ldlm_lock_addref(const struct lustre_handle *lockh, __u32 mode); |
1167 | int ldlm_lock_addref_try(const struct lustre_handle *lockh, __u32 mode); | |
1168 | void ldlm_lock_decref(const struct lustre_handle *lockh, __u32 mode); | |
1169 | void ldlm_lock_decref_and_cancel(const struct lustre_handle *lockh, __u32 mode); | |
d7e09d03 | 1170 | void ldlm_lock_fail_match_locked(struct ldlm_lock *lock); |
d7e09d03 PT |
1171 | void ldlm_lock_allow_match(struct ldlm_lock *lock); |
1172 | void ldlm_lock_allow_match_locked(struct ldlm_lock *lock); | |
52ee0d20 OD |
1173 | enum ldlm_mode ldlm_lock_match(struct ldlm_namespace *ns, __u64 flags, |
1174 | const struct ldlm_res_id *, | |
1175 | enum ldlm_type type, ldlm_policy_data_t *, | |
1176 | enum ldlm_mode mode, struct lustre_handle *, | |
1177 | int unref); | |
e8beaf67 | 1178 | enum ldlm_mode ldlm_revalidate_lock_handle(const struct lustre_handle *lockh, |
52ee0d20 | 1179 | __u64 *bits); |
d7e09d03 | 1180 | void ldlm_lock_cancel(struct ldlm_lock *lock); |
e8beaf67 | 1181 | void ldlm_lock_dump_handle(int level, const struct lustre_handle *); |
d7e09d03 PT |
1182 | void ldlm_unlink_lock_skiplist(struct ldlm_lock *req); |
1183 | ||
1184 | /* resource.c */ | |
1185 | struct ldlm_namespace * | |
1186 | ldlm_namespace_new(struct obd_device *obd, char *name, | |
4d0d6b0e | 1187 | ldlm_side_t client, enum ldlm_appetite apt, |
87ba6ebf | 1188 | enum ldlm_ns_type ns_type); |
d7e09d03 | 1189 | int ldlm_namespace_cleanup(struct ldlm_namespace *ns, __u64 flags); |
d7e09d03 PT |
1190 | void ldlm_namespace_get(struct ldlm_namespace *ns); |
1191 | void ldlm_namespace_put(struct ldlm_namespace *ns); | |
700815d4 DE |
1192 | int ldlm_debugfs_setup(void); |
1193 | void ldlm_debugfs_cleanup(void); | |
d7e09d03 PT |
1194 | |
1195 | /* resource.c - internal */ | |
1196 | struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns, | |
1197 | struct ldlm_resource *parent, | |
1198 | const struct ldlm_res_id *, | |
52ee0d20 | 1199 | enum ldlm_type type, int create); |
d7e09d03 PT |
1200 | int ldlm_resource_putref(struct ldlm_resource *res); |
1201 | void ldlm_resource_add_lock(struct ldlm_resource *res, | |
1202 | struct list_head *head, | |
1203 | struct ldlm_lock *lock); | |
1204 | void ldlm_resource_unlink_lock(struct ldlm_lock *lock); | |
1205 | void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc); | |
1206 | void ldlm_dump_all_namespaces(ldlm_side_t client, int level); | |
1207 | void ldlm_namespace_dump(int level, struct ldlm_namespace *); | |
1208 | void ldlm_resource_dump(int level, struct ldlm_resource *); | |
1209 | int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *, | |
1210 | const struct ldlm_res_id *); | |
1211 | ||
1212 | #define LDLM_RESOURCE_ADDREF(res) do { \ | |
f9bd9c1a | 1213 | lu_ref_add_atomic(&(res)->lr_reference, __func__, current); \ |
d7e09d03 PT |
1214 | } while (0) |
1215 | ||
1216 | #define LDLM_RESOURCE_DELREF(res) do { \ | |
f9bd9c1a | 1217 | lu_ref_del(&(res)->lr_reference, __func__, current); \ |
d7e09d03 PT |
1218 | } while (0) |
1219 | ||
1220 | /* ldlm_request.c */ | |
d7e09d03 PT |
1221 | /** \defgroup ldlm_local_ast Default AST handlers for local locks |
1222 | * These AST handlers are typically used for server-side local locks and are | |
1223 | * also used by client-side lock handlers to perform minimum level base | |
1224 | * processing. | |
c56e256d OD |
1225 | * @{ |
1226 | */ | |
d7e09d03 PT |
1227 | int ldlm_completion_ast_async(struct ldlm_lock *lock, __u64 flags, void *data); |
1228 | int ldlm_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data); | |
1229 | /** @} ldlm_local_ast */ | |
1230 | ||
1231 | /** \defgroup ldlm_cli_api API to operate on locks from actual LDLM users. | |
1232 | * These are typically used by client and server (*_local versions) | |
1233 | * to obtain and release locks. | |
c56e256d OD |
1234 | * @{ |
1235 | */ | |
d7e09d03 PT |
1236 | int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp, |
1237 | struct ldlm_enqueue_info *einfo, | |
1238 | const struct ldlm_res_id *res_id, | |
1239 | ldlm_policy_data_t const *policy, __u64 *flags, | |
1240 | void *lvb, __u32 lvb_len, enum lvb_type lvb_type, | |
1241 | struct lustre_handle *lockh, int async); | |
1242 | int ldlm_prep_enqueue_req(struct obd_export *exp, | |
1243 | struct ptlrpc_request *req, | |
1244 | struct list_head *cancels, | |
1245 | int count); | |
1246 | int ldlm_prep_elc_req(struct obd_export *exp, | |
1247 | struct ptlrpc_request *req, | |
1248 | int version, int opc, int canceloff, | |
1249 | struct list_head *cancels, int count); | |
1250 | ||
d7e09d03 | 1251 | int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req, |
52ee0d20 OD |
1252 | enum ldlm_type type, __u8 with_policy, |
1253 | enum ldlm_mode mode, | |
d7e09d03 | 1254 | __u64 *flags, void *lvb, __u32 lvb_len, |
e8beaf67 | 1255 | const struct lustre_handle *lockh, int rc); |
d7e09d03 | 1256 | int ldlm_cli_update_pool(struct ptlrpc_request *req); |
e8beaf67 | 1257 | int ldlm_cli_cancel(const struct lustre_handle *lockh, |
f833ee42 | 1258 | enum ldlm_cancel_flags cancel_flags); |
d7e09d03 | 1259 | int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *, |
f833ee42 | 1260 | enum ldlm_cancel_flags flags, void *opaque); |
d7e09d03 PT |
1261 | int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns, |
1262 | const struct ldlm_res_id *res_id, | |
1263 | ldlm_policy_data_t *policy, | |
52ee0d20 | 1264 | enum ldlm_mode mode, |
f833ee42 | 1265 | enum ldlm_cancel_flags flags, |
d7e09d03 | 1266 | void *opaque); |
d7e09d03 PT |
1267 | int ldlm_cancel_resource_local(struct ldlm_resource *res, |
1268 | struct list_head *cancels, | |
1269 | ldlm_policy_data_t *policy, | |
52ee0d20 | 1270 | enum ldlm_mode mode, __u64 lock_flags, |
f833ee42 OD |
1271 | enum ldlm_cancel_flags cancel_flags, |
1272 | void *opaque); | |
d7e09d03 | 1273 | int ldlm_cli_cancel_list_local(struct list_head *cancels, int count, |
f833ee42 | 1274 | enum ldlm_cancel_flags flags); |
d7e09d03 | 1275 | int ldlm_cli_cancel_list(struct list_head *head, int count, |
f833ee42 OD |
1276 | struct ptlrpc_request *req, |
1277 | enum ldlm_cancel_flags flags); | |
d7e09d03 PT |
1278 | /** @} ldlm_cli_api */ |
1279 | ||
1280 | /* mds/handler.c */ | |
1281 | /* This has to be here because recursive inclusion sucks. */ | |
1282 | int intent_disposition(struct ldlm_reply *rep, int flag); | |
1283 | void intent_set_disposition(struct ldlm_reply *rep, int flag); | |
1284 | ||
d7e09d03 PT |
1285 | /** |
1286 | * "Modes" of acquiring lock_res, necessary to tell lockdep that taking more | |
1287 | * than one lock_res is dead-lock safe. | |
1288 | */ | |
1289 | enum lock_res_type { | |
1290 | LRT_NORMAL, | |
1291 | LRT_NEW | |
1292 | }; | |
1293 | ||
1294 | /** Lock resource. */ | |
1295 | static inline void lock_res(struct ldlm_resource *res) | |
1296 | { | |
1297 | spin_lock(&res->lr_lock); | |
1298 | } | |
1299 | ||
1300 | /** Lock resource with a way to instruct lockdep code about nestedness-safe. */ | |
1301 | static inline void lock_res_nested(struct ldlm_resource *res, | |
1302 | enum lock_res_type mode) | |
1303 | { | |
1304 | spin_lock_nested(&res->lr_lock, mode); | |
1305 | } | |
1306 | ||
1307 | /** Unlock resource. */ | |
1308 | static inline void unlock_res(struct ldlm_resource *res) | |
1309 | { | |
1310 | spin_unlock(&res->lr_lock); | |
1311 | } | |
1312 | ||
1313 | /** Check if resource is already locked, assert if not. */ | |
1314 | static inline void check_res_locked(struct ldlm_resource *res) | |
1315 | { | |
5e42bc9d | 1316 | assert_spin_locked(&res->lr_lock); |
d7e09d03 PT |
1317 | } |
1318 | ||
54442610 | 1319 | struct ldlm_resource *lock_res_and_lock(struct ldlm_lock *lock); |
d7e09d03 PT |
1320 | void unlock_res_and_lock(struct ldlm_lock *lock); |
1321 | ||
1322 | /* ldlm_pool.c */ | |
1323 | /** \defgroup ldlm_pools Various LDLM pool related functions | |
1324 | * There are not used outside of ldlm. | |
1325 | * @{ | |
1326 | */ | |
d7e09d03 PT |
1327 | int ldlm_pools_init(void); |
1328 | void ldlm_pools_fini(void); | |
1329 | ||
1330 | int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns, | |
1331 | int idx, ldlm_side_t client); | |
d7e09d03 | 1332 | void ldlm_pool_fini(struct ldlm_pool *pl); |
d7e09d03 PT |
1333 | void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock); |
1334 | void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock); | |
1335 | /** @} */ | |
1336 | ||
1337 | #endif | |
1338 | /** @} LDLM */ |