1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Object Devices Class Driver
6 * Copyright (C) 2001-2003 Cluster File Systems, Inc.
8 * This file is part of Lustre, http://www.lustre.org.
10 * Lustre is free software; you can redistribute it and/or
11 * modify it under the terms of version 2 of the GNU General Public
12 * License as published by the Free Software Foundation.
14 * Lustre 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
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with Lustre; if not, write to the Free Software
21 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 * These are the only exported functions, they provide some generic
24 * infrastructure for managing object devices
27 #define DEBUG_SUBSYSTEM S_CLASS
29 # define EXPORT_SYMTAB
32 #include <linux/config.h> /* for CONFIG_PROC_FS */
33 #include <linux/module.h>
34 #include <linux/errno.h>
35 #include <linux/kernel.h>
36 #include <linux/major.h>
37 #include <linux/sched.h>
39 #include <linux/slab.h>
40 #include <linux/ioport.h>
41 #include <linux/fcntl.h>
42 #include <linux/delay.h>
43 #include <linux/skbuff.h>
44 #include <linux/proc_fs.h>
46 #include <linux/poll.h>
47 #include <linux/init.h>
48 #include <linux/list.h>
49 #include <linux/highmem.h>
51 #include <asm/ioctls.h>
52 #include <asm/system.h>
54 #include <asm/uaccess.h>
55 #include <linux/miscdevice.h>
56 #include <linux/smp_lock.h>
57 #include <linux/seq_file.h>
59 # include <liblustre.h>
62 #include <linux/obd_support.h>
63 #include <linux/obd_class.h>
64 #include <linux/lustre_debug.h>
65 #include <linux/lprocfs_status.h>
67 #include <linux/lustre_build_version.h>
68 #include <linux/lustre_version.h>
70 #include <libcfs/list.h>
71 #include "llog_internal.h"
74 /* liblustre workaround */
75 atomic_t portal_kmemory = {0};
78 struct obd_device obd_dev[MAX_OBD_DEVICES];
79 struct list_head obd_types;
80 spinlock_t obd_dev_lock;
88 /* The following are visible and mutable through /proc/sys/lustre/. */
89 unsigned int obd_fail_loc;
90 unsigned int obd_dump_on_timeout;
91 unsigned int obd_timeout = 100; /* seconds */
92 unsigned int ldlm_timeout = 6; /* seconds */
93 char obd_lustre_upcall[128] = "DEFAULT"; /* or NONE or /full/path/to/upcall */
94 unsigned int obd_sync_filter; /* = 0, don't sync by default */
96 DECLARE_WAIT_QUEUE_HEAD(obd_race_waitq);
99 unsigned int obd_print_fail_loc(void)
101 CWARN("obd_fail_loc = %x\n", obd_fail_loc);
105 void ll_set_rdonly(ll_sbdev_type dev)
107 CDEBUG(D_IOCTL | D_HA, "set dev %ld rdonly\n", (long)dev);
109 #ifdef HAVE_OLD_DEV_SET_RDONLY
110 dev_set_rdonly(dev, 2);
116 void ll_clear_rdonly(ll_sbdev_type dev)
118 #ifndef HAVE_CLEAR_RDONLY_ON_PUT
119 CDEBUG(D_IOCTL | D_HA, "unset dev %ld rdonly\n", (long)dev);
120 if (ll_check_rdonly(dev)) {
122 #ifdef HAVE_OLD_DEV_SET_RDONLY
125 dev_clear_rdonly(dev);
129 CDEBUG(D_IOCTL | D_HA, "(will unset dev %ld rdonly on put)\n",
134 /* opening /dev/obd */
135 static int obd_class_open(struct inode * inode, struct file * file)
143 /* closing /dev/obd */
144 static int obd_class_release(struct inode * inode, struct file * file)
153 static inline void obd_data2conn(struct lustre_handle *conn,
154 struct obd_ioctl_data *data)
156 memset(conn, 0, sizeof *conn);
157 conn->cookie = data->ioc_cookie;
160 static inline void obd_conn2data(struct obd_ioctl_data *data,
161 struct lustre_handle *conn)
163 data->ioc_cookie = conn->cookie;
166 int class_resolve_dev_name(uint32_t len, char *name)
172 CERROR("No name passed,!\n");
173 GOTO(out, rc = -EINVAL);
175 if (name[len - 1] != 0) {
176 CERROR("Name not nul terminated!\n");
177 GOTO(out, rc = -EINVAL);
180 CDEBUG(D_IOCTL, "device name %s\n", name);
181 dev = class_name2dev(name);
183 CDEBUG(D_IOCTL, "No device for name %s!\n", name);
184 GOTO(out, rc = -EINVAL);
187 CDEBUG(D_IOCTL, "device name %s, dev %d\n", name, dev);
194 int class_handle_ioctl(unsigned int cmd, unsigned long arg)
197 struct obd_ioctl_data *data;
198 struct portals_debug_ioctl_data *debug_data;
199 struct obd_device *obd = NULL;
200 int err = 0, len = 0;
203 if (current->fsuid != 0)
204 RETURN(err = -EACCES);
206 if ((cmd & 0xffffff00) == ((int)'T') << 8) /* ignore all tty ioctls */
207 RETURN(err = -ENOTTY);
209 /* only for debugging */
210 if (cmd == PTL_IOC_DEBUG_MASK) {
211 debug_data = (struct portals_debug_ioctl_data*)arg;
212 portal_subsystem_debug = debug_data->subs;
213 portal_debug = debug_data->debug;
217 CDEBUG(D_IOCTL, "cmd = %x, obd = %p\n", cmd, obd);
218 if (obd_ioctl_getdata(&buf, &len, (void *)arg)) {
219 CERROR("OBD ioctl: data error\n");
220 GOTO(out, err = -EINVAL);
222 data = (struct obd_ioctl_data *)buf;
225 case OBD_IOC_PROCESS_CFG: {
226 struct lustre_cfg *lcfg;
228 if (!data->ioc_plen1 || !data->ioc_pbuf1) {
229 CERROR("No config buffer passed!\n");
230 GOTO(out, err = -EINVAL);
233 err = lustre_cfg_sanity_check(data->ioc_pbuf1,
238 OBD_ALLOC(lcfg, data->ioc_plen1);
239 err = copy_from_user(lcfg, data->ioc_pbuf1, data->ioc_plen1);
243 err = class_process_config(lcfg);
244 OBD_FREE(lcfg, data->ioc_plen1);
248 case OBD_GET_VERSION:
249 if (!data->ioc_inlbuf1) {
250 CERROR("No buffer passed in ioctl\n");
251 GOTO(out, err = -EINVAL);
254 if (strlen(BUILD_VERSION) + 1 > data->ioc_inllen1) {
255 CERROR("ioctl buffer too small to hold version\n");
256 GOTO(out, err = -EINVAL);
259 memcpy(data->ioc_bulk, BUILD_VERSION,
260 strlen(BUILD_VERSION) + 1);
262 err = copy_to_user((void *)arg, data, len);
267 case OBD_IOC_NAME2DEV: {
268 /* Resolve a device name. This does not change the
269 * currently selected device.
273 dev = class_resolve_dev_name(data->ioc_inllen1,
277 GOTO(out, err = -EINVAL);
279 err = copy_to_user((void *)arg, data, sizeof(*data));
285 case OBD_IOC_UUID2DEV: {
286 /* Resolve a device uuid. This does not change the
287 * currently selected device.
290 struct obd_uuid uuid;
292 if (!data->ioc_inllen1 || !data->ioc_inlbuf1) {
293 CERROR("No UUID passed!\n");
294 GOTO(out, err = -EINVAL);
296 if (data->ioc_inlbuf1[data->ioc_inllen1 - 1] != 0) {
297 CERROR("UUID not NUL terminated!\n");
298 GOTO(out, err = -EINVAL);
301 CDEBUG(D_IOCTL, "device name %s\n", data->ioc_inlbuf1);
302 obd_str2uuid(&uuid, data->ioc_inlbuf1);
303 dev = class_uuid2dev(&uuid);
306 CDEBUG(D_IOCTL, "No device for UUID %s!\n",
308 GOTO(out, err = -EINVAL);
311 CDEBUG(D_IOCTL, "device name %s, dev %d\n", data->ioc_inlbuf1,
313 err = copy_to_user((void *)arg, data, sizeof(*data));
320 case OBD_IOC_CLOSE_UUID: {
323 CDEBUG(D_IOCTL, "closing all connections to uuid %s\n",
325 lustre_uuid_to_peer(data->ioc_inlbuf1, &peer_nal, &peer_nid);
331 if (data->ioc_dev >= MAX_OBD_DEVICES) {
332 CERROR("OBD ioctl: No device\n");
333 GOTO(out, err = -EINVAL);
335 obd = &obd_dev[data->ioc_dev];
336 if (!(obd && obd->obd_set_up) || obd->obd_stopping) {
337 CERROR("OBD ioctl: device not setup %d \n", data->ioc_dev);
338 GOTO(out, err = -EINVAL);
342 case OBD_IOC_NO_TRANSNO: {
343 if (!obd->obd_attached) {
344 CERROR("Device %d not attached\n", obd->obd_minor);
345 GOTO(out, err = -ENODEV);
348 "disabling committed-transno notifications on %d\n",
350 obd->obd_no_transno = 1;
355 err = obd_iocontrol(cmd, obd->obd_self_export, len, data, NULL);
359 err = copy_to_user((void *)arg, data, len);
368 obd_ioctl_freedata(buf, len);
370 } /* class_handle_ioctl */
374 #define OBD_MINOR 241
376 /* to control /dev/obd */
377 static int obd_class_ioctl(struct inode *inode, struct file *filp,
378 unsigned int cmd, unsigned long arg)
380 return class_handle_ioctl(cmd, arg);
383 /* declare character device */
384 static struct file_operations obd_psdev_fops = {
385 .owner = THIS_MODULE,
386 .ioctl = obd_class_ioctl, /* ioctl */
387 .open = obd_class_open, /* open */
388 .release = obd_class_release, /* release */
392 static struct miscdevice obd_psdev = {
395 .fops = &obd_psdev_fops,
398 void *obd_psdev = NULL;
401 EXPORT_SYMBOL(obd_dev);
402 EXPORT_SYMBOL(obdo_cachep);
403 EXPORT_SYMBOL(qunit_cachep);
404 EXPORT_SYMBOL(qunit_hash_lock);
405 EXPORT_SYMBOL(qunit_hash);
406 EXPORT_SYMBOL(obd_fail_loc);
407 EXPORT_SYMBOL(ll_set_rdonly);
408 EXPORT_SYMBOL(ll_clear_rdonly);
409 EXPORT_SYMBOL(obd_print_fail_loc);
410 EXPORT_SYMBOL(obd_race_waitq);
411 EXPORT_SYMBOL(obd_dump_on_timeout);
412 EXPORT_SYMBOL(obd_timeout);
413 EXPORT_SYMBOL(ldlm_timeout);
414 EXPORT_SYMBOL(obd_lustre_upcall);
415 EXPORT_SYMBOL(obd_sync_filter);
416 EXPORT_SYMBOL(ptlrpc_put_connection_superhack);
417 EXPORT_SYMBOL(ptlrpc_abort_inflight_superhack);
418 EXPORT_SYMBOL(proc_lustre_root);
420 EXPORT_SYMBOL(class_register_type);
421 EXPORT_SYMBOL(class_unregister_type);
422 EXPORT_SYMBOL(class_get_type);
423 EXPORT_SYMBOL(class_put_type);
424 EXPORT_SYMBOL(class_name2dev);
425 EXPORT_SYMBOL(class_name2obd);
426 EXPORT_SYMBOL(class_uuid2dev);
427 EXPORT_SYMBOL(class_uuid2obd);
428 EXPORT_SYMBOL(class_find_client_obd);
429 EXPORT_SYMBOL(class_find_client_notype);
430 EXPORT_SYMBOL(class_devices_in_group);
431 EXPORT_SYMBOL(__class_export_put);
432 EXPORT_SYMBOL(class_new_export);
433 EXPORT_SYMBOL(class_unlink_export);
434 EXPORT_SYMBOL(class_import_get);
435 EXPORT_SYMBOL(class_import_put);
436 EXPORT_SYMBOL(class_new_import);
437 EXPORT_SYMBOL(class_destroy_import);
438 EXPORT_SYMBOL(class_connect);
439 EXPORT_SYMBOL(class_conn2export);
440 EXPORT_SYMBOL(class_exp2obd);
441 EXPORT_SYMBOL(class_conn2obd);
442 EXPORT_SYMBOL(class_exp2cliimp);
443 EXPORT_SYMBOL(class_conn2cliimp);
444 EXPORT_SYMBOL(class_disconnect);
445 EXPORT_SYMBOL(class_disconnect_exports);
446 EXPORT_SYMBOL(class_disconnect_stale_exports);
447 EXPORT_SYMBOL(class_update_export_timer);
449 EXPORT_SYMBOL(oig_init);
450 EXPORT_SYMBOL(oig_release);
451 EXPORT_SYMBOL(oig_add_one);
452 EXPORT_SYMBOL(oig_wait);
453 EXPORT_SYMBOL(oig_complete_one);
455 EXPORT_SYMBOL(ping_evictor_start);
456 EXPORT_SYMBOL(ping_evictor_stop);
459 EXPORT_SYMBOL(class_uuid_unparse);
460 EXPORT_SYMBOL(lustre_uuid_to_peer);
462 EXPORT_SYMBOL(class_handle_hash);
463 EXPORT_SYMBOL(class_handle_unhash);
464 EXPORT_SYMBOL(class_handle2object);
467 EXPORT_SYMBOL(class_get_profile);
468 EXPORT_SYMBOL(class_del_profile);
469 EXPORT_SYMBOL(class_process_config);
470 EXPORT_SYMBOL(class_config_parse_llog);
471 EXPORT_SYMBOL(class_config_dump_llog);
472 EXPORT_SYMBOL(class_attach);
473 EXPORT_SYMBOL(class_setup);
474 EXPORT_SYMBOL(class_cleanup);
475 EXPORT_SYMBOL(class_detach);
478 int obd_proc_read_version(char *page, char **start, off_t off, int count,
479 int *eof, void *data)
482 return snprintf(page, count, "%s\n", BUILD_VERSION);
485 int obd_proc_read_kernel_version(char *page, char **start, off_t off, int count,
486 int *eof, void *data)
489 return snprintf(page, count, "%u\n", LUSTRE_KERNEL_VERSION);
492 int obd_proc_read_pinger(char *page, char **start, off_t off, int count,
493 int *eof, void *data)
496 return snprintf(page, count, "%s\n",
505 /* Root for /proc/fs/lustre */
506 struct proc_dir_entry *proc_lustre_root = NULL;
507 struct lprocfs_vars lprocfs_base[] = {
508 { "version", obd_proc_read_version, NULL, NULL },
509 { "kernel_version", obd_proc_read_kernel_version, NULL, NULL },
510 { "pinger", obd_proc_read_pinger, NULL, NULL },
514 static void *obd_device_list_seq_start(struct seq_file *p, loff_t*pos)
516 if (*pos >= MAX_OBD_DEVICES)
518 return &obd_dev[*pos];
521 static void obd_device_list_seq_stop(struct seq_file *p, void *v)
525 static void *obd_device_list_seq_next(struct seq_file *p, void *v, loff_t *pos)
528 if (*pos >= MAX_OBD_DEVICES)
530 return &obd_dev[*pos];
533 static int obd_device_list_seq_show(struct seq_file *p, void *v)
535 struct obd_device *obd = (struct obd_device *)v;
536 int index = obd - &obd_dev[0];
541 if (obd->obd_stopping)
543 else if (obd->obd_set_up)
545 else if (obd->obd_attached)
550 return seq_printf(p, "%3d %s %s %s %s %d\n",
551 (int)index, status, obd->obd_type->typ_name,
552 obd->obd_name, obd->obd_uuid.uuid,
553 atomic_read(&obd->obd_refcount));
556 struct seq_operations obd_device_list_sops = {
557 .start = obd_device_list_seq_start,
558 .stop = obd_device_list_seq_stop,
559 .next = obd_device_list_seq_next,
560 .show = obd_device_list_seq_show,
563 static int obd_device_list_open(struct inode *inode, struct file *file)
565 struct proc_dir_entry *dp = PDE(inode);
566 struct seq_file *seq;
567 int rc = seq_open(file, &obd_device_list_sops);
572 seq = file->private_data;
573 seq->private = dp->data;
578 struct file_operations obd_device_list_fops = {
579 .owner = THIS_MODULE,
580 .open = obd_device_list_open,
583 .release = seq_release,
587 #define OBD_INIT_CHECK
588 #ifdef OBD_INIT_CHECK
589 int obd_init_checks(void)
591 __u64 u64val, div64val;
595 CDEBUG(D_INFO, "LPU64=%s, LPD64=%s, LPX64=%s, LPSZ=%s, LPSSZ=%s\n",
596 LPU64, LPD64, LPX64, LPSZ, LPSSZ);
598 CDEBUG(D_INFO, "OBD_OBJECT_EOF = "LPX64"\n", OBD_OBJECT_EOF);
600 u64val = OBD_OBJECT_EOF;
601 CDEBUG(D_INFO, "u64val OBD_OBJECT_EOF = "LPX64"\n", u64val);
602 if (u64val != OBD_OBJECT_EOF) {
603 CERROR("__u64 "LPX64"(%d) != 0xffffffffffffffff\n",
604 u64val, sizeof(u64val));
607 len = snprintf(buf, sizeof(buf), LPX64, u64val);
609 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf, len);
613 div64val = OBD_OBJECT_EOF;
614 CDEBUG(D_INFO, "u64val OBD_OBJECT_EOF = "LPX64"\n", u64val);
615 if (u64val != OBD_OBJECT_EOF) {
616 CERROR("__u64 "LPX64"(%d) != 0xffffffffffffffff\n",
617 u64val, sizeof(u64val));
620 if (u64val >> 8 != OBD_OBJECT_EOF >> 8) {
621 CERROR("__u64 "LPX64"(%d) != 0xffffffffffffffff\n",
622 u64val, sizeof(u64val));
625 if (do_div(div64val, 256) != (u64val & 255)) {
626 CERROR("do_div("LPX64",256) != "LPU64"\n", u64val, u64val &255);
629 if (u64val >> 8 != div64val) {
630 CERROR("do_div("LPX64",256) "LPU64" != "LPU64"\n",
631 u64val, div64val, u64val >> 8);
634 len = snprintf(buf, sizeof(buf), LPX64, u64val);
636 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf, len);
639 len = snprintf(buf, sizeof(buf), LPU64, u64val);
641 CWARN("LPU64 wrong length! strlen(%s)=%d != 20\n", buf, len);
644 len = snprintf(buf, sizeof(buf), LPD64, u64val);
646 CWARN("LPD64 wrong length! strlen(%s)=%d != 2\n", buf, len);
649 if ((u64val & ~PAGE_MASK) >= PAGE_SIZE) {
650 CWARN("mask failed: u64val "LPU64" >= %lu\n", u64val,PAGE_SIZE);
657 #define obd_init_checks() do {} while(0)
661 static int __init init_obdclass(void)
663 int init_obdclass(void)
666 struct obd_device *obd;
668 struct proc_dir_entry *entry;
673 printk(KERN_INFO "Lustre: OBD class driver Build Version: "
674 BUILD_VERSION", info@clusterfs.com\n");
676 err = obd_init_checks();
677 if (err == -EOVERFLOW)
680 class_init_uuidlist();
681 err = class_handle_init();
685 spin_lock_init(&obd_dev_lock);
686 INIT_LIST_HEAD(&obd_types);
688 err = misc_register(&obd_psdev);
690 CERROR("cannot register %d err %d\n", OBD_MINOR, err);
694 /* This struct is already zerod for us (static global) */
695 for (i = 0, obd = obd_dev; i < MAX_OBD_DEVICES; i++, obd++)
698 err = obd_init_caches();
707 proc_lustre_root = proc_mkdir("lustre", proc_root_fs);
708 if (!proc_lustre_root) {
710 "LustreError: error registering /proc/fs/lustre\n");
713 proc_version = lprocfs_add_vars(proc_lustre_root, lprocfs_base, NULL);
714 entry = create_proc_entry("devices", 0444, proc_lustre_root);
716 printk(KERN_ERR "LustreError: error registering "
717 "/proc/fs/lustre/devices\n");
718 lprocfs_remove(proc_lustre_root);
721 entry->proc_fops = &obd_device_list_fops;
726 /* liblustre doesn't call cleanup_obdclass, apparently. we carry on in this
727 * ifdef to the end of the file to cover module and versioning goo.*/
730 static void cleanup_obdclass(void)
736 misc_deregister(&obd_psdev);
737 for (i = 0; i < MAX_OBD_DEVICES; i++) {
738 struct obd_device *obd = &obd_dev[i];
739 if (obd->obd_type && obd->obd_set_up &&
740 OBT(obd) && OBP(obd, detach)) {
741 /* XXX should this call generic detach otherwise? */
742 OBP(obd, detach)(obd);
746 obd_cleanup_caches();
749 if (proc_lustre_root) {
750 lprocfs_remove(proc_lustre_root);
751 proc_lustre_root = NULL;
755 class_handle_cleanup();
756 class_exit_uuidlist();
758 leaked = atomic_read(&obd_memory);
759 CDEBUG(leaked ? D_ERROR : D_INFO,
760 "obd mem max: %d leaked: %d\n", obd_memmax, leaked);
765 /* Check that we're building against the appropriate version of the Lustre
767 #include <linux/lustre_version.h>
768 #define LUSTRE_MIN_VERSION 32
769 #define LUSTRE_MAX_VERSION 45
770 #if (LUSTRE_KERNEL_VERSION < LUSTRE_MIN_VERSION)
771 # error Cannot continue: Your Lustre kernel patch is older than the sources
772 #elif (LUSTRE_KERNEL_VERSION > LUSTRE_MAX_VERSION)
773 # error Cannot continue: Your Lustre sources are older than the kernel patch
776 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
777 MODULE_DESCRIPTION("Lustre Class Driver Build Version: " BUILD_VERSION);
778 MODULE_LICENSE("GPL");
780 module_init(init_obdclass);
781 module_exit(cleanup_obdclass);