blob: 69f66e3d22bf512787b3b9db403e0c8c91babd59 [file] [log] [blame]
David Teiglandb3b94fa2006-01-16 16:50:04 +00001/*
2 * Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
Steven Whitehouse3a8a9a12006-05-18 15:09:15 -04003 * Copyright (C) 2004-2006 Red Hat, Inc. All rights reserved.
David Teiglandb3b94fa2006-01-16 16:50:04 +00004 *
5 * This copyrighted material is made available to anyone wishing to use,
6 * modify, copy, or redistribute it subject to the terms and conditions
Steven Whitehousee9fc2aa2006-09-01 11:05:15 -04007 * of the GNU General Public License version 2.
David Teiglandb3b94fa2006-01-16 16:50:04 +00008 */
9
10#ifndef __GLOCK_DOT_H__
11#define __GLOCK_DOT_H__
12
Alexey Dobriyane8edc6e2007-05-21 01:22:52 +040013#include <linux/sched.h>
Steven Whitehousef057f6c2009-01-12 10:43:39 +000014#include <linux/parser.h>
Steven Whitehousef2f7ba52006-09-05 10:39:21 -040015#include "incore.h"
16
Steven Whitehousef057f6c2009-01-12 10:43:39 +000017/* Options for hostdata parser */
18
19enum {
20 Opt_jid,
21 Opt_id,
22 Opt_first,
23 Opt_nodir,
24 Opt_err,
25};
26
27/*
28 * lm_lockname types
29 */
30
31#define LM_TYPE_RESERVED 0x00
32#define LM_TYPE_NONDISK 0x01
33#define LM_TYPE_INODE 0x02
34#define LM_TYPE_RGRP 0x03
35#define LM_TYPE_META 0x04
36#define LM_TYPE_IOPEN 0x05
37#define LM_TYPE_FLOCK 0x06
38#define LM_TYPE_PLOCK 0x07
39#define LM_TYPE_QUOTA 0x08
40#define LM_TYPE_JOURNAL 0x09
41
42/*
43 * lm_lock() states
44 *
45 * SHARED is compatible with SHARED, not with DEFERRED or EX.
46 * DEFERRED is compatible with DEFERRED, not with SHARED or EX.
47 */
48
49#define LM_ST_UNLOCKED 0
50#define LM_ST_EXCLUSIVE 1
51#define LM_ST_DEFERRED 2
52#define LM_ST_SHARED 3
53
54/*
55 * lm_lock() flags
56 *
57 * LM_FLAG_TRY
58 * Don't wait to acquire the lock if it can't be granted immediately.
59 *
60 * LM_FLAG_TRY_1CB
61 * Send one blocking callback if TRY is set and the lock is not granted.
62 *
63 * LM_FLAG_NOEXP
64 * GFS sets this flag on lock requests it makes while doing journal recovery.
65 * These special requests should not be blocked due to the recovery like
66 * ordinary locks would be.
67 *
68 * LM_FLAG_ANY
69 * A SHARED request may also be granted in DEFERRED, or a DEFERRED request may
70 * also be granted in SHARED. The preferred state is whichever is compatible
71 * with other granted locks, or the specified state if no other locks exist.
72 *
73 * LM_FLAG_PRIORITY
74 * Override fairness considerations. Suppose a lock is held in a shared state
75 * and there is a pending request for the deferred state. A shared lock
76 * request with the priority flag would be allowed to bypass the deferred
77 * request and directly join the other shared lock. A shared lock request
78 * without the priority flag might be forced to wait until the deferred
79 * requested had acquired and released the lock.
80 */
81
David Teiglandb3b94fa2006-01-16 16:50:04 +000082#define LM_FLAG_TRY 0x00000001
83#define LM_FLAG_TRY_1CB 0x00000002
84#define LM_FLAG_NOEXP 0x00000004
85#define LM_FLAG_ANY 0x00000008
Steven Whitehousef057f6c2009-01-12 10:43:39 +000086#define LM_FLAG_PRIORITY 0x00000010
87#define GL_ASYNC 0x00000040
88#define GL_EXACT 0x00000080
89#define GL_SKIP 0x00000100
Steven Whitehousef057f6c2009-01-12 10:43:39 +000090#define GL_NOCACHE 0x00000400
91
92/*
Steven Whitehouse921169c2010-11-29 12:50:38 +000093 * lm_async_cb return flags
Steven Whitehousef057f6c2009-01-12 10:43:39 +000094 *
95 * LM_OUT_ST_MASK
96 * Masks the lower two bits of lock state in the returned value.
97 *
98 * LM_OUT_CANCELED
99 * The lock request was canceled.
100 *
Steven Whitehousef057f6c2009-01-12 10:43:39 +0000101 */
102
103#define LM_OUT_ST_MASK 0x00000003
104#define LM_OUT_CANCELED 0x00000008
Steven Whitehouse921169c2010-11-29 12:50:38 +0000105#define LM_OUT_ERROR 0x00000004
Steven Whitehousef057f6c2009-01-12 10:43:39 +0000106
107/*
108 * lm_recovery_done() messages
109 */
110
111#define LM_RD_GAVEUP 308
112#define LM_RD_SUCCESS 309
113
114#define GLR_TRYFAILED 13
115
Bob Peterson7cf8dcd2011-06-15 11:41:48 -0400116#define GL_GLOCK_MAX_HOLD (long)(HZ / 5)
117#define GL_GLOCK_DFT_HOLD (long)(HZ / 5)
118#define GL_GLOCK_MIN_HOLD (long)(10)
119#define GL_GLOCK_HOLD_INCR (long)(HZ / 20)
120#define GL_GLOCK_HOLD_DECR (long)(HZ / 40)
121
Steven Whitehousef057f6c2009-01-12 10:43:39 +0000122struct lm_lockops {
123 const char *lm_proto_name;
David Teiglande0c2a9a2012-01-09 17:18:05 -0500124 int (*lm_mount) (struct gfs2_sbd *sdp, const char *table);
125 void (*lm_first_done) (struct gfs2_sbd *sdp);
126 void (*lm_recovery_result) (struct gfs2_sbd *sdp, unsigned int jid,
127 unsigned int result);
128 void (*lm_unmount) (struct gfs2_sbd *sdp);
Steven Whitehousef057f6c2009-01-12 10:43:39 +0000129 void (*lm_withdraw) (struct gfs2_sbd *sdp);
Steven Whitehousebc015cb2011-01-19 09:30:01 +0000130 void (*lm_put_lock) (struct gfs2_glock *gl);
Steven Whitehouse921169c2010-11-29 12:50:38 +0000131 int (*lm_lock) (struct gfs2_glock *gl, unsigned int req_state,
132 unsigned int flags);
Steven Whitehousef057f6c2009-01-12 10:43:39 +0000133 void (*lm_cancel) (struct gfs2_glock *gl);
134 const match_table_t *lm_tokens;
135};
136
Benjamin Marzinskib94a1702009-07-23 18:52:34 -0500137extern struct workqueue_struct *gfs2_delete_workqueue;
Steven Whitehouse7afd88d2008-02-22 16:07:18 +0000138static inline struct gfs2_holder *gfs2_glock_is_locked_by_me(struct gfs2_glock *gl)
David Teiglandb3b94fa2006-01-16 16:50:04 +0000139{
140 struct gfs2_holder *gh;
Pavel Emelyanovb1e058d2008-02-07 00:13:19 -0800141 struct pid *pid;
David Teiglandb3b94fa2006-01-16 16:50:04 +0000142
143 /* Look in glock's list of holders for one with current task as owner */
144 spin_lock(&gl->gl_spin);
Pavel Emelyanovb1e058d2008-02-07 00:13:19 -0800145 pid = task_pid(current);
David Teiglandb3b94fa2006-01-16 16:50:04 +0000146 list_for_each_entry(gh, &gl->gl_holders, gh_list) {
Steven Whitehouse6802e342008-05-21 17:03:22 +0100147 if (!test_bit(HIF_HOLDER, &gh->gh_iflags))
148 break;
Steven Whitehouse7afd88d2008-02-22 16:07:18 +0000149 if (gh->gh_owner_pid == pid)
150 goto out;
David Teiglandb3b94fa2006-01-16 16:50:04 +0000151 }
Steven Whitehouse7afd88d2008-02-22 16:07:18 +0000152 gh = NULL;
153out:
David Teiglandb3b94fa2006-01-16 16:50:04 +0000154 spin_unlock(&gl->gl_spin);
155
Steven Whitehouse7afd88d2008-02-22 16:07:18 +0000156 return gh;
David Teiglandb3b94fa2006-01-16 16:50:04 +0000157}
158
159static inline int gfs2_glock_is_held_excl(struct gfs2_glock *gl)
160{
Steven Whitehouse50299962006-09-04 09:49:55 -0400161 return gl->gl_state == LM_ST_EXCLUSIVE;
David Teiglandb3b94fa2006-01-16 16:50:04 +0000162}
163
164static inline int gfs2_glock_is_held_dfrd(struct gfs2_glock *gl)
165{
Steven Whitehouse50299962006-09-04 09:49:55 -0400166 return gl->gl_state == LM_ST_DEFERRED;
David Teiglandb3b94fa2006-01-16 16:50:04 +0000167}
168
169static inline int gfs2_glock_is_held_shrd(struct gfs2_glock *gl)
170{
Steven Whitehouse50299962006-09-04 09:49:55 -0400171 return gl->gl_state == LM_ST_SHARED;
David Teiglandb3b94fa2006-01-16 16:50:04 +0000172}
173
Steven Whitehouse009d8512009-12-08 12:12:13 +0000174static inline struct address_space *gfs2_glock2aspace(struct gfs2_glock *gl)
175{
176 if (gl->gl_ops->go_flags & GLOF_ASPACE)
177 return (struct address_space *)(gl + 1);
178 return NULL;
179}
180
Steven Whitehouse8eae1ca2012-10-15 10:57:02 +0100181extern int gfs2_glock_get(struct gfs2_sbd *sdp, u64 number,
182 const struct gfs2_glock_operations *glops,
183 int create, struct gfs2_glock **glp);
184extern void gfs2_glock_hold(struct gfs2_glock *gl);
185extern void gfs2_glock_put_nolock(struct gfs2_glock *gl);
186extern void gfs2_glock_put(struct gfs2_glock *gl);
187extern void gfs2_holder_init(struct gfs2_glock *gl, unsigned int state,
188 unsigned flags, struct gfs2_holder *gh);
189extern void gfs2_holder_reinit(unsigned int state, unsigned flags,
190 struct gfs2_holder *gh);
191extern void gfs2_holder_uninit(struct gfs2_holder *gh);
192extern int gfs2_glock_nq(struct gfs2_holder *gh);
193extern int gfs2_glock_poll(struct gfs2_holder *gh);
194extern int gfs2_glock_wait(struct gfs2_holder *gh);
195extern void gfs2_glock_dq(struct gfs2_holder *gh);
196extern void gfs2_glock_dq_wait(struct gfs2_holder *gh);
197extern void gfs2_glock_dq_uninit(struct gfs2_holder *gh);
198extern int gfs2_glock_nq_num(struct gfs2_sbd *sdp, u64 number,
199 const struct gfs2_glock_operations *glops,
200 unsigned int state, int flags,
201 struct gfs2_holder *gh);
202extern int gfs2_glock_nq_m(unsigned int num_gh, struct gfs2_holder *ghs);
203extern void gfs2_glock_dq_m(unsigned int num_gh, struct gfs2_holder *ghs);
Steven Whitehouse8eae1ca2012-10-15 10:57:02 +0100204extern int gfs2_dump_glock(struct seq_file *seq, const struct gfs2_glock *gl);
205#define GLOCK_BUG_ON(gl,x) do { if (unlikely(x)) { gfs2_dump_glock(NULL, gl); BUG(); } } while(0)
206extern __printf(2, 3)
Steven Whitehouse6802e342008-05-21 17:03:22 +0100207void gfs2_print_dbg(struct seq_file *seq, const char *fmt, ...);
David Teiglandb3b94fa2006-01-16 16:50:04 +0000208
Steven Whitehoused0dc80d2006-03-29 14:36:49 -0500209/**
Andrea Gelmini33027af2010-10-16 15:19:22 +0200210 * gfs2_glock_nq_init - initialize a holder and enqueue it on a glock
Steven Whitehoused0dc80d2006-03-29 14:36:49 -0500211 * @gl: the glock
212 * @state: the state we're requesting
213 * @flags: the modifier flags
214 * @gh: the holder structure
215 *
216 * Returns: 0, GLR_*, or errno
217 */
218
219static inline int gfs2_glock_nq_init(struct gfs2_glock *gl,
220 unsigned int state, int flags,
221 struct gfs2_holder *gh)
222{
223 int error;
224
225 gfs2_holder_init(gl, state, flags, gh);
226
227 error = gfs2_glock_nq(gh);
228 if (error)
229 gfs2_holder_uninit(gh);
230
231 return error;
232}
233
Steven Whitehousebc015cb2011-01-19 09:30:01 +0000234extern void gfs2_glock_cb(struct gfs2_glock *gl, unsigned int state);
235extern void gfs2_glock_complete(struct gfs2_glock *gl, int ret);
Steven Whitehousebc015cb2011-01-19 09:30:01 +0000236extern void gfs2_gl_hash_clear(struct gfs2_sbd *sdp);
237extern void gfs2_glock_finish_truncate(struct gfs2_inode *ip);
238extern void gfs2_glock_thaw(struct gfs2_sbd *sdp);
Steven Whitehouse29687a22011-03-30 16:33:25 +0100239extern void gfs2_glock_add_to_lru(struct gfs2_glock *gl);
Steven Whitehousefc0e38d2011-03-09 10:58:04 +0000240extern void gfs2_glock_free(struct gfs2_glock *gl);
David Teiglandb3b94fa2006-01-16 16:50:04 +0000241
Steven Whitehousebc015cb2011-01-19 09:30:01 +0000242extern int __init gfs2_glock_init(void);
243extern void gfs2_glock_exit(void);
David Teiglandb3b94fa2006-01-16 16:50:04 +0000244
Steven Whitehousebc015cb2011-01-19 09:30:01 +0000245extern int gfs2_create_debugfs_file(struct gfs2_sbd *sdp);
246extern void gfs2_delete_debugfs_file(struct gfs2_sbd *sdp);
247extern int gfs2_register_debugfs(void);
248extern void gfs2_unregister_debugfs(void);
Steven Whitehouse85d1da62006-09-07 14:40:21 -0400249
Steven Whitehousef057f6c2009-01-12 10:43:39 +0000250extern const struct lm_lockops gfs2_dlm_ops;
251
David Teiglandb3b94fa2006-01-16 16:50:04 +0000252#endif /* __GLOCK_DOT_H__ */