1 /* -*- mode: c; c-basic-offset: 8; -*-
2 * vim: noexpandtab sw=8 ts=8 sts=0:
6 * Code which implements an OCFS2 specific interface to underlying
9 * Copyright (C) 2007, 2009 Oracle. All rights reserved.
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public
13 * License as published by the Free Software Foundation, version 2.
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.
21 #include <linux/list.h>
22 #include <linux/spinlock.h>
23 #include <linux/module.h>
24 #include <linux/slab.h>
25 #include <linux/kmod.h>
27 #include <linux/kobject.h>
28 #include <linux/sysfs.h>
29 #include <linux/sysctl.h>
33 #include "stackglue.h"
35 #define OCFS2_STACK_PLUGIN_O2CB "o2cb"
36 #define OCFS2_STACK_PLUGIN_USER "user"
37 #define OCFS2_MAX_HB_CTL_PATH 256
39 static struct ocfs2_locking_protocol
*lproto
;
40 static DEFINE_SPINLOCK(ocfs2_stack_lock
);
41 static LIST_HEAD(ocfs2_stack_list
);
42 static char cluster_stack_name
[OCFS2_STACK_LABEL_LEN
+ 1];
43 static char ocfs2_hb_ctl_path
[OCFS2_MAX_HB_CTL_PATH
] = "/sbin/ocfs2_hb_ctl";
46 * The stack currently in use. If not null, active_stack->sp_count > 0,
47 * the module is pinned, and the locking protocol cannot be changed.
49 static struct ocfs2_stack_plugin
*active_stack
;
51 static struct ocfs2_stack_plugin
*ocfs2_stack_lookup(const char *name
)
53 struct ocfs2_stack_plugin
*p
;
55 assert_spin_locked(&ocfs2_stack_lock
);
57 list_for_each_entry(p
, &ocfs2_stack_list
, sp_list
) {
58 if (!strcmp(p
->sp_name
, name
))
65 static int ocfs2_stack_driver_request(const char *stack_name
,
66 const char *plugin_name
)
69 struct ocfs2_stack_plugin
*p
;
71 spin_lock(&ocfs2_stack_lock
);
74 * If the stack passed by the filesystem isn't the selected one,
77 if (strcmp(stack_name
, cluster_stack_name
)) {
84 * If the active stack isn't the one we want, it cannot
85 * be selected right now.
87 if (!strcmp(active_stack
->sp_name
, plugin_name
))
94 p
= ocfs2_stack_lookup(plugin_name
);
95 if (!p
|| !try_module_get(p
->sp_owner
)) {
104 /* If we found it, pin it */
106 active_stack
->sp_count
++;
108 spin_unlock(&ocfs2_stack_lock
);
113 * This function looks up the appropriate stack and makes it active. If
114 * there is no stack, it tries to load it. It will fail if the stack still
115 * cannot be found. It will also fail if a different stack is in use.
117 static int ocfs2_stack_driver_get(const char *stack_name
)
120 char *plugin_name
= OCFS2_STACK_PLUGIN_O2CB
;
123 * Classic stack does not pass in a stack name. This is
124 * compatible with older tools as well.
126 if (!stack_name
|| !*stack_name
)
127 stack_name
= OCFS2_STACK_PLUGIN_O2CB
;
129 if (strlen(stack_name
) != OCFS2_STACK_LABEL_LEN
) {
131 "ocfs2 passed an invalid cluster stack label: \"%s\"\n",
136 /* Anything that isn't the classic stack is a user stack */
137 if (strcmp(stack_name
, OCFS2_STACK_PLUGIN_O2CB
))
138 plugin_name
= OCFS2_STACK_PLUGIN_USER
;
140 rc
= ocfs2_stack_driver_request(stack_name
, plugin_name
);
142 request_module("ocfs2_stack_%s", plugin_name
);
143 rc
= ocfs2_stack_driver_request(stack_name
, plugin_name
);
148 "ocfs2: Cluster stack driver \"%s\" cannot be found\n",
150 } else if (rc
== -EBUSY
) {
152 "ocfs2: A different cluster stack is in use\n");
158 static void ocfs2_stack_driver_put(void)
160 spin_lock(&ocfs2_stack_lock
);
161 BUG_ON(active_stack
== NULL
);
162 BUG_ON(active_stack
->sp_count
== 0);
164 active_stack
->sp_count
--;
165 if (!active_stack
->sp_count
) {
166 module_put(active_stack
->sp_owner
);
169 spin_unlock(&ocfs2_stack_lock
);
172 int ocfs2_stack_glue_register(struct ocfs2_stack_plugin
*plugin
)
176 spin_lock(&ocfs2_stack_lock
);
177 if (!ocfs2_stack_lookup(plugin
->sp_name
)) {
178 plugin
->sp_count
= 0;
179 plugin
->sp_proto
= lproto
;
180 list_add(&plugin
->sp_list
, &ocfs2_stack_list
);
181 printk(KERN_INFO
"ocfs2: Registered cluster interface %s\n",
185 printk(KERN_ERR
"ocfs2: Stack \"%s\" already registered\n",
189 spin_unlock(&ocfs2_stack_lock
);
193 EXPORT_SYMBOL_GPL(ocfs2_stack_glue_register
);
195 void ocfs2_stack_glue_unregister(struct ocfs2_stack_plugin
*plugin
)
197 struct ocfs2_stack_plugin
*p
;
199 spin_lock(&ocfs2_stack_lock
);
200 p
= ocfs2_stack_lookup(plugin
->sp_name
);
203 BUG_ON(plugin
== active_stack
);
204 BUG_ON(plugin
->sp_count
!= 0);
205 list_del_init(&plugin
->sp_list
);
206 printk(KERN_INFO
"ocfs2: Unregistered cluster interface %s\n",
209 printk(KERN_ERR
"Stack \"%s\" is not registered\n",
212 spin_unlock(&ocfs2_stack_lock
);
214 EXPORT_SYMBOL_GPL(ocfs2_stack_glue_unregister
);
216 void ocfs2_stack_glue_set_locking_protocol(struct ocfs2_locking_protocol
*proto
)
218 struct ocfs2_stack_plugin
*p
;
220 BUG_ON(proto
== NULL
);
222 spin_lock(&ocfs2_stack_lock
);
223 BUG_ON(active_stack
!= NULL
);
226 list_for_each_entry(p
, &ocfs2_stack_list
, sp_list
) {
227 p
->sp_proto
= lproto
;
230 spin_unlock(&ocfs2_stack_lock
);
232 EXPORT_SYMBOL_GPL(ocfs2_stack_glue_set_locking_protocol
);
236 * The ocfs2_dlm_lock() and ocfs2_dlm_unlock() functions take
237 * "struct ocfs2_lock_res *astarg" instead of "void *astarg" because the
238 * underlying stack plugins need to pilfer the lksb off of the lock_res.
239 * If some other structure needs to be passed as an astarg, the plugins
240 * will need to be given a different avenue to the lksb.
242 int ocfs2_dlm_lock(struct ocfs2_cluster_connection
*conn
,
244 union ocfs2_dlm_lksb
*lksb
,
247 unsigned int namelen
,
248 struct ocfs2_lock_res
*astarg
)
250 BUG_ON(lproto
== NULL
);
252 return active_stack
->sp_ops
->dlm_lock(conn
, mode
, lksb
, flags
,
253 name
, namelen
, astarg
);
255 EXPORT_SYMBOL_GPL(ocfs2_dlm_lock
);
257 int ocfs2_dlm_unlock(struct ocfs2_cluster_connection
*conn
,
258 union ocfs2_dlm_lksb
*lksb
,
260 struct ocfs2_lock_res
*astarg
)
262 BUG_ON(lproto
== NULL
);
264 return active_stack
->sp_ops
->dlm_unlock(conn
, lksb
, flags
, astarg
);
266 EXPORT_SYMBOL_GPL(ocfs2_dlm_unlock
);
268 int ocfs2_dlm_lock_status(union ocfs2_dlm_lksb
*lksb
)
270 return active_stack
->sp_ops
->lock_status(lksb
);
272 EXPORT_SYMBOL_GPL(ocfs2_dlm_lock_status
);
274 int ocfs2_dlm_lvb_valid(union ocfs2_dlm_lksb
*lksb
)
276 return active_stack
->sp_ops
->lvb_valid(lksb
);
278 EXPORT_SYMBOL_GPL(ocfs2_dlm_lvb_valid
);
280 void *ocfs2_dlm_lvb(union ocfs2_dlm_lksb
*lksb
)
282 return active_stack
->sp_ops
->lock_lvb(lksb
);
284 EXPORT_SYMBOL_GPL(ocfs2_dlm_lvb
);
286 void ocfs2_dlm_dump_lksb(union ocfs2_dlm_lksb
*lksb
)
288 active_stack
->sp_ops
->dump_lksb(lksb
);
290 EXPORT_SYMBOL_GPL(ocfs2_dlm_dump_lksb
);
292 int ocfs2_stack_supports_plocks(void)
294 return active_stack
&& active_stack
->sp_ops
->plock
;
296 EXPORT_SYMBOL_GPL(ocfs2_stack_supports_plocks
);
299 * ocfs2_plock() can only be safely called if
300 * ocfs2_stack_supports_plocks() returned true
302 int ocfs2_plock(struct ocfs2_cluster_connection
*conn
, u64 ino
,
303 struct file
*file
, int cmd
, struct file_lock
*fl
)
305 WARN_ON_ONCE(active_stack
->sp_ops
->plock
== NULL
);
306 if (active_stack
->sp_ops
->plock
)
307 return active_stack
->sp_ops
->plock(conn
, ino
, file
, cmd
, fl
);
310 EXPORT_SYMBOL_GPL(ocfs2_plock
);
312 int ocfs2_cluster_connect(const char *stack_name
,
315 void (*recovery_handler
)(int node_num
,
316 void *recovery_data
),
318 struct ocfs2_cluster_connection
**conn
)
321 struct ocfs2_cluster_connection
*new_conn
;
323 BUG_ON(group
== NULL
);
324 BUG_ON(conn
== NULL
);
325 BUG_ON(recovery_handler
== NULL
);
327 if (grouplen
> GROUP_NAME_MAX
) {
332 new_conn
= kzalloc(sizeof(struct ocfs2_cluster_connection
),
339 memcpy(new_conn
->cc_name
, group
, grouplen
);
340 new_conn
->cc_namelen
= grouplen
;
341 new_conn
->cc_recovery_handler
= recovery_handler
;
342 new_conn
->cc_recovery_data
= recovery_data
;
344 /* Start the new connection at our maximum compatibility level */
345 new_conn
->cc_version
= lproto
->lp_max_version
;
347 /* This will pin the stack driver if successful */
348 rc
= ocfs2_stack_driver_get(stack_name
);
352 rc
= active_stack
->sp_ops
->connect(new_conn
);
354 ocfs2_stack_driver_put();
367 EXPORT_SYMBOL_GPL(ocfs2_cluster_connect
);
369 /* If hangup_pending is 0, the stack driver will be dropped */
370 int ocfs2_cluster_disconnect(struct ocfs2_cluster_connection
*conn
,
375 BUG_ON(conn
== NULL
);
377 ret
= active_stack
->sp_ops
->disconnect(conn
);
379 /* XXX Should we free it anyway? */
383 ocfs2_stack_driver_put();
388 EXPORT_SYMBOL_GPL(ocfs2_cluster_disconnect
);
391 * Leave the group for this filesystem. This is executed by a userspace
392 * program (stored in ocfs2_hb_ctl_path).
394 static void ocfs2_leave_group(const char *group
)
397 char *argv
[5], *envp
[3];
399 argv
[0] = ocfs2_hb_ctl_path
;
402 argv
[3] = (char *)group
;
405 /* minimal command environment taken from cpu_run_sbin_hotplug */
407 envp
[1] = "PATH=/sbin:/bin:/usr/sbin:/usr/bin";
410 ret
= call_usermodehelper(argv
[0], argv
, envp
, UMH_WAIT_PROC
);
413 "ocfs2: Error %d running user helper "
415 ret
, argv
[0], argv
[1], argv
[2], argv
[3]);
420 * Hangup is a required post-umount. ocfs2-tools software expects the
421 * filesystem to call "ocfs2_hb_ctl" during unmount. This happens
422 * regardless of whether the DLM got started, so we can't do it
423 * in ocfs2_cluster_disconnect(). The ocfs2_leave_group() function does
426 void ocfs2_cluster_hangup(const char *group
, int grouplen
)
428 BUG_ON(group
== NULL
);
429 BUG_ON(group
[grouplen
] != '\0');
431 ocfs2_leave_group(group
);
433 /* cluster_disconnect() was called with hangup_pending==1 */
434 ocfs2_stack_driver_put();
436 EXPORT_SYMBOL_GPL(ocfs2_cluster_hangup
);
438 int ocfs2_cluster_this_node(unsigned int *node
)
440 return active_stack
->sp_ops
->this_node(node
);
442 EXPORT_SYMBOL_GPL(ocfs2_cluster_this_node
);
449 static ssize_t
ocfs2_max_locking_protocol_show(struct kobject
*kobj
,
450 struct kobj_attribute
*attr
,
455 spin_lock(&ocfs2_stack_lock
);
457 ret
= snprintf(buf
, PAGE_SIZE
, "%u.%u\n",
458 lproto
->lp_max_version
.pv_major
,
459 lproto
->lp_max_version
.pv_minor
);
460 spin_unlock(&ocfs2_stack_lock
);
465 static struct kobj_attribute ocfs2_attr_max_locking_protocol
=
466 __ATTR(max_locking_protocol
, S_IFREG
| S_IRUGO
,
467 ocfs2_max_locking_protocol_show
, NULL
);
469 static ssize_t
ocfs2_loaded_cluster_plugins_show(struct kobject
*kobj
,
470 struct kobj_attribute
*attr
,
473 ssize_t ret
= 0, total
= 0, remain
= PAGE_SIZE
;
474 struct ocfs2_stack_plugin
*p
;
476 spin_lock(&ocfs2_stack_lock
);
477 list_for_each_entry(p
, &ocfs2_stack_list
, sp_list
) {
478 ret
= snprintf(buf
, remain
, "%s\n",
485 /* snprintf() didn't fit */
492 spin_unlock(&ocfs2_stack_lock
);
497 static struct kobj_attribute ocfs2_attr_loaded_cluster_plugins
=
498 __ATTR(loaded_cluster_plugins
, S_IFREG
| S_IRUGO
,
499 ocfs2_loaded_cluster_plugins_show
, NULL
);
501 static ssize_t
ocfs2_active_cluster_plugin_show(struct kobject
*kobj
,
502 struct kobj_attribute
*attr
,
507 spin_lock(&ocfs2_stack_lock
);
509 ret
= snprintf(buf
, PAGE_SIZE
, "%s\n",
510 active_stack
->sp_name
);
511 if (ret
== PAGE_SIZE
)
514 spin_unlock(&ocfs2_stack_lock
);
519 static struct kobj_attribute ocfs2_attr_active_cluster_plugin
=
520 __ATTR(active_cluster_plugin
, S_IFREG
| S_IRUGO
,
521 ocfs2_active_cluster_plugin_show
, NULL
);
523 static ssize_t
ocfs2_cluster_stack_show(struct kobject
*kobj
,
524 struct kobj_attribute
*attr
,
528 spin_lock(&ocfs2_stack_lock
);
529 ret
= snprintf(buf
, PAGE_SIZE
, "%s\n", cluster_stack_name
);
530 spin_unlock(&ocfs2_stack_lock
);
535 static ssize_t
ocfs2_cluster_stack_store(struct kobject
*kobj
,
536 struct kobj_attribute
*attr
,
537 const char *buf
, size_t count
)
545 if (buf
[len
- 1] == '\n')
548 if ((len
!= OCFS2_STACK_LABEL_LEN
) ||
549 (strnlen(buf
, len
) != len
))
552 spin_lock(&ocfs2_stack_lock
);
554 if (!strncmp(buf
, cluster_stack_name
, len
))
559 memcpy(cluster_stack_name
, buf
, len
);
562 spin_unlock(&ocfs2_stack_lock
);
568 static struct kobj_attribute ocfs2_attr_cluster_stack
=
569 __ATTR(cluster_stack
, S_IFREG
| S_IRUGO
| S_IWUSR
,
570 ocfs2_cluster_stack_show
,
571 ocfs2_cluster_stack_store
);
573 static struct attribute
*ocfs2_attrs
[] = {
574 &ocfs2_attr_max_locking_protocol
.attr
,
575 &ocfs2_attr_loaded_cluster_plugins
.attr
,
576 &ocfs2_attr_active_cluster_plugin
.attr
,
577 &ocfs2_attr_cluster_stack
.attr
,
581 static struct attribute_group ocfs2_attr_group
= {
582 .attrs
= ocfs2_attrs
,
585 static struct kset
*ocfs2_kset
;
587 static void ocfs2_sysfs_exit(void)
589 kset_unregister(ocfs2_kset
);
592 static int ocfs2_sysfs_init(void)
596 ocfs2_kset
= kset_create_and_add("ocfs2", NULL
, fs_kobj
);
600 ret
= sysfs_create_group(&ocfs2_kset
->kobj
, &ocfs2_attr_group
);
607 kset_unregister(ocfs2_kset
);
614 * The sysctl lives at /proc/sys/fs/ocfs2/nm/hb_ctl_path. The 'nm' doesn't
615 * make as much sense in a multiple cluster stack world, but it's safer
616 * and easier to preserve the name.
619 #define FS_OCFS2_NM 1
621 static ctl_table ocfs2_nm_table
[] = {
624 .procname
= "hb_ctl_path",
625 .data
= ocfs2_hb_ctl_path
,
626 .maxlen
= OCFS2_MAX_HB_CTL_PATH
,
628 .proc_handler
= &proc_dostring
,
629 .strategy
= &sysctl_string
,
634 static ctl_table ocfs2_mod_table
[] = {
636 .ctl_name
= FS_OCFS2_NM
,
641 .child
= ocfs2_nm_table
646 static ctl_table ocfs2_kern_table
[] = {
648 .ctl_name
= FS_OCFS2
,
653 .child
= ocfs2_mod_table
658 static ctl_table ocfs2_root_table
[] = {
665 .child
= ocfs2_kern_table
670 static struct ctl_table_header
*ocfs2_table_header
= NULL
;
677 static int __init
ocfs2_stack_glue_init(void)
679 strcpy(cluster_stack_name
, OCFS2_STACK_PLUGIN_O2CB
);
681 ocfs2_table_header
= register_sysctl_table(ocfs2_root_table
);
682 if (!ocfs2_table_header
) {
684 "ocfs2 stack glue: unable to register sysctl\n");
685 return -ENOMEM
; /* or something. */
688 return ocfs2_sysfs_init();
691 static void __exit
ocfs2_stack_glue_exit(void)
695 if (ocfs2_table_header
)
696 unregister_sysctl_table(ocfs2_table_header
);
699 MODULE_AUTHOR("Oracle");
700 MODULE_DESCRIPTION("ocfs2 cluter stack glue layer");
701 MODULE_LICENSE("GPL");
702 module_init(ocfs2_stack_glue_init
);
703 module_exit(ocfs2_stack_glue_exit
);