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 the Lustre file system, http://www.lustre.org
9 * Lustre is a trademark of Cluster File Systems, Inc.
11 * You may have signed or agreed to another license before downloading
12 * this software. If so, you are bound by the terms and conditions
13 * of that agreement, and the following does not apply to you. See the
14 * LICENSE file included with this distribution for more information.
16 * If you did not agree to a different license, then this copy of Lustre
17 * is open source software; you can redistribute it and/or modify it
18 * under the terms of version 2 of the GNU General Public License as
19 * published by the Free Software Foundation.
21 * In either case, Lustre is distributed in the hope that it will be
22 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty
23 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * license text for more details.
26 * These are the only exported functions, they provide some generic
27 * infrastructure for managing object devices
30 #define DEBUG_SUBSYSTEM S_CLASS
32 # define EXPORT_SYMTAB
35 # include <liblustre.h>
38 #include <obd_support.h>
39 #include <obd_class.h>
40 #include <lustre_debug.h>
41 #include <lprocfs_status.h>
43 #include <linux/lustre_build_version.h>
45 #include <libcfs/list.h>
46 #include "llog_internal.h"
49 /* liblustre workaround */
50 atomic_t libcfs_kmemory = {0};
53 struct obd_device *obd_devs[MAX_OBD_DEVICES];
54 struct list_head obd_types;
55 spinlock_t obd_dev_lock = SPIN_LOCK_UNLOCKED;
61 /* The following are visible and mutable through /proc/sys/lustre/. */
62 unsigned int obd_fail_loc;
63 unsigned int obd_debug_peer_on_timeout;
64 unsigned int obd_dump_on_timeout;
65 unsigned int obd_dump_on_eviction;
66 unsigned int obd_timeout = 100; /* seconds */
67 unsigned int ldlm_timeout = LDLM_TIMEOUT_DEFAULT; /* seconds */
68 unsigned int obd_health_check_timeout = 120; /* seconds */
69 unsigned int obd_max_dirty_pages = 256;
70 atomic_t obd_dirty_pages;
72 cfs_waitq_t obd_race_waitq;
76 unsigned int obd_print_fail_loc(void)
78 CWARN("obd_fail_loc = %x\n", obd_fail_loc);
82 void obd_set_fail_loc(unsigned int fl)
87 /* opening /dev/obd */
88 static int obd_class_open(unsigned long flags, void *args)
96 /* closing /dev/obd */
97 static int obd_class_release(unsigned long flags, void *args)
106 static inline void obd_data2conn(struct lustre_handle *conn,
107 struct obd_ioctl_data *data)
109 memset(conn, 0, sizeof *conn);
110 conn->cookie = data->ioc_cookie;
113 static inline void obd_conn2data(struct obd_ioctl_data *data,
114 struct lustre_handle *conn)
116 data->ioc_cookie = conn->cookie;
119 int class_resolve_dev_name(uint32_t len, const char *name)
126 CERROR("No name passed,!\n");
127 GOTO(out, rc = -EINVAL);
129 if (name[len - 1] != 0) {
130 CERROR("Name not nul terminated!\n");
131 GOTO(out, rc = -EINVAL);
134 CDEBUG(D_IOCTL, "device name %s\n", name);
135 dev = class_name2dev(name);
137 CDEBUG(D_IOCTL, "No device for name %s!\n", name);
138 GOTO(out, rc = -EINVAL);
141 CDEBUG(D_IOCTL, "device name %s, dev %d\n", name, dev);
148 int class_handle_ioctl(unsigned int cmd, unsigned long arg)
151 struct obd_ioctl_data *data;
152 struct libcfs_debug_ioctl_data *debug_data;
153 struct obd_device *obd = NULL;
154 int err = 0, len = 0;
157 /* only for debugging */
158 if (cmd == LIBCFS_IOC_DEBUG_MASK) {
159 debug_data = (struct libcfs_debug_ioctl_data*)arg;
160 libcfs_subsystem_debug = debug_data->subs;
161 libcfs_debug = debug_data->debug;
165 CDEBUG(D_IOCTL, "cmd = %x\n", cmd);
166 if (obd_ioctl_getdata(&buf, &len, (void *)arg)) {
167 CERROR("OBD ioctl: data error\n");
168 GOTO(out, err = -EINVAL);
170 data = (struct obd_ioctl_data *)buf;
173 case OBD_IOC_PROCESS_CFG: {
174 struct lustre_cfg *lcfg;
176 if (!data->ioc_plen1 || !data->ioc_pbuf1) {
177 CERROR("No config buffer passed!\n");
178 GOTO(out, err = -EINVAL);
180 OBD_ALLOC(lcfg, data->ioc_plen1);
182 GOTO(out, err = -ENOMEM);
183 err = copy_from_user(lcfg, data->ioc_pbuf1, data->ioc_plen1);
185 err = lustre_cfg_sanity_check(lcfg, data->ioc_plen1);
187 err = class_process_config(lcfg);
188 OBD_FREE(lcfg, data->ioc_plen1);
192 case OBD_GET_VERSION:
193 if (!data->ioc_inlbuf1) {
194 CERROR("No buffer passed in ioctl\n");
195 GOTO(out, err = -EINVAL);
198 if (strlen(BUILD_VERSION) + 1 > data->ioc_inllen1) {
199 CERROR("ioctl buffer too small to hold version\n");
200 GOTO(out, err = -EINVAL);
203 memcpy(data->ioc_bulk, BUILD_VERSION,
204 strlen(BUILD_VERSION) + 1);
206 err = obd_ioctl_popdata((void *)arg, data, len);
211 case OBD_IOC_NAME2DEV: {
212 /* Resolve a device name. This does not change the
213 * currently selected device.
217 dev = class_resolve_dev_name(data->ioc_inllen1,
221 GOTO(out, err = -EINVAL);
223 err = obd_ioctl_popdata((void *)arg, data, sizeof(*data));
229 case OBD_IOC_UUID2DEV: {
230 /* Resolve a device uuid. This does not change the
231 * currently selected device.
234 struct obd_uuid uuid;
236 if (!data->ioc_inllen1 || !data->ioc_inlbuf1) {
237 CERROR("No UUID passed!\n");
238 GOTO(out, err = -EINVAL);
240 if (data->ioc_inlbuf1[data->ioc_inllen1 - 1] != 0) {
241 CERROR("UUID not NUL terminated!\n");
242 GOTO(out, err = -EINVAL);
245 CDEBUG(D_IOCTL, "device name %s\n", data->ioc_inlbuf1);
246 obd_str2uuid(&uuid, data->ioc_inlbuf1);
247 dev = class_uuid2dev(&uuid);
250 CDEBUG(D_IOCTL, "No device for UUID %s!\n",
252 GOTO(out, err = -EINVAL);
255 CDEBUG(D_IOCTL, "device name %s, dev %d\n", data->ioc_inlbuf1,
257 err = obd_ioctl_popdata((void *)arg, data, sizeof(*data));
263 case OBD_IOC_CLOSE_UUID: {
264 CDEBUG(D_IOCTL, "closing all connections to uuid %s (NOOP)\n",
269 case OBD_IOC_GETDEVICE: {
270 int index = data->ioc_count;
273 if (!data->ioc_inlbuf1) {
274 CERROR("No buffer passed in ioctl\n");
275 GOTO(out, err = -EINVAL);
277 if (data->ioc_inllen1 < 128) {
278 CERROR("ioctl buffer too small to hold version\n");
279 GOTO(out, err = -EINVAL);
282 obd = class_num2obd(index);
284 GOTO(out, err = -ENOENT);
286 if (obd->obd_stopping)
288 else if (obd->obd_set_up)
290 else if (obd->obd_attached)
294 str = (char *)data->ioc_bulk;
295 snprintf(str, len - sizeof(*data), "%3d %s %s %s %s %d",
296 (int)index, status, obd->obd_type->typ_name,
297 obd->obd_name, obd->obd_uuid.uuid,
298 atomic_read(&obd->obd_refcount));
299 err = obd_ioctl_popdata((void *)arg, data, len);
306 if (data->ioc_dev >= class_devno_max()) {
307 CERROR("OBD ioctl: No device\n");
308 GOTO(out, err = -EINVAL);
311 obd = class_num2obd(data->ioc_dev);
313 CERROR("OBD ioctl : No Device %d\n", data->ioc_dev);
314 GOTO(out, err = -EINVAL);
316 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
318 if (!obd->obd_set_up || obd->obd_stopping) {
319 CERROR("OBD ioctl: device not setup %d \n", data->ioc_dev);
320 GOTO(out, err = -EINVAL);
324 case OBD_IOC_NO_TRANSNO: {
325 if (!obd->obd_attached) {
326 CERROR("Device %d not attached\n", obd->obd_minor);
327 GOTO(out, err = -ENODEV);
329 CDEBUG(D_HA, "%s: disabling committed-transno notification\n",
331 obd->obd_no_transno = 1;
336 err = obd_iocontrol(cmd, obd->obd_self_export, len, data, NULL);
340 err = obd_ioctl_popdata((void *)arg, data, len);
349 obd_ioctl_freedata(buf, len);
351 } /* class_handle_ioctl */
355 #define OBD_MINOR 241
357 /* to control /dev/obd */
358 static int obd_class_ioctl (struct cfs_psdev_file *pfile, unsigned long cmd,
361 return class_handle_ioctl(cmd, (unsigned long)arg);
364 /* declare character device */
365 struct cfs_psdev_ops obd_psdev_ops = {
366 /* .p_open = */ obd_class_open, /* open */
367 /* .p_close = */ obd_class_release, /* release */
368 /* .p_read = */ NULL,
369 /* .p_write = */ NULL,
370 /* .p_ioctl = */ obd_class_ioctl /* ioctl */
373 extern cfs_psdev_t obd_psdev;
375 void *obd_psdev = NULL;
378 EXPORT_SYMBOL(obd_devs);
379 EXPORT_SYMBOL(obd_fail_loc);
380 EXPORT_SYMBOL(obd_print_fail_loc);
381 EXPORT_SYMBOL(obd_race_waitq);
382 EXPORT_SYMBOL(obd_race_state);
383 EXPORT_SYMBOL(obd_debug_peer_on_timeout);
384 EXPORT_SYMBOL(obd_dump_on_timeout);
385 EXPORT_SYMBOL(obd_dump_on_eviction);
386 EXPORT_SYMBOL(obd_timeout);
387 EXPORT_SYMBOL(ldlm_timeout);
388 EXPORT_SYMBOL(obd_health_check_timeout);
389 EXPORT_SYMBOL(obd_max_dirty_pages);
390 EXPORT_SYMBOL(obd_dirty_pages);
391 EXPORT_SYMBOL(ptlrpc_put_connection_superhack);
393 EXPORT_SYMBOL(proc_lustre_root);
395 EXPORT_SYMBOL(class_register_type);
396 EXPORT_SYMBOL(class_unregister_type);
397 EXPORT_SYMBOL(class_get_type);
398 EXPORT_SYMBOL(class_put_type);
399 EXPORT_SYMBOL(class_name2dev);
400 EXPORT_SYMBOL(class_name2obd);
401 EXPORT_SYMBOL(class_uuid2dev);
402 EXPORT_SYMBOL(class_uuid2obd);
403 EXPORT_SYMBOL(class_find_client_obd);
404 EXPORT_SYMBOL(class_find_client_notype);
405 EXPORT_SYMBOL(class_devices_in_group);
406 EXPORT_SYMBOL(class_conn2export);
407 EXPORT_SYMBOL(class_exp2obd);
408 EXPORT_SYMBOL(class_conn2obd);
409 EXPORT_SYMBOL(class_exp2cliimp);
410 EXPORT_SYMBOL(class_conn2cliimp);
411 EXPORT_SYMBOL(class_disconnect);
412 EXPORT_SYMBOL(class_num2obd);
415 EXPORT_SYMBOL(class_generate_random_uuid);
416 EXPORT_SYMBOL(class_uuid_unparse);
417 EXPORT_SYMBOL(lustre_uuid_to_peer);
419 EXPORT_SYMBOL(class_handle_hash);
420 EXPORT_SYMBOL(class_handle_unhash);
421 EXPORT_SYMBOL(class_handle2object);
424 EXPORT_SYMBOL(class_incref);
425 EXPORT_SYMBOL(class_decref);
426 EXPORT_SYMBOL(class_get_profile);
427 EXPORT_SYMBOL(class_del_profile);
428 EXPORT_SYMBOL(class_del_profiles);
429 EXPORT_SYMBOL(class_process_config);
430 EXPORT_SYMBOL(class_process_proc_param);
431 EXPORT_SYMBOL(class_config_parse_llog);
432 EXPORT_SYMBOL(class_config_dump_llog);
433 EXPORT_SYMBOL(class_attach);
434 EXPORT_SYMBOL(class_setup);
435 EXPORT_SYMBOL(class_cleanup);
436 EXPORT_SYMBOL(class_detach);
437 EXPORT_SYMBOL(class_manual_cleanup);
439 #define OBD_INIT_CHECK
440 #ifdef OBD_INIT_CHECK
441 int obd_init_checks(void)
443 __u64 u64val, div64val;
447 CDEBUG(D_INFO, "LPU64=%s, LPD64=%s, LPX64=%s, LPSZ=%s, LPSSZ=%s\n",
448 LPU64, LPD64, LPX64, LPSZ, LPSSZ);
450 CDEBUG(D_INFO, "OBD_OBJECT_EOF = "LPX64"\n", (__u64)OBD_OBJECT_EOF);
452 u64val = OBD_OBJECT_EOF;
453 CDEBUG(D_INFO, "u64val OBD_OBJECT_EOF = "LPX64"\n", u64val);
454 if (u64val != OBD_OBJECT_EOF) {
455 CERROR("__u64 "LPX64"(%d) != 0xffffffffffffffff\n",
456 u64val, (int)sizeof(u64val));
459 len = snprintf(buf, sizeof(buf), LPX64, u64val);
461 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf, len);
465 div64val = OBD_OBJECT_EOF;
466 CDEBUG(D_INFO, "u64val OBD_OBJECT_EOF = "LPX64"\n", u64val);
467 if (u64val != OBD_OBJECT_EOF) {
468 CERROR("__u64 "LPX64"(%d) != 0xffffffffffffffff\n",
469 u64val, (int)sizeof(u64val));
472 if (u64val >> 8 != OBD_OBJECT_EOF >> 8) {
473 CERROR("__u64 "LPX64"(%d) != 0xffffffffffffffff\n",
474 u64val, (int)sizeof(u64val));
477 if (do_div(div64val, 256) != (u64val & 255)) {
478 CERROR("do_div("LPX64",256) != "LPU64"\n", u64val, u64val &255);
481 if (u64val >> 8 != div64val) {
482 CERROR("do_div("LPX64",256) "LPU64" != "LPU64"\n",
483 u64val, div64val, u64val >> 8);
486 len = snprintf(buf, sizeof(buf), LPX64, u64val);
488 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf, len);
491 len = snprintf(buf, sizeof(buf), LPU64, u64val);
493 CWARN("LPU64 wrong length! strlen(%s)=%d != 20\n", buf, len);
496 len = snprintf(buf, sizeof(buf), LPD64, u64val);
498 CWARN("LPD64 wrong length! strlen(%s)=%d != 2\n", buf, len);
501 if ((u64val & ~CFS_PAGE_MASK) >= CFS_PAGE_SIZE) {
502 CWARN("mask failed: u64val "LPU64" >= %lu\n", u64val,
510 #define obd_init_checks() do {} while(0)
513 extern spinlock_t obd_types_lock;
514 extern spinlock_t handle_lock;
515 extern int class_procfs_init(void);
516 extern int class_procfs_clean(void);
519 static int __init init_obdclass(void)
521 int init_obdclass(void)
526 int lustre_register_fs(void);
528 printk(KERN_INFO "Lustre: OBD class driver, info@clusterfs.com\n");
529 printk(KERN_INFO " Lustre Version: "LUSTRE_VERSION_STRING"\n");
530 printk(KERN_INFO " Build Version: "BUILD_VERSION"\n");
532 CDEBUG(D_INFO, "Lustre: OBD class driver, info@clusterfs.com\n");
533 CDEBUG(D_INFO, " Lustre Version: "LUSTRE_VERSION_STRING"\n");
534 CDEBUG(D_INFO, " Build Version: "BUILD_VERSION"\n");
537 spin_lock_init(&obd_types_lock);
538 spin_lock_init(&handle_lock);
539 cfs_waitq_init(&obd_race_waitq);
540 obd_zombie_impexp_init();
542 err = obd_init_checks();
543 if (err == -EOVERFLOW)
546 class_init_uuidlist();
547 err = class_handle_init();
551 spin_lock_init(&obd_dev_lock);
552 INIT_LIST_HEAD(&obd_types);
554 err = cfs_psdev_register(&obd_psdev);
556 CERROR("cannot register %d err %d\n", OBD_MINOR, err);
560 /* This struct is already zerod for us (static global) */
561 for (i = 0; i < class_devno_max(); i++)
564 /* Default the dirty page cache cap to 1/2 of system memory */
565 obd_max_dirty_pages = num_physpages / 2;
567 err = obd_init_caches();
571 err = class_procfs_init();
574 err = lustre_register_fs();
580 /* liblustre doesn't call cleanup_obdclass, apparently. we carry on in this
581 * ifdef to the end of the file to cover module and versioning goo.*/
583 static void cleanup_obdclass(void)
586 int lustre_unregister_fs(void);
589 lustre_unregister_fs();
591 cfs_psdev_deregister(&obd_psdev);
592 for (i = 0; i < class_devno_max(); i++) {
593 struct obd_device *obd = class_num2obd(i);
594 if (obd && obd->obd_set_up &&
595 OBT(obd) && OBP(obd, detach)) {
596 /* XXX should this call generic detach otherwise? */
597 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
598 OBP(obd, detach)(obd);
602 obd_cleanup_caches();
605 class_procfs_clean();
607 class_handle_cleanup();
608 class_exit_uuidlist();
612 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
613 MODULE_DESCRIPTION("Lustre Class Driver Build Version: " BUILD_VERSION);
614 MODULE_LICENSE("GPL");
616 cfs_module(obdclass, LUSTRE_VERSION_STRING, init_obdclass, cleanup_obdclass);