2 * osd_uld.c - OSD Upper Layer Driver
4 * A Linux driver module that registers as a SCSI ULD and probes
5 * for OSD type SCSI devices.
6 * It's main function is to export osd devices to in-kernel users like
7 * osdfs and pNFS-objects-LD. It also provides one ioctl for running
10 * Copyright (C) 2008 Panasas Inc. All rights reserved.
13 * Boaz Harrosh <ooo@electrozaur.com>
14 * Benny Halevy <bhalevy@panasas.com>
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License version 2
19 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions
23 * 1. Redistributions of source code must retain the above copyright
24 * notice, this list of conditions and the following disclaimer.
25 * 2. Redistributions in binary form must reproduce the above copyright
26 * notice, this list of conditions and the following disclaimer in the
27 * documentation and/or other materials provided with the distribution.
28 * 3. Neither the name of the Panasas company nor the names of its
29 * contributors may be used to endorse or promote products derived
30 * from this software without specific prior written permission.
32 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
33 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
34 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
35 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
36 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
37 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
38 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
39 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
40 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
41 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
42 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45 #include <linux/namei.h>
46 #include <linux/cdev.h>
48 #include <linux/module.h>
49 #include <linux/device.h>
50 #include <linux/idr.h>
51 #include <linux/major.h>
52 #include <linux/file.h>
53 #include <linux/slab.h>
55 #include <scsi/scsi.h>
56 #include <scsi/scsi_driver.h>
57 #include <scsi/scsi_device.h>
58 #include <scsi/scsi_ioctl.h>
60 #include <scsi/osd_initiator.h>
61 #include <scsi/osd_sec.h>
63 #include "osd_debug.h"
66 # define TYPE_OSD 0x11
69 #ifndef SCSI_OSD_MAJOR
70 # define SCSI_OSD_MAJOR 260
72 #define SCSI_OSD_MAX_MINOR MINORMASK
74 static const char osd_name
[] = "osd";
75 static const char *osd_version_string
= "open-osd 0.2.1";
77 MODULE_AUTHOR("Boaz Harrosh <ooo@electrozaur.com>");
78 MODULE_DESCRIPTION("open-osd Upper-Layer-Driver osd.ko");
79 MODULE_LICENSE("GPL");
80 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_OSD_MAJOR
);
81 MODULE_ALIAS_SCSI_DEVICE(TYPE_OSD
);
83 struct osd_uld_device
{
85 struct device class_dev
;
88 struct osd_dev_info odi
;
92 struct osd_dev_handle
{
95 struct osd_uld_device
*oud
;
98 static DEFINE_IDA(osd_minor_ida
);
101 * scsi sysfs attribute operations
103 static ssize_t
osdname_show(struct device
*dev
, struct device_attribute
*attr
,
106 struct osd_uld_device
*ould
= container_of(dev
, struct osd_uld_device
,
108 return sprintf(buf
, "%s\n", ould
->odi
.osdname
);
110 static DEVICE_ATTR_RO(osdname
);
112 static ssize_t
systemid_show(struct device
*dev
, struct device_attribute
*attr
,
115 struct osd_uld_device
*ould
= container_of(dev
, struct osd_uld_device
,
118 memcpy(buf
, ould
->odi
.systemid
, ould
->odi
.systemid_len
);
119 return ould
->odi
.systemid_len
;
121 static DEVICE_ATTR_RO(systemid
);
123 static struct attribute
*osd_uld_attrs
[] = {
124 &dev_attr_osdname
.attr
,
125 &dev_attr_systemid
.attr
,
128 ATTRIBUTE_GROUPS(osd_uld
);
130 static struct class osd_uld_class
= {
131 .owner
= THIS_MODULE
,
133 .dev_groups
= osd_uld_groups
,
137 * Char Device operations
140 static int osd_uld_open(struct inode
*inode
, struct file
*file
)
142 struct osd_uld_device
*oud
= container_of(inode
->i_cdev
,
143 struct osd_uld_device
, cdev
);
145 get_device(&oud
->class_dev
);
146 /* cache osd_uld_device on file handle */
147 file
->private_data
= oud
;
148 OSD_DEBUG("osd_uld_open %p\n", oud
);
152 static int osd_uld_release(struct inode
*inode
, struct file
*file
)
154 struct osd_uld_device
*oud
= file
->private_data
;
156 OSD_DEBUG("osd_uld_release %p\n", file
->private_data
);
157 file
->private_data
= NULL
;
158 put_device(&oud
->class_dev
);
162 /* FIXME: Only one vector for now */
163 unsigned g_test_ioctl
;
164 do_test_fn
*g_do_test
;
166 int osduld_register_test(unsigned ioctl
, do_test_fn
*do_test
)
171 g_test_ioctl
= ioctl
;
175 EXPORT_SYMBOL(osduld_register_test
);
177 void osduld_unregister_test(unsigned ioctl
)
179 if (ioctl
== g_test_ioctl
) {
184 EXPORT_SYMBOL(osduld_unregister_test
);
186 static do_test_fn
*_find_ioctl(unsigned cmd
)
188 if (g_test_ioctl
== cmd
)
194 static long osd_uld_ioctl(struct file
*file
, unsigned int cmd
,
197 struct osd_uld_device
*oud
= file
->private_data
;
201 do_test
= _find_ioctl(cmd
);
203 ret
= do_test(&oud
->od
, cmd
, arg
);
205 OSD_ERR("Unknown ioctl %d: osd_uld_device=%p\n", cmd
, oud
);
211 static const struct file_operations osd_fops
= {
212 .owner
= THIS_MODULE
,
213 .open
= osd_uld_open
,
214 .release
= osd_uld_release
,
215 .unlocked_ioctl
= osd_uld_ioctl
,
216 .llseek
= noop_llseek
,
219 struct osd_dev
*osduld_path_lookup(const char *name
)
221 struct osd_uld_device
*oud
;
222 struct osd_dev_handle
*odh
;
226 if (!name
|| !*name
) {
227 OSD_ERR("Mount with !path || !*path\n");
228 return ERR_PTR(-EINVAL
);
231 odh
= kzalloc(sizeof(*odh
), GFP_KERNEL
);
233 return ERR_PTR(-ENOMEM
);
235 file
= filp_open(name
, O_RDWR
, 0);
237 error
= PTR_ERR(file
);
241 if (file
->f_op
!= &osd_fops
){
246 oud
= file
->private_data
;
258 return ERR_PTR(error
);
260 EXPORT_SYMBOL(osduld_path_lookup
);
262 static inline bool _the_same_or_null(const u8
*a1
, unsigned a1_len
,
263 const u8
*a2
, unsigned a2_len
)
265 if (!a2_len
) /* User string is Empty means don't care */
268 if (a1_len
!= a2_len
)
271 return 0 == memcmp(a1
, a2
, a1_len
);
274 static int _match_odi(struct device
*dev
, const void *find_data
)
276 struct osd_uld_device
*oud
= container_of(dev
, struct osd_uld_device
,
278 const struct osd_dev_info
*odi
= find_data
;
280 if (_the_same_or_null(oud
->odi
.systemid
, oud
->odi
.systemid_len
,
281 odi
->systemid
, odi
->systemid_len
) &&
282 _the_same_or_null(oud
->odi
.osdname
, oud
->odi
.osdname_len
,
283 odi
->osdname
, odi
->osdname_len
)) {
284 OSD_DEBUG("found device sysid_len=%d osdname=%d\n",
285 odi
->systemid_len
, odi
->osdname_len
);
292 /* osduld_info_lookup - Loop through all devices, return the requested osd_dev.
294 * if @odi->systemid_len and/or @odi->osdname_len are zero, they act as a don't
295 * care. .e.g if they're both zero /dev/osd0 is returned.
297 struct osd_dev
*osduld_info_lookup(const struct osd_dev_info
*odi
)
299 struct device
*dev
= class_find_device(&osd_uld_class
, NULL
, odi
, _match_odi
);
301 struct osd_dev_handle
*odh
= kzalloc(sizeof(*odh
), GFP_KERNEL
);
302 struct osd_uld_device
*oud
= container_of(dev
,
303 struct osd_uld_device
, class_dev
);
305 if (unlikely(!odh
)) {
307 return ERR_PTR(-ENOMEM
);
316 return ERR_PTR(-ENODEV
);
318 EXPORT_SYMBOL(osduld_info_lookup
);
320 void osduld_put_device(struct osd_dev
*od
)
322 if (od
&& !IS_ERR(od
)) {
323 struct osd_dev_handle
*odh
=
324 container_of(od
, struct osd_dev_handle
, od
);
325 struct osd_uld_device
*oud
= odh
->oud
;
327 BUG_ON(od
->scsi_device
!= oud
->od
.scsi_device
);
329 /* If scsi has released the device (logout), and exofs has last
330 * reference on oud it will be freed by above osd_uld_release
331 * within fput below. But this will oops in cdev_release which
332 * is called after the fops->release. A get_/put_ pair makes
333 * sure we have a cdev for the duration of fput
336 get_device(&oud
->class_dev
);
339 put_device(&oud
->class_dev
);
343 EXPORT_SYMBOL(osduld_put_device
);
345 const struct osd_dev_info
*osduld_device_info(struct osd_dev
*od
)
347 struct osd_dev_handle
*odh
=
348 container_of(od
, struct osd_dev_handle
, od
);
349 return &odh
->oud
->odi
;
351 EXPORT_SYMBOL(osduld_device_info
);
353 bool osduld_device_same(struct osd_dev
*od
, const struct osd_dev_info
*odi
)
355 struct osd_dev_handle
*odh
=
356 container_of(od
, struct osd_dev_handle
, od
);
357 struct osd_uld_device
*oud
= odh
->oud
;
359 return (oud
->odi
.systemid_len
== odi
->systemid_len
) &&
360 _the_same_or_null(oud
->odi
.systemid
, oud
->odi
.systemid_len
,
361 odi
->systemid
, odi
->systemid_len
) &&
362 (oud
->odi
.osdname_len
== odi
->osdname_len
) &&
363 _the_same_or_null(oud
->odi
.osdname
, oud
->odi
.osdname_len
,
364 odi
->osdname
, odi
->osdname_len
);
366 EXPORT_SYMBOL(osduld_device_same
);
369 * Scsi Device operations
372 static int __detect_osd(struct osd_uld_device
*oud
)
374 struct scsi_device
*scsi_device
= oud
->od
.scsi_device
;
375 char caps
[OSD_CAP_LEN
];
378 /* sending a test_unit_ready as first command seems to be needed
381 OSD_DEBUG("start scsi_test_unit_ready %p %p %p\n",
382 oud
, scsi_device
, scsi_device
->request_queue
);
383 error
= scsi_test_unit_ready(scsi_device
, 10*HZ
, 5, NULL
);
385 OSD_ERR("warning: scsi_test_unit_ready failed\n");
387 osd_sec_init_nosec_doall_caps(caps
, &osd_root_object
, false, true);
388 if (osd_auto_detect_ver(&oud
->od
, caps
, &oud
->odi
))
394 static void __remove(struct device
*dev
)
396 struct osd_uld_device
*oud
= container_of(dev
, struct osd_uld_device
,
398 struct scsi_device
*scsi_device
= oud
->od
.scsi_device
;
400 kfree(oud
->odi
.osdname
);
403 cdev_del(&oud
->cdev
);
405 osd_dev_fini(&oud
->od
);
406 scsi_device_put(scsi_device
);
408 OSD_INFO("osd_remove %s\n",
409 oud
->disk
? oud
->disk
->disk_name
: NULL
);
413 ida_remove(&osd_minor_ida
, oud
->minor
);
418 static int osd_probe(struct device
*dev
)
420 struct scsi_device
*scsi_device
= to_scsi_device(dev
);
421 struct gendisk
*disk
;
422 struct osd_uld_device
*oud
;
426 if (scsi_device
->type
!= TYPE_OSD
)
430 if (!ida_pre_get(&osd_minor_ida
, GFP_KERNEL
))
433 error
= ida_get_new(&osd_minor_ida
, &minor
);
434 } while (error
== -EAGAIN
);
438 if (minor
>= SCSI_OSD_MAX_MINOR
) {
440 goto err_retract_minor
;
444 oud
= kzalloc(sizeof(*oud
), GFP_KERNEL
);
446 goto err_retract_minor
;
448 dev_set_drvdata(dev
, oud
);
451 /* allocate a disk and set it up */
452 /* FIXME: do we need this since sg has already done that */
453 disk
= alloc_disk(1);
455 OSD_ERR("alloc_disk failed\n");
458 disk
->major
= SCSI_OSD_MAJOR
;
459 disk
->first_minor
= oud
->minor
;
460 sprintf(disk
->disk_name
, "osd%d", oud
->minor
);
463 /* hold one more reference to the scsi_device that will get released
464 * in __release, in case a logout is happening while fs is mounted
466 scsi_device_get(scsi_device
);
467 osd_dev_init(&oud
->od
, scsi_device
);
469 /* Detect the OSD Version */
470 error
= __detect_osd(oud
);
472 OSD_ERR("osd detection failed, non-compatible OSD device\n");
476 /* init the char-device for communication with user-mode */
477 cdev_init(&oud
->cdev
, &osd_fops
);
478 oud
->cdev
.owner
= THIS_MODULE
;
479 error
= cdev_add(&oud
->cdev
,
480 MKDEV(SCSI_OSD_MAJOR
, oud
->minor
), 1);
482 OSD_ERR("cdev_add failed\n");
486 /* class device member */
487 oud
->class_dev
.devt
= oud
->cdev
.dev
;
488 oud
->class_dev
.class = &osd_uld_class
;
489 oud
->class_dev
.parent
= dev
;
490 oud
->class_dev
.release
= __remove
;
491 error
= dev_set_name(&oud
->class_dev
, "%s", disk
->disk_name
);
493 OSD_ERR("dev_set_name failed => %d\n", error
);
497 error
= device_register(&oud
->class_dev
);
499 OSD_ERR("device_register failed => %d\n", error
);
503 get_device(&oud
->class_dev
);
505 OSD_INFO("osd_probe %s\n", disk
->disk_name
);
509 cdev_del(&oud
->cdev
);
511 scsi_device_put(scsi_device
);
514 dev_set_drvdata(dev
, NULL
);
517 ida_remove(&osd_minor_ida
, minor
);
521 static int osd_remove(struct device
*dev
)
523 struct scsi_device
*scsi_device
= to_scsi_device(dev
);
524 struct osd_uld_device
*oud
= dev_get_drvdata(dev
);
526 if (!oud
|| (oud
->od
.scsi_device
!= scsi_device
)) {
527 OSD_ERR("Half cooked osd-device %p,%p || %p!=%p",
528 dev
, oud
, oud
? oud
->od
.scsi_device
: NULL
,
532 device_unregister(&oud
->class_dev
);
534 put_device(&oud
->class_dev
);
539 * Global driver and scsi registration
542 static struct scsi_driver osd_driver
= {
545 .owner
= THIS_MODULE
,
547 .remove
= osd_remove
,
551 static int __init
osd_uld_init(void)
555 err
= class_register(&osd_uld_class
);
557 OSD_ERR("Unable to register sysfs class => %d\n", err
);
561 err
= register_chrdev_region(MKDEV(SCSI_OSD_MAJOR
, 0),
562 SCSI_OSD_MAX_MINOR
, osd_name
);
564 OSD_ERR("Unable to register major %d for osd ULD => %d\n",
565 SCSI_OSD_MAJOR
, err
);
569 err
= scsi_register_driver(&osd_driver
.gendrv
);
571 OSD_ERR("scsi_register_driver failed => %d\n", err
);
575 OSD_INFO("LOADED %s\n", osd_version_string
);
579 unregister_chrdev_region(MKDEV(SCSI_OSD_MAJOR
, 0), SCSI_OSD_MAX_MINOR
);
581 class_unregister(&osd_uld_class
);
585 static void __exit
osd_uld_exit(void)
587 scsi_unregister_driver(&osd_driver
.gendrv
);
588 unregister_chrdev_region(MKDEV(SCSI_OSD_MAJOR
, 0), SCSI_OSD_MAX_MINOR
);
589 class_unregister(&osd_uld_class
);
590 OSD_INFO("UNLOADED %s\n", osd_version_string
);
593 module_init(osd_uld_init
);
594 module_exit(osd_uld_exit
);