1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (C) 2008-2012 Daisuke Aoyama <aoyama@peach.ne.jp>. 5 * Copyright (c) Intel Corporation. 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 12 * * Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * * Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in 16 * the documentation and/or other materials provided with the 17 * distribution. 18 * * Neither the name of Intel Corporation nor the names of its 19 * contributors may be used to endorse or promote products derived 20 * from this software without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 33 */ 34 35 #ifndef SPDK_SCSI_INTERNAL_H 36 #define SPDK_SCSI_INTERNAL_H 37 38 #include "spdk/stdinc.h" 39 40 #include "spdk/bdev.h" 41 #include "spdk/scsi.h" 42 #include "spdk/scsi_spec.h" 43 #include "spdk/trace.h" 44 #include "spdk/dif.h" 45 46 #include "spdk_internal/log.h" 47 48 enum { 49 SPDK_SCSI_TASK_UNKNOWN = -1, 50 SPDK_SCSI_TASK_COMPLETE, 51 SPDK_SCSI_TASK_PENDING, 52 }; 53 54 struct spdk_scsi_port { 55 uint8_t is_used; 56 uint64_t id; 57 uint16_t index; 58 uint16_t transport_id_len; 59 char transport_id[SPDK_SCSI_MAX_TRANSPORT_ID_LENGTH]; 60 char name[SPDK_SCSI_PORT_MAX_NAME_LENGTH]; 61 }; 62 63 struct spdk_scsi_dev { 64 int id; 65 int is_allocated; 66 bool removed; 67 spdk_scsi_dev_destruct_cb_t remove_cb; 68 void *remove_ctx; 69 70 char name[SPDK_SCSI_DEV_MAX_NAME + 1]; 71 72 struct spdk_scsi_lun *lun[SPDK_SCSI_DEV_MAX_LUN]; 73 74 int num_ports; 75 struct spdk_scsi_port port[SPDK_SCSI_DEV_MAX_PORTS]; 76 77 uint8_t protocol_id; 78 }; 79 80 struct spdk_scsi_lun_desc { 81 struct spdk_scsi_lun *lun; 82 spdk_scsi_lun_remove_cb_t hotremove_cb; 83 void *hotremove_ctx; 84 TAILQ_ENTRY(spdk_scsi_lun_desc) link; 85 }; 86 87 struct spdk_scsi_lun { 88 /** LUN id for this logical unit. */ 89 int id; 90 91 /** Pointer to the SCSI device containing this LUN. */ 92 struct spdk_scsi_dev *dev; 93 94 /** The bdev associated with this LUN. */ 95 struct spdk_bdev *bdev; 96 97 /** Descriptor for opened block device. */ 98 struct spdk_bdev_desc *bdev_desc; 99 100 /** I/O channel for the bdev associated with this LUN. */ 101 struct spdk_io_channel *io_channel; 102 103 /** The reference number for this LUN, thus we can correctly free the io_channel */ 104 uint32_t ref; 105 106 /** Poller to release the resource of the lun when it is hot removed */ 107 struct spdk_poller *hotremove_poller; 108 109 /** The LUN is removed */ 110 bool removed; 111 112 /** Callback to be fired when LUN removal is first triggered. */ 113 void (*hotremove_cb)(const struct spdk_scsi_lun *lun, void *arg); 114 115 /** Argument for hotremove_cb */ 116 void *hotremove_ctx; 117 118 /** List of open descriptors for this LUN. */ 119 TAILQ_HEAD(, spdk_scsi_lun_desc) open_descs; 120 121 /** submitted tasks */ 122 TAILQ_HEAD(tasks, spdk_scsi_task) tasks; 123 124 /** pending tasks */ 125 TAILQ_HEAD(pending_tasks, spdk_scsi_task) pending_tasks; 126 127 /** submitted management tasks */ 128 TAILQ_HEAD(mgmt_tasks, spdk_scsi_task) mgmt_tasks; 129 130 /** pending management tasks */ 131 TAILQ_HEAD(pending_mgmt_tasks, spdk_scsi_task) pending_mgmt_tasks; 132 133 /** poller to check completion of tasks prior to reset */ 134 struct spdk_poller *reset_poller; 135 }; 136 137 struct spdk_lun_db_entry { 138 struct spdk_scsi_lun *lun; 139 struct spdk_lun_db_entry *next; 140 }; 141 142 extern struct spdk_lun_db_entry *spdk_scsi_lun_list_head; 143 144 /* This typedef exists to work around an astyle 2.05 bug. 145 * Remove it when astyle is fixed. 146 */ 147 typedef struct spdk_scsi_lun _spdk_scsi_lun; 148 149 _spdk_scsi_lun *spdk_scsi_lun_construct(struct spdk_bdev *bdev, 150 void (*hotremove_cb)(const struct spdk_scsi_lun *, void *), 151 void *hotremove_ctx); 152 void spdk_scsi_lun_destruct(struct spdk_scsi_lun *lun); 153 154 void spdk_scsi_lun_append_task(struct spdk_scsi_lun *lun, struct spdk_scsi_task *task); 155 void spdk_scsi_lun_execute_tasks(struct spdk_scsi_lun *lun); 156 void spdk_scsi_lun_append_mgmt_task(struct spdk_scsi_lun *lun, struct spdk_scsi_task *task); 157 void spdk_scsi_lun_execute_mgmt_task(struct spdk_scsi_lun *lun); 158 bool spdk_scsi_lun_has_pending_mgmt_tasks(const struct spdk_scsi_lun *lun); 159 void spdk_scsi_lun_complete_task(struct spdk_scsi_lun *lun, struct spdk_scsi_task *task); 160 void spdk_scsi_lun_complete_reset_task(struct spdk_scsi_lun *lun, struct spdk_scsi_task *task); 161 bool spdk_scsi_lun_has_pending_tasks(const struct spdk_scsi_lun *lun); 162 int _spdk_scsi_lun_allocate_io_channel(struct spdk_scsi_lun *lun); 163 void _spdk_scsi_lun_free_io_channel(struct spdk_scsi_lun *lun); 164 165 struct spdk_scsi_dev *spdk_scsi_dev_get_list(void); 166 167 int spdk_scsi_port_construct(struct spdk_scsi_port *port, uint64_t id, 168 uint16_t index, const char *name); 169 void spdk_scsi_port_destruct(struct spdk_scsi_port *port); 170 171 int spdk_bdev_scsi_execute(struct spdk_scsi_task *task); 172 void spdk_bdev_scsi_reset(struct spdk_scsi_task *task); 173 174 bool spdk_scsi_bdev_get_dif_ctx(struct spdk_bdev *bdev, uint8_t *cdb, uint32_t offset, 175 struct spdk_dif_ctx *dif_ctx); 176 177 struct spdk_scsi_globals { 178 pthread_mutex_t mutex; 179 }; 180 181 extern struct spdk_scsi_globals g_spdk_scsi; 182 183 #endif /* SPDK_SCSI_INTERNAL_H */ 184