1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) Intel Corporation. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * * Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * * Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in 15 * the documentation and/or other materials provided with the 16 * distribution. 17 * * Neither the name of Intel Corporation nor the names of its 18 * contributors may be used to endorse or promote products derived 19 * from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 #include "nvme_internal.h" 35 #include "spdk/nvme_ocssd.h" 36 37 static int nvme_qpair_resubmit_request(struct spdk_nvme_qpair *qpair, struct nvme_request *req); 38 39 struct nvme_string { 40 uint16_t value; 41 const char *str; 42 }; 43 44 static const struct nvme_string admin_opcode[] = { 45 { SPDK_NVME_OPC_DELETE_IO_SQ, "DELETE IO SQ" }, 46 { SPDK_NVME_OPC_CREATE_IO_SQ, "CREATE IO SQ" }, 47 { SPDK_NVME_OPC_GET_LOG_PAGE, "GET LOG PAGE" }, 48 { SPDK_NVME_OPC_DELETE_IO_CQ, "DELETE IO CQ" }, 49 { SPDK_NVME_OPC_CREATE_IO_CQ, "CREATE IO CQ" }, 50 { SPDK_NVME_OPC_IDENTIFY, "IDENTIFY" }, 51 { SPDK_NVME_OPC_ABORT, "ABORT" }, 52 { SPDK_NVME_OPC_SET_FEATURES, "SET FEATURES" }, 53 { SPDK_NVME_OPC_GET_FEATURES, "GET FEATURES" }, 54 { SPDK_NVME_OPC_ASYNC_EVENT_REQUEST, "ASYNC EVENT REQUEST" }, 55 { SPDK_NVME_OPC_NS_MANAGEMENT, "NAMESPACE MANAGEMENT" }, 56 { SPDK_NVME_OPC_FIRMWARE_COMMIT, "FIRMWARE COMMIT" }, 57 { SPDK_NVME_OPC_FIRMWARE_IMAGE_DOWNLOAD, "FIRMWARE IMAGE DOWNLOAD" }, 58 { SPDK_NVME_OPC_DEVICE_SELF_TEST, "DEVICE SELF-TEST" }, 59 { SPDK_NVME_OPC_NS_ATTACHMENT, "NAMESPACE ATTACHMENT" }, 60 { SPDK_NVME_OPC_KEEP_ALIVE, "KEEP ALIVE" }, 61 { SPDK_NVME_OPC_DIRECTIVE_SEND, "DIRECTIVE SEND" }, 62 { SPDK_NVME_OPC_DIRECTIVE_RECEIVE, "DIRECTIVE RECEIVE" }, 63 { SPDK_NVME_OPC_VIRTUALIZATION_MANAGEMENT, "VIRTUALIZATION MANAGEMENT" }, 64 { SPDK_NVME_OPC_NVME_MI_SEND, "NVME-MI SEND" }, 65 { SPDK_NVME_OPC_NVME_MI_RECEIVE, "NVME-MI RECEIVE" }, 66 { SPDK_NVME_OPC_DOORBELL_BUFFER_CONFIG, "DOORBELL BUFFER CONFIG" }, 67 { SPDK_NVME_OPC_FORMAT_NVM, "FORMAT NVM" }, 68 { SPDK_NVME_OPC_SECURITY_SEND, "SECURITY SEND" }, 69 { SPDK_NVME_OPC_SECURITY_RECEIVE, "SECURITY RECEIVE" }, 70 { SPDK_NVME_OPC_SANITIZE, "SANITIZE" }, 71 { SPDK_OCSSD_OPC_GEOMETRY, "OCSSD / GEOMETRY" }, 72 { 0xFFFF, "ADMIN COMMAND" } 73 }; 74 75 static const struct nvme_string io_opcode[] = { 76 { SPDK_NVME_OPC_FLUSH, "FLUSH" }, 77 { SPDK_NVME_OPC_WRITE, "WRITE" }, 78 { SPDK_NVME_OPC_READ, "READ" }, 79 { SPDK_NVME_OPC_WRITE_UNCORRECTABLE, "WRITE UNCORRECTABLE" }, 80 { SPDK_NVME_OPC_COMPARE, "COMPARE" }, 81 { SPDK_NVME_OPC_WRITE_ZEROES, "WRITE ZEROES" }, 82 { SPDK_NVME_OPC_DATASET_MANAGEMENT, "DATASET MANAGEMENT" }, 83 { SPDK_NVME_OPC_RESERVATION_REGISTER, "RESERVATION REGISTER" }, 84 { SPDK_NVME_OPC_RESERVATION_REPORT, "RESERVATION REPORT" }, 85 { SPDK_NVME_OPC_RESERVATION_ACQUIRE, "RESERVATION ACQUIRE" }, 86 { SPDK_NVME_OPC_RESERVATION_RELEASE, "RESERVATION RELEASE" }, 87 { SPDK_OCSSD_OPC_VECTOR_RESET, "OCSSD / VECTOR RESET" }, 88 { SPDK_OCSSD_OPC_VECTOR_WRITE, "OCSSD / VECTOR WRITE" }, 89 { SPDK_OCSSD_OPC_VECTOR_READ, "OCSSD / VECTOR READ" }, 90 { SPDK_OCSSD_OPC_VECTOR_COPY, "OCSSD / VECTOR COPY" }, 91 { 0xFFFF, "IO COMMAND" } 92 }; 93 94 static const char * 95 nvme_get_string(const struct nvme_string *strings, uint16_t value) 96 { 97 const struct nvme_string *entry; 98 99 entry = strings; 100 101 while (entry->value != 0xFFFF) { 102 if (entry->value == value) { 103 return entry->str; 104 } 105 entry++; 106 } 107 return entry->str; 108 } 109 110 static void 111 nvme_admin_qpair_print_command(struct spdk_nvme_qpair *qpair, 112 struct spdk_nvme_cmd *cmd) 113 { 114 115 SPDK_NOTICELOG("%s (%02x) sqid:%d cid:%d nsid:%x " 116 "cdw10:%08x cdw11:%08x\n", 117 nvme_get_string(admin_opcode, cmd->opc), cmd->opc, qpair->id, cmd->cid, 118 cmd->nsid, cmd->cdw10, cmd->cdw11); 119 } 120 121 static void 122 nvme_io_qpair_print_command(struct spdk_nvme_qpair *qpair, 123 struct spdk_nvme_cmd *cmd) 124 { 125 assert(qpair != NULL); 126 assert(cmd != NULL); 127 switch ((int)cmd->opc) { 128 case SPDK_NVME_OPC_WRITE: 129 case SPDK_NVME_OPC_READ: 130 case SPDK_NVME_OPC_WRITE_UNCORRECTABLE: 131 case SPDK_NVME_OPC_COMPARE: 132 SPDK_NOTICELOG("%s sqid:%d cid:%d nsid:%d " 133 "lba:%llu len:%d\n", 134 nvme_get_string(io_opcode, cmd->opc), qpair->id, cmd->cid, 135 cmd->nsid, 136 ((unsigned long long)cmd->cdw11 << 32) + cmd->cdw10, 137 (cmd->cdw12 & 0xFFFF) + 1); 138 break; 139 case SPDK_NVME_OPC_FLUSH: 140 case SPDK_NVME_OPC_DATASET_MANAGEMENT: 141 SPDK_NOTICELOG("%s sqid:%d cid:%d nsid:%d\n", 142 nvme_get_string(io_opcode, cmd->opc), qpair->id, cmd->cid, 143 cmd->nsid); 144 break; 145 default: 146 SPDK_NOTICELOG("%s (%02x) sqid:%d cid:%d nsid:%d\n", 147 nvme_get_string(io_opcode, cmd->opc), cmd->opc, qpair->id, 148 cmd->cid, cmd->nsid); 149 break; 150 } 151 } 152 153 void 154 spdk_nvme_qpair_print_command(struct spdk_nvme_qpair *qpair, struct spdk_nvme_cmd *cmd) 155 { 156 assert(qpair != NULL); 157 assert(cmd != NULL); 158 159 if (nvme_qpair_is_admin_queue(qpair)) { 160 nvme_admin_qpair_print_command(qpair, cmd); 161 } else { 162 nvme_io_qpair_print_command(qpair, cmd); 163 } 164 } 165 166 static const struct nvme_string generic_status[] = { 167 { SPDK_NVME_SC_SUCCESS, "SUCCESS" }, 168 { SPDK_NVME_SC_INVALID_OPCODE, "INVALID OPCODE" }, 169 { SPDK_NVME_SC_INVALID_FIELD, "INVALID FIELD" }, 170 { SPDK_NVME_SC_COMMAND_ID_CONFLICT, "COMMAND ID CONFLICT" }, 171 { SPDK_NVME_SC_DATA_TRANSFER_ERROR, "DATA TRANSFER ERROR" }, 172 { SPDK_NVME_SC_ABORTED_POWER_LOSS, "ABORTED - POWER LOSS" }, 173 { SPDK_NVME_SC_INTERNAL_DEVICE_ERROR, "INTERNAL DEVICE ERROR" }, 174 { SPDK_NVME_SC_ABORTED_BY_REQUEST, "ABORTED - BY REQUEST" }, 175 { SPDK_NVME_SC_ABORTED_SQ_DELETION, "ABORTED - SQ DELETION" }, 176 { SPDK_NVME_SC_ABORTED_FAILED_FUSED, "ABORTED - FAILED FUSED" }, 177 { SPDK_NVME_SC_ABORTED_MISSING_FUSED, "ABORTED - MISSING FUSED" }, 178 { SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT, "INVALID NAMESPACE OR FORMAT" }, 179 { SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR, "COMMAND SEQUENCE ERROR" }, 180 { SPDK_NVME_SC_INVALID_SGL_SEG_DESCRIPTOR, "INVALID SGL SEGMENT DESCRIPTOR" }, 181 { SPDK_NVME_SC_INVALID_NUM_SGL_DESCIRPTORS, "INVALID NUMBER OF SGL DESCRIPTORS" }, 182 { SPDK_NVME_SC_DATA_SGL_LENGTH_INVALID, "DATA SGL LENGTH INVALID" }, 183 { SPDK_NVME_SC_METADATA_SGL_LENGTH_INVALID, "METADATA SGL LENGTH INVALID" }, 184 { SPDK_NVME_SC_SGL_DESCRIPTOR_TYPE_INVALID, "SGL DESCRIPTOR TYPE INVALID" }, 185 { SPDK_NVME_SC_INVALID_CONTROLLER_MEM_BUF, "INVALID CONTROLLER MEMORY BUFFER" }, 186 { SPDK_NVME_SC_INVALID_PRP_OFFSET, "INVALID PRP OFFSET" }, 187 { SPDK_NVME_SC_ATOMIC_WRITE_UNIT_EXCEEDED, "ATOMIC WRITE UNIT EXCEEDED" }, 188 { SPDK_NVME_SC_OPERATION_DENIED, "OPERATION DENIED" }, 189 { SPDK_NVME_SC_INVALID_SGL_OFFSET, "INVALID SGL OFFSET" }, 190 { SPDK_NVME_SC_HOSTID_INCONSISTENT_FORMAT, "HOSTID INCONSISTENT FORMAT" }, 191 { SPDK_NVME_SC_KEEP_ALIVE_EXPIRED, "KEEP ALIVE EXPIRED" }, 192 { SPDK_NVME_SC_KEEP_ALIVE_INVALID, "KEEP ALIVE INVALID" }, 193 { SPDK_NVME_SC_ABORTED_PREEMPT, "ABORTED - PREEMPT AND ABORT" }, 194 { SPDK_NVME_SC_SANITIZE_FAILED, "SANITIZE FAILED" }, 195 { SPDK_NVME_SC_SANITIZE_IN_PROGRESS, "SANITIZE IN PROGRESS" }, 196 { SPDK_NVME_SC_SGL_DATA_BLOCK_GRANULARITY_INVALID, "DATA BLOCK GRANULARITY INVALID" }, 197 { SPDK_NVME_SC_COMMAND_INVALID_IN_CMB, "COMMAND NOT SUPPORTED FOR QUEUE IN CMB" }, 198 { SPDK_NVME_SC_LBA_OUT_OF_RANGE, "LBA OUT OF RANGE" }, 199 { SPDK_NVME_SC_CAPACITY_EXCEEDED, "CAPACITY EXCEEDED" }, 200 { SPDK_NVME_SC_NAMESPACE_NOT_READY, "NAMESPACE NOT READY" }, 201 { SPDK_NVME_SC_RESERVATION_CONFLICT, "RESERVATION CONFLICT" }, 202 { SPDK_NVME_SC_FORMAT_IN_PROGRESS, "FORMAT IN PROGRESS" }, 203 { 0xFFFF, "GENERIC" } 204 }; 205 206 static const struct nvme_string command_specific_status[] = { 207 { SPDK_NVME_SC_COMPLETION_QUEUE_INVALID, "INVALID COMPLETION QUEUE" }, 208 { SPDK_NVME_SC_INVALID_QUEUE_IDENTIFIER, "INVALID QUEUE IDENTIFIER" }, 209 { SPDK_NVME_SC_INVALID_QUEUE_SIZE, "INVALID QUEUE SIZE" }, 210 { SPDK_NVME_SC_ABORT_COMMAND_LIMIT_EXCEEDED, "ABORT CMD LIMIT EXCEEDED" }, 211 { SPDK_NVME_SC_ASYNC_EVENT_REQUEST_LIMIT_EXCEEDED, "ASYNC LIMIT EXCEEDED" }, 212 { SPDK_NVME_SC_INVALID_FIRMWARE_SLOT, "INVALID FIRMWARE SLOT" }, 213 { SPDK_NVME_SC_INVALID_FIRMWARE_IMAGE, "INVALID FIRMWARE IMAGE" }, 214 { SPDK_NVME_SC_INVALID_INTERRUPT_VECTOR, "INVALID INTERRUPT VECTOR" }, 215 { SPDK_NVME_SC_INVALID_LOG_PAGE, "INVALID LOG PAGE" }, 216 { SPDK_NVME_SC_INVALID_FORMAT, "INVALID FORMAT" }, 217 { SPDK_NVME_SC_FIRMWARE_REQ_CONVENTIONAL_RESET, "FIRMWARE REQUIRES CONVENTIONAL RESET" }, 218 { SPDK_NVME_SC_INVALID_QUEUE_DELETION, "INVALID QUEUE DELETION" }, 219 { SPDK_NVME_SC_FEATURE_ID_NOT_SAVEABLE, "FEATURE ID NOT SAVEABLE" }, 220 { SPDK_NVME_SC_FEATURE_NOT_CHANGEABLE, "FEATURE NOT CHANGEABLE" }, 221 { SPDK_NVME_SC_FEATURE_NOT_NAMESPACE_SPECIFIC, "FEATURE NOT NAMESPACE SPECIFIC" }, 222 { SPDK_NVME_SC_FIRMWARE_REQ_NVM_RESET, "FIRMWARE REQUIRES NVM RESET" }, 223 { SPDK_NVME_SC_FIRMWARE_REQ_RESET, "FIRMWARE REQUIRES RESET" }, 224 { SPDK_NVME_SC_FIRMWARE_REQ_MAX_TIME_VIOLATION, "FIRMWARE REQUIRES MAX TIME VIOLATION" }, 225 { SPDK_NVME_SC_FIRMWARE_ACTIVATION_PROHIBITED, "FIRMWARE ACTIVATION PROHIBITED" }, 226 { SPDK_NVME_SC_OVERLAPPING_RANGE, "OVERLAPPING RANGE" }, 227 { SPDK_NVME_SC_NAMESPACE_INSUFFICIENT_CAPACITY, "NAMESPACE INSUFFICIENT CAPACITY" }, 228 { SPDK_NVME_SC_NAMESPACE_ID_UNAVAILABLE, "NAMESPACE ID UNAVAILABLE" }, 229 { SPDK_NVME_SC_NAMESPACE_ALREADY_ATTACHED, "NAMESPACE ALREADY ATTACHED" }, 230 { SPDK_NVME_SC_NAMESPACE_IS_PRIVATE, "NAMESPACE IS PRIVATE" }, 231 { SPDK_NVME_SC_NAMESPACE_NOT_ATTACHED, "NAMESPACE NOT ATTACHED" }, 232 { SPDK_NVME_SC_THINPROVISIONING_NOT_SUPPORTED, "THINPROVISIONING NOT SUPPORTED" }, 233 { SPDK_NVME_SC_CONTROLLER_LIST_INVALID, "CONTROLLER LIST INVALID" }, 234 { SPDK_NVME_SC_DEVICE_SELF_TEST_IN_PROGRESS, "DEVICE SELF-TEST IN PROGRESS" }, 235 { SPDK_NVME_SC_BOOT_PARTITION_WRITE_PROHIBITED, "BOOT PARTITION WRITE PROHIBITED" }, 236 { SPDK_NVME_SC_INVALID_CTRLR_ID, "INVALID CONTROLLER ID" }, 237 { SPDK_NVME_SC_INVALID_SECONDARY_CTRLR_STATE, "INVALID SECONDARY CONTROLLER STATE" }, 238 { SPDK_NVME_SC_INVALID_NUM_CTRLR_RESOURCES, "INVALID NUMBER OF CONTROLLER RESOURCES" }, 239 { SPDK_NVME_SC_INVALID_RESOURCE_ID, "INVALID RESOURCE IDENTIFIER" }, 240 { SPDK_NVME_SC_CONFLICTING_ATTRIBUTES, "CONFLICTING ATTRIBUTES" }, 241 { SPDK_NVME_SC_INVALID_PROTECTION_INFO, "INVALID PROTECTION INFO" }, 242 { SPDK_NVME_SC_ATTEMPTED_WRITE_TO_RO_RANGE, "WRITE TO RO RANGE" }, 243 { 0xFFFF, "COMMAND SPECIFIC" } 244 }; 245 246 static const struct nvme_string media_error_status[] = { 247 { SPDK_NVME_SC_WRITE_FAULTS, "WRITE FAULTS" }, 248 { SPDK_NVME_SC_UNRECOVERED_READ_ERROR, "UNRECOVERED READ ERROR" }, 249 { SPDK_NVME_SC_GUARD_CHECK_ERROR, "GUARD CHECK ERROR" }, 250 { SPDK_NVME_SC_APPLICATION_TAG_CHECK_ERROR, "APPLICATION TAG CHECK ERROR" }, 251 { SPDK_NVME_SC_REFERENCE_TAG_CHECK_ERROR, "REFERENCE TAG CHECK ERROR" }, 252 { SPDK_NVME_SC_COMPARE_FAILURE, "COMPARE FAILURE" }, 253 { SPDK_NVME_SC_ACCESS_DENIED, "ACCESS DENIED" }, 254 { SPDK_NVME_SC_DEALLOCATED_OR_UNWRITTEN_BLOCK, "DEALLOCATED OR UNWRITTEN BLOCK" }, 255 { SPDK_OCSSD_SC_OFFLINE_CHUNK, "RESET OFFLINE CHUNK" }, 256 { SPDK_OCSSD_SC_INVALID_RESET, "INVALID RESET" }, 257 { SPDK_OCSSD_SC_WRITE_FAIL_WRITE_NEXT_UNIT, "WRITE FAIL WRITE NEXT UNIT" }, 258 { SPDK_OCSSD_SC_WRITE_FAIL_CHUNK_EARLY_CLOSE, "WRITE FAIL CHUNK EARLY CLOSE" }, 259 { SPDK_OCSSD_SC_OUT_OF_ORDER_WRITE, "OUT OF ORDER WRITE" }, 260 { SPDK_OCSSD_SC_READ_HIGH_ECC, "READ HIGH ECC" }, 261 { 0xFFFF, "MEDIA ERROR" } 262 }; 263 264 static const struct nvme_string path_status[] = { 265 { SPDK_NVME_SC_INTERNAL_PATH_ERROR, "INTERNAL PATH ERROR" }, 266 { SPDK_NVME_SC_CONTROLLER_PATH_ERROR, "CONTROLLER PATH ERROR" }, 267 { SPDK_NVME_SC_HOST_PATH_ERROR, "HOST PATH ERROR" }, 268 { SPDK_NVME_SC_ABORTED_BY_HOST, "ABORTED BY HOST" }, 269 { 0xFFFF, "PATH ERROR" } 270 }; 271 272 const char * 273 spdk_nvme_cpl_get_status_string(const struct spdk_nvme_status *status) 274 { 275 const struct nvme_string *entry; 276 277 switch (status->sct) { 278 case SPDK_NVME_SCT_GENERIC: 279 entry = generic_status; 280 break; 281 case SPDK_NVME_SCT_COMMAND_SPECIFIC: 282 entry = command_specific_status; 283 break; 284 case SPDK_NVME_SCT_MEDIA_ERROR: 285 entry = media_error_status; 286 break; 287 case SPDK_NVME_SCT_PATH: 288 entry = path_status; 289 break; 290 case SPDK_NVME_SCT_VENDOR_SPECIFIC: 291 return "VENDOR SPECIFIC"; 292 default: 293 return "RESERVED"; 294 } 295 296 return nvme_get_string(entry, status->sc); 297 } 298 299 void 300 spdk_nvme_qpair_print_completion(struct spdk_nvme_qpair *qpair, 301 struct spdk_nvme_cpl *cpl) 302 { 303 SPDK_NOTICELOG("%s (%02x/%02x) sqid:%d cid:%d cdw0:%x sqhd:%04x p:%x m:%x dnr:%x\n", 304 spdk_nvme_cpl_get_status_string(&cpl->status), 305 cpl->status.sct, cpl->status.sc, cpl->sqid, cpl->cid, cpl->cdw0, 306 cpl->sqhd, cpl->status.p, cpl->status.m, cpl->status.dnr); 307 } 308 309 bool 310 nvme_completion_is_retry(const struct spdk_nvme_cpl *cpl) 311 { 312 /* 313 * TODO: spec is not clear how commands that are aborted due 314 * to TLER will be marked. So for now, it seems 315 * NAMESPACE_NOT_READY is the only case where we should 316 * look at the DNR bit. 317 */ 318 switch ((int)cpl->status.sct) { 319 case SPDK_NVME_SCT_GENERIC: 320 switch ((int)cpl->status.sc) { 321 case SPDK_NVME_SC_NAMESPACE_NOT_READY: 322 case SPDK_NVME_SC_FORMAT_IN_PROGRESS: 323 if (cpl->status.dnr) { 324 return false; 325 } else { 326 return true; 327 } 328 case SPDK_NVME_SC_INVALID_OPCODE: 329 case SPDK_NVME_SC_INVALID_FIELD: 330 case SPDK_NVME_SC_COMMAND_ID_CONFLICT: 331 case SPDK_NVME_SC_DATA_TRANSFER_ERROR: 332 case SPDK_NVME_SC_ABORTED_POWER_LOSS: 333 case SPDK_NVME_SC_INTERNAL_DEVICE_ERROR: 334 case SPDK_NVME_SC_ABORTED_BY_REQUEST: 335 case SPDK_NVME_SC_ABORTED_SQ_DELETION: 336 case SPDK_NVME_SC_ABORTED_FAILED_FUSED: 337 case SPDK_NVME_SC_ABORTED_MISSING_FUSED: 338 case SPDK_NVME_SC_INVALID_NAMESPACE_OR_FORMAT: 339 case SPDK_NVME_SC_COMMAND_SEQUENCE_ERROR: 340 case SPDK_NVME_SC_LBA_OUT_OF_RANGE: 341 case SPDK_NVME_SC_CAPACITY_EXCEEDED: 342 default: 343 return false; 344 } 345 case SPDK_NVME_SCT_PATH: 346 /* 347 * Per NVMe TP 4028 (Path and Transport Error Enhancements), retries should be 348 * based on the setting of the DNR bit for Internal Path Error 349 */ 350 switch ((int)cpl->status.sc) { 351 case SPDK_NVME_SC_INTERNAL_PATH_ERROR: 352 return !cpl->status.dnr; 353 default: 354 return false; 355 } 356 case SPDK_NVME_SCT_COMMAND_SPECIFIC: 357 case SPDK_NVME_SCT_MEDIA_ERROR: 358 case SPDK_NVME_SCT_VENDOR_SPECIFIC: 359 default: 360 return false; 361 } 362 } 363 364 static void 365 nvme_qpair_manual_complete_request(struct spdk_nvme_qpair *qpair, 366 struct nvme_request *req, uint32_t sct, uint32_t sc, 367 uint32_t dnr, bool print_on_error) 368 { 369 struct spdk_nvme_cpl cpl; 370 bool error; 371 372 memset(&cpl, 0, sizeof(cpl)); 373 cpl.sqid = qpair->id; 374 cpl.status.sct = sct; 375 cpl.status.sc = sc; 376 cpl.status.dnr = dnr; 377 378 error = spdk_nvme_cpl_is_error(&cpl); 379 380 if (error && print_on_error && !qpair->ctrlr->opts.disable_error_logging) { 381 SPDK_NOTICELOG("Command completed manually:\n"); 382 spdk_nvme_qpair_print_command(qpair, &req->cmd); 383 spdk_nvme_qpair_print_completion(qpair, &cpl); 384 } 385 386 nvme_complete_request(req->cb_fn, req->cb_arg, qpair, req, &cpl); 387 nvme_free_request(req); 388 } 389 390 static void 391 nvme_qpair_abort_queued_reqs(struct spdk_nvme_qpair *qpair, uint32_t dnr) 392 { 393 struct nvme_request *req; 394 395 while (!STAILQ_EMPTY(&qpair->queued_req)) { 396 req = STAILQ_FIRST(&qpair->queued_req); 397 STAILQ_REMOVE_HEAD(&qpair->queued_req, stailq); 398 if (!qpair->ctrlr->opts.disable_error_logging) { 399 SPDK_ERRLOG("aborting queued i/o\n"); 400 } 401 nvme_qpair_manual_complete_request(qpair, req, SPDK_NVME_SCT_GENERIC, 402 SPDK_NVME_SC_ABORTED_BY_REQUEST, dnr, true); 403 } 404 } 405 406 static inline bool 407 nvme_qpair_check_enabled(struct spdk_nvme_qpair *qpair) 408 { 409 struct nvme_request *req; 410 411 /* 412 * Either during initial connect or reset, the qpair should follow the given state machine. 413 * QPAIR_DISABLED->QPAIR_CONNECTING->QPAIR_CONNECTED->QPAIR_ENABLING->QPAIR_ENABLED. In the 414 * reset case, once the qpair is properly connected, we need to abort any outstanding requests 415 * from the old transport connection and encourage the application to retry them. We also need 416 * to submit any queued requests that built up while we were in the connected or enabling state. 417 */ 418 if (nvme_qpair_get_state(qpair) == NVME_QPAIR_CONNECTED && !qpair->ctrlr->is_resetting) { 419 nvme_qpair_set_state(qpair, NVME_QPAIR_ENABLING); 420 nvme_qpair_complete_error_reqs(qpair); 421 nvme_transport_qpair_abort_reqs(qpair, 0 /* retry */); 422 nvme_qpair_set_state(qpair, NVME_QPAIR_ENABLED); 423 while (!STAILQ_EMPTY(&qpair->queued_req)) { 424 req = STAILQ_FIRST(&qpair->queued_req); 425 STAILQ_REMOVE_HEAD(&qpair->queued_req, stailq); 426 if (nvme_qpair_resubmit_request(qpair, req)) { 427 break; 428 } 429 } 430 } 431 432 return nvme_qpair_get_state(qpair) == NVME_QPAIR_ENABLED; 433 } 434 435 int32_t 436 spdk_nvme_qpair_process_completions(struct spdk_nvme_qpair *qpair, uint32_t max_completions) 437 { 438 int32_t ret; 439 int32_t resubmit_rc; 440 int32_t i; 441 struct nvme_request *req, *tmp; 442 443 if (spdk_unlikely(qpair->ctrlr->is_failed)) { 444 if (qpair->ctrlr->is_removed) { 445 nvme_qpair_abort_reqs(qpair, 1 /* Do not retry */); 446 } 447 return -ENXIO; 448 } 449 450 if (spdk_unlikely(!nvme_qpair_check_enabled(qpair) && 451 !(nvme_qpair_get_state(qpair) == NVME_QPAIR_CONNECTING))) { 452 /* 453 * qpair is not enabled, likely because a controller reset is 454 * in progress. 455 */ 456 return -ENXIO; 457 } 458 459 /* error injection for those queued error requests */ 460 if (spdk_unlikely(!STAILQ_EMPTY(&qpair->err_req_head))) { 461 STAILQ_FOREACH_SAFE(req, &qpair->err_req_head, stailq, tmp) { 462 if (spdk_get_ticks() - req->submit_tick > req->timeout_tsc) { 463 STAILQ_REMOVE(&qpair->err_req_head, req, nvme_request, stailq); 464 nvme_qpair_manual_complete_request(qpair, req, 465 req->cpl.status.sct, 466 req->cpl.status.sc, 0, true); 467 } 468 } 469 } 470 471 qpair->in_completion_context = 1; 472 ret = nvme_transport_qpair_process_completions(qpair, max_completions); 473 if (ret < 0) { 474 SPDK_ERRLOG("CQ error, abort requests after transport retry counter exceeded\n"); 475 if (nvme_qpair_is_admin_queue(qpair)) { 476 nvme_ctrlr_fail(qpair->ctrlr, false); 477 } 478 } 479 qpair->in_completion_context = 0; 480 if (qpair->delete_after_completion_context) { 481 /* 482 * A request to delete this qpair was made in the context of this completion 483 * routine - so it is safe to delete it now. 484 */ 485 spdk_nvme_ctrlr_free_io_qpair(qpair); 486 return ret; 487 } 488 489 /* 490 * At this point, ret must represent the number of completions we reaped. 491 * submit as many queued requests as we completed. 492 */ 493 i = 0; 494 while (i < ret && !STAILQ_EMPTY(&qpair->queued_req) && !qpair->ctrlr->is_resetting) { 495 req = STAILQ_FIRST(&qpair->queued_req); 496 STAILQ_REMOVE_HEAD(&qpair->queued_req, stailq); 497 resubmit_rc = nvme_qpair_resubmit_request(qpair, req); 498 if (spdk_unlikely(resubmit_rc != 0)) { 499 SPDK_ERRLOG("Unable to resubmit as many requests as we completed.\n"); 500 break; 501 } 502 i++; 503 } 504 505 return ret; 506 } 507 508 spdk_nvme_qp_failure_reason 509 spdk_nvme_qpair_get_failure_reason(struct spdk_nvme_qpair *qpair) 510 { 511 return qpair->transport_failure_reason; 512 } 513 514 int 515 nvme_qpair_init(struct spdk_nvme_qpair *qpair, uint16_t id, 516 struct spdk_nvme_ctrlr *ctrlr, 517 enum spdk_nvme_qprio qprio, 518 uint32_t num_requests) 519 { 520 size_t req_size_padded; 521 uint32_t i; 522 523 qpair->id = id; 524 qpair->qprio = qprio; 525 526 qpair->in_completion_context = 0; 527 qpair->delete_after_completion_context = 0; 528 qpair->no_deletion_notification_needed = 0; 529 530 qpair->ctrlr = ctrlr; 531 qpair->trtype = ctrlr->trid.trtype; 532 533 STAILQ_INIT(&qpair->free_req); 534 STAILQ_INIT(&qpair->queued_req); 535 TAILQ_INIT(&qpair->err_cmd_head); 536 STAILQ_INIT(&qpair->err_req_head); 537 538 req_size_padded = (sizeof(struct nvme_request) + 63) & ~(size_t)63; 539 540 qpair->req_buf = spdk_zmalloc(req_size_padded * num_requests, 64, NULL, 541 SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_SHARE); 542 if (qpair->req_buf == NULL) { 543 SPDK_ERRLOG("no memory to allocate qpair(cntlid:0x%x sqid:%d) req_buf with %d request\n", 544 ctrlr->cntlid, qpair->id, num_requests); 545 return -ENOMEM; 546 } 547 548 for (i = 0; i < num_requests; i++) { 549 struct nvme_request *req = qpair->req_buf + i * req_size_padded; 550 551 req->qpair = qpair; 552 STAILQ_INSERT_HEAD(&qpair->free_req, req, stailq); 553 } 554 555 return 0; 556 } 557 558 void 559 nvme_qpair_complete_error_reqs(struct spdk_nvme_qpair *qpair) 560 { 561 struct nvme_request *req; 562 563 while (!STAILQ_EMPTY(&qpair->err_req_head)) { 564 req = STAILQ_FIRST(&qpair->err_req_head); 565 STAILQ_REMOVE_HEAD(&qpair->err_req_head, stailq); 566 nvme_qpair_manual_complete_request(qpair, req, 567 req->cpl.status.sct, 568 req->cpl.status.sc, 0, true); 569 } 570 } 571 572 void 573 nvme_qpair_deinit(struct spdk_nvme_qpair *qpair) 574 { 575 struct nvme_error_cmd *cmd, *entry; 576 577 nvme_qpair_abort_queued_reqs(qpair, 1); 578 nvme_qpair_complete_error_reqs(qpair); 579 580 TAILQ_FOREACH_SAFE(cmd, &qpair->err_cmd_head, link, entry) { 581 TAILQ_REMOVE(&qpair->err_cmd_head, cmd, link); 582 spdk_free(cmd); 583 } 584 585 spdk_free(qpair->req_buf); 586 } 587 588 static inline int 589 _nvme_qpair_submit_request(struct spdk_nvme_qpair *qpair, struct nvme_request *req) 590 { 591 int rc = 0; 592 struct nvme_request *child_req, *tmp; 593 struct nvme_error_cmd *cmd; 594 struct spdk_nvme_ctrlr *ctrlr = qpair->ctrlr; 595 bool child_req_failed = false; 596 597 nvme_qpair_check_enabled(qpair); 598 599 if (req->num_children) { 600 /* 601 * This is a split (parent) request. Submit all of the children but not the parent 602 * request itself, since the parent is the original unsplit request. 603 */ 604 TAILQ_FOREACH_SAFE(child_req, &req->children, child_tailq, tmp) { 605 if (spdk_likely(!child_req_failed)) { 606 rc = nvme_qpair_submit_request(qpair, child_req); 607 if (spdk_unlikely(rc != 0)) { 608 child_req_failed = true; 609 } 610 } else { /* free remaining child_reqs since one child_req fails */ 611 nvme_request_remove_child(req, child_req); 612 nvme_request_free_children(child_req); 613 nvme_free_request(child_req); 614 } 615 } 616 617 if (spdk_unlikely(child_req_failed)) { 618 /* part of children requests have been submitted, 619 * return success for this case. 620 */ 621 if (req->num_children) { 622 return 0; 623 } 624 goto error; 625 } 626 627 return rc; 628 } 629 630 /* queue those requests which matches with opcode in err_cmd list */ 631 if (spdk_unlikely(!TAILQ_EMPTY(&qpair->err_cmd_head))) { 632 TAILQ_FOREACH(cmd, &qpair->err_cmd_head, link) { 633 if (!cmd->do_not_submit) { 634 continue; 635 } 636 637 if ((cmd->opc == req->cmd.opc) && cmd->err_count) { 638 /* add to error request list and set cpl */ 639 req->timeout_tsc = cmd->timeout_tsc; 640 req->submit_tick = spdk_get_ticks(); 641 req->cpl.status.sct = cmd->status.sct; 642 req->cpl.status.sc = cmd->status.sc; 643 STAILQ_INSERT_TAIL(&qpair->err_req_head, req, stailq); 644 cmd->err_count--; 645 return 0; 646 } 647 } 648 } 649 650 if (spdk_unlikely(ctrlr->is_failed)) { 651 rc = -ENXIO; 652 goto error; 653 } 654 655 /* assign submit_tick before submitting req to specific transport */ 656 if (spdk_unlikely(ctrlr->timeout_enabled)) { 657 if (req->submit_tick == 0) { /* req submitted for the first time */ 658 req->submit_tick = spdk_get_ticks(); 659 req->timed_out = false; 660 } 661 } else { 662 req->submit_tick = 0; 663 } 664 665 /* Allow two cases: 666 * 1. NVMe qpair is enabled. 667 * 2. Always allow fabrics commands through - these get 668 * the controller out of reset state. 669 */ 670 if (spdk_likely(nvme_qpair_get_state(qpair) == NVME_QPAIR_ENABLED) || 671 (req->cmd.opc == SPDK_NVME_OPC_FABRIC && 672 nvme_qpair_get_state(qpair) == NVME_QPAIR_CONNECTING)) { 673 rc = nvme_transport_qpair_submit_request(qpair, req); 674 } else { 675 /* The controller is being reset - queue this request and 676 * submit it later when the reset is completed. 677 */ 678 return -EAGAIN; 679 } 680 681 if (spdk_likely(rc == 0)) { 682 req->queued = false; 683 return 0; 684 } 685 686 if (rc == -EAGAIN) { 687 return -EAGAIN; 688 } 689 690 error: 691 if (req->parent != NULL) { 692 nvme_request_remove_child(req->parent, req); 693 } 694 695 /* The request is from queued_req list we should trigger the callback from caller */ 696 if (spdk_unlikely(req->queued)) { 697 nvme_qpair_manual_complete_request(qpair, req, SPDK_NVME_SCT_GENERIC, 698 SPDK_NVME_SC_INTERNAL_DEVICE_ERROR, true, true); 699 return rc; 700 } 701 702 nvme_free_request(req); 703 704 return rc; 705 } 706 707 int 708 nvme_qpair_submit_request(struct spdk_nvme_qpair *qpair, struct nvme_request *req) 709 { 710 int rc; 711 712 if (spdk_unlikely(!STAILQ_EMPTY(&qpair->queued_req) && req->num_children == 0)) { 713 /* 714 * requests that have no children should be sent to the transport after all 715 * currently queued requests. Requests with chilren will be split and go back 716 * through this path. 717 */ 718 STAILQ_INSERT_TAIL(&qpair->queued_req, req, stailq); 719 req->queued = true; 720 return 0; 721 } 722 723 rc = _nvme_qpair_submit_request(qpair, req); 724 if (rc == -EAGAIN) { 725 STAILQ_INSERT_TAIL(&qpair->queued_req, req, stailq); 726 req->queued = true; 727 rc = 0; 728 } 729 730 return rc; 731 } 732 733 static int 734 nvme_qpair_resubmit_request(struct spdk_nvme_qpair *qpair, struct nvme_request *req) 735 { 736 int rc; 737 738 /* 739 * We should never have a request with children on the queue. 740 * This is necessary to preserve the 1:1 relationship between 741 * completions and resubmissions. 742 */ 743 assert(req->num_children == 0); 744 assert(req->queued); 745 rc = _nvme_qpair_submit_request(qpair, req); 746 if (spdk_unlikely(rc == -EAGAIN)) { 747 STAILQ_INSERT_HEAD(&qpair->queued_req, req, stailq); 748 } 749 750 return rc; 751 } 752 753 void 754 nvme_qpair_abort_reqs(struct spdk_nvme_qpair *qpair, uint32_t dnr) 755 { 756 nvme_qpair_abort_queued_reqs(qpair, dnr); 757 nvme_transport_qpair_abort_reqs(qpair, dnr); 758 } 759 760 int 761 spdk_nvme_qpair_add_cmd_error_injection(struct spdk_nvme_ctrlr *ctrlr, 762 struct spdk_nvme_qpair *qpair, 763 uint8_t opc, bool do_not_submit, 764 uint64_t timeout_in_us, 765 uint32_t err_count, 766 uint8_t sct, uint8_t sc) 767 { 768 struct nvme_error_cmd *entry, *cmd = NULL; 769 770 if (qpair == NULL) { 771 qpair = ctrlr->adminq; 772 } 773 774 TAILQ_FOREACH(entry, &qpair->err_cmd_head, link) { 775 if (entry->opc == opc) { 776 cmd = entry; 777 break; 778 } 779 } 780 781 if (cmd == NULL) { 782 cmd = spdk_zmalloc(sizeof(*cmd), 64, NULL, SPDK_ENV_LCORE_ID_ANY, SPDK_MALLOC_DMA); 783 if (!cmd) { 784 return -ENOMEM; 785 } 786 TAILQ_INSERT_TAIL(&qpair->err_cmd_head, cmd, link); 787 } 788 789 cmd->do_not_submit = do_not_submit; 790 cmd->err_count = err_count; 791 cmd->timeout_tsc = timeout_in_us * spdk_get_ticks_hz() / 1000000ULL; 792 cmd->opc = opc; 793 cmd->status.sct = sct; 794 cmd->status.sc = sc; 795 796 return 0; 797 } 798 799 void 800 spdk_nvme_qpair_remove_cmd_error_injection(struct spdk_nvme_ctrlr *ctrlr, 801 struct spdk_nvme_qpair *qpair, 802 uint8_t opc) 803 { 804 struct nvme_error_cmd *cmd, *entry; 805 806 if (qpair == NULL) { 807 qpair = ctrlr->adminq; 808 } 809 810 TAILQ_FOREACH_SAFE(cmd, &qpair->err_cmd_head, link, entry) { 811 if (cmd->opc == opc) { 812 TAILQ_REMOVE(&qpair->err_cmd_head, cmd, link); 813 spdk_free(cmd); 814 return; 815 } 816 } 817 818 return; 819 } 820