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