Whamcloud - gitweb
Introduction of lu_env.
[fs/lustre-release.git] / lustre / obdclass / class_obd.c
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * Object Devices Class Driver
5  *
6  *  Copyright (C) 2001-2003 Cluster File Systems, Inc.
7  *
8  *   This file is part of the Lustre file system, http://www.lustre.org
9  *   Lustre is a trademark of Cluster File Systems, Inc.
10  *
11  *   You may have signed or agreed to another license before downloading
12  *   this software.  If so, you are bound by the terms and conditions
13  *   of that agreement, and the following does not apply to you.  See the
14  *   LICENSE file included with this distribution for more information.
15  *
16  *   If you did not agree to a different license, then this copy of Lustre
17  *   is open source software; you can redistribute it and/or modify it
18  *   under the terms of version 2 of the GNU General Public License as
19  *   published by the Free Software Foundation.
20  *
21  *   In either case, Lustre is distributed in the hope that it will be
22  *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty
23  *   of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24  *   license text for more details.
25  *
26  * These are the only exported functions, they provide some generic
27  * infrastructure for managing object devices
28  */
29
30 #define DEBUG_SUBSYSTEM S_CLASS
31 #ifndef EXPORT_SYMTAB
32 # define EXPORT_SYMTAB
33 #endif
34 #ifndef __KERNEL__
35 # include <liblustre.h>
36 #endif
37
38 #include <obd_support.h>
39 #include <obd_class.h>
40 #include <lustre_debug.h>
41 #include <lprocfs_status.h>
42 #ifdef __KERNEL__
43 #include <linux/lustre_build_version.h>
44 #endif
45 #include <libcfs/list.h>
46 #include <lustre_ver.h>
47 #include "llog_internal.h"
48
49 #ifndef __KERNEL__
50 /* liblustre workaround */
51 atomic_t libcfs_kmemory = {0};
52 #endif
53
54 struct obd_device *obd_devs[MAX_OBD_DEVICES];
55 struct list_head obd_types;
56 spinlock_t obd_dev_lock = SPIN_LOCK_UNLOCKED;
57 #ifndef __KERNEL__
58 atomic_t obd_memory;
59 int obd_memmax;
60 #endif
61
62 /* The following are visible and mutable through /proc/sys/lustre/. */
63 unsigned int obd_fail_loc;
64 unsigned int obd_dump_on_timeout;
65 unsigned int obd_dump_on_eviction;
66 unsigned int obd_timeout = 100; /* seconds */
67 unsigned int ldlm_timeout = 20; /* seconds */
68 unsigned int obd_health_check_timeout = 120; /* seconds */
69
70 cfs_waitq_t obd_race_waitq;
71 int obd_race_state;
72
73 #ifdef __KERNEL__
74 unsigned int obd_print_fail_loc(void)
75 {
76         CWARN("obd_fail_loc = %x\n", obd_fail_loc);
77         return obd_fail_loc;
78 }
79
80 void obd_set_fail_loc(unsigned int fl)
81 {
82         obd_fail_loc = fl;
83 }
84
85 /*  opening /dev/obd */
86 static int obd_class_open(unsigned long flags, void *args)
87 {
88         ENTRY;
89
90         PORTAL_MODULE_USE;
91         RETURN(0);
92 }
93
94 /*  closing /dev/obd */
95 static int obd_class_release(unsigned long flags, void *args)
96 {
97         ENTRY;
98
99         PORTAL_MODULE_UNUSE;
100         RETURN(0);
101 }
102 #endif
103
104 static inline void obd_data2conn(struct lustre_handle *conn,
105                                  struct obd_ioctl_data *data)
106 {
107         memset(conn, 0, sizeof *conn);
108         conn->cookie = data->ioc_cookie;
109 }
110
111 static inline void obd_conn2data(struct obd_ioctl_data *data,
112                                  struct lustre_handle *conn)
113 {
114         data->ioc_cookie = conn->cookie;
115 }
116
117 int class_resolve_dev_name(uint32_t len, const char *name)
118 {
119         int rc;
120         int dev;
121
122         ENTRY;
123         if (!len || !name) {
124                 CERROR("No name passed,!\n");
125                 GOTO(out, rc = -EINVAL);
126         }
127         if (name[len - 1] != 0) {
128                 CERROR("Name not nul terminated!\n");
129                 GOTO(out, rc = -EINVAL);
130         }
131
132         CDEBUG(D_IOCTL, "device name %s\n", name);
133         dev = class_name2dev(name);
134         if (dev == -1) {
135                 CDEBUG(D_IOCTL, "No device for name %s!\n", name);
136                 GOTO(out, rc = -EINVAL);
137         }
138
139         CDEBUG(D_IOCTL, "device name %s, dev %d\n", name, dev);
140         rc = dev;
141
142 out:
143         RETURN(rc);
144 }
145
146 int class_handle_ioctl(unsigned int cmd, unsigned long arg)
147 {
148         char *buf = NULL;
149         struct obd_ioctl_data *data;
150         struct libcfs_debug_ioctl_data *debug_data;
151         struct obd_device *obd = NULL;
152         int err = 0, len = 0;
153         ENTRY;
154
155         /* only for debugging */
156         if (cmd == LIBCFS_IOC_DEBUG_MASK) {
157                 debug_data = (struct libcfs_debug_ioctl_data*)arg;
158                 libcfs_subsystem_debug = debug_data->subs;
159                 libcfs_debug = debug_data->debug;
160                 return 0;
161         }
162
163         CDEBUG(D_IOCTL, "cmd = %x\n", cmd);
164         if (obd_ioctl_getdata(&buf, &len, (void *)arg)) {
165                 CERROR("OBD ioctl: data error\n");
166                 GOTO(out, err = -EINVAL);
167         }
168         data = (struct obd_ioctl_data *)buf;
169
170         switch (cmd) {
171         case OBD_IOC_PROCESS_CFG: {
172                 struct lustre_cfg *lcfg;
173
174                 if (!data->ioc_plen1 || !data->ioc_pbuf1) {
175                         CERROR("No config buffer passed!\n");
176                         GOTO(out, err = -EINVAL);
177                 }
178                 OBD_ALLOC(lcfg, data->ioc_plen1);
179                 err = copy_from_user(lcfg, data->ioc_pbuf1, data->ioc_plen1);
180                 if (err) {
181                         OBD_FREE(lcfg, data->ioc_plen1);
182                         GOTO(out, err);
183                 }
184                 err = lustre_cfg_sanity_check(lcfg, data->ioc_plen1);
185                 if (err) {
186                         OBD_FREE(lcfg, data->ioc_plen1);
187                         GOTO(out, err);
188                 }
189                 err = class_process_config(lcfg);
190
191                 OBD_FREE(lcfg, data->ioc_plen1);
192                 GOTO(out, err);
193         }
194
195         case OBD_GET_VERSION:
196                 if (!data->ioc_inlbuf1) {
197                         CERROR("No buffer passed in ioctl\n");
198                         GOTO(out, err = -EINVAL);
199                 }
200
201                 if (strlen(BUILD_VERSION) + 1 > data->ioc_inllen1) {
202                         CERROR("ioctl buffer too small to hold version\n");
203                         GOTO(out, err = -EINVAL);
204                 }
205
206                 memcpy(data->ioc_bulk, BUILD_VERSION,
207                        strlen(BUILD_VERSION) + 1);
208
209                 err = obd_ioctl_popdata((void *)arg, data, len);
210                 if (err)
211                         err = -EFAULT;
212                 GOTO(out, err);
213
214         case OBD_IOC_NAME2DEV: {
215                 /* Resolve a device name.  This does not change the
216                  * currently selected device.
217                  */
218                 int dev;
219
220                 dev = class_resolve_dev_name(data->ioc_inllen1,
221                                              data->ioc_inlbuf1);
222                 data->ioc_dev = dev;
223                 if (dev < 0)
224                         GOTO(out, err = -EINVAL);
225
226                 err = obd_ioctl_popdata((void *)arg, data, sizeof(*data));
227                 if (err)
228                         err = -EFAULT;
229                 GOTO(out, err);
230         }
231
232         case OBD_IOC_UUID2DEV: {
233                 /* Resolve a device uuid.  This does not change the
234                  * currently selected device.
235                  */
236                 int dev;
237                 struct obd_uuid uuid;
238
239                 if (!data->ioc_inllen1 || !data->ioc_inlbuf1) {
240                         CERROR("No UUID passed!\n");
241                         GOTO(out, err = -EINVAL);
242                 }
243                 if (data->ioc_inlbuf1[data->ioc_inllen1 - 1] != 0) {
244                         CERROR("UUID not NUL terminated!\n");
245                         GOTO(out, err = -EINVAL);
246                 }
247
248                 CDEBUG(D_IOCTL, "device name %s\n", data->ioc_inlbuf1);
249                 obd_str2uuid(&uuid, data->ioc_inlbuf1);
250                 dev = class_uuid2dev(&uuid);
251                 data->ioc_dev = dev;
252                 if (dev == -1) {
253                         CDEBUG(D_IOCTL, "No device for UUID %s!\n",
254                                data->ioc_inlbuf1);
255                         GOTO(out, err = -EINVAL);
256                 }
257
258                 CDEBUG(D_IOCTL, "device name %s, dev %d\n", data->ioc_inlbuf1,
259                        dev);
260                 err = obd_ioctl_popdata((void *)arg, data, sizeof(*data));
261                 if (err)
262                         err = -EFAULT;
263                 GOTO(out, err);
264         }
265
266         case OBD_IOC_CLOSE_UUID: {
267                 CDEBUG(D_IOCTL, "closing all connections to uuid %s (NOOP)\n",
268                        data->ioc_inlbuf1);
269                 GOTO(out, err = 0);
270         }
271
272         case OBD_IOC_GETDEVICE: {
273                 int     index = data->ioc_count;
274                 char    *status, *str;
275
276                 if (!data->ioc_inlbuf1) {
277                         CERROR("No buffer passed in ioctl\n");
278                         GOTO(out, err = -EINVAL);
279                 }
280                 if (data->ioc_inllen1 < 128) {
281                         CERROR("ioctl buffer too small to hold version\n");
282                         GOTO(out, err = -EINVAL);
283                 }
284                                 
285                 obd = class_num2obd(index);
286                 if (!obd)
287                         GOTO(out, err = -ENOENT);
288
289                 if (obd->obd_stopping)
290                         status = "ST";
291                 else if (obd->obd_set_up)
292                         status = "UP";
293                 else if (obd->obd_attached)
294                         status = "AT";
295                 else
296                         status = "--";
297                 str = (char *)data->ioc_bulk;
298                 snprintf(str, len - sizeof(*data), "%3d %s %s %s %s %d",
299                          (int)index, status, obd->obd_type->typ_name,
300                          obd->obd_name, obd->obd_uuid.uuid,
301                          atomic_read(&obd->obd_refcount));
302                 err = obd_ioctl_popdata((void *)arg, data, len);
303
304                 GOTO(out, err = 0);
305         }
306
307         }
308
309         if (data->ioc_dev >= class_devno_max()) {
310                 CERROR("OBD ioctl: No device\n");
311                 GOTO(out, err = -EINVAL);
312         }
313
314         obd = class_num2obd(data->ioc_dev);
315         if (obd == NULL) {
316                 CERROR("OBD ioctl : No Device %d\n", data->ioc_dev);
317                 GOTO(out, err = -EINVAL);
318         }
319         LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
320
321         if (!obd->obd_set_up || obd->obd_stopping) {
322                 CERROR("OBD ioctl: device not setup %d \n", data->ioc_dev);
323                 GOTO(out, err = -EINVAL);
324         }
325
326         switch(cmd) {
327         case OBD_IOC_NO_TRANSNO: {
328                 if (!obd->obd_attached) {
329                         CERROR("Device %d not attached\n", obd->obd_minor);
330                         GOTO(out, err = -ENODEV);
331                 }
332                 CDEBUG(D_HA, "%s: disabling committed-transno notification\n",
333                        obd->obd_name);
334                 obd->obd_no_transno = 1;
335                 GOTO(out, err = 0);
336         }
337
338         default: {
339                 err = obd_iocontrol(cmd, obd->obd_self_export, len, data, NULL);
340                 if (err)
341                         GOTO(out, err);
342
343                 err = obd_ioctl_popdata((void *)arg, data, len);
344                 if (err)
345                         err = -EFAULT;
346                 GOTO(out, err);
347         }
348         }
349
350  out:
351         if (buf)
352                 obd_ioctl_freedata(buf, len);
353         RETURN(err);
354 } /* class_handle_ioctl */
355
356
357
358 #define OBD_MINOR 241
359 #ifdef __KERNEL__
360 /* to control /dev/obd */
361 static int obd_class_ioctl (struct cfs_psdev_file *pfile, unsigned long cmd, void *arg)
362 {
363         return class_handle_ioctl(cmd, (unsigned long)arg);
364 }
365
366 /* declare character device */
367 struct cfs_psdev_ops obd_psdev_ops = {
368         /* .p_open    = */ obd_class_open,      /* open */
369         /* .p_close   = */ obd_class_release,   /* release */
370         /* .p_read    = */ NULL,
371         /* .p_write   = */ NULL,
372         /* .p_ioctl   = */ obd_class_ioctl     /* ioctl */
373 };
374
375 extern cfs_psdev_t obd_psdev;
376 #else
377 void *obd_psdev = NULL;
378 #endif
379
380 EXPORT_SYMBOL(obd_devs);
381 EXPORT_SYMBOL(obd_fail_loc);
382 EXPORT_SYMBOL(obd_print_fail_loc);
383 EXPORT_SYMBOL(obd_race_waitq);
384 EXPORT_SYMBOL(obd_race_state);
385 EXPORT_SYMBOL(obd_dump_on_timeout);
386 EXPORT_SYMBOL(obd_dump_on_eviction);
387 EXPORT_SYMBOL(obd_timeout);
388 EXPORT_SYMBOL(ldlm_timeout);
389 EXPORT_SYMBOL(obd_health_check_timeout);
390 EXPORT_SYMBOL(ptlrpc_put_connection_superhack);
391
392 EXPORT_SYMBOL(proc_lustre_root);
393
394 EXPORT_SYMBOL(class_register_type);
395 EXPORT_SYMBOL(class_unregister_type);
396 EXPORT_SYMBOL(class_get_type);
397 EXPORT_SYMBOL(class_put_type);
398 EXPORT_SYMBOL(class_name2dev);
399 EXPORT_SYMBOL(class_name2obd);
400 EXPORT_SYMBOL(class_uuid2dev);
401 EXPORT_SYMBOL(class_uuid2obd);
402 EXPORT_SYMBOL(class_find_client_obd);
403 EXPORT_SYMBOL(class_find_client_notype);
404 EXPORT_SYMBOL(class_devices_in_group);
405 EXPORT_SYMBOL(class_conn2export);
406 EXPORT_SYMBOL(class_exp2obd);
407 EXPORT_SYMBOL(class_conn2obd);
408 EXPORT_SYMBOL(class_exp2cliimp);
409 EXPORT_SYMBOL(class_conn2cliimp);
410 EXPORT_SYMBOL(class_disconnect);
411 EXPORT_SYMBOL(class_num2obd);
412
413 /* uuid.c */
414 EXPORT_SYMBOL(class_generate_random_uuid);
415 EXPORT_SYMBOL(class_uuid_unparse);
416 EXPORT_SYMBOL(lustre_uuid_to_peer);
417
418 EXPORT_SYMBOL(class_handle_hash);
419 EXPORT_SYMBOL(class_handle_unhash);
420 EXPORT_SYMBOL(class_handle_hash_back);
421 EXPORT_SYMBOL(class_handle2object);
422
423 /* obd_config.c */
424 EXPORT_SYMBOL(class_incref);
425 EXPORT_SYMBOL(class_decref);
426 EXPORT_SYMBOL(class_get_profile);
427 EXPORT_SYMBOL(class_del_profile);
428 EXPORT_SYMBOL(class_del_profiles);
429 EXPORT_SYMBOL(class_process_config);
430 EXPORT_SYMBOL(class_process_proc_param);
431 EXPORT_SYMBOL(class_config_parse_llog);
432 EXPORT_SYMBOL(class_config_dump_llog);
433 EXPORT_SYMBOL(class_attach);
434 EXPORT_SYMBOL(class_setup);
435 EXPORT_SYMBOL(class_cleanup);
436 EXPORT_SYMBOL(class_detach);
437 EXPORT_SYMBOL(class_manual_cleanup);
438
439 /* mea.c */
440 EXPORT_SYMBOL(mea_name2idx);
441 EXPORT_SYMBOL(raw_name2idx);
442
443 #define OBD_INIT_CHECK
444 #ifdef OBD_INIT_CHECK
445 int obd_init_checks(void)
446 {
447         __u64 u64val, div64val;
448         char buf[64];
449         int len, ret = 0;
450
451         CDEBUG(D_INFO, "LPU64=%s, LPD64=%s, LPX64=%s, LPSZ=%s, LPSSZ=%s\n",
452                LPU64, LPD64, LPX64, LPSZ, LPSSZ);
453
454         CDEBUG(D_INFO, "OBD_OBJECT_EOF = "LPX64"\n", (__u64)OBD_OBJECT_EOF);
455
456         u64val = OBD_OBJECT_EOF;
457         CDEBUG(D_INFO, "u64val OBD_OBJECT_EOF = "LPX64"\n", u64val);
458         if (u64val != OBD_OBJECT_EOF) {
459                 CERROR("__u64 "LPX64"(%d) != 0xffffffffffffffff\n",
460                        u64val, (int)sizeof(u64val));
461                 ret = -EINVAL;
462         }
463         len = snprintf(buf, sizeof(buf), LPX64, u64val);
464         if (len != 18) {
465                 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf, len);
466                 ret = -EINVAL;
467         }
468
469         div64val = OBD_OBJECT_EOF;
470         CDEBUG(D_INFO, "u64val OBD_OBJECT_EOF = "LPX64"\n", u64val);
471         if (u64val != OBD_OBJECT_EOF) {
472                 CERROR("__u64 "LPX64"(%d) != 0xffffffffffffffff\n",
473                        u64val, (int)sizeof(u64val));
474                 ret = -EOVERFLOW;
475         }
476         if (u64val >> 8 != OBD_OBJECT_EOF >> 8) {
477                 CERROR("__u64 "LPX64"(%d) != 0xffffffffffffffff\n",
478                        u64val, (int)sizeof(u64val));
479                 return -EOVERFLOW;
480         }
481         if (do_div(div64val, 256) != (u64val & 255)) {
482                 CERROR("do_div("LPX64",256) != "LPU64"\n", u64val, u64val &255);
483                 return -EOVERFLOW;
484         }
485         if (u64val >> 8 != div64val) {
486                 CERROR("do_div("LPX64",256) "LPU64" != "LPU64"\n",
487                        u64val, div64val, u64val >> 8);
488                 return -EOVERFLOW;
489         }
490         len = snprintf(buf, sizeof(buf), LPX64, u64val);
491         if (len != 18) {
492                 CWARN("LPX64 wrong length! strlen(%s)=%d != 18\n", buf, len);
493                 ret = -EINVAL;
494         }
495         len = snprintf(buf, sizeof(buf), LPU64, u64val);
496         if (len != 20) {
497                 CWARN("LPU64 wrong length! strlen(%s)=%d != 20\n", buf, len);
498                 ret = -EINVAL;
499         }
500         len = snprintf(buf, sizeof(buf), LPD64, u64val);
501         if (len != 2) {
502                 CWARN("LPD64 wrong length! strlen(%s)=%d != 2\n", buf, len);
503                 ret = -EINVAL;
504         }
505         if ((u64val & ~CFS_PAGE_MASK) >= CFS_PAGE_SIZE) {
506                 CWARN("mask failed: u64val "LPU64" >= %lu\n", u64val,CFS_PAGE_SIZE);
507                 ret = -EINVAL;
508         }
509
510         return ret;
511 }
512 #else
513 #define obd_init_checks() do {} while(0)
514 #endif
515
516 extern int init_capa_hash(void);
517 extern void cleanup_capa_hash(void);
518
519 extern spinlock_t obd_types_lock;
520 extern spinlock_t handle_lock;
521 extern int class_procfs_init(void);
522 extern int class_procfs_clean(void);
523
524 #ifdef __KERNEL__
525 static int __init init_obdclass(void)
526 #else
527 int init_obdclass(void)
528 #endif
529 {
530         int i, err;
531 #ifdef __KERNEL__
532         int lustre_register_fs(void);
533
534         printk(KERN_INFO "Lustre: OBD class driver, info@clusterfs.com\n");
535         printk(KERN_INFO "        Lustre Version: "LUSTRE_VERSION_STRING"\n");
536         printk(KERN_INFO "        Build Version: "BUILD_VERSION"\n");
537 #else
538         CDEBUG(D_INFO, "Lustre: OBD class driver, info@clusterfs.com\n");
539         CDEBUG(D_INFO, "        Lustre Version: "LUSTRE_VERSION_STRING"\n");
540         CDEBUG(D_INFO, "        Build Version: "BUILD_VERSION"\n");
541 #endif
542
543         err = init_capa_hash();
544         if (err)
545                 return err;
546
547         spin_lock_init(&obd_types_lock);
548         spin_lock_init(&handle_lock);
549         cfs_waitq_init(&obd_race_waitq);
550
551         err = obd_init_checks();
552         if (err == -EOVERFLOW)
553                 return err;
554
555         class_init_uuidlist();
556         err = class_handle_init();
557         if (err)
558                 return err;
559
560         spin_lock_init(&obd_dev_lock);
561         INIT_LIST_HEAD(&obd_types);
562
563         err = cfs_psdev_register(&obd_psdev);
564         if (err) {
565                 CERROR("cannot register %d err %d\n", OBD_MINOR, err);
566                 return err;
567         }
568
569         /* This struct is already zerod for us (static global) */
570         for (i = 0; i < class_devno_max(); i++)
571                 obd_devs[i] = NULL;
572
573         err = obd_init_caches();
574         if (err)
575                 return err;
576 #ifdef __KERNEL__
577         err = lu_global_init();
578         if (err)
579                 return err;
580         err = class_procfs_init();
581         if (err)
582                 return err;
583         err = lustre_register_fs();
584 #endif
585
586         return err;
587 }
588
589 /* liblustre doesn't call cleanup_obdclass, apparently.  we carry on in this
590  * ifdef to the end of the file to cover module and versioning goo.*/
591 #ifdef __KERNEL__
592 static void cleanup_obdclass(void)
593 {
594         int i;
595         int lustre_unregister_fs(void);
596         ENTRY;
597
598         lustre_unregister_fs();
599
600         cfs_psdev_deregister(&obd_psdev);
601         for (i = 0; i < class_devno_max(); i++) {
602                 struct obd_device *obd = class_num2obd(i);
603                 if (obd && obd->obd_set_up &&
604                     OBT(obd) && OBP(obd, detach)) {
605                         /* XXX should this call generic detach otherwise? */
606                         LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
607                         OBP(obd, detach)(obd);
608                 }
609         }
610         lu_global_fini();
611
612         cleanup_capa_hash();
613         obd_cleanup_caches();
614         obd_sysctl_clean();
615
616         class_procfs_clean();
617
618         class_handle_cleanup();
619         class_exit_uuidlist();
620         EXIT;
621 }
622
623 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
624 MODULE_DESCRIPTION("Lustre Class Driver Build Version: " BUILD_VERSION);
625 MODULE_LICENSE("GPL");
626
627 cfs_module(obdclass, LUSTRE_VERSION_STRING, init_obdclass, cleanup_obdclass);
628 #endif