tgtd.h

#ifndef __TARGET_DAEMON_H
#define __TARGET_DAEMON_H

#include "log.h"
#include "scsi_cmnd.h"
#include "tgtadm_error.h"

#ifdef USE_SYSTEMD
#include <systemd/sd-daemon.h>
#endif

struct concat_buf;

#define NR_SCSI_OPCODES		256

#define SCSI_ID_LEN		36
#define SCSI_SN_LEN		36

#define VENDOR_ID_LEN		8
#define PRODUCT_ID_LEN		16
#define PRODUCT_REV_LEN		4
#define BLOCK_LIMITS_VPD_LEN	0x3C
#define BDC_VPD_LEN		0x40
#define LBP_VPD_LEN		4

#define PCODE_SHIFT		7
#define PCODE_OFFSET(x) (x & ((1 << PCODE_SHIFT) - 1))

#define BLOCK_DESCRIPTOR_LEN	8
#define VERSION_DESCRIPTOR_LEN	8

#define VENDOR_ID	"IET"

#define _TAB1 "    "
#define _TAB2 _TAB1 _TAB1
#define _TAB3 _TAB1 _TAB1 _TAB1
#define _TAB4 _TAB2 _TAB2

#define dtype_priv(lu) (lu)->xxc_p

enum tgt_system_state {
	TGT_SYSTEM_OFFLINE = 1,
	TGT_SYSTEM_READY,
};

enum scsi_target_state {
	SCSI_TARGET_OFFLINE = 1,
	SCSI_TARGET_READY,
};

struct tgt_cmd_queue {
	int active_cmd;
	unsigned long state;
	struct list_head queue;
};

struct scsi_lu;

struct vpd {
	uint16_t size;
	void (*vpd_update)(struct scsi_lu *lu, void *data);
	uint8_t data[0];
};

#define PREVENT_REMOVAL			0x01
#define PREVENT_REMOVAL_PERSISTENT	0x02
#define PREVENT_MASK			0x03

struct lu_phy_attr {
	char scsi_id[SCSI_ID_LEN + 1];
	char scsi_sn[SCSI_SN_LEN + 1];
	uint64_t numeric_id;

	char vendor_id[VENDOR_ID_LEN + 1];
	char product_id[PRODUCT_ID_LEN + 1];
	char product_rev[PRODUCT_REV_LEN + 1];

	uint16_t version_desc[VERSION_DESCRIPTOR_LEN];

	unsigned char device_type; /* Peripheral device type */
	char qualifier;		/* Peripheral Qualifier */
	char removable;		/* Removable media */
	char readonly;          /* Read-Only media */
	char swp;               /* Software Write Protect */
	char thinprovisioning;  /* Use thin-provisioning for this LUN */
	char online;		/* Logical Unit online */
	char sense_format;	/* Descrptor format sense data supported */
				/* For the following see READ CAPACITY (16) */
	unsigned char lbppbe;	/* Logical blocks per physical block exponent */
	char no_auto_lbppbe;    /* Do not update it automatically when the
				   backing file changes */
	uint16_t la_lba;	/* Lowest aligned LBA */
	uint16_t rotation_rate;	/* Block rotation rate */

	/* VPD pages 0x80 -> 0xff masked with 0x80*/
	struct vpd *lu_vpd[1 << PCODE_SHIFT];
};

struct ua_sense {
	struct list_head ua_sense_siblings;
	unsigned char ua_sense_buffer[SCSI_SENSE_BUFFERSIZE];
	int ua_sense_len;
};

struct lu_stat {
	uint64_t rd_subm_bytes;
	uint64_t rd_done_bytes;

	uint64_t wr_subm_bytes;
	uint64_t wr_done_bytes;

	uint32_t rd_subm_cmds;
	uint32_t rd_done_cmds;

	uint32_t wr_subm_cmds;
	uint32_t wr_done_cmds;

	uint32_t bidir_subm_cmds;
	uint32_t bidir_done_cmds;

	uint32_t err_num;
};

struct it_nexus_lu_info {
	struct scsi_lu *lu;
	uint64_t itn_id;
	struct lu_stat stat;
	struct list_head itn_itl_info_siblings;
	struct list_head lu_itl_info_siblings;
	struct list_head pending_ua_sense_list;
	int prevent; /* prevent removal on this itl nexus ? */
};

struct service_action {
	uint32_t service_action;
	int (*cmd_perform)(int host_no, struct scsi_cmd *cmd);
};

struct device_type_operations {
	int (*cmd_perform)(int host_no, struct scsi_cmd *cmd);
	struct service_action *service_actions;
	uint8_t pr_conflict_bits;
};

#define PR_SPECIAL	(1U << 5)
#define PR_WE_FA	(1U << 4)
#define PR_EA_FA	(1U << 3)
#define PR_RR_FR	(1U << 2)
#define PR_WE_FN	(1U << 1)
#define PR_EA_FN	(1U << 0)

struct device_type_template {
	unsigned char type;

	tgtadm_err (*lu_init)(struct scsi_lu *lu);
	void (*lu_exit)(struct scsi_lu *lu);
	tgtadm_err (*lu_config)(struct scsi_lu *lu, char *args);
	tgtadm_err (*lu_online)(struct scsi_lu *lu);
	tgtadm_err (*lu_offline)(struct scsi_lu *lu);
	int (*cmd_passthrough)(int, struct scsi_cmd *);

	struct device_type_operations ops[NR_SCSI_OPCODES];

	struct list_head device_type_siblings;
};

struct backingstore_template {
	const char *bs_name;
	int bs_datasize;
	int (*bs_open)(struct scsi_lu *dev, char *path, int *fd, uint64_t *size);
	void (*bs_close)(struct scsi_lu *dev);
	tgtadm_err (*bs_init)(struct scsi_lu *dev, char *bsopts);
	void (*bs_exit)(struct scsi_lu *dev);
	int (*bs_cmd_submit)(struct scsi_cmd *cmd);
	int bs_oflags_supported;
	unsigned long bs_supported_ops[NR_SCSI_OPCODES / __WORDSIZE];

	struct list_head backingstore_siblings;
};

struct mode_pg {
	struct list_head mode_pg_siblings;
	uint8_t pcode;		/* Page code */
	uint8_t subpcode;	/* Sub page code */
	int16_t pcode_size;	/* Size of page code data. */
	uint8_t mode_data[0];	/* Rest of mode page info */
};

struct registration {
	uint64_t key;
	uint64_t nexus_id;
	long ctime;
	struct list_head registration_siblings;

	uint8_t pr_scope;
	uint8_t pr_type;
};

struct scsi_lu {
	int fd;
	uint64_t addr; /* persistent mapped address */
	uint64_t size;
	uint64_t lun;
	char *path;
	int bsoflags;
	unsigned int blk_shift;

	/* the list of devices belonging to a target */
	struct list_head device_siblings;

	struct list_head lu_itl_info_list;

	struct tgt_cmd_queue cmd_queue;

	uint64_t reserve_id;

	/* we don't use a pointer because a lld could change this. */
	struct device_type_template dev_type_template;

	struct backingstore_template *bst;

	struct target *tgt;

	uint8_t	mode_block_descriptor[BLOCK_DESCRIPTOR_LEN];
	struct list_head mode_pages;

	struct lu_phy_attr attrs;

	struct list_head registration_list;
	uint32_t prgeneration;
	struct registration *pr_holder;

	/* A pointer for each modules private use.
	 * Currently used by ssc, smc and mmc modules.
	 */
	void *xxc_p;
	/*
	 * Used internally for usr/target.c:target_cmd_perform() and with
	 * passthrough CMD processing with
	 * struct device_type_template->cmd_passthrough().
	 */
	int (*cmd_perform)(int, struct scsi_cmd *);
	/*
	 * Used internally for usr/target.c:__cmd_done() and with
	 * passthrough CMD processing with __cmd_done_passthrough()
	 */
	void (*cmd_done)(struct target *, struct scsi_cmd *);
};

struct mgmt_req {
	uint64_t mid;
	int busy;
	int function;
	int result;
};

enum mgmt_req_result {
	MGMT_REQ_FAILED = -1,
	MGMT_REQ_DONE,
	MGMT_REQ_QUEUED,
};

extern int system_active;
extern int is_debug;
extern int nr_iothreads;
extern struct list_head bst_list;

extern int ipc_init(void);
extern void ipc_exit(void);
extern tgtadm_err tgt_device_create(int tid, int dev_type, uint64_t lun, char *args, int backing);
extern tgtadm_err tgt_device_destroy(int tid, uint64_t lun, int force);
extern tgtadm_err tgt_device_update(int tid, uint64_t dev_id, char *name);
extern int device_reserve(struct scsi_cmd *cmd);
extern int device_release(int tid, uint64_t itn_id, uint64_t lun, int force);
extern int device_reserved(struct scsi_cmd *cmd);
extern tgtadm_err tgt_device_path_update(struct target *target, struct scsi_lu *lu, char *path);

extern tgtadm_err tgt_target_create(int lld, int tid, char *args);
extern tgtadm_err tgt_target_destroy(int lld, int tid, int force);
extern char *tgt_targetname(int tid);
extern tgtadm_err tgt_target_show_all(struct concat_buf *b);
tgtadm_err system_set_state(char *str);
tgtadm_err system_show(int mode, struct concat_buf *b);
tgtadm_err lld_show(struct concat_buf *b);
int is_system_available(void);
int is_system_inactive(void);

extern tgtadm_err tgt_portal_create(int lld, char *args);
extern tgtadm_err tgt_portal_destroy(int lld, char *args);

extern tgtadm_err tgt_bind_host_to_target(int tid, int host_no);
extern tgtadm_err tgt_unbind_host_to_target(int tid, int host_no);

struct event_data;
typedef void (*sched_event_handler_t)(struct event_data *tev);

extern void tgt_init_sched_event(struct event_data *evt,
			  sched_event_handler_t sched_handler, void *data);

typedef void (*event_handler_t)(int fd, int events, void *data);

extern int tgt_event_add(int fd, int events, event_handler_t handler, void *data);
extern void tgt_event_del(int fd);

extern void tgt_add_sched_event(struct event_data *evt);
extern void tgt_remove_sched_event(struct event_data *evt);

extern int tgt_event_modify(int fd, int events);
extern int target_cmd_queue(int tid, struct scsi_cmd *cmd);
extern int target_cmd_perform(int tid, struct scsi_cmd *cmd);
extern int target_cmd_perform_passthrough(int tid, struct scsi_cmd *cmd);
extern void target_cmd_done(struct scsi_cmd *cmd);
extern void __cmd_done_passthrough(struct target *target, struct scsi_cmd *cmd);

extern enum mgmt_req_result target_mgmt_request(int tid, uint64_t itn_id,
						uint64_t req_id, int function,
						uint8_t *lun, uint64_t tag,
						int host_no);

extern struct it_nexus *it_nexus_lookup(int tid, uint64_t itn_id);
extern void target_cmd_io_done(struct scsi_cmd *cmd, int result);
extern int ua_sense_del(struct scsi_cmd *cmd, int del);
extern void ua_sense_clear(struct it_nexus_lu_info *itn_lu, uint16_t asc);
extern void ua_sense_add_other_it_nexus(uint64_t itn_id, struct scsi_lu *lu,
					uint16_t asc);
extern void ua_sense_add_it_nexus(uint64_t itn_id, struct scsi_lu *lu,
					uint16_t asc);

extern int lu_prevent_removal(struct scsi_lu *lu);

extern uint64_t scsi_get_devid(int lid, uint8_t *pdu);
extern int scsi_cmd_perform(int host_no, struct scsi_cmd *cmd);
extern void sense_data_build(struct scsi_cmd *cmd, uint8_t key, uint16_t asc);
extern void sense_data_build_with_info(struct scsi_cmd *cmd, uint8_t key,
				       uint16_t asc, uint64_t info);
extern uint64_t scsi_rw_offset(uint8_t *scb);
extern uint32_t scsi_rw_count(uint8_t *scb);
extern int scsi_is_io_opcode(unsigned char op);
extern enum data_direction scsi_data_dir_opcode(unsigned char op);
extern int get_scsi_cdb_size(struct scsi_cmd *cmd);
extern int get_scsi_command_size(unsigned char op);
extern const unsigned char *get_scsi_cdb_usage_data(unsigned char op,
						    unsigned char sa);

extern enum scsi_target_state tgt_get_target_state(int tid);
extern tgtadm_err tgt_set_target_state(int tid, char *str);

extern tgtadm_err acl_add(int tid, char *address);
extern tgtadm_err acl_del(int tid, char *address);
extern char *acl_get(int tid, int idx);

extern tgtadm_err iqn_acl_add(int tid, char *name);
extern tgtadm_err iqn_acl_del(int tid, char *name);
extern char *iqn_acl_get(int tid, int idx);

extern void tgt_stat_header(struct concat_buf *b);
extern void tgt_stat_line(int tid, uint64_t lun, uint64_t sid, struct lu_stat *stat, struct concat_buf *b);
extern void tgt_stat_device(struct target *target, struct scsi_lu *lu, struct concat_buf *b);

extern tgtadm_err tgt_stat_device_by_id(int tid, uint64_t dev_id, struct concat_buf *b);
extern tgtadm_err tgt_stat_target(struct target *target, struct concat_buf *b);
extern tgtadm_err tgt_stat_target_by_id(int tid, struct concat_buf *b);
extern tgtadm_err tgt_stat_system(struct concat_buf *b);

extern int account_lookup(int tid, int type, char *user, int ulen, char *password, int plen);
extern tgtadm_err account_add(char *user, char *password);
extern tgtadm_err account_del(char *user);
extern tgtadm_err account_ctl(int tid, int type, char *user, int bind);
extern tgtadm_err account_show(struct concat_buf *b);
extern int account_available(int tid, int dir);

extern int it_nexus_create(int tid, uint64_t itn_id, int host_no, char *info);
extern int it_nexus_destroy(int tid, uint64_t itn_id);

extern int device_type_register(struct device_type_template *);

extern struct lu_phy_attr *lu_attr_lookup(int tid, uint64_t lun);
extern tgtadm_err dtd_load_unload(int tid, uint64_t lun, int load, char *file);
extern tgtadm_err dtd_check_removable(int tid, uint64_t lun);

extern int register_backingstore_template(struct backingstore_template *bst);
extern struct backingstore_template *get_backingstore_template(const char *name);
extern void bs_create_opcode_map(struct backingstore_template *bst,
				 unsigned char *opcodes, int num);
extern int is_bs_support_opcode(struct backingstore_template *bst, int op);

extern int lld_init_one(int lld_index);

extern int setup_param(char *name, int (*parser)(char *));

extern int bs_init(void);

struct event_data {
	union {
		event_handler_t handler;
		sched_event_handler_t sched_handler;
	};
	union {
		int fd;
		int scheduled;
	};
	void *data;
	struct list_head e_list;
};

int call_program(const char *cmd,
		    void (*callback)(void *data, int result), void *data,
		    char *output, int op_len, int flags);

void update_lbppbe(struct scsi_lu *lu, int blksize);

struct service_action *
find_service_action(struct service_action *service_action,
		    uint32_t action);

#endif