block/blk-integrity.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * blk-integrity.c - Block layer data integrity extensions
   4  *
   5  * Copyright (C) 2007, 2008 Oracle Corporation
   6  * Written by: Martin K. Petersen <martin.petersen@oracle.com>
   7  */
   8
   9 #include <linux/blk-integrity.h>
  10 #include <linux/backing-dev.h>
  11 #include <linux/mempool.h>
  12 #include <linux/bio.h>
  13 #include <linux/scatterlist.h>
  14 #include <linux/export.h>
  15 #include <linux/slab.h>
  16
  17 #include "blk.h"
  18
  19 /**
  20  * blk_rq_count_integrity_sg - Count number of integrity scatterlist elements
  21  * @q:          request queue
  22  * @bio:        bio with integrity metadata attached
  23  *
  24  * Description: Returns the number of elements required in a
  25  * scatterlist corresponding to the integrity metadata in a bio.
  26  */
  27 int blk_rq_count_integrity_sg(struct request_queue *q, struct bio *bio)
  28 {
  29         struct bio_vec iv, ivprv = { NULL };
  30         unsigned int segments = 0;
  31         unsigned int seg_size = 0;
  32         struct bvec_iter iter;
  33         int prev = 0;
  34
  35         bio_for_each_integrity_vec(iv, bio, iter) {
  36
  37                 if (prev) {
  38                         if (!biovec_phys_mergeable(q, &ivprv, &iv))
  39                                 goto new_segment;
  40                         if (seg_size + iv.bv_len > queue_max_segment_size(q))
  41                                 goto new_segment;
  42
  43                         seg_size += iv.bv_len;
  44                 } else {
  45 new_segment:
  46                         segments++;
  47                         seg_size = iv.bv_len;
  48                 }
  49
  50                 prev = 1;
  51                 ivprv = iv;
  52         }
  53
  54         return segments;
  55 }
  56 EXPORT_SYMBOL(blk_rq_count_integrity_sg);
  57
  58 /**
  59  * blk_rq_map_integrity_sg - Map integrity metadata into a scatterlist
  60  * @q:          request queue
  61  * @bio:        bio with integrity metadata attached
  62  * @sglist:     target scatterlist
  63  *
  64  * Description: Map the integrity vectors in request into a
  65  * scatterlist.  The scatterlist must be big enough to hold all
  66  * elements.  I.e. sized using blk_rq_count_integrity_sg().
  67  */
  68 int blk_rq_map_integrity_sg(struct request_queue *q, struct bio *bio,
  69                             struct scatterlist *sglist)
  70 {
  71         struct bio_vec iv, ivprv = { NULL };
  72         struct scatterlist *sg = NULL;
  73         unsigned int segments = 0;
  74         struct bvec_iter iter;
  75         int prev = 0;
  76
  77         bio_for_each_integrity_vec(iv, bio, iter) {
  78
  79                 if (prev) {
  80                         if (!biovec_phys_mergeable(q, &ivprv, &iv))
  81                                 goto new_segment;
  82                         if (sg->length + iv.bv_len > queue_max_segment_size(q))
  83                                 goto new_segment;
  84
  85                         sg->length += iv.bv_len;
  86                 } else {
  87 new_segment:
  88                         if (!sg)
  89                                 sg = sglist;
  90                         else {
  91                                 sg_unmark_end(sg);
  92                                 sg = sg_next(sg);
  93                         }
  94
  95                         sg_set_page(sg, iv.bv_page, iv.bv_len, iv.bv_offset);
  96                         segments++;
  97                 }
  98
  99                 prev = 1;
 100                 ivprv = iv;
 101         }
 102
 103         if (sg)
 104                 sg_mark_end(sg);
 105
 106         return segments;
 107 }
 108 EXPORT_SYMBOL(blk_rq_map_integrity_sg);
 109
 110 /**
 111  * blk_integrity_compare - Compare integrity profile of two disks
 112  * @gd1:        Disk to compare
 113  * @gd2:        Disk to compare
 114  *
 115  * Description: Meta-devices like DM and MD need to verify that all
 116  * sub-devices use the same integrity format before advertising to
 117  * upper layers that they can send/receive integrity metadata.  This
 118  * function can be used to check whether two gendisk devices have
 119  * compatible integrity formats.
 120  */
 121 int blk_integrity_compare(struct gendisk *gd1, struct gendisk *gd2)
 122 {
 123         struct blk_integrity *b1 = &gd1->queue->integrity;
 124         struct blk_integrity *b2 = &gd2->queue->integrity;
 125
 126         if (!b1->profile && !b2->profile)
 127                 return 0;
 128
 129         if (!b1->profile || !b2->profile)
 130                 return -1;
 131
 132         if (b1->interval_exp != b2->interval_exp) {
 133                 pr_err("%s: %s/%s protection interval %u != %u\n",
 134                        __func__, gd1->disk_name, gd2->disk_name,
 135                        1 << b1->interval_exp, 1 << b2->interval_exp);
 136                 return -1;
 137         }
 138
 139         if (b1->tuple_size != b2->tuple_size) {
 140                 pr_err("%s: %s/%s tuple sz %u != %u\n", __func__,
 141                        gd1->disk_name, gd2->disk_name,
 142                        b1->tuple_size, b2->tuple_size);
 143                 return -1;
 144         }
 145
 146         if (b1->tag_size && b2->tag_size && (b1->tag_size != b2->tag_size)) {
 147                 pr_err("%s: %s/%s tag sz %u != %u\n", __func__,
 148                        gd1->disk_name, gd2->disk_name,
 149                        b1->tag_size, b2->tag_size);
 150                 return -1;
 151         }
 152
 153         if (b1->profile != b2->profile) {
 154                 pr_err("%s: %s/%s type %s != %s\n", __func__,
 155                        gd1->disk_name, gd2->disk_name,
 156                        b1->profile->name, b2->profile->name);
 157                 return -1;
 158         }
 159
 160         return 0;
 161 }
 162 EXPORT_SYMBOL(blk_integrity_compare);
 163
 164 bool blk_integrity_merge_rq(struct request_queue *q, struct request *req,
 165                             struct request *next)
 166 {
 167         if (blk_integrity_rq(req) == 0 && blk_integrity_rq(next) == 0)
 168                 return true;
 169
 170         if (blk_integrity_rq(req) == 0 || blk_integrity_rq(next) == 0)
 171                 return false;
 172
 173         if (bio_integrity(req->bio)->bip_flags !=
 174             bio_integrity(next->bio)->bip_flags)
 175                 return false;
 176
 177         if (req->nr_integrity_segments + next->nr_integrity_segments >
 178             q->limits.max_integrity_segments)
 179                 return false;
 180
 181         if (integrity_req_gap_back_merge(req, next->bio))
 182                 return false;
 183
 184         return true;
 185 }
 186
 187 bool blk_integrity_merge_bio(struct request_queue *q, struct request *req,
 188                              struct bio *bio)
 189 {
 190         int nr_integrity_segs;
 191         struct bio *next = bio->bi_next;
 192
 193         if (blk_integrity_rq(req) == 0 && bio_integrity(bio) == NULL)
 194                 return true;
 195
 196         if (blk_integrity_rq(req) == 0 || bio_integrity(bio) == NULL)
 197                 return false;
 198
 199         if (bio_integrity(req->bio)->bip_flags != bio_integrity(bio)->bip_flags)
 200                 return false;
 201
 202         bio->bi_next = NULL;
 203         nr_integrity_segs = blk_rq_count_integrity_sg(q, bio);
 204         bio->bi_next = next;
 205
 206         if (req->nr_integrity_segments + nr_integrity_segs >
 207             q->limits.max_integrity_segments)
 208                 return false;
 209
 210         req->nr_integrity_segments += nr_integrity_segs;
 211
 212         return true;
 213 }
 214
 215 static ssize_t integrity_attr_show(struct kobject *kobj, struct attribute *attr,
 216                                    char *page)
 217 {
 218         struct gendisk *disk = container_of(kobj, struct gendisk, integrity_kobj);
 219         struct device *dev = disk_to_dev(disk);
 220         struct device_attribute *dev_attr =
 221                 container_of(attr, struct device_attribute, attr);
 222
 223         return dev_attr->show(dev, dev_attr, page);
 224 }
 225
 226 static ssize_t integrity_attr_store(struct kobject *kobj,
 227                                     struct attribute *attr, const char *page,
 228                                     size_t count)
 229 {
 230         struct gendisk *disk = container_of(kobj, struct gendisk, integrity_kobj);
 231         struct device *dev = disk_to_dev(disk);
 232         struct device_attribute *dev_attr =
 233                 container_of(attr, struct device_attribute, attr);
 234
 235         if (!dev_attr->store)
 236                 return 0;
 237         return dev_attr->store(dev, dev_attr, page, count);
 238 }
 239
 240 static inline struct blk_integrity *dev_to_bi(struct device *dev)
 241 {
 242         return &dev_to_disk(dev)->queue->integrity;
 243 }
 244
 245 static ssize_t format_show(struct device *dev, struct device_attribute *attr,
 246                            char *page)
 247 {
 248         struct blk_integrity *bi = dev_to_bi(dev);
 249
 250         if (bi->profile && bi->profile->name)
 251                 return sysfs_emit(page, "%s\n", bi->profile->name);
 252         return sysfs_emit(page, "none\n");
 253 }
 254
 255 static ssize_t tag_size_show(struct device *dev, struct device_attribute *attr,
 256                              char *page)
 257 {
 258         struct blk_integrity *bi = dev_to_bi(dev);
 259
 260         return sysfs_emit(page, "%u\n", bi->tag_size);
 261 }
 262
 263 static ssize_t protection_interval_bytes_show(struct device *dev,
 264                                               struct device_attribute *attr,
 265                                               char *page)
 266 {
 267         struct blk_integrity *bi = dev_to_bi(dev);
 268
 269         return sysfs_emit(page, "%u\n",
 270                           bi->interval_exp ? 1 << bi->interval_exp : 0);
 271 }
 272
 273 static ssize_t read_verify_store(struct device *dev,
 274                                  struct device_attribute *attr,
 275                                  const char *page, size_t count)
 276 {
 277         struct blk_integrity *bi = dev_to_bi(dev);
 278         char *p = (char *) page;
 279         unsigned long val = simple_strtoul(p, &p, 10);
 280
 281         if (val)
 282                 bi->flags |= BLK_INTEGRITY_VERIFY;
 283         else
 284                 bi->flags &= ~BLK_INTEGRITY_VERIFY;
 285
 286         return count;
 287 }
 288
 289 static ssize_t read_verify_show(struct device *dev,
 290                                 struct device_attribute *attr, char *page)
 291 {
 292         struct blk_integrity *bi = dev_to_bi(dev);
 293
 294         return sysfs_emit(page, "%d\n", !!(bi->flags & BLK_INTEGRITY_VERIFY));
 295 }
 296
 297 static ssize_t write_generate_store(struct device *dev,
 298                                     struct device_attribute *attr,
 299                                     const char *page, size_t count)
 300 {
 301         struct blk_integrity *bi = dev_to_bi(dev);
 302
 303         char *p = (char *) page;
 304         unsigned long val = simple_strtoul(p, &p, 10);
 305
 306         if (val)
 307                 bi->flags |= BLK_INTEGRITY_GENERATE;
 308         else
 309                 bi->flags &= ~BLK_INTEGRITY_GENERATE;
 310
 311         return count;
 312 }
 313
 314 static ssize_t write_generate_show(struct device *dev,
 315                                    struct device_attribute *attr, char *page)
 316 {
 317         struct blk_integrity *bi = dev_to_bi(dev);
 318
 319         return sysfs_emit(page, "%d\n", !!(bi->flags & BLK_INTEGRITY_GENERATE));
 320 }
 321
 322 static ssize_t device_is_integrity_capable_show(struct device *dev,
 323                                                 struct device_attribute *attr,
 324                                                 char *page)
 325 {
 326         struct blk_integrity *bi = dev_to_bi(dev);
 327
 328         return sysfs_emit(page, "%u\n",
 329                           !!(bi->flags & BLK_INTEGRITY_DEVICE_CAPABLE));
 330 }
 331
 332 static DEVICE_ATTR_RO(format);
 333 static DEVICE_ATTR_RO(tag_size);
 334 static DEVICE_ATTR_RO(protection_interval_bytes);
 335 static DEVICE_ATTR_RW(read_verify);
 336 static DEVICE_ATTR_RW(write_generate);
 337 static DEVICE_ATTR_RO(device_is_integrity_capable);
 338
 339 static struct attribute *integrity_attrs[] = {
 340         &dev_attr_format.attr,
 341         &dev_attr_tag_size.attr,
 342         &dev_attr_protection_interval_bytes.attr,
 343         &dev_attr_read_verify.attr,
 344         &dev_attr_write_generate.attr,
 345         &dev_attr_device_is_integrity_capable.attr,
 346         NULL
 347 };
 348 ATTRIBUTE_GROUPS(integrity);
 349
 350 static const struct sysfs_ops integrity_ops = {
 351         .show   = &integrity_attr_show,
 352         .store  = &integrity_attr_store,
 353 };
 354
 355 static const struct kobj_type integrity_ktype = {
 356         .default_groups = integrity_groups,
 357         .sysfs_ops      = &integrity_ops,
 358 };
 359
 360 static blk_status_t blk_integrity_nop_fn(struct blk_integrity_iter *iter)
 361 {
 362         return BLK_STS_OK;
 363 }
 364
 365 static void blk_integrity_nop_prepare(struct request *rq)
 366 {
 367 }
 368
 369 static void blk_integrity_nop_complete(struct request *rq,
 370                 unsigned int nr_bytes)
 371 {
 372 }
 373
 374 static const struct blk_integrity_profile nop_profile = {
 375         .name = "nop",
 376         .generate_fn = blk_integrity_nop_fn,
 377         .verify_fn = blk_integrity_nop_fn,
 378         .prepare_fn = blk_integrity_nop_prepare,
 379         .complete_fn = blk_integrity_nop_complete,
 380 };
 381
 382 /**
 383  * blk_integrity_register - Register a gendisk as being integrity-capable
 384  * @disk:       struct gendisk pointer to make integrity-aware
 385  * @template:   block integrity profile to register
 386  *
 387  * Description: When a device needs to advertise itself as being able to
 388  * send/receive integrity metadata it must use this function to register
 389  * the capability with the block layer. The template is a blk_integrity
 390  * struct with values appropriate for the underlying hardware. See
 391  * Documentation/block/data-integrity.rst.
 392  */
 393 void blk_integrity_register(struct gendisk *disk, struct blk_integrity *template)
 394 {
 395         struct blk_integrity *bi = &disk->queue->integrity;
 396
 397         bi->flags = BLK_INTEGRITY_VERIFY | BLK_INTEGRITY_GENERATE |
 398                 template->flags;
 399         bi->interval_exp = template->interval_exp ? :
 400                 ilog2(queue_logical_block_size(disk->queue));
 401         bi->profile = template->profile ? template->profile : &nop_profile;
 402         bi->tuple_size = template->tuple_size;
 403         bi->tag_size = template->tag_size;
 404
 405         blk_queue_flag_set(QUEUE_FLAG_STABLE_WRITES, disk->queue);
 406
 407 #ifdef CONFIG_BLK_INLINE_ENCRYPTION
 408         if (disk->queue->crypto_profile) {
 409                 pr_warn("blk-integrity: Integrity and hardware inline encryption are not supported together. Disabling hardware inline encryption.\n");
 410                 disk->queue->crypto_profile = NULL;
 411         }
 412 #endif
 413 }
 414 EXPORT_SYMBOL(blk_integrity_register);
 415
 416 /**
 417  * blk_integrity_unregister - Unregister block integrity profile
 418  * @disk:       disk whose integrity profile to unregister
 419  *
 420  * Description: This function unregisters the integrity capability from
 421  * a block device.
 422  */
 423 void blk_integrity_unregister(struct gendisk *disk)
 424 {
 425         struct blk_integrity *bi = &disk->queue->integrity;
 426
 427         if (!bi->profile)
 428                 return;
 429
 430         /* ensure all bios are off the integrity workqueue */
 431         blk_flush_integrity();
 432         blk_queue_flag_clear(QUEUE_FLAG_STABLE_WRITES, disk->queue);
 433         memset(bi, 0, sizeof(*bi));
 434 }
 435 EXPORT_SYMBOL(blk_integrity_unregister);
 436
 437 int blk_integrity_add(struct gendisk *disk)
 438 {
 439         int ret;
 440
 441         ret = kobject_init_and_add(&disk->integrity_kobj, &integrity_ktype,
 442                                    &disk_to_dev(disk)->kobj, "%s", "integrity");
 443         if (!ret)
 444                 kobject_uevent(&disk->integrity_kobj, KOBJ_ADD);
 445         return ret;
 446 }
 447
 448 void blk_integrity_del(struct gendisk *disk)
 449 {
 450         kobject_uevent(&disk->integrity_kobj, KOBJ_REMOVE);
 451         kobject_del(&disk->integrity_kobj);
 452         kobject_put(&disk->integrity_kobj);
 453 }