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, 2014, 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
39 #include <linux/user_namespace.h>
40 #ifdef HAVE_UIDGID_HEADER
41 # include <linux/uidgid.h>
43 #include <linux/atomic.h>
45 #include <obd_support.h>
46 #include <obd_class.h>
47 #include <lnet/lnetctl.h>
48 #include <lustre_debug.h>
49 #include <lprocfs_status.h>
50 #include <lustre/lustre_build_version.h>
51 #include <libcfs/list.h>
52 #include <cl_object.h>
53 #ifdef HAVE_SERVER_SUPPORT
54 # include <dt_object.h>
55 # include <md_object.h>
56 #endif /* HAVE_SERVER_SUPPORT */
57 #include <lustre_ioctl.h>
58 #include "llog_internal.h"
60 struct obd_device *obd_devs[MAX_OBD_DEVICES];
61 struct list_head obd_types;
62 DEFINE_RWLOCK(obd_dev_lock);
65 static __u64 obd_max_alloc;
70 static DEFINE_SPINLOCK(obd_updatemax_lock);
72 /* The following are visible and mutable through /proc/sys/lustre/. */
73 unsigned int obd_debug_peer_on_timeout;
74 EXPORT_SYMBOL(obd_debug_peer_on_timeout);
75 unsigned int obd_dump_on_timeout;
76 EXPORT_SYMBOL(obd_dump_on_timeout);
77 unsigned int obd_dump_on_eviction;
78 EXPORT_SYMBOL(obd_dump_on_eviction);
79 unsigned long obd_max_dirty_pages;
80 EXPORT_SYMBOL(obd_max_dirty_pages);
81 atomic_long_t obd_dirty_pages;
82 EXPORT_SYMBOL(obd_dirty_pages);
83 unsigned int obd_timeout = OBD_TIMEOUT_DEFAULT; /* seconds */
84 EXPORT_SYMBOL(obd_timeout);
85 unsigned int ldlm_timeout = LDLM_TIMEOUT_DEFAULT; /* seconds */
86 EXPORT_SYMBOL(ldlm_timeout);
87 unsigned int obd_timeout_set;
88 EXPORT_SYMBOL(obd_timeout_set);
89 unsigned int ldlm_timeout_set;
90 EXPORT_SYMBOL(ldlm_timeout_set);
91 /* bulk transfer timeout, give up after 100s by default */
92 unsigned int bulk_timeout = 100; /* seconds */
93 EXPORT_SYMBOL(bulk_timeout);
94 /* Adaptive timeout defs here instead of ptlrpc module for /proc/sys/ access */
95 unsigned int at_min = 0;
96 EXPORT_SYMBOL(at_min);
97 unsigned int at_max = 600;
98 EXPORT_SYMBOL(at_max);
99 unsigned int at_history = 600;
100 EXPORT_SYMBOL(at_history);
101 int at_early_margin = 5;
102 EXPORT_SYMBOL(at_early_margin);
104 EXPORT_SYMBOL(at_extra);
106 atomic_long_t obd_dirty_transit_pages;
107 EXPORT_SYMBOL(obd_dirty_transit_pages);
109 char obd_jobid_var[JOBSTATS_JOBID_VAR_MAX_LEN + 1] = JOBSTATS_DISABLE;
111 #ifdef CONFIG_PROC_FS
112 struct lprocfs_stats *obd_memory = NULL;
113 EXPORT_SYMBOL(obd_memory);
116 /* Get jobid of current process by reading the environment variable
117 * stored in between the "env_start" & "env_end" of task struct.
120 * It's better to cache the jobid for later use if there is any
121 * efficient way, the cl_env code probably could be reused for this
124 * If some job scheduler doesn't store jobid in the "env_start/end",
125 * then an upcall could be issued here to get the jobid by utilizing
126 * the userspace tools/api. Then, the jobid must be cached.
128 int lustre_get_jobid(char *jobid)
130 int jobid_len = LUSTRE_JOBID_SIZE;
134 memset(jobid, 0, LUSTRE_JOBID_SIZE);
135 /* Jobstats isn't enabled */
136 if (strcmp(obd_jobid_var, JOBSTATS_DISABLE) == 0)
139 /* Use process name + fsuid as jobid */
140 if (strcmp(obd_jobid_var, JOBSTATS_PROCNAME_UID) == 0) {
141 snprintf(jobid, LUSTRE_JOBID_SIZE, "%s.%u",
143 from_kuid(&init_user_ns, current_fsuid()));
147 rc = cfs_get_environ(obd_jobid_var, jobid, &jobid_len);
149 if (rc == -EOVERFLOW) {
150 /* For the PBS_JOBID and LOADL_STEP_ID keys (which are
151 * variable length strings instead of just numbers), it
152 * might make sense to keep the unique parts for JobID,
153 * instead of just returning an error. That means a
154 * larger temp buffer for cfs_get_environ(), then
155 * truncating the string at some separator to fit into
156 * the specified jobid_len. Fix later if needed. */
158 if (unlikely(!printed)) {
159 LCONSOLE_ERROR_MSG(0x16b, "%s value too large "
160 "for JobID buffer (%d)\n",
161 obd_jobid_var, jobid_len);
165 CDEBUG((rc == -ENOENT || rc == -EINVAL ||
166 rc == -EDEADLK) ? D_INFO : D_ERROR,
167 "Get jobid for (%s) failed: rc = %d\n",
173 EXPORT_SYMBOL(lustre_get_jobid);
175 static int class_resolve_dev_name(__u32 len, const char *name)
182 CERROR("No name passed,!\n");
183 GOTO(out, rc = -EINVAL);
185 if (name[len - 1] != 0) {
186 CERROR("Name not nul terminated!\n");
187 GOTO(out, rc = -EINVAL);
190 CDEBUG(D_IOCTL, "device name %s\n", name);
191 dev = class_name2dev(name);
193 CDEBUG(D_IOCTL, "No device for name %s!\n", name);
194 GOTO(out, rc = -EINVAL);
197 CDEBUG(D_IOCTL, "device name %s, dev %d\n", name, dev);
204 int class_handle_ioctl(unsigned int cmd, unsigned long arg)
207 struct obd_ioctl_data *data;
208 struct libcfs_debug_ioctl_data *debug_data;
209 struct obd_device *obd = NULL;
210 int err = 0, len = 0;
213 /* only for debugging */
214 if (cmd == LIBCFS_IOC_DEBUG_MASK) {
215 debug_data = (struct libcfs_debug_ioctl_data*)arg;
216 libcfs_subsystem_debug = debug_data->subs;
217 libcfs_debug = debug_data->debug;
221 CDEBUG(D_IOCTL, "cmd = %x\n", cmd);
222 if (obd_ioctl_getdata(&buf, &len, (void __user *)arg)) {
223 CERROR("OBD ioctl: data error\n");
226 data = (struct obd_ioctl_data *)buf;
229 case OBD_IOC_PROCESS_CFG: {
230 struct lustre_cfg *lcfg;
232 if (!data->ioc_plen1 || !data->ioc_pbuf1) {
233 CERROR("No config buffer passed!\n");
234 GOTO(out, err = -EINVAL);
236 OBD_ALLOC(lcfg, data->ioc_plen1);
238 GOTO(out, err = -ENOMEM);
239 err = copy_from_user(lcfg, data->ioc_pbuf1,
242 err = lustre_cfg_sanity_check(lcfg, data->ioc_plen1);
244 err = class_process_config(lcfg);
246 OBD_FREE(lcfg, data->ioc_plen1);
250 case OBD_GET_VERSION:
251 if (!data->ioc_inlbuf1) {
252 CERROR("No buffer passed in ioctl\n");
253 GOTO(out, err = -EINVAL);
256 if (strlen(BUILD_VERSION) + 1 > data->ioc_inllen1) {
257 CERROR("ioctl buffer too small to hold version\n");
258 GOTO(out, err = -EINVAL);
261 memcpy(data->ioc_bulk, BUILD_VERSION,
262 strlen(BUILD_VERSION) + 1);
264 err = obd_ioctl_popdata((void __user *)arg, data, len);
269 case OBD_IOC_NAME2DEV: {
270 /* Resolve a device name. This does not change the
271 * currently selected device.
275 dev = class_resolve_dev_name(data->ioc_inllen1,
279 GOTO(out, err = -EINVAL);
281 err = obd_ioctl_popdata((void __user *)arg, data,
288 case OBD_IOC_UUID2DEV: {
289 /* Resolve a device uuid. This does not change the
290 * currently selected device.
293 struct obd_uuid uuid;
295 if (!data->ioc_inllen1 || !data->ioc_inlbuf1) {
296 CERROR("No UUID passed!\n");
297 GOTO(out, err = -EINVAL);
299 if (data->ioc_inlbuf1[data->ioc_inllen1 - 1] != 0) {
300 CERROR("UUID not NUL terminated!\n");
301 GOTO(out, err = -EINVAL);
304 CDEBUG(D_IOCTL, "device name %s\n", data->ioc_inlbuf1);
305 obd_str2uuid(&uuid, data->ioc_inlbuf1);
306 dev = class_uuid2dev(&uuid);
309 CDEBUG(D_IOCTL, "No device for UUID %s!\n",
311 GOTO(out, err = -EINVAL);
314 CDEBUG(D_IOCTL, "device name %s, dev %d\n", data->ioc_inlbuf1,
316 err = obd_ioctl_popdata((void __user *)arg, data,
323 case OBD_IOC_GETDEVICE: {
324 int index = data->ioc_count;
327 if (!data->ioc_inlbuf1) {
328 CERROR("No buffer passed in ioctl\n");
329 GOTO(out, err = -EINVAL);
331 if (data->ioc_inllen1 < 128) {
332 CERROR("ioctl buffer too small to hold version\n");
333 GOTO(out, err = -EINVAL);
336 obd = class_num2obd(index);
338 GOTO(out, err = -ENOENT);
340 if (obd->obd_stopping)
342 else if (obd->obd_set_up)
344 else if (obd->obd_attached)
348 str = (char *)data->ioc_bulk;
349 snprintf(str, len - sizeof(*data), "%3d %s %s %s %s %d",
350 (int)index, status, obd->obd_type->typ_name,
351 obd->obd_name, obd->obd_uuid.uuid,
352 atomic_read(&obd->obd_refcount));
353 err = obd_ioctl_popdata((void __user *)arg, data, len);
360 if (data->ioc_dev == OBD_DEV_BY_DEVNAME) {
361 if (data->ioc_inllen4 <= 0 || data->ioc_inlbuf4 == NULL)
362 GOTO(out, err = -EINVAL);
363 if (strnlen(data->ioc_inlbuf4, MAX_OBD_NAME) >= MAX_OBD_NAME)
364 GOTO(out, err = -EINVAL);
365 obd = class_name2obd(data->ioc_inlbuf4);
366 } else if (data->ioc_dev < class_devno_max()) {
367 obd = class_num2obd(data->ioc_dev);
369 CERROR("OBD ioctl: No device\n");
370 GOTO(out, err = -EINVAL);
374 CERROR("OBD ioctl : No Device %d\n", data->ioc_dev);
375 GOTO(out, err = -EINVAL);
377 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
379 if (!obd->obd_set_up || obd->obd_stopping) {
380 CERROR("OBD ioctl: device not setup %d \n", data->ioc_dev);
381 GOTO(out, err = -EINVAL);
385 case OBD_IOC_NO_TRANSNO: {
386 if (!obd->obd_attached) {
387 CERROR("Device %d not attached\n", obd->obd_minor);
388 GOTO(out, err = -ENODEV);
390 CDEBUG(D_HA, "%s: disabling committed-transno notification\n",
392 obd->obd_no_transno = 1;
397 err = obd_iocontrol(cmd, obd->obd_self_export, len, data, NULL);
401 err = obd_ioctl_popdata((void __user *)arg, data, len);
410 obd_ioctl_freedata(buf, len);
412 } /* class_handle_ioctl */
414 #define OBD_INIT_CHECK
415 #ifdef OBD_INIT_CHECK
416 static int obd_init_checks(void)
418 __u64 u64val, div64val;
422 CDEBUG(D_INFO, "LPU64=%s, LPD64=%s, LPX64=%s\n", LPU64, LPD64, LPX64);
424 CDEBUG(D_INFO, "OBD_OBJECT_EOF = "LPX64"\n", (__u64)OBD_OBJECT_EOF);
426 u64val = OBD_OBJECT_EOF;
427 CDEBUG(D_INFO, "u64val OBD_OBJECT_EOF = "LPX64"\n", u64val);
428 if (u64val != OBD_OBJECT_EOF) {
429 CERROR("__u64 "LPX64"(%d) != 0xffffffffffffffff\n",
430 u64val, (int)sizeof(u64val));
433 len = snprintf(buf, sizeof(buf), LPX64, u64val);
435 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf, len);
439 div64val = OBD_OBJECT_EOF;
440 CDEBUG(D_INFO, "u64val OBD_OBJECT_EOF = "LPX64"\n", u64val);
441 if (u64val != OBD_OBJECT_EOF) {
442 CERROR("__u64 "LPX64"(%d) != 0xffffffffffffffff\n",
443 u64val, (int)sizeof(u64val));
446 if (u64val >> 8 != OBD_OBJECT_EOF >> 8) {
447 CERROR("__u64 "LPX64"(%d) != 0xffffffffffffffff\n",
448 u64val, (int)sizeof(u64val));
451 if (do_div(div64val, 256) != (u64val & 255)) {
452 CERROR("do_div("LPX64",256) != "LPU64"\n", u64val, u64val &255);
455 if (u64val >> 8 != div64val) {
456 CERROR("do_div("LPX64",256) "LPU64" != "LPU64"\n",
457 u64val, div64val, u64val >> 8);
460 len = snprintf(buf, sizeof(buf), LPX64, u64val);
462 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf, len);
465 len = snprintf(buf, sizeof(buf), LPU64, u64val);
467 CWARN("LPU64 wrong length! strlen(%s)=%d != 20\n", buf, len);
470 len = snprintf(buf, sizeof(buf), LPD64, u64val);
472 CWARN("LPD64 wrong length! strlen(%s)=%d != 2\n", buf, len);
475 if ((u64val & ~PAGE_CACHE_MASK) >= PAGE_CACHE_SIZE) {
476 CWARN("mask failed: u64val "LPU64" >= "LPU64"\n", u64val,
477 (__u64)PAGE_CACHE_SIZE);
484 #define obd_init_checks() do {} while(0)
487 static int __init init_obdclass(void)
491 spin_lock_init(&obd_stale_export_lock);
492 INIT_LIST_HEAD(&obd_stale_exports);
493 atomic_set(&obd_stale_export_num, 0);
495 LCONSOLE_INFO("Lustre: Build Version: "BUILD_VERSION"\n");
497 spin_lock_init(&obd_types_lock);
498 obd_zombie_impexp_init();
499 #ifdef CONFIG_PROC_FS
500 obd_memory = lprocfs_alloc_stats(OBD_STATS_NUM,
501 LPROCFS_STATS_FLAG_NONE |
502 LPROCFS_STATS_FLAG_IRQ_SAFE);
503 if (obd_memory == NULL) {
504 CERROR("kmalloc of 'obd_memory' failed\n");
508 lprocfs_counter_init(obd_memory, OBD_MEMORY_STAT,
509 LPROCFS_CNTR_AVGMINMAX,
512 err = obd_init_checks();
513 if (err == -EOVERFLOW)
516 class_init_uuidlist();
517 err = class_handle_init();
521 INIT_LIST_HEAD(&obd_types);
523 err = misc_register(&obd_psdev);
525 CERROR("cannot register %d err %d\n", OBD_DEV_MINOR, err);
529 /* This struct is already zeroed for us (static global) */
530 for (i = 0; i < class_devno_max(); i++)
533 /* Default the dirty page cache cap to 1/2 of system memory.
534 * For clients with less memory, a larger fraction is needed
535 * for other purposes (mostly for BGL). */
536 if (totalram_pages <= 512 << (20 - PAGE_CACHE_SHIFT))
537 obd_max_dirty_pages = totalram_pages / 4;
539 obd_max_dirty_pages = totalram_pages / 2;
541 err = obd_init_caches();
544 err = class_procfs_init();
548 err = lu_global_init();
552 err = cl_global_init();
556 #ifdef HAVE_SERVER_SUPPORT
557 err = dt_global_init();
561 err = lu_ucred_global_init();
564 #endif /* HAVE_SERVER_SUPPORT */
566 err = llog_info_init();
570 err = lustre_register_fs();
575 void obd_update_maxusage(void)
579 max = obd_memory_sum();
581 spin_lock(&obd_updatemax_lock);
582 if (max > obd_max_alloc)
584 spin_unlock(&obd_updatemax_lock);
586 EXPORT_SYMBOL(obd_update_maxusage);
588 #ifdef CONFIG_PROC_FS
589 __u64 obd_memory_max(void)
593 obd_update_maxusage();
594 spin_lock(&obd_updatemax_lock);
596 spin_unlock(&obd_updatemax_lock);
600 #endif /* CONFIG_PROC_FS */
602 /* liblustre doesn't call cleanup_obdclass, apparently. we carry on in this
603 * ifdef to the end of the file to cover module and versioning goo.*/
604 static void cleanup_obdclass(void)
610 lustre_unregister_fs();
612 misc_deregister(&obd_psdev);
614 #ifdef HAVE_SERVER_SUPPORT
615 lu_ucred_global_fini();
617 #endif /* HAVE_SERVER_SUPPORT */
621 obd_cleanup_caches();
624 class_procfs_clean();
626 class_handle_cleanup();
627 class_exit_uuidlist();
628 obd_zombie_impexp_stop();
629 LASSERT(list_empty(&obd_stale_exports));
631 memory_leaked = obd_memory_sum();
633 memory_max = obd_memory_max();
635 lprocfs_free_stats(&obd_memory);
636 CDEBUG((memory_leaked) ? D_ERROR : D_INFO,
637 "obd_memory max: "LPU64", leaked: "LPU64"\n",
638 memory_max, memory_leaked);
643 MODULE_AUTHOR("Sun Microsystems, Inc. <http://www.lustre.org/>");
644 MODULE_DESCRIPTION("Lustre Class Driver Build Version: " BUILD_VERSION);
645 MODULE_VERSION(LUSTRE_VERSION_STRING);
646 MODULE_LICENSE("GPL");
648 module_init(init_obdclass);
649 module_exit(cleanup_obdclass);