2 * Copyright (C) 2012-2016 Intel Corporation
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
34 #include <sys/sysctl.h>
36 #include "nvme_private.h"
39 #define NVME_USE_NVD 1
42 int nvme_use_nvd = NVME_USE_NVD;
44 SYSCTL_NODE(_hw, OID_AUTO, nvme, CTLFLAG_RD, 0, "NVMe sysctl tunables");
45 SYSCTL_INT(_hw_nvme, OID_AUTO, use_nvd, CTLFLAG_RDTUN,
46 &nvme_use_nvd, 1, "1 = Create NVD devices, 0 = Create NDA devices");
49 * CTLTYPE_S64 and sysctl_handle_64 were added in r217616. Define these
50 * explicitly here for older kernels that don't include the r217616
54 #define CTLTYPE_S64 CTLTYPE_QUAD
55 #define sysctl_handle_64 sysctl_handle_quad
59 nvme_dump_queue(struct nvme_qpair *qpair)
61 struct nvme_completion *cpl;
62 struct nvme_command *cmd;
65 printf("id:%04Xh phase:%d\n", qpair->id, qpair->phase);
67 printf("Completion queue:\n");
68 for (i = 0; i < qpair->num_entries; i++) {
71 nvme_dump_completion(cpl);
74 printf("Submission queue:\n");
75 for (i = 0; i < qpair->num_entries; i++) {
78 nvme_dump_command(cmd);
84 nvme_sysctl_dump_debug(SYSCTL_HANDLER_ARGS)
86 struct nvme_qpair *qpair = arg1;
89 int error = sysctl_handle_int(oidp, &val, 0, req);
95 nvme_dump_queue(qpair);
101 nvme_sysctl_int_coal_time(SYSCTL_HANDLER_ARGS)
103 struct nvme_controller *ctrlr = arg1;
104 uint32_t oldval = ctrlr->int_coal_time;
105 int error = sysctl_handle_int(oidp, &ctrlr->int_coal_time, 0,
111 if (oldval != ctrlr->int_coal_time)
112 nvme_ctrlr_cmd_set_interrupt_coalescing(ctrlr,
113 ctrlr->int_coal_time, ctrlr->int_coal_threshold, NULL,
120 nvme_sysctl_int_coal_threshold(SYSCTL_HANDLER_ARGS)
122 struct nvme_controller *ctrlr = arg1;
123 uint32_t oldval = ctrlr->int_coal_threshold;
124 int error = sysctl_handle_int(oidp, &ctrlr->int_coal_threshold, 0,
130 if (oldval != ctrlr->int_coal_threshold)
131 nvme_ctrlr_cmd_set_interrupt_coalescing(ctrlr,
132 ctrlr->int_coal_time, ctrlr->int_coal_threshold, NULL,
139 nvme_sysctl_timeout_period(SYSCTL_HANDLER_ARGS)
141 struct nvme_controller *ctrlr = arg1;
142 uint32_t oldval = ctrlr->timeout_period;
143 int error = sysctl_handle_int(oidp, &ctrlr->timeout_period, 0, req);
148 if (ctrlr->timeout_period > NVME_MAX_TIMEOUT_PERIOD ||
149 ctrlr->timeout_period < NVME_MIN_TIMEOUT_PERIOD) {
150 ctrlr->timeout_period = oldval;
158 nvme_qpair_reset_stats(struct nvme_qpair *qpair)
162 qpair->num_intr_handler_calls = 0;
166 nvme_sysctl_num_cmds(SYSCTL_HANDLER_ARGS)
168 struct nvme_controller *ctrlr = arg1;
169 int64_t num_cmds = 0;
172 num_cmds = ctrlr->adminq.num_cmds;
174 for (i = 0; i < ctrlr->num_io_queues; i++)
175 num_cmds += ctrlr->ioq[i].num_cmds;
177 return (sysctl_handle_64(oidp, &num_cmds, 0, req));
181 nvme_sysctl_num_intr_handler_calls(SYSCTL_HANDLER_ARGS)
183 struct nvme_controller *ctrlr = arg1;
184 int64_t num_intr_handler_calls = 0;
187 num_intr_handler_calls = ctrlr->adminq.num_intr_handler_calls;
189 for (i = 0; i < ctrlr->num_io_queues; i++)
190 num_intr_handler_calls += ctrlr->ioq[i].num_intr_handler_calls;
192 return (sysctl_handle_64(oidp, &num_intr_handler_calls, 0, req));
196 nvme_sysctl_reset_stats(SYSCTL_HANDLER_ARGS)
198 struct nvme_controller *ctrlr = arg1;
201 int error = sysctl_handle_int(oidp, &val, 0, req);
207 nvme_qpair_reset_stats(&ctrlr->adminq);
209 for (i = 0; i < ctrlr->num_io_queues; i++)
210 nvme_qpair_reset_stats(&ctrlr->ioq[i]);
218 nvme_sysctl_initialize_queue(struct nvme_qpair *qpair,
219 struct sysctl_ctx_list *ctrlr_ctx, struct sysctl_oid *que_tree)
221 struct sysctl_oid_list *que_list = SYSCTL_CHILDREN(que_tree);
223 SYSCTL_ADD_UINT(ctrlr_ctx, que_list, OID_AUTO, "num_entries",
224 CTLFLAG_RD, &qpair->num_entries, 0,
225 "Number of entries in hardware queue");
226 SYSCTL_ADD_UINT(ctrlr_ctx, que_list, OID_AUTO, "num_trackers",
227 CTLFLAG_RD, &qpair->num_trackers, 0,
228 "Number of trackers pre-allocated for this queue pair");
229 SYSCTL_ADD_UINT(ctrlr_ctx, que_list, OID_AUTO, "sq_head",
230 CTLFLAG_RD, &qpair->sq_head, 0,
231 "Current head of submission queue (as observed by driver)");
232 SYSCTL_ADD_UINT(ctrlr_ctx, que_list, OID_AUTO, "sq_tail",
233 CTLFLAG_RD, &qpair->sq_tail, 0,
234 "Current tail of submission queue (as observed by driver)");
235 SYSCTL_ADD_UINT(ctrlr_ctx, que_list, OID_AUTO, "cq_head",
236 CTLFLAG_RD, &qpair->cq_head, 0,
237 "Current head of completion queue (as observed by driver)");
239 SYSCTL_ADD_QUAD(ctrlr_ctx, que_list, OID_AUTO, "num_cmds",
240 CTLFLAG_RD, &qpair->num_cmds, "Number of commands submitted");
241 SYSCTL_ADD_QUAD(ctrlr_ctx, que_list, OID_AUTO, "num_intr_handler_calls",
242 CTLFLAG_RD, &qpair->num_intr_handler_calls,
243 "Number of times interrupt handler was invoked (will typically be "
244 "less than number of actual interrupts generated due to "
247 SYSCTL_ADD_PROC(ctrlr_ctx, que_list, OID_AUTO,
248 "dump_debug", CTLTYPE_UINT | CTLFLAG_RW, qpair, 0,
249 nvme_sysctl_dump_debug, "IU", "Dump debug data");
253 nvme_sysctl_initialize_ctrlr(struct nvme_controller *ctrlr)
255 struct sysctl_ctx_list *ctrlr_ctx;
256 struct sysctl_oid *ctrlr_tree, *que_tree;
257 struct sysctl_oid_list *ctrlr_list;
258 #define QUEUE_NAME_LENGTH 16
259 char queue_name[QUEUE_NAME_LENGTH];
262 ctrlr_ctx = device_get_sysctl_ctx(ctrlr->dev);
263 ctrlr_tree = device_get_sysctl_tree(ctrlr->dev);
264 ctrlr_list = SYSCTL_CHILDREN(ctrlr_tree);
266 SYSCTL_ADD_UINT(ctrlr_ctx, ctrlr_list, OID_AUTO, "num_cpus_per_ioq",
267 CTLFLAG_RD, &ctrlr->num_cpus_per_ioq, 0,
268 "Number of CPUs assigned per I/O queue pair");
270 SYSCTL_ADD_PROC(ctrlr_ctx, ctrlr_list, OID_AUTO,
271 "int_coal_time", CTLTYPE_UINT | CTLFLAG_RW, ctrlr, 0,
272 nvme_sysctl_int_coal_time, "IU",
273 "Interrupt coalescing timeout (in microseconds)");
275 SYSCTL_ADD_PROC(ctrlr_ctx, ctrlr_list, OID_AUTO,
276 "int_coal_threshold", CTLTYPE_UINT | CTLFLAG_RW, ctrlr, 0,
277 nvme_sysctl_int_coal_threshold, "IU",
278 "Interrupt coalescing threshold");
280 SYSCTL_ADD_PROC(ctrlr_ctx, ctrlr_list, OID_AUTO,
281 "timeout_period", CTLTYPE_UINT | CTLFLAG_RW, ctrlr, 0,
282 nvme_sysctl_timeout_period, "IU",
283 "Timeout period (in seconds)");
285 SYSCTL_ADD_PROC(ctrlr_ctx, ctrlr_list, OID_AUTO,
286 "num_cmds", CTLTYPE_S64 | CTLFLAG_RD,
287 ctrlr, 0, nvme_sysctl_num_cmds, "IU",
288 "Number of commands submitted");
290 SYSCTL_ADD_PROC(ctrlr_ctx, ctrlr_list, OID_AUTO,
291 "num_intr_handler_calls", CTLTYPE_S64 | CTLFLAG_RD,
292 ctrlr, 0, nvme_sysctl_num_intr_handler_calls, "IU",
293 "Number of times interrupt handler was invoked (will "
294 "typically be less than number of actual interrupts "
295 "generated due to coalescing)");
297 SYSCTL_ADD_PROC(ctrlr_ctx, ctrlr_list, OID_AUTO,
298 "reset_stats", CTLTYPE_UINT | CTLFLAG_RW, ctrlr, 0,
299 nvme_sysctl_reset_stats, "IU", "Reset statistics to zero");
301 que_tree = SYSCTL_ADD_NODE(ctrlr_ctx, ctrlr_list, OID_AUTO, "adminq",
302 CTLFLAG_RD, NULL, "Admin Queue");
304 nvme_sysctl_initialize_queue(&ctrlr->adminq, ctrlr_ctx, que_tree);
306 for (i = 0; i < ctrlr->num_io_queues; i++) {
307 snprintf(queue_name, QUEUE_NAME_LENGTH, "ioq%d", i);
308 que_tree = SYSCTL_ADD_NODE(ctrlr_ctx, ctrlr_list, OID_AUTO,
309 queue_name, CTLFLAG_RD, NULL, "IO Queue");
310 nvme_sysctl_initialize_queue(&ctrlr->ioq[i], ctrlr_ctx,