blob: 4ffa3814f6a997fde4a34d68749728f7c79f52ba [file] [log] [blame]
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001/*
2 * blk-integrity.c - Block layer data integrity extensions
3 *
4 * Copyright (C) 2007, 2008 Oracle Corporation
5 * Written by: Martin K. Petersen <martin.petersen@oracle.com>
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License version
9 * 2 as published by the Free Software Foundation.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; see the file COPYING. If not, write to
18 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139,
19 * USA.
20 *
21 */
22
23#include <linux/blkdev.h>
24#include <linux/mempool.h>
25#include <linux/bio.h>
26#include <linux/scatterlist.h>
27
28#include "blk.h"
29
30static struct kmem_cache *integrity_cachep;
31
32/**
33 * blk_rq_count_integrity_sg - Count number of integrity scatterlist elements
34 * @rq: request with integrity metadata attached
35 *
36 * Description: Returns the number of elements required in a
37 * scatterlist corresponding to the integrity metadata in a request.
38 */
39int blk_rq_count_integrity_sg(struct request *rq)
40{
41 struct bio_vec *iv, *ivprv;
42 struct req_iterator iter;
43 unsigned int segments;
44
45 ivprv = NULL;
46 segments = 0;
47
48 rq_for_each_integrity_segment(iv, rq, iter) {
49
50 if (!ivprv || !BIOVEC_PHYS_MERGEABLE(ivprv, iv))
51 segments++;
52
53 ivprv = iv;
54 }
55
56 return segments;
57}
58EXPORT_SYMBOL(blk_rq_count_integrity_sg);
59
60/**
61 * blk_rq_map_integrity_sg - Map integrity metadata into a scatterlist
62 * @rq: request with integrity metadata attached
63 * @sglist: target scatterlist
64 *
65 * Description: Map the integrity vectors in request into a
66 * scatterlist. The scatterlist must be big enough to hold all
67 * elements. I.e. sized using blk_rq_count_integrity_sg().
68 */
69int blk_rq_map_integrity_sg(struct request *rq, struct scatterlist *sglist)
70{
71 struct bio_vec *iv, *ivprv;
72 struct req_iterator iter;
73 struct scatterlist *sg;
74 unsigned int segments;
75
76 ivprv = NULL;
77 sg = NULL;
78 segments = 0;
79
80 rq_for_each_integrity_segment(iv, rq, iter) {
81
82 if (ivprv) {
83 if (!BIOVEC_PHYS_MERGEABLE(ivprv, iv))
84 goto new_segment;
85
86 sg->length += iv->bv_len;
87 } else {
88new_segment:
89 if (!sg)
90 sg = sglist;
91 else {
92 sg->page_link &= ~0x02;
93 sg = sg_next(sg);
94 }
95
96 sg_set_page(sg, iv->bv_page, iv->bv_len, iv->bv_offset);
97 segments++;
98 }
99
100 ivprv = iv;
101 }
102
103 if (sg)
104 sg_mark_end(sg);
105
106 return segments;
107}
108EXPORT_SYMBOL(blk_rq_map_integrity_sg);
109
110/**
111 * blk_integrity_compare - Compare integrity profile of two block devices
112 * @b1: Device to compare
113 * @b2: Device 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 block devices have
119 * compatible integrity formats.
120 */
121int blk_integrity_compare(struct block_device *bd1, struct block_device *bd2)
122{
123 struct blk_integrity *b1 = bd1->bd_disk->integrity;
124 struct blk_integrity *b2 = bd2->bd_disk->integrity;
125
126 BUG_ON(bd1->bd_disk == NULL);
127 BUG_ON(bd2->bd_disk == NULL);
128
129 if (!b1 || !b2)
130 return 0;
131
132 if (b1->sector_size != b2->sector_size) {
133 printk(KERN_ERR "%s: %s/%s sector sz %u != %u\n", __func__,
134 bd1->bd_disk->disk_name, bd2->bd_disk->disk_name,
135 b1->sector_size, b2->sector_size);
136 return -1;
137 }
138
139 if (b1->tuple_size != b2->tuple_size) {
140 printk(KERN_ERR "%s: %s/%s tuple sz %u != %u\n", __func__,
141 bd1->bd_disk->disk_name, bd2->bd_disk->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 printk(KERN_ERR "%s: %s/%s tag sz %u != %u\n", __func__,
148 bd1->bd_disk->disk_name, bd2->bd_disk->disk_name,
149 b1->tag_size, b2->tag_size);
150 return -1;
151 }
152
153 if (strcmp(b1->name, b2->name)) {
154 printk(KERN_ERR "%s: %s/%s type %s != %s\n", __func__,
155 bd1->bd_disk->disk_name, bd2->bd_disk->disk_name,
156 b1->name, b2->name);
157 return -1;
158 }
159
160 return 0;
161}
162EXPORT_SYMBOL(blk_integrity_compare);
163
164struct integrity_sysfs_entry {
165 struct attribute attr;
166 ssize_t (*show)(struct blk_integrity *, char *);
167 ssize_t (*store)(struct blk_integrity *, const char *, size_t);
168};
169
170static ssize_t integrity_attr_show(struct kobject *kobj, struct attribute *attr,
171 char *page)
172{
173 struct blk_integrity *bi =
174 container_of(kobj, struct blk_integrity, kobj);
175 struct integrity_sysfs_entry *entry =
176 container_of(attr, struct integrity_sysfs_entry, attr);
177
178 return entry->show(bi, page);
179}
180
Jens Axboeb9846792008-06-17 19:05:48 +0200181static ssize_t integrity_attr_store(struct kobject *kobj,
182 struct attribute *attr, const char *page,
183 size_t count)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200184{
185 struct blk_integrity *bi =
186 container_of(kobj, struct blk_integrity, kobj);
187 struct integrity_sysfs_entry *entry =
188 container_of(attr, struct integrity_sysfs_entry, attr);
189 ssize_t ret = 0;
190
191 if (entry->store)
192 ret = entry->store(bi, page, count);
193
194 return ret;
195}
196
197static ssize_t integrity_format_show(struct blk_integrity *bi, char *page)
198{
199 if (bi != NULL && bi->name != NULL)
200 return sprintf(page, "%s\n", bi->name);
201 else
202 return sprintf(page, "none\n");
203}
204
205static ssize_t integrity_tag_size_show(struct blk_integrity *bi, char *page)
206{
207 if (bi != NULL)
208 return sprintf(page, "%u\n", bi->tag_size);
209 else
210 return sprintf(page, "0\n");
211}
212
213static ssize_t integrity_read_store(struct blk_integrity *bi,
214 const char *page, size_t count)
215{
216 char *p = (char *) page;
217 unsigned long val = simple_strtoul(p, &p, 10);
218
219 if (val)
220 set_bit(INTEGRITY_FLAG_READ, &bi->flags);
221 else
222 clear_bit(INTEGRITY_FLAG_READ, &bi->flags);
223
224 return count;
225}
226
227static ssize_t integrity_read_show(struct blk_integrity *bi, char *page)
228{
229 return sprintf(page, "%d\n",
230 test_bit(INTEGRITY_FLAG_READ, &bi->flags) ? 1 : 0);
231}
232
233static ssize_t integrity_write_store(struct blk_integrity *bi,
234 const char *page, size_t count)
235{
236 char *p = (char *) page;
237 unsigned long val = simple_strtoul(p, &p, 10);
238
239 if (val)
240 set_bit(INTEGRITY_FLAG_WRITE, &bi->flags);
241 else
242 clear_bit(INTEGRITY_FLAG_WRITE, &bi->flags);
243
244 return count;
245}
246
247static ssize_t integrity_write_show(struct blk_integrity *bi, char *page)
248{
249 return sprintf(page, "%d\n",
250 test_bit(INTEGRITY_FLAG_WRITE, &bi->flags) ? 1 : 0);
251}
252
253static struct integrity_sysfs_entry integrity_format_entry = {
254 .attr = { .name = "format", .mode = S_IRUGO },
255 .show = integrity_format_show,
256};
257
258static struct integrity_sysfs_entry integrity_tag_size_entry = {
259 .attr = { .name = "tag_size", .mode = S_IRUGO },
260 .show = integrity_tag_size_show,
261};
262
263static struct integrity_sysfs_entry integrity_read_entry = {
264 .attr = { .name = "read_verify", .mode = S_IRUGO | S_IWUSR },
265 .show = integrity_read_show,
266 .store = integrity_read_store,
267};
268
269static struct integrity_sysfs_entry integrity_write_entry = {
270 .attr = { .name = "write_generate", .mode = S_IRUGO | S_IWUSR },
271 .show = integrity_write_show,
272 .store = integrity_write_store,
273};
274
275static struct attribute *integrity_attrs[] = {
276 &integrity_format_entry.attr,
277 &integrity_tag_size_entry.attr,
278 &integrity_read_entry.attr,
279 &integrity_write_entry.attr,
280 NULL,
281};
282
283static struct sysfs_ops integrity_ops = {
284 .show = &integrity_attr_show,
285 .store = &integrity_attr_store,
286};
287
288static int __init blk_dev_integrity_init(void)
289{
290 integrity_cachep = kmem_cache_create("blkdev_integrity",
291 sizeof(struct blk_integrity),
292 0, SLAB_PANIC, NULL);
293 return 0;
294}
295subsys_initcall(blk_dev_integrity_init);
296
297static void blk_integrity_release(struct kobject *kobj)
298{
299 struct blk_integrity *bi =
300 container_of(kobj, struct blk_integrity, kobj);
301
302 kmem_cache_free(integrity_cachep, bi);
303}
304
305static struct kobj_type integrity_ktype = {
306 .default_attrs = integrity_attrs,
307 .sysfs_ops = &integrity_ops,
308 .release = blk_integrity_release,
309};
310
311/**
312 * blk_integrity_register - Register a gendisk as being integrity-capable
313 * @disk: struct gendisk pointer to make integrity-aware
314 * @template: integrity profile
315 *
316 * Description: When a device needs to advertise itself as being able
317 * to send/receive integrity metadata it must use this function to
318 * register the capability with the block layer. The template is a
319 * blk_integrity struct with values appropriate for the underlying
320 * hardware. See Documentation/block/data-integrity.txt.
321 */
322int blk_integrity_register(struct gendisk *disk, struct blk_integrity *template)
323{
324 struct blk_integrity *bi;
325
326 BUG_ON(disk == NULL);
327 BUG_ON(template == NULL);
328
329 if (disk->integrity == NULL) {
Jens Axboeb9846792008-06-17 19:05:48 +0200330 bi = kmem_cache_alloc(integrity_cachep,
331 GFP_KERNEL | __GFP_ZERO);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200332 if (!bi)
333 return -1;
334
335 if (kobject_init_and_add(&bi->kobj, &integrity_ktype,
336 &disk->dev.kobj, "%s", "integrity")) {
337 kmem_cache_free(integrity_cachep, bi);
338 return -1;
339 }
340
341 kobject_uevent(&bi->kobj, KOBJ_ADD);
342
343 set_bit(INTEGRITY_FLAG_READ, &bi->flags);
344 set_bit(INTEGRITY_FLAG_WRITE, &bi->flags);
345 bi->sector_size = disk->queue->hardsect_size;
346 disk->integrity = bi;
347 } else
348 bi = disk->integrity;
349
350 /* Use the provided profile as template */
351 bi->name = template->name;
352 bi->generate_fn = template->generate_fn;
353 bi->verify_fn = template->verify_fn;
354 bi->tuple_size = template->tuple_size;
355 bi->set_tag_fn = template->set_tag_fn;
356 bi->get_tag_fn = template->get_tag_fn;
357 bi->tag_size = template->tag_size;
358
359 return 0;
360}
361EXPORT_SYMBOL(blk_integrity_register);
362
363/**
364 * blk_integrity_unregister - Remove block integrity profile
365 * @disk: disk whose integrity profile to deallocate
366 *
367 * Description: This function frees all memory used by the block
368 * integrity profile. To be called at device teardown.
369 */
370void blk_integrity_unregister(struct gendisk *disk)
371{
372 struct blk_integrity *bi;
373
374 if (!disk || !disk->integrity)
375 return;
376
377 bi = disk->integrity;
378
379 kobject_uevent(&bi->kobj, KOBJ_REMOVE);
380 kobject_del(&bi->kobj);
381 kobject_put(&disk->dev.kobj);
382 kmem_cache_free(integrity_cachep, bi);
383}
384EXPORT_SYMBOL(blk_integrity_unregister);