blob: d51c24ac529f86c391d9f0ce4aff5a56c327cd67 [file] [log] [blame]
Jens Axboef2298c02013-10-25 11:52:25 +01001#include <linux/module.h>
Matias Bjørlingfc1bc352013-12-21 00:11:01 +01002
Jens Axboef2298c02013-10-25 11:52:25 +01003#include <linux/moduleparam.h>
4#include <linux/sched.h>
5#include <linux/fs.h>
6#include <linux/blkdev.h>
7#include <linux/init.h>
8#include <linux/slab.h>
9#include <linux/blk-mq.h>
10#include <linux/hrtimer.h>
Matias Bjørlingb2b7e002015-11-12 20:25:10 +010011#include <linux/lightnvm.h>
Jens Axboef2298c02013-10-25 11:52:25 +010012
13struct nullb_cmd {
14 struct list_head list;
15 struct llist_node ll_list;
16 struct call_single_data csd;
17 struct request *rq;
18 struct bio *bio;
19 unsigned int tag;
20 struct nullb_queue *nq;
21};
22
23struct nullb_queue {
24 unsigned long *tag_map;
25 wait_queue_head_t wait;
26 unsigned int queue_depth;
27
28 struct nullb_cmd *cmds;
29};
30
31struct nullb {
32 struct list_head list;
33 unsigned int index;
34 struct request_queue *q;
35 struct gendisk *disk;
Christoph Hellwig24d2f902014-04-15 14:14:00 -060036 struct blk_mq_tag_set tag_set;
Jens Axboef2298c02013-10-25 11:52:25 +010037 struct hrtimer timer;
38 unsigned int queue_depth;
39 spinlock_t lock;
40
41 struct nullb_queue *queues;
42 unsigned int nr_queues;
Matias Bjørlingb2b7e002015-11-12 20:25:10 +010043 char disk_name[DISK_NAME_LEN];
Jens Axboef2298c02013-10-25 11:52:25 +010044};
45
46static LIST_HEAD(nullb_list);
47static struct mutex lock;
48static int null_major;
49static int nullb_indexes;
Matias Bjørling6bb95352015-11-19 12:50:08 +010050static struct kmem_cache *ppa_cache;
Jens Axboef2298c02013-10-25 11:52:25 +010051
52struct completion_queue {
53 struct llist_head list;
54 struct hrtimer timer;
55};
56
57/*
58 * These are per-cpu for now, they will need to be configured by the
59 * complete_queues parameter and appropriately mapped.
60 */
61static DEFINE_PER_CPU(struct completion_queue, completion_queues);
62
63enum {
64 NULL_IRQ_NONE = 0,
65 NULL_IRQ_SOFTIRQ = 1,
66 NULL_IRQ_TIMER = 2,
Christoph Hellwigce2c3502014-02-10 03:24:40 -080067};
Jens Axboef2298c02013-10-25 11:52:25 +010068
Christoph Hellwigce2c3502014-02-10 03:24:40 -080069enum {
Jens Axboef2298c02013-10-25 11:52:25 +010070 NULL_Q_BIO = 0,
71 NULL_Q_RQ = 1,
72 NULL_Q_MQ = 2,
73};
74
Matias Bjorling2d263a782013-12-18 13:41:43 +010075static int submit_queues;
Jens Axboef2298c02013-10-25 11:52:25 +010076module_param(submit_queues, int, S_IRUGO);
77MODULE_PARM_DESC(submit_queues, "Number of submission queues");
78
79static int home_node = NUMA_NO_NODE;
80module_param(home_node, int, S_IRUGO);
81MODULE_PARM_DESC(home_node, "Home node for the device");
82
83static int queue_mode = NULL_Q_MQ;
Matias Bjorling709c8662014-11-26 14:45:48 -070084
85static int null_param_store_val(const char *str, int *val, int min, int max)
86{
87 int ret, new_val;
88
89 ret = kstrtoint(str, 10, &new_val);
90 if (ret)
91 return -EINVAL;
92
93 if (new_val < min || new_val > max)
94 return -EINVAL;
95
96 *val = new_val;
97 return 0;
98}
99
100static int null_set_queue_mode(const char *str, const struct kernel_param *kp)
101{
102 return null_param_store_val(str, &queue_mode, NULL_Q_BIO, NULL_Q_MQ);
103}
104
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930105static const struct kernel_param_ops null_queue_mode_param_ops = {
Matias Bjorling709c8662014-11-26 14:45:48 -0700106 .set = null_set_queue_mode,
107 .get = param_get_int,
108};
109
110device_param_cb(queue_mode, &null_queue_mode_param_ops, &queue_mode, S_IRUGO);
Mike Snitzer54ae81c2014-06-11 17:13:50 -0400111MODULE_PARM_DESC(queue_mode, "Block interface to use (0=bio,1=rq,2=multiqueue)");
Jens Axboef2298c02013-10-25 11:52:25 +0100112
113static int gb = 250;
114module_param(gb, int, S_IRUGO);
115MODULE_PARM_DESC(gb, "Size in GB");
116
117static int bs = 512;
118module_param(bs, int, S_IRUGO);
119MODULE_PARM_DESC(bs, "Block size (in bytes)");
120
121static int nr_devices = 2;
122module_param(nr_devices, int, S_IRUGO);
123MODULE_PARM_DESC(nr_devices, "Number of devices to register");
124
Matias Bjørlingb2b7e002015-11-12 20:25:10 +0100125static bool use_lightnvm;
126module_param(use_lightnvm, bool, S_IRUGO);
127MODULE_PARM_DESC(use_lightnvm, "Register as a LightNVM device");
128
Jens Axboef2298c02013-10-25 11:52:25 +0100129static int irqmode = NULL_IRQ_SOFTIRQ;
Matias Bjorling709c8662014-11-26 14:45:48 -0700130
131static int null_set_irqmode(const char *str, const struct kernel_param *kp)
132{
133 return null_param_store_val(str, &irqmode, NULL_IRQ_NONE,
134 NULL_IRQ_TIMER);
135}
136
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930137static const struct kernel_param_ops null_irqmode_param_ops = {
Matias Bjorling709c8662014-11-26 14:45:48 -0700138 .set = null_set_irqmode,
139 .get = param_get_int,
140};
141
142device_param_cb(irqmode, &null_irqmode_param_ops, &irqmode, S_IRUGO);
Jens Axboef2298c02013-10-25 11:52:25 +0100143MODULE_PARM_DESC(irqmode, "IRQ completion handler. 0-none, 1-softirq, 2-timer");
144
145static int completion_nsec = 10000;
146module_param(completion_nsec, int, S_IRUGO);
147MODULE_PARM_DESC(completion_nsec, "Time in ns to complete a request in hardware. Default: 10,000ns");
148
149static int hw_queue_depth = 64;
150module_param(hw_queue_depth, int, S_IRUGO);
151MODULE_PARM_DESC(hw_queue_depth, "Queue depth for each hardware queue. Default: 64");
152
Matias Bjørling20005242013-12-21 00:11:00 +0100153static bool use_per_node_hctx = false;
Jens Axboef2298c02013-10-25 11:52:25 +0100154module_param(use_per_node_hctx, bool, S_IRUGO);
Matias Bjørling20005242013-12-21 00:11:00 +0100155MODULE_PARM_DESC(use_per_node_hctx, "Use per-node allocation for hardware context queues. Default: false");
Jens Axboef2298c02013-10-25 11:52:25 +0100156
157static void put_tag(struct nullb_queue *nq, unsigned int tag)
158{
159 clear_bit_unlock(tag, nq->tag_map);
160
161 if (waitqueue_active(&nq->wait))
162 wake_up(&nq->wait);
163}
164
165static unsigned int get_tag(struct nullb_queue *nq)
166{
167 unsigned int tag;
168
169 do {
170 tag = find_first_zero_bit(nq->tag_map, nq->queue_depth);
171 if (tag >= nq->queue_depth)
172 return -1U;
173 } while (test_and_set_bit_lock(tag, nq->tag_map));
174
175 return tag;
176}
177
178static void free_cmd(struct nullb_cmd *cmd)
179{
180 put_tag(cmd->nq, cmd->tag);
181}
182
183static struct nullb_cmd *__alloc_cmd(struct nullb_queue *nq)
184{
185 struct nullb_cmd *cmd;
186 unsigned int tag;
187
188 tag = get_tag(nq);
189 if (tag != -1U) {
190 cmd = &nq->cmds[tag];
191 cmd->tag = tag;
192 cmd->nq = nq;
193 return cmd;
194 }
195
196 return NULL;
197}
198
199static struct nullb_cmd *alloc_cmd(struct nullb_queue *nq, int can_wait)
200{
201 struct nullb_cmd *cmd;
202 DEFINE_WAIT(wait);
203
204 cmd = __alloc_cmd(nq);
205 if (cmd || !can_wait)
206 return cmd;
207
208 do {
209 prepare_to_wait(&nq->wait, &wait, TASK_UNINTERRUPTIBLE);
210 cmd = __alloc_cmd(nq);
211 if (cmd)
212 break;
213
214 io_schedule();
215 } while (1);
216
217 finish_wait(&nq->wait, &wait);
218 return cmd;
219}
220
221static void end_cmd(struct nullb_cmd *cmd)
222{
Christoph Hellwigce2c3502014-02-10 03:24:40 -0800223 switch (queue_mode) {
224 case NULL_Q_MQ:
Christoph Hellwigc8a446a2014-09-13 16:40:10 -0700225 blk_mq_end_request(cmd->rq, 0);
Christoph Hellwigce2c3502014-02-10 03:24:40 -0800226 return;
227 case NULL_Q_RQ:
228 INIT_LIST_HEAD(&cmd->rq->queuelist);
229 blk_end_request_all(cmd->rq, 0);
230 break;
231 case NULL_Q_BIO:
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200232 bio_endio(cmd->bio);
Christoph Hellwigce2c3502014-02-10 03:24:40 -0800233 break;
234 }
Jens Axboef2298c02013-10-25 11:52:25 +0100235
Christoph Hellwigce2c3502014-02-10 03:24:40 -0800236 free_cmd(cmd);
Jens Axboef2298c02013-10-25 11:52:25 +0100237}
238
239static enum hrtimer_restart null_cmd_timer_expired(struct hrtimer *timer)
240{
241 struct completion_queue *cq;
242 struct llist_node *entry;
243 struct nullb_cmd *cmd;
244
245 cq = &per_cpu(completion_queues, smp_processor_id());
246
247 while ((entry = llist_del_all(&cq->list)) != NULL) {
Shlomo Pongratzd7790b92014-02-06 18:33:17 +0200248 entry = llist_reverse_order(entry);
Jens Axboef2298c02013-10-25 11:52:25 +0100249 do {
Mike Krinkin21974062015-07-19 09:53:17 +0300250 struct request_queue *q = NULL;
251
Jens Axboef2298c02013-10-25 11:52:25 +0100252 cmd = container_of(entry, struct nullb_cmd, ll_list);
Jens Axboef2298c02013-10-25 11:52:25 +0100253 entry = entry->next;
Mike Krinkin21974062015-07-19 09:53:17 +0300254 if (cmd->rq)
255 q = cmd->rq->q;
Ming Leifc276912014-05-01 15:12:36 +0800256 end_cmd(cmd);
Akinobu Mita8b70f452015-06-02 08:35:10 +0900257
Mike Krinkin21974062015-07-19 09:53:17 +0300258 if (q && !q->mq_ops && blk_queue_stopped(q)) {
259 spin_lock(q->queue_lock);
260 if (blk_queue_stopped(q))
261 blk_start_queue(q);
262 spin_unlock(q->queue_lock);
Akinobu Mita8b70f452015-06-02 08:35:10 +0900263 }
Jens Axboef2298c02013-10-25 11:52:25 +0100264 } while (entry);
265 }
266
267 return HRTIMER_NORESTART;
268}
269
270static void null_cmd_end_timer(struct nullb_cmd *cmd)
271{
272 struct completion_queue *cq = &per_cpu(completion_queues, get_cpu());
273
274 cmd->ll_list.next = NULL;
275 if (llist_add(&cmd->ll_list, &cq->list)) {
276 ktime_t kt = ktime_set(0, completion_nsec);
277
Akinobu Mita419c21a2015-06-02 08:35:09 +0900278 hrtimer_start(&cq->timer, kt, HRTIMER_MODE_REL_PINNED);
Jens Axboef2298c02013-10-25 11:52:25 +0100279 }
280
281 put_cpu();
282}
283
284static void null_softirq_done_fn(struct request *rq)
285{
Jens Axboed891fa72014-06-16 11:40:25 -0600286 if (queue_mode == NULL_Q_MQ)
287 end_cmd(blk_mq_rq_to_pdu(rq));
288 else
289 end_cmd(rq->special);
Jens Axboef2298c02013-10-25 11:52:25 +0100290}
291
Jens Axboef2298c02013-10-25 11:52:25 +0100292static inline void null_handle_cmd(struct nullb_cmd *cmd)
293{
294 /* Complete IO by inline, softirq or timer */
295 switch (irqmode) {
Christoph Hellwigce2c3502014-02-10 03:24:40 -0800296 case NULL_IRQ_SOFTIRQ:
297 switch (queue_mode) {
298 case NULL_Q_MQ:
Christoph Hellwigf4829a92015-09-27 21:01:50 +0200299 blk_mq_complete_request(cmd->rq, cmd->rq->errors);
Christoph Hellwigce2c3502014-02-10 03:24:40 -0800300 break;
301 case NULL_Q_RQ:
302 blk_complete_request(cmd->rq);
303 break;
304 case NULL_Q_BIO:
305 /*
306 * XXX: no proper submitting cpu information available.
307 */
308 end_cmd(cmd);
309 break;
310 }
311 break;
Jens Axboef2298c02013-10-25 11:52:25 +0100312 case NULL_IRQ_NONE:
313 end_cmd(cmd);
314 break;
Jens Axboef2298c02013-10-25 11:52:25 +0100315 case NULL_IRQ_TIMER:
316 null_cmd_end_timer(cmd);
317 break;
318 }
319}
320
321static struct nullb_queue *nullb_to_queue(struct nullb *nullb)
322{
323 int index = 0;
324
325 if (nullb->nr_queues != 1)
326 index = raw_smp_processor_id() / ((nr_cpu_ids + nullb->nr_queues - 1) / nullb->nr_queues);
327
328 return &nullb->queues[index];
329}
330
Jens Axboedece1632015-11-05 10:41:16 -0700331static blk_qc_t null_queue_bio(struct request_queue *q, struct bio *bio)
Jens Axboef2298c02013-10-25 11:52:25 +0100332{
333 struct nullb *nullb = q->queuedata;
334 struct nullb_queue *nq = nullb_to_queue(nullb);
335 struct nullb_cmd *cmd;
336
337 cmd = alloc_cmd(nq, 1);
338 cmd->bio = bio;
339
340 null_handle_cmd(cmd);
Jens Axboedece1632015-11-05 10:41:16 -0700341 return BLK_QC_T_NONE;
Jens Axboef2298c02013-10-25 11:52:25 +0100342}
343
344static int null_rq_prep_fn(struct request_queue *q, struct request *req)
345{
346 struct nullb *nullb = q->queuedata;
347 struct nullb_queue *nq = nullb_to_queue(nullb);
348 struct nullb_cmd *cmd;
349
350 cmd = alloc_cmd(nq, 0);
351 if (cmd) {
352 cmd->rq = req;
353 req->special = cmd;
354 return BLKPREP_OK;
355 }
Akinobu Mita8b70f452015-06-02 08:35:10 +0900356 blk_stop_queue(q);
Jens Axboef2298c02013-10-25 11:52:25 +0100357
358 return BLKPREP_DEFER;
359}
360
361static void null_request_fn(struct request_queue *q)
362{
363 struct request *rq;
364
365 while ((rq = blk_fetch_request(q)) != NULL) {
366 struct nullb_cmd *cmd = rq->special;
367
368 spin_unlock_irq(q->queue_lock);
369 null_handle_cmd(cmd);
370 spin_lock_irq(q->queue_lock);
371 }
372}
373
Jens Axboe74c45052014-10-29 11:14:52 -0600374static int null_queue_rq(struct blk_mq_hw_ctx *hctx,
375 const struct blk_mq_queue_data *bd)
Jens Axboef2298c02013-10-25 11:52:25 +0100376{
Jens Axboe74c45052014-10-29 11:14:52 -0600377 struct nullb_cmd *cmd = blk_mq_rq_to_pdu(bd->rq);
Jens Axboef2298c02013-10-25 11:52:25 +0100378
Jens Axboe74c45052014-10-29 11:14:52 -0600379 cmd->rq = bd->rq;
Jens Axboef2298c02013-10-25 11:52:25 +0100380 cmd->nq = hctx->driver_data;
381
Jens Axboe74c45052014-10-29 11:14:52 -0600382 blk_mq_start_request(bd->rq);
Christoph Hellwige2490072014-09-13 16:40:09 -0700383
Jens Axboef2298c02013-10-25 11:52:25 +0100384 null_handle_cmd(cmd);
385 return BLK_MQ_RQ_QUEUE_OK;
386}
387
Matias Bjorling2d263a782013-12-18 13:41:43 +0100388static void null_init_queue(struct nullb *nullb, struct nullb_queue *nq)
389{
390 BUG_ON(!nullb);
391 BUG_ON(!nq);
392
393 init_waitqueue_head(&nq->wait);
394 nq->queue_depth = nullb->queue_depth;
395}
396
Jens Axboef2298c02013-10-25 11:52:25 +0100397static int null_init_hctx(struct blk_mq_hw_ctx *hctx, void *data,
398 unsigned int index)
399{
400 struct nullb *nullb = data;
401 struct nullb_queue *nq = &nullb->queues[index];
402
Jens Axboef2298c02013-10-25 11:52:25 +0100403 hctx->driver_data = nq;
Matias Bjorling2d263a782013-12-18 13:41:43 +0100404 null_init_queue(nullb, nq);
405 nullb->nr_queues++;
Jens Axboef2298c02013-10-25 11:52:25 +0100406
407 return 0;
408}
409
410static struct blk_mq_ops null_mq_ops = {
411 .queue_rq = null_queue_rq,
412 .map_queue = blk_mq_map_queue,
413 .init_hctx = null_init_hctx,
Christoph Hellwigce2c3502014-02-10 03:24:40 -0800414 .complete = null_softirq_done_fn,
Jens Axboef2298c02013-10-25 11:52:25 +0100415};
416
Matias Bjørlingde65d2d2015-08-31 14:17:18 +0200417static void cleanup_queue(struct nullb_queue *nq)
418{
419 kfree(nq->tag_map);
420 kfree(nq->cmds);
421}
422
423static void cleanup_queues(struct nullb *nullb)
424{
425 int i;
426
427 for (i = 0; i < nullb->nr_queues; i++)
428 cleanup_queue(&nullb->queues[i]);
429
430 kfree(nullb->queues);
431}
432
Jens Axboef2298c02013-10-25 11:52:25 +0100433static void null_del_dev(struct nullb *nullb)
434{
435 list_del_init(&nullb->list);
436
Matias Bjørlingb2b7e002015-11-12 20:25:10 +0100437 if (use_lightnvm)
438 nvm_unregister(nullb->disk->disk_name);
Jens Axboef2298c02013-10-25 11:52:25 +0100439 del_gendisk(nullb->disk);
Ming Lei518d00b2013-12-26 21:31:37 +0800440 blk_cleanup_queue(nullb->q);
Christoph Hellwig24d2f902014-04-15 14:14:00 -0600441 if (queue_mode == NULL_Q_MQ)
442 blk_mq_free_tag_set(&nullb->tag_set);
Jens Axboef2298c02013-10-25 11:52:25 +0100443 put_disk(nullb->disk);
Matias Bjørlingde65d2d2015-08-31 14:17:18 +0200444 cleanup_queues(nullb);
Jens Axboef2298c02013-10-25 11:52:25 +0100445 kfree(nullb);
446}
447
Matias Bjørlingb2b7e002015-11-12 20:25:10 +0100448#ifdef CONFIG_NVM
449
450static void null_lnvm_end_io(struct request *rq, int error)
451{
452 struct nvm_rq *rqd = rq->end_io_data;
453 struct nvm_dev *dev = rqd->dev;
454
455 dev->mt->end_io(rqd, error);
456
457 blk_put_request(rq);
458}
459
460static int null_lnvm_submit_io(struct request_queue *q, struct nvm_rq *rqd)
461{
462 struct request *rq;
463 struct bio *bio = rqd->bio;
464
465 rq = blk_mq_alloc_request(q, bio_rw(bio), GFP_KERNEL, 0);
466 if (IS_ERR(rq))
467 return -ENOMEM;
468
469 rq->cmd_type = REQ_TYPE_DRV_PRIV;
470 rq->__sector = bio->bi_iter.bi_sector;
471 rq->ioprio = bio_prio(bio);
472
473 if (bio_has_data(bio))
474 rq->nr_phys_segments = bio_phys_segments(q, bio);
475
476 rq->__data_len = bio->bi_iter.bi_size;
477 rq->bio = rq->biotail = bio;
478
479 rq->end_io_data = rqd;
480
481 blk_execute_rq_nowait(q, NULL, rq, 0, null_lnvm_end_io);
482
483 return 0;
484}
485
486static int null_lnvm_id(struct request_queue *q, struct nvm_id *id)
487{
488 sector_t size = gb * 1024 * 1024 * 1024ULL;
Matias Bjørling5b40db92015-11-19 12:50:09 +0100489 sector_t blksize;
Matias Bjørlingb2b7e002015-11-12 20:25:10 +0100490 struct nvm_id_group *grp;
491
492 id->ver_id = 0x1;
493 id->vmnt = 0;
494 id->cgrps = 1;
495 id->cap = 0x3;
496 id->dom = 0x1;
Matias Bjørling5b40db92015-11-19 12:50:09 +0100497
498 id->ppaf.blk_offset = 0;
499 id->ppaf.blk_len = 16;
500 id->ppaf.pg_offset = 16;
501 id->ppaf.pg_len = 16;
502 id->ppaf.sect_offset = 32;
503 id->ppaf.sect_len = 8;
504 id->ppaf.pln_offset = 40;
505 id->ppaf.pln_len = 8;
506 id->ppaf.lun_offset = 48;
507 id->ppaf.lun_len = 8;
508 id->ppaf.ch_offset = 56;
509 id->ppaf.ch_len = 8;
Matias Bjørlingb2b7e002015-11-12 20:25:10 +0100510
511 do_div(size, bs); /* convert size to pages */
Matias Bjørling5b40db92015-11-19 12:50:09 +0100512 do_div(size, 256); /* concert size to pgs pr blk */
Matias Bjørlingb2b7e002015-11-12 20:25:10 +0100513 grp = &id->groups[0];
514 grp->mtype = 0;
Matias Bjørling5b40db92015-11-19 12:50:09 +0100515 grp->fmtype = 0;
Matias Bjørlingb2b7e002015-11-12 20:25:10 +0100516 grp->num_ch = 1;
Matias Bjørlingb2b7e002015-11-12 20:25:10 +0100517 grp->num_pg = 256;
Matias Bjørling5b40db92015-11-19 12:50:09 +0100518 blksize = size;
519 do_div(size, (1 << 16));
520 grp->num_lun = size + 1;
521 do_div(blksize, grp->num_lun);
522 grp->num_blk = blksize;
523 grp->num_pln = 1;
524
Matias Bjørlingb2b7e002015-11-12 20:25:10 +0100525 grp->fpg_sz = bs;
526 grp->csecs = bs;
527 grp->trdt = 25000;
528 grp->trdm = 25000;
529 grp->tprt = 500000;
530 grp->tprm = 500000;
531 grp->tbet = 1500000;
532 grp->tbem = 1500000;
533 grp->mpos = 0x010101; /* single plane rwe */
534 grp->cpar = hw_queue_depth;
535
536 return 0;
537}
538
539static void *null_lnvm_create_dma_pool(struct request_queue *q, char *name)
540{
541 mempool_t *virtmem_pool;
542
Matias Bjørling6bb95352015-11-19 12:50:08 +0100543 virtmem_pool = mempool_create_slab_pool(64, ppa_cache);
Matias Bjørlingb2b7e002015-11-12 20:25:10 +0100544 if (!virtmem_pool) {
545 pr_err("null_blk: Unable to create virtual memory pool\n");
546 return NULL;
547 }
548
549 return virtmem_pool;
550}
551
552static void null_lnvm_destroy_dma_pool(void *pool)
553{
554 mempool_destroy(pool);
555}
556
557static void *null_lnvm_dev_dma_alloc(struct request_queue *q, void *pool,
558 gfp_t mem_flags, dma_addr_t *dma_handler)
559{
560 return mempool_alloc(pool, mem_flags);
561}
562
563static void null_lnvm_dev_dma_free(void *pool, void *entry,
564 dma_addr_t dma_handler)
565{
566 mempool_free(entry, pool);
567}
568
569static struct nvm_dev_ops null_lnvm_dev_ops = {
570 .identity = null_lnvm_id,
571 .submit_io = null_lnvm_submit_io,
572
573 .create_dma_pool = null_lnvm_create_dma_pool,
574 .destroy_dma_pool = null_lnvm_destroy_dma_pool,
575 .dev_dma_alloc = null_lnvm_dev_dma_alloc,
576 .dev_dma_free = null_lnvm_dev_dma_free,
577
578 /* Simulate nvme protocol restriction */
579 .max_phys_sect = 64,
580};
581#else
582static struct nvm_dev_ops null_lnvm_dev_ops;
583#endif /* CONFIG_NVM */
584
Jens Axboef2298c02013-10-25 11:52:25 +0100585static int null_open(struct block_device *bdev, fmode_t mode)
586{
587 return 0;
588}
589
590static void null_release(struct gendisk *disk, fmode_t mode)
591{
592}
593
594static const struct block_device_operations null_fops = {
595 .owner = THIS_MODULE,
596 .open = null_open,
597 .release = null_release,
598};
599
600static int setup_commands(struct nullb_queue *nq)
601{
602 struct nullb_cmd *cmd;
603 int i, tag_size;
604
605 nq->cmds = kzalloc(nq->queue_depth * sizeof(*cmd), GFP_KERNEL);
606 if (!nq->cmds)
Matias Bjorling2d263a782013-12-18 13:41:43 +0100607 return -ENOMEM;
Jens Axboef2298c02013-10-25 11:52:25 +0100608
609 tag_size = ALIGN(nq->queue_depth, BITS_PER_LONG) / BITS_PER_LONG;
610 nq->tag_map = kzalloc(tag_size * sizeof(unsigned long), GFP_KERNEL);
611 if (!nq->tag_map) {
612 kfree(nq->cmds);
Matias Bjorling2d263a782013-12-18 13:41:43 +0100613 return -ENOMEM;
Jens Axboef2298c02013-10-25 11:52:25 +0100614 }
615
616 for (i = 0; i < nq->queue_depth; i++) {
617 cmd = &nq->cmds[i];
618 INIT_LIST_HEAD(&cmd->list);
619 cmd->ll_list.next = NULL;
620 cmd->tag = -1U;
621 }
622
623 return 0;
624}
625
Jens Axboef2298c02013-10-25 11:52:25 +0100626static int setup_queues(struct nullb *nullb)
627{
Matias Bjorling2d263a782013-12-18 13:41:43 +0100628 nullb->queues = kzalloc(submit_queues * sizeof(struct nullb_queue),
629 GFP_KERNEL);
Jens Axboef2298c02013-10-25 11:52:25 +0100630 if (!nullb->queues)
Matias Bjorling2d263a782013-12-18 13:41:43 +0100631 return -ENOMEM;
Jens Axboef2298c02013-10-25 11:52:25 +0100632
633 nullb->nr_queues = 0;
634 nullb->queue_depth = hw_queue_depth;
635
Matias Bjorling2d263a782013-12-18 13:41:43 +0100636 return 0;
637}
638
639static int init_driver_queues(struct nullb *nullb)
640{
641 struct nullb_queue *nq;
642 int i, ret = 0;
Jens Axboef2298c02013-10-25 11:52:25 +0100643
644 for (i = 0; i < submit_queues; i++) {
645 nq = &nullb->queues[i];
Matias Bjorling2d263a782013-12-18 13:41:43 +0100646
647 null_init_queue(nullb, nq);
648
649 ret = setup_commands(nq);
650 if (ret)
Jan Kara31f96902014-10-22 15:34:21 +0200651 return ret;
Jens Axboef2298c02013-10-25 11:52:25 +0100652 nullb->nr_queues++;
653 }
Matias Bjorling2d263a782013-12-18 13:41:43 +0100654 return 0;
Jens Axboef2298c02013-10-25 11:52:25 +0100655}
656
657static int null_add_dev(void)
658{
659 struct gendisk *disk;
660 struct nullb *nullb;
661 sector_t size;
Robert Elliottdc501dc2014-09-02 11:38:49 -0500662 int rv;
Jens Axboef2298c02013-10-25 11:52:25 +0100663
664 nullb = kzalloc_node(sizeof(*nullb), GFP_KERNEL, home_node);
Robert Elliottdc501dc2014-09-02 11:38:49 -0500665 if (!nullb) {
666 rv = -ENOMEM;
Christoph Hellwig24d2f902014-04-15 14:14:00 -0600667 goto out;
Robert Elliottdc501dc2014-09-02 11:38:49 -0500668 }
Jens Axboef2298c02013-10-25 11:52:25 +0100669
670 spin_lock_init(&nullb->lock);
671
Matias Bjorling57053d82013-12-10 16:50:38 +0100672 if (queue_mode == NULL_Q_MQ && use_per_node_hctx)
673 submit_queues = nr_online_nodes;
674
Robert Elliottdc501dc2014-09-02 11:38:49 -0500675 rv = setup_queues(nullb);
676 if (rv)
Christoph Hellwig24d2f902014-04-15 14:14:00 -0600677 goto out_free_nullb;
Jens Axboef2298c02013-10-25 11:52:25 +0100678
679 if (queue_mode == NULL_Q_MQ) {
Christoph Hellwigcdef54d2014-05-28 18:11:06 +0200680 nullb->tag_set.ops = &null_mq_ops;
Christoph Hellwig24d2f902014-04-15 14:14:00 -0600681 nullb->tag_set.nr_hw_queues = submit_queues;
682 nullb->tag_set.queue_depth = hw_queue_depth;
683 nullb->tag_set.numa_node = home_node;
684 nullb->tag_set.cmd_size = sizeof(struct nullb_cmd);
685 nullb->tag_set.flags = BLK_MQ_F_SHOULD_MERGE;
686 nullb->tag_set.driver_data = nullb;
Jens Axboef2298c02013-10-25 11:52:25 +0100687
Robert Elliottdc501dc2014-09-02 11:38:49 -0500688 rv = blk_mq_alloc_tag_set(&nullb->tag_set);
689 if (rv)
Christoph Hellwig24d2f902014-04-15 14:14:00 -0600690 goto out_cleanup_queues;
Jens Axboef2298c02013-10-25 11:52:25 +0100691
Christoph Hellwig24d2f902014-04-15 14:14:00 -0600692 nullb->q = blk_mq_init_queue(&nullb->tag_set);
Ming Lei35b489d2015-01-02 14:25:27 +0000693 if (IS_ERR(nullb->q)) {
Robert Elliottdc501dc2014-09-02 11:38:49 -0500694 rv = -ENOMEM;
Christoph Hellwig24d2f902014-04-15 14:14:00 -0600695 goto out_cleanup_tags;
Robert Elliottdc501dc2014-09-02 11:38:49 -0500696 }
Jens Axboef2298c02013-10-25 11:52:25 +0100697 } else if (queue_mode == NULL_Q_BIO) {
698 nullb->q = blk_alloc_queue_node(GFP_KERNEL, home_node);
Robert Elliottdc501dc2014-09-02 11:38:49 -0500699 if (!nullb->q) {
700 rv = -ENOMEM;
Christoph Hellwig24d2f902014-04-15 14:14:00 -0600701 goto out_cleanup_queues;
Robert Elliottdc501dc2014-09-02 11:38:49 -0500702 }
Jens Axboef2298c02013-10-25 11:52:25 +0100703 blk_queue_make_request(nullb->q, null_queue_bio);
Jan Kara31f96902014-10-22 15:34:21 +0200704 rv = init_driver_queues(nullb);
705 if (rv)
706 goto out_cleanup_blk_queue;
Jens Axboef2298c02013-10-25 11:52:25 +0100707 } else {
708 nullb->q = blk_init_queue_node(null_request_fn, &nullb->lock, home_node);
Robert Elliottdc501dc2014-09-02 11:38:49 -0500709 if (!nullb->q) {
710 rv = -ENOMEM;
Christoph Hellwig24d2f902014-04-15 14:14:00 -0600711 goto out_cleanup_queues;
Robert Elliottdc501dc2014-09-02 11:38:49 -0500712 }
Jens Axboef2298c02013-10-25 11:52:25 +0100713 blk_queue_prep_rq(nullb->q, null_rq_prep_fn);
Christoph Hellwig24d2f902014-04-15 14:14:00 -0600714 blk_queue_softirq_done(nullb->q, null_softirq_done_fn);
Jan Kara31f96902014-10-22 15:34:21 +0200715 rv = init_driver_queues(nullb);
716 if (rv)
717 goto out_cleanup_blk_queue;
Jens Axboef2298c02013-10-25 11:52:25 +0100718 }
719
Jens Axboef2298c02013-10-25 11:52:25 +0100720 nullb->q->queuedata = nullb;
721 queue_flag_set_unlocked(QUEUE_FLAG_NONROT, nullb->q);
Mike Snitzerb277da02014-10-04 10:55:32 -0600722 queue_flag_clear_unlocked(QUEUE_FLAG_ADD_RANDOM, nullb->q);
Jens Axboef2298c02013-10-25 11:52:25 +0100723
Jens Axboef2298c02013-10-25 11:52:25 +0100724
725 mutex_lock(&lock);
726 list_add_tail(&nullb->list, &nullb_list);
727 nullb->index = nullb_indexes++;
728 mutex_unlock(&lock);
729
730 blk_queue_logical_block_size(nullb->q, bs);
731 blk_queue_physical_block_size(nullb->q, bs);
732
Matias Bjørlingb2b7e002015-11-12 20:25:10 +0100733 sprintf(nullb->disk_name, "nullb%d", nullb->index);
734
735 if (use_lightnvm) {
736 rv = nvm_register(nullb->q, nullb->disk_name,
737 &null_lnvm_dev_ops);
738 if (rv)
739 goto out_cleanup_blk_queue;
740 goto done;
741 }
742
743 disk = nullb->disk = alloc_disk_node(1, home_node);
744 if (!disk) {
745 rv = -ENOMEM;
746 goto out_cleanup_lightnvm;
747 }
Jens Axboef2298c02013-10-25 11:52:25 +0100748 size = gb * 1024 * 1024 * 1024ULL;
Matias Bjørling5fdb7e12015-08-31 14:17:31 +0200749 set_capacity(disk, size >> 9);
Jens Axboef2298c02013-10-25 11:52:25 +0100750
Jens Axboe227290b2015-01-16 16:02:24 -0700751 disk->flags |= GENHD_FL_EXT_DEVT | GENHD_FL_SUPPRESS_PARTITION_INFO;
Jens Axboef2298c02013-10-25 11:52:25 +0100752 disk->major = null_major;
753 disk->first_minor = nullb->index;
754 disk->fops = &null_fops;
755 disk->private_data = nullb;
756 disk->queue = nullb->q;
Matias Bjørlingb2b7e002015-11-12 20:25:10 +0100757 strncpy(disk->disk_name, nullb->disk_name, DISK_NAME_LEN);
758
Jens Axboef2298c02013-10-25 11:52:25 +0100759 add_disk(disk);
Matias Bjørlingb2b7e002015-11-12 20:25:10 +0100760done:
Jens Axboef2298c02013-10-25 11:52:25 +0100761 return 0;
Christoph Hellwig24d2f902014-04-15 14:14:00 -0600762
Matias Bjørlingb2b7e002015-11-12 20:25:10 +0100763out_cleanup_lightnvm:
764 if (use_lightnvm)
765 nvm_unregister(nullb->disk_name);
Christoph Hellwig24d2f902014-04-15 14:14:00 -0600766out_cleanup_blk_queue:
767 blk_cleanup_queue(nullb->q);
768out_cleanup_tags:
769 if (queue_mode == NULL_Q_MQ)
770 blk_mq_free_tag_set(&nullb->tag_set);
771out_cleanup_queues:
772 cleanup_queues(nullb);
773out_free_nullb:
774 kfree(nullb);
775out:
Robert Elliottdc501dc2014-09-02 11:38:49 -0500776 return rv;
Jens Axboef2298c02013-10-25 11:52:25 +0100777}
778
779static int __init null_init(void)
780{
781 unsigned int i;
782
Raghavendra K T9967d8a2014-01-21 16:59:59 +0530783 if (bs > PAGE_SIZE) {
784 pr_warn("null_blk: invalid block size\n");
785 pr_warn("null_blk: defaults block size to %lu\n", PAGE_SIZE);
786 bs = PAGE_SIZE;
787 }
Jens Axboef2298c02013-10-25 11:52:25 +0100788
Matias Bjørling6bb95352015-11-19 12:50:08 +0100789 if (use_lightnvm && bs != 4096) {
790 pr_warn("null_blk: LightNVM only supports 4k block size\n");
791 pr_warn("null_blk: defaults block size to 4k\n");
792 bs = 4096;
793 }
794
Matias Bjørlingb2b7e002015-11-12 20:25:10 +0100795 if (use_lightnvm && queue_mode != NULL_Q_MQ) {
796 pr_warn("null_blk: LightNVM only supported for blk-mq\n");
797 pr_warn("null_blk: defaults queue mode to blk-mq\n");
798 queue_mode = NULL_Q_MQ;
799 }
800
Matias Bjorlingd15ee6b2013-12-18 13:41:44 +0100801 if (queue_mode == NULL_Q_MQ && use_per_node_hctx) {
Matias Bjørlingfc1bc352013-12-21 00:11:01 +0100802 if (submit_queues < nr_online_nodes) {
Matias Bjorlingd15ee6b2013-12-18 13:41:44 +0100803 pr_warn("null_blk: submit_queues param is set to %u.",
804 nr_online_nodes);
Matias Bjørlingfc1bc352013-12-21 00:11:01 +0100805 submit_queues = nr_online_nodes;
806 }
Matias Bjorlingd15ee6b2013-12-18 13:41:44 +0100807 } else if (submit_queues > nr_cpu_ids)
Jens Axboef2298c02013-10-25 11:52:25 +0100808 submit_queues = nr_cpu_ids;
809 else if (!submit_queues)
810 submit_queues = 1;
811
812 mutex_init(&lock);
813
814 /* Initialize a separate list for each CPU for issuing softirqs */
815 for_each_possible_cpu(i) {
816 struct completion_queue *cq = &per_cpu(completion_queues, i);
817
818 init_llist_head(&cq->list);
819
820 if (irqmode != NULL_IRQ_TIMER)
821 continue;
822
823 hrtimer_init(&cq->timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
824 cq->timer.function = null_cmd_timer_expired;
825 }
826
827 null_major = register_blkdev(0, "nullb");
828 if (null_major < 0)
829 return null_major;
830
Matias Bjørling6bb95352015-11-19 12:50:08 +0100831 if (use_lightnvm) {
832 ppa_cache = kmem_cache_create("ppa_cache", 64 * sizeof(u64),
833 0, 0, NULL);
834 if (!ppa_cache) {
835 pr_err("null_blk: unable to create ppa cache\n");
836 return -ENOMEM;
837 }
838 }
839
Jens Axboef2298c02013-10-25 11:52:25 +0100840 for (i = 0; i < nr_devices; i++) {
841 if (null_add_dev()) {
842 unregister_blkdev(null_major, "nullb");
Matias Bjørling6bb95352015-11-19 12:50:08 +0100843 goto err_ppa;
Jens Axboef2298c02013-10-25 11:52:25 +0100844 }
845 }
846
847 pr_info("null: module loaded\n");
848 return 0;
Matias Bjørling6bb95352015-11-19 12:50:08 +0100849err_ppa:
850 kmem_cache_destroy(ppa_cache);
851 return -EINVAL;
Jens Axboef2298c02013-10-25 11:52:25 +0100852}
853
854static void __exit null_exit(void)
855{
856 struct nullb *nullb;
857
858 unregister_blkdev(null_major, "nullb");
859
860 mutex_lock(&lock);
861 while (!list_empty(&nullb_list)) {
862 nullb = list_entry(nullb_list.next, struct nullb, list);
863 null_del_dev(nullb);
864 }
865 mutex_unlock(&lock);
Matias Bjørling6bb95352015-11-19 12:50:08 +0100866
867 kmem_cache_destroy(ppa_cache);
Jens Axboef2298c02013-10-25 11:52:25 +0100868}
869
870module_init(null_init);
871module_exit(null_exit);
872
873MODULE_AUTHOR("Jens Axboe <jaxboe@fusionio.com>");
874MODULE_LICENSE("GPL");