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>
37 # include <asm/atomic.h>
40 #include <obd_support.h>
41 #include <obd_class.h>
42 #include <lustre_debug.h>
43 #include <lprocfs_status.h>
44 #include <lustre/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;
58 __u64 obd_max_pages = 0;
59 __u64 obd_max_alloc = 0;
64 /* The following are visible and mutable through /proc/sys/lustre/. */
65 unsigned int obd_debug_peer_on_timeout;
66 unsigned int obd_dump_on_timeout;
67 unsigned int obd_dump_on_eviction;
68 unsigned int obd_timeout = OBD_TIMEOUT_DEFAULT; /* seconds */
69 unsigned int ldlm_timeout = LDLM_TIMEOUT_DEFAULT; /* seconds */
70 unsigned int obd_health_check_timeout = HEALTH_CHECK_TIMEOUT_DEFAULT; /* seconds */
71 unsigned int obd_max_dirty_pages = 256;
72 atomic_t obd_dirty_pages;
74 cfs_waitq_t obd_race_waitq;
78 unsigned long obd_print_fail_loc(void)
80 CWARN("obd_fail_loc = %lx\n", obd_fail_loc);
84 void obd_set_fail_loc(unsigned int fl)
89 /* opening /dev/obd */
90 static int obd_class_open(unsigned long flags, void *args)
98 /* closing /dev/obd */
99 static int obd_class_release(unsigned long flags, void *args)
108 static inline void obd_data2conn(struct lustre_handle *conn,
109 struct obd_ioctl_data *data)
111 memset(conn, 0, sizeof *conn);
112 conn->cookie = data->ioc_cookie;
115 static inline void obd_conn2data(struct obd_ioctl_data *data,
116 struct lustre_handle *conn)
118 data->ioc_cookie = conn->cookie;
121 int class_resolve_dev_name(__u32 len, const char *name)
128 CERROR("No name passed,!\n");
129 GOTO(out, rc = -EINVAL);
131 if (name[len - 1] != 0) {
132 CERROR("Name not nul terminated!\n");
133 GOTO(out, rc = -EINVAL);
136 CDEBUG(D_IOCTL, "device name %s\n", name);
137 dev = class_name2dev(name);
139 CDEBUG(D_IOCTL, "No device for name %s!\n", name);
140 GOTO(out, rc = -EINVAL);
143 CDEBUG(D_IOCTL, "device name %s, dev %d\n", name, dev);
150 int class_handle_ioctl(unsigned int cmd, unsigned long arg)
153 struct obd_ioctl_data *data;
154 struct libcfs_debug_ioctl_data *debug_data;
155 struct obd_device *obd = NULL;
156 int err = 0, len = 0;
159 /* only for debugging */
160 if (cmd == LIBCFS_IOC_DEBUG_MASK) {
161 debug_data = (struct libcfs_debug_ioctl_data*)arg;
162 libcfs_subsystem_debug = debug_data->subs;
163 libcfs_debug = debug_data->debug;
167 CDEBUG(D_IOCTL, "cmd = %x\n", cmd);
168 if (obd_ioctl_getdata(&buf, &len, (void *)arg)) {
169 CERROR("OBD ioctl: data error\n");
170 GOTO(out, err = -EINVAL);
172 data = (struct obd_ioctl_data *)buf;
175 case OBD_IOC_PROCESS_CFG: {
176 struct lustre_cfg *lcfg;
178 if (!data->ioc_plen1 || !data->ioc_pbuf1) {
179 CERROR("No config buffer passed!\n");
180 GOTO(out, err = -EINVAL);
182 OBD_ALLOC(lcfg, data->ioc_plen1);
184 GOTO(out, err = -ENOMEM);
185 err = copy_from_user(lcfg, data->ioc_pbuf1, data->ioc_plen1);
187 err = lustre_cfg_sanity_check(lcfg, data->ioc_plen1);
189 err = class_process_config(lcfg);
191 OBD_FREE(lcfg, data->ioc_plen1);
195 case OBD_GET_VERSION:
196 if (!data->ioc_inlbuf1) {
197 CERROR("No buffer passed in ioctl\n");
198 GOTO(out, err = -EINVAL);
201 if (strlen(BUILD_VERSION) + 1 > data->ioc_inllen1) {
202 CERROR("ioctl buffer too small to hold version\n");
203 GOTO(out, err = -EINVAL);
206 memcpy(data->ioc_bulk, BUILD_VERSION,
207 strlen(BUILD_VERSION) + 1);
209 err = obd_ioctl_popdata((void *)arg, data, len);
214 case OBD_IOC_NAME2DEV: {
215 /* Resolve a device name. This does not change the
216 * currently selected device.
220 dev = class_resolve_dev_name(data->ioc_inllen1,
224 GOTO(out, err = -EINVAL);
226 err = obd_ioctl_popdata((void *)arg, data, sizeof(*data));
232 case OBD_IOC_UUID2DEV: {
233 /* Resolve a device uuid. This does not change the
234 * currently selected device.
237 struct obd_uuid uuid;
239 if (!data->ioc_inllen1 || !data->ioc_inlbuf1) {
240 CERROR("No UUID passed!\n");
241 GOTO(out, err = -EINVAL);
243 if (data->ioc_inlbuf1[data->ioc_inllen1 - 1] != 0) {
244 CERROR("UUID not NUL terminated!\n");
245 GOTO(out, err = -EINVAL);
248 CDEBUG(D_IOCTL, "device name %s\n", data->ioc_inlbuf1);
249 obd_str2uuid(&uuid, data->ioc_inlbuf1);
250 dev = class_uuid2dev(&uuid);
253 CDEBUG(D_IOCTL, "No device for UUID %s!\n",
255 GOTO(out, err = -EINVAL);
258 CDEBUG(D_IOCTL, "device name %s, dev %d\n", data->ioc_inlbuf1,
260 err = obd_ioctl_popdata((void *)arg, data, sizeof(*data));
266 case OBD_IOC_CLOSE_UUID: {
267 CDEBUG(D_IOCTL, "closing all connections to uuid %s (NOOP)\n",
272 case OBD_IOC_GETDEVICE: {
273 int index = data->ioc_count;
276 if (!data->ioc_inlbuf1) {
277 CERROR("No buffer passed in ioctl\n");
278 GOTO(out, err = -EINVAL);
280 if (data->ioc_inllen1 < 128) {
281 CERROR("ioctl buffer too small to hold version\n");
282 GOTO(out, err = -EINVAL);
285 obd = class_num2obd(index);
287 GOTO(out, err = -ENOENT);
289 if (obd->obd_stopping)
291 else if (obd->obd_set_up)
293 else if (obd->obd_attached)
297 str = (char *)data->ioc_bulk;
298 snprintf(str, len - sizeof(*data), "%3d %s %s %s %s %d",
299 (int)index, status, obd->obd_type->typ_name,
300 obd->obd_name, obd->obd_uuid.uuid,
301 atomic_read(&obd->obd_refcount));
302 err = obd_ioctl_popdata((void *)arg, data, len);
309 if (data->ioc_dev >= class_devno_max()) {
310 CERROR("OBD ioctl: No device\n");
311 GOTO(out, err = -EINVAL);
314 obd = class_num2obd(data->ioc_dev);
316 CERROR("OBD ioctl : No Device %d\n", data->ioc_dev);
317 GOTO(out, err = -EINVAL);
319 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
321 if (!obd->obd_set_up || obd->obd_stopping) {
322 CERROR("OBD ioctl: device not setup %d \n", data->ioc_dev);
323 GOTO(out, err = -EINVAL);
327 case OBD_IOC_NO_TRANSNO: {
328 if (!obd->obd_attached) {
329 CERROR("Device %d not attached\n", obd->obd_minor);
330 GOTO(out, err = -ENODEV);
332 CDEBUG(D_HA, "%s: disabling committed-transno notification\n",
334 obd->obd_no_transno = 1;
339 err = obd_iocontrol(cmd, obd->obd_self_export, len, data, NULL);
343 err = obd_ioctl_popdata((void *)arg, data, len);
352 obd_ioctl_freedata(buf, len);
354 } /* class_handle_ioctl */
358 #define OBD_MINOR 241
360 /* to control /dev/obd */
361 static int obd_class_ioctl (struct cfs_psdev_file *pfile, unsigned long cmd,
364 return class_handle_ioctl(cmd, (unsigned long)arg);
367 /* declare character device */
368 struct cfs_psdev_ops obd_psdev_ops = {
369 /* .p_open = */ obd_class_open, /* open */
370 /* .p_close = */ obd_class_release, /* release */
371 /* .p_read = */ NULL,
372 /* .p_write = */ NULL,
373 /* .p_ioctl = */ obd_class_ioctl /* ioctl */
376 extern cfs_psdev_t obd_psdev;
378 void *obd_psdev = NULL;
381 EXPORT_SYMBOL(obd_devs);
382 EXPORT_SYMBOL(obd_print_fail_loc);
383 EXPORT_SYMBOL(obd_race_waitq);
384 EXPORT_SYMBOL(obd_race_state);
385 EXPORT_SYMBOL(obd_debug_peer_on_timeout);
386 EXPORT_SYMBOL(obd_dump_on_timeout);
387 EXPORT_SYMBOL(obd_dump_on_eviction);
388 EXPORT_SYMBOL(obd_timeout);
389 EXPORT_SYMBOL(ldlm_timeout);
390 EXPORT_SYMBOL(obd_health_check_timeout);
391 EXPORT_SYMBOL(obd_max_dirty_pages);
392 EXPORT_SYMBOL(obd_dirty_pages);
393 EXPORT_SYMBOL(ptlrpc_put_connection_superhack);
395 EXPORT_SYMBOL(proc_lustre_root);
397 EXPORT_SYMBOL(class_register_type);
398 EXPORT_SYMBOL(class_unregister_type);
399 EXPORT_SYMBOL(class_get_type);
400 EXPORT_SYMBOL(class_put_type);
401 EXPORT_SYMBOL(class_name2dev);
402 EXPORT_SYMBOL(class_name2obd);
403 EXPORT_SYMBOL(class_uuid2dev);
404 EXPORT_SYMBOL(class_uuid2obd);
405 EXPORT_SYMBOL(class_find_client_obd);
406 EXPORT_SYMBOL(class_find_client_notype);
407 EXPORT_SYMBOL(class_devices_in_group);
408 EXPORT_SYMBOL(class_conn2export);
409 EXPORT_SYMBOL(class_exp2obd);
410 EXPORT_SYMBOL(class_conn2obd);
411 EXPORT_SYMBOL(class_exp2cliimp);
412 EXPORT_SYMBOL(class_conn2cliimp);
413 EXPORT_SYMBOL(class_disconnect);
414 EXPORT_SYMBOL(class_num2obd);
417 EXPORT_SYMBOL(class_uuid_unparse);
418 EXPORT_SYMBOL(lustre_uuid_to_peer);
420 EXPORT_SYMBOL(class_handle_hash);
421 EXPORT_SYMBOL(class_handle_unhash);
422 EXPORT_SYMBOL(class_handle_hash_back);
423 EXPORT_SYMBOL(class_handle2object);
424 EXPORT_SYMBOL(class_handle_free_cb);
427 EXPORT_SYMBOL(class_incref);
428 EXPORT_SYMBOL(class_decref);
429 EXPORT_SYMBOL(class_get_profile);
430 EXPORT_SYMBOL(class_del_profile);
431 EXPORT_SYMBOL(class_del_profiles);
432 EXPORT_SYMBOL(class_process_config);
433 EXPORT_SYMBOL(class_process_proc_param);
434 EXPORT_SYMBOL(class_config_parse_llog);
435 EXPORT_SYMBOL(class_config_dump_llog);
436 EXPORT_SYMBOL(class_attach);
437 EXPORT_SYMBOL(class_setup);
438 EXPORT_SYMBOL(class_cleanup);
439 EXPORT_SYMBOL(class_detach);
440 EXPORT_SYMBOL(class_manual_cleanup);
443 EXPORT_SYMBOL(mea_name2idx);
444 EXPORT_SYMBOL(raw_name2idx);
446 #define OBD_INIT_CHECK
447 #ifdef OBD_INIT_CHECK
448 int obd_init_checks(void)
450 __u64 u64val, div64val;
454 CDEBUG(D_INFO, "LPU64=%s, LPD64=%s, LPX64=%s, LPSZ=%s, LPSSZ=%s\n",
455 LPU64, LPD64, LPX64, LPSZ, LPSSZ);
457 CDEBUG(D_INFO, "OBD_OBJECT_EOF = "LPX64"\n", (__u64)OBD_OBJECT_EOF);
459 u64val = OBD_OBJECT_EOF;
460 CDEBUG(D_INFO, "u64val OBD_OBJECT_EOF = "LPX64"\n", u64val);
461 if (u64val != OBD_OBJECT_EOF) {
462 CERROR("__u64 "LPX64"(%d) != 0xffffffffffffffff\n",
463 u64val, (int)sizeof(u64val));
466 len = snprintf(buf, sizeof(buf), LPX64, u64val);
468 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf, len);
472 div64val = OBD_OBJECT_EOF;
473 CDEBUG(D_INFO, "u64val OBD_OBJECT_EOF = "LPX64"\n", u64val);
474 if (u64val != OBD_OBJECT_EOF) {
475 CERROR("__u64 "LPX64"(%d) != 0xffffffffffffffff\n",
476 u64val, (int)sizeof(u64val));
479 if (u64val >> 8 != OBD_OBJECT_EOF >> 8) {
480 CERROR("__u64 "LPX64"(%d) != 0xffffffffffffffff\n",
481 u64val, (int)sizeof(u64val));
484 if (do_div(div64val, 256) != (u64val & 255)) {
485 CERROR("do_div("LPX64",256) != "LPU64"\n", u64val, u64val &255);
488 if (u64val >> 8 != div64val) {
489 CERROR("do_div("LPX64",256) "LPU64" != "LPU64"\n",
490 u64val, div64val, u64val >> 8);
493 len = snprintf(buf, sizeof(buf), LPX64, u64val);
495 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf, len);
498 len = snprintf(buf, sizeof(buf), LPU64, u64val);
500 CWARN("LPU64 wrong length! strlen(%s)=%d != 20\n", buf, len);
503 len = snprintf(buf, sizeof(buf), LPD64, u64val);
505 CWARN("LPD64 wrong length! strlen(%s)=%d != 2\n", buf, len);
508 if ((u64val & ~CFS_PAGE_MASK) >= CFS_PAGE_SIZE) {
509 CWARN("mask failed: u64val "LPU64" >= "LPU64"\n", u64val,
510 (__u64)CFS_PAGE_SIZE);
517 #define obd_init_checks() do {} while(0)
520 extern spinlock_t obd_types_lock;
521 extern int class_procfs_init(void);
522 extern int class_procfs_clean(void);
525 static int __init init_obdclass(void)
527 int init_obdclass(void)
532 int lustre_register_fs(void);
534 printk(KERN_INFO "Lustre: OBD class driver, info@clusterfs.com\n");
535 printk(KERN_INFO " Lustre Version: "LUSTRE_VERSION_STRING"\n");
536 printk(KERN_INFO " Build Version: "BUILD_VERSION"\n");
538 for (i = CAPA_SITE_CLIENT; i < CAPA_SITE_MAX; i++)
539 CFS_INIT_LIST_HEAD(&capa_list[i]);
541 CDEBUG(D_INFO, "Lustre: OBD class driver, info@clusterfs.com\n");
542 CDEBUG(D_INFO, " Lustre Version: "LUSTRE_VERSION_STRING"\n");
543 CDEBUG(D_INFO, " Build Version: "BUILD_VERSION"\n");
546 spin_lock_init(&obd_types_lock);
547 cfs_waitq_init(&obd_race_waitq);
548 obd_zombie_impexp_init();
550 obd_memory = lprocfs_alloc_stats(OBD_STATS_NUM,
551 LPROCFS_STATS_FLAG_PERCPU);
552 if (obd_memory == NULL) {
553 CERROR("kmalloc of 'obd_memory' failed\n");
557 lprocfs_counter_init(obd_memory, OBD_MEMORY_STAT,
558 LPROCFS_CNTR_AVGMINMAX,
560 lprocfs_counter_init(obd_memory, OBD_MEMORY_PAGES_STAT,
561 LPROCFS_CNTR_AVGMINMAX,
562 "pagesused", "pages");
564 err = obd_init_checks();
565 if (err == -EOVERFLOW)
568 class_init_uuidlist();
569 err = class_handle_init();
573 spin_lock_init(&obd_dev_lock);
574 CFS_INIT_LIST_HEAD(&obd_types);
576 err = cfs_psdev_register(&obd_psdev);
578 CERROR("cannot register %d err %d\n", OBD_MINOR, err);
582 /* This struct is already zerod for us (static global) */
583 for (i = 0; i < class_devno_max(); i++)
586 /* Default the dirty page cache cap to 1/2 of system memory */
587 obd_max_dirty_pages = num_physpages / 2;
589 err = obd_init_caches();
593 err = lu_global_init();
596 err = class_procfs_init();
599 err = lustre_register_fs();
605 /* liblustre doesn't call cleanup_obdclass, apparently. we carry on in this
606 * ifdef to the end of the file to cover module and versioning goo.*/
608 static void cleanup_obdclass(void)
611 int lustre_unregister_fs(void);
612 __u64 memory_leaked, pages_leaked;
613 __u64 memory_max, pages_max;
616 lustre_unregister_fs();
618 cfs_psdev_deregister(&obd_psdev);
619 for (i = 0; i < class_devno_max(); i++) {
620 struct obd_device *obd = class_num2obd(i);
621 if (obd && obd->obd_set_up &&
622 OBT(obd) && OBP(obd, detach)) {
623 /* XXX should this call generic detach otherwise? */
624 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
625 OBP(obd, detach)(obd);
630 obd_cleanup_caches();
633 class_procfs_clean();
635 class_handle_cleanup();
636 class_exit_uuidlist();
637 obd_zombie_impexp_stop();
639 memory_leaked = obd_memory_sum();
640 pages_leaked = obd_pages_sum();
642 memory_max = obd_memory_max();
643 pages_max = obd_pages_max();
645 lprocfs_free_stats(&obd_memory);
646 if (memory_leaked > 0) {
647 CWARN("Memory leaks detected (max "LPU64", leaked "LPD64")\n",
648 memory_max, memory_leaked);
650 if (pages_leaked > 0) {
651 CWARN("Page leaks detected (max "LPU64", leaked "LPU64")\n",
652 pages_max, pages_leaked);
658 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
659 MODULE_DESCRIPTION("Lustre Class Driver Build Version: " BUILD_VERSION);
660 MODULE_LICENSE("GPL");
662 cfs_module(obdclass, LUSTRE_VERSION_STRING, init_obdclass, cleanup_obdclass);