target_core_base.h 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833
  1. #ifndef TARGET_CORE_BASE_H
  2. #define TARGET_CORE_BASE_H
  3. #include <linux/in.h>
  4. #include <linux/configfs.h>
  5. #include <linux/dma-mapping.h>
  6. #include <linux/blkdev.h>
  7. #include <linux/percpu_ida.h>
  8. #include <scsi/scsi_cmnd.h>
  9. #include <net/sock.h>
  10. #include <net/tcp.h>
  11. #define TARGET_CORE_MOD_VERSION "v4.1.0"
  12. #define TARGET_CORE_VERSION TARGET_CORE_MOD_VERSION
  13. /* Maximum Number of LUNs per Target Portal Group */
  14. /* Don't raise above 511 or REPORT_LUNS needs to handle >1 page */
  15. #define TRANSPORT_MAX_LUNS_PER_TPG 256
  16. /*
  17. * By default we use 32-byte CDBs in TCM Core and subsystem plugin code.
  18. *
  19. * Note that both include/scsi/scsi_cmnd.h:MAX_COMMAND_SIZE and
  20. * include/linux/blkdev.h:BLOCK_MAX_CDB as of v2.6.36-rc4 still use
  21. * 16-byte CDBs by default and require an extra allocation for
  22. * 32-byte CDBs to because of legacy issues.
  23. *
  24. * Within TCM Core there are no such legacy limitiations, so we go ahead
  25. * use 32-byte CDBs by default and use include/scsi/scsi.h:scsi_command_size()
  26. * within all TCM Core and subsystem plugin code.
  27. */
  28. #define TCM_MAX_COMMAND_SIZE 32
  29. /*
  30. * From include/scsi/scsi_cmnd.h:SCSI_SENSE_BUFFERSIZE, currently
  31. * defined 96, but the real limit is 252 (or 260 including the header)
  32. */
  33. #define TRANSPORT_SENSE_BUFFER SCSI_SENSE_BUFFERSIZE
  34. /* Used by transport_send_check_condition_and_sense() */
  35. #define SPC_SENSE_KEY_OFFSET 2
  36. #define SPC_ADD_SENSE_LEN_OFFSET 7
  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 254
  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. /* Attempts before moving from SHORT to LONG */
  56. #define PYX_TRANSPORT_WINDOW_CLOSED_THRESHOLD 3
  57. #define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_SHORT 3 /* In milliseconds */
  58. #define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_LONG 10 /* In milliseconds */
  59. #define PYX_TRANSPORT_STATUS_INTERVAL 5 /* In seconds */
  60. /* struct se_dev_attrib sanity values */
  61. /* Default max_unmap_lba_count */
  62. #define DA_MAX_UNMAP_LBA_COUNT 0
  63. /* Default max_unmap_block_desc_count */
  64. #define DA_MAX_UNMAP_BLOCK_DESC_COUNT 0
  65. /* Default unmap_granularity */
  66. #define DA_UNMAP_GRANULARITY_DEFAULT 0
  67. /* Default unmap_granularity_alignment */
  68. #define DA_UNMAP_GRANULARITY_ALIGNMENT_DEFAULT 0
  69. /* Default max_write_same_len, disabled by default */
  70. #define DA_MAX_WRITE_SAME_LEN 0
  71. /* Default max transfer length */
  72. #define DA_FABRIC_MAX_SECTORS 8192
  73. /* Use a model alias based on the configfs backend device name */
  74. #define DA_EMULATE_MODEL_ALIAS 0
  75. /* Emulation for Direct Page Out */
  76. #define DA_EMULATE_DPO 0
  77. /* Emulation for Forced Unit Access WRITEs */
  78. #define DA_EMULATE_FUA_WRITE 1
  79. /* Emulation for Forced Unit Access READs */
  80. #define DA_EMULATE_FUA_READ 0
  81. /* Emulation for WriteCache and SYNCHRONIZE_CACHE */
  82. #define DA_EMULATE_WRITE_CACHE 0
  83. /* Emulation for UNIT ATTENTION Interlock Control */
  84. #define DA_EMULATE_UA_INTLLCK_CTRL 0
  85. /* Emulation for TASK_ABORTED status (TAS) by default */
  86. #define DA_EMULATE_TAS 1
  87. /* Emulation for Thin Provisioning UNMAP using block/blk-lib.c:blkdev_issue_discard() */
  88. #define DA_EMULATE_TPU 0
  89. /*
  90. * Emulation for Thin Provisioning WRITE_SAME w/ UNMAP=1 bit using
  91. * block/blk-lib.c:blkdev_issue_discard()
  92. */
  93. #define DA_EMULATE_TPWS 0
  94. /* Emulation for CompareAndWrite (AtomicTestandSet) by default */
  95. #define DA_EMULATE_CAW 1
  96. /* Emulation for 3rd Party Copy (ExtendedCopy) by default */
  97. #define DA_EMULATE_3PC 1
  98. /* No Emulation for PSCSI by default */
  99. #define DA_EMULATE_ALUA 0
  100. /* Enforce SCSI Initiator Port TransportID with 'ISID' for PR */
  101. #define DA_ENFORCE_PR_ISIDS 1
  102. #define DA_STATUS_MAX_SECTORS_MIN 16
  103. #define DA_STATUS_MAX_SECTORS_MAX 8192
  104. /* By default don't report non-rotating (solid state) medium */
  105. #define DA_IS_NONROT 0
  106. /* Queue Algorithm Modifier default for restricted reordering in control mode page */
  107. #define DA_EMULATE_REST_REORD 0
  108. #define SE_INQUIRY_BUF 512
  109. #define SE_MODE_PAGE_BUF 512
  110. #define SE_SENSE_BUF 96
  111. /* struct se_hba->hba_flags */
  112. enum hba_flags_table {
  113. HBA_FLAGS_INTERNAL_USE = 0x01,
  114. HBA_FLAGS_PSCSI_MODE = 0x02,
  115. };
  116. /* struct se_lun->lun_status */
  117. enum transport_lun_status_table {
  118. TRANSPORT_LUN_STATUS_FREE = 0,
  119. TRANSPORT_LUN_STATUS_ACTIVE = 1,
  120. };
  121. /* struct se_portal_group->se_tpg_type */
  122. enum transport_tpg_type_table {
  123. TRANSPORT_TPG_TYPE_NORMAL = 0,
  124. TRANSPORT_TPG_TYPE_DISCOVERY = 1,
  125. };
  126. /* Special transport agnostic struct se_cmd->t_states */
  127. enum transport_state_table {
  128. TRANSPORT_NO_STATE = 0,
  129. TRANSPORT_NEW_CMD = 1,
  130. TRANSPORT_WRITE_PENDING = 3,
  131. TRANSPORT_PROCESSING = 5,
  132. TRANSPORT_COMPLETE = 6,
  133. TRANSPORT_ISTATE_PROCESSING = 11,
  134. TRANSPORT_COMPLETE_QF_WP = 18,
  135. TRANSPORT_COMPLETE_QF_OK = 19,
  136. };
  137. /* Used for struct se_cmd->se_cmd_flags */
  138. enum se_cmd_flags_table {
  139. SCF_SUPPORTED_SAM_OPCODE = 0x00000001,
  140. SCF_TRANSPORT_TASK_SENSE = 0x00000002,
  141. SCF_EMULATED_TASK_SENSE = 0x00000004,
  142. SCF_SCSI_DATA_CDB = 0x00000008,
  143. SCF_SCSI_TMR_CDB = 0x00000010,
  144. SCF_FUA = 0x00000080,
  145. SCF_SE_LUN_CMD = 0x00000100,
  146. SCF_BIDI = 0x00000400,
  147. SCF_SENT_CHECK_CONDITION = 0x00000800,
  148. SCF_OVERFLOW_BIT = 0x00001000,
  149. SCF_UNDERFLOW_BIT = 0x00002000,
  150. SCF_SENT_DELAYED_TAS = 0x00004000,
  151. SCF_ALUA_NON_OPTIMIZED = 0x00008000,
  152. SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC = 0x00020000,
  153. SCF_ACK_KREF = 0x00040000,
  154. SCF_COMPARE_AND_WRITE = 0x00080000,
  155. SCF_COMPARE_AND_WRITE_POST = 0x00100000,
  156. SCF_CMD_XCOPY_PASSTHROUGH = 0x00200000,
  157. };
  158. /* struct se_dev_entry->lun_flags and struct se_lun->lun_access */
  159. enum transport_lunflags_table {
  160. TRANSPORT_LUNFLAGS_NO_ACCESS = 0x00,
  161. TRANSPORT_LUNFLAGS_INITIATOR_ACCESS = 0x01,
  162. TRANSPORT_LUNFLAGS_READ_ONLY = 0x02,
  163. TRANSPORT_LUNFLAGS_READ_WRITE = 0x04,
  164. };
  165. /*
  166. * Used by transport_send_check_condition_and_sense()
  167. * to signal which ASC/ASCQ sense payload should be built.
  168. */
  169. typedef unsigned __bitwise__ sense_reason_t;
  170. enum tcm_sense_reason_table {
  171. #define R(x) (__force sense_reason_t )(x)
  172. TCM_NO_SENSE = R(0x00),
  173. TCM_NON_EXISTENT_LUN = R(0x01),
  174. TCM_UNSUPPORTED_SCSI_OPCODE = R(0x02),
  175. TCM_INCORRECT_AMOUNT_OF_DATA = R(0x03),
  176. TCM_UNEXPECTED_UNSOLICITED_DATA = R(0x04),
  177. TCM_SERVICE_CRC_ERROR = R(0x05),
  178. TCM_SNACK_REJECTED = R(0x06),
  179. TCM_SECTOR_COUNT_TOO_MANY = R(0x07),
  180. TCM_INVALID_CDB_FIELD = R(0x08),
  181. TCM_INVALID_PARAMETER_LIST = R(0x09),
  182. TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE = R(0x0a),
  183. TCM_UNKNOWN_MODE_PAGE = R(0x0b),
  184. TCM_WRITE_PROTECTED = R(0x0c),
  185. TCM_CHECK_CONDITION_ABORT_CMD = R(0x0d),
  186. TCM_CHECK_CONDITION_UNIT_ATTENTION = R(0x0e),
  187. TCM_CHECK_CONDITION_NOT_READY = R(0x0f),
  188. TCM_RESERVATION_CONFLICT = R(0x10),
  189. TCM_ADDRESS_OUT_OF_RANGE = R(0x11),
  190. TCM_OUT_OF_RESOURCES = R(0x12),
  191. TCM_PARAMETER_LIST_LENGTH_ERROR = R(0x13),
  192. TCM_MISCOMPARE_VERIFY = R(0x14),
  193. #undef R
  194. };
  195. enum target_sc_flags_table {
  196. TARGET_SCF_BIDI_OP = 0x01,
  197. TARGET_SCF_ACK_KREF = 0x02,
  198. TARGET_SCF_UNKNOWN_SIZE = 0x04,
  199. };
  200. /* fabric independent task management function values */
  201. enum tcm_tmreq_table {
  202. TMR_ABORT_TASK = 1,
  203. TMR_ABORT_TASK_SET = 2,
  204. TMR_CLEAR_ACA = 3,
  205. TMR_CLEAR_TASK_SET = 4,
  206. TMR_LUN_RESET = 5,
  207. TMR_TARGET_WARM_RESET = 6,
  208. TMR_TARGET_COLD_RESET = 7,
  209. };
  210. /* fabric independent task management response values */
  211. enum tcm_tmrsp_table {
  212. TMR_FUNCTION_COMPLETE = 1,
  213. TMR_TASK_DOES_NOT_EXIST = 2,
  214. TMR_LUN_DOES_NOT_EXIST = 3,
  215. TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED = 4,
  216. TMR_FUNCTION_REJECTED = 5,
  217. };
  218. /*
  219. * Used for target SCSI statistics
  220. */
  221. typedef enum {
  222. SCSI_INST_INDEX,
  223. SCSI_DEVICE_INDEX,
  224. SCSI_AUTH_INTR_INDEX,
  225. SCSI_INDEX_TYPE_MAX
  226. } scsi_index_t;
  227. struct se_cmd;
  228. struct t10_alua {
  229. /* ALUA Target Port Group ID */
  230. u16 alua_tg_pt_gps_counter;
  231. u32 alua_tg_pt_gps_count;
  232. spinlock_t tg_pt_gps_lock;
  233. struct se_device *t10_dev;
  234. /* Used for default ALUA Target Port Group */
  235. struct t10_alua_tg_pt_gp *default_tg_pt_gp;
  236. /* Used for default ALUA Target Port Group ConfigFS group */
  237. struct config_group alua_tg_pt_gps_group;
  238. struct list_head tg_pt_gps_list;
  239. };
  240. struct t10_alua_lu_gp {
  241. u16 lu_gp_id;
  242. int lu_gp_valid_id;
  243. u32 lu_gp_members;
  244. atomic_t lu_gp_ref_cnt;
  245. spinlock_t lu_gp_lock;
  246. struct config_group lu_gp_group;
  247. struct list_head lu_gp_node;
  248. struct list_head lu_gp_mem_list;
  249. };
  250. struct t10_alua_lu_gp_member {
  251. bool lu_gp_assoc;
  252. atomic_t lu_gp_mem_ref_cnt;
  253. spinlock_t lu_gp_mem_lock;
  254. struct t10_alua_lu_gp *lu_gp;
  255. struct se_device *lu_gp_mem_dev;
  256. struct list_head lu_gp_mem_list;
  257. };
  258. struct t10_alua_tg_pt_gp {
  259. u16 tg_pt_gp_id;
  260. int tg_pt_gp_valid_id;
  261. int tg_pt_gp_alua_access_status;
  262. int tg_pt_gp_alua_access_type;
  263. int tg_pt_gp_nonop_delay_msecs;
  264. int tg_pt_gp_trans_delay_msecs;
  265. int tg_pt_gp_implict_trans_secs;
  266. int tg_pt_gp_pref;
  267. int tg_pt_gp_write_metadata;
  268. /* Used by struct t10_alua_tg_pt_gp->tg_pt_gp_md_buf_len */
  269. #define ALUA_MD_BUF_LEN 1024
  270. u32 tg_pt_gp_md_buf_len;
  271. u32 tg_pt_gp_members;
  272. atomic_t tg_pt_gp_alua_access_state;
  273. atomic_t tg_pt_gp_ref_cnt;
  274. spinlock_t tg_pt_gp_lock;
  275. struct mutex tg_pt_gp_md_mutex;
  276. struct se_device *tg_pt_gp_dev;
  277. struct config_group tg_pt_gp_group;
  278. struct list_head tg_pt_gp_list;
  279. struct list_head tg_pt_gp_mem_list;
  280. };
  281. struct t10_alua_tg_pt_gp_member {
  282. bool tg_pt_gp_assoc;
  283. atomic_t tg_pt_gp_mem_ref_cnt;
  284. spinlock_t tg_pt_gp_mem_lock;
  285. struct t10_alua_tg_pt_gp *tg_pt_gp;
  286. struct se_port *tg_pt;
  287. struct list_head tg_pt_gp_mem_list;
  288. };
  289. struct t10_vpd {
  290. unsigned char device_identifier[INQUIRY_VPD_DEVICE_IDENTIFIER_LEN];
  291. int protocol_identifier_set;
  292. u32 protocol_identifier;
  293. u32 device_identifier_code_set;
  294. u32 association;
  295. u32 device_identifier_type;
  296. struct list_head vpd_list;
  297. };
  298. struct t10_wwn {
  299. char vendor[8];
  300. char model[16];
  301. char revision[4];
  302. char unit_serial[INQUIRY_VPD_SERIAL_LEN];
  303. spinlock_t t10_vpd_lock;
  304. struct se_device *t10_dev;
  305. struct config_group t10_wwn_group;
  306. struct list_head t10_vpd_list;
  307. };
  308. struct t10_pr_registration {
  309. /* Used for fabrics that contain WWN+ISID */
  310. #define PR_REG_ISID_LEN 16
  311. /* PR_REG_ISID_LEN + ',i,0x' */
  312. #define PR_REG_ISID_ID_LEN (PR_REG_ISID_LEN + 5)
  313. char pr_reg_isid[PR_REG_ISID_LEN];
  314. /* Used during APTPL metadata reading */
  315. #define PR_APTPL_MAX_IPORT_LEN 256
  316. unsigned char pr_iport[PR_APTPL_MAX_IPORT_LEN];
  317. /* Used during APTPL metadata reading */
  318. #define PR_APTPL_MAX_TPORT_LEN 256
  319. unsigned char pr_tport[PR_APTPL_MAX_TPORT_LEN];
  320. u16 pr_aptpl_rpti;
  321. u16 pr_reg_tpgt;
  322. /* Reservation effects all target ports */
  323. int pr_reg_all_tg_pt;
  324. /* Activate Persistence across Target Power Loss */
  325. int pr_reg_aptpl;
  326. int pr_res_holder;
  327. int pr_res_type;
  328. int pr_res_scope;
  329. /* Used for fabric initiator WWPNs using a ISID */
  330. bool isid_present_at_reg;
  331. u32 pr_res_mapped_lun;
  332. u32 pr_aptpl_target_lun;
  333. u32 pr_res_generation;
  334. u64 pr_reg_bin_isid;
  335. u64 pr_res_key;
  336. atomic_t pr_res_holders;
  337. struct se_node_acl *pr_reg_nacl;
  338. struct se_dev_entry *pr_reg_deve;
  339. struct se_lun *pr_reg_tg_pt_lun;
  340. struct list_head pr_reg_list;
  341. struct list_head pr_reg_abort_list;
  342. struct list_head pr_reg_aptpl_list;
  343. struct list_head pr_reg_atp_list;
  344. struct list_head pr_reg_atp_mem_list;
  345. };
  346. struct t10_reservation {
  347. /* Reservation effects all target ports */
  348. int pr_all_tg_pt;
  349. /* Activate Persistence across Target Power Loss enabled
  350. * for SCSI device */
  351. int pr_aptpl_active;
  352. #define PR_APTPL_BUF_LEN 8192
  353. u32 pr_generation;
  354. spinlock_t registration_lock;
  355. spinlock_t aptpl_reg_lock;
  356. /*
  357. * This will always be set by one individual I_T Nexus.
  358. * However with all_tg_pt=1, other I_T Nexus from the
  359. * same initiator can access PR reg/res info on a different
  360. * target port.
  361. *
  362. * There is also the 'All Registrants' case, where there is
  363. * a single *pr_res_holder of the reservation, but all
  364. * registrations are considered reservation holders.
  365. */
  366. struct se_node_acl *pr_res_holder;
  367. struct list_head registration_list;
  368. struct list_head aptpl_reg_list;
  369. };
  370. struct se_tmr_req {
  371. /* Task Management function to be performed */
  372. u8 function;
  373. /* Task Management response to send */
  374. u8 response;
  375. int call_transport;
  376. /* Reference to ITT that Task Mgmt should be performed */
  377. u32 ref_task_tag;
  378. void *fabric_tmr_ptr;
  379. struct se_cmd *task_cmd;
  380. struct se_device *tmr_dev;
  381. struct se_lun *tmr_lun;
  382. struct list_head tmr_list;
  383. };
  384. struct se_cmd {
  385. /* SAM response code being sent to initiator */
  386. u8 scsi_status;
  387. u8 scsi_asc;
  388. u8 scsi_ascq;
  389. u16 scsi_sense_length;
  390. /* Delay for ALUA Active/NonOptimized state access in milliseconds */
  391. int alua_nonop_delay;
  392. /* See include/linux/dma-mapping.h */
  393. enum dma_data_direction data_direction;
  394. /* For SAM Task Attribute */
  395. int sam_task_attr;
  396. /* Used for se_sess->sess_tag_pool */
  397. unsigned int map_tag;
  398. /* Transport protocol dependent state, see transport_state_table */
  399. enum transport_state_table t_state;
  400. unsigned cmd_wait_set:1;
  401. unsigned unknown_data_length:1;
  402. /* See se_cmd_flags_table */
  403. u32 se_cmd_flags;
  404. u32 se_ordered_id;
  405. /* Total size in bytes associated with command */
  406. u32 data_length;
  407. u32 residual_count;
  408. u32 orig_fe_lun;
  409. /* Persistent Reservation key */
  410. u64 pr_res_key;
  411. /* Used for sense data */
  412. void *sense_buffer;
  413. struct list_head se_delayed_node;
  414. struct list_head se_lun_node;
  415. struct list_head se_qf_node;
  416. struct se_device *se_dev;
  417. struct se_dev_entry *se_deve;
  418. struct se_lun *se_lun;
  419. /* Only used for internal passthrough and legacy TCM fabric modules */
  420. struct se_session *se_sess;
  421. struct se_tmr_req *se_tmr_req;
  422. struct list_head se_cmd_list;
  423. struct completion cmd_wait_comp;
  424. struct kref cmd_kref;
  425. struct target_core_fabric_ops *se_tfo;
  426. sense_reason_t (*execute_cmd)(struct se_cmd *);
  427. sense_reason_t (*execute_rw)(struct se_cmd *, struct scatterlist *,
  428. u32, enum dma_data_direction);
  429. sense_reason_t (*transport_complete_callback)(struct se_cmd *);
  430. unsigned char *t_task_cdb;
  431. unsigned char __t_task_cdb[TCM_MAX_COMMAND_SIZE];
  432. unsigned long long t_task_lba;
  433. unsigned int t_task_nolb;
  434. unsigned int transport_state;
  435. #define CMD_T_ABORTED (1 << 0)
  436. #define CMD_T_ACTIVE (1 << 1)
  437. #define CMD_T_COMPLETE (1 << 2)
  438. #define CMD_T_SENT (1 << 4)
  439. #define CMD_T_STOP (1 << 5)
  440. #define CMD_T_FAILED (1 << 6)
  441. #define CMD_T_LUN_STOP (1 << 7)
  442. #define CMD_T_LUN_FE_STOP (1 << 8)
  443. #define CMD_T_DEV_ACTIVE (1 << 9)
  444. #define CMD_T_REQUEST_STOP (1 << 10)
  445. #define CMD_T_BUSY (1 << 11)
  446. spinlock_t t_state_lock;
  447. struct completion t_transport_stop_comp;
  448. struct completion transport_lun_fe_stop_comp;
  449. struct completion transport_lun_stop_comp;
  450. struct work_struct work;
  451. struct scatterlist *t_data_sg;
  452. struct scatterlist *t_data_sg_orig;
  453. unsigned int t_data_nents;
  454. unsigned int t_data_nents_orig;
  455. void *t_data_vmap;
  456. struct scatterlist *t_bidi_data_sg;
  457. unsigned int t_bidi_data_nents;
  458. struct list_head state_list;
  459. bool state_active;
  460. /* old task stop completion, consider merging with some of the above */
  461. struct completion task_stop_comp;
  462. /* backend private data */
  463. void *priv;
  464. };
  465. struct se_ua {
  466. u8 ua_asc;
  467. u8 ua_ascq;
  468. struct se_node_acl *ua_nacl;
  469. struct list_head ua_dev_list;
  470. struct list_head ua_nacl_list;
  471. };
  472. struct se_node_acl {
  473. char initiatorname[TRANSPORT_IQN_LEN];
  474. /* Used to signal demo mode created ACL, disabled by default */
  475. bool dynamic_node_acl;
  476. bool acl_stop:1;
  477. u32 queue_depth;
  478. u32 acl_index;
  479. #define MAX_ACL_TAG_SIZE 64
  480. char acl_tag[MAX_ACL_TAG_SIZE];
  481. u64 num_cmds;
  482. u64 read_bytes;
  483. u64 write_bytes;
  484. spinlock_t stats_lock;
  485. /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
  486. atomic_t acl_pr_ref_count;
  487. struct se_dev_entry **device_list;
  488. struct se_session *nacl_sess;
  489. struct se_portal_group *se_tpg;
  490. spinlock_t device_list_lock;
  491. spinlock_t nacl_sess_lock;
  492. struct config_group acl_group;
  493. struct config_group acl_attrib_group;
  494. struct config_group acl_auth_group;
  495. struct config_group acl_param_group;
  496. struct config_group acl_fabric_stat_group;
  497. struct config_group *acl_default_groups[5];
  498. struct list_head acl_list;
  499. struct list_head acl_sess_list;
  500. struct completion acl_free_comp;
  501. struct kref acl_kref;
  502. };
  503. struct se_session {
  504. unsigned sess_tearing_down:1;
  505. u64 sess_bin_isid;
  506. struct se_node_acl *se_node_acl;
  507. struct se_portal_group *se_tpg;
  508. void *fabric_sess_ptr;
  509. struct list_head sess_list;
  510. struct list_head sess_acl_list;
  511. struct list_head sess_cmd_list;
  512. struct list_head sess_wait_list;
  513. spinlock_t sess_cmd_lock;
  514. struct kref sess_kref;
  515. void *sess_cmd_map;
  516. struct percpu_ida sess_tag_pool;
  517. };
  518. struct se_device;
  519. struct se_transform_info;
  520. struct scatterlist;
  521. struct se_ml_stat_grps {
  522. struct config_group stat_group;
  523. struct config_group scsi_auth_intr_group;
  524. struct config_group scsi_att_intr_port_group;
  525. };
  526. struct se_lun_acl {
  527. char initiatorname[TRANSPORT_IQN_LEN];
  528. u32 mapped_lun;
  529. struct se_node_acl *se_lun_nacl;
  530. struct se_lun *se_lun;
  531. struct list_head lacl_list;
  532. struct config_group se_lun_group;
  533. struct se_ml_stat_grps ml_stat_grps;
  534. };
  535. struct se_dev_entry {
  536. bool def_pr_registered;
  537. /* See transport_lunflags_table */
  538. u32 lun_flags;
  539. u32 mapped_lun;
  540. u32 total_cmds;
  541. u64 pr_res_key;
  542. u64 creation_time;
  543. u32 attach_count;
  544. u64 read_bytes;
  545. u64 write_bytes;
  546. atomic_t ua_count;
  547. /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
  548. atomic_t pr_ref_count;
  549. struct se_lun_acl *se_lun_acl;
  550. spinlock_t ua_lock;
  551. struct se_lun *se_lun;
  552. struct list_head alua_port_list;
  553. struct list_head ua_list;
  554. };
  555. struct se_dev_attrib {
  556. int emulate_model_alias;
  557. int emulate_dpo;
  558. int emulate_fua_write;
  559. int emulate_fua_read;
  560. int emulate_write_cache;
  561. int emulate_ua_intlck_ctrl;
  562. int emulate_tas;
  563. int emulate_tpu;
  564. int emulate_tpws;
  565. int emulate_caw;
  566. int emulate_3pc;
  567. int enforce_pr_isids;
  568. int is_nonrot;
  569. int emulate_rest_reord;
  570. u32 hw_block_size;
  571. u32 block_size;
  572. u32 hw_max_sectors;
  573. u32 fabric_max_sectors;
  574. u32 optimal_sectors;
  575. u32 hw_queue_depth;
  576. u32 queue_depth;
  577. u32 max_unmap_lba_count;
  578. u32 max_unmap_block_desc_count;
  579. u32 unmap_granularity;
  580. u32 unmap_granularity_alignment;
  581. u32 max_write_same_len;
  582. struct se_device *da_dev;
  583. struct config_group da_group;
  584. };
  585. struct se_dev_stat_grps {
  586. struct config_group stat_group;
  587. struct config_group scsi_dev_group;
  588. struct config_group scsi_tgt_dev_group;
  589. struct config_group scsi_lu_group;
  590. };
  591. struct se_device {
  592. #define SE_DEV_LINK_MAGIC 0xfeeddeef
  593. u32 dev_link_magic;
  594. /* RELATIVE TARGET PORT IDENTIFER Counter */
  595. u16 dev_rpti_counter;
  596. /* Used for SAM Task Attribute ordering */
  597. u32 dev_cur_ordered_id;
  598. u32 dev_flags;
  599. #define DF_CONFIGURED 0x00000001
  600. #define DF_FIRMWARE_VPD_UNIT_SERIAL 0x00000002
  601. #define DF_EMULATED_VPD_UNIT_SERIAL 0x00000004
  602. #define DF_USING_UDEV_PATH 0x00000008
  603. #define DF_USING_ALIAS 0x00000010
  604. u32 dev_port_count;
  605. /* Physical device queue depth */
  606. u32 queue_depth;
  607. /* Used for SPC-2 reservations enforce of ISIDs */
  608. u64 dev_res_bin_isid;
  609. /* Pointer to transport specific device structure */
  610. u32 dev_index;
  611. u64 creation_time;
  612. u32 num_resets;
  613. u64 num_cmds;
  614. u64 read_bytes;
  615. u64 write_bytes;
  616. spinlock_t stats_lock;
  617. /* Active commands on this virtual SE device */
  618. atomic_t simple_cmds;
  619. atomic_t dev_ordered_id;
  620. atomic_t dev_ordered_sync;
  621. atomic_t dev_qf_count;
  622. int export_count;
  623. spinlock_t delayed_cmd_lock;
  624. spinlock_t execute_task_lock;
  625. spinlock_t dev_reservation_lock;
  626. unsigned int dev_reservation_flags;
  627. #define DRF_SPC2_RESERVATIONS 0x00000001
  628. #define DRF_SPC2_RESERVATIONS_WITH_ISID 0x00000002
  629. spinlock_t se_port_lock;
  630. spinlock_t se_tmr_lock;
  631. spinlock_t qf_cmd_lock;
  632. struct semaphore caw_sem;
  633. /* Used for legacy SPC-2 reservationsa */
  634. struct se_node_acl *dev_reserved_node_acl;
  635. /* Used for ALUA Logical Unit Group membership */
  636. struct t10_alua_lu_gp_member *dev_alua_lu_gp_mem;
  637. /* Used for SPC-3 Persistent Reservations */
  638. struct t10_pr_registration *dev_pr_res_holder;
  639. struct list_head dev_sep_list;
  640. struct list_head dev_tmr_list;
  641. struct workqueue_struct *tmr_wq;
  642. struct work_struct qf_work_queue;
  643. struct list_head delayed_cmd_list;
  644. struct list_head state_list;
  645. struct list_head qf_cmd_list;
  646. struct list_head g_dev_node;
  647. /* Pointer to associated SE HBA */
  648. struct se_hba *se_hba;
  649. /* T10 Inquiry and VPD WWN Information */
  650. struct t10_wwn t10_wwn;
  651. /* T10 Asymmetric Logical Unit Assignment for Target Ports */
  652. struct t10_alua t10_alua;
  653. /* T10 SPC-2 + SPC-3 Reservations */
  654. struct t10_reservation t10_pr;
  655. struct se_dev_attrib dev_attrib;
  656. struct config_group dev_group;
  657. struct config_group dev_pr_group;
  658. struct se_dev_stat_grps dev_stat_grps;
  659. #define SE_DEV_ALIAS_LEN 512 /* must be less than PAGE_SIZE */
  660. unsigned char dev_alias[SE_DEV_ALIAS_LEN];
  661. #define SE_UDEV_PATH_LEN 512 /* must be less than PAGE_SIZE */
  662. unsigned char udev_path[SE_UDEV_PATH_LEN];
  663. /* Pointer to template of function pointers for transport */
  664. struct se_subsystem_api *transport;
  665. /* Linked list for struct se_hba struct se_device list */
  666. struct list_head dev_list;
  667. };
  668. struct se_hba {
  669. u16 hba_tpgt;
  670. u32 hba_id;
  671. /* See hba_flags_table */
  672. u32 hba_flags;
  673. /* Virtual iSCSI devices attached. */
  674. u32 dev_count;
  675. u32 hba_index;
  676. /* Pointer to transport specific host structure. */
  677. void *hba_ptr;
  678. struct list_head hba_node;
  679. spinlock_t device_lock;
  680. struct config_group hba_group;
  681. struct mutex hba_access_mutex;
  682. struct se_subsystem_api *transport;
  683. };
  684. struct se_port_stat_grps {
  685. struct config_group stat_group;
  686. struct config_group scsi_port_group;
  687. struct config_group scsi_tgt_port_group;
  688. struct config_group scsi_transport_group;
  689. };
  690. struct se_lun {
  691. #define SE_LUN_LINK_MAGIC 0xffff7771
  692. u32 lun_link_magic;
  693. /* See transport_lun_status_table */
  694. enum transport_lun_status_table lun_status;
  695. u32 lun_access;
  696. u32 lun_flags;
  697. u32 unpacked_lun;
  698. atomic_t lun_acl_count;
  699. spinlock_t lun_acl_lock;
  700. spinlock_t lun_cmd_lock;
  701. spinlock_t lun_sep_lock;
  702. struct completion lun_shutdown_comp;
  703. struct list_head lun_cmd_list;
  704. struct list_head lun_acl_list;
  705. struct se_device *lun_se_dev;
  706. struct se_port *lun_sep;
  707. struct config_group lun_group;
  708. struct se_port_stat_grps port_stat_grps;
  709. };
  710. struct scsi_port_stats {
  711. u64 cmd_pdus;
  712. u64 tx_data_octets;
  713. u64 rx_data_octets;
  714. };
  715. struct se_port {
  716. /* RELATIVE TARGET PORT IDENTIFER */
  717. u16 sep_rtpi;
  718. int sep_tg_pt_secondary_stat;
  719. int sep_tg_pt_secondary_write_md;
  720. u32 sep_index;
  721. struct scsi_port_stats sep_stats;
  722. /* Used for ALUA Target Port Groups membership */
  723. atomic_t sep_tg_pt_secondary_offline;
  724. /* Used for PR ALL_TG_PT=1 */
  725. atomic_t sep_tg_pt_ref_cnt;
  726. spinlock_t sep_alua_lock;
  727. struct mutex sep_tg_pt_md_mutex;
  728. struct t10_alua_tg_pt_gp_member *sep_alua_tg_pt_gp_mem;
  729. struct se_lun *sep_lun;
  730. struct se_portal_group *sep_tpg;
  731. struct list_head sep_alua_list;
  732. struct list_head sep_list;
  733. };
  734. struct se_tpg_np {
  735. struct se_portal_group *tpg_np_parent;
  736. struct config_group tpg_np_group;
  737. };
  738. struct se_portal_group {
  739. /* Type of target portal group, see transport_tpg_type_table */
  740. enum transport_tpg_type_table se_tpg_type;
  741. /* Number of ACLed Initiator Nodes for this TPG */
  742. u32 num_node_acls;
  743. /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
  744. atomic_t tpg_pr_ref_count;
  745. /* Spinlock for adding/removing ACLed Nodes */
  746. spinlock_t acl_node_lock;
  747. /* Spinlock for adding/removing sessions */
  748. spinlock_t session_lock;
  749. spinlock_t tpg_lun_lock;
  750. /* Pointer to $FABRIC_MOD portal group */
  751. void *se_tpg_fabric_ptr;
  752. struct list_head se_tpg_node;
  753. /* linked list for initiator ACL list */
  754. struct list_head acl_node_list;
  755. struct se_lun **tpg_lun_list;
  756. struct se_lun tpg_virt_lun0;
  757. /* List of TCM sessions associated wth this TPG */
  758. struct list_head tpg_sess_list;
  759. /* Pointer to $FABRIC_MOD dependent code */
  760. struct target_core_fabric_ops *se_tpg_tfo;
  761. struct se_wwn *se_tpg_wwn;
  762. struct config_group tpg_group;
  763. struct config_group *tpg_default_groups[7];
  764. struct config_group tpg_lun_group;
  765. struct config_group tpg_np_group;
  766. struct config_group tpg_acl_group;
  767. struct config_group tpg_attrib_group;
  768. struct config_group tpg_auth_group;
  769. struct config_group tpg_param_group;
  770. };
  771. struct se_wwn {
  772. struct target_fabric_configfs *wwn_tf;
  773. struct config_group wwn_group;
  774. struct config_group *wwn_default_groups[2];
  775. struct config_group fabric_stat_group;
  776. };
  777. #endif /* TARGET_CORE_BASE_H */