17336d0e6SThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-only */
2b3b94faaSDavid Teigland /*
3b3b94faaSDavid Teigland * Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
43a8a9a10SSteven Whitehouse * Copyright (C) 2004-2006 Red Hat, Inc. All rights reserved.
5b3b94faaSDavid Teigland */
6b3b94faaSDavid Teigland
7b3b94faaSDavid Teigland #ifndef __GLOCK_DOT_H__
8b3b94faaSDavid Teigland #define __GLOCK_DOT_H__
9b3b94faaSDavid Teigland
10e8edc6e0SAlexey Dobriyan #include <linux/sched.h>
11f057f6cdSSteven Whitehouse #include <linux/parser.h>
12f2f7ba52SSteven Whitehouse #include "incore.h"
13df3d87bdSBob Peterson #include "util.h"
14f2f7ba52SSteven Whitehouse
15f057f6cdSSteven Whitehouse /* Options for hostdata parser */
16f057f6cdSSteven Whitehouse
17f057f6cdSSteven Whitehouse enum {
18f057f6cdSSteven Whitehouse Opt_jid,
19f057f6cdSSteven Whitehouse Opt_id,
20f057f6cdSSteven Whitehouse Opt_first,
21f057f6cdSSteven Whitehouse Opt_nodir,
22f057f6cdSSteven Whitehouse Opt_err,
23f057f6cdSSteven Whitehouse };
24f057f6cdSSteven Whitehouse
25f057f6cdSSteven Whitehouse /*
26f057f6cdSSteven Whitehouse * lm_lockname types
27f057f6cdSSteven Whitehouse */
28f057f6cdSSteven Whitehouse
29f057f6cdSSteven Whitehouse #define LM_TYPE_RESERVED 0x00
30f057f6cdSSteven Whitehouse #define LM_TYPE_NONDISK 0x01
31f057f6cdSSteven Whitehouse #define LM_TYPE_INODE 0x02
32f057f6cdSSteven Whitehouse #define LM_TYPE_RGRP 0x03
33f057f6cdSSteven Whitehouse #define LM_TYPE_META 0x04
34f057f6cdSSteven Whitehouse #define LM_TYPE_IOPEN 0x05
35f057f6cdSSteven Whitehouse #define LM_TYPE_FLOCK 0x06
36f057f6cdSSteven Whitehouse #define LM_TYPE_PLOCK 0x07
37f057f6cdSSteven Whitehouse #define LM_TYPE_QUOTA 0x08
38f057f6cdSSteven Whitehouse #define LM_TYPE_JOURNAL 0x09
39f057f6cdSSteven Whitehouse
40f057f6cdSSteven Whitehouse /*
41f057f6cdSSteven Whitehouse * lm_lock() states
42f057f6cdSSteven Whitehouse *
43f057f6cdSSteven Whitehouse * SHARED is compatible with SHARED, not with DEFERRED or EX.
44f057f6cdSSteven Whitehouse * DEFERRED is compatible with DEFERRED, not with SHARED or EX.
45f057f6cdSSteven Whitehouse */
46f057f6cdSSteven Whitehouse
47f057f6cdSSteven Whitehouse #define LM_ST_UNLOCKED 0
48f057f6cdSSteven Whitehouse #define LM_ST_EXCLUSIVE 1
49f057f6cdSSteven Whitehouse #define LM_ST_DEFERRED 2
50f057f6cdSSteven Whitehouse #define LM_ST_SHARED 3
51f057f6cdSSteven Whitehouse
52f057f6cdSSteven Whitehouse /*
53f057f6cdSSteven Whitehouse * lm_lock() flags
54f057f6cdSSteven Whitehouse *
55f057f6cdSSteven Whitehouse * LM_FLAG_TRY
56f057f6cdSSteven Whitehouse * Don't wait to acquire the lock if it can't be granted immediately.
57f057f6cdSSteven Whitehouse *
58f057f6cdSSteven Whitehouse * LM_FLAG_TRY_1CB
59f057f6cdSSteven Whitehouse * Send one blocking callback if TRY is set and the lock is not granted.
60f057f6cdSSteven Whitehouse *
61f057f6cdSSteven Whitehouse * LM_FLAG_NOEXP
62f057f6cdSSteven Whitehouse * GFS sets this flag on lock requests it makes while doing journal recovery.
63f057f6cdSSteven Whitehouse * These special requests should not be blocked due to the recovery like
64f057f6cdSSteven Whitehouse * ordinary locks would be.
65f057f6cdSSteven Whitehouse *
66f057f6cdSSteven Whitehouse * LM_FLAG_ANY
67f057f6cdSSteven Whitehouse * A SHARED request may also be granted in DEFERRED, or a DEFERRED request may
68f057f6cdSSteven Whitehouse * also be granted in SHARED. The preferred state is whichever is compatible
69f057f6cdSSteven Whitehouse * with other granted locks, or the specified state if no other locks exist.
70f057f6cdSSteven Whitehouse *
7106e908cdSBob Peterson * LM_FLAG_NODE_SCOPE
7206e908cdSBob Peterson * This holder agrees to share the lock within this node. In other words,
7306e908cdSBob Peterson * the glock is held in EX mode according to DLM, but local holders on the
7406e908cdSBob Peterson * same node can share it.
75f057f6cdSSteven Whitehouse */
76f057f6cdSSteven Whitehouse
77b58bf407SBob Peterson #define LM_FLAG_TRY 0x0001
78b58bf407SBob Peterson #define LM_FLAG_TRY_1CB 0x0002
79b58bf407SBob Peterson #define LM_FLAG_NOEXP 0x0004
80b58bf407SBob Peterson #define LM_FLAG_ANY 0x0008
8106e908cdSBob Peterson #define LM_FLAG_NODE_SCOPE 0x0020
82b58bf407SBob Peterson #define GL_ASYNC 0x0040
83b58bf407SBob Peterson #define GL_EXACT 0x0080
84b58bf407SBob Peterson #define GL_SKIP 0x0100
85cbe6d257SAndreas Gruenbacher #define GL_NOPID 0x0200
86b58bf407SBob Peterson #define GL_NOCACHE 0x0400
87f9f229c1SAndreas Gruenbacher #define GL_NOBLOCK 0x0800
88f057f6cdSSteven Whitehouse
89f057f6cdSSteven Whitehouse /*
90921169caSSteven Whitehouse * lm_async_cb return flags
91f057f6cdSSteven Whitehouse *
92f057f6cdSSteven Whitehouse * LM_OUT_ST_MASK
93f057f6cdSSteven Whitehouse * Masks the lower two bits of lock state in the returned value.
94f057f6cdSSteven Whitehouse *
95f057f6cdSSteven Whitehouse * LM_OUT_CANCELED
96f057f6cdSSteven Whitehouse * The lock request was canceled.
97f057f6cdSSteven Whitehouse *
98f057f6cdSSteven Whitehouse */
99f057f6cdSSteven Whitehouse
100f057f6cdSSteven Whitehouse #define LM_OUT_ST_MASK 0x00000003
101f057f6cdSSteven Whitehouse #define LM_OUT_CANCELED 0x00000008
102921169caSSteven Whitehouse #define LM_OUT_ERROR 0x00000004
103f057f6cdSSteven Whitehouse
104f057f6cdSSteven Whitehouse /*
105f057f6cdSSteven Whitehouse * lm_recovery_done() messages
106f057f6cdSSteven Whitehouse */
107f057f6cdSSteven Whitehouse
108f057f6cdSSteven Whitehouse #define LM_RD_GAVEUP 308
109f057f6cdSSteven Whitehouse #define LM_RD_SUCCESS 309
110f057f6cdSSteven Whitehouse
111f057f6cdSSteven Whitehouse #define GLR_TRYFAILED 13
112f057f6cdSSteven Whitehouse
1137cf8dcd3SBob Peterson #define GL_GLOCK_MAX_HOLD (long)(HZ / 5)
1147cf8dcd3SBob Peterson #define GL_GLOCK_DFT_HOLD (long)(HZ / 5)
1157cf8dcd3SBob Peterson #define GL_GLOCK_MIN_HOLD (long)(10)
1167cf8dcd3SBob Peterson #define GL_GLOCK_HOLD_INCR (long)(HZ / 20)
1177cf8dcd3SBob Peterson #define GL_GLOCK_HOLD_DECR (long)(HZ / 40)
1187cf8dcd3SBob Peterson
119f057f6cdSSteven Whitehouse struct lm_lockops {
120f057f6cdSSteven Whitehouse const char *lm_proto_name;
121e0c2a9aaSDavid Teigland int (*lm_mount) (struct gfs2_sbd *sdp, const char *table);
122e0c2a9aaSDavid Teigland void (*lm_first_done) (struct gfs2_sbd *sdp);
123e0c2a9aaSDavid Teigland void (*lm_recovery_result) (struct gfs2_sbd *sdp, unsigned int jid,
124e0c2a9aaSDavid Teigland unsigned int result);
125f057f6cdSSteven Whitehouse void (*lm_unmount) (struct gfs2_sbd *sdp);
126f057f6cdSSteven Whitehouse void (*lm_withdraw) (struct gfs2_sbd *sdp);
127bc015cb8SSteven Whitehouse void (*lm_put_lock) (struct gfs2_glock *gl);
128921169caSSteven Whitehouse int (*lm_lock) (struct gfs2_glock *gl, unsigned int req_state,
129921169caSSteven Whitehouse unsigned int flags);
130f057f6cdSSteven Whitehouse void (*lm_cancel) (struct gfs2_glock *gl);
131f057f6cdSSteven Whitehouse const match_table_t *lm_tokens;
132f057f6cdSSteven Whitehouse };
133f057f6cdSSteven Whitehouse
13411d8b79eSKees Cook struct gfs2_glock_aspace {
13511d8b79eSKees Cook struct gfs2_glock glock;
13611d8b79eSKees Cook struct address_space mapping;
13711d8b79eSKees Cook };
13811d8b79eSKees Cook
gfs2_glock_is_locked_by_me(struct gfs2_glock * gl)1397afd88d9SSteven Whitehouse static inline struct gfs2_holder *gfs2_glock_is_locked_by_me(struct gfs2_glock *gl)
140b3b94faaSDavid Teigland {
141b3b94faaSDavid Teigland struct gfs2_holder *gh;
142b1e058daSPavel Emelyanov struct pid *pid;
143b3b94faaSDavid Teigland
144b3b94faaSDavid Teigland /* Look in glock's list of holders for one with current task as owner */
145f3dd1649SAndreas Gruenbacher spin_lock(&gl->gl_lockref.lock);
146b1e058daSPavel Emelyanov pid = task_pid(current);
147b3b94faaSDavid Teigland list_for_each_entry(gh, &gl->gl_holders, gh_list) {
1486802e340SSteven Whitehouse if (!test_bit(HIF_HOLDER, &gh->gh_iflags))
1496802e340SSteven Whitehouse break;
1507afd88d9SSteven Whitehouse if (gh->gh_owner_pid == pid)
1517afd88d9SSteven Whitehouse goto out;
152b3b94faaSDavid Teigland }
1537afd88d9SSteven Whitehouse gh = NULL;
1547afd88d9SSteven Whitehouse out:
155f3dd1649SAndreas Gruenbacher spin_unlock(&gl->gl_lockref.lock);
156b3b94faaSDavid Teigland
1577afd88d9SSteven Whitehouse return gh;
158b3b94faaSDavid Teigland }
159b3b94faaSDavid Teigland
gfs2_glock2aspace(struct gfs2_glock * gl)160009d8518SSteven Whitehouse static inline struct address_space *gfs2_glock2aspace(struct gfs2_glock *gl)
161009d8518SSteven Whitehouse {
16211d8b79eSKees Cook if (gl->gl_ops->go_flags & GLOF_ASPACE) {
16311d8b79eSKees Cook struct gfs2_glock_aspace *gla =
16411d8b79eSKees Cook container_of(gl, struct gfs2_glock_aspace, glock);
16511d8b79eSKees Cook return &gla->mapping;
16611d8b79eSKees Cook }
167009d8518SSteven Whitehouse return NULL;
168009d8518SSteven Whitehouse }
169009d8518SSteven Whitehouse
1700b2355feSAndreas Gruenbacher int gfs2_glock_get(struct gfs2_sbd *sdp, u64 number,
1718eae1ca0SSteven Whitehouse const struct gfs2_glock_operations *glops,
172b3b94faaSDavid Teigland int create, struct gfs2_glock **glp);
1730b2355feSAndreas Gruenbacher struct gfs2_glock *gfs2_glock_hold(struct gfs2_glock *gl);
1740b2355feSAndreas Gruenbacher void gfs2_glock_put(struct gfs2_glock *gl);
175ee2be7d7SAndreas Gruenbacher void gfs2_glock_put_async(struct gfs2_glock *gl);
176b016d9a8SAndreas Gruenbacher
1770b2355feSAndreas Gruenbacher void __gfs2_holder_init(struct gfs2_glock *gl, unsigned int state,
178b016d9a8SAndreas Gruenbacher u16 flags, struct gfs2_holder *gh,
179b016d9a8SAndreas Gruenbacher unsigned long ip);
gfs2_holder_init(struct gfs2_glock * gl,unsigned int state,u16 flags,struct gfs2_holder * gh)180b016d9a8SAndreas Gruenbacher static inline void gfs2_holder_init(struct gfs2_glock *gl, unsigned int state,
181b016d9a8SAndreas Gruenbacher u16 flags, struct gfs2_holder *gh) {
182b016d9a8SAndreas Gruenbacher __gfs2_holder_init(gl, state, flags, gh, _RET_IP_);
183b016d9a8SAndreas Gruenbacher }
184b016d9a8SAndreas Gruenbacher
1850b2355feSAndreas Gruenbacher void gfs2_holder_reinit(unsigned int state, u16 flags,
186b3b94faaSDavid Teigland struct gfs2_holder *gh);
1870b2355feSAndreas Gruenbacher void gfs2_holder_uninit(struct gfs2_holder *gh);
1880b2355feSAndreas Gruenbacher int gfs2_glock_nq(struct gfs2_holder *gh);
1890b2355feSAndreas Gruenbacher int gfs2_glock_poll(struct gfs2_holder *gh);
1900b2355feSAndreas Gruenbacher int gfs2_instantiate(struct gfs2_holder *gh);
1910b2355feSAndreas Gruenbacher int gfs2_glock_holder_ready(struct gfs2_holder *gh);
1920b2355feSAndreas Gruenbacher int gfs2_glock_wait(struct gfs2_holder *gh);
1930b2355feSAndreas Gruenbacher int gfs2_glock_async_wait(unsigned int num_gh, struct gfs2_holder *ghs);
1940b2355feSAndreas Gruenbacher void gfs2_glock_dq(struct gfs2_holder *gh);
1950b2355feSAndreas Gruenbacher void gfs2_glock_dq_wait(struct gfs2_holder *gh);
1960b2355feSAndreas Gruenbacher void gfs2_glock_dq_uninit(struct gfs2_holder *gh);
1970b2355feSAndreas Gruenbacher int gfs2_glock_nq_num(struct gfs2_sbd *sdp, u64 number,
1988eae1ca0SSteven Whitehouse const struct gfs2_glock_operations *glops,
199b58bf407SBob Peterson unsigned int state, u16 flags,
200190562bdSSteven Whitehouse struct gfs2_holder *gh);
2010b2355feSAndreas Gruenbacher int gfs2_glock_nq_m(unsigned int num_gh, struct gfs2_holder *ghs);
2020b2355feSAndreas Gruenbacher void gfs2_glock_dq_m(unsigned int num_gh, struct gfs2_holder *ghs);
2030b2355feSAndreas Gruenbacher void gfs2_dump_glock(struct seq_file *seq, struct gfs2_glock *gl,
2043792ce97SBob Peterson bool fsid);
2053792ce97SBob Peterson #define GLOCK_BUG_ON(gl,x) do { if (unlikely(x)) { \
2063792ce97SBob Peterson gfs2_dump_glock(NULL, gl, true); \
2073792ce97SBob Peterson BUG(); } } while(0)
208ea4e61c7SBob Peterson #define gfs2_glock_assert_warn(gl, x) do { if (unlikely(!(x))) { \
209ea4e61c7SBob Peterson gfs2_dump_glock(NULL, gl, true); \
210ea4e61c7SBob Peterson gfs2_assert_warn((gl)->gl_name.ln_sbd, (x)); } } \
211ea4e61c7SBob Peterson while (0)
212ea4e61c7SBob Peterson #define gfs2_glock_assert_withdraw(gl, x) do { if (unlikely(!(x))) { \
213ea4e61c7SBob Peterson gfs2_dump_glock(NULL, gl, true); \
214ea4e61c7SBob Peterson gfs2_assert_withdraw((gl)->gl_name.ln_sbd, (x)); } } \
215ea4e61c7SBob Peterson while (0)
216ea4e61c7SBob Peterson
2170b2355feSAndreas Gruenbacher __printf(2, 3)
2186802e340SSteven Whitehouse void gfs2_print_dbg(struct seq_file *seq, const char *fmt, ...);
219b3b94faaSDavid Teigland
220d0dc80dbSSteven Whitehouse /**
22133027af6SAndrea Gelmini * gfs2_glock_nq_init - initialize a holder and enqueue it on a glock
222d0dc80dbSSteven Whitehouse * @gl: the glock
223d0dc80dbSSteven Whitehouse * @state: the state we're requesting
224d0dc80dbSSteven Whitehouse * @flags: the modifier flags
225d0dc80dbSSteven Whitehouse * @gh: the holder structure
226d0dc80dbSSteven Whitehouse *
227d0dc80dbSSteven Whitehouse * Returns: 0, GLR_*, or errno
228d0dc80dbSSteven Whitehouse */
229d0dc80dbSSteven Whitehouse
gfs2_glock_nq_init(struct gfs2_glock * gl,unsigned int state,u16 flags,struct gfs2_holder * gh)230d0dc80dbSSteven Whitehouse static inline int gfs2_glock_nq_init(struct gfs2_glock *gl,
231b58bf407SBob Peterson unsigned int state, u16 flags,
232d0dc80dbSSteven Whitehouse struct gfs2_holder *gh)
233d0dc80dbSSteven Whitehouse {
234d0dc80dbSSteven Whitehouse int error;
235d0dc80dbSSteven Whitehouse
236b016d9a8SAndreas Gruenbacher __gfs2_holder_init(gl, state, flags, gh, _RET_IP_);
237d0dc80dbSSteven Whitehouse
238d0dc80dbSSteven Whitehouse error = gfs2_glock_nq(gh);
239d0dc80dbSSteven Whitehouse if (error)
240d0dc80dbSSteven Whitehouse gfs2_holder_uninit(gh);
241d0dc80dbSSteven Whitehouse
242d0dc80dbSSteven Whitehouse return error;
243d0dc80dbSSteven Whitehouse }
244d0dc80dbSSteven Whitehouse
2450b2355feSAndreas Gruenbacher void gfs2_glock_cb(struct gfs2_glock *gl, unsigned int state);
2460b2355feSAndreas Gruenbacher void gfs2_glock_complete(struct gfs2_glock *gl, int ret);
2470b2355feSAndreas Gruenbacher bool gfs2_queue_try_to_evict(struct gfs2_glock *gl);
2480b2355feSAndreas Gruenbacher void gfs2_cancel_delete_work(struct gfs2_glock *gl);
2490b2355feSAndreas Gruenbacher void gfs2_flush_delete_work(struct gfs2_sbd *sdp);
2500b2355feSAndreas Gruenbacher void gfs2_gl_hash_clear(struct gfs2_sbd *sdp);
2510b2355feSAndreas Gruenbacher void gfs2_gl_dq_holders(struct gfs2_sbd *sdp);
2520b2355feSAndreas Gruenbacher void gfs2_glock_thaw(struct gfs2_sbd *sdp);
2530b2355feSAndreas Gruenbacher void gfs2_glock_free(struct gfs2_glock *gl);
254*d98779e6SAndreas Gruenbacher void gfs2_glock_free_later(struct gfs2_glock *gl);
255b3b94faaSDavid Teigland
2560b2355feSAndreas Gruenbacher int __init gfs2_glock_init(void);
2570b2355feSAndreas Gruenbacher void gfs2_glock_exit(void);
258b3b94faaSDavid Teigland
2590b2355feSAndreas Gruenbacher void gfs2_create_debugfs_file(struct gfs2_sbd *sdp);
2600b2355feSAndreas Gruenbacher void gfs2_delete_debugfs_file(struct gfs2_sbd *sdp);
2610b2355feSAndreas Gruenbacher void gfs2_register_debugfs(void);
2620b2355feSAndreas Gruenbacher void gfs2_unregister_debugfs(void);
26385d1da67SSteven Whitehouse
2640b2355feSAndreas Gruenbacher void glock_set_object(struct gfs2_glock *gl, void *object);
2650b2355feSAndreas Gruenbacher void glock_clear_object(struct gfs2_glock *gl, void *object);
2663781ec9eSAndreas Gruenbacher
267f057f6cdSSteven Whitehouse extern const struct lm_lockops gfs2_dlm_ops;
268f057f6cdSSteven Whitehouse
gfs2_holder_mark_uninitialized(struct gfs2_holder * gh)2696df9f9a2SAndreas Gruenbacher static inline void gfs2_holder_mark_uninitialized(struct gfs2_holder *gh)
2706df9f9a2SAndreas Gruenbacher {
2716df9f9a2SAndreas Gruenbacher gh->gh_gl = NULL;
2726df9f9a2SAndreas Gruenbacher }
2736df9f9a2SAndreas Gruenbacher
gfs2_holder_initialized(struct gfs2_holder * gh)2746df9f9a2SAndreas Gruenbacher static inline bool gfs2_holder_initialized(struct gfs2_holder *gh)
2756df9f9a2SAndreas Gruenbacher {
2766df9f9a2SAndreas Gruenbacher return gh->gh_gl;
2776df9f9a2SAndreas Gruenbacher }
2786df9f9a2SAndreas Gruenbacher
gfs2_holder_queued(struct gfs2_holder * gh)279ad26967bSBob Peterson static inline bool gfs2_holder_queued(struct gfs2_holder *gh)
280ad26967bSBob Peterson {
281ad26967bSBob Peterson return !list_empty(&gh->gh_list);
282ad26967bSBob Peterson }
283ad26967bSBob Peterson
2840b2355feSAndreas Gruenbacher void gfs2_inode_remember_delete(struct gfs2_glock *gl, u64 generation);
2850b2355feSAndreas Gruenbacher bool gfs2_inode_already_deleted(struct gfs2_glock *gl, u64 generation);
286f286d627SAndreas Gruenbacher
287b3b94faaSDavid Teigland #endif /* __GLOCK_DOT_H__ */
288