Blame view
fs/ocfs2/stackglue.h
8.79 KB
50acfb2b7 treewide: Replace... |
1 |
/* SPDX-License-Identifier: GPL-2.0-only */ |
24ef1815e ocfs2: Separate o... |
2 3 4 5 6 7 8 9 |
/* -*- mode: c; c-basic-offset: 8; -*- * vim: noexpandtab sw=8 ts=8 sts=0: * * stackglue.h * * Glue to the underlying cluster stack. * * Copyright (C) 2007 Oracle. All rights reserved. |
24ef1815e ocfs2: Separate o... |
10 11 12 13 14 |
*/ #ifndef STACKGLUE_H #define STACKGLUE_H |
bd3e76105 ocfs2: Use global... |
15 16 17 |
#include <linux/types.h> #include <linux/list.h> #include <linux/dlmconstants.h> |
e3dad42bf ocfs2: Create ocf... |
18 |
#include "dlm/dlmapi.h" |
cf4d8d75d ocfs2: add fsdlm ... |
19 |
#include <linux/dlm.h> |
e3dad42bf ocfs2: Create ocf... |
20 |
|
53da4939f ocfs2: POSIX file... |
21 22 23 |
/* Needed for plock-related prototypes */ struct file; struct file_lock; |
bd3e76105 ocfs2: Use global... |
24 25 26 27 28 29 |
/* * dlmconstants.h does not have a LOCAL flag. We hope to remove it * some day, but right now we need it. Let's fake it. This value is larger * than any flag in dlmconstants.h. */ #define DLM_LKF_LOCAL 0x00100000 |
4670c46de ocfs2: Introduce ... |
30 31 32 33 34 |
/* * This shadows DLM_LOCKSPACE_LEN in fs/dlm/dlm_internal.h. That probably * wants to be in a public header. */ #define GROUP_NAME_MAX 64 |
c74a3bdd9 ocfs2: add cluste... |
35 36 |
/* This shadows OCFS2_CLUSTER_NAME_LEN */ #define CLUSTER_NAME_MAX 16 |
4670c46de ocfs2: Introduce ... |
37 |
|
e3dad42bf ocfs2: Create ocf... |
38 39 40 41 |
/* * ocfs2_protocol_version changes when ocfs2 does something different in * its inter-node behavior. See dlmglue.c for more information. */ |
4670c46de ocfs2: Introduce ... |
42 43 44 45 |
struct ocfs2_protocol_version { u8 pv_major; u8 pv_minor; }; |
e3dad42bf ocfs2: Create ocf... |
46 |
/* |
cf4d8d75d ocfs2: add fsdlm ... |
47 48 49 50 51 52 53 54 |
* The dlm_lockstatus struct includes lvb space, but the dlm_lksb struct only * has a pointer to separately allocated lvb space. This struct exists only to * include in the lksb union to make space for a combined dlm_lksb and lvb. */ struct fsdlm_lksb_plus_lvb { struct dlm_lksb lksb; char lvb[DLM_LVB_LEN]; }; |
e3dad42bf ocfs2: Create ocf... |
55 56 57 58 59 |
/* * A union of all lock status structures. We define it here so that the * size of the union is known. Lock status structures are embedded in * ocfs2 inodes. */ |
c0e413385 ocfs2: Attach the... |
60 61 62 63 64 65 66 67 |
struct ocfs2_cluster_connection; struct ocfs2_dlm_lksb { union { struct dlm_lockstatus lksb_o2dlm; struct dlm_lksb lksb_fsdlm; struct fsdlm_lksb_plus_lvb padding; }; struct ocfs2_cluster_connection *lksb_conn; |
8f2c9c1b1 ocfs2: Create the... |
68 |
}; |
e3dad42bf ocfs2: Create ocf... |
69 |
/* |
a796d2862 ocfs2: Pass lksbs... |
70 71 72 73 |
* The ocfs2_locking_protocol defines the handlers called on ocfs2's behalf. */ struct ocfs2_locking_protocol { struct ocfs2_protocol_version lp_max_version; |
c0e413385 ocfs2: Attach the... |
74 75 76 |
void (*lp_lock_ast)(struct ocfs2_dlm_lksb *lksb); void (*lp_blocking_ast)(struct ocfs2_dlm_lksb *lksb, int level); void (*lp_unlock_ast)(struct ocfs2_dlm_lksb *lksb, int error); |
a796d2862 ocfs2: Pass lksbs... |
77 78 79 80 |
}; /* |
e3dad42bf ocfs2: Create ocf... |
81 82 83 84 |
* A cluster connection. Mostly opaque to ocfs2, the connection holds * state for the underlying stack. ocfs2 does use cc_version to determine * locking compatibility. */ |
4670c46de ocfs2: Introduce ... |
85 |
struct ocfs2_cluster_connection { |
c74a3bdd9 ocfs2: add cluste... |
86 |
char cc_name[GROUP_NAME_MAX + 1]; |
4670c46de ocfs2: Introduce ... |
87 |
int cc_namelen; |
c74a3bdd9 ocfs2: add cluste... |
88 89 |
char cc_cluster_name[CLUSTER_NAME_MAX + 1]; int cc_cluster_name_len; |
4670c46de ocfs2: Introduce ... |
90 |
struct ocfs2_protocol_version cc_version; |
110946c8f ocfs2: Hang the l... |
91 |
struct ocfs2_locking_protocol *cc_proto; |
4670c46de ocfs2: Introduce ... |
92 93 94 95 96 |
void (*cc_recovery_handler)(int node_num, void *recovery_data); void *cc_recovery_data; void *cc_lockspace; void *cc_private; }; |
e3dad42bf ocfs2: Create ocf... |
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
/* * Each cluster stack implements the stack operations structure. Not used * in the ocfs2 code, the stackglue code translates generic cluster calls * into stack operations. */ struct ocfs2_stack_operations { /* * The fs code calls ocfs2_cluster_connect() to attach a new * filesystem to the cluster stack. The ->connect() op is passed * an ocfs2_cluster_connection with the name and recovery field * filled in. * * The stack must set up any notification mechanisms and create * the filesystem lockspace in the DLM. The lockspace should be * stored on cc_lockspace. Any other information can be stored on * cc_private. * * ->connect() must not return until it is guaranteed that * |
25985edce Fix common misspe... |
116 |
* - Node down notifications for the filesystem will be received |
e3dad42bf ocfs2: Create ocf... |
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
* and passed to conn->cc_recovery_handler(). * - Locking requests for the filesystem will be processed. */ int (*connect)(struct ocfs2_cluster_connection *conn); /* * The fs code calls ocfs2_cluster_disconnect() when a filesystem * no longer needs cluster services. All DLM locks have been * dropped, and recovery notification is being ignored by the * fs code. The stack must disengage from the DLM and discontinue * recovery notification. * * Once ->disconnect() has returned, the connection structure will * be freed. Thus, a stack must not return from ->disconnect() * until it will no longer reference the conn pointer. |
286eaa95c ocfs2: Break out ... |
132 |
* |
2c39450b3 ocfs2: Remove ->h... |
133 134 |
* Once this call returns, the stack glue will be dropping this * connection's reference on the module. |
e3dad42bf ocfs2: Create ocf... |
135 |
*/ |
2c39450b3 ocfs2: Remove ->h... |
136 |
int (*disconnect)(struct ocfs2_cluster_connection *conn); |
e3dad42bf ocfs2: Create ocf... |
137 138 139 140 141 |
/* * ->this_node() returns the cluster's unique identifier for the * local node. */ |
3e8341516 ocfs2: pass ocfs2... |
142 143 |
int (*this_node)(struct ocfs2_cluster_connection *conn, unsigned int *node); |
e3dad42bf ocfs2: Create ocf... |
144 145 146 147 148 149 150 |
/* * Call the underlying dlm lock function. The ->dlm_lock() * callback should convert the flags and mode as appropriate. * * ast and bast functions are not part of the call because the * stack will likely want to wrap ast and bast calls before passing |
a796d2862 ocfs2: Pass lksbs... |
151 152 153 |
* them to stack->sp_proto. There is no astarg. The lksb will * be passed back to the ast and bast functions. The caller can * use this to find their object. |
e3dad42bf ocfs2: Create ocf... |
154 155 156 |
*/ int (*dlm_lock)(struct ocfs2_cluster_connection *conn, int mode, |
c0e413385 ocfs2: Attach the... |
157 |
struct ocfs2_dlm_lksb *lksb, |
e3dad42bf ocfs2: Create ocf... |
158 159 |
u32 flags, void *name, |
a796d2862 ocfs2: Pass lksbs... |
160 |
unsigned int namelen); |
e3dad42bf ocfs2: Create ocf... |
161 162 163 164 165 166 |
/* * Call the underlying dlm unlock function. The ->dlm_unlock() * function should convert the flags as appropriate. * * The unlock ast is not passed, as the stack will want to wrap |
a796d2862 ocfs2: Pass lksbs... |
167 168 169 |
* it before calling stack->sp_proto->lp_unlock_ast(). There is * no astarg. The lksb will be passed back to the unlock ast * function. The caller can use this to find their object. |
e3dad42bf ocfs2: Create ocf... |
170 171 |
*/ int (*dlm_unlock)(struct ocfs2_cluster_connection *conn, |
c0e413385 ocfs2: Attach the... |
172 |
struct ocfs2_dlm_lksb *lksb, |
a796d2862 ocfs2: Pass lksbs... |
173 |
u32 flags); |
e3dad42bf ocfs2: Create ocf... |
174 175 176 177 178 179 180 |
/* * Return the status of the current lock status block. The fs * code should never dereference the union. The ->lock_status() * callback pulls out the stack-specific lksb, converts the status * to a proper errno, and returns it. */ |
c0e413385 ocfs2: Attach the... |
181 |
int (*lock_status)(struct ocfs2_dlm_lksb *lksb); |
e3dad42bf ocfs2: Create ocf... |
182 183 |
/* |
1c520dfbf ocfs2: Provide th... |
184 185 |
* Return non-zero if the LVB is valid. */ |
c0e413385 ocfs2: Attach the... |
186 |
int (*lvb_valid)(struct ocfs2_dlm_lksb *lksb); |
1c520dfbf ocfs2: Provide th... |
187 188 |
/* |
e3dad42bf ocfs2: Create ocf... |
189 190 |
* Pull the lvb pointer off of the stack-specific lksb. */ |
c0e413385 ocfs2: Attach the... |
191 |
void *(*lock_lvb)(struct ocfs2_dlm_lksb *lksb); |
e3dad42bf ocfs2: Create ocf... |
192 193 |
/* |
53da4939f ocfs2: POSIX file... |
194 195 196 197 198 199 200 201 202 203 204 |
* Cluster-aware posix locks * * This is NULL for stacks which do not support posix locks. */ int (*plock)(struct ocfs2_cluster_connection *conn, u64 ino, struct file *file, int cmd, struct file_lock *fl); /* |
e3dad42bf ocfs2: Create ocf... |
205 206 207 |
* This is an optoinal debugging hook. If provided, the * stack can dump debugging information about this lock. */ |
c0e413385 ocfs2: Attach the... |
208 |
void (*dump_lksb)(struct ocfs2_dlm_lksb *lksb); |
e3dad42bf ocfs2: Create ocf... |
209 |
}; |
286eaa95c ocfs2: Break out ... |
210 211 212 213 214 215 216 217 218 219 220 221 222 |
/* * Each stack plugin must describe itself by registering a * ocfs2_stack_plugin structure. This is only seen by stackglue and the * stack driver. */ struct ocfs2_stack_plugin { char *sp_name; struct ocfs2_stack_operations *sp_ops; struct module *sp_owner; /* These are managed by the stackglue code. */ struct list_head sp_list; unsigned int sp_count; |
e603cfb07 ocfs2: Remove the... |
223 |
struct ocfs2_protocol_version sp_max_proto; |
286eaa95c ocfs2: Break out ... |
224 225 226 227 |
}; /* Used by the filesystem */ |
9c6c877c0 ocfs2: Add the 'c... |
228 |
int ocfs2_cluster_connect(const char *stack_name, |
c74a3bdd9 ocfs2: add cluste... |
229 230 |
const char *cluster_name, int cluster_name_len, |
9c6c877c0 ocfs2: Add the 'c... |
231 |
const char *group, |
4670c46de ocfs2: Introduce ... |
232 |
int grouplen, |
553b5eb91 ocfs2: Pass the l... |
233 |
struct ocfs2_locking_protocol *lproto, |
4670c46de ocfs2: Introduce ... |
234 235 236 237 |
void (*recovery_handler)(int node_num, void *recovery_data), void *recovery_data, struct ocfs2_cluster_connection **conn); |
cbe0e331f ocfs2_dlmfs: Enab... |
238 239 240 241 242 243 244 245 246 247 248 |
/* * Used by callers that don't store their stack name. They must ensure * all nodes have the same stack. */ int ocfs2_cluster_connect_agnostic(const char *group, int grouplen, struct ocfs2_locking_protocol *lproto, void (*recovery_handler)(int node_num, void *recovery_data), void *recovery_data, struct ocfs2_cluster_connection **conn); |
286eaa95c ocfs2: Break out ... |
249 250 |
int ocfs2_cluster_disconnect(struct ocfs2_cluster_connection *conn, int hangup_pending); |
6953b4c00 ocfs2: Move o2hb ... |
251 |
void ocfs2_cluster_hangup(const char *group, int grouplen); |
3e8341516 ocfs2: pass ocfs2... |
252 253 |
int ocfs2_cluster_this_node(struct ocfs2_cluster_connection *conn, unsigned int *node); |
4670c46de ocfs2: Introduce ... |
254 |
|
cf4d8d75d ocfs2: add fsdlm ... |
255 |
struct ocfs2_lock_res; |
4670c46de ocfs2: Introduce ... |
256 |
int ocfs2_dlm_lock(struct ocfs2_cluster_connection *conn, |
24ef1815e ocfs2: Separate o... |
257 |
int mode, |
c0e413385 ocfs2: Attach the... |
258 |
struct ocfs2_dlm_lksb *lksb, |
24ef1815e ocfs2: Separate o... |
259 260 |
u32 flags, void *name, |
a796d2862 ocfs2: Pass lksbs... |
261 |
unsigned int namelen); |
4670c46de ocfs2: Introduce ... |
262 |
int ocfs2_dlm_unlock(struct ocfs2_cluster_connection *conn, |
c0e413385 ocfs2: Attach the... |
263 |
struct ocfs2_dlm_lksb *lksb, |
a796d2862 ocfs2: Pass lksbs... |
264 |
u32 flags); |
24ef1815e ocfs2: Separate o... |
265 |
|
c0e413385 ocfs2: Attach the... |
266 267 268 269 |
int ocfs2_dlm_lock_status(struct ocfs2_dlm_lksb *lksb); int ocfs2_dlm_lvb_valid(struct ocfs2_dlm_lksb *lksb); void *ocfs2_dlm_lvb(struct ocfs2_dlm_lksb *lksb); void ocfs2_dlm_dump_lksb(struct ocfs2_dlm_lksb *lksb); |
8f2c9c1b1 ocfs2: Create the... |
270 |
|
53da4939f ocfs2: POSIX file... |
271 272 273 |
int ocfs2_stack_supports_plocks(void); int ocfs2_plock(struct ocfs2_cluster_connection *conn, u64 ino, struct file *file, int cmd, struct file_lock *fl); |
553b5eb91 ocfs2: Pass the l... |
274 |
void ocfs2_stack_glue_set_max_proto_version(struct ocfs2_protocol_version *max_proto); |
24ef1815e ocfs2: Separate o... |
275 |
|
286eaa95c ocfs2: Break out ... |
276 277 278 279 |
/* Used by stack plugins */ int ocfs2_stack_glue_register(struct ocfs2_stack_plugin *plugin); void ocfs2_stack_glue_unregister(struct ocfs2_stack_plugin *plugin); |
3878f110f ocfs2: Move the h... |
280 |
|
9dde5e4f3 ocfs2: export ocf... |
281 |
extern struct kset *ocfs2_kset; |
24ef1815e ocfs2: Separate o... |
282 |
#endif /* STACKGLUE_H */ |