fs-randomfail.c revision 4d71d712b42285afbd2a997f3408142ef0d5f899
a11689fe3fbb3bca11b9cb4ae5faf27db96401ccTimo Sirainen/* Copyright (c) 2015-2017 Dovecot authors, see the included COPYING file */
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen#define RANDOMFAIL_ERROR "Random failure injection"
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainenstatic const char *fs_op_names[FS_OP_COUNT] = {
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainen "wait", "metadata", "prefetch", "read", "write", "lock", "exists",
4e0204dbac352e271c79cfa6c74a71145a058de5Timo Sirainen uoff_t range_start[FS_OP_COUNT], range_end[FS_OP_COUNT];
1358e2c58ce29231485a5cfa454756d429ad3d2cTimo Sirainenstatic bool fs_op_find(const char *str, enum fs_op *op_r)
28cb56e6957f06717e876cecb7aabc820fdf632eTimo Sirainenfs_randomfail_add_probability(struct randomfail_fs *fs,
28cb56e6957f06717e876cecb7aabc820fdf632eTimo Sirainen const char **error_r)
28cb56e6957f06717e876cecb7aabc820fdf632eTimo Sirainen unsigned int num;
28cb56e6957f06717e876cecb7aabc820fdf632eTimo Sirainen if (str_to_uint(value, &num) < 0 || num > 100)
28cb56e6957f06717e876cecb7aabc820fdf632eTimo Sirainenfs_randomfail_add_probability_range(struct randomfail_fs *fs,
28cb56e6957f06717e876cecb7aabc820fdf632eTimo Sirainen const char **error_r)
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen const char *p;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen } else if (str_to_uoff(t_strdup_until(value, p), &num1) < 0 ||
bbc30fd4fa86723f6a72309ad3a2a96f34eabd6cTimo Sirainenstatic int fs_randomfail_parse_params(struct randomfail_fs *fs,
bbc30fd4fa86723f6a72309ad3a2a96f34eabd6cTimo Sirainen const char *const *tmp;
bbc30fd4fa86723f6a72309ad3a2a96f34eabd6cTimo Sirainen for (tmp = t_strsplit_spaces(params, ","); *tmp != NULL; tmp++) {
637ec4c33b4715737a41f7e58c9b6d1f693c27e2Timo Sirainen if ((ret = fs_randomfail_add_probability(fs, key, value, error_r)) != 0) {
637ec4c33b4715737a41f7e58c9b6d1f693c27e2Timo Sirainen if ((ret = fs_randomfail_add_probability_range(fs, key, value, error_r)) != 0) {
637ec4c33b4715737a41f7e58c9b6d1f693c27e2Timo Sirainen *error_r = t_strdup_printf("Unknown key '%s'", key);
637ec4c33b4715737a41f7e58c9b6d1f693c27e2Timo Sirainenfs_randomfail_init(struct fs *_fs, const char *args,
637ec4c33b4715737a41f7e58c9b6d1f693c27e2Timo Sirainen struct randomfail_fs *fs = (struct randomfail_fs *)_fs;
637ec4c33b4715737a41f7e58c9b6d1f693c27e2Timo Sirainen const char *p, *parent_name, *parent_args, *error;
13be7f7215efe02d020e9d823772861df98b82bdTimo Sirainen fs_set_error(_fs, "Randomfail parameters missing");
637ec4c33b4715737a41f7e58c9b6d1f693c27e2Timo Sirainen if (fs_randomfail_parse_params(fs, t_strdup_until(args, p++), &error) < 0) {
637ec4c33b4715737a41f7e58c9b6d1f693c27e2Timo Sirainen fs_set_error(_fs, "Invalid randomfail parameters: %s", error);
637ec4c33b4715737a41f7e58c9b6d1f693c27e2Timo Sirainen fs_set_error(_fs, "Parent filesystem not given as parameter");
637ec4c33b4715737a41f7e58c9b6d1f693c27e2Timo Sirainen parent_name = t_strdup_until(args, parent_args);
637ec4c33b4715737a41f7e58c9b6d1f693c27e2Timo Sirainen if (fs_init(parent_name, parent_args, set, &_fs->parent, &error) < 0) {
637ec4c33b4715737a41f7e58c9b6d1f693c27e2Timo Sirainenstatic void fs_randomfail_deinit(struct fs *_fs)
637ec4c33b4715737a41f7e58c9b6d1f693c27e2Timo Sirainen struct randomfail_fs *fs = (struct randomfail_fs *)_fs;
637ec4c33b4715737a41f7e58c9b6d1f693c27e2Timo Sirainenstatic enum fs_properties fs_randomfail_get_properties(struct fs *_fs)
dbd93ca6319a01fdea82853e8b4bd4b226d796f0Timo Sirainenstatic struct fs_file *fs_randomfail_file_alloc(void)
94163c620a8880024d0e8bbb503c788159fa222bTimo Sirainen struct randomfail_fs_file *file = i_new(struct randomfail_fs_file, 1);
dbd93ca6319a01fdea82853e8b4bd4b226d796f0Timo Sirainenfs_randomfail_file_init(struct fs_file *_file, const char *path,
94163c620a8880024d0e8bbb503c788159fa222bTimo Sirainen enum fs_open_mode mode, enum fs_open_flags flags)
dbd93ca6319a01fdea82853e8b4bd4b226d796f0Timo Sirainen struct randomfail_fs_file *file = (struct randomfail_fs_file *)_file;
dbd93ca6319a01fdea82853e8b4bd4b226d796f0Timo Sirainen file->file.parent = fs_file_init(_file->fs->parent, path, mode | flags);
dbd93ca6319a01fdea82853e8b4bd4b226d796f0Timo Sirainenstatic void fs_randomfail_file_deinit(struct fs_file *_file)
dbd93ca6319a01fdea82853e8b4bd4b226d796f0Timo Sirainen struct randomfail_fs_file *file = (struct randomfail_fs_file *)_file;
dbd93ca6319a01fdea82853e8b4bd4b226d796f0Timo Sirainenstatic bool fs_random_fail(struct fs *_fs, int divider, enum fs_op op)
94163c620a8880024d0e8bbb503c788159fa222bTimo Sirainen struct randomfail_fs *fs = (struct randomfail_fs *)_fs;
dbd93ca6319a01fdea82853e8b4bd4b226d796f0Timo Sirainen if ((unsigned int)i_rand_limit(100 * divider) <= fs->op_probability[op]) {
637ec4c33b4715737a41f7e58c9b6d1f693c27e2Timo Sirainenfs_file_random_fail_begin(struct randomfail_fs_file *file, enum fs_op op)
637ec4c33b4715737a41f7e58c9b6d1f693c27e2Timo Sirainenfs_file_random_fail_end(struct randomfail_fs_file *file,
1358e2c58ce29231485a5cfa454756d429ad3d2cTimo Sirainenfs_random_fail_range(struct fs *_fs, enum fs_op op, uoff_t *offset_r)
6ed1e82824590b514201d9db84ba96bdfc832dd5Timo Sirainen struct randomfail_fs *fs = (struct randomfail_fs *)_fs;
1358e2c58ce29231485a5cfa454756d429ad3d2cTimo Sirainen *offset_r = i_rand_minmax(fs->range_start[op], fs->range_end[op]);
6ed1e82824590b514201d9db84ba96bdfc832dd5Timo Sirainenfs_randomfail_get_metadata(struct fs_file *_file,
6ed1e82824590b514201d9db84ba96bdfc832dd5Timo Sirainen struct randomfail_fs_file *file = (struct randomfail_fs_file *)_file;
6ed1e82824590b514201d9db84ba96bdfc832dd5Timo Sirainen if (fs_file_random_fail_begin(file, FS_OP_METADATA))
6ed1e82824590b514201d9db84ba96bdfc832dd5Timo Sirainen ret = fs_get_metadata(_file->parent, metadata_r);
6ed1e82824590b514201d9db84ba96bdfc832dd5Timo Sirainen return fs_file_random_fail_end(file, ret, FS_OP_METADATA);
6ed1e82824590b514201d9db84ba96bdfc832dd5Timo Sirainenstatic bool fs_randomfail_prefetch(struct fs_file *_file, uoff_t length)
1358e2c58ce29231485a5cfa454756d429ad3d2cTimo Sirainen if (fs_random_fail(_file->fs, 1, FS_OP_PREFETCH))
1b33e848e84e6f74aa0e3339c32fa96bc15102a2Timo Sirainenstatic ssize_t fs_randomfail_read(struct fs_file *_file, void *buf, size_t size)
1b33e848e84e6f74aa0e3339c32fa96bc15102a2Timo Sirainen struct randomfail_fs_file *file = (struct randomfail_fs_file *)_file;
1b33e848e84e6f74aa0e3339c32fa96bc15102a2Timo Sirainen if (fs_file_random_fail_begin(file, FS_OP_READ))
1b33e848e84e6f74aa0e3339c32fa96bc15102a2Timo Sirainen if (fs_file_random_fail_end(file, ret < 0 ? -1 : 0, FS_OP_READ) < 0)
1b33e848e84e6f74aa0e3339c32fa96bc15102a2Timo Sirainenstatic struct istream *
1b33e848e84e6f74aa0e3339c32fa96bc15102a2Timo Sirainenfs_randomfail_read_stream(struct fs_file *_file, size_t max_buffer_size)
1b33e848e84e6f74aa0e3339c32fa96bc15102a2Timo Sirainen input = fs_read_stream(_file->parent, max_buffer_size);
1b33e848e84e6f74aa0e3339c32fa96bc15102a2Timo Sirainen if (!fs_random_fail_range(_file->fs, FS_OP_READ, &offset))
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainen input2 = i_stream_create_failure_at(input, offset, EIO, RANDOMFAIL_ERROR);
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainenstatic int fs_randomfail_write(struct fs_file *_file, const void *data, size_t size)
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainen struct randomfail_fs_file *file = (struct randomfail_fs_file *)_file;
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainen if (fs_file_random_fail_begin(file, FS_OP_WRITE))
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainen return fs_file_random_fail_end(file, ret, FS_OP_EXISTS);
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainenstatic void fs_randomfail_write_stream(struct fs_file *_file)
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainen struct randomfail_fs_file *file = (struct randomfail_fs_file *)_file;
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainen file->super_output = fs_write_stream(_file->parent);
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainen if (!fs_random_fail_range(_file->fs, FS_OP_WRITE, &offset))
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainen _file->output = o_stream_create_failure_at(file->super_output, offset,
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainenstatic int fs_randomfail_write_stream_finish(struct fs_file *_file, bool success)
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainen struct randomfail_fs_file *file = (struct randomfail_fs_file *)_file;
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainen fs_write_stream_abort_parent(_file, &file->super_output);
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainen if (fs_random_fail(_file->fs, 1, FS_OP_WRITE)) {
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainen fs_write_stream_abort_error(_file->parent, &file->super_output, RANDOMFAIL_ERROR);
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainen return fs_write_stream_finish(_file->parent, &file->super_output);
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainenfs_randomfail_lock(struct fs_file *_file, unsigned int secs, struct fs_lock **lock_r)
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainenstatic void fs_randomfail_unlock(struct fs_lock *_lock ATTR_UNUSED)
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainenstatic int fs_randomfail_exists(struct fs_file *_file)
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainen struct randomfail_fs_file *file = (struct randomfail_fs_file *)_file;
a78d5bd9772681a232de56b3dd6acefee66cc71bTimo Sirainen if (fs_file_random_fail_begin(file, FS_OP_EXISTS))
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen return fs_file_random_fail_end(file, ret, FS_OP_EXISTS);
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainenstatic int fs_randomfail_stat(struct fs_file *_file, struct stat *st_r)
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen struct randomfail_fs_file *file = (struct randomfail_fs_file *)_file;
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen if (fs_file_random_fail_begin(file, FS_OP_STAT))
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen return fs_file_random_fail_end(file, ret, FS_OP_STAT);
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainenstatic int fs_randomfail_get_nlinks(struct fs_file *_file, nlink_t *nlinks_r)
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen struct randomfail_fs_file *file = (struct randomfail_fs_file *)_file;
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen if (fs_file_random_fail_begin(file, FS_OP_STAT))
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen return fs_file_random_fail_end(file, ret, FS_OP_STAT);
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainenstatic int fs_randomfail_copy(struct fs_file *_src, struct fs_file *_dest)
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen struct randomfail_fs_file *dest = (struct randomfail_fs_file *)_dest;
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen if (fs_file_random_fail_begin(dest, FS_OP_COPY))
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen return fs_file_random_fail_end(dest, ret, FS_OP_COPY);
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainenstatic int fs_randomfail_rename(struct fs_file *_src, struct fs_file *_dest)
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen struct randomfail_fs_file *dest = (struct randomfail_fs_file *)_dest;
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen if (fs_file_random_fail_begin(dest, FS_OP_RENAME))
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen return fs_file_random_fail_end(dest, ret, FS_OP_RENAME);
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainenstatic int fs_randomfail_delete(struct fs_file *_file)
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen struct randomfail_fs_file *file = (struct randomfail_fs_file *)_file;
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen if (fs_file_random_fail_begin(file, FS_OP_DELETE))
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen return fs_file_random_fail_end(file, ret, FS_OP_DELETE);
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainenstatic struct fs_iter *fs_randomfail_iter_alloc(void)
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen struct randomfail_fs_iter *iter = i_new(struct randomfail_fs_iter, 1);
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainenfs_randomfail_iter_init(struct fs_iter *_iter, const char *path,
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen struct randomfail_fs_iter *iter = (struct randomfail_fs_iter *)_iter;
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen iter->super = fs_iter_init(_iter->fs->parent, path, flags);
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen if (fs_random_fail_range(_iter->fs, FS_OP_ITER, &pos))
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainenstatic const char *fs_randomfail_iter_next(struct fs_iter *_iter)
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen struct randomfail_fs_iter *iter = (struct randomfail_fs_iter *)_iter;
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen iter->super->async_callback = _iter->async_callback;
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen iter->super->async_context = _iter->async_context;
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen _iter->async_have_more = iter->super->async_have_more;
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainenstatic int fs_randomfail_iter_deinit(struct fs_iter *_iter)
3c3777721b56e065fac99a0f34e4cef4f293b517Timo Sirainen struct randomfail_fs_iter *iter = (struct randomfail_fs_iter *)_iter;