diff options
Diffstat (limited to 'src/lib-fs/fs-randomfail.c')
| -rw-r--r-- | src/lib-fs/fs-randomfail.c | 555 |
1 files changed, 555 insertions, 0 deletions
diff --git a/src/lib-fs/fs-randomfail.c b/src/lib-fs/fs-randomfail.c new file mode 100644 index 0000000..48b1bf0 --- /dev/null +++ b/src/lib-fs/fs-randomfail.c @@ -0,0 +1,555 @@ +/* Copyright (c) 2015-2018 Dovecot authors, see the included COPYING file */ + +#include "lib.h" +#include "istream.h" +#include "istream-private.h" +#include "istream-concat.h" +#include "istream-failure-at.h" +#include "ostream-failure-at.h" +#include "ostream.h" +#include "fs-api-private.h" + + +#define RANDOMFAIL_ERROR "Random failure injection" + +static const char *fs_op_names[FS_OP_COUNT] = { + "wait", "metadata", "prefetch", "read", "write", "lock", "exists", + "stat", "copy", "rename", "delete", "iter" +}; + +struct randomfail_fs { + struct fs fs; + unsigned int op_probability[FS_OP_COUNT]; + uoff_t range_start[FS_OP_COUNT], range_end[FS_OP_COUNT]; +}; + +struct randomfail_fs_file { + struct fs_file file; + struct fs_file *super_read; + struct istream *input; + bool op_pending[FS_OP_COUNT]; + + struct ostream *super_output; +}; + +struct randomfail_fs_iter { + struct fs_iter iter; + struct fs_iter *super; + unsigned int fail_pos; +}; + +#define RANDOMFAIL_FS(ptr) container_of((ptr), struct randomfail_fs, fs) +#define RANDOMFAIL_FILE(ptr) container_of((ptr), struct randomfail_fs_file, file) +#define RANDOMFAIL_ITER(ptr) container_of((ptr), struct randomfail_fs_iter, iter) + +static struct fs *fs_randomfail_alloc(void) +{ + struct randomfail_fs *fs; + + fs = i_new(struct randomfail_fs, 1); + fs->fs = fs_class_randomfail; + return &fs->fs; +} + +static bool fs_op_find(const char *str, enum fs_op *op_r) +{ + enum fs_op op; + + for (op = 0; op < FS_OP_COUNT; op++) { + if (strcmp(fs_op_names[op], str) == 0) { + *op_r = op; + return TRUE; + } + } + return FALSE; +} + +static int +fs_randomfail_add_probability(struct randomfail_fs *fs, + const char *key, const char *value, + const char **error_r) +{ + unsigned int num; + enum fs_op op; + bool invalid_value = FALSE; + + if (str_to_uint(value, &num) < 0 || num > 100) + invalid_value = TRUE; + if (fs_op_find(key, &op)) { + if (invalid_value) { + *error_r = "Invalid probability value"; + return -1; + } + fs->op_probability[op] = num; + return 1; + } + if (strcmp(key, "all") == 0) { + if (invalid_value) { + *error_r = "Invalid probability value"; + return -1; + } + for (op = 0; op < FS_OP_COUNT; op++) + fs->op_probability[op] = num; + return 1; + } + return 0; +} + +static int +fs_randomfail_add_probability_range(struct randomfail_fs *fs, + const char *key, const char *value, + const char **error_r) +{ + enum fs_op op; + const char *p; + uoff_t num1, num2; + + if (strcmp(key, "read-range") == 0) + op = FS_OP_READ; + else if (strcmp(key, "write-range") == 0) + op = FS_OP_WRITE; + else if (strcmp(key, "iter-range") == 0) + op = FS_OP_ITER; + else + return 0; + + p = strchr(value, '-'); + if (p == NULL) { + if (str_to_uoff(value, &num1) < 0) { + *error_r = "Invalid range value"; + return -1; + } + num2 = num1; + } else if (str_to_uoff(t_strdup_until(value, p), &num1) < 0 || + str_to_uoff(p+1, &num2) < 0 || num1 > num2) { + *error_r = "Invalid range values"; + return -1; + } + fs->range_start[op] = num1; + fs->range_end[op] = num2; + return 1; +} + +static int fs_randomfail_parse_params(struct randomfail_fs *fs, + const char *params, const char **error_r) +{ + const char *const *tmp; + int ret; + + for (tmp = t_strsplit_spaces(params, ","); *tmp != NULL; tmp++) { + const char *key = *tmp; + const char *value = strchr(key, '='); + + if (value == NULL) { + *error_r = "Missing '='"; + return -1; + } + key = t_strdup_until(key, value++); + if ((ret = fs_randomfail_add_probability(fs, key, value, error_r)) != 0) { + if (ret < 0) + return -1; + continue; + } + if ((ret = fs_randomfail_add_probability_range(fs, key, value, error_r)) != 0) { + if (ret < 0) + return -1; + continue; + } + *error_r = t_strdup_printf("Unknown key '%s'", key); + return -1; + } + return 0; +} + +static int +fs_randomfail_init(struct fs *_fs, const char *args, + const struct fs_settings *set, const char **error_r) +{ + struct randomfail_fs *fs = RANDOMFAIL_FS(_fs); + const char *p, *parent_name, *parent_args, *error; + + p = strchr(args, ':'); + if (p == NULL) { + *error_r = "Randomfail parameters missing"; + return -1; + } + if (fs_randomfail_parse_params(fs, t_strdup_until(args, p++), &error) < 0) { + *error_r = t_strdup_printf( + "Invalid randomfail parameters: %s", error); + return -1; + } + args = p; + + if (*args == '\0') { + *error_r = "Parent filesystem not given as parameter"; + return -1; + } + + parent_args = strchr(args, ':'); + if (parent_args == NULL) { + parent_name = args; + parent_args = ""; + } else { + parent_name = t_strdup_until(args, parent_args); + parent_args++; + } + if (fs_init(parent_name, parent_args, set, &_fs->parent, error_r) < 0) + return -1; + return 0; +} + +static void fs_randomfail_free(struct fs *_fs) +{ + struct randomfail_fs *fs = RANDOMFAIL_FS(_fs); + + i_free(fs); +} + +static enum fs_properties fs_randomfail_get_properties(struct fs *_fs) +{ + return fs_get_properties(_fs->parent); +} + +static struct fs_file *fs_randomfail_file_alloc(void) +{ + struct randomfail_fs_file *file = i_new(struct randomfail_fs_file, 1); + return &file->file; +} + +static void +fs_randomfail_file_init(struct fs_file *_file, const char *path, + enum fs_open_mode mode, enum fs_open_flags flags) +{ + struct randomfail_fs_file *file = RANDOMFAIL_FILE(_file); + + file->file.path = i_strdup(path); + file->file.parent = fs_file_init_parent(_file, path, mode, flags); +} + +static void fs_randomfail_file_deinit(struct fs_file *_file) +{ + struct randomfail_fs_file *file = RANDOMFAIL_FILE(_file); + + fs_file_free(_file); + i_free(file->file.path); + i_free(file); +} + +static bool fs_random_fail(struct fs *_fs, struct event *event, + int divider, enum fs_op op) +{ + struct randomfail_fs *fs = RANDOMFAIL_FS(_fs); + + if (fs->op_probability[op] == 0) + return FALSE; + if ((unsigned int)i_rand_limit(100 * divider) <= fs->op_probability[op]) { + fs_set_error(event, EIO, RANDOMFAIL_ERROR); + return TRUE; + } + return FALSE; +} + +static bool +fs_file_random_fail_begin(struct randomfail_fs_file *file, enum fs_op op) +{ + if (!file->op_pending[op]) { + if (fs_random_fail(file->file.fs, file->file.event, 2, op)) + return TRUE; + } + file->op_pending[op] = TRUE; + return FALSE; +} + +static int +fs_file_random_fail_end(struct randomfail_fs_file *file, + int ret, enum fs_op op) +{ + if (ret == 0 || errno != EAGAIN) { + if (fs_random_fail(file->file.fs, file->file.event, 2, op)) + return -1; + file->op_pending[op] = FALSE; + } + return ret; +} + +static bool +fs_random_fail_range(struct fs *_fs, struct event *event, + enum fs_op op, uoff_t *offset_r) +{ + struct randomfail_fs *fs = RANDOMFAIL_FS(_fs); + + if (!fs_random_fail(_fs, event, 1, op)) + return FALSE; + *offset_r = i_rand_minmax(fs->range_start[op], fs->range_end[op]); + return TRUE; +} + +static int +fs_randomfail_get_metadata(struct fs_file *_file, + enum fs_get_metadata_flags flags, + const ARRAY_TYPE(fs_metadata) **metadata_r) +{ + struct randomfail_fs_file *file = RANDOMFAIL_FILE(_file); + int ret; + + if (fs_file_random_fail_begin(file, FS_OP_METADATA)) + return -1; + ret = fs_get_metadata_full(_file->parent, flags, metadata_r); + return fs_file_random_fail_end(file, ret, FS_OP_METADATA); +} + +static bool fs_randomfail_prefetch(struct fs_file *_file, uoff_t length) +{ + if (fs_random_fail(_file->fs, _file->event, 1, FS_OP_PREFETCH)) + return TRUE; + return fs_prefetch(_file->parent, length); +} + +static ssize_t fs_randomfail_read(struct fs_file *_file, void *buf, size_t size) +{ + struct randomfail_fs_file *file = RANDOMFAIL_FILE(_file); + int ret; + + if (fs_file_random_fail_begin(file, FS_OP_READ)) + return -1; + ret = fs_read(_file->parent, buf, size); + if (fs_file_random_fail_end(file, ret < 0 ? -1 : 0, FS_OP_READ) < 0) + return -1; + return ret; +} + +static struct istream * +fs_randomfail_read_stream(struct fs_file *_file, size_t max_buffer_size) +{ + struct istream *input, *input2; + uoff_t offset; + + input = fs_read_stream(_file->parent, max_buffer_size); + if (!fs_random_fail_range(_file->fs, _file->event, FS_OP_READ, &offset)) + return input; + input2 = i_stream_create_failure_at(input, offset, EIO, RANDOMFAIL_ERROR); + i_stream_unref(&input); + return input2; +} + +static int fs_randomfail_write(struct fs_file *_file, const void *data, size_t size) +{ + struct randomfail_fs_file *file = RANDOMFAIL_FILE(_file); + int ret; + + if (fs_file_random_fail_begin(file, FS_OP_WRITE)) + return -1; + ret = fs_write(_file->parent, data, size); + return fs_file_random_fail_end(file, ret, FS_OP_EXISTS); +} + +static void fs_randomfail_write_stream(struct fs_file *_file) +{ + struct randomfail_fs_file *file = RANDOMFAIL_FILE(_file); + uoff_t offset; + + i_assert(_file->output == NULL); + + file->super_output = fs_write_stream(_file->parent); + if (!fs_random_fail_range(_file->fs, _file->event, FS_OP_WRITE, &offset)) + _file->output = file->super_output; + else { + _file->output = o_stream_create_failure_at(file->super_output, offset, + RANDOMFAIL_ERROR); + } +} + +static int fs_randomfail_write_stream_finish(struct fs_file *_file, bool success) +{ + struct randomfail_fs_file *file = RANDOMFAIL_FILE(_file); + + if (_file->output != NULL) { + if (_file->output == file->super_output) + _file->output = NULL; + else + o_stream_unref(&_file->output); + if (!success) { + fs_write_stream_abort_parent(_file, &file->super_output); + return -1; + } + if (fs_random_fail(_file->fs, _file->event, 1, FS_OP_WRITE)) { + fs_write_stream_abort_error(_file->parent, &file->super_output, RANDOMFAIL_ERROR); + return -1; + } + } + return fs_write_stream_finish(_file->parent, &file->super_output); +} + +static int +fs_randomfail_lock(struct fs_file *_file, unsigned int secs, struct fs_lock **lock_r) +{ + if (fs_random_fail(_file->fs, _file->event, 1, FS_OP_LOCK)) + return -1; + return fs_lock(_file->parent, secs, lock_r); +} + +static void fs_randomfail_unlock(struct fs_lock *_lock ATTR_UNUSED) +{ + i_unreached(); +} + +static int fs_randomfail_exists(struct fs_file *_file) +{ + struct randomfail_fs_file *file = RANDOMFAIL_FILE(_file); + int ret; + + if (fs_file_random_fail_begin(file, FS_OP_EXISTS)) + return -1; + ret = fs_exists(_file->parent); + return fs_file_random_fail_end(file, ret, FS_OP_EXISTS); +} + +static int fs_randomfail_stat(struct fs_file *_file, struct stat *st_r) +{ + struct randomfail_fs_file *file = RANDOMFAIL_FILE(_file); + int ret; + + if (fs_file_random_fail_begin(file, FS_OP_STAT)) + return -1; + ret = fs_stat(_file->parent, st_r); + return fs_file_random_fail_end(file, ret, FS_OP_STAT); +} + +static int fs_randomfail_get_nlinks(struct fs_file *_file, nlink_t *nlinks_r) +{ + struct randomfail_fs_file *file = RANDOMFAIL_FILE(_file); + int ret; + + if (fs_file_random_fail_begin(file, FS_OP_STAT)) + return -1; + ret = fs_get_nlinks(_file->parent, nlinks_r); + return fs_file_random_fail_end(file, ret, FS_OP_STAT); +} + +static int fs_randomfail_copy(struct fs_file *_src, struct fs_file *_dest) +{ + struct randomfail_fs_file *dest = RANDOMFAIL_FILE(_dest); + int ret; + + if (fs_file_random_fail_begin(dest, FS_OP_COPY)) + return -1; + + if (_src != NULL) + ret = fs_copy(_src->parent, _dest->parent); + else + ret = fs_copy_finish_async(_dest->parent); + return fs_file_random_fail_end(dest, ret, FS_OP_COPY); +} + +static int fs_randomfail_rename(struct fs_file *_src, struct fs_file *_dest) +{ + struct randomfail_fs_file *dest = RANDOMFAIL_FILE(_dest); + int ret; + + if (fs_file_random_fail_begin(dest, FS_OP_RENAME)) + return -1; + ret = fs_rename(_src->parent, _dest->parent); + return fs_file_random_fail_end(dest, ret, FS_OP_RENAME); +} + +static int fs_randomfail_delete(struct fs_file *_file) +{ + struct randomfail_fs_file *file = RANDOMFAIL_FILE(_file); + int ret; + + if (fs_file_random_fail_begin(file, FS_OP_DELETE)) + return -1; + ret = fs_delete(_file->parent); + return fs_file_random_fail_end(file, ret, FS_OP_DELETE); +} + +static struct fs_iter *fs_randomfail_iter_alloc(void) +{ + struct randomfail_fs_iter *iter = i_new(struct randomfail_fs_iter, 1); + return &iter->iter; +} + +static void +fs_randomfail_iter_init(struct fs_iter *_iter, const char *path, + enum fs_iter_flags flags) +{ + struct randomfail_fs_iter *iter = RANDOMFAIL_ITER(_iter); + uoff_t pos; + + iter->super = fs_iter_init_parent(_iter, path, flags); + if (fs_random_fail_range(_iter->fs, _iter->event, FS_OP_ITER, &pos)) + iter->fail_pos = pos + 1; +} + +static const char *fs_randomfail_iter_next(struct fs_iter *_iter) +{ + struct randomfail_fs_iter *iter = RANDOMFAIL_ITER(_iter); + const char *fname; + + if (iter->fail_pos > 0) { + if (iter->fail_pos == 1) + return NULL; + iter->fail_pos--; + } + + iter->super->async_callback = _iter->async_callback; + iter->super->async_context = _iter->async_context; + + fname = fs_iter_next(iter->super); + _iter->async_have_more = iter->super->async_have_more; + return fname; +} + +static int fs_randomfail_iter_deinit(struct fs_iter *_iter) +{ + struct randomfail_fs_iter *iter = RANDOMFAIL_ITER(_iter); + const char *error; + int ret; + + if ((ret = fs_iter_deinit(&iter->super, &error)) < 0) + fs_set_error_errno(_iter->event, "%s", error); + if (iter->fail_pos == 1) { + fs_set_error(_iter->event, EIO, RANDOMFAIL_ERROR); + ret = -1; + } + return ret; +} + +const struct fs fs_class_randomfail = { + .name = "randomfail", + .v = { + fs_randomfail_alloc, + fs_randomfail_init, + NULL, + fs_randomfail_free, + fs_randomfail_get_properties, + fs_randomfail_file_alloc, + fs_randomfail_file_init, + fs_randomfail_file_deinit, + fs_wrapper_file_close, + fs_wrapper_file_get_path, + fs_wrapper_set_async_callback, + fs_wrapper_wait_async, + fs_wrapper_set_metadata, + fs_randomfail_get_metadata, + fs_randomfail_prefetch, + fs_randomfail_read, + fs_randomfail_read_stream, + fs_randomfail_write, + fs_randomfail_write_stream, + fs_randomfail_write_stream_finish, + fs_randomfail_lock, + fs_randomfail_unlock, + fs_randomfail_exists, + fs_randomfail_stat, + fs_randomfail_copy, + fs_randomfail_rename, + fs_randomfail_delete, + fs_randomfail_iter_alloc, + fs_randomfail_iter_init, + fs_randomfail_iter_next, + fs_randomfail_iter_deinit, + NULL, + fs_randomfail_get_nlinks, + } +}; |