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