1 /* -*- mode: c; c-basic-offset: 8; -*-
2 * vim: noexpandtab sw=8 ts=8 sts=0:
6 * Code which interfaces ocfs2 with the o2cb stack.
8 * Copyright (C) 2007 Oracle. All rights reserved.
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.
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.
20 #include <linux/kernel.h>
21 #include <linux/crc32.h>
22 #include <linux/module.h>
24 /* Needed for AOP_TRUNCATED_PAGE in mlog_errno() */
27 #include "cluster/masklog.h"
28 #include "cluster/nodemanager.h"
29 #include "cluster/heartbeat.h"
31 #include "stackglue.h"
33 struct o2dlm_private {
34 struct dlm_eviction_cb op_eviction_cb;
37 static struct ocfs2_stack_plugin o2cb_stack;
39 /* These should be identical */
40 #if (DLM_LOCK_IV != LKM_IVMODE)
41 # error Lock modes do not match
43 #if (DLM_LOCK_NL != LKM_NLMODE)
44 # error Lock modes do not match
46 #if (DLM_LOCK_CR != LKM_CRMODE)
47 # error Lock modes do not match
49 #if (DLM_LOCK_CW != LKM_CWMODE)
50 # error Lock modes do not match
52 #if (DLM_LOCK_PR != LKM_PRMODE)
53 # error Lock modes do not match
55 #if (DLM_LOCK_PW != LKM_PWMODE)
56 # error Lock modes do not match
58 #if (DLM_LOCK_EX != LKM_EXMODE)
59 # error Lock modes do not match
61 static inline int mode_to_o2dlm(int mode)
63 BUG_ON(mode > LKM_MAXMODE);
68 #define map_flag(_generic, _o2dlm) \
69 if (flags & (_generic)) { \
70 flags &= ~(_generic); \
71 o2dlm_flags |= (_o2dlm); \
73 static int flags_to_o2dlm(u32 flags)
77 map_flag(DLM_LKF_NOQUEUE, LKM_NOQUEUE);
78 map_flag(DLM_LKF_CANCEL, LKM_CANCEL);
79 map_flag(DLM_LKF_CONVERT, LKM_CONVERT);
80 map_flag(DLM_LKF_VALBLK, LKM_VALBLK);
81 map_flag(DLM_LKF_IVVALBLK, LKM_INVVALBLK);
82 map_flag(DLM_LKF_ORPHAN, LKM_ORPHAN);
83 map_flag(DLM_LKF_FORCEUNLOCK, LKM_FORCE);
84 map_flag(DLM_LKF_TIMEOUT, LKM_TIMEOUT);
85 map_flag(DLM_LKF_LOCAL, LKM_LOCAL);
87 /* map_flag() should have cleared every flag passed in */
95 * Map an o2dlm status to standard errno values.
97 * o2dlm only uses a handful of these, and returns even fewer to the
98 * caller. Still, we try to assign sane values to each error.
100 * The following value pairs have special meanings to dlmglue, thus
101 * the right hand side needs to stay unique - never duplicate the
102 * mapping elsewhere in the table!
105 * DLM_NOTQUEUED: -EAGAIN
106 * DLM_CANCELGRANT: -EBUSY
107 * DLM_CANCEL: -DLM_ECANCEL
109 /* Keep in sync with dlmapi.h */
110 static int status_map[] = {
111 [DLM_NORMAL] = 0, /* Success */
112 [DLM_GRANTED] = -EINVAL,
113 [DLM_DENIED] = -EACCES,
114 [DLM_DENIED_NOLOCKS] = -EACCES,
115 [DLM_WORKING] = -EACCES,
116 [DLM_BLOCKED] = -EINVAL,
117 [DLM_BLOCKED_ORPHAN] = -EINVAL,
118 [DLM_DENIED_GRACE_PERIOD] = -EACCES,
119 [DLM_SYSERR] = -ENOMEM, /* It is what it is */
120 [DLM_NOSUPPORT] = -EPROTO,
121 [DLM_CANCELGRANT] = -EBUSY, /* Cancel after grant */
122 [DLM_IVLOCKID] = -EINVAL,
123 [DLM_SYNC] = -EINVAL,
124 [DLM_BADTYPE] = -EINVAL,
125 [DLM_BADRESOURCE] = -EINVAL,
126 [DLM_MAXHANDLES] = -ENOMEM,
127 [DLM_NOCLINFO] = -EINVAL,
128 [DLM_NOLOCKMGR] = -EINVAL,
129 [DLM_NOPURGED] = -EINVAL,
130 [DLM_BADARGS] = -EINVAL,
131 [DLM_VOID] = -EINVAL,
132 [DLM_NOTQUEUED] = -EAGAIN, /* Trylock failed */
133 [DLM_IVBUFLEN] = -EINVAL,
134 [DLM_CVTUNGRANT] = -EPERM,
135 [DLM_BADPARAM] = -EINVAL,
136 [DLM_VALNOTVALID] = -EINVAL,
137 [DLM_REJECTED] = -EPERM,
138 [DLM_ABORT] = -EINVAL,
139 [DLM_CANCEL] = -DLM_ECANCEL, /* Successful cancel */
140 [DLM_IVRESHANDLE] = -EINVAL,
141 [DLM_DEADLOCK] = -EDEADLK,
142 [DLM_DENIED_NOASTS] = -EINVAL,
143 [DLM_FORWARD] = -EINVAL,
144 [DLM_TIMEOUT] = -ETIMEDOUT,
145 [DLM_IVGROUPID] = -EINVAL,
146 [DLM_VERS_CONFLICT] = -EOPNOTSUPP,
147 [DLM_BAD_DEVICE_PATH] = -ENOENT,
148 [DLM_NO_DEVICE_PERMISSION] = -EPERM,
149 [DLM_NO_CONTROL_DEVICE] = -ENOENT,
150 [DLM_RECOVERING] = -ENOTCONN,
151 [DLM_MIGRATING] = -ERESTART,
152 [DLM_MAXSTATS] = -EINVAL,
155 static int dlm_status_to_errno(enum dlm_status status)
157 BUG_ON(status < 0 || status >= ARRAY_SIZE(status_map));
159 return status_map[status];
162 static void o2dlm_lock_ast_wrapper(void *astarg)
164 struct ocfs2_dlm_lksb *lksb = astarg;
166 BUG_ON(o2cb_stack.sp_proto == NULL);
168 o2cb_stack.sp_proto->lp_lock_ast(lksb);
171 static void o2dlm_blocking_ast_wrapper(void *astarg, int level)
173 struct ocfs2_dlm_lksb *lksb = astarg;
175 BUG_ON(o2cb_stack.sp_proto == NULL);
177 o2cb_stack.sp_proto->lp_blocking_ast(lksb, level);
180 static void o2dlm_unlock_ast_wrapper(void *astarg, enum dlm_status status)
182 struct ocfs2_dlm_lksb *lksb = astarg;
184 int error = dlm_status_to_errno(status);
186 BUG_ON(o2cb_stack.sp_proto == NULL);
189 * In o2dlm, you can get both the lock_ast() for the lock being
190 * granted and the unlock_ast() for the CANCEL failing. A
191 * successful cancel sends DLM_NORMAL here. If the
192 * lock grant happened before the cancel arrived, you get
195 * There's no need for the double-ast. If we see DLM_CANCELGRANT,
196 * we just ignore it. We expect the lock_ast() to handle the
199 if (status == DLM_CANCELGRANT)
202 o2cb_stack.sp_proto->lp_unlock_ast(lksb, error);
205 static int o2cb_dlm_lock(struct ocfs2_cluster_connection *conn,
207 struct ocfs2_dlm_lksb *lksb,
210 unsigned int namelen)
212 enum dlm_status status;
213 int o2dlm_mode = mode_to_o2dlm(mode);
214 int o2dlm_flags = flags_to_o2dlm(flags);
217 status = dlmlock(conn->cc_lockspace, o2dlm_mode, &lksb->lksb_o2dlm,
218 o2dlm_flags, name, namelen,
219 o2dlm_lock_ast_wrapper, lksb,
220 o2dlm_blocking_ast_wrapper);
221 ret = dlm_status_to_errno(status);
225 static int o2cb_dlm_unlock(struct ocfs2_cluster_connection *conn,
226 struct ocfs2_dlm_lksb *lksb,
229 enum dlm_status status;
230 int o2dlm_flags = flags_to_o2dlm(flags);
233 status = dlmunlock(conn->cc_lockspace, &lksb->lksb_o2dlm,
234 o2dlm_flags, o2dlm_unlock_ast_wrapper, lksb);
235 ret = dlm_status_to_errno(status);
239 static int o2cb_dlm_lock_status(struct ocfs2_dlm_lksb *lksb)
241 return dlm_status_to_errno(lksb->lksb_o2dlm.status);
245 * o2dlm aways has a "valid" LVB. If the dlm loses track of the LVB
246 * contents, it will zero out the LVB. Thus the caller can always trust
249 static int o2cb_dlm_lvb_valid(struct ocfs2_dlm_lksb *lksb)
254 static void *o2cb_dlm_lvb(struct ocfs2_dlm_lksb *lksb)
256 return (void *)(lksb->lksb_o2dlm.lvb);
259 static void o2cb_dump_lksb(struct ocfs2_dlm_lksb *lksb)
261 dlm_print_one_lock(lksb->lksb_o2dlm.lockid);
265 * Called from the dlm when it's about to evict a node. This is how the
266 * classic stack signals node death.
268 static void o2dlm_eviction_cb(int node_num, void *data)
270 struct ocfs2_cluster_connection *conn = data;
272 mlog(ML_NOTICE, "o2dlm has evicted node %d from group %.*s\n",
273 node_num, conn->cc_namelen, conn->cc_name);
275 conn->cc_recovery_handler(node_num, conn->cc_recovery_data);
278 static int o2cb_cluster_connect(struct ocfs2_cluster_connection *conn)
282 struct dlm_ctxt *dlm;
283 struct o2dlm_private *priv;
284 struct dlm_protocol_version fs_version;
286 BUG_ON(conn == NULL);
287 BUG_ON(o2cb_stack.sp_proto == NULL);
289 /* for now we only have one cluster/node, make sure we see it
290 * in the heartbeat universe */
291 if (!o2hb_check_local_node_heartbeating()) {
296 priv = kzalloc(sizeof(struct o2dlm_private), GFP_KERNEL);
302 /* This just fills the structure in. It is safe to pass conn. */
303 dlm_setup_eviction_cb(&priv->op_eviction_cb, o2dlm_eviction_cb,
306 conn->cc_private = priv;
308 /* used by the dlm code to make message headers unique, each
309 * node in this domain must agree on this. */
310 dlm_key = crc32_le(0, conn->cc_name, conn->cc_namelen);
311 fs_version.pv_major = conn->cc_version.pv_major;
312 fs_version.pv_minor = conn->cc_version.pv_minor;
314 dlm = dlm_register_domain(conn->cc_name, dlm_key, &fs_version);
321 conn->cc_version.pv_major = fs_version.pv_major;
322 conn->cc_version.pv_minor = fs_version.pv_minor;
323 conn->cc_lockspace = dlm;
325 dlm_register_eviction_cb(dlm, &priv->op_eviction_cb);
328 if (rc && conn->cc_private)
329 kfree(conn->cc_private);
335 static int o2cb_cluster_disconnect(struct ocfs2_cluster_connection *conn)
337 struct dlm_ctxt *dlm = conn->cc_lockspace;
338 struct o2dlm_private *priv = conn->cc_private;
340 dlm_unregister_eviction_cb(&priv->op_eviction_cb);
341 conn->cc_private = NULL;
344 dlm_unregister_domain(dlm);
345 conn->cc_lockspace = NULL;
350 static int o2cb_cluster_this_node(unsigned int *node)
354 node_num = o2nm_this_node();
355 if (node_num == O2NM_INVALID_NODE_NUM)
358 if (node_num >= O2NM_MAX_NODES)
365 static struct ocfs2_stack_operations o2cb_stack_ops = {
366 .connect = o2cb_cluster_connect,
367 .disconnect = o2cb_cluster_disconnect,
368 .this_node = o2cb_cluster_this_node,
369 .dlm_lock = o2cb_dlm_lock,
370 .dlm_unlock = o2cb_dlm_unlock,
371 .lock_status = o2cb_dlm_lock_status,
372 .lvb_valid = o2cb_dlm_lvb_valid,
373 .lock_lvb = o2cb_dlm_lvb,
374 .dump_lksb = o2cb_dump_lksb,
377 static struct ocfs2_stack_plugin o2cb_stack = {
379 .sp_ops = &o2cb_stack_ops,
380 .sp_owner = THIS_MODULE,
383 static int __init o2cb_stack_init(void)
385 return ocfs2_stack_glue_register(&o2cb_stack);
388 static void __exit o2cb_stack_exit(void)
390 ocfs2_stack_glue_unregister(&o2cb_stack);
393 MODULE_AUTHOR("Oracle");
394 MODULE_DESCRIPTION("ocfs2 driver for the classic o2cb stack");
395 MODULE_LICENSE("GPL");
396 module_init(o2cb_stack_init);
397 module_exit(o2cb_stack_exit);