2 * iSCSI transport class definitions
4 * Copyright (C) IBM Corporation, 2004
5 * Copyright (C) Mike Christie, 2004 - 2005
6 * Copyright (C) Dmitry Yusupov, 2004 - 2005
7 * Copyright (C) Alex Aizman, 2004 - 2005
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 #include <linux/module.h>
24 #include <linux/mutex.h>
26 #include <scsi/scsi.h>
27 #include <scsi/scsi_host.h>
28 #include <scsi/scsi_device.h>
29 #include <scsi/scsi_transport.h>
30 #include <scsi/scsi_transport_iscsi.h>
31 #include <scsi/iscsi_if.h>
33 #define ISCSI_SESSION_ATTRS 11
34 #define ISCSI_CONN_ATTRS 11
35 #define ISCSI_HOST_ATTRS 0
36 #define ISCSI_TRANSPORT_VERSION "2.0-685"
38 struct iscsi_internal {
40 struct scsi_transport_template t;
41 struct iscsi_transport *iscsi_transport;
42 struct list_head list;
43 struct class_device cdev;
45 struct class_device_attribute *host_attrs[ISCSI_HOST_ATTRS + 1];
46 struct transport_container conn_cont;
47 struct class_device_attribute *conn_attrs[ISCSI_CONN_ATTRS + 1];
48 struct transport_container session_cont;
49 struct class_device_attribute *session_attrs[ISCSI_SESSION_ATTRS + 1];
52 static int iscsi_session_nr; /* sysfs session id for next new session */
55 * list of registered transports and lock that must
56 * be held while accessing list. The iscsi_transport_lock must
57 * be acquired after the rx_queue_mutex.
59 static LIST_HEAD(iscsi_transports);
60 static DEFINE_SPINLOCK(iscsi_transport_lock);
62 #define to_iscsi_internal(tmpl) \
63 container_of(tmpl, struct iscsi_internal, t)
65 #define cdev_to_iscsi_internal(_cdev) \
66 container_of(_cdev, struct iscsi_internal, cdev)
68 static void iscsi_transport_release(struct class_device *cdev)
70 struct iscsi_internal *priv = cdev_to_iscsi_internal(cdev);
75 * iscsi_transport_class represents the iscsi_transports that are
78 static struct class iscsi_transport_class = {
79 .name = "iscsi_transport",
80 .release = iscsi_transport_release,
84 show_transport_handle(struct class_device *cdev, char *buf)
86 struct iscsi_internal *priv = cdev_to_iscsi_internal(cdev);
87 return sprintf(buf, "%llu\n", (unsigned long long)iscsi_handle(priv->iscsi_transport));
89 static CLASS_DEVICE_ATTR(handle, S_IRUGO, show_transport_handle, NULL);
91 #define show_transport_attr(name, format) \
93 show_transport_##name(struct class_device *cdev, char *buf) \
95 struct iscsi_internal *priv = cdev_to_iscsi_internal(cdev); \
96 return sprintf(buf, format"\n", priv->iscsi_transport->name); \
98 static CLASS_DEVICE_ATTR(name, S_IRUGO, show_transport_##name, NULL);
100 show_transport_attr(caps, "0x%x");
101 show_transport_attr(max_lun, "%d");
102 show_transport_attr(max_conn, "%d");
103 show_transport_attr(max_cmd_len, "%d");
105 static struct attribute *iscsi_transport_attrs[] = {
106 &class_device_attr_handle.attr,
107 &class_device_attr_caps.attr,
108 &class_device_attr_max_lun.attr,
109 &class_device_attr_max_conn.attr,
110 &class_device_attr_max_cmd_len.attr,
114 static struct attribute_group iscsi_transport_group = {
115 .attrs = iscsi_transport_attrs,
118 static int iscsi_setup_host(struct transport_container *tc, struct device *dev,
119 struct class_device *cdev)
121 struct Scsi_Host *shost = dev_to_shost(dev);
122 struct iscsi_host *ihost = shost->shost_data;
124 memset(ihost, 0, sizeof(*ihost));
125 INIT_LIST_HEAD(&ihost->sessions);
126 mutex_init(&ihost->mutex);
130 static DECLARE_TRANSPORT_CLASS(iscsi_host_class,
136 static DECLARE_TRANSPORT_CLASS(iscsi_session_class,
142 static DECLARE_TRANSPORT_CLASS(iscsi_connection_class,
148 static struct sock *nls;
149 static DEFINE_MUTEX(rx_queue_mutex);
151 static LIST_HEAD(sesslist);
152 static DEFINE_SPINLOCK(sesslock);
153 static LIST_HEAD(connlist);
154 static DEFINE_SPINLOCK(connlock);
156 static uint32_t iscsi_conn_get_sid(struct iscsi_cls_conn *conn)
158 struct iscsi_cls_session *sess = iscsi_dev_to_session(conn->dev.parent);
163 * Returns the matching session to a given sid
165 static struct iscsi_cls_session *iscsi_session_lookup(uint32_t sid)
168 struct iscsi_cls_session *sess;
170 spin_lock_irqsave(&sesslock, flags);
171 list_for_each_entry(sess, &sesslist, sess_list) {
172 if (sess->sid == sid) {
173 spin_unlock_irqrestore(&sesslock, flags);
177 spin_unlock_irqrestore(&sesslock, flags);
182 * Returns the matching connection to a given sid / cid tuple
184 static struct iscsi_cls_conn *iscsi_conn_lookup(uint32_t sid, uint32_t cid)
187 struct iscsi_cls_conn *conn;
189 spin_lock_irqsave(&connlock, flags);
190 list_for_each_entry(conn, &connlist, conn_list) {
191 if ((conn->cid == cid) && (iscsi_conn_get_sid(conn) == sid)) {
192 spin_unlock_irqrestore(&connlock, flags);
196 spin_unlock_irqrestore(&connlock, flags);
201 * The following functions can be used by LLDs that allocate
202 * their own scsi_hosts or by software iscsi LLDs
204 static void iscsi_session_release(struct device *dev)
206 struct iscsi_cls_session *session = iscsi_dev_to_session(dev);
207 struct Scsi_Host *shost;
209 shost = iscsi_session_to_shost(session);
210 scsi_host_put(shost);
214 static int iscsi_is_session_dev(const struct device *dev)
216 return dev->release == iscsi_session_release;
219 static int iscsi_user_scan(struct Scsi_Host *shost, uint channel,
222 struct iscsi_host *ihost = shost->shost_data;
223 struct iscsi_cls_session *session;
225 mutex_lock(&ihost->mutex);
226 list_for_each_entry(session, &ihost->sessions, host_list) {
227 if ((channel == SCAN_WILD_CARD || channel == 0) &&
228 (id == SCAN_WILD_CARD || id == session->target_id))
229 scsi_scan_target(&session->dev, 0,
230 session->target_id, lun, 1);
232 mutex_unlock(&ihost->mutex);
237 static void session_recovery_timedout(void *data)
239 struct iscsi_cls_session *session = data;
241 dev_printk(KERN_INFO, &session->dev, "iscsi: session recovery timed "
242 "out after %d secs\n", session->recovery_tmo);
244 if (session->transport->session_recovery_timedout)
245 session->transport->session_recovery_timedout(session);
247 scsi_target_unblock(&session->dev);
250 void iscsi_unblock_session(struct iscsi_cls_session *session)
252 if (!cancel_delayed_work(&session->recovery_work))
253 flush_scheduled_work();
254 scsi_target_unblock(&session->dev);
256 EXPORT_SYMBOL_GPL(iscsi_unblock_session);
258 void iscsi_block_session(struct iscsi_cls_session *session)
260 scsi_target_block(&session->dev);
261 schedule_delayed_work(&session->recovery_work,
262 session->recovery_tmo * HZ);
264 EXPORT_SYMBOL_GPL(iscsi_block_session);
266 struct iscsi_cls_session *
267 iscsi_alloc_session(struct Scsi_Host *shost,
268 struct iscsi_transport *transport)
270 struct iscsi_cls_session *session;
272 session = kzalloc(sizeof(*session) + transport->sessiondata_size,
277 session->transport = transport;
278 session->recovery_tmo = 120;
279 INIT_WORK(&session->recovery_work, session_recovery_timedout, session);
280 INIT_LIST_HEAD(&session->host_list);
281 INIT_LIST_HEAD(&session->sess_list);
283 /* this is released in the dev's release function */
284 scsi_host_get(shost);
285 session->dev.parent = &shost->shost_gendev;
286 session->dev.release = iscsi_session_release;
287 device_initialize(&session->dev);
288 if (transport->sessiondata_size)
289 session->dd_data = &session[1];
292 EXPORT_SYMBOL_GPL(iscsi_alloc_session);
294 int iscsi_add_session(struct iscsi_cls_session *session, unsigned int target_id)
296 struct Scsi_Host *shost = iscsi_session_to_shost(session);
297 struct iscsi_host *ihost;
300 ihost = shost->shost_data;
301 session->sid = iscsi_session_nr++;
302 session->target_id = target_id;
304 snprintf(session->dev.bus_id, BUS_ID_SIZE, "session%u",
306 err = device_add(&session->dev);
308 dev_printk(KERN_ERR, &session->dev, "iscsi: could not "
309 "register session's dev\n");
312 transport_register_device(&session->dev);
314 mutex_lock(&ihost->mutex);
315 list_add(&session->host_list, &ihost->sessions);
316 mutex_unlock(&ihost->mutex);
320 scsi_host_put(shost);
323 EXPORT_SYMBOL_GPL(iscsi_add_session);
326 * iscsi_create_session - create iscsi class session
328 * @transport: iscsi transport
330 * This can be called from a LLD or iscsi_transport.
332 struct iscsi_cls_session *
333 iscsi_create_session(struct Scsi_Host *shost,
334 struct iscsi_transport *transport,
335 unsigned int target_id)
337 struct iscsi_cls_session *session;
339 session = iscsi_alloc_session(shost, transport);
343 if (iscsi_add_session(session, target_id)) {
344 iscsi_free_session(session);
349 EXPORT_SYMBOL_GPL(iscsi_create_session);
351 void iscsi_remove_session(struct iscsi_cls_session *session)
353 struct Scsi_Host *shost = iscsi_session_to_shost(session);
354 struct iscsi_host *ihost = shost->shost_data;
356 if (!cancel_delayed_work(&session->recovery_work))
357 flush_scheduled_work();
359 mutex_lock(&ihost->mutex);
360 list_del(&session->host_list);
361 mutex_unlock(&ihost->mutex);
363 scsi_remove_target(&session->dev);
365 transport_unregister_device(&session->dev);
366 device_del(&session->dev);
368 EXPORT_SYMBOL_GPL(iscsi_remove_session);
370 void iscsi_free_session(struct iscsi_cls_session *session)
372 put_device(&session->dev);
375 EXPORT_SYMBOL_GPL(iscsi_free_session);
378 * iscsi_destroy_session - destroy iscsi session
379 * @session: iscsi_session
381 * Can be called by a LLD or iscsi_transport. There must not be
382 * any running connections.
384 int iscsi_destroy_session(struct iscsi_cls_session *session)
386 iscsi_remove_session(session);
387 iscsi_free_session(session);
390 EXPORT_SYMBOL_GPL(iscsi_destroy_session);
392 static void iscsi_conn_release(struct device *dev)
394 struct iscsi_cls_conn *conn = iscsi_dev_to_conn(dev);
395 struct device *parent = conn->dev.parent;
401 static int iscsi_is_conn_dev(const struct device *dev)
403 return dev->release == iscsi_conn_release;
407 * iscsi_create_conn - create iscsi class connection
408 * @session: iscsi cls session
409 * @cid: connection id
411 * This can be called from a LLD or iscsi_transport. The connection
412 * is child of the session so cid must be unique for all connections
415 * Since we do not support MCS, cid will normally be zero. In some cases
416 * for software iscsi we could be trying to preallocate a connection struct
417 * in which case there could be two connection structs and cid would be
420 struct iscsi_cls_conn *
421 iscsi_create_conn(struct iscsi_cls_session *session, uint32_t cid)
423 struct iscsi_transport *transport = session->transport;
424 struct iscsi_cls_conn *conn;
427 conn = kzalloc(sizeof(*conn) + transport->conndata_size, GFP_KERNEL);
431 if (transport->conndata_size)
432 conn->dd_data = &conn[1];
434 INIT_LIST_HEAD(&conn->conn_list);
435 conn->transport = transport;
438 /* this is released in the dev's release function */
439 if (!get_device(&session->dev))
442 snprintf(conn->dev.bus_id, BUS_ID_SIZE, "connection%d:%u",
444 conn->dev.parent = &session->dev;
445 conn->dev.release = iscsi_conn_release;
446 err = device_register(&conn->dev);
448 dev_printk(KERN_ERR, &conn->dev, "iscsi: could not register "
449 "connection's dev\n");
450 goto release_parent_ref;
452 transport_register_device(&conn->dev);
456 put_device(&session->dev);
462 EXPORT_SYMBOL_GPL(iscsi_create_conn);
465 * iscsi_destroy_conn - destroy iscsi class connection
466 * @session: iscsi cls session
468 * This can be called from a LLD or iscsi_transport.
470 int iscsi_destroy_conn(struct iscsi_cls_conn *conn)
472 transport_unregister_device(&conn->dev);
473 device_unregister(&conn->dev);
477 EXPORT_SYMBOL_GPL(iscsi_destroy_conn);
480 * iscsi interface functions
482 static struct iscsi_internal *
483 iscsi_if_transport_lookup(struct iscsi_transport *tt)
485 struct iscsi_internal *priv;
488 spin_lock_irqsave(&iscsi_transport_lock, flags);
489 list_for_each_entry(priv, &iscsi_transports, list) {
490 if (tt == priv->iscsi_transport) {
491 spin_unlock_irqrestore(&iscsi_transport_lock, flags);
495 spin_unlock_irqrestore(&iscsi_transport_lock, flags);
500 iscsi_broadcast_skb(struct sk_buff *skb, gfp_t gfp)
504 rc = netlink_broadcast(nls, skb, 0, 1, gfp);
506 printk(KERN_ERR "iscsi: can not broadcast skb (%d)\n", rc);
514 iscsi_unicast_skb(struct sk_buff *skb, int pid)
518 rc = netlink_unicast(nls, skb, pid, MSG_DONTWAIT);
520 printk(KERN_ERR "iscsi: can not unicast skb (%d)\n", rc);
527 int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
528 char *data, uint32_t data_size)
530 struct nlmsghdr *nlh;
532 struct iscsi_uevent *ev;
534 struct iscsi_internal *priv;
535 int len = NLMSG_SPACE(sizeof(*ev) + sizeof(struct iscsi_hdr) +
538 priv = iscsi_if_transport_lookup(conn->transport);
542 skb = alloc_skb(len, GFP_ATOMIC);
544 iscsi_conn_error(conn, ISCSI_ERR_CONN_FAILED);
545 dev_printk(KERN_ERR, &conn->dev, "iscsi: can not deliver "
546 "control PDU: OOM\n");
550 nlh = __nlmsg_put(skb, priv->daemon_pid, 0, 0, (len - sizeof(*nlh)), 0);
551 ev = NLMSG_DATA(nlh);
552 memset(ev, 0, sizeof(*ev));
553 ev->transport_handle = iscsi_handle(conn->transport);
554 ev->type = ISCSI_KEVENT_RECV_PDU;
555 ev->r.recv_req.cid = conn->cid;
556 ev->r.recv_req.sid = iscsi_conn_get_sid(conn);
557 pdu = (char*)ev + sizeof(*ev);
558 memcpy(pdu, hdr, sizeof(struct iscsi_hdr));
559 memcpy(pdu + sizeof(struct iscsi_hdr), data, data_size);
561 return iscsi_unicast_skb(skb, priv->daemon_pid);
563 EXPORT_SYMBOL_GPL(iscsi_recv_pdu);
565 void iscsi_conn_error(struct iscsi_cls_conn *conn, enum iscsi_err error)
567 struct nlmsghdr *nlh;
569 struct iscsi_uevent *ev;
570 struct iscsi_internal *priv;
571 int len = NLMSG_SPACE(sizeof(*ev));
573 priv = iscsi_if_transport_lookup(conn->transport);
577 skb = alloc_skb(len, GFP_ATOMIC);
579 dev_printk(KERN_ERR, &conn->dev, "iscsi: gracefully ignored "
580 "conn error (%d)\n", error);
584 nlh = __nlmsg_put(skb, priv->daemon_pid, 0, 0, (len - sizeof(*nlh)), 0);
585 ev = NLMSG_DATA(nlh);
586 ev->transport_handle = iscsi_handle(conn->transport);
587 ev->type = ISCSI_KEVENT_CONN_ERROR;
588 ev->r.connerror.error = error;
589 ev->r.connerror.cid = conn->cid;
590 ev->r.connerror.sid = iscsi_conn_get_sid(conn);
592 iscsi_broadcast_skb(skb, GFP_ATOMIC);
594 dev_printk(KERN_INFO, &conn->dev, "iscsi: detected conn error (%d)\n",
597 EXPORT_SYMBOL_GPL(iscsi_conn_error);
600 iscsi_if_send_reply(int pid, int seq, int type, int done, int multi,
601 void *payload, int size)
604 struct nlmsghdr *nlh;
605 int len = NLMSG_SPACE(size);
606 int flags = multi ? NLM_F_MULTI : 0;
607 int t = done ? NLMSG_DONE : type;
609 skb = alloc_skb(len, GFP_ATOMIC);
612 * user is supposed to react on iferror == -ENOMEM;
617 nlh = __nlmsg_put(skb, pid, seq, t, (len - sizeof(*nlh)), 0);
618 nlh->nlmsg_flags = flags;
619 memcpy(NLMSG_DATA(nlh), payload, size);
620 return iscsi_unicast_skb(skb, pid);
624 iscsi_if_get_stats(struct iscsi_transport *transport, struct nlmsghdr *nlh)
626 struct iscsi_uevent *ev = NLMSG_DATA(nlh);
627 struct iscsi_stats *stats;
628 struct sk_buff *skbstat;
629 struct iscsi_cls_conn *conn;
630 struct nlmsghdr *nlhstat;
631 struct iscsi_uevent *evstat;
632 struct iscsi_internal *priv;
633 int len = NLMSG_SPACE(sizeof(*ev) +
634 sizeof(struct iscsi_stats) +
635 sizeof(struct iscsi_stats_custom) *
636 ISCSI_STATS_CUSTOM_MAX);
639 priv = iscsi_if_transport_lookup(transport);
643 conn = iscsi_conn_lookup(ev->u.get_stats.sid, ev->u.get_stats.cid);
650 skbstat = alloc_skb(len, GFP_ATOMIC);
652 dev_printk(KERN_ERR, &conn->dev, "iscsi: can not "
653 "deliver stats: OOM\n");
657 nlhstat = __nlmsg_put(skbstat, priv->daemon_pid, 0, 0,
658 (len - sizeof(*nlhstat)), 0);
659 evstat = NLMSG_DATA(nlhstat);
660 memset(evstat, 0, sizeof(*evstat));
661 evstat->transport_handle = iscsi_handle(conn->transport);
662 evstat->type = nlh->nlmsg_type;
663 evstat->u.get_stats.cid =
665 evstat->u.get_stats.sid =
667 stats = (struct iscsi_stats *)
668 ((char*)evstat + sizeof(*evstat));
669 memset(stats, 0, sizeof(*stats));
671 transport->get_stats(conn, stats);
672 actual_size = NLMSG_SPACE(sizeof(struct iscsi_uevent) +
673 sizeof(struct iscsi_stats) +
674 sizeof(struct iscsi_stats_custom) *
675 stats->custom_length);
676 actual_size -= sizeof(*nlhstat);
677 actual_size = NLMSG_LENGTH(actual_size);
678 skb_trim(skbstat, NLMSG_ALIGN(actual_size));
679 nlhstat->nlmsg_len = actual_size;
681 err = iscsi_unicast_skb(skbstat, priv->daemon_pid);
682 } while (err < 0 && err != -ECONNREFUSED);
688 * iscsi_if_destroy_session_done - send session destr. completion event
689 * @conn: last connection for session
691 * This is called by HW iscsi LLDs to notify userpsace that its HW has
694 int iscsi_if_destroy_session_done(struct iscsi_cls_conn *conn)
696 struct iscsi_internal *priv;
697 struct iscsi_cls_session *session;
698 struct Scsi_Host *shost;
699 struct iscsi_uevent *ev;
701 struct nlmsghdr *nlh;
703 int rc, len = NLMSG_SPACE(sizeof(*ev));
705 priv = iscsi_if_transport_lookup(conn->transport);
709 session = iscsi_dev_to_session(conn->dev.parent);
710 shost = iscsi_session_to_shost(session);
712 skb = alloc_skb(len, GFP_KERNEL);
714 dev_printk(KERN_ERR, &conn->dev, "Cannot notify userspace of "
715 "session creation event\n");
719 nlh = __nlmsg_put(skb, priv->daemon_pid, 0, 0, (len - sizeof(*nlh)), 0);
720 ev = NLMSG_DATA(nlh);
721 ev->transport_handle = iscsi_handle(conn->transport);
722 ev->type = ISCSI_KEVENT_DESTROY_SESSION;
723 ev->r.d_session.host_no = shost->host_no;
724 ev->r.d_session.sid = session->sid;
727 * this will occur if the daemon is not up, so we just warn
728 * the user and when the daemon is restarted it will handle it
730 rc = iscsi_broadcast_skb(skb, GFP_KERNEL);
732 dev_printk(KERN_ERR, &conn->dev, "Cannot notify userspace of "
733 "session destruction event. Check iscsi daemon\n");
735 spin_lock_irqsave(&sesslock, flags);
736 list_del(&session->sess_list);
737 spin_unlock_irqrestore(&sesslock, flags);
739 spin_lock_irqsave(&connlock, flags);
741 list_del(&conn->conn_list);
742 spin_unlock_irqrestore(&connlock, flags);
746 EXPORT_SYMBOL_GPL(iscsi_if_destroy_session_done);
749 * iscsi_if_create_session_done - send session creation completion event
750 * @conn: leading connection for session
752 * This is called by HW iscsi LLDs to notify userpsace that its HW has
753 * created a session or a existing session is back in the logged in state.
755 int iscsi_if_create_session_done(struct iscsi_cls_conn *conn)
757 struct iscsi_internal *priv;
758 struct iscsi_cls_session *session;
759 struct Scsi_Host *shost;
760 struct iscsi_uevent *ev;
762 struct nlmsghdr *nlh;
764 int rc, len = NLMSG_SPACE(sizeof(*ev));
766 priv = iscsi_if_transport_lookup(conn->transport);
770 session = iscsi_dev_to_session(conn->dev.parent);
771 shost = iscsi_session_to_shost(session);
773 skb = alloc_skb(len, GFP_KERNEL);
775 dev_printk(KERN_ERR, &conn->dev, "Cannot notify userspace of "
776 "session creation event\n");
780 nlh = __nlmsg_put(skb, priv->daemon_pid, 0, 0, (len - sizeof(*nlh)), 0);
781 ev = NLMSG_DATA(nlh);
782 ev->transport_handle = iscsi_handle(conn->transport);
783 ev->type = ISCSI_UEVENT_CREATE_SESSION;
784 ev->r.c_session_ret.host_no = shost->host_no;
785 ev->r.c_session_ret.sid = session->sid;
788 * this will occur if the daemon is not up, so we just warn
789 * the user and when the daemon is restarted it will handle it
791 rc = iscsi_broadcast_skb(skb, GFP_KERNEL);
793 dev_printk(KERN_ERR, &conn->dev, "Cannot notify userspace of "
794 "session creation event. Check iscsi daemon\n");
796 spin_lock_irqsave(&sesslock, flags);
797 list_add(&session->sess_list, &sesslist);
798 spin_unlock_irqrestore(&sesslock, flags);
800 spin_lock_irqsave(&connlock, flags);
801 list_add(&conn->conn_list, &connlist);
803 spin_unlock_irqrestore(&connlock, flags);
806 EXPORT_SYMBOL_GPL(iscsi_if_create_session_done);
809 iscsi_if_create_session(struct iscsi_internal *priv, struct iscsi_uevent *ev)
811 struct iscsi_transport *transport = priv->iscsi_transport;
812 struct iscsi_cls_session *session;
816 session = transport->create_session(transport, &priv->t,
817 ev->u.c_session.initial_cmdsn,
822 spin_lock_irqsave(&sesslock, flags);
823 list_add(&session->sess_list, &sesslist);
824 spin_unlock_irqrestore(&sesslock, flags);
826 ev->r.c_session_ret.host_no = hostno;
827 ev->r.c_session_ret.sid = session->sid;
832 iscsi_if_create_conn(struct iscsi_transport *transport, struct iscsi_uevent *ev)
834 struct iscsi_cls_conn *conn;
835 struct iscsi_cls_session *session;
838 session = iscsi_session_lookup(ev->u.c_conn.sid);
840 printk(KERN_ERR "iscsi: invalid session %d\n",
845 conn = transport->create_conn(session, ev->u.c_conn.cid);
847 printk(KERN_ERR "iscsi: couldn't create a new "
848 "connection for session %d\n",
853 ev->r.c_conn_ret.sid = session->sid;
854 ev->r.c_conn_ret.cid = conn->cid;
856 spin_lock_irqsave(&connlock, flags);
857 list_add(&conn->conn_list, &connlist);
859 spin_unlock_irqrestore(&connlock, flags);
865 iscsi_if_destroy_conn(struct iscsi_transport *transport, struct iscsi_uevent *ev)
868 struct iscsi_cls_conn *conn;
870 conn = iscsi_conn_lookup(ev->u.d_conn.sid, ev->u.d_conn.cid);
873 spin_lock_irqsave(&connlock, flags);
875 list_del(&conn->conn_list);
876 spin_unlock_irqrestore(&connlock, flags);
878 if (transport->destroy_conn)
879 transport->destroy_conn(conn);
884 iscsi_set_param(struct iscsi_transport *transport, struct iscsi_uevent *ev)
886 char *data = (char*)ev + sizeof(*ev);
887 struct iscsi_cls_conn *conn;
888 struct iscsi_cls_session *session;
889 int err = 0, value = 0;
891 session = iscsi_session_lookup(ev->u.set_param.sid);
892 conn = iscsi_conn_lookup(ev->u.set_param.sid, ev->u.set_param.cid);
893 if (!conn || !session)
896 switch (ev->u.set_param.param) {
897 case ISCSI_PARAM_SESS_RECOVERY_TMO:
898 sscanf(data, "%d", &value);
900 session->recovery_tmo = value;
903 err = transport->set_param(conn, ev->u.set_param.param,
904 data, ev->u.set_param.len);
911 iscsi_if_transport_ep(struct iscsi_transport *transport,
912 struct iscsi_uevent *ev, int msg_type)
914 struct sockaddr *dst_addr;
918 case ISCSI_UEVENT_TRANSPORT_EP_CONNECT:
919 if (!transport->ep_connect)
922 dst_addr = (struct sockaddr *)((char*)ev + sizeof(*ev));
923 rc = transport->ep_connect(dst_addr,
924 ev->u.ep_connect.non_blocking,
925 &ev->r.ep_connect_ret.handle);
927 case ISCSI_UEVENT_TRANSPORT_EP_POLL:
928 if (!transport->ep_poll)
931 ev->r.retcode = transport->ep_poll(ev->u.ep_poll.ep_handle,
932 ev->u.ep_poll.timeout_ms);
934 case ISCSI_UEVENT_TRANSPORT_EP_DISCONNECT:
935 if (!transport->ep_disconnect)
938 transport->ep_disconnect(ev->u.ep_disconnect.ep_handle);
945 iscsi_tgt_dscvr(struct iscsi_transport *transport,
946 struct iscsi_uevent *ev)
948 struct sockaddr *dst_addr;
950 if (!transport->tgt_dscvr)
953 dst_addr = (struct sockaddr *)((char*)ev + sizeof(*ev));
954 return transport->tgt_dscvr(ev->u.tgt_dscvr.type,
955 ev->u.tgt_dscvr.host_no,
956 ev->u.tgt_dscvr.enable, dst_addr);
960 iscsi_if_recv_msg(struct sk_buff *skb, struct nlmsghdr *nlh)
963 struct iscsi_uevent *ev = NLMSG_DATA(nlh);
964 struct iscsi_transport *transport = NULL;
965 struct iscsi_internal *priv;
966 struct iscsi_cls_session *session;
967 struct iscsi_cls_conn *conn;
970 priv = iscsi_if_transport_lookup(iscsi_ptr(ev->transport_handle));
973 transport = priv->iscsi_transport;
975 if (!try_module_get(transport->owner))
978 priv->daemon_pid = NETLINK_CREDS(skb)->pid;
980 switch (nlh->nlmsg_type) {
981 case ISCSI_UEVENT_CREATE_SESSION:
982 err = iscsi_if_create_session(priv, ev);
984 case ISCSI_UEVENT_DESTROY_SESSION:
985 session = iscsi_session_lookup(ev->u.d_session.sid);
987 spin_lock_irqsave(&sesslock, flags);
988 list_del(&session->sess_list);
989 spin_unlock_irqrestore(&sesslock, flags);
991 transport->destroy_session(session);
995 case ISCSI_UEVENT_CREATE_CONN:
996 err = iscsi_if_create_conn(transport, ev);
998 case ISCSI_UEVENT_DESTROY_CONN:
999 err = iscsi_if_destroy_conn(transport, ev);
1001 case ISCSI_UEVENT_BIND_CONN:
1002 session = iscsi_session_lookup(ev->u.b_conn.sid);
1003 conn = iscsi_conn_lookup(ev->u.b_conn.sid, ev->u.b_conn.cid);
1005 if (session && conn)
1006 ev->r.retcode = transport->bind_conn(session, conn,
1007 ev->u.b_conn.transport_eph,
1008 ev->u.b_conn.is_leading);
1012 case ISCSI_UEVENT_SET_PARAM:
1013 err = iscsi_set_param(transport, ev);
1015 case ISCSI_UEVENT_START_CONN:
1016 conn = iscsi_conn_lookup(ev->u.start_conn.sid, ev->u.start_conn.cid);
1018 ev->r.retcode = transport->start_conn(conn);
1022 case ISCSI_UEVENT_STOP_CONN:
1023 conn = iscsi_conn_lookup(ev->u.stop_conn.sid, ev->u.stop_conn.cid);
1025 transport->stop_conn(conn, ev->u.stop_conn.flag);
1029 case ISCSI_UEVENT_SEND_PDU:
1030 conn = iscsi_conn_lookup(ev->u.send_pdu.sid, ev->u.send_pdu.cid);
1032 ev->r.retcode = transport->send_pdu(conn,
1033 (struct iscsi_hdr*)((char*)ev + sizeof(*ev)),
1034 (char*)ev + sizeof(*ev) + ev->u.send_pdu.hdr_size,
1035 ev->u.send_pdu.data_size);
1039 case ISCSI_UEVENT_GET_STATS:
1040 err = iscsi_if_get_stats(transport, nlh);
1042 case ISCSI_UEVENT_TRANSPORT_EP_CONNECT:
1043 case ISCSI_UEVENT_TRANSPORT_EP_POLL:
1044 case ISCSI_UEVENT_TRANSPORT_EP_DISCONNECT:
1045 err = iscsi_if_transport_ep(transport, ev, nlh->nlmsg_type);
1047 case ISCSI_UEVENT_TGT_DSCVR:
1048 err = iscsi_tgt_dscvr(transport, ev);
1055 module_put(transport->owner);
1060 * Get message from skb (based on rtnetlink_rcv_skb). Each message is
1061 * processed by iscsi_if_recv_msg. Malformed skbs with wrong lengths or
1062 * invalid creds are discarded silently.
1065 iscsi_if_rx(struct sock *sk, int len)
1067 struct sk_buff *skb;
1069 mutex_lock(&rx_queue_mutex);
1070 while ((skb = skb_dequeue(&sk->sk_receive_queue)) != NULL) {
1071 if (NETLINK_CREDS(skb)->uid) {
1072 skb_pull(skb, skb->len);
1076 while (skb->len >= NLMSG_SPACE(0)) {
1079 struct nlmsghdr *nlh;
1080 struct iscsi_uevent *ev;
1082 nlh = (struct nlmsghdr *)skb->data;
1083 if (nlh->nlmsg_len < sizeof(*nlh) ||
1084 skb->len < nlh->nlmsg_len) {
1088 ev = NLMSG_DATA(nlh);
1089 rlen = NLMSG_ALIGN(nlh->nlmsg_len);
1090 if (rlen > skb->len)
1093 err = iscsi_if_recv_msg(skb, nlh);
1095 ev->type = ISCSI_KEVENT_IF_ERROR;
1100 * special case for GET_STATS:
1101 * on success - sending reply and stats from
1102 * inside of if_recv_msg(),
1103 * on error - fall through.
1105 if (ev->type == ISCSI_UEVENT_GET_STATS && !err)
1107 err = iscsi_if_send_reply(
1108 NETLINK_CREDS(skb)->pid, nlh->nlmsg_seq,
1109 nlh->nlmsg_type, 0, 0, ev, sizeof(*ev));
1110 } while (err < 0 && err != -ECONNREFUSED);
1111 skb_pull(skb, rlen);
1116 mutex_unlock(&rx_queue_mutex);
1119 #define iscsi_cdev_to_conn(_cdev) \
1120 iscsi_dev_to_conn(_cdev->dev)
1122 #define ISCSI_CLASS_ATTR(_prefix,_name,_mode,_show,_store) \
1123 struct class_device_attribute class_device_attr_##_prefix##_##_name = \
1124 __ATTR(_name,_mode,_show,_store)
1127 * iSCSI connection attrs
1129 #define iscsi_conn_attr_show(param) \
1131 show_conn_param_##param(struct class_device *cdev, char *buf) \
1133 struct iscsi_cls_conn *conn = iscsi_cdev_to_conn(cdev); \
1134 struct iscsi_transport *t = conn->transport; \
1135 return t->get_conn_param(conn, param, buf); \
1138 #define iscsi_conn_attr(field, param) \
1139 iscsi_conn_attr_show(param) \
1140 static ISCSI_CLASS_ATTR(conn, field, S_IRUGO, show_conn_param_##param, \
1143 iscsi_conn_attr(max_recv_dlength, ISCSI_PARAM_MAX_RECV_DLENGTH);
1144 iscsi_conn_attr(max_xmit_dlength, ISCSI_PARAM_MAX_XMIT_DLENGTH);
1145 iscsi_conn_attr(header_digest, ISCSI_PARAM_HDRDGST_EN);
1146 iscsi_conn_attr(data_digest, ISCSI_PARAM_DATADGST_EN);
1147 iscsi_conn_attr(ifmarker, ISCSI_PARAM_IFMARKER_EN);
1148 iscsi_conn_attr(ofmarker, ISCSI_PARAM_OFMARKER_EN);
1149 iscsi_conn_attr(persistent_port, ISCSI_PARAM_PERSISTENT_PORT);
1150 iscsi_conn_attr(port, ISCSI_PARAM_CONN_PORT);
1151 iscsi_conn_attr(exp_statsn, ISCSI_PARAM_EXP_STATSN);
1152 iscsi_conn_attr(persistent_address, ISCSI_PARAM_PERSISTENT_ADDRESS);
1153 iscsi_conn_attr(address, ISCSI_PARAM_CONN_ADDRESS);
1155 #define iscsi_cdev_to_session(_cdev) \
1156 iscsi_dev_to_session(_cdev->dev)
1159 * iSCSI session attrs
1161 #define iscsi_session_attr_show(param) \
1163 show_session_param_##param(struct class_device *cdev, char *buf) \
1165 struct iscsi_cls_session *session = iscsi_cdev_to_session(cdev); \
1166 struct iscsi_transport *t = session->transport; \
1167 return t->get_session_param(session, param, buf); \
1170 #define iscsi_session_attr(field, param) \
1171 iscsi_session_attr_show(param) \
1172 static ISCSI_CLASS_ATTR(sess, field, S_IRUGO, show_session_param_##param, \
1175 iscsi_session_attr(targetname, ISCSI_PARAM_TARGET_NAME);
1176 iscsi_session_attr(initial_r2t, ISCSI_PARAM_INITIAL_R2T_EN);
1177 iscsi_session_attr(max_outstanding_r2t, ISCSI_PARAM_MAX_R2T);
1178 iscsi_session_attr(immediate_data, ISCSI_PARAM_IMM_DATA_EN);
1179 iscsi_session_attr(first_burst_len, ISCSI_PARAM_FIRST_BURST);
1180 iscsi_session_attr(max_burst_len, ISCSI_PARAM_MAX_BURST);
1181 iscsi_session_attr(data_pdu_in_order, ISCSI_PARAM_PDU_INORDER_EN);
1182 iscsi_session_attr(data_seq_in_order, ISCSI_PARAM_DATASEQ_INORDER_EN);
1183 iscsi_session_attr(erl, ISCSI_PARAM_ERL);
1184 iscsi_session_attr(tpgt, ISCSI_PARAM_TPGT);
1186 #define iscsi_priv_session_attr_show(field, format) \
1188 show_priv_session_##field(struct class_device *cdev, char *buf) \
1190 struct iscsi_cls_session *session = iscsi_cdev_to_session(cdev);\
1191 return sprintf(buf, format"\n", session->field); \
1194 #define iscsi_priv_session_attr(field, format) \
1195 iscsi_priv_session_attr_show(field, format) \
1196 static ISCSI_CLASS_ATTR(priv_sess, field, S_IRUGO, show_priv_session_##field, \
1198 iscsi_priv_session_attr(recovery_tmo, "%d");
1200 #define SETUP_PRIV_SESSION_RD_ATTR(field) \
1202 priv->session_attrs[count] = &class_device_attr_priv_sess_##field; \
1207 #define SETUP_SESSION_RD_ATTR(field, param_flag) \
1209 if (tt->param_mask & param_flag) { \
1210 priv->session_attrs[count] = &class_device_attr_sess_##field; \
1215 #define SETUP_CONN_RD_ATTR(field, param_flag) \
1217 if (tt->param_mask & param_flag) { \
1218 priv->conn_attrs[count] = &class_device_attr_conn_##field; \
1223 static int iscsi_session_match(struct attribute_container *cont,
1226 struct iscsi_cls_session *session;
1227 struct Scsi_Host *shost;
1228 struct iscsi_internal *priv;
1230 if (!iscsi_is_session_dev(dev))
1233 session = iscsi_dev_to_session(dev);
1234 shost = iscsi_session_to_shost(session);
1235 if (!shost->transportt)
1238 priv = to_iscsi_internal(shost->transportt);
1239 if (priv->session_cont.ac.class != &iscsi_session_class.class)
1242 return &priv->session_cont.ac == cont;
1245 static int iscsi_conn_match(struct attribute_container *cont,
1248 struct iscsi_cls_session *session;
1249 struct iscsi_cls_conn *conn;
1250 struct Scsi_Host *shost;
1251 struct iscsi_internal *priv;
1253 if (!iscsi_is_conn_dev(dev))
1256 conn = iscsi_dev_to_conn(dev);
1257 session = iscsi_dev_to_session(conn->dev.parent);
1258 shost = iscsi_session_to_shost(session);
1260 if (!shost->transportt)
1263 priv = to_iscsi_internal(shost->transportt);
1264 if (priv->conn_cont.ac.class != &iscsi_connection_class.class)
1267 return &priv->conn_cont.ac == cont;
1270 static int iscsi_host_match(struct attribute_container *cont,
1273 struct Scsi_Host *shost;
1274 struct iscsi_internal *priv;
1276 if (!scsi_is_host_device(dev))
1279 shost = dev_to_shost(dev);
1280 if (!shost->transportt ||
1281 shost->transportt->host_attrs.ac.class != &iscsi_host_class.class)
1284 priv = to_iscsi_internal(shost->transportt);
1285 return &priv->t.host_attrs.ac == cont;
1288 struct scsi_transport_template *
1289 iscsi_register_transport(struct iscsi_transport *tt)
1291 struct iscsi_internal *priv;
1292 unsigned long flags;
1297 priv = iscsi_if_transport_lookup(tt);
1301 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
1304 INIT_LIST_HEAD(&priv->list);
1305 priv->daemon_pid = -1;
1306 priv->iscsi_transport = tt;
1307 priv->t.user_scan = iscsi_user_scan;
1309 priv->cdev.class = &iscsi_transport_class;
1310 snprintf(priv->cdev.class_id, BUS_ID_SIZE, "%s", tt->name);
1311 err = class_device_register(&priv->cdev);
1315 err = sysfs_create_group(&priv->cdev.kobj, &iscsi_transport_group);
1317 goto unregister_cdev;
1319 /* host parameters */
1320 priv->t.host_attrs.ac.attrs = &priv->host_attrs[0];
1321 priv->t.host_attrs.ac.class = &iscsi_host_class.class;
1322 priv->t.host_attrs.ac.match = iscsi_host_match;
1323 priv->t.host_size = sizeof(struct iscsi_host);
1324 priv->host_attrs[0] = NULL;
1325 transport_container_register(&priv->t.host_attrs);
1327 /* connection parameters */
1328 priv->conn_cont.ac.attrs = &priv->conn_attrs[0];
1329 priv->conn_cont.ac.class = &iscsi_connection_class.class;
1330 priv->conn_cont.ac.match = iscsi_conn_match;
1331 transport_container_register(&priv->conn_cont);
1333 SETUP_CONN_RD_ATTR(max_recv_dlength, ISCSI_MAX_RECV_DLENGTH);
1334 SETUP_CONN_RD_ATTR(max_xmit_dlength, ISCSI_MAX_XMIT_DLENGTH);
1335 SETUP_CONN_RD_ATTR(header_digest, ISCSI_HDRDGST_EN);
1336 SETUP_CONN_RD_ATTR(data_digest, ISCSI_DATADGST_EN);
1337 SETUP_CONN_RD_ATTR(ifmarker, ISCSI_IFMARKER_EN);
1338 SETUP_CONN_RD_ATTR(ofmarker, ISCSI_OFMARKER_EN);
1339 SETUP_CONN_RD_ATTR(address, ISCSI_CONN_ADDRESS);
1340 SETUP_CONN_RD_ATTR(port, ISCSI_CONN_PORT);
1341 SETUP_CONN_RD_ATTR(exp_statsn, ISCSI_EXP_STATSN);
1342 SETUP_CONN_RD_ATTR(persistent_address, ISCSI_PERSISTENT_ADDRESS);
1343 SETUP_CONN_RD_ATTR(persistent_port, ISCSI_PERSISTENT_PORT);
1345 BUG_ON(count > ISCSI_CONN_ATTRS);
1346 priv->conn_attrs[count] = NULL;
1349 /* session parameters */
1350 priv->session_cont.ac.attrs = &priv->session_attrs[0];
1351 priv->session_cont.ac.class = &iscsi_session_class.class;
1352 priv->session_cont.ac.match = iscsi_session_match;
1353 transport_container_register(&priv->session_cont);
1355 SETUP_SESSION_RD_ATTR(initial_r2t, ISCSI_INITIAL_R2T_EN);
1356 SETUP_SESSION_RD_ATTR(max_outstanding_r2t, ISCSI_MAX_R2T);
1357 SETUP_SESSION_RD_ATTR(immediate_data, ISCSI_IMM_DATA_EN);
1358 SETUP_SESSION_RD_ATTR(first_burst_len, ISCSI_FIRST_BURST);
1359 SETUP_SESSION_RD_ATTR(max_burst_len, ISCSI_MAX_BURST);
1360 SETUP_SESSION_RD_ATTR(data_pdu_in_order, ISCSI_PDU_INORDER_EN);
1361 SETUP_SESSION_RD_ATTR(data_seq_in_order, ISCSI_DATASEQ_INORDER_EN);
1362 SETUP_SESSION_RD_ATTR(erl, ISCSI_ERL);
1363 SETUP_SESSION_RD_ATTR(targetname, ISCSI_TARGET_NAME);
1364 SETUP_SESSION_RD_ATTR(tpgt, ISCSI_TPGT);
1365 SETUP_PRIV_SESSION_RD_ATTR(recovery_tmo);
1367 BUG_ON(count > ISCSI_SESSION_ATTRS);
1368 priv->session_attrs[count] = NULL;
1370 spin_lock_irqsave(&iscsi_transport_lock, flags);
1371 list_add(&priv->list, &iscsi_transports);
1372 spin_unlock_irqrestore(&iscsi_transport_lock, flags);
1374 printk(KERN_NOTICE "iscsi: registered transport (%s)\n", tt->name);
1378 class_device_unregister(&priv->cdev);
1383 EXPORT_SYMBOL_GPL(iscsi_register_transport);
1385 int iscsi_unregister_transport(struct iscsi_transport *tt)
1387 struct iscsi_internal *priv;
1388 unsigned long flags;
1392 mutex_lock(&rx_queue_mutex);
1394 priv = iscsi_if_transport_lookup(tt);
1397 spin_lock_irqsave(&iscsi_transport_lock, flags);
1398 list_del(&priv->list);
1399 spin_unlock_irqrestore(&iscsi_transport_lock, flags);
1401 transport_container_unregister(&priv->conn_cont);
1402 transport_container_unregister(&priv->session_cont);
1403 transport_container_unregister(&priv->t.host_attrs);
1405 sysfs_remove_group(&priv->cdev.kobj, &iscsi_transport_group);
1406 class_device_unregister(&priv->cdev);
1407 mutex_unlock(&rx_queue_mutex);
1411 EXPORT_SYMBOL_GPL(iscsi_unregister_transport);
1413 static __init int iscsi_transport_init(void)
1417 printk(KERN_INFO "Loading iSCSI transport class v%s.",
1418 ISCSI_TRANSPORT_VERSION);
1420 err = class_register(&iscsi_transport_class);
1424 err = transport_class_register(&iscsi_host_class);
1426 goto unregister_transport_class;
1428 err = transport_class_register(&iscsi_connection_class);
1430 goto unregister_host_class;
1432 err = transport_class_register(&iscsi_session_class);
1434 goto unregister_conn_class;
1436 nls = netlink_kernel_create(NETLINK_ISCSI, 1, iscsi_if_rx,
1440 goto unregister_session_class;
1445 unregister_session_class:
1446 transport_class_unregister(&iscsi_session_class);
1447 unregister_conn_class:
1448 transport_class_unregister(&iscsi_connection_class);
1449 unregister_host_class:
1450 transport_class_unregister(&iscsi_host_class);
1451 unregister_transport_class:
1452 class_unregister(&iscsi_transport_class);
1456 static void __exit iscsi_transport_exit(void)
1458 sock_release(nls->sk_socket);
1459 transport_class_unregister(&iscsi_connection_class);
1460 transport_class_unregister(&iscsi_session_class);
1461 transport_class_unregister(&iscsi_host_class);
1462 class_unregister(&iscsi_transport_class);
1465 module_init(iscsi_transport_init);
1466 module_exit(iscsi_transport_exit);
1468 MODULE_AUTHOR("Mike Christie <michaelc@cs.wisc.edu>, "
1469 "Dmitry Yusupov <dmitry_yus@yahoo.com>, "
1470 "Alex Aizman <itn780@yahoo.com>");
1471 MODULE_DESCRIPTION("iSCSI Transport Interface");
1472 MODULE_LICENSE("GPL");
1473 MODULE_VERSION(ISCSI_TRANSPORT_VERSION);