3f8d9986b8e0e82d9f8b938ef9d648669b14fff0
[linux-2.6.git] / fs / ocfs2 / dlmglue.h
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 /* ocfs2_inode_lock_full() 'arg_flags' flags */
66 /* don't wait on recovery. */
67 #define OCFS2_META_LOCK_RECOVERY        (0x01)
68 /* Instruct the dlm not to queue ourselves on the other node. */
69 #define OCFS2_META_LOCK_NOQUEUE         (0x02)
70 /* don't block waiting for the downconvert thread, instead return -EAGAIN */
71 #define OCFS2_LOCK_NONBLOCK             (0x04)
72
73 int ocfs2_dlm_init(struct ocfs2_super *osb);
74 void ocfs2_dlm_shutdown(struct ocfs2_super *osb, int hangup_pending);
75 void ocfs2_lock_res_init_once(struct ocfs2_lock_res *res);
76 void ocfs2_inode_lock_res_init(struct ocfs2_lock_res *res,
77                                enum ocfs2_lock_type type,
78                                unsigned int generation,
79                                struct inode *inode);
80 void ocfs2_dentry_lock_res_init(struct ocfs2_dentry_lock *dl,
81                                 u64 parent, struct inode *inode);
82 struct ocfs2_file_private;
83 void ocfs2_file_lock_res_init(struct ocfs2_lock_res *lockres,
84                               struct ocfs2_file_private *fp);
85 struct ocfs2_mem_dqinfo;
86 void ocfs2_qinfo_lock_res_init(struct ocfs2_lock_res *lockres,
87                                struct ocfs2_mem_dqinfo *info);
88 void ocfs2_lock_res_free(struct ocfs2_lock_res *res);
89 int ocfs2_create_new_inode_locks(struct inode *inode);
90 int ocfs2_drop_inode_locks(struct inode *inode);
91 int ocfs2_rw_lock(struct inode *inode, int write);
92 void ocfs2_rw_unlock(struct inode *inode, int write);
93 int ocfs2_open_lock(struct inode *inode);
94 int ocfs2_try_open_lock(struct inode *inode, int write);
95 void ocfs2_open_unlock(struct inode *inode);
96 int ocfs2_inode_lock_atime(struct inode *inode,
97                           struct vfsmount *vfsmnt,
98                           int *level);
99 int ocfs2_inode_lock_full(struct inode *inode,
100                          struct buffer_head **ret_bh,
101                          int ex,
102                          int arg_flags);
103 int ocfs2_inode_lock_with_page(struct inode *inode,
104                               struct buffer_head **ret_bh,
105                               int ex,
106                               struct page *page);
107 /* 99% of the time we don't want to supply any additional flags --
108  * those are for very specific cases only. */
109 #define ocfs2_inode_lock(i, b, e) ocfs2_inode_lock_full(i, b, e, 0)
110 void ocfs2_inode_unlock(struct inode *inode,
111                        int ex);
112 int ocfs2_super_lock(struct ocfs2_super *osb,
113                      int ex);
114 void ocfs2_super_unlock(struct ocfs2_super *osb,
115                         int ex);
116 int ocfs2_rename_lock(struct ocfs2_super *osb);
117 void ocfs2_rename_unlock(struct ocfs2_super *osb);
118 int ocfs2_dentry_lock(struct dentry *dentry, int ex);
119 void ocfs2_dentry_unlock(struct dentry *dentry, int ex);
120 int ocfs2_file_lock(struct file *file, int ex, int trylock);
121 void ocfs2_file_unlock(struct file *file);
122 int ocfs2_qinfo_lock(struct ocfs2_mem_dqinfo *oinfo, int ex);
123 void ocfs2_qinfo_unlock(struct ocfs2_mem_dqinfo *oinfo, int ex);
124
125
126 void ocfs2_mark_lockres_freeing(struct ocfs2_lock_res *lockres);
127 void ocfs2_simple_drop_lockres(struct ocfs2_super *osb,
128                                struct ocfs2_lock_res *lockres);
129
130 /* for the downconvert thread */
131 void ocfs2_wake_downconvert_thread(struct ocfs2_super *osb);
132
133 struct ocfs2_dlm_debug *ocfs2_new_dlm_debug(void);
134 void ocfs2_put_dlm_debug(struct ocfs2_dlm_debug *dlm_debug);
135
136 /* To set the locking protocol on module initialization */
137 void ocfs2_set_locking_protocol(void);
138 #endif  /* DLMGLUE_H */