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 __u64 obd_max_pages = 0;
57 EXPORT_SYMBOL(obd_max_pages);
58 __u64 obd_max_alloc = 0;
59 EXPORT_SYMBOL(obd_max_alloc);
61 EXPORT_SYMBOL(obd_alloc);
63 EXPORT_SYMBOL(obd_pages);
64 DEFINE_SPINLOCK(obd_updatemax_lock);
66 /* The following are visible and mutable through /proc/sys/lustre/. */
67 unsigned int obd_alloc_fail_rate = 0;
68 EXPORT_SYMBOL(obd_alloc_fail_rate);
69 unsigned int obd_debug_peer_on_timeout;
70 EXPORT_SYMBOL(obd_debug_peer_on_timeout);
71 unsigned int obd_dump_on_timeout;
72 EXPORT_SYMBOL(obd_dump_on_timeout);
73 unsigned int obd_dump_on_eviction;
74 EXPORT_SYMBOL(obd_dump_on_eviction);
75 unsigned int obd_max_dirty_pages = 256;
76 EXPORT_SYMBOL(obd_max_dirty_pages);
77 atomic_t obd_dirty_pages;
78 EXPORT_SYMBOL(obd_dirty_pages);
79 unsigned int obd_timeout = OBD_TIMEOUT_DEFAULT; /* seconds */
80 EXPORT_SYMBOL(obd_timeout);
81 unsigned int ldlm_timeout = LDLM_TIMEOUT_DEFAULT; /* seconds */
82 EXPORT_SYMBOL(ldlm_timeout);
83 unsigned int obd_timeout_set;
84 EXPORT_SYMBOL(obd_timeout_set);
85 unsigned int ldlm_timeout_set;
86 EXPORT_SYMBOL(ldlm_timeout_set);
87 /* Adaptive timeout defs here instead of ptlrpc module for /proc/sys/ access */
88 unsigned int at_min = 0;
89 EXPORT_SYMBOL(at_min);
90 unsigned int at_max = 600;
91 EXPORT_SYMBOL(at_max);
92 unsigned int at_history = 600;
93 EXPORT_SYMBOL(at_history);
94 int at_early_margin = 5;
95 EXPORT_SYMBOL(at_early_margin);
97 EXPORT_SYMBOL(at_extra);
99 atomic_t obd_dirty_transit_pages;
100 EXPORT_SYMBOL(obd_dirty_transit_pages);
102 char obd_jobid_var[JOBSTATS_JOBID_VAR_MAX_LEN + 1] = JOBSTATS_DISABLE;
103 EXPORT_SYMBOL(obd_jobid_var);
105 char obd_jobid_node[JOBSTATS_JOBID_SIZE + 1];
107 /* Get jobid of current process from stored variable or calculate
108 * it from pid and user_id.
110 * Historically this was also done by reading the environment variable
111 * stored in between the "env_start" & "env_end" of task struct.
112 * This is now deprecated.
114 int lustre_get_jobid(char *jobid)
116 memset(jobid, 0, JOBSTATS_JOBID_SIZE);
117 /* Jobstats isn't enabled */
118 if (strcmp(obd_jobid_var, JOBSTATS_DISABLE) == 0)
121 /* Use process name + fsuid as jobid */
122 if (strcmp(obd_jobid_var, JOBSTATS_PROCNAME_UID) == 0) {
123 snprintf(jobid, JOBSTATS_JOBID_SIZE, "%s.%u",
125 from_kuid(&init_user_ns, current_fsuid()));
129 /* Whole node dedicated to single job */
130 if (strcmp(obd_jobid_var, JOBSTATS_NODELOCAL) == 0) {
131 strcpy(jobid, obd_jobid_node);
137 EXPORT_SYMBOL(lustre_get_jobid);
139 int obd_alloc_fail(const void *ptr, const char *name, const char *type,
140 size_t size, const char *file, int line)
143 (cfs_rand() & OBD_ALLOC_FAIL_MASK) < obd_alloc_fail_rate) {
144 CERROR("%s%salloc of %s (%llu bytes) failed at %s:%d\n",
145 ptr ? "force " :"", type, name, (__u64)size, file,
147 CERROR("%llu total bytes and %llu total pages "
148 "(%llu bytes) allocated by Lustre, "
149 "%d total bytes by LNET\n",
151 obd_pages_sum() << PAGE_CACHE_SHIFT,
153 atomic_read(&libcfs_kmemory));
158 EXPORT_SYMBOL(obd_alloc_fail);
160 static inline void obd_data2conn(struct lustre_handle *conn,
161 struct obd_ioctl_data *data)
163 memset(conn, 0, sizeof(*conn));
164 conn->cookie = data->ioc_cookie;
167 static inline void obd_conn2data(struct obd_ioctl_data *data,
168 struct lustre_handle *conn)
170 data->ioc_cookie = conn->cookie;
173 int class_resolve_dev_name(__u32 len, const char *name)
179 CERROR("No name passed,!\n");
183 if (name[len - 1] != 0) {
184 CERROR("Name not nul terminated!\n");
189 CDEBUG(D_IOCTL, "device name %s\n", name);
190 dev = class_name2dev(name);
192 CDEBUG(D_IOCTL, "No device for name %s!\n", name);
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;
212 /* only for debugging */
213 if (cmd == LIBCFS_IOC_DEBUG_MASK) {
214 debug_data = (struct libcfs_debug_ioctl_data *)arg;
215 libcfs_subsystem_debug = debug_data->subs;
216 libcfs_debug = debug_data->debug;
220 CDEBUG(D_IOCTL, "cmd = %x\n", cmd);
221 if (obd_ioctl_getdata(&buf, &len, (void *)arg)) {
222 CERROR("OBD ioctl: data error\n");
225 data = (struct obd_ioctl_data *)buf;
228 case OBD_IOC_PROCESS_CFG: {
229 struct lustre_cfg *lcfg;
231 if (!data->ioc_plen1 || !data->ioc_pbuf1) {
232 CERROR("No config buffer passed!\n");
236 OBD_ALLOC(lcfg, data->ioc_plen1);
241 err = copy_from_user(lcfg, data->ioc_pbuf1,
244 err = lustre_cfg_sanity_check(lcfg, data->ioc_plen1);
246 err = class_process_config(lcfg);
248 OBD_FREE(lcfg, data->ioc_plen1);
252 case OBD_GET_VERSION:
253 if (!data->ioc_inlbuf1) {
254 CERROR("No buffer passed in ioctl\n");
259 if (strlen(BUILD_VERSION) + 1 > data->ioc_inllen1) {
260 CERROR("ioctl buffer too small to hold version\n");
265 memcpy(data->ioc_bulk, BUILD_VERSION,
266 strlen(BUILD_VERSION) + 1);
268 err = obd_ioctl_popdata((void *)arg, data, len);
273 case OBD_IOC_NAME2DEV: {
274 /* Resolve a device name. This does not change the
275 * currently selected device.
279 dev = class_resolve_dev_name(data->ioc_inllen1,
287 err = obd_ioctl_popdata((void *)arg, data, sizeof(*data));
293 case OBD_IOC_UUID2DEV: {
294 /* Resolve a device uuid. This does not change the
295 * currently selected device.
298 struct obd_uuid uuid;
300 if (!data->ioc_inllen1 || !data->ioc_inlbuf1) {
301 CERROR("No UUID passed!\n");
305 if (data->ioc_inlbuf1[data->ioc_inllen1 - 1] != 0) {
306 CERROR("UUID not NUL terminated!\n");
311 CDEBUG(D_IOCTL, "device name %s\n", data->ioc_inlbuf1);
312 obd_str2uuid(&uuid, data->ioc_inlbuf1);
313 dev = class_uuid2dev(&uuid);
316 CDEBUG(D_IOCTL, "No device for UUID %s!\n",
322 CDEBUG(D_IOCTL, "device name %s, dev %d\n", data->ioc_inlbuf1,
324 err = obd_ioctl_popdata((void *)arg, data, sizeof(*data));
330 case OBD_IOC_CLOSE_UUID: {
331 CDEBUG(D_IOCTL, "closing all connections to uuid %s (NOOP)\n",
337 case OBD_IOC_GETDEVICE: {
338 int index = data->ioc_count;
341 if (!data->ioc_inlbuf1) {
342 CERROR("No buffer passed in ioctl\n");
346 if (data->ioc_inllen1 < 128) {
347 CERROR("ioctl buffer too small to hold version\n");
352 obd = class_num2obd(index);
358 if (obd->obd_stopping)
360 else if (obd->obd_set_up)
362 else if (obd->obd_attached)
366 str = (char *)data->ioc_bulk;
367 snprintf(str, len - sizeof(*data), "%3d %s %s %s %s %d",
368 (int)index, status, obd->obd_type->typ_name,
369 obd->obd_name, obd->obd_uuid.uuid,
370 atomic_read(&obd->obd_refcount));
371 err = obd_ioctl_popdata((void *)arg, data, len);
379 if (data->ioc_dev == OBD_DEV_BY_DEVNAME) {
380 if (data->ioc_inllen4 <= 0 || data->ioc_inlbuf4 == NULL) {
384 if (strnlen(data->ioc_inlbuf4, MAX_OBD_NAME) >= MAX_OBD_NAME) {
388 obd = class_name2obd(data->ioc_inlbuf4);
389 } else if (data->ioc_dev < class_devno_max()) {
390 obd = class_num2obd(data->ioc_dev);
392 CERROR("OBD ioctl: No device\n");
398 CERROR("OBD ioctl : No Device %d\n", data->ioc_dev);
402 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
404 if (!obd->obd_set_up || obd->obd_stopping) {
405 CERROR("OBD ioctl: device not setup %d\n", data->ioc_dev);
411 case OBD_IOC_NO_TRANSNO: {
412 if (!obd->obd_attached) {
413 CERROR("Device %d not attached\n", obd->obd_minor);
417 CDEBUG(D_HA, "%s: disabling committed-transno notification\n",
419 obd->obd_no_transno = 1;
425 err = obd_iocontrol(cmd, obd->obd_self_export, len, data, NULL);
429 err = obd_ioctl_popdata((void *)arg, data, len);
438 obd_ioctl_freedata(buf, len);
440 } /* class_handle_ioctl */
442 extern struct miscdevice obd_psdev;
444 #define OBD_INIT_CHECK
445 int obd_init_checks(void)
447 __u64 u64val, div64val;
451 CDEBUG(D_INFO, "LPU64=%s, LPD64=%s, LPX64=%s\n", "%llu", "%lld", "%#llx");
453 CDEBUG(D_INFO, "OBD_OBJECT_EOF = %#llx\n", (__u64)OBD_OBJECT_EOF);
455 u64val = OBD_OBJECT_EOF;
456 CDEBUG(D_INFO, "u64val OBD_OBJECT_EOF = %#llx\n", u64val);
457 if (u64val != OBD_OBJECT_EOF) {
458 CERROR("__u64 %#llx(%d) != 0xffffffffffffffff\n",
459 u64val, (int)sizeof(u64val));
462 len = snprintf(buf, sizeof(buf), "%#llx", u64val);
464 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf, len);
468 div64val = OBD_OBJECT_EOF;
469 CDEBUG(D_INFO, "u64val OBD_OBJECT_EOF = %#llx\n", u64val);
470 if (u64val != OBD_OBJECT_EOF) {
471 CERROR("__u64 %#llx(%d) != 0xffffffffffffffff\n",
472 u64val, (int)sizeof(u64val));
475 if (u64val >> 8 != OBD_OBJECT_EOF >> 8) {
476 CERROR("__u64 %#llx(%d) != 0xffffffffffffffff\n",
477 u64val, (int)sizeof(u64val));
480 if (do_div(div64val, 256) != (u64val & 255)) {
481 CERROR("do_div(%#llx,256) != %llu\n", u64val, u64val &255);
484 if (u64val >> 8 != div64val) {
485 CERROR("do_div(%#llx,256) %llu != %llu\n",
486 u64val, div64val, u64val >> 8);
489 len = snprintf(buf, sizeof(buf), "%#llx", u64val);
491 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf, len);
494 len = snprintf(buf, sizeof(buf), "%llu", u64val);
496 CWARN("LPU64 wrong length! strlen(%s)=%d != 20\n", buf, len);
499 len = snprintf(buf, sizeof(buf), "%lld", u64val);
501 CWARN("LPD64 wrong length! strlen(%s)=%d != 2\n", buf, len);
504 if ((u64val & ~CFS_PAGE_MASK) >= PAGE_CACHE_SIZE) {
505 CWARN("mask failed: u64val %llu >= %llu\n", u64val,
506 (__u64)PAGE_CACHE_SIZE);
513 extern spinlock_t obd_types_lock;
514 #if defined (CONFIG_PROC_FS)
515 extern int class_procfs_init(void);
516 extern int class_procfs_clean(void);
518 static inline int class_procfs_init(void)
520 static inline int class_procfs_clean(void)
524 static int __init init_obdclass(void)
527 int lustre_register_fs(void);
529 for (i = CAPA_SITE_CLIENT; i < CAPA_SITE_MAX; i++)
530 INIT_LIST_HEAD(&capa_list[i]);
532 LCONSOLE_INFO("Lustre: Build Version: "BUILD_VERSION"\n");
534 spin_lock_init(&obd_types_lock);
535 obd_zombie_impexp_init();
537 if (IS_ENABLED(CONFIG_PROC_FS)) {
538 obd_memory = lprocfs_alloc_stats(OBD_STATS_NUM,
539 LPROCFS_STATS_FLAG_NONE |
540 LPROCFS_STATS_FLAG_IRQ_SAFE);
542 if (obd_memory == NULL) {
543 CERROR("kmalloc of 'obd_memory' failed\n");
547 lprocfs_counter_init(obd_memory, OBD_MEMORY_STAT,
548 LPROCFS_CNTR_AVGMINMAX,
550 lprocfs_counter_init(obd_memory, OBD_MEMORY_PAGES_STAT,
551 LPROCFS_CNTR_AVGMINMAX,
552 "pagesused", "pages");
555 err = obd_init_checks();
556 if (err == -EOVERFLOW)
559 class_init_uuidlist();
560 err = class_handle_init();
564 INIT_LIST_HEAD(&obd_types);
566 err = misc_register(&obd_psdev);
568 CERROR("cannot register %d err %d\n", OBD_DEV_MINOR, err);
572 /* This struct is already zeroed for us (static global) */
573 for (i = 0; i < class_devno_max(); i++)
576 /* Default the dirty page cache cap to 1/2 of system memory.
577 * For clients with less memory, a larger fraction is needed
578 * for other purposes (mostly for BGL). */
579 if (totalram_pages <= 512 << (20 - PAGE_CACHE_SHIFT))
580 obd_max_dirty_pages = totalram_pages / 4;
582 obd_max_dirty_pages = totalram_pages / 2;
584 err = obd_init_caches();
590 err = class_procfs_init();
594 err = lu_global_init();
598 err = cl_global_init();
603 err = llog_info_init();
607 err = lustre_register_fs();
612 void obd_update_maxusage(void)
616 max1 = obd_pages_sum();
617 max2 = obd_memory_sum();
619 spin_lock(&obd_updatemax_lock);
620 if (max1 > obd_max_pages)
621 obd_max_pages = max1;
622 if (max2 > obd_max_alloc)
623 obd_max_alloc = max2;
624 spin_unlock(&obd_updatemax_lock);
626 EXPORT_SYMBOL(obd_update_maxusage);
628 #if defined (CONFIG_PROC_FS)
629 __u64 obd_memory_max(void)
633 spin_lock(&obd_updatemax_lock);
635 spin_unlock(&obd_updatemax_lock);
639 EXPORT_SYMBOL(obd_memory_max);
641 __u64 obd_pages_max(void)
645 spin_lock(&obd_updatemax_lock);
647 spin_unlock(&obd_updatemax_lock);
651 EXPORT_SYMBOL(obd_pages_max);
654 /* liblustre doesn't call cleanup_obdclass, apparently. we carry on in this
655 * ifdef to the end of the file to cover module and versioning goo.*/
656 static void cleanup_obdclass(void)
659 int lustre_unregister_fs(void);
660 __u64 memory_leaked, pages_leaked;
661 __u64 memory_max, pages_max;
663 lustre_unregister_fs();
665 misc_deregister(&obd_psdev);
666 for (i = 0; i < class_devno_max(); i++) {
667 struct obd_device *obd = class_num2obd(i);
668 if (obd && obd->obd_set_up &&
669 OBT(obd) && OBP(obd, detach)) {
670 /* XXX should this call generic detach otherwise? */
671 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
672 OBP(obd, detach)(obd);
679 obd_cleanup_caches();
682 class_procfs_clean();
684 class_handle_cleanup();
685 class_exit_uuidlist();
686 obd_zombie_impexp_stop();
688 memory_leaked = obd_memory_sum();
689 pages_leaked = obd_pages_sum();
691 memory_max = obd_memory_max();
692 pages_max = obd_pages_max();
694 lprocfs_free_stats(&obd_memory);
695 CDEBUG((memory_leaked) ? D_ERROR : D_INFO,
696 "obd_memory max: %llu, leaked: %llu\n",
697 memory_max, memory_leaked);
698 CDEBUG((pages_leaked) ? D_ERROR : D_INFO,
699 "obd_memory_pages max: %llu, leaked: %llu\n",
700 pages_max, pages_leaked);
703 MODULE_AUTHOR("Sun Microsystems, Inc. <http://www.lustre.org/>");
704 MODULE_DESCRIPTION("Lustre Class Driver Build Version: " BUILD_VERSION);
705 MODULE_LICENSE("GPL");
706 MODULE_VERSION(LUSTRE_VERSION_STRING);
708 module_init(init_obdclass);
709 module_exit(cleanup_obdclass);