1c66ac9dbSNicholas Bellinger /* SPDX-License-Identifier: GPL-2.0 */ 2c66ac9dbSNicholas Bellinger #ifndef TARGET_CORE_ALUA_H 3c66ac9dbSNicholas Bellinger #define TARGET_CORE_ALUA_H 48dcf07beSBart Van Assche 58dcf07beSBart Van Assche #include <target/target_core_base.h> 6c66ac9dbSNicholas Bellinger 7c66ac9dbSNicholas Bellinger /* 8c66ac9dbSNicholas Bellinger * INQUIRY response data, TPGS Field 9c66ac9dbSNicholas Bellinger * 10c66ac9dbSNicholas Bellinger * from spc4r17 section 6.4.2 Table 135 11c66ac9dbSNicholas Bellinger */ 12125d0119SHannes Reinecke #define TPGS_NO_ALUA 0x00 13125d0119SHannes Reinecke #define TPGS_IMPLICIT_ALUA 0x10 14c66ac9dbSNicholas Bellinger #define TPGS_EXPLICIT_ALUA 0x20 15c66ac9dbSNicholas Bellinger 16c66ac9dbSNicholas Bellinger /* 17c66ac9dbSNicholas Bellinger * ASYMMETRIC ACCESS STATE field 18c66094bfSHannes Reinecke * 19c66ac9dbSNicholas Bellinger * from spc4r36j section 6.37 Table 307 2073f3bf51SHannes Reinecke */ 21c66ac9dbSNicholas Bellinger #define ALUA_ACCESS_STATE_ACTIVE_OPTIMIZED 0x0 22c66ac9dbSNicholas Bellinger #define ALUA_ACCESS_STATE_ACTIVE_NON_OPTIMIZED 0x1 23c66ac9dbSNicholas Bellinger #define ALUA_ACCESS_STATE_STANDBY 0x2 24c66094bfSHannes Reinecke #define ALUA_ACCESS_STATE_UNAVAILABLE 0x3 25c66ac9dbSNicholas Bellinger #define ALUA_ACCESS_STATE_LBA_DEPENDENT 0x4 26c66ac9dbSNicholas Bellinger #define ALUA_ACCESS_STATE_OFFLINE 0xe 27c66ac9dbSNicholas Bellinger #define ALUA_ACCESS_STATE_TRANSITION 0xf 28c66ac9dbSNicholas Bellinger 29c0dc941eSHannes Reinecke /* 30c0dc941eSHannes Reinecke * from spc4r36j section 6.37 Table 306 31c0dc941eSHannes Reinecke */ 32c0dc941eSHannes Reinecke #define ALUA_T_SUP 0x80 33c0dc941eSHannes Reinecke #define ALUA_O_SUP 0x40 34c0dc941eSHannes Reinecke #define ALUA_LBD_SUP 0x10 35c0dc941eSHannes Reinecke #define ALUA_U_SUP 0x08 36c0dc941eSHannes Reinecke #define ALUA_S_SUP 0x04 37c0dc941eSHannes Reinecke #define ALUA_AN_SUP 0x02 38c0dc941eSHannes Reinecke #define ALUA_AO_SUP 0x01 39c0dc941eSHannes Reinecke 40c66ac9dbSNicholas Bellinger /* 41c66ac9dbSNicholas Bellinger * REPORT_TARGET_PORT_GROUP STATUS CODE 42c66ac9dbSNicholas Bellinger * 43c66ac9dbSNicholas Bellinger * from spc4r17 section 6.27 Table 246 44c66ac9dbSNicholas Bellinger */ 45125d0119SHannes Reinecke #define ALUA_STATUS_NONE 0x00 46125d0119SHannes Reinecke #define ALUA_STATUS_ALTERED_BY_EXPLICIT_STPG 0x01 47c66ac9dbSNicholas Bellinger #define ALUA_STATUS_ALTERED_BY_IMPLICIT_ALUA 0x02 48c66ac9dbSNicholas Bellinger 49c66ac9dbSNicholas Bellinger /* 50c66ac9dbSNicholas Bellinger * From spc4r17, Table D.1: ASC and ASCQ Assignement 51c66ac9dbSNicholas Bellinger */ 52c66ac9dbSNicholas Bellinger #define ASCQ_04H_ALUA_STATE_TRANSITION 0x0a 53c66ac9dbSNicholas Bellinger #define ASCQ_04H_ALUA_TG_PT_STANDBY 0x0b 54c66ac9dbSNicholas Bellinger #define ASCQ_04H_ALUA_TG_PT_UNAVAILABLE 0x0c 55c66ac9dbSNicholas Bellinger #define ASCQ_04H_ALUA_OFFLINE 0x12 56c66ac9dbSNicholas Bellinger 57c66ac9dbSNicholas Bellinger /* 58c66ac9dbSNicholas Bellinger * Used as the default for Active/NonOptimized delay (in milliseconds) 59c66ac9dbSNicholas Bellinger * This can also be changed via configfs on a per target port group basis.. 60c66ac9dbSNicholas Bellinger */ 61c66ac9dbSNicholas Bellinger #define ALUA_DEFAULT_NONOP_DELAY_MSECS 100 62c66ac9dbSNicholas Bellinger #define ALUA_MAX_NONOP_DELAY_MSECS 10000 /* 10 seconds */ 63125d0119SHannes Reinecke /* 64c66ac9dbSNicholas Bellinger * Used for implicit and explicit ALUA transitional delay, that is disabled 65c66ac9dbSNicholas Bellinger * by default, and is intended to be used for debugging client side ALUA code. 66c66ac9dbSNicholas Bellinger */ 67c66ac9dbSNicholas Bellinger #define ALUA_DEFAULT_TRANS_DELAY_MSECS 0 68c66ac9dbSNicholas Bellinger #define ALUA_MAX_TRANS_DELAY_MSECS 30000 /* 30 seconds */ 69125d0119SHannes Reinecke /* 705b9a4d72SNicholas Bellinger * Used for the recommended application client implicit transition timeout 715b9a4d72SNicholas Bellinger * in seconds, returned by the REPORT_TARGET_PORT_GROUPS w/ extended header. 72125d0119SHannes Reinecke */ 73125d0119SHannes Reinecke #define ALUA_DEFAULT_IMPLICIT_TRANS_SECS 0 74c66ac9dbSNicholas Bellinger #define ALUA_MAX_IMPLICIT_TRANS_SECS 255 751e0b9403SHannes Reinecke 761e0b9403SHannes Reinecke /* Used by core_alua_update_tpg_(primary,secondary)_metadata */ 771e0b9403SHannes Reinecke #define ALUA_MD_BUF_LEN 1024 78c66ac9dbSNicholas Bellinger 79c66ac9dbSNicholas Bellinger extern struct kmem_cache *t10_alua_lu_gp_cache; 80c66ac9dbSNicholas Bellinger extern struct kmem_cache *t10_alua_lu_gp_mem_cache; 81229d4f11SHannes Reinecke extern struct kmem_cache *t10_alua_tg_pt_gp_cache; 82229d4f11SHannes Reinecke extern struct kmem_cache *t10_alua_lba_map_cache; 83c66ac9dbSNicholas Bellinger extern struct kmem_cache *t10_alua_lba_map_mem_cache; 84de103c93SChristoph Hellwig 85de103c93SChristoph Hellwig extern sense_reason_t target_emulate_report_target_port_groups(struct se_cmd *); 86c66094bfSHannes Reinecke extern sense_reason_t target_emulate_set_target_port_groups(struct se_cmd *); 87c66ac9dbSNicholas Bellinger extern sense_reason_t target_emulate_report_referrals(struct se_cmd *); 88c66ac9dbSNicholas Bellinger extern int core_alua_check_nonop_delay(struct se_cmd *); 89adf653f9SChristoph Hellwig extern int core_alua_do_port_transition(struct t10_alua_tg_pt_gp *, 90c66ac9dbSNicholas Bellinger struct se_device *, struct se_lun *, 91c66ac9dbSNicholas Bellinger struct se_node_acl *, int, int); 92229d4f11SHannes Reinecke extern char *core_alua_dump_status(int); 93229d4f11SHannes Reinecke extern struct t10_alua_lba_map *core_alua_allocate_lba_map( 94229d4f11SHannes Reinecke struct list_head *, u64, u64); 95229d4f11SHannes Reinecke extern int core_alua_allocate_lba_map_mem(struct t10_alua_lba_map *, int, int); 96229d4f11SHannes Reinecke extern void core_alua_free_lba_map(struct list_head *); 97229d4f11SHannes Reinecke extern void core_alua_set_lba_map(struct se_device *, struct list_head *, 98c66ac9dbSNicholas Bellinger int, int); 99c66ac9dbSNicholas Bellinger extern struct t10_alua_lu_gp *core_alua_allocate_lu_gp(const char *, int); 100c66ac9dbSNicholas Bellinger extern int core_alua_set_lu_gp_id(struct t10_alua_lu_gp *, u16); 101c66ac9dbSNicholas Bellinger extern void core_alua_free_lu_gp(struct t10_alua_lu_gp *); 102c66ac9dbSNicholas Bellinger extern void core_alua_free_lu_gp_mem(struct se_device *); 103c66ac9dbSNicholas Bellinger extern struct t10_alua_lu_gp *core_alua_get_lu_gp_by_name(const char *); 104c66ac9dbSNicholas Bellinger extern void core_alua_put_lu_gp_from_name(struct t10_alua_lu_gp *); 105c66ac9dbSNicholas Bellinger extern void __core_alua_attach_lu_gp_mem(struct t10_alua_lu_gp_member *, 106c66ac9dbSNicholas Bellinger struct t10_alua_lu_gp *); 107c66ac9dbSNicholas Bellinger extern void __core_alua_drop_lu_gp_mem(struct t10_alua_lu_gp_member *, 108c66ac9dbSNicholas Bellinger struct t10_alua_lu_gp *); 109c66ac9dbSNicholas Bellinger extern void core_alua_drop_lu_gp_dev(struct se_device *); 1100fd97ccfSChristoph Hellwig extern struct t10_alua_tg_pt_gp *core_alua_allocate_tg_pt_gp( 111c66ac9dbSNicholas Bellinger struct se_device *, const char *, int); 112c66ac9dbSNicholas Bellinger extern int core_alua_set_tg_pt_gp_id(struct t10_alua_tg_pt_gp *, u16); 113adf653f9SChristoph Hellwig extern void core_alua_free_tg_pt_gp(struct t10_alua_tg_pt_gp *); 114adf653f9SChristoph Hellwig extern void target_detach_tg_pt_gp(struct se_lun *); 115adf653f9SChristoph Hellwig extern void target_attach_tg_pt_gp(struct se_lun *, struct t10_alua_tg_pt_gp *); 116adf653f9SChristoph Hellwig extern ssize_t core_alua_show_tg_pt_gp_info(struct se_lun *, char *); 117c66ac9dbSNicholas Bellinger extern ssize_t core_alua_store_tg_pt_gp_info(struct se_lun *, const char *, 118c66ac9dbSNicholas Bellinger size_t); 119c66ac9dbSNicholas Bellinger extern ssize_t core_alua_show_access_type(struct t10_alua_tg_pt_gp *, char *); 120c66ac9dbSNicholas Bellinger extern ssize_t core_alua_store_access_type(struct t10_alua_tg_pt_gp *, 121c66ac9dbSNicholas Bellinger const char *, size_t); 122c66ac9dbSNicholas Bellinger extern ssize_t core_alua_show_nonop_delay_msecs(struct t10_alua_tg_pt_gp *, 123c66ac9dbSNicholas Bellinger char *); 124c66ac9dbSNicholas Bellinger extern ssize_t core_alua_store_nonop_delay_msecs(struct t10_alua_tg_pt_gp *, 125c66ac9dbSNicholas Bellinger const char *, size_t); 126c66ac9dbSNicholas Bellinger extern ssize_t core_alua_show_trans_delay_msecs(struct t10_alua_tg_pt_gp *, 127c66ac9dbSNicholas Bellinger char *); 128c66ac9dbSNicholas Bellinger extern ssize_t core_alua_store_trans_delay_msecs(struct t10_alua_tg_pt_gp *, 129125d0119SHannes Reinecke const char *, size_t); 1305b9a4d72SNicholas Bellinger extern ssize_t core_alua_show_implicit_trans_secs(struct t10_alua_tg_pt_gp *, 131125d0119SHannes Reinecke char *); 1325b9a4d72SNicholas Bellinger extern ssize_t core_alua_store_implicit_trans_secs(struct t10_alua_tg_pt_gp *, 133c66ac9dbSNicholas Bellinger const char *, size_t); 134c66ac9dbSNicholas Bellinger extern ssize_t core_alua_show_preferred_bit(struct t10_alua_tg_pt_gp *, 135c66ac9dbSNicholas Bellinger char *); 136c66ac9dbSNicholas Bellinger extern ssize_t core_alua_store_preferred_bit(struct t10_alua_tg_pt_gp *, 137c66ac9dbSNicholas Bellinger const char *, size_t); 138c66ac9dbSNicholas Bellinger extern ssize_t core_alua_show_offline_bit(struct se_lun *, char *); 139c66ac9dbSNicholas Bellinger extern ssize_t core_alua_store_offline_bit(struct se_lun *, const char *, 140c66ac9dbSNicholas Bellinger size_t); 141c66ac9dbSNicholas Bellinger extern ssize_t core_alua_show_secondary_status(struct se_lun *, char *); 142c66ac9dbSNicholas Bellinger extern ssize_t core_alua_store_secondary_status(struct se_lun *, 143c66ac9dbSNicholas Bellinger const char *, size_t); 144c66ac9dbSNicholas Bellinger extern ssize_t core_alua_show_secondary_write_metadata(struct se_lun *, 145c66ac9dbSNicholas Bellinger char *); 146c66ac9dbSNicholas Bellinger extern ssize_t core_alua_store_secondary_write_metadata(struct se_lun *, 1470fd97ccfSChristoph Hellwig const char *, size_t); 148de103c93SChristoph Hellwig extern int core_setup_alua(struct se_device *); 149c66ac9dbSNicholas Bellinger extern sense_reason_t target_alua_state_check(struct se_cmd *cmd); 150c66ac9dbSNicholas Bellinger 151 #endif /* TARGET_CORE_ALUA_H */ 152