1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2010 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 #ifndef _STMF_IMPL_H 26 #define _STMF_IMPL_H 27 28 #include <sys/stmf_defines.h> 29 #include <sys/stmf_ioctl.h> 30 31 #ifdef __cplusplus 32 extern "C" { 33 #endif 34 35 typedef uint32_t stmf_event_handle_t; 36 #define STMF_MAX_NUM_EVENTS (sizeof (stmf_event_handle_t) * 8) 37 #define STMF_EVENT_ADD(h, e) (atomic_or_32(&(h), \ 38 ((uint32_t)1) << (e))) 39 #define STMF_EVENT_REMOVE(h, e) (atomic_and_32(&(h), \ 40 ~(((uint32_t)1) << (e)))) 41 #define STMF_EVENT_ENABLED(h, e) (((h) & ((uint32_t)1) << (e)) != 0) 42 #define STMF_EVENT_CLEAR_ALL(h) ((h) = 0) 43 #define STMF_EVENT_ALLOC_HANDLE(h) ((h) = 0) 44 #define STMF_EVENT_FREE_HANDLE(h) ((h) = 0) 45 46 #define STMF_TGT_NAME_LEN 256 47 #define STMF_GUID_INPUT 32 48 49 #define STMF_UPDATE_KSTAT_IO(kip, dbuf) \ 50 if (dbuf->db_flags & DB_DIRECTION_TO_RPORT) { \ 51 kip->reads++; \ 52 kip->nread += dbuf->db_data_size; \ 53 } else { \ 54 kip->writes++; \ 55 kip->nwritten += dbuf->db_data_size; \ 56 } 57 58 struct stmf_i_scsi_task; 59 struct stmf_itl_data; 60 61 typedef struct stmf_i_lu_provider { 62 stmf_lu_provider_t *ilp_lp; 63 uint32_t ilp_alloc_size; 64 uint32_t ilp_nlus; /* # LUNs being exported */ 65 uint32_t ilp_cb_in_progress:1, 66 ilp_rsvd:31; 67 struct stmf_i_lu_provider *ilp_next; 68 struct stmf_pp_data *ilp_ppd; 69 } stmf_i_lu_provider_t; 70 71 typedef struct stmf_i_lu { 72 stmf_lu_t *ilu_lu; 73 uint32_t ilu_alloc_size; 74 uint32_t ilu_flags; 75 uint32_t ilu_ref_cnt; 76 uint8_t ilu_state; 77 uint8_t ilu_prev_state; 78 uint8_t ilu_access; 79 uint8_t ilu_alua; 80 stmf_event_handle_t ilu_event_hdl; 81 struct stmf_i_lu *ilu_next; 82 struct stmf_i_lu *ilu_prev; 83 char *ilu_alias; 84 char ilu_ascii_hex_guid[STMF_GUID_INPUT + 1]; 85 kmutex_t ilu_task_lock; 86 uint32_t ilu_task_cntr1; 87 uint32_t ilu_task_cntr2; 88 uint32_t *ilu_cur_task_cntr; 89 uint32_t ilu_ntasks; /* # of tasks in the ilu_task list */ 90 uint32_t ilu_ntasks_free; /* # of tasks that are free */ 91 uint32_t ilu_ntasks_min_free; /* # minimal free tasks */ 92 uint32_t rsvd1; 93 uint32_t ilu_proxy_registered; 94 uint64_t ilu_reg_msgid; 95 struct stmf_i_scsi_task *ilu_tasks; 96 struct stmf_i_scsi_task *ilu_free_tasks; 97 struct stmf_itl_data *ilu_itl_list; 98 kstat_t *ilu_kstat_info; 99 kstat_t *ilu_kstat_io; 100 kmutex_t ilu_kstat_lock; 101 102 /* point to the luid entry in stmf_state.stmf_luid_list */ 103 void *ilu_luid; 104 } stmf_i_lu_t; 105 106 /* 107 * ilu_flags 108 */ 109 #define ILU_STALL_DEREGISTER 0x0001 110 #define ILU_RESET_ACTIVE 0x0002 111 112 typedef struct stmf_i_port_provider { 113 stmf_port_provider_t *ipp_pp; 114 uint32_t ipp_alloc_size; 115 uint32_t ipp_npps; 116 uint32_t ipp_cb_in_progress:1, 117 ipp_rsvd:31; 118 struct stmf_i_port_provider *ipp_next; 119 struct stmf_pp_data *ipp_ppd; 120 } stmf_i_port_provider_t; 121 122 #define MAX_ILPORT 0x10000 123 124 typedef struct stmf_i_local_port { 125 stmf_local_port_t *ilport_lport; 126 uint32_t ilport_alloc_size; 127 uint32_t ilport_nsessions; 128 struct stmf_i_scsi_session *ilport_ss_list; 129 krwlock_t ilport_lock; 130 struct stmf_i_local_port *ilport_next; 131 struct stmf_i_local_port *ilport_prev; 132 uint8_t ilport_state; 133 uint8_t ilport_prev_state; 134 uint8_t ilport_standby; 135 uint8_t ilport_alua; 136 uint16_t ilport_rtpid; /* relative tpid */ 137 uint16_t ilport_proxy_registered; 138 uint64_t ilport_reg_msgid; 139 uint8_t ilport_no_standby_lu; 140 stmf_event_handle_t ilport_event_hdl; 141 clock_t ilport_last_online_clock; 142 clock_t ilport_avg_interval; 143 uint32_t ilport_online_times; 144 uint32_t ilport_flags; 145 kstat_t *ilport_kstat_info; 146 kstat_t *ilport_kstat_io; 147 kmutex_t ilport_kstat_lock; 148 char ilport_kstat_tgt_name[STMF_TGT_NAME_LEN]; 149 /* which target group this port belongs to in stmf_state.stmf_tg_list */ 150 void *ilport_tg; 151 id_t ilport_instance; 152 /* XXX Need something to track all the remote ports also */ 153 } stmf_i_local_port_t; 154 155 #define STMF_AVG_ONLINE_INTERVAL (30 * drv_usectohz(1000000)) 156 157 #define MAX_IRPORT 0x10000 158 159 typedef struct stmf_i_remote_port { 160 struct scsi_devid_desc *irport_id; 161 kmutex_t irport_mutex; 162 int irport_refcnt; 163 id_t irport_instance; 164 avl_node_t irport_ln; 165 } stmf_i_remote_port_t; 166 167 typedef struct stmf_i_itl_kstat { 168 char iitl_kstat_nm[KSTAT_STRLEN]; 169 char iitl_kstat_lport[STMF_TGT_NAME_LEN]; 170 char iitl_kstat_guid[STMF_GUID_INPUT + 1]; 171 char *iitl_kstat_strbuf; 172 int iitl_kstat_strbuflen; 173 kstat_t *iitl_kstat_info; 174 kstat_t *iitl_kstat_taskq; 175 kstat_t *iitl_kstat_lu_xfer; 176 kstat_t *iitl_kstat_lport_xfer; 177 avl_node_t iitl_kstat_ln; 178 } stmf_i_itl_kstat_t; 179 180 /* 181 * ilport flags 182 */ 183 #define ILPORT_FORCED_OFFLINE 0x01 184 #define ILPORT_SS_GOT_INITIAL_LUNS 0x02 185 186 typedef struct stmf_i_scsi_session { 187 stmf_scsi_session_t *iss_ss; 188 uint32_t iss_alloc_size; 189 uint32_t iss_flags; 190 stmf_i_remote_port_t *iss_irport; 191 struct stmf_i_scsi_session *iss_next; 192 /* 193 * Ideally we should maintain 2 maps. One would indicate a new map 194 * which will become available only upon receipt of a REPORT LUN 195 * cmd. 196 */ 197 struct stmf_lun_map *iss_sm; 198 /* 199 * which host group the host of this session belongs to in 200 * stmf_state.stmf_hg_list 201 */ 202 void *iss_hg; 203 krwlock_t *iss_lockp; 204 time_t iss_creation_time; 205 } stmf_i_scsi_session_t; 206 207 /* 208 * iss flags 209 */ 210 #define ISS_LUN_INVENTORY_CHANGED 0x0001 211 #define ISS_RESET_ACTIVE 0x0002 212 #define ISS_BEING_CREATED 0x0004 213 #define ISS_GOT_INITIAL_LUNS 0x0008 214 #define ISS_EVENT_ACTIVE 0x0010 215 216 #define ITASK_MAX_NCMDS 14 217 #define ITASK_DEFAULT_POLL_TIMEOUT 0 218 struct stmf_worker; 219 typedef struct stmf_i_scsi_task { 220 scsi_task_t *itask_task; 221 uint32_t itask_alloc_size; 222 uint32_t itask_flags; 223 uint64_t itask_proxy_msg_id; 224 stmf_data_buf_t *itask_proxy_dbuf; 225 struct stmf_worker *itask_worker; 226 uint32_t *itask_ilu_task_cntr; 227 struct stmf_i_scsi_task *itask_worker_next; 228 struct stmf_i_scsi_task *itask_lu_next; 229 struct stmf_i_scsi_task *itask_lu_prev; 230 struct stmf_i_scsi_task *itask_lu_free_next; 231 struct stmf_i_scsi_task *itask_abort_next; 232 struct stmf_itl_data *itask_itl_datap; 233 clock_t itask_start_time; /* abort and normal */ 234 /* For now we only support 4 parallel buffers. Should be enough. */ 235 stmf_data_buf_t *itask_dbufs[4]; 236 clock_t itask_poll_timeout; 237 uint8_t itask_cmd_stack[ITASK_MAX_NCMDS]; 238 uint8_t itask_ncmds; 239 uint8_t itask_allocated_buf_map; 240 uint16_t itask_cdb_buf_size; 241 242 /* Task profile data */ 243 hrtime_t itask_start_timestamp; 244 hrtime_t itask_done_timestamp; 245 hrtime_t itask_waitq_enter_timestamp; 246 hrtime_t itask_waitq_time; 247 hrtime_t itask_lu_read_time; 248 hrtime_t itask_lu_write_time; 249 hrtime_t itask_lport_read_time; 250 hrtime_t itask_lport_write_time; 251 uint64_t itask_read_xfer; 252 uint64_t itask_write_xfer; 253 } stmf_i_scsi_task_t; 254 255 #define ITASK_DEFAULT_ABORT_TIMEOUT 5 256 257 /* 258 * itask_flags 259 */ 260 #define ITASK_IN_FREE_LIST 0x0001 261 #define ITASK_IN_TRANSITION 0x0002 262 #define ITASK_IN_WORKER_QUEUE 0x0004 263 #define ITASK_BEING_ABORTED 0x0008 264 #define ITASK_BEING_COMPLETED 0x0010 265 #define ITASK_KNOWN_TO_TGT_PORT 0x0020 266 #define ITASK_KNOWN_TO_LU 0x0040 267 #define ITASK_LU_ABORT_CALLED 0x0080 268 #define ITASK_TGT_PORT_ABORT_CALLED 0x0100 269 #define ITASK_DEFAULT_HANDLING 0x0200 270 #define ITASK_CAUSING_LU_RESET 0x0400 271 #define ITASK_CAUSING_TARGET_RESET 0x0800 272 #define ITASK_KSTAT_IN_RUNQ 0x1000 273 #define ITASK_PROXY_TASK 0x2000 274 275 /* 276 * itask cmds. 277 */ 278 #define ITASK_CMD_MASK 0x1F 279 #define ITASK_CMD_BUF_NDX(cmd) (((uint8_t)(cmd)) >> 5) 280 #define ITASK_CMD_NEW_TASK 0x1 281 #define ITASK_CMD_DATA_XFER_DONE 0x2 282 #define ITASK_CMD_STATUS_DONE 0x3 283 #define ITASK_CMD_ABORT 0x4 284 #define ITASK_CMD_SEND_STATUS 0x5 285 #define ITASK_CMD_POLL 0x10 286 #define ITASK_CMD_POLL_LU (ITASK_CMD_POLL | 1) 287 #define ITASK_CMD_POLL_LPORT (ITASK_CMD_POLL | 2) 288 289 /* 290 * struct maintained on a per itl basis when the lu registers ITL handle. 291 */ 292 typedef struct stmf_itl_data { 293 uint32_t itl_counter; 294 uint8_t itl_flags; 295 uint8_t itl_hdlrm_reason; 296 uint16_t itl_lun; 297 char *itl_kstat_strbuf; 298 int itl_kstat_strbuflen; 299 kstat_t *itl_kstat_info; 300 kstat_t *itl_kstat_taskq; 301 kstat_t *itl_kstat_lu_xfer; 302 kstat_t *itl_kstat_lport_xfer; 303 void *itl_handle; 304 struct stmf_i_lu *itl_ilu; 305 struct stmf_i_scsi_session *itl_session; 306 struct stmf_itl_data *itl_next; 307 } stmf_itl_data_t; 308 309 /* 310 * itl flags 311 */ 312 #define STMF_ITL_BEING_TERMINATED 0x01 313 314 /* 315 * data structures to maintain provider private data. 316 */ 317 typedef struct stmf_pp_data { 318 struct stmf_pp_data *ppd_next; 319 void *ppd_provider; 320 nvlist_t *ppd_nv; 321 uint32_t ppd_lu_provider:1, 322 ppd_port_provider:1, 323 ppd_rsvd:30; 324 uint32_t ppd_alloc_size; 325 uint64_t ppd_token; 326 char ppd_name[8]; 327 } stmf_pp_data_t; 328 329 typedef struct stmf_worker { 330 kthread_t *worker_tid; 331 stmf_i_scsi_task_t *worker_task_head; 332 stmf_i_scsi_task_t *worker_task_tail; 333 stmf_i_scsi_task_t *worker_wait_head; 334 stmf_i_scsi_task_t *worker_wait_tail; 335 kmutex_t worker_lock; 336 kcondvar_t worker_cv; 337 uint32_t worker_flags; 338 uint32_t worker_queue_depth; /* ntasks cur queued */ 339 uint32_t worker_max_qdepth_pu; /* maxqd / unit time */ 340 uint32_t worker_max_sys_qdepth_pu; /* for all workers */ 341 uint32_t worker_ref_count; /* # IOs referencing */ 342 hrtime_t worker_signal_timestamp; 343 } stmf_worker_t; 344 345 /* 346 * worker flags 347 */ 348 #define STMF_WORKER_STARTED 1 349 #define STMF_WORKER_ACTIVE 2 350 #define STMF_WORKER_TERMINATE 4 351 352 /* 353 * data struct for managing transfers. 354 */ 355 typedef struct stmf_xfer_data { 356 uint32_t alloc_size; /* Including this struct */ 357 uint32_t size_done; 358 uint32_t size_left; 359 uint8_t buf[4]; 360 } stmf_xfer_data_t; 361 362 /* 363 * Define frequently used macros 364 */ 365 #define TASK_TO_ITASK(x_task) \ 366 ((stmf_i_scsi_task_t *)(x_task)->task_stmf_private) 367 368 void stmf_dlun_init(); 369 stmf_status_t stmf_dlun_fini(); 370 void stmf_worker_init(); 371 stmf_status_t stmf_worker_fini(); 372 void stmf_task_free(scsi_task_t *task); 373 void stmf_do_task_abort(scsi_task_t *task); 374 void stmf_do_itl_dereg(stmf_lu_t *lu, stmf_itl_data_t *itl, 375 uint8_t hdlrm_reason); 376 void stmf_generate_lu_event(stmf_i_lu_t *ilu, int eventid, 377 void *arg, uint32_t flags); 378 void stmf_generate_lport_event(stmf_i_local_port_t *ilport, int eventid, 379 void *arg, uint32_t flags); 380 381 #ifdef __cplusplus 382 } 383 #endif 384 385 #endif /* _STMF_IMPL_H */ 386