Whamcloud - gitweb
The ioctl handler for test_brw was corrupting kernel memory and giving an
[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  * Copyright (C) 2001  Cluster File Systems, Inc.
5  *
6  * This code is issued under the GNU General Public License.
7  * See the file COPYING in this distribution
8  *
9  * These are the only exported functions, they provide some generic
10  * infrastructure for managing object devices
11  *
12  * Object Devices Class Driver
13  *              Copyright (C) 2002 Cluster File Systems, Inc.
14  */
15
16 #define EXPORT_SYMTAB
17 #include <linux/config.h> /* for CONFIG_PROC_FS */
18 #include <linux/module.h>
19 #include <linux/errno.h>
20 #include <linux/kernel.h>
21 #include <linux/major.h>
22 #include <linux/sched.h>
23 #include <linux/lp.h>
24 #include <linux/slab.h>
25 #include <linux/ioport.h>
26 #include <linux/fcntl.h>
27 #include <linux/delay.h>
28 #include <linux/skbuff.h>
29 #include <linux/proc_fs.h>
30 #include <linux/fs.h>
31 #include <linux/poll.h>
32 #include <linux/init.h>
33 #include <linux/list.h>
34 #include <asm/io.h>
35 #include <asm/system.h>
36 #include <asm/poll.h>
37 #include <asm/uaccess.h>
38 #include <linux/miscdevice.h>
39
40 #define DEBUG_SUBSYSTEM S_CLASS
41
42 #include <linux/obd_support.h>
43 #include <linux/obd_class.h>
44 #include <linux/smp_lock.h>
45
46 struct semaphore obd_conf_sem;   /* serialize configuration commands */
47 struct obd_device obd_dev[MAX_OBD_DEVICES];
48 struct list_head obd_types;
49 unsigned long obd_memory = 0;
50 unsigned long obd_fail_loc = 0;
51
52 extern struct obd_type *class_nm_to_type(char *nm);
53
54 /*  opening /dev/obd */
55 static int obd_class_open(struct inode * inode, struct file * file)
56 {
57         ENTRY;
58
59         file->private_data = NULL;
60         MOD_INC_USE_COUNT;
61         RETURN(0);
62 }
63
64 /*  closing /dev/obd */
65 static int obd_class_release(struct inode * inode, struct file * file)
66 {
67         ENTRY;
68
69         if (file->private_data)
70                 file->private_data = NULL;
71
72         MOD_DEC_USE_COUNT;
73         RETURN(0);
74 }
75
76
77 inline void obd_data2conn(struct lustre_handle *conn, struct obd_ioctl_data *data)
78 {
79         conn->addr = data->ioc_addr;
80         conn->cookie = data->ioc_cookie;
81 }
82
83
84 inline void obd_conn2data(struct obd_ioctl_data *data, struct lustre_handle *conn)
85 {
86         data->ioc_addr = conn->addr;
87         data->ioc_cookie = conn->cookie;
88 }
89
90
91 /* to control /dev/obd */
92 static int obd_class_ioctl (struct inode * inode, struct file * filp,
93                             unsigned int cmd, unsigned long arg)
94 {
95         char *buf = NULL;
96         int len = 0;
97         struct obd_ioctl_data *data;
98         struct obd_device *obd = filp->private_data;
99         struct lustre_handle conn;
100         int rw = OBD_BRW_READ;
101         int err = 0;
102         ENTRY;
103
104         down(&obd_conf_sem);
105
106         if (!obd && cmd != OBD_IOC_DEVICE && cmd != TCGETS &&
107             cmd != OBD_IOC_LIST &&
108             cmd != OBD_IOC_NAME2DEV && cmd != OBD_IOC_NEWDEV) {
109                 CERROR("OBD ioctl: No device\n");
110                 GOTO(out, err=-EINVAL);
111         }
112         if (obd_ioctl_getdata(&buf, &len, (void *)arg)) {
113                 CERROR("OBD ioctl: data error\n");
114                 GOTO(out, err=-EINVAL);
115         }
116         data = (struct obd_ioctl_data *)buf;
117
118         switch (cmd) {
119         case TCGETS:
120                 GOTO(out, err=-EINVAL);
121         case OBD_IOC_DEVICE: {
122                 CDEBUG(D_IOCTL, "\n");
123                 if (data->ioc_dev >= MAX_OBD_DEVICES || data->ioc_dev < 0) {
124                         CERROR("OBD ioctl: DEVICE insufficient devices\n");
125                         GOTO(out, err=-EINVAL);
126                 }
127                 CDEBUG(D_IOCTL, "device %d\n", data->ioc_dev);
128
129                 filp->private_data = &obd_dev[data->ioc_dev];
130                 GOTO(out, err=0);
131         }
132
133         case OBD_IOC_LIST: {
134                 int i;
135                 char *buf2 = data->ioc_bulk;
136                 int remains = data->ioc_inllen1;
137
138                 if (!data->ioc_inlbuf1) {
139                         CERROR("No buffer passed!\n");
140                         GOTO(out, err=-EINVAL);
141                 }
142
143
144                 for (i = 0 ; i < MAX_OBD_DEVICES ; i++) {
145                         int l;
146                         char *status;
147                         struct obd_device *obd = &obd_dev[i];
148                         if (!obd->obd_type)
149                                 continue;
150                         if (obd->obd_flags & OBD_SET_UP)
151                                 status = "*";
152                         else
153                                 status = " ";
154                         l = snprintf(buf2, remains, "%2d %s %s %s %s\n",
155                                      i, status, obd->obd_type->typ_name,
156                                      obd->obd_name, obd->obd_uuid);
157                         buf2 +=l;
158                         remains -=l;
159                         if (remains <= 0) {
160                                 CERROR("not enough space for device listing\n");
161                                 break;
162                         }
163                 }
164
165                 err = copy_to_user((int *)arg, data, len);
166                 GOTO(out, err);
167         }
168
169
170         case OBD_IOC_NAME2DEV: {
171                 /* Resolve a device name.  This does not change the
172                  * currently selected device.
173                  */
174                 int dev;
175
176                 if (!data->ioc_inllen1 || !data->ioc_inlbuf1 ) {
177                         CERROR("No name passed,!\n");
178                         GOTO(out, err=-EINVAL);
179                 }
180                 if (data->ioc_inlbuf1[data->ioc_inllen1-1] !=0) {
181                         CERROR("Name not nul terminated!\n");
182                         GOTO(out, err=-EINVAL);
183                 }
184
185                 CDEBUG(D_IOCTL, "device name %s\n", data->ioc_inlbuf1);
186                 dev = class_name2dev(data->ioc_inlbuf1);
187                 data->ioc_dev = dev;
188                 if (dev == -1) {
189                         CDEBUG(D_IOCTL, "No device for name %s!\n",
190                                data->ioc_inlbuf1);
191                         GOTO(out, err=-EINVAL);
192                 }
193
194                 CDEBUG(D_IOCTL, "device name %s, dev %d\n", data->ioc_inlbuf1,
195                        dev);
196                 err = copy_to_user((int *)arg, data, sizeof(*data));
197                 GOTO(out, err);
198         }
199
200         case OBD_IOC_UUID2DEV: {
201                 /* Resolve a device uuid.  This does not change the
202                  * currently selected device.
203                  */
204                 int dev;
205
206                 if (!data->ioc_inllen1 || !data->ioc_inlbuf1) {
207                         CERROR("No UUID passed!\n");
208                         GOTO(out, err=-EINVAL);
209                 }
210                 if (data->ioc_inlbuf1[data->ioc_inllen1-1] !=0) {
211                         CERROR("Name not nul terminated!\n");
212                         GOTO(out, err=-EINVAL);
213                 }
214
215                 CDEBUG(D_IOCTL, "device name %s\n", data->ioc_inlbuf1);
216                 dev = class_uuid2dev(data->ioc_inlbuf1);
217                 data->ioc_dev = dev;
218                 if (dev == -1) {
219                         CDEBUG(D_IOCTL, "No device for name %s!\n",
220                                data->ioc_inlbuf1);
221                         GOTO(out, err=-EINVAL);
222                 }
223
224                 CDEBUG(D_IOCTL, "device name %s, dev %d\n", data->ioc_inlbuf1,
225                        dev);
226                 err = copy_to_user((int *)arg, data, sizeof(*data));
227                 GOTO(out, err);
228         }
229
230         case OBD_IOC_NEWDEV: {
231                 int dev = -1;
232                 int i;
233
234                 filp->private_data = NULL;
235                 for (i = 0 ; i < MAX_OBD_DEVICES ; i++) {
236                         struct obd_device *obd = &obd_dev[i];
237                         if (!obd->obd_type) {
238                                 filp->private_data = obd;
239                                 dev = i;
240                                 break;
241                         }
242                 }
243
244
245                 data->ioc_dev = dev;
246                 if (dev == -1)
247                         GOTO(out, err=-EINVAL);
248
249                 err = copy_to_user((int *)arg, data, sizeof(*data));
250                 GOTO(out, err);
251         }
252
253         case OBD_IOC_ATTACH: {
254                 struct obd_type *type;
255
256                 /* have we attached a type to this device */
257                 if (obd->obd_flags & OBD_ATTACHED) {
258                         CERROR("OBD: Device %d already typed as %s.\n",
259                                obd->obd_minor, MKSTR(obd->obd_type->typ_name));
260                         GOTO(out, err=-EBUSY);
261                 }
262
263                 if (!data->ioc_inllen1 || !data->ioc_inlbuf1) {
264                         CERROR("No type passed!\n");
265                         GOTO(out, err=-EINVAL);
266                 }
267                 if (data->ioc_inlbuf1[data->ioc_inllen1-1] !=0) {
268                         CERROR("Type not nul terminated!\n");
269                         GOTO(out, err=-EINVAL);
270                 }
271
272                 CDEBUG(D_IOCTL, "attach type %s name: %s uuid: %s\n",
273                        MKSTR(data->ioc_inlbuf1),
274                        MKSTR(data->ioc_inlbuf2), MKSTR(data->ioc_inlbuf3));
275
276                 /* find the type */
277                 type = class_nm_to_type(data->ioc_inlbuf1);
278                 if (!type) {
279                         CERROR("OBD: unknown type dev %d\n", obd->obd_minor);
280                         GOTO(out, err=-EINVAL);
281                 }
282
283                 obd->obd_type = type;
284                 INIT_LIST_HEAD(&obd->obd_exports);
285
286                 /* do the attach */
287                 if (OBT(obd) && OBP(obd, attach))
288                         err = OBP(obd,attach)(obd, sizeof(*data), data);
289                 if (err) {
290                         obd->obd_type = NULL;
291                 } else {
292                         obd->obd_flags |= OBD_ATTACHED;
293                         type->typ_refcnt++;
294                         CDEBUG(D_IOCTL, "OBD: dev %d attached type %s\n",
295                                obd->obd_minor, data->ioc_inlbuf1);
296                         if (data->ioc_inlbuf2) {
297                                 int len = strlen(data->ioc_inlbuf2) + 1;
298                                 OBD_ALLOC(obd->obd_name, len);
299                                 if (!obd->obd_name) {
300                                         CERROR("no memory\n");
301                                         LBUG();
302                                 }
303                                 memcpy(obd->obd_name, data->ioc_inlbuf2, len);
304                                 //obd->obd_proc_entry =
305                                 //        proc_lustre_register_obd_device(obd);
306                         } else {
307                                 CERROR("WARNING: unnamed obd device\n");
308                                 obd->obd_proc_entry = NULL;
309                         }
310
311                         if (data->ioc_inlbuf3) {
312                                 int len = strlen(data->ioc_inlbuf3);
313                                 if (len > 37) {
314                                         CERROR("uuid should be shorter than 37 bytes\n");
315                                         if (obd->obd_name)
316                                                 OBD_FREE(obd->obd_name,
317                                                          strlen(obd->obd_name) + 1);
318                                         GOTO(out, err=-EINVAL);
319                                 }
320                                 memcpy(obd->obd_uuid, data->ioc_inlbuf3,
321                                        sizeof(obd->obd_uuid));
322                         }
323
324                         MOD_INC_USE_COUNT;
325                 }
326
327                 GOTO(out, err);
328         }
329
330         case OBD_IOC_DETACH: {
331                 ENTRY;
332                 if (obd->obd_flags & OBD_SET_UP) {
333                         CERROR("OBD device %d still set up\n", obd->obd_minor);
334                         GOTO(out, err=-EBUSY);
335                 }
336                 if (! (obd->obd_flags & OBD_ATTACHED) ) {
337                         CERROR("OBD device %d not attached\n", obd->obd_minor);
338                         GOTO(out, err=-ENODEV);
339                 }
340                 if ( !list_empty(&obd->obd_exports) ) {
341                         CERROR("OBD device %d has exports\n",
342                                obd->obd_minor);
343                         GOTO(out, err=-EBUSY);
344                 }
345
346                 if (obd->obd_name) {
347                         OBD_FREE(obd->obd_name, strlen(obd->obd_name)+1);
348                         obd->obd_name = NULL;
349                 }
350
351                 //if (obd->obd_proc_entry)
352                   //      proc_lustre_release_obd_device(obd);
353
354                 obd->obd_flags &= ~OBD_ATTACHED;
355                 obd->obd_type->typ_refcnt--;
356                 obd->obd_type = NULL;
357                 MOD_DEC_USE_COUNT;
358                 GOTO(out, err=0);
359         }
360
361         case OBD_IOC_SETUP: {
362                 /* have we attached a type to this device? */
363                 if (!(obd->obd_flags & OBD_ATTACHED)) {
364                         CERROR("Device %d not attached\n", obd->obd_minor);
365                         GOTO(out, err=-ENODEV);
366                 }
367
368                 /* has this been done already? */
369                 if ( obd->obd_flags & OBD_SET_UP ) {
370                         CERROR("Device %d already setup (type %s)\n",
371                                obd->obd_minor, obd->obd_type->typ_name);
372                         GOTO(out, err=-EBUSY);
373                 }
374
375                 if ( OBT(obd) && OBP(obd, setup) )
376                         err = obd_setup(obd, sizeof(*data), data);
377
378                 if (!err) {
379                         obd->obd_type->typ_refcnt++;
380                         obd->obd_flags |= OBD_SET_UP;
381                 }
382
383                 GOTO(out, err);
384         }
385         case OBD_IOC_CLEANUP: {
386                 /* have we attached a type to this device? */
387                 if (!(obd->obd_flags & OBD_ATTACHED)) {
388                         CERROR("Device %d not attached\n", obd->obd_minor);
389                         GOTO(out, err=-ENODEV);
390                 }
391
392                 if ( OBT(obd) && OBP(obd, cleanup) )
393                         err = obd_cleanup(obd);
394
395                 if (!err) {
396                         obd->obd_flags &= ~OBD_SET_UP;
397                         obd->obd_type->typ_refcnt--;
398                 }
399                 GOTO(out, err);
400         }
401
402         case OBD_IOC_CONNECT: {
403                 obd_data2conn(&conn, data);
404
405                 err = obd_connect(&conn, obd);
406
407                 CDEBUG(D_IOCTL, "assigned export %Lx\n", conn.addr);
408                 obd_conn2data(data, &conn);
409                 if (err)
410                         GOTO(out, err);
411
412                 err = copy_to_user((int *)arg, data, sizeof(*data));
413                 GOTO(out, err);
414         }
415
416         case OBD_IOC_DISCONNECT: {
417                 obd_data2conn(&conn, data);
418                 err = obd_disconnect(&conn);
419                 GOTO(out, err);
420         }
421
422         case OBD_IOC_DEC_USE_COUNT: {
423                 MOD_DEC_USE_COUNT;
424                 GOTO(out, err=0);
425         }
426
427         case OBD_IOC_CREATE: {
428                 struct lov_stripe_md *ea;
429                 obd_data2conn(&conn, data);
430
431
432                 err = obd_create(&conn, &data->ioc_obdo1, &ea);
433                 if (err)
434                         GOTO(out, err);
435
436                 err = copy_to_user((int *)arg, data, sizeof(*data));
437                 GOTO(out, err);
438         }
439
440         case OBD_IOC_GETATTR: {
441
442                 obd_data2conn(&conn, data);
443                 err = obd_getattr(&conn, &data->ioc_obdo1);
444                 if (err)
445                         GOTO(out, err);
446
447                 err = copy_to_user((int *)arg, data, sizeof(*data));
448                 GOTO(out, err);
449         }
450
451         case OBD_IOC_SETATTR: {
452                 obd_data2conn(&conn, data);
453                 err = obd_setattr(&conn, &data->ioc_obdo1);
454                 if (err)
455                         GOTO(out, err);
456
457                 err = copy_to_user((int *)arg, data, sizeof(*data));
458                 GOTO(out, err);
459         }
460
461         case OBD_IOC_DESTROY: {
462                 void *ea;
463                 obd_data2conn(&conn, data);
464
465                 err = obd_destroy(&conn, &data->ioc_obdo1, ea);
466                 if (err)
467                         GOTO(out, err);
468
469                 err = copy_to_user((int *)arg, data, sizeof(*data));
470                 GOTO(out, err);
471         }
472
473         case OBD_IOC_BRW_WRITE:
474                 rw = OBD_BRW_WRITE;
475         case OBD_IOC_BRW_READ: {
476                 /* FIXME: use a better ioctl data struct than obd_ioctl_data.
477                  *        We don't really support multiple-obdo I/Os here,
478                  *        for example offset and count are not per-obdo.
479                  */
480                 struct lov_stripe_md *md;
481                 obd_count       pages = 0;
482                 struct page     **bufs = NULL;
483                 obd_size        *counts = NULL;
484                 obd_off         *offsets = NULL;
485                 obd_flag        *flags = NULL;
486                 int             j;
487                 unsigned long off;
488                 void *from;
489
490                 obd_data2conn(&conn, data);
491
492                 pages = data->ioc_plen1 / PAGE_SIZE;
493
494                 CDEBUG(D_INODE, "BRW %s with %d pages\n",
495                        rw == OBD_BRW_READ ? "read" : "write", pages);
496                 OBD_ALLOC(bufs, pages * sizeof(*bufs));
497                 OBD_ALLOC(counts, pages * sizeof(*counts));
498                 OBD_ALLOC(offsets, pages * sizeof(*offsets));
499                 OBD_ALLOC(flags, pages * sizeof(*flags));
500                 if (!bufs || !counts || !offsets || !flags) {
501                         CERROR("no memory for %d BRW per-page data\n", pages);
502                         GOTO(brw_free, err = -ENOMEM);
503                 }
504
505                 md = &data->ioc_obdo1;
506
507                 from = (&data->ioc_pbuf1)[0];
508                 off = data->ioc_offset;
509
510                 for (j = 0; j < pages;
511                      j++, off += PAGE_SIZE, from += PAGE_SIZE) {
512                         unsigned long to;
513
514                         to = __get_free_pages(GFP_KERNEL, 0);
515                         if (!to) {
516                                 /*      ||
517                                         copy_from_user((void
518                                         *)to,from,PAGE_SIZE))
519                                         free_pages(to, 0);
520                                 */
521                                 CERROR("no memory for brw pages\n");
522                                 GOTO(brw_cleanup, err = -ENOMEM);
523                         }
524                         bufs[j] = virt_to_page(to);
525                         counts[j] = PAGE_SIZE;
526                         offsets[j] = off;
527                         flags[j] = 0;
528                 }
529
530                 err = obd_brw(rw, &conn, md, j, bufs, counts, offsets, flags,
531                               NULL);
532
533                 EXIT;
534         brw_cleanup:
535                 for (j = 0; j < pages; j++)
536                         if (bufs[j] != NULL)
537                                 __free_pages(bufs[j], 0);
538         brw_free:
539                 OBD_FREE(bufs, pages * sizeof(*bufs));
540                 OBD_FREE(counts, pages * sizeof(*counts));
541                 OBD_FREE(offsets, pages * sizeof(*offsets));
542                 OBD_FREE(flags, pages * sizeof(*flags));
543                 GOTO(out, err);
544         }
545         default:
546                 obd_data2conn(&conn, data);
547
548                 err = obd_iocontrol(cmd, &conn, len, data, NULL);
549                 if (err)
550                         GOTO(out, err);
551
552                 err = copy_to_user((int *)arg, data, len);
553                 GOTO(out, err);
554         }
555
556  out:
557         if (buf)
558                 OBD_FREE(buf, len);
559         up(&obd_conf_sem);
560         RETURN(err);
561 } /* obd_class_ioctl */
562
563
564
565 /* declare character device */
566 static struct file_operations obd_psdev_fops = {
567         ioctl: obd_class_ioctl,       /* ioctl */
568         open: obd_class_open,        /* open */
569         release: obd_class_release,     /* release */
570 };
571
572 /* modules setup */
573 #define OBD_MINOR 241
574 static struct miscdevice obd_psdev = {
575         OBD_MINOR,
576         "obd_psdev",
577         &obd_psdev_fops
578 };
579
580
581 EXPORT_SYMBOL(obd_dev);
582 EXPORT_SYMBOL(obdo_cachep);
583 EXPORT_SYMBOL(obd_memory);
584 EXPORT_SYMBOL(obd_fail_loc);
585
586 EXPORT_SYMBOL(class_register_type);
587 EXPORT_SYMBOL(class_unregister_type);
588 EXPORT_SYMBOL(class_name2dev);
589 EXPORT_SYMBOL(class_uuid2dev);
590 EXPORT_SYMBOL(class_uuid2obd);
591 EXPORT_SYMBOL(class_connect);
592 EXPORT_SYMBOL(class_conn2export);
593 EXPORT_SYMBOL(class_conn2obd);
594 EXPORT_SYMBOL(class_disconnect);
595 //EXPORT_SYMBOL(class_multi_setup);
596 //EXPORT_SYMBOL(class_multi_cleanup);
597
598 static int __init init_obdclass(void)
599 {
600         int err;
601         int i;
602
603         printk(KERN_INFO "OBD class driver  v0.9, info@clusterfs.com\n");
604
605         sema_init(&obd_conf_sem, 1);
606         INIT_LIST_HEAD(&obd_types);
607
608         if ((err = misc_register(&obd_psdev))) {
609                 CERROR("cannot register %d err %d\n", OBD_MINOR, err);
610                 return err;
611         }
612
613         for (i = 0; i < MAX_OBD_DEVICES; i++) {
614                 memset(&(obd_dev[i]), 0, sizeof(obd_dev[i]));
615                 obd_dev[i].obd_minor = i;
616                 INIT_LIST_HEAD(&obd_dev[i].obd_exports);
617         }
618
619         err = obd_init_caches();
620         if (err)
621                 return err;
622         obd_sysctl_init();
623         return 0;
624 }
625
626 static void __exit cleanup_obdclass(void)
627 {
628         int i;
629         ENTRY;
630
631         misc_deregister(&obd_psdev);
632         for (i = 0; i < MAX_OBD_DEVICES; i++) {
633                 struct obd_device *obd = &obd_dev[i];
634                 if (obd->obd_type && (obd->obd_flags & OBD_SET_UP) &&
635                     OBT(obd) && OBP(obd, detach)) {
636                         /* XXX should this call generic detach otherwise? */
637                         OBP(obd, detach)(obd);
638                 }
639         }
640
641         obd_cleanup_caches();
642         obd_sysctl_clean();
643         CERROR("obd memory leaked: %ld bytes\n", obd_memory);
644         EXIT;
645 }
646
647 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
648 MODULE_DESCRIPTION("Lustre Class Driver v1.0");
649 MODULE_LICENSE("GPL");
650
651 module_init(init_obdclass);
652 module_exit(cleanup_obdclass);