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 u16 nvmet_get_smart_log_nsid(struct nvmet_req *req,
36 struct nvme_smart_log *slog)
40 u64 host_reads, host_writes, data_units_read, data_units_written;
42 status = NVME_SC_SUCCESS;
43 ns = nvmet_find_namespace(req->sq->ctrl, req->cmd->get_log_page.nsid);
45 status = NVME_SC_INVALID_NS;
46 pr_err("nvmet : Could not find namespace id : %d\n",
47 le32_to_cpu(req->cmd->get_log_page.nsid));
51 host_reads = part_stat_read(ns->bdev->bd_part, ios[READ]);
52 data_units_read = part_stat_read(ns->bdev->bd_part, sectors[READ]);
53 host_writes = part_stat_read(ns->bdev->bd_part, ios[WRITE]);
54 data_units_written = part_stat_read(ns->bdev->bd_part, sectors[WRITE]);
56 put_unaligned_le64(host_reads, &slog->host_reads[0]);
57 put_unaligned_le64(data_units_read, &slog->data_units_read[0]);
58 put_unaligned_le64(host_writes, &slog->host_writes[0]);
59 put_unaligned_le64(data_units_written, &slog->data_units_written[0]);
60 nvmet_put_namespace(ns);
65 static u16 nvmet_get_smart_log_all(struct nvmet_req *req,
66 struct nvme_smart_log *slog)
69 u64 host_reads = 0, host_writes = 0;
70 u64 data_units_read = 0, data_units_written = 0;
72 struct nvmet_ctrl *ctrl;
74 status = NVME_SC_SUCCESS;
78 list_for_each_entry_rcu(ns, &ctrl->subsys->namespaces, dev_link) {
79 host_reads += part_stat_read(ns->bdev->bd_part, ios[READ]);
81 part_stat_read(ns->bdev->bd_part, sectors[READ]);
82 host_writes += part_stat_read(ns->bdev->bd_part, ios[WRITE]);
84 part_stat_read(ns->bdev->bd_part, sectors[WRITE]);
89 put_unaligned_le64(host_reads, &slog->host_reads[0]);
90 put_unaligned_le64(data_units_read, &slog->data_units_read[0]);
91 put_unaligned_le64(host_writes, &slog->host_writes[0]);
92 put_unaligned_le64(data_units_written, &slog->data_units_written[0]);
97 static u16 nvmet_get_smart_log(struct nvmet_req *req,
98 struct nvme_smart_log *slog)
102 WARN_ON(req == NULL || slog == NULL);
103 if (req->cmd->get_log_page.nsid == cpu_to_le32(0xFFFFFFFF))
104 status = nvmet_get_smart_log_all(req, slog);
106 status = nvmet_get_smart_log_nsid(req, slog);
110 static void nvmet_execute_get_log_page(struct nvmet_req *req)
112 struct nvme_smart_log *smart_log;
113 size_t data_len = nvmet_get_log_page_len(req->cmd);
117 buf = kzalloc(data_len, GFP_KERNEL);
119 status = NVME_SC_INTERNAL;
123 switch (req->cmd->get_log_page.lid) {
126 * We currently never set the More bit in the status field,
127 * so all error log entries are invalid and can be zeroed out.
128 * This is called a minum viable implementation (TM) of this
129 * mandatory log page.
134 * XXX: fill out actual smart log
136 * We might have a hard time coming up with useful values for
137 * many of the fields, and even when we have useful data
138 * available (e.g. units or commands read/written) those aren't
139 * persistent over power loss.
141 if (data_len != sizeof(*smart_log)) {
142 status = NVME_SC_INTERNAL;
146 status = nvmet_get_smart_log(req, smart_log);
148 memset(buf, '\0', data_len);
152 case NVME_LOG_FW_SLOT:
154 * We only support a single firmware slot which always is
155 * active, so we can zero out the whole firmware slot log and
156 * still claim to fully implement this mandatory log page.
163 status = nvmet_copy_to_sgl(req, 0, buf, data_len);
168 nvmet_req_complete(req, status);
171 static void copy_and_pad(char *dst, int dst_len, const char *src, int src_len)
173 int len = min(src_len, dst_len);
175 memcpy(dst, src, len);
177 memset(dst + len, ' ', dst_len - len);
180 static void nvmet_execute_identify_ctrl(struct nvmet_req *req)
182 struct nvmet_ctrl *ctrl = req->sq->ctrl;
183 struct nvme_id_ctrl *id;
185 const char model[] = "Linux";
187 id = kzalloc(sizeof(*id), GFP_KERNEL);
189 status = NVME_SC_INTERNAL;
193 /* XXX: figure out how to assign real vendors IDs. */
197 bin2hex(id->sn, &ctrl->subsys->serial,
198 min(sizeof(ctrl->subsys->serial), sizeof(id->sn) / 2));
199 copy_and_pad(id->mn, sizeof(id->mn), model, sizeof(model) - 1);
200 copy_and_pad(id->fr, sizeof(id->fr), UTS_RELEASE, strlen(UTS_RELEASE));
205 * XXX: figure out how we can assign a IEEE OUI, but until then
206 * the safest is to leave it as zeroes.
209 /* we support multiple ports and multiples hosts: */
210 id->cmic = (1 << 0) | (1 << 1);
212 /* no limit on data transfer sizes for now */
214 id->cntlid = cpu_to_le16(ctrl->cntlid);
215 id->ver = cpu_to_le32(ctrl->subsys->ver);
217 /* XXX: figure out what to do about RTD3R/RTD3 */
218 id->oaes = cpu_to_le32(1 << 8);
219 id->ctratt = cpu_to_le32(1 << 0);
224 * We don't really have a practical limit on the number of abort
225 * comands. But we don't do anything useful for abort either, so
226 * no point in allowing more abort commands than the spec requires.
230 id->aerl = NVMET_ASYNC_EVENTS - 1;
232 /* first slot is read-only, only one slot supported */
233 id->frmw = (1 << 0) | (1 << 1);
234 id->lpa = (1 << 0) | (1 << 2);
235 id->elpe = NVMET_ERROR_LOG_SLOTS - 1;
238 /* We support keep-alive timeout in granularity of seconds */
239 id->kas = cpu_to_le16(NVMET_KAS);
241 id->sqes = (0x6 << 4) | 0x6;
242 id->cqes = (0x4 << 4) | 0x4;
244 /* no enforcement soft-limit for maxcmd - pick arbitrary high value */
245 id->maxcmd = cpu_to_le16(NVMET_MAX_CMD);
247 id->nn = cpu_to_le32(ctrl->subsys->max_nsid);
248 id->oncs = cpu_to_le16(NVME_CTRL_ONCS_DSM |
249 NVME_CTRL_ONCS_WRITE_ZEROES);
251 /* XXX: don't report vwc if the underlying device is write through */
252 id->vwc = NVME_CTRL_VWC_PRESENT;
255 * We can't support atomic writes bigger than a LBA without support
256 * from the backend device.
261 id->sgls = cpu_to_le32(1 << 0); /* we always support SGLs */
262 if (ctrl->ops->has_keyed_sgls)
263 id->sgls |= cpu_to_le32(1 << 2);
264 if (ctrl->ops->sqe_inline_size)
265 id->sgls |= cpu_to_le32(1 << 20);
267 strcpy(id->subnqn, ctrl->subsys->subsysnqn);
269 /* Max command capsule size is sqe + single page of in-capsule data */
270 id->ioccsz = cpu_to_le32((sizeof(struct nvme_command) +
271 ctrl->ops->sqe_inline_size) / 16);
272 /* Max response capsule size is cqe */
273 id->iorcsz = cpu_to_le32(sizeof(struct nvme_completion) / 16);
275 id->msdbd = ctrl->ops->msdbd;
278 * Meh, we don't really support any power state. Fake up the same
279 * values that qemu does.
281 id->psd[0].max_power = cpu_to_le16(0x9c4);
282 id->psd[0].entry_lat = cpu_to_le32(0x10);
283 id->psd[0].exit_lat = cpu_to_le32(0x4);
285 status = nvmet_copy_to_sgl(req, 0, id, sizeof(*id));
289 nvmet_req_complete(req, status);
292 static void nvmet_execute_identify_ns(struct nvmet_req *req)
295 struct nvme_id_ns *id;
298 ns = nvmet_find_namespace(req->sq->ctrl, req->cmd->identify.nsid);
300 status = NVME_SC_INVALID_NS | NVME_SC_DNR;
304 id = kzalloc(sizeof(*id), GFP_KERNEL);
306 status = NVME_SC_INTERNAL;
311 * nuse = ncap = nsze isn't aways true, but we have no way to find
312 * that out from the underlying device.
314 id->ncap = id->nuse = id->nsze =
315 cpu_to_le64(ns->size >> ns->blksize_shift);
318 * We just provide a single LBA format that matches what the
319 * underlying device reports.
325 * Our namespace might always be shared. Not just with other
326 * controllers, but also with any other user of the block device.
330 memcpy(&id->nguid, &ns->nguid, sizeof(uuid_le));
332 id->lbaf[0].ds = ns->blksize_shift;
334 status = nvmet_copy_to_sgl(req, 0, id, sizeof(*id));
338 nvmet_put_namespace(ns);
340 nvmet_req_complete(req, status);
343 static void nvmet_execute_identify_nslist(struct nvmet_req *req)
345 static const int buf_size = NVME_IDENTIFY_DATA_SIZE;
346 struct nvmet_ctrl *ctrl = req->sq->ctrl;
348 u32 min_nsid = le32_to_cpu(req->cmd->identify.nsid);
353 list = kzalloc(buf_size, GFP_KERNEL);
355 status = NVME_SC_INTERNAL;
360 list_for_each_entry_rcu(ns, &ctrl->subsys->namespaces, dev_link) {
361 if (ns->nsid <= min_nsid)
363 list[i++] = cpu_to_le32(ns->nsid);
364 if (i == buf_size / sizeof(__le32))
369 status = nvmet_copy_to_sgl(req, 0, list, buf_size);
373 nvmet_req_complete(req, status);
376 static u16 nvmet_copy_ns_identifier(struct nvmet_req *req, u8 type, u8 len,
377 void *id, off_t *off)
379 struct nvme_ns_id_desc desc = {
385 status = nvmet_copy_to_sgl(req, *off, &desc, sizeof(desc));
388 *off += sizeof(desc);
390 status = nvmet_copy_to_sgl(req, *off, id, len);
398 static void nvmet_execute_identify_desclist(struct nvmet_req *req)
404 ns = nvmet_find_namespace(req->sq->ctrl, req->cmd->identify.nsid);
406 status = NVME_SC_INVALID_NS | NVME_SC_DNR;
410 if (memchr_inv(&ns->uuid, 0, sizeof(ns->uuid))) {
411 status = nvmet_copy_ns_identifier(req, NVME_NIDT_UUID,
417 if (memchr_inv(ns->nguid, 0, sizeof(ns->nguid))) {
418 status = nvmet_copy_ns_identifier(req, NVME_NIDT_NGUID,
425 if (sg_zero_buffer(req->sg, req->sg_cnt, NVME_IDENTIFY_DATA_SIZE - off,
426 off) != NVME_IDENTIFY_DATA_SIZE - off)
427 status = NVME_SC_INTERNAL | NVME_SC_DNR;
429 nvmet_put_namespace(ns);
431 nvmet_req_complete(req, status);
435 * A "mimimum viable" abort implementation: the command is mandatory in the
436 * spec, but we are not required to do any useful work. We couldn't really
437 * do a useful abort, so don't bother even with waiting for the command
438 * to be exectuted and return immediately telling the command to abort
441 static void nvmet_execute_abort(struct nvmet_req *req)
443 nvmet_set_result(req, 1);
444 nvmet_req_complete(req, 0);
447 static void nvmet_execute_set_features(struct nvmet_req *req)
449 struct nvmet_subsys *subsys = req->sq->ctrl->subsys;
450 u32 cdw10 = le32_to_cpu(req->cmd->common.cdw10[0]);
454 switch (cdw10 & 0xf) {
455 case NVME_FEAT_NUM_QUEUES:
456 nvmet_set_result(req,
457 (subsys->max_qid - 1) | ((subsys->max_qid - 1) << 16));
460 val32 = le32_to_cpu(req->cmd->common.cdw10[1]);
461 req->sq->ctrl->kato = DIV_ROUND_UP(val32, 1000);
462 nvmet_set_result(req, req->sq->ctrl->kato);
465 status = NVME_SC_INVALID_FIELD | NVME_SC_DNR;
469 nvmet_req_complete(req, status);
472 static void nvmet_execute_get_features(struct nvmet_req *req)
474 struct nvmet_subsys *subsys = req->sq->ctrl->subsys;
475 u32 cdw10 = le32_to_cpu(req->cmd->common.cdw10[0]);
478 switch (cdw10 & 0xf) {
480 * These features are mandatory in the spec, but we don't
481 * have a useful way to implement them. We'll eventually
482 * need to come up with some fake values for these.
485 case NVME_FEAT_ARBITRATION:
487 case NVME_FEAT_POWER_MGMT:
489 case NVME_FEAT_TEMP_THRESH:
491 case NVME_FEAT_ERR_RECOVERY:
493 case NVME_FEAT_IRQ_COALESCE:
495 case NVME_FEAT_IRQ_CONFIG:
497 case NVME_FEAT_WRITE_ATOMIC:
499 case NVME_FEAT_ASYNC_EVENT:
502 case NVME_FEAT_VOLATILE_WC:
503 nvmet_set_result(req, 1);
505 case NVME_FEAT_NUM_QUEUES:
506 nvmet_set_result(req,
507 (subsys->max_qid-1) | ((subsys->max_qid-1) << 16));
510 nvmet_set_result(req, req->sq->ctrl->kato * 1000);
513 status = NVME_SC_INVALID_FIELD | NVME_SC_DNR;
517 nvmet_req_complete(req, status);
520 static void nvmet_execute_async_event(struct nvmet_req *req)
522 struct nvmet_ctrl *ctrl = req->sq->ctrl;
524 mutex_lock(&ctrl->lock);
525 if (ctrl->nr_async_event_cmds >= NVMET_ASYNC_EVENTS) {
526 mutex_unlock(&ctrl->lock);
527 nvmet_req_complete(req, NVME_SC_ASYNC_LIMIT | NVME_SC_DNR);
530 ctrl->async_event_cmds[ctrl->nr_async_event_cmds++] = req;
531 mutex_unlock(&ctrl->lock);
533 schedule_work(&ctrl->async_event_work);
536 static void nvmet_execute_keep_alive(struct nvmet_req *req)
538 struct nvmet_ctrl *ctrl = req->sq->ctrl;
540 pr_debug("ctrl %d update keep-alive timer for %d secs\n",
541 ctrl->cntlid, ctrl->kato);
543 mod_delayed_work(system_wq, &ctrl->ka_work, ctrl->kato * HZ);
544 nvmet_req_complete(req, 0);
547 u16 nvmet_parse_admin_cmd(struct nvmet_req *req)
549 struct nvme_command *cmd = req->cmd;
554 ret = nvmet_check_ctrl_status(req, cmd);
558 switch (cmd->common.opcode) {
559 case nvme_admin_get_log_page:
560 req->data_len = nvmet_get_log_page_len(cmd);
562 switch (cmd->get_log_page.lid) {
565 case NVME_LOG_FW_SLOT:
566 req->execute = nvmet_execute_get_log_page;
570 case nvme_admin_identify:
571 req->data_len = NVME_IDENTIFY_DATA_SIZE;
572 switch (cmd->identify.cns) {
574 req->execute = nvmet_execute_identify_ns;
576 case NVME_ID_CNS_CTRL:
577 req->execute = nvmet_execute_identify_ctrl;
579 case NVME_ID_CNS_NS_ACTIVE_LIST:
580 req->execute = nvmet_execute_identify_nslist;
582 case NVME_ID_CNS_NS_DESC_LIST:
583 req->execute = nvmet_execute_identify_desclist;
587 case nvme_admin_abort_cmd:
588 req->execute = nvmet_execute_abort;
591 case nvme_admin_set_features:
592 req->execute = nvmet_execute_set_features;
595 case nvme_admin_get_features:
596 req->execute = nvmet_execute_get_features;
599 case nvme_admin_async_event:
600 req->execute = nvmet_execute_async_event;
603 case nvme_admin_keep_alive:
604 req->execute = nvmet_execute_keep_alive;
609 pr_err("unhandled cmd %d on qid %d\n", cmd->common.opcode,
611 return NVME_SC_INVALID_OPCODE | NVME_SC_DNR;