1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef TARGET_CORE_ALUA_H
3 #define TARGET_CORE_ALUA_H
5 #include <target/target_core_base.h>
8 * INQUIRY response data, TPGS Field
10 * from spc4r17 section 6.4.2 Table 135
12 #define TPGS_NO_ALUA 0x00
13 #define TPGS_IMPLICIT_ALUA 0x10
14 #define TPGS_EXPLICIT_ALUA 0x20
17 * ASYMMETRIC ACCESS STATE field
19 * from spc4r36j section 6.37 Table 307
21 #define ALUA_ACCESS_STATE_ACTIVE_OPTIMIZED 0x0
22 #define ALUA_ACCESS_STATE_ACTIVE_NON_OPTIMIZED 0x1
23 #define ALUA_ACCESS_STATE_STANDBY 0x2
24 #define ALUA_ACCESS_STATE_UNAVAILABLE 0x3
25 #define ALUA_ACCESS_STATE_LBA_DEPENDENT 0x4
26 #define ALUA_ACCESS_STATE_OFFLINE 0xe
27 #define ALUA_ACCESS_STATE_TRANSITION 0xf
30 * from spc4r36j section 6.37 Table 306
32 #define ALUA_T_SUP 0x80
33 #define ALUA_O_SUP 0x40
34 #define ALUA_LBD_SUP 0x10
35 #define ALUA_U_SUP 0x08
36 #define ALUA_S_SUP 0x04
37 #define ALUA_AN_SUP 0x02
38 #define ALUA_AO_SUP 0x01
41 * REPORT_TARGET_PORT_GROUP STATUS CODE
43 * from spc4r17 section 6.27 Table 246
45 #define ALUA_STATUS_NONE 0x00
46 #define ALUA_STATUS_ALTERED_BY_EXPLICIT_STPG 0x01
47 #define ALUA_STATUS_ALTERED_BY_IMPLICIT_ALUA 0x02
50 * From spc4r17, Table D.1: ASC and ASCQ Assignement
52 #define ASCQ_04H_ALUA_STATE_TRANSITION 0x0a
53 #define ASCQ_04H_ALUA_TG_PT_STANDBY 0x0b
54 #define ASCQ_04H_ALUA_TG_PT_UNAVAILABLE 0x0c
55 #define ASCQ_04H_ALUA_OFFLINE 0x12
58 * Used as the default for Active/NonOptimized delay (in milliseconds)
59 * This can also be changed via configfs on a per target port group basis..
61 #define ALUA_DEFAULT_NONOP_DELAY_MSECS 100
62 #define ALUA_MAX_NONOP_DELAY_MSECS 10000 /* 10 seconds */
64 * Used for implicit and explicit ALUA transitional delay, that is disabled
65 * by default, and is intended to be used for debugging client side ALUA code.
67 #define ALUA_DEFAULT_TRANS_DELAY_MSECS 0
68 #define ALUA_MAX_TRANS_DELAY_MSECS 30000 /* 30 seconds */
70 * Used for the recommended application client implicit transition timeout
71 * in seconds, returned by the REPORT_TARGET_PORT_GROUPS w/ extended header.
73 #define ALUA_DEFAULT_IMPLICIT_TRANS_SECS 0
74 #define ALUA_MAX_IMPLICIT_TRANS_SECS 255
76 * Used by core_alua_update_tpg_primary_metadata() and
77 * core_alua_update_tpg_secondary_metadata()
79 #define ALUA_METADATA_PATH_LEN 512
81 * Used by core_alua_update_tpg_secondary_metadata()
83 #define ALUA_SECONDARY_METADATA_WWN_LEN 256
85 /* Used by core_alua_update_tpg_(primary,secondary)_metadata */
86 #define ALUA_MD_BUF_LEN 1024
88 extern struct kmem_cache
*t10_alua_lu_gp_cache
;
89 extern struct kmem_cache
*t10_alua_lu_gp_mem_cache
;
90 extern struct kmem_cache
*t10_alua_tg_pt_gp_cache
;
91 extern struct kmem_cache
*t10_alua_lba_map_cache
;
92 extern struct kmem_cache
*t10_alua_lba_map_mem_cache
;
94 extern sense_reason_t
target_emulate_report_target_port_groups(struct se_cmd
*);
95 extern sense_reason_t
target_emulate_set_target_port_groups(struct se_cmd
*);
96 extern sense_reason_t
target_emulate_report_referrals(struct se_cmd
*);
97 extern int core_alua_check_nonop_delay(struct se_cmd
*);
98 extern int core_alua_do_port_transition(struct t10_alua_tg_pt_gp
*,
99 struct se_device
*, struct se_lun
*,
100 struct se_node_acl
*, int, int);
101 extern char *core_alua_dump_status(int);
102 extern struct t10_alua_lba_map
*core_alua_allocate_lba_map(
103 struct list_head
*, u64
, u64
);
104 extern int core_alua_allocate_lba_map_mem(struct t10_alua_lba_map
*, int, int);
105 extern void core_alua_free_lba_map(struct list_head
*);
106 extern void core_alua_set_lba_map(struct se_device
*, struct list_head
*,
108 extern struct t10_alua_lu_gp
*core_alua_allocate_lu_gp(const char *, int);
109 extern int core_alua_set_lu_gp_id(struct t10_alua_lu_gp
*, u16
);
110 extern void core_alua_free_lu_gp(struct t10_alua_lu_gp
*);
111 extern void core_alua_free_lu_gp_mem(struct se_device
*);
112 extern struct t10_alua_lu_gp
*core_alua_get_lu_gp_by_name(const char *);
113 extern void core_alua_put_lu_gp_from_name(struct t10_alua_lu_gp
*);
114 extern void __core_alua_attach_lu_gp_mem(struct t10_alua_lu_gp_member
*,
115 struct t10_alua_lu_gp
*);
116 extern void __core_alua_drop_lu_gp_mem(struct t10_alua_lu_gp_member
*,
117 struct t10_alua_lu_gp
*);
118 extern void core_alua_drop_lu_gp_dev(struct se_device
*);
119 extern struct t10_alua_tg_pt_gp
*core_alua_allocate_tg_pt_gp(
120 struct se_device
*, const char *, int);
121 extern int core_alua_set_tg_pt_gp_id(struct t10_alua_tg_pt_gp
*, u16
);
122 extern void core_alua_free_tg_pt_gp(struct t10_alua_tg_pt_gp
*);
123 extern void target_detach_tg_pt_gp(struct se_lun
*);
124 extern void target_attach_tg_pt_gp(struct se_lun
*, struct t10_alua_tg_pt_gp
*);
125 extern ssize_t
core_alua_show_tg_pt_gp_info(struct se_lun
*, char *);
126 extern ssize_t
core_alua_store_tg_pt_gp_info(struct se_lun
*, const char *,
128 extern ssize_t
core_alua_show_access_type(struct t10_alua_tg_pt_gp
*, char *);
129 extern ssize_t
core_alua_store_access_type(struct t10_alua_tg_pt_gp
*,
130 const char *, size_t);
131 extern ssize_t
core_alua_show_nonop_delay_msecs(struct t10_alua_tg_pt_gp
*,
133 extern ssize_t
core_alua_store_nonop_delay_msecs(struct t10_alua_tg_pt_gp
*,
134 const char *, size_t);
135 extern ssize_t
core_alua_show_trans_delay_msecs(struct t10_alua_tg_pt_gp
*,
137 extern ssize_t
core_alua_store_trans_delay_msecs(struct t10_alua_tg_pt_gp
*,
138 const char *, size_t);
139 extern ssize_t
core_alua_show_implicit_trans_secs(struct t10_alua_tg_pt_gp
*,
141 extern ssize_t
core_alua_store_implicit_trans_secs(struct t10_alua_tg_pt_gp
*,
142 const char *, size_t);
143 extern ssize_t
core_alua_show_preferred_bit(struct t10_alua_tg_pt_gp
*,
145 extern ssize_t
core_alua_store_preferred_bit(struct t10_alua_tg_pt_gp
*,
146 const char *, size_t);
147 extern ssize_t
core_alua_show_offline_bit(struct se_lun
*, char *);
148 extern ssize_t
core_alua_store_offline_bit(struct se_lun
*, const char *,
150 extern ssize_t
core_alua_show_secondary_status(struct se_lun
*, char *);
151 extern ssize_t
core_alua_store_secondary_status(struct se_lun
*,
152 const char *, size_t);
153 extern ssize_t
core_alua_show_secondary_write_metadata(struct se_lun
*,
155 extern ssize_t
core_alua_store_secondary_write_metadata(struct se_lun
*,
156 const char *, size_t);
157 extern int core_setup_alua(struct se_device
*);
158 extern sense_reason_t
target_alua_state_check(struct se_cmd
*cmd
);
160 #endif /* TARGET_CORE_ALUA_H */