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>
73 /* liblustre workaround */
74 atomic_t portal_kmemory = {0};
77 struct obd_device obd_dev[MAX_OBD_DEVICES];
78 struct list_head obd_types;
79 spinlock_t obd_dev_lock;
87 /* The following are visible and mutable through /proc/sys/lustre/. */
88 unsigned int obd_fail_loc;
89 unsigned int obd_dump_on_timeout;
90 unsigned int obd_timeout = 100;
91 unsigned int ldlm_timeout = 6;
92 char obd_lustre_upcall[128] = "DEFAULT"; /* or NONE or /full/path/to/upcall */
93 unsigned int obd_sync_filter = 1; /* = 1, sync by default */
95 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 /* opening /dev/obd */
106 static int obd_class_open(struct inode * inode, struct file * file)
114 /* closing /dev/obd */
115 static int obd_class_release(struct inode * inode, struct file * file)
124 static inline void obd_data2conn(struct lustre_handle *conn,
125 struct obd_ioctl_data *data)
127 memset(conn, 0, sizeof *conn);
128 conn->cookie = data->ioc_cookie;
131 static inline void obd_conn2data(struct obd_ioctl_data *data,
132 struct lustre_handle *conn)
134 data->ioc_cookie = conn->cookie;
137 int class_resolve_dev_name(uint32_t len, char *name)
143 CERROR("No name passed,!\n");
144 GOTO(out, rc = -EINVAL);
146 if (name[len - 1] != 0) {
147 CERROR("Name not nul terminated!\n");
148 GOTO(out, rc = -EINVAL);
151 CDEBUG(D_IOCTL, "device name %s\n", name);
152 dev = class_name2dev(name);
154 CDEBUG(D_IOCTL, "No device for name %s!\n", name);
155 GOTO(out, rc = -EINVAL);
158 CDEBUG(D_IOCTL, "device name %s, dev %d\n", name, dev);
165 int class_handle_ioctl(unsigned int cmd, unsigned long arg)
168 struct obd_ioctl_data *data;
169 struct portals_debug_ioctl_data *debug_data;
170 struct obd_device *obd = NULL;
171 int err = 0, len = 0;
174 if (current->fsuid != 0)
175 RETURN(err = -EACCES);
177 if ((cmd & 0xffffff00) == ((int)'T') << 8) /* ignore all tty ioctls */
178 RETURN(err = -ENOTTY);
180 /* only for debugging */
181 if (cmd == PTL_IOC_DEBUG_MASK) {
182 debug_data = (struct portals_debug_ioctl_data*)arg;
183 portal_subsystem_debug = debug_data->subs;
184 portal_debug = debug_data->debug;
188 CDEBUG(D_IOCTL, "cmd = %x, obd = %p\n", cmd, obd);
189 if (obd_ioctl_getdata(&buf, &len, (void *)arg)) {
190 CERROR("OBD ioctl: data error\n");
191 GOTO(out, err = -EINVAL);
193 data = (struct obd_ioctl_data *)buf;
196 case OBD_IOC_PROCESS_CFG: {
197 struct lustre_cfg *lcfg;
199 if (!data->ioc_plen1 || !data->ioc_pbuf1) {
200 CERROR("No config buffer passed!\n");
201 GOTO(out, err = -EINVAL);
204 err = lustre_cfg_sanity_check(data->ioc_pbuf1,
209 OBD_ALLOC(lcfg, data->ioc_plen1);
210 err = copy_from_user(lcfg, data->ioc_pbuf1, data->ioc_plen1);
212 err = class_process_config(lcfg);
213 OBD_FREE(lcfg, data->ioc_plen1);
217 case OBD_GET_VERSION:
218 if (!data->ioc_inlbuf1) {
219 CERROR("No buffer passed in ioctl\n");
220 GOTO(out, err = -EINVAL);
223 if (strlen(BUILD_VERSION) + 1 > data->ioc_inllen1) {
224 CERROR("ioctl buffer too small to hold version\n");
225 GOTO(out, err = -EINVAL);
228 memcpy(data->ioc_bulk, BUILD_VERSION,
229 strlen(BUILD_VERSION) + 1);
231 err = copy_to_user((void *)arg, data, len);
236 case OBD_IOC_NAME2DEV: {
237 /* Resolve a device name. This does not change the
238 * currently selected device.
242 dev = class_resolve_dev_name(data->ioc_inllen1,
246 GOTO(out, err = -EINVAL);
248 err = copy_to_user((void *)arg, data, sizeof(*data));
254 case OBD_IOC_UUID2DEV: {
255 /* Resolve a device uuid. This does not change the
256 * currently selected device.
259 struct obd_uuid uuid;
261 if (!data->ioc_inllen1 || !data->ioc_inlbuf1) {
262 CERROR("No UUID passed!\n");
263 GOTO(out, err = -EINVAL);
265 if (data->ioc_inlbuf1[data->ioc_inllen1 - 1] != 0) {
266 CERROR("UUID not NUL terminated!\n");
267 GOTO(out, err = -EINVAL);
270 CDEBUG(D_IOCTL, "device name %s\n", data->ioc_inlbuf1);
271 obd_str2uuid(&uuid, data->ioc_inlbuf1);
272 dev = class_uuid2dev(&uuid);
275 CDEBUG(D_IOCTL, "No device for UUID %s!\n",
277 GOTO(out, err = -EINVAL);
280 CDEBUG(D_IOCTL, "device name %s, dev %d\n", data->ioc_inlbuf1,
282 err = copy_to_user((void *)arg, data, sizeof(*data));
289 case OBD_IOC_CLOSE_UUID: {
292 CDEBUG(D_IOCTL, "closing all connections to uuid %s\n",
294 lustre_uuid_to_peer(data->ioc_inlbuf1, &peer_nal, &peer_nid);
300 if (data->ioc_dev >= MAX_OBD_DEVICES) {
301 CERROR("OBD ioctl: No device\n");
302 GOTO(out, err = -EINVAL);
304 obd = &obd_dev[data->ioc_dev];
305 if (!(obd && obd->obd_set_up) || obd->obd_stopping) {
306 CERROR("OBD ioctl: device not setup %d \n", data->ioc_dev);
307 GOTO(out, err = -EINVAL);
311 case OBD_IOC_NO_TRANSNO: {
312 if (!obd->obd_attached) {
313 CERROR("Device %d not attached\n", obd->obd_minor);
314 GOTO(out, err = -ENODEV);
317 "disabling committed-transno notifications on %d\n",
319 obd->obd_no_transno = 1;
324 err = obd_iocontrol(cmd, obd->obd_self_export, len, data, NULL);
328 err = copy_to_user((void *)arg, data, len);
337 obd_ioctl_freedata(buf, len);
339 } /* class_handle_ioctl */
343 #define OBD_MINOR 241
345 /* to control /dev/obd */
346 static int obd_class_ioctl(struct inode *inode, struct file *filp,
347 unsigned int cmd, unsigned long arg)
349 return class_handle_ioctl(cmd, arg);
352 /* declare character device */
353 static struct file_operations obd_psdev_fops = {
354 .owner = THIS_MODULE,
355 .ioctl = obd_class_ioctl, /* ioctl */
356 .open = obd_class_open, /* open */
357 .release = obd_class_release, /* release */
361 static struct miscdevice obd_psdev = {
364 .fops = &obd_psdev_fops,
367 void *obd_psdev = NULL;
370 EXPORT_SYMBOL(obd_dev);
371 EXPORT_SYMBOL(obdo_cachep);
372 EXPORT_SYMBOL(obd_fail_loc);
373 EXPORT_SYMBOL(obd_print_fail_loc);
374 EXPORT_SYMBOL(obd_race_waitq);
375 EXPORT_SYMBOL(obd_dump_on_timeout);
376 EXPORT_SYMBOL(ldlm_timeout);
377 EXPORT_SYMBOL(obd_timeout);
378 EXPORT_SYMBOL(obd_lustre_upcall);
379 EXPORT_SYMBOL(obd_sync_filter);
380 EXPORT_SYMBOL(ptlrpc_put_connection_superhack);
381 EXPORT_SYMBOL(ptlrpc_abort_inflight_superhack);
382 EXPORT_SYMBOL(proc_lustre_root);
384 EXPORT_SYMBOL(class_register_type);
385 EXPORT_SYMBOL(class_unregister_type);
386 EXPORT_SYMBOL(class_get_type);
387 EXPORT_SYMBOL(class_put_type);
388 EXPORT_SYMBOL(class_name2dev);
389 EXPORT_SYMBOL(class_name2obd);
390 EXPORT_SYMBOL(class_uuid2dev);
391 EXPORT_SYMBOL(class_uuid2obd);
392 EXPORT_SYMBOL(class_find_client_obd);
393 EXPORT_SYMBOL(class_devices_in_group);
394 EXPORT_SYMBOL(__class_export_put);
395 EXPORT_SYMBOL(class_new_export);
396 EXPORT_SYMBOL(class_unlink_export);
397 EXPORT_SYMBOL(class_import_get);
398 EXPORT_SYMBOL(class_import_put);
399 EXPORT_SYMBOL(class_new_import);
400 EXPORT_SYMBOL(class_destroy_import);
401 EXPORT_SYMBOL(class_connect);
402 EXPORT_SYMBOL(class_conn2export);
403 EXPORT_SYMBOL(class_exp2obd);
404 EXPORT_SYMBOL(class_conn2obd);
405 EXPORT_SYMBOL(class_exp2cliimp);
406 EXPORT_SYMBOL(class_conn2cliimp);
407 EXPORT_SYMBOL(class_disconnect);
408 EXPORT_SYMBOL(class_disconnect_exports);
409 EXPORT_SYMBOL(class_disconnect_stale_exports);
411 EXPORT_SYMBOL(oig_init);
412 EXPORT_SYMBOL(oig_release);
413 EXPORT_SYMBOL(oig_add_one);
414 EXPORT_SYMBOL(oig_wait);
415 EXPORT_SYMBOL(oig_complete_one);
418 EXPORT_SYMBOL(class_uuid_unparse);
419 EXPORT_SYMBOL(lustre_uuid_to_peer);
421 EXPORT_SYMBOL(class_handle_hash);
422 EXPORT_SYMBOL(class_handle_unhash);
423 EXPORT_SYMBOL(class_handle2object);
426 EXPORT_SYMBOL(class_get_profile);
427 EXPORT_SYMBOL(class_del_profile);
428 EXPORT_SYMBOL(class_process_config);
429 EXPORT_SYMBOL(class_config_process_llog);
430 EXPORT_SYMBOL(class_config_dump_llog);
433 EXPORT_SYMBOL(mea_name2idx);
434 EXPORT_SYMBOL(raw_name2idx);
437 int obd_proc_read_version(char *page, char **start, off_t off, int count,
438 int *eof, void *data)
441 return snprintf(page, count, "%s\n", BUILD_VERSION);
444 int obd_proc_read_kernel_version(char *page, char **start, off_t off, int count,
445 int *eof, void *data)
448 return snprintf(page, count, "%u\n", LUSTRE_KERNEL_VERSION);
451 int obd_proc_read_pinger(char *page, char **start, off_t off, int count,
452 int *eof, void *data)
455 return snprintf(page, count, "%s\n",
465 /* FIXME move these staff to proper place */
466 int (*lustre_secinit_downcall_handler)(const char *buffer,
468 EXPORT_SYMBOL(lustre_secinit_downcall_handler);
470 int obd_proc_write_secinit(struct file *file, const char *buffer,
471 unsigned long count, void *data)
475 if (lustre_secinit_downcall_handler) {
476 rc = (*lustre_secinit_downcall_handler)((char *)buffer, count);
486 /* Root for /proc/fs/lustre */
487 struct proc_dir_entry *proc_lustre_root = NULL;
488 struct lprocfs_vars lprocfs_base[] = {
489 { "version", obd_proc_read_version, NULL, NULL },
490 { "kernel_version", obd_proc_read_kernel_version, NULL, NULL },
491 { "pinger", obd_proc_read_pinger, NULL, NULL },
493 { "secinit", NULL, obd_proc_write_secinit, NULL },
498 static void *obd_device_list_seq_start(struct seq_file *p, loff_t*pos)
500 if (*pos >= MAX_OBD_DEVICES)
502 return &obd_dev[*pos];
505 static void obd_device_list_seq_stop(struct seq_file *p, void *v)
509 static void *obd_device_list_seq_next(struct seq_file *p, void *v, loff_t *pos)
512 if (*pos >= MAX_OBD_DEVICES)
514 return &obd_dev[*pos];
517 static int obd_device_list_seq_show(struct seq_file *p, void *v)
519 struct obd_device *obd = (struct obd_device *)v;
520 int index = obd - &obd_dev[0];
525 if (obd->obd_stopping)
527 else if (obd->obd_set_up)
529 else if (obd->obd_attached)
534 return seq_printf(p, "%3d %s %s %s %s %d\n",
535 (int)index, status, obd->obd_type->typ_name,
536 obd->obd_name, obd->obd_uuid.uuid,
537 atomic_read(&obd->obd_refcount));
540 struct seq_operations obd_device_list_sops = {
541 .start = obd_device_list_seq_start,
542 .stop = obd_device_list_seq_stop,
543 .next = obd_device_list_seq_next,
544 .show = obd_device_list_seq_show,
547 static int obd_device_list_open(struct inode *inode, struct file *file)
549 struct proc_dir_entry *dp = PDE(inode);
550 struct seq_file *seq;
551 int rc = seq_open(file, &obd_device_list_sops);
556 seq = file->private_data;
557 seq->private = dp->data;
562 struct file_operations obd_device_list_fops = {
563 .owner = THIS_MODULE,
564 .open = obd_device_list_open,
567 .release = seq_release,
571 extern int capa_cache_init(void);
572 extern void capa_cache_cleanup(void);
575 static int __init init_obdclass(void)
577 int init_obdclass(void)
580 struct obd_device *obd;
582 struct proc_dir_entry *entry;
587 printk(KERN_INFO "Lustre: OBD class driver Build Version: "
588 BUILD_VERSION", info@clusterfs.com\n");
590 class_init_uuidlist();
591 err = class_handle_init();
595 spin_lock_init(&obd_dev_lock);
596 INIT_LIST_HEAD(&obd_types);
598 err = misc_register(&obd_psdev);
600 CERROR("cannot register %d err %d\n", OBD_MINOR, err);
604 /* This struct is already zerod for us (static global) */
605 for (i = 0, obd = obd_dev; i < MAX_OBD_DEVICES; i++, obd++)
608 err = obd_init_caches();
612 err = capa_cache_init();
621 proc_lustre_root = proc_mkdir("lustre", proc_root_fs);
622 if (!proc_lustre_root) {
624 "LustreError: error registering /proc/fs/lustre\n");
627 proc_version = lprocfs_add_vars(proc_lustre_root, lprocfs_base, NULL);
628 entry = create_proc_entry("devices", 0444, proc_lustre_root);
630 printk(KERN_ERR "LustreError: error registering "
631 "/proc/fs/lustre/devices\n");
632 lprocfs_remove(proc_lustre_root);
635 entry->proc_fops = &obd_device_list_fops;
640 /* liblustre doesn't call cleanup_obdclass, apparently. we carry on in this
641 * ifdef to the end of the file to cover module and versioning goo.*/
644 static void cleanup_obdclass(void)
649 misc_deregister(&obd_psdev);
650 for (i = 0; i < MAX_OBD_DEVICES; i++) {
651 struct obd_device *obd = &obd_dev[i];
652 if (obd->obd_type && obd->obd_set_up &&
653 OBT(obd) && OBP(obd, detach)) {
654 /* XXX should this call generic detach otherwise? */
655 OBP(obd, detach)(obd);
659 capa_cache_cleanup();
660 obd_cleanup_caches();
663 if (proc_lustre_root) {
664 lprocfs_remove(proc_lustre_root);
665 proc_lustre_root = NULL;
669 class_handle_cleanup();
670 class_exit_uuidlist();
674 /* Check that we're building against the appropriate version of the Lustre
676 #include <linux/lustre_version.h>
677 #define LUSTRE_MIN_VERSION 500
678 #define LUSTRE_MAX_VERSION 500
679 #if (LUSTRE_KERNEL_VERSION < LUSTRE_MIN_VERSION)
680 # error Cannot continue: Your Lustre kernel patch is older than the sources
681 #elif (LUSTRE_KERNEL_VERSION > LUSTRE_MAX_VERSION)
682 # error Cannot continue: Your Lustre sources are older than the kernel patch
685 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
686 MODULE_DESCRIPTION("Lustre Class Driver Build Version: " BUILD_VERSION);
687 MODULE_LICENSE("GPL");
689 module_init(init_obdclass);
690 module_exit(cleanup_obdclass);