1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright (c) 1999, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 #define DEBUG_SUBSYSTEM S_CLASS
39 # define EXPORT_SYMTAB
42 # include <liblustre.h>
44 # include <asm/atomic.h>
47 #include <obd_support.h>
48 #include <obd_class.h>
49 #include <lnet/lnetctl.h>
50 #include <lustre_debug.h>
51 #include <lprocfs_status.h>
52 #include <lustre/lustre_build_version.h>
53 #include <libcfs/list.h>
54 #include "llog_internal.h"
57 /* liblustre workaround */
58 cfs_atomic_t libcfs_kmemory = {0};
61 struct obd_device *obd_devs[MAX_OBD_DEVICES];
63 cfs_spinlock_t obd_dev_lock = CFS_SPIN_LOCK_UNLOCKED;
66 __u64 obd_max_pages = 0;
67 __u64 obd_max_alloc = 0;
72 /* The following are visible and mutable through /proc/sys/lustre/. */
73 unsigned int obd_debug_peer_on_timeout;
74 unsigned int obd_dump_on_timeout;
75 unsigned int obd_dump_on_eviction;
76 unsigned int obd_max_dirty_pages = 256;
77 unsigned int obd_timeout = OBD_TIMEOUT_DEFAULT; /* seconds */
78 unsigned int ldlm_timeout = LDLM_TIMEOUT_DEFAULT; /* seconds */
79 /* Adaptive timeout defs here instead of ptlrpc module for /proc/sys/ access */
80 unsigned int at_min = 0;
81 unsigned int at_max = 600;
82 unsigned int at_history = 600;
83 int at_early_margin = 5;
86 cfs_atomic_t obd_dirty_pages;
87 cfs_atomic_t obd_dirty_transit_pages;
89 static inline void obd_data2conn(struct lustre_handle *conn,
90 struct obd_ioctl_data *data)
92 memset(conn, 0, sizeof *conn);
93 conn->cookie = data->ioc_cookie;
96 static inline void obd_conn2data(struct obd_ioctl_data *data,
97 struct lustre_handle *conn)
99 data->ioc_cookie = conn->cookie;
102 int class_resolve_dev_name(__u32 len, const char *name)
109 CERROR("No name passed,!\n");
110 GOTO(out, rc = -EINVAL);
112 if (name[len - 1] != 0) {
113 CERROR("Name not nul terminated!\n");
114 GOTO(out, rc = -EINVAL);
117 CDEBUG(D_IOCTL, "device name %s\n", name);
118 dev = class_name2dev(name);
120 CDEBUG(D_IOCTL, "No device for name %s!\n", name);
121 GOTO(out, rc = -EINVAL);
124 CDEBUG(D_IOCTL, "device name %s, dev %d\n", name, dev);
131 int class_handle_ioctl(unsigned int cmd, unsigned long arg)
134 struct obd_ioctl_data *data;
135 struct libcfs_debug_ioctl_data *debug_data;
136 struct obd_device *obd = NULL;
137 int err = 0, len = 0;
140 /* only for debugging */
141 if (cmd == LIBCFS_IOC_DEBUG_MASK) {
142 debug_data = (struct libcfs_debug_ioctl_data*)arg;
143 libcfs_subsystem_debug = debug_data->subs;
144 libcfs_debug = debug_data->debug;
148 CDEBUG(D_IOCTL, "cmd = %x\n", cmd);
149 if (obd_ioctl_getdata(&buf, &len, (void *)arg)) {
150 CERROR("OBD ioctl: data error\n");
153 data = (struct obd_ioctl_data *)buf;
156 case OBD_IOC_PROCESS_CFG: {
157 struct lustre_cfg *lcfg;
159 if (!data->ioc_plen1 || !data->ioc_pbuf1) {
160 CERROR("No config buffer passed!\n");
161 GOTO(out, err = -EINVAL);
163 OBD_ALLOC(lcfg, data->ioc_plen1);
165 GOTO(out, err = -ENOMEM);
166 err = cfs_copy_from_user(lcfg, data->ioc_pbuf1,
169 err = lustre_cfg_sanity_check(lcfg, data->ioc_plen1);
171 err = class_process_config(lcfg);
173 OBD_FREE(lcfg, data->ioc_plen1);
177 case OBD_GET_VERSION:
178 if (!data->ioc_inlbuf1) {
179 CERROR("No buffer passed in ioctl\n");
180 GOTO(out, err = -EINVAL);
183 if (strlen(BUILD_VERSION) + 1 > data->ioc_inllen1) {
184 CERROR("ioctl buffer too small to hold version\n");
185 GOTO(out, err = -EINVAL);
188 memcpy(data->ioc_bulk, BUILD_VERSION,
189 strlen(BUILD_VERSION) + 1);
191 err = obd_ioctl_popdata((void *)arg, data, len);
196 case OBD_IOC_NAME2DEV: {
197 /* Resolve a device name. This does not change the
198 * currently selected device.
202 dev = class_resolve_dev_name(data->ioc_inllen1,
206 GOTO(out, err = -EINVAL);
208 err = obd_ioctl_popdata((void *)arg, data, sizeof(*data));
214 case OBD_IOC_UUID2DEV: {
215 /* Resolve a device uuid. This does not change the
216 * currently selected device.
219 struct obd_uuid uuid;
221 if (!data->ioc_inllen1 || !data->ioc_inlbuf1) {
222 CERROR("No UUID passed!\n");
223 GOTO(out, err = -EINVAL);
225 if (data->ioc_inlbuf1[data->ioc_inllen1 - 1] != 0) {
226 CERROR("UUID not NUL terminated!\n");
227 GOTO(out, err = -EINVAL);
230 CDEBUG(D_IOCTL, "device name %s\n", data->ioc_inlbuf1);
231 obd_str2uuid(&uuid, data->ioc_inlbuf1);
232 dev = class_uuid2dev(&uuid);
235 CDEBUG(D_IOCTL, "No device for UUID %s!\n",
237 GOTO(out, err = -EINVAL);
240 CDEBUG(D_IOCTL, "device name %s, dev %d\n", data->ioc_inlbuf1,
242 err = obd_ioctl_popdata((void *)arg, data, sizeof(*data));
248 case OBD_IOC_CLOSE_UUID: {
249 CDEBUG(D_IOCTL, "closing all connections to uuid %s (NOOP)\n",
254 case OBD_IOC_GETDEVICE: {
255 int index = data->ioc_count;
259 if (!data->ioc_inlbuf1) {
260 CERROR("No buffer passed in ioctl\n");
261 GOTO(out, err = -EINVAL);
263 if (data->ioc_inllen1 < 128) {
264 CERROR("ioctl buffer too small to hold version\n");
265 GOTO(out, err = -EINVAL);
268 obd = class_num2obd(index);
270 GOTO(out, err = -ENOENT);
272 status = obd_dev_status(obd);
273 str = (char *)data->ioc_bulk;
274 snprintf(str, len - sizeof(*data), "%3d %s %s %s %s %d",
275 (int)index, status, obd->obd_type->typ_name,
276 obd->obd_name, obd->obd_uuid.uuid,
277 cfs_atomic_read(&obd->obd_refcount));
278 err = obd_ioctl_popdata((void *)arg, data, len);
285 if (data->ioc_dev == OBD_DEV_BY_DEVNAME) {
286 if (data->ioc_inllen4 <= 0 || data->ioc_inlbuf4 == NULL)
287 GOTO(out, err = -EINVAL);
288 if (strnlen(data->ioc_inlbuf4, MAX_OBD_NAME) >= MAX_OBD_NAME)
289 GOTO(out, err = -EINVAL);
290 obd = class_name2obd(data->ioc_inlbuf4);
291 } else if (obd_minor_valid(data->ioc_dev)) {
292 /* XXX = max allocated minor */
293 obd = class_num2obd(data->ioc_dev);
295 CERROR("OBD ioctl: No device\n");
296 GOTO(out, err = -EINVAL);
300 CERROR("OBD ioctl : No Device %d\n", data->ioc_dev);
301 GOTO(out, err = -EINVAL);
303 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
305 if (!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);
316 CDEBUG(D_HA, "%s: disabling committed-transno notification\n",
318 obd->obd_no_transno = 1;
323 err = obd_iocontrol(cmd, obd->obd_self_export, len, data, NULL);
327 err = obd_ioctl_popdata((void *)arg, data, len);
336 obd_ioctl_freedata(buf, len);
338 } /* class_handle_ioctl */
343 extern cfs_psdev_t obd_psdev;
345 void *obd_psdev = NULL;
348 EXPORT_SYMBOL(obd_devs);
349 EXPORT_SYMBOL(obd_debug_peer_on_timeout);
350 EXPORT_SYMBOL(obd_dump_on_timeout);
351 EXPORT_SYMBOL(obd_dump_on_eviction);
352 EXPORT_SYMBOL(obd_timeout);
353 EXPORT_SYMBOL(ldlm_timeout);
354 EXPORT_SYMBOL(obd_max_dirty_pages);
355 EXPORT_SYMBOL(obd_dirty_pages);
356 EXPORT_SYMBOL(obd_dirty_transit_pages);
357 EXPORT_SYMBOL(at_min);
358 EXPORT_SYMBOL(at_max);
359 EXPORT_SYMBOL(at_extra);
360 EXPORT_SYMBOL(at_early_margin);
361 EXPORT_SYMBOL(at_history);
362 EXPORT_SYMBOL(ptlrpc_put_connection_superhack);
364 EXPORT_SYMBOL(proc_lustre_root);
366 EXPORT_SYMBOL(class_register_type);
367 EXPORT_SYMBOL(class_unregister_type);
368 EXPORT_SYMBOL(class_get_type);
369 EXPORT_SYMBOL(class_put_type);
370 EXPORT_SYMBOL(class_name2obd);
371 EXPORT_SYMBOL(class_uuid2obd);
372 EXPORT_SYMBOL(class_find_client_obd);
373 EXPORT_SYMBOL(class_devices_in_group);
374 EXPORT_SYMBOL(class_conn2export);
375 EXPORT_SYMBOL(class_exp2obd);
376 EXPORT_SYMBOL(class_conn2obd);
377 EXPORT_SYMBOL(class_exp2cliimp);
378 EXPORT_SYMBOL(class_conn2cliimp);
379 EXPORT_SYMBOL(class_disconnect);
380 EXPORT_SYMBOL(class_num2obd);
383 EXPORT_SYMBOL(class_uuid_unparse);
384 EXPORT_SYMBOL(lustre_uuid_to_peer);
386 EXPORT_SYMBOL(class_handle_hash);
387 EXPORT_SYMBOL(class_handle_unhash);
388 EXPORT_SYMBOL(class_handle_hash_back);
389 EXPORT_SYMBOL(class_handle2object);
390 EXPORT_SYMBOL(class_handle_free_cb);
393 EXPORT_SYMBOL(class_incref);
394 EXPORT_SYMBOL(class_decref);
395 EXPORT_SYMBOL(class_get_profile);
396 EXPORT_SYMBOL(class_del_profile);
397 EXPORT_SYMBOL(class_del_profiles);
398 EXPORT_SYMBOL(class_process_config);
399 EXPORT_SYMBOL(class_process_proc_param);
400 EXPORT_SYMBOL(class_config_parse_llog);
401 EXPORT_SYMBOL(class_config_dump_llog);
402 EXPORT_SYMBOL(class_attach);
403 EXPORT_SYMBOL(class_setup);
404 EXPORT_SYMBOL(class_cleanup);
405 EXPORT_SYMBOL(class_detach);
406 EXPORT_SYMBOL(class_manual_cleanup);
409 EXPORT_SYMBOL(mea_name2idx);
410 EXPORT_SYMBOL(raw_name2idx);
412 #define OBD_INIT_CHECK
413 #ifdef OBD_INIT_CHECK
414 int obd_init_checks(void)
416 __u64 u64val, div64val;
420 CDEBUG(D_INFO, "LPU64=%s, LPD64=%s, LPX64=%s\n", LPU64, LPD64, LPX64);
422 CDEBUG(D_INFO, "OBD_OBJECT_EOF = "LPX64"\n", (__u64)OBD_OBJECT_EOF);
424 u64val = OBD_OBJECT_EOF;
425 CDEBUG(D_INFO, "u64val OBD_OBJECT_EOF = "LPX64"\n", u64val);
426 if (u64val != OBD_OBJECT_EOF) {
427 CERROR("__u64 "LPX64"(%d) != 0xffffffffffffffff\n",
428 u64val, (int)sizeof(u64val));
431 len = snprintf(buf, sizeof(buf), LPX64, u64val);
433 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf, len);
437 div64val = OBD_OBJECT_EOF;
438 CDEBUG(D_INFO, "u64val OBD_OBJECT_EOF = "LPX64"\n", u64val);
439 if (u64val != OBD_OBJECT_EOF) {
440 CERROR("__u64 "LPX64"(%d) != 0xffffffffffffffff\n",
441 u64val, (int)sizeof(u64val));
444 if (u64val >> 8 != OBD_OBJECT_EOF >> 8) {
445 CERROR("__u64 "LPX64"(%d) != 0xffffffffffffffff\n",
446 u64val, (int)sizeof(u64val));
449 if (do_div(div64val, 256) != (u64val & 255)) {
450 CERROR("do_div("LPX64",256) != "LPU64"\n", u64val, u64val &255);
453 if (u64val >> 8 != div64val) {
454 CERROR("do_div("LPX64",256) "LPU64" != "LPU64"\n",
455 u64val, div64val, u64val >> 8);
458 len = snprintf(buf, sizeof(buf), LPX64, u64val);
460 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf, len);
463 len = snprintf(buf, sizeof(buf), LPU64, u64val);
465 CWARN("LPU64 wrong length! strlen(%s)=%d != 20\n", buf, len);
468 len = snprintf(buf, sizeof(buf), LPD64, u64val);
470 CWARN("LPD64 wrong length! strlen(%s)=%d != 2\n", buf, len);
473 if ((u64val & ~CFS_PAGE_MASK) >= CFS_PAGE_SIZE) {
474 CWARN("mask failed: u64val "LPU64" >= "LPU64"\n", u64val,
475 (__u64)CFS_PAGE_SIZE);
482 #define obd_init_checks() do {} while(0)
485 extern cfs_spinlock_t obd_types_lock;
486 extern int class_procfs_init(void);
487 extern int class_procfs_clean(void);
490 static int __init init_obdclass(void)
492 int init_obdclass(void)
498 int lustre_register_fs(void);
500 for (i = CAPA_SITE_CLIENT; i < CAPA_SITE_MAX; i++)
501 CFS_INIT_LIST_HEAD(&capa_list[i]);
505 LCONSOLE_INFO("Lustre: Build Version: "BUILD_VERSION"\n");
507 LCONSOLE_INFO("OBD class driver, http://www.lustre.org/\n");
508 LCONSOLE_INFO(" Lustre Version: "LUSTRE_VERSION_STRING"\n");
509 LCONSOLE_INFO(" Build Version: "BUILD_VERSION"\n");
512 cfs_spin_lock_init(&obd_types_lock);
513 obd_zombie_impexp_init();
515 obd_memory = lprocfs_alloc_stats(OBD_STATS_NUM,
516 LPROCFS_STATS_FLAG_NONE);
517 if (obd_memory == NULL) {
518 CERROR("kmalloc of 'obd_memory' failed\n");
522 lprocfs_counter_init(obd_memory, OBD_MEMORY_STAT,
523 LPROCFS_CNTR_AVGMINMAX,
525 lprocfs_counter_init(obd_memory, OBD_MEMORY_PAGES_STAT,
526 LPROCFS_CNTR_AVGMINMAX,
527 "pagesused", "pages");
529 err = obd_init_checks();
530 if (err == -EOVERFLOW)
533 class_init_uuidlist();
534 err = class_handle_init();
538 cfs_spin_lock_init(&obd_dev_lock);
539 CFS_INIT_LIST_HEAD(&obd_types);
541 err = cfs_psdev_register(&obd_psdev);
543 CERROR("cannot register %d err %d\n", OBD_DEV_MINOR, err);
548 /* Default the dirty page cache cap to 1/2 of system memory.
549 * For clients with less memory, a larger fraction is needed
550 * for other purposes (mostly for BGL). */
551 if (cfs_num_physpages <= 512 << (20 - CFS_PAGE_SHIFT))
552 obd_max_dirty_pages = cfs_num_physpages / 4;
554 obd_max_dirty_pages = cfs_num_physpages / 2;
556 err = obd_init_caches();
560 err = class_procfs_init();
565 err = lu_global_init();
570 err = lustre_register_fs();
574 err = obd_hashes_init();
581 /* liblustre doesn't call cleanup_obdclass, apparently. we carry on in this
582 * ifdef to the end of the file to cover module and versioning goo.*/
584 static void cleanup_obdclass(void)
586 int lustre_unregister_fs(void);
587 __u64 memory_leaked, pages_leaked;
588 __u64 memory_max, pages_max;
589 struct obd_device *obd;
592 lustre_unregister_fs();
594 cfs_psdev_deregister(&obd_psdev);
595 for (obd_devlist_first(&obd);
597 obd_devlist_next(&obd)) {
598 if (obd->obd_set_up &&
599 OBT(obd) && OBP(obd, detach)) {
600 /* XXX should this call generic detach otherwise? */
601 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
602 OBP(obd, detach)(obd);
609 obd_cleanup_caches();
612 class_procfs_clean();
614 class_handle_cleanup();
615 class_exit_uuidlist();
616 obd_zombie_impexp_stop();
618 memory_leaked = obd_memory_sum();
619 pages_leaked = obd_pages_sum();
621 memory_max = obd_memory_max();
622 pages_max = obd_pages_max();
624 lprocfs_free_stats(&obd_memory);
625 CDEBUG((memory_leaked) ? D_ERROR : D_INFO,
626 "obd_memory max: "LPU64", leaked: "LPU64"\n",
627 memory_max, memory_leaked);
628 CDEBUG((pages_leaked) ? D_ERROR : D_INFO,
629 "obd_memory_pages max: "LPU64", leaked: "LPU64"\n",
630 pages_max, pages_leaked);
635 MODULE_AUTHOR("Sun Microsystems, Inc. <http://www.lustre.org/>");
636 MODULE_DESCRIPTION("Lustre Class Driver Build Version: " BUILD_VERSION);
637 MODULE_LICENSE("GPL");
639 cfs_module(obdclass, LUSTRE_VERSION_STRING, init_obdclass, cleanup_obdclass);