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, 2015, 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 <linux/list.h>
46 #include "../include/cl_object.h"
47 #include "llog_internal.h"
49 struct obd_device
*obd_devs
[MAX_OBD_DEVICES
];
50 EXPORT_SYMBOL(obd_devs
);
51 struct list_head obd_types
;
52 DEFINE_RWLOCK(obd_dev_lock
);
54 /* The following are visible and mutable through /sys/fs/lustre. */
55 unsigned int obd_debug_peer_on_timeout
;
56 EXPORT_SYMBOL(obd_debug_peer_on_timeout
);
57 unsigned int obd_dump_on_timeout
;
58 EXPORT_SYMBOL(obd_dump_on_timeout
);
59 unsigned int obd_dump_on_eviction
;
60 EXPORT_SYMBOL(obd_dump_on_eviction
);
61 unsigned int obd_max_dirty_pages
= 256;
62 EXPORT_SYMBOL(obd_max_dirty_pages
);
63 atomic_t obd_dirty_pages
;
64 EXPORT_SYMBOL(obd_dirty_pages
);
65 unsigned int obd_timeout
= OBD_TIMEOUT_DEFAULT
; /* seconds */
66 EXPORT_SYMBOL(obd_timeout
);
67 unsigned int obd_timeout_set
;
68 EXPORT_SYMBOL(obd_timeout_set
);
69 /* Adaptive timeout defs here instead of ptlrpc module for /sys/fs/ access */
71 EXPORT_SYMBOL(at_min
);
72 unsigned int at_max
= 600;
73 EXPORT_SYMBOL(at_max
);
74 unsigned int at_history
= 600;
75 EXPORT_SYMBOL(at_history
);
76 int at_early_margin
= 5;
77 EXPORT_SYMBOL(at_early_margin
);
79 EXPORT_SYMBOL(at_extra
);
81 atomic_t obd_dirty_transit_pages
;
82 EXPORT_SYMBOL(obd_dirty_transit_pages
);
84 char obd_jobid_var
[JOBSTATS_JOBID_VAR_MAX_LEN
+ 1] = JOBSTATS_DISABLE
;
85 EXPORT_SYMBOL(obd_jobid_var
);
87 char obd_jobid_node
[JOBSTATS_JOBID_SIZE
+ 1];
89 /* Get jobid of current process from stored variable or calculate
90 * it from pid and user_id.
92 * Historically this was also done by reading the environment variable
93 * stored in between the "env_start" & "env_end" of task struct.
94 * This is now deprecated.
96 int lustre_get_jobid(char *jobid
)
98 memset(jobid
, 0, JOBSTATS_JOBID_SIZE
);
99 /* Jobstats isn't enabled */
100 if (strcmp(obd_jobid_var
, JOBSTATS_DISABLE
) == 0)
103 /* Use process name + fsuid as jobid */
104 if (strcmp(obd_jobid_var
, JOBSTATS_PROCNAME_UID
) == 0) {
105 snprintf(jobid
, JOBSTATS_JOBID_SIZE
, "%s.%u",
107 from_kuid(&init_user_ns
, current_fsuid()));
111 /* Whole node dedicated to single job */
112 if (strcmp(obd_jobid_var
, JOBSTATS_NODELOCAL
) == 0) {
113 strcpy(jobid
, obd_jobid_node
);
119 EXPORT_SYMBOL(lustre_get_jobid
);
121 static inline void obd_data2conn(struct lustre_handle
*conn
,
122 struct obd_ioctl_data
*data
)
124 memset(conn
, 0, sizeof(*conn
));
125 conn
->cookie
= data
->ioc_cookie
;
128 static inline void obd_conn2data(struct obd_ioctl_data
*data
,
129 struct lustre_handle
*conn
)
131 data
->ioc_cookie
= conn
->cookie
;
134 static int class_resolve_dev_name(__u32 len
, const char *name
)
140 CERROR("No name passed,!\n");
144 if (name
[len
- 1] != 0) {
145 CERROR("Name not nul terminated!\n");
150 CDEBUG(D_IOCTL
, "device name %s\n", name
);
151 dev
= class_name2dev(name
);
153 CDEBUG(D_IOCTL
, "No device for name %s!\n", name
);
158 CDEBUG(D_IOCTL
, "device name %s, dev %d\n", name
, dev
);
165 int class_handle_ioctl(unsigned int cmd
, unsigned long arg
)
168 struct obd_ioctl_data
*data
;
169 struct libcfs_debug_ioctl_data
*debug_data
;
170 struct obd_device
*obd
= NULL
;
171 int err
= 0, len
= 0;
173 /* only for debugging */
174 if (cmd
== LIBCFS_IOC_DEBUG_MASK
) {
175 debug_data
= (struct libcfs_debug_ioctl_data
*)arg
;
176 libcfs_subsystem_debug
= debug_data
->subs
;
177 libcfs_debug
= debug_data
->debug
;
181 CDEBUG(D_IOCTL
, "cmd = %x\n", cmd
);
182 if (obd_ioctl_getdata(&buf
, &len
, (void __user
*)arg
)) {
183 CERROR("OBD ioctl: data error\n");
186 data
= (struct obd_ioctl_data
*)buf
;
189 case OBD_IOC_PROCESS_CFG
: {
190 struct lustre_cfg
*lcfg
;
192 if (!data
->ioc_plen1
|| !data
->ioc_pbuf1
) {
193 CERROR("No config buffer passed!\n");
197 lcfg
= kzalloc(data
->ioc_plen1
, GFP_NOFS
);
202 err
= copy_from_user(lcfg
, data
->ioc_pbuf1
, data
->ioc_plen1
);
204 err
= lustre_cfg_sanity_check(lcfg
, data
->ioc_plen1
);
206 err
= class_process_config(lcfg
);
212 case OBD_GET_VERSION
:
213 if (!data
->ioc_inlbuf1
) {
214 CERROR("No buffer passed in ioctl\n");
219 if (strlen(LUSTRE_VERSION_STRING
) + 1 > data
->ioc_inllen1
) {
220 CERROR("ioctl buffer too small to hold version\n");
225 memcpy(data
->ioc_bulk
, LUSTRE_VERSION_STRING
,
226 strlen(LUSTRE_VERSION_STRING
) + 1);
228 err
= obd_ioctl_popdata((void __user
*)arg
, data
, len
);
233 case OBD_IOC_NAME2DEV
: {
234 /* Resolve a device name. This does not change the
235 * currently selected device.
239 dev
= class_resolve_dev_name(data
->ioc_inllen1
,
247 err
= obd_ioctl_popdata((void __user
*)arg
, data
,
254 case OBD_IOC_UUID2DEV
: {
255 /* Resolve a device uuid. This does not change the
256 * currently selected device.
259 struct obd_uuid uuid
;
261 if (!data
->ioc_inllen1
|| !data
->ioc_inlbuf1
) {
262 CERROR("No UUID passed!\n");
266 if (data
->ioc_inlbuf1
[data
->ioc_inllen1
- 1] != 0) {
267 CERROR("UUID not NUL terminated!\n");
272 CDEBUG(D_IOCTL
, "device name %s\n", data
->ioc_inlbuf1
);
273 obd_str2uuid(&uuid
, data
->ioc_inlbuf1
);
274 dev
= class_uuid2dev(&uuid
);
277 CDEBUG(D_IOCTL
, "No device for UUID %s!\n",
283 CDEBUG(D_IOCTL
, "device name %s, dev %d\n", data
->ioc_inlbuf1
,
285 err
= obd_ioctl_popdata((void __user
*)arg
, data
,
292 case OBD_IOC_CLOSE_UUID
: {
293 CDEBUG(D_IOCTL
, "closing all connections to uuid %s (NOOP)\n",
299 case OBD_IOC_GETDEVICE
: {
300 int index
= data
->ioc_count
;
303 if (!data
->ioc_inlbuf1
) {
304 CERROR("No buffer passed in ioctl\n");
308 if (data
->ioc_inllen1
< 128) {
309 CERROR("ioctl buffer too small to hold version\n");
314 obd
= class_num2obd(index
);
320 if (obd
->obd_stopping
)
322 else if (obd
->obd_set_up
)
324 else if (obd
->obd_attached
)
328 str
= (char *)data
->ioc_bulk
;
329 snprintf(str
, len
- sizeof(*data
), "%3d %s %s %s %s %d",
330 (int)index
, status
, obd
->obd_type
->typ_name
,
331 obd
->obd_name
, obd
->obd_uuid
.uuid
,
332 atomic_read(&obd
->obd_refcount
));
333 err
= obd_ioctl_popdata((void __user
*)arg
, data
, len
);
341 if (data
->ioc_dev
== OBD_DEV_BY_DEVNAME
) {
342 if (data
->ioc_inllen4
<= 0 || !data
->ioc_inlbuf4
) {
346 if (strnlen(data
->ioc_inlbuf4
, MAX_OBD_NAME
) >= MAX_OBD_NAME
) {
350 obd
= class_name2obd(data
->ioc_inlbuf4
);
351 } else if (data
->ioc_dev
< class_devno_max()) {
352 obd
= class_num2obd(data
->ioc_dev
);
354 CERROR("OBD ioctl: No device\n");
360 CERROR("OBD ioctl : No Device %d\n", data
->ioc_dev
);
364 LASSERT(obd
->obd_magic
== OBD_DEVICE_MAGIC
);
366 if (!obd
->obd_set_up
|| obd
->obd_stopping
) {
367 CERROR("OBD ioctl: device not setup %d\n", data
->ioc_dev
);
373 case OBD_IOC_NO_TRANSNO
: {
374 if (!obd
->obd_attached
) {
375 CERROR("Device %d not attached\n", obd
->obd_minor
);
379 CDEBUG(D_HA
, "%s: disabling committed-transno notification\n",
381 obd
->obd_no_transno
= 1;
387 err
= obd_iocontrol(cmd
, obd
->obd_self_export
, len
, data
, NULL
);
391 err
= obd_ioctl_popdata((void __user
*)arg
, data
, len
);
400 obd_ioctl_freedata(buf
, len
);
402 } /* class_handle_ioctl */
404 #define OBD_INIT_CHECK
405 static int obd_init_checks(void)
407 __u64 u64val
, div64val
;
411 CDEBUG(D_INFO
, "LPU64=%s, LPD64=%s, LPX64=%s\n", "%llu", "%lld", "%#llx");
413 CDEBUG(D_INFO
, "OBD_OBJECT_EOF = %#llx\n", (__u64
)OBD_OBJECT_EOF
);
415 u64val
= OBD_OBJECT_EOF
;
416 CDEBUG(D_INFO
, "u64val OBD_OBJECT_EOF = %#llx\n", u64val
);
417 if (u64val
!= OBD_OBJECT_EOF
) {
418 CERROR("__u64 %#llx(%d) != 0xffffffffffffffff\n",
419 u64val
, (int)sizeof(u64val
));
422 len
= snprintf(buf
, sizeof(buf
), "%#llx", u64val
);
424 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf
, len
);
428 div64val
= OBD_OBJECT_EOF
;
429 CDEBUG(D_INFO
, "u64val OBD_OBJECT_EOF = %#llx\n", u64val
);
430 if (u64val
!= OBD_OBJECT_EOF
) {
431 CERROR("__u64 %#llx(%d) != 0xffffffffffffffff\n",
432 u64val
, (int)sizeof(u64val
));
435 if (u64val
>> 8 != OBD_OBJECT_EOF
>> 8) {
436 CERROR("__u64 %#llx(%d) != 0xffffffffffffffff\n",
437 u64val
, (int)sizeof(u64val
));
440 if (do_div(div64val
, 256) != (u64val
& 255)) {
441 CERROR("do_div(%#llx,256) != %llu\n", u64val
, u64val
& 255);
444 if (u64val
>> 8 != div64val
) {
445 CERROR("do_div(%#llx,256) %llu != %llu\n",
446 u64val
, div64val
, u64val
>> 8);
449 len
= snprintf(buf
, sizeof(buf
), "%#llx", u64val
);
451 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf
, len
);
454 len
= snprintf(buf
, sizeof(buf
), "%llu", u64val
);
456 CWARN("LPU64 wrong length! strlen(%s)=%d != 20\n", buf
, len
);
459 len
= snprintf(buf
, sizeof(buf
), "%lld", u64val
);
461 CWARN("LPD64 wrong length! strlen(%s)=%d != 2\n", buf
, len
);
464 if ((u64val
& ~CFS_PAGE_MASK
) >= PAGE_SIZE
) {
465 CWARN("mask failed: u64val %llu >= %llu\n", u64val
,
473 extern int class_procfs_init(void);
474 extern int class_procfs_clean(void);
476 static int __init
obdclass_init(void)
480 int lustre_register_fs(void);
482 LCONSOLE_INFO("Lustre: Build Version: " LUSTRE_VERSION_STRING
"\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).
512 if (totalram_pages
<= 512 << (20 - PAGE_SHIFT
))
513 obd_max_dirty_pages
= totalram_pages
/ 4;
515 obd_max_dirty_pages
= totalram_pages
/ 2;
517 err
= obd_init_caches();
521 err
= class_procfs_init();
525 err
= obd_sysctl_init();
529 err
= lu_global_init();
533 err
= cl_global_init();
537 err
= llog_info_init();
541 err
= lustre_register_fs();
546 static void obdclass_exit(void)
550 int lustre_unregister_fs(void);
552 lustre_unregister_fs();
554 misc_deregister(&obd_psdev
);
555 for (i
= 0; i
< class_devno_max(); i
++) {
556 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("OpenSFS, Inc. <http://www.lustre.org/>");
579 MODULE_DESCRIPTION("Lustre Class Driver");
580 MODULE_VERSION(LUSTRE_VERSION_STRING
);
581 MODULE_LICENSE("GPL");
583 module_init(obdclass_init
);
584 module_exit(obdclass_exit
);