]>
Commit | Line | Data |
---|---|---|
7336d0e6 | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
b3b94faa DT |
2 | /* |
3 | * Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved. | |
3a8a9a10 | 4 | * Copyright (C) 2004-2006 Red Hat, Inc. All rights reserved. |
b3b94faa DT |
5 | */ |
6 | ||
7 | #ifndef __GLOCK_DOT_H__ | |
8 | #define __GLOCK_DOT_H__ | |
9 | ||
e8edc6e0 | 10 | #include <linux/sched.h> |
f057f6cd | 11 | #include <linux/parser.h> |
f2f7ba52 | 12 | #include "incore.h" |
df3d87bd | 13 | #include "util.h" |
f2f7ba52 | 14 | |
f057f6cd SW |
15 | /* Options for hostdata parser */ |
16 | ||
17 | enum { | |
18 | Opt_jid, | |
19 | Opt_id, | |
20 | Opt_first, | |
21 | Opt_nodir, | |
22 | Opt_err, | |
23 | }; | |
24 | ||
25 | /* | |
26 | * lm_lockname types | |
27 | */ | |
28 | ||
29 | #define LM_TYPE_RESERVED 0x00 | |
30 | #define LM_TYPE_NONDISK 0x01 | |
31 | #define LM_TYPE_INODE 0x02 | |
32 | #define LM_TYPE_RGRP 0x03 | |
33 | #define LM_TYPE_META 0x04 | |
34 | #define LM_TYPE_IOPEN 0x05 | |
35 | #define LM_TYPE_FLOCK 0x06 | |
36 | #define LM_TYPE_PLOCK 0x07 | |
37 | #define LM_TYPE_QUOTA 0x08 | |
38 | #define LM_TYPE_JOURNAL 0x09 | |
39 | ||
40 | /* | |
41 | * lm_lock() states | |
42 | * | |
43 | * SHARED is compatible with SHARED, not with DEFERRED or EX. | |
44 | * DEFERRED is compatible with DEFERRED, not with SHARED or EX. | |
45 | */ | |
46 | ||
47 | #define LM_ST_UNLOCKED 0 | |
48 | #define LM_ST_EXCLUSIVE 1 | |
49 | #define LM_ST_DEFERRED 2 | |
50 | #define LM_ST_SHARED 3 | |
51 | ||
52 | /* | |
53 | * lm_lock() flags | |
54 | * | |
55 | * LM_FLAG_TRY | |
56 | * Don't wait to acquire the lock if it can't be granted immediately. | |
57 | * | |
58 | * LM_FLAG_TRY_1CB | |
59 | * Send one blocking callback if TRY is set and the lock is not granted. | |
60 | * | |
61 | * LM_FLAG_NOEXP | |
62 | * GFS sets this flag on lock requests it makes while doing journal recovery. | |
63 | * These special requests should not be blocked due to the recovery like | |
64 | * ordinary locks would be. | |
65 | * | |
66 | * LM_FLAG_ANY | |
67 | * A SHARED request may also be granted in DEFERRED, or a DEFERRED request may | |
68 | * also be granted in SHARED. The preferred state is whichever is compatible | |
69 | * with other granted locks, or the specified state if no other locks exist. | |
70 | * | |
71 | * LM_FLAG_PRIORITY | |
72 | * Override fairness considerations. Suppose a lock is held in a shared state | |
73 | * and there is a pending request for the deferred state. A shared lock | |
74 | * request with the priority flag would be allowed to bypass the deferred | |
75 | * request and directly join the other shared lock. A shared lock request | |
76 | * without the priority flag might be forced to wait until the deferred | |
77 | * requested had acquired and released the lock. | |
06e908cd BP |
78 | * |
79 | * LM_FLAG_NODE_SCOPE | |
80 | * This holder agrees to share the lock within this node. In other words, | |
81 | * the glock is held in EX mode according to DLM, but local holders on the | |
82 | * same node can share it. | |
f057f6cd SW |
83 | */ |
84 | ||
b58bf407 BP |
85 | #define LM_FLAG_TRY 0x0001 |
86 | #define LM_FLAG_TRY_1CB 0x0002 | |
87 | #define LM_FLAG_NOEXP 0x0004 | |
88 | #define LM_FLAG_ANY 0x0008 | |
89 | #define LM_FLAG_PRIORITY 0x0010 | |
06e908cd | 90 | #define LM_FLAG_NODE_SCOPE 0x0020 |
b58bf407 BP |
91 | #define GL_ASYNC 0x0040 |
92 | #define GL_EXACT 0x0080 | |
93 | #define GL_SKIP 0x0100 | |
94 | #define GL_NOCACHE 0x0400 | |
f057f6cd SW |
95 | |
96 | /* | |
921169ca | 97 | * lm_async_cb return flags |
f057f6cd SW |
98 | * |
99 | * LM_OUT_ST_MASK | |
100 | * Masks the lower two bits of lock state in the returned value. | |
101 | * | |
102 | * LM_OUT_CANCELED | |
103 | * The lock request was canceled. | |
104 | * | |
f057f6cd SW |
105 | */ |
106 | ||
107 | #define LM_OUT_ST_MASK 0x00000003 | |
108 | #define LM_OUT_CANCELED 0x00000008 | |
921169ca | 109 | #define LM_OUT_ERROR 0x00000004 |
f057f6cd SW |
110 | |
111 | /* | |
112 | * lm_recovery_done() messages | |
113 | */ | |
114 | ||
115 | #define LM_RD_GAVEUP 308 | |
116 | #define LM_RD_SUCCESS 309 | |
117 | ||
118 | #define GLR_TRYFAILED 13 | |
119 | ||
7cf8dcd3 BP |
120 | #define GL_GLOCK_MAX_HOLD (long)(HZ / 5) |
121 | #define GL_GLOCK_DFT_HOLD (long)(HZ / 5) | |
122 | #define GL_GLOCK_MIN_HOLD (long)(10) | |
123 | #define GL_GLOCK_HOLD_INCR (long)(HZ / 20) | |
124 | #define GL_GLOCK_HOLD_DECR (long)(HZ / 40) | |
125 | ||
f057f6cd SW |
126 | struct lm_lockops { |
127 | const char *lm_proto_name; | |
e0c2a9aa DT |
128 | int (*lm_mount) (struct gfs2_sbd *sdp, const char *table); |
129 | void (*lm_first_done) (struct gfs2_sbd *sdp); | |
130 | void (*lm_recovery_result) (struct gfs2_sbd *sdp, unsigned int jid, | |
131 | unsigned int result); | |
132 | void (*lm_unmount) (struct gfs2_sbd *sdp); | |
f057f6cd | 133 | void (*lm_withdraw) (struct gfs2_sbd *sdp); |
bc015cb8 | 134 | void (*lm_put_lock) (struct gfs2_glock *gl); |
921169ca SW |
135 | int (*lm_lock) (struct gfs2_glock *gl, unsigned int req_state, |
136 | unsigned int flags); | |
f057f6cd SW |
137 | void (*lm_cancel) (struct gfs2_glock *gl); |
138 | const match_table_t *lm_tokens; | |
139 | }; | |
140 | ||
b94a170e | 141 | extern struct workqueue_struct *gfs2_delete_workqueue; |
7afd88d9 | 142 | static inline struct gfs2_holder *gfs2_glock_is_locked_by_me(struct gfs2_glock *gl) |
b3b94faa DT |
143 | { |
144 | struct gfs2_holder *gh; | |
b1e058da | 145 | struct pid *pid; |
b3b94faa DT |
146 | |
147 | /* Look in glock's list of holders for one with current task as owner */ | |
f3dd1649 | 148 | spin_lock(&gl->gl_lockref.lock); |
b1e058da | 149 | pid = task_pid(current); |
b3b94faa | 150 | list_for_each_entry(gh, &gl->gl_holders, gh_list) { |
6802e340 SW |
151 | if (!test_bit(HIF_HOLDER, &gh->gh_iflags)) |
152 | break; | |
7afd88d9 SW |
153 | if (gh->gh_owner_pid == pid) |
154 | goto out; | |
b3b94faa | 155 | } |
7afd88d9 SW |
156 | gh = NULL; |
157 | out: | |
f3dd1649 | 158 | spin_unlock(&gl->gl_lockref.lock); |
b3b94faa | 159 | |
7afd88d9 | 160 | return gh; |
b3b94faa DT |
161 | } |
162 | ||
163 | static inline int gfs2_glock_is_held_excl(struct gfs2_glock *gl) | |
164 | { | |
50299965 | 165 | return gl->gl_state == LM_ST_EXCLUSIVE; |
b3b94faa DT |
166 | } |
167 | ||
168 | static inline int gfs2_glock_is_held_dfrd(struct gfs2_glock *gl) | |
169 | { | |
50299965 | 170 | return gl->gl_state == LM_ST_DEFERRED; |
b3b94faa DT |
171 | } |
172 | ||
173 | static inline int gfs2_glock_is_held_shrd(struct gfs2_glock *gl) | |
174 | { | |
50299965 | 175 | return gl->gl_state == LM_ST_SHARED; |
b3b94faa DT |
176 | } |
177 | ||
009d8518 SW |
178 | static inline struct address_space *gfs2_glock2aspace(struct gfs2_glock *gl) |
179 | { | |
180 | if (gl->gl_ops->go_flags & GLOF_ASPACE) | |
181 | return (struct address_space *)(gl + 1); | |
182 | return NULL; | |
183 | } | |
184 | ||
8eae1ca0 SW |
185 | extern int gfs2_glock_get(struct gfs2_sbd *sdp, u64 number, |
186 | const struct gfs2_glock_operations *glops, | |
187 | int create, struct gfs2_glock **glp); | |
71c1b213 | 188 | extern void gfs2_glock_hold(struct gfs2_glock *gl); |
8eae1ca0 | 189 | extern void gfs2_glock_put(struct gfs2_glock *gl); |
71c1b213 | 190 | extern void gfs2_glock_queue_put(struct gfs2_glock *gl); |
8eae1ca0 | 191 | extern void gfs2_holder_init(struct gfs2_glock *gl, unsigned int state, |
b58bf407 BP |
192 | u16 flags, struct gfs2_holder *gh); |
193 | extern void gfs2_holder_reinit(unsigned int state, u16 flags, | |
8eae1ca0 SW |
194 | struct gfs2_holder *gh); |
195 | extern void gfs2_holder_uninit(struct gfs2_holder *gh); | |
196 | extern int gfs2_glock_nq(struct gfs2_holder *gh); | |
197 | extern int gfs2_glock_poll(struct gfs2_holder *gh); | |
198 | extern int gfs2_glock_wait(struct gfs2_holder *gh); | |
ad26967b | 199 | extern int gfs2_glock_async_wait(unsigned int num_gh, struct gfs2_holder *ghs); |
8eae1ca0 SW |
200 | extern void gfs2_glock_dq(struct gfs2_holder *gh); |
201 | extern void gfs2_glock_dq_wait(struct gfs2_holder *gh); | |
202 | extern void gfs2_glock_dq_uninit(struct gfs2_holder *gh); | |
203 | extern int gfs2_glock_nq_num(struct gfs2_sbd *sdp, u64 number, | |
204 | const struct gfs2_glock_operations *glops, | |
b58bf407 | 205 | unsigned int state, u16 flags, |
8eae1ca0 SW |
206 | struct gfs2_holder *gh); |
207 | extern int gfs2_glock_nq_m(unsigned int num_gh, struct gfs2_holder *ghs); | |
208 | extern void gfs2_glock_dq_m(unsigned int num_gh, struct gfs2_holder *ghs); | |
3792ce97 BP |
209 | extern void gfs2_dump_glock(struct seq_file *seq, struct gfs2_glock *gl, |
210 | bool fsid); | |
211 | #define GLOCK_BUG_ON(gl,x) do { if (unlikely(x)) { \ | |
212 | gfs2_dump_glock(NULL, gl, true); \ | |
213 | BUG(); } } while(0) | |
ea4e61c7 BP |
214 | #define gfs2_glock_assert_warn(gl, x) do { if (unlikely(!(x))) { \ |
215 | gfs2_dump_glock(NULL, gl, true); \ | |
216 | gfs2_assert_warn((gl)->gl_name.ln_sbd, (x)); } } \ | |
217 | while (0) | |
218 | #define gfs2_glock_assert_withdraw(gl, x) do { if (unlikely(!(x))) { \ | |
219 | gfs2_dump_glock(NULL, gl, true); \ | |
220 | gfs2_assert_withdraw((gl)->gl_name.ln_sbd, (x)); } } \ | |
221 | while (0) | |
222 | ||
8eae1ca0 | 223 | extern __printf(2, 3) |
6802e340 | 224 | void gfs2_print_dbg(struct seq_file *seq, const char *fmt, ...); |
b3b94faa | 225 | |
d0dc80db | 226 | /** |
33027af6 | 227 | * gfs2_glock_nq_init - initialize a holder and enqueue it on a glock |
d0dc80db SW |
228 | * @gl: the glock |
229 | * @state: the state we're requesting | |
230 | * @flags: the modifier flags | |
231 | * @gh: the holder structure | |
232 | * | |
233 | * Returns: 0, GLR_*, or errno | |
234 | */ | |
235 | ||
236 | static inline int gfs2_glock_nq_init(struct gfs2_glock *gl, | |
b58bf407 | 237 | unsigned int state, u16 flags, |
d0dc80db SW |
238 | struct gfs2_holder *gh) |
239 | { | |
240 | int error; | |
241 | ||
242 | gfs2_holder_init(gl, state, flags, gh); | |
243 | ||
244 | error = gfs2_glock_nq(gh); | |
245 | if (error) | |
246 | gfs2_holder_uninit(gh); | |
247 | ||
248 | return error; | |
249 | } | |
250 | ||
bc015cb8 SW |
251 | extern void gfs2_glock_cb(struct gfs2_glock *gl, unsigned int state); |
252 | extern void gfs2_glock_complete(struct gfs2_glock *gl, int ret); | |
a0e3cc65 AG |
253 | extern bool gfs2_queue_delete_work(struct gfs2_glock *gl, unsigned long delay); |
254 | extern void gfs2_cancel_delete_work(struct gfs2_glock *gl); | |
255 | extern bool gfs2_delete_work_queued(const struct gfs2_glock *gl); | |
256 | extern void gfs2_flush_delete_work(struct gfs2_sbd *sdp); | |
bc015cb8 SW |
257 | extern void gfs2_gl_hash_clear(struct gfs2_sbd *sdp); |
258 | extern void gfs2_glock_finish_truncate(struct gfs2_inode *ip); | |
259 | extern void gfs2_glock_thaw(struct gfs2_sbd *sdp); | |
29687a2a | 260 | extern void gfs2_glock_add_to_lru(struct gfs2_glock *gl); |
fc0e38da | 261 | extern void gfs2_glock_free(struct gfs2_glock *gl); |
bc015cb8 SW |
262 | |
263 | extern int __init gfs2_glock_init(void); | |
264 | extern void gfs2_glock_exit(void); | |
265 | ||
2abbf9a4 | 266 | extern void gfs2_create_debugfs_file(struct gfs2_sbd *sdp); |
bc015cb8 | 267 | extern void gfs2_delete_debugfs_file(struct gfs2_sbd *sdp); |
2abbf9a4 | 268 | extern void gfs2_register_debugfs(void); |
bc015cb8 | 269 | extern void gfs2_unregister_debugfs(void); |
85d1da67 | 270 | |
f057f6cd SW |
271 | extern const struct lm_lockops gfs2_dlm_ops; |
272 | ||
6df9f9a2 AG |
273 | static inline void gfs2_holder_mark_uninitialized(struct gfs2_holder *gh) |
274 | { | |
275 | gh->gh_gl = NULL; | |
276 | } | |
277 | ||
278 | static inline bool gfs2_holder_initialized(struct gfs2_holder *gh) | |
279 | { | |
280 | return gh->gh_gl; | |
281 | } | |
282 | ||
ad26967b BP |
283 | static inline bool gfs2_holder_queued(struct gfs2_holder *gh) |
284 | { | |
285 | return !list_empty(&gh->gh_list); | |
286 | } | |
287 | ||
df3d87bd BP |
288 | /** |
289 | * glock_set_object - set the gl_object field of a glock | |
290 | * @gl: the glock | |
291 | * @object: the object | |
292 | */ | |
4fd1a579 AG |
293 | static inline void glock_set_object(struct gfs2_glock *gl, void *object) |
294 | { | |
295 | spin_lock(&gl->gl_lockref.lock); | |
df3d87bd | 296 | if (gfs2_assert_warn(gl->gl_name.ln_sbd, gl->gl_object == NULL)) |
3792ce97 | 297 | gfs2_dump_glock(NULL, gl, true); |
4fd1a579 AG |
298 | gl->gl_object = object; |
299 | spin_unlock(&gl->gl_lockref.lock); | |
300 | } | |
301 | ||
df3d87bd BP |
302 | /** |
303 | * glock_clear_object - clear the gl_object field of a glock | |
304 | * @gl: the glock | |
305 | * @object: the object | |
306 | * | |
307 | * I'd love to similarly add this: | |
308 | * else if (gfs2_assert_warn(gl->gl_sbd, gl->gl_object == object)) | |
3792ce97 | 309 | * gfs2_dump_glock(NULL, gl, true); |
df3d87bd BP |
310 | * Unfortunately, that's not possible because as soon as gfs2_delete_inode |
311 | * frees the block in the rgrp, another process can reassign it for an I_NEW | |
312 | * inode in gfs2_create_inode because that calls new_inode, not gfs2_iget. | |
313 | * That means gfs2_delete_inode may subsequently try to call this function | |
314 | * for a glock that's already pointing to a brand new inode. If we clear the | |
315 | * new inode's gl_object, we'll introduce metadata corruption. Function | |
316 | * gfs2_delete_inode calls clear_inode which calls gfs2_clear_inode which also | |
317 | * tries to clear gl_object, so it's more than just gfs2_delete_inode. | |
318 | * | |
319 | */ | |
320 | static inline void glock_clear_object(struct gfs2_glock *gl, void *object) | |
321 | { | |
322 | spin_lock(&gl->gl_lockref.lock); | |
323 | if (gl->gl_object == object) | |
324 | gl->gl_object = NULL; | |
325 | spin_unlock(&gl->gl_lockref.lock); | |
326 | } | |
327 | ||
f286d627 AG |
328 | extern void gfs2_inode_remember_delete(struct gfs2_glock *gl, u64 generation); |
329 | extern bool gfs2_inode_already_deleted(struct gfs2_glock *gl, u64 generation); | |
330 | ||
b3b94faa | 331 | #endif /* __GLOCK_DOT_H__ */ |