Kiran Patil | 3699d92 | 2011-04-18 16:24:14 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2010 Cisco Systems, Inc. |
| 3 | * |
| 4 | * This program is free software; you can redistribute it and/or modify it |
| 5 | * under the terms and conditions of the GNU General Public License, |
| 6 | * version 2, as published by the Free Software Foundation. |
| 7 | * |
| 8 | * This program is distributed in the hope it will be useful, but WITHOUT |
| 9 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 10 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for |
| 11 | * more details. |
| 12 | * |
| 13 | * You should have received a copy of the GNU General Public License along with |
| 14 | * this program; if not, write to the Free Software Foundation, Inc., |
| 15 | * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. |
| 16 | */ |
| 17 | #ifndef __TCM_FC_H__ |
| 18 | #define __TCM_FC_H__ |
| 19 | |
| 20 | #define FT_VERSION "0.3" |
| 21 | |
| 22 | #define FT_NAMELEN 32 /* length of ASCII WWPNs including pad */ |
| 23 | #define FT_TPG_NAMELEN 32 /* max length of TPG name */ |
| 24 | #define FT_LUN_NAMELEN 32 /* max length of LUN name */ |
| 25 | |
| 26 | /* |
| 27 | * Debug options. |
| 28 | */ |
| 29 | #define FT_DEBUG_CONF 0x01 /* configuration messages */ |
| 30 | #define FT_DEBUG_SESS 0x02 /* session messages */ |
| 31 | #define FT_DEBUG_TM 0x04 /* TM operations */ |
| 32 | #define FT_DEBUG_IO 0x08 /* I/O commands */ |
| 33 | #define FT_DEBUG_DATA 0x10 /* Data transfer */ |
| 34 | |
| 35 | extern unsigned int ft_debug_logging; /* debug options */ |
| 36 | |
| 37 | #define FT_DEBUG(mask, fmt, args...) \ |
| 38 | do { \ |
| 39 | if (ft_debug_logging & (mask)) \ |
| 40 | printk(KERN_INFO "tcm_fc: %s: " fmt, \ |
| 41 | __func__, ##args); \ |
| 42 | } while (0) |
| 43 | |
| 44 | #define FT_CONF_DBG(fmt, args...) FT_DEBUG(FT_DEBUG_CONF, fmt, ##args) |
| 45 | #define FT_SESS_DBG(fmt, args...) FT_DEBUG(FT_DEBUG_SESS, fmt, ##args) |
| 46 | #define FT_TM_DBG(fmt, args...) FT_DEBUG(FT_DEBUG_TM, fmt, ##args) |
| 47 | #define FT_IO_DBG(fmt, args...) FT_DEBUG(FT_DEBUG_IO, fmt, ##args) |
| 48 | #define FT_DATA_DBG(fmt, args...) FT_DEBUG(FT_DEBUG_DATA, fmt, ##args) |
| 49 | |
| 50 | struct ft_transport_id { |
| 51 | __u8 format; |
| 52 | __u8 __resvd1[7]; |
| 53 | __u8 wwpn[8]; |
| 54 | __u8 __resvd2[8]; |
| 55 | } __attribute__((__packed__)); |
| 56 | |
| 57 | /* |
| 58 | * Session (remote port). |
| 59 | */ |
| 60 | struct ft_sess { |
| 61 | u32 port_id; /* for hash lookup use only */ |
| 62 | u32 params; |
| 63 | u16 max_frame; /* maximum frame size */ |
| 64 | u64 port_name; /* port name for transport ID */ |
| 65 | struct ft_tport *tport; |
| 66 | struct se_session *se_sess; |
| 67 | struct hlist_node hash; /* linkage in ft_sess_hash table */ |
| 68 | struct rcu_head rcu; |
| 69 | struct kref kref; /* ref for hash and outstanding I/Os */ |
| 70 | }; |
| 71 | |
| 72 | /* |
| 73 | * Hash table of sessions per local port. |
| 74 | * Hash lookup by remote port FC_ID. |
| 75 | */ |
| 76 | #define FT_SESS_HASH_BITS 6 |
| 77 | #define FT_SESS_HASH_SIZE (1 << FT_SESS_HASH_BITS) |
| 78 | |
| 79 | /* |
| 80 | * Per local port data. |
| 81 | * This is created only after a TPG exists that allows target function |
| 82 | * for the local port. If the TPG exists, this is allocated when |
| 83 | * we're notified that the local port has been created, or when |
| 84 | * the first PRLI provider callback is received. |
| 85 | */ |
| 86 | struct ft_tport { |
| 87 | struct fc_lport *lport; |
| 88 | struct ft_tpg *tpg; /* NULL if TPG deleted before tport */ |
| 89 | u32 sess_count; /* number of sessions in hash */ |
| 90 | struct rcu_head rcu; |
| 91 | struct hlist_head hash[FT_SESS_HASH_SIZE]; /* list of sessions */ |
| 92 | }; |
| 93 | |
| 94 | /* |
| 95 | * Node ID and authentication. |
| 96 | */ |
| 97 | struct ft_node_auth { |
| 98 | u64 port_name; |
| 99 | u64 node_name; |
| 100 | }; |
| 101 | |
| 102 | /* |
| 103 | * Node ACL for FC remote port session. |
| 104 | */ |
| 105 | struct ft_node_acl { |
| 106 | struct ft_node_auth node_auth; |
| 107 | struct se_node_acl se_node_acl; |
| 108 | }; |
| 109 | |
| 110 | struct ft_lun { |
| 111 | u32 index; |
| 112 | char name[FT_LUN_NAMELEN]; |
| 113 | }; |
| 114 | |
| 115 | /* |
| 116 | * Target portal group (local port). |
| 117 | */ |
| 118 | struct ft_tpg { |
| 119 | u32 index; |
| 120 | struct ft_lport_acl *lport_acl; |
| 121 | struct ft_tport *tport; /* active tport or NULL */ |
| 122 | struct list_head list; /* linkage in ft_lport_acl tpg_list */ |
| 123 | struct list_head lun_list; /* head of LUNs */ |
| 124 | struct se_portal_group se_tpg; |
| 125 | struct task_struct *thread; /* processing thread */ |
| 126 | struct se_queue_obj qobj; /* queue for processing thread */ |
| 127 | }; |
| 128 | |
| 129 | struct ft_lport_acl { |
| 130 | u64 wwpn; |
| 131 | char name[FT_NAMELEN]; |
| 132 | struct list_head list; |
| 133 | struct list_head tpg_list; |
| 134 | struct se_wwn fc_lport_wwn; |
| 135 | }; |
| 136 | |
| 137 | enum ft_cmd_state { |
| 138 | FC_CMD_ST_NEW = 0, |
| 139 | FC_CMD_ST_REJ |
| 140 | }; |
| 141 | |
| 142 | /* |
| 143 | * Commands |
| 144 | */ |
| 145 | struct ft_cmd { |
| 146 | enum ft_cmd_state state; |
Kiran Patil | 61db952 | 2011-06-22 16:30:22 -0700 | [diff] [blame^] | 147 | u32 lun; /* LUN from request */ |
Kiran Patil | 3699d92 | 2011-04-18 16:24:14 -0700 | [diff] [blame] | 148 | struct ft_sess *sess; /* session held for cmd */ |
| 149 | struct fc_seq *seq; /* sequence in exchange mgr */ |
| 150 | struct se_cmd se_cmd; /* Local TCM I/O descriptor */ |
| 151 | struct fc_frame *req_frame; |
| 152 | unsigned char *cdb; /* pointer to CDB inside frame */ |
| 153 | u32 write_data_len; /* data received on writes */ |
| 154 | struct se_queue_req se_req; |
| 155 | /* Local sense buffer */ |
| 156 | unsigned char ft_sense_buffer[TRANSPORT_SENSE_BUFFER]; |
| 157 | u32 was_ddp_setup:1; /* Set only if ddp is setup */ |
| 158 | struct scatterlist *sg; /* Set only if DDP is setup */ |
| 159 | u32 sg_cnt; /* No. of item in scatterlist */ |
| 160 | }; |
| 161 | |
| 162 | extern struct list_head ft_lport_list; |
| 163 | extern struct mutex ft_lport_lock; |
| 164 | extern struct fc4_prov ft_prov; |
| 165 | extern struct target_fabric_configfs *ft_configfs; |
| 166 | |
| 167 | /* |
| 168 | * Fabric methods. |
| 169 | */ |
| 170 | |
| 171 | /* |
| 172 | * Session ops. |
| 173 | */ |
| 174 | void ft_sess_put(struct ft_sess *); |
| 175 | int ft_sess_shutdown(struct se_session *); |
| 176 | void ft_sess_close(struct se_session *); |
| 177 | void ft_sess_stop(struct se_session *, int, int); |
| 178 | int ft_sess_logged_in(struct se_session *); |
| 179 | u32 ft_sess_get_index(struct se_session *); |
| 180 | u32 ft_sess_get_port_name(struct se_session *, unsigned char *, u32); |
| 181 | void ft_sess_set_erl0(struct se_session *); |
| 182 | |
| 183 | void ft_lport_add(struct fc_lport *, void *); |
| 184 | void ft_lport_del(struct fc_lport *, void *); |
| 185 | int ft_lport_notify(struct notifier_block *, unsigned long, void *); |
| 186 | |
| 187 | /* |
| 188 | * IO methods. |
| 189 | */ |
| 190 | void ft_check_stop_free(struct se_cmd *); |
| 191 | void ft_release_cmd(struct se_cmd *); |
| 192 | int ft_queue_status(struct se_cmd *); |
| 193 | int ft_queue_data_in(struct se_cmd *); |
| 194 | int ft_write_pending(struct se_cmd *); |
| 195 | int ft_write_pending_status(struct se_cmd *); |
| 196 | u32 ft_get_task_tag(struct se_cmd *); |
| 197 | int ft_get_cmd_state(struct se_cmd *); |
| 198 | void ft_new_cmd_failure(struct se_cmd *); |
| 199 | int ft_queue_tm_resp(struct se_cmd *); |
| 200 | int ft_is_state_remove(struct se_cmd *); |
| 201 | |
| 202 | /* |
| 203 | * other internal functions. |
| 204 | */ |
| 205 | int ft_thread(void *); |
| 206 | void ft_recv_req(struct ft_sess *, struct fc_frame *); |
| 207 | struct ft_tpg *ft_lport_find_tpg(struct fc_lport *); |
| 208 | struct ft_node_acl *ft_acl_get(struct ft_tpg *, struct fc_rport_priv *); |
| 209 | |
| 210 | void ft_recv_write_data(struct ft_cmd *, struct fc_frame *); |
| 211 | void ft_dump_cmd(struct ft_cmd *, const char *caller); |
| 212 | |
| 213 | ssize_t ft_format_wwn(char *, size_t, u64); |
| 214 | |
| 215 | #endif /* __TCM_FC_H__ */ |