1 /* SPDX-License-Identifier: GPL-2.0-only */ !! 1 /* -*- mode: c; c-basic-offset: 8; -*-
2 /* !! 2 * vim: noexpandtab sw=8 ts=8 sts=0:
>> 3 *
3 * stackglue.h 4 * stackglue.h
4 * 5 *
5 * Glue to the underlying cluster stack. 6 * Glue to the underlying cluster stack.
6 * 7 *
7 * Copyright (C) 2007 Oracle. All rights rese 8 * Copyright (C) 2007 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, version 2.
>> 13 *
>> 14 * This program is distributed in the hope that it will be useful,
>> 15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
>> 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
>> 17 * General Public License for more details.
8 */ 18 */
9 19
10 20
11 #ifndef STACKGLUE_H 21 #ifndef STACKGLUE_H
12 #define STACKGLUE_H 22 #define STACKGLUE_H
13 23
14 #include <linux/types.h> 24 #include <linux/types.h>
15 #include <linux/list.h> 25 #include <linux/list.h>
16 #include <linux/dlmconstants.h> 26 #include <linux/dlmconstants.h>
17 27
18 #include "dlm/dlmapi.h" 28 #include "dlm/dlmapi.h"
19 #include <linux/dlm.h> 29 #include <linux/dlm.h>
20 30
21 /* Needed for plock-related prototypes */ 31 /* Needed for plock-related prototypes */
22 struct file; 32 struct file;
23 struct file_lock; 33 struct file_lock;
24 34
25 /* 35 /*
26 * dlmconstants.h does not have a LOCAL flag. 36 * dlmconstants.h does not have a LOCAL flag. We hope to remove it
27 * some day, but right now we need it. Let's 37 * some day, but right now we need it. Let's fake it. This value is larger
28 * than any flag in dlmconstants.h. 38 * than any flag in dlmconstants.h.
29 */ 39 */
30 #define DLM_LKF_LOCAL 0x00100000 40 #define DLM_LKF_LOCAL 0x00100000
31 41
32 /* 42 /*
33 * This shadows DLM_LOCKSPACE_LEN in fs/dlm/dl 43 * This shadows DLM_LOCKSPACE_LEN in fs/dlm/dlm_internal.h. That probably
34 * wants to be in a public header. 44 * wants to be in a public header.
35 */ 45 */
36 #define GROUP_NAME_MAX 64 46 #define GROUP_NAME_MAX 64
37 47
38 /* This shadows OCFS2_CLUSTER_NAME_LEN */ <<
39 #define CLUSTER_NAME_MAX 16 <<
40 <<
41 48
42 /* 49 /*
43 * ocfs2_protocol_version changes when ocfs2 d 50 * ocfs2_protocol_version changes when ocfs2 does something different in
44 * its inter-node behavior. See dlmglue.c for 51 * its inter-node behavior. See dlmglue.c for more information.
45 */ 52 */
46 struct ocfs2_protocol_version { 53 struct ocfs2_protocol_version {
47 u8 pv_major; 54 u8 pv_major;
48 u8 pv_minor; 55 u8 pv_minor;
49 }; 56 };
50 57
51 /* 58 /*
>> 59 * The ocfs2_locking_protocol defines the handlers called on ocfs2's behalf.
>> 60 */
>> 61 struct ocfs2_locking_protocol {
>> 62 struct ocfs2_protocol_version lp_max_version;
>> 63 void (*lp_lock_ast)(void *astarg);
>> 64 void (*lp_blocking_ast)(void *astarg, int level);
>> 65 void (*lp_unlock_ast)(void *astarg, int error);
>> 66 };
>> 67
>> 68
>> 69 /*
52 * The dlm_lockstatus struct includes lvb spac 70 * The dlm_lockstatus struct includes lvb space, but the dlm_lksb struct only
53 * has a pointer to separately allocated lvb s 71 * has a pointer to separately allocated lvb space. This struct exists only to
54 * include in the lksb union to make space for 72 * include in the lksb union to make space for a combined dlm_lksb and lvb.
55 */ 73 */
56 struct fsdlm_lksb_plus_lvb { 74 struct fsdlm_lksb_plus_lvb {
57 struct dlm_lksb lksb; 75 struct dlm_lksb lksb;
58 char lvb[DLM_LVB_LEN]; 76 char lvb[DLM_LVB_LEN];
59 }; 77 };
60 78
61 /* 79 /*
62 * A union of all lock status structures. We 80 * A union of all lock status structures. We define it here so that the
63 * size of the union is known. Lock status st 81 * size of the union is known. Lock status structures are embedded in
64 * ocfs2 inodes. 82 * ocfs2 inodes.
65 */ 83 */
66 struct ocfs2_cluster_connection; !! 84 union ocfs2_dlm_lksb {
67 struct ocfs2_dlm_lksb { !! 85 struct dlm_lockstatus lksb_o2dlm;
68 union { !! 86 struct dlm_lksb lksb_fsdlm;
69 struct dlm_lockstatus lksb_o2 !! 87 struct fsdlm_lksb_plus_lvb padding;
70 struct dlm_lksb lksb_fsdlm; <<
71 struct fsdlm_lksb_plus_lvb pa <<
72 }; <<
73 struct ocfs2_cluster_connection *lksb <<
74 }; 88 };
75 89
76 /* 90 /*
77 * The ocfs2_locking_protocol defines the hand <<
78 */ <<
79 struct ocfs2_locking_protocol { <<
80 struct ocfs2_protocol_version lp_max_v <<
81 void (*lp_lock_ast)(struct ocfs2_dlm_l <<
82 void (*lp_blocking_ast)(struct ocfs2_d <<
83 void (*lp_unlock_ast)(struct ocfs2_dlm <<
84 }; <<
85 <<
86 <<
87 /* <<
88 * A cluster connection. Mostly opaque to ocf 91 * A cluster connection. Mostly opaque to ocfs2, the connection holds
89 * state for the underlying stack. ocfs2 does 92 * state for the underlying stack. ocfs2 does use cc_version to determine
90 * locking compatibility. 93 * locking compatibility.
91 */ 94 */
92 struct ocfs2_cluster_connection { 95 struct ocfs2_cluster_connection {
93 char cc_name[GROUP_NAME_MAX + 1]; !! 96 char cc_name[GROUP_NAME_MAX];
94 int cc_namelen; 97 int cc_namelen;
95 char cc_cluster_name[CLUSTER_NAME_MAX <<
96 int cc_cluster_name_len; <<
97 struct ocfs2_protocol_version cc_versi 98 struct ocfs2_protocol_version cc_version;
98 struct ocfs2_locking_protocol *cc_prot <<
99 void (*cc_recovery_handler)(int node_n 99 void (*cc_recovery_handler)(int node_num, void *recovery_data);
100 void *cc_recovery_data; 100 void *cc_recovery_data;
101 void *cc_lockspace; 101 void *cc_lockspace;
102 void *cc_private; 102 void *cc_private;
103 }; 103 };
104 104
105 /* 105 /*
106 * Each cluster stack implements the stack ope 106 * Each cluster stack implements the stack operations structure. Not used
107 * in the ocfs2 code, the stackglue code trans 107 * in the ocfs2 code, the stackglue code translates generic cluster calls
108 * into stack operations. 108 * into stack operations.
109 */ 109 */
110 struct ocfs2_stack_operations { 110 struct ocfs2_stack_operations {
111 /* 111 /*
112 * The fs code calls ocfs2_cluster_con 112 * The fs code calls ocfs2_cluster_connect() to attach a new
113 * filesystem to the cluster stack. T 113 * filesystem to the cluster stack. The ->connect() op is passed
114 * an ocfs2_cluster_connection with th 114 * an ocfs2_cluster_connection with the name and recovery field
115 * filled in. 115 * filled in.
116 * 116 *
117 * The stack must set up any notificat 117 * The stack must set up any notification mechanisms and create
118 * the filesystem lockspace in the DLM 118 * the filesystem lockspace in the DLM. The lockspace should be
119 * stored on cc_lockspace. Any other 119 * stored on cc_lockspace. Any other information can be stored on
120 * cc_private. 120 * cc_private.
121 * 121 *
122 * ->connect() must not return until i 122 * ->connect() must not return until it is guaranteed that
123 * 123 *
124 * - Node down notifications for the !! 124 * - Node down notifications for the filesystem will be recieved
125 * and passed to conn->cc_recovery_ 125 * and passed to conn->cc_recovery_handler().
126 * - Locking requests for the filesys 126 * - Locking requests for the filesystem will be processed.
127 */ 127 */
128 int (*connect)(struct ocfs2_cluster_co 128 int (*connect)(struct ocfs2_cluster_connection *conn);
129 129
130 /* 130 /*
131 * The fs code calls ocfs2_cluster_dis 131 * The fs code calls ocfs2_cluster_disconnect() when a filesystem
132 * no longer needs cluster services. 132 * no longer needs cluster services. All DLM locks have been
133 * dropped, and recovery notification 133 * dropped, and recovery notification is being ignored by the
134 * fs code. The stack must disengage 134 * fs code. The stack must disengage from the DLM and discontinue
135 * recovery notification. 135 * recovery notification.
136 * 136 *
137 * Once ->disconnect() has returned, t 137 * Once ->disconnect() has returned, the connection structure will
138 * be freed. Thus, a stack must not r 138 * be freed. Thus, a stack must not return from ->disconnect()
139 * until it will no longer reference t 139 * until it will no longer reference the conn pointer.
140 * 140 *
141 * Once this call returns, the stack g 141 * Once this call returns, the stack glue will be dropping this
142 * connection's reference on the modul 142 * connection's reference on the module.
143 */ 143 */
144 int (*disconnect)(struct ocfs2_cluster 144 int (*disconnect)(struct ocfs2_cluster_connection *conn);
145 145
146 /* 146 /*
147 * ->this_node() returns the cluster's 147 * ->this_node() returns the cluster's unique identifier for the
148 * local node. 148 * local node.
149 */ 149 */
150 int (*this_node)(struct ocfs2_cluster_ !! 150 int (*this_node)(unsigned int *node);
151 unsigned int *node); <<
152 151
153 /* 152 /*
154 * Call the underlying dlm lock functi 153 * Call the underlying dlm lock function. The ->dlm_lock()
155 * callback should convert the flags a 154 * callback should convert the flags and mode as appropriate.
156 * 155 *
157 * ast and bast functions are not part 156 * ast and bast functions are not part of the call because the
158 * stack will likely want to wrap ast 157 * stack will likely want to wrap ast and bast calls before passing
159 * them to stack->sp_proto. There is !! 158 * them to stack->sp_proto.
160 * be passed back to the ast and bast <<
161 * use this to find their object. <<
162 */ 159 */
163 int (*dlm_lock)(struct ocfs2_cluster_c 160 int (*dlm_lock)(struct ocfs2_cluster_connection *conn,
164 int mode, 161 int mode,
165 struct ocfs2_dlm_lksb !! 162 union ocfs2_dlm_lksb *lksb,
166 u32 flags, 163 u32 flags,
167 void *name, 164 void *name,
168 unsigned int namelen); !! 165 unsigned int namelen,
>> 166 void *astarg);
169 167
170 /* 168 /*
171 * Call the underlying dlm unlock func 169 * Call the underlying dlm unlock function. The ->dlm_unlock()
172 * function should convert the flags a 170 * function should convert the flags as appropriate.
173 * 171 *
174 * The unlock ast is not passed, as th 172 * The unlock ast is not passed, as the stack will want to wrap
175 * it before calling stack->sp_proto-> !! 173 * it before calling stack->sp_proto->lp_unlock_ast().
176 * no astarg. The lksb will be passed <<
177 * function. The caller can use this <<
178 */ 174 */
179 int (*dlm_unlock)(struct ocfs2_cluster 175 int (*dlm_unlock)(struct ocfs2_cluster_connection *conn,
180 struct ocfs2_dlm_lks !! 176 union ocfs2_dlm_lksb *lksb,
181 u32 flags); !! 177 u32 flags,
>> 178 void *astarg);
182 179
183 /* 180 /*
184 * Return the status of the current lo 181 * Return the status of the current lock status block. The fs
185 * code should never dereference the u 182 * code should never dereference the union. The ->lock_status()
186 * callback pulls out the stack-specif 183 * callback pulls out the stack-specific lksb, converts the status
187 * to a proper errno, and returns it. 184 * to a proper errno, and returns it.
188 */ 185 */
189 int (*lock_status)(struct ocfs2_dlm_lk !! 186 int (*lock_status)(union ocfs2_dlm_lksb *lksb);
190 187
191 /* 188 /*
192 * Return non-zero if the LVB is valid 189 * Return non-zero if the LVB is valid.
193 */ 190 */
194 int (*lvb_valid)(struct ocfs2_dlm_lksb !! 191 int (*lvb_valid)(union ocfs2_dlm_lksb *lksb);
195 192
196 /* 193 /*
197 * Pull the lvb pointer off of the sta 194 * Pull the lvb pointer off of the stack-specific lksb.
198 */ 195 */
199 void *(*lock_lvb)(struct ocfs2_dlm_lks !! 196 void *(*lock_lvb)(union ocfs2_dlm_lksb *lksb);
200 197
201 /* 198 /*
202 * Cluster-aware posix locks 199 * Cluster-aware posix locks
203 * 200 *
204 * This is NULL for stacks which do no 201 * This is NULL for stacks which do not support posix locks.
205 */ 202 */
206 int (*plock)(struct ocfs2_cluster_conn 203 int (*plock)(struct ocfs2_cluster_connection *conn,
207 u64 ino, 204 u64 ino,
208 struct file *file, 205 struct file *file,
209 int cmd, 206 int cmd,
210 struct file_lock *fl); 207 struct file_lock *fl);
211 208
212 /* 209 /*
213 * This is an optoinal debugging hook. 210 * This is an optoinal debugging hook. If provided, the
214 * stack can dump debugging informatio 211 * stack can dump debugging information about this lock.
215 */ 212 */
216 void (*dump_lksb)(struct ocfs2_dlm_lks !! 213 void (*dump_lksb)(union ocfs2_dlm_lksb *lksb);
217 }; 214 };
218 215
219 /* 216 /*
220 * Each stack plugin must describe itself by r 217 * Each stack plugin must describe itself by registering a
221 * ocfs2_stack_plugin structure. This is only 218 * ocfs2_stack_plugin structure. This is only seen by stackglue and the
222 * stack driver. 219 * stack driver.
223 */ 220 */
224 struct ocfs2_stack_plugin { 221 struct ocfs2_stack_plugin {
225 char *sp_name; 222 char *sp_name;
226 const struct ocfs2_stack_operations *s !! 223 struct ocfs2_stack_operations *sp_ops;
227 struct module *sp_owner; 224 struct module *sp_owner;
228 225
229 /* These are managed by the stackglue 226 /* These are managed by the stackglue code. */
230 struct list_head sp_list; 227 struct list_head sp_list;
231 unsigned int sp_count; 228 unsigned int sp_count;
232 struct ocfs2_protocol_version sp_max_p !! 229 struct ocfs2_locking_protocol *sp_proto;
233 }; 230 };
234 231
235 232
236 /* Used by the filesystem */ 233 /* Used by the filesystem */
237 int ocfs2_cluster_connect(const char *stack_na 234 int ocfs2_cluster_connect(const char *stack_name,
238 const char *cluster_ <<
239 int cluster_name_len <<
240 const char *group, 235 const char *group,
241 int grouplen, 236 int grouplen,
242 struct ocfs2_locking <<
243 void (*recovery_hand 237 void (*recovery_handler)(int node_num,
244 238 void *recovery_data),
245 void *recovery_data, 239 void *recovery_data,
246 struct ocfs2_cluster 240 struct ocfs2_cluster_connection **conn);
247 /* <<
248 * Used by callers that don't store their stac <<
249 * all nodes have the same stack. <<
250 */ <<
251 int ocfs2_cluster_connect_agnostic(const char <<
252 int grouple <<
253 struct ocfs <<
254 void (*reco <<
255 <<
256 void *recov <<
257 struct ocfs <<
258 int ocfs2_cluster_disconnect(struct ocfs2_clus 241 int ocfs2_cluster_disconnect(struct ocfs2_cluster_connection *conn,
259 int hangup_pendin 242 int hangup_pending);
260 void ocfs2_cluster_hangup(const char *group, i 243 void ocfs2_cluster_hangup(const char *group, int grouplen);
261 int ocfs2_cluster_this_node(struct ocfs2_clust !! 244 int ocfs2_cluster_this_node(unsigned int *node);
262 unsigned int *node <<
263 245
264 struct ocfs2_lock_res; 246 struct ocfs2_lock_res;
265 int ocfs2_dlm_lock(struct ocfs2_cluster_connec 247 int ocfs2_dlm_lock(struct ocfs2_cluster_connection *conn,
266 int mode, 248 int mode,
267 struct ocfs2_dlm_lksb *lksb !! 249 union ocfs2_dlm_lksb *lksb,
268 u32 flags, 250 u32 flags,
269 void *name, 251 void *name,
270 unsigned int namelen); !! 252 unsigned int namelen,
>> 253 struct ocfs2_lock_res *astarg);
271 int ocfs2_dlm_unlock(struct ocfs2_cluster_conn 254 int ocfs2_dlm_unlock(struct ocfs2_cluster_connection *conn,
272 struct ocfs2_dlm_lksb *lk !! 255 union ocfs2_dlm_lksb *lksb,
273 u32 flags); !! 256 u32 flags,
274 !! 257 struct ocfs2_lock_res *astarg);
275 int ocfs2_dlm_lock_status(struct ocfs2_dlm_lks !! 258
276 int ocfs2_dlm_lvb_valid(struct ocfs2_dlm_lksb !! 259 int ocfs2_dlm_lock_status(union ocfs2_dlm_lksb *lksb);
277 void *ocfs2_dlm_lvb(struct ocfs2_dlm_lksb *lks !! 260 int ocfs2_dlm_lvb_valid(union ocfs2_dlm_lksb *lksb);
278 void ocfs2_dlm_dump_lksb(struct ocfs2_dlm_lksb !! 261 void *ocfs2_dlm_lvb(union ocfs2_dlm_lksb *lksb);
>> 262 void ocfs2_dlm_dump_lksb(union ocfs2_dlm_lksb *lksb);
279 263
280 int ocfs2_stack_supports_plocks(void); 264 int ocfs2_stack_supports_plocks(void);
281 int ocfs2_plock(struct ocfs2_cluster_connectio 265 int ocfs2_plock(struct ocfs2_cluster_connection *conn, u64 ino,
282 struct file *file, int cmd, st 266 struct file *file, int cmd, struct file_lock *fl);
283 267
284 void ocfs2_stack_glue_set_max_proto_version(st !! 268 void ocfs2_stack_glue_set_locking_protocol(struct ocfs2_locking_protocol *proto);
285 269
286 270
287 /* Used by stack plugins */ 271 /* Used by stack plugins */
288 int ocfs2_stack_glue_register(struct ocfs2_sta 272 int ocfs2_stack_glue_register(struct ocfs2_stack_plugin *plugin);
289 void ocfs2_stack_glue_unregister(struct ocfs2_ 273 void ocfs2_stack_glue_unregister(struct ocfs2_stack_plugin *plugin);
290 <<
291 extern struct kset *ocfs2_kset; <<
292 274
293 #endif /* STACKGLUE_H */ 275 #endif /* STACKGLUE_H */
294 276
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.