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
39 # include <liblustre.h>
41 # include <asm/atomic.h>
44 #include <obd_support.h>
45 #include <obd_class.h>
46 #include <lnet/lnetctl.h>
47 #include <lustre_debug.h>
48 #include <lprocfs_status.h>
49 #include <lustre/lustre_build_version.h>
50 #include <libcfs/list.h>
51 #include <cl_object.h>
52 #ifdef HAVE_SERVER_SUPPORT
53 # include <dt_object.h>
54 # include <md_object.h>
55 #endif /* HAVE_SERVER_SUPPORT */
56 #include <lustre_ioctl.h>
57 #include "llog_internal.h"
60 /* liblustre workaround */
61 atomic_t libcfs_kmemory = {0};
64 struct obd_device *obd_devs[MAX_OBD_DEVICES];
65 EXPORT_SYMBOL(obd_devs);
67 DEFINE_RWLOCK(obd_dev_lock);
69 __u64 obd_max_pages = 0;
70 __u64 obd_max_alloc = 0;
75 DEFINE_SPINLOCK(obd_updatemax_lock);
77 /* The following are visible and mutable through /proc/sys/lustre/. */
78 unsigned int obd_alloc_fail_rate = 0;
79 EXPORT_SYMBOL(obd_alloc_fail_rate);
80 unsigned int obd_debug_peer_on_timeout;
81 EXPORT_SYMBOL(obd_debug_peer_on_timeout);
82 unsigned int obd_dump_on_timeout;
83 EXPORT_SYMBOL(obd_dump_on_timeout);
84 unsigned int obd_dump_on_eviction;
85 EXPORT_SYMBOL(obd_dump_on_eviction);
86 unsigned int obd_max_dirty_pages = 256;
87 EXPORT_SYMBOL(obd_max_dirty_pages);
88 atomic_t obd_unstable_pages;
89 EXPORT_SYMBOL(obd_unstable_pages);
90 atomic_t obd_dirty_pages;
91 EXPORT_SYMBOL(obd_dirty_pages);
92 unsigned int obd_timeout = OBD_TIMEOUT_DEFAULT; /* seconds */
93 EXPORT_SYMBOL(obd_timeout);
94 unsigned int ldlm_timeout = LDLM_TIMEOUT_DEFAULT; /* seconds */
95 EXPORT_SYMBOL(ldlm_timeout);
96 unsigned int obd_timeout_set;
97 EXPORT_SYMBOL(obd_timeout_set);
98 unsigned int ldlm_timeout_set;
99 EXPORT_SYMBOL(ldlm_timeout_set);
100 /* Adaptive timeout defs here instead of ptlrpc module for /proc/sys/ access */
101 unsigned int at_min = 0;
102 EXPORT_SYMBOL(at_min);
103 unsigned int at_max = 600;
104 EXPORT_SYMBOL(at_max);
105 unsigned int at_history = 600;
106 EXPORT_SYMBOL(at_history);
107 int at_early_margin = 5;
108 EXPORT_SYMBOL(at_early_margin);
110 EXPORT_SYMBOL(at_extra);
112 atomic_t obd_dirty_transit_pages;
113 EXPORT_SYMBOL(obd_dirty_transit_pages);
115 char obd_jobid_var[JOBSTATS_JOBID_VAR_MAX_LEN + 1] = JOBSTATS_DISABLE;
116 EXPORT_SYMBOL(obd_jobid_var);
119 struct lprocfs_stats *obd_memory = NULL;
120 EXPORT_SYMBOL(obd_memory);
123 /* Get jobid of current process by reading the environment variable
124 * stored in between the "env_start" & "env_end" of task struct.
127 * It's better to cache the jobid for later use if there is any
128 * efficient way, the cl_env code probably could be reused for this
131 * If some job scheduler doesn't store jobid in the "env_start/end",
132 * then an upcall could be issued here to get the jobid by utilizing
133 * the userspace tools/api. Then, the jobid must be cached.
135 int lustre_get_jobid(char *jobid)
137 int jobid_len = JOBSTATS_JOBID_SIZE;
141 memset(jobid, 0, JOBSTATS_JOBID_SIZE);
142 /* Jobstats isn't enabled */
143 if (strcmp(obd_jobid_var, JOBSTATS_DISABLE) == 0)
146 /* Use process name + fsuid as jobid */
147 if (strcmp(obd_jobid_var, JOBSTATS_PROCNAME_UID) == 0) {
148 snprintf(jobid, JOBSTATS_JOBID_SIZE, "%s.%u",
150 from_kuid(&init_user_ns, current_fsuid()));
154 rc = cfs_get_environ(obd_jobid_var, jobid, &jobid_len);
156 if (rc == -EOVERFLOW) {
157 /* For the PBS_JOBID and LOADL_STEP_ID keys (which are
158 * variable length strings instead of just numbers), it
159 * might make sense to keep the unique parts for JobID,
160 * instead of just returning an error. That means a
161 * larger temp buffer for cfs_get_environ(), then
162 * truncating the string at some separator to fit into
163 * the specified jobid_len. Fix later if needed. */
165 if (unlikely(!printed)) {
166 LCONSOLE_ERROR_MSG(0x16b, "%s value too large "
167 "for JobID buffer (%d)\n",
168 obd_jobid_var, jobid_len);
172 CDEBUG((rc == -ENOENT || rc == -EINVAL ||
173 rc == -EDEADLK) ? D_INFO : D_ERROR,
174 "Get jobid for (%s) failed: rc = %d\n",
180 EXPORT_SYMBOL(lustre_get_jobid);
182 int obd_alloc_fail(const void *ptr, const char *name, const char *type,
183 size_t size, const char *file, int line)
186 (cfs_rand() & OBD_ALLOC_FAIL_MASK) < obd_alloc_fail_rate) {
187 CERROR("%s%salloc of %s ("LPU64" bytes) failed at %s:%d\n",
188 ptr ? "force " :"", type, name, (__u64)size, file,
190 CERROR(LPU64" total bytes and "LPU64" total pages "
191 "("LPU64" bytes) allocated by Lustre, "
192 "%d total bytes by LNET\n",
194 obd_pages_sum() << PAGE_CACHE_SHIFT,
196 atomic_read(&libcfs_kmemory));
201 EXPORT_SYMBOL(obd_alloc_fail);
203 static inline void obd_data2conn(struct lustre_handle *conn,
204 struct obd_ioctl_data *data)
206 memset(conn, 0, sizeof *conn);
207 conn->cookie = data->ioc_cookie;
210 static inline void obd_conn2data(struct obd_ioctl_data *data,
211 struct lustre_handle *conn)
213 data->ioc_cookie = conn->cookie;
216 int class_resolve_dev_name(__u32 len, const char *name)
223 CERROR("No name passed,!\n");
224 GOTO(out, rc = -EINVAL);
226 if (name[len - 1] != 0) {
227 CERROR("Name not nul terminated!\n");
228 GOTO(out, rc = -EINVAL);
231 CDEBUG(D_IOCTL, "device name %s\n", name);
232 dev = class_name2dev(name);
234 CDEBUG(D_IOCTL, "No device for name %s!\n", name);
235 GOTO(out, rc = -EINVAL);
238 CDEBUG(D_IOCTL, "device name %s, dev %d\n", name, dev);
245 int class_handle_ioctl(unsigned int cmd, unsigned long arg)
248 struct obd_ioctl_data *data;
249 struct libcfs_debug_ioctl_data *debug_data;
250 struct obd_device *obd = NULL;
251 int err = 0, len = 0;
254 /* only for debugging */
255 if (cmd == LIBCFS_IOC_DEBUG_MASK) {
256 debug_data = (struct libcfs_debug_ioctl_data*)arg;
257 libcfs_subsystem_debug = debug_data->subs;
258 libcfs_debug = debug_data->debug;
262 CDEBUG(D_IOCTL, "cmd = %x\n", cmd);
263 if (obd_ioctl_getdata(&buf, &len, (void *)arg)) {
264 CERROR("OBD ioctl: data error\n");
267 data = (struct obd_ioctl_data *)buf;
270 case OBD_IOC_PROCESS_CFG: {
271 struct lustre_cfg *lcfg;
273 if (!data->ioc_plen1 || !data->ioc_pbuf1) {
274 CERROR("No config buffer passed!\n");
275 GOTO(out, err = -EINVAL);
277 OBD_ALLOC(lcfg, data->ioc_plen1);
279 GOTO(out, err = -ENOMEM);
280 err = copy_from_user(lcfg, data->ioc_pbuf1,
283 err = lustre_cfg_sanity_check(lcfg, data->ioc_plen1);
285 err = class_process_config(lcfg);
287 OBD_FREE(lcfg, data->ioc_plen1);
291 case OBD_GET_VERSION:
292 if (!data->ioc_inlbuf1) {
293 CERROR("No buffer passed in ioctl\n");
294 GOTO(out, err = -EINVAL);
297 if (strlen(BUILD_VERSION) + 1 > data->ioc_inllen1) {
298 CERROR("ioctl buffer too small to hold version\n");
299 GOTO(out, err = -EINVAL);
302 memcpy(data->ioc_bulk, BUILD_VERSION,
303 strlen(BUILD_VERSION) + 1);
305 err = obd_ioctl_popdata((void *)arg, data, len);
310 case OBD_IOC_NAME2DEV: {
311 /* Resolve a device name. This does not change the
312 * currently selected device.
316 dev = class_resolve_dev_name(data->ioc_inllen1,
320 GOTO(out, err = -EINVAL);
322 err = obd_ioctl_popdata((void *)arg, data, sizeof(*data));
328 case OBD_IOC_UUID2DEV: {
329 /* Resolve a device uuid. This does not change the
330 * currently selected device.
333 struct obd_uuid uuid;
335 if (!data->ioc_inllen1 || !data->ioc_inlbuf1) {
336 CERROR("No UUID passed!\n");
337 GOTO(out, err = -EINVAL);
339 if (data->ioc_inlbuf1[data->ioc_inllen1 - 1] != 0) {
340 CERROR("UUID not NUL terminated!\n");
341 GOTO(out, err = -EINVAL);
344 CDEBUG(D_IOCTL, "device name %s\n", data->ioc_inlbuf1);
345 obd_str2uuid(&uuid, data->ioc_inlbuf1);
346 dev = class_uuid2dev(&uuid);
349 CDEBUG(D_IOCTL, "No device for UUID %s!\n",
351 GOTO(out, err = -EINVAL);
354 CDEBUG(D_IOCTL, "device name %s, dev %d\n", data->ioc_inlbuf1,
356 err = obd_ioctl_popdata((void *)arg, data, sizeof(*data));
362 case OBD_IOC_GETDEVICE: {
363 int index = data->ioc_count;
366 if (!data->ioc_inlbuf1) {
367 CERROR("No buffer passed in ioctl\n");
368 GOTO(out, err = -EINVAL);
370 if (data->ioc_inllen1 < 128) {
371 CERROR("ioctl buffer too small to hold version\n");
372 GOTO(out, err = -EINVAL);
375 obd = class_num2obd(index);
377 GOTO(out, err = -ENOENT);
379 if (obd->obd_stopping)
381 else if (obd->obd_set_up)
383 else if (obd->obd_attached)
387 str = (char *)data->ioc_bulk;
388 snprintf(str, len - sizeof(*data), "%3d %s %s %s %s %d",
389 (int)index, status, obd->obd_type->typ_name,
390 obd->obd_name, obd->obd_uuid.uuid,
391 atomic_read(&obd->obd_refcount));
392 err = obd_ioctl_popdata((void *)arg, data, len);
399 if (data->ioc_dev == OBD_DEV_BY_DEVNAME) {
400 if (data->ioc_inllen4 <= 0 || data->ioc_inlbuf4 == NULL)
401 GOTO(out, err = -EINVAL);
402 if (strnlen(data->ioc_inlbuf4, MAX_OBD_NAME) >= MAX_OBD_NAME)
403 GOTO(out, err = -EINVAL);
404 obd = class_name2obd(data->ioc_inlbuf4);
405 } else if (data->ioc_dev < class_devno_max()) {
406 obd = class_num2obd(data->ioc_dev);
408 CERROR("OBD ioctl: No device\n");
409 GOTO(out, err = -EINVAL);
413 CERROR("OBD ioctl : No Device %d\n", data->ioc_dev);
414 GOTO(out, err = -EINVAL);
416 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
418 if (!obd->obd_set_up || obd->obd_stopping) {
419 CERROR("OBD ioctl: device not setup %d \n", data->ioc_dev);
420 GOTO(out, err = -EINVAL);
424 case OBD_IOC_NO_TRANSNO: {
425 if (!obd->obd_attached) {
426 CERROR("Device %d not attached\n", obd->obd_minor);
427 GOTO(out, err = -ENODEV);
429 CDEBUG(D_HA, "%s: disabling committed-transno notification\n",
431 obd->obd_no_transno = 1;
436 err = obd_iocontrol(cmd, obd->obd_self_export, len, data, NULL);
440 err = obd_ioctl_popdata((void *)arg, data, len);
449 obd_ioctl_freedata(buf, len);
451 } /* class_handle_ioctl */
454 extern struct miscdevice obd_psdev;
456 struct miscdevice obd_psdev;
459 #define OBD_INIT_CHECK
460 #ifdef OBD_INIT_CHECK
461 int obd_init_checks(void)
463 __u64 u64val, div64val;
467 CDEBUG(D_INFO, "LPU64=%s, LPD64=%s, LPX64=%s\n", LPU64, LPD64, LPX64);
469 CDEBUG(D_INFO, "OBD_OBJECT_EOF = "LPX64"\n", (__u64)OBD_OBJECT_EOF);
471 u64val = OBD_OBJECT_EOF;
472 CDEBUG(D_INFO, "u64val OBD_OBJECT_EOF = "LPX64"\n", u64val);
473 if (u64val != OBD_OBJECT_EOF) {
474 CERROR("__u64 "LPX64"(%d) != 0xffffffffffffffff\n",
475 u64val, (int)sizeof(u64val));
478 len = snprintf(buf, sizeof(buf), LPX64, u64val);
480 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf, len);
484 div64val = OBD_OBJECT_EOF;
485 CDEBUG(D_INFO, "u64val OBD_OBJECT_EOF = "LPX64"\n", u64val);
486 if (u64val != OBD_OBJECT_EOF) {
487 CERROR("__u64 "LPX64"(%d) != 0xffffffffffffffff\n",
488 u64val, (int)sizeof(u64val));
491 if (u64val >> 8 != OBD_OBJECT_EOF >> 8) {
492 CERROR("__u64 "LPX64"(%d) != 0xffffffffffffffff\n",
493 u64val, (int)sizeof(u64val));
496 if (do_div(div64val, 256) != (u64val & 255)) {
497 CERROR("do_div("LPX64",256) != "LPU64"\n", u64val, u64val &255);
500 if (u64val >> 8 != div64val) {
501 CERROR("do_div("LPX64",256) "LPU64" != "LPU64"\n",
502 u64val, div64val, u64val >> 8);
505 len = snprintf(buf, sizeof(buf), LPX64, u64val);
507 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf, len);
510 len = snprintf(buf, sizeof(buf), LPU64, u64val);
512 CWARN("LPU64 wrong length! strlen(%s)=%d != 20\n", buf, len);
515 len = snprintf(buf, sizeof(buf), LPD64, u64val);
517 CWARN("LPD64 wrong length! strlen(%s)=%d != 2\n", buf, len);
520 if ((u64val & ~CFS_PAGE_MASK) >= PAGE_CACHE_SIZE) {
521 CWARN("mask failed: u64val "LPU64" >= "LPU64"\n", u64val,
522 (__u64)PAGE_CACHE_SIZE);
529 #define obd_init_checks() do {} while(0)
532 extern spinlock_t obd_types_lock;
533 extern int class_procfs_init(void);
534 extern int class_procfs_clean(void);
537 static int __init init_obdclass(void)
539 int init_obdclass(void)
544 int lustre_register_fs(void);
546 for (i = CAPA_SITE_CLIENT; i < CAPA_SITE_MAX; i++)
547 CFS_INIT_LIST_HEAD(&capa_list[i]);
550 LCONSOLE_INFO("Lustre: Build Version: "BUILD_VERSION"\n");
552 spin_lock_init(&obd_types_lock);
553 obd_zombie_impexp_init();
555 obd_memory = lprocfs_alloc_stats(OBD_STATS_NUM,
556 LPROCFS_STATS_FLAG_NONE |
557 LPROCFS_STATS_FLAG_IRQ_SAFE);
558 if (obd_memory == NULL) {
559 CERROR("kmalloc of 'obd_memory' failed\n");
563 lprocfs_counter_init(obd_memory, OBD_MEMORY_STAT,
564 LPROCFS_CNTR_AVGMINMAX,
566 lprocfs_counter_init(obd_memory, OBD_MEMORY_PAGES_STAT,
567 LPROCFS_CNTR_AVGMINMAX,
568 "pagesused", "pages");
570 err = obd_init_checks();
571 if (err == -EOVERFLOW)
574 class_init_uuidlist();
575 err = class_handle_init();
579 CFS_INIT_LIST_HEAD(&obd_types);
581 err = misc_register(&obd_psdev);
583 CERROR("cannot register %d err %d\n", OBD_DEV_MINOR, err);
587 /* This struct is already zeroed for us (static global) */
588 for (i = 0; i < class_devno_max(); i++)
591 /* Default the dirty page cache cap to 1/2 of system memory.
592 * For clients with less memory, a larger fraction is needed
593 * for other purposes (mostly for BGL). */
594 if (totalram_pages <= 512 << (20 - PAGE_CACHE_SHIFT))
595 obd_max_dirty_pages = totalram_pages / 4;
597 obd_max_dirty_pages = totalram_pages / 2;
599 err = obd_init_caches();
603 err = class_procfs_init();
608 err = lu_global_init();
612 err = lu_capainfo_init();
616 err = cl_global_init();
620 #if defined(__KERNEL__) && defined(HAVE_SERVER_SUPPORT)
621 err = dt_global_init();
625 err = lu_ucred_global_init();
630 err = llog_info_init();
635 err = lustre_register_fs();
641 void obd_update_maxusage(void)
645 max1 = obd_pages_sum();
646 max2 = obd_memory_sum();
648 spin_lock(&obd_updatemax_lock);
649 if (max1 > obd_max_pages)
650 obd_max_pages = max1;
651 if (max2 > obd_max_alloc)
652 obd_max_alloc = max2;
653 spin_unlock(&obd_updatemax_lock);
655 EXPORT_SYMBOL(obd_update_maxusage);
658 __u64 obd_memory_max(void)
662 spin_lock(&obd_updatemax_lock);
664 spin_unlock(&obd_updatemax_lock);
668 EXPORT_SYMBOL(obd_memory_max);
670 __u64 obd_pages_max(void)
674 spin_lock(&obd_updatemax_lock);
676 spin_unlock(&obd_updatemax_lock);
680 EXPORT_SYMBOL(obd_pages_max);
683 /* liblustre doesn't call cleanup_obdclass, apparently. we carry on in this
684 * ifdef to the end of the file to cover module and versioning goo.*/
686 static void cleanup_obdclass(void)
689 int lustre_unregister_fs(void);
690 __u64 memory_leaked, pages_leaked;
691 __u64 memory_max, pages_max;
694 lustre_unregister_fs();
696 misc_deregister(&obd_psdev);
697 for (i = 0; i < class_devno_max(); i++) {
698 struct obd_device *obd = class_num2obd(i);
699 if (obd && obd->obd_set_up &&
700 OBT(obd) && OBP(obd, detach)) {
701 /* XXX should this call generic detach otherwise? */
702 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
703 OBP(obd, detach)(obd);
707 #ifdef HAVE_SERVER_SUPPORT
708 lu_ucred_global_fini();
715 obd_cleanup_caches();
718 class_procfs_clean();
720 class_handle_cleanup();
721 class_exit_uuidlist();
722 obd_zombie_impexp_stop();
724 memory_leaked = obd_memory_sum();
725 pages_leaked = obd_pages_sum();
727 memory_max = obd_memory_max();
728 pages_max = obd_pages_max();
730 lprocfs_free_stats(&obd_memory);
731 CDEBUG((memory_leaked) ? D_ERROR : D_INFO,
732 "obd_memory max: "LPU64", leaked: "LPU64"\n",
733 memory_max, memory_leaked);
734 CDEBUG((pages_leaked) ? D_ERROR : D_INFO,
735 "obd_memory_pages max: "LPU64", leaked: "LPU64"\n",
736 pages_max, pages_leaked);
741 MODULE_AUTHOR("Sun Microsystems, Inc. <http://www.lustre.org/>");
742 MODULE_DESCRIPTION("Lustre Class Driver Build Version: " BUILD_VERSION);
743 MODULE_LICENSE("GPL");
745 cfs_module(obdclass, LUSTRE_VERSION_STRING, init_obdclass, cleanup_obdclass);