]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - block/bsg.c
netfilter: nft_exthdr: check for IPv6 packet before further processing
[mirror_ubuntu-jammy-kernel.git] / block / bsg.c
CommitLineData
8c16567d 1// SPDX-License-Identifier: GPL-2.0
3d6392cf 2/*
0c6a89ba 3 * bsg.c - block layer implementation of the sg v4 interface
3d6392cf 4 */
3d6392cf
JA
5#include <linux/module.h>
6#include <linux/init.h>
7#include <linux/file.h>
8#include <linux/blkdev.h>
3d6392cf 9#include <linux/cdev.h>
ad5ebd2f 10#include <linux/jiffies.h>
3d6392cf 11#include <linux/percpu.h>
598443a2 12#include <linux/idr.h>
3d6392cf 13#include <linux/bsg.h>
5a0e3ad6 14#include <linux/slab.h>
3d6392cf
JA
15
16#include <scsi/scsi.h>
17#include <scsi/scsi_ioctl.h>
18#include <scsi/scsi_cmnd.h>
4e2872d6
FT
19#include <scsi/scsi_device.h>
20#include <scsi/scsi_driver.h>
3d6392cf
JA
21#include <scsi/sg.h>
22
0ed081ce
FT
23#define BSG_DESCRIPTION "Block layer SCSI generic (bsg) driver"
24#define BSG_VERSION "0.4"
3d6392cf 25
3124b65d
JT
26#define bsg_dbg(bd, fmt, ...) \
27 pr_debug("%s: " fmt, (bd)->name, ##__VA_ARGS__)
28
3d6392cf 29struct bsg_device {
165125e1 30 struct request_queue *queue;
3d6392cf 31 spinlock_t lock;
3d6392cf 32 struct hlist_node dev_list;
db193954 33 refcount_t ref_count;
3ada8b7e 34 char name[20];
3d6392cf 35 int max_queue;
3d6392cf
JA
36};
37
5309cb38 38#define BSG_DEFAULT_CMDS 64
292b7f27 39#define BSG_MAX_DEVS 32768
3d6392cf 40
3d6392cf 41static DEFINE_MUTEX(bsg_mutex);
598443a2 42static DEFINE_IDR(bsg_minor_idr);
3d6392cf 43
25fd1643 44#define BSG_LIST_ARRAY_SIZE 8
25fd1643 45static struct hlist_head bsg_device_list[BSG_LIST_ARRAY_SIZE];
3d6392cf
JA
46
47static struct class *bsg_class;
46f6ef4a 48static int bsg_major;
3d6392cf 49
1c1133e1 50static inline struct hlist_head *bsg_dev_idx_hash(int index)
3d6392cf 51{
1c1133e1 52 return &bsg_device_list[index & (BSG_LIST_ARRAY_SIZE - 1)];
3d6392cf
JA
53}
54
17cb960f
CH
55#define uptr64(val) ((void __user *)(uintptr_t)(val))
56
57static int bsg_scsi_check_proto(struct sg_io_v4 *hdr)
58{
59 if (hdr->protocol != BSG_PROTOCOL_SCSI ||
60 hdr->subprotocol != BSG_SUB_PROTOCOL_SCSI_CMD)
61 return -EINVAL;
62 return 0;
63}
64
65static int bsg_scsi_fill_hdr(struct request *rq, struct sg_io_v4 *hdr,
66 fmode_t mode)
70e36ece 67{
17cb960f 68 struct scsi_request *sreq = scsi_req(rq);
82ed4db4 69
972248e9
CH
70 if (hdr->dout_xfer_len && hdr->din_xfer_len) {
71 pr_warn_once("BIDI support in bsg has been removed.\n");
72 return -EOPNOTSUPP;
73 }
74
17cb960f
CH
75 sreq->cmd_len = hdr->request_len;
76 if (sreq->cmd_len > BLK_MAX_CDB) {
77 sreq->cmd = kzalloc(sreq->cmd_len, GFP_KERNEL);
78 if (!sreq->cmd)
9f5de6b1
FT
79 return -ENOMEM;
80 }
70e36ece 81
17cb960f 82 if (copy_from_user(sreq->cmd, uptr64(hdr->request), sreq->cmd_len))
70e36ece 83 return -EFAULT;
17cb960f 84 if (blk_verify_command(sreq->cmd, mode))
70e36ece 85 return -EPERM;
70e36ece
FT
86 return 0;
87}
88
17cb960f 89static int bsg_scsi_complete_rq(struct request *rq, struct sg_io_v4 *hdr)
3d6392cf 90{
17cb960f 91 struct scsi_request *sreq = scsi_req(rq);
15d10b61
FT
92 int ret = 0;
93
17cb960f
CH
94 /*
95 * fill in all the output members
96 */
97 hdr->device_status = sreq->result & 0xff;
98 hdr->transport_status = host_byte(sreq->result);
99 hdr->driver_status = driver_byte(sreq->result);
100 hdr->info = 0;
101 if (hdr->device_status || hdr->transport_status || hdr->driver_status)
102 hdr->info |= SG_INFO_CHECK;
103 hdr->response_len = 0;
3d6392cf 104
17cb960f
CH
105 if (sreq->sense_len && hdr->response) {
106 int len = min_t(unsigned int, hdr->max_response_len,
107 sreq->sense_len);
108
109 if (copy_to_user(uptr64(hdr->response), sreq->sense, len))
110 ret = -EFAULT;
111 else
112 hdr->response_len = len;
113 }
114
972248e9 115 if (rq_data_dir(rq) == READ)
17cb960f 116 hdr->din_resid = sreq->resid_len;
972248e9 117 else
17cb960f 118 hdr->dout_resid = sreq->resid_len;
70e36ece 119
15d10b61 120 return ret;
3d6392cf
JA
121}
122
17cb960f
CH
123static void bsg_scsi_free_rq(struct request *rq)
124{
125 scsi_req_free_cmd(scsi_req(rq));
126}
127
128static const struct bsg_ops bsg_scsi_ops = {
129 .check_proto = bsg_scsi_check_proto,
130 .fill_hdr = bsg_scsi_fill_hdr,
131 .complete_rq = bsg_scsi_complete_rq,
132 .free_rq = bsg_scsi_free_rq,
133};
134
ccf3209f 135static int bsg_sg_io(struct request_queue *q, fmode_t mode, void __user *uarg)
3d6392cf 136{
972248e9
CH
137 struct request *rq;
138 struct bio *bio;
ccf3209f 139 struct sg_io_v4 hdr;
aebf526b 140 int ret;
c7a841f3 141
ccf3209f
CH
142 if (copy_from_user(&hdr, uarg, sizeof(hdr)))
143 return -EFAULT;
3d6392cf 144
ccf3209f
CH
145 if (!q->bsg_dev.class_dev)
146 return -ENXIO;
3d6392cf 147
ccf3209f
CH
148 if (hdr.guard != 'Q')
149 return -EINVAL;
150 ret = q->bsg_dev.ops->check_proto(&hdr);
3d6392cf 151 if (ret)
ccf3209f 152 return ret;
3d6392cf 153
ccf3209f 154 rq = blk_get_request(q, hdr.dout_xfer_len ?
ff005a06 155 REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, 0);
a492f075 156 if (IS_ERR(rq))
ccf3209f 157 return PTR_ERR(rq);
f27b087b 158
ccf3209f 159 ret = q->bsg_dev.ops->fill_hdr(rq, &hdr, mode);
0f7b4bc6
PB
160 if (ret) {
161 blk_put_request(rq);
972248e9 162 return ret;
0f7b4bc6 163 }
2c9ecdf4 164
ccf3209f 165 rq->timeout = msecs_to_jiffies(hdr.timeout);
17cb960f
CH
166 if (!rq->timeout)
167 rq->timeout = q->sg_timeout;
168 if (!rq->timeout)
169 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
170 if (rq->timeout < BLK_MIN_SG_TIMEOUT)
171 rq->timeout = BLK_MIN_SG_TIMEOUT;
172
ccf3209f
CH
173 if (hdr.dout_xfer_len) {
174 ret = blk_rq_map_user(q, rq, NULL, uptr64(hdr.dout_xferp),
175 hdr.dout_xfer_len, GFP_KERNEL);
176 } else if (hdr.din_xfer_len) {
177 ret = blk_rq_map_user(q, rq, NULL, uptr64(hdr.din_xferp),
178 hdr.din_xfer_len, GFP_KERNEL);
3d6392cf 179 }
c1c20120 180
17cb960f 181 if (ret)
972248e9 182 goto out_free_rq;
17cb960f 183
ccf3209f 184 bio = rq->bio;
70e36ece 185
684da762 186 blk_execute_rq(NULL, rq, !(hdr.flags & BSG_FLAG_Q_AT_TAIL));
ccf3209f 187 ret = rq->q->bsg_dev.ops->complete_rq(rq, &hdr);
70e36ece 188 blk_rq_unmap_user(bio);
972248e9
CH
189
190out_free_rq:
17cb960f 191 rq->q->bsg_dev.ops->free_rq(rq);
70e36ece 192 blk_put_request(rq);
972248e9 193 if (!ret && copy_to_user(uarg, &hdr, sizeof(hdr)))
ccf3209f
CH
194 return -EFAULT;
195 return ret;
70e36ece
FT
196}
197
3d6392cf
JA
198static struct bsg_device *bsg_alloc_device(void)
199{
3d6392cf 200 struct bsg_device *bd;
3d6392cf
JA
201
202 bd = kzalloc(sizeof(struct bsg_device), GFP_KERNEL);
203 if (unlikely(!bd))
204 return NULL;
205
206 spin_lock_init(&bd->lock);
5309cb38 207 bd->max_queue = BSG_DEFAULT_CMDS;
3d6392cf 208 INIT_HLIST_NODE(&bd->dev_list);
3d6392cf 209 return bd;
3d6392cf
JA
210}
211
212static int bsg_put_device(struct bsg_device *bd)
213{
97f46ae4 214 struct request_queue *q = bd->queue;
3d6392cf
JA
215
216 mutex_lock(&bsg_mutex);
217
db193954 218 if (!refcount_dec_and_test(&bd->ref_count)) {
3f27e3ed 219 mutex_unlock(&bsg_mutex);
28519c89 220 return 0;
3f27e3ed
FT
221 }
222
223 hlist_del(&bd->dev_list);
224 mutex_unlock(&bsg_mutex);
3d6392cf 225
3124b65d 226 bsg_dbg(bd, "tearing down\n");
3d6392cf
JA
227
228 /*
229 * close can always block
230 */
5309cb38 231 kfree(bd);
28519c89
CH
232 blk_put_queue(q);
233 return 0;
3d6392cf
JA
234}
235
236static struct bsg_device *bsg_add_device(struct inode *inode,
d351af01 237 struct request_queue *rq,
3d6392cf
JA
238 struct file *file)
239{
25fd1643 240 struct bsg_device *bd;
3d6392cf 241 unsigned char buf[32];
d9f97264 242
d6c73964
AG
243 lockdep_assert_held(&bsg_mutex);
244
09ac46c4 245 if (!blk_get_queue(rq))
c3ff1b90 246 return ERR_PTR(-ENXIO);
3d6392cf
JA
247
248 bd = bsg_alloc_device();
c3ff1b90
FT
249 if (!bd) {
250 blk_put_queue(rq);
3d6392cf 251 return ERR_PTR(-ENOMEM);
c3ff1b90 252 }
3d6392cf 253
d351af01 254 bd->queue = rq;
0b07de85 255
db193954 256 refcount_set(&bd->ref_count, 1);
842ea771 257 hlist_add_head(&bd->dev_list, bsg_dev_idx_hash(iminor(inode)));
3d6392cf 258
3ada8b7e 259 strncpy(bd->name, dev_name(rq->bsg_dev.class_dev), sizeof(bd->name) - 1);
3124b65d 260 bsg_dbg(bd, "bound to <%s>, max queue %d\n",
9e69fbb5 261 format_dev_t(buf, inode->i_rdev), bd->max_queue);
3d6392cf 262
3d6392cf
JA
263 return bd;
264}
265
842ea771 266static struct bsg_device *__bsg_get_device(int minor, struct request_queue *q)
3d6392cf 267{
43ac9e62 268 struct bsg_device *bd;
3d6392cf 269
d6c73964 270 lockdep_assert_held(&bsg_mutex);
3d6392cf 271
b67bfe0d 272 hlist_for_each_entry(bd, bsg_dev_idx_hash(minor), dev_list) {
842ea771 273 if (bd->queue == q) {
db193954 274 refcount_inc(&bd->ref_count);
43ac9e62 275 goto found;
3d6392cf 276 }
3d6392cf 277 }
43ac9e62
FT
278 bd = NULL;
279found:
3d6392cf
JA
280 return bd;
281}
282
283static struct bsg_device *bsg_get_device(struct inode *inode, struct file *file)
284{
598443a2
FT
285 struct bsg_device *bd;
286 struct bsg_class_device *bcd;
3d6392cf 287
3d6392cf
JA
288 /*
289 * find the class device
290 */
3d6392cf 291 mutex_lock(&bsg_mutex);
598443a2 292 bcd = idr_find(&bsg_minor_idr, iminor(inode));
3d6392cf 293
d6c73964
AG
294 if (!bcd) {
295 bd = ERR_PTR(-ENODEV);
296 goto out_unlock;
297 }
3d6392cf 298
842ea771 299 bd = __bsg_get_device(iminor(inode), bcd->queue);
d6c73964
AG
300 if (!bd)
301 bd = bsg_add_device(inode, bcd->queue, file);
d45ac4fa 302
d6c73964
AG
303out_unlock:
304 mutex_unlock(&bsg_mutex);
d45ac4fa 305 return bd;
3d6392cf
JA
306}
307
308static int bsg_open(struct inode *inode, struct file *file)
309{
75bd2ef1
JC
310 struct bsg_device *bd;
311
75bd2ef1 312 bd = bsg_get_device(inode, file);
3d6392cf
JA
313
314 if (IS_ERR(bd))
315 return PTR_ERR(bd);
316
317 file->private_data = bd;
318 return 0;
319}
320
321static int bsg_release(struct inode *inode, struct file *file)
322{
323 struct bsg_device *bd = file->private_data;
324
325 file->private_data = NULL;
326 return bsg_put_device(bd);
327}
328
ccf3209f
CH
329static int bsg_get_command_q(struct bsg_device *bd, int __user *uarg)
330{
331 return put_user(bd->max_queue, uarg);
332}
333
334static int bsg_set_command_q(struct bsg_device *bd, int __user *uarg)
335{
336 int queue;
337
338 if (get_user(queue, uarg))
339 return -EFAULT;
340 if (queue < 1)
341 return -EINVAL;
342
343 spin_lock_irq(&bd->lock);
344 bd->max_queue = queue;
345 spin_unlock_irq(&bd->lock);
346 return 0;
347}
348
25fd1643 349static long bsg_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
3d6392cf
JA
350{
351 struct bsg_device *bd = file->private_data;
ccf3209f 352 void __user *uarg = (void __user *) arg;
3d6392cf 353
3d6392cf 354 switch (cmd) {
ccf3209f
CH
355 /*
356 * Our own ioctls
357 */
3d6392cf 358 case SG_GET_COMMAND_Q:
ccf3209f
CH
359 return bsg_get_command_q(bd, uarg);
360 case SG_SET_COMMAND_Q:
361 return bsg_set_command_q(bd, uarg);
3d6392cf
JA
362
363 /*
364 * SCSI/sg ioctls
365 */
366 case SG_GET_VERSION_NUM:
367 case SCSI_IOCTL_GET_IDLUN:
368 case SCSI_IOCTL_GET_BUS_NUMBER:
369 case SG_SET_TIMEOUT:
370 case SG_GET_TIMEOUT:
371 case SG_GET_RESERVED_SIZE:
372 case SG_SET_RESERVED_SIZE:
373 case SG_EMULATED_HOST:
ccf3209f 374 case SCSI_IOCTL_SEND_COMMAND:
74f3c8af 375 return scsi_cmd_ioctl(bd->queue, NULL, file->f_mode, cmd, uarg);
ccf3209f
CH
376 case SG_IO:
377 return bsg_sg_io(bd->queue, file->f_mode, uarg);
3d6392cf 378 default:
3d6392cf 379 return -ENOTTY;
3d6392cf
JA
380 }
381}
382
7344be05 383static const struct file_operations bsg_fops = {
3d6392cf
JA
384 .open = bsg_open,
385 .release = bsg_release,
25fd1643 386 .unlocked_ioctl = bsg_ioctl,
fe0da4e5 387 .compat_ioctl = compat_ptr_ioctl,
3d6392cf 388 .owner = THIS_MODULE,
6038f373 389 .llseek = default_llseek,
3d6392cf
JA
390};
391
d351af01 392void bsg_unregister_queue(struct request_queue *q)
3d6392cf 393{
d351af01 394 struct bsg_class_device *bcd = &q->bsg_dev;
3d6392cf 395
df468820
FT
396 if (!bcd->class_dev)
397 return;
3d6392cf
JA
398
399 mutex_lock(&bsg_mutex);
598443a2 400 idr_remove(&bsg_minor_idr, bcd->minor);
37b40adf
SG
401 if (q->kobj.sd)
402 sysfs_remove_link(&q->kobj, "bsg");
ee959b00 403 device_unregister(bcd->class_dev);
3d6392cf 404 bcd->class_dev = NULL;
3d6392cf
JA
405 mutex_unlock(&bsg_mutex);
406}
4cf0723a 407EXPORT_SYMBOL_GPL(bsg_unregister_queue);
3d6392cf 408
97f46ae4 409int bsg_register_queue(struct request_queue *q, struct device *parent,
5de815a7 410 const char *name, const struct bsg_ops *ops)
3d6392cf 411{
598443a2 412 struct bsg_class_device *bcd;
3d6392cf 413 dev_t dev;
bab998d6 414 int ret;
ee959b00 415 struct device *class_dev = NULL;
3d6392cf
JA
416
417 /*
418 * we need a proper transport to send commands, not a stacked device
419 */
344e9ffc 420 if (!queue_is_mq(q))
3d6392cf
JA
421 return 0;
422
d351af01 423 bcd = &q->bsg_dev;
3d6392cf 424 memset(bcd, 0, sizeof(*bcd));
3d6392cf
JA
425
426 mutex_lock(&bsg_mutex);
292b7f27 427
bab998d6
TH
428 ret = idr_alloc(&bsg_minor_idr, bcd, 0, BSG_MAX_DEVS, GFP_KERNEL);
429 if (ret < 0) {
430 if (ret == -ENOSPC) {
431 printk(KERN_ERR "bsg: too many bsg devices\n");
432 ret = -EINVAL;
433 }
598443a2 434 goto unlock;
598443a2
FT
435 }
436
bab998d6 437 bcd->minor = ret;
d351af01 438 bcd->queue = q;
17cb960f 439 bcd->ops = ops;
46f6ef4a 440 dev = MKDEV(bsg_major, bcd->minor);
5de815a7 441 class_dev = device_create(bsg_class, parent, dev, NULL, "%s", name);
4e2872d6
FT
442 if (IS_ERR(class_dev)) {
443 ret = PTR_ERR(class_dev);
5de815a7 444 goto idr_remove;
4e2872d6
FT
445 }
446 bcd->class_dev = class_dev;
447
abce891a 448 if (q->kobj.sd) {
4e2872d6
FT
449 ret = sysfs_create_link(&q->kobj, &bcd->class_dev->kobj, "bsg");
450 if (ret)
598443a2 451 goto unregister_class_dev;
4e2872d6
FT
452 }
453
3d6392cf
JA
454 mutex_unlock(&bsg_mutex);
455 return 0;
6826ee4f 456
598443a2 457unregister_class_dev:
ee959b00 458 device_unregister(class_dev);
5de815a7 459idr_remove:
bab998d6 460 idr_remove(&bsg_minor_idr, bcd->minor);
598443a2 461unlock:
264a0472 462 mutex_unlock(&bsg_mutex);
4e2872d6
FT
463 return ret;
464}
17cb960f
CH
465
466int bsg_scsi_register_queue(struct request_queue *q, struct device *parent)
467{
468 if (!blk_queue_scsi_passthrough(q)) {
469 WARN_ONCE(true, "Attempt to register a non-SCSI queue\n");
470 return -EINVAL;
471 }
472
5de815a7 473 return bsg_register_queue(q, parent, dev_name(parent), &bsg_scsi_ops);
17cb960f
CH
474}
475EXPORT_SYMBOL_GPL(bsg_scsi_register_queue);
4e2872d6 476
7e7654a9 477static struct cdev bsg_cdev;
292b7f27 478
2c9ede55 479static char *bsg_devnode(struct device *dev, umode_t *mode)
2bdf9149
KS
480{
481 return kasprintf(GFP_KERNEL, "bsg/%s", dev_name(dev));
482}
483
3d6392cf
JA
484static int __init bsg_init(void)
485{
486 int ret, i;
46f6ef4a 487 dev_t devid;
3d6392cf 488
25fd1643 489 for (i = 0; i < BSG_LIST_ARRAY_SIZE; i++)
3d6392cf
JA
490 INIT_HLIST_HEAD(&bsg_device_list[i]);
491
492 bsg_class = class_create(THIS_MODULE, "bsg");
28519c89
CH
493 if (IS_ERR(bsg_class))
494 return PTR_ERR(bsg_class);
e454cea2 495 bsg_class->devnode = bsg_devnode;
3d6392cf 496
46f6ef4a 497 ret = alloc_chrdev_region(&devid, 0, BSG_MAX_DEVS, "bsg");
9b9f770c
FT
498 if (ret)
499 goto destroy_bsg_class;
292b7f27 500
46f6ef4a
JA
501 bsg_major = MAJOR(devid);
502
292b7f27 503 cdev_init(&bsg_cdev, &bsg_fops);
46f6ef4a 504 ret = cdev_add(&bsg_cdev, MKDEV(bsg_major, 0), BSG_MAX_DEVS);
9b9f770c
FT
505 if (ret)
506 goto unregister_chrdev;
3d6392cf 507
5d3a8cd3 508 printk(KERN_INFO BSG_DESCRIPTION " version " BSG_VERSION
0ed081ce 509 " loaded (major %d)\n", bsg_major);
3d6392cf 510 return 0;
9b9f770c
FT
511unregister_chrdev:
512 unregister_chrdev_region(MKDEV(bsg_major, 0), BSG_MAX_DEVS);
513destroy_bsg_class:
514 class_destroy(bsg_class);
9b9f770c 515 return ret;
3d6392cf
JA
516}
517
518MODULE_AUTHOR("Jens Axboe");
0ed081ce 519MODULE_DESCRIPTION(BSG_DESCRIPTION);
3d6392cf
JA
520MODULE_LICENSE("GPL");
521
4e2872d6 522device_initcall(bsg_init);