Whamcloud - gitweb
b=21452 kABI tracking
[fs/lustre-release.git] / lustre / ldlm / ldlm_internal.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see
20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
30  * Use is subject to license terms.
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 cfs_atomic_t ldlm_srv_namespace_nr;
40 extern cfs_atomic_t ldlm_cli_namespace_nr;
41 extern cfs_semaphore_t ldlm_srv_namespace_lock;
42 extern cfs_list_t ldlm_srv_namespace_list;
43 extern cfs_semaphore_t ldlm_cli_namespace_lock;
44 extern cfs_list_t ldlm_cli_namespace_list;
45
46 static inline cfs_atomic_t *ldlm_namespace_nr(ldlm_side_t client)
47 {
48         return client == LDLM_NAMESPACE_SERVER ?
49                 &ldlm_srv_namespace_nr : &ldlm_cli_namespace_nr;
50 }
51
52 static inline cfs_list_t *ldlm_namespace_list(ldlm_side_t client)
53 {
54         return client == LDLM_NAMESPACE_SERVER ?
55                 &ldlm_srv_namespace_list : &ldlm_cli_namespace_list;
56 }
57
58 static inline cfs_semaphore_t *ldlm_namespace_lock(ldlm_side_t client)
59 {
60         return client == LDLM_NAMESPACE_SERVER ?
61                 &ldlm_srv_namespace_lock : &ldlm_cli_namespace_lock;
62 }
63
64 /* ldlm_request.c */
65 typedef enum {
66         LDLM_ASYNC,
67         LDLM_SYNC,
68 } ldlm_sync_t;
69
70 /* Cancel lru flag, it indicates we cancel aged locks. */
71 enum {
72         LDLM_CANCEL_AGED   = 1 << 0, /* Cancel aged locks (non lru resize). */
73         LDLM_CANCEL_PASSED = 1 << 1, /* Cancel passed number of locks. */
74         LDLM_CANCEL_SHRINK = 1 << 2, /* Cancel locks from shrinker. */
75         LDLM_CANCEL_LRUR   = 1 << 3  /* Cancel locks from lru resize. */
76 };
77
78 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr, ldlm_sync_t sync,
79                     int flags);
80 int ldlm_cancel_lru_local(struct ldlm_namespace *ns,
81                           cfs_list_t *cancels, int count, int max,
82                           ldlm_cancel_flags_t cancel_flags, int flags);
83 extern int ldlm_enqueue_min;
84 int ldlm_get_enq_timeout(struct ldlm_lock *lock);
85
86 /* ldlm_resource.c */
87 int ldlm_resource_putref_locked(struct ldlm_resource *res);
88 void ldlm_resource_insert_lock_after(struct ldlm_lock *original,
89                                      struct ldlm_lock *new);
90 void ldlm_namespace_free_prior(struct ldlm_namespace *ns,
91                                struct obd_import *imp, int force);
92 void ldlm_namespace_free_post(struct ldlm_namespace *ns);
93 /* ldlm_lock.c */
94
95 /* Number of blocking/completion callbacks that will be sent in
96  * parallel (see bug 11301). */
97 #define PARALLEL_AST_LIMIT      200
98
99 struct ldlm_cb_set_arg {
100         struct ptlrpc_request_set *set;
101         cfs_atomic_t restart;
102         __u32 type; /* LDLM_BL_CALLBACK or LDLM_CP_CALLBACK */
103 };
104
105 typedef enum {
106         LDLM_WORK_BL_AST,
107         LDLM_WORK_CP_AST,
108         LDLM_WORK_REVOKE_AST
109 } ldlm_desc_ast_t;
110
111 void ldlm_grant_lock(struct ldlm_lock *lock, cfs_list_t *work_list);
112 struct ldlm_lock *
113 ldlm_lock_create(struct ldlm_namespace *ns, const struct ldlm_res_id *,
114                  ldlm_type_t type, ldlm_mode_t,
115                  const struct ldlm_callback_suite *cbs,
116                  void *data, __u32 lvb_len);
117 ldlm_error_t ldlm_lock_enqueue(struct ldlm_namespace *, struct ldlm_lock **,
118                                void *cookie, int *flags);
119 void ldlm_lock_addref_internal(struct ldlm_lock *, __u32 mode);
120 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *, __u32 mode);
121 void ldlm_lock_decref_internal(struct ldlm_lock *, __u32 mode);
122 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *, __u32 mode);
123 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
124                             cfs_list_t *work_list);
125 int ldlm_reprocess_queue(struct ldlm_resource *res, cfs_list_t *queue,
126                          cfs_list_t *work_list);
127 int ldlm_run_ast_work(cfs_list_t *rpc_list, ldlm_desc_ast_t ast_type);
128 int ldlm_lock_remove_from_lru(struct ldlm_lock *lock);
129 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock);
130 void ldlm_lock_add_to_lru_nolock(struct ldlm_lock *lock);
131 void ldlm_lock_add_to_lru(struct ldlm_lock *lock);
132 void ldlm_lock_touch_in_lru(struct ldlm_lock *lock);
133 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock);
134
135 void ldlm_cancel_locks_for_export(struct obd_export *export);
136
137 /* ldlm_lockd.c */
138 int ldlm_bl_to_thread_lock(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
139                            struct ldlm_lock *lock);
140 int ldlm_bl_to_thread_list(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
141                            cfs_list_t *cancels, int count, int mode);
142
143 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
144                              struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
145
146 /* ldlm_plain.c */
147 int ldlm_process_plain_lock(struct ldlm_lock *lock, int *flags, int first_enq,
148                             ldlm_error_t *err, cfs_list_t *work_list);
149
150 /* ldlm_extent.c */
151 int ldlm_process_extent_lock(struct ldlm_lock *lock, int *flags, int first_enq,
152                              ldlm_error_t *err, cfs_list_t *work_list);
153 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
154 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
155
156 /* ldlm_flock.c */
157 int ldlm_process_flock_lock(struct ldlm_lock *req, int *flags, int first_enq,
158                             ldlm_error_t *err, cfs_list_t *work_list);
159
160 /* ldlm_inodebits.c */
161 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, int *flags,
162                                 int first_enq, ldlm_error_t *err,
163                                 cfs_list_t *work_list);
164
165 /* l_lock.c */
166 void l_check_ns_lock(struct ldlm_namespace *ns);
167 void l_check_no_ns_lock(struct ldlm_namespace *ns);
168
169 extern cfs_proc_dir_entry_t *ldlm_svc_proc_dir;
170 extern cfs_proc_dir_entry_t *ldlm_type_proc_dir;
171
172 struct ldlm_state {
173         struct ptlrpc_service *ldlm_cb_service;
174         struct ptlrpc_service *ldlm_cancel_service;
175         struct ptlrpc_client *ldlm_client;
176         struct ptlrpc_connection *ldlm_server_conn;
177         struct ldlm_bl_pool *ldlm_bl_pool;
178 };
179
180 /* interval tree, for LDLM_EXTENT. */
181 extern cfs_mem_cache_t *ldlm_interval_slab; /* slab cache for ldlm_interval */
182 extern void ldlm_interval_attach(struct ldlm_interval *n, struct ldlm_lock *l);
183 extern struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
184 extern struct ldlm_interval *ldlm_interval_alloc(struct ldlm_lock *lock);
185 extern void ldlm_interval_free(struct ldlm_interval *node);
186 /* this function must be called with res lock held */
187 static inline struct ldlm_extent *
188 ldlm_interval_extent(struct ldlm_interval *node)
189 {
190         struct ldlm_lock *lock;
191         LASSERT(!cfs_list_empty(&node->li_group));
192
193         lock = cfs_list_entry(node->li_group.next, struct ldlm_lock,
194                               l_sl_policy);
195         return &lock->l_policy_data.l_extent;
196 }
197
198 int ldlm_init(void);
199 void ldlm_exit(void);
200
201 enum ldlm_policy_res {
202         LDLM_POLICY_CANCEL_LOCK,
203         LDLM_POLICY_KEEP_LOCK
204 };
205
206 typedef enum ldlm_policy_res ldlm_policy_res_t;
207
208 #define LDLM_POOL_PROC_READER(var, type)                                    \
209         static int lprocfs_rd_##var(char *page, char **start, off_t off,    \
210                                     int count, int *eof, void *data)        \
211         {                                                                   \
212                 struct ldlm_pool *pl = data;                                \
213                 type tmp;                                                   \
214                                                                             \
215                 cfs_spin_lock(&pl->pl_lock);                                \
216                 tmp = pl->pl_##var;                                         \
217                 cfs_spin_unlock(&pl->pl_lock);                              \
218                                                                             \
219                 return lprocfs_rd_uint(page, start, off, count, eof, &tmp); \
220         }                                                                   \
221         struct __##var##__dummy_read {;} /* semicolon catcher */
222
223 #define LDLM_POOL_PROC_WRITER(var, type)                                    \
224         int lprocfs_wr_##var(struct file *file, const char *buffer,         \
225                              unsigned long count, void *data)               \
226         {                                                                   \
227                 struct ldlm_pool *pl = data;                                \
228                 type tmp;                                                   \
229                 int rc;                                                     \
230                                                                             \
231                 rc = lprocfs_wr_uint(file, buffer, count, &tmp);            \
232                 if (rc < 0) {                                               \
233                         CERROR("Can't parse user input, rc = %d\n", rc);    \
234                         return rc;                                          \
235                 }                                                           \
236                                                                             \
237                 cfs_spin_lock(&pl->pl_lock);                                \
238                 pl->pl_##var = tmp;                                         \
239                 cfs_spin_unlock(&pl->pl_lock);                              \
240                                                                             \
241                 return rc;                                                  \
242         }                                                                   \
243         struct __##var##__dummy_write {;} /* semicolon catcher */
244
245 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
246 {
247         int ret = 0;
248
249         lock_res_and_lock(lock);
250         if (((lock->l_req_mode == lock->l_granted_mode) &&
251              !(lock->l_flags & LDLM_FL_CP_REQD)) ||
252             (lock->l_flags & LDLM_FL_FAILED))
253                 ret = 1;
254         unlock_res_and_lock(lock);
255
256         return ret;
257 }