1 // SPDX-License-Identifier: GPL-2.0-only 2 /* 3 * Copyright (C) 1999 Eric Youngdale 4 * Copyright (C) 2014 Christoph Hellwig 5 * 6 * SCSI queueing library. 7 * Initial versions: Eric Youngdale (eric@andante.org). 8 * Based upon conversations with large numbers 9 * of people at Linux Expo. 10 */ 11 12 #include <linux/bio.h> 13 #include <linux/bitops.h> 14 #include <linux/blkdev.h> 15 #include <linux/completion.h> 16 #include <linux/kernel.h> 17 #include <linux/export.h> 18 #include <linux/init.h> 19 #include <linux/pci.h> 20 #include <linux/delay.h> 21 #include <linux/hardirq.h> 22 #include <linux/scatterlist.h> 23 #include <linux/blk-mq.h> 24 #include <linux/ratelimit.h> 25 #include <asm/unaligned.h> 26 27 #include <scsi/scsi.h> 28 #include <scsi/scsi_cmnd.h> 29 #include <scsi/scsi_dbg.h> 30 #include <scsi/scsi_device.h> 31 #include <scsi/scsi_driver.h> 32 #include <scsi/scsi_eh.h> 33 #include <scsi/scsi_host.h> 34 #include <scsi/scsi_transport.h> /* __scsi_init_queue() */ 35 #include <scsi/scsi_dh.h> 36 37 #include <trace/events/scsi.h> 38 39 #include "scsi_debugfs.h" 40 #include "scsi_priv.h" 41 #include "scsi_logging.h" 42 43 /* 44 * Size of integrity metadata is usually small, 1 inline sg should 45 * cover normal cases. 46 */ 47 #ifdef CONFIG_ARCH_NO_SG_CHAIN 48 #define SCSI_INLINE_PROT_SG_CNT 0 49 #define SCSI_INLINE_SG_CNT 0 50 #else 51 #define SCSI_INLINE_PROT_SG_CNT 1 52 #define SCSI_INLINE_SG_CNT 2 53 #endif 54 55 static struct kmem_cache *scsi_sense_cache; 56 static DEFINE_MUTEX(scsi_sense_cache_mutex); 57 58 static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd); 59 60 int scsi_init_sense_cache(struct Scsi_Host *shost) 61 { 62 int ret = 0; 63 64 mutex_lock(&scsi_sense_cache_mutex); 65 if (!scsi_sense_cache) { 66 scsi_sense_cache = 67 kmem_cache_create_usercopy("scsi_sense_cache", 68 SCSI_SENSE_BUFFERSIZE, 0, SLAB_HWCACHE_ALIGN, 69 0, SCSI_SENSE_BUFFERSIZE, NULL); 70 if (!scsi_sense_cache) 71 ret = -ENOMEM; 72 } 73 mutex_unlock(&scsi_sense_cache_mutex); 74 return ret; 75 } 76 77 /* 78 * When to reinvoke queueing after a resource shortage. It's 3 msecs to 79 * not change behaviour from the previous unplug mechanism, experimentation 80 * may prove this needs changing. 81 */ 82 #define SCSI_QUEUE_DELAY 3 83 84 static void 85 scsi_set_blocked(struct scsi_cmnd *cmd, int reason) 86 { 87 struct Scsi_Host *host = cmd->device->host; 88 struct scsi_device *device = cmd->device; 89 struct scsi_target *starget = scsi_target(device); 90 91 /* 92 * Set the appropriate busy bit for the device/host. 93 * 94 * If the host/device isn't busy, assume that something actually 95 * completed, and that we should be able to queue a command now. 96 * 97 * Note that the prior mid-layer assumption that any host could 98 * always queue at least one command is now broken. The mid-layer 99 * will implement a user specifiable stall (see 100 * scsi_host.max_host_blocked and scsi_device.max_device_blocked) 101 * if a command is requeued with no other commands outstanding 102 * either for the device or for the host. 103 */ 104 switch (reason) { 105 case SCSI_MLQUEUE_HOST_BUSY: 106 atomic_set(&host->host_blocked, host->max_host_blocked); 107 break; 108 case SCSI_MLQUEUE_DEVICE_BUSY: 109 case SCSI_MLQUEUE_EH_RETRY: 110 atomic_set(&device->device_blocked, 111 device->max_device_blocked); 112 break; 113 case SCSI_MLQUEUE_TARGET_BUSY: 114 atomic_set(&starget->target_blocked, 115 starget->max_target_blocked); 116 break; 117 } 118 } 119 120 static void scsi_mq_requeue_cmd(struct scsi_cmnd *cmd) 121 { 122 struct request *rq = scsi_cmd_to_rq(cmd); 123 124 if (rq->rq_flags & RQF_DONTPREP) { 125 rq->rq_flags &= ~RQF_DONTPREP; 126 scsi_mq_uninit_cmd(cmd); 127 } else { 128 WARN_ON_ONCE(true); 129 } 130 blk_mq_requeue_request(rq, true); 131 } 132 133 /** 134 * __scsi_queue_insert - private queue insertion 135 * @cmd: The SCSI command being requeued 136 * @reason: The reason for the requeue 137 * @unbusy: Whether the queue should be unbusied 138 * 139 * This is a private queue insertion. The public interface 140 * scsi_queue_insert() always assumes the queue should be unbusied 141 * because it's always called before the completion. This function is 142 * for a requeue after completion, which should only occur in this 143 * file. 144 */ 145 static void __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, bool unbusy) 146 { 147 struct scsi_device *device = cmd->device; 148 149 SCSI_LOG_MLQUEUE(1, scmd_printk(KERN_INFO, cmd, 150 "Inserting command %p into mlqueue\n", cmd)); 151 152 scsi_set_blocked(cmd, reason); 153 154 /* 155 * Decrement the counters, since these commands are no longer 156 * active on the host/device. 157 */ 158 if (unbusy) 159 scsi_device_unbusy(device, cmd); 160 161 /* 162 * Requeue this command. It will go before all other commands 163 * that are already in the queue. Schedule requeue work under 164 * lock such that the kblockd_schedule_work() call happens 165 * before blk_cleanup_queue() finishes. 166 */ 167 cmd->result = 0; 168 169 blk_mq_requeue_request(scsi_cmd_to_rq(cmd), true); 170 } 171 172 /** 173 * scsi_queue_insert - Reinsert a command in the queue. 174 * @cmd: command that we are adding to queue. 175 * @reason: why we are inserting command to queue. 176 * 177 * We do this for one of two cases. Either the host is busy and it cannot accept 178 * any more commands for the time being, or the device returned QUEUE_FULL and 179 * can accept no more commands. 180 * 181 * Context: This could be called either from an interrupt context or a normal 182 * process context. 183 */ 184 void scsi_queue_insert(struct scsi_cmnd *cmd, int reason) 185 { 186 __scsi_queue_insert(cmd, reason, true); 187 } 188 189 190 /** 191 * __scsi_execute - insert request and wait for the result 192 * @sdev: scsi device 193 * @cmd: scsi command 194 * @data_direction: data direction 195 * @buffer: data buffer 196 * @bufflen: len of buffer 197 * @sense: optional sense buffer 198 * @sshdr: optional decoded sense header 199 * @timeout: request timeout in HZ 200 * @retries: number of times to retry request 201 * @flags: flags for ->cmd_flags 202 * @rq_flags: flags for ->rq_flags 203 * @resid: optional residual length 204 * 205 * Returns the scsi_cmnd result field if a command was executed, or a negative 206 * Linux error code if we didn't get that far. 207 */ 208 int __scsi_execute(struct scsi_device *sdev, const unsigned char *cmd, 209 int data_direction, void *buffer, unsigned bufflen, 210 unsigned char *sense, struct scsi_sense_hdr *sshdr, 211 int timeout, int retries, u64 flags, req_flags_t rq_flags, 212 int *resid) 213 { 214 struct request *req; 215 struct scsi_request *rq; 216 int ret; 217 218 req = blk_get_request(sdev->request_queue, 219 data_direction == DMA_TO_DEVICE ? 220 REQ_OP_DRV_OUT : REQ_OP_DRV_IN, 221 rq_flags & RQF_PM ? BLK_MQ_REQ_PM : 0); 222 if (IS_ERR(req)) 223 return PTR_ERR(req); 224 225 rq = scsi_req(req); 226 227 if (bufflen) { 228 ret = blk_rq_map_kern(sdev->request_queue, req, 229 buffer, bufflen, GFP_NOIO); 230 if (ret) 231 goto out; 232 } 233 rq->cmd_len = COMMAND_SIZE(cmd[0]); 234 memcpy(rq->cmd, cmd, rq->cmd_len); 235 rq->retries = retries; 236 req->timeout = timeout; 237 req->cmd_flags |= flags; 238 req->rq_flags |= rq_flags | RQF_QUIET; 239 240 /* 241 * head injection *required* here otherwise quiesce won't work 242 */ 243 blk_execute_rq(NULL, req, 1); 244 245 /* 246 * Some devices (USB mass-storage in particular) may transfer 247 * garbage data together with a residue indicating that the data 248 * is invalid. Prevent the garbage from being misinterpreted 249 * and prevent security leaks by zeroing out the excess data. 250 */ 251 if (unlikely(rq->resid_len > 0 && rq->resid_len <= bufflen)) 252 memset(buffer + (bufflen - rq->resid_len), 0, rq->resid_len); 253 254 if (resid) 255 *resid = rq->resid_len; 256 if (sense && rq->sense_len) 257 memcpy(sense, rq->sense, SCSI_SENSE_BUFFERSIZE); 258 if (sshdr) 259 scsi_normalize_sense(rq->sense, rq->sense_len, sshdr); 260 ret = rq->result; 261 out: 262 blk_put_request(req); 263 264 return ret; 265 } 266 EXPORT_SYMBOL(__scsi_execute); 267 268 /* 269 * Wake up the error handler if necessary. Avoid as follows that the error 270 * handler is not woken up if host in-flight requests number == 271 * shost->host_failed: use call_rcu() in scsi_eh_scmd_add() in combination 272 * with an RCU read lock in this function to ensure that this function in 273 * its entirety either finishes before scsi_eh_scmd_add() increases the 274 * host_failed counter or that it notices the shost state change made by 275 * scsi_eh_scmd_add(). 276 */ 277 static void scsi_dec_host_busy(struct Scsi_Host *shost, struct scsi_cmnd *cmd) 278 { 279 unsigned long flags; 280 281 rcu_read_lock(); 282 __clear_bit(SCMD_STATE_INFLIGHT, &cmd->state); 283 if (unlikely(scsi_host_in_recovery(shost))) { 284 spin_lock_irqsave(shost->host_lock, flags); 285 if (shost->host_failed || shost->host_eh_scheduled) 286 scsi_eh_wakeup(shost); 287 spin_unlock_irqrestore(shost->host_lock, flags); 288 } 289 rcu_read_unlock(); 290 } 291 292 void scsi_device_unbusy(struct scsi_device *sdev, struct scsi_cmnd *cmd) 293 { 294 struct Scsi_Host *shost = sdev->host; 295 struct scsi_target *starget = scsi_target(sdev); 296 297 scsi_dec_host_busy(shost, cmd); 298 299 if (starget->can_queue > 0) 300 atomic_dec(&starget->target_busy); 301 302 sbitmap_put(&sdev->budget_map, cmd->budget_token); 303 cmd->budget_token = -1; 304 } 305 306 static void scsi_kick_queue(struct request_queue *q) 307 { 308 blk_mq_run_hw_queues(q, false); 309 } 310 311 /* 312 * Called for single_lun devices on IO completion. Clear starget_sdev_user, 313 * and call blk_run_queue for all the scsi_devices on the target - 314 * including current_sdev first. 315 * 316 * Called with *no* scsi locks held. 317 */ 318 static void scsi_single_lun_run(struct scsi_device *current_sdev) 319 { 320 struct Scsi_Host *shost = current_sdev->host; 321 struct scsi_device *sdev, *tmp; 322 struct scsi_target *starget = scsi_target(current_sdev); 323 unsigned long flags; 324 325 spin_lock_irqsave(shost->host_lock, flags); 326 starget->starget_sdev_user = NULL; 327 spin_unlock_irqrestore(shost->host_lock, flags); 328 329 /* 330 * Call blk_run_queue for all LUNs on the target, starting with 331 * current_sdev. We race with others (to set starget_sdev_user), 332 * but in most cases, we will be first. Ideally, each LU on the 333 * target would get some limited time or requests on the target. 334 */ 335 scsi_kick_queue(current_sdev->request_queue); 336 337 spin_lock_irqsave(shost->host_lock, flags); 338 if (starget->starget_sdev_user) 339 goto out; 340 list_for_each_entry_safe(sdev, tmp, &starget->devices, 341 same_target_siblings) { 342 if (sdev == current_sdev) 343 continue; 344 if (scsi_device_get(sdev)) 345 continue; 346 347 spin_unlock_irqrestore(shost->host_lock, flags); 348 scsi_kick_queue(sdev->request_queue); 349 spin_lock_irqsave(shost->host_lock, flags); 350 351 scsi_device_put(sdev); 352 } 353 out: 354 spin_unlock_irqrestore(shost->host_lock, flags); 355 } 356 357 static inline bool scsi_device_is_busy(struct scsi_device *sdev) 358 { 359 if (scsi_device_busy(sdev) >= sdev->queue_depth) 360 return true; 361 if (atomic_read(&sdev->device_blocked) > 0) 362 return true; 363 return false; 364 } 365 366 static inline bool scsi_target_is_busy(struct scsi_target *starget) 367 { 368 if (starget->can_queue > 0) { 369 if (atomic_read(&starget->target_busy) >= starget->can_queue) 370 return true; 371 if (atomic_read(&starget->target_blocked) > 0) 372 return true; 373 } 374 return false; 375 } 376 377 static inline bool scsi_host_is_busy(struct Scsi_Host *shost) 378 { 379 if (atomic_read(&shost->host_blocked) > 0) 380 return true; 381 if (shost->host_self_blocked) 382 return true; 383 return false; 384 } 385 386 static void scsi_starved_list_run(struct Scsi_Host *shost) 387 { 388 LIST_HEAD(starved_list); 389 struct scsi_device *sdev; 390 unsigned long flags; 391 392 spin_lock_irqsave(shost->host_lock, flags); 393 list_splice_init(&shost->starved_list, &starved_list); 394 395 while (!list_empty(&starved_list)) { 396 struct request_queue *slq; 397 398 /* 399 * As long as shost is accepting commands and we have 400 * starved queues, call blk_run_queue. scsi_request_fn 401 * drops the queue_lock and can add us back to the 402 * starved_list. 403 * 404 * host_lock protects the starved_list and starved_entry. 405 * scsi_request_fn must get the host_lock before checking 406 * or modifying starved_list or starved_entry. 407 */ 408 if (scsi_host_is_busy(shost)) 409 break; 410 411 sdev = list_entry(starved_list.next, 412 struct scsi_device, starved_entry); 413 list_del_init(&sdev->starved_entry); 414 if (scsi_target_is_busy(scsi_target(sdev))) { 415 list_move_tail(&sdev->starved_entry, 416 &shost->starved_list); 417 continue; 418 } 419 420 /* 421 * Once we drop the host lock, a racing scsi_remove_device() 422 * call may remove the sdev from the starved list and destroy 423 * it and the queue. Mitigate by taking a reference to the 424 * queue and never touching the sdev again after we drop the 425 * host lock. Note: if __scsi_remove_device() invokes 426 * blk_cleanup_queue() before the queue is run from this 427 * function then blk_run_queue() will return immediately since 428 * blk_cleanup_queue() marks the queue with QUEUE_FLAG_DYING. 429 */ 430 slq = sdev->request_queue; 431 if (!blk_get_queue(slq)) 432 continue; 433 spin_unlock_irqrestore(shost->host_lock, flags); 434 435 scsi_kick_queue(slq); 436 blk_put_queue(slq); 437 438 spin_lock_irqsave(shost->host_lock, flags); 439 } 440 /* put any unprocessed entries back */ 441 list_splice(&starved_list, &shost->starved_list); 442 spin_unlock_irqrestore(shost->host_lock, flags); 443 } 444 445 /** 446 * scsi_run_queue - Select a proper request queue to serve next. 447 * @q: last request's queue 448 * 449 * The previous command was completely finished, start a new one if possible. 450 */ 451 static void scsi_run_queue(struct request_queue *q) 452 { 453 struct scsi_device *sdev = q->queuedata; 454 455 if (scsi_target(sdev)->single_lun) 456 scsi_single_lun_run(sdev); 457 if (!list_empty(&sdev->host->starved_list)) 458 scsi_starved_list_run(sdev->host); 459 460 blk_mq_run_hw_queues(q, false); 461 } 462 463 void scsi_requeue_run_queue(struct work_struct *work) 464 { 465 struct scsi_device *sdev; 466 struct request_queue *q; 467 468 sdev = container_of(work, struct scsi_device, requeue_work); 469 q = sdev->request_queue; 470 scsi_run_queue(q); 471 } 472 473 void scsi_run_host_queues(struct Scsi_Host *shost) 474 { 475 struct scsi_device *sdev; 476 477 shost_for_each_device(sdev, shost) 478 scsi_run_queue(sdev->request_queue); 479 } 480 481 static void scsi_uninit_cmd(struct scsi_cmnd *cmd) 482 { 483 if (!blk_rq_is_passthrough(scsi_cmd_to_rq(cmd))) { 484 struct scsi_driver *drv = scsi_cmd_to_driver(cmd); 485 486 if (drv->uninit_command) 487 drv->uninit_command(cmd); 488 } 489 } 490 491 void scsi_free_sgtables(struct scsi_cmnd *cmd) 492 { 493 if (cmd->sdb.table.nents) 494 sg_free_table_chained(&cmd->sdb.table, 495 SCSI_INLINE_SG_CNT); 496 if (scsi_prot_sg_count(cmd)) 497 sg_free_table_chained(&cmd->prot_sdb->table, 498 SCSI_INLINE_PROT_SG_CNT); 499 } 500 EXPORT_SYMBOL_GPL(scsi_free_sgtables); 501 502 static void scsi_mq_uninit_cmd(struct scsi_cmnd *cmd) 503 { 504 scsi_free_sgtables(cmd); 505 scsi_uninit_cmd(cmd); 506 } 507 508 static void scsi_run_queue_async(struct scsi_device *sdev) 509 { 510 if (scsi_target(sdev)->single_lun || 511 !list_empty(&sdev->host->starved_list)) { 512 kblockd_schedule_work(&sdev->requeue_work); 513 } else { 514 /* 515 * smp_mb() present in sbitmap_queue_clear() or implied in 516 * .end_io is for ordering writing .device_busy in 517 * scsi_device_unbusy() and reading sdev->restarts. 518 */ 519 int old = atomic_read(&sdev->restarts); 520 521 /* 522 * ->restarts has to be kept as non-zero if new budget 523 * contention occurs. 524 * 525 * No need to run queue when either another re-run 526 * queue wins in updating ->restarts or a new budget 527 * contention occurs. 528 */ 529 if (old && atomic_cmpxchg(&sdev->restarts, old, 0) == old) 530 blk_mq_run_hw_queues(sdev->request_queue, true); 531 } 532 } 533 534 /* Returns false when no more bytes to process, true if there are more */ 535 static bool scsi_end_request(struct request *req, blk_status_t error, 536 unsigned int bytes) 537 { 538 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req); 539 struct scsi_device *sdev = cmd->device; 540 struct request_queue *q = sdev->request_queue; 541 542 if (blk_update_request(req, error, bytes)) 543 return true; 544 545 if (blk_queue_add_random(q)) 546 add_disk_randomness(req->rq_disk); 547 548 if (!blk_rq_is_passthrough(req)) { 549 WARN_ON_ONCE(!(cmd->flags & SCMD_INITIALIZED)); 550 cmd->flags &= ~SCMD_INITIALIZED; 551 } 552 553 /* 554 * Calling rcu_barrier() is not necessary here because the 555 * SCSI error handler guarantees that the function called by 556 * call_rcu() has been called before scsi_end_request() is 557 * called. 558 */ 559 destroy_rcu_head(&cmd->rcu); 560 561 /* 562 * In the MQ case the command gets freed by __blk_mq_end_request, 563 * so we have to do all cleanup that depends on it earlier. 564 * 565 * We also can't kick the queues from irq context, so we 566 * will have to defer it to a workqueue. 567 */ 568 scsi_mq_uninit_cmd(cmd); 569 570 /* 571 * queue is still alive, so grab the ref for preventing it 572 * from being cleaned up during running queue. 573 */ 574 percpu_ref_get(&q->q_usage_counter); 575 576 __blk_mq_end_request(req, error); 577 578 scsi_run_queue_async(sdev); 579 580 percpu_ref_put(&q->q_usage_counter); 581 return false; 582 } 583 584 /** 585 * scsi_result_to_blk_status - translate a SCSI result code into blk_status_t 586 * @cmd: SCSI command 587 * @result: scsi error code 588 * 589 * Translate a SCSI result code into a blk_status_t value. May reset the host 590 * byte of @cmd->result. 591 */ 592 static blk_status_t scsi_result_to_blk_status(struct scsi_cmnd *cmd, int result) 593 { 594 switch (host_byte(result)) { 595 case DID_OK: 596 if (scsi_status_is_good(result)) 597 return BLK_STS_OK; 598 return BLK_STS_IOERR; 599 case DID_TRANSPORT_FAILFAST: 600 case DID_TRANSPORT_MARGINAL: 601 return BLK_STS_TRANSPORT; 602 case DID_TARGET_FAILURE: 603 set_host_byte(cmd, DID_OK); 604 return BLK_STS_TARGET; 605 case DID_NEXUS_FAILURE: 606 set_host_byte(cmd, DID_OK); 607 return BLK_STS_NEXUS; 608 case DID_ALLOC_FAILURE: 609 set_host_byte(cmd, DID_OK); 610 return BLK_STS_NOSPC; 611 case DID_MEDIUM_ERROR: 612 set_host_byte(cmd, DID_OK); 613 return BLK_STS_MEDIUM; 614 default: 615 return BLK_STS_IOERR; 616 } 617 } 618 619 /* Helper for scsi_io_completion() when "reprep" action required. */ 620 static void scsi_io_completion_reprep(struct scsi_cmnd *cmd, 621 struct request_queue *q) 622 { 623 /* A new command will be prepared and issued. */ 624 scsi_mq_requeue_cmd(cmd); 625 } 626 627 static bool scsi_cmd_runtime_exceeced(struct scsi_cmnd *cmd) 628 { 629 struct request *req = scsi_cmd_to_rq(cmd); 630 unsigned long wait_for; 631 632 if (cmd->allowed == SCSI_CMD_RETRIES_NO_LIMIT) 633 return false; 634 635 wait_for = (cmd->allowed + 1) * req->timeout; 636 if (time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) { 637 scmd_printk(KERN_ERR, cmd, "timing out command, waited %lus\n", 638 wait_for/HZ); 639 return true; 640 } 641 return false; 642 } 643 644 /* Helper for scsi_io_completion() when special action required. */ 645 static void scsi_io_completion_action(struct scsi_cmnd *cmd, int result) 646 { 647 struct request_queue *q = cmd->device->request_queue; 648 struct request *req = scsi_cmd_to_rq(cmd); 649 int level = 0; 650 enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY, 651 ACTION_DELAYED_RETRY} action; 652 struct scsi_sense_hdr sshdr; 653 bool sense_valid; 654 bool sense_current = true; /* false implies "deferred sense" */ 655 blk_status_t blk_stat; 656 657 sense_valid = scsi_command_normalize_sense(cmd, &sshdr); 658 if (sense_valid) 659 sense_current = !scsi_sense_is_deferred(&sshdr); 660 661 blk_stat = scsi_result_to_blk_status(cmd, result); 662 663 if (host_byte(result) == DID_RESET) { 664 /* Third party bus reset or reset for error recovery 665 * reasons. Just retry the command and see what 666 * happens. 667 */ 668 action = ACTION_RETRY; 669 } else if (sense_valid && sense_current) { 670 switch (sshdr.sense_key) { 671 case UNIT_ATTENTION: 672 if (cmd->device->removable) { 673 /* Detected disc change. Set a bit 674 * and quietly refuse further access. 675 */ 676 cmd->device->changed = 1; 677 action = ACTION_FAIL; 678 } else { 679 /* Must have been a power glitch, or a 680 * bus reset. Could not have been a 681 * media change, so we just retry the 682 * command and see what happens. 683 */ 684 action = ACTION_RETRY; 685 } 686 break; 687 case ILLEGAL_REQUEST: 688 /* If we had an ILLEGAL REQUEST returned, then 689 * we may have performed an unsupported 690 * command. The only thing this should be 691 * would be a ten byte read where only a six 692 * byte read was supported. Also, on a system 693 * where READ CAPACITY failed, we may have 694 * read past the end of the disk. 695 */ 696 if ((cmd->device->use_10_for_rw && 697 sshdr.asc == 0x20 && sshdr.ascq == 0x00) && 698 (cmd->cmnd[0] == READ_10 || 699 cmd->cmnd[0] == WRITE_10)) { 700 /* This will issue a new 6-byte command. */ 701 cmd->device->use_10_for_rw = 0; 702 action = ACTION_REPREP; 703 } else if (sshdr.asc == 0x10) /* DIX */ { 704 action = ACTION_FAIL; 705 blk_stat = BLK_STS_PROTECTION; 706 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */ 707 } else if (sshdr.asc == 0x20 || sshdr.asc == 0x24) { 708 action = ACTION_FAIL; 709 blk_stat = BLK_STS_TARGET; 710 } else 711 action = ACTION_FAIL; 712 break; 713 case ABORTED_COMMAND: 714 action = ACTION_FAIL; 715 if (sshdr.asc == 0x10) /* DIF */ 716 blk_stat = BLK_STS_PROTECTION; 717 break; 718 case NOT_READY: 719 /* If the device is in the process of becoming 720 * ready, or has a temporary blockage, retry. 721 */ 722 if (sshdr.asc == 0x04) { 723 switch (sshdr.ascq) { 724 case 0x01: /* becoming ready */ 725 case 0x04: /* format in progress */ 726 case 0x05: /* rebuild in progress */ 727 case 0x06: /* recalculation in progress */ 728 case 0x07: /* operation in progress */ 729 case 0x08: /* Long write in progress */ 730 case 0x09: /* self test in progress */ 731 case 0x11: /* notify (enable spinup) required */ 732 case 0x14: /* space allocation in progress */ 733 case 0x1a: /* start stop unit in progress */ 734 case 0x1b: /* sanitize in progress */ 735 case 0x1d: /* configuration in progress */ 736 case 0x24: /* depopulation in progress */ 737 action = ACTION_DELAYED_RETRY; 738 break; 739 case 0x0a: /* ALUA state transition */ 740 blk_stat = BLK_STS_AGAIN; 741 fallthrough; 742 default: 743 action = ACTION_FAIL; 744 break; 745 } 746 } else 747 action = ACTION_FAIL; 748 break; 749 case VOLUME_OVERFLOW: 750 /* See SSC3rXX or current. */ 751 action = ACTION_FAIL; 752 break; 753 case DATA_PROTECT: 754 action = ACTION_FAIL; 755 if ((sshdr.asc == 0x0C && sshdr.ascq == 0x12) || 756 (sshdr.asc == 0x55 && 757 (sshdr.ascq == 0x0E || sshdr.ascq == 0x0F))) { 758 /* Insufficient zone resources */ 759 blk_stat = BLK_STS_ZONE_OPEN_RESOURCE; 760 } 761 break; 762 default: 763 action = ACTION_FAIL; 764 break; 765 } 766 } else 767 action = ACTION_FAIL; 768 769 if (action != ACTION_FAIL && scsi_cmd_runtime_exceeced(cmd)) 770 action = ACTION_FAIL; 771 772 switch (action) { 773 case ACTION_FAIL: 774 /* Give up and fail the remainder of the request */ 775 if (!(req->rq_flags & RQF_QUIET)) { 776 static DEFINE_RATELIMIT_STATE(_rs, 777 DEFAULT_RATELIMIT_INTERVAL, 778 DEFAULT_RATELIMIT_BURST); 779 780 if (unlikely(scsi_logging_level)) 781 level = 782 SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT, 783 SCSI_LOG_MLCOMPLETE_BITS); 784 785 /* 786 * if logging is enabled the failure will be printed 787 * in scsi_log_completion(), so avoid duplicate messages 788 */ 789 if (!level && __ratelimit(&_rs)) { 790 scsi_print_result(cmd, NULL, FAILED); 791 if (sense_valid) 792 scsi_print_sense(cmd); 793 scsi_print_command(cmd); 794 } 795 } 796 if (!scsi_end_request(req, blk_stat, blk_rq_err_bytes(req))) 797 return; 798 fallthrough; 799 case ACTION_REPREP: 800 scsi_io_completion_reprep(cmd, q); 801 break; 802 case ACTION_RETRY: 803 /* Retry the same command immediately */ 804 __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, false); 805 break; 806 case ACTION_DELAYED_RETRY: 807 /* Retry the same command after a delay */ 808 __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, false); 809 break; 810 } 811 } 812 813 /* 814 * Helper for scsi_io_completion() when cmd->result is non-zero. Returns a 815 * new result that may suppress further error checking. Also modifies 816 * *blk_statp in some cases. 817 */ 818 static int scsi_io_completion_nz_result(struct scsi_cmnd *cmd, int result, 819 blk_status_t *blk_statp) 820 { 821 bool sense_valid; 822 bool sense_current = true; /* false implies "deferred sense" */ 823 struct request *req = scsi_cmd_to_rq(cmd); 824 struct scsi_sense_hdr sshdr; 825 826 sense_valid = scsi_command_normalize_sense(cmd, &sshdr); 827 if (sense_valid) 828 sense_current = !scsi_sense_is_deferred(&sshdr); 829 830 if (blk_rq_is_passthrough(req)) { 831 if (sense_valid) { 832 /* 833 * SG_IO wants current and deferred errors 834 */ 835 scsi_req(req)->sense_len = 836 min(8 + cmd->sense_buffer[7], 837 SCSI_SENSE_BUFFERSIZE); 838 } 839 if (sense_current) 840 *blk_statp = scsi_result_to_blk_status(cmd, result); 841 } else if (blk_rq_bytes(req) == 0 && sense_current) { 842 /* 843 * Flush commands do not transfers any data, and thus cannot use 844 * good_bytes != blk_rq_bytes(req) as the signal for an error. 845 * This sets *blk_statp explicitly for the problem case. 846 */ 847 *blk_statp = scsi_result_to_blk_status(cmd, result); 848 } 849 /* 850 * Recovered errors need reporting, but they're always treated as 851 * success, so fiddle the result code here. For passthrough requests 852 * we already took a copy of the original into sreq->result which 853 * is what gets returned to the user 854 */ 855 if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) { 856 bool do_print = true; 857 /* 858 * if ATA PASS-THROUGH INFORMATION AVAILABLE [0x0, 0x1d] 859 * skip print since caller wants ATA registers. Only occurs 860 * on SCSI ATA PASS_THROUGH commands when CK_COND=1 861 */ 862 if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d)) 863 do_print = false; 864 else if (req->rq_flags & RQF_QUIET) 865 do_print = false; 866 if (do_print) 867 scsi_print_sense(cmd); 868 result = 0; 869 /* for passthrough, *blk_statp may be set */ 870 *blk_statp = BLK_STS_OK; 871 } 872 /* 873 * Another corner case: the SCSI status byte is non-zero but 'good'. 874 * Example: PRE-FETCH command returns SAM_STAT_CONDITION_MET when 875 * it is able to fit nominated LBs in its cache (and SAM_STAT_GOOD 876 * if it can't fit). Treat SAM_STAT_CONDITION_MET and the related 877 * intermediate statuses (both obsolete in SAM-4) as good. 878 */ 879 if ((result & 0xff) && scsi_status_is_good(result)) { 880 result = 0; 881 *blk_statp = BLK_STS_OK; 882 } 883 return result; 884 } 885 886 /** 887 * scsi_io_completion - Completion processing for SCSI commands. 888 * @cmd: command that is finished. 889 * @good_bytes: number of processed bytes. 890 * 891 * We will finish off the specified number of sectors. If we are done, the 892 * command block will be released and the queue function will be goosed. If we 893 * are not done then we have to figure out what to do next: 894 * 895 * a) We can call scsi_io_completion_reprep(). The request will be 896 * unprepared and put back on the queue. Then a new command will 897 * be created for it. This should be used if we made forward 898 * progress, or if we want to switch from READ(10) to READ(6) for 899 * example. 900 * 901 * b) We can call scsi_io_completion_action(). The request will be 902 * put back on the queue and retried using the same command as 903 * before, possibly after a delay. 904 * 905 * c) We can call scsi_end_request() with blk_stat other than 906 * BLK_STS_OK, to fail the remainder of the request. 907 */ 908 void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes) 909 { 910 int result = cmd->result; 911 struct request_queue *q = cmd->device->request_queue; 912 struct request *req = scsi_cmd_to_rq(cmd); 913 blk_status_t blk_stat = BLK_STS_OK; 914 915 if (unlikely(result)) /* a nz result may or may not be an error */ 916 result = scsi_io_completion_nz_result(cmd, result, &blk_stat); 917 918 if (unlikely(blk_rq_is_passthrough(req))) { 919 /* 920 * scsi_result_to_blk_status may have reset the host_byte 921 */ 922 scsi_req(req)->result = cmd->result; 923 } 924 925 /* 926 * Next deal with any sectors which we were able to correctly 927 * handle. 928 */ 929 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, cmd, 930 "%u sectors total, %d bytes done.\n", 931 blk_rq_sectors(req), good_bytes)); 932 933 /* 934 * Failed, zero length commands always need to drop down 935 * to retry code. Fast path should return in this block. 936 */ 937 if (likely(blk_rq_bytes(req) > 0 || blk_stat == BLK_STS_OK)) { 938 if (likely(!scsi_end_request(req, blk_stat, good_bytes))) 939 return; /* no bytes remaining */ 940 } 941 942 /* Kill remainder if no retries. */ 943 if (unlikely(blk_stat && scsi_noretry_cmd(cmd))) { 944 if (scsi_end_request(req, blk_stat, blk_rq_bytes(req))) 945 WARN_ONCE(true, 946 "Bytes remaining after failed, no-retry command"); 947 return; 948 } 949 950 /* 951 * If there had been no error, but we have leftover bytes in the 952 * requeues just queue the command up again. 953 */ 954 if (likely(result == 0)) 955 scsi_io_completion_reprep(cmd, q); 956 else 957 scsi_io_completion_action(cmd, result); 958 } 959 960 static inline bool scsi_cmd_needs_dma_drain(struct scsi_device *sdev, 961 struct request *rq) 962 { 963 return sdev->dma_drain_len && blk_rq_is_passthrough(rq) && 964 !op_is_write(req_op(rq)) && 965 sdev->host->hostt->dma_need_drain(rq); 966 } 967 968 /** 969 * scsi_alloc_sgtables - Allocate and initialize data and integrity scatterlists 970 * @cmd: SCSI command data structure to initialize. 971 * 972 * Initializes @cmd->sdb and also @cmd->prot_sdb if data integrity is enabled 973 * for @cmd. 974 * 975 * Returns: 976 * * BLK_STS_OK - on success 977 * * BLK_STS_RESOURCE - if the failure is retryable 978 * * BLK_STS_IOERR - if the failure is fatal 979 */ 980 blk_status_t scsi_alloc_sgtables(struct scsi_cmnd *cmd) 981 { 982 struct scsi_device *sdev = cmd->device; 983 struct request *rq = scsi_cmd_to_rq(cmd); 984 unsigned short nr_segs = blk_rq_nr_phys_segments(rq); 985 struct scatterlist *last_sg = NULL; 986 blk_status_t ret; 987 bool need_drain = scsi_cmd_needs_dma_drain(sdev, rq); 988 int count; 989 990 if (WARN_ON_ONCE(!nr_segs)) 991 return BLK_STS_IOERR; 992 993 /* 994 * Make sure there is space for the drain. The driver must adjust 995 * max_hw_segments to be prepared for this. 996 */ 997 if (need_drain) 998 nr_segs++; 999 1000 /* 1001 * If sg table allocation fails, requeue request later. 1002 */ 1003 if (unlikely(sg_alloc_table_chained(&cmd->sdb.table, nr_segs, 1004 cmd->sdb.table.sgl, SCSI_INLINE_SG_CNT))) 1005 return BLK_STS_RESOURCE; 1006 1007 /* 1008 * Next, walk the list, and fill in the addresses and sizes of 1009 * each segment. 1010 */ 1011 count = __blk_rq_map_sg(rq->q, rq, cmd->sdb.table.sgl, &last_sg); 1012 1013 if (blk_rq_bytes(rq) & rq->q->dma_pad_mask) { 1014 unsigned int pad_len = 1015 (rq->q->dma_pad_mask & ~blk_rq_bytes(rq)) + 1; 1016 1017 last_sg->length += pad_len; 1018 cmd->extra_len += pad_len; 1019 } 1020 1021 if (need_drain) { 1022 sg_unmark_end(last_sg); 1023 last_sg = sg_next(last_sg); 1024 sg_set_buf(last_sg, sdev->dma_drain_buf, sdev->dma_drain_len); 1025 sg_mark_end(last_sg); 1026 1027 cmd->extra_len += sdev->dma_drain_len; 1028 count++; 1029 } 1030 1031 BUG_ON(count > cmd->sdb.table.nents); 1032 cmd->sdb.table.nents = count; 1033 cmd->sdb.length = blk_rq_payload_bytes(rq); 1034 1035 if (blk_integrity_rq(rq)) { 1036 struct scsi_data_buffer *prot_sdb = cmd->prot_sdb; 1037 int ivecs; 1038 1039 if (WARN_ON_ONCE(!prot_sdb)) { 1040 /* 1041 * This can happen if someone (e.g. multipath) 1042 * queues a command to a device on an adapter 1043 * that does not support DIX. 1044 */ 1045 ret = BLK_STS_IOERR; 1046 goto out_free_sgtables; 1047 } 1048 1049 ivecs = blk_rq_count_integrity_sg(rq->q, rq->bio); 1050 1051 if (sg_alloc_table_chained(&prot_sdb->table, ivecs, 1052 prot_sdb->table.sgl, 1053 SCSI_INLINE_PROT_SG_CNT)) { 1054 ret = BLK_STS_RESOURCE; 1055 goto out_free_sgtables; 1056 } 1057 1058 count = blk_rq_map_integrity_sg(rq->q, rq->bio, 1059 prot_sdb->table.sgl); 1060 BUG_ON(count > ivecs); 1061 BUG_ON(count > queue_max_integrity_segments(rq->q)); 1062 1063 cmd->prot_sdb = prot_sdb; 1064 cmd->prot_sdb->table.nents = count; 1065 } 1066 1067 return BLK_STS_OK; 1068 out_free_sgtables: 1069 scsi_free_sgtables(cmd); 1070 return ret; 1071 } 1072 EXPORT_SYMBOL(scsi_alloc_sgtables); 1073 1074 /** 1075 * scsi_initialize_rq - initialize struct scsi_cmnd partially 1076 * @rq: Request associated with the SCSI command to be initialized. 1077 * 1078 * This function initializes the members of struct scsi_cmnd that must be 1079 * initialized before request processing starts and that won't be 1080 * reinitialized if a SCSI command is requeued. 1081 * 1082 * Called from inside blk_get_request() for pass-through requests and from 1083 * inside scsi_init_command() for filesystem requests. 1084 */ 1085 static void scsi_initialize_rq(struct request *rq) 1086 { 1087 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq); 1088 struct scsi_request *req = &cmd->req; 1089 1090 memset(req->__cmd, 0, sizeof(req->__cmd)); 1091 req->cmd = req->__cmd; 1092 req->cmd_len = BLK_MAX_CDB; 1093 req->sense_len = 0; 1094 1095 init_rcu_head(&cmd->rcu); 1096 cmd->jiffies_at_alloc = jiffies; 1097 cmd->retries = 0; 1098 } 1099 1100 /* 1101 * Only called when the request isn't completed by SCSI, and not freed by 1102 * SCSI 1103 */ 1104 static void scsi_cleanup_rq(struct request *rq) 1105 { 1106 if (rq->rq_flags & RQF_DONTPREP) { 1107 scsi_mq_uninit_cmd(blk_mq_rq_to_pdu(rq)); 1108 rq->rq_flags &= ~RQF_DONTPREP; 1109 } 1110 } 1111 1112 /* Called before a request is prepared. See also scsi_mq_prep_fn(). */ 1113 void scsi_init_command(struct scsi_device *dev, struct scsi_cmnd *cmd) 1114 { 1115 void *buf = cmd->sense_buffer; 1116 void *prot = cmd->prot_sdb; 1117 struct request *rq = scsi_cmd_to_rq(cmd); 1118 unsigned int flags = cmd->flags & SCMD_PRESERVED_FLAGS; 1119 unsigned long jiffies_at_alloc; 1120 int retries, to_clear; 1121 bool in_flight; 1122 int budget_token = cmd->budget_token; 1123 1124 if (!blk_rq_is_passthrough(rq) && !(flags & SCMD_INITIALIZED)) { 1125 flags |= SCMD_INITIALIZED; 1126 scsi_initialize_rq(rq); 1127 } 1128 1129 jiffies_at_alloc = cmd->jiffies_at_alloc; 1130 retries = cmd->retries; 1131 in_flight = test_bit(SCMD_STATE_INFLIGHT, &cmd->state); 1132 /* 1133 * Zero out the cmd, except for the embedded scsi_request. Only clear 1134 * the driver-private command data if the LLD does not supply a 1135 * function to initialize that data. 1136 */ 1137 to_clear = sizeof(*cmd) - sizeof(cmd->req); 1138 if (!dev->host->hostt->init_cmd_priv) 1139 to_clear += dev->host->hostt->cmd_size; 1140 memset((char *)cmd + sizeof(cmd->req), 0, to_clear); 1141 1142 cmd->device = dev; 1143 cmd->sense_buffer = buf; 1144 cmd->prot_sdb = prot; 1145 cmd->flags = flags; 1146 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler); 1147 cmd->jiffies_at_alloc = jiffies_at_alloc; 1148 cmd->retries = retries; 1149 if (in_flight) 1150 __set_bit(SCMD_STATE_INFLIGHT, &cmd->state); 1151 cmd->budget_token = budget_token; 1152 1153 } 1154 1155 static blk_status_t scsi_setup_scsi_cmnd(struct scsi_device *sdev, 1156 struct request *req) 1157 { 1158 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req); 1159 1160 /* 1161 * Passthrough requests may transfer data, in which case they must 1162 * a bio attached to them. Or they might contain a SCSI command 1163 * that does not transfer data, in which case they may optionally 1164 * submit a request without an attached bio. 1165 */ 1166 if (req->bio) { 1167 blk_status_t ret = scsi_alloc_sgtables(cmd); 1168 if (unlikely(ret != BLK_STS_OK)) 1169 return ret; 1170 } else { 1171 BUG_ON(blk_rq_bytes(req)); 1172 1173 memset(&cmd->sdb, 0, sizeof(cmd->sdb)); 1174 } 1175 1176 cmd->cmd_len = scsi_req(req)->cmd_len; 1177 if (cmd->cmd_len == 0) 1178 cmd->cmd_len = scsi_command_size(cmd->cmnd); 1179 cmd->cmnd = scsi_req(req)->cmd; 1180 cmd->transfersize = blk_rq_bytes(req); 1181 cmd->allowed = scsi_req(req)->retries; 1182 return BLK_STS_OK; 1183 } 1184 1185 static blk_status_t 1186 scsi_device_state_check(struct scsi_device *sdev, struct request *req) 1187 { 1188 switch (sdev->sdev_state) { 1189 case SDEV_CREATED: 1190 return BLK_STS_OK; 1191 case SDEV_OFFLINE: 1192 case SDEV_TRANSPORT_OFFLINE: 1193 /* 1194 * If the device is offline we refuse to process any 1195 * commands. The device must be brought online 1196 * before trying any recovery commands. 1197 */ 1198 if (!sdev->offline_already) { 1199 sdev->offline_already = true; 1200 sdev_printk(KERN_ERR, sdev, 1201 "rejecting I/O to offline device\n"); 1202 } 1203 return BLK_STS_IOERR; 1204 case SDEV_DEL: 1205 /* 1206 * If the device is fully deleted, we refuse to 1207 * process any commands as well. 1208 */ 1209 sdev_printk(KERN_ERR, sdev, 1210 "rejecting I/O to dead device\n"); 1211 return BLK_STS_IOERR; 1212 case SDEV_BLOCK: 1213 case SDEV_CREATED_BLOCK: 1214 return BLK_STS_RESOURCE; 1215 case SDEV_QUIESCE: 1216 /* 1217 * If the device is blocked we only accept power management 1218 * commands. 1219 */ 1220 if (req && WARN_ON_ONCE(!(req->rq_flags & RQF_PM))) 1221 return BLK_STS_RESOURCE; 1222 return BLK_STS_OK; 1223 default: 1224 /* 1225 * For any other not fully online state we only allow 1226 * power management commands. 1227 */ 1228 if (req && !(req->rq_flags & RQF_PM)) 1229 return BLK_STS_IOERR; 1230 return BLK_STS_OK; 1231 } 1232 } 1233 1234 /* 1235 * scsi_dev_queue_ready: if we can send requests to sdev, assign one token 1236 * and return the token else return -1. 1237 */ 1238 static inline int scsi_dev_queue_ready(struct request_queue *q, 1239 struct scsi_device *sdev) 1240 { 1241 int token; 1242 1243 token = sbitmap_get(&sdev->budget_map); 1244 if (atomic_read(&sdev->device_blocked)) { 1245 if (token < 0) 1246 goto out; 1247 1248 if (scsi_device_busy(sdev) > 1) 1249 goto out_dec; 1250 1251 /* 1252 * unblock after device_blocked iterates to zero 1253 */ 1254 if (atomic_dec_return(&sdev->device_blocked) > 0) 1255 goto out_dec; 1256 SCSI_LOG_MLQUEUE(3, sdev_printk(KERN_INFO, sdev, 1257 "unblocking device at zero depth\n")); 1258 } 1259 1260 return token; 1261 out_dec: 1262 if (token >= 0) 1263 sbitmap_put(&sdev->budget_map, token); 1264 out: 1265 return -1; 1266 } 1267 1268 /* 1269 * scsi_target_queue_ready: checks if there we can send commands to target 1270 * @sdev: scsi device on starget to check. 1271 */ 1272 static inline int scsi_target_queue_ready(struct Scsi_Host *shost, 1273 struct scsi_device *sdev) 1274 { 1275 struct scsi_target *starget = scsi_target(sdev); 1276 unsigned int busy; 1277 1278 if (starget->single_lun) { 1279 spin_lock_irq(shost->host_lock); 1280 if (starget->starget_sdev_user && 1281 starget->starget_sdev_user != sdev) { 1282 spin_unlock_irq(shost->host_lock); 1283 return 0; 1284 } 1285 starget->starget_sdev_user = sdev; 1286 spin_unlock_irq(shost->host_lock); 1287 } 1288 1289 if (starget->can_queue <= 0) 1290 return 1; 1291 1292 busy = atomic_inc_return(&starget->target_busy) - 1; 1293 if (atomic_read(&starget->target_blocked) > 0) { 1294 if (busy) 1295 goto starved; 1296 1297 /* 1298 * unblock after target_blocked iterates to zero 1299 */ 1300 if (atomic_dec_return(&starget->target_blocked) > 0) 1301 goto out_dec; 1302 1303 SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget, 1304 "unblocking target at zero depth\n")); 1305 } 1306 1307 if (busy >= starget->can_queue) 1308 goto starved; 1309 1310 return 1; 1311 1312 starved: 1313 spin_lock_irq(shost->host_lock); 1314 list_move_tail(&sdev->starved_entry, &shost->starved_list); 1315 spin_unlock_irq(shost->host_lock); 1316 out_dec: 1317 if (starget->can_queue > 0) 1318 atomic_dec(&starget->target_busy); 1319 return 0; 1320 } 1321 1322 /* 1323 * scsi_host_queue_ready: if we can send requests to shost, return 1 else 1324 * return 0. We must end up running the queue again whenever 0 is 1325 * returned, else IO can hang. 1326 */ 1327 static inline int scsi_host_queue_ready(struct request_queue *q, 1328 struct Scsi_Host *shost, 1329 struct scsi_device *sdev, 1330 struct scsi_cmnd *cmd) 1331 { 1332 if (scsi_host_in_recovery(shost)) 1333 return 0; 1334 1335 if (atomic_read(&shost->host_blocked) > 0) { 1336 if (scsi_host_busy(shost) > 0) 1337 goto starved; 1338 1339 /* 1340 * unblock after host_blocked iterates to zero 1341 */ 1342 if (atomic_dec_return(&shost->host_blocked) > 0) 1343 goto out_dec; 1344 1345 SCSI_LOG_MLQUEUE(3, 1346 shost_printk(KERN_INFO, shost, 1347 "unblocking host at zero depth\n")); 1348 } 1349 1350 if (shost->host_self_blocked) 1351 goto starved; 1352 1353 /* We're OK to process the command, so we can't be starved */ 1354 if (!list_empty(&sdev->starved_entry)) { 1355 spin_lock_irq(shost->host_lock); 1356 if (!list_empty(&sdev->starved_entry)) 1357 list_del_init(&sdev->starved_entry); 1358 spin_unlock_irq(shost->host_lock); 1359 } 1360 1361 __set_bit(SCMD_STATE_INFLIGHT, &cmd->state); 1362 1363 return 1; 1364 1365 starved: 1366 spin_lock_irq(shost->host_lock); 1367 if (list_empty(&sdev->starved_entry)) 1368 list_add_tail(&sdev->starved_entry, &shost->starved_list); 1369 spin_unlock_irq(shost->host_lock); 1370 out_dec: 1371 scsi_dec_host_busy(shost, cmd); 1372 return 0; 1373 } 1374 1375 /* 1376 * Busy state exporting function for request stacking drivers. 1377 * 1378 * For efficiency, no lock is taken to check the busy state of 1379 * shost/starget/sdev, since the returned value is not guaranteed and 1380 * may be changed after request stacking drivers call the function, 1381 * regardless of taking lock or not. 1382 * 1383 * When scsi can't dispatch I/Os anymore and needs to kill I/Os scsi 1384 * needs to return 'not busy'. Otherwise, request stacking drivers 1385 * may hold requests forever. 1386 */ 1387 static bool scsi_mq_lld_busy(struct request_queue *q) 1388 { 1389 struct scsi_device *sdev = q->queuedata; 1390 struct Scsi_Host *shost; 1391 1392 if (blk_queue_dying(q)) 1393 return false; 1394 1395 shost = sdev->host; 1396 1397 /* 1398 * Ignore host/starget busy state. 1399 * Since block layer does not have a concept of fairness across 1400 * multiple queues, congestion of host/starget needs to be handled 1401 * in SCSI layer. 1402 */ 1403 if (scsi_host_in_recovery(shost) || scsi_device_is_busy(sdev)) 1404 return true; 1405 1406 return false; 1407 } 1408 1409 /* 1410 * Block layer request completion callback. May be called from interrupt 1411 * context. 1412 */ 1413 static void scsi_complete(struct request *rq) 1414 { 1415 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq); 1416 enum scsi_disposition disposition; 1417 1418 INIT_LIST_HEAD(&cmd->eh_entry); 1419 1420 atomic_inc(&cmd->device->iodone_cnt); 1421 if (cmd->result) 1422 atomic_inc(&cmd->device->ioerr_cnt); 1423 1424 disposition = scsi_decide_disposition(cmd); 1425 if (disposition != SUCCESS && scsi_cmd_runtime_exceeced(cmd)) 1426 disposition = SUCCESS; 1427 1428 scsi_log_completion(cmd, disposition); 1429 1430 switch (disposition) { 1431 case SUCCESS: 1432 scsi_finish_command(cmd); 1433 break; 1434 case NEEDS_RETRY: 1435 scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY); 1436 break; 1437 case ADD_TO_MLQUEUE: 1438 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY); 1439 break; 1440 default: 1441 scsi_eh_scmd_add(cmd); 1442 break; 1443 } 1444 } 1445 1446 /** 1447 * scsi_dispatch_cmd - Dispatch a command to the low-level driver. 1448 * @cmd: command block we are dispatching. 1449 * 1450 * Return: nonzero return request was rejected and device's queue needs to be 1451 * plugged. 1452 */ 1453 static int scsi_dispatch_cmd(struct scsi_cmnd *cmd) 1454 { 1455 struct Scsi_Host *host = cmd->device->host; 1456 int rtn = 0; 1457 1458 atomic_inc(&cmd->device->iorequest_cnt); 1459 1460 /* check if the device is still usable */ 1461 if (unlikely(cmd->device->sdev_state == SDEV_DEL)) { 1462 /* in SDEV_DEL we error all commands. DID_NO_CONNECT 1463 * returns an immediate error upwards, and signals 1464 * that the device is no longer present */ 1465 cmd->result = DID_NO_CONNECT << 16; 1466 goto done; 1467 } 1468 1469 /* Check to see if the scsi lld made this device blocked. */ 1470 if (unlikely(scsi_device_blocked(cmd->device))) { 1471 /* 1472 * in blocked state, the command is just put back on 1473 * the device queue. The suspend state has already 1474 * blocked the queue so future requests should not 1475 * occur until the device transitions out of the 1476 * suspend state. 1477 */ 1478 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd, 1479 "queuecommand : device blocked\n")); 1480 return SCSI_MLQUEUE_DEVICE_BUSY; 1481 } 1482 1483 /* Store the LUN value in cmnd, if needed. */ 1484 if (cmd->device->lun_in_cdb) 1485 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) | 1486 (cmd->device->lun << 5 & 0xe0); 1487 1488 scsi_log_send(cmd); 1489 1490 /* 1491 * Before we queue this command, check if the command 1492 * length exceeds what the host adapter can handle. 1493 */ 1494 if (cmd->cmd_len > cmd->device->host->max_cmd_len) { 1495 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd, 1496 "queuecommand : command too long. " 1497 "cdb_size=%d host->max_cmd_len=%d\n", 1498 cmd->cmd_len, cmd->device->host->max_cmd_len)); 1499 cmd->result = (DID_ABORT << 16); 1500 goto done; 1501 } 1502 1503 if (unlikely(host->shost_state == SHOST_DEL)) { 1504 cmd->result = (DID_NO_CONNECT << 16); 1505 goto done; 1506 1507 } 1508 1509 trace_scsi_dispatch_cmd_start(cmd); 1510 rtn = host->hostt->queuecommand(host, cmd); 1511 if (rtn) { 1512 trace_scsi_dispatch_cmd_error(cmd, rtn); 1513 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY && 1514 rtn != SCSI_MLQUEUE_TARGET_BUSY) 1515 rtn = SCSI_MLQUEUE_HOST_BUSY; 1516 1517 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd, 1518 "queuecommand : request rejected\n")); 1519 } 1520 1521 return rtn; 1522 done: 1523 cmd->scsi_done(cmd); 1524 return 0; 1525 } 1526 1527 /* Size in bytes of the sg-list stored in the scsi-mq command-private data. */ 1528 static unsigned int scsi_mq_inline_sgl_size(struct Scsi_Host *shost) 1529 { 1530 return min_t(unsigned int, shost->sg_tablesize, SCSI_INLINE_SG_CNT) * 1531 sizeof(struct scatterlist); 1532 } 1533 1534 static blk_status_t scsi_prepare_cmd(struct request *req) 1535 { 1536 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req); 1537 struct scsi_device *sdev = req->q->queuedata; 1538 struct Scsi_Host *shost = sdev->host; 1539 struct scatterlist *sg; 1540 1541 scsi_init_command(sdev, cmd); 1542 1543 cmd->request = req; 1544 cmd->tag = req->tag; 1545 cmd->prot_op = SCSI_PROT_NORMAL; 1546 if (blk_rq_bytes(req)) 1547 cmd->sc_data_direction = rq_dma_dir(req); 1548 else 1549 cmd->sc_data_direction = DMA_NONE; 1550 1551 sg = (void *)cmd + sizeof(struct scsi_cmnd) + shost->hostt->cmd_size; 1552 cmd->sdb.table.sgl = sg; 1553 1554 if (scsi_host_get_prot(shost)) { 1555 memset(cmd->prot_sdb, 0, sizeof(struct scsi_data_buffer)); 1556 1557 cmd->prot_sdb->table.sgl = 1558 (struct scatterlist *)(cmd->prot_sdb + 1); 1559 } 1560 1561 /* 1562 * Special handling for passthrough commands, which don't go to the ULP 1563 * at all: 1564 */ 1565 if (blk_rq_is_passthrough(req)) 1566 return scsi_setup_scsi_cmnd(sdev, req); 1567 1568 if (sdev->handler && sdev->handler->prep_fn) { 1569 blk_status_t ret = sdev->handler->prep_fn(sdev, req); 1570 1571 if (ret != BLK_STS_OK) 1572 return ret; 1573 } 1574 1575 cmd->cmnd = scsi_req(req)->cmd = scsi_req(req)->__cmd; 1576 memset(cmd->cmnd, 0, BLK_MAX_CDB); 1577 return scsi_cmd_to_driver(cmd)->init_command(cmd); 1578 } 1579 1580 static void scsi_mq_done(struct scsi_cmnd *cmd) 1581 { 1582 if (unlikely(blk_should_fake_timeout(scsi_cmd_to_rq(cmd)->q))) 1583 return; 1584 if (unlikely(test_and_set_bit(SCMD_STATE_COMPLETE, &cmd->state))) 1585 return; 1586 trace_scsi_dispatch_cmd_done(cmd); 1587 blk_mq_complete_request(scsi_cmd_to_rq(cmd)); 1588 } 1589 1590 static void scsi_mq_put_budget(struct request_queue *q, int budget_token) 1591 { 1592 struct scsi_device *sdev = q->queuedata; 1593 1594 sbitmap_put(&sdev->budget_map, budget_token); 1595 } 1596 1597 static int scsi_mq_get_budget(struct request_queue *q) 1598 { 1599 struct scsi_device *sdev = q->queuedata; 1600 int token = scsi_dev_queue_ready(q, sdev); 1601 1602 if (token >= 0) 1603 return token; 1604 1605 atomic_inc(&sdev->restarts); 1606 1607 /* 1608 * Orders atomic_inc(&sdev->restarts) and atomic_read(&sdev->device_busy). 1609 * .restarts must be incremented before .device_busy is read because the 1610 * code in scsi_run_queue_async() depends on the order of these operations. 1611 */ 1612 smp_mb__after_atomic(); 1613 1614 /* 1615 * If all in-flight requests originated from this LUN are completed 1616 * before reading .device_busy, sdev->device_busy will be observed as 1617 * zero, then blk_mq_delay_run_hw_queues() will dispatch this request 1618 * soon. Otherwise, completion of one of these requests will observe 1619 * the .restarts flag, and the request queue will be run for handling 1620 * this request, see scsi_end_request(). 1621 */ 1622 if (unlikely(scsi_device_busy(sdev) == 0 && 1623 !scsi_device_blocked(sdev))) 1624 blk_mq_delay_run_hw_queues(sdev->request_queue, SCSI_QUEUE_DELAY); 1625 return -1; 1626 } 1627 1628 static void scsi_mq_set_rq_budget_token(struct request *req, int token) 1629 { 1630 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req); 1631 1632 cmd->budget_token = token; 1633 } 1634 1635 static int scsi_mq_get_rq_budget_token(struct request *req) 1636 { 1637 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req); 1638 1639 return cmd->budget_token; 1640 } 1641 1642 static blk_status_t scsi_queue_rq(struct blk_mq_hw_ctx *hctx, 1643 const struct blk_mq_queue_data *bd) 1644 { 1645 struct request *req = bd->rq; 1646 struct request_queue *q = req->q; 1647 struct scsi_device *sdev = q->queuedata; 1648 struct Scsi_Host *shost = sdev->host; 1649 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(req); 1650 blk_status_t ret; 1651 int reason; 1652 1653 WARN_ON_ONCE(cmd->budget_token < 0); 1654 1655 /* 1656 * If the device is not in running state we will reject some or all 1657 * commands. 1658 */ 1659 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) { 1660 ret = scsi_device_state_check(sdev, req); 1661 if (ret != BLK_STS_OK) 1662 goto out_put_budget; 1663 } 1664 1665 ret = BLK_STS_RESOURCE; 1666 if (!scsi_target_queue_ready(shost, sdev)) 1667 goto out_put_budget; 1668 if (!scsi_host_queue_ready(q, shost, sdev, cmd)) 1669 goto out_dec_target_busy; 1670 1671 if (!(req->rq_flags & RQF_DONTPREP)) { 1672 ret = scsi_prepare_cmd(req); 1673 if (ret != BLK_STS_OK) 1674 goto out_dec_host_busy; 1675 req->rq_flags |= RQF_DONTPREP; 1676 } else { 1677 clear_bit(SCMD_STATE_COMPLETE, &cmd->state); 1678 } 1679 1680 cmd->flags &= SCMD_PRESERVED_FLAGS; 1681 if (sdev->simple_tags) 1682 cmd->flags |= SCMD_TAGGED; 1683 if (bd->last) 1684 cmd->flags |= SCMD_LAST; 1685 1686 scsi_set_resid(cmd, 0); 1687 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE); 1688 cmd->scsi_done = scsi_mq_done; 1689 1690 blk_mq_start_request(req); 1691 reason = scsi_dispatch_cmd(cmd); 1692 if (reason) { 1693 scsi_set_blocked(cmd, reason); 1694 ret = BLK_STS_RESOURCE; 1695 goto out_dec_host_busy; 1696 } 1697 1698 return BLK_STS_OK; 1699 1700 out_dec_host_busy: 1701 scsi_dec_host_busy(shost, cmd); 1702 out_dec_target_busy: 1703 if (scsi_target(sdev)->can_queue > 0) 1704 atomic_dec(&scsi_target(sdev)->target_busy); 1705 out_put_budget: 1706 scsi_mq_put_budget(q, cmd->budget_token); 1707 cmd->budget_token = -1; 1708 switch (ret) { 1709 case BLK_STS_OK: 1710 break; 1711 case BLK_STS_RESOURCE: 1712 case BLK_STS_ZONE_RESOURCE: 1713 if (scsi_device_blocked(sdev)) 1714 ret = BLK_STS_DEV_RESOURCE; 1715 break; 1716 case BLK_STS_AGAIN: 1717 scsi_req(req)->result = DID_BUS_BUSY << 16; 1718 if (req->rq_flags & RQF_DONTPREP) 1719 scsi_mq_uninit_cmd(cmd); 1720 break; 1721 default: 1722 if (unlikely(!scsi_device_online(sdev))) 1723 scsi_req(req)->result = DID_NO_CONNECT << 16; 1724 else 1725 scsi_req(req)->result = DID_ERROR << 16; 1726 /* 1727 * Make sure to release all allocated resources when 1728 * we hit an error, as we will never see this command 1729 * again. 1730 */ 1731 if (req->rq_flags & RQF_DONTPREP) 1732 scsi_mq_uninit_cmd(cmd); 1733 scsi_run_queue_async(sdev); 1734 break; 1735 } 1736 return ret; 1737 } 1738 1739 static enum blk_eh_timer_return scsi_timeout(struct request *req, 1740 bool reserved) 1741 { 1742 if (reserved) 1743 return BLK_EH_RESET_TIMER; 1744 return scsi_times_out(req); 1745 } 1746 1747 static int scsi_mq_init_request(struct blk_mq_tag_set *set, struct request *rq, 1748 unsigned int hctx_idx, unsigned int numa_node) 1749 { 1750 struct Scsi_Host *shost = set->driver_data; 1751 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq); 1752 struct scatterlist *sg; 1753 int ret = 0; 1754 1755 cmd->sense_buffer = 1756 kmem_cache_alloc_node(scsi_sense_cache, GFP_KERNEL, numa_node); 1757 if (!cmd->sense_buffer) 1758 return -ENOMEM; 1759 cmd->req.sense = cmd->sense_buffer; 1760 1761 if (scsi_host_get_prot(shost)) { 1762 sg = (void *)cmd + sizeof(struct scsi_cmnd) + 1763 shost->hostt->cmd_size; 1764 cmd->prot_sdb = (void *)sg + scsi_mq_inline_sgl_size(shost); 1765 } 1766 1767 if (shost->hostt->init_cmd_priv) { 1768 ret = shost->hostt->init_cmd_priv(shost, cmd); 1769 if (ret < 0) 1770 kmem_cache_free(scsi_sense_cache, cmd->sense_buffer); 1771 } 1772 1773 return ret; 1774 } 1775 1776 static void scsi_mq_exit_request(struct blk_mq_tag_set *set, struct request *rq, 1777 unsigned int hctx_idx) 1778 { 1779 struct Scsi_Host *shost = set->driver_data; 1780 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq); 1781 1782 if (shost->hostt->exit_cmd_priv) 1783 shost->hostt->exit_cmd_priv(shost, cmd); 1784 kmem_cache_free(scsi_sense_cache, cmd->sense_buffer); 1785 } 1786 1787 1788 static int scsi_mq_poll(struct blk_mq_hw_ctx *hctx) 1789 { 1790 struct Scsi_Host *shost = hctx->driver_data; 1791 1792 if (shost->hostt->mq_poll) 1793 return shost->hostt->mq_poll(shost, hctx->queue_num); 1794 1795 return 0; 1796 } 1797 1798 static int scsi_init_hctx(struct blk_mq_hw_ctx *hctx, void *data, 1799 unsigned int hctx_idx) 1800 { 1801 struct Scsi_Host *shost = data; 1802 1803 hctx->driver_data = shost; 1804 return 0; 1805 } 1806 1807 static int scsi_map_queues(struct blk_mq_tag_set *set) 1808 { 1809 struct Scsi_Host *shost = container_of(set, struct Scsi_Host, tag_set); 1810 1811 if (shost->hostt->map_queues) 1812 return shost->hostt->map_queues(shost); 1813 return blk_mq_map_queues(&set->map[HCTX_TYPE_DEFAULT]); 1814 } 1815 1816 void __scsi_init_queue(struct Scsi_Host *shost, struct request_queue *q) 1817 { 1818 struct device *dev = shost->dma_dev; 1819 1820 /* 1821 * this limit is imposed by hardware restrictions 1822 */ 1823 blk_queue_max_segments(q, min_t(unsigned short, shost->sg_tablesize, 1824 SG_MAX_SEGMENTS)); 1825 1826 if (scsi_host_prot_dma(shost)) { 1827 shost->sg_prot_tablesize = 1828 min_not_zero(shost->sg_prot_tablesize, 1829 (unsigned short)SCSI_MAX_PROT_SG_SEGMENTS); 1830 BUG_ON(shost->sg_prot_tablesize < shost->sg_tablesize); 1831 blk_queue_max_integrity_segments(q, shost->sg_prot_tablesize); 1832 } 1833 1834 if (dev->dma_mask) { 1835 shost->max_sectors = min_t(unsigned int, shost->max_sectors, 1836 dma_max_mapping_size(dev) >> SECTOR_SHIFT); 1837 } 1838 blk_queue_max_hw_sectors(q, shost->max_sectors); 1839 blk_queue_segment_boundary(q, shost->dma_boundary); 1840 dma_set_seg_boundary(dev, shost->dma_boundary); 1841 1842 blk_queue_max_segment_size(q, shost->max_segment_size); 1843 blk_queue_virt_boundary(q, shost->virt_boundary_mask); 1844 dma_set_max_seg_size(dev, queue_max_segment_size(q)); 1845 1846 /* 1847 * Set a reasonable default alignment: The larger of 32-byte (dword), 1848 * which is a common minimum for HBAs, and the minimum DMA alignment, 1849 * which is set by the platform. 1850 * 1851 * Devices that require a bigger alignment can increase it later. 1852 */ 1853 blk_queue_dma_alignment(q, max(4, dma_get_cache_alignment()) - 1); 1854 } 1855 EXPORT_SYMBOL_GPL(__scsi_init_queue); 1856 1857 static const struct blk_mq_ops scsi_mq_ops_no_commit = { 1858 .get_budget = scsi_mq_get_budget, 1859 .put_budget = scsi_mq_put_budget, 1860 .queue_rq = scsi_queue_rq, 1861 .complete = scsi_complete, 1862 .timeout = scsi_timeout, 1863 #ifdef CONFIG_BLK_DEBUG_FS 1864 .show_rq = scsi_show_rq, 1865 #endif 1866 .init_request = scsi_mq_init_request, 1867 .exit_request = scsi_mq_exit_request, 1868 .initialize_rq_fn = scsi_initialize_rq, 1869 .cleanup_rq = scsi_cleanup_rq, 1870 .busy = scsi_mq_lld_busy, 1871 .map_queues = scsi_map_queues, 1872 .init_hctx = scsi_init_hctx, 1873 .poll = scsi_mq_poll, 1874 .set_rq_budget_token = scsi_mq_set_rq_budget_token, 1875 .get_rq_budget_token = scsi_mq_get_rq_budget_token, 1876 }; 1877 1878 1879 static void scsi_commit_rqs(struct blk_mq_hw_ctx *hctx) 1880 { 1881 struct Scsi_Host *shost = hctx->driver_data; 1882 1883 shost->hostt->commit_rqs(shost, hctx->queue_num); 1884 } 1885 1886 static const struct blk_mq_ops scsi_mq_ops = { 1887 .get_budget = scsi_mq_get_budget, 1888 .put_budget = scsi_mq_put_budget, 1889 .queue_rq = scsi_queue_rq, 1890 .commit_rqs = scsi_commit_rqs, 1891 .complete = scsi_complete, 1892 .timeout = scsi_timeout, 1893 #ifdef CONFIG_BLK_DEBUG_FS 1894 .show_rq = scsi_show_rq, 1895 #endif 1896 .init_request = scsi_mq_init_request, 1897 .exit_request = scsi_mq_exit_request, 1898 .initialize_rq_fn = scsi_initialize_rq, 1899 .cleanup_rq = scsi_cleanup_rq, 1900 .busy = scsi_mq_lld_busy, 1901 .map_queues = scsi_map_queues, 1902 .init_hctx = scsi_init_hctx, 1903 .poll = scsi_mq_poll, 1904 .set_rq_budget_token = scsi_mq_set_rq_budget_token, 1905 .get_rq_budget_token = scsi_mq_get_rq_budget_token, 1906 }; 1907 1908 int scsi_mq_setup_tags(struct Scsi_Host *shost) 1909 { 1910 unsigned int cmd_size, sgl_size; 1911 struct blk_mq_tag_set *tag_set = &shost->tag_set; 1912 1913 sgl_size = max_t(unsigned int, sizeof(struct scatterlist), 1914 scsi_mq_inline_sgl_size(shost)); 1915 cmd_size = sizeof(struct scsi_cmnd) + shost->hostt->cmd_size + sgl_size; 1916 if (scsi_host_get_prot(shost)) 1917 cmd_size += sizeof(struct scsi_data_buffer) + 1918 sizeof(struct scatterlist) * SCSI_INLINE_PROT_SG_CNT; 1919 1920 memset(tag_set, 0, sizeof(*tag_set)); 1921 if (shost->hostt->commit_rqs) 1922 tag_set->ops = &scsi_mq_ops; 1923 else 1924 tag_set->ops = &scsi_mq_ops_no_commit; 1925 tag_set->nr_hw_queues = shost->nr_hw_queues ? : 1; 1926 tag_set->nr_maps = shost->nr_maps ? : 1; 1927 tag_set->queue_depth = shost->can_queue; 1928 tag_set->cmd_size = cmd_size; 1929 tag_set->numa_node = NUMA_NO_NODE; 1930 tag_set->flags = BLK_MQ_F_SHOULD_MERGE; 1931 tag_set->flags |= 1932 BLK_ALLOC_POLICY_TO_MQ_FLAG(shost->hostt->tag_alloc_policy); 1933 tag_set->driver_data = shost; 1934 if (shost->host_tagset) 1935 tag_set->flags |= BLK_MQ_F_TAG_HCTX_SHARED; 1936 1937 return blk_mq_alloc_tag_set(tag_set); 1938 } 1939 1940 void scsi_mq_destroy_tags(struct Scsi_Host *shost) 1941 { 1942 blk_mq_free_tag_set(&shost->tag_set); 1943 } 1944 1945 /** 1946 * scsi_device_from_queue - return sdev associated with a request_queue 1947 * @q: The request queue to return the sdev from 1948 * 1949 * Return the sdev associated with a request queue or NULL if the 1950 * request_queue does not reference a SCSI device. 1951 */ 1952 struct scsi_device *scsi_device_from_queue(struct request_queue *q) 1953 { 1954 struct scsi_device *sdev = NULL; 1955 1956 if (q->mq_ops == &scsi_mq_ops_no_commit || 1957 q->mq_ops == &scsi_mq_ops) 1958 sdev = q->queuedata; 1959 if (!sdev || !get_device(&sdev->sdev_gendev)) 1960 sdev = NULL; 1961 1962 return sdev; 1963 } 1964 1965 /** 1966 * scsi_block_requests - Utility function used by low-level drivers to prevent 1967 * further commands from being queued to the device. 1968 * @shost: host in question 1969 * 1970 * There is no timer nor any other means by which the requests get unblocked 1971 * other than the low-level driver calling scsi_unblock_requests(). 1972 */ 1973 void scsi_block_requests(struct Scsi_Host *shost) 1974 { 1975 shost->host_self_blocked = 1; 1976 } 1977 EXPORT_SYMBOL(scsi_block_requests); 1978 1979 /** 1980 * scsi_unblock_requests - Utility function used by low-level drivers to allow 1981 * further commands to be queued to the device. 1982 * @shost: host in question 1983 * 1984 * There is no timer nor any other means by which the requests get unblocked 1985 * other than the low-level driver calling scsi_unblock_requests(). This is done 1986 * as an API function so that changes to the internals of the scsi mid-layer 1987 * won't require wholesale changes to drivers that use this feature. 1988 */ 1989 void scsi_unblock_requests(struct Scsi_Host *shost) 1990 { 1991 shost->host_self_blocked = 0; 1992 scsi_run_host_queues(shost); 1993 } 1994 EXPORT_SYMBOL(scsi_unblock_requests); 1995 1996 void scsi_exit_queue(void) 1997 { 1998 kmem_cache_destroy(scsi_sense_cache); 1999 } 2000 2001 /** 2002 * scsi_mode_select - issue a mode select 2003 * @sdev: SCSI device to be queried 2004 * @pf: Page format bit (1 == standard, 0 == vendor specific) 2005 * @sp: Save page bit (0 == don't save, 1 == save) 2006 * @modepage: mode page being requested 2007 * @buffer: request buffer (may not be smaller than eight bytes) 2008 * @len: length of request buffer. 2009 * @timeout: command timeout 2010 * @retries: number of retries before failing 2011 * @data: returns a structure abstracting the mode header data 2012 * @sshdr: place to put sense data (or NULL if no sense to be collected). 2013 * must be SCSI_SENSE_BUFFERSIZE big. 2014 * 2015 * Returns zero if successful; negative error number or scsi 2016 * status on error 2017 * 2018 */ 2019 int 2020 scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage, 2021 unsigned char *buffer, int len, int timeout, int retries, 2022 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr) 2023 { 2024 unsigned char cmd[10]; 2025 unsigned char *real_buffer; 2026 int ret; 2027 2028 memset(cmd, 0, sizeof(cmd)); 2029 cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0); 2030 2031 if (sdev->use_10_for_ms) { 2032 if (len > 65535) 2033 return -EINVAL; 2034 real_buffer = kmalloc(8 + len, GFP_KERNEL); 2035 if (!real_buffer) 2036 return -ENOMEM; 2037 memcpy(real_buffer + 8, buffer, len); 2038 len += 8; 2039 real_buffer[0] = 0; 2040 real_buffer[1] = 0; 2041 real_buffer[2] = data->medium_type; 2042 real_buffer[3] = data->device_specific; 2043 real_buffer[4] = data->longlba ? 0x01 : 0; 2044 real_buffer[5] = 0; 2045 real_buffer[6] = data->block_descriptor_length >> 8; 2046 real_buffer[7] = data->block_descriptor_length; 2047 2048 cmd[0] = MODE_SELECT_10; 2049 cmd[7] = len >> 8; 2050 cmd[8] = len; 2051 } else { 2052 if (len > 255 || data->block_descriptor_length > 255 || 2053 data->longlba) 2054 return -EINVAL; 2055 2056 real_buffer = kmalloc(4 + len, GFP_KERNEL); 2057 if (!real_buffer) 2058 return -ENOMEM; 2059 memcpy(real_buffer + 4, buffer, len); 2060 len += 4; 2061 real_buffer[0] = 0; 2062 real_buffer[1] = data->medium_type; 2063 real_buffer[2] = data->device_specific; 2064 real_buffer[3] = data->block_descriptor_length; 2065 2066 cmd[0] = MODE_SELECT; 2067 cmd[4] = len; 2068 } 2069 2070 ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len, 2071 sshdr, timeout, retries, NULL); 2072 kfree(real_buffer); 2073 return ret; 2074 } 2075 EXPORT_SYMBOL_GPL(scsi_mode_select); 2076 2077 /** 2078 * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary. 2079 * @sdev: SCSI device to be queried 2080 * @dbd: set if mode sense will allow block descriptors to be returned 2081 * @modepage: mode page being requested 2082 * @buffer: request buffer (may not be smaller than eight bytes) 2083 * @len: length of request buffer. 2084 * @timeout: command timeout 2085 * @retries: number of retries before failing 2086 * @data: returns a structure abstracting the mode header data 2087 * @sshdr: place to put sense data (or NULL if no sense to be collected). 2088 * must be SCSI_SENSE_BUFFERSIZE big. 2089 * 2090 * Returns zero if successful, or a negative error number on failure 2091 */ 2092 int 2093 scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage, 2094 unsigned char *buffer, int len, int timeout, int retries, 2095 struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr) 2096 { 2097 unsigned char cmd[12]; 2098 int use_10_for_ms; 2099 int header_length; 2100 int result, retry_count = retries; 2101 struct scsi_sense_hdr my_sshdr; 2102 2103 memset(data, 0, sizeof(*data)); 2104 memset(&cmd[0], 0, 12); 2105 2106 dbd = sdev->set_dbd_for_ms ? 8 : dbd; 2107 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */ 2108 cmd[2] = modepage; 2109 2110 /* caller might not be interested in sense, but we need it */ 2111 if (!sshdr) 2112 sshdr = &my_sshdr; 2113 2114 retry: 2115 use_10_for_ms = sdev->use_10_for_ms; 2116 2117 if (use_10_for_ms) { 2118 if (len < 8) 2119 len = 8; 2120 2121 cmd[0] = MODE_SENSE_10; 2122 cmd[8] = len; 2123 header_length = 8; 2124 } else { 2125 if (len < 4) 2126 len = 4; 2127 2128 cmd[0] = MODE_SENSE; 2129 cmd[4] = len; 2130 header_length = 4; 2131 } 2132 2133 memset(buffer, 0, len); 2134 2135 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len, 2136 sshdr, timeout, retries, NULL); 2137 if (result < 0) 2138 return result; 2139 2140 /* This code looks awful: what it's doing is making sure an 2141 * ILLEGAL REQUEST sense return identifies the actual command 2142 * byte as the problem. MODE_SENSE commands can return 2143 * ILLEGAL REQUEST if the code page isn't supported */ 2144 2145 if (!scsi_status_is_good(result)) { 2146 if (scsi_sense_valid(sshdr)) { 2147 if ((sshdr->sense_key == ILLEGAL_REQUEST) && 2148 (sshdr->asc == 0x20) && (sshdr->ascq == 0)) { 2149 /* 2150 * Invalid command operation code 2151 */ 2152 if (use_10_for_ms) { 2153 sdev->use_10_for_ms = 0; 2154 goto retry; 2155 } 2156 } 2157 if (scsi_status_is_check_condition(result) && 2158 sshdr->sense_key == UNIT_ATTENTION && 2159 retry_count) { 2160 retry_count--; 2161 goto retry; 2162 } 2163 } 2164 return -EIO; 2165 } 2166 if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b && 2167 (modepage == 6 || modepage == 8))) { 2168 /* Initio breakage? */ 2169 header_length = 0; 2170 data->length = 13; 2171 data->medium_type = 0; 2172 data->device_specific = 0; 2173 data->longlba = 0; 2174 data->block_descriptor_length = 0; 2175 } else if (use_10_for_ms) { 2176 data->length = buffer[0]*256 + buffer[1] + 2; 2177 data->medium_type = buffer[2]; 2178 data->device_specific = buffer[3]; 2179 data->longlba = buffer[4] & 0x01; 2180 data->block_descriptor_length = buffer[6]*256 2181 + buffer[7]; 2182 } else { 2183 data->length = buffer[0] + 1; 2184 data->medium_type = buffer[1]; 2185 data->device_specific = buffer[2]; 2186 data->block_descriptor_length = buffer[3]; 2187 } 2188 data->header_length = header_length; 2189 2190 return 0; 2191 } 2192 EXPORT_SYMBOL(scsi_mode_sense); 2193 2194 /** 2195 * scsi_test_unit_ready - test if unit is ready 2196 * @sdev: scsi device to change the state of. 2197 * @timeout: command timeout 2198 * @retries: number of retries before failing 2199 * @sshdr: outpout pointer for decoded sense information. 2200 * 2201 * Returns zero if unsuccessful or an error if TUR failed. For 2202 * removable media, UNIT_ATTENTION sets ->changed flag. 2203 **/ 2204 int 2205 scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries, 2206 struct scsi_sense_hdr *sshdr) 2207 { 2208 char cmd[] = { 2209 TEST_UNIT_READY, 0, 0, 0, 0, 0, 2210 }; 2211 int result; 2212 2213 /* try to eat the UNIT_ATTENTION if there are enough retries */ 2214 do { 2215 result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr, 2216 timeout, 1, NULL); 2217 if (sdev->removable && scsi_sense_valid(sshdr) && 2218 sshdr->sense_key == UNIT_ATTENTION) 2219 sdev->changed = 1; 2220 } while (scsi_sense_valid(sshdr) && 2221 sshdr->sense_key == UNIT_ATTENTION && --retries); 2222 2223 return result; 2224 } 2225 EXPORT_SYMBOL(scsi_test_unit_ready); 2226 2227 /** 2228 * scsi_device_set_state - Take the given device through the device state model. 2229 * @sdev: scsi device to change the state of. 2230 * @state: state to change to. 2231 * 2232 * Returns zero if successful or an error if the requested 2233 * transition is illegal. 2234 */ 2235 int 2236 scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state) 2237 { 2238 enum scsi_device_state oldstate = sdev->sdev_state; 2239 2240 if (state == oldstate) 2241 return 0; 2242 2243 switch (state) { 2244 case SDEV_CREATED: 2245 switch (oldstate) { 2246 case SDEV_CREATED_BLOCK: 2247 break; 2248 default: 2249 goto illegal; 2250 } 2251 break; 2252 2253 case SDEV_RUNNING: 2254 switch (oldstate) { 2255 case SDEV_CREATED: 2256 case SDEV_OFFLINE: 2257 case SDEV_TRANSPORT_OFFLINE: 2258 case SDEV_QUIESCE: 2259 case SDEV_BLOCK: 2260 break; 2261 default: 2262 goto illegal; 2263 } 2264 break; 2265 2266 case SDEV_QUIESCE: 2267 switch (oldstate) { 2268 case SDEV_RUNNING: 2269 case SDEV_OFFLINE: 2270 case SDEV_TRANSPORT_OFFLINE: 2271 break; 2272 default: 2273 goto illegal; 2274 } 2275 break; 2276 2277 case SDEV_OFFLINE: 2278 case SDEV_TRANSPORT_OFFLINE: 2279 switch (oldstate) { 2280 case SDEV_CREATED: 2281 case SDEV_RUNNING: 2282 case SDEV_QUIESCE: 2283 case SDEV_BLOCK: 2284 break; 2285 default: 2286 goto illegal; 2287 } 2288 break; 2289 2290 case SDEV_BLOCK: 2291 switch (oldstate) { 2292 case SDEV_RUNNING: 2293 case SDEV_CREATED_BLOCK: 2294 case SDEV_QUIESCE: 2295 case SDEV_OFFLINE: 2296 break; 2297 default: 2298 goto illegal; 2299 } 2300 break; 2301 2302 case SDEV_CREATED_BLOCK: 2303 switch (oldstate) { 2304 case SDEV_CREATED: 2305 break; 2306 default: 2307 goto illegal; 2308 } 2309 break; 2310 2311 case SDEV_CANCEL: 2312 switch (oldstate) { 2313 case SDEV_CREATED: 2314 case SDEV_RUNNING: 2315 case SDEV_QUIESCE: 2316 case SDEV_OFFLINE: 2317 case SDEV_TRANSPORT_OFFLINE: 2318 break; 2319 default: 2320 goto illegal; 2321 } 2322 break; 2323 2324 case SDEV_DEL: 2325 switch (oldstate) { 2326 case SDEV_CREATED: 2327 case SDEV_RUNNING: 2328 case SDEV_OFFLINE: 2329 case SDEV_TRANSPORT_OFFLINE: 2330 case SDEV_CANCEL: 2331 case SDEV_BLOCK: 2332 case SDEV_CREATED_BLOCK: 2333 break; 2334 default: 2335 goto illegal; 2336 } 2337 break; 2338 2339 } 2340 sdev->offline_already = false; 2341 sdev->sdev_state = state; 2342 return 0; 2343 2344 illegal: 2345 SCSI_LOG_ERROR_RECOVERY(1, 2346 sdev_printk(KERN_ERR, sdev, 2347 "Illegal state transition %s->%s", 2348 scsi_device_state_name(oldstate), 2349 scsi_device_state_name(state)) 2350 ); 2351 return -EINVAL; 2352 } 2353 EXPORT_SYMBOL(scsi_device_set_state); 2354 2355 /** 2356 * scsi_evt_emit - emit a single SCSI device uevent 2357 * @sdev: associated SCSI device 2358 * @evt: event to emit 2359 * 2360 * Send a single uevent (scsi_event) to the associated scsi_device. 2361 */ 2362 static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt) 2363 { 2364 int idx = 0; 2365 char *envp[3]; 2366 2367 switch (evt->evt_type) { 2368 case SDEV_EVT_MEDIA_CHANGE: 2369 envp[idx++] = "SDEV_MEDIA_CHANGE=1"; 2370 break; 2371 case SDEV_EVT_INQUIRY_CHANGE_REPORTED: 2372 scsi_rescan_device(&sdev->sdev_gendev); 2373 envp[idx++] = "SDEV_UA=INQUIRY_DATA_HAS_CHANGED"; 2374 break; 2375 case SDEV_EVT_CAPACITY_CHANGE_REPORTED: 2376 envp[idx++] = "SDEV_UA=CAPACITY_DATA_HAS_CHANGED"; 2377 break; 2378 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED: 2379 envp[idx++] = "SDEV_UA=THIN_PROVISIONING_SOFT_THRESHOLD_REACHED"; 2380 break; 2381 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED: 2382 envp[idx++] = "SDEV_UA=MODE_PARAMETERS_CHANGED"; 2383 break; 2384 case SDEV_EVT_LUN_CHANGE_REPORTED: 2385 envp[idx++] = "SDEV_UA=REPORTED_LUNS_DATA_HAS_CHANGED"; 2386 break; 2387 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED: 2388 envp[idx++] = "SDEV_UA=ASYMMETRIC_ACCESS_STATE_CHANGED"; 2389 break; 2390 case SDEV_EVT_POWER_ON_RESET_OCCURRED: 2391 envp[idx++] = "SDEV_UA=POWER_ON_RESET_OCCURRED"; 2392 break; 2393 default: 2394 /* do nothing */ 2395 break; 2396 } 2397 2398 envp[idx++] = NULL; 2399 2400 kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp); 2401 } 2402 2403 /** 2404 * scsi_evt_thread - send a uevent for each scsi event 2405 * @work: work struct for scsi_device 2406 * 2407 * Dispatch queued events to their associated scsi_device kobjects 2408 * as uevents. 2409 */ 2410 void scsi_evt_thread(struct work_struct *work) 2411 { 2412 struct scsi_device *sdev; 2413 enum scsi_device_event evt_type; 2414 LIST_HEAD(event_list); 2415 2416 sdev = container_of(work, struct scsi_device, event_work); 2417 2418 for (evt_type = SDEV_EVT_FIRST; evt_type <= SDEV_EVT_LAST; evt_type++) 2419 if (test_and_clear_bit(evt_type, sdev->pending_events)) 2420 sdev_evt_send_simple(sdev, evt_type, GFP_KERNEL); 2421 2422 while (1) { 2423 struct scsi_event *evt; 2424 struct list_head *this, *tmp; 2425 unsigned long flags; 2426 2427 spin_lock_irqsave(&sdev->list_lock, flags); 2428 list_splice_init(&sdev->event_list, &event_list); 2429 spin_unlock_irqrestore(&sdev->list_lock, flags); 2430 2431 if (list_empty(&event_list)) 2432 break; 2433 2434 list_for_each_safe(this, tmp, &event_list) { 2435 evt = list_entry(this, struct scsi_event, node); 2436 list_del(&evt->node); 2437 scsi_evt_emit(sdev, evt); 2438 kfree(evt); 2439 } 2440 } 2441 } 2442 2443 /** 2444 * sdev_evt_send - send asserted event to uevent thread 2445 * @sdev: scsi_device event occurred on 2446 * @evt: event to send 2447 * 2448 * Assert scsi device event asynchronously. 2449 */ 2450 void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt) 2451 { 2452 unsigned long flags; 2453 2454 #if 0 2455 /* FIXME: currently this check eliminates all media change events 2456 * for polled devices. Need to update to discriminate between AN 2457 * and polled events */ 2458 if (!test_bit(evt->evt_type, sdev->supported_events)) { 2459 kfree(evt); 2460 return; 2461 } 2462 #endif 2463 2464 spin_lock_irqsave(&sdev->list_lock, flags); 2465 list_add_tail(&evt->node, &sdev->event_list); 2466 schedule_work(&sdev->event_work); 2467 spin_unlock_irqrestore(&sdev->list_lock, flags); 2468 } 2469 EXPORT_SYMBOL_GPL(sdev_evt_send); 2470 2471 /** 2472 * sdev_evt_alloc - allocate a new scsi event 2473 * @evt_type: type of event to allocate 2474 * @gfpflags: GFP flags for allocation 2475 * 2476 * Allocates and returns a new scsi_event. 2477 */ 2478 struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type, 2479 gfp_t gfpflags) 2480 { 2481 struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags); 2482 if (!evt) 2483 return NULL; 2484 2485 evt->evt_type = evt_type; 2486 INIT_LIST_HEAD(&evt->node); 2487 2488 /* evt_type-specific initialization, if any */ 2489 switch (evt_type) { 2490 case SDEV_EVT_MEDIA_CHANGE: 2491 case SDEV_EVT_INQUIRY_CHANGE_REPORTED: 2492 case SDEV_EVT_CAPACITY_CHANGE_REPORTED: 2493 case SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED: 2494 case SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED: 2495 case SDEV_EVT_LUN_CHANGE_REPORTED: 2496 case SDEV_EVT_ALUA_STATE_CHANGE_REPORTED: 2497 case SDEV_EVT_POWER_ON_RESET_OCCURRED: 2498 default: 2499 /* do nothing */ 2500 break; 2501 } 2502 2503 return evt; 2504 } 2505 EXPORT_SYMBOL_GPL(sdev_evt_alloc); 2506 2507 /** 2508 * sdev_evt_send_simple - send asserted event to uevent thread 2509 * @sdev: scsi_device event occurred on 2510 * @evt_type: type of event to send 2511 * @gfpflags: GFP flags for allocation 2512 * 2513 * Assert scsi device event asynchronously, given an event type. 2514 */ 2515 void sdev_evt_send_simple(struct scsi_device *sdev, 2516 enum scsi_device_event evt_type, gfp_t gfpflags) 2517 { 2518 struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags); 2519 if (!evt) { 2520 sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n", 2521 evt_type); 2522 return; 2523 } 2524 2525 sdev_evt_send(sdev, evt); 2526 } 2527 EXPORT_SYMBOL_GPL(sdev_evt_send_simple); 2528 2529 /** 2530 * scsi_device_quiesce - Block all commands except power management. 2531 * @sdev: scsi device to quiesce. 2532 * 2533 * This works by trying to transition to the SDEV_QUIESCE state 2534 * (which must be a legal transition). When the device is in this 2535 * state, only power management requests will be accepted, all others will 2536 * be deferred. 2537 * 2538 * Must be called with user context, may sleep. 2539 * 2540 * Returns zero if unsuccessful or an error if not. 2541 */ 2542 int 2543 scsi_device_quiesce(struct scsi_device *sdev) 2544 { 2545 struct request_queue *q = sdev->request_queue; 2546 int err; 2547 2548 /* 2549 * It is allowed to call scsi_device_quiesce() multiple times from 2550 * the same context but concurrent scsi_device_quiesce() calls are 2551 * not allowed. 2552 */ 2553 WARN_ON_ONCE(sdev->quiesced_by && sdev->quiesced_by != current); 2554 2555 if (sdev->quiesced_by == current) 2556 return 0; 2557 2558 blk_set_pm_only(q); 2559 2560 blk_mq_freeze_queue(q); 2561 /* 2562 * Ensure that the effect of blk_set_pm_only() will be visible 2563 * for percpu_ref_tryget() callers that occur after the queue 2564 * unfreeze even if the queue was already frozen before this function 2565 * was called. See also https://lwn.net/Articles/573497/. 2566 */ 2567 synchronize_rcu(); 2568 blk_mq_unfreeze_queue(q); 2569 2570 mutex_lock(&sdev->state_mutex); 2571 err = scsi_device_set_state(sdev, SDEV_QUIESCE); 2572 if (err == 0) 2573 sdev->quiesced_by = current; 2574 else 2575 blk_clear_pm_only(q); 2576 mutex_unlock(&sdev->state_mutex); 2577 2578 return err; 2579 } 2580 EXPORT_SYMBOL(scsi_device_quiesce); 2581 2582 /** 2583 * scsi_device_resume - Restart user issued commands to a quiesced device. 2584 * @sdev: scsi device to resume. 2585 * 2586 * Moves the device from quiesced back to running and restarts the 2587 * queues. 2588 * 2589 * Must be called with user context, may sleep. 2590 */ 2591 void scsi_device_resume(struct scsi_device *sdev) 2592 { 2593 /* check if the device state was mutated prior to resume, and if 2594 * so assume the state is being managed elsewhere (for example 2595 * device deleted during suspend) 2596 */ 2597 mutex_lock(&sdev->state_mutex); 2598 if (sdev->sdev_state == SDEV_QUIESCE) 2599 scsi_device_set_state(sdev, SDEV_RUNNING); 2600 if (sdev->quiesced_by) { 2601 sdev->quiesced_by = NULL; 2602 blk_clear_pm_only(sdev->request_queue); 2603 } 2604 mutex_unlock(&sdev->state_mutex); 2605 } 2606 EXPORT_SYMBOL(scsi_device_resume); 2607 2608 static void 2609 device_quiesce_fn(struct scsi_device *sdev, void *data) 2610 { 2611 scsi_device_quiesce(sdev); 2612 } 2613 2614 void 2615 scsi_target_quiesce(struct scsi_target *starget) 2616 { 2617 starget_for_each_device(starget, NULL, device_quiesce_fn); 2618 } 2619 EXPORT_SYMBOL(scsi_target_quiesce); 2620 2621 static void 2622 device_resume_fn(struct scsi_device *sdev, void *data) 2623 { 2624 scsi_device_resume(sdev); 2625 } 2626 2627 void 2628 scsi_target_resume(struct scsi_target *starget) 2629 { 2630 starget_for_each_device(starget, NULL, device_resume_fn); 2631 } 2632 EXPORT_SYMBOL(scsi_target_resume); 2633 2634 /** 2635 * scsi_internal_device_block_nowait - try to transition to the SDEV_BLOCK state 2636 * @sdev: device to block 2637 * 2638 * Pause SCSI command processing on the specified device. Does not sleep. 2639 * 2640 * Returns zero if successful or a negative error code upon failure. 2641 * 2642 * Notes: 2643 * This routine transitions the device to the SDEV_BLOCK state (which must be 2644 * a legal transition). When the device is in this state, command processing 2645 * is paused until the device leaves the SDEV_BLOCK state. See also 2646 * scsi_internal_device_unblock_nowait(). 2647 */ 2648 int scsi_internal_device_block_nowait(struct scsi_device *sdev) 2649 { 2650 struct request_queue *q = sdev->request_queue; 2651 int err = 0; 2652 2653 err = scsi_device_set_state(sdev, SDEV_BLOCK); 2654 if (err) { 2655 err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK); 2656 2657 if (err) 2658 return err; 2659 } 2660 2661 /* 2662 * The device has transitioned to SDEV_BLOCK. Stop the 2663 * block layer from calling the midlayer with this device's 2664 * request queue. 2665 */ 2666 blk_mq_quiesce_queue_nowait(q); 2667 return 0; 2668 } 2669 EXPORT_SYMBOL_GPL(scsi_internal_device_block_nowait); 2670 2671 /** 2672 * scsi_internal_device_block - try to transition to the SDEV_BLOCK state 2673 * @sdev: device to block 2674 * 2675 * Pause SCSI command processing on the specified device and wait until all 2676 * ongoing scsi_request_fn() / scsi_queue_rq() calls have finished. May sleep. 2677 * 2678 * Returns zero if successful or a negative error code upon failure. 2679 * 2680 * Note: 2681 * This routine transitions the device to the SDEV_BLOCK state (which must be 2682 * a legal transition). When the device is in this state, command processing 2683 * is paused until the device leaves the SDEV_BLOCK state. See also 2684 * scsi_internal_device_unblock(). 2685 */ 2686 static int scsi_internal_device_block(struct scsi_device *sdev) 2687 { 2688 struct request_queue *q = sdev->request_queue; 2689 int err; 2690 2691 mutex_lock(&sdev->state_mutex); 2692 err = scsi_internal_device_block_nowait(sdev); 2693 if (err == 0) 2694 blk_mq_quiesce_queue(q); 2695 mutex_unlock(&sdev->state_mutex); 2696 2697 return err; 2698 } 2699 2700 void scsi_start_queue(struct scsi_device *sdev) 2701 { 2702 struct request_queue *q = sdev->request_queue; 2703 2704 blk_mq_unquiesce_queue(q); 2705 } 2706 2707 /** 2708 * scsi_internal_device_unblock_nowait - resume a device after a block request 2709 * @sdev: device to resume 2710 * @new_state: state to set the device to after unblocking 2711 * 2712 * Restart the device queue for a previously suspended SCSI device. Does not 2713 * sleep. 2714 * 2715 * Returns zero if successful or a negative error code upon failure. 2716 * 2717 * Notes: 2718 * This routine transitions the device to the SDEV_RUNNING state or to one of 2719 * the offline states (which must be a legal transition) allowing the midlayer 2720 * to goose the queue for this device. 2721 */ 2722 int scsi_internal_device_unblock_nowait(struct scsi_device *sdev, 2723 enum scsi_device_state new_state) 2724 { 2725 switch (new_state) { 2726 case SDEV_RUNNING: 2727 case SDEV_TRANSPORT_OFFLINE: 2728 break; 2729 default: 2730 return -EINVAL; 2731 } 2732 2733 /* 2734 * Try to transition the scsi device to SDEV_RUNNING or one of the 2735 * offlined states and goose the device queue if successful. 2736 */ 2737 switch (sdev->sdev_state) { 2738 case SDEV_BLOCK: 2739 case SDEV_TRANSPORT_OFFLINE: 2740 sdev->sdev_state = new_state; 2741 break; 2742 case SDEV_CREATED_BLOCK: 2743 if (new_state == SDEV_TRANSPORT_OFFLINE || 2744 new_state == SDEV_OFFLINE) 2745 sdev->sdev_state = new_state; 2746 else 2747 sdev->sdev_state = SDEV_CREATED; 2748 break; 2749 case SDEV_CANCEL: 2750 case SDEV_OFFLINE: 2751 break; 2752 default: 2753 return -EINVAL; 2754 } 2755 scsi_start_queue(sdev); 2756 2757 return 0; 2758 } 2759 EXPORT_SYMBOL_GPL(scsi_internal_device_unblock_nowait); 2760 2761 /** 2762 * scsi_internal_device_unblock - resume a device after a block request 2763 * @sdev: device to resume 2764 * @new_state: state to set the device to after unblocking 2765 * 2766 * Restart the device queue for a previously suspended SCSI device. May sleep. 2767 * 2768 * Returns zero if successful or a negative error code upon failure. 2769 * 2770 * Notes: 2771 * This routine transitions the device to the SDEV_RUNNING state or to one of 2772 * the offline states (which must be a legal transition) allowing the midlayer 2773 * to goose the queue for this device. 2774 */ 2775 static int scsi_internal_device_unblock(struct scsi_device *sdev, 2776 enum scsi_device_state new_state) 2777 { 2778 int ret; 2779 2780 mutex_lock(&sdev->state_mutex); 2781 ret = scsi_internal_device_unblock_nowait(sdev, new_state); 2782 mutex_unlock(&sdev->state_mutex); 2783 2784 return ret; 2785 } 2786 2787 static void 2788 device_block(struct scsi_device *sdev, void *data) 2789 { 2790 int ret; 2791 2792 ret = scsi_internal_device_block(sdev); 2793 2794 WARN_ONCE(ret, "scsi_internal_device_block(%s) failed: ret = %d\n", 2795 dev_name(&sdev->sdev_gendev), ret); 2796 } 2797 2798 static int 2799 target_block(struct device *dev, void *data) 2800 { 2801 if (scsi_is_target_device(dev)) 2802 starget_for_each_device(to_scsi_target(dev), NULL, 2803 device_block); 2804 return 0; 2805 } 2806 2807 void 2808 scsi_target_block(struct device *dev) 2809 { 2810 if (scsi_is_target_device(dev)) 2811 starget_for_each_device(to_scsi_target(dev), NULL, 2812 device_block); 2813 else 2814 device_for_each_child(dev, NULL, target_block); 2815 } 2816 EXPORT_SYMBOL_GPL(scsi_target_block); 2817 2818 static void 2819 device_unblock(struct scsi_device *sdev, void *data) 2820 { 2821 scsi_internal_device_unblock(sdev, *(enum scsi_device_state *)data); 2822 } 2823 2824 static int 2825 target_unblock(struct device *dev, void *data) 2826 { 2827 if (scsi_is_target_device(dev)) 2828 starget_for_each_device(to_scsi_target(dev), data, 2829 device_unblock); 2830 return 0; 2831 } 2832 2833 void 2834 scsi_target_unblock(struct device *dev, enum scsi_device_state new_state) 2835 { 2836 if (scsi_is_target_device(dev)) 2837 starget_for_each_device(to_scsi_target(dev), &new_state, 2838 device_unblock); 2839 else 2840 device_for_each_child(dev, &new_state, target_unblock); 2841 } 2842 EXPORT_SYMBOL_GPL(scsi_target_unblock); 2843 2844 int 2845 scsi_host_block(struct Scsi_Host *shost) 2846 { 2847 struct scsi_device *sdev; 2848 int ret = 0; 2849 2850 /* 2851 * Call scsi_internal_device_block_nowait so we can avoid 2852 * calling synchronize_rcu() for each LUN. 2853 */ 2854 shost_for_each_device(sdev, shost) { 2855 mutex_lock(&sdev->state_mutex); 2856 ret = scsi_internal_device_block_nowait(sdev); 2857 mutex_unlock(&sdev->state_mutex); 2858 if (ret) { 2859 scsi_device_put(sdev); 2860 break; 2861 } 2862 } 2863 2864 /* 2865 * SCSI never enables blk-mq's BLK_MQ_F_BLOCKING flag so 2866 * calling synchronize_rcu() once is enough. 2867 */ 2868 WARN_ON_ONCE(shost->tag_set.flags & BLK_MQ_F_BLOCKING); 2869 2870 if (!ret) 2871 synchronize_rcu(); 2872 2873 return ret; 2874 } 2875 EXPORT_SYMBOL_GPL(scsi_host_block); 2876 2877 int 2878 scsi_host_unblock(struct Scsi_Host *shost, int new_state) 2879 { 2880 struct scsi_device *sdev; 2881 int ret = 0; 2882 2883 shost_for_each_device(sdev, shost) { 2884 ret = scsi_internal_device_unblock(sdev, new_state); 2885 if (ret) { 2886 scsi_device_put(sdev); 2887 break; 2888 } 2889 } 2890 return ret; 2891 } 2892 EXPORT_SYMBOL_GPL(scsi_host_unblock); 2893 2894 /** 2895 * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt 2896 * @sgl: scatter-gather list 2897 * @sg_count: number of segments in sg 2898 * @offset: offset in bytes into sg, on return offset into the mapped area 2899 * @len: bytes to map, on return number of bytes mapped 2900 * 2901 * Returns virtual address of the start of the mapped page 2902 */ 2903 void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count, 2904 size_t *offset, size_t *len) 2905 { 2906 int i; 2907 size_t sg_len = 0, len_complete = 0; 2908 struct scatterlist *sg; 2909 struct page *page; 2910 2911 WARN_ON(!irqs_disabled()); 2912 2913 for_each_sg(sgl, sg, sg_count, i) { 2914 len_complete = sg_len; /* Complete sg-entries */ 2915 sg_len += sg->length; 2916 if (sg_len > *offset) 2917 break; 2918 } 2919 2920 if (unlikely(i == sg_count)) { 2921 printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, " 2922 "elements %d\n", 2923 __func__, sg_len, *offset, sg_count); 2924 WARN_ON(1); 2925 return NULL; 2926 } 2927 2928 /* Offset starting from the beginning of first page in this sg-entry */ 2929 *offset = *offset - len_complete + sg->offset; 2930 2931 /* Assumption: contiguous pages can be accessed as "page + i" */ 2932 page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT)); 2933 *offset &= ~PAGE_MASK; 2934 2935 /* Bytes in this sg-entry from *offset to the end of the page */ 2936 sg_len = PAGE_SIZE - *offset; 2937 if (*len > sg_len) 2938 *len = sg_len; 2939 2940 return kmap_atomic(page); 2941 } 2942 EXPORT_SYMBOL(scsi_kmap_atomic_sg); 2943 2944 /** 2945 * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg 2946 * @virt: virtual address to be unmapped 2947 */ 2948 void scsi_kunmap_atomic_sg(void *virt) 2949 { 2950 kunmap_atomic(virt); 2951 } 2952 EXPORT_SYMBOL(scsi_kunmap_atomic_sg); 2953 2954 void sdev_disable_disk_events(struct scsi_device *sdev) 2955 { 2956 atomic_inc(&sdev->disk_events_disable_depth); 2957 } 2958 EXPORT_SYMBOL(sdev_disable_disk_events); 2959 2960 void sdev_enable_disk_events(struct scsi_device *sdev) 2961 { 2962 if (WARN_ON_ONCE(atomic_read(&sdev->disk_events_disable_depth) <= 0)) 2963 return; 2964 atomic_dec(&sdev->disk_events_disable_depth); 2965 } 2966 EXPORT_SYMBOL(sdev_enable_disk_events); 2967 2968 static unsigned char designator_prio(const unsigned char *d) 2969 { 2970 if (d[1] & 0x30) 2971 /* not associated with LUN */ 2972 return 0; 2973 2974 if (d[3] == 0) 2975 /* invalid length */ 2976 return 0; 2977 2978 /* 2979 * Order of preference for lun descriptor: 2980 * - SCSI name string 2981 * - NAA IEEE Registered Extended 2982 * - EUI-64 based 16-byte 2983 * - EUI-64 based 12-byte 2984 * - NAA IEEE Registered 2985 * - NAA IEEE Extended 2986 * - EUI-64 based 8-byte 2987 * - SCSI name string (truncated) 2988 * - T10 Vendor ID 2989 * as longer descriptors reduce the likelyhood 2990 * of identification clashes. 2991 */ 2992 2993 switch (d[1] & 0xf) { 2994 case 8: 2995 /* SCSI name string, variable-length UTF-8 */ 2996 return 9; 2997 case 3: 2998 switch (d[4] >> 4) { 2999 case 6: 3000 /* NAA registered extended */ 3001 return 8; 3002 case 5: 3003 /* NAA registered */ 3004 return 5; 3005 case 4: 3006 /* NAA extended */ 3007 return 4; 3008 case 3: 3009 /* NAA locally assigned */ 3010 return 1; 3011 default: 3012 break; 3013 } 3014 break; 3015 case 2: 3016 switch (d[3]) { 3017 case 16: 3018 /* EUI64-based, 16 byte */ 3019 return 7; 3020 case 12: 3021 /* EUI64-based, 12 byte */ 3022 return 6; 3023 case 8: 3024 /* EUI64-based, 8 byte */ 3025 return 3; 3026 default: 3027 break; 3028 } 3029 break; 3030 case 1: 3031 /* T10 vendor ID */ 3032 return 1; 3033 default: 3034 break; 3035 } 3036 3037 return 0; 3038 } 3039 3040 /** 3041 * scsi_vpd_lun_id - return a unique device identification 3042 * @sdev: SCSI device 3043 * @id: buffer for the identification 3044 * @id_len: length of the buffer 3045 * 3046 * Copies a unique device identification into @id based 3047 * on the information in the VPD page 0x83 of the device. 3048 * The string will be formatted as a SCSI name string. 3049 * 3050 * Returns the length of the identification or error on failure. 3051 * If the identifier is longer than the supplied buffer the actual 3052 * identifier length is returned and the buffer is not zero-padded. 3053 */ 3054 int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len) 3055 { 3056 u8 cur_id_prio = 0; 3057 u8 cur_id_size = 0; 3058 const unsigned char *d, *cur_id_str; 3059 const struct scsi_vpd *vpd_pg83; 3060 int id_size = -EINVAL; 3061 3062 rcu_read_lock(); 3063 vpd_pg83 = rcu_dereference(sdev->vpd_pg83); 3064 if (!vpd_pg83) { 3065 rcu_read_unlock(); 3066 return -ENXIO; 3067 } 3068 3069 /* The id string must be at least 20 bytes + terminating NULL byte */ 3070 if (id_len < 21) { 3071 rcu_read_unlock(); 3072 return -EINVAL; 3073 } 3074 3075 memset(id, 0, id_len); 3076 for (d = vpd_pg83->data + 4; 3077 d < vpd_pg83->data + vpd_pg83->len; 3078 d += d[3] + 4) { 3079 u8 prio = designator_prio(d); 3080 3081 if (prio == 0 || cur_id_prio > prio) 3082 continue; 3083 3084 switch (d[1] & 0xf) { 3085 case 0x1: 3086 /* T10 Vendor ID */ 3087 if (cur_id_size > d[3]) 3088 break; 3089 cur_id_prio = prio; 3090 cur_id_size = d[3]; 3091 if (cur_id_size + 4 > id_len) 3092 cur_id_size = id_len - 4; 3093 cur_id_str = d + 4; 3094 id_size = snprintf(id, id_len, "t10.%*pE", 3095 cur_id_size, cur_id_str); 3096 break; 3097 case 0x2: 3098 /* EUI-64 */ 3099 cur_id_prio = prio; 3100 cur_id_size = d[3]; 3101 cur_id_str = d + 4; 3102 switch (cur_id_size) { 3103 case 8: 3104 id_size = snprintf(id, id_len, 3105 "eui.%8phN", 3106 cur_id_str); 3107 break; 3108 case 12: 3109 id_size = snprintf(id, id_len, 3110 "eui.%12phN", 3111 cur_id_str); 3112 break; 3113 case 16: 3114 id_size = snprintf(id, id_len, 3115 "eui.%16phN", 3116 cur_id_str); 3117 break; 3118 default: 3119 break; 3120 } 3121 break; 3122 case 0x3: 3123 /* NAA */ 3124 cur_id_prio = prio; 3125 cur_id_size = d[3]; 3126 cur_id_str = d + 4; 3127 switch (cur_id_size) { 3128 case 8: 3129 id_size = snprintf(id, id_len, 3130 "naa.%8phN", 3131 cur_id_str); 3132 break; 3133 case 16: 3134 id_size = snprintf(id, id_len, 3135 "naa.%16phN", 3136 cur_id_str); 3137 break; 3138 default: 3139 break; 3140 } 3141 break; 3142 case 0x8: 3143 /* SCSI name string */ 3144 if (cur_id_size > d[3]) 3145 break; 3146 /* Prefer others for truncated descriptor */ 3147 if (d[3] > id_len) { 3148 prio = 2; 3149 if (cur_id_prio > prio) 3150 break; 3151 } 3152 cur_id_prio = prio; 3153 cur_id_size = id_size = d[3]; 3154 cur_id_str = d + 4; 3155 if (cur_id_size >= id_len) 3156 cur_id_size = id_len - 1; 3157 memcpy(id, cur_id_str, cur_id_size); 3158 break; 3159 default: 3160 break; 3161 } 3162 } 3163 rcu_read_unlock(); 3164 3165 return id_size; 3166 } 3167 EXPORT_SYMBOL(scsi_vpd_lun_id); 3168 3169 /* 3170 * scsi_vpd_tpg_id - return a target port group identifier 3171 * @sdev: SCSI device 3172 * 3173 * Returns the Target Port Group identifier from the information 3174 * froom VPD page 0x83 of the device. 3175 * 3176 * Returns the identifier or error on failure. 3177 */ 3178 int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id) 3179 { 3180 const unsigned char *d; 3181 const struct scsi_vpd *vpd_pg83; 3182 int group_id = -EAGAIN, rel_port = -1; 3183 3184 rcu_read_lock(); 3185 vpd_pg83 = rcu_dereference(sdev->vpd_pg83); 3186 if (!vpd_pg83) { 3187 rcu_read_unlock(); 3188 return -ENXIO; 3189 } 3190 3191 d = vpd_pg83->data + 4; 3192 while (d < vpd_pg83->data + vpd_pg83->len) { 3193 switch (d[1] & 0xf) { 3194 case 0x4: 3195 /* Relative target port */ 3196 rel_port = get_unaligned_be16(&d[6]); 3197 break; 3198 case 0x5: 3199 /* Target port group */ 3200 group_id = get_unaligned_be16(&d[6]); 3201 break; 3202 default: 3203 break; 3204 } 3205 d += d[3] + 4; 3206 } 3207 rcu_read_unlock(); 3208 3209 if (group_id >= 0 && rel_id && rel_port != -1) 3210 *rel_id = rel_port; 3211 3212 return group_id; 3213 } 3214 EXPORT_SYMBOL(scsi_vpd_tpg_id); 3215 3216 /** 3217 * scsi_build_sense - build sense data for a command 3218 * @scmd: scsi command for which the sense should be formatted 3219 * @desc: Sense format (non-zero == descriptor format, 3220 * 0 == fixed format) 3221 * @key: Sense key 3222 * @asc: Additional sense code 3223 * @ascq: Additional sense code qualifier 3224 * 3225 **/ 3226 void scsi_build_sense(struct scsi_cmnd *scmd, int desc, u8 key, u8 asc, u8 ascq) 3227 { 3228 scsi_build_sense_buffer(desc, scmd->sense_buffer, key, asc, ascq); 3229 scmd->result = SAM_STAT_CHECK_CONDITION; 3230 } 3231 EXPORT_SYMBOL_GPL(scsi_build_sense); 3232