xref: /openbmc/linux/drivers/nvme/host/fault_inject.c (revision c900529f3d9161bfde5cca0754f83b4d3c3e0220)
1bc50ad75SChristoph Hellwig // SPDX-License-Identifier: GPL-2.0
2b9e03857SThomas Tai /*
3b9e03857SThomas Tai  * fault injection support for nvme.
4b9e03857SThomas Tai  *
5b9e03857SThomas Tai  * Copyright (c) 2018, Oracle and/or its affiliates
6b9e03857SThomas Tai  */
7b9e03857SThomas Tai 
8b9e03857SThomas Tai #include <linux/moduleparam.h>
9b9e03857SThomas Tai #include "nvme.h"
10b9e03857SThomas Tai 
11b9e03857SThomas Tai static DECLARE_FAULT_ATTR(fail_default_attr);
12b9e03857SThomas Tai /* optional fault injection attributes boot time option:
13b9e03857SThomas Tai  * nvme_core.fail_request=<interval>,<probability>,<space>,<times>
14b9e03857SThomas Tai  */
15b9e03857SThomas Tai static char *fail_request;
16b9e03857SThomas Tai module_param(fail_request, charp, 0000);
17b9e03857SThomas Tai 
nvme_fault_inject_init(struct nvme_fault_inject * fault_inj,const char * dev_name)18a3646451SAkinobu Mita void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj,
19a3646451SAkinobu Mita 			    const char *dev_name)
20b9e03857SThomas Tai {
21b9e03857SThomas Tai 	struct dentry *dir, *parent;
22b9e03857SThomas Tai 	struct fault_attr *attr = &fault_inj->attr;
23b9e03857SThomas Tai 
24b9e03857SThomas Tai 	/* set default fault injection attribute */
25b9e03857SThomas Tai 	if (fail_request)
26b9e03857SThomas Tai 		setup_fault_attr(&fail_default_attr, fail_request);
27b9e03857SThomas Tai 
28b9e03857SThomas Tai 	/* create debugfs directory and attribute */
29a3646451SAkinobu Mita 	parent = debugfs_create_dir(dev_name, NULL);
30*733ba346SMinjie Du 	if (IS_ERR(parent)) {
31a3646451SAkinobu Mita 		pr_warn("%s: failed to create debugfs directory\n", dev_name);
32b9e03857SThomas Tai 		return;
33b9e03857SThomas Tai 	}
34b9e03857SThomas Tai 
35b9e03857SThomas Tai 	*attr = fail_default_attr;
36b9e03857SThomas Tai 	dir = fault_create_debugfs_attr("fault_inject", parent, attr);
37b9e03857SThomas Tai 	if (IS_ERR(dir)) {
38a3646451SAkinobu Mita 		pr_warn("%s: failed to create debugfs attr\n", dev_name);
39b9e03857SThomas Tai 		debugfs_remove_recursive(parent);
40b9e03857SThomas Tai 		return;
41b9e03857SThomas Tai 	}
42a3646451SAkinobu Mita 	fault_inj->parent = parent;
43b9e03857SThomas Tai 
44b9e03857SThomas Tai 	/* create debugfs for status code and dont_retry */
45b9e03857SThomas Tai 	fault_inj->status = NVME_SC_INVALID_OPCODE;
46b9e03857SThomas Tai 	fault_inj->dont_retry = true;
47b9e03857SThomas Tai 	debugfs_create_x16("status", 0600, dir,	&fault_inj->status);
48b9e03857SThomas Tai 	debugfs_create_bool("dont_retry", 0600, dir, &fault_inj->dont_retry);
49b9e03857SThomas Tai }
50b9e03857SThomas Tai 
nvme_fault_inject_fini(struct nvme_fault_inject * fault_inject)51a3646451SAkinobu Mita void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inject)
52b9e03857SThomas Tai {
53b9e03857SThomas Tai 	/* remove debugfs directories */
54a3646451SAkinobu Mita 	debugfs_remove_recursive(fault_inject->parent);
55b9e03857SThomas Tai }
56b9e03857SThomas Tai 
nvme_should_fail(struct request * req)57b9e03857SThomas Tai void nvme_should_fail(struct request *req)
58b9e03857SThomas Tai {
59f3fa33acSChristoph Hellwig 	struct gendisk *disk = req->q->disk;
60a3646451SAkinobu Mita 	struct nvme_fault_inject *fault_inject = NULL;
61b9e03857SThomas Tai 	u16 status;
62b9e03857SThomas Tai 
63a3646451SAkinobu Mita 	if (disk) {
64a3646451SAkinobu Mita 		struct nvme_ns *ns = disk->private_data;
65b9e03857SThomas Tai 
66a3646451SAkinobu Mita 		if (ns)
67a3646451SAkinobu Mita 			fault_inject = &ns->fault_inject;
68a3646451SAkinobu Mita 		else
69a3646451SAkinobu Mita 			WARN_ONCE(1, "No namespace found for request\n");
70f79d5fdaSAkinobu Mita 	} else {
71f79d5fdaSAkinobu Mita 		fault_inject = &nvme_req(req)->ctrl->fault_inject;
72a3646451SAkinobu Mita 	}
73a3646451SAkinobu Mita 
74a3646451SAkinobu Mita 	if (fault_inject && should_fail(&fault_inject->attr, 1)) {
75b9e03857SThomas Tai 		/* inject status code and DNR bit */
76a3646451SAkinobu Mita 		status = fault_inject->status;
77a3646451SAkinobu Mita 		if (fault_inject->dont_retry)
78b9e03857SThomas Tai 			status |= NVME_SC_DNR;
79b9e03857SThomas Tai 		nvme_req(req)->status =	status;
80b9e03857SThomas Tai 	}
81b9e03857SThomas Tai }
82b9e03857SThomas Tai EXPORT_SYMBOL_GPL(nvme_should_fail);
83