Merge tag 'mailbox-v5.1' of git://git.linaro.org/landing-teams/working/fujitsu/integr...
[linux-2.6-block.git] / fs / ocfs2 / dlmglue.h
CommitLineData
ccd979bd
MF
1/* -*- mode: c; c-basic-offset: 8; -*-
2 * vim: noexpandtab sw=8 ts=8 sts=0:
3 *
4 * dlmglue.h
5 *
6 * description here
7 *
8 * Copyright (C) 2002, 2004 Oracle. All rights reserved.
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public
12 * License as published by the Free Software Foundation; either
13 * version 2 of the License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public
21 * License along with this program; if not, write to the
22 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 * Boston, MA 021110-1307, USA.
24 */
25
26
27#ifndef DLMGLUE_H
28#define DLMGLUE_H
29
d680efe9
MF
30#include "dcache.h"
31
15b1e36b 32#define OCFS2_LVB_VERSION 5
ccd979bd
MF
33
34struct ocfs2_meta_lvb {
4d3b83f7 35 __u8 lvb_version;
24c19ef4 36 __u8 lvb_reserved0;
15b1e36b 37 __be16 lvb_idynfeatures;
ccd979bd
MF
38 __be32 lvb_iclusters;
39 __be32 lvb_iuid;
40 __be32 lvb_igid;
41 __be64 lvb_iatime_packed;
42 __be64 lvb_ictime_packed;
43 __be64 lvb_imtime_packed;
44 __be64 lvb_isize;
45 __be16 lvb_imode;
46 __be16 lvb_inlink;
ca4d147e 47 __be32 lvb_iattr;
f9e2d82e
MF
48 __be32 lvb_igeneration;
49 __be32 lvb_reserved2;
ccd979bd
MF
50};
51
9e33d69f
JK
52#define OCFS2_QINFO_LVB_VERSION 1
53
54struct ocfs2_qinfo_lvb {
55 __u8 lvb_version;
56 __u8 lvb_reserved[3];
57 __be32 lvb_bgrace;
58 __be32 lvb_igrace;
59 __be32 lvb_syncms;
60 __be32 lvb_blocks;
61 __be32 lvb_free_blk;
62 __be32 lvb_free_entry;
63};
64
83273932
SE
65#define OCFS2_ORPHAN_LVB_VERSION 1
66
67struct ocfs2_orphan_scan_lvb {
68 __u8 lvb_version;
69 __u8 lvb_reserved[3];
70 __be32 lvb_os_seqno;
71};
72
4882abeb
GH
73#define OCFS2_TRIMFS_LVB_VERSION 1
74
75struct ocfs2_trim_fs_lvb {
76 __u8 lvb_version;
77 __u8 lvb_success;
78 __u8 lvb_reserved[2];
79 __be32 lvb_nodenum;
80 __be64 lvb_start;
81 __be64 lvb_len;
82 __be64 lvb_minlen;
83 __be64 lvb_trimlen;
84};
85
86struct ocfs2_trim_fs_info {
87 u8 tf_valid; /* lvb is valid, or not */
88 u8 tf_success; /* trim is successful, or not */
89 u32 tf_nodenum; /* osb node number */
90 u64 tf_start; /* trim start offset in clusters */
91 u64 tf_len; /* trim end offset in clusters */
92 u64 tf_minlen; /* trim minimum contiguous free clusters */
93 u64 tf_trimlen; /* trimmed length in bytes */
94};
95
439a36b8
ER
96struct ocfs2_lock_holder {
97 struct list_head oh_list;
98 struct pid *oh_owner_pid;
133b81f2 99 int oh_ex;
439a36b8
ER
100};
101
e63aecb6 102/* ocfs2_inode_lock_full() 'arg_flags' flags */
ccd979bd
MF
103/* don't wait on recovery. */
104#define OCFS2_META_LOCK_RECOVERY (0x01)
105/* Instruct the dlm not to queue ourselves on the other node. */
106#define OCFS2_META_LOCK_NOQUEUE (0x02)
34d024f8 107/* don't block waiting for the downconvert thread, instead return -EAGAIN */
ccd979bd 108#define OCFS2_LOCK_NONBLOCK (0x04)
439a36b8
ER
109/* just get back disk inode bh if we've got cluster lock. */
110#define OCFS2_META_LOCK_GETBH (0x08)
ccd979bd 111
cb25797d
JK
112/* Locking subclasses of inode cluster lock */
113enum {
114 OI_LS_NORMAL = 0,
115 OI_LS_PARENT,
116 OI_LS_RENAME1,
117 OI_LS_RENAME2,
07eaac94 118 OI_LS_REFLINK_TARGET,
cb25797d
JK
119};
120
ccd979bd 121int ocfs2_dlm_init(struct ocfs2_super *osb);
286eaa95 122void ocfs2_dlm_shutdown(struct ocfs2_super *osb, int hangup_pending);
ccd979bd
MF
123void ocfs2_lock_res_init_once(struct ocfs2_lock_res *res);
124void ocfs2_inode_lock_res_init(struct ocfs2_lock_res *res,
125 enum ocfs2_lock_type type,
24c19ef4 126 unsigned int generation,
ccd979bd 127 struct inode *inode);
d680efe9
MF
128void ocfs2_dentry_lock_res_init(struct ocfs2_dentry_lock *dl,
129 u64 parent, struct inode *inode);
cf8e06f1
MF
130struct ocfs2_file_private;
131void ocfs2_file_lock_res_init(struct ocfs2_lock_res *lockres,
132 struct ocfs2_file_private *fp);
9e33d69f
JK
133struct ocfs2_mem_dqinfo;
134void ocfs2_qinfo_lock_res_init(struct ocfs2_lock_res *lockres,
135 struct ocfs2_mem_dqinfo *info);
8dec98ed
TM
136void ocfs2_refcount_lock_res_init(struct ocfs2_lock_res *lockres,
137 struct ocfs2_super *osb, u64 ref_blkno,
138 unsigned int generation);
ccd979bd
MF
139void ocfs2_lock_res_free(struct ocfs2_lock_res *res);
140int ocfs2_create_new_inode_locks(struct inode *inode);
141int ocfs2_drop_inode_locks(struct inode *inode);
ccd979bd 142int ocfs2_rw_lock(struct inode *inode, int write);
06e7f13d 143int ocfs2_try_rw_lock(struct inode *inode, int write);
ccd979bd 144void ocfs2_rw_unlock(struct inode *inode, int write);
50008630
TY
145int ocfs2_open_lock(struct inode *inode);
146int ocfs2_try_open_lock(struct inode *inode, int write);
147void ocfs2_open_unlock(struct inode *inode);
e63aecb6 148int ocfs2_inode_lock_atime(struct inode *inode,
7f1a37e3 149 struct vfsmount *vfsmnt,
c4c2416a 150 int *level, int wait);
cb25797d 151int ocfs2_inode_lock_full_nested(struct inode *inode,
ccd979bd
MF
152 struct buffer_head **ret_bh,
153 int ex,
cb25797d
JK
154 int arg_flags,
155 int subclass);
e63aecb6 156int ocfs2_inode_lock_with_page(struct inode *inode,
ccd979bd
MF
157 struct buffer_head **ret_bh,
158 int ex,
159 struct page *page);
cb25797d
JK
160/* Variants without special locking class or flags */
161#define ocfs2_inode_lock_full(i, r, e, f)\
162 ocfs2_inode_lock_full_nested(i, r, e, f, OI_LS_NORMAL)
163#define ocfs2_inode_lock_nested(i, b, e, s)\
164 ocfs2_inode_lock_full_nested(i, b, e, 0, s)
ccd979bd
MF
165/* 99% of the time we don't want to supply any additional flags --
166 * those are for very specific cases only. */
cb25797d 167#define ocfs2_inode_lock(i, b, e) ocfs2_inode_lock_full_nested(i, b, e, 0, OI_LS_NORMAL)
06e7f13d
GH
168#define ocfs2_try_inode_lock(i, b, e)\
169 ocfs2_inode_lock_full_nested(i, b, e, OCFS2_META_LOCK_NOQUEUE,\
170 OI_LS_NORMAL)
e63aecb6 171void ocfs2_inode_unlock(struct inode *inode,
ccd979bd
MF
172 int ex);
173int ocfs2_super_lock(struct ocfs2_super *osb,
174 int ex);
175void ocfs2_super_unlock(struct ocfs2_super *osb,
176 int ex);
df152c24
SM
177int ocfs2_orphan_scan_lock(struct ocfs2_super *osb, u32 *seqno);
178void ocfs2_orphan_scan_unlock(struct ocfs2_super *osb, u32 seqno);
83273932 179
ccd979bd
MF
180int ocfs2_rename_lock(struct ocfs2_super *osb);
181void ocfs2_rename_unlock(struct ocfs2_super *osb);
6ca497a8 182int ocfs2_nfs_sync_lock(struct ocfs2_super *osb, int ex);
183void ocfs2_nfs_sync_unlock(struct ocfs2_super *osb, int ex);
4882abeb
GH
184void ocfs2_trim_fs_lock_res_init(struct ocfs2_super *osb);
185void ocfs2_trim_fs_lock_res_uninit(struct ocfs2_super *osb);
186int ocfs2_trim_fs_lock(struct ocfs2_super *osb,
187 struct ocfs2_trim_fs_info *info, int trylock);
188void ocfs2_trim_fs_unlock(struct ocfs2_super *osb,
189 struct ocfs2_trim_fs_info *info);
d680efe9
MF
190int ocfs2_dentry_lock(struct dentry *dentry, int ex);
191void ocfs2_dentry_unlock(struct dentry *dentry, int ex);
cf8e06f1
MF
192int ocfs2_file_lock(struct file *file, int ex, int trylock);
193void ocfs2_file_unlock(struct file *file);
9e33d69f
JK
194int ocfs2_qinfo_lock(struct ocfs2_mem_dqinfo *oinfo, int ex);
195void ocfs2_qinfo_unlock(struct ocfs2_mem_dqinfo *oinfo, int ex);
8dec98ed
TM
196struct ocfs2_refcount_tree;
197int ocfs2_refcount_lock(struct ocfs2_refcount_tree *ref_tree, int ex);
198void ocfs2_refcount_unlock(struct ocfs2_refcount_tree *ref_tree, int ex);
9e33d69f 199
d680efe9 200
84d86f83
JK
201void ocfs2_mark_lockres_freeing(struct ocfs2_super *osb,
202 struct ocfs2_lock_res *lockres);
d680efe9
MF
203void ocfs2_simple_drop_lockres(struct ocfs2_super *osb,
204 struct ocfs2_lock_res *lockres);
ccd979bd 205
34d024f8 206/* for the downconvert thread */
34d024f8 207void ocfs2_wake_downconvert_thread(struct ocfs2_super *osb);
ccd979bd
MF
208
209struct ocfs2_dlm_debug *ocfs2_new_dlm_debug(void);
210void ocfs2_put_dlm_debug(struct ocfs2_dlm_debug *dlm_debug);
211
63e0c48a
JB
212/* To set the locking protocol on module initialization */
213void ocfs2_set_locking_protocol(void);
439a36b8
ER
214
215/* The _tracker pair is used to avoid cluster recursive locking */
216int ocfs2_inode_lock_tracker(struct inode *inode,
217 struct buffer_head **ret_bh,
218 int ex,
219 struct ocfs2_lock_holder *oh);
220void ocfs2_inode_unlock_tracker(struct inode *inode,
221 int ex,
222 struct ocfs2_lock_holder *oh,
223 int had_lock);
224
ccd979bd 225#endif /* DLMGLUE_H */