target_core_base.h 27 KB

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