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