Whamcloud - gitweb
LU-5396 lov: (and ldlm) make some functions static
[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.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2012, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  */
36
37 #define MAX_STRING_SIZE 128
38
39 extern int ldlm_srv_namespace_nr;
40 extern int ldlm_cli_namespace_nr;
41 extern struct mutex ldlm_srv_namespace_lock;
42 extern struct list_head ldlm_srv_namespace_list;
43 extern struct mutex ldlm_cli_namespace_lock;
44 extern struct list_head ldlm_cli_active_namespace_list;
45 extern struct list_head ldlm_cli_inactive_namespace_list;
46 extern unsigned int ldlm_cancel_unused_locks_before_replay;
47
48 static inline int ldlm_namespace_nr_read(ldlm_side_t client)
49 {
50         return client == LDLM_NAMESPACE_SERVER ?
51                 ldlm_srv_namespace_nr : ldlm_cli_namespace_nr;
52 }
53
54 static inline void ldlm_namespace_nr_inc(ldlm_side_t client)
55 {
56         if (client == LDLM_NAMESPACE_SERVER)
57                 ldlm_srv_namespace_nr++;
58         else
59                 ldlm_cli_namespace_nr++;
60 }
61
62 static inline void ldlm_namespace_nr_dec(ldlm_side_t client)
63 {
64         if (client == LDLM_NAMESPACE_SERVER)
65                 ldlm_srv_namespace_nr--;
66         else
67                 ldlm_cli_namespace_nr--;
68 }
69
70 static inline struct list_head *ldlm_namespace_list(ldlm_side_t client)
71 {
72         return client == LDLM_NAMESPACE_SERVER ?
73                 &ldlm_srv_namespace_list : &ldlm_cli_active_namespace_list;
74 }
75
76 static inline struct list_head *ldlm_namespace_inactive_list(ldlm_side_t client)
77 {
78         return client == LDLM_NAMESPACE_SERVER ?
79                 &ldlm_srv_namespace_list : &ldlm_cli_inactive_namespace_list;
80 }
81
82 static inline struct mutex *ldlm_namespace_lock(ldlm_side_t client)
83 {
84         return client == LDLM_NAMESPACE_SERVER ?
85                 &ldlm_srv_namespace_lock : &ldlm_cli_namespace_lock;
86 }
87
88 /* ns_bref is the number of resources in this namespace */
89 static inline int ldlm_ns_empty(struct ldlm_namespace *ns)
90 {
91         return atomic_read(&ns->ns_bref) == 0;
92 }
93
94 void ldlm_namespace_move_to_active_locked(struct ldlm_namespace *, ldlm_side_t);
95 void ldlm_namespace_move_to_inactive_locked(struct ldlm_namespace *, ldlm_side_t);
96 struct ldlm_namespace *ldlm_namespace_first_locked(ldlm_side_t);
97
98 /* ldlm_request.c */
99 /* Cancel lru flag, it indicates we cancel aged locks. */
100 enum {
101         LDLM_CANCEL_AGED   = 1 << 0, /* Cancel aged locks (non lru resize). */
102         LDLM_CANCEL_PASSED = 1 << 1, /* Cancel passed number of locks. */
103         LDLM_CANCEL_SHRINK = 1 << 2, /* Cancel locks from shrinker. */
104         LDLM_CANCEL_LRUR   = 1 << 3, /* Cancel locks from lru resize. */
105         LDLM_CANCEL_NO_WAIT = 1 << 4 /* Cancel locks w/o blocking (neither
106                                       * sending nor waiting for any rpcs) */
107 };
108
109 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr,
110                     ldlm_cancel_flags_t sync, int flags);
111 int ldlm_cancel_lru_local(struct ldlm_namespace *ns,
112                           struct list_head *cancels, int count, int max,
113                           ldlm_cancel_flags_t cancel_flags, int flags);
114 extern unsigned int ldlm_enqueue_min;
115 /* ldlm_resource.c */
116 extern struct kmem_cache *ldlm_resource_slab;
117 extern struct kmem_cache *ldlm_lock_slab;
118
119 int ldlm_resource_putref_locked(struct ldlm_resource *res);
120 void ldlm_resource_insert_lock_after(struct ldlm_lock *original,
121                                      struct ldlm_lock *new);
122 void ldlm_namespace_free_prior(struct ldlm_namespace *ns,
123                                struct obd_import *imp, int force);
124 void ldlm_namespace_free_post(struct ldlm_namespace *ns);
125
126 /* ldlm_lock.c */
127
128 struct ldlm_cb_set_arg {
129         struct ptlrpc_request_set       *set;
130         int                              type; /* LDLM_{CP,BL,GL}_CALLBACK */
131         atomic_t                         restart;
132         struct list_head                        *list;
133         union ldlm_gl_desc              *gl_desc; /* glimpse AST descriptor */
134 };
135
136 typedef enum {
137         LDLM_WORK_BL_AST,
138         LDLM_WORK_CP_AST,
139         LDLM_WORK_REVOKE_AST,
140         LDLM_WORK_GL_AST
141 } ldlm_desc_ast_t;
142
143 void ldlm_grant_lock(struct ldlm_lock *lock, struct list_head *work_list);
144 int ldlm_fill_lvb(struct ldlm_lock *lock, struct req_capsule *pill,
145                   enum req_location loc, void *data, int size);
146 struct ldlm_lock *
147 ldlm_lock_create(struct ldlm_namespace *ns, const struct ldlm_res_id *,
148                  ldlm_type_t type, ldlm_mode_t,
149                  const struct ldlm_callback_suite *cbs,
150                  void *data, __u32 lvb_len, enum lvb_type lvb_type);
151 ldlm_error_t ldlm_lock_enqueue(struct ldlm_namespace *, struct ldlm_lock **,
152                                void *cookie, __u64 *flags);
153 void ldlm_lock_addref_internal(struct ldlm_lock *, __u32 mode);
154 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *, __u32 mode);
155 void ldlm_lock_decref_internal(struct ldlm_lock *, __u32 mode);
156 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *, __u32 mode);
157 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
158                             struct list_head *work_list);
159 #ifdef HAVE_SERVER_SUPPORT
160 int ldlm_reprocess_queue(struct ldlm_resource *res, struct list_head *queue,
161                          struct list_head *work_list);
162 #endif
163 int ldlm_run_ast_work(struct ldlm_namespace *ns, struct list_head *rpc_list,
164                       ldlm_desc_ast_t ast_type);
165 int ldlm_work_gl_ast_lock(struct ptlrpc_request_set *rqset, void *opaq);
166 int ldlm_lock_remove_from_lru(struct ldlm_lock *lock);
167 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock);
168 void ldlm_lock_add_to_lru_nolock(struct ldlm_lock *lock);
169 void ldlm_lock_add_to_lru(struct ldlm_lock *lock);
170 void ldlm_lock_touch_in_lru(struct ldlm_lock *lock);
171 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock);
172
173 void ldlm_cancel_locks_for_export(struct obd_export *export);
174
175 /* ldlm_lockd.c */
176 int ldlm_bl_to_thread_lock(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
177                            struct ldlm_lock *lock);
178 int ldlm_bl_to_thread_list(struct ldlm_namespace *ns,
179                            struct ldlm_lock_desc *ld,
180                            struct list_head *cancels, int count,
181                            ldlm_cancel_flags_t cancel_flags);
182
183 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
184                              struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
185
186 #ifdef HAVE_SERVER_SUPPORT
187 /* ldlm_plain.c */
188 int ldlm_process_plain_lock(struct ldlm_lock *lock, __u64 *flags,
189                             int first_enq, ldlm_error_t *err,
190                             struct list_head *work_list);
191
192 /* ldlm_inodebits.c */
193 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, __u64 *flags,
194                                 int first_enq, ldlm_error_t *err,
195                                 struct list_head *work_list);
196 #endif
197
198 /* ldlm_extent.c */
199 #ifdef HAVE_SERVER_SUPPORT
200 int ldlm_process_extent_lock(struct ldlm_lock *lock, __u64 *flags,
201                              int first_enq, ldlm_error_t *err,
202                              struct list_head *work_list);
203 #endif
204 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
205 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
206
207 /* ldlm_flock.c */
208 int ldlm_process_flock_lock(struct ldlm_lock *req, __u64 *flags,
209                             int first_enq, ldlm_error_t *err,
210                             struct list_head *work_list);
211 int ldlm_init_flock_export(struct obd_export *exp);
212 void ldlm_destroy_flock_export(struct obd_export *exp);
213
214 /* l_lock.c */
215 void l_check_ns_lock(struct ldlm_namespace *ns);
216 void l_check_no_ns_lock(struct ldlm_namespace *ns);
217
218 extern struct proc_dir_entry *ldlm_svc_proc_dir;
219
220 struct ldlm_state {
221         struct ptlrpc_service *ldlm_cb_service;
222         struct ptlrpc_service *ldlm_cancel_service;
223         struct ptlrpc_client *ldlm_client;
224         struct ptlrpc_connection *ldlm_server_conn;
225         struct ldlm_bl_pool *ldlm_bl_pool;
226 };
227
228 /* interval tree, for LDLM_EXTENT. */
229 extern struct kmem_cache *ldlm_interval_slab; /* slab cache for ldlm_interval */
230 extern void ldlm_interval_attach(struct ldlm_interval *n, struct ldlm_lock *l);
231 extern struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
232 extern struct ldlm_interval *ldlm_interval_alloc(struct ldlm_lock *lock);
233 extern void ldlm_interval_free(struct ldlm_interval *node);
234 /* this function must be called with res lock held */
235 static inline struct ldlm_extent *
236 ldlm_interval_extent(struct ldlm_interval *node)
237 {
238         struct ldlm_lock *lock;
239         LASSERT(!list_empty(&node->li_group));
240
241         lock = list_entry(node->li_group.next, struct ldlm_lock,
242                               l_sl_policy);
243         return &lock->l_policy_data.l_extent;
244 }
245
246 int ldlm_init(void);
247 void ldlm_exit(void);
248
249 enum ldlm_policy_res {
250         LDLM_POLICY_CANCEL_LOCK,
251         LDLM_POLICY_KEEP_LOCK,
252         LDLM_POLICY_SKIP_LOCK
253 };
254
255 typedef enum ldlm_policy_res ldlm_policy_res_t;
256
257 #define LDLM_POOL_PROC_READER_SEQ_SHOW(var, type)                       \
258         static int lprocfs_##var##_seq_show(struct seq_file *m, void *v)\
259         {                                                               \
260                 struct ldlm_pool *pl = m->private;                      \
261                 type tmp;                                               \
262                                                                         \
263                 spin_lock(&pl->pl_lock);                                \
264                 tmp = pl->pl_##var;                                     \
265                 spin_unlock(&pl->pl_lock);                              \
266                                                                         \
267                 return lprocfs_uint_seq_show(m, &tmp);                  \
268         }                                                               \
269         struct __##var##__dummy_read {;} /* semicolon catcher */
270
271 #define LDLM_POOL_PROC_WRITER(var, type)                                \
272         static int lprocfs_wr_##var(struct file *file,                  \
273                              const char __user *buffer,                 \
274                              unsigned long count, void *data)           \
275         {                                                               \
276                 struct ldlm_pool *pl = data;                            \
277                 type tmp;                                               \
278                 int rc;                                                 \
279                                                                         \
280                 rc = lprocfs_wr_uint(file, buffer, count, &tmp);        \
281                 if (rc < 0) {                                           \
282                         CERROR("Can't parse user input, rc = %d\n", rc);\
283                         return rc;                                      \
284                 }                                                       \
285                                                                         \
286                 spin_lock(&pl->pl_lock);                                \
287                 pl->pl_##var = tmp;                                     \
288                 spin_unlock(&pl->pl_lock);                              \
289                                                                         \
290                 return rc;                                              \
291         }                                                               \
292         struct __##var##__dummy_write {;} /* semicolon catcher */
293
294 static inline void
295 ldlm_add_var(struct lprocfs_seq_vars *vars, struct proc_dir_entry *proc_dir,
296              const char *name, void *data, const struct file_operations *ops)
297 {
298         snprintf((char *)vars->name, MAX_STRING_SIZE, "%s", name);
299         vars->data = data;
300         vars->fops = ops;
301         lprocfs_seq_add_vars(proc_dir, vars, 0);
302 }
303
304 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
305 {
306         int ret = 0;
307
308         lock_res_and_lock(lock);
309         if ((lock->l_req_mode == lock->l_granted_mode) &&
310              !ldlm_is_cp_reqd(lock))
311                 ret = 1;
312         else if (ldlm_is_failed(lock) || ldlm_is_cancel(lock))
313                 ret = 1;
314         unlock_res_and_lock(lock);
315
316         return ret;
317 }
318
319 typedef void (*ldlm_policy_wire_to_local_t)(const ldlm_wire_policy_data_t *,
320                                             ldlm_policy_data_t *);
321
322 typedef void (*ldlm_policy_local_to_wire_t)(const ldlm_policy_data_t *,
323                                             ldlm_wire_policy_data_t *);
324
325 void ldlm_plain_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
326                                      ldlm_policy_data_t *lpolicy);
327 void ldlm_plain_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
328                                      ldlm_wire_policy_data_t *wpolicy);
329 void ldlm_ibits_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
330                                      ldlm_policy_data_t *lpolicy);
331 void ldlm_ibits_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
332                                      ldlm_wire_policy_data_t *wpolicy);
333 void ldlm_extent_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
334                                      ldlm_policy_data_t *lpolicy);
335 void ldlm_extent_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
336                                      ldlm_wire_policy_data_t *wpolicy);
337 void ldlm_flock_policy_wire18_to_local(const ldlm_wire_policy_data_t *wpolicy,
338                                      ldlm_policy_data_t *lpolicy);
339 void ldlm_flock_policy_wire21_to_local(const ldlm_wire_policy_data_t *wpolicy,
340                                      ldlm_policy_data_t *lpolicy);
341
342 void ldlm_flock_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
343                                      ldlm_wire_policy_data_t *wpolicy);