blob: b257e46876d357f831bf1c751010d5b16fa125b8 [file] [log] [blame]
Josef Bacik3407ef52011-03-24 13:54:24 +00001/*
2 * Copyright (C) 2003 Sistina Software (UK) Limited.
Mike Snitzera3998792011-08-02 12:32:06 +01003 * Copyright (C) 2004, 2010-2011 Red Hat, Inc. All rights reserved.
Josef Bacik3407ef52011-03-24 13:54:24 +00004 *
5 * This file is released under the GPL.
6 */
7
8#include <linux/device-mapper.h>
9
10#include <linux/module.h>
11#include <linux/init.h>
12#include <linux/blkdev.h>
13#include <linux/bio.h>
14#include <linux/slab.h>
15
16#define DM_MSG_PREFIX "flakey"
17
Mike Snitzera3998792011-08-02 12:32:06 +010018#define all_corrupt_bio_flags_match(bio, fc) \
19 (((bio)->bi_rw & (fc)->corrupt_bio_flags) == (fc)->corrupt_bio_flags)
20
Josef Bacik3407ef52011-03-24 13:54:24 +000021/*
22 * Flakey: Used for testing only, simulates intermittent,
23 * catastrophic device failure.
24 */
25struct flakey_c {
26 struct dm_dev *dev;
27 unsigned long start_time;
28 sector_t start;
29 unsigned up_interval;
30 unsigned down_interval;
Mike Snitzerb26f5e32011-08-02 12:32:05 +010031 unsigned long flags;
Mike Snitzera3998792011-08-02 12:32:06 +010032 unsigned corrupt_bio_byte;
33 unsigned corrupt_bio_rw;
34 unsigned corrupt_bio_value;
35 unsigned corrupt_bio_flags;
Josef Bacik3407ef52011-03-24 13:54:24 +000036};
37
Mike Snitzerb26f5e32011-08-02 12:32:05 +010038enum feature_flag_bits {
39 DROP_WRITES
40};
41
Mikulas Patockac7cfdf52012-12-21 20:23:39 +000042struct per_bio_data {
43 bool bio_submitted;
44};
45
Mike Snitzerb26f5e32011-08-02 12:32:05 +010046static int parse_features(struct dm_arg_set *as, struct flakey_c *fc,
47 struct dm_target *ti)
Mike Snitzerdfd068b2011-08-02 12:32:05 +010048{
49 int r;
50 unsigned argc;
51 const char *arg_name;
52
53 static struct dm_arg _args[] = {
Mike Snitzera3998792011-08-02 12:32:06 +010054 {0, 6, "Invalid number of feature args"},
55 {1, UINT_MAX, "Invalid corrupt bio byte"},
56 {0, 255, "Invalid corrupt value to write into bio byte (0-255)"},
57 {0, UINT_MAX, "Invalid corrupt bio flags mask"},
Mike Snitzerdfd068b2011-08-02 12:32:05 +010058 };
59
60 /* No feature arguments supplied. */
61 if (!as->argc)
62 return 0;
63
64 r = dm_read_arg_group(_args, as, &argc, &ti->error);
65 if (r)
Mike Snitzera3998792011-08-02 12:32:06 +010066 return r;
Mike Snitzerdfd068b2011-08-02 12:32:05 +010067
Mike Snitzera3998792011-08-02 12:32:06 +010068 while (argc) {
Mike Snitzerdfd068b2011-08-02 12:32:05 +010069 arg_name = dm_shift_arg(as);
70 argc--;
71
Mike Snitzerb26f5e32011-08-02 12:32:05 +010072 /*
73 * drop_writes
74 */
75 if (!strcasecmp(arg_name, "drop_writes")) {
76 if (test_and_set_bit(DROP_WRITES, &fc->flags)) {
77 ti->error = "Feature drop_writes duplicated";
78 return -EINVAL;
79 }
80
81 continue;
82 }
83
Mike Snitzera3998792011-08-02 12:32:06 +010084 /*
85 * corrupt_bio_byte <Nth_byte> <direction> <value> <bio_flags>
86 */
87 if (!strcasecmp(arg_name, "corrupt_bio_byte")) {
Mike Snitzer68e58a22011-09-25 23:26:15 +010088 if (!argc) {
Mike Snitzera3998792011-08-02 12:32:06 +010089 ti->error = "Feature corrupt_bio_byte requires parameters";
Mike Snitzer68e58a22011-09-25 23:26:15 +010090 return -EINVAL;
91 }
Mike Snitzera3998792011-08-02 12:32:06 +010092
93 r = dm_read_arg(_args + 1, as, &fc->corrupt_bio_byte, &ti->error);
94 if (r)
95 return r;
96 argc--;
97
98 /*
99 * Direction r or w?
100 */
101 arg_name = dm_shift_arg(as);
102 if (!strcasecmp(arg_name, "w"))
103 fc->corrupt_bio_rw = WRITE;
104 else if (!strcasecmp(arg_name, "r"))
105 fc->corrupt_bio_rw = READ;
106 else {
107 ti->error = "Invalid corrupt bio direction (r or w)";
108 return -EINVAL;
109 }
110 argc--;
111
112 /*
113 * Value of byte (0-255) to write in place of correct one.
114 */
115 r = dm_read_arg(_args + 2, as, &fc->corrupt_bio_value, &ti->error);
116 if (r)
117 return r;
118 argc--;
119
120 /*
121 * Only corrupt bios with these flags set.
122 */
123 r = dm_read_arg(_args + 3, as, &fc->corrupt_bio_flags, &ti->error);
124 if (r)
125 return r;
126 argc--;
127
128 continue;
129 }
130
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100131 ti->error = "Unrecognised flakey feature requested";
Mike Snitzera3998792011-08-02 12:32:06 +0100132 return -EINVAL;
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100133 }
134
Mike Snitzera3998792011-08-02 12:32:06 +0100135 if (test_bit(DROP_WRITES, &fc->flags) && (fc->corrupt_bio_rw == WRITE)) {
136 ti->error = "drop_writes is incompatible with corrupt_bio_byte with the WRITE flag set";
137 return -EINVAL;
138 }
139
140 return 0;
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100141}
142
Josef Bacik3407ef52011-03-24 13:54:24 +0000143/*
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100144 * Construct a flakey mapping:
145 * <dev_path> <offset> <up interval> <down interval> [<#feature args> [<arg>]*]
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100146 *
147 * Feature args:
148 * [drop_writes]
Mike Snitzera3998792011-08-02 12:32:06 +0100149 * [corrupt_bio_byte <Nth_byte> <direction> <value> <bio_flags>]
150 *
151 * Nth_byte starts from 1 for the first byte.
152 * Direction is r for READ or w for WRITE.
153 * bio_flags is ignored if 0.
Josef Bacik3407ef52011-03-24 13:54:24 +0000154 */
155static int flakey_ctr(struct dm_target *ti, unsigned int argc, char **argv)
156{
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100157 static struct dm_arg _args[] = {
158 {0, UINT_MAX, "Invalid up interval"},
159 {0, UINT_MAX, "Invalid down interval"},
160 };
Josef Bacik3407ef52011-03-24 13:54:24 +0000161
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100162 int r;
163 struct flakey_c *fc;
164 unsigned long long tmpll;
165 struct dm_arg_set as;
166 const char *devname;
Mikulas Patocka31998ef2012-03-28 18:41:26 +0100167 char dummy;
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100168
169 as.argc = argc;
170 as.argv = argv;
171
172 if (argc < 4) {
173 ti->error = "Invalid argument count";
Josef Bacik3407ef52011-03-24 13:54:24 +0000174 return -EINVAL;
175 }
176
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100177 fc = kzalloc(sizeof(*fc), GFP_KERNEL);
Josef Bacik3407ef52011-03-24 13:54:24 +0000178 if (!fc) {
Alasdair G Kergon75e3a0f2013-07-10 23:41:17 +0100179 ti->error = "Cannot allocate context";
Josef Bacik3407ef52011-03-24 13:54:24 +0000180 return -ENOMEM;
181 }
182 fc->start_time = jiffies;
183
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100184 devname = dm_shift_arg(&as);
Josef Bacik3407ef52011-03-24 13:54:24 +0000185
Mikulas Patocka31998ef2012-03-28 18:41:26 +0100186 if (sscanf(dm_shift_arg(&as), "%llu%c", &tmpll, &dummy) != 1) {
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100187 ti->error = "Invalid device sector";
Josef Bacik3407ef52011-03-24 13:54:24 +0000188 goto bad;
189 }
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100190 fc->start = tmpll;
Josef Bacik3407ef52011-03-24 13:54:24 +0000191
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100192 r = dm_read_arg(_args, &as, &fc->up_interval, &ti->error);
193 if (r)
Josef Bacik3407ef52011-03-24 13:54:24 +0000194 goto bad;
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100195
196 r = dm_read_arg(_args, &as, &fc->down_interval, &ti->error);
197 if (r)
198 goto bad;
Josef Bacik3407ef52011-03-24 13:54:24 +0000199
200 if (!(fc->up_interval + fc->down_interval)) {
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100201 ti->error = "Total (up + down) interval is zero";
Josef Bacik3407ef52011-03-24 13:54:24 +0000202 goto bad;
203 }
204
205 if (fc->up_interval + fc->down_interval < fc->up_interval) {
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100206 ti->error = "Interval overflow";
Josef Bacik3407ef52011-03-24 13:54:24 +0000207 goto bad;
208 }
209
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100210 r = parse_features(&as, fc, ti);
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100211 if (r)
212 goto bad;
213
214 if (dm_get_device(ti, devname, dm_table_get_mode(ti->table), &fc->dev)) {
215 ti->error = "Device lookup failed";
Josef Bacik3407ef52011-03-24 13:54:24 +0000216 goto bad;
217 }
218
Alasdair G Kergon55a62ee2013-03-01 22:45:47 +0000219 ti->num_flush_bios = 1;
220 ti->num_discard_bios = 1;
Mikulas Patockac7cfdf52012-12-21 20:23:39 +0000221 ti->per_bio_data_size = sizeof(struct per_bio_data);
Josef Bacik3407ef52011-03-24 13:54:24 +0000222 ti->private = fc;
223 return 0;
224
225bad:
226 kfree(fc);
227 return -EINVAL;
228}
229
230static void flakey_dtr(struct dm_target *ti)
231{
232 struct flakey_c *fc = ti->private;
233
234 dm_put_device(ti, fc->dev);
235 kfree(fc);
236}
237
238static sector_t flakey_map_sector(struct dm_target *ti, sector_t bi_sector)
239{
240 struct flakey_c *fc = ti->private;
241
Mike Snitzer30e41712011-08-02 12:32:05 +0100242 return fc->start + dm_target_offset(ti, bi_sector);
Josef Bacik3407ef52011-03-24 13:54:24 +0000243}
244
245static void flakey_map_bio(struct dm_target *ti, struct bio *bio)
246{
247 struct flakey_c *fc = ti->private;
248
249 bio->bi_bdev = fc->dev->bdev;
250 if (bio_sectors(bio))
Kent Overstreet4f024f32013-10-11 15:44:27 -0700251 bio->bi_iter.bi_sector =
252 flakey_map_sector(ti, bio->bi_iter.bi_sector);
Josef Bacik3407ef52011-03-24 13:54:24 +0000253}
254
Mike Snitzera3998792011-08-02 12:32:06 +0100255static void corrupt_bio_data(struct bio *bio, struct flakey_c *fc)
256{
257 unsigned bio_bytes = bio_cur_bytes(bio);
258 char *data = bio_data(bio);
259
260 /*
261 * Overwrite the Nth byte of the data returned.
262 */
263 if (data && bio_bytes >= fc->corrupt_bio_byte) {
264 data[fc->corrupt_bio_byte - 1] = fc->corrupt_bio_value;
265
266 DMDEBUG("Corrupting data bio=%p by writing %u to byte %u "
267 "(rw=%c bi_rw=%lu bi_sector=%llu cur_bytes=%u)\n",
268 bio, fc->corrupt_bio_value, fc->corrupt_bio_byte,
Kent Overstreet4f024f32013-10-11 15:44:27 -0700269 (bio_data_dir(bio) == WRITE) ? 'w' : 'r', bio->bi_rw,
270 (unsigned long long)bio->bi_iter.bi_sector, bio_bytes);
Mike Snitzera3998792011-08-02 12:32:06 +0100271 }
272}
273
Mikulas Patocka7de3ee52012-12-21 20:23:41 +0000274static int flakey_map(struct dm_target *ti, struct bio *bio)
Josef Bacik3407ef52011-03-24 13:54:24 +0000275{
276 struct flakey_c *fc = ti->private;
277 unsigned elapsed;
Mikulas Patockac7cfdf52012-12-21 20:23:39 +0000278 struct per_bio_data *pb = dm_per_bio_data(bio, sizeof(struct per_bio_data));
279 pb->bio_submitted = false;
Josef Bacik3407ef52011-03-24 13:54:24 +0000280
281 /* Are we alive ? */
282 elapsed = (jiffies - fc->start_time) / HZ;
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100283 if (elapsed % (fc->up_interval + fc->down_interval) >= fc->up_interval) {
Mike Snitzera3998792011-08-02 12:32:06 +0100284 /*
285 * Flag this bio as submitted while down.
286 */
Mikulas Patockac7cfdf52012-12-21 20:23:39 +0000287 pb->bio_submitted = true;
Josef Bacik3407ef52011-03-24 13:54:24 +0000288
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100289 /*
Mike Snitzera3998792011-08-02 12:32:06 +0100290 * Map reads as normal.
291 */
292 if (bio_data_dir(bio) == READ)
293 goto map_bio;
294
295 /*
296 * Drop writes?
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100297 */
298 if (test_bit(DROP_WRITES, &fc->flags)) {
Mike Snitzera3998792011-08-02 12:32:06 +0100299 bio_endio(bio, 0);
300 return DM_MAPIO_SUBMITTED;
301 }
302
303 /*
304 * Corrupt matching writes.
305 */
306 if (fc->corrupt_bio_byte && (fc->corrupt_bio_rw == WRITE)) {
307 if (all_corrupt_bio_flags_match(bio, fc))
308 corrupt_bio_data(bio, fc);
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100309 goto map_bio;
310 }
311
312 /*
Mike Snitzera3998792011-08-02 12:32:06 +0100313 * By default, error all I/O.
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100314 */
315 return -EIO;
316 }
317
318map_bio:
Josef Bacik3407ef52011-03-24 13:54:24 +0000319 flakey_map_bio(ti, bio);
320
321 return DM_MAPIO_REMAPPED;
322}
323
Mikulas Patocka7de3ee52012-12-21 20:23:41 +0000324static int flakey_end_io(struct dm_target *ti, struct bio *bio, int error)
Mike Snitzera3998792011-08-02 12:32:06 +0100325{
326 struct flakey_c *fc = ti->private;
Mikulas Patockac7cfdf52012-12-21 20:23:39 +0000327 struct per_bio_data *pb = dm_per_bio_data(bio, sizeof(struct per_bio_data));
Mike Snitzera3998792011-08-02 12:32:06 +0100328
329 /*
330 * Corrupt successful READs while in down state.
331 * If flags were specified, only corrupt those that match.
332 */
Mikulas Patockac7cfdf52012-12-21 20:23:39 +0000333 if (fc->corrupt_bio_byte && !error && pb->bio_submitted &&
Mike Snitzera3998792011-08-02 12:32:06 +0100334 (bio_data_dir(bio) == READ) && (fc->corrupt_bio_rw == READ) &&
335 all_corrupt_bio_flags_match(bio, fc))
336 corrupt_bio_data(bio, fc);
337
338 return error;
339}
340
Mikulas Patockafd7c0922013-03-01 22:45:44 +0000341static void flakey_status(struct dm_target *ti, status_type_t type,
342 unsigned status_flags, char *result, unsigned maxlen)
Josef Bacik3407ef52011-03-24 13:54:24 +0000343{
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100344 unsigned sz = 0;
Josef Bacik3407ef52011-03-24 13:54:24 +0000345 struct flakey_c *fc = ti->private;
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100346 unsigned drop_writes;
Josef Bacik3407ef52011-03-24 13:54:24 +0000347
348 switch (type) {
349 case STATUSTYPE_INFO:
350 result[0] = '\0';
351 break;
352
353 case STATUSTYPE_TABLE:
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100354 DMEMIT("%s %llu %u %u ", fc->dev->name,
355 (unsigned long long)fc->start, fc->up_interval,
356 fc->down_interval);
357
358 drop_writes = test_bit(DROP_WRITES, &fc->flags);
Mike Snitzera3998792011-08-02 12:32:06 +0100359 DMEMIT("%u ", drop_writes + (fc->corrupt_bio_byte > 0) * 5);
360
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100361 if (drop_writes)
362 DMEMIT("drop_writes ");
Mike Snitzera3998792011-08-02 12:32:06 +0100363
364 if (fc->corrupt_bio_byte)
365 DMEMIT("corrupt_bio_byte %u %c %u %u ",
366 fc->corrupt_bio_byte,
367 (fc->corrupt_bio_rw == WRITE) ? 'w' : 'r',
368 fc->corrupt_bio_value, fc->corrupt_bio_flags);
369
Josef Bacik3407ef52011-03-24 13:54:24 +0000370 break;
371 }
Josef Bacik3407ef52011-03-24 13:54:24 +0000372}
373
374static int flakey_ioctl(struct dm_target *ti, unsigned int cmd, unsigned long arg)
375{
376 struct flakey_c *fc = ti->private;
Paolo Bonziniec8013b2012-01-12 16:01:29 +0100377 struct dm_dev *dev = fc->dev;
378 int r = 0;
Josef Bacik3407ef52011-03-24 13:54:24 +0000379
Paolo Bonziniec8013b2012-01-12 16:01:29 +0100380 /*
381 * Only pass ioctls through if the device sizes match exactly.
382 */
383 if (fc->start ||
384 ti->len != i_size_read(dev->bdev->bd_inode) >> SECTOR_SHIFT)
385 r = scsi_verify_blk_ioctl(NULL, cmd);
386
387 return r ? : __blkdev_driver_ioctl(dev->bdev, dev->mode, cmd, arg);
Josef Bacik3407ef52011-03-24 13:54:24 +0000388}
389
390static int flakey_merge(struct dm_target *ti, struct bvec_merge_data *bvm,
391 struct bio_vec *biovec, int max_size)
392{
393 struct flakey_c *fc = ti->private;
394 struct request_queue *q = bdev_get_queue(fc->dev->bdev);
395
396 if (!q->merge_bvec_fn)
397 return max_size;
398
399 bvm->bi_bdev = fc->dev->bdev;
400 bvm->bi_sector = flakey_map_sector(ti, bvm->bi_sector);
401
402 return min(max_size, q->merge_bvec_fn(q, bvm, biovec));
403}
404
405static int flakey_iterate_devices(struct dm_target *ti, iterate_devices_callout_fn fn, void *data)
406{
407 struct flakey_c *fc = ti->private;
408
409 return fn(ti, fc->dev, fc->start, ti->len, data);
410}
411
412static struct target_type flakey_target = {
413 .name = "flakey",
Mikulas Patockafd7c0922013-03-01 22:45:44 +0000414 .version = {1, 3, 1},
Josef Bacik3407ef52011-03-24 13:54:24 +0000415 .module = THIS_MODULE,
416 .ctr = flakey_ctr,
417 .dtr = flakey_dtr,
418 .map = flakey_map,
Mike Snitzera3998792011-08-02 12:32:06 +0100419 .end_io = flakey_end_io,
Josef Bacik3407ef52011-03-24 13:54:24 +0000420 .status = flakey_status,
421 .ioctl = flakey_ioctl,
422 .merge = flakey_merge,
423 .iterate_devices = flakey_iterate_devices,
424};
425
426static int __init dm_flakey_init(void)
427{
428 int r = dm_register_target(&flakey_target);
429
430 if (r < 0)
431 DMERR("register failed %d", r);
432
433 return r;
434}
435
436static void __exit dm_flakey_exit(void)
437{
438 dm_unregister_target(&flakey_target);
439}
440
441/* Module hooks */
442module_init(dm_flakey_init);
443module_exit(dm_flakey_exit);
444
445MODULE_DESCRIPTION(DM_NAME " flakey target");
446MODULE_AUTHOR("Joe Thornber <dm-devel@redhat.com>");
447MODULE_LICENSE("GPL");