target_core_base.h 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934
  1. #ifndef TARGET_CORE_BASE_H
  2. #define TARGET_CORE_BASE_H
  3. #include <linux/configfs.h> /* struct config_group */
  4. #include <linux/dma-direction.h> /* enum dma_data_direction */
  5. #include <linux/percpu_ida.h> /* struct percpu_ida */
  6. #include <linux/semaphore.h> /* struct semaphore */
  7. #define TARGET_CORE_VERSION "v5.0"
  8. /*
  9. * Maximum size of a CDB that can be stored in se_cmd without allocating
  10. * memory dynamically for the CDB.
  11. */
  12. #define TCM_MAX_COMMAND_SIZE 32
  13. /*
  14. * From include/scsi/scsi_cmnd.h:SCSI_SENSE_BUFFERSIZE, currently
  15. * defined 96, but the real limit is 252 (or 260 including the header)
  16. */
  17. #define TRANSPORT_SENSE_BUFFER 96
  18. /* Used by transport_send_check_condition_and_sense() */
  19. #define SPC_SENSE_KEY_OFFSET 2
  20. #define SPC_ADD_SENSE_LEN_OFFSET 7
  21. #define SPC_DESC_TYPE_OFFSET 8
  22. #define SPC_ADDITIONAL_DESC_LEN_OFFSET 9
  23. #define SPC_VALIDITY_OFFSET 10
  24. #define SPC_ASC_KEY_OFFSET 12
  25. #define SPC_ASCQ_KEY_OFFSET 13
  26. #define TRANSPORT_IQN_LEN 224
  27. /* Used by target_core_store_alua_lu_gp() and target_core_alua_lu_gp_show_attr_members() */
  28. #define LU_GROUP_NAME_BUF 256
  29. /* Used by core_alua_store_tg_pt_gp_info() and target_core_alua_tg_pt_gp_show_attr_members() */
  30. #define TG_PT_GROUP_NAME_BUF 256
  31. /* Used to parse VPD into struct t10_vpd */
  32. #define VPD_TMP_BUF_SIZE 254
  33. /* Used by transport_generic_cmd_sequencer() */
  34. #define READ_BLOCK_LEN 6
  35. #define READ_CAP_LEN 8
  36. #define READ_POSITION_LEN 20
  37. #define INQUIRY_LEN 36
  38. /* Used by transport_get_inquiry_vpd_serial() */
  39. #define INQUIRY_VPD_SERIAL_LEN 254
  40. /* Used by transport_get_inquiry_vpd_device_ident() */
  41. #define INQUIRY_VPD_DEVICE_IDENTIFIER_LEN 254
  42. /* Attempts before moving from SHORT to LONG */
  43. #define PYX_TRANSPORT_WINDOW_CLOSED_THRESHOLD 3
  44. #define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_SHORT 3 /* In milliseconds */
  45. #define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_LONG 10 /* In milliseconds */
  46. #define PYX_TRANSPORT_STATUS_INTERVAL 5 /* In seconds */
  47. /* struct se_dev_attrib sanity values */
  48. /* Default max_unmap_lba_count */
  49. #define DA_MAX_UNMAP_LBA_COUNT 0
  50. /* Default max_unmap_block_desc_count */
  51. #define DA_MAX_UNMAP_BLOCK_DESC_COUNT 0
  52. /* Default unmap_granularity */
  53. #define DA_UNMAP_GRANULARITY_DEFAULT 0
  54. /* Default unmap_granularity_alignment */
  55. #define DA_UNMAP_GRANULARITY_ALIGNMENT_DEFAULT 0
  56. /* Default unmap_zeroes_data */
  57. #define DA_UNMAP_ZEROES_DATA_DEFAULT 0
  58. /* Default max_write_same_len, disabled by default */
  59. #define DA_MAX_WRITE_SAME_LEN 0
  60. /* Use a model alias based on the configfs backend device name */
  61. #define DA_EMULATE_MODEL_ALIAS 0
  62. /* Emulation for WriteCache and SYNCHRONIZE_CACHE */
  63. #define DA_EMULATE_WRITE_CACHE 0
  64. /* Emulation for UNIT ATTENTION Interlock Control */
  65. #define DA_EMULATE_UA_INTLLCK_CTRL 0
  66. /* Emulation for TASK_ABORTED status (TAS) by default */
  67. #define DA_EMULATE_TAS 1
  68. /* Emulation for Thin Provisioning UNMAP using block/blk-lib.c:blkdev_issue_discard() */
  69. #define DA_EMULATE_TPU 0
  70. /*
  71. * Emulation for Thin Provisioning WRITE_SAME w/ UNMAP=1 bit using
  72. * block/blk-lib.c:blkdev_issue_discard()
  73. */
  74. #define DA_EMULATE_TPWS 0
  75. /* Emulation for CompareAndWrite (AtomicTestandSet) by default */
  76. #define DA_EMULATE_CAW 1
  77. /* Emulation for 3rd Party Copy (ExtendedCopy) by default */
  78. #define DA_EMULATE_3PC 1
  79. /* No Emulation for PSCSI by default */
  80. #define DA_EMULATE_ALUA 0
  81. /* Enforce SCSI Initiator Port TransportID with 'ISID' for PR */
  82. #define DA_ENFORCE_PR_ISIDS 1
  83. /* Force SPC-3 PR Activate Persistence across Target Power Loss */
  84. #define DA_FORCE_PR_APTPL 0
  85. #define DA_STATUS_MAX_SECTORS_MIN 16
  86. #define DA_STATUS_MAX_SECTORS_MAX 8192
  87. /* By default don't report non-rotating (solid state) medium */
  88. #define DA_IS_NONROT 0
  89. /* Queue Algorithm Modifier default for restricted reordering in control mode page */
  90. #define DA_EMULATE_REST_REORD 0
  91. #define SE_INQUIRY_BUF 1024
  92. #define SE_MODE_PAGE_BUF 512
  93. #define SE_SENSE_BUF 96
  94. /* struct se_hba->hba_flags */
  95. enum hba_flags_table {
  96. HBA_FLAGS_INTERNAL_USE = 0x01,
  97. HBA_FLAGS_PSCSI_MODE = 0x02,
  98. };
  99. /* Special transport agnostic struct se_cmd->t_states */
  100. enum transport_state_table {
  101. TRANSPORT_NO_STATE = 0,
  102. TRANSPORT_NEW_CMD = 1,
  103. TRANSPORT_WRITE_PENDING = 3,
  104. TRANSPORT_PROCESSING = 5,
  105. TRANSPORT_COMPLETE = 6,
  106. TRANSPORT_ISTATE_PROCESSING = 11,
  107. TRANSPORT_COMPLETE_QF_WP = 18,
  108. TRANSPORT_COMPLETE_QF_OK = 19,
  109. };
  110. /* Used for struct se_cmd->se_cmd_flags */
  111. enum se_cmd_flags_table {
  112. SCF_SUPPORTED_SAM_OPCODE = 0x00000001,
  113. SCF_TRANSPORT_TASK_SENSE = 0x00000002,
  114. SCF_EMULATED_TASK_SENSE = 0x00000004,
  115. SCF_SCSI_DATA_CDB = 0x00000008,
  116. SCF_SCSI_TMR_CDB = 0x00000010,
  117. SCF_FUA = 0x00000080,
  118. SCF_SE_LUN_CMD = 0x00000100,
  119. SCF_BIDI = 0x00000400,
  120. SCF_SENT_CHECK_CONDITION = 0x00000800,
  121. SCF_OVERFLOW_BIT = 0x00001000,
  122. SCF_UNDERFLOW_BIT = 0x00002000,
  123. SCF_SEND_DELAYED_TAS = 0x00004000,
  124. SCF_ALUA_NON_OPTIMIZED = 0x00008000,
  125. SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC = 0x00020000,
  126. SCF_COMPARE_AND_WRITE = 0x00080000,
  127. SCF_COMPARE_AND_WRITE_POST = 0x00100000,
  128. SCF_PASSTHROUGH_PROT_SG_TO_MEM_NOALLOC = 0x00200000,
  129. SCF_ACK_KREF = 0x00400000,
  130. SCF_USE_CPUID = 0x00800000,
  131. SCF_TASK_ATTR_SET = 0x01000000,
  132. };
  133. /*
  134. * Used by transport_send_check_condition_and_sense()
  135. * to signal which ASC/ASCQ sense payload should be built.
  136. */
  137. typedef unsigned __bitwise sense_reason_t;
  138. enum tcm_sense_reason_table {
  139. #define R(x) (__force sense_reason_t )(x)
  140. TCM_NO_SENSE = R(0x00),
  141. TCM_NON_EXISTENT_LUN = R(0x01),
  142. TCM_UNSUPPORTED_SCSI_OPCODE = R(0x02),
  143. TCM_INCORRECT_AMOUNT_OF_DATA = R(0x03),
  144. TCM_UNEXPECTED_UNSOLICITED_DATA = R(0x04),
  145. TCM_SERVICE_CRC_ERROR = R(0x05),
  146. TCM_SNACK_REJECTED = R(0x06),
  147. TCM_SECTOR_COUNT_TOO_MANY = R(0x07),
  148. TCM_INVALID_CDB_FIELD = R(0x08),
  149. TCM_INVALID_PARAMETER_LIST = R(0x09),
  150. TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE = R(0x0a),
  151. TCM_UNKNOWN_MODE_PAGE = R(0x0b),
  152. TCM_WRITE_PROTECTED = R(0x0c),
  153. TCM_CHECK_CONDITION_ABORT_CMD = R(0x0d),
  154. TCM_CHECK_CONDITION_UNIT_ATTENTION = R(0x0e),
  155. TCM_CHECK_CONDITION_NOT_READY = R(0x0f),
  156. TCM_RESERVATION_CONFLICT = R(0x10),
  157. TCM_ADDRESS_OUT_OF_RANGE = R(0x11),
  158. TCM_OUT_OF_RESOURCES = R(0x12),
  159. TCM_PARAMETER_LIST_LENGTH_ERROR = R(0x13),
  160. TCM_MISCOMPARE_VERIFY = R(0x14),
  161. TCM_LOGICAL_BLOCK_GUARD_CHECK_FAILED = R(0x15),
  162. TCM_LOGICAL_BLOCK_APP_TAG_CHECK_FAILED = R(0x16),
  163. TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED = R(0x17),
  164. TCM_COPY_TARGET_DEVICE_NOT_REACHABLE = R(0x18),
  165. TCM_TOO_MANY_TARGET_DESCS = R(0x19),
  166. TCM_UNSUPPORTED_TARGET_DESC_TYPE_CODE = R(0x1a),
  167. TCM_TOO_MANY_SEGMENT_DESCS = R(0x1b),
  168. TCM_UNSUPPORTED_SEGMENT_DESC_TYPE_CODE = R(0x1c),
  169. #undef R
  170. };
  171. enum target_sc_flags_table {
  172. TARGET_SCF_BIDI_OP = 0x01,
  173. TARGET_SCF_ACK_KREF = 0x02,
  174. TARGET_SCF_UNKNOWN_SIZE = 0x04,
  175. TARGET_SCF_USE_CPUID = 0x08,
  176. };
  177. /* fabric independent task management function values */
  178. enum tcm_tmreq_table {
  179. TMR_ABORT_TASK = 1,
  180. TMR_ABORT_TASK_SET = 2,
  181. TMR_CLEAR_ACA = 3,
  182. TMR_CLEAR_TASK_SET = 4,
  183. TMR_LUN_RESET = 5,
  184. TMR_TARGET_WARM_RESET = 6,
  185. TMR_TARGET_COLD_RESET = 7,
  186. };
  187. /* fabric independent task management response values */
  188. enum tcm_tmrsp_table {
  189. TMR_FUNCTION_FAILED = 0,
  190. TMR_FUNCTION_COMPLETE = 1,
  191. TMR_TASK_DOES_NOT_EXIST = 2,
  192. TMR_LUN_DOES_NOT_EXIST = 3,
  193. TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED = 4,
  194. TMR_FUNCTION_REJECTED = 5,
  195. };
  196. /*
  197. * Used for target SCSI statistics
  198. */
  199. typedef enum {
  200. SCSI_INST_INDEX,
  201. SCSI_DEVICE_INDEX,
  202. SCSI_AUTH_INTR_INDEX,
  203. SCSI_INDEX_TYPE_MAX
  204. } scsi_index_t;
  205. struct se_cmd;
  206. struct t10_alua_lba_map_member {
  207. struct list_head lba_map_mem_list;
  208. int lba_map_mem_alua_state;
  209. int lba_map_mem_alua_pg_id;
  210. };
  211. struct t10_alua_lba_map {
  212. u64 lba_map_first_lba;
  213. u64 lba_map_last_lba;
  214. struct list_head lba_map_list;
  215. struct list_head lba_map_mem_list;
  216. };
  217. struct t10_alua {
  218. /* ALUA Target Port Group ID */
  219. u16 alua_tg_pt_gps_counter;
  220. u32 alua_tg_pt_gps_count;
  221. /* Referrals support */
  222. spinlock_t lba_map_lock;
  223. u32 lba_map_segment_size;
  224. u32 lba_map_segment_multiplier;
  225. struct list_head lba_map_list;
  226. spinlock_t tg_pt_gps_lock;
  227. struct se_device *t10_dev;
  228. /* Used for default ALUA Target Port Group */
  229. struct t10_alua_tg_pt_gp *default_tg_pt_gp;
  230. /* Used for default ALUA Target Port Group ConfigFS group */
  231. struct config_group alua_tg_pt_gps_group;
  232. struct list_head tg_pt_gps_list;
  233. };
  234. struct t10_alua_lu_gp {
  235. u16 lu_gp_id;
  236. int lu_gp_valid_id;
  237. u32 lu_gp_members;
  238. atomic_t lu_gp_ref_cnt;
  239. spinlock_t lu_gp_lock;
  240. struct config_group lu_gp_group;
  241. struct list_head lu_gp_node;
  242. struct list_head lu_gp_mem_list;
  243. };
  244. struct t10_alua_lu_gp_member {
  245. bool lu_gp_assoc;
  246. atomic_t lu_gp_mem_ref_cnt;
  247. spinlock_t lu_gp_mem_lock;
  248. struct t10_alua_lu_gp *lu_gp;
  249. struct se_device *lu_gp_mem_dev;
  250. struct list_head lu_gp_mem_list;
  251. };
  252. struct t10_alua_tg_pt_gp {
  253. u16 tg_pt_gp_id;
  254. int tg_pt_gp_valid_id;
  255. int tg_pt_gp_alua_supported_states;
  256. int tg_pt_gp_alua_pending_state;
  257. int tg_pt_gp_alua_previous_state;
  258. int tg_pt_gp_alua_access_status;
  259. int tg_pt_gp_alua_access_type;
  260. int tg_pt_gp_nonop_delay_msecs;
  261. int tg_pt_gp_trans_delay_msecs;
  262. int tg_pt_gp_implicit_trans_secs;
  263. int tg_pt_gp_pref;
  264. int tg_pt_gp_write_metadata;
  265. u32 tg_pt_gp_members;
  266. atomic_t tg_pt_gp_alua_access_state;
  267. atomic_t tg_pt_gp_ref_cnt;
  268. spinlock_t tg_pt_gp_lock;
  269. struct mutex tg_pt_gp_md_mutex;
  270. struct se_device *tg_pt_gp_dev;
  271. struct config_group tg_pt_gp_group;
  272. struct list_head tg_pt_gp_list;
  273. struct list_head tg_pt_gp_lun_list;
  274. struct se_lun *tg_pt_gp_alua_lun;
  275. struct se_node_acl *tg_pt_gp_alua_nacl;
  276. struct delayed_work tg_pt_gp_transition_work;
  277. struct completion *tg_pt_gp_transition_complete;
  278. };
  279. struct t10_vpd {
  280. unsigned char device_identifier[INQUIRY_VPD_DEVICE_IDENTIFIER_LEN];
  281. int protocol_identifier_set;
  282. u32 protocol_identifier;
  283. u32 device_identifier_code_set;
  284. u32 association;
  285. u32 device_identifier_type;
  286. struct list_head vpd_list;
  287. };
  288. struct t10_wwn {
  289. char vendor[8];
  290. char model[16];
  291. char revision[4];
  292. char unit_serial[INQUIRY_VPD_SERIAL_LEN];
  293. spinlock_t t10_vpd_lock;
  294. struct se_device *t10_dev;
  295. struct config_group t10_wwn_group;
  296. struct list_head t10_vpd_list;
  297. };
  298. struct 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. u16 pr_aptpl_rpti;
  311. u16 pr_reg_tpgt;
  312. /* Reservation effects all target ports */
  313. int pr_reg_all_tg_pt;
  314. /* Activate Persistence across Target Power Loss */
  315. int pr_reg_aptpl;
  316. int pr_res_holder;
  317. int pr_res_type;
  318. int pr_res_scope;
  319. /* Used for fabric initiator WWPNs using a ISID */
  320. bool isid_present_at_reg;
  321. u64 pr_res_mapped_lun;
  322. u64 pr_aptpl_target_lun;
  323. u16 tg_pt_sep_rtpi;
  324. u32 pr_res_generation;
  325. u64 pr_reg_bin_isid;
  326. u64 pr_res_key;
  327. atomic_t pr_res_holders;
  328. struct se_node_acl *pr_reg_nacl;
  329. /* Used by ALL_TG_PT=1 registration with deve->pr_ref taken */
  330. struct se_dev_entry *pr_reg_deve;
  331. struct list_head pr_reg_list;
  332. struct list_head pr_reg_abort_list;
  333. struct list_head pr_reg_aptpl_list;
  334. struct list_head pr_reg_atp_list;
  335. struct list_head pr_reg_atp_mem_list;
  336. };
  337. struct t10_reservation {
  338. /* Reservation effects all target ports */
  339. int pr_all_tg_pt;
  340. /* Activate Persistence across Target Power Loss enabled
  341. * for SCSI device */
  342. int pr_aptpl_active;
  343. #define PR_APTPL_BUF_LEN 262144
  344. u32 pr_generation;
  345. spinlock_t registration_lock;
  346. spinlock_t aptpl_reg_lock;
  347. /*
  348. * This will always be set by one individual I_T Nexus.
  349. * However with all_tg_pt=1, other I_T Nexus from the
  350. * same initiator can access PR reg/res info on a different
  351. * target port.
  352. *
  353. * There is also the 'All Registrants' case, where there is
  354. * a single *pr_res_holder of the reservation, but all
  355. * registrations are considered reservation holders.
  356. */
  357. struct se_node_acl *pr_res_holder;
  358. struct list_head registration_list;
  359. struct list_head aptpl_reg_list;
  360. };
  361. struct se_tmr_req {
  362. /* Task Management function to be performed */
  363. u8 function;
  364. /* Task Management response to send */
  365. u8 response;
  366. int call_transport;
  367. /* Reference to ITT that Task Mgmt should be performed */
  368. u64 ref_task_tag;
  369. void *fabric_tmr_ptr;
  370. struct se_cmd *task_cmd;
  371. struct se_device *tmr_dev;
  372. struct se_lun *tmr_lun;
  373. struct list_head tmr_list;
  374. };
  375. enum target_prot_op {
  376. TARGET_PROT_NORMAL = 0,
  377. TARGET_PROT_DIN_INSERT = (1 << 0),
  378. TARGET_PROT_DOUT_INSERT = (1 << 1),
  379. TARGET_PROT_DIN_STRIP = (1 << 2),
  380. TARGET_PROT_DOUT_STRIP = (1 << 3),
  381. TARGET_PROT_DIN_PASS = (1 << 4),
  382. TARGET_PROT_DOUT_PASS = (1 << 5),
  383. };
  384. #define TARGET_PROT_ALL TARGET_PROT_DIN_INSERT | TARGET_PROT_DOUT_INSERT | \
  385. TARGET_PROT_DIN_STRIP | TARGET_PROT_DOUT_STRIP | \
  386. TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS
  387. enum target_prot_type {
  388. TARGET_DIF_TYPE0_PROT,
  389. TARGET_DIF_TYPE1_PROT,
  390. TARGET_DIF_TYPE2_PROT,
  391. TARGET_DIF_TYPE3_PROT,
  392. };
  393. enum target_core_dif_check {
  394. TARGET_DIF_CHECK_GUARD = 0x1 << 0,
  395. TARGET_DIF_CHECK_APPTAG = 0x1 << 1,
  396. TARGET_DIF_CHECK_REFTAG = 0x1 << 2,
  397. };
  398. /* for sam_task_attr */
  399. #define TCM_SIMPLE_TAG 0x20
  400. #define TCM_HEAD_TAG 0x21
  401. #define TCM_ORDERED_TAG 0x22
  402. #define TCM_ACA_TAG 0x24
  403. struct se_cmd {
  404. /* SAM response code being sent to initiator */
  405. u8 scsi_status;
  406. u8 scsi_asc;
  407. u8 scsi_ascq;
  408. u16 scsi_sense_length;
  409. unsigned cmd_wait_set:1;
  410. unsigned unknown_data_length:1;
  411. bool state_active:1;
  412. u64 tag; /* SAM command identifier aka task tag */
  413. /* Delay for ALUA Active/NonOptimized state access in milliseconds */
  414. int alua_nonop_delay;
  415. /* See include/linux/dma-mapping.h */
  416. enum dma_data_direction data_direction;
  417. /* For SAM Task Attribute */
  418. int sam_task_attr;
  419. /* Used for se_sess->sess_tag_pool */
  420. unsigned int map_tag;
  421. /* Transport protocol dependent state, see transport_state_table */
  422. enum transport_state_table t_state;
  423. /* See se_cmd_flags_table */
  424. u32 se_cmd_flags;
  425. /* Total size in bytes associated with command */
  426. u32 data_length;
  427. u32 residual_count;
  428. u64 orig_fe_lun;
  429. /* Persistent Reservation key */
  430. u64 pr_res_key;
  431. /* Used for sense data */
  432. void *sense_buffer;
  433. struct list_head se_delayed_node;
  434. struct list_head se_qf_node;
  435. struct se_device *se_dev;
  436. struct se_lun *se_lun;
  437. /* Only used for internal passthrough and legacy TCM fabric modules */
  438. struct se_session *se_sess;
  439. struct se_tmr_req *se_tmr_req;
  440. struct list_head se_cmd_list;
  441. struct completion cmd_wait_comp;
  442. const struct target_core_fabric_ops *se_tfo;
  443. sense_reason_t (*execute_cmd)(struct se_cmd *);
  444. sense_reason_t (*transport_complete_callback)(struct se_cmd *, bool, int *);
  445. void *protocol_data;
  446. unsigned char *t_task_cdb;
  447. unsigned char __t_task_cdb[TCM_MAX_COMMAND_SIZE];
  448. unsigned long long t_task_lba;
  449. unsigned int t_task_nolb;
  450. unsigned int transport_state;
  451. #define CMD_T_ABORTED (1 << 0)
  452. #define CMD_T_ACTIVE (1 << 1)
  453. #define CMD_T_COMPLETE (1 << 2)
  454. #define CMD_T_SENT (1 << 4)
  455. #define CMD_T_STOP (1 << 5)
  456. #define CMD_T_DEV_ACTIVE (1 << 7)
  457. #define CMD_T_BUSY (1 << 9)
  458. #define CMD_T_TAS (1 << 10)
  459. #define CMD_T_FABRIC_STOP (1 << 11)
  460. spinlock_t t_state_lock;
  461. struct kref cmd_kref;
  462. struct completion t_transport_stop_comp;
  463. struct work_struct work;
  464. struct scatterlist *t_data_sg;
  465. struct scatterlist *t_data_sg_orig;
  466. unsigned int t_data_nents;
  467. unsigned int t_data_nents_orig;
  468. void *t_data_vmap;
  469. struct scatterlist *t_bidi_data_sg;
  470. unsigned int t_bidi_data_nents;
  471. /* Used for lun->lun_ref counting */
  472. int lun_ref_active;
  473. struct list_head state_list;
  474. /* backend private data */
  475. void *priv;
  476. /* DIF related members */
  477. enum target_prot_op prot_op;
  478. enum target_prot_type prot_type;
  479. u8 prot_checks;
  480. bool prot_pto;
  481. u32 prot_length;
  482. u32 reftag_seed;
  483. struct scatterlist *t_prot_sg;
  484. unsigned int t_prot_nents;
  485. sense_reason_t pi_err;
  486. sector_t bad_sector;
  487. int cpuid;
  488. };
  489. struct se_ua {
  490. u8 ua_asc;
  491. u8 ua_ascq;
  492. struct list_head ua_nacl_list;
  493. };
  494. struct se_node_acl {
  495. char initiatorname[TRANSPORT_IQN_LEN];
  496. /* Used to signal demo mode created ACL, disabled by default */
  497. bool dynamic_node_acl;
  498. u32 queue_depth;
  499. u32 acl_index;
  500. enum target_prot_type saved_prot_type;
  501. #define MAX_ACL_TAG_SIZE 64
  502. char acl_tag[MAX_ACL_TAG_SIZE];
  503. /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
  504. atomic_t acl_pr_ref_count;
  505. struct hlist_head lun_entry_hlist;
  506. struct se_session *nacl_sess;
  507. struct se_portal_group *se_tpg;
  508. struct mutex lun_entry_mutex;
  509. spinlock_t nacl_sess_lock;
  510. struct config_group acl_group;
  511. struct config_group acl_attrib_group;
  512. struct config_group acl_auth_group;
  513. struct config_group acl_param_group;
  514. struct config_group acl_fabric_stat_group;
  515. struct list_head acl_list;
  516. struct list_head acl_sess_list;
  517. struct completion acl_free_comp;
  518. struct kref acl_kref;
  519. };
  520. static inline struct se_node_acl *acl_to_nacl(struct config_item *item)
  521. {
  522. return container_of(to_config_group(item), struct se_node_acl,
  523. acl_group);
  524. }
  525. static inline struct se_node_acl *attrib_to_nacl(struct config_item *item)
  526. {
  527. return container_of(to_config_group(item), struct se_node_acl,
  528. acl_attrib_group);
  529. }
  530. static inline struct se_node_acl *auth_to_nacl(struct config_item *item)
  531. {
  532. return container_of(to_config_group(item), struct se_node_acl,
  533. acl_auth_group);
  534. }
  535. static inline struct se_node_acl *param_to_nacl(struct config_item *item)
  536. {
  537. return container_of(to_config_group(item), struct se_node_acl,
  538. acl_param_group);
  539. }
  540. static inline struct se_node_acl *fabric_stat_to_nacl(struct config_item *item)
  541. {
  542. return container_of(to_config_group(item), struct se_node_acl,
  543. acl_fabric_stat_group);
  544. }
  545. struct se_session {
  546. unsigned sess_tearing_down:1;
  547. u64 sess_bin_isid;
  548. enum target_prot_op sup_prot_ops;
  549. enum target_prot_type sess_prot_type;
  550. struct se_node_acl *se_node_acl;
  551. struct se_portal_group *se_tpg;
  552. void *fabric_sess_ptr;
  553. struct list_head sess_list;
  554. struct list_head sess_acl_list;
  555. struct list_head sess_cmd_list;
  556. struct list_head sess_wait_list;
  557. spinlock_t sess_cmd_lock;
  558. void *sess_cmd_map;
  559. struct percpu_ida sess_tag_pool;
  560. };
  561. struct se_device;
  562. struct se_transform_info;
  563. struct scatterlist;
  564. struct se_ml_stat_grps {
  565. struct config_group stat_group;
  566. struct config_group scsi_auth_intr_group;
  567. struct config_group scsi_att_intr_port_group;
  568. };
  569. struct se_lun_acl {
  570. u64 mapped_lun;
  571. struct se_node_acl *se_lun_nacl;
  572. struct se_lun *se_lun;
  573. struct config_group se_lun_group;
  574. struct se_ml_stat_grps ml_stat_grps;
  575. };
  576. struct se_dev_entry {
  577. u64 mapped_lun;
  578. u64 pr_res_key;
  579. u64 creation_time;
  580. bool lun_access_ro;
  581. u32 attach_count;
  582. atomic_long_t total_cmds;
  583. atomic_long_t read_bytes;
  584. atomic_long_t write_bytes;
  585. atomic_t ua_count;
  586. /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
  587. struct kref pr_kref;
  588. struct completion pr_comp;
  589. struct se_lun_acl __rcu *se_lun_acl;
  590. spinlock_t ua_lock;
  591. struct se_lun __rcu *se_lun;
  592. #define DEF_PR_REG_ACTIVE 1
  593. unsigned long deve_flags;
  594. struct list_head alua_port_list;
  595. struct list_head lun_link;
  596. struct list_head ua_list;
  597. struct hlist_node link;
  598. struct rcu_head rcu_head;
  599. };
  600. struct se_dev_attrib {
  601. int emulate_model_alias;
  602. int emulate_dpo;
  603. int emulate_fua_write;
  604. int emulate_fua_read;
  605. int emulate_write_cache;
  606. int emulate_ua_intlck_ctrl;
  607. int emulate_tas;
  608. int emulate_tpu;
  609. int emulate_tpws;
  610. int emulate_caw;
  611. int emulate_3pc;
  612. int pi_prot_format;
  613. enum target_prot_type pi_prot_type;
  614. enum target_prot_type hw_pi_prot_type;
  615. int enforce_pr_isids;
  616. int force_pr_aptpl;
  617. int is_nonrot;
  618. int emulate_rest_reord;
  619. int unmap_zeroes_data;
  620. u32 hw_block_size;
  621. u32 block_size;
  622. u32 hw_max_sectors;
  623. u32 optimal_sectors;
  624. u32 hw_queue_depth;
  625. u32 queue_depth;
  626. u32 max_unmap_lba_count;
  627. u32 max_unmap_block_desc_count;
  628. u32 unmap_granularity;
  629. u32 unmap_granularity_alignment;
  630. u32 max_write_same_len;
  631. u32 max_bytes_per_io;
  632. struct se_device *da_dev;
  633. struct config_group da_group;
  634. };
  635. struct se_port_stat_grps {
  636. struct config_group stat_group;
  637. struct config_group scsi_port_group;
  638. struct config_group scsi_tgt_port_group;
  639. struct config_group scsi_transport_group;
  640. };
  641. struct scsi_port_stats {
  642. atomic_long_t cmd_pdus;
  643. atomic_long_t tx_data_octets;
  644. atomic_long_t rx_data_octets;
  645. };
  646. struct se_lun {
  647. u64 unpacked_lun;
  648. #define SE_LUN_LINK_MAGIC 0xffff7771
  649. u32 lun_link_magic;
  650. bool lun_access_ro;
  651. u32 lun_index;
  652. /* RELATIVE TARGET PORT IDENTIFER */
  653. u16 lun_rtpi;
  654. atomic_t lun_acl_count;
  655. struct se_device __rcu *lun_se_dev;
  656. struct list_head lun_deve_list;
  657. spinlock_t lun_deve_lock;
  658. /* ALUA state */
  659. int lun_tg_pt_secondary_stat;
  660. int lun_tg_pt_secondary_write_md;
  661. atomic_t lun_tg_pt_secondary_offline;
  662. struct mutex lun_tg_pt_md_mutex;
  663. /* ALUA target port group linkage */
  664. struct list_head lun_tg_pt_gp_link;
  665. struct t10_alua_tg_pt_gp *lun_tg_pt_gp;
  666. spinlock_t lun_tg_pt_gp_lock;
  667. struct se_portal_group *lun_tpg;
  668. struct scsi_port_stats lun_stats;
  669. struct config_group lun_group;
  670. struct se_port_stat_grps port_stat_grps;
  671. struct completion lun_ref_comp;
  672. struct percpu_ref lun_ref;
  673. struct list_head lun_dev_link;
  674. struct hlist_node link;
  675. struct rcu_head rcu_head;
  676. };
  677. struct se_dev_stat_grps {
  678. struct config_group stat_group;
  679. struct config_group scsi_dev_group;
  680. struct config_group scsi_tgt_dev_group;
  681. struct config_group scsi_lu_group;
  682. };
  683. struct se_device {
  684. #define SE_DEV_LINK_MAGIC 0xfeeddeef
  685. u32 dev_link_magic;
  686. /* RELATIVE TARGET PORT IDENTIFER Counter */
  687. u16 dev_rpti_counter;
  688. /* Used for SAM Task Attribute ordering */
  689. u32 dev_cur_ordered_id;
  690. u32 dev_flags;
  691. #define DF_CONFIGURED 0x00000001
  692. #define DF_FIRMWARE_VPD_UNIT_SERIAL 0x00000002
  693. #define DF_EMULATED_VPD_UNIT_SERIAL 0x00000004
  694. #define DF_USING_UDEV_PATH 0x00000008
  695. #define DF_USING_ALIAS 0x00000010
  696. #define DF_READ_ONLY 0x00000020
  697. /* Physical device queue depth */
  698. u32 queue_depth;
  699. /* Used for SPC-2 reservations enforce of ISIDs */
  700. u64 dev_res_bin_isid;
  701. /* Pointer to transport specific device structure */
  702. u32 dev_index;
  703. u64 creation_time;
  704. atomic_long_t num_resets;
  705. atomic_long_t num_cmds;
  706. atomic_long_t read_bytes;
  707. atomic_long_t write_bytes;
  708. /* Active commands on this virtual SE device */
  709. atomic_t simple_cmds;
  710. atomic_t dev_ordered_sync;
  711. atomic_t dev_qf_count;
  712. u32 export_count;
  713. spinlock_t delayed_cmd_lock;
  714. spinlock_t execute_task_lock;
  715. spinlock_t dev_reservation_lock;
  716. unsigned int dev_reservation_flags;
  717. #define DRF_SPC2_RESERVATIONS 0x00000001
  718. #define DRF_SPC2_RESERVATIONS_WITH_ISID 0x00000002
  719. spinlock_t se_port_lock;
  720. spinlock_t se_tmr_lock;
  721. spinlock_t qf_cmd_lock;
  722. struct semaphore caw_sem;
  723. /* Used for legacy SPC-2 reservationsa */
  724. struct se_node_acl *dev_reserved_node_acl;
  725. /* Used for ALUA Logical Unit Group membership */
  726. struct t10_alua_lu_gp_member *dev_alua_lu_gp_mem;
  727. /* Used for SPC-3 Persistent Reservations */
  728. struct t10_pr_registration *dev_pr_res_holder;
  729. struct list_head dev_sep_list;
  730. struct list_head dev_tmr_list;
  731. struct workqueue_struct *tmr_wq;
  732. struct work_struct qf_work_queue;
  733. struct list_head delayed_cmd_list;
  734. struct list_head state_list;
  735. struct list_head qf_cmd_list;
  736. struct list_head g_dev_node;
  737. /* Pointer to associated SE HBA */
  738. struct se_hba *se_hba;
  739. /* T10 Inquiry and VPD WWN Information */
  740. struct t10_wwn t10_wwn;
  741. /* T10 Asymmetric Logical Unit Assignment for Target Ports */
  742. struct t10_alua t10_alua;
  743. /* T10 SPC-2 + SPC-3 Reservations */
  744. struct t10_reservation t10_pr;
  745. struct se_dev_attrib dev_attrib;
  746. struct config_group dev_group;
  747. struct config_group dev_pr_group;
  748. struct se_dev_stat_grps dev_stat_grps;
  749. #define SE_DEV_ALIAS_LEN 512 /* must be less than PAGE_SIZE */
  750. unsigned char dev_alias[SE_DEV_ALIAS_LEN];
  751. #define SE_UDEV_PATH_LEN 512 /* must be less than PAGE_SIZE */
  752. unsigned char udev_path[SE_UDEV_PATH_LEN];
  753. /* Pointer to template of function pointers for transport */
  754. const struct target_backend_ops *transport;
  755. /* Linked list for struct se_hba struct se_device list */
  756. struct list_head dev_list;
  757. struct se_lun xcopy_lun;
  758. /* Protection Information */
  759. int prot_length;
  760. /* For se_lun->lun_se_dev RCU read-side critical access */
  761. u32 hba_index;
  762. struct rcu_head rcu_head;
  763. };
  764. struct se_hba {
  765. u16 hba_tpgt;
  766. u32 hba_id;
  767. /* See hba_flags_table */
  768. u32 hba_flags;
  769. /* Virtual iSCSI devices attached. */
  770. u32 dev_count;
  771. u32 hba_index;
  772. /* Pointer to transport specific host structure. */
  773. void *hba_ptr;
  774. struct list_head hba_node;
  775. spinlock_t device_lock;
  776. struct config_group hba_group;
  777. struct mutex hba_access_mutex;
  778. struct target_backend *backend;
  779. };
  780. struct se_tpg_np {
  781. struct se_portal_group *tpg_np_parent;
  782. struct config_group tpg_np_group;
  783. };
  784. static inline struct se_tpg_np *to_tpg_np(struct config_item *item)
  785. {
  786. return container_of(to_config_group(item), struct se_tpg_np,
  787. tpg_np_group);
  788. }
  789. struct se_portal_group {
  790. /*
  791. * PROTOCOL IDENTIFIER value per SPC4, 7.5.1.
  792. *
  793. * Negative values can be used by fabric drivers for internal use TPGs.
  794. */
  795. int proto_id;
  796. /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
  797. atomic_t tpg_pr_ref_count;
  798. /* Spinlock for adding/removing ACLed Nodes */
  799. struct mutex acl_node_mutex;
  800. /* Spinlock for adding/removing sessions */
  801. spinlock_t session_lock;
  802. struct mutex tpg_lun_mutex;
  803. struct list_head se_tpg_node;
  804. /* linked list for initiator ACL list */
  805. struct list_head acl_node_list;
  806. struct hlist_head tpg_lun_hlist;
  807. struct se_lun *tpg_virt_lun0;
  808. /* List of TCM sessions associated wth this TPG */
  809. struct list_head tpg_sess_list;
  810. /* Pointer to $FABRIC_MOD dependent code */
  811. const struct target_core_fabric_ops *se_tpg_tfo;
  812. struct se_wwn *se_tpg_wwn;
  813. struct config_group tpg_group;
  814. struct config_group tpg_lun_group;
  815. struct config_group tpg_np_group;
  816. struct config_group tpg_acl_group;
  817. struct config_group tpg_attrib_group;
  818. struct config_group tpg_auth_group;
  819. struct config_group tpg_param_group;
  820. };
  821. static inline struct se_portal_group *to_tpg(struct config_item *item)
  822. {
  823. return container_of(to_config_group(item), struct se_portal_group,
  824. tpg_group);
  825. }
  826. static inline struct se_portal_group *attrib_to_tpg(struct config_item *item)
  827. {
  828. return container_of(to_config_group(item), struct se_portal_group,
  829. tpg_attrib_group);
  830. }
  831. static inline struct se_portal_group *auth_to_tpg(struct config_item *item)
  832. {
  833. return container_of(to_config_group(item), struct se_portal_group,
  834. tpg_auth_group);
  835. }
  836. static inline struct se_portal_group *param_to_tpg(struct config_item *item)
  837. {
  838. return container_of(to_config_group(item), struct se_portal_group,
  839. tpg_param_group);
  840. }
  841. struct se_wwn {
  842. struct target_fabric_configfs *wwn_tf;
  843. struct config_group wwn_group;
  844. struct config_group fabric_stat_group;
  845. };
  846. static inline void atomic_inc_mb(atomic_t *v)
  847. {
  848. smp_mb__before_atomic();
  849. atomic_inc(v);
  850. smp_mb__after_atomic();
  851. }
  852. static inline void atomic_dec_mb(atomic_t *v)
  853. {
  854. smp_mb__before_atomic();
  855. atomic_dec(v);
  856. smp_mb__after_atomic();
  857. }
  858. #endif /* TARGET_CORE_BASE_H */