4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 1999, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2012, Intel Corporation.
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
38 # include <linux/atomic.h>
40 #include "../include/obd_support.h"
41 #include "../include/obd_class.h"
42 #include "../../include/linux/lnet/lnetctl.h"
43 #include "../include/lustre_debug.h"
44 #include "../include/lprocfs_status.h"
45 #include "../include/lustre/lustre_build_version.h"
46 #include <linux/list.h>
47 #include "../include/cl_object.h"
48 #include "llog_internal.h"
51 struct obd_device *obd_devs[MAX_OBD_DEVICES];
52 EXPORT_SYMBOL(obd_devs);
53 struct list_head obd_types;
54 DEFINE_RWLOCK(obd_dev_lock);
56 /* The following are visible and mutable through /proc/sys/lustre/. */
57 unsigned int obd_debug_peer_on_timeout;
58 EXPORT_SYMBOL(obd_debug_peer_on_timeout);
59 unsigned int obd_dump_on_timeout;
60 EXPORT_SYMBOL(obd_dump_on_timeout);
61 unsigned int obd_dump_on_eviction;
62 EXPORT_SYMBOL(obd_dump_on_eviction);
63 unsigned int obd_max_dirty_pages = 256;
64 EXPORT_SYMBOL(obd_max_dirty_pages);
65 atomic_t obd_dirty_pages;
66 EXPORT_SYMBOL(obd_dirty_pages);
67 unsigned int obd_timeout = OBD_TIMEOUT_DEFAULT; /* seconds */
68 EXPORT_SYMBOL(obd_timeout);
69 unsigned int obd_timeout_set;
70 EXPORT_SYMBOL(obd_timeout_set);
71 /* Adaptive timeout defs here instead of ptlrpc module for /proc/sys/ access */
73 EXPORT_SYMBOL(at_min);
74 unsigned int at_max = 600;
75 EXPORT_SYMBOL(at_max);
76 unsigned int at_history = 600;
77 EXPORT_SYMBOL(at_history);
78 int at_early_margin = 5;
79 EXPORT_SYMBOL(at_early_margin);
81 EXPORT_SYMBOL(at_extra);
83 atomic_t obd_dirty_transit_pages;
84 EXPORT_SYMBOL(obd_dirty_transit_pages);
86 char obd_jobid_var[JOBSTATS_JOBID_VAR_MAX_LEN + 1] = JOBSTATS_DISABLE;
87 EXPORT_SYMBOL(obd_jobid_var);
89 char obd_jobid_node[JOBSTATS_JOBID_SIZE + 1];
91 /* Get jobid of current process from stored variable or calculate
92 * it from pid and user_id.
94 * Historically this was also done by reading the environment variable
95 * stored in between the "env_start" & "env_end" of task struct.
96 * This is now deprecated.
98 int lustre_get_jobid(char *jobid)
100 memset(jobid, 0, JOBSTATS_JOBID_SIZE);
101 /* Jobstats isn't enabled */
102 if (strcmp(obd_jobid_var, JOBSTATS_DISABLE) == 0)
105 /* Use process name + fsuid as jobid */
106 if (strcmp(obd_jobid_var, JOBSTATS_PROCNAME_UID) == 0) {
107 snprintf(jobid, JOBSTATS_JOBID_SIZE, "%s.%u",
109 from_kuid(&init_user_ns, current_fsuid()));
113 /* Whole node dedicated to single job */
114 if (strcmp(obd_jobid_var, JOBSTATS_NODELOCAL) == 0) {
115 strcpy(jobid, obd_jobid_node);
121 EXPORT_SYMBOL(lustre_get_jobid);
123 static inline void obd_data2conn(struct lustre_handle *conn,
124 struct obd_ioctl_data *data)
126 memset(conn, 0, sizeof(*conn));
127 conn->cookie = data->ioc_cookie;
130 static inline void obd_conn2data(struct obd_ioctl_data *data,
131 struct lustre_handle *conn)
133 data->ioc_cookie = conn->cookie;
136 static int class_resolve_dev_name(__u32 len, const char *name)
142 CERROR("No name passed,!\n");
146 if (name[len - 1] != 0) {
147 CERROR("Name not nul terminated!\n");
152 CDEBUG(D_IOCTL, "device name %s\n", name);
153 dev = class_name2dev(name);
155 CDEBUG(D_IOCTL, "No device for name %s!\n", name);
160 CDEBUG(D_IOCTL, "device name %s, dev %d\n", name, dev);
167 int class_handle_ioctl(unsigned int cmd, unsigned long arg)
170 struct obd_ioctl_data *data;
171 struct libcfs_debug_ioctl_data *debug_data;
172 struct obd_device *obd = NULL;
173 int err = 0, len = 0;
175 /* only for debugging */
176 if (cmd == LIBCFS_IOC_DEBUG_MASK) {
177 debug_data = (struct libcfs_debug_ioctl_data *)arg;
178 libcfs_subsystem_debug = debug_data->subs;
179 libcfs_debug = debug_data->debug;
183 CDEBUG(D_IOCTL, "cmd = %x\n", cmd);
184 if (obd_ioctl_getdata(&buf, &len, (void *)arg)) {
185 CERROR("OBD ioctl: data error\n");
188 data = (struct obd_ioctl_data *)buf;
191 case OBD_IOC_PROCESS_CFG: {
192 struct lustre_cfg *lcfg;
194 if (!data->ioc_plen1 || !data->ioc_pbuf1) {
195 CERROR("No config buffer passed!\n");
199 lcfg = kzalloc(data->ioc_plen1, GFP_NOFS);
204 err = copy_from_user(lcfg, data->ioc_pbuf1,
207 err = lustre_cfg_sanity_check(lcfg, data->ioc_plen1);
209 err = class_process_config(lcfg);
215 case OBD_GET_VERSION:
216 if (!data->ioc_inlbuf1) {
217 CERROR("No buffer passed in ioctl\n");
222 if (strlen(BUILD_VERSION) + 1 > data->ioc_inllen1) {
223 CERROR("ioctl buffer too small to hold version\n");
228 memcpy(data->ioc_bulk, BUILD_VERSION,
229 strlen(BUILD_VERSION) + 1);
231 err = obd_ioctl_popdata((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,
250 err = obd_ioctl_popdata((void *)arg, data, sizeof(*data));
256 case OBD_IOC_UUID2DEV: {
257 /* Resolve a device uuid. This does not change the
258 * currently selected device.
261 struct obd_uuid uuid;
263 if (!data->ioc_inllen1 || !data->ioc_inlbuf1) {
264 CERROR("No UUID passed!\n");
268 if (data->ioc_inlbuf1[data->ioc_inllen1 - 1] != 0) {
269 CERROR("UUID not NUL terminated!\n");
274 CDEBUG(D_IOCTL, "device name %s\n", data->ioc_inlbuf1);
275 obd_str2uuid(&uuid, data->ioc_inlbuf1);
276 dev = class_uuid2dev(&uuid);
279 CDEBUG(D_IOCTL, "No device for UUID %s!\n",
285 CDEBUG(D_IOCTL, "device name %s, dev %d\n", data->ioc_inlbuf1,
287 err = obd_ioctl_popdata((void *)arg, data, sizeof(*data));
293 case OBD_IOC_CLOSE_UUID: {
294 CDEBUG(D_IOCTL, "closing all connections to uuid %s (NOOP)\n",
300 case OBD_IOC_GETDEVICE: {
301 int index = data->ioc_count;
304 if (!data->ioc_inlbuf1) {
305 CERROR("No buffer passed in ioctl\n");
309 if (data->ioc_inllen1 < 128) {
310 CERROR("ioctl buffer too small to hold version\n");
315 obd = class_num2obd(index);
321 if (obd->obd_stopping)
323 else if (obd->obd_set_up)
325 else if (obd->obd_attached)
329 str = (char *)data->ioc_bulk;
330 snprintf(str, len - sizeof(*data), "%3d %s %s %s %s %d",
331 (int)index, status, obd->obd_type->typ_name,
332 obd->obd_name, obd->obd_uuid.uuid,
333 atomic_read(&obd->obd_refcount));
334 err = obd_ioctl_popdata((void *)arg, data, len);
342 if (data->ioc_dev == OBD_DEV_BY_DEVNAME) {
343 if (data->ioc_inllen4 <= 0 || data->ioc_inlbuf4 == NULL) {
347 if (strnlen(data->ioc_inlbuf4, MAX_OBD_NAME) >= MAX_OBD_NAME) {
351 obd = class_name2obd(data->ioc_inlbuf4);
352 } else if (data->ioc_dev < class_devno_max()) {
353 obd = class_num2obd(data->ioc_dev);
355 CERROR("OBD ioctl: No device\n");
361 CERROR("OBD ioctl : No Device %d\n", data->ioc_dev);
365 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
367 if (!obd->obd_set_up || obd->obd_stopping) {
368 CERROR("OBD ioctl: device not setup %d\n", data->ioc_dev);
374 case OBD_IOC_NO_TRANSNO: {
375 if (!obd->obd_attached) {
376 CERROR("Device %d not attached\n", obd->obd_minor);
380 CDEBUG(D_HA, "%s: disabling committed-transno notification\n",
382 obd->obd_no_transno = 1;
388 err = obd_iocontrol(cmd, obd->obd_self_export, len, data, NULL);
392 err = obd_ioctl_popdata((void *)arg, data, len);
401 obd_ioctl_freedata(buf, len);
403 } /* class_handle_ioctl */
405 #define OBD_INIT_CHECK
406 static int obd_init_checks(void)
408 __u64 u64val, div64val;
412 CDEBUG(D_INFO, "LPU64=%s, LPD64=%s, LPX64=%s\n", "%llu", "%lld", "%#llx");
414 CDEBUG(D_INFO, "OBD_OBJECT_EOF = %#llx\n", (__u64)OBD_OBJECT_EOF);
416 u64val = OBD_OBJECT_EOF;
417 CDEBUG(D_INFO, "u64val OBD_OBJECT_EOF = %#llx\n", u64val);
418 if (u64val != OBD_OBJECT_EOF) {
419 CERROR("__u64 %#llx(%d) != 0xffffffffffffffff\n",
420 u64val, (int)sizeof(u64val));
423 len = snprintf(buf, sizeof(buf), "%#llx", u64val);
425 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf, len);
429 div64val = OBD_OBJECT_EOF;
430 CDEBUG(D_INFO, "u64val OBD_OBJECT_EOF = %#llx\n", u64val);
431 if (u64val != OBD_OBJECT_EOF) {
432 CERROR("__u64 %#llx(%d) != 0xffffffffffffffff\n",
433 u64val, (int)sizeof(u64val));
436 if (u64val >> 8 != OBD_OBJECT_EOF >> 8) {
437 CERROR("__u64 %#llx(%d) != 0xffffffffffffffff\n",
438 u64val, (int)sizeof(u64val));
441 if (do_div(div64val, 256) != (u64val & 255)) {
442 CERROR("do_div(%#llx,256) != %llu\n", u64val, u64val & 255);
445 if (u64val >> 8 != div64val) {
446 CERROR("do_div(%#llx,256) %llu != %llu\n",
447 u64val, div64val, u64val >> 8);
450 len = snprintf(buf, sizeof(buf), "%#llx", u64val);
452 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf, len);
455 len = snprintf(buf, sizeof(buf), "%llu", u64val);
457 CWARN("LPU64 wrong length! strlen(%s)=%d != 20\n", buf, len);
460 len = snprintf(buf, sizeof(buf), "%lld", u64val);
462 CWARN("LPD64 wrong length! strlen(%s)=%d != 2\n", buf, len);
465 if ((u64val & ~CFS_PAGE_MASK) >= PAGE_CACHE_SIZE) {
466 CWARN("mask failed: u64val %llu >= %llu\n", u64val,
467 (__u64)PAGE_CACHE_SIZE);
474 extern int class_procfs_init(void);
475 extern int class_procfs_clean(void);
477 static int __init init_obdclass(void)
480 int lustre_register_fs(void);
482 LCONSOLE_INFO("Lustre: Build Version: "BUILD_VERSION"\n");
484 spin_lock_init(&obd_types_lock);
485 obd_zombie_impexp_init();
487 err = obd_init_checks();
488 if (err == -EOVERFLOW)
491 class_init_uuidlist();
492 err = class_handle_init();
496 INIT_LIST_HEAD(&obd_types);
498 err = misc_register(&obd_psdev);
500 CERROR("cannot register %d err %d\n", OBD_DEV_MINOR, err);
504 /* This struct is already zeroed for us (static global) */
505 for (i = 0; i < class_devno_max(); i++)
508 /* Default the dirty page cache cap to 1/2 of system memory.
509 * For clients with less memory, a larger fraction is needed
510 * for other purposes (mostly for BGL). */
511 if (totalram_pages <= 512 << (20 - PAGE_CACHE_SHIFT))
512 obd_max_dirty_pages = totalram_pages / 4;
514 obd_max_dirty_pages = totalram_pages / 2;
516 err = obd_init_caches();
520 err = class_procfs_init();
524 err = obd_sysctl_init();
528 err = lu_global_init();
532 err = cl_global_init();
537 err = llog_info_init();
541 err = lustre_register_fs();
546 /* liblustre doesn't call cleanup_obdclass, apparently. we carry on in this
547 * ifdef to the end of the file to cover module and versioning goo.*/
548 static void cleanup_obdclass(void)
551 int lustre_unregister_fs(void);
553 lustre_unregister_fs();
555 misc_deregister(&obd_psdev);
556 for (i = 0; i < class_devno_max(); i++) {
557 struct obd_device *obd = class_num2obd(i);
558 if (obd && obd->obd_set_up &&
559 OBT(obd) && OBP(obd, detach)) {
560 /* XXX should this call generic detach otherwise? */
561 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
562 OBP(obd, detach)(obd);
569 obd_cleanup_caches();
571 class_procfs_clean();
573 class_handle_cleanup();
574 class_exit_uuidlist();
575 obd_zombie_impexp_stop();
578 MODULE_AUTHOR("Sun Microsystems, Inc. <http://www.lustre.org/>");
579 MODULE_DESCRIPTION("Lustre Class Driver Build Version: " BUILD_VERSION);
580 MODULE_LICENSE("GPL");
581 MODULE_VERSION(LUSTRE_VERSION_STRING);
583 module_init(init_obdclass);
584 module_exit(cleanup_obdclass);