2 * NVMe admin command implementation.
3 * Copyright (c) 2015-2016 HGST, a Western Digital Company.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
15 #include <linux/module.h>
16 #include <linux/rculist.h>
18 #include <generated/utsrelease.h>
19 #include <asm/unaligned.h>
22 u32 nvmet_get_log_page_len(struct nvme_command *cmd)
24 u32 len = le16_to_cpu(cmd->get_log_page.numdu);
27 len += le16_to_cpu(cmd->get_log_page.numdl);
28 /* NUMD is a 0's based value */
35 static void nvmet_execute_get_log_page_noop(struct nvmet_req *req)
37 nvmet_req_complete(req, nvmet_zero_sgl(req, 0, req->data_len));
40 static u16 nvmet_get_smart_log_nsid(struct nvmet_req *req,
41 struct nvme_smart_log *slog)
44 u64 host_reads, host_writes, data_units_read, data_units_written;
46 ns = nvmet_find_namespace(req->sq->ctrl, req->cmd->get_log_page.nsid);
48 pr_err("nvmet : Could not find namespace id : %d\n",
49 le32_to_cpu(req->cmd->get_log_page.nsid));
50 return NVME_SC_INVALID_NS;
53 /* we don't have the right data for file backed ns */
57 host_reads = part_stat_read(ns->bdev->bd_part, ios[READ]);
58 data_units_read = part_stat_read(ns->bdev->bd_part, sectors[READ]);
59 host_writes = part_stat_read(ns->bdev->bd_part, ios[WRITE]);
60 data_units_written = part_stat_read(ns->bdev->bd_part, sectors[WRITE]);
62 put_unaligned_le64(host_reads, &slog->host_reads[0]);
63 put_unaligned_le64(data_units_read, &slog->data_units_read[0]);
64 put_unaligned_le64(host_writes, &slog->host_writes[0]);
65 put_unaligned_le64(data_units_written, &slog->data_units_written[0]);
67 nvmet_put_namespace(ns);
69 return NVME_SC_SUCCESS;
72 static u16 nvmet_get_smart_log_all(struct nvmet_req *req,
73 struct nvme_smart_log *slog)
75 u64 host_reads = 0, host_writes = 0;
76 u64 data_units_read = 0, data_units_written = 0;
78 struct nvmet_ctrl *ctrl;
83 list_for_each_entry_rcu(ns, &ctrl->subsys->namespaces, dev_link) {
84 /* we don't have the right data for file backed ns */
87 host_reads += part_stat_read(ns->bdev->bd_part, ios[READ]);
89 part_stat_read(ns->bdev->bd_part, sectors[READ]);
90 host_writes += part_stat_read(ns->bdev->bd_part, ios[WRITE]);
92 part_stat_read(ns->bdev->bd_part, sectors[WRITE]);
97 put_unaligned_le64(host_reads, &slog->host_reads[0]);
98 put_unaligned_le64(data_units_read, &slog->data_units_read[0]);
99 put_unaligned_le64(host_writes, &slog->host_writes[0]);
100 put_unaligned_le64(data_units_written, &slog->data_units_written[0]);
102 return NVME_SC_SUCCESS;
105 static void nvmet_execute_get_log_page_smart(struct nvmet_req *req)
107 struct nvme_smart_log *log;
108 u16 status = NVME_SC_INTERNAL;
110 if (req->data_len != sizeof(*log))
113 log = kzalloc(sizeof(*log), GFP_KERNEL);
117 if (req->cmd->get_log_page.nsid == cpu_to_le32(NVME_NSID_ALL))
118 status = nvmet_get_smart_log_all(req, log);
120 status = nvmet_get_smart_log_nsid(req, log);
124 status = nvmet_copy_to_sgl(req, 0, log, sizeof(*log));
128 nvmet_req_complete(req, status);
131 static void nvmet_execute_get_log_changed_ns(struct nvmet_req *req)
133 struct nvmet_ctrl *ctrl = req->sq->ctrl;
134 u16 status = NVME_SC_INTERNAL;
137 if (req->data_len != NVME_MAX_CHANGED_NAMESPACES * sizeof(__le32))
140 mutex_lock(&ctrl->lock);
141 if (ctrl->nr_changed_ns == U32_MAX)
142 len = sizeof(__le32);
144 len = ctrl->nr_changed_ns * sizeof(__le32);
145 status = nvmet_copy_to_sgl(req, 0, ctrl->changed_ns_list, len);
147 status = nvmet_zero_sgl(req, len, req->data_len - len);
148 ctrl->nr_changed_ns = 0;
149 clear_bit(NVME_AEN_CFG_NS_ATTR, &ctrl->aen_masked);
150 mutex_unlock(&ctrl->lock);
152 nvmet_req_complete(req, status);
155 static void nvmet_execute_identify_ctrl(struct nvmet_req *req)
157 struct nvmet_ctrl *ctrl = req->sq->ctrl;
158 struct nvme_id_ctrl *id;
160 const char model[] = "Linux";
162 id = kzalloc(sizeof(*id), GFP_KERNEL);
164 status = NVME_SC_INTERNAL;
168 /* XXX: figure out how to assign real vendors IDs. */
172 memset(id->sn, ' ', sizeof(id->sn));
173 bin2hex(id->sn, &ctrl->subsys->serial,
174 min(sizeof(ctrl->subsys->serial), sizeof(id->sn) / 2));
175 memcpy_and_pad(id->mn, sizeof(id->mn), model, sizeof(model) - 1, ' ');
176 memcpy_and_pad(id->fr, sizeof(id->fr),
177 UTS_RELEASE, strlen(UTS_RELEASE), ' ');
182 * XXX: figure out how we can assign a IEEE OUI, but until then
183 * the safest is to leave it as zeroes.
186 /* we support multiple ports and multiples hosts: */
187 id->cmic = (1 << 0) | (1 << 1);
189 /* no limit on data transfer sizes for now */
191 id->cntlid = cpu_to_le16(ctrl->cntlid);
192 id->ver = cpu_to_le32(ctrl->subsys->ver);
194 /* XXX: figure out what to do about RTD3R/RTD3 */
195 id->oaes = cpu_to_le32(NVMET_AEN_CFG_OPTIONAL);
196 id->ctratt = cpu_to_le32(1 << 0);
201 * We don't really have a practical limit on the number of abort
202 * comands. But we don't do anything useful for abort either, so
203 * no point in allowing more abort commands than the spec requires.
207 id->aerl = NVMET_ASYNC_EVENTS - 1;
209 /* first slot is read-only, only one slot supported */
210 id->frmw = (1 << 0) | (1 << 1);
211 id->lpa = (1 << 0) | (1 << 2);
212 id->elpe = NVMET_ERROR_LOG_SLOTS - 1;
215 /* We support keep-alive timeout in granularity of seconds */
216 id->kas = cpu_to_le16(NVMET_KAS);
218 id->sqes = (0x6 << 4) | 0x6;
219 id->cqes = (0x4 << 4) | 0x4;
221 /* no enforcement soft-limit for maxcmd - pick arbitrary high value */
222 id->maxcmd = cpu_to_le16(NVMET_MAX_CMD);
224 id->nn = cpu_to_le32(ctrl->subsys->max_nsid);
225 id->oncs = cpu_to_le16(NVME_CTRL_ONCS_DSM |
226 NVME_CTRL_ONCS_WRITE_ZEROES);
228 /* XXX: don't report vwc if the underlying device is write through */
229 id->vwc = NVME_CTRL_VWC_PRESENT;
232 * We can't support atomic writes bigger than a LBA without support
233 * from the backend device.
238 id->sgls = cpu_to_le32(1 << 0); /* we always support SGLs */
239 if (ctrl->ops->has_keyed_sgls)
240 id->sgls |= cpu_to_le32(1 << 2);
241 if (ctrl->ops->sqe_inline_size)
242 id->sgls |= cpu_to_le32(1 << 20);
244 strcpy(id->subnqn, ctrl->subsys->subsysnqn);
246 /* Max command capsule size is sqe + single page of in-capsule data */
247 id->ioccsz = cpu_to_le32((sizeof(struct nvme_command) +
248 ctrl->ops->sqe_inline_size) / 16);
249 /* Max response capsule size is cqe */
250 id->iorcsz = cpu_to_le32(sizeof(struct nvme_completion) / 16);
252 id->msdbd = ctrl->ops->msdbd;
255 * Meh, we don't really support any power state. Fake up the same
256 * values that qemu does.
258 id->psd[0].max_power = cpu_to_le16(0x9c4);
259 id->psd[0].entry_lat = cpu_to_le32(0x10);
260 id->psd[0].exit_lat = cpu_to_le32(0x4);
262 status = nvmet_copy_to_sgl(req, 0, id, sizeof(*id));
266 nvmet_req_complete(req, status);
269 static void nvmet_execute_identify_ns(struct nvmet_req *req)
272 struct nvme_id_ns *id;
275 if (le32_to_cpu(req->cmd->identify.nsid) == NVME_NSID_ALL) {
276 status = NVME_SC_INVALID_NS | NVME_SC_DNR;
280 id = kzalloc(sizeof(*id), GFP_KERNEL);
282 status = NVME_SC_INTERNAL;
286 /* return an all zeroed buffer if we can't find an active namespace */
287 ns = nvmet_find_namespace(req->sq->ctrl, req->cmd->identify.nsid);
292 * nuse = ncap = nsze isn't always true, but we have no way to find
293 * that out from the underlying device.
295 id->ncap = id->nuse = id->nsze =
296 cpu_to_le64(ns->size >> ns->blksize_shift);
299 * We just provide a single LBA format that matches what the
300 * underlying device reports.
306 * Our namespace might always be shared. Not just with other
307 * controllers, but also with any other user of the block device.
311 memcpy(&id->nguid, &ns->nguid, sizeof(uuid_le));
313 id->lbaf[0].ds = ns->blksize_shift;
315 nvmet_put_namespace(ns);
317 status = nvmet_copy_to_sgl(req, 0, id, sizeof(*id));
320 nvmet_req_complete(req, status);
323 static void nvmet_execute_identify_nslist(struct nvmet_req *req)
325 static const int buf_size = NVME_IDENTIFY_DATA_SIZE;
326 struct nvmet_ctrl *ctrl = req->sq->ctrl;
328 u32 min_nsid = le32_to_cpu(req->cmd->identify.nsid);
333 list = kzalloc(buf_size, GFP_KERNEL);
335 status = NVME_SC_INTERNAL;
340 list_for_each_entry_rcu(ns, &ctrl->subsys->namespaces, dev_link) {
341 if (ns->nsid <= min_nsid)
343 list[i++] = cpu_to_le32(ns->nsid);
344 if (i == buf_size / sizeof(__le32))
349 status = nvmet_copy_to_sgl(req, 0, list, buf_size);
353 nvmet_req_complete(req, status);
356 static u16 nvmet_copy_ns_identifier(struct nvmet_req *req, u8 type, u8 len,
357 void *id, off_t *off)
359 struct nvme_ns_id_desc desc = {
365 status = nvmet_copy_to_sgl(req, *off, &desc, sizeof(desc));
368 *off += sizeof(desc);
370 status = nvmet_copy_to_sgl(req, *off, id, len);
378 static void nvmet_execute_identify_desclist(struct nvmet_req *req)
384 ns = nvmet_find_namespace(req->sq->ctrl, req->cmd->identify.nsid);
386 status = NVME_SC_INVALID_NS | NVME_SC_DNR;
390 if (memchr_inv(&ns->uuid, 0, sizeof(ns->uuid))) {
391 status = nvmet_copy_ns_identifier(req, NVME_NIDT_UUID,
397 if (memchr_inv(ns->nguid, 0, sizeof(ns->nguid))) {
398 status = nvmet_copy_ns_identifier(req, NVME_NIDT_NGUID,
405 if (sg_zero_buffer(req->sg, req->sg_cnt, NVME_IDENTIFY_DATA_SIZE - off,
406 off) != NVME_IDENTIFY_DATA_SIZE - off)
407 status = NVME_SC_INTERNAL | NVME_SC_DNR;
409 nvmet_put_namespace(ns);
411 nvmet_req_complete(req, status);
415 * A "minimum viable" abort implementation: the command is mandatory in the
416 * spec, but we are not required to do any useful work. We couldn't really
417 * do a useful abort, so don't bother even with waiting for the command
418 * to be exectuted and return immediately telling the command to abort
421 static void nvmet_execute_abort(struct nvmet_req *req)
423 nvmet_set_result(req, 1);
424 nvmet_req_complete(req, 0);
427 static void nvmet_execute_set_features(struct nvmet_req *req)
429 struct nvmet_subsys *subsys = req->sq->ctrl->subsys;
430 u32 cdw10 = le32_to_cpu(req->cmd->common.cdw10[0]);
434 switch (cdw10 & 0xff) {
435 case NVME_FEAT_NUM_QUEUES:
436 nvmet_set_result(req,
437 (subsys->max_qid - 1) | ((subsys->max_qid - 1) << 16));
440 val32 = le32_to_cpu(req->cmd->common.cdw10[1]);
441 req->sq->ctrl->kato = DIV_ROUND_UP(val32, 1000);
442 nvmet_set_result(req, req->sq->ctrl->kato);
444 case NVME_FEAT_ASYNC_EVENT:
445 val32 = le32_to_cpu(req->cmd->common.cdw10[1]);
446 if (val32 & ~NVMET_AEN_CFG_ALL) {
447 status = NVME_SC_INVALID_FIELD | NVME_SC_DNR;
451 WRITE_ONCE(req->sq->ctrl->aen_enabled, val32);
452 nvmet_set_result(req, val32);
454 case NVME_FEAT_HOST_ID:
455 status = NVME_SC_CMD_SEQ_ERROR | NVME_SC_DNR;
458 status = NVME_SC_INVALID_FIELD | NVME_SC_DNR;
462 nvmet_req_complete(req, status);
465 static void nvmet_execute_get_features(struct nvmet_req *req)
467 struct nvmet_subsys *subsys = req->sq->ctrl->subsys;
468 u32 cdw10 = le32_to_cpu(req->cmd->common.cdw10[0]);
471 switch (cdw10 & 0xff) {
473 * These features are mandatory in the spec, but we don't
474 * have a useful way to implement them. We'll eventually
475 * need to come up with some fake values for these.
478 case NVME_FEAT_ARBITRATION:
480 case NVME_FEAT_POWER_MGMT:
482 case NVME_FEAT_TEMP_THRESH:
484 case NVME_FEAT_ERR_RECOVERY:
486 case NVME_FEAT_IRQ_COALESCE:
488 case NVME_FEAT_IRQ_CONFIG:
490 case NVME_FEAT_WRITE_ATOMIC:
493 case NVME_FEAT_ASYNC_EVENT:
494 nvmet_set_result(req, READ_ONCE(req->sq->ctrl->aen_enabled));
496 case NVME_FEAT_VOLATILE_WC:
497 nvmet_set_result(req, 1);
499 case NVME_FEAT_NUM_QUEUES:
500 nvmet_set_result(req,
501 (subsys->max_qid-1) | ((subsys->max_qid-1) << 16));
504 nvmet_set_result(req, req->sq->ctrl->kato * 1000);
506 case NVME_FEAT_HOST_ID:
507 /* need 128-bit host identifier flag */
508 if (!(req->cmd->common.cdw10[1] & cpu_to_le32(1 << 0))) {
509 status = NVME_SC_INVALID_FIELD | NVME_SC_DNR;
513 status = nvmet_copy_to_sgl(req, 0, &req->sq->ctrl->hostid,
514 sizeof(req->sq->ctrl->hostid));
517 status = NVME_SC_INVALID_FIELD | NVME_SC_DNR;
521 nvmet_req_complete(req, status);
524 static void nvmet_execute_async_event(struct nvmet_req *req)
526 struct nvmet_ctrl *ctrl = req->sq->ctrl;
528 mutex_lock(&ctrl->lock);
529 if (ctrl->nr_async_event_cmds >= NVMET_ASYNC_EVENTS) {
530 mutex_unlock(&ctrl->lock);
531 nvmet_req_complete(req, NVME_SC_ASYNC_LIMIT | NVME_SC_DNR);
534 ctrl->async_event_cmds[ctrl->nr_async_event_cmds++] = req;
535 mutex_unlock(&ctrl->lock);
537 schedule_work(&ctrl->async_event_work);
540 static void nvmet_execute_keep_alive(struct nvmet_req *req)
542 struct nvmet_ctrl *ctrl = req->sq->ctrl;
544 pr_debug("ctrl %d update keep-alive timer for %d secs\n",
545 ctrl->cntlid, ctrl->kato);
547 mod_delayed_work(system_wq, &ctrl->ka_work, ctrl->kato * HZ);
548 nvmet_req_complete(req, 0);
551 u16 nvmet_parse_admin_cmd(struct nvmet_req *req)
553 struct nvme_command *cmd = req->cmd;
556 ret = nvmet_check_ctrl_status(req, cmd);
560 switch (cmd->common.opcode) {
561 case nvme_admin_get_log_page:
562 req->data_len = nvmet_get_log_page_len(cmd);
564 switch (cmd->get_log_page.lid) {
567 * We currently never set the More bit in the status
568 * field, so all error log entries are invalid and can
569 * be zeroed out. This is called a minum viable
570 * implementation (TM) of this mandatory log page.
572 req->execute = nvmet_execute_get_log_page_noop;
575 req->execute = nvmet_execute_get_log_page_smart;
577 case NVME_LOG_FW_SLOT:
579 * We only support a single firmware slot which always
580 * is active, so we can zero out the whole firmware slot
581 * log and still claim to fully implement this mandatory
584 req->execute = nvmet_execute_get_log_page_noop;
586 case NVME_LOG_CHANGED_NS:
587 req->execute = nvmet_execute_get_log_changed_ns;
591 case nvme_admin_identify:
592 req->data_len = NVME_IDENTIFY_DATA_SIZE;
593 switch (cmd->identify.cns) {
595 req->execute = nvmet_execute_identify_ns;
597 case NVME_ID_CNS_CTRL:
598 req->execute = nvmet_execute_identify_ctrl;
600 case NVME_ID_CNS_NS_ACTIVE_LIST:
601 req->execute = nvmet_execute_identify_nslist;
603 case NVME_ID_CNS_NS_DESC_LIST:
604 req->execute = nvmet_execute_identify_desclist;
608 case nvme_admin_abort_cmd:
609 req->execute = nvmet_execute_abort;
612 case nvme_admin_set_features:
613 req->execute = nvmet_execute_set_features;
616 case nvme_admin_get_features:
617 req->execute = nvmet_execute_get_features;
620 case nvme_admin_async_event:
621 req->execute = nvmet_execute_async_event;
624 case nvme_admin_keep_alive:
625 req->execute = nvmet_execute_keep_alive;
630 pr_err("unhandled cmd %d on qid %d\n", cmd->common.opcode,
632 return NVME_SC_INVALID_OPCODE | NVME_SC_DNR;