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/mempool.h>
25 #include <linux/mutex.h>
27 #include <scsi/scsi.h>
28 #include <scsi/scsi_host.h>
29 #include <scsi/scsi_device.h>
30 #include <scsi/scsi_transport.h>
31 #include <scsi/scsi_transport_iscsi.h>
32 #include <scsi/iscsi_if.h>
34 #define ISCSI_SESSION_ATTRS 8
35 #define ISCSI_CONN_ATTRS 6
37 struct iscsi_internal {
38 struct scsi_transport_template t;
39 struct iscsi_transport *iscsi_transport;
40 struct list_head list;
42 * based on transport capabilities, at register time we set these
43 * bits to tell the transport class it wants attributes displayed
44 * in sysfs or that it can support different iSCSI Data-Path
49 struct class_device cdev;
51 * We do not have any private or other attrs.
53 struct transport_container conn_cont;
54 struct class_device_attribute *conn_attrs[ISCSI_CONN_ATTRS + 1];
55 struct transport_container session_cont;
56 struct class_device_attribute *session_attrs[ISCSI_SESSION_ATTRS + 1];
59 static int iscsi_session_nr; /* sysfs session id for next new session */
62 * list of registered transports and lock that must
63 * be held while accessing list. The iscsi_transport_lock must
64 * be acquired after the rx_queue_mutex.
66 static LIST_HEAD(iscsi_transports);
67 static DEFINE_SPINLOCK(iscsi_transport_lock);
69 #define to_iscsi_internal(tmpl) \
70 container_of(tmpl, struct iscsi_internal, t)
72 #define cdev_to_iscsi_internal(_cdev) \
73 container_of(_cdev, struct iscsi_internal, cdev)
75 static void iscsi_transport_release(struct class_device *cdev)
77 struct iscsi_internal *priv = cdev_to_iscsi_internal(cdev);
82 * iscsi_transport_class represents the iscsi_transports that are
85 static struct class iscsi_transport_class = {
86 .name = "iscsi_transport",
87 .release = iscsi_transport_release,
91 show_transport_handle(struct class_device *cdev, char *buf)
93 struct iscsi_internal *priv = cdev_to_iscsi_internal(cdev);
94 return sprintf(buf, "%llu\n", (unsigned long long)iscsi_handle(priv->iscsi_transport));
96 static CLASS_DEVICE_ATTR(handle, S_IRUGO, show_transport_handle, NULL);
98 #define show_transport_attr(name, format) \
100 show_transport_##name(struct class_device *cdev, char *buf) \
102 struct iscsi_internal *priv = cdev_to_iscsi_internal(cdev); \
103 return sprintf(buf, format"\n", priv->iscsi_transport->name); \
105 static CLASS_DEVICE_ATTR(name, S_IRUGO, show_transport_##name, NULL);
107 show_transport_attr(caps, "0x%x");
108 show_transport_attr(max_lun, "%d");
109 show_transport_attr(max_conn, "%d");
110 show_transport_attr(max_cmd_len, "%d");
112 static struct attribute *iscsi_transport_attrs[] = {
113 &class_device_attr_handle.attr,
114 &class_device_attr_caps.attr,
115 &class_device_attr_max_lun.attr,
116 &class_device_attr_max_conn.attr,
117 &class_device_attr_max_cmd_len.attr,
121 static struct attribute_group iscsi_transport_group = {
122 .attrs = iscsi_transport_attrs,
125 static DECLARE_TRANSPORT_CLASS(iscsi_session_class,
131 static DECLARE_TRANSPORT_CLASS(iscsi_connection_class,
137 static struct sock *nls;
138 static int daemon_pid;
139 static DEFINE_MUTEX(rx_queue_mutex);
141 struct mempool_zone {
146 struct list_head freequeue;
150 static struct mempool_zone *z_reply;
153 * Z_MAX_* - actual mempool size allocated at the mempool_zone_init() time
154 * Z_HIWAT_* - zone's high watermark when if_error bit will be set to -ENOMEM
155 * so daemon will notice OOM on NETLINK tranposrt level and will
156 * be able to predict or change operational behavior
158 #define Z_MAX_REPLY 8
159 #define Z_HIWAT_REPLY 6
161 #define Z_HIWAT_PDU 6
162 #define Z_MAX_ERROR 16
163 #define Z_HIWAT_ERROR 12
165 static LIST_HEAD(sesslist);
166 static DEFINE_SPINLOCK(sesslock);
167 static LIST_HEAD(connlist);
168 static DEFINE_SPINLOCK(connlock);
170 static uint32_t iscsi_conn_get_sid(struct iscsi_cls_conn *conn)
172 struct iscsi_cls_session *sess = iscsi_dev_to_session(conn->dev.parent);
177 * Returns the matching session to a given sid
179 static struct iscsi_cls_session *iscsi_session_lookup(uint32_t sid)
182 struct iscsi_cls_session *sess;
184 spin_lock_irqsave(&sesslock, flags);
185 list_for_each_entry(sess, &sesslist, sess_list) {
186 if (sess->sid == sid) {
187 spin_unlock_irqrestore(&sesslock, flags);
191 spin_unlock_irqrestore(&sesslock, flags);
196 * Returns the matching connection to a given sid / cid tuple
198 static struct iscsi_cls_conn *iscsi_conn_lookup(uint32_t sid, uint32_t cid)
201 struct iscsi_cls_conn *conn;
203 spin_lock_irqsave(&connlock, flags);
204 list_for_each_entry(conn, &connlist, conn_list) {
205 if ((conn->cid == cid) && (iscsi_conn_get_sid(conn) == sid)) {
206 spin_unlock_irqrestore(&connlock, flags);
210 spin_unlock_irqrestore(&connlock, flags);
215 * The following functions can be used by LLDs that allocate
216 * their own scsi_hosts or by software iscsi LLDs
218 static void iscsi_session_release(struct device *dev)
220 struct iscsi_cls_session *session = iscsi_dev_to_session(dev);
221 struct iscsi_transport *transport = session->transport;
222 struct Scsi_Host *shost;
224 shost = iscsi_session_to_shost(session);
225 scsi_host_put(shost);
227 module_put(transport->owner);
230 static int iscsi_is_session_dev(const struct device *dev)
232 return dev->release == iscsi_session_release;
236 * iscsi_create_session - create iscsi class session
238 * @transport: iscsi transport
240 * This can be called from a LLD or iscsi_transport.
242 struct iscsi_cls_session *
243 iscsi_create_session(struct Scsi_Host *shost, struct iscsi_transport *transport)
245 struct iscsi_cls_session *session;
248 if (!try_module_get(transport->owner))
251 session = kzalloc(sizeof(*session) + transport->sessiondata_size,
255 session->transport = transport;
257 if (transport->sessiondata_size)
258 session->dd_data = &session[1];
260 /* this is released in the dev's release function */
261 scsi_host_get(shost);
262 session->sid = iscsi_session_nr++;
263 snprintf(session->dev.bus_id, BUS_ID_SIZE, "session%u",
265 session->dev.parent = &shost->shost_gendev;
266 session->dev.release = iscsi_session_release;
267 err = device_register(&session->dev);
269 dev_printk(KERN_ERR, &session->dev, "iscsi: could not "
270 "register session's dev\n");
273 transport_register_device(&session->dev);
280 module_put(transport->owner);
284 EXPORT_SYMBOL_GPL(iscsi_create_session);
287 * iscsi_destroy_session - destroy iscsi session
288 * @session: iscsi_session
290 * Can be called by a LLD or iscsi_transport. There must not be
291 * any running connections.
293 int iscsi_destroy_session(struct iscsi_cls_session *session)
295 transport_unregister_device(&session->dev);
296 device_unregister(&session->dev);
300 EXPORT_SYMBOL_GPL(iscsi_destroy_session);
302 static void iscsi_conn_release(struct device *dev)
304 struct iscsi_cls_conn *conn = iscsi_dev_to_conn(dev);
305 struct device *parent = conn->dev.parent;
311 static int iscsi_is_conn_dev(const struct device *dev)
313 return dev->release == iscsi_conn_release;
317 * iscsi_create_conn - create iscsi class connection
318 * @session: iscsi cls session
319 * @cid: connection id
321 * This can be called from a LLD or iscsi_transport. The connection
322 * is child of the session so cid must be unique for all connections
325 * Since we do not support MCS, cid will normally be zero. In some cases
326 * for software iscsi we could be trying to preallocate a connection struct
327 * in which case there could be two connection structs and cid would be
330 struct iscsi_cls_conn *
331 iscsi_create_conn(struct iscsi_cls_session *session, uint32_t cid)
333 struct iscsi_transport *transport = session->transport;
334 struct iscsi_cls_conn *conn;
337 conn = kzalloc(sizeof(*conn) + transport->conndata_size, GFP_KERNEL);
341 if (transport->conndata_size)
342 conn->dd_data = &conn[1];
344 INIT_LIST_HEAD(&conn->conn_list);
345 conn->transport = transport;
348 /* this is released in the dev's release function */
349 if (!get_device(&session->dev))
352 snprintf(conn->dev.bus_id, BUS_ID_SIZE, "connection%d:%u",
354 conn->dev.parent = &session->dev;
355 conn->dev.release = iscsi_conn_release;
356 err = device_register(&conn->dev);
358 dev_printk(KERN_ERR, &conn->dev, "iscsi: could not register "
359 "connection's dev\n");
360 goto release_parent_ref;
362 transport_register_device(&conn->dev);
366 put_device(&session->dev);
372 EXPORT_SYMBOL_GPL(iscsi_create_conn);
375 * iscsi_destroy_conn - destroy iscsi class connection
376 * @session: iscsi cls session
378 * This can be called from a LLD or iscsi_transport.
380 int iscsi_destroy_conn(struct iscsi_cls_conn *conn)
382 transport_unregister_device(&conn->dev);
383 device_unregister(&conn->dev);
387 EXPORT_SYMBOL_GPL(iscsi_destroy_conn);
390 * These functions are used only by software iscsi_transports
391 * which do not allocate and more their scsi_hosts since this
392 * is initiated from userspace.
396 * iSCSI Session's hostdata organization:
398 * *------------------* <== hostdata_session(host->hostdata)
399 * | ptr to class sess|
400 * |------------------| <== iscsi_hostdata(host->hostdata)
401 * | transport's data |
402 * *------------------*
405 #define hostdata_privsize(_t) (sizeof(unsigned long) + _t->hostdata_size + \
406 _t->hostdata_size % sizeof(unsigned long))
408 #define hostdata_session(_hostdata) (iscsi_ptr(*(unsigned long *)_hostdata))
411 * iscsi_transport_create_session - create iscsi cls session and host
412 * scsit: scsi transport template
413 * transport: iscsi transport template
415 * This can be used by software iscsi_transports that allocate
416 * a session per scsi host.
419 iscsi_transport_create_session(struct scsi_transport_template *scsit,
420 struct iscsi_transport *transport)
422 struct iscsi_cls_session *session;
423 struct Scsi_Host *shost;
426 shost = scsi_host_alloc(transport->host_template,
427 hostdata_privsize(transport));
429 printk(KERN_ERR "iscsi: can not allocate SCSI host for "
435 shost->max_channel = 0;
436 shost->max_lun = transport->max_lun;
437 shost->max_cmd_len = transport->max_cmd_len;
438 shost->transportt = scsit;
439 shost->transportt->create_work_queue = 1;
441 if (scsi_add_host(shost, NULL))
444 session = iscsi_create_session(shost, transport);
448 *(unsigned long*)shost->hostdata = (unsigned long)session;
449 spin_lock_irqsave(&sesslock, flags);
450 list_add(&session->sess_list, &sesslist);
451 spin_unlock_irqrestore(&sesslock, flags);
455 scsi_remove_host(shost);
457 scsi_host_put(shost);
461 EXPORT_SYMBOL_GPL(iscsi_transport_create_session);
464 * iscsi_transport_destroy_session - destroy session and scsi host
467 * This can be used by software iscsi_transports that allocate
468 * a session per scsi host.
470 int iscsi_transport_destroy_session(struct Scsi_Host *shost)
472 struct iscsi_cls_session *session;
475 scsi_remove_host(shost);
476 session = hostdata_session(shost->hostdata);
477 spin_lock_irqsave(&sesslock, flags);
478 list_del(&session->sess_list);
479 spin_unlock_irqrestore(&sesslock, flags);
480 iscsi_destroy_session(session);
481 /* ref from host alloc */
482 scsi_host_put(shost);
486 EXPORT_SYMBOL_GPL(iscsi_transport_destroy_session);
489 * iscsi interface functions
491 static struct iscsi_internal *
492 iscsi_if_transport_lookup(struct iscsi_transport *tt)
494 struct iscsi_internal *priv;
497 spin_lock_irqsave(&iscsi_transport_lock, flags);
498 list_for_each_entry(priv, &iscsi_transports, list) {
499 if (tt == priv->iscsi_transport) {
500 spin_unlock_irqrestore(&iscsi_transport_lock, flags);
504 spin_unlock_irqrestore(&iscsi_transport_lock, flags);
508 static inline struct list_head *skb_to_lh(struct sk_buff *skb)
510 return (struct list_head *)&skb->cb;
514 mempool_zone_alloc_skb(gfp_t gfp_mask, void *pool_data)
516 struct mempool_zone *zone = pool_data;
518 return alloc_skb(zone->size, gfp_mask);
522 mempool_zone_free_skb(void *element, void *pool_data)
528 mempool_zone_complete(struct mempool_zone *zone)
531 struct list_head *lh, *n;
533 spin_lock_irqsave(&zone->freelock, flags);
534 list_for_each_safe(lh, n, &zone->freequeue) {
535 struct sk_buff *skb = (struct sk_buff *)((char *)lh -
536 offsetof(struct sk_buff, cb));
537 if (!skb_shared(skb)) {
538 list_del(skb_to_lh(skb));
539 mempool_free(skb, zone->pool);
540 atomic_dec(&zone->allocated);
543 spin_unlock_irqrestore(&zone->freelock, flags);
546 static struct mempool_zone *
547 mempool_zone_init(unsigned max, unsigned size, unsigned hiwat)
549 struct mempool_zone *zp;
551 zp = kzalloc(sizeof(*zp), GFP_KERNEL);
557 INIT_LIST_HEAD(&zp->freequeue);
558 spin_lock_init(&zp->freelock);
559 atomic_set(&zp->allocated, 0);
561 zp->pool = mempool_create(max, mempool_zone_alloc_skb,
562 mempool_zone_free_skb, zp);
571 static void mempool_zone_destroy(struct mempool_zone *zp)
573 mempool_destroy(zp->pool);
577 static struct sk_buff*
578 mempool_zone_get_skb(struct mempool_zone *zone)
582 skb = mempool_alloc(zone->pool, GFP_ATOMIC);
584 atomic_inc(&zone->allocated);
589 iscsi_unicast_skb(struct mempool_zone *zone, struct sk_buff *skb)
595 rc = netlink_unicast(nls, skb, daemon_pid, MSG_DONTWAIT);
597 mempool_free(skb, zone->pool);
598 printk(KERN_ERR "iscsi: can not unicast skb (%d)\n", rc);
602 spin_lock_irqsave(&zone->freelock, flags);
603 list_add(skb_to_lh(skb), &zone->freequeue);
604 spin_unlock_irqrestore(&zone->freelock, flags);
609 int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
610 char *data, uint32_t data_size)
612 struct nlmsghdr *nlh;
614 struct iscsi_uevent *ev;
616 int len = NLMSG_SPACE(sizeof(*ev) + sizeof(struct iscsi_hdr) +
619 mempool_zone_complete(conn->z_pdu);
621 skb = mempool_zone_get_skb(conn->z_pdu);
623 iscsi_conn_error(conn, ISCSI_ERR_CONN_FAILED);
624 dev_printk(KERN_ERR, &conn->dev, "iscsi: can not deliver "
625 "control PDU: OOM\n");
629 nlh = __nlmsg_put(skb, daemon_pid, 0, 0, (len - sizeof(*nlh)), 0);
630 ev = NLMSG_DATA(nlh);
631 memset(ev, 0, sizeof(*ev));
632 ev->transport_handle = iscsi_handle(conn->transport);
633 ev->type = ISCSI_KEVENT_RECV_PDU;
634 if (atomic_read(&conn->z_pdu->allocated) >= conn->z_pdu->hiwat)
635 ev->iferror = -ENOMEM;
636 ev->r.recv_req.cid = conn->cid;
637 ev->r.recv_req.sid = iscsi_conn_get_sid(conn);
638 pdu = (char*)ev + sizeof(*ev);
639 memcpy(pdu, hdr, sizeof(struct iscsi_hdr));
640 memcpy(pdu + sizeof(struct iscsi_hdr), data, data_size);
642 return iscsi_unicast_skb(conn->z_pdu, skb);
644 EXPORT_SYMBOL_GPL(iscsi_recv_pdu);
646 void iscsi_conn_error(struct iscsi_cls_conn *conn, enum iscsi_err error)
648 struct nlmsghdr *nlh;
650 struct iscsi_uevent *ev;
651 int len = NLMSG_SPACE(sizeof(*ev));
653 mempool_zone_complete(conn->z_error);
655 skb = mempool_zone_get_skb(conn->z_error);
657 dev_printk(KERN_ERR, &conn->dev, "iscsi: gracefully ignored "
658 "conn error (%d)\n", error);
662 nlh = __nlmsg_put(skb, daemon_pid, 0, 0, (len - sizeof(*nlh)), 0);
663 ev = NLMSG_DATA(nlh);
664 ev->transport_handle = iscsi_handle(conn->transport);
665 ev->type = ISCSI_KEVENT_CONN_ERROR;
666 if (atomic_read(&conn->z_error->allocated) >= conn->z_error->hiwat)
667 ev->iferror = -ENOMEM;
668 ev->r.connerror.error = error;
669 ev->r.connerror.cid = conn->cid;
670 ev->r.connerror.sid = iscsi_conn_get_sid(conn);
672 iscsi_unicast_skb(conn->z_error, skb);
674 dev_printk(KERN_INFO, &conn->dev, "iscsi: detected conn error (%d)\n",
677 EXPORT_SYMBOL_GPL(iscsi_conn_error);
680 iscsi_if_send_reply(int pid, int seq, int type, int done, int multi,
681 void *payload, int size)
684 struct nlmsghdr *nlh;
685 int len = NLMSG_SPACE(size);
686 int flags = multi ? NLM_F_MULTI : 0;
687 int t = done ? NLMSG_DONE : type;
689 mempool_zone_complete(z_reply);
691 skb = mempool_zone_get_skb(z_reply);
694 * user is supposed to react on iferror == -ENOMEM;
699 nlh = __nlmsg_put(skb, pid, seq, t, (len - sizeof(*nlh)), 0);
700 nlh->nlmsg_flags = flags;
701 memcpy(NLMSG_DATA(nlh), payload, size);
702 return iscsi_unicast_skb(z_reply, skb);
706 iscsi_if_get_stats(struct iscsi_transport *transport, struct nlmsghdr *nlh)
708 struct iscsi_uevent *ev = NLMSG_DATA(nlh);
709 struct iscsi_stats *stats;
710 struct sk_buff *skbstat;
711 struct iscsi_cls_conn *conn;
712 struct nlmsghdr *nlhstat;
713 struct iscsi_uevent *evstat;
714 int len = NLMSG_SPACE(sizeof(*ev) +
715 sizeof(struct iscsi_stats) +
716 sizeof(struct iscsi_stats_custom) *
717 ISCSI_STATS_CUSTOM_MAX);
720 conn = iscsi_conn_lookup(ev->u.get_stats.sid, ev->u.get_stats.cid);
727 mempool_zone_complete(conn->z_pdu);
729 skbstat = mempool_zone_get_skb(conn->z_pdu);
731 dev_printk(KERN_ERR, &conn->dev, "iscsi: can not "
732 "deliver stats: OOM\n");
736 nlhstat = __nlmsg_put(skbstat, daemon_pid, 0, 0,
737 (len - sizeof(*nlhstat)), 0);
738 evstat = NLMSG_DATA(nlhstat);
739 memset(evstat, 0, sizeof(*evstat));
740 evstat->transport_handle = iscsi_handle(conn->transport);
741 evstat->type = nlh->nlmsg_type;
742 if (atomic_read(&conn->z_pdu->allocated) >= conn->z_pdu->hiwat)
743 evstat->iferror = -ENOMEM;
744 evstat->u.get_stats.cid =
746 evstat->u.get_stats.sid =
748 stats = (struct iscsi_stats *)
749 ((char*)evstat + sizeof(*evstat));
750 memset(stats, 0, sizeof(*stats));
752 transport->get_stats(conn, stats);
753 actual_size = NLMSG_SPACE(sizeof(struct iscsi_uevent) +
754 sizeof(struct iscsi_stats) +
755 sizeof(struct iscsi_stats_custom) *
756 stats->custom_length);
757 actual_size -= sizeof(*nlhstat);
758 actual_size = NLMSG_LENGTH(actual_size);
759 skb_trim(skbstat, NLMSG_ALIGN(actual_size));
760 nlhstat->nlmsg_len = actual_size;
762 err = iscsi_unicast_skb(conn->z_pdu, skbstat);
763 } while (err < 0 && err != -ECONNREFUSED);
769 iscsi_if_create_session(struct iscsi_internal *priv, struct iscsi_uevent *ev)
771 struct iscsi_transport *transport = priv->iscsi_transport;
772 struct iscsi_cls_session *session;
775 session = transport->create_session(&priv->t,
776 ev->u.c_session.initial_cmdsn,
781 ev->r.c_session_ret.host_no = hostno;
782 ev->r.c_session_ret.sid = session->sid;
787 iscsi_if_create_conn(struct iscsi_transport *transport, struct iscsi_uevent *ev)
789 struct iscsi_cls_conn *conn;
790 struct iscsi_cls_session *session;
793 session = iscsi_session_lookup(ev->u.c_conn.sid);
795 printk(KERN_ERR "iscsi: invalid session %d\n",
800 conn = transport->create_conn(session, ev->u.c_conn.cid);
802 printk(KERN_ERR "iscsi: couldn't create a new "
803 "connection for session %d\n",
808 conn->z_pdu = mempool_zone_init(Z_MAX_PDU,
809 NLMSG_SPACE(sizeof(struct iscsi_uevent) +
810 sizeof(struct iscsi_hdr) +
811 DEFAULT_MAX_RECV_DATA_SEGMENT_LENGTH),
814 dev_printk(KERN_ERR, &conn->dev, "iscsi: can not allocate "
815 "pdu zone for new conn\n");
819 conn->z_error = mempool_zone_init(Z_MAX_ERROR,
820 NLMSG_SPACE(sizeof(struct iscsi_uevent)),
822 if (!conn->z_error) {
823 dev_printk(KERN_ERR, &conn->dev, "iscsi: can not allocate "
824 "error zone for new conn\n");
828 ev->r.c_conn_ret.sid = session->sid;
829 ev->r.c_conn_ret.cid = conn->cid;
831 spin_lock_irqsave(&connlock, flags);
832 list_add(&conn->conn_list, &connlist);
834 spin_unlock_irqrestore(&connlock, flags);
839 mempool_zone_destroy(conn->z_pdu);
841 if (transport->destroy_conn)
842 transport->destroy_conn(conn->dd_data);
847 iscsi_if_destroy_conn(struct iscsi_transport *transport, struct iscsi_uevent *ev)
850 struct iscsi_cls_conn *conn;
851 struct mempool_zone *z_error, *z_pdu;
853 conn = iscsi_conn_lookup(ev->u.d_conn.sid, ev->u.d_conn.cid);
856 spin_lock_irqsave(&connlock, flags);
858 list_del(&conn->conn_list);
859 spin_unlock_irqrestore(&connlock, flags);
862 z_error = conn->z_error;
864 if (transport->destroy_conn)
865 transport->destroy_conn(conn);
867 mempool_zone_destroy(z_pdu);
868 mempool_zone_destroy(z_error);
874 iscsi_if_recv_msg(struct sk_buff *skb, struct nlmsghdr *nlh)
877 struct iscsi_uevent *ev = NLMSG_DATA(nlh);
878 struct iscsi_transport *transport = NULL;
879 struct iscsi_internal *priv;
880 struct iscsi_cls_session *session;
881 struct iscsi_cls_conn *conn;
883 priv = iscsi_if_transport_lookup(iscsi_ptr(ev->transport_handle));
886 transport = priv->iscsi_transport;
888 if (!try_module_get(transport->owner))
891 switch (nlh->nlmsg_type) {
892 case ISCSI_UEVENT_CREATE_SESSION:
893 err = iscsi_if_create_session(priv, ev);
895 case ISCSI_UEVENT_DESTROY_SESSION:
896 session = iscsi_session_lookup(ev->u.d_session.sid);
898 transport->destroy_session(session);
902 case ISCSI_UEVENT_CREATE_CONN:
903 err = iscsi_if_create_conn(transport, ev);
905 case ISCSI_UEVENT_DESTROY_CONN:
906 err = iscsi_if_destroy_conn(transport, ev);
908 case ISCSI_UEVENT_BIND_CONN:
909 session = iscsi_session_lookup(ev->u.b_conn.sid);
910 conn = iscsi_conn_lookup(ev->u.b_conn.sid, ev->u.b_conn.cid);
913 ev->r.retcode = transport->bind_conn(session, conn,
914 ev->u.b_conn.transport_fd,
915 ev->u.b_conn.is_leading);
919 case ISCSI_UEVENT_SET_PARAM:
920 conn = iscsi_conn_lookup(ev->u.set_param.sid, ev->u.set_param.cid);
922 ev->r.retcode = transport->set_param(conn,
923 ev->u.set_param.param, ev->u.set_param.value);
927 case ISCSI_UEVENT_START_CONN:
928 conn = iscsi_conn_lookup(ev->u.start_conn.sid, ev->u.start_conn.cid);
930 ev->r.retcode = transport->start_conn(conn);
935 case ISCSI_UEVENT_STOP_CONN:
936 conn = iscsi_conn_lookup(ev->u.stop_conn.sid, ev->u.stop_conn.cid);
938 transport->stop_conn(conn, ev->u.stop_conn.flag);
942 case ISCSI_UEVENT_SEND_PDU:
943 conn = iscsi_conn_lookup(ev->u.send_pdu.sid, ev->u.send_pdu.cid);
945 ev->r.retcode = transport->send_pdu(conn,
946 (struct iscsi_hdr*)((char*)ev + sizeof(*ev)),
947 (char*)ev + sizeof(*ev) + ev->u.send_pdu.hdr_size,
948 ev->u.send_pdu.data_size);
952 case ISCSI_UEVENT_GET_STATS:
953 err = iscsi_if_get_stats(transport, nlh);
960 module_put(transport->owner);
965 * Get message from skb (based on rtnetlink_rcv_skb). Each message is
966 * processed by iscsi_if_recv_msg. Malformed skbs with wrong lengths or
967 * invalid creds are discarded silently.
970 iscsi_if_rx(struct sock *sk, int len)
974 mutex_lock(&rx_queue_mutex);
975 while ((skb = skb_dequeue(&sk->sk_receive_queue)) != NULL) {
976 if (NETLINK_CREDS(skb)->uid) {
977 skb_pull(skb, skb->len);
980 daemon_pid = NETLINK_CREDS(skb)->pid;
982 while (skb->len >= NLMSG_SPACE(0)) {
985 struct nlmsghdr *nlh;
986 struct iscsi_uevent *ev;
988 nlh = (struct nlmsghdr *)skb->data;
989 if (nlh->nlmsg_len < sizeof(*nlh) ||
990 skb->len < nlh->nlmsg_len) {
994 ev = NLMSG_DATA(nlh);
995 rlen = NLMSG_ALIGN(nlh->nlmsg_len);
999 err = iscsi_if_recv_msg(skb, nlh);
1001 ev->type = ISCSI_KEVENT_IF_ERROR;
1006 * special case for GET_STATS:
1007 * on success - sending reply and stats from
1008 * inside of if_recv_msg(),
1009 * on error - fall through.
1011 if (ev->type == ISCSI_UEVENT_GET_STATS && !err)
1013 err = iscsi_if_send_reply(
1014 NETLINK_CREDS(skb)->pid, nlh->nlmsg_seq,
1015 nlh->nlmsg_type, 0, 0, ev, sizeof(*ev));
1016 if (atomic_read(&z_reply->allocated) >=
1018 ev->iferror = -ENOMEM;
1019 } while (err < 0 && err != -ECONNREFUSED);
1020 skb_pull(skb, rlen);
1025 mutex_unlock(&rx_queue_mutex);
1028 #define iscsi_cdev_to_conn(_cdev) \
1029 iscsi_dev_to_conn(_cdev->dev)
1032 * iSCSI connection attrs
1034 #define iscsi_conn_int_attr_show(param, format) \
1036 show_conn_int_param_##param(struct class_device *cdev, char *buf) \
1038 uint32_t value = 0; \
1039 struct iscsi_cls_conn *conn = iscsi_cdev_to_conn(cdev); \
1040 struct iscsi_transport *t = conn->transport; \
1042 t->get_conn_param(conn, param, &value); \
1043 return snprintf(buf, 20, format"\n", value); \
1046 #define iscsi_conn_int_attr(field, param, format) \
1047 iscsi_conn_int_attr_show(param, format) \
1048 static CLASS_DEVICE_ATTR(field, S_IRUGO, show_conn_int_param_##param, NULL);
1050 iscsi_conn_int_attr(max_recv_dlength, ISCSI_PARAM_MAX_RECV_DLENGTH, "%u");
1051 iscsi_conn_int_attr(max_xmit_dlength, ISCSI_PARAM_MAX_XMIT_DLENGTH, "%u");
1052 iscsi_conn_int_attr(header_digest, ISCSI_PARAM_HDRDGST_EN, "%d");
1053 iscsi_conn_int_attr(data_digest, ISCSI_PARAM_DATADGST_EN, "%d");
1054 iscsi_conn_int_attr(ifmarker, ISCSI_PARAM_IFMARKER_EN, "%d");
1055 iscsi_conn_int_attr(ofmarker, ISCSI_PARAM_OFMARKER_EN, "%d");
1057 #define iscsi_cdev_to_session(_cdev) \
1058 iscsi_dev_to_session(_cdev->dev)
1061 * iSCSI session attrs
1063 #define iscsi_session_int_attr_show(param, format) \
1065 show_session_int_param_##param(struct class_device *cdev, char *buf) \
1067 uint32_t value = 0; \
1068 struct iscsi_cls_session *session = iscsi_cdev_to_session(cdev); \
1069 struct iscsi_transport *t = session->transport; \
1071 t->get_session_param(session, param, &value); \
1072 return snprintf(buf, 20, format"\n", value); \
1075 #define iscsi_session_int_attr(field, param, format) \
1076 iscsi_session_int_attr_show(param, format) \
1077 static CLASS_DEVICE_ATTR(field, S_IRUGO, show_session_int_param_##param, NULL);
1079 iscsi_session_int_attr(initial_r2t, ISCSI_PARAM_INITIAL_R2T_EN, "%d");
1080 iscsi_session_int_attr(max_outstanding_r2t, ISCSI_PARAM_MAX_R2T, "%hu");
1081 iscsi_session_int_attr(immediate_data, ISCSI_PARAM_IMM_DATA_EN, "%d");
1082 iscsi_session_int_attr(first_burst_len, ISCSI_PARAM_FIRST_BURST, "%u");
1083 iscsi_session_int_attr(max_burst_len, ISCSI_PARAM_MAX_BURST, "%u");
1084 iscsi_session_int_attr(data_pdu_in_order, ISCSI_PARAM_PDU_INORDER_EN, "%d");
1085 iscsi_session_int_attr(data_seq_in_order, ISCSI_PARAM_DATASEQ_INORDER_EN, "%d");
1086 iscsi_session_int_attr(erl, ISCSI_PARAM_ERL, "%d");
1088 #define SETUP_SESSION_RD_ATTR(field, param) \
1089 if (priv->param_mask & (1 << param)) { \
1090 priv->session_attrs[count] = &class_device_attr_##field;\
1094 #define SETUP_CONN_RD_ATTR(field, param) \
1095 if (priv->param_mask & (1 << param)) { \
1096 priv->conn_attrs[count] = &class_device_attr_##field; \
1100 static int iscsi_session_match(struct attribute_container *cont,
1103 struct iscsi_cls_session *session;
1104 struct Scsi_Host *shost;
1105 struct iscsi_internal *priv;
1107 if (!iscsi_is_session_dev(dev))
1110 session = iscsi_dev_to_session(dev);
1111 shost = iscsi_session_to_shost(session);
1112 if (!shost->transportt)
1115 priv = to_iscsi_internal(shost->transportt);
1116 if (priv->session_cont.ac.class != &iscsi_session_class.class)
1119 return &priv->session_cont.ac == cont;
1122 static int iscsi_conn_match(struct attribute_container *cont,
1125 struct iscsi_cls_session *session;
1126 struct iscsi_cls_conn *conn;
1127 struct Scsi_Host *shost;
1128 struct iscsi_internal *priv;
1130 if (!iscsi_is_conn_dev(dev))
1133 conn = iscsi_dev_to_conn(dev);
1134 session = iscsi_dev_to_session(conn->dev.parent);
1135 shost = iscsi_session_to_shost(session);
1137 if (!shost->transportt)
1140 priv = to_iscsi_internal(shost->transportt);
1141 if (priv->conn_cont.ac.class != &iscsi_connection_class.class)
1144 return &priv->conn_cont.ac == cont;
1147 struct scsi_transport_template *
1148 iscsi_register_transport(struct iscsi_transport *tt)
1150 struct iscsi_internal *priv;
1151 unsigned long flags;
1156 priv = iscsi_if_transport_lookup(tt);
1160 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
1163 INIT_LIST_HEAD(&priv->list);
1164 priv->iscsi_transport = tt;
1166 priv->cdev.class = &iscsi_transport_class;
1167 snprintf(priv->cdev.class_id, BUS_ID_SIZE, "%s", tt->name);
1168 err = class_device_register(&priv->cdev);
1172 err = sysfs_create_group(&priv->cdev.kobj, &iscsi_transport_group);
1174 goto unregister_cdev;
1176 /* setup parameters mask */
1177 priv->param_mask = 0xFFFFFFFF;
1178 if (!(tt->caps & CAP_MULTI_R2T))
1179 priv->param_mask &= ~(1 << ISCSI_PARAM_MAX_R2T);
1180 if (!(tt->caps & CAP_HDRDGST))
1181 priv->param_mask &= ~(1 << ISCSI_PARAM_HDRDGST_EN);
1182 if (!(tt->caps & CAP_DATADGST))
1183 priv->param_mask &= ~(1 << ISCSI_PARAM_DATADGST_EN);
1184 if (!(tt->caps & CAP_MARKERS)) {
1185 priv->param_mask &= ~(1 << ISCSI_PARAM_IFMARKER_EN);
1186 priv->param_mask &= ~(1 << ISCSI_PARAM_OFMARKER_EN);
1189 /* connection parameters */
1190 priv->conn_cont.ac.attrs = &priv->conn_attrs[0];
1191 priv->conn_cont.ac.class = &iscsi_connection_class.class;
1192 priv->conn_cont.ac.match = iscsi_conn_match;
1193 transport_container_register(&priv->conn_cont);
1195 SETUP_CONN_RD_ATTR(max_recv_dlength, ISCSI_PARAM_MAX_RECV_DLENGTH);
1196 SETUP_CONN_RD_ATTR(max_xmit_dlength, ISCSI_PARAM_MAX_XMIT_DLENGTH);
1197 SETUP_CONN_RD_ATTR(header_digest, ISCSI_PARAM_HDRDGST_EN);
1198 SETUP_CONN_RD_ATTR(data_digest, ISCSI_PARAM_DATADGST_EN);
1199 SETUP_CONN_RD_ATTR(ifmarker, ISCSI_PARAM_IFMARKER_EN);
1200 SETUP_CONN_RD_ATTR(ofmarker, ISCSI_PARAM_OFMARKER_EN);
1202 BUG_ON(count > ISCSI_CONN_ATTRS);
1203 priv->conn_attrs[count] = NULL;
1206 /* session parameters */
1207 priv->session_cont.ac.attrs = &priv->session_attrs[0];
1208 priv->session_cont.ac.class = &iscsi_session_class.class;
1209 priv->session_cont.ac.match = iscsi_session_match;
1210 transport_container_register(&priv->session_cont);
1212 SETUP_SESSION_RD_ATTR(initial_r2t, ISCSI_PARAM_INITIAL_R2T_EN);
1213 SETUP_SESSION_RD_ATTR(max_outstanding_r2t, ISCSI_PARAM_MAX_R2T);
1214 SETUP_SESSION_RD_ATTR(immediate_data, ISCSI_PARAM_IMM_DATA_EN);
1215 SETUP_SESSION_RD_ATTR(first_burst_len, ISCSI_PARAM_FIRST_BURST);
1216 SETUP_SESSION_RD_ATTR(max_burst_len, ISCSI_PARAM_MAX_BURST);
1217 SETUP_SESSION_RD_ATTR(data_pdu_in_order, ISCSI_PARAM_PDU_INORDER_EN);
1218 SETUP_SESSION_RD_ATTR(data_seq_in_order,ISCSI_PARAM_DATASEQ_INORDER_EN)
1219 SETUP_SESSION_RD_ATTR(erl, ISCSI_PARAM_ERL);
1221 BUG_ON(count > ISCSI_SESSION_ATTRS);
1222 priv->session_attrs[count] = NULL;
1224 spin_lock_irqsave(&iscsi_transport_lock, flags);
1225 list_add(&priv->list, &iscsi_transports);
1226 spin_unlock_irqrestore(&iscsi_transport_lock, flags);
1228 printk(KERN_NOTICE "iscsi: registered transport (%s)\n", tt->name);
1232 class_device_unregister(&priv->cdev);
1237 EXPORT_SYMBOL_GPL(iscsi_register_transport);
1239 int iscsi_unregister_transport(struct iscsi_transport *tt)
1241 struct iscsi_internal *priv;
1242 unsigned long flags;
1246 mutex_lock(&rx_queue_mutex);
1248 priv = iscsi_if_transport_lookup(tt);
1251 spin_lock_irqsave(&iscsi_transport_lock, flags);
1252 list_del(&priv->list);
1253 spin_unlock_irqrestore(&iscsi_transport_lock, flags);
1255 transport_container_unregister(&priv->conn_cont);
1256 transport_container_unregister(&priv->session_cont);
1258 sysfs_remove_group(&priv->cdev.kobj, &iscsi_transport_group);
1259 class_device_unregister(&priv->cdev);
1260 mutex_unlock(&rx_queue_mutex);
1264 EXPORT_SYMBOL_GPL(iscsi_unregister_transport);
1267 iscsi_rcv_nl_event(struct notifier_block *this, unsigned long event, void *ptr)
1269 struct netlink_notify *n = ptr;
1271 if (event == NETLINK_URELEASE &&
1272 n->protocol == NETLINK_ISCSI && n->pid) {
1273 struct iscsi_cls_conn *conn;
1274 unsigned long flags;
1276 mempool_zone_complete(z_reply);
1277 spin_lock_irqsave(&connlock, flags);
1278 list_for_each_entry(conn, &connlist, conn_list) {
1279 mempool_zone_complete(conn->z_error);
1280 mempool_zone_complete(conn->z_pdu);
1282 spin_unlock_irqrestore(&connlock, flags);
1288 static struct notifier_block iscsi_nl_notifier = {
1289 .notifier_call = iscsi_rcv_nl_event,
1292 static __init int iscsi_transport_init(void)
1296 err = class_register(&iscsi_transport_class);
1300 err = transport_class_register(&iscsi_connection_class);
1302 goto unregister_transport_class;
1304 err = transport_class_register(&iscsi_session_class);
1306 goto unregister_conn_class;
1308 err = netlink_register_notifier(&iscsi_nl_notifier);
1310 goto unregister_session_class;
1312 nls = netlink_kernel_create(NETLINK_ISCSI, 1, iscsi_if_rx,
1316 goto unregister_notifier;
1319 z_reply = mempool_zone_init(Z_MAX_REPLY,
1320 NLMSG_SPACE(sizeof(struct iscsi_uevent)), Z_HIWAT_REPLY);
1324 sock_release(nls->sk_socket);
1325 unregister_notifier:
1326 netlink_unregister_notifier(&iscsi_nl_notifier);
1327 unregister_session_class:
1328 transport_class_unregister(&iscsi_session_class);
1329 unregister_conn_class:
1330 transport_class_unregister(&iscsi_connection_class);
1331 unregister_transport_class:
1332 class_unregister(&iscsi_transport_class);
1336 static void __exit iscsi_transport_exit(void)
1338 mempool_zone_destroy(z_reply);
1339 sock_release(nls->sk_socket);
1340 netlink_unregister_notifier(&iscsi_nl_notifier);
1341 transport_class_unregister(&iscsi_connection_class);
1342 transport_class_unregister(&iscsi_session_class);
1343 class_unregister(&iscsi_transport_class);
1346 module_init(iscsi_transport_init);
1347 module_exit(iscsi_transport_exit);
1349 MODULE_AUTHOR("Mike Christie <michaelc@cs.wisc.edu>, "
1350 "Dmitry Yusupov <dmitry_yus@yahoo.com>, "
1351 "Alex Aizman <itn780@yahoo.com>");
1352 MODULE_DESCRIPTION("iSCSI Transport Interface");
1353 MODULE_LICENSE("GPL");