Merge tag 'tpmdd-v6.8' of git://git.kernel.org/pub/scm/linux/kernel/git/jarkko/linux...
[linux-block.git] / drivers / block / nbd.c
CommitLineData
eb1fe3bf 1// SPDX-License-Identifier: GPL-2.0-or-later
1da177e4
LT
2/*
3 * Network block device - make block devices work over TCP
4 *
5 * Note that you can not swap over this thing, yet. Seems to work but
6 * deadlocks sometimes - you can not swap over TCP in general.
7 *
a2531293 8 * Copyright 1997-2000, 2008 Pavel Machek <pavel@ucw.cz>
1da177e4
LT
9 * Parts copyright 2001 Steven Whitehouse <steve@chygwyn.com>
10 *
dbf492d6 11 * (part of code stolen from loop.c)
1da177e4
LT
12 */
13
bc9da6dd
YK
14#define pr_fmt(fmt) "nbd: " fmt
15
1da177e4
LT
16#include <linux/major.h>
17
18#include <linux/blkdev.h>
19#include <linux/module.h>
20#include <linux/init.h>
21#include <linux/sched.h>
f1083048 22#include <linux/sched/mm.h>
1da177e4
LT
23#include <linux/fs.h>
24#include <linux/bio.h>
25#include <linux/stat.h>
26#include <linux/errno.h>
27#include <linux/file.h>
28#include <linux/ioctl.h>
2a48fc0a 29#include <linux/mutex.h>
4b2f0260 30#include <linux/compiler.h>
8454d685 31#include <linux/completion.h>
4b2f0260
HX
32#include <linux/err.h>
33#include <linux/kernel.h>
5a0e3ad6 34#include <linux/slab.h>
1da177e4 35#include <net/sock.h>
91cf45f0 36#include <linux/net.h>
48cf6061 37#include <linux/kthread.h>
b9c495bb 38#include <linux/types.h>
30d53d9c 39#include <linux/debugfs.h>
fd8383fd 40#include <linux/blk-mq.h>
1da177e4 41
7c0f6ba6 42#include <linux/uaccess.h>
1da177e4
LT
43#include <asm/types.h>
44
45#include <linux/nbd.h>
e46c7287
JB
46#include <linux/nbd-netlink.h>
47#include <net/genetlink.h>
1da177e4 48
ea106722
MM
49#define CREATE_TRACE_POINTS
50#include <trace/events/nbd.h>
51
b0d9111a
JB
52static DEFINE_IDR(nbd_index_idr);
53static DEFINE_MUTEX(nbd_index_mutex);
68c9417b 54static struct workqueue_struct *nbd_del_wq;
47d902b9 55static int nbd_total_devices = 0;
b0d9111a 56
9561a7ad
JB
57struct nbd_sock {
58 struct socket *sock;
59 struct mutex tx_lock;
9dd5d3ab
JB
60 struct request *pending;
61 int sent;
f3733247
JB
62 bool dead;
63 int fallback_index;
799f9a38 64 int cookie;
9561a7ad
JB
65};
66
5ea8d108
JB
67struct recv_thread_args {
68 struct work_struct work;
69 struct nbd_device *nbd;
98c598af 70 struct nbd_sock *nsock;
5ea8d108
JB
71 int index;
72};
73
799f9a38
JB
74struct link_dead_args {
75 struct work_struct work;
76 int index;
77};
78
ec76a7b9
XL
79#define NBD_RT_TIMEDOUT 0
80#define NBD_RT_DISCONNECT_REQUESTED 1
81#define NBD_RT_DISCONNECTED 2
82#define NBD_RT_HAS_PID_FILE 3
83#define NBD_RT_HAS_CONFIG_REF 4
84#define NBD_RT_BOUND 5
c9a2f90f 85#define NBD_RT_DISCONNECT_ON_CLOSE 6
6497ef8d 86#define NBD_RT_HAS_BACKEND_FILE 7
9b4a6ba9 87
8454d685
XL
88#define NBD_DESTROY_ON_DISCONNECT 0
89#define NBD_DISCONNECT_REQUESTED 1
90
5ea8d108 91struct nbd_config {
22d109c1 92 u32 flags;
9b4a6ba9 93 unsigned long runtime_flags;
560bc4b3 94 u64 dead_conn_timeout;
13e71d69 95
5ea8d108 96 struct nbd_sock **socks;
9561a7ad 97 int num_connections;
560bc4b3
JB
98 atomic_t live_connections;
99 wait_queue_head_t conn_wait;
5ea8d108 100
9561a7ad
JB
101 atomic_t recv_threads;
102 wait_queue_head_t recv_wq;
41e76c6a 103 unsigned int blksize_bits;
b9c495bb 104 loff_t bytesize;
30d53d9c
MP
105#if IS_ENABLED(CONFIG_DEBUG_FS)
106 struct dentry *dbg_dir;
107#endif
13e71d69
MP
108};
109
41e76c6a
ND
110static inline unsigned int nbd_blksize(struct nbd_config *config)
111{
112 return 1u << config->blksize_bits;
113}
114
5ea8d108
JB
115struct nbd_device {
116 struct blk_mq_tag_set tag_set;
117
e46c7287 118 int index;
5ea8d108 119 refcount_t config_refs;
c6a4759e 120 refcount_t refs;
5ea8d108
JB
121 struct nbd_config *config;
122 struct mutex config_lock;
123 struct gendisk *disk;
e9e006f5 124 struct workqueue_struct *recv_workq;
68c9417b 125 struct work_struct remove_work;
5ea8d108 126
c6a4759e 127 struct list_head list;
5ea8d108 128 struct task_struct *task_setup;
8454d685 129
8454d685 130 unsigned long flags;
0c98057b 131 pid_t pid; /* pid of nbd-client, if attached */
6497ef8d
PKK
132
133 char *backend;
5ea8d108
JB
134};
135
d7d94d48 136#define NBD_CMD_REQUEUED 1
4e6eef5d
YK
137/*
138 * This flag will be set if nbd_queue_rq() succeed, and will be checked and
139 * cleared in completion. Both setting and clearing of the flag are protected
140 * by cmd->lock.
141 */
142#define NBD_CMD_INFLIGHT 2
d7d94d48 143
fd8383fd
JB
144struct nbd_cmd {
145 struct nbd_device *nbd;
8f3ea359 146 struct mutex lock;
f3733247 147 int index;
799f9a38 148 int cookie;
2da22da5 149 int retries;
2a842aca 150 blk_status_t status;
d7d94d48 151 unsigned long flags;
8f3ea359 152 u32 cmd_cookie;
fd8383fd
JB
153};
154
30d53d9c
MP
155#if IS_ENABLED(CONFIG_DEBUG_FS)
156static struct dentry *nbd_dbg_dir;
157#endif
158
159#define nbd_name(nbd) ((nbd)->disk->disk_name)
160
41e76c6a 161#define NBD_DEF_BLKSIZE_BITS 10
553768d1 162
9c7a4169 163static unsigned int nbds_max = 16;
7a8362a0 164static int max_part = 16;
b0d9111a 165static int part_shift;
1da177e4 166
9442b739
JB
167static int nbd_dev_dbg_init(struct nbd_device *nbd);
168static void nbd_dev_dbg_close(struct nbd_device *nbd);
5ea8d108 169static void nbd_config_put(struct nbd_device *nbd);
e46c7287 170static void nbd_connect_reply(struct genl_info *info, int index);
47d902b9 171static int nbd_genl_status(struct sk_buff *skb, struct genl_info *info);
799f9a38 172static void nbd_dead_link_work(struct work_struct *work);
08ba91ee 173static void nbd_disconnect_and_put(struct nbd_device *nbd);
9442b739 174
d18509f5 175static inline struct device *nbd_to_dev(struct nbd_device *nbd)
1da177e4 176{
d18509f5 177 return disk_to_dev(nbd->disk);
1da177e4
LT
178}
179
d7d94d48
JB
180static void nbd_requeue_cmd(struct nbd_cmd *cmd)
181{
182 struct request *req = blk_mq_rq_from_pdu(cmd);
183
184 if (!test_and_set_bit(NBD_CMD_REQUEUED, &cmd->flags))
185 blk_mq_requeue_request(req, true);
186}
187
8f3ea359
JB
188#define NBD_COOKIE_BITS 32
189
190static u64 nbd_cmd_handle(struct nbd_cmd *cmd)
191{
192 struct request *req = blk_mq_rq_from_pdu(cmd);
193 u32 tag = blk_mq_unique_tag(req);
194 u64 cookie = cmd->cmd_cookie;
195
196 return (cookie << NBD_COOKIE_BITS) | tag;
197}
198
199static u32 nbd_handle_to_tag(u64 handle)
200{
201 return (u32)handle;
202}
203
204static u32 nbd_handle_to_cookie(u64 handle)
205{
206 return (u32)(handle >> NBD_COOKIE_BITS);
207}
208
1da177e4
LT
209static const char *nbdcmd_to_ascii(int cmd)
210{
211 switch (cmd) {
212 case NBD_CMD_READ: return "read";
213 case NBD_CMD_WRITE: return "write";
214 case NBD_CMD_DISC: return "disconnect";
75f187ab 215 case NBD_CMD_FLUSH: return "flush";
a336d298 216 case NBD_CMD_TRIM: return "trim/discard";
1da177e4
LT
217 }
218 return "invalid";
219}
1da177e4 220
5ea8d108
JB
221static ssize_t pid_show(struct device *dev,
222 struct device_attribute *attr, char *buf)
223{
224 struct gendisk *disk = dev_to_disk(dev);
225 struct nbd_device *nbd = (struct nbd_device *)disk->private_data;
226
0c98057b 227 return sprintf(buf, "%d\n", nbd->pid);
5ea8d108
JB
228}
229
dfbde552 230static const struct device_attribute pid_attr = {
5657a819 231 .attr = { .name = "pid", .mode = 0444},
5ea8d108
JB
232 .show = pid_show,
233};
234
6497ef8d
PKK
235static ssize_t backend_show(struct device *dev,
236 struct device_attribute *attr, char *buf)
237{
238 struct gendisk *disk = dev_to_disk(dev);
239 struct nbd_device *nbd = (struct nbd_device *)disk->private_data;
240
241 return sprintf(buf, "%s\n", nbd->backend ?: "");
242}
243
244static const struct device_attribute backend_attr = {
245 .attr = { .name = "backend", .mode = 0444},
246 .show = backend_show,
247};
248
c6a4759e
JB
249static void nbd_dev_remove(struct nbd_device *nbd)
250{
251 struct gendisk *disk = nbd->disk;
8364da47 252
327b501b 253 del_gendisk(disk);
327b501b 254 blk_mq_free_tag_set(&nbd->tag_set);
8454d685
XL
255
256 /*
3f74e064
CH
257 * Remove from idr after del_gendisk() completes, so if the same ID is
258 * reused, the following add_disk() will succeed.
8454d685 259 */
3f74e064 260 mutex_lock(&nbd_index_mutex);
68c9417b 261 idr_remove(&nbd_index_idr, nbd->index);
68c9417b 262 mutex_unlock(&nbd_index_mutex);
e2daec48 263 destroy_workqueue(nbd->recv_workq);
32746272 264 put_disk(disk);
c6a4759e
JB
265}
266
3f74e064 267static void nbd_dev_remove_work(struct work_struct *work)
68c9417b 268{
3f74e064 269 nbd_dev_remove(container_of(work, struct nbd_device, remove_work));
68c9417b
HT
270}
271
c6a4759e
JB
272static void nbd_put(struct nbd_device *nbd)
273{
3f74e064
CH
274 if (!refcount_dec_and_test(&nbd->refs))
275 return;
276
277 /* Call del_gendisk() asynchrounously to prevent deadlock */
278 if (test_bit(NBD_DESTROY_ON_DISCONNECT, &nbd->flags))
279 queue_work(nbd_del_wq, &nbd->remove_work);
280 else
c6a4759e 281 nbd_dev_remove(nbd);
c6a4759e
JB
282}
283
799f9a38
JB
284static int nbd_disconnected(struct nbd_config *config)
285{
ec76a7b9
XL
286 return test_bit(NBD_RT_DISCONNECTED, &config->runtime_flags) ||
287 test_bit(NBD_RT_DISCONNECT_REQUESTED, &config->runtime_flags);
799f9a38
JB
288}
289
290static void nbd_mark_nsock_dead(struct nbd_device *nbd, struct nbd_sock *nsock,
291 int notify)
f3733247 292{
799f9a38
JB
293 if (!nsock->dead && notify && !nbd_disconnected(nbd->config)) {
294 struct link_dead_args *args;
295 args = kmalloc(sizeof(struct link_dead_args), GFP_NOIO);
296 if (args) {
297 INIT_WORK(&args->work, nbd_dead_link_work);
298 args->index = nbd->index;
299 queue_work(system_wq, &args->work);
300 }
301 }
560bc4b3 302 if (!nsock->dead) {
f3733247 303 kernel_sock_shutdown(nsock->sock, SHUT_RDWR);
5e3c3a7e 304 if (atomic_dec_return(&nbd->config->live_connections) == 0) {
ec76a7b9 305 if (test_and_clear_bit(NBD_RT_DISCONNECT_REQUESTED,
5e3c3a7e 306 &nbd->config->runtime_flags)) {
ec76a7b9 307 set_bit(NBD_RT_DISCONNECTED,
5e3c3a7e
KV
308 &nbd->config->runtime_flags);
309 dev_info(nbd_to_dev(nbd),
310 "Disconnected due to user request.\n");
311 }
312 }
560bc4b3 313 }
f3733247
JB
314 nsock->dead = true;
315 nsock->pending = NULL;
316 nsock->sent = 0;
317}
318
dcbddf54 319static int nbd_set_size(struct nbd_device *nbd, loff_t bytesize,
2dc691cc 320 loff_t blksize)
37091fdd 321{
dcbddf54 322 if (!blksize)
41e76c6a 323 blksize = 1u << NBD_DEF_BLKSIZE_BITS;
c4318d6c
XY
324
325 if (blk_validate_block_size(blksize))
dcbddf54
CH
326 return -EINVAL;
327
55793ea5
ZJ
328 if (bytesize < 0)
329 return -EINVAL;
330
2dc691cc 331 nbd->config->bytesize = bytesize;
41e76c6a 332 nbd->config->blksize_bits = __ffs(blksize);
2dc691cc 333
0c98057b 334 if (!nbd->pid)
dcbddf54 335 return 0;
9e2b1967 336
2dc691cc
CH
337 if (nbd->config->flags & NBD_FLAG_SEND_TRIM) {
338 nbd->disk->queue->limits.discard_granularity = blksize;
6df133a1
JB
339 blk_queue_max_discard_sectors(nbd->disk->queue, UINT_MAX);
340 }
2dc691cc
CH
341 blk_queue_logical_block_size(nbd->disk->queue, blksize);
342 blk_queue_physical_block_size(nbd->disk->queue, blksize);
92f93c3a 343
1aba169e
JT
344 if (max_part)
345 set_bit(GD_NEED_PART_SCAN, &nbd->disk->state);
2ebcabf3
CH
346 if (!set_capacity_and_notify(nbd->disk, bytesize >> 9))
347 kobject_uevent(&nbd_to_dev(nbd)->kobj, KOBJ_CHANGE);
dcbddf54 348 return 0;
37091fdd
MP
349}
350
1e388ae0 351static void nbd_complete_rq(struct request *req)
1da177e4 352{
1e388ae0 353 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(req);
1da177e4 354
ee57a05c 355 dev_dbg(nbd_to_dev(cmd->nbd), "request %p: %s\n", req,
1e388ae0 356 cmd->status ? "failed" : "done");
1da177e4 357
1e388ae0 358 blk_mq_end_request(req, cmd->status);
1da177e4
LT
359}
360
e018e757
MP
361/*
362 * Forcibly shutdown the socket causing all listeners to error
363 */
36e47bee 364static void sock_shutdown(struct nbd_device *nbd)
7fdfd406 365{
5ea8d108 366 struct nbd_config *config = nbd->config;
9561a7ad 367 int i;
23272a67 368
5ea8d108 369 if (config->num_connections == 0)
9561a7ad 370 return;
ec76a7b9 371 if (test_and_set_bit(NBD_RT_DISCONNECTED, &config->runtime_flags))
260bbce4 372 return;
23272a67 373
5ea8d108
JB
374 for (i = 0; i < config->num_connections; i++) {
375 struct nbd_sock *nsock = config->socks[i];
9561a7ad 376 mutex_lock(&nsock->tx_lock);
799f9a38 377 nbd_mark_nsock_dead(nbd, nsock, 0);
9561a7ad
JB
378 mutex_unlock(&nsock->tx_lock);
379 }
380 dev_warn(disk_to_dev(nbd->disk), "shutting down sockets\n");
7fdfd406
PC
381}
382
00514677
MC
383static u32 req_to_nbd_cmd_type(struct request *req)
384{
385 switch (req_op(req)) {
386 case REQ_OP_DISCARD:
387 return NBD_CMD_TRIM;
388 case REQ_OP_FLUSH:
389 return NBD_CMD_FLUSH;
390 case REQ_OP_WRITE:
391 return NBD_CMD_WRITE;
392 case REQ_OP_READ:
393 return NBD_CMD_READ;
394 default:
395 return U32_MAX;
396 }
397}
398
3123ac77
LN
399static struct nbd_config *nbd_get_config_unlocked(struct nbd_device *nbd)
400{
c2da049f
LN
401 if (refcount_inc_not_zero(&nbd->config_refs)) {
402 /*
403 * Add smp_mb__after_atomic to ensure that reading nbd->config_refs
404 * and reading nbd->config is ordered. The pair is the barrier in
405 * nbd_alloc_and_init_config(), avoid nbd->config_refs is set
406 * before nbd->config.
407 */
408 smp_mb__after_atomic();
3123ac77 409 return nbd->config;
c2da049f 410 }
3123ac77
LN
411
412 return NULL;
413}
414
9bdb4833 415static enum blk_eh_timer_return nbd_xmit_timeout(struct request *req)
7fdfd406 416{
0eadf37a
JB
417 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(req);
418 struct nbd_device *nbd = cmd->nbd;
5ea8d108
JB
419 struct nbd_config *config;
420
de6346ec
JB
421 if (!mutex_trylock(&cmd->lock))
422 return BLK_EH_RESET_TIMER;
423
2895f183 424 if (!test_bit(NBD_CMD_INFLIGHT, &cmd->flags)) {
07175cb1
YK
425 mutex_unlock(&cmd->lock);
426 return BLK_EH_DONE;
427 }
428
3123ac77
LN
429 config = nbd_get_config_unlocked(nbd);
430 if (!config) {
2a842aca 431 cmd->status = BLK_STS_TIMEOUT;
2895f183 432 __clear_bit(NBD_CMD_INFLIGHT, &cmd->flags);
de6346ec 433 mutex_unlock(&cmd->lock);
e5eab017 434 goto done;
5ea8d108 435 }
dcc909d9 436
d970958b
HP
437 if (config->num_connections > 1 ||
438 (config->num_connections == 1 && nbd->tag_set.timeout)) {
f3733247 439 dev_err_ratelimited(nbd_to_dev(nbd),
5e3c3a7e
KV
440 "Connection timed out, retrying (%d/%d alive)\n",
441 atomic_read(&config->live_connections),
442 config->num_connections);
f3733247
JB
443 /*
444 * Hooray we have more connections, requeue this IO, the submit
d970958b
HP
445 * path will put it on a real connection. Or if only one
446 * connection is configured, the submit path will wait util
447 * a new connection is reconfigured or util dead timeout.
f3733247 448 */
d970958b 449 if (config->socks) {
5ea8d108 450 if (cmd->index < config->num_connections) {
f3733247 451 struct nbd_sock *nsock =
5ea8d108 452 config->socks[cmd->index];
f3733247 453 mutex_lock(&nsock->tx_lock);
799f9a38
JB
454 /* We can have multiple outstanding requests, so
455 * we don't want to mark the nsock dead if we've
456 * already reconnected with a new socket, so
457 * only mark it dead if its the same socket we
458 * were sent out on.
459 */
460 if (cmd->cookie == nsock->cookie)
461 nbd_mark_nsock_dead(nbd, nsock, 1);
f3733247
JB
462 mutex_unlock(&nsock->tx_lock);
463 }
8f3ea359 464 mutex_unlock(&cmd->lock);
d7d94d48 465 nbd_requeue_cmd(cmd);
5ea8d108 466 nbd_config_put(nbd);
6600593c 467 return BLK_EH_DONE;
f3733247 468 }
f3733247 469 }
2da22da5
MC
470
471 if (!nbd->tag_set.timeout) {
472 /*
473 * Userspace sets timeout=0 to disable socket disconnection,
474 * so just warn and reset the timer.
475 */
2c272542 476 struct nbd_sock *nsock = config->socks[cmd->index];
2da22da5
MC
477 cmd->retries++;
478 dev_info(nbd_to_dev(nbd), "Possible stuck request %p: control (%s@%llu,%uB). Runtime %u seconds\n",
479 req, nbdcmd_to_ascii(req_to_nbd_cmd_type(req)),
480 (unsigned long long)blk_rq_pos(req) << 9,
481 blk_rq_bytes(req), (req->timeout / HZ) * cmd->retries);
482
2c272542
HP
483 mutex_lock(&nsock->tx_lock);
484 if (cmd->cookie != nsock->cookie) {
485 nbd_requeue_cmd(cmd);
486 mutex_unlock(&nsock->tx_lock);
487 mutex_unlock(&cmd->lock);
488 nbd_config_put(nbd);
489 return BLK_EH_DONE;
490 }
491 mutex_unlock(&nsock->tx_lock);
2da22da5
MC
492 mutex_unlock(&cmd->lock);
493 nbd_config_put(nbd);
494 return BLK_EH_RESET_TIMER;
495 }
496
497 dev_err_ratelimited(nbd_to_dev(nbd), "Connection timed out\n");
ec76a7b9 498 set_bit(NBD_RT_TIMEDOUT, &config->runtime_flags);
2a842aca 499 cmd->status = BLK_STS_IOERR;
2895f183 500 __clear_bit(NBD_CMD_INFLIGHT, &cmd->flags);
8f3ea359 501 mutex_unlock(&cmd->lock);
9561a7ad 502 sock_shutdown(nbd);
5ea8d108 503 nbd_config_put(nbd);
e5eab017
CH
504done:
505 blk_mq_complete_request(req);
506 return BLK_EH_DONE;
7fdfd406
PC
507}
508
98c598af
LN
509static int __sock_xmit(struct nbd_device *nbd, struct socket *sock, int send,
510 struct iov_iter *iter, int msg_flags, int *sent)
1da177e4
LT
511{
512 int result;
513 struct msghdr msg;
f1083048 514 unsigned int noreclaim_flag;
1da177e4 515
ffc41cf8 516 if (unlikely(!sock)) {
a897b666 517 dev_err_ratelimited(disk_to_dev(nbd->disk),
7f1b90f9
WC
518 "Attempted %s on closed socket in sock_xmit\n",
519 (send ? "send" : "recv"));
ffc41cf8
MS
520 return -EINVAL;
521 }
522
c9f2b6ae 523 msg.msg_iter = *iter;
c1696cab 524
f1083048 525 noreclaim_flag = memalloc_noreclaim_save();
1da177e4 526 do {
7f338fe4 527 sock->sk->sk_allocation = GFP_NOIO | __GFP_MEMALLOC;
98123866 528 sock->sk->sk_use_task_frag = false;
1da177e4
LT
529 msg.msg_name = NULL;
530 msg.msg_namelen = 0;
531 msg.msg_control = NULL;
532 msg.msg_controllen = 0;
1da177e4
LT
533 msg.msg_flags = msg_flags | MSG_NOSIGNAL;
534
7e2893a1 535 if (send)
c1696cab 536 result = sock_sendmsg(sock, &msg);
7e2893a1 537 else
c1696cab 538 result = sock_recvmsg(sock, &msg, msg.msg_flags);
1da177e4 539
1da177e4
LT
540 if (result <= 0) {
541 if (result == 0)
542 result = -EPIPE; /* short read */
543 break;
544 }
9dd5d3ab
JB
545 if (sent)
546 *sent += result;
c1696cab 547 } while (msg_data_left(&msg));
1da177e4 548
f1083048 549 memalloc_noreclaim_restore(noreclaim_flag);
1da177e4
LT
550
551 return result;
552}
553
98c598af
LN
554/*
555 * Send or receive packet. Return a positive value on success and
556 * negtive value on failure, and never return 0.
557 */
558static int sock_xmit(struct nbd_device *nbd, int index, int send,
559 struct iov_iter *iter, int msg_flags, int *sent)
560{
561 struct nbd_config *config = nbd->config;
562 struct socket *sock = config->socks[index]->sock;
563
564 return __sock_xmit(nbd, sock, send, iter, msg_flags, sent);
565}
566
32e67a3a
JB
567/*
568 * Different settings for sk->sk_sndtimeo can result in different return values
569 * if there is a signal pending when we enter sendmsg, because reasons?
570 */
571static inline int was_interrupted(int result)
572{
573 return result == -ERESTARTSYS || result == -EINTR;
574}
575
7fdfd406 576/* always call with the tx_lock held */
9561a7ad 577static int nbd_send_cmd(struct nbd_device *nbd, struct nbd_cmd *cmd, int index)
1da177e4 578{
fd8383fd 579 struct request *req = blk_mq_rq_from_pdu(cmd);
5ea8d108
JB
580 struct nbd_config *config = nbd->config;
581 struct nbd_sock *nsock = config->socks[index];
d61b7f97 582 int result;
c9f2b6ae
AV
583 struct nbd_request request = {.magic = htonl(NBD_REQUEST_MAGIC)};
584 struct kvec iov = {.iov_base = &request, .iov_len = sizeof(request)};
585 struct iov_iter from;
1011c1b9 586 unsigned long size = blk_rq_bytes(req);
429a787b 587 struct bio *bio;
8f3ea359 588 u64 handle;
9dc6c806 589 u32 type;
685c9b24 590 u32 nbd_cmd_flags = 0;
9dd5d3ab 591 int sent = nsock->sent, skip = 0;
9dc6c806 592
de4eda9d 593 iov_iter_kvec(&from, ITER_SOURCE, &iov, 1, sizeof(request));
c9f2b6ae 594
00514677
MC
595 type = req_to_nbd_cmd_type(req);
596 if (type == U32_MAX)
aebf526b 597 return -EIO;
1da177e4 598
09fc54cc 599 if (rq_data_dir(req) == WRITE &&
5ea8d108 600 (config->flags & NBD_FLAG_READ_ONLY)) {
09fc54cc
CH
601 dev_err_ratelimited(disk_to_dev(nbd->disk),
602 "Write on read-only\n");
603 return -EIO;
604 }
605
685c9b24
SM
606 if (req->cmd_flags & REQ_FUA)
607 nbd_cmd_flags |= NBD_CMD_FLAG_FUA;
608
9dd5d3ab
JB
609 /* We did a partial send previously, and we at least sent the whole
610 * request struct, so just go and send the rest of the pages in the
611 * request.
612 */
613 if (sent) {
614 if (sent >= sizeof(request)) {
615 skip = sent - sizeof(request);
2abd2de7
AH
616
617 /* initialize handle for tracing purposes */
618 handle = nbd_cmd_handle(cmd);
619
9dd5d3ab
JB
620 goto send_pages;
621 }
622 iov_iter_advance(&from, sent);
8f3ea359
JB
623 } else {
624 cmd->cmd_cookie++;
9dd5d3ab 625 }
f3733247 626 cmd->index = index;
799f9a38 627 cmd->cookie = nsock->cookie;
2da22da5 628 cmd->retries = 0;
685c9b24 629 request.type = htonl(type | nbd_cmd_flags);
9561a7ad 630 if (type != NBD_CMD_FLUSH) {
75f187ab
AB
631 request.from = cpu_to_be64((u64)blk_rq_pos(req) << 9);
632 request.len = htonl(size);
633 }
8f3ea359 634 handle = nbd_cmd_handle(cmd);
bd9e9916 635 request.cookie = cpu_to_be64(handle);
1da177e4 636
ea106722
MM
637 trace_nbd_send_request(&request, nbd->index, blk_mq_rq_from_pdu(cmd));
638
d18509f5 639 dev_dbg(nbd_to_dev(nbd), "request %p: sending control (%s@%llu,%uB)\n",
ee57a05c 640 req, nbdcmd_to_ascii(type),
d18509f5 641 (unsigned long long)blk_rq_pos(req) << 9, blk_rq_bytes(req));
c9f2b6ae 642 result = sock_xmit(nbd, index, 1, &from,
9dd5d3ab 643 (type == NBD_CMD_WRITE) ? MSG_MORE : 0, &sent);
2abd2de7 644 trace_nbd_header_sent(req, handle);
f52c0e08 645 if (result < 0) {
32e67a3a 646 if (was_interrupted(result)) {
bd9e9916 647 /* If we haven't sent anything we can just return BUSY,
9dd5d3ab
JB
648 * however if we have sent something we need to make
649 * sure we only allow this req to be sent until we are
650 * completely done.
651 */
652 if (sent) {
653 nsock->pending = req;
654 nsock->sent = sent;
655 }
d7d94d48 656 set_bit(NBD_CMD_REQUEUED, &cmd->flags);
fc17b653 657 return BLK_STS_RESOURCE;
9dd5d3ab 658 }
a897b666 659 dev_err_ratelimited(disk_to_dev(nbd->disk),
7f1b90f9 660 "Send control failed (result %d)\n", result);
f3733247 661 return -EAGAIN;
1da177e4 662 }
9dd5d3ab 663send_pages:
429a787b 664 if (type != NBD_CMD_WRITE)
9dd5d3ab 665 goto out;
429a787b 666
429a787b
JA
667 bio = req->bio;
668 while (bio) {
669 struct bio *next = bio->bi_next;
670 struct bvec_iter iter;
7988613b 671 struct bio_vec bvec;
429a787b
JA
672
673 bio_for_each_segment(bvec, bio, iter) {
674 bool is_last = !next && bio_iter_last(bvec, iter);
d61b7f97 675 int flags = is_last ? 0 : MSG_MORE;
429a787b 676
d18509f5 677 dev_dbg(nbd_to_dev(nbd), "request %p: sending %d bytes data\n",
ee57a05c 678 req, bvec.bv_len);
de4eda9d 679 iov_iter_bvec(&from, ITER_SOURCE, &bvec, 1, bvec.bv_len);
9dd5d3ab
JB
680 if (skip) {
681 if (skip >= iov_iter_count(&from)) {
682 skip -= iov_iter_count(&from);
683 continue;
684 }
685 iov_iter_advance(&from, skip);
686 skip = 0;
687 }
688 result = sock_xmit(nbd, index, 1, &from, flags, &sent);
f52c0e08 689 if (result < 0) {
32e67a3a 690 if (was_interrupted(result)) {
9dd5d3ab
JB
691 /* We've already sent the header, we
692 * have no choice but to set pending and
693 * return BUSY.
694 */
695 nsock->pending = req;
696 nsock->sent = sent;
d7d94d48 697 set_bit(NBD_CMD_REQUEUED, &cmd->flags);
fc17b653 698 return BLK_STS_RESOURCE;
9dd5d3ab 699 }
f4507164 700 dev_err(disk_to_dev(nbd->disk),
7f1b90f9
WC
701 "Send data failed (result %d)\n",
702 result);
f3733247 703 return -EAGAIN;
6c92e699 704 }
429a787b
JA
705 /*
706 * The completion might already have come in,
707 * so break for the last one instead of letting
708 * the iterator do it. This prevents use-after-free
709 * of the bio.
710 */
711 if (is_last)
712 break;
1da177e4 713 }
429a787b 714 bio = next;
1da177e4 715 }
9dd5d3ab 716out:
2abd2de7 717 trace_nbd_payload_sent(req, handle);
9dd5d3ab
JB
718 nsock->pending = NULL;
719 nsock->sent = 0;
1da177e4 720 return 0;
1da177e4
LT
721}
722
98c598af 723static int nbd_read_reply(struct nbd_device *nbd, struct socket *sock,
3fe1db62 724 struct nbd_reply *reply)
1da177e4 725{
3fe1db62 726 struct kvec iov = {.iov_base = reply, .iov_len = sizeof(*reply)};
c9f2b6ae 727 struct iov_iter to;
3fe1db62 728 int result;
1da177e4 729
3fe1db62 730 reply->magic = 0;
de4eda9d 731 iov_iter_kvec(&to, ITER_DEST, &iov, 1, sizeof(*reply));
98c598af 732 result = __sock_xmit(nbd, sock, 0, &to, MSG_WAITALL, NULL);
f52c0e08 733 if (result < 0) {
3fe1db62 734 if (!nbd_disconnected(nbd->config))
9561a7ad
JB
735 dev_err(disk_to_dev(nbd->disk),
736 "Receive control failed (result %d)\n", result);
3fe1db62 737 return result;
1da177e4 738 }
e4b57e08 739
3fe1db62 740 if (ntohl(reply->magic) != NBD_REPLY_MAGIC) {
f4507164 741 dev_err(disk_to_dev(nbd->disk), "Wrong magic (0x%lx)\n",
3fe1db62
YK
742 (unsigned long)ntohl(reply->magic));
743 return -EPROTO;
e4b57e08
MF
744 }
745
3fe1db62
YK
746 return 0;
747}
748
749/* NULL returned = something went wrong, inform userspace */
750static struct nbd_cmd *nbd_handle_reply(struct nbd_device *nbd, int index,
751 struct nbd_reply *reply)
752{
753 int result;
754 struct nbd_cmd *cmd;
755 struct request *req = NULL;
756 u64 handle;
757 u16 hwq;
758 u32 tag;
759 int ret = 0;
760
bd9e9916 761 handle = be64_to_cpu(reply->cookie);
8f3ea359 762 tag = nbd_handle_to_tag(handle);
fd8383fd
JB
763 hwq = blk_mq_unique_tag_to_hwq(tag);
764 if (hwq < nbd->tag_set.nr_hw_queues)
765 req = blk_mq_tag_to_rq(nbd->tag_set.tags[hwq],
766 blk_mq_unique_tag_to_tag(tag));
767 if (!req || !blk_mq_request_started(req)) {
768 dev_err(disk_to_dev(nbd->disk), "Unexpected reply (%d) %p\n",
769 tag, req);
770 return ERR_PTR(-ENOENT);
1da177e4 771 }
2abd2de7 772 trace_nbd_header_received(req, handle);
fd8383fd 773 cmd = blk_mq_rq_to_pdu(req);
8f3ea359
JB
774
775 mutex_lock(&cmd->lock);
2895f183 776 if (!test_bit(NBD_CMD_INFLIGHT, &cmd->flags)) {
4e6eef5d
YK
777 dev_err(disk_to_dev(nbd->disk), "Suspicious reply %d (status %u flags %lu)",
778 tag, cmd->status, cmd->flags);
779 ret = -ENOENT;
780 goto out;
781 }
fcf3d633
YK
782 if (cmd->index != index) {
783 dev_err(disk_to_dev(nbd->disk), "Unexpected reply %d from different sock %d (expected %d)",
784 tag, index, cmd->index);
494dbee3
YK
785 ret = -ENOENT;
786 goto out;
fcf3d633 787 }
8f3ea359
JB
788 if (cmd->cmd_cookie != nbd_handle_to_cookie(handle)) {
789 dev_err(disk_to_dev(nbd->disk), "Double reply on req %p, cmd_cookie %u, handle cookie %u\n",
790 req, cmd->cmd_cookie, nbd_handle_to_cookie(handle));
791 ret = -ENOENT;
792 goto out;
793 }
7ce23e8e
JB
794 if (cmd->status != BLK_STS_OK) {
795 dev_err(disk_to_dev(nbd->disk), "Command already handled %p\n",
796 req);
797 ret = -ENOENT;
798 goto out;
799 }
8f3ea359
JB
800 if (test_bit(NBD_CMD_REQUEUED, &cmd->flags)) {
801 dev_err(disk_to_dev(nbd->disk), "Raced with timeout on req %p\n",
802 req);
803 ret = -ENOENT;
804 goto out;
805 }
3fe1db62 806 if (ntohl(reply->error)) {
f4507164 807 dev_err(disk_to_dev(nbd->disk), "Other side returned error (%d)\n",
3fe1db62 808 ntohl(reply->error));
2a842aca 809 cmd->status = BLK_STS_IOERR;
8f3ea359 810 goto out;
1da177e4
LT
811 }
812
ee57a05c 813 dev_dbg(nbd_to_dev(nbd), "request %p: got reply\n", req);
9dc6c806 814 if (rq_data_dir(req) != WRITE) {
5705f702 815 struct req_iterator iter;
7988613b 816 struct bio_vec bvec;
3fe1db62 817 struct iov_iter to;
5705f702
N
818
819 rq_for_each_segment(bvec, req, iter) {
de4eda9d 820 iov_iter_bvec(&to, ITER_DEST, &bvec, 1, bvec.bv_len);
9dd5d3ab 821 result = sock_xmit(nbd, index, 0, &to, MSG_WAITALL, NULL);
f52c0e08 822 if (result < 0) {
f4507164 823 dev_err(disk_to_dev(nbd->disk), "Receive data failed (result %d)\n",
7f1b90f9 824 result);
f3733247 825 /*
d970958b 826 * If we've disconnected, we need to make sure we
f3733247
JB
827 * complete this request, otherwise error out
828 * and let the timeout stuff handle resubmitting
829 * this request onto another connection.
830 */
3fe1db62 831 if (nbd_disconnected(nbd->config)) {
2a842aca 832 cmd->status = BLK_STS_IOERR;
8f3ea359 833 goto out;
f3733247 834 }
8f3ea359
JB
835 ret = -EIO;
836 goto out;
6c92e699 837 }
d18509f5 838 dev_dbg(nbd_to_dev(nbd), "request %p: got %d bytes data\n",
ee57a05c 839 req, bvec.bv_len);
1da177e4
LT
840 }
841 }
8f3ea359 842out:
2abd2de7 843 trace_nbd_payload_received(req, handle);
8f3ea359
JB
844 mutex_unlock(&cmd->lock);
845 return ret ? ERR_PTR(ret) : cmd;
1da177e4
LT
846}
847
9561a7ad 848static void recv_work(struct work_struct *work)
1da177e4 849{
9561a7ad
JB
850 struct recv_thread_args *args = container_of(work,
851 struct recv_thread_args,
852 work);
853 struct nbd_device *nbd = args->nbd;
5ea8d108 854 struct nbd_config *config = nbd->config;
8663b210 855 struct request_queue *q = nbd->disk->queue;
98c598af 856 struct nbd_sock *nsock = args->nsock;
fd8383fd 857 struct nbd_cmd *cmd;
15f73f5b 858 struct request *rq;
1da177e4 859
19391830 860 while (1) {
3fe1db62 861 struct nbd_reply reply;
f3733247 862
98c598af 863 if (nbd_read_reply(nbd, nsock->sock, &reply))
3fe1db62
YK
864 break;
865
8663b210
YK
866 /*
867 * Grab .q_usage_counter so request pool won't go away, then no
868 * request use-after-free is possible during nbd_handle_reply().
869 * If queue is frozen, there won't be any inflight requests, we
870 * needn't to handle the incoming garbage message.
871 */
872 if (!percpu_ref_tryget(&q->q_usage_counter)) {
873 dev_err(disk_to_dev(nbd->disk), "%s: no io inflight\n",
874 __func__);
875 break;
876 }
877
3fe1db62 878 cmd = nbd_handle_reply(nbd, args->index, &reply);
8663b210
YK
879 if (IS_ERR(cmd)) {
880 percpu_ref_put(&q->q_usage_counter);
19391830
MP
881 break;
882 }
883
15f73f5b 884 rq = blk_mq_rq_from_pdu(cmd);
2895f183
YK
885 if (likely(!blk_should_fake_timeout(rq->q))) {
886 bool complete;
887
888 mutex_lock(&cmd->lock);
889 complete = __test_and_clear_bit(NBD_CMD_INFLIGHT,
890 &cmd->flags);
891 mutex_unlock(&cmd->lock);
892 if (complete)
893 blk_mq_complete_request(rq);
894 }
8663b210 895 percpu_ref_put(&q->q_usage_counter);
19391830 896 }
3fe1db62 897
3fe1db62
YK
898 mutex_lock(&nsock->tx_lock);
899 nbd_mark_nsock_dead(nbd, nsock, 1);
900 mutex_unlock(&nsock->tx_lock);
901
87aac3a8 902 nbd_config_put(nbd);
5ea8d108
JB
903 atomic_dec(&config->recv_threads);
904 wake_up(&config->recv_wq);
5ea8d108 905 kfree(args);
1da177e4
LT
906}
907
2dd6532e 908static bool nbd_clear_req(struct request *req, void *data)
1da177e4 909{
d250bf4e 910 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(req);
1da177e4 911
cddce011
XY
912 /* don't abort one completed request */
913 if (blk_mq_request_completed(req))
914 return true;
915
de6346ec 916 mutex_lock(&cmd->lock);
07175cb1
YK
917 if (!__test_and_clear_bit(NBD_CMD_INFLIGHT, &cmd->flags)) {
918 mutex_unlock(&cmd->lock);
919 return true;
920 }
2a842aca 921 cmd->status = BLK_STS_IOERR;
de6346ec
JB
922 mutex_unlock(&cmd->lock);
923
08e0029a 924 blk_mq_complete_request(req);
7baa8572 925 return true;
fd8383fd
JB
926}
927
928static void nbd_clear_que(struct nbd_device *nbd)
929{
b52c2e92 930 blk_mq_quiesce_queue(nbd->disk->queue);
fd8383fd 931 blk_mq_tagset_busy_iter(&nbd->tag_set, nbd_clear_req, NULL);
b52c2e92 932 blk_mq_unquiesce_queue(nbd->disk->queue);
e78273c8 933 dev_dbg(disk_to_dev(nbd->disk), "queue cleared\n");
1da177e4
LT
934}
935
f3733247
JB
936static int find_fallback(struct nbd_device *nbd, int index)
937{
5ea8d108 938 struct nbd_config *config = nbd->config;
f3733247 939 int new_index = -1;
5ea8d108 940 struct nbd_sock *nsock = config->socks[index];
f3733247
JB
941 int fallback = nsock->fallback_index;
942
ec76a7b9 943 if (test_bit(NBD_RT_DISCONNECTED, &config->runtime_flags))
f3733247
JB
944 return new_index;
945
5ea8d108 946 if (config->num_connections <= 1) {
f3733247 947 dev_err_ratelimited(disk_to_dev(nbd->disk),
d970958b 948 "Dead connection, failed to find a fallback\n");
f3733247
JB
949 return new_index;
950 }
951
5ea8d108
JB
952 if (fallback >= 0 && fallback < config->num_connections &&
953 !config->socks[fallback]->dead)
f3733247
JB
954 return fallback;
955
956 if (nsock->fallback_index < 0 ||
5ea8d108
JB
957 nsock->fallback_index >= config->num_connections ||
958 config->socks[nsock->fallback_index]->dead) {
f3733247 959 int i;
5ea8d108 960 for (i = 0; i < config->num_connections; i++) {
f3733247
JB
961 if (i == index)
962 continue;
5ea8d108 963 if (!config->socks[i]->dead) {
f3733247
JB
964 new_index = i;
965 break;
966 }
967 }
968 nsock->fallback_index = new_index;
969 if (new_index < 0) {
970 dev_err_ratelimited(disk_to_dev(nbd->disk),
971 "Dead connection, failed to find a fallback\n");
972 return new_index;
973 }
974 }
975 new_index = nsock->fallback_index;
976 return new_index;
977}
7fdfd406 978
560bc4b3
JB
979static int wait_for_reconnect(struct nbd_device *nbd)
980{
981 struct nbd_config *config = nbd->config;
982 if (!config->dead_conn_timeout)
983 return 0;
491bf8f2
XY
984
985 if (!wait_event_timeout(config->conn_wait,
986 test_bit(NBD_RT_DISCONNECTED,
987 &config->runtime_flags) ||
988 atomic_read(&config->live_connections) > 0,
989 config->dead_conn_timeout))
560bc4b3 990 return 0;
491bf8f2
XY
991
992 return !test_bit(NBD_RT_DISCONNECTED, &config->runtime_flags);
560bc4b3
JB
993}
994
9dd5d3ab 995static int nbd_handle_cmd(struct nbd_cmd *cmd, int index)
48cf6061 996{
fd8383fd
JB
997 struct request *req = blk_mq_rq_from_pdu(cmd);
998 struct nbd_device *nbd = cmd->nbd;
5ea8d108 999 struct nbd_config *config;
9561a7ad 1000 struct nbd_sock *nsock;
9dd5d3ab 1001 int ret;
fd8383fd 1002
3123ac77
LN
1003 config = nbd_get_config_unlocked(nbd);
1004 if (!config) {
5ea8d108
JB
1005 dev_err_ratelimited(disk_to_dev(nbd->disk),
1006 "Socks array is empty\n");
1007 return -EINVAL;
1008 }
5ea8d108
JB
1009
1010 if (index >= config->num_connections) {
a897b666
JB
1011 dev_err_ratelimited(disk_to_dev(nbd->disk),
1012 "Attempted send on invalid socket\n");
5ea8d108 1013 nbd_config_put(nbd);
9dd5d3ab 1014 return -EINVAL;
9561a7ad 1015 }
2a842aca 1016 cmd->status = BLK_STS_OK;
f3733247 1017again:
5ea8d108 1018 nsock = config->socks[index];
9561a7ad 1019 mutex_lock(&nsock->tx_lock);
f3733247 1020 if (nsock->dead) {
560bc4b3 1021 int old_index = index;
f3733247 1022 index = find_fallback(nbd, index);
560bc4b3 1023 mutex_unlock(&nsock->tx_lock);
5ea8d108 1024 if (index < 0) {
560bc4b3
JB
1025 if (wait_for_reconnect(nbd)) {
1026 index = old_index;
1027 goto again;
1028 }
1029 /* All the sockets should already be down at this point,
1030 * we just want to make sure that DISCONNECTED is set so
1031 * any requests that come in that were queue'ed waiting
1032 * for the reconnect timer don't trigger the timer again
1033 * and instead just error out.
1034 */
1035 sock_shutdown(nbd);
1036 nbd_config_put(nbd);
1037 return -EIO;
5ea8d108 1038 }
f3733247 1039 goto again;
48cf6061
LV
1040 }
1041
9dd5d3ab
JB
1042 /* Handle the case that we have a pending request that was partially
1043 * transmitted that _has_ to be serviced first. We need to call requeue
1044 * here so that it gets put _after_ the request that is already on the
1045 * dispatch list.
1046 */
6a468d59 1047 blk_mq_start_request(req);
9dd5d3ab 1048 if (unlikely(nsock->pending && nsock->pending != req)) {
d7d94d48 1049 nbd_requeue_cmd(cmd);
9dd5d3ab
JB
1050 ret = 0;
1051 goto out;
48cf6061 1052 }
f3733247
JB
1053 /*
1054 * Some failures are related to the link going down, so anything that
1055 * returns EAGAIN can be retried on a different socket.
1056 */
9dd5d3ab 1057 ret = nbd_send_cmd(nbd, cmd, index);
4e6eef5d
YK
1058 /*
1059 * Access to this flag is protected by cmd->lock, thus it's safe to set
1060 * the flag after nbd_send_cmd() succeed to send request to server.
1061 */
1062 if (!ret)
1063 __set_bit(NBD_CMD_INFLIGHT, &cmd->flags);
1064 else if (ret == -EAGAIN) {
f3733247 1065 dev_err_ratelimited(disk_to_dev(nbd->disk),
6a468d59 1066 "Request send failed, requeueing\n");
799f9a38 1067 nbd_mark_nsock_dead(nbd, nsock, 1);
d7d94d48 1068 nbd_requeue_cmd(cmd);
6a468d59 1069 ret = 0;
f3733247 1070 }
9dd5d3ab 1071out:
9561a7ad 1072 mutex_unlock(&nsock->tx_lock);
5ea8d108 1073 nbd_config_put(nbd);
9dd5d3ab 1074 return ret;
48cf6061
LV
1075}
1076
fc17b653 1077static blk_status_t nbd_queue_rq(struct blk_mq_hw_ctx *hctx,
fd8383fd 1078 const struct blk_mq_queue_data *bd)
1da177e4 1079{
fd8383fd 1080 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(bd->rq);
9dd5d3ab 1081 int ret;
1da177e4 1082
9561a7ad
JB
1083 /*
1084 * Since we look at the bio's to send the request over the network we
1085 * need to make sure the completion work doesn't mark this request done
1086 * before we are done doing our send. This keeps us from dereferencing
1087 * freed data if we have particularly fast completions (ie we get the
1088 * completion before we exit sock_xmit on the last bvec) or in the case
1089 * that the server is misbehaving (or there was an error) before we're
1090 * done sending everything over the wire.
1091 */
8f3ea359 1092 mutex_lock(&cmd->lock);
d7d94d48 1093 clear_bit(NBD_CMD_REQUEUED, &cmd->flags);
9dd5d3ab
JB
1094
1095 /* We can be called directly from the user space process, which means we
1096 * could possibly have signals pending so our sendmsg will fail. In
1097 * this case we need to return that we are busy, otherwise error out as
1098 * appropriate.
1099 */
1100 ret = nbd_handle_cmd(cmd, hctx->queue_num);
6e60a3bb
JB
1101 if (ret < 0)
1102 ret = BLK_STS_IOERR;
1103 else if (!ret)
1104 ret = BLK_STS_OK;
8f3ea359 1105 mutex_unlock(&cmd->lock);
9561a7ad 1106
6e60a3bb 1107 return ret;
1da177e4
LT
1108}
1109
cf1b2326
MC
1110static struct socket *nbd_get_socket(struct nbd_device *nbd, unsigned long fd,
1111 int *err)
1112{
1113 struct socket *sock;
1114
1115 *err = 0;
1116 sock = sockfd_lookup(fd, err);
1117 if (!sock)
1118 return NULL;
1119
1120 if (sock->ops->shutdown == sock_no_shutdown) {
1121 dev_err(disk_to_dev(nbd->disk), "Unsupported socket: shutdown callout must be supported.\n");
1122 *err = -EINVAL;
dff10bbe 1123 sockfd_put(sock);
cf1b2326
MC
1124 return NULL;
1125 }
1126
1127 return sock;
1128}
1129
e46c7287
JB
1130static int nbd_add_socket(struct nbd_device *nbd, unsigned long arg,
1131 bool netlink)
23272a67 1132{
5ea8d108 1133 struct nbd_config *config = nbd->config;
9442b739 1134 struct socket *sock;
9561a7ad
JB
1135 struct nbd_sock **socks;
1136 struct nbd_sock *nsock;
9442b739
JB
1137 int err;
1138
55793ea5
ZJ
1139 /* Arg will be cast to int, check it to avoid overflow */
1140 if (arg > INT_MAX)
1141 return -EINVAL;
cf1b2326 1142 sock = nbd_get_socket(nbd, arg, &err);
9442b739
JB
1143 if (!sock)
1144 return err;
23272a67 1145
b98e762e
JB
1146 /*
1147 * We need to make sure we don't get any errant requests while we're
1148 * reallocating the ->socks array.
1149 */
1150 blk_mq_freeze_queue(nbd->disk->queue);
1151
e46c7287 1152 if (!netlink && !nbd->task_setup &&
ec76a7b9 1153 !test_bit(NBD_RT_BOUND, &config->runtime_flags))
9561a7ad 1154 nbd->task_setup = current;
e46c7287
JB
1155
1156 if (!netlink &&
1157 (nbd->task_setup != current ||
ec76a7b9 1158 test_bit(NBD_RT_BOUND, &config->runtime_flags))) {
9561a7ad
JB
1159 dev_err(disk_to_dev(nbd->disk),
1160 "Device being setup by another task");
579dd91a
ZB
1161 err = -EBUSY;
1162 goto put_socket;
1163 }
1164
1165 nsock = kzalloc(sizeof(*nsock), GFP_KERNEL);
1166 if (!nsock) {
1167 err = -ENOMEM;
1168 goto put_socket;
23272a67
MP
1169 }
1170
5ea8d108 1171 socks = krealloc(config->socks, (config->num_connections + 1) *
9561a7ad 1172 sizeof(struct nbd_sock *), GFP_KERNEL);
9b1355d5 1173 if (!socks) {
579dd91a
ZB
1174 kfree(nsock);
1175 err = -ENOMEM;
1176 goto put_socket;
9b1355d5 1177 }
03bf73c3
NE
1178
1179 config->socks = socks;
1180
f3733247
JB
1181 nsock->fallback_index = -1;
1182 nsock->dead = false;
9561a7ad
JB
1183 mutex_init(&nsock->tx_lock);
1184 nsock->sock = sock;
9dd5d3ab
JB
1185 nsock->pending = NULL;
1186 nsock->sent = 0;
799f9a38 1187 nsock->cookie = 0;
5ea8d108 1188 socks[config->num_connections++] = nsock;
560bc4b3 1189 atomic_inc(&config->live_connections);
b98e762e 1190 blk_mq_unfreeze_queue(nbd->disk->queue);
23272a67 1191
9561a7ad 1192 return 0;
579dd91a
ZB
1193
1194put_socket:
b98e762e 1195 blk_mq_unfreeze_queue(nbd->disk->queue);
579dd91a
ZB
1196 sockfd_put(sock);
1197 return err;
23272a67
MP
1198}
1199
b7aa3d39
JB
1200static int nbd_reconnect_socket(struct nbd_device *nbd, unsigned long arg)
1201{
1202 struct nbd_config *config = nbd->config;
1203 struct socket *sock, *old;
1204 struct recv_thread_args *args;
1205 int i;
1206 int err;
1207
cf1b2326 1208 sock = nbd_get_socket(nbd, arg, &err);
b7aa3d39
JB
1209 if (!sock)
1210 return err;
1211
1212 args = kzalloc(sizeof(*args), GFP_KERNEL);
1213 if (!args) {
1214 sockfd_put(sock);
1215 return -ENOMEM;
1216 }
1217
1218 for (i = 0; i < config->num_connections; i++) {
1219 struct nbd_sock *nsock = config->socks[i];
1220
1221 if (!nsock->dead)
1222 continue;
1223
1224 mutex_lock(&nsock->tx_lock);
1225 if (!nsock->dead) {
1226 mutex_unlock(&nsock->tx_lock);
1227 continue;
1228 }
1229 sk_set_memalloc(sock->sk);
a7ee8cf1
JB
1230 if (nbd->tag_set.timeout)
1231 sock->sk->sk_sndtimeo = nbd->tag_set.timeout;
b7aa3d39
JB
1232 atomic_inc(&config->recv_threads);
1233 refcount_inc(&nbd->config_refs);
1234 old = nsock->sock;
1235 nsock->fallback_index = -1;
1236 nsock->sock = sock;
1237 nsock->dead = false;
1238 INIT_WORK(&args->work, recv_work);
1239 args->index = i;
1240 args->nbd = nbd;
98c598af 1241 args->nsock = nsock;
799f9a38 1242 nsock->cookie++;
b7aa3d39
JB
1243 mutex_unlock(&nsock->tx_lock);
1244 sockfd_put(old);
1245
ec76a7b9 1246 clear_bit(NBD_RT_DISCONNECTED, &config->runtime_flags);
7a362ea9 1247
b7aa3d39
JB
1248 /* We take the tx_mutex in an error path in the recv_work, so we
1249 * need to queue_work outside of the tx_mutex.
1250 */
e9e006f5 1251 queue_work(nbd->recv_workq, &args->work);
560bc4b3
JB
1252
1253 atomic_inc(&config->live_connections);
1254 wake_up(&config->conn_wait);
b7aa3d39
JB
1255 return 0;
1256 }
1257 sockfd_put(sock);
1258 kfree(args);
1259 return -ENOSPC;
1260}
1261
2a852a69 1262static void nbd_bdev_reset(struct nbd_device *nbd)
0e4f0f6f 1263{
dbdc1be3 1264 if (disk_openers(nbd->disk) > 1)
abbbdf12 1265 return;
2a852a69 1266 set_capacity(nbd->disk, 0);
0e4f0f6f
MP
1267}
1268
29eaadc0 1269static void nbd_parse_flags(struct nbd_device *nbd)
d02cf531 1270{
5ea8d108
JB
1271 struct nbd_config *config = nbd->config;
1272 if (config->flags & NBD_FLAG_READ_ONLY)
29eaadc0
JB
1273 set_disk_ro(nbd->disk, true);
1274 else
1275 set_disk_ro(nbd->disk, false);
685c9b24
SM
1276 if (config->flags & NBD_FLAG_SEND_FLUSH) {
1277 if (config->flags & NBD_FLAG_SEND_FUA)
1278 blk_queue_write_cache(nbd->disk->queue, true, true);
1279 else
1280 blk_queue_write_cache(nbd->disk->queue, true, false);
1281 }
d02cf531 1282 else
aafb1eec 1283 blk_queue_write_cache(nbd->disk->queue, false, false);
d02cf531
MP
1284}
1285
9561a7ad
JB
1286static void send_disconnects(struct nbd_device *nbd)
1287{
5ea8d108 1288 struct nbd_config *config = nbd->config;
c9f2b6ae
AV
1289 struct nbd_request request = {
1290 .magic = htonl(NBD_REQUEST_MAGIC),
1291 .type = htonl(NBD_CMD_DISC),
1292 };
1293 struct kvec iov = {.iov_base = &request, .iov_len = sizeof(request)};
1294 struct iov_iter from;
9561a7ad
JB
1295 int i, ret;
1296
5ea8d108 1297 for (i = 0; i < config->num_connections; i++) {
b4b2aecc
JB
1298 struct nbd_sock *nsock = config->socks[i];
1299
de4eda9d 1300 iov_iter_kvec(&from, ITER_SOURCE, &iov, 1, sizeof(request));
b4b2aecc 1301 mutex_lock(&nsock->tx_lock);
9dd5d3ab 1302 ret = sock_xmit(nbd, i, 1, &from, 0, NULL);
f52c0e08 1303 if (ret < 0)
9561a7ad
JB
1304 dev_err(disk_to_dev(nbd->disk),
1305 "Send disconnect failed %d\n", ret);
b4b2aecc 1306 mutex_unlock(&nsock->tx_lock);
9561a7ad
JB
1307 }
1308}
1309
29eaadc0 1310static int nbd_disconnect(struct nbd_device *nbd)
9442b739 1311{
5ea8d108 1312 struct nbd_config *config = nbd->config;
30d53d9c 1313
5ea8d108 1314 dev_info(disk_to_dev(nbd->disk), "NBD_DISCONNECT\n");
ec76a7b9 1315 set_bit(NBD_RT_DISCONNECT_REQUESTED, &config->runtime_flags);
8454d685 1316 set_bit(NBD_DISCONNECT_REQUESTED, &nbd->flags);
2e13456f 1317 send_disconnects(nbd);
9442b739
JB
1318 return 0;
1319}
1320
29eaadc0 1321static void nbd_clear_sock(struct nbd_device *nbd)
1a2ad211 1322{
9442b739
JB
1323 sock_shutdown(nbd);
1324 nbd_clear_que(nbd);
5ea8d108 1325 nbd->task_setup = NULL;
5ea8d108
JB
1326}
1327
1328static void nbd_config_put(struct nbd_device *nbd)
1329{
1330 if (refcount_dec_and_mutex_lock(&nbd->config_refs,
1331 &nbd->config_lock)) {
5ea8d108 1332 struct nbd_config *config = nbd->config;
5ea8d108 1333 nbd_dev_dbg_close(nbd);
435c2acb
XY
1334 invalidate_disk(nbd->disk);
1335 if (nbd->config->bytesize)
1336 kobject_uevent(&nbd_to_dev(nbd)->kobj, KOBJ_CHANGE);
ec76a7b9 1337 if (test_and_clear_bit(NBD_RT_HAS_PID_FILE,
5ea8d108
JB
1338 &config->runtime_flags))
1339 device_remove_file(disk_to_dev(nbd->disk), &pid_attr);
0c98057b 1340 nbd->pid = 0;
6497ef8d
PKK
1341 if (test_and_clear_bit(NBD_RT_HAS_BACKEND_FILE,
1342 &config->runtime_flags)) {
1343 device_remove_file(disk_to_dev(nbd->disk), &backend_attr);
1344 kfree(nbd->backend);
1345 nbd->backend = NULL;
1346 }
29eaadc0 1347 nbd_clear_sock(nbd);
5ea8d108
JB
1348 if (config->num_connections) {
1349 int i;
1350 for (i = 0; i < config->num_connections; i++) {
1351 sockfd_put(config->socks[i]->sock);
1352 kfree(config->socks[i]);
1353 }
1354 kfree(config->socks);
1355 }
fa976532 1356 kfree(nbd->config);
af622b86
ID
1357 nbd->config = NULL;
1358
1359 nbd->tag_set.timeout = 0;
6df133a1 1360 nbd->disk->queue->limits.discard_granularity = 0;
70200574 1361 blk_queue_max_discard_sectors(nbd->disk->queue, 0);
a2c97909 1362
5ea8d108 1363 mutex_unlock(&nbd->config_lock);
c6a4759e 1364 nbd_put(nbd);
5ea8d108
JB
1365 module_put(THIS_MODULE);
1366 }
9442b739
JB
1367}
1368
e46c7287 1369static int nbd_start_device(struct nbd_device *nbd)
9442b739 1370{
5ea8d108
JB
1371 struct nbd_config *config = nbd->config;
1372 int num_connections = config->num_connections;
9442b739 1373 int error = 0, i;
1a2ad211 1374
0c98057b 1375 if (nbd->pid)
9442b739 1376 return -EBUSY;
5ea8d108 1377 if (!config->socks)
9442b739
JB
1378 return -EINVAL;
1379 if (num_connections > 1 &&
5ea8d108 1380 !(config->flags & NBD_FLAG_CAN_MULTI_CONN)) {
9442b739 1381 dev_err(disk_to_dev(nbd->disk), "server does not support multiple connections per device.\n");
5ea8d108 1382 return -EINVAL;
9442b739 1383 }
23272a67 1384
5ea8d108 1385 blk_mq_update_nr_hw_queues(&nbd->tag_set, config->num_connections);
0c98057b 1386 nbd->pid = task_pid_nr(current);
23272a67 1387
29eaadc0 1388 nbd_parse_flags(nbd);
23272a67 1389
9442b739
JB
1390 error = device_create_file(disk_to_dev(nbd->disk), &pid_attr);
1391 if (error) {
6497ef8d 1392 dev_err(disk_to_dev(nbd->disk), "device_create_file failed for pid!\n");
5ea8d108 1393 return error;
1a2ad211 1394 }
ec76a7b9 1395 set_bit(NBD_RT_HAS_PID_FILE, &config->runtime_flags);
37091fdd 1396
9442b739
JB
1397 nbd_dev_dbg_init(nbd);
1398 for (i = 0; i < num_connections; i++) {
5ea8d108
JB
1399 struct recv_thread_args *args;
1400
1401 args = kzalloc(sizeof(*args), GFP_KERNEL);
1402 if (!args) {
1403 sock_shutdown(nbd);
5c0dd228
SK
1404 /*
1405 * If num_connections is m (2 < m),
1406 * and NO.1 ~ NO.n(1 < n < m) kzallocs are successful.
1407 * But NO.(n + 1) failed. We still have n recv threads.
1408 * So, add flush_workqueue here to prevent recv threads
1409 * dropping the last config_refs and trying to destroy
1410 * the workqueue from inside the workqueue.
1411 */
1412 if (i)
1413 flush_workqueue(nbd->recv_workq);
5ea8d108
JB
1414 return -ENOMEM;
1415 }
1416 sk_set_memalloc(config->socks[i]->sock->sk);
a7ee8cf1
JB
1417 if (nbd->tag_set.timeout)
1418 config->socks[i]->sock->sk->sk_sndtimeo =
1419 nbd->tag_set.timeout;
5ea8d108
JB
1420 atomic_inc(&config->recv_threads);
1421 refcount_inc(&nbd->config_refs);
1422 INIT_WORK(&args->work, recv_work);
1423 args->nbd = nbd;
98c598af 1424 args->nsock = config->socks[i];
5ea8d108 1425 args->index = i;
e9e006f5 1426 queue_work(nbd->recv_workq, &args->work);
37091fdd 1427 }
41e76c6a 1428 return nbd_set_size(nbd, config->bytesize, nbd_blksize(config));
e46c7287
JB
1429}
1430
2a852a69 1431static int nbd_start_device_ioctl(struct nbd_device *nbd)
e46c7287
JB
1432{
1433 struct nbd_config *config = nbd->config;
1434 int ret;
1435
1436 ret = nbd_start_device(nbd);
1437 if (ret)
1438 return ret;
1439
e46c7287 1440 if (max_part)
38430f08 1441 set_bit(GD_NEED_PART_SCAN, &nbd->disk->state);
e46c7287
JB
1442 mutex_unlock(&nbd->config_lock);
1443 ret = wait_event_interruptible(config->recv_wq,
5ea8d108 1444 atomic_read(&config->recv_threads) == 0);
1de7c3cf 1445 if (ret) {
5ea8d108 1446 sock_shutdown(nbd);
1de7c3cf
SY
1447 nbd_clear_que(nbd);
1448 }
1c05839a 1449
1de7c3cf 1450 flush_workqueue(nbd->recv_workq);
9442b739 1451 mutex_lock(&nbd->config_lock);
2a852a69 1452 nbd_bdev_reset(nbd);
9442b739 1453 /* user requested, ignore socket errors */
ec76a7b9 1454 if (test_bit(NBD_RT_DISCONNECT_REQUESTED, &config->runtime_flags))
e46c7287 1455 ret = 0;
ec76a7b9 1456 if (test_bit(NBD_RT_TIMEDOUT, &config->runtime_flags))
e46c7287
JB
1457 ret = -ETIMEDOUT;
1458 return ret;
9442b739
JB
1459}
1460
0c1c9a27 1461static void nbd_clear_sock_ioctl(struct nbd_device *nbd)
29eaadc0 1462{
09dadb59 1463 nbd_clear_sock(nbd);
07a1141f
CH
1464 disk_force_media_change(nbd->disk);
1465 nbd_bdev_reset(nbd);
ec76a7b9 1466 if (test_and_clear_bit(NBD_RT_HAS_CONFIG_REF,
e46c7287
JB
1467 &nbd->config->runtime_flags))
1468 nbd_config_put(nbd);
29eaadc0
JB
1469}
1470
55313e92
MC
1471static void nbd_set_cmd_timeout(struct nbd_device *nbd, u64 timeout)
1472{
1473 nbd->tag_set.timeout = timeout * HZ;
2da22da5
MC
1474 if (timeout)
1475 blk_queue_rq_timeout(nbd->disk->queue, timeout * HZ);
acb19e17
HP
1476 else
1477 blk_queue_rq_timeout(nbd->disk->queue, 30 * HZ);
55313e92
MC
1478}
1479
9442b739
JB
1480/* Must be called with config_lock held */
1481static int __nbd_ioctl(struct block_device *bdev, struct nbd_device *nbd,
1482 unsigned int cmd, unsigned long arg)
1483{
5ea8d108 1484 struct nbd_config *config = nbd->config;
fad7cd33 1485 loff_t bytesize;
5ea8d108 1486
9442b739
JB
1487 switch (cmd) {
1488 case NBD_DISCONNECT:
29eaadc0 1489 return nbd_disconnect(nbd);
9442b739 1490 case NBD_CLEAR_SOCK:
0c1c9a27 1491 nbd_clear_sock_ioctl(nbd);
29eaadc0 1492 return 0;
9442b739 1493 case NBD_SET_SOCK:
e46c7287 1494 return nbd_add_socket(nbd, arg, false);
9442b739 1495 case NBD_SET_BLKSIZE:
dcbddf54 1496 return nbd_set_size(nbd, config->bytesize, arg);
1da177e4 1497 case NBD_SET_SIZE:
41e76c6a 1498 return nbd_set_size(nbd, arg, nbd_blksize(config));
37091fdd 1499 case NBD_SET_SIZE_BLOCKS:
41e76c6a 1500 if (check_shl_overflow(arg, config->blksize_bits, &bytesize))
fad7cd33 1501 return -EINVAL;
41e76c6a 1502 return nbd_set_size(nbd, bytesize, nbd_blksize(config));
7fdfd406 1503 case NBD_SET_TIMEOUT:
2da22da5 1504 nbd_set_cmd_timeout(nbd, arg);
7fdfd406 1505 return 0;
1a2ad211 1506
2f012508 1507 case NBD_SET_FLAGS:
5ea8d108 1508 config->flags = arg;
2f012508 1509 return 0;
9442b739 1510 case NBD_DO_IT:
2a852a69 1511 return nbd_start_device_ioctl(nbd);
1da177e4 1512 case NBD_CLEAR_QUE:
4b2f0260
HX
1513 /*
1514 * This is for compatibility only. The queue is always cleared
1515 * by NBD_DO_IT or NBD_CLEAR_SOCK.
1516 */
1da177e4
LT
1517 return 0;
1518 case NBD_PRINT_DEBUG:
fd8383fd
JB
1519 /*
1520 * For compatibility only, we no longer keep a list of
1521 * outstanding requests.
1522 */
1da177e4
LT
1523 return 0;
1524 }
1a2ad211
PM
1525 return -ENOTTY;
1526}
1527
05bdb996 1528static int nbd_ioctl(struct block_device *bdev, blk_mode_t mode,
1a2ad211
PM
1529 unsigned int cmd, unsigned long arg)
1530{
f4507164 1531 struct nbd_device *nbd = bdev->bd_disk->private_data;
e46c7287
JB
1532 struct nbd_config *config = nbd->config;
1533 int error = -EINVAL;
1a2ad211
PM
1534
1535 if (!capable(CAP_SYS_ADMIN))
1536 return -EPERM;
1537
1dae69be
JB
1538 /* The block layer will pass back some non-nbd ioctls in case we have
1539 * special handling for them, but we don't so just return an error.
1540 */
1541 if (_IOC_TYPE(cmd) != 0xab)
1542 return -EINVAL;
1543
9561a7ad 1544 mutex_lock(&nbd->config_lock);
e46c7287
JB
1545
1546 /* Don't allow ioctl operations on a nbd device that was created with
1547 * netlink, unless it's DISCONNECT or CLEAR_SOCK, which are fine.
1548 */
ec76a7b9 1549 if (!test_bit(NBD_RT_BOUND, &config->runtime_flags) ||
e46c7287
JB
1550 (cmd == NBD_DISCONNECT || cmd == NBD_CLEAR_SOCK))
1551 error = __nbd_ioctl(bdev, nbd, cmd, arg);
1552 else
1553 dev_err(nbd_to_dev(nbd), "Cannot use ioctl interface on a netlink controlled device.\n");
9561a7ad 1554 mutex_unlock(&nbd->config_lock);
1a2ad211 1555 return error;
1da177e4
LT
1556}
1557
1b598605 1558static int nbd_alloc_and_init_config(struct nbd_device *nbd)
5ea8d108
JB
1559{
1560 struct nbd_config *config;
1561
1b598605
LN
1562 if (WARN_ON(nbd->config))
1563 return -EINVAL;
1564
c55b2b98 1565 if (!try_module_get(THIS_MODULE))
1b598605 1566 return -ENODEV;
c55b2b98 1567
5ea8d108 1568 config = kzalloc(sizeof(struct nbd_config), GFP_NOFS);
c55b2b98
YK
1569 if (!config) {
1570 module_put(THIS_MODULE);
1b598605 1571 return -ENOMEM;
c55b2b98
YK
1572 }
1573
5ea8d108
JB
1574 atomic_set(&config->recv_threads, 0);
1575 init_waitqueue_head(&config->recv_wq);
560bc4b3 1576 init_waitqueue_head(&config->conn_wait);
41e76c6a 1577 config->blksize_bits = NBD_DEF_BLKSIZE_BITS;
560bc4b3 1578 atomic_set(&config->live_connections, 0);
c2da049f 1579
1b598605 1580 nbd->config = config;
c2da049f
LN
1581 /*
1582 * Order refcount_set(&nbd->config_refs, 1) and nbd->config assignment,
1583 * its pair is the barrier in nbd_get_config_unlocked().
1584 * So nbd_get_config_unlocked() won't see nbd->config as null after
1585 * refcount_inc_not_zero() succeed.
1586 */
1587 smp_mb__before_atomic();
1b598605
LN
1588 refcount_set(&nbd->config_refs, 1);
1589
1590 return 0;
5ea8d108
JB
1591}
1592
05bdb996 1593static int nbd_open(struct gendisk *disk, blk_mode_t mode)
5ea8d108
JB
1594{
1595 struct nbd_device *nbd;
3123ac77 1596 struct nbd_config *config;
5ea8d108
JB
1597 int ret = 0;
1598
1599 mutex_lock(&nbd_index_mutex);
d32e2bf8 1600 nbd = disk->private_data;
5ea8d108
JB
1601 if (!nbd) {
1602 ret = -ENXIO;
1603 goto out;
1604 }
c6a4759e
JB
1605 if (!refcount_inc_not_zero(&nbd->refs)) {
1606 ret = -ENXIO;
1607 goto out;
1608 }
3123ac77
LN
1609
1610 config = nbd_get_config_unlocked(nbd);
1611 if (!config) {
5ea8d108
JB
1612 mutex_lock(&nbd->config_lock);
1613 if (refcount_inc_not_zero(&nbd->config_refs)) {
1614 mutex_unlock(&nbd->config_lock);
1615 goto out;
1616 }
1b598605
LN
1617 ret = nbd_alloc_and_init_config(nbd);
1618 if (ret) {
5ea8d108
JB
1619 mutex_unlock(&nbd->config_lock);
1620 goto out;
1621 }
1b598605 1622
c6a4759e 1623 refcount_inc(&nbd->refs);
5ea8d108 1624 mutex_unlock(&nbd->config_lock);
1aba169e 1625 if (max_part)
d32e2bf8 1626 set_bit(GD_NEED_PART_SCAN, &disk->state);
3123ac77 1627 } else if (nbd_disconnected(config)) {
1aba169e 1628 if (max_part)
d32e2bf8 1629 set_bit(GD_NEED_PART_SCAN, &disk->state);
5ea8d108
JB
1630 }
1631out:
1632 mutex_unlock(&nbd_index_mutex);
1633 return ret;
1634}
1635
ae220766 1636static void nbd_release(struct gendisk *disk)
5ea8d108
JB
1637{
1638 struct nbd_device *nbd = disk->private_data;
08ba91ee 1639
ec76a7b9 1640 if (test_bit(NBD_RT_DISCONNECT_ON_CLOSE, &nbd->config->runtime_flags) &&
dbdc1be3 1641 disk_openers(disk) == 0)
08ba91ee
DRK
1642 nbd_disconnect_and_put(nbd);
1643
5ea8d108 1644 nbd_config_put(nbd);
c6a4759e 1645 nbd_put(nbd);
5ea8d108
JB
1646}
1647
32746272
LL
1648static void nbd_free_disk(struct gendisk *disk)
1649{
1650 struct nbd_device *nbd = disk->private_data;
1651
1652 kfree(nbd);
1653}
1654
83d5cde4 1655static const struct block_device_operations nbd_fops =
1da177e4
LT
1656{
1657 .owner = THIS_MODULE,
5ea8d108
JB
1658 .open = nbd_open,
1659 .release = nbd_release,
8a6cfeb6 1660 .ioctl = nbd_ioctl,
263a3df1 1661 .compat_ioctl = nbd_ioctl,
32746272 1662 .free_disk = nbd_free_disk,
1da177e4
LT
1663};
1664
30d53d9c
MP
1665#if IS_ENABLED(CONFIG_DEBUG_FS)
1666
1667static int nbd_dbg_tasks_show(struct seq_file *s, void *unused)
1668{
1669 struct nbd_device *nbd = s->private;
1670
0c98057b
YB
1671 if (nbd->pid)
1672 seq_printf(s, "recv: %d\n", nbd->pid);
30d53d9c
MP
1673
1674 return 0;
1675}
1676
a2d52a6c 1677DEFINE_SHOW_ATTRIBUTE(nbd_dbg_tasks);
30d53d9c
MP
1678
1679static int nbd_dbg_flags_show(struct seq_file *s, void *unused)
1680{
1681 struct nbd_device *nbd = s->private;
5ea8d108 1682 u32 flags = nbd->config->flags;
30d53d9c
MP
1683
1684 seq_printf(s, "Hex: 0x%08x\n\n", flags);
1685
1686 seq_puts(s, "Known flags:\n");
1687
1688 if (flags & NBD_FLAG_HAS_FLAGS)
1689 seq_puts(s, "NBD_FLAG_HAS_FLAGS\n");
1690 if (flags & NBD_FLAG_READ_ONLY)
1691 seq_puts(s, "NBD_FLAG_READ_ONLY\n");
1692 if (flags & NBD_FLAG_SEND_FLUSH)
1693 seq_puts(s, "NBD_FLAG_SEND_FLUSH\n");
685c9b24
SM
1694 if (flags & NBD_FLAG_SEND_FUA)
1695 seq_puts(s, "NBD_FLAG_SEND_FUA\n");
30d53d9c
MP
1696 if (flags & NBD_FLAG_SEND_TRIM)
1697 seq_puts(s, "NBD_FLAG_SEND_TRIM\n");
1698
1699 return 0;
1700}
1701
a2d52a6c 1702DEFINE_SHOW_ATTRIBUTE(nbd_dbg_flags);
30d53d9c
MP
1703
1704static int nbd_dev_dbg_init(struct nbd_device *nbd)
1705{
1706 struct dentry *dir;
5ea8d108 1707 struct nbd_config *config = nbd->config;
27ea43fe
MP
1708
1709 if (!nbd_dbg_dir)
1710 return -EIO;
30d53d9c
MP
1711
1712 dir = debugfs_create_dir(nbd_name(nbd), nbd_dbg_dir);
4913cfcf 1713 if (IS_ERR(dir)) {
27ea43fe
MP
1714 dev_err(nbd_to_dev(nbd), "Failed to create debugfs dir for '%s'\n",
1715 nbd_name(nbd));
1716 return -EIO;
30d53d9c 1717 }
5ea8d108 1718 config->dbg_dir = dir;
30d53d9c 1719
a2d52a6c 1720 debugfs_create_file("tasks", 0444, dir, nbd, &nbd_dbg_tasks_fops);
5ea8d108 1721 debugfs_create_u64("size_bytes", 0444, dir, &config->bytesize);
0eadf37a 1722 debugfs_create_u32("timeout", 0444, dir, &nbd->tag_set.timeout);
41e76c6a 1723 debugfs_create_u32("blocksize_bits", 0444, dir, &config->blksize_bits);
a2d52a6c 1724 debugfs_create_file("flags", 0444, dir, nbd, &nbd_dbg_flags_fops);
30d53d9c
MP
1725
1726 return 0;
1727}
1728
1729static void nbd_dev_dbg_close(struct nbd_device *nbd)
1730{
5ea8d108 1731 debugfs_remove_recursive(nbd->config->dbg_dir);
30d53d9c
MP
1732}
1733
1734static int nbd_dbg_init(void)
1735{
1736 struct dentry *dbg_dir;
1737
1738 dbg_dir = debugfs_create_dir("nbd", NULL);
4913cfcf 1739 if (IS_ERR(dbg_dir))
27ea43fe 1740 return -EIO;
30d53d9c
MP
1741
1742 nbd_dbg_dir = dbg_dir;
1743
1744 return 0;
1745}
1746
1747static void nbd_dbg_close(void)
1748{
1749 debugfs_remove_recursive(nbd_dbg_dir);
1750}
1751
1752#else /* IS_ENABLED(CONFIG_DEBUG_FS) */
1753
1754static int nbd_dev_dbg_init(struct nbd_device *nbd)
1755{
1756 return 0;
1757}
1758
1759static void nbd_dev_dbg_close(struct nbd_device *nbd)
1760{
1761}
1762
1763static int nbd_dbg_init(void)
1764{
1765 return 0;
1766}
1767
1768static void nbd_dbg_close(void)
1769{
1770}
1771
1772#endif
1773
d6296d39
CH
1774static int nbd_init_request(struct blk_mq_tag_set *set, struct request *rq,
1775 unsigned int hctx_idx, unsigned int numa_node)
fd8383fd
JB
1776{
1777 struct nbd_cmd *cmd = blk_mq_rq_to_pdu(rq);
d6296d39 1778 cmd->nbd = set->driver_data;
d7d94d48 1779 cmd->flags = 0;
8f3ea359 1780 mutex_init(&cmd->lock);
fd8383fd
JB
1781 return 0;
1782}
1783
f363b089 1784static const struct blk_mq_ops nbd_mq_ops = {
fd8383fd 1785 .queue_rq = nbd_queue_rq,
1e388ae0 1786 .complete = nbd_complete_rq,
fd8383fd 1787 .init_request = nbd_init_request,
0eadf37a 1788 .timeout = nbd_xmit_timeout,
fd8383fd
JB
1789};
1790
6e4df4c6 1791static struct nbd_device *nbd_dev_add(int index, unsigned int refs)
b0d9111a
JB
1792{
1793 struct nbd_device *nbd;
1794 struct gendisk *disk;
b0d9111a
JB
1795 int err = -ENOMEM;
1796
1797 nbd = kzalloc(sizeof(struct nbd_device), GFP_KERNEL);
1798 if (!nbd)
1799 goto out;
1800
4af5f2e0
CH
1801 nbd->tag_set.ops = &nbd_mq_ops;
1802 nbd->tag_set.nr_hw_queues = 1;
1803 nbd->tag_set.queue_depth = 128;
1804 nbd->tag_set.numa_node = NUMA_NO_NODE;
1805 nbd->tag_set.cmd_size = sizeof(struct nbd_cmd);
1806 nbd->tag_set.flags = BLK_MQ_F_SHOULD_MERGE |
1807 BLK_MQ_F_BLOCKING;
1808 nbd->tag_set.driver_data = nbd;
68c9417b 1809 INIT_WORK(&nbd->remove_work, nbd_dev_remove_work);
6497ef8d 1810 nbd->backend = NULL;
4af5f2e0
CH
1811
1812 err = blk_mq_alloc_tag_set(&nbd->tag_set);
1813 if (err)
b0d9111a
JB
1814 goto out_free_nbd;
1815
6e4df4c6 1816 mutex_lock(&nbd_index_mutex);
b0d9111a
JB
1817 if (index >= 0) {
1818 err = idr_alloc(&nbd_index_idr, nbd, index, index + 1,
1819 GFP_KERNEL);
1820 if (err == -ENOSPC)
1821 err = -EEXIST;
1822 } else {
f12bc113
ZJ
1823 err = idr_alloc(&nbd_index_idr, nbd, 0,
1824 (MINORMASK >> part_shift) + 1, GFP_KERNEL);
b0d9111a
JB
1825 if (err >= 0)
1826 index = err;
1827 }
b190300d 1828 nbd->index = index;
6e4df4c6 1829 mutex_unlock(&nbd_index_mutex);
b0d9111a 1830 if (err < 0)
4af5f2e0 1831 goto out_free_tags;
b0d9111a 1832
4af5f2e0
CH
1833 disk = blk_mq_alloc_disk(&nbd->tag_set, NULL);
1834 if (IS_ERR(disk)) {
1835 err = PTR_ERR(disk);
b0d9111a 1836 goto out_free_idr;
b0d9111a 1837 }
4af5f2e0 1838 nbd->disk = disk;
b0d9111a 1839
e2daec48
YB
1840 nbd->recv_workq = alloc_workqueue("nbd%d-recv",
1841 WQ_MEM_RECLAIM | WQ_HIGHPRI |
1842 WQ_UNBOUND, 0, nbd->index);
1843 if (!nbd->recv_workq) {
1844 dev_err(disk_to_dev(nbd->disk), "Could not allocate knbd recv work queue.\n");
1845 err = -ENOMEM;
1846 goto out_err_disk;
1847 }
1848
b0d9111a
JB
1849 /*
1850 * Tell the block layer that we are not a rotational device
1851 */
8b904b5b 1852 blk_queue_flag_set(QUEUE_FLAG_NONROT, disk->queue);
6df133a1
JB
1853 disk->queue->limits.discard_granularity = 0;
1854 blk_queue_max_discard_sectors(disk->queue, 0);
ebb16d0d 1855 blk_queue_max_segment_size(disk->queue, UINT_MAX);
1cc1f17a 1856 blk_queue_max_segments(disk->queue, USHRT_MAX);
b0d9111a
JB
1857 blk_queue_max_hw_sectors(disk->queue, 65536);
1858 disk->queue->limits.max_sectors = 256;
1859
b0d9111a 1860 mutex_init(&nbd->config_lock);
5ea8d108 1861 refcount_set(&nbd->config_refs, 0);
75b7f62a
TH
1862 /*
1863 * Start out with a zero references to keep other threads from using
1864 * this device until it is fully initialized.
1865 */
1866 refcount_set(&nbd->refs, 0);
c6a4759e 1867 INIT_LIST_HEAD(&nbd->list);
b0d9111a 1868 disk->major = NBD_MAJOR;
7198bfc2 1869 disk->first_minor = index << part_shift;
4af5f2e0 1870 disk->minors = 1 << part_shift;
b0d9111a
JB
1871 disk->fops = &nbd_fops;
1872 disk->private_data = nbd;
1873 sprintf(disk->disk_name, "nbd%d", index);
e1654f41
LC
1874 err = add_disk(disk);
1875 if (err)
e2daec48 1876 goto out_free_work;
75b7f62a
TH
1877
1878 /*
1879 * Now publish the device.
1880 */
1881 refcount_set(&nbd->refs, refs);
47d902b9 1882 nbd_total_devices++;
7bdc00cf 1883 return nbd;
b0d9111a 1884
e2daec48
YB
1885out_free_work:
1886 destroy_workqueue(nbd->recv_workq);
e1654f41 1887out_err_disk:
8b9ab626 1888 put_disk(disk);
b0d9111a 1889out_free_idr:
93f63bc4 1890 mutex_lock(&nbd_index_mutex);
b0d9111a 1891 idr_remove(&nbd_index_idr, index);
93f63bc4 1892 mutex_unlock(&nbd_index_mutex);
4af5f2e0
CH
1893out_free_tags:
1894 blk_mq_free_tag_set(&nbd->tag_set);
b0d9111a
JB
1895out_free_nbd:
1896 kfree(nbd);
1897out:
7bdc00cf 1898 return ERR_PTR(err);
b0d9111a
JB
1899}
1900
438cd318 1901static struct nbd_device *nbd_find_get_unused(void)
e46c7287 1902{
409e0ff1
CH
1903 struct nbd_device *nbd;
1904 int id;
e46c7287 1905
409e0ff1
CH
1906 lockdep_assert_held(&nbd_index_mutex);
1907
438cd318
CH
1908 idr_for_each_entry(&nbd_index_idr, nbd, id) {
1909 if (refcount_read(&nbd->config_refs) ||
1910 test_bit(NBD_DESTROY_ON_DISCONNECT, &nbd->flags))
1911 continue;
1912 if (refcount_inc_not_zero(&nbd->refs))
409e0ff1 1913 return nbd;
e46c7287 1914 }
409e0ff1
CH
1915
1916 return NULL;
e46c7287
JB
1917}
1918
1919/* Netlink interface. */
a86c4120 1920static const struct nla_policy nbd_attr_policy[NBD_ATTR_MAX + 1] = {
e46c7287
JB
1921 [NBD_ATTR_INDEX] = { .type = NLA_U32 },
1922 [NBD_ATTR_SIZE_BYTES] = { .type = NLA_U64 },
1923 [NBD_ATTR_BLOCK_SIZE_BYTES] = { .type = NLA_U64 },
1924 [NBD_ATTR_TIMEOUT] = { .type = NLA_U64 },
1925 [NBD_ATTR_SERVER_FLAGS] = { .type = NLA_U64 },
1926 [NBD_ATTR_CLIENT_FLAGS] = { .type = NLA_U64 },
1927 [NBD_ATTR_SOCKETS] = { .type = NLA_NESTED},
560bc4b3 1928 [NBD_ATTR_DEAD_CONN_TIMEOUT] = { .type = NLA_U64 },
47d902b9 1929 [NBD_ATTR_DEVICE_LIST] = { .type = NLA_NESTED},
6497ef8d 1930 [NBD_ATTR_BACKEND_IDENTIFIER] = { .type = NLA_STRING},
e46c7287
JB
1931};
1932
a86c4120 1933static const struct nla_policy nbd_sock_policy[NBD_SOCK_MAX + 1] = {
e46c7287
JB
1934 [NBD_SOCK_FD] = { .type = NLA_U32 },
1935};
1936
47d902b9
JB
1937/* We don't use this right now since we don't parse the incoming list, but we
1938 * still want it here so userspace knows what to expect.
1939 */
a86c4120 1940static const struct nla_policy __attribute__((unused))
47d902b9
JB
1941nbd_device_policy[NBD_DEVICE_ATTR_MAX + 1] = {
1942 [NBD_DEVICE_INDEX] = { .type = NLA_U32 },
1943 [NBD_DEVICE_CONNECTED] = { .type = NLA_U8 },
1944};
1945
4ddeaae8
MC
1946static int nbd_genl_size_set(struct genl_info *info, struct nbd_device *nbd)
1947{
1948 struct nbd_config *config = nbd->config;
41e76c6a 1949 u64 bsize = nbd_blksize(config);
4ddeaae8
MC
1950 u64 bytes = config->bytesize;
1951
1952 if (info->attrs[NBD_ATTR_SIZE_BYTES])
1953 bytes = nla_get_u64(info->attrs[NBD_ATTR_SIZE_BYTES]);
1954
dcbddf54 1955 if (info->attrs[NBD_ATTR_BLOCK_SIZE_BYTES])
4ddeaae8 1956 bsize = nla_get_u64(info->attrs[NBD_ATTR_BLOCK_SIZE_BYTES]);
4ddeaae8 1957
41e76c6a 1958 if (bytes != config->bytesize || bsize != nbd_blksize(config))
dcbddf54 1959 return nbd_set_size(nbd, bytes, bsize);
4ddeaae8
MC
1960 return 0;
1961}
1962
e46c7287
JB
1963static int nbd_genl_connect(struct sk_buff *skb, struct genl_info *info)
1964{
409e0ff1 1965 struct nbd_device *nbd;
e46c7287
JB
1966 struct nbd_config *config;
1967 int index = -1;
1968 int ret;
a2c97909 1969 bool put_dev = false;
e46c7287
JB
1970
1971 if (!netlink_capable(skb, CAP_SYS_ADMIN))
1972 return -EPERM;
1973
858f1bf6 1974 if (info->attrs[NBD_ATTR_INDEX]) {
e46c7287 1975 index = nla_get_u32(info->attrs[NBD_ATTR_INDEX]);
858f1bf6
ZW
1976
1977 /*
1978 * Too big first_minor can cause duplicate creation of
1979 * sysfs files/links, since index << part_shift might overflow, or
1980 * MKDEV() expect that the max bits of first_minor is 20.
1981 */
1982 if (index < 0 || index > MINORMASK >> part_shift) {
1243172d 1983 pr_err("illegal input index %d\n", index);
858f1bf6
ZW
1984 return -EINVAL;
1985 }
1986 }
7399b886 1987 if (GENL_REQ_ATTR_CHECK(info, NBD_ATTR_SOCKETS)) {
1243172d 1988 pr_err("must specify at least one socket\n");
e46c7287
JB
1989 return -EINVAL;
1990 }
7399b886 1991 if (GENL_REQ_ATTR_CHECK(info, NBD_ATTR_SIZE_BYTES)) {
1243172d 1992 pr_err("must specify a size in bytes for the device\n");
e46c7287
JB
1993 return -EINVAL;
1994 }
1995again:
1996 mutex_lock(&nbd_index_mutex);
1997 if (index == -1) {
438cd318 1998 nbd = nbd_find_get_unused();
e46c7287
JB
1999 } else {
2000 nbd = idr_find(&nbd_index_idr, index);
7ee656c3
CH
2001 if (nbd) {
2002 if ((test_bit(NBD_DESTROY_ON_DISCONNECT, &nbd->flags) &&
2003 test_bit(NBD_DISCONNECT_REQUESTED, &nbd->flags)) ||
2004 !refcount_inc_not_zero(&nbd->refs)) {
e6a76272 2005 mutex_unlock(&nbd_index_mutex);
bc9da6dd 2006 pr_err("device at index %d is going down\n",
7ee656c3
CH
2007 index);
2008 return -EINVAL;
e6a76272 2009 }
e6a76272 2010 }
e46c7287 2011 }
7ee656c3 2012 mutex_unlock(&nbd_index_mutex);
8454d685 2013
7ee656c3 2014 if (!nbd) {
6e4df4c6
CH
2015 nbd = nbd_dev_add(index, 2);
2016 if (IS_ERR(nbd)) {
bc9da6dd 2017 pr_err("failed to add new device\n");
6e4df4c6
CH
2018 return PTR_ERR(nbd);
2019 }
e46c7287
JB
2020 }
2021
2022 mutex_lock(&nbd->config_lock);
2023 if (refcount_read(&nbd->config_refs)) {
2024 mutex_unlock(&nbd->config_lock);
c6a4759e 2025 nbd_put(nbd);
e46c7287
JB
2026 if (index == -1)
2027 goto again;
1243172d 2028 pr_err("nbd%d already in use\n", index);
e46c7287
JB
2029 return -EBUSY;
2030 }
1b598605
LN
2031
2032 ret = nbd_alloc_and_init_config(nbd);
2033 if (ret) {
e46c7287 2034 mutex_unlock(&nbd->config_lock);
c6a4759e 2035 nbd_put(nbd);
1243172d 2036 pr_err("couldn't allocate config\n");
1b598605 2037 return ret;
e46c7287 2038 }
e46c7287 2039
1b598605
LN
2040 config = nbd->config;
2041 set_bit(NBD_RT_BOUND, &config->runtime_flags);
4ddeaae8
MC
2042 ret = nbd_genl_size_set(info, nbd);
2043 if (ret)
2044 goto out;
2045
55313e92
MC
2046 if (info->attrs[NBD_ATTR_TIMEOUT])
2047 nbd_set_cmd_timeout(nbd,
2048 nla_get_u64(info->attrs[NBD_ATTR_TIMEOUT]));
560bc4b3
JB
2049 if (info->attrs[NBD_ATTR_DEAD_CONN_TIMEOUT]) {
2050 config->dead_conn_timeout =
2051 nla_get_u64(info->attrs[NBD_ATTR_DEAD_CONN_TIMEOUT]);
2052 config->dead_conn_timeout *= HZ;
2053 }
e46c7287
JB
2054 if (info->attrs[NBD_ATTR_SERVER_FLAGS])
2055 config->flags =
2056 nla_get_u64(info->attrs[NBD_ATTR_SERVER_FLAGS]);
a2c97909
JB
2057 if (info->attrs[NBD_ATTR_CLIENT_FLAGS]) {
2058 u64 flags = nla_get_u64(info->attrs[NBD_ATTR_CLIENT_FLAGS]);
2059 if (flags & NBD_CFLAG_DESTROY_ON_DISCONNECT) {
c9a2f90f
JB
2060 /*
2061 * We have 1 ref to keep the device around, and then 1
2062 * ref for our current operation here, which will be
2063 * inherited by the config. If we already have
2064 * DESTROY_ON_DISCONNECT set then we know we don't have
2065 * that extra ref already held so we don't need the
2066 * put_dev.
2067 */
2068 if (!test_and_set_bit(NBD_DESTROY_ON_DISCONNECT,
2069 &nbd->flags))
2070 put_dev = true;
8454d685 2071 } else {
c9a2f90f
JB
2072 if (test_and_clear_bit(NBD_DESTROY_ON_DISCONNECT,
2073 &nbd->flags))
2074 refcount_inc(&nbd->refs);
a2c97909 2075 }
08ba91ee 2076 if (flags & NBD_CFLAG_DISCONNECT_ON_CLOSE) {
ec76a7b9 2077 set_bit(NBD_RT_DISCONNECT_ON_CLOSE,
08ba91ee
DRK
2078 &config->runtime_flags);
2079 }
a2c97909
JB
2080 }
2081
e46c7287
JB
2082 if (info->attrs[NBD_ATTR_SOCKETS]) {
2083 struct nlattr *attr;
2084 int rem, fd;
2085
2086 nla_for_each_nested(attr, info->attrs[NBD_ATTR_SOCKETS],
2087 rem) {
2088 struct nlattr *socks[NBD_SOCK_MAX+1];
2089
2090 if (nla_type(attr) != NBD_SOCK_ITEM) {
1243172d 2091 pr_err("socks must be embedded in a SOCK_ITEM attr\n");
e46c7287
JB
2092 ret = -EINVAL;
2093 goto out;
2094 }
8cb08174
JB
2095 ret = nla_parse_nested_deprecated(socks, NBD_SOCK_MAX,
2096 attr,
2097 nbd_sock_policy,
2098 info->extack);
e46c7287 2099 if (ret != 0) {
1243172d 2100 pr_err("error processing sock list\n");
e46c7287
JB
2101 ret = -EINVAL;
2102 goto out;
2103 }
2104 if (!socks[NBD_SOCK_FD])
2105 continue;
2106 fd = (int)nla_get_u32(socks[NBD_SOCK_FD]);
2107 ret = nbd_add_socket(nbd, fd, true);
2108 if (ret)
2109 goto out;
2110 }
2111 }
2112 ret = nbd_start_device(nbd);
6497ef8d
PKK
2113 if (ret)
2114 goto out;
2115 if (info->attrs[NBD_ATTR_BACKEND_IDENTIFIER]) {
2116 nbd->backend = nla_strdup(info->attrs[NBD_ATTR_BACKEND_IDENTIFIER],
2117 GFP_KERNEL);
2118 if (!nbd->backend) {
2119 ret = -ENOMEM;
2120 goto out;
2121 }
2122 }
2123 ret = device_create_file(disk_to_dev(nbd->disk), &backend_attr);
2124 if (ret) {
2125 dev_err(disk_to_dev(nbd->disk),
2126 "device_create_file failed for backend!\n");
2127 goto out;
2128 }
2129 set_bit(NBD_RT_HAS_BACKEND_FILE, &config->runtime_flags);
e46c7287
JB
2130out:
2131 mutex_unlock(&nbd->config_lock);
2132 if (!ret) {
ec76a7b9 2133 set_bit(NBD_RT_HAS_CONFIG_REF, &config->runtime_flags);
e46c7287
JB
2134 refcount_inc(&nbd->config_refs);
2135 nbd_connect_reply(info, nbd->index);
2136 }
2137 nbd_config_put(nbd);
a2c97909
JB
2138 if (put_dev)
2139 nbd_put(nbd);
e46c7287
JB
2140 return ret;
2141}
2142
08ba91ee
DRK
2143static void nbd_disconnect_and_put(struct nbd_device *nbd)
2144{
2145 mutex_lock(&nbd->config_lock);
2146 nbd_disconnect(nbd);
cddce011 2147 sock_shutdown(nbd);
491bf8f2 2148 wake_up(&nbd->config->conn_wait);
e9e006f5 2149 /*
e2daec48 2150 * Make sure recv thread has finished, we can safely call nbd_clear_que()
cddce011 2151 * to cancel the inflight I/Os.
e9e006f5 2152 */
e2daec48 2153 flush_workqueue(nbd->recv_workq);
cddce011
XY
2154 nbd_clear_que(nbd);
2155 nbd->task_setup = NULL;
2156 mutex_unlock(&nbd->config_lock);
2157
ec76a7b9 2158 if (test_and_clear_bit(NBD_RT_HAS_CONFIG_REF,
08ba91ee
DRK
2159 &nbd->config->runtime_flags))
2160 nbd_config_put(nbd);
2161}
2162
e46c7287
JB
2163static int nbd_genl_disconnect(struct sk_buff *skb, struct genl_info *info)
2164{
2165 struct nbd_device *nbd;
2166 int index;
2167
2168 if (!netlink_capable(skb, CAP_SYS_ADMIN))
2169 return -EPERM;
2170
7399b886 2171 if (GENL_REQ_ATTR_CHECK(info, NBD_ATTR_INDEX)) {
1243172d 2172 pr_err("must specify an index to disconnect\n");
e46c7287
JB
2173 return -EINVAL;
2174 }
2175 index = nla_get_u32(info->attrs[NBD_ATTR_INDEX]);
2176 mutex_lock(&nbd_index_mutex);
2177 nbd = idr_find(&nbd_index_idr, index);
e46c7287 2178 if (!nbd) {
c6a4759e 2179 mutex_unlock(&nbd_index_mutex);
1243172d 2180 pr_err("couldn't find device at index %d\n", index);
e46c7287
JB
2181 return -EINVAL;
2182 }
c6a4759e
JB
2183 if (!refcount_inc_not_zero(&nbd->refs)) {
2184 mutex_unlock(&nbd_index_mutex);
1243172d 2185 pr_err("device at index %d is going down\n", index);
c6a4759e
JB
2186 return -EINVAL;
2187 }
2188 mutex_unlock(&nbd_index_mutex);
bedf78c4
SK
2189 if (!refcount_inc_not_zero(&nbd->config_refs))
2190 goto put_nbd;
08ba91ee 2191 nbd_disconnect_and_put(nbd);
e46c7287 2192 nbd_config_put(nbd);
bedf78c4 2193put_nbd:
c6a4759e 2194 nbd_put(nbd);
e46c7287
JB
2195 return 0;
2196}
2197
b7aa3d39
JB
2198static int nbd_genl_reconfigure(struct sk_buff *skb, struct genl_info *info)
2199{
2200 struct nbd_device *nbd = NULL;
2201 struct nbd_config *config;
2202 int index;
08ba91ee 2203 int ret = 0;
a2c97909 2204 bool put_dev = false;
b7aa3d39
JB
2205
2206 if (!netlink_capable(skb, CAP_SYS_ADMIN))
2207 return -EPERM;
2208
7399b886 2209 if (GENL_REQ_ATTR_CHECK(info, NBD_ATTR_INDEX)) {
1243172d 2210 pr_err("must specify a device to reconfigure\n");
b7aa3d39
JB
2211 return -EINVAL;
2212 }
2213 index = nla_get_u32(info->attrs[NBD_ATTR_INDEX]);
2214 mutex_lock(&nbd_index_mutex);
2215 nbd = idr_find(&nbd_index_idr, index);
b7aa3d39 2216 if (!nbd) {
c6a4759e 2217 mutex_unlock(&nbd_index_mutex);
1243172d 2218 pr_err("couldn't find a device at index %d\n", index);
b7aa3d39
JB
2219 return -EINVAL;
2220 }
6497ef8d
PKK
2221 if (nbd->backend) {
2222 if (info->attrs[NBD_ATTR_BACKEND_IDENTIFIER]) {
2223 if (nla_strcmp(info->attrs[NBD_ATTR_BACKEND_IDENTIFIER],
2224 nbd->backend)) {
2225 mutex_unlock(&nbd_index_mutex);
2226 dev_err(nbd_to_dev(nbd),
2227 "backend image doesn't match with %s\n",
2228 nbd->backend);
2229 return -EINVAL;
2230 }
2231 } else {
2232 mutex_unlock(&nbd_index_mutex);
2233 dev_err(nbd_to_dev(nbd), "must specify backend\n");
2234 return -EINVAL;
2235 }
2236 }
c6a4759e
JB
2237 if (!refcount_inc_not_zero(&nbd->refs)) {
2238 mutex_unlock(&nbd_index_mutex);
1243172d 2239 pr_err("device at index %d is going down\n", index);
c6a4759e
JB
2240 return -EINVAL;
2241 }
2242 mutex_unlock(&nbd_index_mutex);
b7aa3d39 2243
3123ac77
LN
2244 config = nbd_get_config_unlocked(nbd);
2245 if (!config) {
b7aa3d39
JB
2246 dev_err(nbd_to_dev(nbd),
2247 "not configured, cannot reconfigure\n");
c6a4759e 2248 nbd_put(nbd);
b7aa3d39
JB
2249 return -EINVAL;
2250 }
2251
2252 mutex_lock(&nbd->config_lock);
ec76a7b9 2253 if (!test_bit(NBD_RT_BOUND, &config->runtime_flags) ||
0c98057b 2254 !nbd->pid) {
b7aa3d39
JB
2255 dev_err(nbd_to_dev(nbd),
2256 "not configured, cannot reconfigure\n");
08ba91ee 2257 ret = -EINVAL;
b7aa3d39
JB
2258 goto out;
2259 }
2260
4ddeaae8
MC
2261 ret = nbd_genl_size_set(info, nbd);
2262 if (ret)
2263 goto out;
2264
55313e92
MC
2265 if (info->attrs[NBD_ATTR_TIMEOUT])
2266 nbd_set_cmd_timeout(nbd,
2267 nla_get_u64(info->attrs[NBD_ATTR_TIMEOUT]));
560bc4b3
JB
2268 if (info->attrs[NBD_ATTR_DEAD_CONN_TIMEOUT]) {
2269 config->dead_conn_timeout =
2270 nla_get_u64(info->attrs[NBD_ATTR_DEAD_CONN_TIMEOUT]);
2271 config->dead_conn_timeout *= HZ;
2272 }
a2c97909
JB
2273 if (info->attrs[NBD_ATTR_CLIENT_FLAGS]) {
2274 u64 flags = nla_get_u64(info->attrs[NBD_ATTR_CLIENT_FLAGS]);
2275 if (flags & NBD_CFLAG_DESTROY_ON_DISCONNECT) {
c9a2f90f
JB
2276 if (!test_and_set_bit(NBD_DESTROY_ON_DISCONNECT,
2277 &nbd->flags))
a2c97909
JB
2278 put_dev = true;
2279 } else {
c9a2f90f
JB
2280 if (test_and_clear_bit(NBD_DESTROY_ON_DISCONNECT,
2281 &nbd->flags))
a2c97909
JB
2282 refcount_inc(&nbd->refs);
2283 }
08ba91ee
DRK
2284
2285 if (flags & NBD_CFLAG_DISCONNECT_ON_CLOSE) {
ec76a7b9 2286 set_bit(NBD_RT_DISCONNECT_ON_CLOSE,
08ba91ee
DRK
2287 &config->runtime_flags);
2288 } else {
ec76a7b9 2289 clear_bit(NBD_RT_DISCONNECT_ON_CLOSE,
08ba91ee
DRK
2290 &config->runtime_flags);
2291 }
a2c97909 2292 }
b7aa3d39
JB
2293
2294 if (info->attrs[NBD_ATTR_SOCKETS]) {
2295 struct nlattr *attr;
2296 int rem, fd;
2297
2298 nla_for_each_nested(attr, info->attrs[NBD_ATTR_SOCKETS],
2299 rem) {
2300 struct nlattr *socks[NBD_SOCK_MAX+1];
2301
2302 if (nla_type(attr) != NBD_SOCK_ITEM) {
1243172d 2303 pr_err("socks must be embedded in a SOCK_ITEM attr\n");
b7aa3d39
JB
2304 ret = -EINVAL;
2305 goto out;
2306 }
8cb08174
JB
2307 ret = nla_parse_nested_deprecated(socks, NBD_SOCK_MAX,
2308 attr,
2309 nbd_sock_policy,
2310 info->extack);
b7aa3d39 2311 if (ret != 0) {
1243172d 2312 pr_err("error processing sock list\n");
b7aa3d39
JB
2313 ret = -EINVAL;
2314 goto out;
2315 }
2316 if (!socks[NBD_SOCK_FD])
2317 continue;
2318 fd = (int)nla_get_u32(socks[NBD_SOCK_FD]);
2319 ret = nbd_reconnect_socket(nbd, fd);
2320 if (ret) {
2321 if (ret == -ENOSPC)
2322 ret = 0;
2323 goto out;
2324 }
2325 dev_info(nbd_to_dev(nbd), "reconnected socket\n");
2326 }
2327 }
2328out:
2329 mutex_unlock(&nbd->config_lock);
2330 nbd_config_put(nbd);
c6a4759e 2331 nbd_put(nbd);
a2c97909
JB
2332 if (put_dev)
2333 nbd_put(nbd);
b7aa3d39
JB
2334 return ret;
2335}
2336
66a9b928 2337static const struct genl_small_ops nbd_connect_genl_ops[] = {
e46c7287
JB
2338 {
2339 .cmd = NBD_CMD_CONNECT,
ef6243ac 2340 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
e46c7287
JB
2341 .doit = nbd_genl_connect,
2342 },
2343 {
2344 .cmd = NBD_CMD_DISCONNECT,
ef6243ac 2345 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
e46c7287
JB
2346 .doit = nbd_genl_disconnect,
2347 },
b7aa3d39
JB
2348 {
2349 .cmd = NBD_CMD_RECONFIGURE,
ef6243ac 2350 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
b7aa3d39
JB
2351 .doit = nbd_genl_reconfigure,
2352 },
47d902b9
JB
2353 {
2354 .cmd = NBD_CMD_STATUS,
ef6243ac 2355 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
47d902b9
JB
2356 .doit = nbd_genl_status,
2357 },
e46c7287
JB
2358};
2359
799f9a38
JB
2360static const struct genl_multicast_group nbd_mcast_grps[] = {
2361 { .name = NBD_GENL_MCAST_GROUP_NAME, },
2362};
2363
e46c7287
JB
2364static struct genl_family nbd_genl_family __ro_after_init = {
2365 .hdrsize = 0,
2366 .name = NBD_GENL_FAMILY_NAME,
2367 .version = NBD_GENL_VERSION,
2368 .module = THIS_MODULE,
66a9b928
JK
2369 .small_ops = nbd_connect_genl_ops,
2370 .n_small_ops = ARRAY_SIZE(nbd_connect_genl_ops),
9c5d03d3 2371 .resv_start_op = NBD_CMD_STATUS + 1,
e46c7287 2372 .maxattr = NBD_ATTR_MAX,
9195b317 2373 .netnsok = 1,
3b0f31f2 2374 .policy = nbd_attr_policy,
799f9a38
JB
2375 .mcgrps = nbd_mcast_grps,
2376 .n_mcgrps = ARRAY_SIZE(nbd_mcast_grps),
e46c7287 2377};
ffe357c8 2378MODULE_ALIAS_GENL_FAMILY(NBD_GENL_FAMILY_NAME);
e46c7287 2379
47d902b9
JB
2380static int populate_nbd_status(struct nbd_device *nbd, struct sk_buff *reply)
2381{
2382 struct nlattr *dev_opt;
2383 u8 connected = 0;
2384 int ret;
2385
2386 /* This is a little racey, but for status it's ok. The
2387 * reason we don't take a ref here is because we can't
2388 * take a ref in the index == -1 case as we would need
2389 * to put under the nbd_index_mutex, which could
2390 * deadlock if we are configured to remove ourselves
2391 * once we're disconnected.
2392 */
2393 if (refcount_read(&nbd->config_refs))
2394 connected = 1;
ae0be8de 2395 dev_opt = nla_nest_start_noflag(reply, NBD_DEVICE_ITEM);
47d902b9
JB
2396 if (!dev_opt)
2397 return -EMSGSIZE;
2398 ret = nla_put_u32(reply, NBD_DEVICE_INDEX, nbd->index);
2399 if (ret)
2400 return -EMSGSIZE;
2401 ret = nla_put_u8(reply, NBD_DEVICE_CONNECTED,
2402 connected);
2403 if (ret)
2404 return -EMSGSIZE;
2405 nla_nest_end(reply, dev_opt);
2406 return 0;
2407}
2408
2409static int status_cb(int id, void *ptr, void *data)
2410{
2411 struct nbd_device *nbd = ptr;
2412 return populate_nbd_status(nbd, (struct sk_buff *)data);
2413}
2414
2415static int nbd_genl_status(struct sk_buff *skb, struct genl_info *info)
2416{
2417 struct nlattr *dev_list;
2418 struct sk_buff *reply;
2419 void *reply_head;
2420 size_t msg_size;
2421 int index = -1;
2422 int ret = -ENOMEM;
2423
2424 if (info->attrs[NBD_ATTR_INDEX])
2425 index = nla_get_u32(info->attrs[NBD_ATTR_INDEX]);
2426
2427 mutex_lock(&nbd_index_mutex);
2428
2429 msg_size = nla_total_size(nla_attr_size(sizeof(u32)) +
2430 nla_attr_size(sizeof(u8)));
2431 msg_size *= (index == -1) ? nbd_total_devices : 1;
2432
2433 reply = genlmsg_new(msg_size, GFP_KERNEL);
2434 if (!reply)
2435 goto out;
2436 reply_head = genlmsg_put_reply(reply, info, &nbd_genl_family, 0,
2437 NBD_CMD_STATUS);
2438 if (!reply_head) {
2439 nlmsg_free(reply);
2440 goto out;
2441 }
2442
ae0be8de 2443 dev_list = nla_nest_start_noflag(reply, NBD_ATTR_DEVICE_LIST);
47d902b9
JB
2444 if (index == -1) {
2445 ret = idr_for_each(&nbd_index_idr, &status_cb, reply);
2446 if (ret) {
2447 nlmsg_free(reply);
2448 goto out;
2449 }
2450 } else {
2451 struct nbd_device *nbd;
2452 nbd = idr_find(&nbd_index_idr, index);
2453 if (nbd) {
2454 ret = populate_nbd_status(nbd, reply);
2455 if (ret) {
2456 nlmsg_free(reply);
2457 goto out;
2458 }
2459 }
2460 }
2461 nla_nest_end(reply, dev_list);
2462 genlmsg_end(reply, reply_head);
cd46eb89 2463 ret = genlmsg_reply(reply, info);
47d902b9
JB
2464out:
2465 mutex_unlock(&nbd_index_mutex);
2466 return ret;
2467}
2468
e46c7287
JB
2469static void nbd_connect_reply(struct genl_info *info, int index)
2470{
2471 struct sk_buff *skb;
2472 void *msg_head;
2473 int ret;
2474
2475 skb = genlmsg_new(nla_total_size(sizeof(u32)), GFP_KERNEL);
2476 if (!skb)
2477 return;
2478 msg_head = genlmsg_put_reply(skb, info, &nbd_genl_family, 0,
2479 NBD_CMD_CONNECT);
2480 if (!msg_head) {
2481 nlmsg_free(skb);
2482 return;
2483 }
2484 ret = nla_put_u32(skb, NBD_ATTR_INDEX, index);
2485 if (ret) {
2486 nlmsg_free(skb);
2487 return;
2488 }
2489 genlmsg_end(skb, msg_head);
2490 genlmsg_reply(skb, info);
2491}
1da177e4 2492
799f9a38
JB
2493static void nbd_mcast_index(int index)
2494{
2495 struct sk_buff *skb;
2496 void *msg_head;
2497 int ret;
2498
2499 skb = genlmsg_new(nla_total_size(sizeof(u32)), GFP_KERNEL);
2500 if (!skb)
2501 return;
2502 msg_head = genlmsg_put(skb, 0, 0, &nbd_genl_family, 0,
2503 NBD_CMD_LINK_DEAD);
2504 if (!msg_head) {
2505 nlmsg_free(skb);
2506 return;
2507 }
2508 ret = nla_put_u32(skb, NBD_ATTR_INDEX, index);
2509 if (ret) {
2510 nlmsg_free(skb);
2511 return;
2512 }
2513 genlmsg_end(skb, msg_head);
2514 genlmsg_multicast(&nbd_genl_family, skb, 0, 0, GFP_KERNEL);
2515}
2516
2517static void nbd_dead_link_work(struct work_struct *work)
2518{
2519 struct link_dead_args *args = container_of(work, struct link_dead_args,
2520 work);
2521 nbd_mcast_index(args->index);
2522 kfree(args);
2523}
2524
1da177e4
LT
2525static int __init nbd_init(void)
2526{
1da177e4
LT
2527 int i;
2528
5b7b18cc 2529 BUILD_BUG_ON(sizeof(struct nbd_request) != 28);
1da177e4 2530
d71a6d73 2531 if (max_part < 0) {
1243172d 2532 pr_err("max_part must be >= 0\n");
d71a6d73
LV
2533 return -EINVAL;
2534 }
2535
2536 part_shift = 0;
5988ce23 2537 if (max_part > 0) {
d71a6d73
LV
2538 part_shift = fls(max_part);
2539
5988ce23
NK
2540 /*
2541 * Adjust max_part according to part_shift as it is exported
2542 * to user space so that user can know the max number of
2543 * partition kernel should be able to manage.
2544 *
2545 * Note that -1 is required because partition 0 is reserved
2546 * for the whole disk.
2547 */
2548 max_part = (1UL << part_shift) - 1;
2549 }
2550
3b271082
NK
2551 if ((1UL << part_shift) > DISK_MAX_PARTS)
2552 return -EINVAL;
2553
2554 if (nbds_max > 1UL << (MINORBITS - part_shift))
2555 return -EINVAL;
2556
e9e006f5 2557 if (register_blkdev(NBD_MAJOR, "nbd"))
b0d9111a 2558 return -EIO;
1da177e4 2559
68c9417b
HT
2560 nbd_del_wq = alloc_workqueue("nbd-del", WQ_UNBOUND, 0);
2561 if (!nbd_del_wq) {
2562 unregister_blkdev(NBD_MAJOR, "nbd");
2563 return -ENOMEM;
2564 }
2565
e46c7287 2566 if (genl_register_family(&nbd_genl_family)) {
68c9417b 2567 destroy_workqueue(nbd_del_wq);
e46c7287 2568 unregister_blkdev(NBD_MAJOR, "nbd");
e46c7287
JB
2569 return -EINVAL;
2570 }
30d53d9c
MP
2571 nbd_dbg_init();
2572
b0d9111a 2573 for (i = 0; i < nbds_max; i++)
6e4df4c6 2574 nbd_dev_add(i, 1);
b0d9111a
JB
2575 return 0;
2576}
1da177e4 2577
b0d9111a
JB
2578static int nbd_exit_cb(int id, void *ptr, void *data)
2579{
c6a4759e 2580 struct list_head *list = (struct list_head *)data;
b0d9111a 2581 struct nbd_device *nbd = ptr;
c6a4759e 2582
68c9417b
HT
2583 /* Skip nbd that is being removed asynchronously */
2584 if (refcount_read(&nbd->refs))
2585 list_add_tail(&nbd->list, list);
2586
1da177e4 2587 return 0;
1da177e4
LT
2588}
2589
2590static void __exit nbd_cleanup(void)
2591{
c6a4759e
JB
2592 struct nbd_device *nbd;
2593 LIST_HEAD(del_list);
2594
06c4da89
YK
2595 /*
2596 * Unregister netlink interface prior to waiting
2597 * for the completion of netlink commands.
2598 */
2599 genl_unregister_family(&nbd_genl_family);
2600
30d53d9c
MP
2601 nbd_dbg_close();
2602
c6a4759e
JB
2603 mutex_lock(&nbd_index_mutex);
2604 idr_for_each(&nbd_index_idr, &nbd_exit_cb, &del_list);
2605 mutex_unlock(&nbd_index_mutex);
2606
60ae36ad
JB
2607 while (!list_empty(&del_list)) {
2608 nbd = list_first_entry(&del_list, struct nbd_device, list);
2609 list_del_init(&nbd->list);
c55b2b98 2610 if (refcount_read(&nbd->config_refs))
1243172d 2611 pr_err("possibly leaking nbd_config (ref %d)\n",
c55b2b98 2612 refcount_read(&nbd->config_refs));
60ae36ad 2613 if (refcount_read(&nbd->refs) != 1)
1243172d 2614 pr_err("possibly leaking a device\n");
c6a4759e 2615 nbd_put(nbd);
c6a4759e
JB
2616 }
2617
68c9417b
HT
2618 /* Also wait for nbd_dev_remove_work() completes */
2619 destroy_workqueue(nbd_del_wq);
2620
b0d9111a 2621 idr_destroy(&nbd_index_idr);
1da177e4 2622 unregister_blkdev(NBD_MAJOR, "nbd");
1da177e4
LT
2623}
2624
2625module_init(nbd_init);
2626module_exit(nbd_cleanup);
2627
2628MODULE_DESCRIPTION("Network Block Device");
2629MODULE_LICENSE("GPL");
2630
40be0c28 2631module_param(nbds_max, int, 0444);
d71a6d73
LV
2632MODULE_PARM_DESC(nbds_max, "number of network block devices to initialize (default: 16)");
2633module_param(max_part, int, 0444);
7a8362a0 2634MODULE_PARM_DESC(max_part, "number of partitions per device (default: 16)");