1 // SPDX-License-Identifier: GPL-2.0-only
3 * hosts.c Copyright (C) 1992 Drew Eckhardt
4 * Copyright (C) 1993, 1994, 1995 Eric Youngdale
5 * Copyright (C) 2002-2003 Christoph Hellwig
7 * mid to lowlevel SCSI driver interface
8 * Initial versions: Drew Eckhardt
9 * Subsequent revisions: Eric Youngdale
13 * Jiffies wrap fixes (host->resetting), 3 Dec 1998 Andrea Arcangeli
14 * Added QLOGIC QLA1280 SCSI controller kernel host support.
15 * August 4, 1999 Fred Lewis, Intel DuPont
17 * Updated to reflect the new initialization scheme for the higher
18 * level of scsi drivers (sd/sr/st)
19 * September 17, 2000 Torben Mathiasen <tmm@image.dk>
21 * Restructured scsi_host lists and associated functions.
22 * September 04, 2002 Mike Anderson (andmike@us.ibm.com)
25 #include <linux/module.h>
26 #include <linux/blkdev.h>
27 #include <linux/kernel.h>
28 #include <linux/slab.h>
29 #include <linux/kthread.h>
30 #include <linux/string.h>
32 #include <linux/init.h>
33 #include <linux/completion.h>
34 #include <linux/transport_class.h>
35 #include <linux/platform_device.h>
36 #include <linux/pm_runtime.h>
37 #include <linux/idr.h>
38 #include <scsi/scsi_device.h>
39 #include <scsi/scsi_host.h>
40 #include <scsi/scsi_transport.h>
41 #include <scsi/scsi_cmnd.h>
43 #include "scsi_priv.h"
44 #include "scsi_logging.h"
47 static int shost_eh_deadline = -1;
49 module_param_named(eh_deadline, shost_eh_deadline, int, S_IRUGO|S_IWUSR);
50 MODULE_PARM_DESC(eh_deadline,
51 "SCSI EH timeout in seconds (should be between 0 and 2^31-1)");
53 static DEFINE_IDA(host_index_ida);
56 static void scsi_host_cls_release(struct device *dev)
58 put_device(&class_to_shost(dev)->shost_gendev);
61 static struct class shost_class = {
63 .dev_release = scsi_host_cls_release,
64 .dev_groups = scsi_shost_groups,
68 * scsi_host_set_state - Take the given host through the host state model.
69 * @shost: scsi host to change the state of.
70 * @state: state to change to.
72 * Returns zero if unsuccessful or an error if the requested
73 * transition is illegal.
75 int scsi_host_set_state(struct Scsi_Host *shost, enum scsi_host_state state)
77 enum scsi_host_state oldstate = shost->shost_state;
79 if (state == oldstate)
84 /* There are no legal states that come back to
85 * created. This is the manually initialised start
112 case SHOST_CANCEL_RECOVERY:
122 case SHOST_DEL_RECOVERY:
129 case SHOST_CANCEL_RECOVERY:
139 case SHOST_DEL_RECOVERY:
141 case SHOST_CANCEL_RECOVERY:
148 shost->shost_state = state;
152 SCSI_LOG_ERROR_RECOVERY(1,
153 shost_printk(KERN_ERR, shost,
154 "Illegal host state transition"
156 scsi_host_state_name(oldstate),
157 scsi_host_state_name(state)));
162 * scsi_remove_host - remove a scsi host
163 * @shost: a pointer to a scsi host to remove
165 void scsi_remove_host(struct Scsi_Host *shost)
169 mutex_lock(&shost->scan_mutex);
170 spin_lock_irqsave(shost->host_lock, flags);
171 if (scsi_host_set_state(shost, SHOST_CANCEL))
172 if (scsi_host_set_state(shost, SHOST_CANCEL_RECOVERY)) {
173 spin_unlock_irqrestore(shost->host_lock, flags);
174 mutex_unlock(&shost->scan_mutex);
177 spin_unlock_irqrestore(shost->host_lock, flags);
179 scsi_autopm_get_host(shost);
180 flush_workqueue(shost->tmf_work_q);
181 scsi_forget_host(shost);
182 mutex_unlock(&shost->scan_mutex);
183 scsi_proc_host_rm(shost);
185 spin_lock_irqsave(shost->host_lock, flags);
186 if (scsi_host_set_state(shost, SHOST_DEL))
187 BUG_ON(scsi_host_set_state(shost, SHOST_DEL_RECOVERY));
188 spin_unlock_irqrestore(shost->host_lock, flags);
190 transport_unregister_device(&shost->shost_gendev);
191 device_unregister(&shost->shost_dev);
192 device_del(&shost->shost_gendev);
195 * After scsi_remove_host() has returned the scsi LLD module can be
196 * unloaded and/or the host resources can be released. Hence wait until
197 * the dependent SCSI targets and devices are gone before returning.
199 wait_event(shost->targets_wq, atomic_read(&shost->target_count) == 0);
201 EXPORT_SYMBOL(scsi_remove_host);
204 * scsi_add_host_with_dma - add a scsi host with dma device
205 * @shost: scsi host pointer to add
206 * @dev: a struct device of type scsi class
207 * @dma_dev: dma device for the host
209 * Note: You rarely need to worry about this unless you're in a
210 * virtualised host environments, so use the simpler scsi_add_host()
214 * 0 on success / != 0 for error
216 int scsi_add_host_with_dma(struct Scsi_Host *shost, struct device *dev,
217 struct device *dma_dev)
219 struct scsi_host_template *sht = shost->hostt;
222 shost_printk(KERN_INFO, shost, "%s\n",
223 sht->info ? sht->info(shost) : sht->name);
225 if (!shost->can_queue) {
226 shost_printk(KERN_ERR, shost,
227 "can_queue = 0 no longer supported\n");
231 /* Use min_t(int, ...) in case shost->can_queue exceeds SHRT_MAX */
232 shost->cmd_per_lun = min_t(int, shost->cmd_per_lun,
235 error = scsi_init_sense_cache(shost);
239 if (!shost->shost_gendev.parent)
240 shost->shost_gendev.parent = dev ? dev : &platform_bus;
242 dma_dev = shost->shost_gendev.parent;
244 shost->dma_dev = dma_dev;
246 error = scsi_mq_setup_tags(shost);
251 * Increase usage count temporarily here so that calling
252 * scsi_autopm_put_host() will trigger runtime idle if there is
253 * nothing else preventing suspending the device.
255 pm_runtime_get_noresume(&shost->shost_gendev);
256 pm_runtime_set_active(&shost->shost_gendev);
257 pm_runtime_enable(&shost->shost_gendev);
258 device_enable_async_suspend(&shost->shost_gendev);
260 error = device_add(&shost->shost_gendev);
262 goto out_disable_runtime_pm;
264 scsi_host_set_state(shost, SHOST_RUNNING);
265 get_device(shost->shost_gendev.parent);
267 device_enable_async_suspend(&shost->shost_dev);
269 get_device(&shost->shost_gendev);
270 error = device_add(&shost->shost_dev);
274 if (shost->transportt->host_size) {
275 shost->shost_data = kzalloc(shost->transportt->host_size,
277 if (shost->shost_data == NULL) {
283 if (shost->transportt->create_work_queue) {
284 snprintf(shost->work_q_name, sizeof(shost->work_q_name),
285 "scsi_wq_%d", shost->host_no);
286 shost->work_q = alloc_workqueue("%s",
287 WQ_SYSFS | __WQ_LEGACY | WQ_MEM_RECLAIM | WQ_UNBOUND,
288 1, shost->work_q_name);
290 if (!shost->work_q) {
296 error = scsi_sysfs_add_host(shost);
300 scsi_proc_host_add(shost);
301 scsi_autopm_put_host(shost);
305 * Any host allocation in this function will be freed in
306 * scsi_host_dev_release().
309 device_del(&shost->shost_dev);
312 * Host state is SHOST_RUNNING so we have to explicitly release
315 put_device(&shost->shost_dev);
316 device_del(&shost->shost_gendev);
317 out_disable_runtime_pm:
318 device_disable_async_suspend(&shost->shost_gendev);
319 pm_runtime_disable(&shost->shost_gendev);
320 pm_runtime_set_suspended(&shost->shost_gendev);
321 pm_runtime_put_noidle(&shost->shost_gendev);
325 EXPORT_SYMBOL(scsi_add_host_with_dma);
327 static void scsi_host_dev_release(struct device *dev)
329 struct Scsi_Host *shost = dev_to_shost(dev);
330 struct device *parent = dev->parent;
332 scsi_proc_hostdir_rm(shost->hostt);
334 /* Wait for functions invoked through call_rcu(&scmd->rcu, ...) */
337 if (shost->tmf_work_q)
338 destroy_workqueue(shost->tmf_work_q);
340 kthread_stop(shost->ehandler);
342 destroy_workqueue(shost->work_q);
344 if (shost->shost_state == SHOST_CREATED) {
346 * Free the shost_dev device name here if scsi_host_alloc()
347 * and scsi_host_put() have been called but neither
348 * scsi_host_add() nor scsi_host_remove() has been called.
349 * This avoids that the memory allocated for the shost_dev
352 kfree(dev_name(&shost->shost_dev));
355 if (shost->tag_set.tags)
356 scsi_mq_destroy_tags(shost);
358 kfree(shost->shost_data);
360 ida_free(&host_index_ida, shost->host_no);
362 if (shost->shost_state != SHOST_CREATED)
367 static struct device_type scsi_host_type = {
369 .release = scsi_host_dev_release,
373 * scsi_host_alloc - register a scsi host adapter instance.
374 * @sht: pointer to scsi host template
375 * @privsize: extra bytes to allocate for driver
378 * Allocate a new Scsi_Host and perform basic initialization.
379 * The host is not published to the scsi midlayer until scsi_add_host
383 * Pointer to a new Scsi_Host
385 struct Scsi_Host *scsi_host_alloc(struct scsi_host_template *sht, int privsize)
387 struct Scsi_Host *shost;
390 shost = kzalloc(sizeof(struct Scsi_Host) + privsize, GFP_KERNEL);
394 shost->host_lock = &shost->default_lock;
395 spin_lock_init(shost->host_lock);
396 shost->shost_state = SHOST_CREATED;
397 INIT_LIST_HEAD(&shost->__devices);
398 INIT_LIST_HEAD(&shost->__targets);
399 INIT_LIST_HEAD(&shost->eh_abort_list);
400 INIT_LIST_HEAD(&shost->eh_cmd_q);
401 INIT_LIST_HEAD(&shost->starved_list);
402 init_waitqueue_head(&shost->host_wait);
403 mutex_init(&shost->scan_mutex);
404 init_waitqueue_head(&shost->targets_wq);
406 index = ida_alloc(&host_index_ida, GFP_KERNEL);
411 shost->host_no = index;
413 shost->dma_channel = 0xff;
415 /* These three are default values which can be overridden */
416 shost->max_channel = 0;
420 /* Give each shost a default transportt */
421 shost->transportt = &blank_transport_template;
424 * All drivers right now should be able to handle 12 byte
425 * commands. Every so often there are requests for 16 byte
426 * commands, but individual low-level drivers need to certify that
427 * they actually do something sensible with such commands.
429 shost->max_cmd_len = 12;
431 shost->this_id = sht->this_id;
432 shost->can_queue = sht->can_queue;
433 shost->sg_tablesize = sht->sg_tablesize;
434 shost->sg_prot_tablesize = sht->sg_prot_tablesize;
435 shost->cmd_per_lun = sht->cmd_per_lun;
436 shost->no_write_same = sht->no_write_same;
437 shost->host_tagset = sht->host_tagset;
439 if (shost_eh_deadline == -1 || !sht->eh_host_reset_handler)
440 shost->eh_deadline = -1;
441 else if ((ulong) shost_eh_deadline * HZ > INT_MAX) {
442 shost_printk(KERN_WARNING, shost,
443 "eh_deadline %u too large, setting to %u\n",
444 shost_eh_deadline, INT_MAX / HZ);
445 shost->eh_deadline = INT_MAX;
447 shost->eh_deadline = shost_eh_deadline * HZ;
449 if (sht->supported_mode == MODE_UNKNOWN)
450 /* means we didn't set it ... default to INITIATOR */
451 shost->active_mode = MODE_INITIATOR;
453 shost->active_mode = sht->supported_mode;
455 if (sht->max_host_blocked)
456 shost->max_host_blocked = sht->max_host_blocked;
458 shost->max_host_blocked = SCSI_DEFAULT_HOST_BLOCKED;
461 * If the driver imposes no hard sector transfer limit, start at
462 * machine infinity initially.
464 if (sht->max_sectors)
465 shost->max_sectors = sht->max_sectors;
467 shost->max_sectors = SCSI_DEFAULT_MAX_SECTORS;
469 if (sht->max_segment_size)
470 shost->max_segment_size = sht->max_segment_size;
472 shost->max_segment_size = BLK_MAX_SEGMENT_SIZE;
475 * assume a 4GB boundary, if not set
477 if (sht->dma_boundary)
478 shost->dma_boundary = sht->dma_boundary;
480 shost->dma_boundary = 0xffffffff;
482 if (sht->virt_boundary_mask)
483 shost->virt_boundary_mask = sht->virt_boundary_mask;
485 device_initialize(&shost->shost_gendev);
486 dev_set_name(&shost->shost_gendev, "host%d", shost->host_no);
487 shost->shost_gendev.bus = &scsi_bus_type;
488 shost->shost_gendev.type = &scsi_host_type;
489 scsi_enable_async_suspend(&shost->shost_gendev);
491 device_initialize(&shost->shost_dev);
492 shost->shost_dev.parent = &shost->shost_gendev;
493 shost->shost_dev.class = &shost_class;
494 dev_set_name(&shost->shost_dev, "host%d", shost->host_no);
495 shost->shost_dev.groups = sht->shost_groups;
497 shost->ehandler = kthread_run(scsi_error_handler, shost,
498 "scsi_eh_%d", shost->host_no);
499 if (IS_ERR(shost->ehandler)) {
500 shost_printk(KERN_WARNING, shost,
501 "error handler thread failed to spawn, error = %ld\n",
502 PTR_ERR(shost->ehandler));
503 shost->ehandler = NULL;
507 shost->tmf_work_q = alloc_workqueue("scsi_tmf_%d",
508 WQ_UNBOUND | WQ_MEM_RECLAIM | WQ_SYSFS,
510 if (!shost->tmf_work_q) {
511 shost_printk(KERN_WARNING, shost,
512 "failed to create tmf workq\n");
515 scsi_proc_hostdir_add(shost->hostt);
519 * Host state is still SHOST_CREATED and that is enough to release
520 * ->shost_gendev. scsi_host_dev_release() will free
521 * dev_name(&shost->shost_dev).
523 put_device(&shost->shost_gendev);
527 EXPORT_SYMBOL(scsi_host_alloc);
529 static int __scsi_host_match(struct device *dev, const void *data)
532 const unsigned short *hostnum = data;
534 p = class_to_shost(dev);
535 return p->host_no == *hostnum;
539 * scsi_host_lookup - get a reference to a Scsi_Host by host no
540 * @hostnum: host number to locate
543 * A pointer to located Scsi_Host or NULL.
545 * The caller must do a scsi_host_put() to drop the reference
546 * that scsi_host_get() took. The put_device() below dropped
547 * the reference from class_find_device().
549 struct Scsi_Host *scsi_host_lookup(unsigned short hostnum)
552 struct Scsi_Host *shost = NULL;
554 cdev = class_find_device(&shost_class, NULL, &hostnum,
557 shost = scsi_host_get(class_to_shost(cdev));
562 EXPORT_SYMBOL(scsi_host_lookup);
565 * scsi_host_get - inc a Scsi_Host ref count
566 * @shost: Pointer to Scsi_Host to inc.
568 struct Scsi_Host *scsi_host_get(struct Scsi_Host *shost)
570 if ((shost->shost_state == SHOST_DEL) ||
571 !get_device(&shost->shost_gendev))
575 EXPORT_SYMBOL(scsi_host_get);
577 static bool scsi_host_check_in_flight(struct request *rq, void *data,
581 struct scsi_cmnd *cmd = blk_mq_rq_to_pdu(rq);
583 if (test_bit(SCMD_STATE_INFLIGHT, &cmd->state))
590 * scsi_host_busy - Return the host busy counter
591 * @shost: Pointer to Scsi_Host to inc.
593 int scsi_host_busy(struct Scsi_Host *shost)
597 blk_mq_tagset_busy_iter(&shost->tag_set,
598 scsi_host_check_in_flight, &cnt);
601 EXPORT_SYMBOL(scsi_host_busy);
604 * scsi_host_put - dec a Scsi_Host ref count
605 * @shost: Pointer to Scsi_Host to dec.
607 void scsi_host_put(struct Scsi_Host *shost)
609 put_device(&shost->shost_gendev);
611 EXPORT_SYMBOL(scsi_host_put);
613 int scsi_init_hosts(void)
615 return class_register(&shost_class);
618 void scsi_exit_hosts(void)
620 class_unregister(&shost_class);
621 ida_destroy(&host_index_ida);
624 int scsi_is_host_device(const struct device *dev)
626 return dev->type == &scsi_host_type;
628 EXPORT_SYMBOL(scsi_is_host_device);
631 * scsi_queue_work - Queue work to the Scsi_Host workqueue.
632 * @shost: Pointer to Scsi_Host.
633 * @work: Work to queue for execution.
636 * 1 - work queued for execution
637 * 0 - work is already queued
638 * -EINVAL - work queue doesn't exist
640 int scsi_queue_work(struct Scsi_Host *shost, struct work_struct *work)
642 if (unlikely(!shost->work_q)) {
643 shost_printk(KERN_ERR, shost,
644 "ERROR: Scsi host '%s' attempted to queue scsi-work, "
645 "when no workqueue created.\n", shost->hostt->name);
651 return queue_work(shost->work_q, work);
653 EXPORT_SYMBOL_GPL(scsi_queue_work);
656 * scsi_flush_work - Flush a Scsi_Host's workqueue.
657 * @shost: Pointer to Scsi_Host.
659 void scsi_flush_work(struct Scsi_Host *shost)
661 if (!shost->work_q) {
662 shost_printk(KERN_ERR, shost,
663 "ERROR: Scsi host '%s' attempted to flush scsi-work, "
664 "when no workqueue created.\n", shost->hostt->name);
669 flush_workqueue(shost->work_q);
671 EXPORT_SYMBOL_GPL(scsi_flush_work);
673 static bool complete_all_cmds_iter(struct request *rq, void *data, bool rsvd)
675 struct scsi_cmnd *scmd = blk_mq_rq_to_pdu(rq);
676 enum scsi_host_status status = *(enum scsi_host_status *)data;
678 scsi_dma_unmap(scmd);
680 set_host_byte(scmd, status);
686 * scsi_host_complete_all_commands - Terminate all running commands
687 * @shost: Scsi Host on which commands should be terminated
688 * @status: Status to be set for the terminated commands
690 * There is no protection against modification of the number
691 * of outstanding commands. It is the responsibility of the
692 * caller to ensure that concurrent I/O submission and/or
693 * completion is stopped when calling this function.
695 void scsi_host_complete_all_commands(struct Scsi_Host *shost,
696 enum scsi_host_status status)
698 blk_mq_tagset_busy_iter(&shost->tag_set, complete_all_cmds_iter,
701 EXPORT_SYMBOL_GPL(scsi_host_complete_all_commands);
703 struct scsi_host_busy_iter_data {
704 bool (*fn)(struct scsi_cmnd *, void *, bool);
708 static bool __scsi_host_busy_iter_fn(struct request *req, void *priv,
711 struct scsi_host_busy_iter_data *iter_data = priv;
712 struct scsi_cmnd *sc = blk_mq_rq_to_pdu(req);
714 return iter_data->fn(sc, iter_data->priv, reserved);
718 * scsi_host_busy_iter - Iterate over all busy commands
719 * @shost: Pointer to Scsi_Host.
720 * @fn: Function to call on each busy command
721 * @priv: Data pointer passed to @fn
723 * If locking against concurrent command completions is required
724 * ithas to be provided by the caller
726 void scsi_host_busy_iter(struct Scsi_Host *shost,
727 bool (*fn)(struct scsi_cmnd *, void *, bool),
730 struct scsi_host_busy_iter_data iter_data = {
735 blk_mq_tagset_busy_iter(&shost->tag_set, __scsi_host_busy_iter_fn,
738 EXPORT_SYMBOL_GPL(scsi_host_busy_iter);