[mirror_ubuntu-jammy-kernel.git] / drivers / target / target_core_internal.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef TARGET_CORE_INTERNAL_H
#define TARGET_CORE_INTERNAL_H

#include <linux/configfs.h>
#include <linux/list.h>
#include <linux/types.h>
#include <target/target_core_base.h>

#define TARGET_CORE_NAME_MAX_LEN	64
#define TARGET_FABRIC_NAME_SIZE		32

struct target_backend {
	struct list_head list;

	const struct target_backend_ops *ops;

	struct config_item_type tb_dev_cit;
	struct config_item_type tb_dev_attrib_cit;
	struct config_item_type tb_dev_action_cit;
	struct config_item_type tb_dev_pr_cit;
	struct config_item_type tb_dev_wwn_cit;
	struct config_item_type tb_dev_alua_tg_pt_gps_cit;
	struct config_item_type tb_dev_stat_cit;
};

struct target_fabric_configfs {
	atomic_t		tf_access_cnt;
	struct list_head	tf_list;
	struct config_group	tf_group;
	struct config_group	tf_disc_group;
	const struct target_core_fabric_ops *tf_ops;

	struct config_item_type tf_discovery_cit;
	struct config_item_type	tf_wwn_cit;
	struct config_item_type tf_wwn_fabric_stats_cit;
	struct config_item_type tf_tpg_cit;
	struct config_item_type tf_tpg_base_cit;
	struct config_item_type tf_tpg_lun_cit;
	struct config_item_type tf_tpg_port_cit;
	struct config_item_type tf_tpg_port_stat_cit;
	struct config_item_type tf_tpg_np_cit;
	struct config_item_type tf_tpg_np_base_cit;
	struct config_item_type tf_tpg_attrib_cit;
	struct config_item_type tf_tpg_auth_cit;
	struct config_item_type tf_tpg_param_cit;
	struct config_item_type tf_tpg_nacl_cit;
	struct config_item_type tf_tpg_nacl_base_cit;
	struct config_item_type tf_tpg_nacl_attrib_cit;
	struct config_item_type tf_tpg_nacl_auth_cit;
	struct config_item_type tf_tpg_nacl_param_cit;
	struct config_item_type tf_tpg_nacl_stat_cit;
	struct config_item_type tf_tpg_mappedlun_cit;
	struct config_item_type tf_tpg_mappedlun_stat_cit;
};

/* target_core_alua.c */
extern struct t10_alua_lu_gp *default_lu_gp;

/* target_core_device.c */
int	core_alloc_rtpi(struct se_lun *lun, struct se_device *dev);
struct se_dev_entry *core_get_se_deve_from_rtpi(struct se_node_acl *, u16);
void	target_pr_kref_release(struct kref *);
void	core_free_device_list_for_node(struct se_node_acl *,
		struct se_portal_group *);
void	core_update_device_list_access(u64, bool, struct se_node_acl *);
struct se_dev_entry *target_nacl_find_deve(struct se_node_acl *, u64);
int	core_enable_device_list_for_node(struct se_lun *, struct se_lun_acl *,
		u64, bool, struct se_node_acl *, struct se_portal_group *);
void	core_disable_device_list_for_node(struct se_lun *, struct se_dev_entry *,
		struct se_node_acl *, struct se_portal_group *);
void	core_clear_lun_from_tpg(struct se_lun *, struct se_portal_group *);
int	core_dev_add_lun(struct se_portal_group *, struct se_device *,
		struct se_lun *lun);
void	core_dev_del_lun(struct se_portal_group *, struct se_lun *);
struct se_lun_acl *core_dev_init_initiator_node_lun_acl(struct se_portal_group *,
		struct se_node_acl *, u64, int *);
int	core_dev_add_initiator_node_lun_acl(struct se_portal_group *,
		struct se_lun_acl *, struct se_lun *lun, bool);
int	core_dev_del_initiator_node_lun_acl(struct se_lun *,
		struct se_lun_acl *);
void	core_dev_free_initiator_node_lun_acl(struct se_portal_group *,
		struct se_lun_acl *lacl);
int	core_dev_setup_virtual_lun0(void);
void	core_dev_release_virtual_lun0(void);
struct se_device *target_alloc_device(struct se_hba *hba, const char *name);
int	target_configure_device(struct se_device *dev);
void	target_free_device(struct se_device *);
int	target_for_each_device(int (*fn)(struct se_device *dev, void *data),
			       void *data);

/* target_core_configfs.c */
extern struct configfs_item_operations target_core_dev_item_ops;
void	target_setup_backend_cits(struct target_backend *);

/* target_core_fabric_configfs.c */
int	target_fabric_setup_cits(struct target_fabric_configfs *);

/* target_core_fabric_lib.c */
int	target_get_pr_transport_id_len(struct se_node_acl *nacl,
		struct t10_pr_registration *pr_reg, int *format_code);
int	target_get_pr_transport_id(struct se_node_acl *nacl,
		struct t10_pr_registration *pr_reg, int *format_code,
		unsigned char *buf);
const char *target_parse_pr_out_transport_id(struct se_portal_group *tpg,
		char *buf, u32 *out_tid_len, char **port_nexus_ptr);

/* target_core_hba.c */
struct se_hba *core_alloc_hba(const char *, u32, u32);
int	core_delete_hba(struct se_hba *);

/* target_core_tmr.c */
void	core_tmr_abort_task(struct se_device *, struct se_tmr_req *,
			struct se_session *);
int	core_tmr_lun_reset(struct se_device *, struct se_tmr_req *,
		struct list_head *, struct se_cmd *);

/* target_core_tpg.c */
extern struct se_device *g_lun0_dev;

struct se_node_acl *__core_tpg_get_initiator_node_acl(struct se_portal_group *tpg,
		const char *);
void	core_tpg_add_node_to_devs(struct se_node_acl *, struct se_portal_group *,
				  struct se_lun *);
void	core_tpg_wait_for_nacl_pr_ref(struct se_node_acl *);
struct se_lun *core_tpg_alloc_lun(struct se_portal_group *, u64);
int	core_tpg_add_lun(struct se_portal_group *, struct se_lun *,
		bool, struct se_device *);
void core_tpg_remove_lun(struct se_portal_group *, struct se_lun *);
struct se_node_acl *core_tpg_add_initiator_node_acl(struct se_portal_group *tpg,
		const char *initiatorname);
void core_tpg_del_initiator_node_acl(struct se_node_acl *acl);

/* target_core_transport.c */
extern struct kmem_cache *se_tmr_req_cache;

int	init_se_kmem_caches(void);
void	release_se_kmem_caches(void);
u32	scsi_get_new_index(scsi_index_t);
void	transport_subsystem_check_init(void);
void	transport_uninit_session(struct se_session *);
unsigned char *transport_dump_cmd_direction(struct se_cmd *);
void	transport_dump_dev_state(struct se_device *, char *, int *);
void	transport_dump_dev_info(struct se_device *, struct se_lun *,
		unsigned long long, char *, int *);
void	transport_dump_vpd_proto_id(struct t10_vpd *, unsigned char *, int);
int	transport_dump_vpd_assoc(struct t10_vpd *, unsigned char *, int);
int	transport_dump_vpd_ident_type(struct t10_vpd *, unsigned char *, int);
int	transport_dump_vpd_ident(struct t10_vpd *, unsigned char *, int);
void	transport_clear_lun_ref(struct se_lun *);
sense_reason_t	target_cmd_size_check(struct se_cmd *cmd, unsigned int size);
void	target_qf_do_work(struct work_struct *work);
bool	target_check_wce(struct se_device *dev);
bool	target_check_fua(struct se_device *dev);
void	__target_execute_cmd(struct se_cmd *, bool);

/* target_core_stat.c */
void	target_stat_setup_dev_default_groups(struct se_device *);
void	target_stat_setup_port_default_groups(struct se_lun *);
void	target_stat_setup_mappedlun_default_groups(struct se_lun_acl *);

/* target_core_xcopy.c */
extern struct se_portal_group xcopy_pt_tpg;

/* target_core_configfs.c */
#define DB_ROOT_LEN		4096
#define	DB_ROOT_DEFAULT		"/var/target"
#define	DB_ROOT_PREFERRED	"/etc/target"

extern char db_root[];

#endif /* TARGET_CORE_INTERNAL_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
e26d99ae CH	2	#ifndef TARGET_CORE_INTERNAL_H
	3	#define TARGET_CORE_INTERNAL_H
	4
8dcf07be BVA	5	#include <linux/configfs.h>
	6	#include <linux/list.h>
	7	#include <linux/types.h>
	8	#include <target/target_core_base.h>
	9
6de2ce5b CH	10	#define TARGET_CORE_NAME_MAX_LEN 64
	11	#define TARGET_FABRIC_NAME_SIZE 32
	12
0a06d430 CH	13	struct target_backend {
	14	struct list_head list;
	15
	16	const struct target_backend_ops *ops;
	17
	18	struct config_item_type tb_dev_cit;
	19	struct config_item_type tb_dev_attrib_cit;
8dc31ff9	20	struct config_item_type tb_dev_action_cit;
0a06d430 CH	21	struct config_item_type tb_dev_pr_cit;
	22	struct config_item_type tb_dev_wwn_cit;
	23	struct config_item_type tb_dev_alua_tg_pt_gps_cit;
	24	struct config_item_type tb_dev_stat_cit;
	25	};
	26
6de2ce5b CH	27	struct target_fabric_configfs {
	28	atomic_t tf_access_cnt;
	29	struct list_head tf_list;
	30	struct config_group tf_group;
	31	struct config_group tf_disc_group;
6de2ce5b CH	32	const struct target_core_fabric_ops *tf_ops;
	33
	34	struct config_item_type tf_discovery_cit;
	35	struct config_item_type tf_wwn_cit;
	36	struct config_item_type tf_wwn_fabric_stats_cit;
	37	struct config_item_type tf_tpg_cit;
	38	struct config_item_type tf_tpg_base_cit;
	39	struct config_item_type tf_tpg_lun_cit;
	40	struct config_item_type tf_tpg_port_cit;
	41	struct config_item_type tf_tpg_port_stat_cit;
	42	struct config_item_type tf_tpg_np_cit;
	43	struct config_item_type tf_tpg_np_base_cit;
	44	struct config_item_type tf_tpg_attrib_cit;
	45	struct config_item_type tf_tpg_auth_cit;
	46	struct config_item_type tf_tpg_param_cit;
	47	struct config_item_type tf_tpg_nacl_cit;
	48	struct config_item_type tf_tpg_nacl_base_cit;
	49	struct config_item_type tf_tpg_nacl_attrib_cit;
	50	struct config_item_type tf_tpg_nacl_auth_cit;
	51	struct config_item_type tf_tpg_nacl_param_cit;
	52	struct config_item_type tf_tpg_nacl_stat_cit;
	53	struct config_item_type tf_tpg_mappedlun_cit;
	54	struct config_item_type tf_tpg_mappedlun_stat_cit;
	55	};
	56
e26d99ae CH	57	/* target_core_alua.c */
	58	extern struct t10_alua_lu_gp *default_lu_gp;
	59
e26d99ae	60	/* target_core_device.c */
adf653f9	61	int core_alloc_rtpi(struct se_lun lun, struct se_device dev);
e26d99ae	62	struct se_dev_entry core_get_se_deve_from_rtpi(struct se_node_acl , u16);
29a05dee NB	63	void target_pr_kref_release(struct kref *);
29a05dee NB	64	void core_free_device_list_for_node(struct se_node_acl *,
e26d99ae	65	struct se_portal_group *);
03a68b44	66	void core_update_device_list_access(u64, bool, struct se_node_acl *);
f2d30680	67	struct se_dev_entry target_nacl_find_deve(struct se_node_acl , u64);
e80ac6c4	68	int core_enable_device_list_for_node(struct se_lun , struct se_lun_acl ,
03a68b44	69	u64, bool, struct se_node_acl , struct se_portal_group );
29a05dee NB	70	void core_disable_device_list_for_node(struct se_lun , struct se_dev_entry ,
29a05dee NB	71	struct se_node_acl , struct se_portal_group );
e26d99ae	72	void core_clear_lun_from_tpg(struct se_lun , struct se_portal_group );
6bb82612 NB	73	int core_dev_add_lun(struct se_portal_group , struct se_device ,
6bb82612 NB	74	struct se_lun *lun);
cd9d7cba	75	void core_dev_del_lun(struct se_portal_group , struct se_lun );
e26d99ae	76	struct se_lun_acl core_dev_init_initiator_node_lun_acl(struct se_portal_group ,
f2d30680	77	struct se_node_acl , u64, int );
e26d99ae	78	int core_dev_add_initiator_node_lun_acl(struct se_portal_group *,
03a68b44	79	struct se_lun_acl , struct se_lun lun, bool);
adf653f9 CH	80	int core_dev_del_initiator_node_lun_acl(struct se_lun *,
adf653f9 CH	81	struct se_lun_acl *);
e26d99ae CH	82	void core_dev_free_initiator_node_lun_acl(struct se_portal_group *,
	83	struct se_lun_acl *lacl);
	84	int core_dev_setup_virtual_lun0(void);
	85	void core_dev_release_virtual_lun0(void);
0fd97ccf CH	86	struct se_device target_alloc_device(struct se_hba hba, const char *name);
	87	int target_configure_device(struct se_device *dev);
	88	void target_free_device(struct se_device *);
b1943fd4 MC	89	int target_for_each_device(int (fn)(struct se_device dev, void *data),
b1943fd4 MC	90	void *data);
e26d99ae	91
0a06d430	92	/* target_core_configfs.c */
c48e5594	93	extern struct configfs_item_operations target_core_dev_item_ops;
0a06d430 CH	94	void target_setup_backend_cits(struct target_backend *);
0a06d430 CH	95
2eafd729 CH	96	/* target_core_fabric_configfs.c */
	97	int target_fabric_setup_cits(struct target_fabric_configfs *);
	98
2650d71e CH	99	/* target_core_fabric_lib.c */
	100	int target_get_pr_transport_id_len(struct se_node_acl *nacl,
	101	struct t10_pr_registration pr_reg, int format_code);
	102	int target_get_pr_transport_id(struct se_node_acl *nacl,
	103	struct t10_pr_registration pr_reg, int format_code,
	104	unsigned char *buf);
	105	const char target_parse_pr_out_transport_id(struct se_portal_group tpg,
094bb5d7	106	char buf, u32 out_tid_len, char **port_nexus_ptr);
2650d71e	107
e26d99ae CH	108	/* target_core_hba.c */
	109	struct se_hba core_alloc_hba(const char , u32, u32);
	110	int core_delete_hba(struct se_hba *);
	111
	112	/* target_core_tmr.c */
3d28934a NB	113	void core_tmr_abort_task(struct se_device , struct se_tmr_req ,
3d28934a NB	114	struct se_session *);
e26d99ae CH	115	int core_tmr_lun_reset(struct se_device , struct se_tmr_req ,
	116	struct list_head , struct se_cmd );
	117
	118	/* target_core_tpg.c */
	119	extern struct se_device *g_lun0_dev;
	120
	121	struct se_node_acl __core_tpg_get_initiator_node_acl(struct se_portal_group tpg,
	122	const char *);
df9766ca NB	123	void core_tpg_add_node_to_devs(struct se_node_acl , struct se_portal_group ,
df9766ca NB	124	struct se_lun *);
e26d99ae	125	void core_tpg_wait_for_nacl_pr_ref(struct se_node_acl *);
f2d30680	126	struct se_lun core_tpg_alloc_lun(struct se_portal_group , u64);
d344f8a1	127	int core_tpg_add_lun(struct se_portal_group , struct se_lun ,
03a68b44	128	bool, struct se_device *);
cd9d7cba	129	void core_tpg_remove_lun(struct se_portal_group , struct se_lun );
c7d6a803 CH	130	struct se_node_acl core_tpg_add_initiator_node_acl(struct se_portal_group tpg,
	131	const char *initiatorname);
	132	void core_tpg_del_initiator_node_acl(struct se_node_acl *acl);
e26d99ae CH	133
	134	/* target_core_transport.c */
	135	extern struct kmem_cache *se_tmr_req_cache;
	136
	137	int init_se_kmem_caches(void);
	138	void release_se_kmem_caches(void);
	139	u32 scsi_get_new_index(scsi_index_t);
	140	void transport_subsystem_check_init(void);
3c006c7d	141	void transport_uninit_session(struct se_session *);
e26d99ae CH	142	unsigned char transport_dump_cmd_direction(struct se_cmd );
	143	void transport_dump_dev_state(struct se_device , char , int *);
	144	void transport_dump_dev_info(struct se_device , struct se_lun ,
	145	unsigned long long, char , int );
	146	void transport_dump_vpd_proto_id(struct t10_vpd , unsigned char , int);
	147	int transport_dump_vpd_assoc(struct t10_vpd , unsigned char , int);
	148	int transport_dump_vpd_ident_type(struct t10_vpd , unsigned char , int);
	149	int transport_dump_vpd_ident(struct t10_vpd , unsigned char , int);
b3eeea66	150	void transport_clear_lun_ref(struct se_lun *);
de103c93	151	sense_reason_t target_cmd_size_check(struct se_cmd *cmd, unsigned int size);
0fd97ccf	152	void target_qf_do_work(struct work_struct *work);
814e5b45 CH	153	bool target_check_wce(struct se_device *dev);
814e5b45 CH	154	bool target_check_fua(struct se_device *dev);
dff0ca9e	155	void __target_execute_cmd(struct se_cmd *, bool);
e26d99ae CH	156
e26d99ae CH	157	/* target_core_stat.c */
0fd97ccf	158	void target_stat_setup_dev_default_groups(struct se_device *);
e26d99ae CH	159	void target_stat_setup_port_default_groups(struct se_lun *);
	160	void target_stat_setup_mappedlun_default_groups(struct se_lun_acl *);
	161
adf653f9 CH	162	/* target_core_xcopy.c */
	163	extern struct se_portal_group xcopy_pt_tpg;
	164
a96e9783 LD	165	/* target_core_configfs.c */
	166	#define DB_ROOT_LEN 4096
	167	#define DB_ROOT_DEFAULT "/var/target"
78a6295c	168	#define DB_ROOT_PREFERRED "/etc/target"
a96e9783 LD	169
	170	extern char db_root[];
	171
e26d99ae	172	#endif /* TARGET_CORE_INTERNAL_H */