1 /* 2 * Copyright (C) 2020 Red Hat GmbH 3 * 4 * This file is released under the GPL. 5 * 6 * Device-mapper target to emulate smaller logical block 7 * size on backing devices exposing (natively) larger ones. 8 * 9 * E.g. 512 byte sector emulation on 4K native disks. 10 */ 11 12 #include "dm.h" 13 #include <linux/module.h> 14 #include <linux/workqueue.h> 15 #include <linux/dm-bufio.h> 16 17 #define DM_MSG_PREFIX "ebs" 18 19 static void ebs_dtr(struct dm_target *ti); 20 21 /* Emulated block size context. */ 22 struct ebs_c { 23 struct dm_dev *dev; /* Underlying device to emulate block size on. */ 24 struct dm_bufio_client *bufio; /* Use dm-bufio for read and read-modify-write processing. */ 25 struct workqueue_struct *wq; /* Workqueue for ^ processing of bios. */ 26 struct work_struct ws; /* Work item used for ^. */ 27 struct bio_list bios_in; /* Worker bios input list. */ 28 spinlock_t lock; /* Guard bios input list above. */ 29 sector_t start; /* <start> table line argument, see ebs_ctr below. */ 30 unsigned int e_bs; /* Emulated block size in sectors exposed to upper layer. */ 31 unsigned int u_bs; /* Underlying block size in sectors retrieved from/set on lower layer device. */ 32 unsigned char block_shift; /* bitshift sectors -> blocks used in dm-bufio API. */ 33 bool u_bs_set:1; /* Flag to indicate underlying block size is set on table line. */ 34 }; 35 36 static inline sector_t __sector_to_block(struct ebs_c *ec, sector_t sector) 37 { 38 return sector >> ec->block_shift; 39 } 40 41 static inline sector_t __block_mod(sector_t sector, unsigned int bs) 42 { 43 return sector & (bs - 1); 44 } 45 46 /* Return number of blocks for a bio, accounting for misalignment of start and end sectors. */ 47 static inline unsigned int __nr_blocks(struct ebs_c *ec, struct bio *bio) 48 { 49 sector_t end_sector = __block_mod(bio->bi_iter.bi_sector, ec->u_bs) + bio_sectors(bio); 50 51 return __sector_to_block(ec, end_sector) + (__block_mod(end_sector, ec->u_bs) ? 1 : 0); 52 } 53 54 static inline bool __ebs_check_bs(unsigned int bs) 55 { 56 return bs && is_power_of_2(bs); 57 } 58 59 /* 60 * READ/WRITE: 61 * 62 * copy blocks between bufio blocks and bio vector's (partial/overlapping) pages. 63 */ 64 static int __ebs_rw_bvec(struct ebs_c *ec, enum req_op op, struct bio_vec *bv, 65 struct bvec_iter *iter) 66 { 67 int r = 0; 68 unsigned char *ba, *pa; 69 unsigned int cur_len; 70 unsigned int bv_len = bv->bv_len; 71 unsigned int buf_off = to_bytes(__block_mod(iter->bi_sector, ec->u_bs)); 72 sector_t block = __sector_to_block(ec, iter->bi_sector); 73 struct dm_buffer *b; 74 75 if (unlikely(!bv->bv_page || !bv_len)) 76 return -EIO; 77 78 pa = bvec_virt(bv); 79 80 /* Handle overlapping page <-> blocks */ 81 while (bv_len) { 82 cur_len = min(dm_bufio_get_block_size(ec->bufio) - buf_off, bv_len); 83 84 /* Avoid reading for writes in case bio vector's page overwrites block completely. */ 85 if (op == REQ_OP_READ || buf_off || bv_len < dm_bufio_get_block_size(ec->bufio)) 86 ba = dm_bufio_read(ec->bufio, block, &b); 87 else 88 ba = dm_bufio_new(ec->bufio, block, &b); 89 90 if (IS_ERR(ba)) { 91 /* 92 * Carry on with next buffer, if any, to issue all possible 93 * data but return error. 94 */ 95 r = PTR_ERR(ba); 96 } else { 97 /* Copy data to/from bio to buffer if read/new was successful above. */ 98 ba += buf_off; 99 if (op == REQ_OP_READ) { 100 memcpy(pa, ba, cur_len); 101 flush_dcache_page(bv->bv_page); 102 } else { 103 flush_dcache_page(bv->bv_page); 104 memcpy(ba, pa, cur_len); 105 dm_bufio_mark_partial_buffer_dirty(b, buf_off, buf_off + cur_len); 106 } 107 108 dm_bufio_release(b); 109 } 110 111 pa += cur_len; 112 bv_len -= cur_len; 113 buf_off = 0; 114 block++; 115 } 116 117 return r; 118 } 119 120 /* READ/WRITE: iterate bio vector's copying between (partial) pages and bufio blocks. */ 121 static int __ebs_rw_bio(struct ebs_c *ec, enum req_op op, struct bio *bio) 122 { 123 int r = 0, rr; 124 struct bio_vec bv; 125 struct bvec_iter iter; 126 127 bio_for_each_bvec(bv, bio, iter) { 128 rr = __ebs_rw_bvec(ec, op, &bv, &iter); 129 if (rr) 130 r = rr; 131 } 132 133 return r; 134 } 135 136 /* 137 * Discard bio's blocks, i.e. pass discards down. 138 * 139 * Avoid discarding partial blocks at beginning and end; 140 * return 0 in case no blocks can be discarded as a result. 141 */ 142 static int __ebs_discard_bio(struct ebs_c *ec, struct bio *bio) 143 { 144 sector_t block, blocks, sector = bio->bi_iter.bi_sector; 145 146 block = __sector_to_block(ec, sector); 147 blocks = __nr_blocks(ec, bio); 148 149 /* 150 * Partial first underlying block (__nr_blocks() may have 151 * resulted in one block). 152 */ 153 if (__block_mod(sector, ec->u_bs)) { 154 block++; 155 blocks--; 156 } 157 158 /* Partial last underlying block if any. */ 159 if (blocks && __block_mod(bio_end_sector(bio), ec->u_bs)) 160 blocks--; 161 162 return blocks ? dm_bufio_issue_discard(ec->bufio, block, blocks) : 0; 163 } 164 165 /* Release blocks them from the bufio cache. */ 166 static void __ebs_forget_bio(struct ebs_c *ec, struct bio *bio) 167 { 168 sector_t blocks, sector = bio->bi_iter.bi_sector; 169 170 blocks = __nr_blocks(ec, bio); 171 172 dm_bufio_forget_buffers(ec->bufio, __sector_to_block(ec, sector), blocks); 173 } 174 175 /* Worker function to process incoming bios. */ 176 static void __ebs_process_bios(struct work_struct *ws) 177 { 178 int r; 179 bool write = false; 180 sector_t block1, block2; 181 struct ebs_c *ec = container_of(ws, struct ebs_c, ws); 182 struct bio *bio; 183 struct bio_list bios; 184 185 bio_list_init(&bios); 186 187 spin_lock_irq(&ec->lock); 188 bios = ec->bios_in; 189 bio_list_init(&ec->bios_in); 190 spin_unlock_irq(&ec->lock); 191 192 /* Prefetch all read and any mis-aligned write buffers */ 193 bio_list_for_each(bio, &bios) { 194 block1 = __sector_to_block(ec, bio->bi_iter.bi_sector); 195 if (bio_op(bio) == REQ_OP_READ) 196 dm_bufio_prefetch(ec->bufio, block1, __nr_blocks(ec, bio)); 197 else if (bio_op(bio) == REQ_OP_WRITE && !(bio->bi_opf & REQ_PREFLUSH)) { 198 block2 = __sector_to_block(ec, bio_end_sector(bio)); 199 if (__block_mod(bio->bi_iter.bi_sector, ec->u_bs)) 200 dm_bufio_prefetch(ec->bufio, block1, 1); 201 if (__block_mod(bio_end_sector(bio), ec->u_bs) && block2 != block1) 202 dm_bufio_prefetch(ec->bufio, block2, 1); 203 } 204 } 205 206 bio_list_for_each(bio, &bios) { 207 r = -EIO; 208 if (bio_op(bio) == REQ_OP_READ) 209 r = __ebs_rw_bio(ec, REQ_OP_READ, bio); 210 else if (bio_op(bio) == REQ_OP_WRITE) { 211 write = true; 212 r = __ebs_rw_bio(ec, REQ_OP_WRITE, bio); 213 } else if (bio_op(bio) == REQ_OP_DISCARD) { 214 __ebs_forget_bio(ec, bio); 215 r = __ebs_discard_bio(ec, bio); 216 } 217 218 if (r < 0) 219 bio->bi_status = errno_to_blk_status(r); 220 } 221 222 /* 223 * We write dirty buffers after processing I/O on them 224 * but before we endio thus addressing REQ_FUA/REQ_SYNC. 225 */ 226 r = write ? dm_bufio_write_dirty_buffers(ec->bufio) : 0; 227 228 while ((bio = bio_list_pop(&bios))) { 229 /* Any other request is endioed. */ 230 if (unlikely(r && bio_op(bio) == REQ_OP_WRITE)) 231 bio_io_error(bio); 232 else 233 bio_endio(bio); 234 } 235 } 236 237 /* 238 * Construct an emulated block size mapping: <dev_path> <offset> <ebs> [<ubs>] 239 * 240 * <dev_path>: path of the underlying device 241 * <offset>: offset in 512 bytes sectors into <dev_path> 242 * <ebs>: emulated block size in units of 512 bytes exposed to the upper layer 243 * [<ubs>]: underlying block size in units of 512 bytes imposed on the lower layer; 244 * optional, if not supplied, retrieve logical block size from underlying device 245 */ 246 static int ebs_ctr(struct dm_target *ti, unsigned int argc, char **argv) 247 { 248 int r; 249 unsigned short tmp1; 250 unsigned long long tmp; 251 char dummy; 252 struct ebs_c *ec; 253 254 if (argc < 3 || argc > 4) { 255 ti->error = "Invalid argument count"; 256 return -EINVAL; 257 } 258 259 ec = ti->private = kzalloc(sizeof(*ec), GFP_KERNEL); 260 if (!ec) { 261 ti->error = "Cannot allocate ebs context"; 262 return -ENOMEM; 263 } 264 265 r = -EINVAL; 266 if (sscanf(argv[1], "%llu%c", &tmp, &dummy) != 1 || 267 tmp != (sector_t)tmp || 268 (sector_t)tmp >= ti->len) { 269 ti->error = "Invalid device offset sector"; 270 goto bad; 271 } 272 ec->start = tmp; 273 274 if (sscanf(argv[2], "%hu%c", &tmp1, &dummy) != 1 || 275 !__ebs_check_bs(tmp1) || 276 to_bytes(tmp1) > PAGE_SIZE) { 277 ti->error = "Invalid emulated block size"; 278 goto bad; 279 } 280 ec->e_bs = tmp1; 281 282 if (argc > 3) { 283 if (sscanf(argv[3], "%hu%c", &tmp1, &dummy) != 1 || !__ebs_check_bs(tmp1)) { 284 ti->error = "Invalid underlying block size"; 285 goto bad; 286 } 287 ec->u_bs = tmp1; 288 ec->u_bs_set = true; 289 } else 290 ec->u_bs_set = false; 291 292 r = dm_get_device(ti, argv[0], dm_table_get_mode(ti->table), &ec->dev); 293 if (r) { 294 ti->error = "Device lookup failed"; 295 ec->dev = NULL; 296 goto bad; 297 } 298 299 r = -EINVAL; 300 if (!ec->u_bs_set) { 301 ec->u_bs = to_sector(bdev_logical_block_size(ec->dev->bdev)); 302 if (!__ebs_check_bs(ec->u_bs)) { 303 ti->error = "Invalid retrieved underlying block size"; 304 goto bad; 305 } 306 } 307 308 if (!ec->u_bs_set && ec->e_bs == ec->u_bs) 309 DMINFO("Emulation superfluous: emulated equal to underlying block size"); 310 311 if (__block_mod(ec->start, ec->u_bs)) { 312 ti->error = "Device offset must be multiple of underlying block size"; 313 goto bad; 314 } 315 316 ec->bufio = dm_bufio_client_create(ec->dev->bdev, to_bytes(ec->u_bs), 1, 0, NULL, NULL); 317 if (IS_ERR(ec->bufio)) { 318 ti->error = "Cannot create dm bufio client"; 319 r = PTR_ERR(ec->bufio); 320 ec->bufio = NULL; 321 goto bad; 322 } 323 324 ec->wq = alloc_ordered_workqueue("dm-" DM_MSG_PREFIX, WQ_MEM_RECLAIM); 325 if (!ec->wq) { 326 ti->error = "Cannot create dm-" DM_MSG_PREFIX " workqueue"; 327 r = -ENOMEM; 328 goto bad; 329 } 330 331 ec->block_shift = __ffs(ec->u_bs); 332 INIT_WORK(&ec->ws, &__ebs_process_bios); 333 bio_list_init(&ec->bios_in); 334 spin_lock_init(&ec->lock); 335 336 ti->num_flush_bios = 1; 337 ti->num_discard_bios = 1; 338 ti->num_secure_erase_bios = 0; 339 ti->num_write_zeroes_bios = 0; 340 return 0; 341 bad: 342 ebs_dtr(ti); 343 return r; 344 } 345 346 static void ebs_dtr(struct dm_target *ti) 347 { 348 struct ebs_c *ec = ti->private; 349 350 if (ec->wq) 351 destroy_workqueue(ec->wq); 352 if (ec->bufio) 353 dm_bufio_client_destroy(ec->bufio); 354 if (ec->dev) 355 dm_put_device(ti, ec->dev); 356 kfree(ec); 357 } 358 359 static int ebs_map(struct dm_target *ti, struct bio *bio) 360 { 361 struct ebs_c *ec = ti->private; 362 363 bio_set_dev(bio, ec->dev->bdev); 364 bio->bi_iter.bi_sector = ec->start + dm_target_offset(ti, bio->bi_iter.bi_sector); 365 366 if (unlikely(bio_op(bio) == REQ_OP_FLUSH)) 367 return DM_MAPIO_REMAPPED; 368 /* 369 * Only queue for bufio processing in case of partial or overlapping buffers 370 * -or- 371 * emulation with ebs == ubs aiming for tests of dm-bufio overhead. 372 */ 373 if (likely(__block_mod(bio->bi_iter.bi_sector, ec->u_bs) || 374 __block_mod(bio_end_sector(bio), ec->u_bs) || 375 ec->e_bs == ec->u_bs)) { 376 spin_lock_irq(&ec->lock); 377 bio_list_add(&ec->bios_in, bio); 378 spin_unlock_irq(&ec->lock); 379 380 queue_work(ec->wq, &ec->ws); 381 382 return DM_MAPIO_SUBMITTED; 383 } 384 385 /* Forget any buffer content relative to this direct backing device I/O. */ 386 __ebs_forget_bio(ec, bio); 387 388 return DM_MAPIO_REMAPPED; 389 } 390 391 static void ebs_status(struct dm_target *ti, status_type_t type, 392 unsigned status_flags, char *result, unsigned maxlen) 393 { 394 struct ebs_c *ec = ti->private; 395 396 switch (type) { 397 case STATUSTYPE_INFO: 398 *result = '\0'; 399 break; 400 case STATUSTYPE_TABLE: 401 snprintf(result, maxlen, ec->u_bs_set ? "%s %llu %u %u" : "%s %llu %u", 402 ec->dev->name, (unsigned long long) ec->start, ec->e_bs, ec->u_bs); 403 break; 404 case STATUSTYPE_IMA: 405 *result = '\0'; 406 break; 407 } 408 } 409 410 static int ebs_prepare_ioctl(struct dm_target *ti, struct block_device **bdev) 411 { 412 struct ebs_c *ec = ti->private; 413 struct dm_dev *dev = ec->dev; 414 415 /* 416 * Only pass ioctls through if the device sizes match exactly. 417 */ 418 *bdev = dev->bdev; 419 return !!(ec->start || ti->len != bdev_nr_sectors(dev->bdev)); 420 } 421 422 static void ebs_io_hints(struct dm_target *ti, struct queue_limits *limits) 423 { 424 struct ebs_c *ec = ti->private; 425 426 limits->logical_block_size = to_bytes(ec->e_bs); 427 limits->physical_block_size = to_bytes(ec->u_bs); 428 limits->alignment_offset = limits->physical_block_size; 429 blk_limits_io_min(limits, limits->logical_block_size); 430 } 431 432 static int ebs_iterate_devices(struct dm_target *ti, 433 iterate_devices_callout_fn fn, void *data) 434 { 435 struct ebs_c *ec = ti->private; 436 437 return fn(ti, ec->dev, ec->start, ti->len, data); 438 } 439 440 static struct target_type ebs_target = { 441 .name = "ebs", 442 .version = {1, 0, 1}, 443 .features = DM_TARGET_PASSES_INTEGRITY, 444 .module = THIS_MODULE, 445 .ctr = ebs_ctr, 446 .dtr = ebs_dtr, 447 .map = ebs_map, 448 .status = ebs_status, 449 .io_hints = ebs_io_hints, 450 .prepare_ioctl = ebs_prepare_ioctl, 451 .iterate_devices = ebs_iterate_devices, 452 }; 453 454 static int __init dm_ebs_init(void) 455 { 456 int r = dm_register_target(&ebs_target); 457 458 if (r < 0) 459 DMERR("register failed %d", r); 460 461 return r; 462 } 463 464 static void dm_ebs_exit(void) 465 { 466 dm_unregister_target(&ebs_target); 467 } 468 469 module_init(dm_ebs_init); 470 module_exit(dm_ebs_exit); 471 472 MODULE_AUTHOR("Heinz Mauelshagen <dm-devel@redhat.com>"); 473 MODULE_DESCRIPTION(DM_NAME " emulated block size target"); 474 MODULE_LICENSE("GPL"); 475