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