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-724"
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(struct work_struct *work)
239 struct iscsi_cls_session *session =
240 container_of(work, struct iscsi_cls_session,
243 dev_printk(KERN_INFO, &session->dev, "iscsi: session recovery timed "
244 "out after %d secs\n", session->recovery_tmo);
246 if (session->transport->session_recovery_timedout)
247 session->transport->session_recovery_timedout(session);
249 scsi_target_unblock(&session->dev);
252 void iscsi_unblock_session(struct iscsi_cls_session *session)
254 if (!cancel_delayed_work(&session->recovery_work))
255 flush_scheduled_work();
256 scsi_target_unblock(&session->dev);
258 EXPORT_SYMBOL_GPL(iscsi_unblock_session);
260 void iscsi_block_session(struct iscsi_cls_session *session)
262 scsi_target_block(&session->dev);
263 schedule_delayed_work(&session->recovery_work,
264 session->recovery_tmo * HZ);
266 EXPORT_SYMBOL_GPL(iscsi_block_session);
268 struct iscsi_cls_session *
269 iscsi_alloc_session(struct Scsi_Host *shost,
270 struct iscsi_transport *transport)
272 struct iscsi_cls_session *session;
274 session = kzalloc(sizeof(*session) + transport->sessiondata_size,
279 session->transport = transport;
280 session->recovery_tmo = 120;
281 INIT_DELAYED_WORK(&session->recovery_work, session_recovery_timedout);
282 INIT_LIST_HEAD(&session->host_list);
283 INIT_LIST_HEAD(&session->sess_list);
285 /* this is released in the dev's release function */
286 scsi_host_get(shost);
287 session->dev.parent = &shost->shost_gendev;
288 session->dev.release = iscsi_session_release;
289 device_initialize(&session->dev);
290 if (transport->sessiondata_size)
291 session->dd_data = &session[1];
294 EXPORT_SYMBOL_GPL(iscsi_alloc_session);
296 int iscsi_add_session(struct iscsi_cls_session *session, unsigned int target_id)
298 struct Scsi_Host *shost = iscsi_session_to_shost(session);
299 struct iscsi_host *ihost;
302 ihost = shost->shost_data;
303 session->sid = iscsi_session_nr++;
304 session->target_id = target_id;
306 snprintf(session->dev.bus_id, BUS_ID_SIZE, "session%u",
308 err = device_add(&session->dev);
310 dev_printk(KERN_ERR, &session->dev, "iscsi: could not "
311 "register session's dev\n");
314 transport_register_device(&session->dev);
316 mutex_lock(&ihost->mutex);
317 list_add(&session->host_list, &ihost->sessions);
318 mutex_unlock(&ihost->mutex);
322 scsi_host_put(shost);
325 EXPORT_SYMBOL_GPL(iscsi_add_session);
328 * iscsi_create_session - create iscsi class session
330 * @transport: iscsi transport
332 * This can be called from a LLD or iscsi_transport.
334 struct iscsi_cls_session *
335 iscsi_create_session(struct Scsi_Host *shost,
336 struct iscsi_transport *transport,
337 unsigned int target_id)
339 struct iscsi_cls_session *session;
341 session = iscsi_alloc_session(shost, transport);
345 if (iscsi_add_session(session, target_id)) {
346 iscsi_free_session(session);
351 EXPORT_SYMBOL_GPL(iscsi_create_session);
353 void iscsi_remove_session(struct iscsi_cls_session *session)
355 struct Scsi_Host *shost = iscsi_session_to_shost(session);
356 struct iscsi_host *ihost = shost->shost_data;
358 if (!cancel_delayed_work(&session->recovery_work))
359 flush_scheduled_work();
361 mutex_lock(&ihost->mutex);
362 list_del(&session->host_list);
363 mutex_unlock(&ihost->mutex);
365 scsi_remove_target(&session->dev);
367 transport_unregister_device(&session->dev);
368 device_del(&session->dev);
370 EXPORT_SYMBOL_GPL(iscsi_remove_session);
372 void iscsi_free_session(struct iscsi_cls_session *session)
374 put_device(&session->dev);
377 EXPORT_SYMBOL_GPL(iscsi_free_session);
380 * iscsi_destroy_session - destroy iscsi session
381 * @session: iscsi_session
383 * Can be called by a LLD or iscsi_transport. There must not be
384 * any running connections.
386 int iscsi_destroy_session(struct iscsi_cls_session *session)
388 iscsi_remove_session(session);
389 iscsi_free_session(session);
392 EXPORT_SYMBOL_GPL(iscsi_destroy_session);
394 static void iscsi_conn_release(struct device *dev)
396 struct iscsi_cls_conn *conn = iscsi_dev_to_conn(dev);
397 struct device *parent = conn->dev.parent;
403 static int iscsi_is_conn_dev(const struct device *dev)
405 return dev->release == iscsi_conn_release;
409 * iscsi_create_conn - create iscsi class connection
410 * @session: iscsi cls session
411 * @cid: connection id
413 * This can be called from a LLD or iscsi_transport. The connection
414 * is child of the session so cid must be unique for all connections
417 * Since we do not support MCS, cid will normally be zero. In some cases
418 * for software iscsi we could be trying to preallocate a connection struct
419 * in which case there could be two connection structs and cid would be
422 struct iscsi_cls_conn *
423 iscsi_create_conn(struct iscsi_cls_session *session, uint32_t cid)
425 struct iscsi_transport *transport = session->transport;
426 struct iscsi_cls_conn *conn;
429 conn = kzalloc(sizeof(*conn) + transport->conndata_size, GFP_KERNEL);
433 if (transport->conndata_size)
434 conn->dd_data = &conn[1];
436 INIT_LIST_HEAD(&conn->conn_list);
437 conn->transport = transport;
440 /* this is released in the dev's release function */
441 if (!get_device(&session->dev))
444 snprintf(conn->dev.bus_id, BUS_ID_SIZE, "connection%d:%u",
446 conn->dev.parent = &session->dev;
447 conn->dev.release = iscsi_conn_release;
448 err = device_register(&conn->dev);
450 dev_printk(KERN_ERR, &conn->dev, "iscsi: could not register "
451 "connection's dev\n");
452 goto release_parent_ref;
454 transport_register_device(&conn->dev);
458 put_device(&session->dev);
464 EXPORT_SYMBOL_GPL(iscsi_create_conn);
467 * iscsi_destroy_conn - destroy iscsi class connection
468 * @session: iscsi cls session
470 * This can be called from a LLD or iscsi_transport.
472 int iscsi_destroy_conn(struct iscsi_cls_conn *conn)
474 transport_unregister_device(&conn->dev);
475 device_unregister(&conn->dev);
479 EXPORT_SYMBOL_GPL(iscsi_destroy_conn);
482 * iscsi interface functions
484 static struct iscsi_internal *
485 iscsi_if_transport_lookup(struct iscsi_transport *tt)
487 struct iscsi_internal *priv;
490 spin_lock_irqsave(&iscsi_transport_lock, flags);
491 list_for_each_entry(priv, &iscsi_transports, list) {
492 if (tt == priv->iscsi_transport) {
493 spin_unlock_irqrestore(&iscsi_transport_lock, flags);
497 spin_unlock_irqrestore(&iscsi_transport_lock, flags);
502 iscsi_broadcast_skb(struct sk_buff *skb, gfp_t gfp)
506 rc = netlink_broadcast(nls, skb, 0, 1, gfp);
508 printk(KERN_ERR "iscsi: can not broadcast skb (%d)\n", rc);
516 iscsi_unicast_skb(struct sk_buff *skb, int pid)
520 rc = netlink_unicast(nls, skb, pid, MSG_DONTWAIT);
522 printk(KERN_ERR "iscsi: can not unicast skb (%d)\n", rc);
529 int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
530 char *data, uint32_t data_size)
532 struct nlmsghdr *nlh;
534 struct iscsi_uevent *ev;
536 struct iscsi_internal *priv;
537 int len = NLMSG_SPACE(sizeof(*ev) + sizeof(struct iscsi_hdr) +
540 priv = iscsi_if_transport_lookup(conn->transport);
544 skb = alloc_skb(len, GFP_ATOMIC);
546 iscsi_conn_error(conn, ISCSI_ERR_CONN_FAILED);
547 dev_printk(KERN_ERR, &conn->dev, "iscsi: can not deliver "
548 "control PDU: OOM\n");
552 nlh = __nlmsg_put(skb, priv->daemon_pid, 0, 0, (len - sizeof(*nlh)), 0);
553 ev = NLMSG_DATA(nlh);
554 memset(ev, 0, sizeof(*ev));
555 ev->transport_handle = iscsi_handle(conn->transport);
556 ev->type = ISCSI_KEVENT_RECV_PDU;
557 ev->r.recv_req.cid = conn->cid;
558 ev->r.recv_req.sid = iscsi_conn_get_sid(conn);
559 pdu = (char*)ev + sizeof(*ev);
560 memcpy(pdu, hdr, sizeof(struct iscsi_hdr));
561 memcpy(pdu + sizeof(struct iscsi_hdr), data, data_size);
563 return iscsi_unicast_skb(skb, priv->daemon_pid);
565 EXPORT_SYMBOL_GPL(iscsi_recv_pdu);
567 void iscsi_conn_error(struct iscsi_cls_conn *conn, enum iscsi_err error)
569 struct nlmsghdr *nlh;
571 struct iscsi_uevent *ev;
572 struct iscsi_internal *priv;
573 int len = NLMSG_SPACE(sizeof(*ev));
575 priv = iscsi_if_transport_lookup(conn->transport);
579 skb = alloc_skb(len, GFP_ATOMIC);
581 dev_printk(KERN_ERR, &conn->dev, "iscsi: gracefully ignored "
582 "conn error (%d)\n", error);
586 nlh = __nlmsg_put(skb, priv->daemon_pid, 0, 0, (len - sizeof(*nlh)), 0);
587 ev = NLMSG_DATA(nlh);
588 ev->transport_handle = iscsi_handle(conn->transport);
589 ev->type = ISCSI_KEVENT_CONN_ERROR;
590 ev->r.connerror.error = error;
591 ev->r.connerror.cid = conn->cid;
592 ev->r.connerror.sid = iscsi_conn_get_sid(conn);
594 iscsi_broadcast_skb(skb, GFP_ATOMIC);
596 dev_printk(KERN_INFO, &conn->dev, "iscsi: detected conn error (%d)\n",
599 EXPORT_SYMBOL_GPL(iscsi_conn_error);
602 iscsi_if_send_reply(int pid, int seq, int type, int done, int multi,
603 void *payload, int size)
606 struct nlmsghdr *nlh;
607 int len = NLMSG_SPACE(size);
608 int flags = multi ? NLM_F_MULTI : 0;
609 int t = done ? NLMSG_DONE : type;
611 skb = alloc_skb(len, GFP_ATOMIC);
614 * user is supposed to react on iferror == -ENOMEM;
619 nlh = __nlmsg_put(skb, pid, seq, t, (len - sizeof(*nlh)), 0);
620 nlh->nlmsg_flags = flags;
621 memcpy(NLMSG_DATA(nlh), payload, size);
622 return iscsi_unicast_skb(skb, pid);
626 iscsi_if_get_stats(struct iscsi_transport *transport, struct nlmsghdr *nlh)
628 struct iscsi_uevent *ev = NLMSG_DATA(nlh);
629 struct iscsi_stats *stats;
630 struct sk_buff *skbstat;
631 struct iscsi_cls_conn *conn;
632 struct nlmsghdr *nlhstat;
633 struct iscsi_uevent *evstat;
634 struct iscsi_internal *priv;
635 int len = NLMSG_SPACE(sizeof(*ev) +
636 sizeof(struct iscsi_stats) +
637 sizeof(struct iscsi_stats_custom) *
638 ISCSI_STATS_CUSTOM_MAX);
641 priv = iscsi_if_transport_lookup(transport);
645 conn = iscsi_conn_lookup(ev->u.get_stats.sid, ev->u.get_stats.cid);
652 skbstat = alloc_skb(len, GFP_ATOMIC);
654 dev_printk(KERN_ERR, &conn->dev, "iscsi: can not "
655 "deliver stats: OOM\n");
659 nlhstat = __nlmsg_put(skbstat, priv->daemon_pid, 0, 0,
660 (len - sizeof(*nlhstat)), 0);
661 evstat = NLMSG_DATA(nlhstat);
662 memset(evstat, 0, sizeof(*evstat));
663 evstat->transport_handle = iscsi_handle(conn->transport);
664 evstat->type = nlh->nlmsg_type;
665 evstat->u.get_stats.cid =
667 evstat->u.get_stats.sid =
669 stats = (struct iscsi_stats *)
670 ((char*)evstat + sizeof(*evstat));
671 memset(stats, 0, sizeof(*stats));
673 transport->get_stats(conn, stats);
674 actual_size = NLMSG_SPACE(sizeof(struct iscsi_uevent) +
675 sizeof(struct iscsi_stats) +
676 sizeof(struct iscsi_stats_custom) *
677 stats->custom_length);
678 actual_size -= sizeof(*nlhstat);
679 actual_size = NLMSG_LENGTH(actual_size);
680 skb_trim(skbstat, NLMSG_ALIGN(actual_size));
681 nlhstat->nlmsg_len = actual_size;
683 err = iscsi_unicast_skb(skbstat, priv->daemon_pid);
684 } while (err < 0 && err != -ECONNREFUSED);
690 * iscsi_if_destroy_session_done - send session destr. completion event
691 * @conn: last connection for session
693 * This is called by HW iscsi LLDs to notify userpsace that its HW has
696 int iscsi_if_destroy_session_done(struct iscsi_cls_conn *conn)
698 struct iscsi_internal *priv;
699 struct iscsi_cls_session *session;
700 struct Scsi_Host *shost;
701 struct iscsi_uevent *ev;
703 struct nlmsghdr *nlh;
705 int rc, len = NLMSG_SPACE(sizeof(*ev));
707 priv = iscsi_if_transport_lookup(conn->transport);
711 session = iscsi_dev_to_session(conn->dev.parent);
712 shost = iscsi_session_to_shost(session);
714 skb = alloc_skb(len, GFP_KERNEL);
716 dev_printk(KERN_ERR, &conn->dev, "Cannot notify userspace of "
717 "session creation event\n");
721 nlh = __nlmsg_put(skb, priv->daemon_pid, 0, 0, (len - sizeof(*nlh)), 0);
722 ev = NLMSG_DATA(nlh);
723 ev->transport_handle = iscsi_handle(conn->transport);
724 ev->type = ISCSI_KEVENT_DESTROY_SESSION;
725 ev->r.d_session.host_no = shost->host_no;
726 ev->r.d_session.sid = session->sid;
729 * this will occur if the daemon is not up, so we just warn
730 * the user and when the daemon is restarted it will handle it
732 rc = iscsi_broadcast_skb(skb, GFP_KERNEL);
734 dev_printk(KERN_ERR, &conn->dev, "Cannot notify userspace of "
735 "session destruction event. Check iscsi daemon\n");
737 spin_lock_irqsave(&sesslock, flags);
738 list_del(&session->sess_list);
739 spin_unlock_irqrestore(&sesslock, flags);
741 spin_lock_irqsave(&connlock, flags);
743 list_del(&conn->conn_list);
744 spin_unlock_irqrestore(&connlock, flags);
748 EXPORT_SYMBOL_GPL(iscsi_if_destroy_session_done);
751 * iscsi_if_create_session_done - send session creation completion event
752 * @conn: leading connection for session
754 * This is called by HW iscsi LLDs to notify userpsace that its HW has
755 * created a session or a existing session is back in the logged in state.
757 int iscsi_if_create_session_done(struct iscsi_cls_conn *conn)
759 struct iscsi_internal *priv;
760 struct iscsi_cls_session *session;
761 struct Scsi_Host *shost;
762 struct iscsi_uevent *ev;
764 struct nlmsghdr *nlh;
766 int rc, len = NLMSG_SPACE(sizeof(*ev));
768 priv = iscsi_if_transport_lookup(conn->transport);
772 session = iscsi_dev_to_session(conn->dev.parent);
773 shost = iscsi_session_to_shost(session);
775 skb = alloc_skb(len, GFP_KERNEL);
777 dev_printk(KERN_ERR, &conn->dev, "Cannot notify userspace of "
778 "session creation event\n");
782 nlh = __nlmsg_put(skb, priv->daemon_pid, 0, 0, (len - sizeof(*nlh)), 0);
783 ev = NLMSG_DATA(nlh);
784 ev->transport_handle = iscsi_handle(conn->transport);
785 ev->type = ISCSI_UEVENT_CREATE_SESSION;
786 ev->r.c_session_ret.host_no = shost->host_no;
787 ev->r.c_session_ret.sid = session->sid;
790 * this will occur if the daemon is not up, so we just warn
791 * the user and when the daemon is restarted it will handle it
793 rc = iscsi_broadcast_skb(skb, GFP_KERNEL);
795 dev_printk(KERN_ERR, &conn->dev, "Cannot notify userspace of "
796 "session creation event. Check iscsi daemon\n");
798 spin_lock_irqsave(&sesslock, flags);
799 list_add(&session->sess_list, &sesslist);
800 spin_unlock_irqrestore(&sesslock, flags);
802 spin_lock_irqsave(&connlock, flags);
803 list_add(&conn->conn_list, &connlist);
805 spin_unlock_irqrestore(&connlock, flags);
808 EXPORT_SYMBOL_GPL(iscsi_if_create_session_done);
811 iscsi_if_create_session(struct iscsi_internal *priv, struct iscsi_uevent *ev)
813 struct iscsi_transport *transport = priv->iscsi_transport;
814 struct iscsi_cls_session *session;
818 session = transport->create_session(transport, &priv->t,
819 ev->u.c_session.initial_cmdsn,
824 spin_lock_irqsave(&sesslock, flags);
825 list_add(&session->sess_list, &sesslist);
826 spin_unlock_irqrestore(&sesslock, flags);
828 ev->r.c_session_ret.host_no = hostno;
829 ev->r.c_session_ret.sid = session->sid;
834 iscsi_if_create_conn(struct iscsi_transport *transport, struct iscsi_uevent *ev)
836 struct iscsi_cls_conn *conn;
837 struct iscsi_cls_session *session;
840 session = iscsi_session_lookup(ev->u.c_conn.sid);
842 printk(KERN_ERR "iscsi: invalid session %d\n",
847 conn = transport->create_conn(session, ev->u.c_conn.cid);
849 printk(KERN_ERR "iscsi: couldn't create a new "
850 "connection for session %d\n",
855 ev->r.c_conn_ret.sid = session->sid;
856 ev->r.c_conn_ret.cid = conn->cid;
858 spin_lock_irqsave(&connlock, flags);
859 list_add(&conn->conn_list, &connlist);
861 spin_unlock_irqrestore(&connlock, flags);
867 iscsi_if_destroy_conn(struct iscsi_transport *transport, struct iscsi_uevent *ev)
870 struct iscsi_cls_conn *conn;
872 conn = iscsi_conn_lookup(ev->u.d_conn.sid, ev->u.d_conn.cid);
875 spin_lock_irqsave(&connlock, flags);
877 list_del(&conn->conn_list);
878 spin_unlock_irqrestore(&connlock, flags);
880 if (transport->destroy_conn)
881 transport->destroy_conn(conn);
886 iscsi_set_param(struct iscsi_transport *transport, struct iscsi_uevent *ev)
888 char *data = (char*)ev + sizeof(*ev);
889 struct iscsi_cls_conn *conn;
890 struct iscsi_cls_session *session;
891 int err = 0, value = 0;
893 session = iscsi_session_lookup(ev->u.set_param.sid);
894 conn = iscsi_conn_lookup(ev->u.set_param.sid, ev->u.set_param.cid);
895 if (!conn || !session)
898 switch (ev->u.set_param.param) {
899 case ISCSI_PARAM_SESS_RECOVERY_TMO:
900 sscanf(data, "%d", &value);
902 session->recovery_tmo = value;
905 err = transport->set_param(conn, ev->u.set_param.param,
906 data, ev->u.set_param.len);
913 iscsi_if_transport_ep(struct iscsi_transport *transport,
914 struct iscsi_uevent *ev, int msg_type)
916 struct sockaddr *dst_addr;
920 case ISCSI_UEVENT_TRANSPORT_EP_CONNECT:
921 if (!transport->ep_connect)
924 dst_addr = (struct sockaddr *)((char*)ev + sizeof(*ev));
925 rc = transport->ep_connect(dst_addr,
926 ev->u.ep_connect.non_blocking,
927 &ev->r.ep_connect_ret.handle);
929 case ISCSI_UEVENT_TRANSPORT_EP_POLL:
930 if (!transport->ep_poll)
933 ev->r.retcode = transport->ep_poll(ev->u.ep_poll.ep_handle,
934 ev->u.ep_poll.timeout_ms);
936 case ISCSI_UEVENT_TRANSPORT_EP_DISCONNECT:
937 if (!transport->ep_disconnect)
940 transport->ep_disconnect(ev->u.ep_disconnect.ep_handle);
947 iscsi_tgt_dscvr(struct iscsi_transport *transport,
948 struct iscsi_uevent *ev)
950 struct sockaddr *dst_addr;
952 if (!transport->tgt_dscvr)
955 dst_addr = (struct sockaddr *)((char*)ev + sizeof(*ev));
956 return transport->tgt_dscvr(ev->u.tgt_dscvr.type,
957 ev->u.tgt_dscvr.host_no,
958 ev->u.tgt_dscvr.enable, dst_addr);
962 iscsi_if_recv_msg(struct sk_buff *skb, struct nlmsghdr *nlh)
965 struct iscsi_uevent *ev = NLMSG_DATA(nlh);
966 struct iscsi_transport *transport = NULL;
967 struct iscsi_internal *priv;
968 struct iscsi_cls_session *session;
969 struct iscsi_cls_conn *conn;
972 priv = iscsi_if_transport_lookup(iscsi_ptr(ev->transport_handle));
975 transport = priv->iscsi_transport;
977 if (!try_module_get(transport->owner))
980 priv->daemon_pid = NETLINK_CREDS(skb)->pid;
982 switch (nlh->nlmsg_type) {
983 case ISCSI_UEVENT_CREATE_SESSION:
984 err = iscsi_if_create_session(priv, ev);
986 case ISCSI_UEVENT_DESTROY_SESSION:
987 session = iscsi_session_lookup(ev->u.d_session.sid);
989 spin_lock_irqsave(&sesslock, flags);
990 list_del(&session->sess_list);
991 spin_unlock_irqrestore(&sesslock, flags);
993 transport->destroy_session(session);
997 case ISCSI_UEVENT_CREATE_CONN:
998 err = iscsi_if_create_conn(transport, ev);
1000 case ISCSI_UEVENT_DESTROY_CONN:
1001 err = iscsi_if_destroy_conn(transport, ev);
1003 case ISCSI_UEVENT_BIND_CONN:
1004 session = iscsi_session_lookup(ev->u.b_conn.sid);
1005 conn = iscsi_conn_lookup(ev->u.b_conn.sid, ev->u.b_conn.cid);
1007 if (session && conn)
1008 ev->r.retcode = transport->bind_conn(session, conn,
1009 ev->u.b_conn.transport_eph,
1010 ev->u.b_conn.is_leading);
1014 case ISCSI_UEVENT_SET_PARAM:
1015 err = iscsi_set_param(transport, ev);
1017 case ISCSI_UEVENT_START_CONN:
1018 conn = iscsi_conn_lookup(ev->u.start_conn.sid, ev->u.start_conn.cid);
1020 ev->r.retcode = transport->start_conn(conn);
1024 case ISCSI_UEVENT_STOP_CONN:
1025 conn = iscsi_conn_lookup(ev->u.stop_conn.sid, ev->u.stop_conn.cid);
1027 transport->stop_conn(conn, ev->u.stop_conn.flag);
1031 case ISCSI_UEVENT_SEND_PDU:
1032 conn = iscsi_conn_lookup(ev->u.send_pdu.sid, ev->u.send_pdu.cid);
1034 ev->r.retcode = transport->send_pdu(conn,
1035 (struct iscsi_hdr*)((char*)ev + sizeof(*ev)),
1036 (char*)ev + sizeof(*ev) + ev->u.send_pdu.hdr_size,
1037 ev->u.send_pdu.data_size);
1041 case ISCSI_UEVENT_GET_STATS:
1042 err = iscsi_if_get_stats(transport, nlh);
1044 case ISCSI_UEVENT_TRANSPORT_EP_CONNECT:
1045 case ISCSI_UEVENT_TRANSPORT_EP_POLL:
1046 case ISCSI_UEVENT_TRANSPORT_EP_DISCONNECT:
1047 err = iscsi_if_transport_ep(transport, ev, nlh->nlmsg_type);
1049 case ISCSI_UEVENT_TGT_DSCVR:
1050 err = iscsi_tgt_dscvr(transport, ev);
1057 module_put(transport->owner);
1062 * Get message from skb (based on rtnetlink_rcv_skb). Each message is
1063 * processed by iscsi_if_recv_msg. Malformed skbs with wrong lengths or
1064 * invalid creds are discarded silently.
1067 iscsi_if_rx(struct sock *sk, int len)
1069 struct sk_buff *skb;
1071 mutex_lock(&rx_queue_mutex);
1072 while ((skb = skb_dequeue(&sk->sk_receive_queue)) != NULL) {
1073 if (NETLINK_CREDS(skb)->uid) {
1074 skb_pull(skb, skb->len);
1078 while (skb->len >= NLMSG_SPACE(0)) {
1081 struct nlmsghdr *nlh;
1082 struct iscsi_uevent *ev;
1084 nlh = (struct nlmsghdr *)skb->data;
1085 if (nlh->nlmsg_len < sizeof(*nlh) ||
1086 skb->len < nlh->nlmsg_len) {
1090 ev = NLMSG_DATA(nlh);
1091 rlen = NLMSG_ALIGN(nlh->nlmsg_len);
1092 if (rlen > skb->len)
1095 err = iscsi_if_recv_msg(skb, nlh);
1097 ev->type = ISCSI_KEVENT_IF_ERROR;
1102 * special case for GET_STATS:
1103 * on success - sending reply and stats from
1104 * inside of if_recv_msg(),
1105 * on error - fall through.
1107 if (ev->type == ISCSI_UEVENT_GET_STATS && !err)
1109 err = iscsi_if_send_reply(
1110 NETLINK_CREDS(skb)->pid, nlh->nlmsg_seq,
1111 nlh->nlmsg_type, 0, 0, ev, sizeof(*ev));
1112 } while (err < 0 && err != -ECONNREFUSED);
1113 skb_pull(skb, rlen);
1118 mutex_unlock(&rx_queue_mutex);
1121 #define iscsi_cdev_to_conn(_cdev) \
1122 iscsi_dev_to_conn(_cdev->dev)
1124 #define ISCSI_CLASS_ATTR(_prefix,_name,_mode,_show,_store) \
1125 struct class_device_attribute class_device_attr_##_prefix##_##_name = \
1126 __ATTR(_name,_mode,_show,_store)
1129 * iSCSI connection attrs
1131 #define iscsi_conn_attr_show(param) \
1133 show_conn_param_##param(struct class_device *cdev, char *buf) \
1135 struct iscsi_cls_conn *conn = iscsi_cdev_to_conn(cdev); \
1136 struct iscsi_transport *t = conn->transport; \
1137 return t->get_conn_param(conn, param, buf); \
1140 #define iscsi_conn_attr(field, param) \
1141 iscsi_conn_attr_show(param) \
1142 static ISCSI_CLASS_ATTR(conn, field, S_IRUGO, show_conn_param_##param, \
1145 iscsi_conn_attr(max_recv_dlength, ISCSI_PARAM_MAX_RECV_DLENGTH);
1146 iscsi_conn_attr(max_xmit_dlength, ISCSI_PARAM_MAX_XMIT_DLENGTH);
1147 iscsi_conn_attr(header_digest, ISCSI_PARAM_HDRDGST_EN);
1148 iscsi_conn_attr(data_digest, ISCSI_PARAM_DATADGST_EN);
1149 iscsi_conn_attr(ifmarker, ISCSI_PARAM_IFMARKER_EN);
1150 iscsi_conn_attr(ofmarker, ISCSI_PARAM_OFMARKER_EN);
1151 iscsi_conn_attr(persistent_port, ISCSI_PARAM_PERSISTENT_PORT);
1152 iscsi_conn_attr(port, ISCSI_PARAM_CONN_PORT);
1153 iscsi_conn_attr(exp_statsn, ISCSI_PARAM_EXP_STATSN);
1154 iscsi_conn_attr(persistent_address, ISCSI_PARAM_PERSISTENT_ADDRESS);
1155 iscsi_conn_attr(address, ISCSI_PARAM_CONN_ADDRESS);
1157 #define iscsi_cdev_to_session(_cdev) \
1158 iscsi_dev_to_session(_cdev->dev)
1161 * iSCSI session attrs
1163 #define iscsi_session_attr_show(param) \
1165 show_session_param_##param(struct class_device *cdev, char *buf) \
1167 struct iscsi_cls_session *session = iscsi_cdev_to_session(cdev); \
1168 struct iscsi_transport *t = session->transport; \
1169 return t->get_session_param(session, param, buf); \
1172 #define iscsi_session_attr(field, param) \
1173 iscsi_session_attr_show(param) \
1174 static ISCSI_CLASS_ATTR(sess, field, S_IRUGO, show_session_param_##param, \
1177 iscsi_session_attr(targetname, ISCSI_PARAM_TARGET_NAME);
1178 iscsi_session_attr(initial_r2t, ISCSI_PARAM_INITIAL_R2T_EN);
1179 iscsi_session_attr(max_outstanding_r2t, ISCSI_PARAM_MAX_R2T);
1180 iscsi_session_attr(immediate_data, ISCSI_PARAM_IMM_DATA_EN);
1181 iscsi_session_attr(first_burst_len, ISCSI_PARAM_FIRST_BURST);
1182 iscsi_session_attr(max_burst_len, ISCSI_PARAM_MAX_BURST);
1183 iscsi_session_attr(data_pdu_in_order, ISCSI_PARAM_PDU_INORDER_EN);
1184 iscsi_session_attr(data_seq_in_order, ISCSI_PARAM_DATASEQ_INORDER_EN);
1185 iscsi_session_attr(erl, ISCSI_PARAM_ERL);
1186 iscsi_session_attr(tpgt, ISCSI_PARAM_TPGT);
1188 #define iscsi_priv_session_attr_show(field, format) \
1190 show_priv_session_##field(struct class_device *cdev, char *buf) \
1192 struct iscsi_cls_session *session = iscsi_cdev_to_session(cdev);\
1193 return sprintf(buf, format"\n", session->field); \
1196 #define iscsi_priv_session_attr(field, format) \
1197 iscsi_priv_session_attr_show(field, format) \
1198 static ISCSI_CLASS_ATTR(priv_sess, field, S_IRUGO, show_priv_session_##field, \
1200 iscsi_priv_session_attr(recovery_tmo, "%d");
1202 #define SETUP_PRIV_SESSION_RD_ATTR(field) \
1204 priv->session_attrs[count] = &class_device_attr_priv_sess_##field; \
1209 #define SETUP_SESSION_RD_ATTR(field, param_flag) \
1211 if (tt->param_mask & param_flag) { \
1212 priv->session_attrs[count] = &class_device_attr_sess_##field; \
1217 #define SETUP_CONN_RD_ATTR(field, param_flag) \
1219 if (tt->param_mask & param_flag) { \
1220 priv->conn_attrs[count] = &class_device_attr_conn_##field; \
1225 static int iscsi_session_match(struct attribute_container *cont,
1228 struct iscsi_cls_session *session;
1229 struct Scsi_Host *shost;
1230 struct iscsi_internal *priv;
1232 if (!iscsi_is_session_dev(dev))
1235 session = iscsi_dev_to_session(dev);
1236 shost = iscsi_session_to_shost(session);
1237 if (!shost->transportt)
1240 priv = to_iscsi_internal(shost->transportt);
1241 if (priv->session_cont.ac.class != &iscsi_session_class.class)
1244 return &priv->session_cont.ac == cont;
1247 static int iscsi_conn_match(struct attribute_container *cont,
1250 struct iscsi_cls_session *session;
1251 struct iscsi_cls_conn *conn;
1252 struct Scsi_Host *shost;
1253 struct iscsi_internal *priv;
1255 if (!iscsi_is_conn_dev(dev))
1258 conn = iscsi_dev_to_conn(dev);
1259 session = iscsi_dev_to_session(conn->dev.parent);
1260 shost = iscsi_session_to_shost(session);
1262 if (!shost->transportt)
1265 priv = to_iscsi_internal(shost->transportt);
1266 if (priv->conn_cont.ac.class != &iscsi_connection_class.class)
1269 return &priv->conn_cont.ac == cont;
1272 static int iscsi_host_match(struct attribute_container *cont,
1275 struct Scsi_Host *shost;
1276 struct iscsi_internal *priv;
1278 if (!scsi_is_host_device(dev))
1281 shost = dev_to_shost(dev);
1282 if (!shost->transportt ||
1283 shost->transportt->host_attrs.ac.class != &iscsi_host_class.class)
1286 priv = to_iscsi_internal(shost->transportt);
1287 return &priv->t.host_attrs.ac == cont;
1290 struct scsi_transport_template *
1291 iscsi_register_transport(struct iscsi_transport *tt)
1293 struct iscsi_internal *priv;
1294 unsigned long flags;
1299 priv = iscsi_if_transport_lookup(tt);
1303 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
1306 INIT_LIST_HEAD(&priv->list);
1307 priv->daemon_pid = -1;
1308 priv->iscsi_transport = tt;
1309 priv->t.user_scan = iscsi_user_scan;
1311 priv->cdev.class = &iscsi_transport_class;
1312 snprintf(priv->cdev.class_id, BUS_ID_SIZE, "%s", tt->name);
1313 err = class_device_register(&priv->cdev);
1317 err = sysfs_create_group(&priv->cdev.kobj, &iscsi_transport_group);
1319 goto unregister_cdev;
1321 /* host parameters */
1322 priv->t.host_attrs.ac.attrs = &priv->host_attrs[0];
1323 priv->t.host_attrs.ac.class = &iscsi_host_class.class;
1324 priv->t.host_attrs.ac.match = iscsi_host_match;
1325 priv->t.host_size = sizeof(struct iscsi_host);
1326 priv->host_attrs[0] = NULL;
1327 transport_container_register(&priv->t.host_attrs);
1329 /* connection parameters */
1330 priv->conn_cont.ac.attrs = &priv->conn_attrs[0];
1331 priv->conn_cont.ac.class = &iscsi_connection_class.class;
1332 priv->conn_cont.ac.match = iscsi_conn_match;
1333 transport_container_register(&priv->conn_cont);
1335 SETUP_CONN_RD_ATTR(max_recv_dlength, ISCSI_MAX_RECV_DLENGTH);
1336 SETUP_CONN_RD_ATTR(max_xmit_dlength, ISCSI_MAX_XMIT_DLENGTH);
1337 SETUP_CONN_RD_ATTR(header_digest, ISCSI_HDRDGST_EN);
1338 SETUP_CONN_RD_ATTR(data_digest, ISCSI_DATADGST_EN);
1339 SETUP_CONN_RD_ATTR(ifmarker, ISCSI_IFMARKER_EN);
1340 SETUP_CONN_RD_ATTR(ofmarker, ISCSI_OFMARKER_EN);
1341 SETUP_CONN_RD_ATTR(address, ISCSI_CONN_ADDRESS);
1342 SETUP_CONN_RD_ATTR(port, ISCSI_CONN_PORT);
1343 SETUP_CONN_RD_ATTR(exp_statsn, ISCSI_EXP_STATSN);
1344 SETUP_CONN_RD_ATTR(persistent_address, ISCSI_PERSISTENT_ADDRESS);
1345 SETUP_CONN_RD_ATTR(persistent_port, ISCSI_PERSISTENT_PORT);
1347 BUG_ON(count > ISCSI_CONN_ATTRS);
1348 priv->conn_attrs[count] = NULL;
1351 /* session parameters */
1352 priv->session_cont.ac.attrs = &priv->session_attrs[0];
1353 priv->session_cont.ac.class = &iscsi_session_class.class;
1354 priv->session_cont.ac.match = iscsi_session_match;
1355 transport_container_register(&priv->session_cont);
1357 SETUP_SESSION_RD_ATTR(initial_r2t, ISCSI_INITIAL_R2T_EN);
1358 SETUP_SESSION_RD_ATTR(max_outstanding_r2t, ISCSI_MAX_R2T);
1359 SETUP_SESSION_RD_ATTR(immediate_data, ISCSI_IMM_DATA_EN);
1360 SETUP_SESSION_RD_ATTR(first_burst_len, ISCSI_FIRST_BURST);
1361 SETUP_SESSION_RD_ATTR(max_burst_len, ISCSI_MAX_BURST);
1362 SETUP_SESSION_RD_ATTR(data_pdu_in_order, ISCSI_PDU_INORDER_EN);
1363 SETUP_SESSION_RD_ATTR(data_seq_in_order, ISCSI_DATASEQ_INORDER_EN);
1364 SETUP_SESSION_RD_ATTR(erl, ISCSI_ERL);
1365 SETUP_SESSION_RD_ATTR(targetname, ISCSI_TARGET_NAME);
1366 SETUP_SESSION_RD_ATTR(tpgt, ISCSI_TPGT);
1367 SETUP_PRIV_SESSION_RD_ATTR(recovery_tmo);
1369 BUG_ON(count > ISCSI_SESSION_ATTRS);
1370 priv->session_attrs[count] = NULL;
1372 spin_lock_irqsave(&iscsi_transport_lock, flags);
1373 list_add(&priv->list, &iscsi_transports);
1374 spin_unlock_irqrestore(&iscsi_transport_lock, flags);
1376 printk(KERN_NOTICE "iscsi: registered transport (%s)\n", tt->name);
1380 class_device_unregister(&priv->cdev);
1385 EXPORT_SYMBOL_GPL(iscsi_register_transport);
1387 int iscsi_unregister_transport(struct iscsi_transport *tt)
1389 struct iscsi_internal *priv;
1390 unsigned long flags;
1394 mutex_lock(&rx_queue_mutex);
1396 priv = iscsi_if_transport_lookup(tt);
1399 spin_lock_irqsave(&iscsi_transport_lock, flags);
1400 list_del(&priv->list);
1401 spin_unlock_irqrestore(&iscsi_transport_lock, flags);
1403 transport_container_unregister(&priv->conn_cont);
1404 transport_container_unregister(&priv->session_cont);
1405 transport_container_unregister(&priv->t.host_attrs);
1407 sysfs_remove_group(&priv->cdev.kobj, &iscsi_transport_group);
1408 class_device_unregister(&priv->cdev);
1409 mutex_unlock(&rx_queue_mutex);
1413 EXPORT_SYMBOL_GPL(iscsi_unregister_transport);
1415 static __init int iscsi_transport_init(void)
1419 printk(KERN_INFO "Loading iSCSI transport class v%s.\n",
1420 ISCSI_TRANSPORT_VERSION);
1422 err = class_register(&iscsi_transport_class);
1426 err = transport_class_register(&iscsi_host_class);
1428 goto unregister_transport_class;
1430 err = transport_class_register(&iscsi_connection_class);
1432 goto unregister_host_class;
1434 err = transport_class_register(&iscsi_session_class);
1436 goto unregister_conn_class;
1438 nls = netlink_kernel_create(NETLINK_ISCSI, 1, iscsi_if_rx,
1442 goto unregister_session_class;
1447 unregister_session_class:
1448 transport_class_unregister(&iscsi_session_class);
1449 unregister_conn_class:
1450 transport_class_unregister(&iscsi_connection_class);
1451 unregister_host_class:
1452 transport_class_unregister(&iscsi_host_class);
1453 unregister_transport_class:
1454 class_unregister(&iscsi_transport_class);
1458 static void __exit iscsi_transport_exit(void)
1460 sock_release(nls->sk_socket);
1461 transport_class_unregister(&iscsi_connection_class);
1462 transport_class_unregister(&iscsi_session_class);
1463 transport_class_unregister(&iscsi_host_class);
1464 class_unregister(&iscsi_transport_class);
1467 module_init(iscsi_transport_init);
1468 module_exit(iscsi_transport_exit);
1470 MODULE_AUTHOR("Mike Christie <michaelc@cs.wisc.edu>, "
1471 "Dmitry Yusupov <dmitry_yus@yahoo.com>, "
1472 "Alex Aizman <itn780@yahoo.com>");
1473 MODULE_DESCRIPTION("iSCSI Transport Interface");
1474 MODULE_LICENSE("GPL");
1475 MODULE_VERSION(ISCSI_TRANSPORT_VERSION);