2 * Copyright (c) 2010 Cisco Systems, Inc.
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.
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
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.
18 /* XXX TBD some includes may be extraneous */
20 #include <linux/module.h>
21 #include <linux/moduleparam.h>
22 #include <linux/utsname.h>
23 #include <linux/init.h>
24 #include <linux/slab.h>
25 #include <linux/kthread.h>
26 #include <linux/types.h>
27 #include <linux/string.h>
28 #include <linux/configfs.h>
29 #include <linux/ctype.h>
30 #include <linux/hash.h>
31 #include <linux/rcupdate.h>
32 #include <linux/rculist.h>
33 #include <linux/kref.h>
34 #include <asm/unaligned.h>
35 #include <scsi/libfc.h>
37 #include <target/target_core_base.h>
38 #include <target/target_core_fabric.h>
42 static void ft_sess_delete_all(struct ft_tport *);
45 * Lookup or allocate target local port.
46 * Caller holds ft_lport_lock.
48 static struct ft_tport *ft_tport_get(struct fc_lport *lport)
51 struct ft_tport *tport;
54 tport = rcu_dereference_protected(lport->prov[FC_TYPE_FCP],
55 lockdep_is_held(&ft_lport_lock));
56 if (tport && tport->tpg)
59 tpg = ft_lport_find_tpg(lport);
69 tport = kzalloc(sizeof(*tport), GFP_KERNEL);
76 for (i = 0; i < FT_SESS_HASH_SIZE; i++)
77 INIT_HLIST_HEAD(&tport->hash[i]);
79 rcu_assign_pointer(lport->prov[FC_TYPE_FCP], tport);
84 * Delete a target local port.
85 * Caller holds ft_lport_lock.
87 static void ft_tport_delete(struct ft_tport *tport)
89 struct fc_lport *lport;
92 ft_sess_delete_all(tport);
94 BUG_ON(tport != lport->prov[FC_TYPE_FCP]);
95 RCU_INIT_POINTER(lport->prov[FC_TYPE_FCP], NULL);
102 kfree_rcu(tport, rcu);
107 * Called thru fc_lport_iterate().
109 void ft_lport_add(struct fc_lport *lport, void *arg)
111 mutex_lock(&ft_lport_lock);
113 mutex_unlock(&ft_lport_lock);
118 * Called thru fc_lport_iterate().
120 void ft_lport_del(struct fc_lport *lport, void *arg)
122 struct ft_tport *tport;
124 mutex_lock(&ft_lport_lock);
125 tport = lport->prov[FC_TYPE_FCP];
127 ft_tport_delete(tport);
128 mutex_unlock(&ft_lport_lock);
132 * Notification of local port change from libfc.
133 * Create or delete local port and associated tport.
135 int ft_lport_notify(struct notifier_block *nb, unsigned long event, void *arg)
137 struct fc_lport *lport = arg;
140 case FC_LPORT_EV_ADD:
141 ft_lport_add(lport, NULL);
143 case FC_LPORT_EV_DEL:
144 ft_lport_del(lport, NULL);
151 * Hash function for FC_IDs.
153 static u32 ft_sess_hash(u32 port_id)
155 return hash_32(port_id, FT_SESS_HASH_BITS);
159 * Find session in local port.
160 * Sessions and hash lists are RCU-protected.
161 * A reference is taken which must be eventually freed.
163 static struct ft_sess *ft_sess_get(struct fc_lport *lport, u32 port_id)
165 struct ft_tport *tport;
166 struct hlist_head *head;
167 struct ft_sess *sess;
170 tport = rcu_dereference(lport->prov[FC_TYPE_FCP]);
174 head = &tport->hash[ft_sess_hash(port_id)];
175 hlist_for_each_entry_rcu(sess, head, hash) {
176 if (sess->port_id == port_id) {
177 kref_get(&sess->kref);
179 pr_debug("port_id %x found %p\n", port_id, sess);
185 pr_debug("port_id %x not found\n", port_id);
190 * Allocate session and enter it in the hash for the local port.
191 * Caller holds ft_lport_lock.
193 static struct ft_sess *ft_sess_create(struct ft_tport *tport, u32 port_id,
194 struct ft_node_acl *acl)
196 struct ft_sess *sess;
197 struct hlist_head *head;
199 head = &tport->hash[ft_sess_hash(port_id)];
200 hlist_for_each_entry_rcu(sess, head, hash)
201 if (sess->port_id == port_id)
204 sess = kzalloc(sizeof(*sess), GFP_KERNEL);
208 sess->se_sess = transport_init_session_tags(TCM_FC_DEFAULT_TAGS,
209 sizeof(struct ft_cmd),
211 if (IS_ERR(sess->se_sess)) {
215 sess->se_sess->se_node_acl = &acl->se_node_acl;
217 sess->port_id = port_id;
218 kref_init(&sess->kref); /* ref for table entry */
219 hlist_add_head_rcu(&sess->hash, head);
222 pr_debug("port_id %x sess %p\n", port_id, sess);
224 transport_register_session(&tport->tpg->se_tpg, &acl->se_node_acl,
225 sess->se_sess, sess);
230 * Unhash the session.
231 * Caller holds ft_lport_lock.
233 static void ft_sess_unhash(struct ft_sess *sess)
235 struct ft_tport *tport = sess->tport;
237 hlist_del_rcu(&sess->hash);
238 BUG_ON(!tport->sess_count);
245 * Delete session from hash.
246 * Caller holds ft_lport_lock.
248 static struct ft_sess *ft_sess_delete(struct ft_tport *tport, u32 port_id)
250 struct hlist_head *head;
251 struct ft_sess *sess;
253 head = &tport->hash[ft_sess_hash(port_id)];
254 hlist_for_each_entry_rcu(sess, head, hash) {
255 if (sess->port_id == port_id) {
256 ft_sess_unhash(sess);
264 * Delete all sessions from tport.
265 * Caller holds ft_lport_lock.
267 static void ft_sess_delete_all(struct ft_tport *tport)
269 struct hlist_head *head;
270 struct ft_sess *sess;
272 for (head = tport->hash;
273 head < &tport->hash[FT_SESS_HASH_SIZE]; head++) {
274 hlist_for_each_entry_rcu(sess, head, hash) {
275 ft_sess_unhash(sess);
276 transport_deregister_session_configfs(sess->se_sess);
277 ft_sess_put(sess); /* release from table */
283 * TCM ops for sessions.
287 * Determine whether session is allowed to be shutdown in the current context.
288 * Returns non-zero if the session should be shutdown.
290 int ft_sess_shutdown(struct se_session *se_sess)
292 struct ft_sess *sess = se_sess->fabric_sess_ptr;
294 pr_debug("port_id %x\n", sess->port_id);
299 * Remove session and send PRLO.
300 * This is called when the ACL is being deleted or queue depth is changing.
302 void ft_sess_close(struct se_session *se_sess)
304 struct ft_sess *sess = se_sess->fabric_sess_ptr;
307 mutex_lock(&ft_lport_lock);
308 port_id = sess->port_id;
310 mutex_unlock(&ft_lport_lock);
313 pr_debug("port_id %x\n", port_id);
314 ft_sess_unhash(sess);
315 mutex_unlock(&ft_lport_lock);
316 transport_deregister_session_configfs(se_sess);
318 /* XXX Send LOGO or PRLO */
319 synchronize_rcu(); /* let transport deregister happen */
322 u32 ft_sess_get_index(struct se_session *se_sess)
324 struct ft_sess *sess = se_sess->fabric_sess_ptr;
326 return sess->port_id; /* XXX TBD probably not what is needed */
329 u32 ft_sess_get_port_name(struct se_session *se_sess,
330 unsigned char *buf, u32 len)
332 struct ft_sess *sess = se_sess->fabric_sess_ptr;
334 return ft_format_wwn(buf, len, sess->port_name);
338 * libfc ops involving sessions.
341 static int ft_prli_locked(struct fc_rport_priv *rdata, u32 spp_len,
342 const struct fc_els_spp *rspp, struct fc_els_spp *spp)
344 struct ft_tport *tport;
345 struct ft_sess *sess;
346 struct ft_node_acl *acl;
349 tport = ft_tport_get(rdata->local_port);
351 goto not_target; /* not a target for this local port */
353 acl = ft_acl_get(tport->tpg, rdata);
355 goto not_target; /* no target for this remote */
360 if (rspp->spp_flags & (FC_SPP_OPA_VAL | FC_SPP_RPA_VAL))
361 return FC_SPP_RESP_NO_PA;
364 * If both target and initiator bits are off, the SPP is invalid.
366 fcp_parm = ntohl(rspp->spp_params);
367 if (!(fcp_parm & (FCP_SPPF_INIT_FCN | FCP_SPPF_TARG_FCN)))
368 return FC_SPP_RESP_INVL;
371 * Create session (image pair) only if requested by
372 * EST_IMG_PAIR flag and if the requestor is an initiator.
374 if (rspp->spp_flags & FC_SPP_EST_IMG_PAIR) {
375 spp->spp_flags |= FC_SPP_EST_IMG_PAIR;
376 if (!(fcp_parm & FCP_SPPF_INIT_FCN))
377 return FC_SPP_RESP_CONF;
378 sess = ft_sess_create(tport, rdata->ids.port_id, acl);
380 return FC_SPP_RESP_RES;
383 sess->params = fcp_parm;
384 sess->port_name = rdata->ids.port_name;
385 sess->max_frame = rdata->maxframe_size;
387 /* XXX TBD - clearing actions. unit attn, see 4.10 */
391 * OR in our service parameters with other provider (initiator), if any.
394 fcp_parm = ntohl(spp->spp_params);
395 fcp_parm &= ~FCP_SPPF_RETRY;
396 spp->spp_params = htonl(fcp_parm | FCP_SPPF_TARG_FCN);
397 return FC_SPP_RESP_ACK;
400 fcp_parm = ntohl(spp->spp_params);
401 fcp_parm &= ~FCP_SPPF_TARG_FCN;
402 spp->spp_params = htonl(fcp_parm);
407 * tcm_fcp_prli() - Handle incoming or outgoing PRLI for the FCP target
408 * @rdata: remote port private
409 * @spp_len: service parameter page length
410 * @rspp: received service parameter page (NULL for outgoing PRLI)
411 * @spp: response service parameter page
413 * Returns spp response code.
415 static int ft_prli(struct fc_rport_priv *rdata, u32 spp_len,
416 const struct fc_els_spp *rspp, struct fc_els_spp *spp)
420 mutex_lock(&ft_lport_lock);
421 ret = ft_prli_locked(rdata, spp_len, rspp, spp);
422 mutex_unlock(&ft_lport_lock);
423 pr_debug("port_id %x flags %x ret %x\n",
424 rdata->ids.port_id, rspp ? rspp->spp_flags : 0, ret);
428 static void ft_sess_free(struct kref *kref)
430 struct ft_sess *sess = container_of(kref, struct ft_sess, kref);
432 transport_deregister_session(sess->se_sess);
433 kfree_rcu(sess, rcu);
436 void ft_sess_put(struct ft_sess *sess)
438 int sess_held = atomic_read(&sess->kref.refcount);
441 kref_put(&sess->kref, ft_sess_free);
444 static void ft_prlo(struct fc_rport_priv *rdata)
446 struct ft_sess *sess;
447 struct ft_tport *tport;
449 mutex_lock(&ft_lport_lock);
450 tport = rcu_dereference_protected(rdata->local_port->prov[FC_TYPE_FCP],
451 lockdep_is_held(&ft_lport_lock));
454 mutex_unlock(&ft_lport_lock);
457 sess = ft_sess_delete(tport, rdata->ids.port_id);
459 mutex_unlock(&ft_lport_lock);
462 mutex_unlock(&ft_lport_lock);
463 transport_deregister_session_configfs(sess->se_sess);
464 ft_sess_put(sess); /* release from table */
466 /* XXX TBD - clearing actions. unit attn, see 4.10 */
470 * Handle incoming FCP request.
471 * Caller has verified that the frame is type FCP.
473 static void ft_recv(struct fc_lport *lport, struct fc_frame *fp)
475 struct ft_sess *sess;
476 u32 sid = fc_frame_sid(fp);
478 pr_debug("sid %x\n", sid);
480 sess = ft_sess_get(lport, sid);
482 pr_debug("sid %x sess lookup failed\n", sid);
483 /* TBD XXX - if FCP_CMND, send PRLO */
487 ft_recv_req(sess, fp); /* must do ft_sess_put() */
491 * Provider ops for libfc.
493 struct fc4_prov ft_prov = {
497 .module = THIS_MODULE,