Whamcloud - gitweb
LU-12616 obclass: fix MDS start/stop race
[fs/lustre-release.git] / lustre / ldlm / ldlm_internal.h
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
18  * http://www.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2017, Intel Corporation.
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 extern int ldlm_srv_namespace_nr;
34 extern int ldlm_cli_namespace_nr;
35 extern struct mutex ldlm_srv_namespace_lock;
36 extern struct list_head ldlm_srv_namespace_list;
37 extern struct mutex ldlm_cli_namespace_lock;
38 extern struct list_head ldlm_cli_active_namespace_list;
39 extern struct list_head ldlm_cli_inactive_namespace_list;
40 extern unsigned int ldlm_cancel_unused_locks_before_replay;
41 extern struct kmem_cache *ldlm_glimpse_work_kmem;
42
43 static inline int ldlm_namespace_nr_read(enum ldlm_side client)
44 {
45         return client == LDLM_NAMESPACE_SERVER ?
46                 ldlm_srv_namespace_nr : ldlm_cli_namespace_nr;
47 }
48
49 static inline void ldlm_namespace_nr_inc(enum ldlm_side client)
50 {
51         if (client == LDLM_NAMESPACE_SERVER)
52                 ldlm_srv_namespace_nr++;
53         else
54                 ldlm_cli_namespace_nr++;
55 }
56
57 static inline void ldlm_namespace_nr_dec(enum ldlm_side client)
58 {
59         if (client == LDLM_NAMESPACE_SERVER)
60                 ldlm_srv_namespace_nr--;
61         else
62                 ldlm_cli_namespace_nr--;
63 }
64
65 static inline struct list_head *ldlm_namespace_list(enum ldlm_side client)
66 {
67         return client == LDLM_NAMESPACE_SERVER ?
68                 &ldlm_srv_namespace_list : &ldlm_cli_active_namespace_list;
69 }
70
71 static inline
72 struct list_head *ldlm_namespace_inactive_list(enum ldlm_side client)
73 {
74         return client == LDLM_NAMESPACE_SERVER ?
75                 &ldlm_srv_namespace_list : &ldlm_cli_inactive_namespace_list;
76 }
77
78 static inline struct mutex *ldlm_namespace_lock(enum ldlm_side client)
79 {
80         return client == LDLM_NAMESPACE_SERVER ?
81                 &ldlm_srv_namespace_lock : &ldlm_cli_namespace_lock;
82 }
83
84 /* ns_bref is the number of resources in this namespace */
85 static inline int ldlm_ns_empty(struct ldlm_namespace *ns)
86 {
87         return atomic_read(&ns->ns_bref) == 0;
88 }
89
90 void ldlm_namespace_move_to_active_locked(struct ldlm_namespace *,
91                                           enum ldlm_side);
92 void ldlm_namespace_move_to_inactive_locked(struct ldlm_namespace *,
93                                             enum ldlm_side);
94 struct ldlm_namespace *ldlm_namespace_first_locked(enum ldlm_side);
95
96 /* ldlm_request.c */
97 /* Cancel lru flag, it indicates we cancel aged locks. */
98 enum ldlm_lru_flags {
99         LDLM_LRU_FLAG_AGED      = 0x01, /* Cancel aged locks (non LRU resize) */
100         LDLM_LRU_FLAG_PASSED    = 0x02, /* Cancel passed number of locks */
101         LDLM_LRU_FLAG_SHRINK    = 0x04, /* Cancel locks from shrinker */
102         LDLM_LRU_FLAG_LRUR      = 0x08, /* Cancel locks from lru resize */
103         LDLM_LRU_FLAG_NO_WAIT   = 0x10, /* Cancel locks w/o blocking (neither
104                                          * sending nor waiting for any RPCs) */
105         LDLM_LRU_FLAG_CLEANUP   = 0x20, /* Used when clearing lru, tells
106                                          * prepare_lru_list to set discard flag
107                                          * on PR extent locks so we don't waste
108                                          * time saving pages that will be
109                                          * discarded momentarily */
110 };
111
112 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr,
113                     enum ldlm_cancel_flags cancel_flags,
114                     enum ldlm_lru_flags lru_flags);
115 int ldlm_cancel_lru_local(struct ldlm_namespace *ns,
116                           struct list_head *cancels, int count, int max,
117                           enum ldlm_cancel_flags cancel_flags,
118                           enum ldlm_lru_flags lru_flags);
119 extern unsigned int ldlm_enqueue_min;
120 /* ldlm_resource.c */
121 extern struct kmem_cache *ldlm_resource_slab;
122 extern struct kmem_cache *ldlm_lock_slab;
123 extern struct kmem_cache *ldlm_inodebits_slab;
124 extern struct kmem_cache *ldlm_interval_tree_slab;
125
126 void ldlm_resource_insert_lock_after(struct ldlm_lock *original,
127                                      struct ldlm_lock *new);
128
129 /* ldlm_lock.c */
130
131 typedef enum {
132         LDLM_WORK_BL_AST,
133         LDLM_WORK_CP_AST,
134         LDLM_WORK_REVOKE_AST,
135         LDLM_WORK_GL_AST
136 } ldlm_desc_ast_t;
137
138 void ldlm_grant_lock_with_skiplist(struct ldlm_lock *lock);
139 void ldlm_grant_lock(struct ldlm_lock *lock, struct list_head *work_list);
140 int ldlm_fill_lvb(struct ldlm_lock *lock, struct req_capsule *pill,
141                   enum req_location loc, void *data, int size);
142 struct ldlm_lock *
143 ldlm_lock_create(struct ldlm_namespace *ns, const struct ldlm_res_id *,
144                  enum ldlm_type type, enum ldlm_mode mode,
145                  const struct ldlm_callback_suite *cbs,
146                  void *data, __u32 lvb_len, enum lvb_type lvb_type);
147 enum ldlm_error ldlm_lock_enqueue(const struct lu_env *env,
148                                   struct ldlm_namespace *,
149                                   struct ldlm_lock **,
150                                   void *cookie, __u64 *flags);
151 void ldlm_lock_addref_internal(struct ldlm_lock *, enum ldlm_mode mode);
152 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *, enum ldlm_mode mode);
153 void ldlm_lock_decref_internal(struct ldlm_lock *, enum ldlm_mode mode);
154 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *, enum ldlm_mode mode);
155 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
156                             struct list_head *work_list);
157 #ifdef HAVE_SERVER_SUPPORT
158 int ldlm_reprocess_queue(struct ldlm_resource *res, struct list_head *queue,
159                          struct list_head *work_list,
160                          enum ldlm_process_intention intention,
161                          struct ldlm_lock *hint);
162 int ldlm_handle_conflict_lock(struct ldlm_lock *lock, __u64 *flags,
163                               struct list_head *rpc_list);
164 void ldlm_discard_bl_list(struct list_head *bl_list);
165 void ldlm_clear_blocking_lock(struct ldlm_lock *lock);
166 void ldlm_clear_blocking_data(struct ldlm_lock *lock);
167 #endif
168 int ldlm_run_ast_work(struct ldlm_namespace *ns, struct list_head *rpc_list,
169                       ldlm_desc_ast_t ast_type);
170 int ldlm_work_gl_ast_lock(struct ptlrpc_request_set *rqset, void *opaq);
171 int ldlm_lock_remove_from_lru_check(struct ldlm_lock *lock, ktime_t last_use);
172 #define ldlm_lock_remove_from_lru(lock) \
173                 ldlm_lock_remove_from_lru_check(lock, ktime_set(0, 0))
174 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock);
175 void ldlm_lock_add_to_lru_nolock(struct ldlm_lock *lock);
176 void ldlm_lock_add_to_lru(struct ldlm_lock *lock);
177 void ldlm_lock_touch_in_lru(struct ldlm_lock *lock);
178 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock);
179
180 int ldlm_export_cancel_blocked_locks(struct obd_export *exp);
181 int ldlm_export_cancel_locks(struct obd_export *exp);
182 void ldlm_grant_lock_with_skiplist(struct ldlm_lock *lock);
183
184 /* ldlm_lockd.c */
185 int ldlm_bl_to_thread_lock(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
186                            struct ldlm_lock *lock);
187 int ldlm_bl_to_thread_list(struct ldlm_namespace *ns,
188                            struct ldlm_lock_desc *ld,
189                            struct list_head *cancels, int count,
190                            enum ldlm_cancel_flags cancel_flags);
191 int ldlm_bl_thread_wakeup(void);
192
193 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
194                              struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
195
196 #ifdef HAVE_SERVER_SUPPORT
197 /* ldlm_plain.c */
198 int ldlm_process_plain_lock(struct ldlm_lock *lock, __u64 *flags,
199                             enum ldlm_process_intention intention,
200                             enum ldlm_error *err, struct list_head *work_list);
201
202 /* ldlm_inodebits.c */
203 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, __u64 *flags,
204                                 enum ldlm_process_intention intention,
205                                 enum ldlm_error *err,
206                                 struct list_head *work_list);
207 int ldlm_reprocess_inodebits_queue(struct ldlm_resource *res,
208                                    struct list_head *queue,
209                                    struct list_head *work_list,
210                                    enum ldlm_process_intention intention,
211                                    struct ldlm_lock *hint);
212 /* ldlm_extent.c */
213 int ldlm_process_extent_lock(struct ldlm_lock *lock, __u64 *flags,
214                              enum ldlm_process_intention intention,
215                              enum ldlm_error *err, struct list_head *work_list);
216 #endif
217 int ldlm_extent_alloc_lock(struct ldlm_lock *lock);
218 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
219 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
220
221 int ldlm_inodebits_alloc_lock(struct ldlm_lock *lock);
222 void ldlm_inodebits_add_lock(struct ldlm_resource *res, struct list_head *head,
223                              struct ldlm_lock *lock);
224 void ldlm_inodebits_unlink_lock(struct ldlm_lock *lock);
225
226 /* ldlm_flock.c */
227 int ldlm_process_flock_lock(struct ldlm_lock *req, __u64 *flags,
228                             enum ldlm_process_intention intention,
229                             enum ldlm_error *err, struct list_head *work_list);
230 int ldlm_init_flock_export(struct obd_export *exp);
231 void ldlm_destroy_flock_export(struct obd_export *exp);
232
233 /* l_lock.c */
234 void l_check_ns_lock(struct ldlm_namespace *ns);
235 void l_check_no_ns_lock(struct ldlm_namespace *ns);
236
237 extern struct dentry *ldlm_svc_debugfs_dir;
238
239 struct ldlm_state {
240         struct ptlrpc_service *ldlm_cb_service;
241         struct ptlrpc_service *ldlm_cancel_service;
242         struct ptlrpc_client *ldlm_client;
243         struct ptlrpc_connection *ldlm_server_conn;
244         struct ldlm_bl_pool *ldlm_bl_pool;
245 };
246
247 /* interval tree, for LDLM_EXTENT. */
248 extern struct kmem_cache *ldlm_interval_slab; /* slab cache for ldlm_interval */
249 extern void ldlm_interval_attach(struct ldlm_interval *n, struct ldlm_lock *l);
250 extern struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
251 extern void ldlm_interval_free(struct ldlm_interval *node);
252 /* this function must be called with res lock held */
253 static inline struct ldlm_extent *
254 ldlm_interval_extent(struct ldlm_interval *node)
255 {
256         struct ldlm_lock *lock;
257         LASSERT(!list_empty(&node->li_group));
258
259         lock = list_entry(node->li_group.next, struct ldlm_lock,
260                               l_sl_policy);
261         return &lock->l_policy_data.l_extent;
262 }
263
264 int ldlm_init(void);
265 void ldlm_exit(void);
266
267 enum ldlm_policy_res {
268         LDLM_POLICY_CANCEL_LOCK,
269         LDLM_POLICY_KEEP_LOCK,
270         LDLM_POLICY_SKIP_LOCK
271 };
272
273 #define LDLM_POOL_SYSFS_PRINT_int(v) sprintf(buf, "%d\n", v)
274 #define LDLM_POOL_SYSFS_SET_int(a, b) { a = b; }
275 #define LDLM_POOL_SYSFS_PRINT_u64(v) sprintf(buf, "%lld\n", v)
276 #define LDLM_POOL_SYSFS_SET_u64(a, b) { a = b; }
277 #define LDLM_POOL_SYSFS_PRINT_atomic(v) sprintf(buf, "%d\n", atomic_read(&v))
278 #define LDLM_POOL_SYSFS_SET_atomic(a, b) atomic_set(&a, b)
279
280 #define LDLM_POOL_SYSFS_READER_SHOW(var, type)                             \
281         static ssize_t var##_show(struct kobject *kobj,                    \
282                                   struct attribute *attr,                  \
283                                   char *buf)                               \
284         {                                                                  \
285                 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
286                                                     pl_kobj);              \
287                 type tmp;                                                  \
288                                                                            \
289                 spin_lock(&pl->pl_lock);                                   \
290                 tmp = pl->pl_##var;                                        \
291                 spin_unlock(&pl->pl_lock);                                 \
292                                                                            \
293                 return LDLM_POOL_SYSFS_PRINT_##type(tmp);                  \
294         }                                                                  \
295         struct __##var##__dummy_read {;} /* semicolon catcher */
296
297 #define LDLM_POOL_SYSFS_WRITER_STORE(var, type)                            \
298         static ssize_t var##_store(struct kobject *kobj,                   \
299                                    struct attribute *attr,                 \
300                                    const char *buffer,                     \
301                                    size_t count)                           \
302         {                                                                  \
303                 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
304                                                     pl_kobj);              \
305                 unsigned long tmp;                                         \
306                 int rc;                                                    \
307                                                                            \
308                 rc = kstrtoul(buffer, 10, &tmp);                           \
309                 if (rc < 0) {                                              \
310                         return rc;                                         \
311                 }                                                          \
312                                                                            \
313                 spin_lock(&pl->pl_lock);                                   \
314                 LDLM_POOL_SYSFS_SET_##type(pl->pl_##var, tmp);             \
315                 spin_unlock(&pl->pl_lock);                                 \
316                                                                            \
317                 return count;                                              \
318         }                                                                  \
319         struct __##var##__dummy_write {; } /* semicolon catcher */
320
321 #define LDLM_POOL_SYSFS_READER_NOLOCK_SHOW(var, type)                      \
322         static ssize_t var##_show(struct kobject *kobj,                    \
323                                   struct attribute *attr,                  \
324                                   char *buf)                               \
325         {                                                                  \
326                 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
327                                                     pl_kobj);              \
328                                                                            \
329                 return LDLM_POOL_SYSFS_PRINT_##type(pl->pl_##var);         \
330         }                                                                  \
331         struct __##var##__dummy_read {; } /* semicolon catcher */
332
333 #define LDLM_POOL_SYSFS_WRITER_NOLOCK_STORE(var, type)                     \
334         static ssize_t var##_store(struct kobject *kobj,                   \
335                                    struct attribute *attr,                 \
336                                    const char *buffer,                     \
337                                    size_t count)                           \
338         {                                                                  \
339                 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
340                                                     pl_kobj);              \
341                 unsigned long tmp;                                         \
342                 int rc;                                                    \
343                                                                            \
344                 rc = kstrtoul(buffer, 10, &tmp);                           \
345                 if (rc < 0) {                                              \
346                         return rc;                                         \
347                 }                                                          \
348                                                                            \
349                 LDLM_POOL_SYSFS_SET_##type(pl->pl_##var, tmp);             \
350                                                                            \
351                 return count;                                              \
352         }                                                                  \
353         struct __##var##__dummy_write {; } /* semicolon catcher */
354
355 static inline void
356 ldlm_add_var(struct lprocfs_vars *vars, struct dentry *debugfs_entry,
357              const char *name, void *data, const struct file_operations *ops)
358 {
359         vars->name = name;
360         vars->data = data;
361         vars->fops = ops;
362         ldebugfs_add_vars(debugfs_entry, vars, NULL);
363 }
364
365 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
366 {
367         int ret = 0;
368
369         lock_res_and_lock(lock);
370         ret = is_granted_or_cancelled_nolock(lock);
371         unlock_res_and_lock(lock);
372
373         return ret;
374 }
375
376 static inline bool is_bl_done(struct ldlm_lock *lock)
377 {
378         bool bl_done = true;
379
380         if (!ldlm_is_bl_done(lock)) {
381                 lock_res_and_lock(lock);
382                 bl_done = ldlm_is_bl_done(lock);
383                 unlock_res_and_lock(lock);
384         }
385
386         return bl_done;
387 }
388
389 typedef void (*ldlm_policy_wire_to_local_t)(const union ldlm_wire_policy_data *,
390                                             union ldlm_policy_data *);
391 typedef void (*ldlm_policy_local_to_wire_t)(const union ldlm_policy_data *,
392                                             union ldlm_wire_policy_data *);
393 void ldlm_plain_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
394                                      union ldlm_policy_data *lpolicy);
395 void ldlm_plain_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
396                                      union ldlm_wire_policy_data *wpolicy);
397 void ldlm_ibits_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
398                                      union ldlm_policy_data *lpolicy);
399 void ldlm_ibits_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
400                                      union ldlm_wire_policy_data *wpolicy);
401 void ldlm_extent_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
402                                       union ldlm_policy_data *lpolicy);
403 void ldlm_extent_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
404                                       union ldlm_wire_policy_data *wpolicy);
405 void ldlm_flock_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
406                                      union ldlm_policy_data *lpolicy);
407 void ldlm_flock_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
408                                      union ldlm_wire_policy_data *wpolicy);
409
410 /* ldlm_reclaim.c */
411 #ifdef HAVE_SERVER_SUPPORT
412 extern __u64 ldlm_reclaim_threshold;
413 extern __u64 ldlm_lock_limit;
414 extern __u64 ldlm_reclaim_threshold_mb;
415 extern __u64 ldlm_lock_limit_mb;
416 extern struct percpu_counter ldlm_granted_total;
417 #endif
418 int ldlm_reclaim_setup(void);
419 void ldlm_reclaim_cleanup(void);
420 void ldlm_reclaim_add(struct ldlm_lock *lock);
421 void ldlm_reclaim_del(struct ldlm_lock *lock);
422 bool ldlm_reclaim_full(void);
423
424 static inline bool ldlm_res_eq(const struct ldlm_res_id *res0,
425                                const struct ldlm_res_id *res1)
426 {
427         return memcmp(res0, res1, sizeof(*res0)) == 0;
428 }