Whamcloud - gitweb
LU-11518 ldlm: control lru_size for extent lock
[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_NO_WAIT   = 0x1, /* Cancel locks w/o blocking (neither
100                                         * sending nor waiting for any RPCs) */
101         LDLM_LRU_FLAG_CLEANUP   = 0x2, /* Used when clearing lru, tells
102                                         * prepare_lru_list to set discard flag
103                                         * on PR extent locks so we don't waste
104                                         * time saving pages that will be
105                                         * discarded momentarily */
106 };
107
108 int ldlm_cancel_lru(struct ldlm_namespace *ns, int min,
109                     enum ldlm_cancel_flags cancel_flags,
110                     enum ldlm_lru_flags lru_flags);
111 int ldlm_cancel_lru_local(struct ldlm_namespace *ns,
112                           struct list_head *cancels, int min, int max,
113                           enum ldlm_cancel_flags cancel_flags,
114                           enum ldlm_lru_flags lru_flags);
115 extern unsigned int ldlm_enqueue_min;
116 /* ldlm_resource.c */
117 extern struct kmem_cache *ldlm_resource_slab;
118 extern struct kmem_cache *ldlm_lock_slab;
119 extern struct kmem_cache *ldlm_inodebits_slab;
120 extern struct kmem_cache *ldlm_interval_tree_slab;
121
122 void ldlm_resource_insert_lock_after(struct ldlm_lock *original,
123                                      struct ldlm_lock *new);
124 void ldlm_resource_insert_lock_before(struct ldlm_lock *original,
125                                       struct ldlm_lock *new);
126
127 /* ldlm_lock.c */
128
129 typedef enum {
130         LDLM_WORK_BL_AST,
131         LDLM_WORK_CP_AST,
132         LDLM_WORK_REVOKE_AST,
133         LDLM_WORK_GL_AST
134 } ldlm_desc_ast_t;
135
136 void ldlm_grant_lock_with_skiplist(struct ldlm_lock *lock);
137 void ldlm_grant_lock(struct ldlm_lock *lock, struct list_head *work_list);
138 int ldlm_fill_lvb(struct ldlm_lock *lock, struct req_capsule *pill,
139                   enum req_location loc, void *data, int size);
140 struct ldlm_lock *
141 ldlm_lock_create(struct ldlm_namespace *ns, const struct ldlm_res_id *,
142                  enum ldlm_type type, enum ldlm_mode mode,
143                  const struct ldlm_callback_suite *cbs,
144                  void *data, __u32 lvb_len, enum lvb_type lvb_type);
145 enum ldlm_error ldlm_lock_enqueue(const struct lu_env *env,
146                                   struct ldlm_namespace *,
147                                   struct ldlm_lock **,
148                                   void *cookie, __u64 *flags);
149 void ldlm_lock_addref_internal(struct ldlm_lock *, enum ldlm_mode mode);
150 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *, enum ldlm_mode mode);
151 void ldlm_lock_decref_internal(struct ldlm_lock *, enum ldlm_mode mode);
152 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *, enum ldlm_mode mode);
153 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
154                             struct list_head *work_list);
155 #ifdef HAVE_SERVER_SUPPORT
156 int ldlm_reprocess_queue(struct ldlm_resource *res, struct list_head *queue,
157                          struct list_head *work_list,
158                          enum ldlm_process_intention intention,
159                          struct ldlm_lock *hint);
160 int ldlm_handle_conflict_lock(struct ldlm_lock *lock, __u64 *flags,
161                               struct list_head *rpc_list);
162 void ldlm_discard_bl_list(struct list_head *bl_list);
163 void ldlm_clear_blocking_lock(struct ldlm_lock *lock);
164 void ldlm_clear_blocking_data(struct ldlm_lock *lock);
165 #endif
166 int ldlm_run_ast_work(struct ldlm_namespace *ns, struct list_head *rpc_list,
167                       ldlm_desc_ast_t ast_type);
168 int ldlm_work_gl_ast_lock(struct ptlrpc_request_set *rqset, void *opaq);
169 int ldlm_lock_remove_from_lru_check(struct ldlm_lock *lock, ktime_t last_use);
170 #define ldlm_lock_remove_from_lru(lock) \
171                 ldlm_lock_remove_from_lru_check(lock, ktime_set(0, 0))
172 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock);
173 void ldlm_lock_add_to_lru_nolock(struct ldlm_lock *lock);
174 void ldlm_lock_touch_in_lru(struct ldlm_lock *lock);
175 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock);
176
177 int ldlm_export_cancel_blocked_locks(struct obd_export *exp);
178 int ldlm_export_cancel_locks(struct obd_export *exp);
179 void ldlm_grant_lock_with_skiplist(struct ldlm_lock *lock);
180
181 /* ldlm_lockd.c */
182 int ldlm_bl_to_thread_lock(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
183                            struct ldlm_lock *lock);
184 int ldlm_bl_to_thread_list(struct ldlm_namespace *ns,
185                            struct ldlm_lock_desc *ld,
186                            struct list_head *cancels, int count,
187                            enum ldlm_cancel_flags cancel_flags);
188 int ldlm_bl_thread_wakeup(void);
189
190 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
191                              struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
192 void ldlm_bl_desc2lock(const struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
193
194 #ifdef HAVE_SERVER_SUPPORT
195 /* ldlm_plain.c */
196 int ldlm_process_plain_lock(struct ldlm_lock *lock, __u64 *flags,
197                             enum ldlm_process_intention intention,
198                             enum ldlm_error *err, struct list_head *work_list);
199
200 /* ldlm_inodebits.c */
201 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, __u64 *flags,
202                                 enum ldlm_process_intention intention,
203                                 enum ldlm_error *err,
204                                 struct list_head *work_list);
205 int ldlm_reprocess_inodebits_queue(struct ldlm_resource *res,
206                                    struct list_head *queue,
207                                    struct list_head *work_list,
208                                    enum ldlm_process_intention intention,
209                                    struct ldlm_lock *hint);
210 /* ldlm_extent.c */
211 int ldlm_process_extent_lock(struct ldlm_lock *lock, __u64 *flags,
212                              enum ldlm_process_intention intention,
213                              enum ldlm_error *err, struct list_head *work_list);
214 #endif
215 int ldlm_extent_alloc_lock(struct ldlm_lock *lock);
216 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
217 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
218
219 int ldlm_inodebits_alloc_lock(struct ldlm_lock *lock);
220 void ldlm_inodebits_add_lock(struct ldlm_resource *res, struct list_head *head,
221                              struct ldlm_lock *lock);
222 void ldlm_inodebits_unlink_lock(struct ldlm_lock *lock);
223
224 /* ldlm_flock.c */
225 int ldlm_process_flock_lock(struct ldlm_lock *req, __u64 *flags,
226                             enum ldlm_process_intention intention,
227                             enum ldlm_error *err, struct list_head *work_list);
228 int ldlm_init_flock_export(struct obd_export *exp);
229 void ldlm_destroy_flock_export(struct obd_export *exp);
230
231 /* l_lock.c */
232 void l_check_ns_lock(struct ldlm_namespace *ns);
233 void l_check_no_ns_lock(struct ldlm_namespace *ns);
234
235 extern struct dentry *ldlm_svc_debugfs_dir;
236
237 struct ldlm_state {
238         struct ptlrpc_service *ldlm_cb_service;
239         struct ptlrpc_service *ldlm_cancel_service;
240         struct ptlrpc_client *ldlm_client;
241         struct ldlm_bl_pool *ldlm_bl_pool;
242 };
243
244 /* interval tree, for LDLM_EXTENT. */
245 extern struct kmem_cache *ldlm_interval_slab; /* slab cache for ldlm_interval */
246 extern void ldlm_interval_attach(struct ldlm_interval *n, struct ldlm_lock *l);
247 extern struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
248 extern void ldlm_interval_free(struct ldlm_interval *node);
249 /* this function must be called with res lock held */
250 static inline struct ldlm_extent *
251 ldlm_interval_extent(struct ldlm_interval *node)
252 {
253         struct ldlm_lock *lock;
254         LASSERT(!list_empty(&node->li_group));
255
256         lock = list_entry(node->li_group.next, struct ldlm_lock,
257                               l_sl_policy);
258         return &lock->l_policy_data.l_extent;
259 }
260
261 int ldlm_init(void);
262 void ldlm_exit(void);
263
264 enum ldlm_policy_res {
265         LDLM_POLICY_CANCEL_LOCK,
266         LDLM_POLICY_KEEP_LOCK,
267         LDLM_POLICY_SKIP_LOCK
268 };
269
270 #define LDLM_POOL_SYSFS_PRINT_int(v) sprintf(buf, "%d\n", v)
271 #define LDLM_POOL_SYSFS_SET_int(a, b) { a = b; }
272 #define LDLM_POOL_SYSFS_PRINT_u64(v) sprintf(buf, "%lld\n", v)
273 #define LDLM_POOL_SYSFS_SET_u64(a, b) { a = b; }
274 #define LDLM_POOL_SYSFS_PRINT_atomic(v) sprintf(buf, "%d\n", atomic_read(&v))
275 #define LDLM_POOL_SYSFS_SET_atomic(a, b) atomic_set(&a, b)
276
277 #define LDLM_POOL_SYSFS_READER_SHOW(var, type)                             \
278         static ssize_t var##_show(struct kobject *kobj,                    \
279                                   struct attribute *attr,                  \
280                                   char *buf)                               \
281         {                                                                  \
282                 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
283                                                     pl_kobj);              \
284                 type tmp;                                                  \
285                                                                            \
286                 spin_lock(&pl->pl_lock);                                   \
287                 tmp = pl->pl_##var;                                        \
288                 spin_unlock(&pl->pl_lock);                                 \
289                                                                            \
290                 return LDLM_POOL_SYSFS_PRINT_##type(tmp);                  \
291         }                                                                  \
292         struct __##var##__dummy_read {;} /* semicolon catcher */
293
294 #define LDLM_POOL_SYSFS_WRITER_STORE(var, type)                            \
295         static ssize_t var##_store(struct kobject *kobj,                   \
296                                    struct attribute *attr,                 \
297                                    const char *buffer,                     \
298                                    size_t count)                           \
299         {                                                                  \
300                 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
301                                                     pl_kobj);              \
302                 unsigned long tmp;                                         \
303                 int rc;                                                    \
304                                                                            \
305                 rc = kstrtoul(buffer, 10, &tmp);                           \
306                 if (rc < 0) {                                              \
307                         return rc;                                         \
308                 }                                                          \
309                                                                            \
310                 spin_lock(&pl->pl_lock);                                   \
311                 LDLM_POOL_SYSFS_SET_##type(pl->pl_##var, tmp);             \
312                 spin_unlock(&pl->pl_lock);                                 \
313                                                                            \
314                 return count;                                              \
315         }                                                                  \
316         struct __##var##__dummy_write {; } /* semicolon catcher */
317
318 #define LDLM_POOL_SYSFS_READER_NOLOCK_SHOW(var, type)                      \
319         static ssize_t var##_show(struct kobject *kobj,                    \
320                                   struct attribute *attr,                  \
321                                   char *buf)                               \
322         {                                                                  \
323                 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
324                                                     pl_kobj);              \
325                                                                            \
326                 return LDLM_POOL_SYSFS_PRINT_##type(pl->pl_##var);         \
327         }                                                                  \
328         struct __##var##__dummy_read {; } /* semicolon catcher */
329
330 #define LDLM_POOL_SYSFS_WRITER_NOLOCK_STORE(var, type)                     \
331         static ssize_t var##_store(struct kobject *kobj,                   \
332                                    struct attribute *attr,                 \
333                                    const char *buffer,                     \
334                                    size_t count)                           \
335         {                                                                  \
336                 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
337                                                     pl_kobj);              \
338                 unsigned long tmp;                                         \
339                 int rc;                                                    \
340                                                                            \
341                 rc = kstrtoul(buffer, 10, &tmp);                           \
342                 if (rc < 0) {                                              \
343                         return rc;                                         \
344                 }                                                          \
345                                                                            \
346                 LDLM_POOL_SYSFS_SET_##type(pl->pl_##var, tmp);             \
347                                                                            \
348                 return count;                                              \
349         }                                                                  \
350         struct __##var##__dummy_write {; } /* semicolon catcher */
351
352 static inline void
353 ldlm_add_var(struct ldebugfs_vars *vars, struct dentry *debugfs_entry,
354              const char *name, void *data, const struct file_operations *ops)
355 {
356         vars->name = name;
357         vars->data = data;
358         vars->fops = ops;
359         ldebugfs_add_vars(debugfs_entry, vars, NULL);
360 }
361
362 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
363 {
364         int ret = 0;
365
366         lock_res_and_lock(lock);
367         ret = is_granted_or_cancelled_nolock(lock);
368         unlock_res_and_lock(lock);
369
370         return ret;
371 }
372
373 static inline bool is_bl_done(struct ldlm_lock *lock)
374 {
375         bool bl_done = true;
376
377         if (!ldlm_is_bl_done(lock)) {
378                 lock_res_and_lock(lock);
379                 bl_done = ldlm_is_bl_done(lock);
380                 unlock_res_and_lock(lock);
381         }
382
383         return bl_done;
384 }
385
386 static inline bool is_lock_converted(struct ldlm_lock *lock)
387 {
388         bool ret = 0;
389
390         lock_res_and_lock(lock);
391         ret = (lock->l_policy_data.l_inodebits.cancel_bits == 0);
392         unlock_res_and_lock(lock);
393
394         return ret;
395 }
396
397 typedef void (*ldlm_policy_wire_to_local_t)(const union ldlm_wire_policy_data *,
398                                             union ldlm_policy_data *);
399 typedef void (*ldlm_policy_local_to_wire_t)(const union ldlm_policy_data *,
400                                             union ldlm_wire_policy_data *);
401 void ldlm_plain_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
402                                      union ldlm_policy_data *lpolicy);
403 void ldlm_plain_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
404                                      union ldlm_wire_policy_data *wpolicy);
405 void ldlm_ibits_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
406                                      union ldlm_policy_data *lpolicy);
407 void ldlm_ibits_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
408                                      union ldlm_wire_policy_data *wpolicy);
409 void ldlm_extent_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
410                                       union ldlm_policy_data *lpolicy);
411 void ldlm_extent_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
412                                       union ldlm_wire_policy_data *wpolicy);
413 void ldlm_flock_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
414                                      union ldlm_policy_data *lpolicy);
415 void ldlm_flock_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
416                                      union ldlm_wire_policy_data *wpolicy);
417
418 /* ldlm_reclaim.c */
419 #ifdef HAVE_SERVER_SUPPORT
420 extern __u64 ldlm_reclaim_threshold;
421 extern __u64 ldlm_lock_limit;
422 extern __u64 ldlm_reclaim_threshold_mb;
423 extern __u64 ldlm_lock_limit_mb;
424 extern struct percpu_counter ldlm_granted_total;
425 #endif
426 int ldlm_reclaim_setup(void);
427 void ldlm_reclaim_cleanup(void);
428 void ldlm_reclaim_add(struct ldlm_lock *lock);
429 void ldlm_reclaim_del(struct ldlm_lock *lock);
430 bool ldlm_reclaim_full(void);
431
432 static inline bool ldlm_res_eq(const struct ldlm_res_id *res0,
433                                const struct ldlm_res_id *res1)
434 {
435         return memcmp(res0, res1, sizeof(*res0)) == 0;
436 }