xref: /openbmc/linux/fs/ocfs2/dlmglue.h (revision 84c43674)
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 
30 #include "dcache.h"
31 
32 #define OCFS2_LVB_VERSION 5
33 
34 struct ocfs2_meta_lvb {
35 	__u8         lvb_version;
36 	__u8         lvb_reserved0;
37 	__be16       lvb_idynfeatures;
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;
47 	__be32       lvb_iattr;
48 	__be32       lvb_igeneration;
49 	__be32       lvb_reserved2;
50 };
51 
52 #define OCFS2_QINFO_LVB_VERSION 1
53 
54 struct 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 
65 #define OCFS2_ORPHAN_LVB_VERSION 1
66 
67 struct ocfs2_orphan_scan_lvb {
68 	__u8	lvb_version;
69 	__u8	lvb_reserved[3];
70 	__be32	lvb_os_seqno;
71 };
72 
73 struct ocfs2_lock_holder {
74 	struct list_head oh_list;
75 	struct pid *oh_owner_pid;
76 };
77 
78 /* ocfs2_inode_lock_full() 'arg_flags' flags */
79 /* don't wait on recovery. */
80 #define OCFS2_META_LOCK_RECOVERY	(0x01)
81 /* Instruct the dlm not to queue ourselves on the other node. */
82 #define OCFS2_META_LOCK_NOQUEUE		(0x02)
83 /* don't block waiting for the downconvert thread, instead return -EAGAIN */
84 #define OCFS2_LOCK_NONBLOCK		(0x04)
85 /* just get back disk inode bh if we've got cluster lock. */
86 #define OCFS2_META_LOCK_GETBH		(0x08)
87 
88 /* Locking subclasses of inode cluster lock */
89 enum {
90 	OI_LS_NORMAL = 0,
91 	OI_LS_PARENT,
92 	OI_LS_RENAME1,
93 	OI_LS_RENAME2,
94 	OI_LS_REFLINK_TARGET,
95 };
96 
97 int ocfs2_dlm_init(struct ocfs2_super *osb);
98 void ocfs2_dlm_shutdown(struct ocfs2_super *osb, int hangup_pending);
99 void ocfs2_lock_res_init_once(struct ocfs2_lock_res *res);
100 void ocfs2_inode_lock_res_init(struct ocfs2_lock_res *res,
101 			       enum ocfs2_lock_type type,
102 			       unsigned int generation,
103 			       struct inode *inode);
104 void ocfs2_dentry_lock_res_init(struct ocfs2_dentry_lock *dl,
105 				u64 parent, struct inode *inode);
106 struct ocfs2_file_private;
107 void ocfs2_file_lock_res_init(struct ocfs2_lock_res *lockres,
108 			      struct ocfs2_file_private *fp);
109 struct ocfs2_mem_dqinfo;
110 void ocfs2_qinfo_lock_res_init(struct ocfs2_lock_res *lockres,
111                                struct ocfs2_mem_dqinfo *info);
112 void ocfs2_refcount_lock_res_init(struct ocfs2_lock_res *lockres,
113 				  struct ocfs2_super *osb, u64 ref_blkno,
114 				  unsigned int generation);
115 void ocfs2_lock_res_free(struct ocfs2_lock_res *res);
116 int ocfs2_create_new_inode_locks(struct inode *inode);
117 int ocfs2_drop_inode_locks(struct inode *inode);
118 int ocfs2_rw_lock(struct inode *inode, int write);
119 void ocfs2_rw_unlock(struct inode *inode, int write);
120 int ocfs2_open_lock(struct inode *inode);
121 int ocfs2_try_open_lock(struct inode *inode, int write);
122 void ocfs2_open_unlock(struct inode *inode);
123 int ocfs2_inode_lock_atime(struct inode *inode,
124 			  struct vfsmount *vfsmnt,
125 			  int *level);
126 int ocfs2_inode_lock_full_nested(struct inode *inode,
127 			 struct buffer_head **ret_bh,
128 			 int ex,
129 			 int arg_flags,
130 			 int subclass);
131 int ocfs2_inode_lock_with_page(struct inode *inode,
132 			      struct buffer_head **ret_bh,
133 			      int ex,
134 			      struct page *page);
135 /* Variants without special locking class or flags */
136 #define ocfs2_inode_lock_full(i, r, e, f)\
137 		ocfs2_inode_lock_full_nested(i, r, e, f, OI_LS_NORMAL)
138 #define ocfs2_inode_lock_nested(i, b, e, s)\
139 		ocfs2_inode_lock_full_nested(i, b, e, 0, s)
140 /* 99% of the time we don't want to supply any additional flags --
141  * those are for very specific cases only. */
142 #define ocfs2_inode_lock(i, b, e) ocfs2_inode_lock_full_nested(i, b, e, 0, OI_LS_NORMAL)
143 void ocfs2_inode_unlock(struct inode *inode,
144 		       int ex);
145 int ocfs2_super_lock(struct ocfs2_super *osb,
146 		     int ex);
147 void ocfs2_super_unlock(struct ocfs2_super *osb,
148 			int ex);
149 int ocfs2_orphan_scan_lock(struct ocfs2_super *osb, u32 *seqno);
150 void ocfs2_orphan_scan_unlock(struct ocfs2_super *osb, u32 seqno);
151 
152 int ocfs2_rename_lock(struct ocfs2_super *osb);
153 void ocfs2_rename_unlock(struct ocfs2_super *osb);
154 int ocfs2_nfs_sync_lock(struct ocfs2_super *osb, int ex);
155 void ocfs2_nfs_sync_unlock(struct ocfs2_super *osb, int ex);
156 int ocfs2_dentry_lock(struct dentry *dentry, int ex);
157 void ocfs2_dentry_unlock(struct dentry *dentry, int ex);
158 int ocfs2_file_lock(struct file *file, int ex, int trylock);
159 void ocfs2_file_unlock(struct file *file);
160 int ocfs2_qinfo_lock(struct ocfs2_mem_dqinfo *oinfo, int ex);
161 void ocfs2_qinfo_unlock(struct ocfs2_mem_dqinfo *oinfo, int ex);
162 struct ocfs2_refcount_tree;
163 int ocfs2_refcount_lock(struct ocfs2_refcount_tree *ref_tree, int ex);
164 void ocfs2_refcount_unlock(struct ocfs2_refcount_tree *ref_tree, int ex);
165 
166 
167 void ocfs2_mark_lockres_freeing(struct ocfs2_super *osb,
168 				struct ocfs2_lock_res *lockres);
169 void ocfs2_simple_drop_lockres(struct ocfs2_super *osb,
170 			       struct ocfs2_lock_res *lockres);
171 
172 /* for the downconvert thread */
173 void ocfs2_wake_downconvert_thread(struct ocfs2_super *osb);
174 
175 struct ocfs2_dlm_debug *ocfs2_new_dlm_debug(void);
176 void ocfs2_put_dlm_debug(struct ocfs2_dlm_debug *dlm_debug);
177 
178 /* To set the locking protocol on module initialization */
179 void ocfs2_set_locking_protocol(void);
180 
181 /* The _tracker pair is used to avoid cluster recursive locking */
182 int ocfs2_inode_lock_tracker(struct inode *inode,
183 			     struct buffer_head **ret_bh,
184 			     int ex,
185 			     struct ocfs2_lock_holder *oh);
186 void ocfs2_inode_unlock_tracker(struct inode *inode,
187 				int ex,
188 				struct ocfs2_lock_holder *oh,
189 				int had_lock);
190 
191 #endif	/* DLMGLUE_H */
192