blob: 35aa786f93da35a8fa1d6b8859ae6ced92f6ff9e [file] [log] [blame]
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -08001#ifndef TARGET_CORE_BASE_H
2#define TARGET_CORE_BASE_H
3
4#include <linux/in.h>
5#include <linux/configfs.h>
6#include <linux/dma-mapping.h>
7#include <linux/blkdev.h>
8#include <scsi/scsi_cmnd.h>
9#include <net/sock.h>
10#include <net/tcp.h>
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080011
Nicholas Bellingerfa495152011-07-22 08:24:22 +000012#define TARGET_CORE_MOD_VERSION "v4.1.0-rc1-ml"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080013
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080014/* Maximum Number of LUNs per Target Portal Group */
Andy Groverd0229ae2011-07-08 17:04:53 -070015/* Don't raise above 511 or REPORT_LUNS needs to handle >1 page */
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080016#define TRANSPORT_MAX_LUNS_PER_TPG 256
17/*
18 * By default we use 32-byte CDBs in TCM Core and subsystem plugin code.
19 *
20 * Note that both include/scsi/scsi_cmnd.h:MAX_COMMAND_SIZE and
21 * include/linux/blkdev.h:BLOCK_MAX_CDB as of v2.6.36-rc4 still use
22 * 16-byte CDBs by default and require an extra allocation for
Lucas De Marchi25985ed2011-03-30 22:57:33 -030023 * 32-byte CDBs to because of legacy issues.
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080024 *
25 * Within TCM Core there are no such legacy limitiations, so we go ahead
26 * use 32-byte CDBs by default and use include/scsi/scsi.h:scsi_command_size()
27 * within all TCM Core and subsystem plugin code.
28 */
29#define TCM_MAX_COMMAND_SIZE 32
30/*
31 * From include/scsi/scsi_cmnd.h:SCSI_SENSE_BUFFERSIZE, currently
32 * defined 96, but the real limit is 252 (or 260 including the header)
33 */
34#define TRANSPORT_SENSE_BUFFER SCSI_SENSE_BUFFERSIZE
35/* Used by transport_send_check_condition_and_sense() */
36#define SPC_SENSE_KEY_OFFSET 2
37#define SPC_ASC_KEY_OFFSET 12
38#define SPC_ASCQ_KEY_OFFSET 13
39#define TRANSPORT_IQN_LEN 224
40/* Used by target_core_store_alua_lu_gp() and target_core_alua_lu_gp_show_attr_members() */
41#define LU_GROUP_NAME_BUF 256
42/* Used by core_alua_store_tg_pt_gp_info() and target_core_alua_tg_pt_gp_show_attr_members() */
43#define TG_PT_GROUP_NAME_BUF 256
44/* Used to parse VPD into struct t10_vpd */
45#define VPD_TMP_BUF_SIZE 128
46/* Used by transport_generic_cmd_sequencer() */
47#define READ_BLOCK_LEN 6
48#define READ_CAP_LEN 8
49#define READ_POSITION_LEN 20
50#define INQUIRY_LEN 36
51/* Used by transport_get_inquiry_vpd_serial() */
52#define INQUIRY_VPD_SERIAL_LEN 254
53/* Used by transport_get_inquiry_vpd_device_ident() */
54#define INQUIRY_VPD_DEVICE_IDENTIFIER_LEN 254
55
56/* struct se_hba->hba_flags */
57enum hba_flags_table {
58 HBA_FLAGS_INTERNAL_USE = 0x01,
59 HBA_FLAGS_PSCSI_MODE = 0x02,
60};
61
62/* struct se_lun->lun_status */
63enum transport_lun_status_table {
64 TRANSPORT_LUN_STATUS_FREE = 0,
65 TRANSPORT_LUN_STATUS_ACTIVE = 1,
66};
67
68/* struct se_portal_group->se_tpg_type */
69enum transport_tpg_type_table {
70 TRANSPORT_TPG_TYPE_NORMAL = 0,
71 TRANSPORT_TPG_TYPE_DISCOVERY = 1,
72};
73
74/* Used for generate timer flags */
Christoph Hellwig6c76bf92011-10-12 11:07:03 -040075enum se_task_flags {
76 TF_ACTIVE = (1 << 0),
77 TF_SENT = (1 << 1),
Nicholas Bellinger2e982ab2011-10-23 18:46:36 -070078 TF_REQUEST_STOP = (1 << 2),
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080079};
80
81/* Special transport agnostic struct se_cmd->t_states */
82enum transport_state_table {
83 TRANSPORT_NO_STATE = 0,
84 TRANSPORT_NEW_CMD = 1,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080085 TRANSPORT_WRITE_PENDING = 3,
86 TRANSPORT_PROCESS_WRITE = 4,
87 TRANSPORT_PROCESSING = 5,
Christoph Hellwig35e0e752011-10-17 13:56:53 -040088 TRANSPORT_COMPLETE = 6,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080089 TRANSPORT_PROCESS_TMR = 9,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080090 TRANSPORT_ISTATE_PROCESSING = 11,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080091 TRANSPORT_NEW_CMD_MAP = 16,
Nicholas Bellingerf4366772011-05-19 20:19:11 -070092 TRANSPORT_FREE_CMD_INTR = 17,
Nicholas Bellinger07bde792011-06-13 14:46:09 -070093 TRANSPORT_COMPLETE_QF_WP = 18,
Christoph Hellwige057f532011-10-17 13:56:41 -040094 TRANSPORT_COMPLETE_QF_OK = 19,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080095};
96
97/* Used for struct se_cmd->se_cmd_flags */
98enum se_cmd_flags_table {
99 SCF_SUPPORTED_SAM_OPCODE = 0x00000001,
100 SCF_TRANSPORT_TASK_SENSE = 0x00000002,
101 SCF_EMULATED_TASK_SENSE = 0x00000004,
102 SCF_SCSI_DATA_SG_IO_CDB = 0x00000008,
103 SCF_SCSI_CONTROL_SG_IO_CDB = 0x00000010,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800104 SCF_SCSI_NON_DATA_CDB = 0x00000040,
105 SCF_SCSI_CDB_EXCEPTION = 0x00000080,
106 SCF_SCSI_RESERVATION_CONFLICT = 0x00000100,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800107 SCF_SE_CMD_FAILED = 0x00000400,
108 SCF_SE_LUN_CMD = 0x00000800,
109 SCF_SE_ALLOW_EOO = 0x00001000,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800110 SCF_SENT_CHECK_CONDITION = 0x00004000,
111 SCF_OVERFLOW_BIT = 0x00008000,
112 SCF_UNDERFLOW_BIT = 0x00010000,
113 SCF_SENT_DELAYED_TAS = 0x00020000,
114 SCF_ALUA_NON_OPTIMIZED = 0x00040000,
115 SCF_DELAYED_CMD_FROM_SAM_ATTR = 0x00080000,
Andy Grover5951146d2011-07-19 10:26:37 +0000116 SCF_UNUSED = 0x00100000,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800117 SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC = 0x00400000,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800118 SCF_EMULATE_CDB_ASYNC = 0x01000000,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800119};
120
121/* struct se_dev_entry->lun_flags and struct se_lun->lun_access */
122enum transport_lunflags_table {
123 TRANSPORT_LUNFLAGS_NO_ACCESS = 0x00,
124 TRANSPORT_LUNFLAGS_INITIATOR_ACCESS = 0x01,
125 TRANSPORT_LUNFLAGS_READ_ONLY = 0x02,
126 TRANSPORT_LUNFLAGS_READ_WRITE = 0x04,
127};
128
129/* struct se_device->dev_status */
130enum transport_device_status_table {
131 TRANSPORT_DEVICE_ACTIVATED = 0x01,
132 TRANSPORT_DEVICE_DEACTIVATED = 0x02,
133 TRANSPORT_DEVICE_QUEUE_FULL = 0x04,
134 TRANSPORT_DEVICE_SHUTDOWN = 0x08,
135 TRANSPORT_DEVICE_OFFLINE_ACTIVATED = 0x10,
136 TRANSPORT_DEVICE_OFFLINE_DEACTIVATED = 0x20,
137};
138
139/*
140 * Used by transport_send_check_condition_and_sense() and se_cmd->scsi_sense_reason
141 * to signal which ASC/ASCQ sense payload should be built.
142 */
143enum tcm_sense_reason_table {
144 TCM_NON_EXISTENT_LUN = 0x01,
145 TCM_UNSUPPORTED_SCSI_OPCODE = 0x02,
146 TCM_INCORRECT_AMOUNT_OF_DATA = 0x03,
147 TCM_UNEXPECTED_UNSOLICITED_DATA = 0x04,
148 TCM_SERVICE_CRC_ERROR = 0x05,
149 TCM_SNACK_REJECTED = 0x06,
150 TCM_SECTOR_COUNT_TOO_MANY = 0x07,
151 TCM_INVALID_CDB_FIELD = 0x08,
152 TCM_INVALID_PARAMETER_LIST = 0x09,
153 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE = 0x0a,
154 TCM_UNKNOWN_MODE_PAGE = 0x0b,
155 TCM_WRITE_PROTECTED = 0x0c,
156 TCM_CHECK_CONDITION_ABORT_CMD = 0x0d,
157 TCM_CHECK_CONDITION_UNIT_ATTENTION = 0x0e,
158 TCM_CHECK_CONDITION_NOT_READY = 0x0f,
159};
160
161struct se_obj {
162 atomic_t obj_access_count;
163} ____cacheline_aligned;
164
165/*
166 * Used by TCM Core internally to signal if ALUA emulation is enabled or
167 * disabled, or running in with TCM/pSCSI passthrough mode
168 */
169typedef enum {
170 SPC_ALUA_PASSTHROUGH,
171 SPC2_ALUA_DISABLED,
172 SPC3_ALUA_EMULATED
173} t10_alua_index_t;
174
175/*
176 * Used by TCM Core internally to signal if SAM Task Attribute emulation
177 * is enabled or disabled, or running in with TCM/pSCSI passthrough mode
178 */
179typedef enum {
180 SAM_TASK_ATTR_PASSTHROUGH,
181 SAM_TASK_ATTR_UNTAGGED,
182 SAM_TASK_ATTR_EMULATED
183} t10_task_attr_index_t;
184
Nicholas Bellingere89d15e2011-02-09 15:35:03 -0800185/*
186 * Used for target SCSI statistics
187 */
188typedef enum {
189 SCSI_INST_INDEX,
190 SCSI_DEVICE_INDEX,
191 SCSI_AUTH_INTR_INDEX,
192 SCSI_INDEX_TYPE_MAX
193} scsi_index_t;
194
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800195struct se_cmd;
196
197struct t10_alua {
198 t10_alua_index_t alua_type;
199 /* ALUA Target Port Group ID */
200 u16 alua_tg_pt_gps_counter;
201 u32 alua_tg_pt_gps_count;
202 spinlock_t tg_pt_gps_lock;
203 struct se_subsystem_dev *t10_sub_dev;
204 /* Used for default ALUA Target Port Group */
205 struct t10_alua_tg_pt_gp *default_tg_pt_gp;
206 /* Used for default ALUA Target Port Group ConfigFS group */
207 struct config_group alua_tg_pt_gps_group;
208 int (*alua_state_check)(struct se_cmd *, unsigned char *, u8 *);
209 struct list_head tg_pt_gps_list;
210} ____cacheline_aligned;
211
212struct t10_alua_lu_gp {
213 u16 lu_gp_id;
214 int lu_gp_valid_id;
215 u32 lu_gp_members;
216 atomic_t lu_gp_shutdown;
217 atomic_t lu_gp_ref_cnt;
218 spinlock_t lu_gp_lock;
219 struct config_group lu_gp_group;
Andy Grovere3d6f902011-07-19 08:55:10 +0000220 struct list_head lu_gp_node;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800221 struct list_head lu_gp_mem_list;
222} ____cacheline_aligned;
223
224struct t10_alua_lu_gp_member {
Dan Carpenter5dd7ed22011-03-14 04:06:01 -0700225 bool lu_gp_assoc;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800226 atomic_t lu_gp_mem_ref_cnt;
227 spinlock_t lu_gp_mem_lock;
228 struct t10_alua_lu_gp *lu_gp;
229 struct se_device *lu_gp_mem_dev;
230 struct list_head lu_gp_mem_list;
231} ____cacheline_aligned;
232
233struct t10_alua_tg_pt_gp {
234 u16 tg_pt_gp_id;
235 int tg_pt_gp_valid_id;
236 int tg_pt_gp_alua_access_status;
237 int tg_pt_gp_alua_access_type;
238 int tg_pt_gp_nonop_delay_msecs;
239 int tg_pt_gp_trans_delay_msecs;
240 int tg_pt_gp_pref;
241 int tg_pt_gp_write_metadata;
242 /* Used by struct t10_alua_tg_pt_gp->tg_pt_gp_md_buf_len */
243#define ALUA_MD_BUF_LEN 1024
244 u32 tg_pt_gp_md_buf_len;
245 u32 tg_pt_gp_members;
246 atomic_t tg_pt_gp_alua_access_state;
247 atomic_t tg_pt_gp_ref_cnt;
248 spinlock_t tg_pt_gp_lock;
249 struct mutex tg_pt_gp_md_mutex;
250 struct se_subsystem_dev *tg_pt_gp_su_dev;
251 struct config_group tg_pt_gp_group;
252 struct list_head tg_pt_gp_list;
253 struct list_head tg_pt_gp_mem_list;
254} ____cacheline_aligned;
255
256struct t10_alua_tg_pt_gp_member {
Dan Carpenter5dd7ed22011-03-14 04:06:01 -0700257 bool tg_pt_gp_assoc;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800258 atomic_t tg_pt_gp_mem_ref_cnt;
259 spinlock_t tg_pt_gp_mem_lock;
260 struct t10_alua_tg_pt_gp *tg_pt_gp;
261 struct se_port *tg_pt;
262 struct list_head tg_pt_gp_mem_list;
263} ____cacheline_aligned;
264
265struct t10_vpd {
266 unsigned char device_identifier[INQUIRY_VPD_DEVICE_IDENTIFIER_LEN];
267 int protocol_identifier_set;
268 u32 protocol_identifier;
269 u32 device_identifier_code_set;
270 u32 association;
271 u32 device_identifier_type;
272 struct list_head vpd_list;
273} ____cacheline_aligned;
274
275struct t10_wwn {
Andy Grovere3d6f902011-07-19 08:55:10 +0000276 char vendor[8];
277 char model[16];
278 char revision[4];
279 char unit_serial[INQUIRY_VPD_SERIAL_LEN];
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800280 spinlock_t t10_vpd_lock;
281 struct se_subsystem_dev *t10_sub_dev;
282 struct config_group t10_wwn_group;
283 struct list_head t10_vpd_list;
284} ____cacheline_aligned;
285
286
287/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300288 * Used by TCM Core internally to signal if >= SPC-3 persistent reservations
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800289 * emulation is enabled or disabled, or running in with TCM/pSCSI passthrough
290 * mode
291 */
292typedef enum {
293 SPC_PASSTHROUGH,
294 SPC2_RESERVATIONS,
295 SPC3_PERSISTENT_RESERVATIONS
296} t10_reservations_index_t;
297
298struct t10_pr_registration {
299 /* Used for fabrics that contain WWN+ISID */
300#define PR_REG_ISID_LEN 16
301 /* PR_REG_ISID_LEN + ',i,0x' */
302#define PR_REG_ISID_ID_LEN (PR_REG_ISID_LEN + 5)
303 char pr_reg_isid[PR_REG_ISID_LEN];
304 /* Used during APTPL metadata reading */
305#define PR_APTPL_MAX_IPORT_LEN 256
306 unsigned char pr_iport[PR_APTPL_MAX_IPORT_LEN];
307 /* Used during APTPL metadata reading */
308#define PR_APTPL_MAX_TPORT_LEN 256
309 unsigned char pr_tport[PR_APTPL_MAX_TPORT_LEN];
310 /* For writing out live meta data */
311 unsigned char *pr_aptpl_buf;
312 u16 pr_aptpl_rpti;
313 u16 pr_reg_tpgt;
314 /* Reservation effects all target ports */
315 int pr_reg_all_tg_pt;
316 /* Activate Persistence across Target Power Loss */
317 int pr_reg_aptpl;
318 int pr_res_holder;
319 int pr_res_type;
320 int pr_res_scope;
321 /* Used for fabric initiator WWPNs using a ISID */
Dan Carpenter5dd7ed22011-03-14 04:06:01 -0700322 bool isid_present_at_reg;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800323 u32 pr_res_mapped_lun;
324 u32 pr_aptpl_target_lun;
325 u32 pr_res_generation;
326 u64 pr_reg_bin_isid;
327 u64 pr_res_key;
328 atomic_t pr_res_holders;
329 struct se_node_acl *pr_reg_nacl;
330 struct se_dev_entry *pr_reg_deve;
331 struct se_lun *pr_reg_tg_pt_lun;
332 struct list_head pr_reg_list;
333 struct list_head pr_reg_abort_list;
334 struct list_head pr_reg_aptpl_list;
335 struct list_head pr_reg_atp_list;
336 struct list_head pr_reg_atp_mem_list;
337} ____cacheline_aligned;
338
339/*
340 * This set of function pointer ops is set based upon SPC3_PERSISTENT_RESERVATIONS,
341 * SPC2_RESERVATIONS or SPC_PASSTHROUGH in drivers/target/target_core_pr.c:
342 * core_setup_reservations()
343 */
344struct t10_reservation_ops {
345 int (*t10_reservation_check)(struct se_cmd *, u32 *);
346 int (*t10_seq_non_holder)(struct se_cmd *, unsigned char *, u32);
347 int (*t10_pr_register)(struct se_cmd *);
348 int (*t10_pr_clear)(struct se_cmd *);
349};
350
Andy Grovere3d6f902011-07-19 08:55:10 +0000351struct t10_reservation {
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800352 /* Reservation effects all target ports */
353 int pr_all_tg_pt;
354 /* Activate Persistence across Target Power Loss enabled
355 * for SCSI device */
356 int pr_aptpl_active;
Andy Grovere3d6f902011-07-19 08:55:10 +0000357 /* Used by struct t10_reservation->pr_aptpl_buf_len */
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800358#define PR_APTPL_BUF_LEN 8192
359 u32 pr_aptpl_buf_len;
360 u32 pr_generation;
361 t10_reservations_index_t res_type;
362 spinlock_t registration_lock;
363 spinlock_t aptpl_reg_lock;
364 /*
365 * This will always be set by one individual I_T Nexus.
366 * However with all_tg_pt=1, other I_T Nexus from the
367 * same initiator can access PR reg/res info on a different
368 * target port.
369 *
370 * There is also the 'All Registrants' case, where there is
371 * a single *pr_res_holder of the reservation, but all
372 * registrations are considered reservation holders.
373 */
374 struct se_node_acl *pr_res_holder;
375 struct list_head registration_list;
376 struct list_head aptpl_reg_list;
377 struct t10_reservation_ops pr_ops;
378} ____cacheline_aligned;
379
380struct se_queue_req {
381 int state;
Andy Grovere3d6f902011-07-19 08:55:10 +0000382 struct se_cmd *cmd;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800383 struct list_head qr_list;
384} ____cacheline_aligned;
385
386struct se_queue_obj {
387 atomic_t queue_cnt;
388 spinlock_t cmd_queue_lock;
389 struct list_head qobj_list;
390 wait_queue_head_t thread_wq;
391} ____cacheline_aligned;
392
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800393struct se_task {
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800394 unsigned long long task_lba;
Christoph Hellwig3189b062011-10-12 11:07:07 -0400395 u32 task_sectors;
396 u32 task_size;
397 struct se_cmd *task_se_cmd;
398 struct scatterlist *task_sg;
Christoph Hellwig3189b062011-10-12 11:07:07 -0400399 u32 task_sg_nents;
400 u16 task_flags;
401 u8 task_sense;
402 u8 task_scsi_status;
403 int task_error_status;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800404 enum dma_data_direction task_data_direction;
Christoph Hellwig3189b062011-10-12 11:07:07 -0400405 atomic_t task_state_active;
Christoph Hellwig3189b062011-10-12 11:07:07 -0400406 struct list_head t_list;
407 struct list_head t_execute_list;
408 struct list_head t_state_list;
409 struct completion task_stop_comp;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800410} ____cacheline_aligned;
411
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800412struct se_cmd {
413 /* SAM response code being sent to initiator */
414 u8 scsi_status;
415 u8 scsi_asc;
416 u8 scsi_ascq;
417 u8 scsi_sense_reason;
418 u16 scsi_sense_length;
419 /* Delay for ALUA Active/NonOptimized state access in milliseconds */
420 int alua_nonop_delay;
421 /* See include/linux/dma-mapping.h */
422 enum dma_data_direction data_direction;
423 /* For SAM Task Attribute */
424 int sam_task_attr;
425 /* Transport protocol dependent state, see transport_state_table */
426 enum transport_state_table t_state;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800427 /* Transport specific error status */
428 int transport_error_status;
429 /* See se_cmd_flags_table */
430 u32 se_cmd_flags;
431 u32 se_ordered_id;
432 /* Total size in bytes associated with command */
433 u32 data_length;
434 /* SCSI Presented Data Transfer Length */
435 u32 cmd_spdtl;
436 u32 residual_count;
437 u32 orig_fe_lun;
438 /* Persistent Reservation key */
439 u64 pr_res_key;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800440 /* Used for sense data */
441 void *sense_buffer;
Andy Grover5951146d2011-07-19 10:26:37 +0000442 struct list_head se_delayed_node;
443 struct list_head se_ordered_node;
444 struct list_head se_lun_node;
Nicholas Bellinger07bde792011-06-13 14:46:09 -0700445 struct list_head se_qf_node;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800446 struct se_device *se_dev;
447 struct se_dev_entry *se_deve;
448 struct se_device *se_obj_ptr;
449 struct se_device *se_orig_obj_ptr;
450 struct se_lun *se_lun;
451 /* Only used for internal passthrough and legacy TCM fabric modules */
452 struct se_session *se_sess;
453 struct se_tmr_req *se_tmr_req;
Andy Grover5951146d2011-07-19 10:26:37 +0000454 struct list_head se_queue_node;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800455 struct target_core_fabric_ops *se_tfo;
456 int (*transport_emulate_cdb)(struct se_cmd *);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800457 void (*transport_complete_callback)(struct se_cmd *);
Nicholas Bellinger07bde792011-06-13 14:46:09 -0700458
Andy Grovera1d8b492011-05-02 17:12:10 -0700459 unsigned char *t_task_cdb;
460 unsigned char __t_task_cdb[TCM_MAX_COMMAND_SIZE];
461 unsigned long long t_task_lba;
462 int t_tasks_failed;
463 int t_tasks_fua;
464 bool t_tasks_bidi;
Andy Grovera1d8b492011-05-02 17:12:10 -0700465 u32 t_tasks_sg_chained_no;
466 atomic_t t_fe_count;
467 atomic_t t_se_count;
468 atomic_t t_task_cdbs_left;
469 atomic_t t_task_cdbs_ex_left;
Andy Grovera1d8b492011-05-02 17:12:10 -0700470 atomic_t t_task_cdbs_sent;
471 atomic_t t_transport_aborted;
472 atomic_t t_transport_active;
473 atomic_t t_transport_complete;
474 atomic_t t_transport_queue_active;
475 atomic_t t_transport_sent;
476 atomic_t t_transport_stop;
Andy Grovera1d8b492011-05-02 17:12:10 -0700477 atomic_t transport_dev_active;
478 atomic_t transport_lun_active;
479 atomic_t transport_lun_fe_stop;
480 atomic_t transport_lun_stop;
481 spinlock_t t_state_lock;
482 struct completion t_transport_stop_comp;
483 struct completion transport_lun_fe_stop_comp;
484 struct completion transport_lun_stop_comp;
485 struct scatterlist *t_tasks_sg_chained;
Andy Grover05d1c7c2011-07-20 19:13:28 +0000486
Christoph Hellwig35e0e752011-10-17 13:56:53 -0400487 struct work_struct work;
488
Andy Grovera1d8b492011-05-02 17:12:10 -0700489 /*
490 * Used for pre-registered fabric SGL passthrough WRITE and READ
491 * with the special SCF_PASSTHROUGH_CONTIG_TO_SG case for TCM_Loop
492 * and other HW target mode fabric modules.
493 */
494 struct scatterlist *t_task_pt_sgl;
495 u32 t_task_pt_sgl_num;
Andy Groverec98f782011-07-20 19:28:46 +0000496
497 struct scatterlist *t_data_sg;
498 unsigned int t_data_nents;
499 struct scatterlist *t_bidi_data_sg;
500 unsigned int t_bidi_data_nents;
501
Andy Grovera1d8b492011-05-02 17:12:10 -0700502 /* Used for BIDI READ */
Andy Grovera1d8b492011-05-02 17:12:10 -0700503 struct list_head t_task_list;
504 u32 t_task_list_num;
505
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800506} ____cacheline_aligned;
507
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800508struct se_tmr_req {
509 /* Task Management function to be preformed */
510 u8 function;
511 /* Task Management response to send */
512 u8 response;
513 int call_transport;
514 /* Reference to ITT that Task Mgmt should be preformed */
515 u32 ref_task_tag;
516 /* 64-bit encoded SAM LUN from $FABRIC_MOD TMR header */
517 u64 ref_task_lun;
518 void *fabric_tmr_ptr;
519 struct se_cmd *task_cmd;
520 struct se_cmd *ref_cmd;
521 struct se_device *tmr_dev;
522 struct se_lun *tmr_lun;
523 struct list_head tmr_list;
524} ____cacheline_aligned;
525
526struct se_ua {
527 u8 ua_asc;
528 u8 ua_ascq;
529 struct se_node_acl *ua_nacl;
530 struct list_head ua_dev_list;
531 struct list_head ua_nacl_list;
532} ____cacheline_aligned;
533
534struct se_node_acl {
535 char initiatorname[TRANSPORT_IQN_LEN];
536 /* Used to signal demo mode created ACL, disabled by default */
Dan Carpenter5dd7ed22011-03-14 04:06:01 -0700537 bool dynamic_node_acl;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800538 u32 queue_depth;
539 u32 acl_index;
540 u64 num_cmds;
541 u64 read_bytes;
542 u64 write_bytes;
543 spinlock_t stats_lock;
544 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
545 atomic_t acl_pr_ref_count;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800546 struct se_dev_entry *device_list;
547 struct se_session *nacl_sess;
548 struct se_portal_group *se_tpg;
549 spinlock_t device_list_lock;
550 spinlock_t nacl_sess_lock;
551 struct config_group acl_group;
552 struct config_group acl_attrib_group;
553 struct config_group acl_auth_group;
554 struct config_group acl_param_group;
Nicholas Bellinger12d2338422011-03-14 04:06:11 -0700555 struct config_group acl_fabric_stat_group;
556 struct config_group *acl_default_groups[5];
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800557 struct list_head acl_list;
558 struct list_head acl_sess_list;
559} ____cacheline_aligned;
560
561struct se_session {
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800562 u64 sess_bin_isid;
563 struct se_node_acl *se_node_acl;
564 struct se_portal_group *se_tpg;
565 void *fabric_sess_ptr;
566 struct list_head sess_list;
567 struct list_head sess_acl_list;
568} ____cacheline_aligned;
569
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800570struct se_device;
571struct se_transform_info;
572struct scatterlist;
573
Nicholas Bellinger12d2338422011-03-14 04:06:11 -0700574struct se_ml_stat_grps {
575 struct config_group stat_group;
576 struct config_group scsi_auth_intr_group;
577 struct config_group scsi_att_intr_port_group;
578};
579
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800580struct se_lun_acl {
581 char initiatorname[TRANSPORT_IQN_LEN];
582 u32 mapped_lun;
583 struct se_node_acl *se_lun_nacl;
584 struct se_lun *se_lun;
585 struct list_head lacl_list;
586 struct config_group se_lun_group;
Nicholas Bellinger12d2338422011-03-14 04:06:11 -0700587 struct se_ml_stat_grps ml_stat_grps;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800588} ____cacheline_aligned;
589
590struct se_dev_entry {
Dan Carpenter5dd7ed22011-03-14 04:06:01 -0700591 bool def_pr_registered;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800592 /* See transport_lunflags_table */
593 u32 lun_flags;
594 u32 deve_cmds;
595 u32 mapped_lun;
596 u32 average_bytes;
597 u32 last_byte_count;
598 u32 total_cmds;
599 u32 total_bytes;
600 u64 pr_res_key;
601 u64 creation_time;
602 u32 attach_count;
603 u64 read_bytes;
604 u64 write_bytes;
605 atomic_t ua_count;
606 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
607 atomic_t pr_ref_count;
608 struct se_lun_acl *se_lun_acl;
609 spinlock_t ua_lock;
610 struct se_lun *se_lun;
611 struct list_head alua_port_list;
612 struct list_head ua_list;
613} ____cacheline_aligned;
614
615struct se_dev_limits {
616 /* Max supported HW queue depth */
617 u32 hw_queue_depth;
618 /* Max supported virtual queue depth */
619 u32 queue_depth;
620 /* From include/linux/blkdev.h for the other HW/SW limits. */
621 struct queue_limits limits;
622} ____cacheline_aligned;
623
624struct se_dev_attrib {
625 int emulate_dpo;
626 int emulate_fua_write;
627 int emulate_fua_read;
628 int emulate_write_cache;
629 int emulate_ua_intlck_ctrl;
630 int emulate_tas;
631 int emulate_tpu;
632 int emulate_tpws;
633 int emulate_reservations;
634 int emulate_alua;
635 int enforce_pr_isids;
Roland Dreiere22a7f02011-07-05 13:34:52 -0700636 int is_nonrot;
Nicholas Bellinger5de619a2011-07-17 02:57:58 -0700637 int emulate_rest_reord;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800638 u32 hw_block_size;
639 u32 block_size;
640 u32 hw_max_sectors;
641 u32 max_sectors;
642 u32 optimal_sectors;
643 u32 hw_queue_depth;
644 u32 queue_depth;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800645 u32 max_unmap_lba_count;
646 u32 max_unmap_block_desc_count;
647 u32 unmap_granularity;
648 u32 unmap_granularity_alignment;
649 struct se_subsystem_dev *da_sub_dev;
650 struct config_group da_group;
651} ____cacheline_aligned;
652
Nicholas Bellinger12d2338422011-03-14 04:06:11 -0700653struct se_dev_stat_grps {
654 struct config_group stat_group;
655 struct config_group scsi_dev_group;
656 struct config_group scsi_tgt_dev_group;
657 struct config_group scsi_lu_group;
658};
659
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800660struct se_subsystem_dev {
661/* Used for struct se_subsystem_dev-->se_dev_alias, must be less than PAGE_SIZE */
662#define SE_DEV_ALIAS_LEN 512
663 unsigned char se_dev_alias[SE_DEV_ALIAS_LEN];
664/* Used for struct se_subsystem_dev->se_dev_udev_path[], must be less than PAGE_SIZE */
665#define SE_UDEV_PATH_LEN 512
666 unsigned char se_dev_udev_path[SE_UDEV_PATH_LEN];
667 u32 su_dev_flags;
668 struct se_hba *se_dev_hba;
669 struct se_device *se_dev_ptr;
670 struct se_dev_attrib se_dev_attrib;
671 /* T10 Asymmetric Logical Unit Assignment for Target Ports */
672 struct t10_alua t10_alua;
673 /* T10 Inquiry and VPD WWN Information */
674 struct t10_wwn t10_wwn;
675 /* T10 SPC-2 + SPC-3 Reservations */
Andy Grovere3d6f902011-07-19 08:55:10 +0000676 struct t10_reservation t10_pr;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800677 spinlock_t se_dev_lock;
678 void *se_dev_su_ptr;
Andy Grovere3d6f902011-07-19 08:55:10 +0000679 struct list_head se_dev_node;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800680 struct config_group se_dev_group;
681 /* For T10 Reservations */
682 struct config_group se_dev_pr_group;
Nicholas Bellinger12d2338422011-03-14 04:06:11 -0700683 /* For target_core_stat.c groups */
684 struct se_dev_stat_grps dev_stat_grps;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800685} ____cacheline_aligned;
686
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800687struct se_device {
688 /* Set to 1 if thread is NOT sleeping on thread_sem */
689 u8 thread_active;
690 u8 dev_status_timer_flags;
691 /* RELATIVE TARGET PORT IDENTIFER Counter */
692 u16 dev_rpti_counter;
693 /* Used for SAM Task Attribute ordering */
694 u32 dev_cur_ordered_id;
695 u32 dev_flags;
696 u32 dev_port_count;
697 /* See transport_device_status_table */
698 u32 dev_status;
699 u32 dev_tcq_window_closed;
700 /* Physical device queue depth */
701 u32 queue_depth;
702 /* Used for SPC-2 reservations enforce of ISIDs */
703 u64 dev_res_bin_isid;
704 t10_task_attr_index_t dev_task_attr_type;
705 /* Pointer to transport specific device structure */
706 void *dev_ptr;
707 u32 dev_index;
708 u64 creation_time;
709 u32 num_resets;
710 u64 num_cmds;
711 u64 read_bytes;
712 u64 write_bytes;
713 spinlock_t stats_lock;
714 /* Active commands on this virtual SE device */
715 atomic_t active_cmds;
716 atomic_t simple_cmds;
717 atomic_t depth_left;
718 atomic_t dev_ordered_id;
719 atomic_t dev_tur_active;
720 atomic_t execute_tasks;
721 atomic_t dev_status_thr_count;
722 atomic_t dev_hoq_count;
723 atomic_t dev_ordered_sync;
Nicholas Bellinger07bde792011-06-13 14:46:09 -0700724 atomic_t dev_qf_count;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800725 struct se_obj dev_obj;
726 struct se_obj dev_access_obj;
727 struct se_obj dev_export_obj;
Andy Grovere3d6f902011-07-19 08:55:10 +0000728 struct se_queue_obj dev_queue_obj;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800729 spinlock_t delayed_cmd_lock;
730 spinlock_t ordered_cmd_lock;
731 spinlock_t execute_task_lock;
732 spinlock_t state_task_lock;
733 spinlock_t dev_alua_lock;
734 spinlock_t dev_reservation_lock;
735 spinlock_t dev_state_lock;
736 spinlock_t dev_status_lock;
737 spinlock_t dev_status_thr_lock;
738 spinlock_t se_port_lock;
739 spinlock_t se_tmr_lock;
Nicholas Bellinger07bde792011-06-13 14:46:09 -0700740 spinlock_t qf_cmd_lock;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800741 /* Used for legacy SPC-2 reservationsa */
742 struct se_node_acl *dev_reserved_node_acl;
743 /* Used for ALUA Logical Unit Group membership */
744 struct t10_alua_lu_gp_member *dev_alua_lu_gp_mem;
745 /* Used for SPC-3 Persistent Reservations */
746 struct t10_pr_registration *dev_pr_res_holder;
747 struct list_head dev_sep_list;
748 struct list_head dev_tmr_list;
749 struct timer_list dev_status_timer;
750 /* Pointer to descriptor for processing thread */
751 struct task_struct *process_thread;
752 pid_t process_thread_pid;
753 struct task_struct *dev_mgmt_thread;
Nicholas Bellinger07bde792011-06-13 14:46:09 -0700754 struct work_struct qf_work_queue;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800755 struct list_head delayed_cmd_list;
756 struct list_head ordered_cmd_list;
757 struct list_head execute_task_list;
758 struct list_head state_task_list;
Nicholas Bellinger07bde792011-06-13 14:46:09 -0700759 struct list_head qf_cmd_list;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800760 /* Pointer to associated SE HBA */
761 struct se_hba *se_hba;
762 struct se_subsystem_dev *se_sub_dev;
763 /* Pointer to template of function pointers for transport */
764 struct se_subsystem_api *transport;
765 /* Linked list for struct se_hba struct se_device list */
766 struct list_head dev_list;
767 /* Linked list for struct se_global->g_se_dev_list */
768 struct list_head g_se_dev_list;
769} ____cacheline_aligned;
770
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800771struct se_hba {
772 u16 hba_tpgt;
773 u32 hba_id;
774 /* See hba_flags_table */
775 u32 hba_flags;
776 /* Virtual iSCSI devices attached. */
777 u32 dev_count;
778 u32 hba_index;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800779 /* Pointer to transport specific host structure. */
780 void *hba_ptr;
781 /* Linked list for struct se_device */
782 struct list_head hba_dev_list;
Andy Grovere3d6f902011-07-19 08:55:10 +0000783 struct list_head hba_node;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800784 spinlock_t device_lock;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800785 struct config_group hba_group;
786 struct mutex hba_access_mutex;
787 struct se_subsystem_api *transport;
788} ____cacheline_aligned;
789
Nicholas Bellinger12d2338422011-03-14 04:06:11 -0700790struct se_port_stat_grps {
791 struct config_group stat_group;
792 struct config_group scsi_port_group;
793 struct config_group scsi_tgt_port_group;
794 struct config_group scsi_transport_group;
795};
796
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800797struct se_lun {
798 /* See transport_lun_status_table */
799 enum transport_lun_status_table lun_status;
800 u32 lun_access;
801 u32 lun_flags;
802 u32 unpacked_lun;
803 atomic_t lun_acl_count;
804 spinlock_t lun_acl_lock;
805 spinlock_t lun_cmd_lock;
806 spinlock_t lun_sep_lock;
807 struct completion lun_shutdown_comp;
808 struct list_head lun_cmd_list;
809 struct list_head lun_acl_list;
810 struct se_device *lun_se_dev;
Nicholas Bellinger12d2338422011-03-14 04:06:11 -0700811 struct se_port *lun_sep;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800812 struct config_group lun_group;
Nicholas Bellinger12d2338422011-03-14 04:06:11 -0700813 struct se_port_stat_grps port_stat_grps;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800814} ____cacheline_aligned;
815
Nicholas Bellingere89d15e2011-02-09 15:35:03 -0800816struct scsi_port_stats {
817 u64 cmd_pdus;
818 u64 tx_data_octets;
819 u64 rx_data_octets;
820} ____cacheline_aligned;
821
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800822struct se_port {
823 /* RELATIVE TARGET PORT IDENTIFER */
824 u16 sep_rtpi;
825 int sep_tg_pt_secondary_stat;
826 int sep_tg_pt_secondary_write_md;
827 u32 sep_index;
828 struct scsi_port_stats sep_stats;
829 /* Used for ALUA Target Port Groups membership */
830 atomic_t sep_tg_pt_gp_active;
831 atomic_t sep_tg_pt_secondary_offline;
832 /* Used for PR ALL_TG_PT=1 */
833 atomic_t sep_tg_pt_ref_cnt;
834 spinlock_t sep_alua_lock;
835 struct mutex sep_tg_pt_md_mutex;
836 struct t10_alua_tg_pt_gp_member *sep_alua_tg_pt_gp_mem;
837 struct se_lun *sep_lun;
838 struct se_portal_group *sep_tpg;
839 struct list_head sep_alua_list;
840 struct list_head sep_list;
841} ____cacheline_aligned;
842
843struct se_tpg_np {
Nicholas Bellinger1f6fe7c2011-02-09 15:34:54 -0800844 struct se_portal_group *tpg_np_parent;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800845 struct config_group tpg_np_group;
846} ____cacheline_aligned;
847
848struct se_portal_group {
849 /* Type of target portal group, see transport_tpg_type_table */
850 enum transport_tpg_type_table se_tpg_type;
851 /* Number of ACLed Initiator Nodes for this TPG */
852 u32 num_node_acls;
853 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
854 atomic_t tpg_pr_ref_count;
855 /* Spinlock for adding/removing ACLed Nodes */
856 spinlock_t acl_node_lock;
857 /* Spinlock for adding/removing sessions */
858 spinlock_t session_lock;
859 spinlock_t tpg_lun_lock;
860 /* Pointer to $FABRIC_MOD portal group */
861 void *se_tpg_fabric_ptr;
Andy Grovere3d6f902011-07-19 08:55:10 +0000862 struct list_head se_tpg_node;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800863 /* linked list for initiator ACL list */
864 struct list_head acl_node_list;
865 struct se_lun *tpg_lun_list;
866 struct se_lun tpg_virt_lun0;
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300867 /* List of TCM sessions associated wth this TPG */
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800868 struct list_head tpg_sess_list;
869 /* Pointer to $FABRIC_MOD dependent code */
870 struct target_core_fabric_ops *se_tpg_tfo;
871 struct se_wwn *se_tpg_wwn;
872 struct config_group tpg_group;
873 struct config_group *tpg_default_groups[6];
874 struct config_group tpg_lun_group;
875 struct config_group tpg_np_group;
876 struct config_group tpg_acl_group;
877 struct config_group tpg_attrib_group;
878 struct config_group tpg_param_group;
879} ____cacheline_aligned;
880
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800881struct se_wwn {
882 struct target_fabric_configfs *wwn_tf;
883 struct config_group wwn_group;
Nicholas Bellinger12d2338422011-03-14 04:06:11 -0700884 struct config_group *wwn_default_groups[2];
885 struct config_group fabric_stat_group;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800886} ____cacheline_aligned;
887
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800888#endif /* TARGET_CORE_BASE_H */