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 <bharrosh@panasas.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>
54 #include <scsi/scsi.h>
55 #include <scsi/scsi_driver.h>
56 #include <scsi/scsi_device.h>
57 #include <scsi/scsi_ioctl.h>
59 #include <scsi/osd_initiator.h>
60 #include <scsi/osd_sec.h>
62 #include "osd_debug.h"
65 # define TYPE_OSD 0x11
68 #ifndef SCSI_OSD_MAJOR
69 # define SCSI_OSD_MAJOR 260
71 #define SCSI_OSD_MAX_MINOR 64
73 static const char osd_name
[] = "osd";
74 static const char *osd_version_string
= "open-osd 0.2.0";
76 MODULE_AUTHOR("Boaz Harrosh <bharrosh@panasas.com>");
77 MODULE_DESCRIPTION("open-osd Upper-Layer-Driver osd.ko");
78 MODULE_LICENSE("GPL");
79 MODULE_ALIAS_CHARDEV_MAJOR(SCSI_OSD_MAJOR
);
80 MODULE_ALIAS_SCSI_DEVICE(TYPE_OSD
);
82 struct osd_uld_device
{
84 struct device class_dev
;
87 struct osd_dev_info odi
;
91 struct osd_dev_handle
{
94 struct osd_uld_device
*oud
;
97 static DEFINE_IDA(osd_minor_ida
);
99 static struct class osd_uld_class
= {
100 .owner
= THIS_MODULE
,
105 * Char Device operations
108 static int osd_uld_open(struct inode
*inode
, struct file
*file
)
110 struct osd_uld_device
*oud
= container_of(inode
->i_cdev
,
111 struct osd_uld_device
, cdev
);
113 get_device(&oud
->class_dev
);
114 /* cache osd_uld_device on file handle */
115 file
->private_data
= oud
;
116 OSD_DEBUG("osd_uld_open %p\n", oud
);
120 static int osd_uld_release(struct inode
*inode
, struct file
*file
)
122 struct osd_uld_device
*oud
= file
->private_data
;
124 OSD_DEBUG("osd_uld_release %p\n", file
->private_data
);
125 file
->private_data
= NULL
;
126 put_device(&oud
->class_dev
);
130 /* FIXME: Only one vector for now */
131 unsigned g_test_ioctl
;
132 do_test_fn
*g_do_test
;
134 int osduld_register_test(unsigned ioctl
, do_test_fn
*do_test
)
139 g_test_ioctl
= ioctl
;
143 EXPORT_SYMBOL(osduld_register_test
);
145 void osduld_unregister_test(unsigned ioctl
)
147 if (ioctl
== g_test_ioctl
) {
152 EXPORT_SYMBOL(osduld_unregister_test
);
154 static do_test_fn
*_find_ioctl(unsigned cmd
)
156 if (g_test_ioctl
== cmd
)
162 static long osd_uld_ioctl(struct file
*file
, unsigned int cmd
,
165 struct osd_uld_device
*oud
= file
->private_data
;
169 do_test
= _find_ioctl(cmd
);
171 ret
= do_test(&oud
->od
, cmd
, arg
);
173 OSD_ERR("Unknown ioctl %d: osd_uld_device=%p\n", cmd
, oud
);
179 static const struct file_operations osd_fops
= {
180 .owner
= THIS_MODULE
,
181 .open
= osd_uld_open
,
182 .release
= osd_uld_release
,
183 .unlocked_ioctl
= osd_uld_ioctl
,
186 struct osd_dev
*osduld_path_lookup(const char *name
)
188 struct osd_uld_device
*oud
;
189 struct osd_dev_handle
*odh
;
193 if (!name
|| !*name
) {
194 OSD_ERR("Mount with !path || !*path\n");
195 return ERR_PTR(-EINVAL
);
198 odh
= kzalloc(sizeof(*odh
), GFP_KERNEL
);
200 return ERR_PTR(-ENOMEM
);
202 file
= filp_open(name
, O_RDWR
, 0);
204 error
= PTR_ERR(file
);
208 if (file
->f_op
!= &osd_fops
){
213 oud
= file
->private_data
;
225 return ERR_PTR(error
);
227 EXPORT_SYMBOL(osduld_path_lookup
);
229 static inline bool _the_same_or_null(const u8
*a1
, unsigned a1_len
,
230 const u8
*a2
, unsigned a2_len
)
232 if (!a2_len
) /* User string is Empty means don't care */
235 if (a1_len
!= a2_len
)
238 return 0 == memcmp(a1
, a2
, a1_len
);
242 const struct osd_dev_info
*odi
;
244 struct osd_uld_device
*oud
;
247 int _mach_odi(struct device
*dev
, void *find_data
)
249 struct osd_uld_device
*oud
= container_of(dev
, struct osd_uld_device
,
251 struct find_oud_t
*fot
= find_data
;
252 const struct osd_dev_info
*odi
= fot
->odi
;
254 if (_the_same_or_null(oud
->odi
.systemid
, oud
->odi
.systemid_len
,
255 odi
->systemid
, odi
->systemid_len
) &&
256 _the_same_or_null(oud
->odi
.osdname
, oud
->odi
.osdname_len
,
257 odi
->osdname
, odi
->osdname_len
)) {
258 OSD_DEBUG("found device sysid_len=%d osdname=%d\n",
259 odi
->systemid_len
, odi
->osdname_len
);
267 /* osduld_info_lookup - Loop through all devices, return the requested osd_dev.
269 * if @odi->systemid_len and/or @odi->osdname_len are zero, they act as a don't
270 * care. .e.g if they're both zero /dev/osd0 is returned.
272 struct osd_dev
*osduld_info_lookup(const struct osd_dev_info
*odi
)
274 struct find_oud_t find
= {.odi
= odi
};
276 find
.dev
= class_find_device(&osd_uld_class
, NULL
, &find
, _mach_odi
);
277 if (likely(find
.dev
)) {
278 struct osd_dev_handle
*odh
= kzalloc(sizeof(*odh
), GFP_KERNEL
);
280 if (unlikely(!odh
)) {
281 put_device(find
.dev
);
282 return ERR_PTR(-ENOMEM
);
285 odh
->od
= find
.oud
->od
;
291 return ERR_PTR(-ENODEV
);
293 EXPORT_SYMBOL(osduld_info_lookup
);
295 void osduld_put_device(struct osd_dev
*od
)
297 if (od
&& !IS_ERR(od
)) {
298 struct osd_dev_handle
*odh
=
299 container_of(od
, struct osd_dev_handle
, od
);
300 struct osd_uld_device
*oud
= odh
->oud
;
302 BUG_ON(od
->scsi_device
!= oud
->od
.scsi_device
);
304 /* If scsi has released the device (logout), and exofs has last
305 * reference on oud it will be freed by above osd_uld_release
306 * within fput below. But this will oops in cdev_release which
307 * is called after the fops->release. A get_/put_ pair makes
308 * sure we have a cdev for the duration of fput
311 get_device(&oud
->class_dev
);
314 put_device(&oud
->class_dev
);
318 EXPORT_SYMBOL(osduld_put_device
);
320 const struct osd_dev_info
*osduld_device_info(struct osd_dev
*od
)
322 struct osd_dev_handle
*odh
=
323 container_of(od
, struct osd_dev_handle
, od
);
324 return &odh
->oud
->odi
;
326 EXPORT_SYMBOL(osduld_device_info
);
328 bool osduld_device_same(struct osd_dev
*od
, const struct osd_dev_info
*odi
)
330 struct osd_dev_handle
*odh
=
331 container_of(od
, struct osd_dev_handle
, od
);
332 struct osd_uld_device
*oud
= odh
->oud
;
334 return (oud
->odi
.systemid_len
== odi
->systemid_len
) &&
335 _the_same_or_null(oud
->odi
.systemid
, oud
->odi
.systemid_len
,
336 odi
->systemid
, odi
->systemid_len
) &&
337 (oud
->odi
.osdname_len
== odi
->osdname_len
) &&
338 _the_same_or_null(oud
->odi
.osdname
, oud
->odi
.osdname_len
,
339 odi
->osdname
, odi
->osdname_len
);
341 EXPORT_SYMBOL(osduld_device_same
);
344 * Scsi Device operations
347 static int __detect_osd(struct osd_uld_device
*oud
)
349 struct scsi_device
*scsi_device
= oud
->od
.scsi_device
;
350 char caps
[OSD_CAP_LEN
];
353 /* sending a test_unit_ready as first command seems to be needed
356 OSD_DEBUG("start scsi_test_unit_ready %p %p %p\n",
357 oud
, scsi_device
, scsi_device
->request_queue
);
358 error
= scsi_test_unit_ready(scsi_device
, 10*HZ
, 5, NULL
);
360 OSD_ERR("warning: scsi_test_unit_ready failed\n");
362 osd_sec_init_nosec_doall_caps(caps
, &osd_root_object
, false, true);
363 if (osd_auto_detect_ver(&oud
->od
, caps
, &oud
->odi
))
369 static void __remove(struct device
*dev
)
371 struct osd_uld_device
*oud
= container_of(dev
, struct osd_uld_device
,
373 struct scsi_device
*scsi_device
= oud
->od
.scsi_device
;
375 kfree(oud
->odi
.osdname
);
378 cdev_del(&oud
->cdev
);
380 osd_dev_fini(&oud
->od
);
381 scsi_device_put(scsi_device
);
383 OSD_INFO("osd_remove %s\n",
384 oud
->disk
? oud
->disk
->disk_name
: NULL
);
388 ida_remove(&osd_minor_ida
, oud
->minor
);
393 static int osd_probe(struct device
*dev
)
395 struct scsi_device
*scsi_device
= to_scsi_device(dev
);
396 struct gendisk
*disk
;
397 struct osd_uld_device
*oud
;
401 if (scsi_device
->type
!= TYPE_OSD
)
405 if (!ida_pre_get(&osd_minor_ida
, GFP_KERNEL
))
408 error
= ida_get_new(&osd_minor_ida
, &minor
);
409 } while (error
== -EAGAIN
);
413 if (minor
>= SCSI_OSD_MAX_MINOR
) {
415 goto err_retract_minor
;
419 oud
= kzalloc(sizeof(*oud
), GFP_KERNEL
);
421 goto err_retract_minor
;
423 dev_set_drvdata(dev
, oud
);
426 /* allocate a disk and set it up */
427 /* FIXME: do we need this since sg has already done that */
428 disk
= alloc_disk(1);
430 OSD_ERR("alloc_disk failed\n");
433 disk
->major
= SCSI_OSD_MAJOR
;
434 disk
->first_minor
= oud
->minor
;
435 sprintf(disk
->disk_name
, "osd%d", oud
->minor
);
438 /* hold one more reference to the scsi_device that will get released
439 * in __release, in case a logout is happening while fs is mounted
441 scsi_device_get(scsi_device
);
442 osd_dev_init(&oud
->od
, scsi_device
);
444 /* Detect the OSD Version */
445 error
= __detect_osd(oud
);
447 OSD_ERR("osd detection failed, non-compatible OSD device\n");
451 /* init the char-device for communication with user-mode */
452 cdev_init(&oud
->cdev
, &osd_fops
);
453 oud
->cdev
.owner
= THIS_MODULE
;
454 error
= cdev_add(&oud
->cdev
,
455 MKDEV(SCSI_OSD_MAJOR
, oud
->minor
), 1);
457 OSD_ERR("cdev_add failed\n");
461 /* class device member */
462 oud
->class_dev
.devt
= oud
->cdev
.dev
;
463 oud
->class_dev
.class = &osd_uld_class
;
464 oud
->class_dev
.parent
= dev
;
465 oud
->class_dev
.release
= __remove
;
466 error
= dev_set_name(&oud
->class_dev
, disk
->disk_name
);
468 OSD_ERR("dev_set_name failed => %d\n", error
);
472 error
= device_register(&oud
->class_dev
);
474 OSD_ERR("device_register failed => %d\n", error
);
478 get_device(&oud
->class_dev
);
480 OSD_INFO("osd_probe %s\n", disk
->disk_name
);
484 cdev_del(&oud
->cdev
);
486 scsi_device_put(scsi_device
);
489 dev_set_drvdata(dev
, NULL
);
492 ida_remove(&osd_minor_ida
, minor
);
496 static int osd_remove(struct device
*dev
)
498 struct scsi_device
*scsi_device
= to_scsi_device(dev
);
499 struct osd_uld_device
*oud
= dev_get_drvdata(dev
);
501 if (!oud
|| (oud
->od
.scsi_device
!= scsi_device
)) {
502 OSD_ERR("Half cooked osd-device %p,%p || %p!=%p",
503 dev
, oud
, oud
? oud
->od
.scsi_device
: NULL
,
507 device_unregister(&oud
->class_dev
);
509 put_device(&oud
->class_dev
);
514 * Global driver and scsi registration
517 static struct scsi_driver osd_driver
= {
518 .owner
= THIS_MODULE
,
522 .remove
= osd_remove
,
526 static int __init
osd_uld_init(void)
530 err
= class_register(&osd_uld_class
);
532 OSD_ERR("Unable to register sysfs class => %d\n", err
);
536 err
= register_chrdev_region(MKDEV(SCSI_OSD_MAJOR
, 0),
537 SCSI_OSD_MAX_MINOR
, osd_name
);
539 OSD_ERR("Unable to register major %d for osd ULD => %d\n",
540 SCSI_OSD_MAJOR
, err
);
544 err
= scsi_register_driver(&osd_driver
.gendrv
);
546 OSD_ERR("scsi_register_driver failed => %d\n", err
);
550 OSD_INFO("LOADED %s\n", osd_version_string
);
554 unregister_chrdev_region(MKDEV(SCSI_OSD_MAJOR
, 0), SCSI_OSD_MAX_MINOR
);
556 class_unregister(&osd_uld_class
);
560 static void __exit
osd_uld_exit(void)
562 scsi_unregister_driver(&osd_driver
.gendrv
);
563 unregister_chrdev_region(MKDEV(SCSI_OSD_MAJOR
, 0), SCSI_OSD_MAX_MINOR
);
564 class_unregister(&osd_uld_class
);
565 OSD_INFO("UNLOADED %s\n", osd_version_string
);
568 module_init(osd_uld_init
);
569 module_exit(osd_uld_exit
);