blob: b7341de87015e774c30e93324c5e05560b7f6c3f [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
Vivek Goyale80d1c82015-07-31 09:20:36 -0400186 r = -EINVAL;
Mikulas Patocka31998ef2012-03-28 18:41:26 +0100187 if (sscanf(dm_shift_arg(&as), "%llu%c", &tmpll, &dummy) != 1) {
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100188 ti->error = "Invalid device sector";
Josef Bacik3407ef52011-03-24 13:54:24 +0000189 goto bad;
190 }
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100191 fc->start = tmpll;
Josef Bacik3407ef52011-03-24 13:54:24 +0000192
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100193 r = dm_read_arg(_args, &as, &fc->up_interval, &ti->error);
194 if (r)
Josef Bacik3407ef52011-03-24 13:54:24 +0000195 goto bad;
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100196
197 r = dm_read_arg(_args, &as, &fc->down_interval, &ti->error);
198 if (r)
199 goto bad;
Josef Bacik3407ef52011-03-24 13:54:24 +0000200
201 if (!(fc->up_interval + fc->down_interval)) {
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100202 ti->error = "Total (up + down) interval is zero";
Josef Bacik3407ef52011-03-24 13:54:24 +0000203 goto bad;
204 }
205
206 if (fc->up_interval + fc->down_interval < fc->up_interval) {
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100207 ti->error = "Interval overflow";
Josef Bacik3407ef52011-03-24 13:54:24 +0000208 goto bad;
209 }
210
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100211 r = parse_features(&as, fc, ti);
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100212 if (r)
213 goto bad;
214
Vivek Goyale80d1c82015-07-31 09:20:36 -0400215 r = dm_get_device(ti, devname, dm_table_get_mode(ti->table), &fc->dev);
216 if (r) {
Mike Snitzerdfd068b2011-08-02 12:32:05 +0100217 ti->error = "Device lookup failed";
Josef Bacik3407ef52011-03-24 13:54:24 +0000218 goto bad;
219 }
220
Alasdair G Kergon55a62ee2013-03-01 22:45:47 +0000221 ti->num_flush_bios = 1;
222 ti->num_discard_bios = 1;
Mike Snitzer30187e12016-01-31 13:28:26 -0500223 ti->per_io_data_size = sizeof(struct per_bio_data);
Josef Bacik3407ef52011-03-24 13:54:24 +0000224 ti->private = fc;
225 return 0;
226
227bad:
228 kfree(fc);
Vivek Goyale80d1c82015-07-31 09:20:36 -0400229 return r;
Josef Bacik3407ef52011-03-24 13:54:24 +0000230}
231
232static void flakey_dtr(struct dm_target *ti)
233{
234 struct flakey_c *fc = ti->private;
235
236 dm_put_device(ti, fc->dev);
237 kfree(fc);
238}
239
240static sector_t flakey_map_sector(struct dm_target *ti, sector_t bi_sector)
241{
242 struct flakey_c *fc = ti->private;
243
Mike Snitzer30e41712011-08-02 12:32:05 +0100244 return fc->start + dm_target_offset(ti, bi_sector);
Josef Bacik3407ef52011-03-24 13:54:24 +0000245}
246
247static void flakey_map_bio(struct dm_target *ti, struct bio *bio)
248{
249 struct flakey_c *fc = ti->private;
250
251 bio->bi_bdev = fc->dev->bdev;
252 if (bio_sectors(bio))
Kent Overstreet4f024f32013-10-11 15:44:27 -0700253 bio->bi_iter.bi_sector =
254 flakey_map_sector(ti, bio->bi_iter.bi_sector);
Josef Bacik3407ef52011-03-24 13:54:24 +0000255}
256
Mike Snitzera3998792011-08-02 12:32:06 +0100257static void corrupt_bio_data(struct bio *bio, struct flakey_c *fc)
258{
259 unsigned bio_bytes = bio_cur_bytes(bio);
260 char *data = bio_data(bio);
261
262 /*
263 * Overwrite the Nth byte of the data returned.
264 */
265 if (data && bio_bytes >= fc->corrupt_bio_byte) {
266 data[fc->corrupt_bio_byte - 1] = fc->corrupt_bio_value;
267
268 DMDEBUG("Corrupting data bio=%p by writing %u to byte %u "
269 "(rw=%c bi_rw=%lu bi_sector=%llu cur_bytes=%u)\n",
270 bio, fc->corrupt_bio_value, fc->corrupt_bio_byte,
Kent Overstreet4f024f32013-10-11 15:44:27 -0700271 (bio_data_dir(bio) == WRITE) ? 'w' : 'r', bio->bi_rw,
272 (unsigned long long)bio->bi_iter.bi_sector, bio_bytes);
Mike Snitzera3998792011-08-02 12:32:06 +0100273 }
274}
275
Mikulas Patocka7de3ee52012-12-21 20:23:41 +0000276static int flakey_map(struct dm_target *ti, struct bio *bio)
Josef Bacik3407ef52011-03-24 13:54:24 +0000277{
278 struct flakey_c *fc = ti->private;
279 unsigned elapsed;
Mikulas Patockac7cfdf52012-12-21 20:23:39 +0000280 struct per_bio_data *pb = dm_per_bio_data(bio, sizeof(struct per_bio_data));
281 pb->bio_submitted = false;
Josef Bacik3407ef52011-03-24 13:54:24 +0000282
283 /* Are we alive ? */
284 elapsed = (jiffies - fc->start_time) / HZ;
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100285 if (elapsed % (fc->up_interval + fc->down_interval) >= fc->up_interval) {
Mike Snitzera3998792011-08-02 12:32:06 +0100286 /*
287 * Flag this bio as submitted while down.
288 */
Mikulas Patockac7cfdf52012-12-21 20:23:39 +0000289 pb->bio_submitted = true;
Josef Bacik3407ef52011-03-24 13:54:24 +0000290
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100291 /*
Mike Snitzera3998792011-08-02 12:32:06 +0100292 * Map reads as normal.
293 */
294 if (bio_data_dir(bio) == READ)
295 goto map_bio;
296
297 /*
298 * Drop writes?
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100299 */
300 if (test_bit(DROP_WRITES, &fc->flags)) {
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200301 bio_endio(bio);
Mike Snitzera3998792011-08-02 12:32:06 +0100302 return DM_MAPIO_SUBMITTED;
303 }
304
305 /*
306 * Corrupt matching writes.
307 */
308 if (fc->corrupt_bio_byte && (fc->corrupt_bio_rw == WRITE)) {
309 if (all_corrupt_bio_flags_match(bio, fc))
310 corrupt_bio_data(bio, fc);
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100311 goto map_bio;
312 }
313
314 /*
Mike Snitzera3998792011-08-02 12:32:06 +0100315 * By default, error all I/O.
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100316 */
317 return -EIO;
318 }
319
320map_bio:
Josef Bacik3407ef52011-03-24 13:54:24 +0000321 flakey_map_bio(ti, bio);
322
323 return DM_MAPIO_REMAPPED;
324}
325
Mikulas Patocka7de3ee52012-12-21 20:23:41 +0000326static int flakey_end_io(struct dm_target *ti, struct bio *bio, int error)
Mike Snitzera3998792011-08-02 12:32:06 +0100327{
328 struct flakey_c *fc = ti->private;
Mikulas Patockac7cfdf52012-12-21 20:23:39 +0000329 struct per_bio_data *pb = dm_per_bio_data(bio, sizeof(struct per_bio_data));
Mike Snitzera3998792011-08-02 12:32:06 +0100330
331 /*
332 * Corrupt successful READs while in down state.
333 * If flags were specified, only corrupt those that match.
334 */
Mikulas Patockac7cfdf52012-12-21 20:23:39 +0000335 if (fc->corrupt_bio_byte && !error && pb->bio_submitted &&
Mike Snitzera3998792011-08-02 12:32:06 +0100336 (bio_data_dir(bio) == READ) && (fc->corrupt_bio_rw == READ) &&
337 all_corrupt_bio_flags_match(bio, fc))
338 corrupt_bio_data(bio, fc);
339
340 return error;
341}
342
Mikulas Patockafd7c0922013-03-01 22:45:44 +0000343static void flakey_status(struct dm_target *ti, status_type_t type,
344 unsigned status_flags, char *result, unsigned maxlen)
Josef Bacik3407ef52011-03-24 13:54:24 +0000345{
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100346 unsigned sz = 0;
Josef Bacik3407ef52011-03-24 13:54:24 +0000347 struct flakey_c *fc = ti->private;
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100348 unsigned drop_writes;
Josef Bacik3407ef52011-03-24 13:54:24 +0000349
350 switch (type) {
351 case STATUSTYPE_INFO:
352 result[0] = '\0';
353 break;
354
355 case STATUSTYPE_TABLE:
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100356 DMEMIT("%s %llu %u %u ", fc->dev->name,
357 (unsigned long long)fc->start, fc->up_interval,
358 fc->down_interval);
359
360 drop_writes = test_bit(DROP_WRITES, &fc->flags);
Mike Snitzera3998792011-08-02 12:32:06 +0100361 DMEMIT("%u ", drop_writes + (fc->corrupt_bio_byte > 0) * 5);
362
Mike Snitzerb26f5e32011-08-02 12:32:05 +0100363 if (drop_writes)
364 DMEMIT("drop_writes ");
Mike Snitzera3998792011-08-02 12:32:06 +0100365
366 if (fc->corrupt_bio_byte)
367 DMEMIT("corrupt_bio_byte %u %c %u %u ",
368 fc->corrupt_bio_byte,
369 (fc->corrupt_bio_rw == WRITE) ? 'w' : 'r',
370 fc->corrupt_bio_value, fc->corrupt_bio_flags);
371
Josef Bacik3407ef52011-03-24 13:54:24 +0000372 break;
373 }
Josef Bacik3407ef52011-03-24 13:54:24 +0000374}
375
Christoph Hellwige56f81e2015-10-15 14:10:50 +0200376static int flakey_prepare_ioctl(struct dm_target *ti,
377 struct block_device **bdev, fmode_t *mode)
Josef Bacik3407ef52011-03-24 13:54:24 +0000378{
379 struct flakey_c *fc = ti->private;
Christoph Hellwige56f81e2015-10-15 14:10:50 +0200380
381 *bdev = fc->dev->bdev;
Josef Bacik3407ef52011-03-24 13:54:24 +0000382
Paolo Bonziniec8013b2012-01-12 16:01:29 +0100383 /*
384 * Only pass ioctls through if the device sizes match exactly.
385 */
386 if (fc->start ||
Christoph Hellwige56f81e2015-10-15 14:10:50 +0200387 ti->len != i_size_read((*bdev)->bd_inode) >> SECTOR_SHIFT)
388 return 1;
389 return 0;
Josef Bacik3407ef52011-03-24 13:54:24 +0000390}
391
Josef Bacik3407ef52011-03-24 13:54:24 +0000392static int flakey_iterate_devices(struct dm_target *ti, iterate_devices_callout_fn fn, void *data)
393{
394 struct flakey_c *fc = ti->private;
395
396 return fn(ti, fc->dev, fc->start, ti->len, data);
397}
398
399static struct target_type flakey_target = {
400 .name = "flakey",
Mikulas Patockafd7c0922013-03-01 22:45:44 +0000401 .version = {1, 3, 1},
Josef Bacik3407ef52011-03-24 13:54:24 +0000402 .module = THIS_MODULE,
403 .ctr = flakey_ctr,
404 .dtr = flakey_dtr,
405 .map = flakey_map,
Mike Snitzera3998792011-08-02 12:32:06 +0100406 .end_io = flakey_end_io,
Josef Bacik3407ef52011-03-24 13:54:24 +0000407 .status = flakey_status,
Christoph Hellwige56f81e2015-10-15 14:10:50 +0200408 .prepare_ioctl = flakey_prepare_ioctl,
Josef Bacik3407ef52011-03-24 13:54:24 +0000409 .iterate_devices = flakey_iterate_devices,
410};
411
412static int __init dm_flakey_init(void)
413{
414 int r = dm_register_target(&flakey_target);
415
416 if (r < 0)
417 DMERR("register failed %d", r);
418
419 return r;
420}
421
422static void __exit dm_flakey_exit(void)
423{
424 dm_unregister_target(&flakey_target);
425}
426
427/* Module hooks */
428module_init(dm_flakey_init);
429module_exit(dm_flakey_exit);
430
431MODULE_DESCRIPTION(DM_NAME " flakey target");
432MODULE_AUTHOR("Joe Thornber <dm-devel@redhat.com>");
433MODULE_LICENSE("GPL");