Loading...
1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
4 * Copyright (C) 2004-2006 Red Hat, Inc. All rights reserved.
5 */
6
7#ifndef __GLOCK_DOT_H__
8#define __GLOCK_DOT_H__
9
10#include <linux/sched.h>
11#include <linux/parser.h>
12#include "incore.h"
13#include "util.h"
14
15/* Options for hostdata parser */
16
17enum {
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.
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.
83 */
84
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
90#define LM_FLAG_NODE_SCOPE 0x0020
91#define GL_ASYNC 0x0040
92#define GL_EXACT 0x0080
93#define GL_SKIP 0x0100
94#define GL_NOPID 0x0200
95#define GL_NOCACHE 0x0400
96
97/*
98 * lm_async_cb return flags
99 *
100 * LM_OUT_ST_MASK
101 * Masks the lower two bits of lock state in the returned value.
102 *
103 * LM_OUT_CANCELED
104 * The lock request was canceled.
105 *
106 */
107
108#define LM_OUT_ST_MASK 0x00000003
109#define LM_OUT_CANCELED 0x00000008
110#define LM_OUT_ERROR 0x00000004
111
112/*
113 * lm_recovery_done() messages
114 */
115
116#define LM_RD_GAVEUP 308
117#define LM_RD_SUCCESS 309
118
119#define GLR_TRYFAILED 13
120
121#define GL_GLOCK_MAX_HOLD (long)(HZ / 5)
122#define GL_GLOCK_DFT_HOLD (long)(HZ / 5)
123#define GL_GLOCK_MIN_HOLD (long)(10)
124#define GL_GLOCK_HOLD_INCR (long)(HZ / 20)
125#define GL_GLOCK_HOLD_DECR (long)(HZ / 40)
126
127struct lm_lockops {
128 const char *lm_proto_name;
129 int (*lm_mount) (struct gfs2_sbd *sdp, const char *table);
130 void (*lm_first_done) (struct gfs2_sbd *sdp);
131 void (*lm_recovery_result) (struct gfs2_sbd *sdp, unsigned int jid,
132 unsigned int result);
133 void (*lm_unmount) (struct gfs2_sbd *sdp);
134 void (*lm_withdraw) (struct gfs2_sbd *sdp);
135 void (*lm_put_lock) (struct gfs2_glock *gl);
136 int (*lm_lock) (struct gfs2_glock *gl, unsigned int req_state,
137 unsigned int flags);
138 void (*lm_cancel) (struct gfs2_glock *gl);
139 const match_table_t *lm_tokens;
140};
141
142struct gfs2_glock_aspace {
143 struct gfs2_glock glock;
144 struct address_space mapping;
145};
146
147extern struct workqueue_struct *gfs2_delete_workqueue;
148static inline struct gfs2_holder *gfs2_glock_is_locked_by_me(struct gfs2_glock *gl)
149{
150 struct gfs2_holder *gh;
151 struct pid *pid;
152
153 /* Look in glock's list of holders for one with current task as owner */
154 spin_lock(&gl->gl_lockref.lock);
155 pid = task_pid(current);
156 list_for_each_entry(gh, &gl->gl_holders, gh_list) {
157 if (!test_bit(HIF_HOLDER, &gh->gh_iflags))
158 break;
159 if (gh->gh_owner_pid == pid)
160 goto out;
161 }
162 gh = NULL;
163out:
164 spin_unlock(&gl->gl_lockref.lock);
165
166 return gh;
167}
168
169static inline int gfs2_glock_is_held_excl(struct gfs2_glock *gl)
170{
171 return gl->gl_state == LM_ST_EXCLUSIVE;
172}
173
174static inline int gfs2_glock_is_held_dfrd(struct gfs2_glock *gl)
175{
176 return gl->gl_state == LM_ST_DEFERRED;
177}
178
179static inline int gfs2_glock_is_held_shrd(struct gfs2_glock *gl)
180{
181 return gl->gl_state == LM_ST_SHARED;
182}
183
184static inline struct address_space *gfs2_glock2aspace(struct gfs2_glock *gl)
185{
186 if (gl->gl_ops->go_flags & GLOF_ASPACE) {
187 struct gfs2_glock_aspace *gla =
188 container_of(gl, struct gfs2_glock_aspace, glock);
189 return &gla->mapping;
190 }
191 return NULL;
192}
193
194extern int gfs2_glock_get(struct gfs2_sbd *sdp, u64 number,
195 const struct gfs2_glock_operations *glops,
196 int create, struct gfs2_glock **glp);
197extern struct gfs2_glock *gfs2_glock_hold(struct gfs2_glock *gl);
198extern void gfs2_glock_put(struct gfs2_glock *gl);
199extern void gfs2_glock_queue_put(struct gfs2_glock *gl);
200
201extern void __gfs2_holder_init(struct gfs2_glock *gl, unsigned int state,
202 u16 flags, struct gfs2_holder *gh,
203 unsigned long ip);
204static inline void gfs2_holder_init(struct gfs2_glock *gl, unsigned int state,
205 u16 flags, struct gfs2_holder *gh) {
206 __gfs2_holder_init(gl, state, flags, gh, _RET_IP_);
207}
208
209extern void gfs2_holder_reinit(unsigned int state, u16 flags,
210 struct gfs2_holder *gh);
211extern void gfs2_holder_uninit(struct gfs2_holder *gh);
212extern int gfs2_glock_nq(struct gfs2_holder *gh);
213extern int gfs2_glock_poll(struct gfs2_holder *gh);
214extern int gfs2_instantiate(struct gfs2_holder *gh);
215extern int gfs2_glock_holder_ready(struct gfs2_holder *gh);
216extern int gfs2_glock_wait(struct gfs2_holder *gh);
217extern int gfs2_glock_async_wait(unsigned int num_gh, struct gfs2_holder *ghs);
218extern void gfs2_glock_dq(struct gfs2_holder *gh);
219extern void gfs2_glock_dq_wait(struct gfs2_holder *gh);
220extern void gfs2_glock_dq_uninit(struct gfs2_holder *gh);
221extern int gfs2_glock_nq_num(struct gfs2_sbd *sdp, u64 number,
222 const struct gfs2_glock_operations *glops,
223 unsigned int state, u16 flags,
224 struct gfs2_holder *gh);
225extern int gfs2_glock_nq_m(unsigned int num_gh, struct gfs2_holder *ghs);
226extern void gfs2_glock_dq_m(unsigned int num_gh, struct gfs2_holder *ghs);
227extern void gfs2_dump_glock(struct seq_file *seq, struct gfs2_glock *gl,
228 bool fsid);
229#define GLOCK_BUG_ON(gl,x) do { if (unlikely(x)) { \
230 gfs2_dump_glock(NULL, gl, true); \
231 BUG(); } } while(0)
232#define gfs2_glock_assert_warn(gl, x) do { if (unlikely(!(x))) { \
233 gfs2_dump_glock(NULL, gl, true); \
234 gfs2_assert_warn((gl)->gl_name.ln_sbd, (x)); } } \
235 while (0)
236#define gfs2_glock_assert_withdraw(gl, x) do { if (unlikely(!(x))) { \
237 gfs2_dump_glock(NULL, gl, true); \
238 gfs2_assert_withdraw((gl)->gl_name.ln_sbd, (x)); } } \
239 while (0)
240
241extern __printf(2, 3)
242void gfs2_print_dbg(struct seq_file *seq, const char *fmt, ...);
243
244/**
245 * gfs2_glock_nq_init - initialize a holder and enqueue it on a glock
246 * @gl: the glock
247 * @state: the state we're requesting
248 * @flags: the modifier flags
249 * @gh: the holder structure
250 *
251 * Returns: 0, GLR_*, or errno
252 */
253
254static inline int gfs2_glock_nq_init(struct gfs2_glock *gl,
255 unsigned int state, u16 flags,
256 struct gfs2_holder *gh)
257{
258 int error;
259
260 __gfs2_holder_init(gl, state, flags, gh, _RET_IP_);
261
262 error = gfs2_glock_nq(gh);
263 if (error)
264 gfs2_holder_uninit(gh);
265
266 return error;
267}
268
269extern void gfs2_glock_cb(struct gfs2_glock *gl, unsigned int state);
270extern void gfs2_glock_complete(struct gfs2_glock *gl, int ret);
271extern bool gfs2_queue_delete_work(struct gfs2_glock *gl, unsigned long delay);
272extern void gfs2_cancel_delete_work(struct gfs2_glock *gl);
273extern bool gfs2_delete_work_queued(const struct gfs2_glock *gl);
274extern void gfs2_flush_delete_work(struct gfs2_sbd *sdp);
275extern void gfs2_gl_hash_clear(struct gfs2_sbd *sdp);
276extern void gfs2_gl_dq_holders(struct gfs2_sbd *sdp);
277extern void gfs2_glock_thaw(struct gfs2_sbd *sdp);
278extern void gfs2_glock_add_to_lru(struct gfs2_glock *gl);
279extern void gfs2_glock_free(struct gfs2_glock *gl);
280
281extern int __init gfs2_glock_init(void);
282extern void gfs2_glock_exit(void);
283
284extern void gfs2_create_debugfs_file(struct gfs2_sbd *sdp);
285extern void gfs2_delete_debugfs_file(struct gfs2_sbd *sdp);
286extern void gfs2_register_debugfs(void);
287extern void gfs2_unregister_debugfs(void);
288
289extern void glock_set_object(struct gfs2_glock *gl, void *object);
290extern void glock_clear_object(struct gfs2_glock *gl, void *object);
291
292extern const struct lm_lockops gfs2_dlm_ops;
293
294static inline void gfs2_holder_mark_uninitialized(struct gfs2_holder *gh)
295{
296 gh->gh_gl = NULL;
297}
298
299static inline bool gfs2_holder_initialized(struct gfs2_holder *gh)
300{
301 return gh->gh_gl;
302}
303
304static inline bool gfs2_holder_queued(struct gfs2_holder *gh)
305{
306 return !list_empty(&gh->gh_list);
307}
308
309extern void gfs2_inode_remember_delete(struct gfs2_glock *gl, u64 generation);
310extern bool gfs2_inode_already_deleted(struct gfs2_glock *gl, u64 generation);
311
312#endif /* __GLOCK_DOT_H__ */
1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
4 * Copyright (C) 2004-2006 Red Hat, Inc. All rights reserved.
5 */
6
7#ifndef __GLOCK_DOT_H__
8#define __GLOCK_DOT_H__
9
10#include <linux/sched.h>
11#include <linux/parser.h>
12#include "incore.h"
13#include "util.h"
14
15/* Options for hostdata parser */
16
17enum {
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_NODE_SCOPE
72 * This holder agrees to share the lock within this node. In other words,
73 * the glock is held in EX mode according to DLM, but local holders on the
74 * same node can share it.
75 */
76
77#define LM_FLAG_TRY 0x0001
78#define LM_FLAG_TRY_1CB 0x0002
79#define LM_FLAG_NOEXP 0x0004
80#define LM_FLAG_ANY 0x0008
81#define LM_FLAG_NODE_SCOPE 0x0020
82#define GL_ASYNC 0x0040
83#define GL_EXACT 0x0080
84#define GL_SKIP 0x0100
85#define GL_NOPID 0x0200
86#define GL_NOCACHE 0x0400
87#define GL_NOBLOCK 0x0800
88
89/*
90 * lm_async_cb return flags
91 *
92 * LM_OUT_ST_MASK
93 * Masks the lower two bits of lock state in the returned value.
94 *
95 * LM_OUT_CANCELED
96 * The lock request was canceled.
97 *
98 */
99
100#define LM_OUT_ST_MASK 0x00000003
101#define LM_OUT_CANCELED 0x00000008
102#define LM_OUT_ERROR 0x00000004
103
104/*
105 * lm_recovery_done() messages
106 */
107
108#define LM_RD_GAVEUP 308
109#define LM_RD_SUCCESS 309
110
111#define GLR_TRYFAILED 13
112
113#define GL_GLOCK_MAX_HOLD (long)(HZ / 5)
114#define GL_GLOCK_DFT_HOLD (long)(HZ / 5)
115#define GL_GLOCK_MIN_HOLD (long)(10)
116#define GL_GLOCK_HOLD_INCR (long)(HZ / 20)
117#define GL_GLOCK_HOLD_DECR (long)(HZ / 40)
118
119struct lm_lockops {
120 const char *lm_proto_name;
121 int (*lm_mount) (struct gfs2_sbd *sdp, const char *table);
122 void (*lm_first_done) (struct gfs2_sbd *sdp);
123 void (*lm_recovery_result) (struct gfs2_sbd *sdp, unsigned int jid,
124 unsigned int result);
125 void (*lm_unmount) (struct gfs2_sbd *sdp);
126 void (*lm_withdraw) (struct gfs2_sbd *sdp);
127 void (*lm_put_lock) (struct gfs2_glock *gl);
128 int (*lm_lock) (struct gfs2_glock *gl, unsigned int req_state,
129 unsigned int flags);
130 void (*lm_cancel) (struct gfs2_glock *gl);
131 const match_table_t *lm_tokens;
132};
133
134struct gfs2_glock_aspace {
135 struct gfs2_glock glock;
136 struct address_space mapping;
137};
138
139static inline struct gfs2_holder *gfs2_glock_is_locked_by_me(struct gfs2_glock *gl)
140{
141 struct gfs2_holder *gh;
142 struct pid *pid;
143
144 /* Look in glock's list of holders for one with current task as owner */
145 spin_lock(&gl->gl_lockref.lock);
146 pid = task_pid(current);
147 list_for_each_entry(gh, &gl->gl_holders, gh_list) {
148 if (!test_bit(HIF_HOLDER, &gh->gh_iflags))
149 break;
150 if (gh->gh_owner_pid == pid)
151 goto out;
152 }
153 gh = NULL;
154out:
155 spin_unlock(&gl->gl_lockref.lock);
156
157 return gh;
158}
159
160static inline struct address_space *gfs2_glock2aspace(struct gfs2_glock *gl)
161{
162 if (gl->gl_ops->go_flags & GLOF_ASPACE) {
163 struct gfs2_glock_aspace *gla =
164 container_of(gl, struct gfs2_glock_aspace, glock);
165 return &gla->mapping;
166 }
167 return NULL;
168}
169
170int gfs2_glock_get(struct gfs2_sbd *sdp, u64 number,
171 const struct gfs2_glock_operations *glops,
172 int create, struct gfs2_glock **glp);
173struct gfs2_glock *gfs2_glock_hold(struct gfs2_glock *gl);
174void gfs2_glock_put(struct gfs2_glock *gl);
175void gfs2_glock_put_async(struct gfs2_glock *gl);
176
177void __gfs2_holder_init(struct gfs2_glock *gl, unsigned int state,
178 u16 flags, struct gfs2_holder *gh,
179 unsigned long ip);
180static inline void gfs2_holder_init(struct gfs2_glock *gl, unsigned int state,
181 u16 flags, struct gfs2_holder *gh) {
182 __gfs2_holder_init(gl, state, flags, gh, _RET_IP_);
183}
184
185void gfs2_holder_reinit(unsigned int state, u16 flags,
186 struct gfs2_holder *gh);
187void gfs2_holder_uninit(struct gfs2_holder *gh);
188int gfs2_glock_nq(struct gfs2_holder *gh);
189int gfs2_glock_poll(struct gfs2_holder *gh);
190int gfs2_instantiate(struct gfs2_holder *gh);
191int gfs2_glock_holder_ready(struct gfs2_holder *gh);
192int gfs2_glock_wait(struct gfs2_holder *gh);
193int gfs2_glock_async_wait(unsigned int num_gh, struct gfs2_holder *ghs);
194void gfs2_glock_dq(struct gfs2_holder *gh);
195void gfs2_glock_dq_wait(struct gfs2_holder *gh);
196void gfs2_glock_dq_uninit(struct gfs2_holder *gh);
197int gfs2_glock_nq_num(struct gfs2_sbd *sdp, u64 number,
198 const struct gfs2_glock_operations *glops,
199 unsigned int state, u16 flags,
200 struct gfs2_holder *gh);
201int gfs2_glock_nq_m(unsigned int num_gh, struct gfs2_holder *ghs);
202void gfs2_glock_dq_m(unsigned int num_gh, struct gfs2_holder *ghs);
203void gfs2_dump_glock(struct seq_file *seq, struct gfs2_glock *gl,
204 bool fsid);
205#define GLOCK_BUG_ON(gl,x) do { if (unlikely(x)) { \
206 gfs2_dump_glock(NULL, gl, true); \
207 BUG(); } } while(0)
208#define gfs2_glock_assert_warn(gl, x) do { if (unlikely(!(x))) { \
209 gfs2_dump_glock(NULL, gl, true); \
210 gfs2_assert_warn((gl)->gl_name.ln_sbd, (x)); } } \
211 while (0)
212#define gfs2_glock_assert_withdraw(gl, x) do { if (unlikely(!(x))) { \
213 gfs2_dump_glock(NULL, gl, true); \
214 gfs2_assert_withdraw((gl)->gl_name.ln_sbd, (x)); } } \
215 while (0)
216
217__printf(2, 3)
218void gfs2_print_dbg(struct seq_file *seq, const char *fmt, ...);
219
220/**
221 * gfs2_glock_nq_init - initialize a holder and enqueue it on a glock
222 * @gl: the glock
223 * @state: the state we're requesting
224 * @flags: the modifier flags
225 * @gh: the holder structure
226 *
227 * Returns: 0, GLR_*, or errno
228 */
229
230static inline int gfs2_glock_nq_init(struct gfs2_glock *gl,
231 unsigned int state, u16 flags,
232 struct gfs2_holder *gh)
233{
234 int error;
235
236 __gfs2_holder_init(gl, state, flags, gh, _RET_IP_);
237
238 error = gfs2_glock_nq(gh);
239 if (error)
240 gfs2_holder_uninit(gh);
241
242 return error;
243}
244
245void gfs2_glock_cb(struct gfs2_glock *gl, unsigned int state);
246void gfs2_glock_complete(struct gfs2_glock *gl, int ret);
247bool gfs2_queue_try_to_evict(struct gfs2_glock *gl);
248bool gfs2_queue_verify_delete(struct gfs2_glock *gl, bool later);
249void gfs2_cancel_delete_work(struct gfs2_glock *gl);
250void gfs2_flush_delete_work(struct gfs2_sbd *sdp);
251void gfs2_gl_hash_clear(struct gfs2_sbd *sdp);
252void gfs2_gl_dq_holders(struct gfs2_sbd *sdp);
253void gfs2_glock_thaw(struct gfs2_sbd *sdp);
254void gfs2_glock_free(struct gfs2_glock *gl);
255void gfs2_glock_free_later(struct gfs2_glock *gl);
256
257int __init gfs2_glock_init(void);
258void gfs2_glock_exit(void);
259
260void gfs2_create_debugfs_file(struct gfs2_sbd *sdp);
261void gfs2_delete_debugfs_file(struct gfs2_sbd *sdp);
262void gfs2_register_debugfs(void);
263void gfs2_unregister_debugfs(void);
264
265void glock_set_object(struct gfs2_glock *gl, void *object);
266void glock_clear_object(struct gfs2_glock *gl, void *object);
267
268extern const struct lm_lockops gfs2_dlm_ops;
269
270static inline void gfs2_holder_mark_uninitialized(struct gfs2_holder *gh)
271{
272 gh->gh_gl = NULL;
273}
274
275static inline bool gfs2_holder_initialized(struct gfs2_holder *gh)
276{
277 return gh->gh_gl;
278}
279
280static inline bool gfs2_holder_queued(struct gfs2_holder *gh)
281{
282 return !list_empty(&gh->gh_list);
283}
284
285void gfs2_inode_remember_delete(struct gfs2_glock *gl, u64 generation);
286bool gfs2_inode_already_deleted(struct gfs2_glock *gl, u64 generation);
287
288static inline bool glock_needs_demote(struct gfs2_glock *gl)
289{
290 return (test_bit(GLF_DEMOTE, &gl->gl_flags) ||
291 test_bit(GLF_PENDING_DEMOTE, &gl->gl_flags));
292}
293
294#endif /* __GLOCK_DOT_H__ */