]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - drivers/block/nbd.c
block: fold cmd_type into the REQ_OP_ space
[mirror_ubuntu-bionic-kernel.git] / drivers / block / nbd.c
1 /*
2 * Network block device - make block devices work over TCP
3 *
4 * Note that you can not swap over this thing, yet. Seems to work but
5 * deadlocks sometimes - you can not swap over TCP in general.
6 *
7 * Copyright 1997-2000, 2008 Pavel Machek <pavel@ucw.cz>
8 * Parts copyright 2001 Steven Whitehouse <steve@chygwyn.com>
9 *
10 * This file is released under GPLv2 or later.
11 *
12 * (part of code stolen from loop.c)
13 */
14
15 #include <linux/major.h>
16
17 #include <linux/blkdev.h>
18 #include <linux/module.h>
19 #include <linux/init.h>
20 #include <linux/sched.h>
21 #include <linux/fs.h>
22 #include <linux/bio.h>
23 #include <linux/stat.h>
24 #include <linux/errno.h>
25 #include <linux/file.h>
26 #include <linux/ioctl.h>
27 #include <linux/mutex.h>
28 #include <linux/compiler.h>
29 #include <linux/err.h>
30 #include <linux/kernel.h>
31 #include <linux/slab.h>
32 #include <net/sock.h>
33 #include <linux/net.h>
34 #include <linux/kthread.h>
35 #include <linux/types.h>
36 #include <linux/debugfs.h>
37 #include <linux/blk-mq.h>
38
39 #include <linux/uaccess.h>
40 #include <asm/types.h>
41
42 #include <linux/nbd.h>
43
44 struct nbd_sock {
45 struct socket *sock;
46 struct mutex tx_lock;
47 };
48
49 #define NBD_TIMEDOUT 0
50 #define NBD_DISCONNECT_REQUESTED 1
51 #define NBD_DISCONNECTED 2
52 #define NBD_RUNNING 3
53
54 struct nbd_device {
55 u32 flags;
56 unsigned long runtime_flags;
57 struct nbd_sock **socks;
58 int magic;
59
60 struct blk_mq_tag_set tag_set;
61
62 struct mutex config_lock;
63 struct gendisk *disk;
64 int num_connections;
65 atomic_t recv_threads;
66 wait_queue_head_t recv_wq;
67 loff_t blksize;
68 loff_t bytesize;
69
70 struct task_struct *task_recv;
71 struct task_struct *task_setup;
72
73 #if IS_ENABLED(CONFIG_DEBUG_FS)
74 struct dentry *dbg_dir;
75 #endif
76 };
77
78 struct nbd_cmd {
79 struct nbd_device *nbd;
80 struct completion send_complete;
81 };
82
83 #if IS_ENABLED(CONFIG_DEBUG_FS)
84 static struct dentry *nbd_dbg_dir;
85 #endif
86
87 #define nbd_name(nbd) ((nbd)->disk->disk_name)
88
89 #define NBD_MAGIC 0x68797548
90
91 static unsigned int nbds_max = 16;
92 static struct nbd_device *nbd_dev;
93 static int max_part;
94
95 static inline struct device *nbd_to_dev(struct nbd_device *nbd)
96 {
97 return disk_to_dev(nbd->disk);
98 }
99
100 static bool nbd_is_connected(struct nbd_device *nbd)
101 {
102 return !!nbd->task_recv;
103 }
104
105 static const char *nbdcmd_to_ascii(int cmd)
106 {
107 switch (cmd) {
108 case NBD_CMD_READ: return "read";
109 case NBD_CMD_WRITE: return "write";
110 case NBD_CMD_DISC: return "disconnect";
111 case NBD_CMD_FLUSH: return "flush";
112 case NBD_CMD_TRIM: return "trim/discard";
113 }
114 return "invalid";
115 }
116
117 static int nbd_size_clear(struct nbd_device *nbd, struct block_device *bdev)
118 {
119 bdev->bd_inode->i_size = 0;
120 set_capacity(nbd->disk, 0);
121 kobject_uevent(&nbd_to_dev(nbd)->kobj, KOBJ_CHANGE);
122
123 return 0;
124 }
125
126 static void nbd_size_update(struct nbd_device *nbd, struct block_device *bdev)
127 {
128 if (!nbd_is_connected(nbd))
129 return;
130
131 bdev->bd_inode->i_size = nbd->bytesize;
132 set_capacity(nbd->disk, nbd->bytesize >> 9);
133 kobject_uevent(&nbd_to_dev(nbd)->kobj, KOBJ_CHANGE);
134 }
135
136 static int nbd_size_set(struct nbd_device *nbd, struct block_device *bdev,
137 loff_t blocksize, loff_t nr_blocks)
138 {
139 int ret;
140
141 ret = set_blocksize(bdev, blocksize);
142 if (ret)
143 return ret;
144
145 nbd->blksize = blocksize;
146 nbd->bytesize = blocksize * nr_blocks;
147
148 nbd_size_update(nbd, bdev);
149
150 return 0;
151 }
152
153 static void nbd_end_request(struct nbd_cmd *cmd)
154 {
155 struct nbd_device *nbd = cmd->nbd;
156 struct request *req = blk_mq_rq_from_pdu(cmd);
157 int error = req->errors ? -EIO : 0;
158
159 dev_dbg(nbd_to_dev(nbd), "request %p: %s\n", cmd,
160 error ? "failed" : "done");
161
162 blk_mq_complete_request(req, error);
163 }
164
165 /*
166 * Forcibly shutdown the socket causing all listeners to error
167 */
168 static void sock_shutdown(struct nbd_device *nbd)
169 {
170 int i;
171
172 if (nbd->num_connections == 0)
173 return;
174 if (test_and_set_bit(NBD_DISCONNECTED, &nbd->runtime_flags))
175 return;
176
177 for (i = 0; i < nbd->num_connections; i++) {
178 struct nbd_sock *nsock = nbd->socks[i];
179 mutex_lock(&nsock->tx_lock);
180 kernel_sock_shutdown(nsock->sock, SHUT_RDWR);
181 mutex_unlock(&nsock->tx_lock);
182 }
183 dev_warn(disk_to_dev(nbd->disk), "shutting down sockets\n");
184 }
185
186 static enum blk_eh_timer_return nbd_xmit_timeout(struct request *req,
187 bool reserved)
188 {
189 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(req);
190 struct nbd_device *nbd = cmd->nbd;
191
192 dev_err(nbd_to_dev(nbd), "Connection timed out, shutting down connection\n");
193 set_bit(NBD_TIMEDOUT, &nbd->runtime_flags);
194 req->errors++;
195
196 mutex_lock(&nbd->config_lock);
197 sock_shutdown(nbd);
198 mutex_unlock(&nbd->config_lock);
199 return BLK_EH_HANDLED;
200 }
201
202 /*
203 * Send or receive packet.
204 */
205 static int sock_xmit(struct nbd_device *nbd, int index, int send, void *buf,
206 int size, int msg_flags)
207 {
208 struct socket *sock = nbd->socks[index]->sock;
209 int result;
210 struct msghdr msg;
211 struct kvec iov;
212 unsigned long pflags = current->flags;
213
214 if (unlikely(!sock)) {
215 dev_err_ratelimited(disk_to_dev(nbd->disk),
216 "Attempted %s on closed socket in sock_xmit\n",
217 (send ? "send" : "recv"));
218 return -EINVAL;
219 }
220
221 current->flags |= PF_MEMALLOC;
222 do {
223 sock->sk->sk_allocation = GFP_NOIO | __GFP_MEMALLOC;
224 iov.iov_base = buf;
225 iov.iov_len = size;
226 msg.msg_name = NULL;
227 msg.msg_namelen = 0;
228 msg.msg_control = NULL;
229 msg.msg_controllen = 0;
230 msg.msg_flags = msg_flags | MSG_NOSIGNAL;
231
232 if (send)
233 result = kernel_sendmsg(sock, &msg, &iov, 1, size);
234 else
235 result = kernel_recvmsg(sock, &msg, &iov, 1, size,
236 msg.msg_flags);
237
238 if (result <= 0) {
239 if (result == 0)
240 result = -EPIPE; /* short read */
241 break;
242 }
243 size -= result;
244 buf += result;
245 } while (size > 0);
246
247 tsk_restore_flags(current, pflags, PF_MEMALLOC);
248
249 return result;
250 }
251
252 static inline int sock_send_bvec(struct nbd_device *nbd, int index,
253 struct bio_vec *bvec, int flags)
254 {
255 int result;
256 void *kaddr = kmap(bvec->bv_page);
257 result = sock_xmit(nbd, index, 1, kaddr + bvec->bv_offset,
258 bvec->bv_len, flags);
259 kunmap(bvec->bv_page);
260 return result;
261 }
262
263 /* always call with the tx_lock held */
264 static int nbd_send_cmd(struct nbd_device *nbd, struct nbd_cmd *cmd, int index)
265 {
266 struct request *req = blk_mq_rq_from_pdu(cmd);
267 int result;
268 struct nbd_request request;
269 unsigned long size = blk_rq_bytes(req);
270 struct bio *bio;
271 u32 type;
272 u32 tag = blk_mq_unique_tag(req);
273
274 switch (req_op(req)) {
275 case REQ_OP_DISCARD:
276 type = NBD_CMD_TRIM;
277 break;
278 case REQ_OP_FLUSH:
279 type = NBD_CMD_FLUSH;
280 break;
281 case REQ_OP_WRITE:
282 type = NBD_CMD_WRITE;
283 break;
284 case REQ_OP_READ:
285 type = NBD_CMD_READ;
286 break;
287 default:
288 return -EIO;
289 }
290
291 if (rq_data_dir(req) == WRITE &&
292 (nbd->flags & NBD_FLAG_READ_ONLY)) {
293 dev_err_ratelimited(disk_to_dev(nbd->disk),
294 "Write on read-only\n");
295 return -EIO;
296 }
297
298 memset(&request, 0, sizeof(request));
299 request.magic = htonl(NBD_REQUEST_MAGIC);
300 request.type = htonl(type);
301 if (type != NBD_CMD_FLUSH) {
302 request.from = cpu_to_be64((u64)blk_rq_pos(req) << 9);
303 request.len = htonl(size);
304 }
305 memcpy(request.handle, &tag, sizeof(tag));
306
307 dev_dbg(nbd_to_dev(nbd), "request %p: sending control (%s@%llu,%uB)\n",
308 cmd, nbdcmd_to_ascii(type),
309 (unsigned long long)blk_rq_pos(req) << 9, blk_rq_bytes(req));
310 result = sock_xmit(nbd, index, 1, &request, sizeof(request),
311 (type == NBD_CMD_WRITE) ? MSG_MORE : 0);
312 if (result <= 0) {
313 dev_err_ratelimited(disk_to_dev(nbd->disk),
314 "Send control failed (result %d)\n", result);
315 return -EIO;
316 }
317
318 if (type != NBD_CMD_WRITE)
319 return 0;
320
321 bio = req->bio;
322 while (bio) {
323 struct bio *next = bio->bi_next;
324 struct bvec_iter iter;
325 struct bio_vec bvec;
326
327 bio_for_each_segment(bvec, bio, iter) {
328 bool is_last = !next && bio_iter_last(bvec, iter);
329 int flags = is_last ? 0 : MSG_MORE;
330
331 dev_dbg(nbd_to_dev(nbd), "request %p: sending %d bytes data\n",
332 cmd, bvec.bv_len);
333 result = sock_send_bvec(nbd, index, &bvec, flags);
334 if (result <= 0) {
335 dev_err(disk_to_dev(nbd->disk),
336 "Send data failed (result %d)\n",
337 result);
338 return -EIO;
339 }
340 /*
341 * The completion might already have come in,
342 * so break for the last one instead of letting
343 * the iterator do it. This prevents use-after-free
344 * of the bio.
345 */
346 if (is_last)
347 break;
348 }
349 bio = next;
350 }
351 return 0;
352 }
353
354 static inline int sock_recv_bvec(struct nbd_device *nbd, int index,
355 struct bio_vec *bvec)
356 {
357 int result;
358 void *kaddr = kmap(bvec->bv_page);
359 result = sock_xmit(nbd, index, 0, kaddr + bvec->bv_offset,
360 bvec->bv_len, MSG_WAITALL);
361 kunmap(bvec->bv_page);
362 return result;
363 }
364
365 /* NULL returned = something went wrong, inform userspace */
366 static struct nbd_cmd *nbd_read_stat(struct nbd_device *nbd, int index)
367 {
368 int result;
369 struct nbd_reply reply;
370 struct nbd_cmd *cmd;
371 struct request *req = NULL;
372 u16 hwq;
373 u32 tag;
374
375 reply.magic = 0;
376 result = sock_xmit(nbd, index, 0, &reply, sizeof(reply), MSG_WAITALL);
377 if (result <= 0) {
378 if (!test_bit(NBD_DISCONNECTED, &nbd->runtime_flags) &&
379 !test_bit(NBD_DISCONNECT_REQUESTED, &nbd->runtime_flags))
380 dev_err(disk_to_dev(nbd->disk),
381 "Receive control failed (result %d)\n", result);
382 return ERR_PTR(result);
383 }
384
385 if (ntohl(reply.magic) != NBD_REPLY_MAGIC) {
386 dev_err(disk_to_dev(nbd->disk), "Wrong magic (0x%lx)\n",
387 (unsigned long)ntohl(reply.magic));
388 return ERR_PTR(-EPROTO);
389 }
390
391 memcpy(&tag, reply.handle, sizeof(u32));
392
393 hwq = blk_mq_unique_tag_to_hwq(tag);
394 if (hwq < nbd->tag_set.nr_hw_queues)
395 req = blk_mq_tag_to_rq(nbd->tag_set.tags[hwq],
396 blk_mq_unique_tag_to_tag(tag));
397 if (!req || !blk_mq_request_started(req)) {
398 dev_err(disk_to_dev(nbd->disk), "Unexpected reply (%d) %p\n",
399 tag, req);
400 return ERR_PTR(-ENOENT);
401 }
402 cmd = blk_mq_rq_to_pdu(req);
403 if (ntohl(reply.error)) {
404 dev_err(disk_to_dev(nbd->disk), "Other side returned error (%d)\n",
405 ntohl(reply.error));
406 req->errors++;
407 return cmd;
408 }
409
410 dev_dbg(nbd_to_dev(nbd), "request %p: got reply\n", cmd);
411 if (rq_data_dir(req) != WRITE) {
412 struct req_iterator iter;
413 struct bio_vec bvec;
414
415 rq_for_each_segment(bvec, req, iter) {
416 result = sock_recv_bvec(nbd, index, &bvec);
417 if (result <= 0) {
418 dev_err(disk_to_dev(nbd->disk), "Receive data failed (result %d)\n",
419 result);
420 req->errors++;
421 return cmd;
422 }
423 dev_dbg(nbd_to_dev(nbd), "request %p: got %d bytes data\n",
424 cmd, bvec.bv_len);
425 }
426 } else {
427 /* See the comment in nbd_queue_rq. */
428 wait_for_completion(&cmd->send_complete);
429 }
430 return cmd;
431 }
432
433 static ssize_t pid_show(struct device *dev,
434 struct device_attribute *attr, char *buf)
435 {
436 struct gendisk *disk = dev_to_disk(dev);
437 struct nbd_device *nbd = (struct nbd_device *)disk->private_data;
438
439 return sprintf(buf, "%d\n", task_pid_nr(nbd->task_recv));
440 }
441
442 static struct device_attribute pid_attr = {
443 .attr = { .name = "pid", .mode = S_IRUGO},
444 .show = pid_show,
445 };
446
447 struct recv_thread_args {
448 struct work_struct work;
449 struct nbd_device *nbd;
450 int index;
451 };
452
453 static void recv_work(struct work_struct *work)
454 {
455 struct recv_thread_args *args = container_of(work,
456 struct recv_thread_args,
457 work);
458 struct nbd_device *nbd = args->nbd;
459 struct nbd_cmd *cmd;
460 int ret = 0;
461
462 BUG_ON(nbd->magic != NBD_MAGIC);
463 while (1) {
464 cmd = nbd_read_stat(nbd, args->index);
465 if (IS_ERR(cmd)) {
466 ret = PTR_ERR(cmd);
467 break;
468 }
469
470 nbd_end_request(cmd);
471 }
472
473 /*
474 * We got an error, shut everybody down if this wasn't the result of a
475 * disconnect request.
476 */
477 if (ret && !test_bit(NBD_DISCONNECT_REQUESTED, &nbd->runtime_flags))
478 sock_shutdown(nbd);
479 atomic_dec(&nbd->recv_threads);
480 wake_up(&nbd->recv_wq);
481 }
482
483 static void nbd_clear_req(struct request *req, void *data, bool reserved)
484 {
485 struct nbd_cmd *cmd;
486
487 if (!blk_mq_request_started(req))
488 return;
489 cmd = blk_mq_rq_to_pdu(req);
490 req->errors++;
491 nbd_end_request(cmd);
492 }
493
494 static void nbd_clear_que(struct nbd_device *nbd)
495 {
496 BUG_ON(nbd->magic != NBD_MAGIC);
497
498 blk_mq_tagset_busy_iter(&nbd->tag_set, nbd_clear_req, NULL);
499 dev_dbg(disk_to_dev(nbd->disk), "queue cleared\n");
500 }
501
502
503 static void nbd_handle_cmd(struct nbd_cmd *cmd, int index)
504 {
505 struct request *req = blk_mq_rq_from_pdu(cmd);
506 struct nbd_device *nbd = cmd->nbd;
507 struct nbd_sock *nsock;
508
509 if (index >= nbd->num_connections) {
510 dev_err_ratelimited(disk_to_dev(nbd->disk),
511 "Attempted send on invalid socket\n");
512 goto error_out;
513 }
514
515 if (test_bit(NBD_DISCONNECTED, &nbd->runtime_flags)) {
516 dev_err_ratelimited(disk_to_dev(nbd->disk),
517 "Attempted send on closed socket\n");
518 goto error_out;
519 }
520
521 req->errors = 0;
522
523 nsock = nbd->socks[index];
524 mutex_lock(&nsock->tx_lock);
525 if (unlikely(!nsock->sock)) {
526 mutex_unlock(&nsock->tx_lock);
527 dev_err_ratelimited(disk_to_dev(nbd->disk),
528 "Attempted send on closed socket\n");
529 goto error_out;
530 }
531
532 if (nbd_send_cmd(nbd, cmd, index) != 0) {
533 dev_err_ratelimited(disk_to_dev(nbd->disk),
534 "Request send failed\n");
535 req->errors++;
536 nbd_end_request(cmd);
537 }
538
539 mutex_unlock(&nsock->tx_lock);
540
541 return;
542
543 error_out:
544 req->errors++;
545 nbd_end_request(cmd);
546 }
547
548 static int nbd_queue_rq(struct blk_mq_hw_ctx *hctx,
549 const struct blk_mq_queue_data *bd)
550 {
551 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(bd->rq);
552
553 /*
554 * Since we look at the bio's to send the request over the network we
555 * need to make sure the completion work doesn't mark this request done
556 * before we are done doing our send. This keeps us from dereferencing
557 * freed data if we have particularly fast completions (ie we get the
558 * completion before we exit sock_xmit on the last bvec) or in the case
559 * that the server is misbehaving (or there was an error) before we're
560 * done sending everything over the wire.
561 */
562 init_completion(&cmd->send_complete);
563 blk_mq_start_request(bd->rq);
564 nbd_handle_cmd(cmd, hctx->queue_num);
565 complete(&cmd->send_complete);
566
567 return BLK_MQ_RQ_QUEUE_OK;
568 }
569
570 static int nbd_add_socket(struct nbd_device *nbd, struct socket *sock)
571 {
572 struct nbd_sock **socks;
573 struct nbd_sock *nsock;
574
575 if (!nbd->task_setup)
576 nbd->task_setup = current;
577 if (nbd->task_setup != current) {
578 dev_err(disk_to_dev(nbd->disk),
579 "Device being setup by another task");
580 return -EINVAL;
581 }
582
583 socks = krealloc(nbd->socks, (nbd->num_connections + 1) *
584 sizeof(struct nbd_sock *), GFP_KERNEL);
585 if (!socks)
586 return -ENOMEM;
587 nsock = kzalloc(sizeof(struct nbd_sock), GFP_KERNEL);
588 if (!nsock)
589 return -ENOMEM;
590
591 nbd->socks = socks;
592
593 mutex_init(&nsock->tx_lock);
594 nsock->sock = sock;
595 socks[nbd->num_connections++] = nsock;
596
597 return 0;
598 }
599
600 /* Reset all properties of an NBD device */
601 static void nbd_reset(struct nbd_device *nbd)
602 {
603 int i;
604
605 for (i = 0; i < nbd->num_connections; i++)
606 kfree(nbd->socks[i]);
607 kfree(nbd->socks);
608 nbd->socks = NULL;
609 nbd->runtime_flags = 0;
610 nbd->blksize = 1024;
611 nbd->bytesize = 0;
612 set_capacity(nbd->disk, 0);
613 nbd->flags = 0;
614 nbd->tag_set.timeout = 0;
615 nbd->num_connections = 0;
616 nbd->task_setup = NULL;
617 queue_flag_clear_unlocked(QUEUE_FLAG_DISCARD, nbd->disk->queue);
618 }
619
620 static void nbd_bdev_reset(struct block_device *bdev)
621 {
622 set_device_ro(bdev, false);
623 bdev->bd_inode->i_size = 0;
624 if (max_part > 0) {
625 blkdev_reread_part(bdev);
626 bdev->bd_invalidated = 1;
627 }
628 }
629
630 static void nbd_parse_flags(struct nbd_device *nbd, struct block_device *bdev)
631 {
632 if (nbd->flags & NBD_FLAG_READ_ONLY)
633 set_device_ro(bdev, true);
634 if (nbd->flags & NBD_FLAG_SEND_TRIM)
635 queue_flag_set_unlocked(QUEUE_FLAG_DISCARD, nbd->disk->queue);
636 if (nbd->flags & NBD_FLAG_SEND_FLUSH)
637 blk_queue_write_cache(nbd->disk->queue, true, false);
638 else
639 blk_queue_write_cache(nbd->disk->queue, false, false);
640 }
641
642 static void send_disconnects(struct nbd_device *nbd)
643 {
644 struct nbd_request request = {};
645 int i, ret;
646
647 request.magic = htonl(NBD_REQUEST_MAGIC);
648 request.type = htonl(NBD_CMD_DISC);
649
650 for (i = 0; i < nbd->num_connections; i++) {
651 ret = sock_xmit(nbd, i, 1, &request, sizeof(request), 0);
652 if (ret <= 0)
653 dev_err(disk_to_dev(nbd->disk),
654 "Send disconnect failed %d\n", ret);
655 }
656 }
657
658 static int nbd_dev_dbg_init(struct nbd_device *nbd);
659 static void nbd_dev_dbg_close(struct nbd_device *nbd);
660
661 /* Must be called with config_lock held */
662 static int __nbd_ioctl(struct block_device *bdev, struct nbd_device *nbd,
663 unsigned int cmd, unsigned long arg)
664 {
665 switch (cmd) {
666 case NBD_DISCONNECT: {
667 dev_info(disk_to_dev(nbd->disk), "NBD_DISCONNECT\n");
668 if (!nbd->socks)
669 return -EINVAL;
670
671 mutex_unlock(&nbd->config_lock);
672 fsync_bdev(bdev);
673 mutex_lock(&nbd->config_lock);
674
675 /* Check again after getting mutex back. */
676 if (!nbd->socks)
677 return -EINVAL;
678
679 if (!test_and_set_bit(NBD_DISCONNECT_REQUESTED,
680 &nbd->runtime_flags))
681 send_disconnects(nbd);
682 return 0;
683 }
684
685 case NBD_CLEAR_SOCK:
686 sock_shutdown(nbd);
687 nbd_clear_que(nbd);
688 kill_bdev(bdev);
689 nbd_bdev_reset(bdev);
690 /*
691 * We want to give the run thread a chance to wait for everybody
692 * to clean up and then do it's own cleanup.
693 */
694 if (!test_bit(NBD_RUNNING, &nbd->runtime_flags)) {
695 int i;
696
697 for (i = 0; i < nbd->num_connections; i++)
698 kfree(nbd->socks[i]);
699 kfree(nbd->socks);
700 nbd->socks = NULL;
701 nbd->num_connections = 0;
702 nbd->task_setup = NULL;
703 }
704 return 0;
705
706 case NBD_SET_SOCK: {
707 int err;
708 struct socket *sock = sockfd_lookup(arg, &err);
709
710 if (!sock)
711 return err;
712
713 err = nbd_add_socket(nbd, sock);
714 if (!err && max_part)
715 bdev->bd_invalidated = 1;
716
717 return err;
718 }
719
720 case NBD_SET_BLKSIZE: {
721 loff_t bsize = div_s64(nbd->bytesize, arg);
722
723 return nbd_size_set(nbd, bdev, arg, bsize);
724 }
725
726 case NBD_SET_SIZE:
727 return nbd_size_set(nbd, bdev, nbd->blksize,
728 div_s64(arg, nbd->blksize));
729
730 case NBD_SET_SIZE_BLOCKS:
731 return nbd_size_set(nbd, bdev, nbd->blksize, arg);
732
733 case NBD_SET_TIMEOUT:
734 nbd->tag_set.timeout = arg * HZ;
735 return 0;
736
737 case NBD_SET_FLAGS:
738 nbd->flags = arg;
739 return 0;
740
741 case NBD_DO_IT: {
742 struct recv_thread_args *args;
743 int num_connections = nbd->num_connections;
744 int error = 0, i;
745
746 if (nbd->task_recv)
747 return -EBUSY;
748 if (!nbd->socks)
749 return -EINVAL;
750 if (num_connections > 1 &&
751 !(nbd->flags & NBD_FLAG_CAN_MULTI_CONN)) {
752 dev_err(disk_to_dev(nbd->disk), "server does not support multiple connections per device.\n");
753 error = -EINVAL;
754 goto out_err;
755 }
756
757 set_bit(NBD_RUNNING, &nbd->runtime_flags);
758 blk_mq_update_nr_hw_queues(&nbd->tag_set, nbd->num_connections);
759 args = kcalloc(num_connections, sizeof(*args), GFP_KERNEL);
760 if (!args) {
761 error = -ENOMEM;
762 goto out_err;
763 }
764 nbd->task_recv = current;
765 mutex_unlock(&nbd->config_lock);
766
767 nbd_parse_flags(nbd, bdev);
768
769 error = device_create_file(disk_to_dev(nbd->disk), &pid_attr);
770 if (error) {
771 dev_err(disk_to_dev(nbd->disk), "device_create_file failed!\n");
772 goto out_recv;
773 }
774
775 nbd_size_update(nbd, bdev);
776
777 nbd_dev_dbg_init(nbd);
778 for (i = 0; i < num_connections; i++) {
779 sk_set_memalloc(nbd->socks[i]->sock->sk);
780 atomic_inc(&nbd->recv_threads);
781 INIT_WORK(&args[i].work, recv_work);
782 args[i].nbd = nbd;
783 args[i].index = i;
784 queue_work(system_long_wq, &args[i].work);
785 }
786 wait_event_interruptible(nbd->recv_wq,
787 atomic_read(&nbd->recv_threads) == 0);
788 for (i = 0; i < num_connections; i++)
789 flush_work(&args[i].work);
790 nbd_dev_dbg_close(nbd);
791 nbd_size_clear(nbd, bdev);
792 device_remove_file(disk_to_dev(nbd->disk), &pid_attr);
793 out_recv:
794 mutex_lock(&nbd->config_lock);
795 nbd->task_recv = NULL;
796 out_err:
797 sock_shutdown(nbd);
798 nbd_clear_que(nbd);
799 kill_bdev(bdev);
800 nbd_bdev_reset(bdev);
801
802 /* user requested, ignore socket errors */
803 if (test_bit(NBD_DISCONNECT_REQUESTED, &nbd->runtime_flags))
804 error = 0;
805 if (test_bit(NBD_TIMEDOUT, &nbd->runtime_flags))
806 error = -ETIMEDOUT;
807
808 nbd_reset(nbd);
809 return error;
810 }
811
812 case NBD_CLEAR_QUE:
813 /*
814 * This is for compatibility only. The queue is always cleared
815 * by NBD_DO_IT or NBD_CLEAR_SOCK.
816 */
817 return 0;
818
819 case NBD_PRINT_DEBUG:
820 /*
821 * For compatibility only, we no longer keep a list of
822 * outstanding requests.
823 */
824 return 0;
825 }
826 return -ENOTTY;
827 }
828
829 static int nbd_ioctl(struct block_device *bdev, fmode_t mode,
830 unsigned int cmd, unsigned long arg)
831 {
832 struct nbd_device *nbd = bdev->bd_disk->private_data;
833 int error;
834
835 if (!capable(CAP_SYS_ADMIN))
836 return -EPERM;
837
838 BUG_ON(nbd->magic != NBD_MAGIC);
839
840 mutex_lock(&nbd->config_lock);
841 error = __nbd_ioctl(bdev, nbd, cmd, arg);
842 mutex_unlock(&nbd->config_lock);
843
844 return error;
845 }
846
847 static const struct block_device_operations nbd_fops =
848 {
849 .owner = THIS_MODULE,
850 .ioctl = nbd_ioctl,
851 .compat_ioctl = nbd_ioctl,
852 };
853
854 #if IS_ENABLED(CONFIG_DEBUG_FS)
855
856 static int nbd_dbg_tasks_show(struct seq_file *s, void *unused)
857 {
858 struct nbd_device *nbd = s->private;
859
860 if (nbd->task_recv)
861 seq_printf(s, "recv: %d\n", task_pid_nr(nbd->task_recv));
862
863 return 0;
864 }
865
866 static int nbd_dbg_tasks_open(struct inode *inode, struct file *file)
867 {
868 return single_open(file, nbd_dbg_tasks_show, inode->i_private);
869 }
870
871 static const struct file_operations nbd_dbg_tasks_ops = {
872 .open = nbd_dbg_tasks_open,
873 .read = seq_read,
874 .llseek = seq_lseek,
875 .release = single_release,
876 };
877
878 static int nbd_dbg_flags_show(struct seq_file *s, void *unused)
879 {
880 struct nbd_device *nbd = s->private;
881 u32 flags = nbd->flags;
882
883 seq_printf(s, "Hex: 0x%08x\n\n", flags);
884
885 seq_puts(s, "Known flags:\n");
886
887 if (flags & NBD_FLAG_HAS_FLAGS)
888 seq_puts(s, "NBD_FLAG_HAS_FLAGS\n");
889 if (flags & NBD_FLAG_READ_ONLY)
890 seq_puts(s, "NBD_FLAG_READ_ONLY\n");
891 if (flags & NBD_FLAG_SEND_FLUSH)
892 seq_puts(s, "NBD_FLAG_SEND_FLUSH\n");
893 if (flags & NBD_FLAG_SEND_TRIM)
894 seq_puts(s, "NBD_FLAG_SEND_TRIM\n");
895
896 return 0;
897 }
898
899 static int nbd_dbg_flags_open(struct inode *inode, struct file *file)
900 {
901 return single_open(file, nbd_dbg_flags_show, inode->i_private);
902 }
903
904 static const struct file_operations nbd_dbg_flags_ops = {
905 .open = nbd_dbg_flags_open,
906 .read = seq_read,
907 .llseek = seq_lseek,
908 .release = single_release,
909 };
910
911 static int nbd_dev_dbg_init(struct nbd_device *nbd)
912 {
913 struct dentry *dir;
914
915 if (!nbd_dbg_dir)
916 return -EIO;
917
918 dir = debugfs_create_dir(nbd_name(nbd), nbd_dbg_dir);
919 if (!dir) {
920 dev_err(nbd_to_dev(nbd), "Failed to create debugfs dir for '%s'\n",
921 nbd_name(nbd));
922 return -EIO;
923 }
924 nbd->dbg_dir = dir;
925
926 debugfs_create_file("tasks", 0444, dir, nbd, &nbd_dbg_tasks_ops);
927 debugfs_create_u64("size_bytes", 0444, dir, &nbd->bytesize);
928 debugfs_create_u32("timeout", 0444, dir, &nbd->tag_set.timeout);
929 debugfs_create_u64("blocksize", 0444, dir, &nbd->blksize);
930 debugfs_create_file("flags", 0444, dir, nbd, &nbd_dbg_flags_ops);
931
932 return 0;
933 }
934
935 static void nbd_dev_dbg_close(struct nbd_device *nbd)
936 {
937 debugfs_remove_recursive(nbd->dbg_dir);
938 }
939
940 static int nbd_dbg_init(void)
941 {
942 struct dentry *dbg_dir;
943
944 dbg_dir = debugfs_create_dir("nbd", NULL);
945 if (!dbg_dir)
946 return -EIO;
947
948 nbd_dbg_dir = dbg_dir;
949
950 return 0;
951 }
952
953 static void nbd_dbg_close(void)
954 {
955 debugfs_remove_recursive(nbd_dbg_dir);
956 }
957
958 #else /* IS_ENABLED(CONFIG_DEBUG_FS) */
959
960 static int nbd_dev_dbg_init(struct nbd_device *nbd)
961 {
962 return 0;
963 }
964
965 static void nbd_dev_dbg_close(struct nbd_device *nbd)
966 {
967 }
968
969 static int nbd_dbg_init(void)
970 {
971 return 0;
972 }
973
974 static void nbd_dbg_close(void)
975 {
976 }
977
978 #endif
979
980 static int nbd_init_request(void *data, struct request *rq,
981 unsigned int hctx_idx, unsigned int request_idx,
982 unsigned int numa_node)
983 {
984 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(rq);
985 cmd->nbd = data;
986 return 0;
987 }
988
989 static struct blk_mq_ops nbd_mq_ops = {
990 .queue_rq = nbd_queue_rq,
991 .init_request = nbd_init_request,
992 .timeout = nbd_xmit_timeout,
993 };
994
995 /*
996 * And here should be modules and kernel interface
997 * (Just smiley confuses emacs :-)
998 */
999
1000 static int __init nbd_init(void)
1001 {
1002 int err = -ENOMEM;
1003 int i;
1004 int part_shift;
1005
1006 BUILD_BUG_ON(sizeof(struct nbd_request) != 28);
1007
1008 if (max_part < 0) {
1009 printk(KERN_ERR "nbd: max_part must be >= 0\n");
1010 return -EINVAL;
1011 }
1012
1013 part_shift = 0;
1014 if (max_part > 0) {
1015 part_shift = fls(max_part);
1016
1017 /*
1018 * Adjust max_part according to part_shift as it is exported
1019 * to user space so that user can know the max number of
1020 * partition kernel should be able to manage.
1021 *
1022 * Note that -1 is required because partition 0 is reserved
1023 * for the whole disk.
1024 */
1025 max_part = (1UL << part_shift) - 1;
1026 }
1027
1028 if ((1UL << part_shift) > DISK_MAX_PARTS)
1029 return -EINVAL;
1030
1031 if (nbds_max > 1UL << (MINORBITS - part_shift))
1032 return -EINVAL;
1033
1034 nbd_dev = kcalloc(nbds_max, sizeof(*nbd_dev), GFP_KERNEL);
1035 if (!nbd_dev)
1036 return -ENOMEM;
1037
1038 for (i = 0; i < nbds_max; i++) {
1039 struct request_queue *q;
1040 struct gendisk *disk = alloc_disk(1 << part_shift);
1041 if (!disk)
1042 goto out;
1043 nbd_dev[i].disk = disk;
1044
1045 nbd_dev[i].tag_set.ops = &nbd_mq_ops;
1046 nbd_dev[i].tag_set.nr_hw_queues = 1;
1047 nbd_dev[i].tag_set.queue_depth = 128;
1048 nbd_dev[i].tag_set.numa_node = NUMA_NO_NODE;
1049 nbd_dev[i].tag_set.cmd_size = sizeof(struct nbd_cmd);
1050 nbd_dev[i].tag_set.flags = BLK_MQ_F_SHOULD_MERGE |
1051 BLK_MQ_F_SG_MERGE | BLK_MQ_F_BLOCKING;
1052 nbd_dev[i].tag_set.driver_data = &nbd_dev[i];
1053
1054 err = blk_mq_alloc_tag_set(&nbd_dev[i].tag_set);
1055 if (err) {
1056 put_disk(disk);
1057 goto out;
1058 }
1059
1060 /*
1061 * The new linux 2.5 block layer implementation requires
1062 * every gendisk to have its very own request_queue struct.
1063 * These structs are big so we dynamically allocate them.
1064 */
1065 q = blk_mq_init_queue(&nbd_dev[i].tag_set);
1066 if (IS_ERR(q)) {
1067 blk_mq_free_tag_set(&nbd_dev[i].tag_set);
1068 put_disk(disk);
1069 goto out;
1070 }
1071 disk->queue = q;
1072
1073 /*
1074 * Tell the block layer that we are not a rotational device
1075 */
1076 queue_flag_set_unlocked(QUEUE_FLAG_NONROT, disk->queue);
1077 queue_flag_clear_unlocked(QUEUE_FLAG_ADD_RANDOM, disk->queue);
1078 disk->queue->limits.discard_granularity = 512;
1079 blk_queue_max_discard_sectors(disk->queue, UINT_MAX);
1080 disk->queue->limits.discard_zeroes_data = 0;
1081 blk_queue_max_hw_sectors(disk->queue, 65536);
1082 disk->queue->limits.max_sectors = 256;
1083 }
1084
1085 if (register_blkdev(NBD_MAJOR, "nbd")) {
1086 err = -EIO;
1087 goto out;
1088 }
1089
1090 printk(KERN_INFO "nbd: registered device at major %d\n", NBD_MAJOR);
1091
1092 nbd_dbg_init();
1093
1094 for (i = 0; i < nbds_max; i++) {
1095 struct gendisk *disk = nbd_dev[i].disk;
1096 nbd_dev[i].magic = NBD_MAGIC;
1097 mutex_init(&nbd_dev[i].config_lock);
1098 disk->major = NBD_MAJOR;
1099 disk->first_minor = i << part_shift;
1100 disk->fops = &nbd_fops;
1101 disk->private_data = &nbd_dev[i];
1102 sprintf(disk->disk_name, "nbd%d", i);
1103 init_waitqueue_head(&nbd_dev[i].recv_wq);
1104 nbd_reset(&nbd_dev[i]);
1105 add_disk(disk);
1106 }
1107
1108 return 0;
1109 out:
1110 while (i--) {
1111 blk_mq_free_tag_set(&nbd_dev[i].tag_set);
1112 blk_cleanup_queue(nbd_dev[i].disk->queue);
1113 put_disk(nbd_dev[i].disk);
1114 }
1115 kfree(nbd_dev);
1116 return err;
1117 }
1118
1119 static void __exit nbd_cleanup(void)
1120 {
1121 int i;
1122
1123 nbd_dbg_close();
1124
1125 for (i = 0; i < nbds_max; i++) {
1126 struct gendisk *disk = nbd_dev[i].disk;
1127 nbd_dev[i].magic = 0;
1128 if (disk) {
1129 del_gendisk(disk);
1130 blk_cleanup_queue(disk->queue);
1131 blk_mq_free_tag_set(&nbd_dev[i].tag_set);
1132 put_disk(disk);
1133 }
1134 }
1135 unregister_blkdev(NBD_MAJOR, "nbd");
1136 kfree(nbd_dev);
1137 printk(KERN_INFO "nbd: unregistered device at major %d\n", NBD_MAJOR);
1138 }
1139
1140 module_init(nbd_init);
1141 module_exit(nbd_cleanup);
1142
1143 MODULE_DESCRIPTION("Network Block Device");
1144 MODULE_LICENSE("GPL");
1145
1146 module_param(nbds_max, int, 0444);
1147 MODULE_PARM_DESC(nbds_max, "number of network block devices to initialize (default: 16)");
1148 module_param(max_part, int, 0444);
1149 MODULE_PARM_DESC(max_part, "number of partitions per device (default: 0)");