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>
69 #include <portals/list.h>
72 /* liblustre workaround */
73 atomic_t portal_kmemory = {0};
76 struct semaphore obd_conf_sem; /* serialize configuration commands */
77 struct obd_device obd_dev[MAX_OBD_DEVICES];
78 struct list_head obd_types;
86 /* The following are visible and mutable through /proc/sys/lustre/. */
87 unsigned int obd_fail_loc;
88 unsigned int obd_timeout = 100;
89 char obd_lustre_upcall[128] = "DEFAULT"; /* or NONE or /full/path/to/upcall */
90 unsigned int obd_sync_filter; /* = 0, don't sync by default */
92 DECLARE_WAIT_QUEUE_HEAD(obd_race_waitq);
95 /* opening /dev/obd */
96 static int obd_class_open(struct inode * inode, struct file * file)
104 /* closing /dev/obd */
105 static int obd_class_release(struct inode * inode, struct file * file)
114 static inline void obd_data2conn(struct lustre_handle *conn,
115 struct obd_ioctl_data *data)
117 memset(conn, 0, sizeof *conn);
118 conn->cookie = data->ioc_cookie;
121 static inline void obd_conn2data(struct obd_ioctl_data *data,
122 struct lustre_handle *conn)
124 data->ioc_cookie = conn->cookie;
127 int class_resolve_dev_name(uint32_t len, char *name)
133 CERROR("No name passed,!\n");
134 GOTO(out, rc = -EINVAL);
136 if (name[len - 1] != 0) {
137 CERROR("Name not nul terminated!\n");
138 GOTO(out, rc = -EINVAL);
141 CDEBUG(D_IOCTL, "device name %s\n", name);
142 dev = class_name2dev(name);
144 CDEBUG(D_IOCTL, "No device for name %s!\n", name);
145 GOTO(out, rc = -EINVAL);
148 CDEBUG(D_IOCTL, "device name %s, dev %d\n", name, dev);
155 int class_handle_ioctl(unsigned int cmd, unsigned long arg)
158 struct obd_ioctl_data *data;
159 struct portals_debug_ioctl_data *debug_data;
160 struct obd_device *obd = NULL;
161 int err = 0, len = 0, serialised = 0;
164 if (current->fsuid != 0)
165 RETURN(err = -EACCES);
167 if ((cmd & 0xffffff00) == ((int)'T') << 8) /* ignore all tty ioctls */
168 RETURN(err = -ENOTTY);
170 /* only for debugging */
171 if (cmd == PTL_IOC_DEBUG_MASK) {
172 debug_data = (struct portals_debug_ioctl_data*)arg;
173 portal_subsystem_debug = debug_data->subs;
174 portal_debug = debug_data->debug;
179 case OBD_IOC_BRW_WRITE:
180 case OBD_IOC_BRW_READ:
181 case OBD_IOC_GETATTR:
182 case ECHO_IOC_ENQUEUE:
183 case ECHO_IOC_CANCEL:
184 case OBD_IOC_CLIENT_RECOVER:
185 case OBD_IOC_CATLOGLIST:
186 case OBD_IOC_LLOG_INFO:
187 case OBD_IOC_LLOG_PRINT:
188 case OBD_IOC_LLOG_CANCEL:
189 case OBD_IOC_LLOG_CHECK:
190 case OBD_IOC_LLOG_REMOVE:
198 CDEBUG(D_IOCTL, "cmd = %x, obd = %p\n", cmd, obd);
199 if (obd_ioctl_getdata(&buf, &len, (void *)arg)) {
200 CERROR("OBD ioctl: data error\n");
201 GOTO(out, err = -EINVAL);
203 data = (struct obd_ioctl_data *)buf;
206 case OBD_IOC_PROCESS_CFG: {
208 struct lustre_cfg *lcfg;
210 if (!data->ioc_plen1 || !data->ioc_pbuf1) {
211 CERROR("No config buffer passed!\n");
212 GOTO(out, err = -EINVAL);
214 err = lustre_cfg_getdata(&buf, data->ioc_plen1,
218 lcfg = (struct lustre_cfg* ) buf;
220 err = class_process_config(lcfg);
221 lustre_cfg_freedata(buf, data->ioc_plen1);
225 case OBD_GET_VERSION:
226 if (!data->ioc_inlbuf1) {
227 CERROR("No buffer passed in ioctl\n");
228 GOTO(out, err = -EINVAL);
231 if (strlen(BUILD_VERSION) + 1 > data->ioc_inllen1) {
232 CERROR("ioctl buffer too small to hold version\n");
233 GOTO(out, err = -EINVAL);
236 memcpy(data->ioc_bulk, BUILD_VERSION,
237 strlen(BUILD_VERSION) + 1);
239 err = copy_to_user((void *)arg, data, len);
244 case OBD_IOC_NAME2DEV: {
245 /* Resolve a device name. This does not change the
246 * currently selected device.
250 dev = class_resolve_dev_name(data->ioc_inllen1,
254 GOTO(out, err = -EINVAL);
256 err = copy_to_user((void *)arg, data, sizeof(*data));
262 case OBD_IOC_UUID2DEV: {
263 /* Resolve a device uuid. This does not change the
264 * currently selected device.
267 struct obd_uuid uuid;
269 if (!data->ioc_inllen1 || !data->ioc_inlbuf1) {
270 CERROR("No UUID passed!\n");
271 GOTO(out, err = -EINVAL);
273 if (data->ioc_inlbuf1[data->ioc_inllen1 - 1] != 0) {
274 CERROR("UUID not NUL terminated!\n");
275 GOTO(out, err = -EINVAL);
278 CDEBUG(D_IOCTL, "device name %s\n", data->ioc_inlbuf1);
279 obd_str2uuid(&uuid, data->ioc_inlbuf1);
280 dev = class_uuid2dev(&uuid);
283 CDEBUG(D_IOCTL, "No device for UUID %s!\n",
285 GOTO(out, err = -EINVAL);
288 CDEBUG(D_IOCTL, "device name %s, dev %d\n", data->ioc_inlbuf1,
290 err = copy_to_user((void *)arg, data, sizeof(*data));
297 case OBD_IOC_CLOSE_UUID: {
300 CDEBUG(D_IOCTL, "closing all connections to uuid %s\n",
302 lustre_uuid_to_peer(data->ioc_inlbuf1, &peer_nal, &peer_nid);
308 if (data->ioc_dev >= MAX_OBD_DEVICES) {
309 CERROR("OBD ioctl: No device\n");
310 GOTO(out, err = -EINVAL);
312 obd = &obd_dev[data->ioc_dev];
313 if (!(obd && obd->obd_set_up) || obd->obd_stopping) {
314 CERROR("OBD ioctl: device not setup %d \n", data->ioc_dev);
315 GOTO(out, err = -EINVAL);
319 case OBD_IOC_NO_TRANSNO: {
320 if (!obd->obd_attached) {
321 CERROR("Device %d not attached\n", obd->obd_minor);
322 GOTO(out, err = -ENODEV);
325 "disabling committed-transno notifications on %d\n",
327 obd->obd_no_transno = 1;
332 err = obd_iocontrol(cmd, obd->obd_self_export, len, data, NULL);
336 err = copy_to_user((void *)arg, data, len);
345 obd_ioctl_freedata(buf, len);
349 } /* class_handle_ioctl */
353 #define OBD_MINOR 241
355 /* to control /dev/obd */
356 static int obd_class_ioctl(struct inode *inode, struct file *filp,
357 unsigned int cmd, unsigned long arg)
359 return class_handle_ioctl(cmd, arg);
362 /* declare character device */
363 static struct file_operations obd_psdev_fops = {
364 .owner = THIS_MODULE,
365 .ioctl = obd_class_ioctl, /* ioctl */
366 .open = obd_class_open, /* open */
367 .release = obd_class_release, /* release */
371 static struct miscdevice obd_psdev = {
374 .fops = &obd_psdev_fops,
377 void *obd_psdev = NULL;
380 EXPORT_SYMBOL(obd_dev);
381 EXPORT_SYMBOL(obdo_cachep);
382 EXPORT_SYMBOL(obd_fail_loc);
383 EXPORT_SYMBOL(obd_race_waitq);
384 EXPORT_SYMBOL(obd_timeout);
385 EXPORT_SYMBOL(obd_lustre_upcall);
386 EXPORT_SYMBOL(obd_sync_filter);
387 EXPORT_SYMBOL(ptlrpc_put_connection_superhack);
388 EXPORT_SYMBOL(ptlrpc_abort_inflight_superhack);
389 EXPORT_SYMBOL(proc_lustre_root);
391 EXPORT_SYMBOL(class_register_type);
392 EXPORT_SYMBOL(class_unregister_type);
393 EXPORT_SYMBOL(class_get_type);
394 EXPORT_SYMBOL(class_put_type);
395 EXPORT_SYMBOL(class_name2dev);
396 EXPORT_SYMBOL(class_name2obd);
397 EXPORT_SYMBOL(class_uuid2dev);
398 EXPORT_SYMBOL(class_uuid2obd);
399 EXPORT_SYMBOL(class_find_client_obd);
400 EXPORT_SYMBOL(class_devices_in_group);
401 EXPORT_SYMBOL(__class_export_put);
402 EXPORT_SYMBOL(class_new_export);
403 EXPORT_SYMBOL(class_unlink_export);
404 EXPORT_SYMBOL(class_import_get);
405 EXPORT_SYMBOL(class_import_put);
406 EXPORT_SYMBOL(class_new_import);
407 EXPORT_SYMBOL(class_destroy_import);
408 EXPORT_SYMBOL(class_connect);
409 EXPORT_SYMBOL(class_conn2export);
410 EXPORT_SYMBOL(class_exp2obd);
411 EXPORT_SYMBOL(class_conn2obd);
412 EXPORT_SYMBOL(class_exp2cliimp);
413 EXPORT_SYMBOL(class_conn2cliimp);
414 EXPORT_SYMBOL(class_disconnect);
415 EXPORT_SYMBOL(class_disconnect_exports);
417 EXPORT_SYMBOL(oig_init);
418 EXPORT_SYMBOL(oig_release);
419 EXPORT_SYMBOL(oig_add_one);
420 EXPORT_SYMBOL(oig_wait);
421 EXPORT_SYMBOL(oig_complete_one);
424 EXPORT_SYMBOL(class_uuid_unparse);
425 EXPORT_SYMBOL(lustre_uuid_to_peer);
427 EXPORT_SYMBOL(class_handle_hash);
428 EXPORT_SYMBOL(class_handle_unhash);
429 EXPORT_SYMBOL(class_handle2object);
432 EXPORT_SYMBOL(class_get_profile);
433 EXPORT_SYMBOL(class_del_profile);
434 EXPORT_SYMBOL(class_process_config);
435 EXPORT_SYMBOL(class_config_parse_llog);
436 EXPORT_SYMBOL(class_config_dump_llog);
437 EXPORT_SYMBOL(class_attach);
438 EXPORT_SYMBOL(class_setup);
439 EXPORT_SYMBOL(class_cleanup);
440 EXPORT_SYMBOL(class_detach);
443 int obd_proc_read_version(char *page, char **start, off_t off, int count,
444 int *eof, void *data)
447 return snprintf(page, count, "%s\n", BUILD_VERSION);
450 int obd_proc_read_pinger(char *page, char **start, off_t off, int count,
451 int *eof, void *data)
454 return snprintf(page, count, "%s\n",
463 /* Root for /proc/fs/lustre */
464 struct proc_dir_entry *proc_lustre_root = NULL;
465 struct lprocfs_vars lprocfs_base[] = {
466 { "version", obd_proc_read_version, NULL, NULL },
467 { "pinger", obd_proc_read_pinger, NULL, NULL },
471 static void *obd_device_list_seq_start(struct seq_file *p, loff_t*pos)
473 if (*pos >= MAX_OBD_DEVICES)
475 return &obd_dev[*pos];
478 static void obd_device_list_seq_stop(struct seq_file *p, void *v)
482 static void *obd_device_list_seq_next(struct seq_file *p, void *v, loff_t *pos)
485 if (*pos >= MAX_OBD_DEVICES)
487 return &obd_dev[*pos];
490 static int obd_device_list_seq_show(struct seq_file *p, void *v)
492 struct obd_device *obd = (struct obd_device *)v;
493 int index = obd - &obd_dev[0];
498 if (obd->obd_stopping)
500 else if (obd->obd_set_up)
502 else if (obd->obd_attached)
507 return seq_printf(p, "%3d %s %s %s %s %d\n",
508 (int)index, status, obd->obd_type->typ_name,
509 obd->obd_name, obd->obd_uuid.uuid,
510 atomic_read(&obd->obd_refcount));
513 struct seq_operations obd_device_list_sops = {
514 .start = obd_device_list_seq_start,
515 .stop = obd_device_list_seq_stop,
516 .next = obd_device_list_seq_next,
517 .show = obd_device_list_seq_show,
520 static int obd_device_list_open(struct inode *inode, struct file *file)
522 struct proc_dir_entry *dp = PDE(inode);
523 struct seq_file *seq;
524 int rc = seq_open(file, &obd_device_list_sops);
529 seq = file->private_data;
530 seq->private = dp->data;
535 struct file_operations obd_device_list_fops = {
536 .owner = THIS_MODULE,
537 .open = obd_device_list_open,
540 .release = seq_release,
545 static int __init init_obdclass(void)
547 int init_obdclass(void)
550 struct obd_device *obd;
552 struct proc_dir_entry *entry;
557 printk(KERN_INFO "Lustre: OBD class driver Build Version: "
558 BUILD_VERSION", info@clusterfs.com\n");
560 class_init_uuidlist();
561 err = class_handle_init();
565 sema_init(&obd_conf_sem, 1);
566 INIT_LIST_HEAD(&obd_types);
568 err = misc_register(&obd_psdev);
570 CERROR("cannot register %d err %d\n", OBD_MINOR, err);
574 /* This struct is already zerod for us (static global) */
575 for (i = 0, obd = obd_dev; i < MAX_OBD_DEVICES; i++, obd++)
578 err = obd_init_caches();
587 proc_lustre_root = proc_mkdir("lustre", proc_root_fs);
588 if (!proc_lustre_root) {
590 "LustreError: error registering /proc/fs/lustre\n");
593 proc_version = lprocfs_add_vars(proc_lustre_root, lprocfs_base, NULL);
594 entry = create_proc_entry("devices", 0444, proc_lustre_root);
596 printk(KERN_ERR "LustreError: error registering "
597 "/proc/fs/lustre/devices\n");
598 lprocfs_remove(proc_lustre_root);
601 entry->proc_fops = &obd_device_list_fops;
606 /* liblustre doesn't call cleanup_obdclass, apparently. we carry on in this
607 * ifdef to the end of the file to cover module and versioning goo.*/
610 static void cleanup_obdclass(void)
616 misc_deregister(&obd_psdev);
617 for (i = 0; i < MAX_OBD_DEVICES; i++) {
618 struct obd_device *obd = &obd_dev[i];
619 if (obd->obd_type && obd->obd_set_up &&
620 OBT(obd) && OBP(obd, detach)) {
621 /* XXX should this call generic detach otherwise? */
622 OBP(obd, detach)(obd);
626 obd_cleanup_caches();
629 if (proc_lustre_root) {
630 lprocfs_remove(proc_lustre_root);
631 proc_lustre_root = NULL;
635 class_handle_cleanup();
636 class_exit_uuidlist();
638 leaked = atomic_read(&obd_memory);
639 CDEBUG(leaked ? D_ERROR : D_INFO,
640 "obd mem max: %d leaked: %d\n", obd_memmax, leaked);
645 /* Check that we're building against the appropriate version of the Lustre
647 #include <linux/lustre_version.h>
648 #define LUSTRE_MIN_VERSION 28
649 #define LUSTRE_MAX_VERSION 35
650 #if (LUSTRE_KERNEL_VERSION < LUSTRE_MIN_VERSION)
651 # error Cannot continue: Your Lustre kernel patch is older than the sources
652 #elif (LUSTRE_KERNEL_VERSION > LUSTRE_MAX_VERSION)
653 # error Cannot continue: Your Lustre sources are older than the kernel patch
656 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
657 MODULE_DESCRIPTION("Lustre Class Driver Build Version: " BUILD_VERSION);
658 MODULE_LICENSE("GPL");
660 module_init(init_obdclass);
661 module_exit(cleanup_obdclass);