target_core_base.h 26 KB

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