Commit | Line | Data |
---|---|---|
24ef1815 JB |
1 | /* -*- mode: c; c-basic-offset: 8; -*- |
2 | * vim: noexpandtab sw=8 ts=8 sts=0: | |
3 | * | |
4 | * stackglue.h | |
5 | * | |
6 | * Glue to the underlying cluster stack. | |
7 | * | |
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. | |
18 | */ | |
19 | ||
20 | ||
21 | #ifndef STACKGLUE_H | |
22 | #define STACKGLUE_H | |
23 | ||
bd3e7610 JB |
24 | #include <linux/types.h> |
25 | #include <linux/list.h> | |
26 | #include <linux/dlmconstants.h> | |
27 | ||
e3dad42b JB |
28 | #include "dlm/dlmapi.h" |
29 | ||
bd3e7610 JB |
30 | /* |
31 | * dlmconstants.h does not have a LOCAL flag. We hope to remove it | |
32 | * some day, but right now we need it. Let's fake it. This value is larger | |
33 | * than any flag in dlmconstants.h. | |
34 | */ | |
35 | #define DLM_LKF_LOCAL 0x00100000 | |
36 | ||
4670c46d JB |
37 | /* |
38 | * This shadows DLM_LOCKSPACE_LEN in fs/dlm/dlm_internal.h. That probably | |
39 | * wants to be in a public header. | |
40 | */ | |
41 | #define GROUP_NAME_MAX 64 | |
42 | ||
43 | ||
e3dad42b JB |
44 | /* |
45 | * ocfs2_protocol_version changes when ocfs2 does something different in | |
46 | * its inter-node behavior. See dlmglue.c for more information. | |
47 | */ | |
4670c46d JB |
48 | struct ocfs2_protocol_version { |
49 | u8 pv_major; | |
50 | u8 pv_minor; | |
51 | }; | |
52 | ||
e3dad42b JB |
53 | /* |
54 | * The ocfs2_locking_protocol defines the handlers called on ocfs2's behalf. | |
55 | */ | |
24ef1815 | 56 | struct ocfs2_locking_protocol { |
4670c46d | 57 | struct ocfs2_protocol_version lp_max_version; |
24ef1815 JB |
58 | void (*lp_lock_ast)(void *astarg); |
59 | void (*lp_blocking_ast)(void *astarg, int level); | |
7431cd7e | 60 | void (*lp_unlock_ast)(void *astarg, int error); |
24ef1815 JB |
61 | }; |
62 | ||
e3dad42b JB |
63 | /* |
64 | * A union of all lock status structures. We define it here so that the | |
65 | * size of the union is known. Lock status structures are embedded in | |
66 | * ocfs2 inodes. | |
67 | */ | |
8f2c9c1b JB |
68 | union ocfs2_dlm_lksb { |
69 | struct dlm_lockstatus lksb_o2dlm; | |
70 | }; | |
71 | ||
e3dad42b JB |
72 | /* |
73 | * A cluster connection. Mostly opaque to ocfs2, the connection holds | |
74 | * state for the underlying stack. ocfs2 does use cc_version to determine | |
75 | * locking compatibility. | |
76 | */ | |
4670c46d JB |
77 | struct ocfs2_cluster_connection { |
78 | char cc_name[GROUP_NAME_MAX]; | |
79 | int cc_namelen; | |
80 | struct ocfs2_protocol_version cc_version; | |
81 | void (*cc_recovery_handler)(int node_num, void *recovery_data); | |
82 | void *cc_recovery_data; | |
83 | void *cc_lockspace; | |
84 | void *cc_private; | |
85 | }; | |
86 | ||
e3dad42b JB |
87 | /* |
88 | * Each cluster stack implements the stack operations structure. Not used | |
89 | * in the ocfs2 code, the stackglue code translates generic cluster calls | |
90 | * into stack operations. | |
91 | */ | |
92 | struct ocfs2_stack_operations { | |
93 | /* | |
94 | * The fs code calls ocfs2_cluster_connect() to attach a new | |
95 | * filesystem to the cluster stack. The ->connect() op is passed | |
96 | * an ocfs2_cluster_connection with the name and recovery field | |
97 | * filled in. | |
98 | * | |
99 | * The stack must set up any notification mechanisms and create | |
100 | * the filesystem lockspace in the DLM. The lockspace should be | |
101 | * stored on cc_lockspace. Any other information can be stored on | |
102 | * cc_private. | |
103 | * | |
104 | * ->connect() must not return until it is guaranteed that | |
105 | * | |
106 | * - Node down notifications for the filesystem will be recieved | |
107 | * and passed to conn->cc_recovery_handler(). | |
108 | * - Locking requests for the filesystem will be processed. | |
109 | */ | |
110 | int (*connect)(struct ocfs2_cluster_connection *conn); | |
111 | ||
112 | /* | |
113 | * The fs code calls ocfs2_cluster_disconnect() when a filesystem | |
114 | * no longer needs cluster services. All DLM locks have been | |
115 | * dropped, and recovery notification is being ignored by the | |
116 | * fs code. The stack must disengage from the DLM and discontinue | |
117 | * recovery notification. | |
118 | * | |
119 | * Once ->disconnect() has returned, the connection structure will | |
120 | * be freed. Thus, a stack must not return from ->disconnect() | |
121 | * until it will no longer reference the conn pointer. | |
122 | */ | |
123 | int (*disconnect)(struct ocfs2_cluster_connection *conn); | |
124 | ||
125 | /* | |
126 | * ocfs2_cluster_hangup() exists for compatibility with older | |
127 | * ocfs2 tools. Only the classic stack really needs it. As such | |
128 | * ->hangup() is not required of all stacks. See the comment by | |
129 | * ocfs2_cluster_hangup() for more details. | |
130 | */ | |
131 | void (*hangup)(const char *group, int grouplen); | |
132 | ||
133 | /* | |
134 | * ->this_node() returns the cluster's unique identifier for the | |
135 | * local node. | |
136 | */ | |
137 | int (*this_node)(unsigned int *node); | |
138 | ||
139 | /* | |
140 | * Call the underlying dlm lock function. The ->dlm_lock() | |
141 | * callback should convert the flags and mode as appropriate. | |
142 | * | |
143 | * ast and bast functions are not part of the call because the | |
144 | * stack will likely want to wrap ast and bast calls before passing | |
145 | * them to stack->sp_proto. | |
146 | */ | |
147 | int (*dlm_lock)(struct ocfs2_cluster_connection *conn, | |
148 | int mode, | |
149 | union ocfs2_dlm_lksb *lksb, | |
150 | u32 flags, | |
151 | void *name, | |
152 | unsigned int namelen, | |
153 | void *astarg); | |
154 | ||
155 | /* | |
156 | * Call the underlying dlm unlock function. The ->dlm_unlock() | |
157 | * function should convert the flags as appropriate. | |
158 | * | |
159 | * The unlock ast is not passed, as the stack will want to wrap | |
160 | * it before calling stack->sp_proto->lp_unlock_ast(). | |
161 | */ | |
162 | int (*dlm_unlock)(struct ocfs2_cluster_connection *conn, | |
163 | union ocfs2_dlm_lksb *lksb, | |
164 | u32 flags, | |
165 | void *astarg); | |
166 | ||
167 | /* | |
168 | * Return the status of the current lock status block. The fs | |
169 | * code should never dereference the union. The ->lock_status() | |
170 | * callback pulls out the stack-specific lksb, converts the status | |
171 | * to a proper errno, and returns it. | |
172 | */ | |
173 | int (*lock_status)(union ocfs2_dlm_lksb *lksb); | |
174 | ||
175 | /* | |
176 | * Pull the lvb pointer off of the stack-specific lksb. | |
177 | */ | |
178 | void *(*lock_lvb)(union ocfs2_dlm_lksb *lksb); | |
179 | ||
180 | /* | |
181 | * This is an optoinal debugging hook. If provided, the | |
182 | * stack can dump debugging information about this lock. | |
183 | */ | |
184 | void (*dump_lksb)(union ocfs2_dlm_lksb *lksb); | |
185 | }; | |
186 | ||
4670c46d JB |
187 | int ocfs2_cluster_connect(const char *group, |
188 | int grouplen, | |
189 | void (*recovery_handler)(int node_num, | |
190 | void *recovery_data), | |
191 | void *recovery_data, | |
192 | struct ocfs2_cluster_connection **conn); | |
193 | int ocfs2_cluster_disconnect(struct ocfs2_cluster_connection *conn); | |
6953b4c0 | 194 | void ocfs2_cluster_hangup(const char *group, int grouplen); |
19fdb624 | 195 | int ocfs2_cluster_this_node(unsigned int *node); |
4670c46d JB |
196 | |
197 | int ocfs2_dlm_lock(struct ocfs2_cluster_connection *conn, | |
24ef1815 | 198 | int mode, |
8f2c9c1b | 199 | union ocfs2_dlm_lksb *lksb, |
24ef1815 JB |
200 | u32 flags, |
201 | void *name, | |
202 | unsigned int namelen, | |
203 | void *astarg); | |
4670c46d | 204 | int ocfs2_dlm_unlock(struct ocfs2_cluster_connection *conn, |
8f2c9c1b | 205 | union ocfs2_dlm_lksb *lksb, |
24ef1815 JB |
206 | u32 flags, |
207 | void *astarg); | |
208 | ||
8f2c9c1b JB |
209 | int ocfs2_dlm_lock_status(union ocfs2_dlm_lksb *lksb); |
210 | void *ocfs2_dlm_lvb(union ocfs2_dlm_lksb *lksb); | |
cf0acdcd | 211 | void ocfs2_dlm_dump_lksb(union ocfs2_dlm_lksb *lksb); |
8f2c9c1b | 212 | |
63e0c48a | 213 | void ocfs2_stack_glue_set_locking_protocol(struct ocfs2_locking_protocol *proto); |
24ef1815 | 214 | |
e3dad42b JB |
215 | extern struct ocfs2_locking_protocol *stack_glue_lproto; |
216 | extern struct ocfs2_stack_operations o2cb_stack_ops; | |
24ef1815 | 217 | #endif /* STACKGLUE_H */ |