target: Remove obsolete DF_READ_ONLY usage
[deliverable/linux.git] / include / target / target_core_base.h
CommitLineData
c66ac9db
NB
1#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>
c66ac9db 11
9765b1f3 12#define TARGET_CORE_MOD_VERSION "v4.1.0-rc2-ml"
c4795fb2 13#define TARGET_CORE_VERSION TARGET_CORE_MOD_VERSION
c66ac9db 14
c66ac9db 15/* Maximum Number of LUNs per Target Portal Group */
d0229ae3 16/* Don't raise above 511 or REPORT_LUNS needs to handle >1 page */
c66ac9db
NB
17#define TRANSPORT_MAX_LUNS_PER_TPG 256
18/*
19 * By default we use 32-byte CDBs in TCM Core and subsystem plugin code.
20 *
21 * Note that both include/scsi/scsi_cmnd.h:MAX_COMMAND_SIZE and
22 * include/linux/blkdev.h:BLOCK_MAX_CDB as of v2.6.36-rc4 still use
23 * 16-byte CDBs by default and require an extra allocation for
25985edc 24 * 32-byte CDBs to because of legacy issues.
c66ac9db
NB
25 *
26 * Within TCM Core there are no such legacy limitiations, so we go ahead
27 * use 32-byte CDBs by default and use include/scsi/scsi.h:scsi_command_size()
28 * within all TCM Core and subsystem plugin code.
29 */
30#define TCM_MAX_COMMAND_SIZE 32
31/*
32 * From include/scsi/scsi_cmnd.h:SCSI_SENSE_BUFFERSIZE, currently
33 * defined 96, but the real limit is 252 (or 260 including the header)
34 */
35#define TRANSPORT_SENSE_BUFFER SCSI_SENSE_BUFFERSIZE
36/* Used by transport_send_check_condition_and_sense() */
37#define SPC_SENSE_KEY_OFFSET 2
895f3022 38#define SPC_ADD_SENSE_LEN_OFFSET 7
c66ac9db
NB
39#define SPC_ASC_KEY_OFFSET 12
40#define SPC_ASCQ_KEY_OFFSET 13
41#define TRANSPORT_IQN_LEN 224
42/* Used by target_core_store_alua_lu_gp() and target_core_alua_lu_gp_show_attr_members() */
43#define LU_GROUP_NAME_BUF 256
44/* Used by core_alua_store_tg_pt_gp_info() and target_core_alua_tg_pt_gp_show_attr_members() */
45#define TG_PT_GROUP_NAME_BUF 256
46/* Used to parse VPD into struct t10_vpd */
47#define VPD_TMP_BUF_SIZE 128
48/* Used by transport_generic_cmd_sequencer() */
49#define READ_BLOCK_LEN 6
50#define READ_CAP_LEN 8
51#define READ_POSITION_LEN 20
52#define INQUIRY_LEN 36
53/* Used by transport_get_inquiry_vpd_serial() */
54#define INQUIRY_VPD_SERIAL_LEN 254
55/* Used by transport_get_inquiry_vpd_device_ident() */
56#define INQUIRY_VPD_DEVICE_IDENTIFIER_LEN 254
57
c4795fb2
CH
58/* Attempts before moving from SHORT to LONG */
59#define PYX_TRANSPORT_WINDOW_CLOSED_THRESHOLD 3
60#define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_SHORT 3 /* In milliseconds */
61#define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_LONG 10 /* In milliseconds */
62
63#define PYX_TRANSPORT_STATUS_INTERVAL 5 /* In seconds */
64
65/*
66 * struct se_subsystem_dev->su_dev_flags
67*/
68#define SDF_FIRMWARE_VPD_UNIT_SERIAL 0x00000001
69#define SDF_EMULATED_VPD_UNIT_SERIAL 0x00000002
70#define SDF_USING_UDEV_PATH 0x00000004
71#define SDF_USING_ALIAS 0x00000008
72
73/*
74 * struct se_device->dev_flags
75 */
58d92618
NB
76#define DF_SPC2_RESERVATIONS 0x00000001
77#define DF_SPC2_RESERVATIONS_WITH_ISID 0x00000002
c4795fb2
CH
78
79/* struct se_dev_attrib sanity values */
80/* Default max_unmap_lba_count */
81#define DA_MAX_UNMAP_LBA_COUNT 0
82/* Default max_unmap_block_desc_count */
83#define DA_MAX_UNMAP_BLOCK_DESC_COUNT 0
84/* Default unmap_granularity */
85#define DA_UNMAP_GRANULARITY_DEFAULT 0
86/* Default unmap_granularity_alignment */
87#define DA_UNMAP_GRANULARITY_ALIGNMENT_DEFAULT 0
015487b8
RD
88/* Default max transfer length */
89#define DA_FABRIC_MAX_SECTORS 8192
c4795fb2
CH
90/* Emulation for Direct Page Out */
91#define DA_EMULATE_DPO 0
92/* Emulation for Forced Unit Access WRITEs */
93#define DA_EMULATE_FUA_WRITE 1
94/* Emulation for Forced Unit Access READs */
95#define DA_EMULATE_FUA_READ 0
96/* Emulation for WriteCache and SYNCHRONIZE_CACHE */
97#define DA_EMULATE_WRITE_CACHE 0
98/* Emulation for UNIT ATTENTION Interlock Control */
99#define DA_EMULATE_UA_INTLLCK_CTRL 0
100/* Emulation for TASK_ABORTED status (TAS) by default */
101#define DA_EMULATE_TAS 1
102/* Emulation for Thin Provisioning UNMAP using block/blk-lib.c:blkdev_issue_discard() */
103#define DA_EMULATE_TPU 0
104/*
105 * Emulation for Thin Provisioning WRITE_SAME w/ UNMAP=1 bit using
106 * block/blk-lib.c:blkdev_issue_discard()
107 */
108#define DA_EMULATE_TPWS 0
109/* No Emulation for PSCSI by default */
110#define DA_EMULATE_RESERVATIONS 0
111/* No Emulation for PSCSI by default */
112#define DA_EMULATE_ALUA 0
113/* Enforce SCSI Initiator Port TransportID with 'ISID' for PR */
114#define DA_ENFORCE_PR_ISIDS 1
115#define DA_STATUS_MAX_SECTORS_MIN 16
116#define DA_STATUS_MAX_SECTORS_MAX 8192
117/* By default don't report non-rotating (solid state) medium */
118#define DA_IS_NONROT 0
119/* Queue Algorithm Modifier default for restricted reordering in control mode page */
120#define DA_EMULATE_REST_REORD 0
121
d95b8246 122#define SE_INQUIRY_BUF 512
c4795fb2
CH
123#define SE_MODE_PAGE_BUF 512
124
c66ac9db
NB
125/* struct se_hba->hba_flags */
126enum hba_flags_table {
127 HBA_FLAGS_INTERNAL_USE = 0x01,
128 HBA_FLAGS_PSCSI_MODE = 0x02,
129};
130
131/* struct se_lun->lun_status */
132enum transport_lun_status_table {
133 TRANSPORT_LUN_STATUS_FREE = 0,
134 TRANSPORT_LUN_STATUS_ACTIVE = 1,
135};
136
137/* struct se_portal_group->se_tpg_type */
138enum transport_tpg_type_table {
139 TRANSPORT_TPG_TYPE_NORMAL = 0,
140 TRANSPORT_TPG_TYPE_DISCOVERY = 1,
141};
142
ef804a84 143/* struct se_task->task_flags */
6c76bf95
CH
144enum se_task_flags {
145 TF_ACTIVE = (1 << 0),
146 TF_SENT = (1 << 1),
2e982ab9 147 TF_REQUEST_STOP = (1 << 2),
ef804a84 148 TF_HAS_SENSE = (1 << 3),
c66ac9db
NB
149};
150
151/* Special transport agnostic struct se_cmd->t_states */
152enum transport_state_table {
153 TRANSPORT_NO_STATE = 0,
154 TRANSPORT_NEW_CMD = 1,
c66ac9db
NB
155 TRANSPORT_WRITE_PENDING = 3,
156 TRANSPORT_PROCESS_WRITE = 4,
157 TRANSPORT_PROCESSING = 5,
35e0e757 158 TRANSPORT_COMPLETE = 6,
c66ac9db 159 TRANSPORT_PROCESS_TMR = 9,
c66ac9db 160 TRANSPORT_ISTATE_PROCESSING = 11,
c66ac9db 161 TRANSPORT_NEW_CMD_MAP = 16,
07bde79a 162 TRANSPORT_COMPLETE_QF_WP = 18,
e057f533 163 TRANSPORT_COMPLETE_QF_OK = 19,
c66ac9db
NB
164};
165
166/* Used for struct se_cmd->se_cmd_flags */
167enum se_cmd_flags_table {
168 SCF_SUPPORTED_SAM_OPCODE = 0x00000001,
169 SCF_TRANSPORT_TASK_SENSE = 0x00000002,
170 SCF_EMULATED_TASK_SENSE = 0x00000004,
171 SCF_SCSI_DATA_SG_IO_CDB = 0x00000008,
172 SCF_SCSI_CONTROL_SG_IO_CDB = 0x00000010,
c8e31f26
AG
173 SCF_SCSI_NON_DATA_CDB = 0x00000020,
174 SCF_SCSI_TMR_CDB = 0x00000040,
c66ac9db
NB
175 SCF_SCSI_CDB_EXCEPTION = 0x00000080,
176 SCF_SCSI_RESERVATION_CONFLICT = 0x00000100,
2d3a4b51 177 SCF_FUA = 0x00000200,
c66ac9db
NB
178 SCF_SE_LUN_CMD = 0x00000800,
179 SCF_SE_ALLOW_EOO = 0x00001000,
33c3fafc 180 SCF_BIDI = 0x00002000,
c66ac9db
NB
181 SCF_SENT_CHECK_CONDITION = 0x00004000,
182 SCF_OVERFLOW_BIT = 0x00008000,
183 SCF_UNDERFLOW_BIT = 0x00010000,
184 SCF_SENT_DELAYED_TAS = 0x00020000,
185 SCF_ALUA_NON_OPTIMIZED = 0x00040000,
186 SCF_DELAYED_CMD_FROM_SAM_ATTR = 0x00080000,
5951146d 187 SCF_UNUSED = 0x00100000,
86715569
NB
188 SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC = 0x00200000,
189 SCF_ACK_KREF = 0x00400000,
c66ac9db
NB
190};
191
192/* struct se_dev_entry->lun_flags and struct se_lun->lun_access */
193enum transport_lunflags_table {
194 TRANSPORT_LUNFLAGS_NO_ACCESS = 0x00,
195 TRANSPORT_LUNFLAGS_INITIATOR_ACCESS = 0x01,
196 TRANSPORT_LUNFLAGS_READ_ONLY = 0x02,
197 TRANSPORT_LUNFLAGS_READ_WRITE = 0x04,
198};
199
200/* struct se_device->dev_status */
201enum transport_device_status_table {
202 TRANSPORT_DEVICE_ACTIVATED = 0x01,
203 TRANSPORT_DEVICE_DEACTIVATED = 0x02,
204 TRANSPORT_DEVICE_QUEUE_FULL = 0x04,
205 TRANSPORT_DEVICE_SHUTDOWN = 0x08,
206 TRANSPORT_DEVICE_OFFLINE_ACTIVATED = 0x10,
207 TRANSPORT_DEVICE_OFFLINE_DEACTIVATED = 0x20,
208};
209
210/*
211 * Used by transport_send_check_condition_and_sense() and se_cmd->scsi_sense_reason
212 * to signal which ASC/ASCQ sense payload should be built.
213 */
214enum tcm_sense_reason_table {
215 TCM_NON_EXISTENT_LUN = 0x01,
216 TCM_UNSUPPORTED_SCSI_OPCODE = 0x02,
217 TCM_INCORRECT_AMOUNT_OF_DATA = 0x03,
218 TCM_UNEXPECTED_UNSOLICITED_DATA = 0x04,
219 TCM_SERVICE_CRC_ERROR = 0x05,
220 TCM_SNACK_REJECTED = 0x06,
221 TCM_SECTOR_COUNT_TOO_MANY = 0x07,
222 TCM_INVALID_CDB_FIELD = 0x08,
223 TCM_INVALID_PARAMETER_LIST = 0x09,
224 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE = 0x0a,
225 TCM_UNKNOWN_MODE_PAGE = 0x0b,
226 TCM_WRITE_PROTECTED = 0x0c,
227 TCM_CHECK_CONDITION_ABORT_CMD = 0x0d,
228 TCM_CHECK_CONDITION_UNIT_ATTENTION = 0x0e,
229 TCM_CHECK_CONDITION_NOT_READY = 0x0f,
03e98c9e 230 TCM_RESERVATION_CONFLICT = 0x10,
c66ac9db
NB
231};
232
a6360785
NB
233enum target_sc_flags_table {
234 TARGET_SCF_BIDI_OP = 0x01,
235 TARGET_SCF_ACK_KREF = 0x02,
236};
237
c4795fb2
CH
238/* fabric independent task management function values */
239enum tcm_tmreq_table {
240 TMR_ABORT_TASK = 1,
241 TMR_ABORT_TASK_SET = 2,
242 TMR_CLEAR_ACA = 3,
243 TMR_CLEAR_TASK_SET = 4,
244 TMR_LUN_RESET = 5,
245 TMR_TARGET_WARM_RESET = 6,
246 TMR_TARGET_COLD_RESET = 7,
247 TMR_FABRIC_TMR = 255,
248};
249
250/* fabric independent task management response values */
251enum tcm_tmrsp_table {
252 TMR_FUNCTION_COMPLETE = 0,
253 TMR_TASK_DOES_NOT_EXIST = 1,
254 TMR_LUN_DOES_NOT_EXIST = 2,
255 TMR_TASK_STILL_ALLEGIANT = 3,
256 TMR_TASK_FAILOVER_NOT_SUPPORTED = 4,
257 TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED = 5,
258 TMR_FUNCTION_AUTHORIZATION_FAILED = 6,
259 TMR_FUNCTION_REJECTED = 255,
260};
261
c66ac9db
NB
262struct se_obj {
263 atomic_t obj_access_count;
e0a53e70 264};
c66ac9db
NB
265
266/*
267 * Used by TCM Core internally to signal if ALUA emulation is enabled or
268 * disabled, or running in with TCM/pSCSI passthrough mode
269 */
270typedef enum {
271 SPC_ALUA_PASSTHROUGH,
272 SPC2_ALUA_DISABLED,
273 SPC3_ALUA_EMULATED
274} t10_alua_index_t;
275
276/*
277 * Used by TCM Core internally to signal if SAM Task Attribute emulation
278 * is enabled or disabled, or running in with TCM/pSCSI passthrough mode
279 */
280typedef enum {
281 SAM_TASK_ATTR_PASSTHROUGH,
282 SAM_TASK_ATTR_UNTAGGED,
283 SAM_TASK_ATTR_EMULATED
284} t10_task_attr_index_t;
285
e89d15ee
NB
286/*
287 * Used for target SCSI statistics
288 */
289typedef enum {
290 SCSI_INST_INDEX,
291 SCSI_DEVICE_INDEX,
292 SCSI_AUTH_INTR_INDEX,
293 SCSI_INDEX_TYPE_MAX
294} scsi_index_t;
295
c66ac9db
NB
296struct se_cmd;
297
298struct t10_alua {
299 t10_alua_index_t alua_type;
300 /* ALUA Target Port Group ID */
301 u16 alua_tg_pt_gps_counter;
302 u32 alua_tg_pt_gps_count;
303 spinlock_t tg_pt_gps_lock;
304 struct se_subsystem_dev *t10_sub_dev;
305 /* Used for default ALUA Target Port Group */
306 struct t10_alua_tg_pt_gp *default_tg_pt_gp;
307 /* Used for default ALUA Target Port Group ConfigFS group */
308 struct config_group alua_tg_pt_gps_group;
309 int (*alua_state_check)(struct se_cmd *, unsigned char *, u8 *);
310 struct list_head tg_pt_gps_list;
e0a53e70 311};
c66ac9db
NB
312
313struct t10_alua_lu_gp {
314 u16 lu_gp_id;
315 int lu_gp_valid_id;
316 u32 lu_gp_members;
c66ac9db
NB
317 atomic_t lu_gp_ref_cnt;
318 spinlock_t lu_gp_lock;
319 struct config_group lu_gp_group;
e3d6f909 320 struct list_head lu_gp_node;
c66ac9db 321 struct list_head lu_gp_mem_list;
e0a53e70 322};
c66ac9db
NB
323
324struct t10_alua_lu_gp_member {
5dd7ed2e 325 bool lu_gp_assoc;
c66ac9db
NB
326 atomic_t lu_gp_mem_ref_cnt;
327 spinlock_t lu_gp_mem_lock;
328 struct t10_alua_lu_gp *lu_gp;
329 struct se_device *lu_gp_mem_dev;
330 struct list_head lu_gp_mem_list;
e0a53e70 331};
c66ac9db
NB
332
333struct t10_alua_tg_pt_gp {
334 u16 tg_pt_gp_id;
335 int tg_pt_gp_valid_id;
336 int tg_pt_gp_alua_access_status;
337 int tg_pt_gp_alua_access_type;
338 int tg_pt_gp_nonop_delay_msecs;
339 int tg_pt_gp_trans_delay_msecs;
340 int tg_pt_gp_pref;
341 int tg_pt_gp_write_metadata;
342 /* Used by struct t10_alua_tg_pt_gp->tg_pt_gp_md_buf_len */
343#define ALUA_MD_BUF_LEN 1024
344 u32 tg_pt_gp_md_buf_len;
345 u32 tg_pt_gp_members;
346 atomic_t tg_pt_gp_alua_access_state;
347 atomic_t tg_pt_gp_ref_cnt;
348 spinlock_t tg_pt_gp_lock;
349 struct mutex tg_pt_gp_md_mutex;
350 struct se_subsystem_dev *tg_pt_gp_su_dev;
351 struct config_group tg_pt_gp_group;
352 struct list_head tg_pt_gp_list;
353 struct list_head tg_pt_gp_mem_list;
e0a53e70 354};
c66ac9db
NB
355
356struct t10_alua_tg_pt_gp_member {
5dd7ed2e 357 bool tg_pt_gp_assoc;
c66ac9db
NB
358 atomic_t tg_pt_gp_mem_ref_cnt;
359 spinlock_t tg_pt_gp_mem_lock;
360 struct t10_alua_tg_pt_gp *tg_pt_gp;
361 struct se_port *tg_pt;
362 struct list_head tg_pt_gp_mem_list;
e0a53e70 363};
c66ac9db
NB
364
365struct t10_vpd {
366 unsigned char device_identifier[INQUIRY_VPD_DEVICE_IDENTIFIER_LEN];
367 int protocol_identifier_set;
368 u32 protocol_identifier;
369 u32 device_identifier_code_set;
370 u32 association;
371 u32 device_identifier_type;
372 struct list_head vpd_list;
e0a53e70 373};
c66ac9db
NB
374
375struct t10_wwn {
e3d6f909
AG
376 char vendor[8];
377 char model[16];
378 char revision[4];
379 char unit_serial[INQUIRY_VPD_SERIAL_LEN];
c66ac9db
NB
380 spinlock_t t10_vpd_lock;
381 struct se_subsystem_dev *t10_sub_dev;
382 struct config_group t10_wwn_group;
383 struct list_head t10_vpd_list;
e0a53e70 384};
c66ac9db
NB
385
386
387/*
25985edc 388 * Used by TCM Core internally to signal if >= SPC-3 persistent reservations
c66ac9db
NB
389 * emulation is enabled or disabled, or running in with TCM/pSCSI passthrough
390 * mode
391 */
392typedef enum {
393 SPC_PASSTHROUGH,
394 SPC2_RESERVATIONS,
395 SPC3_PERSISTENT_RESERVATIONS
396} t10_reservations_index_t;
397
398struct t10_pr_registration {
399 /* Used for fabrics that contain WWN+ISID */
400#define PR_REG_ISID_LEN 16
401 /* PR_REG_ISID_LEN + ',i,0x' */
402#define PR_REG_ISID_ID_LEN (PR_REG_ISID_LEN + 5)
403 char pr_reg_isid[PR_REG_ISID_LEN];
404 /* Used during APTPL metadata reading */
405#define PR_APTPL_MAX_IPORT_LEN 256
406 unsigned char pr_iport[PR_APTPL_MAX_IPORT_LEN];
407 /* Used during APTPL metadata reading */
408#define PR_APTPL_MAX_TPORT_LEN 256
409 unsigned char pr_tport[PR_APTPL_MAX_TPORT_LEN];
410 /* For writing out live meta data */
411 unsigned char *pr_aptpl_buf;
412 u16 pr_aptpl_rpti;
413 u16 pr_reg_tpgt;
414 /* Reservation effects all target ports */
415 int pr_reg_all_tg_pt;
416 /* Activate Persistence across Target Power Loss */
417 int pr_reg_aptpl;
418 int pr_res_holder;
419 int pr_res_type;
420 int pr_res_scope;
421 /* Used for fabric initiator WWPNs using a ISID */
5dd7ed2e 422 bool isid_present_at_reg;
c66ac9db
NB
423 u32 pr_res_mapped_lun;
424 u32 pr_aptpl_target_lun;
425 u32 pr_res_generation;
426 u64 pr_reg_bin_isid;
427 u64 pr_res_key;
428 atomic_t pr_res_holders;
429 struct se_node_acl *pr_reg_nacl;
430 struct se_dev_entry *pr_reg_deve;
431 struct se_lun *pr_reg_tg_pt_lun;
432 struct list_head pr_reg_list;
433 struct list_head pr_reg_abort_list;
434 struct list_head pr_reg_aptpl_list;
435 struct list_head pr_reg_atp_list;
436 struct list_head pr_reg_atp_mem_list;
e0a53e70 437};
c66ac9db
NB
438
439/*
440 * This set of function pointer ops is set based upon SPC3_PERSISTENT_RESERVATIONS,
441 * SPC2_RESERVATIONS or SPC_PASSTHROUGH in drivers/target/target_core_pr.c:
442 * core_setup_reservations()
443 */
444struct t10_reservation_ops {
445 int (*t10_reservation_check)(struct se_cmd *, u32 *);
446 int (*t10_seq_non_holder)(struct se_cmd *, unsigned char *, u32);
447 int (*t10_pr_register)(struct se_cmd *);
448 int (*t10_pr_clear)(struct se_cmd *);
449};
450
e3d6f909 451struct t10_reservation {
c66ac9db
NB
452 /* Reservation effects all target ports */
453 int pr_all_tg_pt;
454 /* Activate Persistence across Target Power Loss enabled
455 * for SCSI device */
456 int pr_aptpl_active;
e3d6f909 457 /* Used by struct t10_reservation->pr_aptpl_buf_len */
c66ac9db
NB
458#define PR_APTPL_BUF_LEN 8192
459 u32 pr_aptpl_buf_len;
460 u32 pr_generation;
461 t10_reservations_index_t res_type;
462 spinlock_t registration_lock;
463 spinlock_t aptpl_reg_lock;
464 /*
465 * This will always be set by one individual I_T Nexus.
466 * However with all_tg_pt=1, other I_T Nexus from the
467 * same initiator can access PR reg/res info on a different
468 * target port.
469 *
470 * There is also the 'All Registrants' case, where there is
471 * a single *pr_res_holder of the reservation, but all
472 * registrations are considered reservation holders.
473 */
474 struct se_node_acl *pr_res_holder;
475 struct list_head registration_list;
476 struct list_head aptpl_reg_list;
477 struct t10_reservation_ops pr_ops;
e0a53e70 478};
c66ac9db 479
c66ac9db
NB
480struct se_queue_obj {
481 atomic_t queue_cnt;
482 spinlock_t cmd_queue_lock;
483 struct list_head qobj_list;
484 wait_queue_head_t thread_wq;
e0a53e70 485};
c66ac9db 486
c66ac9db 487struct se_task {
c66ac9db 488 unsigned long long task_lba;
3189b067
CH
489 u32 task_sectors;
490 u32 task_size;
491 struct se_cmd *task_se_cmd;
492 struct scatterlist *task_sg;
3189b067
CH
493 u32 task_sg_nents;
494 u16 task_flags;
3189b067 495 u8 task_scsi_status;
c66ac9db 496 enum dma_data_direction task_data_direction;
3189b067
CH
497 struct list_head t_list;
498 struct list_head t_execute_list;
499 struct list_head t_state_list;
1880807a 500 bool t_state_active;
3189b067 501 struct completion task_stop_comp;
e0a53e70 502};
c66ac9db 503
c8e31f26
AG
504struct se_tmr_req {
505 /* Task Management function to be performed */
506 u8 function;
507 /* Task Management response to send */
508 u8 response;
509 int call_transport;
510 /* Reference to ITT that Task Mgmt should be performed */
511 u32 ref_task_tag;
512 /* 64-bit encoded SAM LUN from $FABRIC_MOD TMR header */
513 u64 ref_task_lun;
514 void *fabric_tmr_ptr;
515 struct se_cmd *task_cmd;
516 struct se_cmd *ref_cmd;
517 struct se_device *tmr_dev;
518 struct se_lun *tmr_lun;
519 struct list_head tmr_list;
520};
521
c66ac9db
NB
522struct se_cmd {
523 /* SAM response code being sent to initiator */
524 u8 scsi_status;
525 u8 scsi_asc;
526 u8 scsi_ascq;
527 u8 scsi_sense_reason;
528 u16 scsi_sense_length;
529 /* Delay for ALUA Active/NonOptimized state access in milliseconds */
530 int alua_nonop_delay;
531 /* See include/linux/dma-mapping.h */
532 enum dma_data_direction data_direction;
533 /* For SAM Task Attribute */
534 int sam_task_attr;
535 /* Transport protocol dependent state, see transport_state_table */
536 enum transport_state_table t_state;
a17f091d 537 /* Used to signal cmd->se_tfo->check_release_cmd() usage per cmd */
5f655e8d
BVA
538 unsigned check_release:1;
539 unsigned cmd_wait_set:1;
c66ac9db
NB
540 /* See se_cmd_flags_table */
541 u32 se_cmd_flags;
542 u32 se_ordered_id;
543 /* Total size in bytes associated with command */
544 u32 data_length;
545 /* SCSI Presented Data Transfer Length */
546 u32 cmd_spdtl;
547 u32 residual_count;
548 u32 orig_fe_lun;
549 /* Persistent Reservation key */
550 u64 pr_res_key;
c66ac9db
NB
551 /* Used for sense data */
552 void *sense_buffer;
5951146d 553 struct list_head se_delayed_node;
5951146d 554 struct list_head se_lun_node;
07bde79a 555 struct list_head se_qf_node;
c66ac9db
NB
556 struct se_device *se_dev;
557 struct se_dev_entry *se_deve;
c66ac9db
NB
558 struct se_lun *se_lun;
559 /* Only used for internal passthrough and legacy TCM fabric modules */
560 struct se_session *se_sess;
561 struct se_tmr_req *se_tmr_req;
5951146d 562 struct list_head se_queue_node;
a17f091d
NB
563 struct list_head se_cmd_list;
564 struct completion cmd_wait_comp;
7481deb4 565 struct kref cmd_kref;
c66ac9db 566 struct target_core_fabric_ops *se_tfo;
e76a35d6 567 int (*execute_task)(struct se_task *);
c66ac9db 568 void (*transport_complete_callback)(struct se_cmd *);
07bde79a 569
a1d8b49a
AG
570 unsigned char *t_task_cdb;
571 unsigned char __t_task_cdb[TCM_MAX_COMMAND_SIZE];
572 unsigned long long t_task_lba;
a1d8b49a
AG
573 u32 t_tasks_sg_chained_no;
574 atomic_t t_fe_count;
575 atomic_t t_se_count;
576 atomic_t t_task_cdbs_left;
577 atomic_t t_task_cdbs_ex_left;
a1d8b49a 578 atomic_t t_task_cdbs_sent;
7d680f3b
CH
579 unsigned int transport_state;
580#define CMD_T_ABORTED (1 << 0)
581#define CMD_T_ACTIVE (1 << 1)
582#define CMD_T_COMPLETE (1 << 2)
583#define CMD_T_QUEUED (1 << 3)
584#define CMD_T_SENT (1 << 4)
585#define CMD_T_STOP (1 << 5)
586#define CMD_T_FAILED (1 << 6)
587#define CMD_T_LUN_STOP (1 << 7)
588#define CMD_T_LUN_FE_STOP (1 << 8)
589#define CMD_T_DEV_ACTIVE (1 << 9)
a1d8b49a
AG
590 spinlock_t t_state_lock;
591 struct completion t_transport_stop_comp;
592 struct completion transport_lun_fe_stop_comp;
593 struct completion transport_lun_stop_comp;
594 struct scatterlist *t_tasks_sg_chained;
05d1c7c0 595
35e0e757
CH
596 struct work_struct work;
597
ec98f782
AG
598 struct scatterlist *t_data_sg;
599 unsigned int t_data_nents;
4949314c 600 void *t_data_vmap;
ec98f782
AG
601 struct scatterlist *t_bidi_data_sg;
602 unsigned int t_bidi_data_nents;
603
a1d8b49a 604 /* Used for BIDI READ */
a1d8b49a
AG
605 struct list_head t_task_list;
606 u32 t_task_list_num;
607
e0a53e70 608};
c66ac9db 609
c66ac9db
NB
610struct se_ua {
611 u8 ua_asc;
612 u8 ua_ascq;
613 struct se_node_acl *ua_nacl;
614 struct list_head ua_dev_list;
615 struct list_head ua_nacl_list;
e0a53e70 616};
c66ac9db
NB
617
618struct se_node_acl {
619 char initiatorname[TRANSPORT_IQN_LEN];
620 /* Used to signal demo mode created ACL, disabled by default */
5dd7ed2e 621 bool dynamic_node_acl;
337c0607 622 bool acl_stop:1;
c66ac9db
NB
623 u32 queue_depth;
624 u32 acl_index;
625 u64 num_cmds;
626 u64 read_bytes;
627 u64 write_bytes;
628 spinlock_t stats_lock;
629 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
630 atomic_t acl_pr_ref_count;
f2083241 631 struct se_dev_entry **device_list;
c66ac9db
NB
632 struct se_session *nacl_sess;
633 struct se_portal_group *se_tpg;
634 spinlock_t device_list_lock;
635 spinlock_t nacl_sess_lock;
636 struct config_group acl_group;
637 struct config_group acl_attrib_group;
638 struct config_group acl_auth_group;
639 struct config_group acl_param_group;
12d23384
NB
640 struct config_group acl_fabric_stat_group;
641 struct config_group *acl_default_groups[5];
c66ac9db
NB
642 struct list_head acl_list;
643 struct list_head acl_sess_list;
01468346 644 struct completion acl_free_comp;
afb999ff 645 struct kref acl_kref;
e0a53e70 646};
c66ac9db
NB
647
648struct se_session {
5f655e8d 649 unsigned sess_tearing_down:1;
c66ac9db
NB
650 u64 sess_bin_isid;
651 struct se_node_acl *se_node_acl;
652 struct se_portal_group *se_tpg;
653 void *fabric_sess_ptr;
654 struct list_head sess_list;
655 struct list_head sess_acl_list;
a17f091d
NB
656 struct list_head sess_cmd_list;
657 struct list_head sess_wait_list;
658 spinlock_t sess_cmd_lock;
41ac82b6 659 struct kref sess_kref;
e0a53e70 660};
c66ac9db 661
c66ac9db
NB
662struct se_device;
663struct se_transform_info;
664struct scatterlist;
665
12d23384
NB
666struct se_ml_stat_grps {
667 struct config_group stat_group;
668 struct config_group scsi_auth_intr_group;
669 struct config_group scsi_att_intr_port_group;
670};
671
c66ac9db
NB
672struct se_lun_acl {
673 char initiatorname[TRANSPORT_IQN_LEN];
674 u32 mapped_lun;
675 struct se_node_acl *se_lun_nacl;
676 struct se_lun *se_lun;
677 struct list_head lacl_list;
678 struct config_group se_lun_group;
12d23384 679 struct se_ml_stat_grps ml_stat_grps;
e0a53e70 680};
c66ac9db
NB
681
682struct se_dev_entry {
5dd7ed2e 683 bool def_pr_registered;
c66ac9db
NB
684 /* See transport_lunflags_table */
685 u32 lun_flags;
686 u32 deve_cmds;
687 u32 mapped_lun;
688 u32 average_bytes;
689 u32 last_byte_count;
690 u32 total_cmds;
691 u32 total_bytes;
692 u64 pr_res_key;
693 u64 creation_time;
694 u32 attach_count;
695 u64 read_bytes;
696 u64 write_bytes;
697 atomic_t ua_count;
698 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
699 atomic_t pr_ref_count;
700 struct se_lun_acl *se_lun_acl;
701 spinlock_t ua_lock;
702 struct se_lun *se_lun;
703 struct list_head alua_port_list;
704 struct list_head ua_list;
e0a53e70 705};
c66ac9db
NB
706
707struct se_dev_limits {
708 /* Max supported HW queue depth */
709 u32 hw_queue_depth;
710 /* Max supported virtual queue depth */
711 u32 queue_depth;
712 /* From include/linux/blkdev.h for the other HW/SW limits. */
713 struct queue_limits limits;
e0a53e70 714};
c66ac9db
NB
715
716struct se_dev_attrib {
717 int emulate_dpo;
718 int emulate_fua_write;
719 int emulate_fua_read;
720 int emulate_write_cache;
721 int emulate_ua_intlck_ctrl;
722 int emulate_tas;
723 int emulate_tpu;
724 int emulate_tpws;
725 int emulate_reservations;
726 int emulate_alua;
727 int enforce_pr_isids;
e22a7f07 728 int is_nonrot;
5de619a3 729 int emulate_rest_reord;
c66ac9db
NB
730 u32 hw_block_size;
731 u32 block_size;
732 u32 hw_max_sectors;
733 u32 max_sectors;
015487b8 734 u32 fabric_max_sectors;
c66ac9db
NB
735 u32 optimal_sectors;
736 u32 hw_queue_depth;
737 u32 queue_depth;
c66ac9db
NB
738 u32 max_unmap_lba_count;
739 u32 max_unmap_block_desc_count;
740 u32 unmap_granularity;
741 u32 unmap_granularity_alignment;
742 struct se_subsystem_dev *da_sub_dev;
743 struct config_group da_group;
e0a53e70 744};
c66ac9db 745
12d23384
NB
746struct se_dev_stat_grps {
747 struct config_group stat_group;
748 struct config_group scsi_dev_group;
749 struct config_group scsi_tgt_dev_group;
750 struct config_group scsi_lu_group;
751};
752
c66ac9db
NB
753struct se_subsystem_dev {
754/* Used for struct se_subsystem_dev-->se_dev_alias, must be less than PAGE_SIZE */
755#define SE_DEV_ALIAS_LEN 512
756 unsigned char se_dev_alias[SE_DEV_ALIAS_LEN];
757/* Used for struct se_subsystem_dev->se_dev_udev_path[], must be less than PAGE_SIZE */
758#define SE_UDEV_PATH_LEN 512
759 unsigned char se_dev_udev_path[SE_UDEV_PATH_LEN];
760 u32 su_dev_flags;
761 struct se_hba *se_dev_hba;
762 struct se_device *se_dev_ptr;
763 struct se_dev_attrib se_dev_attrib;
764 /* T10 Asymmetric Logical Unit Assignment for Target Ports */
765 struct t10_alua t10_alua;
766 /* T10 Inquiry and VPD WWN Information */
767 struct t10_wwn t10_wwn;
768 /* T10 SPC-2 + SPC-3 Reservations */
e3d6f909 769 struct t10_reservation t10_pr;
c66ac9db
NB
770 spinlock_t se_dev_lock;
771 void *se_dev_su_ptr;
c66ac9db
NB
772 struct config_group se_dev_group;
773 /* For T10 Reservations */
774 struct config_group se_dev_pr_group;
12d23384
NB
775 /* For target_core_stat.c groups */
776 struct se_dev_stat_grps dev_stat_grps;
e0a53e70 777};
c66ac9db 778
c66ac9db 779struct se_device {
c66ac9db
NB
780 /* RELATIVE TARGET PORT IDENTIFER Counter */
781 u16 dev_rpti_counter;
782 /* Used for SAM Task Attribute ordering */
783 u32 dev_cur_ordered_id;
784 u32 dev_flags;
785 u32 dev_port_count;
786 /* See transport_device_status_table */
787 u32 dev_status;
c66ac9db
NB
788 /* Physical device queue depth */
789 u32 queue_depth;
790 /* Used for SPC-2 reservations enforce of ISIDs */
791 u64 dev_res_bin_isid;
792 t10_task_attr_index_t dev_task_attr_type;
793 /* Pointer to transport specific device structure */
794 void *dev_ptr;
795 u32 dev_index;
796 u64 creation_time;
797 u32 num_resets;
798 u64 num_cmds;
799 u64 read_bytes;
800 u64 write_bytes;
801 spinlock_t stats_lock;
802 /* Active commands on this virtual SE device */
c66ac9db 803 atomic_t simple_cmds;
c66ac9db 804 atomic_t dev_ordered_id;
c66ac9db 805 atomic_t execute_tasks;
c66ac9db 806 atomic_t dev_ordered_sync;
07bde79a 807 atomic_t dev_qf_count;
c66ac9db
NB
808 struct se_obj dev_obj;
809 struct se_obj dev_access_obj;
810 struct se_obj dev_export_obj;
e3d6f909 811 struct se_queue_obj dev_queue_obj;
c66ac9db 812 spinlock_t delayed_cmd_lock;
c66ac9db 813 spinlock_t execute_task_lock;
c66ac9db 814 spinlock_t dev_reservation_lock;
c66ac9db 815 spinlock_t dev_status_lock;
c66ac9db
NB
816 spinlock_t se_port_lock;
817 spinlock_t se_tmr_lock;
07bde79a 818 spinlock_t qf_cmd_lock;
c66ac9db
NB
819 /* Used for legacy SPC-2 reservationsa */
820 struct se_node_acl *dev_reserved_node_acl;
821 /* Used for ALUA Logical Unit Group membership */
822 struct t10_alua_lu_gp_member *dev_alua_lu_gp_mem;
823 /* Used for SPC-3 Persistent Reservations */
824 struct t10_pr_registration *dev_pr_res_holder;
825 struct list_head dev_sep_list;
826 struct list_head dev_tmr_list;
c66ac9db
NB
827 /* Pointer to descriptor for processing thread */
828 struct task_struct *process_thread;
07bde79a 829 struct work_struct qf_work_queue;
c66ac9db 830 struct list_head delayed_cmd_list;
c66ac9db
NB
831 struct list_head execute_task_list;
832 struct list_head state_task_list;
07bde79a 833 struct list_head qf_cmd_list;
c66ac9db
NB
834 /* Pointer to associated SE HBA */
835 struct se_hba *se_hba;
836 struct se_subsystem_dev *se_sub_dev;
837 /* Pointer to template of function pointers for transport */
838 struct se_subsystem_api *transport;
839 /* Linked list for struct se_hba struct se_device list */
840 struct list_head dev_list;
e0a53e70 841};
c66ac9db 842
c66ac9db
NB
843struct se_hba {
844 u16 hba_tpgt;
845 u32 hba_id;
846 /* See hba_flags_table */
847 u32 hba_flags;
848 /* Virtual iSCSI devices attached. */
849 u32 dev_count;
850 u32 hba_index;
c66ac9db
NB
851 /* Pointer to transport specific host structure. */
852 void *hba_ptr;
853 /* Linked list for struct se_device */
854 struct list_head hba_dev_list;
e3d6f909 855 struct list_head hba_node;
c66ac9db 856 spinlock_t device_lock;
c66ac9db
NB
857 struct config_group hba_group;
858 struct mutex hba_access_mutex;
859 struct se_subsystem_api *transport;
e0a53e70 860};
c66ac9db 861
12d23384
NB
862struct se_port_stat_grps {
863 struct config_group stat_group;
864 struct config_group scsi_port_group;
865 struct config_group scsi_tgt_port_group;
866 struct config_group scsi_transport_group;
867};
868
c66ac9db
NB
869struct se_lun {
870 /* See transport_lun_status_table */
871 enum transport_lun_status_table lun_status;
872 u32 lun_access;
873 u32 lun_flags;
874 u32 unpacked_lun;
875 atomic_t lun_acl_count;
876 spinlock_t lun_acl_lock;
877 spinlock_t lun_cmd_lock;
878 spinlock_t lun_sep_lock;
879 struct completion lun_shutdown_comp;
880 struct list_head lun_cmd_list;
881 struct list_head lun_acl_list;
882 struct se_device *lun_se_dev;
12d23384 883 struct se_port *lun_sep;
c66ac9db 884 struct config_group lun_group;
12d23384 885 struct se_port_stat_grps port_stat_grps;
e0a53e70 886};
c66ac9db 887
e89d15ee
NB
888struct scsi_port_stats {
889 u64 cmd_pdus;
890 u64 tx_data_octets;
891 u64 rx_data_octets;
e0a53e70 892};
e89d15ee 893
c66ac9db
NB
894struct se_port {
895 /* RELATIVE TARGET PORT IDENTIFER */
896 u16 sep_rtpi;
897 int sep_tg_pt_secondary_stat;
898 int sep_tg_pt_secondary_write_md;
899 u32 sep_index;
900 struct scsi_port_stats sep_stats;
901 /* Used for ALUA Target Port Groups membership */
c66ac9db
NB
902 atomic_t sep_tg_pt_secondary_offline;
903 /* Used for PR ALL_TG_PT=1 */
904 atomic_t sep_tg_pt_ref_cnt;
905 spinlock_t sep_alua_lock;
906 struct mutex sep_tg_pt_md_mutex;
907 struct t10_alua_tg_pt_gp_member *sep_alua_tg_pt_gp_mem;
908 struct se_lun *sep_lun;
909 struct se_portal_group *sep_tpg;
910 struct list_head sep_alua_list;
911 struct list_head sep_list;
e0a53e70 912};
c66ac9db
NB
913
914struct se_tpg_np {
1f6fe7cb 915 struct se_portal_group *tpg_np_parent;
c66ac9db 916 struct config_group tpg_np_group;
e0a53e70 917};
c66ac9db
NB
918
919struct se_portal_group {
920 /* Type of target portal group, see transport_tpg_type_table */
921 enum transport_tpg_type_table se_tpg_type;
922 /* Number of ACLed Initiator Nodes for this TPG */
923 u32 num_node_acls;
924 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
925 atomic_t tpg_pr_ref_count;
926 /* Spinlock for adding/removing ACLed Nodes */
927 spinlock_t acl_node_lock;
928 /* Spinlock for adding/removing sessions */
929 spinlock_t session_lock;
930 spinlock_t tpg_lun_lock;
931 /* Pointer to $FABRIC_MOD portal group */
932 void *se_tpg_fabric_ptr;
e3d6f909 933 struct list_head se_tpg_node;
c66ac9db
NB
934 /* linked list for initiator ACL list */
935 struct list_head acl_node_list;
4a5a75f3 936 struct se_lun **tpg_lun_list;
c66ac9db 937 struct se_lun tpg_virt_lun0;
25985edc 938 /* List of TCM sessions associated wth this TPG */
c66ac9db
NB
939 struct list_head tpg_sess_list;
940 /* Pointer to $FABRIC_MOD dependent code */
941 struct target_core_fabric_ops *se_tpg_tfo;
942 struct se_wwn *se_tpg_wwn;
943 struct config_group tpg_group;
944 struct config_group *tpg_default_groups[6];
945 struct config_group tpg_lun_group;
946 struct config_group tpg_np_group;
947 struct config_group tpg_acl_group;
948 struct config_group tpg_attrib_group;
949 struct config_group tpg_param_group;
e0a53e70 950};
c66ac9db 951
c66ac9db
NB
952struct se_wwn {
953 struct target_fabric_configfs *wwn_tf;
954 struct config_group wwn_group;
12d23384
NB
955 struct config_group *wwn_default_groups[2];
956 struct config_group fabric_stat_group;
e0a53e70 957};
c66ac9db 958
c66ac9db 959#endif /* TARGET_CORE_BASE_H */
This page took 0.125727 seconds and 5 git commands to generate.