main.c 57 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * Add configfs and memory store: Kyungchan Koh <[email protected]> and
  4. * Shaohua Li <[email protected]>
  5. */
  6. #include <linux/module.h>
  7. #include <linux/moduleparam.h>
  8. #include <linux/sched.h>
  9. #include <linux/fs.h>
  10. #include <linux/init.h>
  11. #include "null_blk.h"
  12. #undef pr_fmt
  13. #define pr_fmt(fmt) "null_blk: " fmt
  14. #define FREE_BATCH 16
  15. #define TICKS_PER_SEC 50ULL
  16. #define TIMER_INTERVAL (NSEC_PER_SEC / TICKS_PER_SEC)
  17. #ifdef CONFIG_BLK_DEV_NULL_BLK_FAULT_INJECTION
  18. static DECLARE_FAULT_ATTR(null_timeout_attr);
  19. static DECLARE_FAULT_ATTR(null_requeue_attr);
  20. static DECLARE_FAULT_ATTR(null_init_hctx_attr);
  21. #endif
  22. static inline u64 mb_per_tick(int mbps)
  23. {
  24. return (1 << 20) / TICKS_PER_SEC * ((u64) mbps);
  25. }
  26. /*
  27. * Status flags for nullb_device.
  28. *
  29. * CONFIGURED: Device has been configured and turned on. Cannot reconfigure.
  30. * UP: Device is currently on and visible in userspace.
  31. * THROTTLED: Device is being throttled.
  32. * CACHE: Device is using a write-back cache.
  33. */
  34. enum nullb_device_flags {
  35. NULLB_DEV_FL_CONFIGURED = 0,
  36. NULLB_DEV_FL_UP = 1,
  37. NULLB_DEV_FL_THROTTLED = 2,
  38. NULLB_DEV_FL_CACHE = 3,
  39. };
  40. #define MAP_SZ ((PAGE_SIZE >> SECTOR_SHIFT) + 2)
  41. /*
  42. * nullb_page is a page in memory for nullb devices.
  43. *
  44. * @page: The page holding the data.
  45. * @bitmap: The bitmap represents which sector in the page has data.
  46. * Each bit represents one block size. For example, sector 8
  47. * will use the 7th bit
  48. * The highest 2 bits of bitmap are for special purpose. LOCK means the cache
  49. * page is being flushing to storage. FREE means the cache page is freed and
  50. * should be skipped from flushing to storage. Please see
  51. * null_make_cache_space
  52. */
  53. struct nullb_page {
  54. struct page *page;
  55. DECLARE_BITMAP(bitmap, MAP_SZ);
  56. };
  57. #define NULLB_PAGE_LOCK (MAP_SZ - 1)
  58. #define NULLB_PAGE_FREE (MAP_SZ - 2)
  59. static LIST_HEAD(nullb_list);
  60. static struct mutex lock;
  61. static int null_major;
  62. static DEFINE_IDA(nullb_indexes);
  63. static struct blk_mq_tag_set tag_set;
  64. enum {
  65. NULL_IRQ_NONE = 0,
  66. NULL_IRQ_SOFTIRQ = 1,
  67. NULL_IRQ_TIMER = 2,
  68. };
  69. static bool g_virt_boundary = false;
  70. module_param_named(virt_boundary, g_virt_boundary, bool, 0444);
  71. MODULE_PARM_DESC(virt_boundary, "Require a virtual boundary for the device. Default: False");
  72. static int g_no_sched;
  73. module_param_named(no_sched, g_no_sched, int, 0444);
  74. MODULE_PARM_DESC(no_sched, "No io scheduler");
  75. static int g_submit_queues = 1;
  76. module_param_named(submit_queues, g_submit_queues, int, 0444);
  77. MODULE_PARM_DESC(submit_queues, "Number of submission queues");
  78. static int g_poll_queues = 1;
  79. module_param_named(poll_queues, g_poll_queues, int, 0444);
  80. MODULE_PARM_DESC(poll_queues, "Number of IOPOLL submission queues");
  81. static int g_home_node = NUMA_NO_NODE;
  82. module_param_named(home_node, g_home_node, int, 0444);
  83. MODULE_PARM_DESC(home_node, "Home node for the device");
  84. #ifdef CONFIG_BLK_DEV_NULL_BLK_FAULT_INJECTION
  85. /*
  86. * For more details about fault injection, please refer to
  87. * Documentation/fault-injection/fault-injection.rst.
  88. */
  89. static char g_timeout_str[80];
  90. module_param_string(timeout, g_timeout_str, sizeof(g_timeout_str), 0444);
  91. MODULE_PARM_DESC(timeout, "Fault injection. timeout=<interval>,<probability>,<space>,<times>");
  92. static char g_requeue_str[80];
  93. module_param_string(requeue, g_requeue_str, sizeof(g_requeue_str), 0444);
  94. MODULE_PARM_DESC(requeue, "Fault injection. requeue=<interval>,<probability>,<space>,<times>");
  95. static char g_init_hctx_str[80];
  96. module_param_string(init_hctx, g_init_hctx_str, sizeof(g_init_hctx_str), 0444);
  97. MODULE_PARM_DESC(init_hctx, "Fault injection to fail hctx init. init_hctx=<interval>,<probability>,<space>,<times>");
  98. #endif
  99. static int g_queue_mode = NULL_Q_MQ;
  100. static int null_param_store_val(const char *str, int *val, int min, int max)
  101. {
  102. int ret, new_val;
  103. ret = kstrtoint(str, 10, &new_val);
  104. if (ret)
  105. return -EINVAL;
  106. if (new_val < min || new_val > max)
  107. return -EINVAL;
  108. *val = new_val;
  109. return 0;
  110. }
  111. static int null_set_queue_mode(const char *str, const struct kernel_param *kp)
  112. {
  113. return null_param_store_val(str, &g_queue_mode, NULL_Q_BIO, NULL_Q_MQ);
  114. }
  115. static const struct kernel_param_ops null_queue_mode_param_ops = {
  116. .set = null_set_queue_mode,
  117. .get = param_get_int,
  118. };
  119. device_param_cb(queue_mode, &null_queue_mode_param_ops, &g_queue_mode, 0444);
  120. MODULE_PARM_DESC(queue_mode, "Block interface to use (0=bio,1=rq,2=multiqueue)");
  121. static int g_gb = 250;
  122. module_param_named(gb, g_gb, int, 0444);
  123. MODULE_PARM_DESC(gb, "Size in GB");
  124. static int g_bs = 512;
  125. module_param_named(bs, g_bs, int, 0444);
  126. MODULE_PARM_DESC(bs, "Block size (in bytes)");
  127. static int g_max_sectors;
  128. module_param_named(max_sectors, g_max_sectors, int, 0444);
  129. MODULE_PARM_DESC(max_sectors, "Maximum size of a command (in 512B sectors)");
  130. static unsigned int nr_devices = 1;
  131. module_param(nr_devices, uint, 0444);
  132. MODULE_PARM_DESC(nr_devices, "Number of devices to register");
  133. static bool g_blocking;
  134. module_param_named(blocking, g_blocking, bool, 0444);
  135. MODULE_PARM_DESC(blocking, "Register as a blocking blk-mq driver device");
  136. static bool shared_tags;
  137. module_param(shared_tags, bool, 0444);
  138. MODULE_PARM_DESC(shared_tags, "Share tag set between devices for blk-mq");
  139. static bool g_shared_tag_bitmap;
  140. module_param_named(shared_tag_bitmap, g_shared_tag_bitmap, bool, 0444);
  141. MODULE_PARM_DESC(shared_tag_bitmap, "Use shared tag bitmap for all submission queues for blk-mq");
  142. static int g_irqmode = NULL_IRQ_SOFTIRQ;
  143. static int null_set_irqmode(const char *str, const struct kernel_param *kp)
  144. {
  145. return null_param_store_val(str, &g_irqmode, NULL_IRQ_NONE,
  146. NULL_IRQ_TIMER);
  147. }
  148. static const struct kernel_param_ops null_irqmode_param_ops = {
  149. .set = null_set_irqmode,
  150. .get = param_get_int,
  151. };
  152. device_param_cb(irqmode, &null_irqmode_param_ops, &g_irqmode, 0444);
  153. MODULE_PARM_DESC(irqmode, "IRQ completion handler. 0-none, 1-softirq, 2-timer");
  154. static unsigned long g_completion_nsec = 10000;
  155. module_param_named(completion_nsec, g_completion_nsec, ulong, 0444);
  156. MODULE_PARM_DESC(completion_nsec, "Time in ns to complete a request in hardware. Default: 10,000ns");
  157. static int g_hw_queue_depth = 64;
  158. module_param_named(hw_queue_depth, g_hw_queue_depth, int, 0444);
  159. MODULE_PARM_DESC(hw_queue_depth, "Queue depth for each hardware queue. Default: 64");
  160. static bool g_use_per_node_hctx;
  161. module_param_named(use_per_node_hctx, g_use_per_node_hctx, bool, 0444);
  162. MODULE_PARM_DESC(use_per_node_hctx, "Use per-node allocation for hardware context queues. Default: false");
  163. static bool g_memory_backed;
  164. module_param_named(memory_backed, g_memory_backed, bool, 0444);
  165. MODULE_PARM_DESC(memory_backed, "Create a memory-backed block device. Default: false");
  166. static bool g_discard;
  167. module_param_named(discard, g_discard, bool, 0444);
  168. MODULE_PARM_DESC(discard, "Support discard operations (requires memory-backed null_blk device). Default: false");
  169. static unsigned long g_cache_size;
  170. module_param_named(cache_size, g_cache_size, ulong, 0444);
  171. MODULE_PARM_DESC(mbps, "Cache size in MiB for memory-backed device. Default: 0 (none)");
  172. static unsigned int g_mbps;
  173. module_param_named(mbps, g_mbps, uint, 0444);
  174. MODULE_PARM_DESC(mbps, "Limit maximum bandwidth (in MiB/s). Default: 0 (no limit)");
  175. static bool g_zoned;
  176. module_param_named(zoned, g_zoned, bool, S_IRUGO);
  177. MODULE_PARM_DESC(zoned, "Make device as a host-managed zoned block device. Default: false");
  178. static unsigned long g_zone_size = 256;
  179. module_param_named(zone_size, g_zone_size, ulong, S_IRUGO);
  180. MODULE_PARM_DESC(zone_size, "Zone size in MB when block device is zoned. Must be power-of-two: Default: 256");
  181. static unsigned long g_zone_capacity;
  182. module_param_named(zone_capacity, g_zone_capacity, ulong, 0444);
  183. MODULE_PARM_DESC(zone_capacity, "Zone capacity in MB when block device is zoned. Can be less than or equal to zone size. Default: Zone size");
  184. static unsigned int g_zone_nr_conv;
  185. module_param_named(zone_nr_conv, g_zone_nr_conv, uint, 0444);
  186. MODULE_PARM_DESC(zone_nr_conv, "Number of conventional zones when block device is zoned. Default: 0");
  187. static unsigned int g_zone_max_open;
  188. module_param_named(zone_max_open, g_zone_max_open, uint, 0444);
  189. MODULE_PARM_DESC(zone_max_open, "Maximum number of open zones when block device is zoned. Default: 0 (no limit)");
  190. static unsigned int g_zone_max_active;
  191. module_param_named(zone_max_active, g_zone_max_active, uint, 0444);
  192. MODULE_PARM_DESC(zone_max_active, "Maximum number of active zones when block device is zoned. Default: 0 (no limit)");
  193. static struct nullb_device *null_alloc_dev(void);
  194. static void null_free_dev(struct nullb_device *dev);
  195. static void null_del_dev(struct nullb *nullb);
  196. static int null_add_dev(struct nullb_device *dev);
  197. static struct nullb *null_find_dev_by_name(const char *name);
  198. static void null_free_device_storage(struct nullb_device *dev, bool is_cache);
  199. static inline struct nullb_device *to_nullb_device(struct config_item *item)
  200. {
  201. return item ? container_of(item, struct nullb_device, item) : NULL;
  202. }
  203. static inline ssize_t nullb_device_uint_attr_show(unsigned int val, char *page)
  204. {
  205. return snprintf(page, PAGE_SIZE, "%u\n", val);
  206. }
  207. static inline ssize_t nullb_device_ulong_attr_show(unsigned long val,
  208. char *page)
  209. {
  210. return snprintf(page, PAGE_SIZE, "%lu\n", val);
  211. }
  212. static inline ssize_t nullb_device_bool_attr_show(bool val, char *page)
  213. {
  214. return snprintf(page, PAGE_SIZE, "%u\n", val);
  215. }
  216. static ssize_t nullb_device_uint_attr_store(unsigned int *val,
  217. const char *page, size_t count)
  218. {
  219. unsigned int tmp;
  220. int result;
  221. result = kstrtouint(page, 0, &tmp);
  222. if (result < 0)
  223. return result;
  224. *val = tmp;
  225. return count;
  226. }
  227. static ssize_t nullb_device_ulong_attr_store(unsigned long *val,
  228. const char *page, size_t count)
  229. {
  230. int result;
  231. unsigned long tmp;
  232. result = kstrtoul(page, 0, &tmp);
  233. if (result < 0)
  234. return result;
  235. *val = tmp;
  236. return count;
  237. }
  238. static ssize_t nullb_device_bool_attr_store(bool *val, const char *page,
  239. size_t count)
  240. {
  241. bool tmp;
  242. int result;
  243. result = kstrtobool(page, &tmp);
  244. if (result < 0)
  245. return result;
  246. *val = tmp;
  247. return count;
  248. }
  249. /* The following macro should only be used with TYPE = {uint, ulong, bool}. */
  250. #define NULLB_DEVICE_ATTR(NAME, TYPE, APPLY) \
  251. static ssize_t \
  252. nullb_device_##NAME##_show(struct config_item *item, char *page) \
  253. { \
  254. return nullb_device_##TYPE##_attr_show( \
  255. to_nullb_device(item)->NAME, page); \
  256. } \
  257. static ssize_t \
  258. nullb_device_##NAME##_store(struct config_item *item, const char *page, \
  259. size_t count) \
  260. { \
  261. int (*apply_fn)(struct nullb_device *dev, TYPE new_value) = APPLY;\
  262. struct nullb_device *dev = to_nullb_device(item); \
  263. TYPE new_value = 0; \
  264. int ret; \
  265. \
  266. ret = nullb_device_##TYPE##_attr_store(&new_value, page, count);\
  267. if (ret < 0) \
  268. return ret; \
  269. if (apply_fn) \
  270. ret = apply_fn(dev, new_value); \
  271. else if (test_bit(NULLB_DEV_FL_CONFIGURED, &dev->flags)) \
  272. ret = -EBUSY; \
  273. if (ret < 0) \
  274. return ret; \
  275. dev->NAME = new_value; \
  276. return count; \
  277. } \
  278. CONFIGFS_ATTR(nullb_device_, NAME);
  279. static int nullb_update_nr_hw_queues(struct nullb_device *dev,
  280. unsigned int submit_queues,
  281. unsigned int poll_queues)
  282. {
  283. struct blk_mq_tag_set *set;
  284. int ret, nr_hw_queues;
  285. if (!dev->nullb)
  286. return 0;
  287. /*
  288. * Make sure at least one submit queue exists.
  289. */
  290. if (!submit_queues)
  291. return -EINVAL;
  292. /*
  293. * Make sure that null_init_hctx() does not access nullb->queues[] past
  294. * the end of that array.
  295. */
  296. if (submit_queues > nr_cpu_ids || poll_queues > g_poll_queues)
  297. return -EINVAL;
  298. /*
  299. * Keep previous and new queue numbers in nullb_device for reference in
  300. * the call back function null_map_queues().
  301. */
  302. dev->prev_submit_queues = dev->submit_queues;
  303. dev->prev_poll_queues = dev->poll_queues;
  304. dev->submit_queues = submit_queues;
  305. dev->poll_queues = poll_queues;
  306. set = dev->nullb->tag_set;
  307. nr_hw_queues = submit_queues + poll_queues;
  308. blk_mq_update_nr_hw_queues(set, nr_hw_queues);
  309. ret = set->nr_hw_queues == nr_hw_queues ? 0 : -ENOMEM;
  310. if (ret) {
  311. /* on error, revert the queue numbers */
  312. dev->submit_queues = dev->prev_submit_queues;
  313. dev->poll_queues = dev->prev_poll_queues;
  314. }
  315. return ret;
  316. }
  317. static int nullb_apply_submit_queues(struct nullb_device *dev,
  318. unsigned int submit_queues)
  319. {
  320. return nullb_update_nr_hw_queues(dev, submit_queues, dev->poll_queues);
  321. }
  322. static int nullb_apply_poll_queues(struct nullb_device *dev,
  323. unsigned int poll_queues)
  324. {
  325. return nullb_update_nr_hw_queues(dev, dev->submit_queues, poll_queues);
  326. }
  327. NULLB_DEVICE_ATTR(size, ulong, NULL);
  328. NULLB_DEVICE_ATTR(completion_nsec, ulong, NULL);
  329. NULLB_DEVICE_ATTR(submit_queues, uint, nullb_apply_submit_queues);
  330. NULLB_DEVICE_ATTR(poll_queues, uint, nullb_apply_poll_queues);
  331. NULLB_DEVICE_ATTR(home_node, uint, NULL);
  332. NULLB_DEVICE_ATTR(queue_mode, uint, NULL);
  333. NULLB_DEVICE_ATTR(blocksize, uint, NULL);
  334. NULLB_DEVICE_ATTR(max_sectors, uint, NULL);
  335. NULLB_DEVICE_ATTR(irqmode, uint, NULL);
  336. NULLB_DEVICE_ATTR(hw_queue_depth, uint, NULL);
  337. NULLB_DEVICE_ATTR(index, uint, NULL);
  338. NULLB_DEVICE_ATTR(blocking, bool, NULL);
  339. NULLB_DEVICE_ATTR(use_per_node_hctx, bool, NULL);
  340. NULLB_DEVICE_ATTR(memory_backed, bool, NULL);
  341. NULLB_DEVICE_ATTR(discard, bool, NULL);
  342. NULLB_DEVICE_ATTR(mbps, uint, NULL);
  343. NULLB_DEVICE_ATTR(cache_size, ulong, NULL);
  344. NULLB_DEVICE_ATTR(zoned, bool, NULL);
  345. NULLB_DEVICE_ATTR(zone_size, ulong, NULL);
  346. NULLB_DEVICE_ATTR(zone_capacity, ulong, NULL);
  347. NULLB_DEVICE_ATTR(zone_nr_conv, uint, NULL);
  348. NULLB_DEVICE_ATTR(zone_max_open, uint, NULL);
  349. NULLB_DEVICE_ATTR(zone_max_active, uint, NULL);
  350. NULLB_DEVICE_ATTR(virt_boundary, bool, NULL);
  351. NULLB_DEVICE_ATTR(no_sched, bool, NULL);
  352. NULLB_DEVICE_ATTR(shared_tag_bitmap, bool, NULL);
  353. static ssize_t nullb_device_power_show(struct config_item *item, char *page)
  354. {
  355. return nullb_device_bool_attr_show(to_nullb_device(item)->power, page);
  356. }
  357. static ssize_t nullb_device_power_store(struct config_item *item,
  358. const char *page, size_t count)
  359. {
  360. struct nullb_device *dev = to_nullb_device(item);
  361. bool newp = false;
  362. ssize_t ret;
  363. ret = nullb_device_bool_attr_store(&newp, page, count);
  364. if (ret < 0)
  365. return ret;
  366. if (!dev->power && newp) {
  367. if (test_and_set_bit(NULLB_DEV_FL_UP, &dev->flags))
  368. return count;
  369. ret = null_add_dev(dev);
  370. if (ret) {
  371. clear_bit(NULLB_DEV_FL_UP, &dev->flags);
  372. return ret;
  373. }
  374. set_bit(NULLB_DEV_FL_CONFIGURED, &dev->flags);
  375. dev->power = newp;
  376. } else if (dev->power && !newp) {
  377. if (test_and_clear_bit(NULLB_DEV_FL_UP, &dev->flags)) {
  378. mutex_lock(&lock);
  379. dev->power = newp;
  380. null_del_dev(dev->nullb);
  381. mutex_unlock(&lock);
  382. }
  383. clear_bit(NULLB_DEV_FL_CONFIGURED, &dev->flags);
  384. }
  385. return count;
  386. }
  387. CONFIGFS_ATTR(nullb_device_, power);
  388. static ssize_t nullb_device_badblocks_show(struct config_item *item, char *page)
  389. {
  390. struct nullb_device *t_dev = to_nullb_device(item);
  391. return badblocks_show(&t_dev->badblocks, page, 0);
  392. }
  393. static ssize_t nullb_device_badblocks_store(struct config_item *item,
  394. const char *page, size_t count)
  395. {
  396. struct nullb_device *t_dev = to_nullb_device(item);
  397. char *orig, *buf, *tmp;
  398. u64 start, end;
  399. int ret;
  400. orig = kstrndup(page, count, GFP_KERNEL);
  401. if (!orig)
  402. return -ENOMEM;
  403. buf = strstrip(orig);
  404. ret = -EINVAL;
  405. if (buf[0] != '+' && buf[0] != '-')
  406. goto out;
  407. tmp = strchr(&buf[1], '-');
  408. if (!tmp)
  409. goto out;
  410. *tmp = '\0';
  411. ret = kstrtoull(buf + 1, 0, &start);
  412. if (ret)
  413. goto out;
  414. ret = kstrtoull(tmp + 1, 0, &end);
  415. if (ret)
  416. goto out;
  417. ret = -EINVAL;
  418. if (start > end)
  419. goto out;
  420. /* enable badblocks */
  421. cmpxchg(&t_dev->badblocks.shift, -1, 0);
  422. if (buf[0] == '+')
  423. ret = badblocks_set(&t_dev->badblocks, start,
  424. end - start + 1, 1);
  425. else
  426. ret = badblocks_clear(&t_dev->badblocks, start,
  427. end - start + 1);
  428. if (ret == 0)
  429. ret = count;
  430. out:
  431. kfree(orig);
  432. return ret;
  433. }
  434. CONFIGFS_ATTR(nullb_device_, badblocks);
  435. static struct configfs_attribute *nullb_device_attrs[] = {
  436. &nullb_device_attr_size,
  437. &nullb_device_attr_completion_nsec,
  438. &nullb_device_attr_submit_queues,
  439. &nullb_device_attr_poll_queues,
  440. &nullb_device_attr_home_node,
  441. &nullb_device_attr_queue_mode,
  442. &nullb_device_attr_blocksize,
  443. &nullb_device_attr_max_sectors,
  444. &nullb_device_attr_irqmode,
  445. &nullb_device_attr_hw_queue_depth,
  446. &nullb_device_attr_index,
  447. &nullb_device_attr_blocking,
  448. &nullb_device_attr_use_per_node_hctx,
  449. &nullb_device_attr_power,
  450. &nullb_device_attr_memory_backed,
  451. &nullb_device_attr_discard,
  452. &nullb_device_attr_mbps,
  453. &nullb_device_attr_cache_size,
  454. &nullb_device_attr_badblocks,
  455. &nullb_device_attr_zoned,
  456. &nullb_device_attr_zone_size,
  457. &nullb_device_attr_zone_capacity,
  458. &nullb_device_attr_zone_nr_conv,
  459. &nullb_device_attr_zone_max_open,
  460. &nullb_device_attr_zone_max_active,
  461. &nullb_device_attr_virt_boundary,
  462. &nullb_device_attr_no_sched,
  463. &nullb_device_attr_shared_tag_bitmap,
  464. NULL,
  465. };
  466. static void nullb_device_release(struct config_item *item)
  467. {
  468. struct nullb_device *dev = to_nullb_device(item);
  469. null_free_device_storage(dev, false);
  470. null_free_dev(dev);
  471. }
  472. static struct configfs_item_operations nullb_device_ops = {
  473. .release = nullb_device_release,
  474. };
  475. static const struct config_item_type nullb_device_type = {
  476. .ct_item_ops = &nullb_device_ops,
  477. .ct_attrs = nullb_device_attrs,
  478. .ct_owner = THIS_MODULE,
  479. };
  480. static struct
  481. config_item *nullb_group_make_item(struct config_group *group, const char *name)
  482. {
  483. struct nullb_device *dev;
  484. if (null_find_dev_by_name(name))
  485. return ERR_PTR(-EEXIST);
  486. dev = null_alloc_dev();
  487. if (!dev)
  488. return ERR_PTR(-ENOMEM);
  489. config_item_init_type_name(&dev->item, name, &nullb_device_type);
  490. return &dev->item;
  491. }
  492. static void
  493. nullb_group_drop_item(struct config_group *group, struct config_item *item)
  494. {
  495. struct nullb_device *dev = to_nullb_device(item);
  496. if (test_and_clear_bit(NULLB_DEV_FL_UP, &dev->flags)) {
  497. mutex_lock(&lock);
  498. dev->power = false;
  499. null_del_dev(dev->nullb);
  500. mutex_unlock(&lock);
  501. }
  502. config_item_put(item);
  503. }
  504. static ssize_t memb_group_features_show(struct config_item *item, char *page)
  505. {
  506. return snprintf(page, PAGE_SIZE,
  507. "badblocks,blocking,blocksize,cache_size,"
  508. "completion_nsec,discard,home_node,hw_queue_depth,"
  509. "irqmode,max_sectors,mbps,memory_backed,no_sched,"
  510. "poll_queues,power,queue_mode,shared_tag_bitmap,size,"
  511. "submit_queues,use_per_node_hctx,virt_boundary,zoned,"
  512. "zone_capacity,zone_max_active,zone_max_open,"
  513. "zone_nr_conv,zone_size\n");
  514. }
  515. CONFIGFS_ATTR_RO(memb_group_, features);
  516. static struct configfs_attribute *nullb_group_attrs[] = {
  517. &memb_group_attr_features,
  518. NULL,
  519. };
  520. static struct configfs_group_operations nullb_group_ops = {
  521. .make_item = nullb_group_make_item,
  522. .drop_item = nullb_group_drop_item,
  523. };
  524. static const struct config_item_type nullb_group_type = {
  525. .ct_group_ops = &nullb_group_ops,
  526. .ct_attrs = nullb_group_attrs,
  527. .ct_owner = THIS_MODULE,
  528. };
  529. static struct configfs_subsystem nullb_subsys = {
  530. .su_group = {
  531. .cg_item = {
  532. .ci_namebuf = "nullb",
  533. .ci_type = &nullb_group_type,
  534. },
  535. },
  536. };
  537. static inline int null_cache_active(struct nullb *nullb)
  538. {
  539. return test_bit(NULLB_DEV_FL_CACHE, &nullb->dev->flags);
  540. }
  541. static struct nullb_device *null_alloc_dev(void)
  542. {
  543. struct nullb_device *dev;
  544. dev = kzalloc(sizeof(*dev), GFP_KERNEL);
  545. if (!dev)
  546. return NULL;
  547. INIT_RADIX_TREE(&dev->data, GFP_ATOMIC);
  548. INIT_RADIX_TREE(&dev->cache, GFP_ATOMIC);
  549. if (badblocks_init(&dev->badblocks, 0)) {
  550. kfree(dev);
  551. return NULL;
  552. }
  553. dev->size = g_gb * 1024;
  554. dev->completion_nsec = g_completion_nsec;
  555. dev->submit_queues = g_submit_queues;
  556. dev->prev_submit_queues = g_submit_queues;
  557. dev->poll_queues = g_poll_queues;
  558. dev->prev_poll_queues = g_poll_queues;
  559. dev->home_node = g_home_node;
  560. dev->queue_mode = g_queue_mode;
  561. dev->blocksize = g_bs;
  562. dev->max_sectors = g_max_sectors;
  563. dev->irqmode = g_irqmode;
  564. dev->hw_queue_depth = g_hw_queue_depth;
  565. dev->blocking = g_blocking;
  566. dev->memory_backed = g_memory_backed;
  567. dev->discard = g_discard;
  568. dev->cache_size = g_cache_size;
  569. dev->mbps = g_mbps;
  570. dev->use_per_node_hctx = g_use_per_node_hctx;
  571. dev->zoned = g_zoned;
  572. dev->zone_size = g_zone_size;
  573. dev->zone_capacity = g_zone_capacity;
  574. dev->zone_nr_conv = g_zone_nr_conv;
  575. dev->zone_max_open = g_zone_max_open;
  576. dev->zone_max_active = g_zone_max_active;
  577. dev->virt_boundary = g_virt_boundary;
  578. dev->no_sched = g_no_sched;
  579. dev->shared_tag_bitmap = g_shared_tag_bitmap;
  580. return dev;
  581. }
  582. static void null_free_dev(struct nullb_device *dev)
  583. {
  584. if (!dev)
  585. return;
  586. null_free_zoned_dev(dev);
  587. badblocks_exit(&dev->badblocks);
  588. kfree(dev);
  589. }
  590. static void put_tag(struct nullb_queue *nq, unsigned int tag)
  591. {
  592. clear_bit_unlock(tag, nq->tag_map);
  593. if (waitqueue_active(&nq->wait))
  594. wake_up(&nq->wait);
  595. }
  596. static unsigned int get_tag(struct nullb_queue *nq)
  597. {
  598. unsigned int tag;
  599. do {
  600. tag = find_first_zero_bit(nq->tag_map, nq->queue_depth);
  601. if (tag >= nq->queue_depth)
  602. return -1U;
  603. } while (test_and_set_bit_lock(tag, nq->tag_map));
  604. return tag;
  605. }
  606. static void free_cmd(struct nullb_cmd *cmd)
  607. {
  608. put_tag(cmd->nq, cmd->tag);
  609. }
  610. static enum hrtimer_restart null_cmd_timer_expired(struct hrtimer *timer);
  611. static struct nullb_cmd *__alloc_cmd(struct nullb_queue *nq)
  612. {
  613. struct nullb_cmd *cmd;
  614. unsigned int tag;
  615. tag = get_tag(nq);
  616. if (tag != -1U) {
  617. cmd = &nq->cmds[tag];
  618. cmd->tag = tag;
  619. cmd->error = BLK_STS_OK;
  620. cmd->nq = nq;
  621. if (nq->dev->irqmode == NULL_IRQ_TIMER) {
  622. hrtimer_init(&cmd->timer, CLOCK_MONOTONIC,
  623. HRTIMER_MODE_REL);
  624. cmd->timer.function = null_cmd_timer_expired;
  625. }
  626. return cmd;
  627. }
  628. return NULL;
  629. }
  630. static struct nullb_cmd *alloc_cmd(struct nullb_queue *nq, struct bio *bio)
  631. {
  632. struct nullb_cmd *cmd;
  633. DEFINE_WAIT(wait);
  634. do {
  635. /*
  636. * This avoids multiple return statements, multiple calls to
  637. * __alloc_cmd() and a fast path call to prepare_to_wait().
  638. */
  639. cmd = __alloc_cmd(nq);
  640. if (cmd) {
  641. cmd->bio = bio;
  642. return cmd;
  643. }
  644. prepare_to_wait(&nq->wait, &wait, TASK_UNINTERRUPTIBLE);
  645. io_schedule();
  646. finish_wait(&nq->wait, &wait);
  647. } while (1);
  648. }
  649. static void end_cmd(struct nullb_cmd *cmd)
  650. {
  651. int queue_mode = cmd->nq->dev->queue_mode;
  652. switch (queue_mode) {
  653. case NULL_Q_MQ:
  654. blk_mq_end_request(cmd->rq, cmd->error);
  655. return;
  656. case NULL_Q_BIO:
  657. cmd->bio->bi_status = cmd->error;
  658. bio_endio(cmd->bio);
  659. break;
  660. }
  661. free_cmd(cmd);
  662. }
  663. static enum hrtimer_restart null_cmd_timer_expired(struct hrtimer *timer)
  664. {
  665. end_cmd(container_of(timer, struct nullb_cmd, timer));
  666. return HRTIMER_NORESTART;
  667. }
  668. static void null_cmd_end_timer(struct nullb_cmd *cmd)
  669. {
  670. ktime_t kt = cmd->nq->dev->completion_nsec;
  671. hrtimer_start(&cmd->timer, kt, HRTIMER_MODE_REL);
  672. }
  673. static void null_complete_rq(struct request *rq)
  674. {
  675. end_cmd(blk_mq_rq_to_pdu(rq));
  676. }
  677. static struct nullb_page *null_alloc_page(void)
  678. {
  679. struct nullb_page *t_page;
  680. t_page = kmalloc(sizeof(struct nullb_page), GFP_NOIO);
  681. if (!t_page)
  682. return NULL;
  683. t_page->page = alloc_pages(GFP_NOIO, 0);
  684. if (!t_page->page) {
  685. kfree(t_page);
  686. return NULL;
  687. }
  688. memset(t_page->bitmap, 0, sizeof(t_page->bitmap));
  689. return t_page;
  690. }
  691. static void null_free_page(struct nullb_page *t_page)
  692. {
  693. __set_bit(NULLB_PAGE_FREE, t_page->bitmap);
  694. if (test_bit(NULLB_PAGE_LOCK, t_page->bitmap))
  695. return;
  696. __free_page(t_page->page);
  697. kfree(t_page);
  698. }
  699. static bool null_page_empty(struct nullb_page *page)
  700. {
  701. int size = MAP_SZ - 2;
  702. return find_first_bit(page->bitmap, size) == size;
  703. }
  704. static void null_free_sector(struct nullb *nullb, sector_t sector,
  705. bool is_cache)
  706. {
  707. unsigned int sector_bit;
  708. u64 idx;
  709. struct nullb_page *t_page, *ret;
  710. struct radix_tree_root *root;
  711. root = is_cache ? &nullb->dev->cache : &nullb->dev->data;
  712. idx = sector >> PAGE_SECTORS_SHIFT;
  713. sector_bit = (sector & SECTOR_MASK);
  714. t_page = radix_tree_lookup(root, idx);
  715. if (t_page) {
  716. __clear_bit(sector_bit, t_page->bitmap);
  717. if (null_page_empty(t_page)) {
  718. ret = radix_tree_delete_item(root, idx, t_page);
  719. WARN_ON(ret != t_page);
  720. null_free_page(ret);
  721. if (is_cache)
  722. nullb->dev->curr_cache -= PAGE_SIZE;
  723. }
  724. }
  725. }
  726. static struct nullb_page *null_radix_tree_insert(struct nullb *nullb, u64 idx,
  727. struct nullb_page *t_page, bool is_cache)
  728. {
  729. struct radix_tree_root *root;
  730. root = is_cache ? &nullb->dev->cache : &nullb->dev->data;
  731. if (radix_tree_insert(root, idx, t_page)) {
  732. null_free_page(t_page);
  733. t_page = radix_tree_lookup(root, idx);
  734. WARN_ON(!t_page || t_page->page->index != idx);
  735. } else if (is_cache)
  736. nullb->dev->curr_cache += PAGE_SIZE;
  737. return t_page;
  738. }
  739. static void null_free_device_storage(struct nullb_device *dev, bool is_cache)
  740. {
  741. unsigned long pos = 0;
  742. int nr_pages;
  743. struct nullb_page *ret, *t_pages[FREE_BATCH];
  744. struct radix_tree_root *root;
  745. root = is_cache ? &dev->cache : &dev->data;
  746. do {
  747. int i;
  748. nr_pages = radix_tree_gang_lookup(root,
  749. (void **)t_pages, pos, FREE_BATCH);
  750. for (i = 0; i < nr_pages; i++) {
  751. pos = t_pages[i]->page->index;
  752. ret = radix_tree_delete_item(root, pos, t_pages[i]);
  753. WARN_ON(ret != t_pages[i]);
  754. null_free_page(ret);
  755. }
  756. pos++;
  757. } while (nr_pages == FREE_BATCH);
  758. if (is_cache)
  759. dev->curr_cache = 0;
  760. }
  761. static struct nullb_page *__null_lookup_page(struct nullb *nullb,
  762. sector_t sector, bool for_write, bool is_cache)
  763. {
  764. unsigned int sector_bit;
  765. u64 idx;
  766. struct nullb_page *t_page;
  767. struct radix_tree_root *root;
  768. idx = sector >> PAGE_SECTORS_SHIFT;
  769. sector_bit = (sector & SECTOR_MASK);
  770. root = is_cache ? &nullb->dev->cache : &nullb->dev->data;
  771. t_page = radix_tree_lookup(root, idx);
  772. WARN_ON(t_page && t_page->page->index != idx);
  773. if (t_page && (for_write || test_bit(sector_bit, t_page->bitmap)))
  774. return t_page;
  775. return NULL;
  776. }
  777. static struct nullb_page *null_lookup_page(struct nullb *nullb,
  778. sector_t sector, bool for_write, bool ignore_cache)
  779. {
  780. struct nullb_page *page = NULL;
  781. if (!ignore_cache)
  782. page = __null_lookup_page(nullb, sector, for_write, true);
  783. if (page)
  784. return page;
  785. return __null_lookup_page(nullb, sector, for_write, false);
  786. }
  787. static struct nullb_page *null_insert_page(struct nullb *nullb,
  788. sector_t sector, bool ignore_cache)
  789. __releases(&nullb->lock)
  790. __acquires(&nullb->lock)
  791. {
  792. u64 idx;
  793. struct nullb_page *t_page;
  794. t_page = null_lookup_page(nullb, sector, true, ignore_cache);
  795. if (t_page)
  796. return t_page;
  797. spin_unlock_irq(&nullb->lock);
  798. t_page = null_alloc_page();
  799. if (!t_page)
  800. goto out_lock;
  801. if (radix_tree_preload(GFP_NOIO))
  802. goto out_freepage;
  803. spin_lock_irq(&nullb->lock);
  804. idx = sector >> PAGE_SECTORS_SHIFT;
  805. t_page->page->index = idx;
  806. t_page = null_radix_tree_insert(nullb, idx, t_page, !ignore_cache);
  807. radix_tree_preload_end();
  808. return t_page;
  809. out_freepage:
  810. null_free_page(t_page);
  811. out_lock:
  812. spin_lock_irq(&nullb->lock);
  813. return null_lookup_page(nullb, sector, true, ignore_cache);
  814. }
  815. static int null_flush_cache_page(struct nullb *nullb, struct nullb_page *c_page)
  816. {
  817. int i;
  818. unsigned int offset;
  819. u64 idx;
  820. struct nullb_page *t_page, *ret;
  821. void *dst, *src;
  822. idx = c_page->page->index;
  823. t_page = null_insert_page(nullb, idx << PAGE_SECTORS_SHIFT, true);
  824. __clear_bit(NULLB_PAGE_LOCK, c_page->bitmap);
  825. if (test_bit(NULLB_PAGE_FREE, c_page->bitmap)) {
  826. null_free_page(c_page);
  827. if (t_page && null_page_empty(t_page)) {
  828. ret = radix_tree_delete_item(&nullb->dev->data,
  829. idx, t_page);
  830. null_free_page(t_page);
  831. }
  832. return 0;
  833. }
  834. if (!t_page)
  835. return -ENOMEM;
  836. src = kmap_atomic(c_page->page);
  837. dst = kmap_atomic(t_page->page);
  838. for (i = 0; i < PAGE_SECTORS;
  839. i += (nullb->dev->blocksize >> SECTOR_SHIFT)) {
  840. if (test_bit(i, c_page->bitmap)) {
  841. offset = (i << SECTOR_SHIFT);
  842. memcpy(dst + offset, src + offset,
  843. nullb->dev->blocksize);
  844. __set_bit(i, t_page->bitmap);
  845. }
  846. }
  847. kunmap_atomic(dst);
  848. kunmap_atomic(src);
  849. ret = radix_tree_delete_item(&nullb->dev->cache, idx, c_page);
  850. null_free_page(ret);
  851. nullb->dev->curr_cache -= PAGE_SIZE;
  852. return 0;
  853. }
  854. static int null_make_cache_space(struct nullb *nullb, unsigned long n)
  855. {
  856. int i, err, nr_pages;
  857. struct nullb_page *c_pages[FREE_BATCH];
  858. unsigned long flushed = 0, one_round;
  859. again:
  860. if ((nullb->dev->cache_size * 1024 * 1024) >
  861. nullb->dev->curr_cache + n || nullb->dev->curr_cache == 0)
  862. return 0;
  863. nr_pages = radix_tree_gang_lookup(&nullb->dev->cache,
  864. (void **)c_pages, nullb->cache_flush_pos, FREE_BATCH);
  865. /*
  866. * nullb_flush_cache_page could unlock before using the c_pages. To
  867. * avoid race, we don't allow page free
  868. */
  869. for (i = 0; i < nr_pages; i++) {
  870. nullb->cache_flush_pos = c_pages[i]->page->index;
  871. /*
  872. * We found the page which is being flushed to disk by other
  873. * threads
  874. */
  875. if (test_bit(NULLB_PAGE_LOCK, c_pages[i]->bitmap))
  876. c_pages[i] = NULL;
  877. else
  878. __set_bit(NULLB_PAGE_LOCK, c_pages[i]->bitmap);
  879. }
  880. one_round = 0;
  881. for (i = 0; i < nr_pages; i++) {
  882. if (c_pages[i] == NULL)
  883. continue;
  884. err = null_flush_cache_page(nullb, c_pages[i]);
  885. if (err)
  886. return err;
  887. one_round++;
  888. }
  889. flushed += one_round << PAGE_SHIFT;
  890. if (n > flushed) {
  891. if (nr_pages == 0)
  892. nullb->cache_flush_pos = 0;
  893. if (one_round == 0) {
  894. /* give other threads a chance */
  895. spin_unlock_irq(&nullb->lock);
  896. spin_lock_irq(&nullb->lock);
  897. }
  898. goto again;
  899. }
  900. return 0;
  901. }
  902. static int copy_to_nullb(struct nullb *nullb, struct page *source,
  903. unsigned int off, sector_t sector, size_t n, bool is_fua)
  904. {
  905. size_t temp, count = 0;
  906. unsigned int offset;
  907. struct nullb_page *t_page;
  908. void *dst, *src;
  909. while (count < n) {
  910. temp = min_t(size_t, nullb->dev->blocksize, n - count);
  911. if (null_cache_active(nullb) && !is_fua)
  912. null_make_cache_space(nullb, PAGE_SIZE);
  913. offset = (sector & SECTOR_MASK) << SECTOR_SHIFT;
  914. t_page = null_insert_page(nullb, sector,
  915. !null_cache_active(nullb) || is_fua);
  916. if (!t_page)
  917. return -ENOSPC;
  918. src = kmap_atomic(source);
  919. dst = kmap_atomic(t_page->page);
  920. memcpy(dst + offset, src + off + count, temp);
  921. kunmap_atomic(dst);
  922. kunmap_atomic(src);
  923. __set_bit(sector & SECTOR_MASK, t_page->bitmap);
  924. if (is_fua)
  925. null_free_sector(nullb, sector, true);
  926. count += temp;
  927. sector += temp >> SECTOR_SHIFT;
  928. }
  929. return 0;
  930. }
  931. static int copy_from_nullb(struct nullb *nullb, struct page *dest,
  932. unsigned int off, sector_t sector, size_t n)
  933. {
  934. size_t temp, count = 0;
  935. unsigned int offset;
  936. struct nullb_page *t_page;
  937. void *dst, *src;
  938. while (count < n) {
  939. temp = min_t(size_t, nullb->dev->blocksize, n - count);
  940. offset = (sector & SECTOR_MASK) << SECTOR_SHIFT;
  941. t_page = null_lookup_page(nullb, sector, false,
  942. !null_cache_active(nullb));
  943. dst = kmap_atomic(dest);
  944. if (!t_page) {
  945. memset(dst + off + count, 0, temp);
  946. goto next;
  947. }
  948. src = kmap_atomic(t_page->page);
  949. memcpy(dst + off + count, src + offset, temp);
  950. kunmap_atomic(src);
  951. next:
  952. kunmap_atomic(dst);
  953. count += temp;
  954. sector += temp >> SECTOR_SHIFT;
  955. }
  956. return 0;
  957. }
  958. static void nullb_fill_pattern(struct nullb *nullb, struct page *page,
  959. unsigned int len, unsigned int off)
  960. {
  961. void *dst;
  962. dst = kmap_atomic(page);
  963. memset(dst + off, 0xFF, len);
  964. kunmap_atomic(dst);
  965. }
  966. blk_status_t null_handle_discard(struct nullb_device *dev,
  967. sector_t sector, sector_t nr_sectors)
  968. {
  969. struct nullb *nullb = dev->nullb;
  970. size_t n = nr_sectors << SECTOR_SHIFT;
  971. size_t temp;
  972. spin_lock_irq(&nullb->lock);
  973. while (n > 0) {
  974. temp = min_t(size_t, n, dev->blocksize);
  975. null_free_sector(nullb, sector, false);
  976. if (null_cache_active(nullb))
  977. null_free_sector(nullb, sector, true);
  978. sector += temp >> SECTOR_SHIFT;
  979. n -= temp;
  980. }
  981. spin_unlock_irq(&nullb->lock);
  982. return BLK_STS_OK;
  983. }
  984. static int null_handle_flush(struct nullb *nullb)
  985. {
  986. int err;
  987. if (!null_cache_active(nullb))
  988. return 0;
  989. spin_lock_irq(&nullb->lock);
  990. while (true) {
  991. err = null_make_cache_space(nullb,
  992. nullb->dev->cache_size * 1024 * 1024);
  993. if (err || nullb->dev->curr_cache == 0)
  994. break;
  995. }
  996. WARN_ON(!radix_tree_empty(&nullb->dev->cache));
  997. spin_unlock_irq(&nullb->lock);
  998. return err;
  999. }
  1000. static int null_transfer(struct nullb *nullb, struct page *page,
  1001. unsigned int len, unsigned int off, bool is_write, sector_t sector,
  1002. bool is_fua)
  1003. {
  1004. struct nullb_device *dev = nullb->dev;
  1005. unsigned int valid_len = len;
  1006. int err = 0;
  1007. if (!is_write) {
  1008. if (dev->zoned)
  1009. valid_len = null_zone_valid_read_len(nullb,
  1010. sector, len);
  1011. if (valid_len) {
  1012. err = copy_from_nullb(nullb, page, off,
  1013. sector, valid_len);
  1014. off += valid_len;
  1015. len -= valid_len;
  1016. }
  1017. if (len)
  1018. nullb_fill_pattern(nullb, page, len, off);
  1019. flush_dcache_page(page);
  1020. } else {
  1021. flush_dcache_page(page);
  1022. err = copy_to_nullb(nullb, page, off, sector, len, is_fua);
  1023. }
  1024. return err;
  1025. }
  1026. static int null_handle_rq(struct nullb_cmd *cmd)
  1027. {
  1028. struct request *rq = cmd->rq;
  1029. struct nullb *nullb = cmd->nq->dev->nullb;
  1030. int err;
  1031. unsigned int len;
  1032. sector_t sector = blk_rq_pos(rq);
  1033. struct req_iterator iter;
  1034. struct bio_vec bvec;
  1035. spin_lock_irq(&nullb->lock);
  1036. rq_for_each_segment(bvec, rq, iter) {
  1037. len = bvec.bv_len;
  1038. err = null_transfer(nullb, bvec.bv_page, len, bvec.bv_offset,
  1039. op_is_write(req_op(rq)), sector,
  1040. rq->cmd_flags & REQ_FUA);
  1041. if (err) {
  1042. spin_unlock_irq(&nullb->lock);
  1043. return err;
  1044. }
  1045. sector += len >> SECTOR_SHIFT;
  1046. }
  1047. spin_unlock_irq(&nullb->lock);
  1048. return 0;
  1049. }
  1050. static int null_handle_bio(struct nullb_cmd *cmd)
  1051. {
  1052. struct bio *bio = cmd->bio;
  1053. struct nullb *nullb = cmd->nq->dev->nullb;
  1054. int err;
  1055. unsigned int len;
  1056. sector_t sector = bio->bi_iter.bi_sector;
  1057. struct bio_vec bvec;
  1058. struct bvec_iter iter;
  1059. spin_lock_irq(&nullb->lock);
  1060. bio_for_each_segment(bvec, bio, iter) {
  1061. len = bvec.bv_len;
  1062. err = null_transfer(nullb, bvec.bv_page, len, bvec.bv_offset,
  1063. op_is_write(bio_op(bio)), sector,
  1064. bio->bi_opf & REQ_FUA);
  1065. if (err) {
  1066. spin_unlock_irq(&nullb->lock);
  1067. return err;
  1068. }
  1069. sector += len >> SECTOR_SHIFT;
  1070. }
  1071. spin_unlock_irq(&nullb->lock);
  1072. return 0;
  1073. }
  1074. static void null_stop_queue(struct nullb *nullb)
  1075. {
  1076. struct request_queue *q = nullb->q;
  1077. if (nullb->dev->queue_mode == NULL_Q_MQ)
  1078. blk_mq_stop_hw_queues(q);
  1079. }
  1080. static void null_restart_queue_async(struct nullb *nullb)
  1081. {
  1082. struct request_queue *q = nullb->q;
  1083. if (nullb->dev->queue_mode == NULL_Q_MQ)
  1084. blk_mq_start_stopped_hw_queues(q, true);
  1085. }
  1086. static inline blk_status_t null_handle_throttled(struct nullb_cmd *cmd)
  1087. {
  1088. struct nullb_device *dev = cmd->nq->dev;
  1089. struct nullb *nullb = dev->nullb;
  1090. blk_status_t sts = BLK_STS_OK;
  1091. struct request *rq = cmd->rq;
  1092. if (!hrtimer_active(&nullb->bw_timer))
  1093. hrtimer_restart(&nullb->bw_timer);
  1094. if (atomic_long_sub_return(blk_rq_bytes(rq), &nullb->cur_bytes) < 0) {
  1095. null_stop_queue(nullb);
  1096. /* race with timer */
  1097. if (atomic_long_read(&nullb->cur_bytes) > 0)
  1098. null_restart_queue_async(nullb);
  1099. /* requeue request */
  1100. sts = BLK_STS_DEV_RESOURCE;
  1101. }
  1102. return sts;
  1103. }
  1104. static inline blk_status_t null_handle_badblocks(struct nullb_cmd *cmd,
  1105. sector_t sector,
  1106. sector_t nr_sectors)
  1107. {
  1108. struct badblocks *bb = &cmd->nq->dev->badblocks;
  1109. sector_t first_bad;
  1110. int bad_sectors;
  1111. if (badblocks_check(bb, sector, nr_sectors, &first_bad, &bad_sectors))
  1112. return BLK_STS_IOERR;
  1113. return BLK_STS_OK;
  1114. }
  1115. static inline blk_status_t null_handle_memory_backed(struct nullb_cmd *cmd,
  1116. enum req_op op,
  1117. sector_t sector,
  1118. sector_t nr_sectors)
  1119. {
  1120. struct nullb_device *dev = cmd->nq->dev;
  1121. int err;
  1122. if (op == REQ_OP_DISCARD)
  1123. return null_handle_discard(dev, sector, nr_sectors);
  1124. if (dev->queue_mode == NULL_Q_BIO)
  1125. err = null_handle_bio(cmd);
  1126. else
  1127. err = null_handle_rq(cmd);
  1128. return errno_to_blk_status(err);
  1129. }
  1130. static void nullb_zero_read_cmd_buffer(struct nullb_cmd *cmd)
  1131. {
  1132. struct nullb_device *dev = cmd->nq->dev;
  1133. struct bio *bio;
  1134. if (dev->memory_backed)
  1135. return;
  1136. if (dev->queue_mode == NULL_Q_BIO && bio_op(cmd->bio) == REQ_OP_READ) {
  1137. zero_fill_bio(cmd->bio);
  1138. } else if (req_op(cmd->rq) == REQ_OP_READ) {
  1139. __rq_for_each_bio(bio, cmd->rq)
  1140. zero_fill_bio(bio);
  1141. }
  1142. }
  1143. static inline void nullb_complete_cmd(struct nullb_cmd *cmd)
  1144. {
  1145. /*
  1146. * Since root privileges are required to configure the null_blk
  1147. * driver, it is fine that this driver does not initialize the
  1148. * data buffers of read commands. Zero-initialize these buffers
  1149. * anyway if KMSAN is enabled to prevent that KMSAN complains
  1150. * about null_blk not initializing read data buffers.
  1151. */
  1152. if (IS_ENABLED(CONFIG_KMSAN))
  1153. nullb_zero_read_cmd_buffer(cmd);
  1154. /* Complete IO by inline, softirq or timer */
  1155. switch (cmd->nq->dev->irqmode) {
  1156. case NULL_IRQ_SOFTIRQ:
  1157. switch (cmd->nq->dev->queue_mode) {
  1158. case NULL_Q_MQ:
  1159. blk_mq_complete_request(cmd->rq);
  1160. break;
  1161. case NULL_Q_BIO:
  1162. /*
  1163. * XXX: no proper submitting cpu information available.
  1164. */
  1165. end_cmd(cmd);
  1166. break;
  1167. }
  1168. break;
  1169. case NULL_IRQ_NONE:
  1170. end_cmd(cmd);
  1171. break;
  1172. case NULL_IRQ_TIMER:
  1173. null_cmd_end_timer(cmd);
  1174. break;
  1175. }
  1176. }
  1177. blk_status_t null_process_cmd(struct nullb_cmd *cmd, enum req_op op,
  1178. sector_t sector, unsigned int nr_sectors)
  1179. {
  1180. struct nullb_device *dev = cmd->nq->dev;
  1181. blk_status_t ret;
  1182. if (dev->badblocks.shift != -1) {
  1183. ret = null_handle_badblocks(cmd, sector, nr_sectors);
  1184. if (ret != BLK_STS_OK)
  1185. return ret;
  1186. }
  1187. if (dev->memory_backed)
  1188. return null_handle_memory_backed(cmd, op, sector, nr_sectors);
  1189. return BLK_STS_OK;
  1190. }
  1191. static blk_status_t null_handle_cmd(struct nullb_cmd *cmd, sector_t sector,
  1192. sector_t nr_sectors, enum req_op op)
  1193. {
  1194. struct nullb_device *dev = cmd->nq->dev;
  1195. struct nullb *nullb = dev->nullb;
  1196. blk_status_t sts;
  1197. if (test_bit(NULLB_DEV_FL_THROTTLED, &dev->flags)) {
  1198. sts = null_handle_throttled(cmd);
  1199. if (sts != BLK_STS_OK)
  1200. return sts;
  1201. }
  1202. if (op == REQ_OP_FLUSH) {
  1203. cmd->error = errno_to_blk_status(null_handle_flush(nullb));
  1204. goto out;
  1205. }
  1206. if (dev->zoned)
  1207. sts = null_process_zoned_cmd(cmd, op, sector, nr_sectors);
  1208. else
  1209. sts = null_process_cmd(cmd, op, sector, nr_sectors);
  1210. /* Do not overwrite errors (e.g. timeout errors) */
  1211. if (cmd->error == BLK_STS_OK)
  1212. cmd->error = sts;
  1213. out:
  1214. nullb_complete_cmd(cmd);
  1215. return BLK_STS_OK;
  1216. }
  1217. static enum hrtimer_restart nullb_bwtimer_fn(struct hrtimer *timer)
  1218. {
  1219. struct nullb *nullb = container_of(timer, struct nullb, bw_timer);
  1220. ktime_t timer_interval = ktime_set(0, TIMER_INTERVAL);
  1221. unsigned int mbps = nullb->dev->mbps;
  1222. if (atomic_long_read(&nullb->cur_bytes) == mb_per_tick(mbps))
  1223. return HRTIMER_NORESTART;
  1224. atomic_long_set(&nullb->cur_bytes, mb_per_tick(mbps));
  1225. null_restart_queue_async(nullb);
  1226. hrtimer_forward_now(&nullb->bw_timer, timer_interval);
  1227. return HRTIMER_RESTART;
  1228. }
  1229. static void nullb_setup_bwtimer(struct nullb *nullb)
  1230. {
  1231. ktime_t timer_interval = ktime_set(0, TIMER_INTERVAL);
  1232. hrtimer_init(&nullb->bw_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
  1233. nullb->bw_timer.function = nullb_bwtimer_fn;
  1234. atomic_long_set(&nullb->cur_bytes, mb_per_tick(nullb->dev->mbps));
  1235. hrtimer_start(&nullb->bw_timer, timer_interval, HRTIMER_MODE_REL);
  1236. }
  1237. static struct nullb_queue *nullb_to_queue(struct nullb *nullb)
  1238. {
  1239. int index = 0;
  1240. if (nullb->nr_queues != 1)
  1241. index = raw_smp_processor_id() / ((nr_cpu_ids + nullb->nr_queues - 1) / nullb->nr_queues);
  1242. return &nullb->queues[index];
  1243. }
  1244. static void null_submit_bio(struct bio *bio)
  1245. {
  1246. sector_t sector = bio->bi_iter.bi_sector;
  1247. sector_t nr_sectors = bio_sectors(bio);
  1248. struct nullb *nullb = bio->bi_bdev->bd_disk->private_data;
  1249. struct nullb_queue *nq = nullb_to_queue(nullb);
  1250. null_handle_cmd(alloc_cmd(nq, bio), sector, nr_sectors, bio_op(bio));
  1251. }
  1252. static bool should_timeout_request(struct request *rq)
  1253. {
  1254. #ifdef CONFIG_BLK_DEV_NULL_BLK_FAULT_INJECTION
  1255. if (g_timeout_str[0])
  1256. return should_fail(&null_timeout_attr, 1);
  1257. #endif
  1258. return false;
  1259. }
  1260. static bool should_requeue_request(struct request *rq)
  1261. {
  1262. #ifdef CONFIG_BLK_DEV_NULL_BLK_FAULT_INJECTION
  1263. if (g_requeue_str[0])
  1264. return should_fail(&null_requeue_attr, 1);
  1265. #endif
  1266. return false;
  1267. }
  1268. static void null_map_queues(struct blk_mq_tag_set *set)
  1269. {
  1270. struct nullb *nullb = set->driver_data;
  1271. int i, qoff;
  1272. unsigned int submit_queues = g_submit_queues;
  1273. unsigned int poll_queues = g_poll_queues;
  1274. if (nullb) {
  1275. struct nullb_device *dev = nullb->dev;
  1276. /*
  1277. * Refer nr_hw_queues of the tag set to check if the expected
  1278. * number of hardware queues are prepared. If block layer failed
  1279. * to prepare them, use previous numbers of submit queues and
  1280. * poll queues to map queues.
  1281. */
  1282. if (set->nr_hw_queues ==
  1283. dev->submit_queues + dev->poll_queues) {
  1284. submit_queues = dev->submit_queues;
  1285. poll_queues = dev->poll_queues;
  1286. } else if (set->nr_hw_queues ==
  1287. dev->prev_submit_queues + dev->prev_poll_queues) {
  1288. submit_queues = dev->prev_submit_queues;
  1289. poll_queues = dev->prev_poll_queues;
  1290. } else {
  1291. pr_warn("tag set has unexpected nr_hw_queues: %d\n",
  1292. set->nr_hw_queues);
  1293. WARN_ON_ONCE(true);
  1294. submit_queues = 1;
  1295. poll_queues = 0;
  1296. }
  1297. }
  1298. for (i = 0, qoff = 0; i < set->nr_maps; i++) {
  1299. struct blk_mq_queue_map *map = &set->map[i];
  1300. switch (i) {
  1301. case HCTX_TYPE_DEFAULT:
  1302. map->nr_queues = submit_queues;
  1303. break;
  1304. case HCTX_TYPE_READ:
  1305. map->nr_queues = 0;
  1306. continue;
  1307. case HCTX_TYPE_POLL:
  1308. map->nr_queues = poll_queues;
  1309. break;
  1310. }
  1311. map->queue_offset = qoff;
  1312. qoff += map->nr_queues;
  1313. blk_mq_map_queues(map);
  1314. }
  1315. }
  1316. static int null_poll(struct blk_mq_hw_ctx *hctx, struct io_comp_batch *iob)
  1317. {
  1318. struct nullb_queue *nq = hctx->driver_data;
  1319. LIST_HEAD(list);
  1320. int nr = 0;
  1321. struct request *rq;
  1322. spin_lock(&nq->poll_lock);
  1323. list_splice_init(&nq->poll_list, &list);
  1324. list_for_each_entry(rq, &list, queuelist)
  1325. blk_mq_set_request_complete(rq);
  1326. spin_unlock(&nq->poll_lock);
  1327. while (!list_empty(&list)) {
  1328. struct nullb_cmd *cmd;
  1329. struct request *req;
  1330. req = list_first_entry(&list, struct request, queuelist);
  1331. list_del_init(&req->queuelist);
  1332. cmd = blk_mq_rq_to_pdu(req);
  1333. cmd->error = null_process_cmd(cmd, req_op(req), blk_rq_pos(req),
  1334. blk_rq_sectors(req));
  1335. if (!blk_mq_add_to_batch(req, iob, (__force int) cmd->error,
  1336. blk_mq_end_request_batch))
  1337. end_cmd(cmd);
  1338. nr++;
  1339. }
  1340. return nr;
  1341. }
  1342. static enum blk_eh_timer_return null_timeout_rq(struct request *rq)
  1343. {
  1344. struct blk_mq_hw_ctx *hctx = rq->mq_hctx;
  1345. struct nullb_cmd *cmd = blk_mq_rq_to_pdu(rq);
  1346. if (hctx->type == HCTX_TYPE_POLL) {
  1347. struct nullb_queue *nq = hctx->driver_data;
  1348. spin_lock(&nq->poll_lock);
  1349. /* The request may have completed meanwhile. */
  1350. if (blk_mq_request_completed(rq)) {
  1351. spin_unlock(&nq->poll_lock);
  1352. return BLK_EH_DONE;
  1353. }
  1354. list_del_init(&rq->queuelist);
  1355. spin_unlock(&nq->poll_lock);
  1356. }
  1357. pr_info("rq %p timed out\n", rq);
  1358. /*
  1359. * If the device is marked as blocking (i.e. memory backed or zoned
  1360. * device), the submission path may be blocked waiting for resources
  1361. * and cause real timeouts. For these real timeouts, the submission
  1362. * path will complete the request using blk_mq_complete_request().
  1363. * Only fake timeouts need to execute blk_mq_complete_request() here.
  1364. */
  1365. cmd->error = BLK_STS_TIMEOUT;
  1366. if (cmd->fake_timeout || hctx->type == HCTX_TYPE_POLL)
  1367. blk_mq_complete_request(rq);
  1368. return BLK_EH_DONE;
  1369. }
  1370. static blk_status_t null_queue_rq(struct blk_mq_hw_ctx *hctx,
  1371. const struct blk_mq_queue_data *bd)
  1372. {
  1373. struct nullb_cmd *cmd = blk_mq_rq_to_pdu(bd->rq);
  1374. struct nullb_queue *nq = hctx->driver_data;
  1375. sector_t nr_sectors = blk_rq_sectors(bd->rq);
  1376. sector_t sector = blk_rq_pos(bd->rq);
  1377. const bool is_poll = hctx->type == HCTX_TYPE_POLL;
  1378. might_sleep_if(hctx->flags & BLK_MQ_F_BLOCKING);
  1379. if (!is_poll && nq->dev->irqmode == NULL_IRQ_TIMER) {
  1380. hrtimer_init(&cmd->timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
  1381. cmd->timer.function = null_cmd_timer_expired;
  1382. }
  1383. cmd->rq = bd->rq;
  1384. cmd->error = BLK_STS_OK;
  1385. cmd->nq = nq;
  1386. cmd->fake_timeout = should_timeout_request(bd->rq) ||
  1387. blk_should_fake_timeout(bd->rq->q);
  1388. blk_mq_start_request(bd->rq);
  1389. if (should_requeue_request(bd->rq)) {
  1390. /*
  1391. * Alternate between hitting the core BUSY path, and the
  1392. * driver driven requeue path
  1393. */
  1394. nq->requeue_selection++;
  1395. if (nq->requeue_selection & 1)
  1396. return BLK_STS_RESOURCE;
  1397. else {
  1398. blk_mq_requeue_request(bd->rq, true);
  1399. return BLK_STS_OK;
  1400. }
  1401. }
  1402. if (is_poll) {
  1403. spin_lock(&nq->poll_lock);
  1404. list_add_tail(&bd->rq->queuelist, &nq->poll_list);
  1405. spin_unlock(&nq->poll_lock);
  1406. return BLK_STS_OK;
  1407. }
  1408. if (cmd->fake_timeout)
  1409. return BLK_STS_OK;
  1410. return null_handle_cmd(cmd, sector, nr_sectors, req_op(bd->rq));
  1411. }
  1412. static void cleanup_queue(struct nullb_queue *nq)
  1413. {
  1414. bitmap_free(nq->tag_map);
  1415. kfree(nq->cmds);
  1416. }
  1417. static void cleanup_queues(struct nullb *nullb)
  1418. {
  1419. int i;
  1420. for (i = 0; i < nullb->nr_queues; i++)
  1421. cleanup_queue(&nullb->queues[i]);
  1422. kfree(nullb->queues);
  1423. }
  1424. static void null_exit_hctx(struct blk_mq_hw_ctx *hctx, unsigned int hctx_idx)
  1425. {
  1426. struct nullb_queue *nq = hctx->driver_data;
  1427. struct nullb *nullb = nq->dev->nullb;
  1428. nullb->nr_queues--;
  1429. }
  1430. static void null_init_queue(struct nullb *nullb, struct nullb_queue *nq)
  1431. {
  1432. init_waitqueue_head(&nq->wait);
  1433. nq->queue_depth = nullb->queue_depth;
  1434. nq->dev = nullb->dev;
  1435. INIT_LIST_HEAD(&nq->poll_list);
  1436. spin_lock_init(&nq->poll_lock);
  1437. }
  1438. static int null_init_hctx(struct blk_mq_hw_ctx *hctx, void *driver_data,
  1439. unsigned int hctx_idx)
  1440. {
  1441. struct nullb *nullb = hctx->queue->queuedata;
  1442. struct nullb_queue *nq;
  1443. #ifdef CONFIG_BLK_DEV_NULL_BLK_FAULT_INJECTION
  1444. if (g_init_hctx_str[0] && should_fail(&null_init_hctx_attr, 1))
  1445. return -EFAULT;
  1446. #endif
  1447. nq = &nullb->queues[hctx_idx];
  1448. hctx->driver_data = nq;
  1449. null_init_queue(nullb, nq);
  1450. nullb->nr_queues++;
  1451. return 0;
  1452. }
  1453. static const struct blk_mq_ops null_mq_ops = {
  1454. .queue_rq = null_queue_rq,
  1455. .complete = null_complete_rq,
  1456. .timeout = null_timeout_rq,
  1457. .poll = null_poll,
  1458. .map_queues = null_map_queues,
  1459. .init_hctx = null_init_hctx,
  1460. .exit_hctx = null_exit_hctx,
  1461. };
  1462. static void null_del_dev(struct nullb *nullb)
  1463. {
  1464. struct nullb_device *dev;
  1465. if (!nullb)
  1466. return;
  1467. dev = nullb->dev;
  1468. ida_simple_remove(&nullb_indexes, nullb->index);
  1469. list_del_init(&nullb->list);
  1470. del_gendisk(nullb->disk);
  1471. if (test_bit(NULLB_DEV_FL_THROTTLED, &nullb->dev->flags)) {
  1472. hrtimer_cancel(&nullb->bw_timer);
  1473. atomic_long_set(&nullb->cur_bytes, LONG_MAX);
  1474. null_restart_queue_async(nullb);
  1475. }
  1476. put_disk(nullb->disk);
  1477. if (dev->queue_mode == NULL_Q_MQ &&
  1478. nullb->tag_set == &nullb->__tag_set)
  1479. blk_mq_free_tag_set(nullb->tag_set);
  1480. cleanup_queues(nullb);
  1481. if (null_cache_active(nullb))
  1482. null_free_device_storage(nullb->dev, true);
  1483. kfree(nullb);
  1484. dev->nullb = NULL;
  1485. }
  1486. static void null_config_discard(struct nullb *nullb)
  1487. {
  1488. if (nullb->dev->discard == false)
  1489. return;
  1490. if (!nullb->dev->memory_backed) {
  1491. nullb->dev->discard = false;
  1492. pr_info("discard option is ignored without memory backing\n");
  1493. return;
  1494. }
  1495. if (nullb->dev->zoned) {
  1496. nullb->dev->discard = false;
  1497. pr_info("discard option is ignored in zoned mode\n");
  1498. return;
  1499. }
  1500. nullb->q->limits.discard_granularity = nullb->dev->blocksize;
  1501. blk_queue_max_discard_sectors(nullb->q, UINT_MAX >> 9);
  1502. }
  1503. static const struct block_device_operations null_bio_ops = {
  1504. .owner = THIS_MODULE,
  1505. .submit_bio = null_submit_bio,
  1506. .report_zones = null_report_zones,
  1507. };
  1508. static const struct block_device_operations null_rq_ops = {
  1509. .owner = THIS_MODULE,
  1510. .report_zones = null_report_zones,
  1511. };
  1512. static int setup_commands(struct nullb_queue *nq)
  1513. {
  1514. struct nullb_cmd *cmd;
  1515. int i;
  1516. nq->cmds = kcalloc(nq->queue_depth, sizeof(*cmd), GFP_KERNEL);
  1517. if (!nq->cmds)
  1518. return -ENOMEM;
  1519. nq->tag_map = bitmap_zalloc(nq->queue_depth, GFP_KERNEL);
  1520. if (!nq->tag_map) {
  1521. kfree(nq->cmds);
  1522. return -ENOMEM;
  1523. }
  1524. for (i = 0; i < nq->queue_depth; i++) {
  1525. cmd = &nq->cmds[i];
  1526. cmd->tag = -1U;
  1527. }
  1528. return 0;
  1529. }
  1530. static int setup_queues(struct nullb *nullb)
  1531. {
  1532. int nqueues = nr_cpu_ids;
  1533. if (g_poll_queues)
  1534. nqueues += g_poll_queues;
  1535. nullb->queues = kcalloc(nqueues, sizeof(struct nullb_queue),
  1536. GFP_KERNEL);
  1537. if (!nullb->queues)
  1538. return -ENOMEM;
  1539. nullb->queue_depth = nullb->dev->hw_queue_depth;
  1540. return 0;
  1541. }
  1542. static int init_driver_queues(struct nullb *nullb)
  1543. {
  1544. struct nullb_queue *nq;
  1545. int i, ret = 0;
  1546. for (i = 0; i < nullb->dev->submit_queues; i++) {
  1547. nq = &nullb->queues[i];
  1548. null_init_queue(nullb, nq);
  1549. ret = setup_commands(nq);
  1550. if (ret)
  1551. return ret;
  1552. nullb->nr_queues++;
  1553. }
  1554. return 0;
  1555. }
  1556. static int null_gendisk_register(struct nullb *nullb)
  1557. {
  1558. sector_t size = ((sector_t)nullb->dev->size * SZ_1M) >> SECTOR_SHIFT;
  1559. struct gendisk *disk = nullb->disk;
  1560. set_capacity(disk, size);
  1561. disk->major = null_major;
  1562. disk->first_minor = nullb->index;
  1563. disk->minors = 1;
  1564. if (queue_is_mq(nullb->q))
  1565. disk->fops = &null_rq_ops;
  1566. else
  1567. disk->fops = &null_bio_ops;
  1568. disk->private_data = nullb;
  1569. strncpy(disk->disk_name, nullb->disk_name, DISK_NAME_LEN);
  1570. if (nullb->dev->zoned) {
  1571. int ret = null_register_zoned_dev(nullb);
  1572. if (ret)
  1573. return ret;
  1574. }
  1575. return add_disk(disk);
  1576. }
  1577. static int null_init_tag_set(struct nullb *nullb, struct blk_mq_tag_set *set)
  1578. {
  1579. unsigned int flags = BLK_MQ_F_SHOULD_MERGE;
  1580. int hw_queues, numa_node;
  1581. unsigned int queue_depth;
  1582. int poll_queues;
  1583. if (nullb) {
  1584. hw_queues = nullb->dev->submit_queues;
  1585. poll_queues = nullb->dev->poll_queues;
  1586. queue_depth = nullb->dev->hw_queue_depth;
  1587. numa_node = nullb->dev->home_node;
  1588. if (nullb->dev->no_sched)
  1589. flags |= BLK_MQ_F_NO_SCHED;
  1590. if (nullb->dev->shared_tag_bitmap)
  1591. flags |= BLK_MQ_F_TAG_HCTX_SHARED;
  1592. if (nullb->dev->blocking)
  1593. flags |= BLK_MQ_F_BLOCKING;
  1594. } else {
  1595. hw_queues = g_submit_queues;
  1596. poll_queues = g_poll_queues;
  1597. queue_depth = g_hw_queue_depth;
  1598. numa_node = g_home_node;
  1599. if (g_no_sched)
  1600. flags |= BLK_MQ_F_NO_SCHED;
  1601. if (g_shared_tag_bitmap)
  1602. flags |= BLK_MQ_F_TAG_HCTX_SHARED;
  1603. if (g_blocking)
  1604. flags |= BLK_MQ_F_BLOCKING;
  1605. }
  1606. set->ops = &null_mq_ops;
  1607. set->cmd_size = sizeof(struct nullb_cmd);
  1608. set->flags = flags;
  1609. set->driver_data = nullb;
  1610. set->nr_hw_queues = hw_queues;
  1611. set->queue_depth = queue_depth;
  1612. set->numa_node = numa_node;
  1613. if (poll_queues) {
  1614. set->nr_hw_queues += poll_queues;
  1615. set->nr_maps = 3;
  1616. } else {
  1617. set->nr_maps = 1;
  1618. }
  1619. return blk_mq_alloc_tag_set(set);
  1620. }
  1621. static int null_validate_conf(struct nullb_device *dev)
  1622. {
  1623. if (dev->queue_mode == NULL_Q_RQ) {
  1624. pr_err("legacy IO path is no longer available\n");
  1625. return -EINVAL;
  1626. }
  1627. dev->blocksize = round_down(dev->blocksize, 512);
  1628. dev->blocksize = clamp_t(unsigned int, dev->blocksize, 512, 4096);
  1629. if (dev->queue_mode == NULL_Q_MQ && dev->use_per_node_hctx) {
  1630. if (dev->submit_queues != nr_online_nodes)
  1631. dev->submit_queues = nr_online_nodes;
  1632. } else if (dev->submit_queues > nr_cpu_ids)
  1633. dev->submit_queues = nr_cpu_ids;
  1634. else if (dev->submit_queues == 0)
  1635. dev->submit_queues = 1;
  1636. dev->prev_submit_queues = dev->submit_queues;
  1637. if (dev->poll_queues > g_poll_queues)
  1638. dev->poll_queues = g_poll_queues;
  1639. dev->prev_poll_queues = dev->poll_queues;
  1640. dev->queue_mode = min_t(unsigned int, dev->queue_mode, NULL_Q_MQ);
  1641. dev->irqmode = min_t(unsigned int, dev->irqmode, NULL_IRQ_TIMER);
  1642. /* Do memory allocation, so set blocking */
  1643. if (dev->memory_backed)
  1644. dev->blocking = true;
  1645. else /* cache is meaningless */
  1646. dev->cache_size = 0;
  1647. dev->cache_size = min_t(unsigned long, ULONG_MAX / 1024 / 1024,
  1648. dev->cache_size);
  1649. dev->mbps = min_t(unsigned int, 1024 * 40, dev->mbps);
  1650. /* can not stop a queue */
  1651. if (dev->queue_mode == NULL_Q_BIO)
  1652. dev->mbps = 0;
  1653. if (dev->zoned &&
  1654. (!dev->zone_size || !is_power_of_2(dev->zone_size))) {
  1655. pr_err("zone_size must be power-of-two\n");
  1656. return -EINVAL;
  1657. }
  1658. return 0;
  1659. }
  1660. #ifdef CONFIG_BLK_DEV_NULL_BLK_FAULT_INJECTION
  1661. static bool __null_setup_fault(struct fault_attr *attr, char *str)
  1662. {
  1663. if (!str[0])
  1664. return true;
  1665. if (!setup_fault_attr(attr, str))
  1666. return false;
  1667. attr->verbose = 0;
  1668. return true;
  1669. }
  1670. #endif
  1671. static bool null_setup_fault(void)
  1672. {
  1673. #ifdef CONFIG_BLK_DEV_NULL_BLK_FAULT_INJECTION
  1674. if (!__null_setup_fault(&null_timeout_attr, g_timeout_str))
  1675. return false;
  1676. if (!__null_setup_fault(&null_requeue_attr, g_requeue_str))
  1677. return false;
  1678. if (!__null_setup_fault(&null_init_hctx_attr, g_init_hctx_str))
  1679. return false;
  1680. #endif
  1681. return true;
  1682. }
  1683. static int null_add_dev(struct nullb_device *dev)
  1684. {
  1685. struct nullb *nullb;
  1686. int rv;
  1687. rv = null_validate_conf(dev);
  1688. if (rv)
  1689. return rv;
  1690. nullb = kzalloc_node(sizeof(*nullb), GFP_KERNEL, dev->home_node);
  1691. if (!nullb) {
  1692. rv = -ENOMEM;
  1693. goto out;
  1694. }
  1695. nullb->dev = dev;
  1696. dev->nullb = nullb;
  1697. spin_lock_init(&nullb->lock);
  1698. rv = setup_queues(nullb);
  1699. if (rv)
  1700. goto out_free_nullb;
  1701. if (dev->queue_mode == NULL_Q_MQ) {
  1702. if (shared_tags) {
  1703. nullb->tag_set = &tag_set;
  1704. rv = 0;
  1705. } else {
  1706. nullb->tag_set = &nullb->__tag_set;
  1707. rv = null_init_tag_set(nullb, nullb->tag_set);
  1708. }
  1709. if (rv)
  1710. goto out_cleanup_queues;
  1711. if (!null_setup_fault())
  1712. goto out_cleanup_tags;
  1713. nullb->tag_set->timeout = 5 * HZ;
  1714. nullb->disk = blk_mq_alloc_disk(nullb->tag_set, nullb);
  1715. if (IS_ERR(nullb->disk)) {
  1716. rv = PTR_ERR(nullb->disk);
  1717. goto out_cleanup_tags;
  1718. }
  1719. nullb->q = nullb->disk->queue;
  1720. } else if (dev->queue_mode == NULL_Q_BIO) {
  1721. rv = -ENOMEM;
  1722. nullb->disk = blk_alloc_disk(nullb->dev->home_node);
  1723. if (!nullb->disk)
  1724. goto out_cleanup_queues;
  1725. nullb->q = nullb->disk->queue;
  1726. rv = init_driver_queues(nullb);
  1727. if (rv)
  1728. goto out_cleanup_disk;
  1729. }
  1730. if (dev->mbps) {
  1731. set_bit(NULLB_DEV_FL_THROTTLED, &dev->flags);
  1732. nullb_setup_bwtimer(nullb);
  1733. }
  1734. if (dev->cache_size > 0) {
  1735. set_bit(NULLB_DEV_FL_CACHE, &nullb->dev->flags);
  1736. blk_queue_write_cache(nullb->q, true, true);
  1737. }
  1738. if (dev->zoned) {
  1739. rv = null_init_zoned_dev(dev, nullb->q);
  1740. if (rv)
  1741. goto out_cleanup_disk;
  1742. }
  1743. nullb->q->queuedata = nullb;
  1744. blk_queue_flag_set(QUEUE_FLAG_NONROT, nullb->q);
  1745. blk_queue_flag_clear(QUEUE_FLAG_ADD_RANDOM, nullb->q);
  1746. mutex_lock(&lock);
  1747. rv = ida_simple_get(&nullb_indexes, 0, 0, GFP_KERNEL);
  1748. if (rv < 0) {
  1749. mutex_unlock(&lock);
  1750. goto out_cleanup_zone;
  1751. }
  1752. nullb->index = rv;
  1753. dev->index = rv;
  1754. mutex_unlock(&lock);
  1755. blk_queue_logical_block_size(nullb->q, dev->blocksize);
  1756. blk_queue_physical_block_size(nullb->q, dev->blocksize);
  1757. if (!dev->max_sectors)
  1758. dev->max_sectors = queue_max_hw_sectors(nullb->q);
  1759. dev->max_sectors = min_t(unsigned int, dev->max_sectors,
  1760. BLK_DEF_MAX_SECTORS);
  1761. blk_queue_max_hw_sectors(nullb->q, dev->max_sectors);
  1762. if (dev->virt_boundary)
  1763. blk_queue_virt_boundary(nullb->q, PAGE_SIZE - 1);
  1764. null_config_discard(nullb);
  1765. if (config_item_name(&dev->item)) {
  1766. /* Use configfs dir name as the device name */
  1767. snprintf(nullb->disk_name, sizeof(nullb->disk_name),
  1768. "%s", config_item_name(&dev->item));
  1769. } else {
  1770. sprintf(nullb->disk_name, "nullb%d", nullb->index);
  1771. }
  1772. rv = null_gendisk_register(nullb);
  1773. if (rv)
  1774. goto out_ida_free;
  1775. mutex_lock(&lock);
  1776. list_add_tail(&nullb->list, &nullb_list);
  1777. mutex_unlock(&lock);
  1778. pr_info("disk %s created\n", nullb->disk_name);
  1779. return 0;
  1780. out_ida_free:
  1781. ida_free(&nullb_indexes, nullb->index);
  1782. out_cleanup_zone:
  1783. null_free_zoned_dev(dev);
  1784. out_cleanup_disk:
  1785. put_disk(nullb->disk);
  1786. out_cleanup_tags:
  1787. if (dev->queue_mode == NULL_Q_MQ && nullb->tag_set == &nullb->__tag_set)
  1788. blk_mq_free_tag_set(nullb->tag_set);
  1789. out_cleanup_queues:
  1790. cleanup_queues(nullb);
  1791. out_free_nullb:
  1792. kfree(nullb);
  1793. dev->nullb = NULL;
  1794. out:
  1795. return rv;
  1796. }
  1797. static struct nullb *null_find_dev_by_name(const char *name)
  1798. {
  1799. struct nullb *nullb = NULL, *nb;
  1800. mutex_lock(&lock);
  1801. list_for_each_entry(nb, &nullb_list, list) {
  1802. if (strcmp(nb->disk_name, name) == 0) {
  1803. nullb = nb;
  1804. break;
  1805. }
  1806. }
  1807. mutex_unlock(&lock);
  1808. return nullb;
  1809. }
  1810. static int null_create_dev(void)
  1811. {
  1812. struct nullb_device *dev;
  1813. int ret;
  1814. dev = null_alloc_dev();
  1815. if (!dev)
  1816. return -ENOMEM;
  1817. ret = null_add_dev(dev);
  1818. if (ret) {
  1819. null_free_dev(dev);
  1820. return ret;
  1821. }
  1822. return 0;
  1823. }
  1824. static void null_destroy_dev(struct nullb *nullb)
  1825. {
  1826. struct nullb_device *dev = nullb->dev;
  1827. null_del_dev(nullb);
  1828. null_free_device_storage(dev, false);
  1829. null_free_dev(dev);
  1830. }
  1831. static int __init null_init(void)
  1832. {
  1833. int ret = 0;
  1834. unsigned int i;
  1835. struct nullb *nullb;
  1836. if (g_bs > PAGE_SIZE) {
  1837. pr_warn("invalid block size\n");
  1838. pr_warn("defaults block size to %lu\n", PAGE_SIZE);
  1839. g_bs = PAGE_SIZE;
  1840. }
  1841. if (g_max_sectors > BLK_DEF_MAX_SECTORS) {
  1842. pr_warn("invalid max sectors\n");
  1843. pr_warn("defaults max sectors to %u\n", BLK_DEF_MAX_SECTORS);
  1844. g_max_sectors = BLK_DEF_MAX_SECTORS;
  1845. }
  1846. if (g_home_node != NUMA_NO_NODE && g_home_node >= nr_online_nodes) {
  1847. pr_err("invalid home_node value\n");
  1848. g_home_node = NUMA_NO_NODE;
  1849. }
  1850. if (g_queue_mode == NULL_Q_RQ) {
  1851. pr_err("legacy IO path is no longer available\n");
  1852. return -EINVAL;
  1853. }
  1854. if (g_queue_mode == NULL_Q_MQ && g_use_per_node_hctx) {
  1855. if (g_submit_queues != nr_online_nodes) {
  1856. pr_warn("submit_queues param is set to %u.\n",
  1857. nr_online_nodes);
  1858. g_submit_queues = nr_online_nodes;
  1859. }
  1860. } else if (g_submit_queues > nr_cpu_ids) {
  1861. g_submit_queues = nr_cpu_ids;
  1862. } else if (g_submit_queues <= 0) {
  1863. g_submit_queues = 1;
  1864. }
  1865. if (g_queue_mode == NULL_Q_MQ && shared_tags) {
  1866. ret = null_init_tag_set(NULL, &tag_set);
  1867. if (ret)
  1868. return ret;
  1869. }
  1870. config_group_init(&nullb_subsys.su_group);
  1871. mutex_init(&nullb_subsys.su_mutex);
  1872. ret = configfs_register_subsystem(&nullb_subsys);
  1873. if (ret)
  1874. goto err_tagset;
  1875. mutex_init(&lock);
  1876. null_major = register_blkdev(0, "nullb");
  1877. if (null_major < 0) {
  1878. ret = null_major;
  1879. goto err_conf;
  1880. }
  1881. for (i = 0; i < nr_devices; i++) {
  1882. ret = null_create_dev();
  1883. if (ret)
  1884. goto err_dev;
  1885. }
  1886. pr_info("module loaded\n");
  1887. return 0;
  1888. err_dev:
  1889. while (!list_empty(&nullb_list)) {
  1890. nullb = list_entry(nullb_list.next, struct nullb, list);
  1891. null_destroy_dev(nullb);
  1892. }
  1893. unregister_blkdev(null_major, "nullb");
  1894. err_conf:
  1895. configfs_unregister_subsystem(&nullb_subsys);
  1896. err_tagset:
  1897. if (g_queue_mode == NULL_Q_MQ && shared_tags)
  1898. blk_mq_free_tag_set(&tag_set);
  1899. return ret;
  1900. }
  1901. static void __exit null_exit(void)
  1902. {
  1903. struct nullb *nullb;
  1904. configfs_unregister_subsystem(&nullb_subsys);
  1905. unregister_blkdev(null_major, "nullb");
  1906. mutex_lock(&lock);
  1907. while (!list_empty(&nullb_list)) {
  1908. nullb = list_entry(nullb_list.next, struct nullb, list);
  1909. null_destroy_dev(nullb);
  1910. }
  1911. mutex_unlock(&lock);
  1912. if (g_queue_mode == NULL_Q_MQ && shared_tags)
  1913. blk_mq_free_tag_set(&tag_set);
  1914. }
  1915. module_init(null_init);
  1916. module_exit(null_exit);
  1917. MODULE_AUTHOR("Jens Axboe <[email protected]>");
  1918. MODULE_LICENSE("GPL");