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 (%llu bytes) allocated by Lustre, %d total bytes by LNET\n",
149 obd_pages_sum() << PAGE_CACHE_SHIFT
,
151 atomic_read(&libcfs_kmemory
));
156 EXPORT_SYMBOL(obd_alloc_fail
);
158 static inline void obd_data2conn(struct lustre_handle
*conn
,
159 struct obd_ioctl_data
*data
)
161 memset(conn
, 0, sizeof(*conn
));
162 conn
->cookie
= data
->ioc_cookie
;
165 static inline void obd_conn2data(struct obd_ioctl_data
*data
,
166 struct lustre_handle
*conn
)
168 data
->ioc_cookie
= conn
->cookie
;
171 int class_resolve_dev_name(__u32 len
, const char *name
)
177 CERROR("No name passed,!\n");
181 if (name
[len
- 1] != 0) {
182 CERROR("Name not nul terminated!\n");
187 CDEBUG(D_IOCTL
, "device name %s\n", name
);
188 dev
= class_name2dev(name
);
190 CDEBUG(D_IOCTL
, "No device for name %s!\n", name
);
195 CDEBUG(D_IOCTL
, "device name %s, dev %d\n", name
, dev
);
202 int class_handle_ioctl(unsigned int cmd
, unsigned long arg
)
205 struct obd_ioctl_data
*data
;
206 struct libcfs_debug_ioctl_data
*debug_data
;
207 struct obd_device
*obd
= NULL
;
208 int err
= 0, len
= 0;
210 /* only for debugging */
211 if (cmd
== LIBCFS_IOC_DEBUG_MASK
) {
212 debug_data
= (struct libcfs_debug_ioctl_data
*)arg
;
213 libcfs_subsystem_debug
= debug_data
->subs
;
214 libcfs_debug
= debug_data
->debug
;
218 CDEBUG(D_IOCTL
, "cmd = %x\n", cmd
);
219 if (obd_ioctl_getdata(&buf
, &len
, (void *)arg
)) {
220 CERROR("OBD ioctl: data error\n");
223 data
= (struct obd_ioctl_data
*)buf
;
226 case OBD_IOC_PROCESS_CFG
: {
227 struct lustre_cfg
*lcfg
;
229 if (!data
->ioc_plen1
|| !data
->ioc_pbuf1
) {
230 CERROR("No config buffer passed!\n");
234 OBD_ALLOC(lcfg
, data
->ioc_plen1
);
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");
257 if (strlen(BUILD_VERSION
) + 1 > data
->ioc_inllen1
) {
258 CERROR("ioctl buffer too small to hold version\n");
263 memcpy(data
->ioc_bulk
, BUILD_VERSION
,
264 strlen(BUILD_VERSION
) + 1);
266 err
= obd_ioctl_popdata((void *)arg
, data
, len
);
271 case OBD_IOC_NAME2DEV
: {
272 /* Resolve a device name. This does not change the
273 * currently selected device.
277 dev
= class_resolve_dev_name(data
->ioc_inllen1
,
285 err
= obd_ioctl_popdata((void *)arg
, data
, sizeof(*data
));
291 case OBD_IOC_UUID2DEV
: {
292 /* Resolve a device uuid. This does not change the
293 * currently selected device.
296 struct obd_uuid uuid
;
298 if (!data
->ioc_inllen1
|| !data
->ioc_inlbuf1
) {
299 CERROR("No UUID passed!\n");
303 if (data
->ioc_inlbuf1
[data
->ioc_inllen1
- 1] != 0) {
304 CERROR("UUID not NUL terminated!\n");
309 CDEBUG(D_IOCTL
, "device name %s\n", data
->ioc_inlbuf1
);
310 obd_str2uuid(&uuid
, data
->ioc_inlbuf1
);
311 dev
= class_uuid2dev(&uuid
);
314 CDEBUG(D_IOCTL
, "No device for UUID %s!\n",
320 CDEBUG(D_IOCTL
, "device name %s, dev %d\n", data
->ioc_inlbuf1
,
322 err
= obd_ioctl_popdata((void *)arg
, data
, sizeof(*data
));
328 case OBD_IOC_CLOSE_UUID
: {
329 CDEBUG(D_IOCTL
, "closing all connections to uuid %s (NOOP)\n",
335 case OBD_IOC_GETDEVICE
: {
336 int index
= data
->ioc_count
;
339 if (!data
->ioc_inlbuf1
) {
340 CERROR("No buffer passed in ioctl\n");
344 if (data
->ioc_inllen1
< 128) {
345 CERROR("ioctl buffer too small to hold version\n");
350 obd
= class_num2obd(index
);
356 if (obd
->obd_stopping
)
358 else if (obd
->obd_set_up
)
360 else if (obd
->obd_attached
)
364 str
= (char *)data
->ioc_bulk
;
365 snprintf(str
, len
- sizeof(*data
), "%3d %s %s %s %s %d",
366 (int)index
, status
, obd
->obd_type
->typ_name
,
367 obd
->obd_name
, obd
->obd_uuid
.uuid
,
368 atomic_read(&obd
->obd_refcount
));
369 err
= obd_ioctl_popdata((void *)arg
, data
, len
);
377 if (data
->ioc_dev
== OBD_DEV_BY_DEVNAME
) {
378 if (data
->ioc_inllen4
<= 0 || data
->ioc_inlbuf4
== NULL
) {
382 if (strnlen(data
->ioc_inlbuf4
, MAX_OBD_NAME
) >= MAX_OBD_NAME
) {
386 obd
= class_name2obd(data
->ioc_inlbuf4
);
387 } else if (data
->ioc_dev
< class_devno_max()) {
388 obd
= class_num2obd(data
->ioc_dev
);
390 CERROR("OBD ioctl: No device\n");
396 CERROR("OBD ioctl : No Device %d\n", data
->ioc_dev
);
400 LASSERT(obd
->obd_magic
== OBD_DEVICE_MAGIC
);
402 if (!obd
->obd_set_up
|| obd
->obd_stopping
) {
403 CERROR("OBD ioctl: device not setup %d\n", data
->ioc_dev
);
409 case OBD_IOC_NO_TRANSNO
: {
410 if (!obd
->obd_attached
) {
411 CERROR("Device %d not attached\n", obd
->obd_minor
);
415 CDEBUG(D_HA
, "%s: disabling committed-transno notification\n",
417 obd
->obd_no_transno
= 1;
423 err
= obd_iocontrol(cmd
, obd
->obd_self_export
, len
, data
, NULL
);
427 err
= obd_ioctl_popdata((void *)arg
, data
, len
);
436 obd_ioctl_freedata(buf
, len
);
438 } /* class_handle_ioctl */
440 extern struct miscdevice obd_psdev
;
442 #define OBD_INIT_CHECK
443 int obd_init_checks(void)
445 __u64 u64val
, div64val
;
449 CDEBUG(D_INFO
, "LPU64=%s, LPD64=%s, LPX64=%s\n", "%llu", "%lld", "%#llx");
451 CDEBUG(D_INFO
, "OBD_OBJECT_EOF = %#llx\n", (__u64
)OBD_OBJECT_EOF
);
453 u64val
= OBD_OBJECT_EOF
;
454 CDEBUG(D_INFO
, "u64val OBD_OBJECT_EOF = %#llx\n", u64val
);
455 if (u64val
!= OBD_OBJECT_EOF
) {
456 CERROR("__u64 %#llx(%d) != 0xffffffffffffffff\n",
457 u64val
, (int)sizeof(u64val
));
460 len
= snprintf(buf
, sizeof(buf
), "%#llx", u64val
);
462 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf
, len
);
466 div64val
= OBD_OBJECT_EOF
;
467 CDEBUG(D_INFO
, "u64val OBD_OBJECT_EOF = %#llx\n", u64val
);
468 if (u64val
!= OBD_OBJECT_EOF
) {
469 CERROR("__u64 %#llx(%d) != 0xffffffffffffffff\n",
470 u64val
, (int)sizeof(u64val
));
473 if (u64val
>> 8 != OBD_OBJECT_EOF
>> 8) {
474 CERROR("__u64 %#llx(%d) != 0xffffffffffffffff\n",
475 u64val
, (int)sizeof(u64val
));
478 if (do_div(div64val
, 256) != (u64val
& 255)) {
479 CERROR("do_div(%#llx,256) != %llu\n", u64val
, u64val
&255);
482 if (u64val
>> 8 != div64val
) {
483 CERROR("do_div(%#llx,256) %llu != %llu\n",
484 u64val
, div64val
, u64val
>> 8);
487 len
= snprintf(buf
, sizeof(buf
), "%#llx", u64val
);
489 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf
, len
);
492 len
= snprintf(buf
, sizeof(buf
), "%llu", u64val
);
494 CWARN("LPU64 wrong length! strlen(%s)=%d != 20\n", buf
, len
);
497 len
= snprintf(buf
, sizeof(buf
), "%lld", u64val
);
499 CWARN("LPD64 wrong length! strlen(%s)=%d != 2\n", buf
, len
);
502 if ((u64val
& ~CFS_PAGE_MASK
) >= PAGE_CACHE_SIZE
) {
503 CWARN("mask failed: u64val %llu >= %llu\n", u64val
,
504 (__u64
)PAGE_CACHE_SIZE
);
511 extern spinlock_t obd_types_lock
;
512 #if defined (CONFIG_PROC_FS)
513 extern int class_procfs_init(void);
514 extern int class_procfs_clean(void);
516 static inline int class_procfs_init(void)
518 static inline int class_procfs_clean(void)
522 static int __init
init_obdclass(void)
525 int lustre_register_fs(void);
527 for (i
= CAPA_SITE_CLIENT
; i
< CAPA_SITE_MAX
; i
++)
528 INIT_LIST_HEAD(&capa_list
[i
]);
530 LCONSOLE_INFO("Lustre: Build Version: "BUILD_VERSION
"\n");
532 spin_lock_init(&obd_types_lock
);
533 obd_zombie_impexp_init();
535 if (IS_ENABLED(CONFIG_PROC_FS
)) {
536 obd_memory
= lprocfs_alloc_stats(OBD_STATS_NUM
,
537 LPROCFS_STATS_FLAG_NONE
|
538 LPROCFS_STATS_FLAG_IRQ_SAFE
);
540 if (obd_memory
== NULL
) {
541 CERROR("kmalloc of 'obd_memory' failed\n");
545 lprocfs_counter_init(obd_memory
, OBD_MEMORY_STAT
,
546 LPROCFS_CNTR_AVGMINMAX
,
548 lprocfs_counter_init(obd_memory
, OBD_MEMORY_PAGES_STAT
,
549 LPROCFS_CNTR_AVGMINMAX
,
550 "pagesused", "pages");
553 err
= obd_init_checks();
554 if (err
== -EOVERFLOW
)
557 class_init_uuidlist();
558 err
= class_handle_init();
562 INIT_LIST_HEAD(&obd_types
);
564 err
= misc_register(&obd_psdev
);
566 CERROR("cannot register %d err %d\n", OBD_DEV_MINOR
, err
);
570 /* This struct is already zeroed for us (static global) */
571 for (i
= 0; i
< class_devno_max(); i
++)
574 /* Default the dirty page cache cap to 1/2 of system memory.
575 * For clients with less memory, a larger fraction is needed
576 * for other purposes (mostly for BGL). */
577 if (totalram_pages
<= 512 << (20 - PAGE_CACHE_SHIFT
))
578 obd_max_dirty_pages
= totalram_pages
/ 4;
580 obd_max_dirty_pages
= totalram_pages
/ 2;
582 err
= obd_init_caches();
588 err
= class_procfs_init();
592 err
= lu_global_init();
596 err
= cl_global_init();
601 err
= llog_info_init();
605 err
= lustre_register_fs();
610 void obd_update_maxusage(void)
614 max1
= obd_pages_sum();
615 max2
= obd_memory_sum();
617 spin_lock(&obd_updatemax_lock
);
618 if (max1
> obd_max_pages
)
619 obd_max_pages
= max1
;
620 if (max2
> obd_max_alloc
)
621 obd_max_alloc
= max2
;
622 spin_unlock(&obd_updatemax_lock
);
624 EXPORT_SYMBOL(obd_update_maxusage
);
626 #if defined (CONFIG_PROC_FS)
627 __u64
obd_memory_max(void)
631 spin_lock(&obd_updatemax_lock
);
633 spin_unlock(&obd_updatemax_lock
);
637 EXPORT_SYMBOL(obd_memory_max
);
639 __u64
obd_pages_max(void)
643 spin_lock(&obd_updatemax_lock
);
645 spin_unlock(&obd_updatemax_lock
);
649 EXPORT_SYMBOL(obd_pages_max
);
652 /* liblustre doesn't call cleanup_obdclass, apparently. we carry on in this
653 * ifdef to the end of the file to cover module and versioning goo.*/
654 static void cleanup_obdclass(void)
657 int lustre_unregister_fs(void);
658 __u64 memory_leaked
, pages_leaked
;
659 __u64 memory_max
, pages_max
;
661 lustre_unregister_fs();
663 misc_deregister(&obd_psdev
);
664 for (i
= 0; i
< class_devno_max(); i
++) {
665 struct obd_device
*obd
= class_num2obd(i
);
666 if (obd
&& obd
->obd_set_up
&&
667 OBT(obd
) && OBP(obd
, detach
)) {
668 /* XXX should this call generic detach otherwise? */
669 LASSERT(obd
->obd_magic
== OBD_DEVICE_MAGIC
);
670 OBP(obd
, detach
)(obd
);
677 obd_cleanup_caches();
680 class_procfs_clean();
682 class_handle_cleanup();
683 class_exit_uuidlist();
684 obd_zombie_impexp_stop();
686 memory_leaked
= obd_memory_sum();
687 pages_leaked
= obd_pages_sum();
689 memory_max
= obd_memory_max();
690 pages_max
= obd_pages_max();
692 lprocfs_free_stats(&obd_memory
);
693 CDEBUG((memory_leaked
) ? D_ERROR
: D_INFO
,
694 "obd_memory max: %llu, leaked: %llu\n",
695 memory_max
, memory_leaked
);
696 CDEBUG((pages_leaked
) ? D_ERROR
: D_INFO
,
697 "obd_memory_pages max: %llu, leaked: %llu\n",
698 pages_max
, pages_leaked
);
701 MODULE_AUTHOR("Sun Microsystems, Inc. <http://www.lustre.org/>");
702 MODULE_DESCRIPTION("Lustre Class Driver Build Version: " BUILD_VERSION
);
703 MODULE_LICENSE("GPL");
704 MODULE_VERSION(LUSTRE_VERSION_STRING
);
706 module_init(init_obdclass
);
707 module_exit(cleanup_obdclass
);