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