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 11
35 #define ISCSI_CONN_ATTRS 11
36 #define ISCSI_HOST_ATTRS 0
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 struct mempool_zone {
156 struct list_head freequeue;
160 static struct mempool_zone *z_reply;
163 * Z_MAX_* - actual mempool size allocated at the mempool_zone_init() time
164 * Z_HIWAT_* - zone's high watermark when if_error bit will be set to -ENOMEM
165 * so daemon will notice OOM on NETLINK tranposrt level and will
166 * be able to predict or change operational behavior
168 #define Z_MAX_REPLY 8
169 #define Z_HIWAT_REPLY 6
171 #define Z_HIWAT_PDU 6
172 #define Z_MAX_ERROR 16
173 #define Z_HIWAT_ERROR 12
175 static LIST_HEAD(sesslist);
176 static DEFINE_SPINLOCK(sesslock);
177 static LIST_HEAD(connlist);
178 static DEFINE_SPINLOCK(connlock);
180 static uint32_t iscsi_conn_get_sid(struct iscsi_cls_conn *conn)
182 struct iscsi_cls_session *sess = iscsi_dev_to_session(conn->dev.parent);
187 * Returns the matching session to a given sid
189 static struct iscsi_cls_session *iscsi_session_lookup(uint32_t sid)
192 struct iscsi_cls_session *sess;
194 spin_lock_irqsave(&sesslock, flags);
195 list_for_each_entry(sess, &sesslist, sess_list) {
196 if (sess->sid == sid) {
197 spin_unlock_irqrestore(&sesslock, flags);
201 spin_unlock_irqrestore(&sesslock, flags);
206 * Returns the matching connection to a given sid / cid tuple
208 static struct iscsi_cls_conn *iscsi_conn_lookup(uint32_t sid, uint32_t cid)
211 struct iscsi_cls_conn *conn;
213 spin_lock_irqsave(&connlock, flags);
214 list_for_each_entry(conn, &connlist, conn_list) {
215 if ((conn->cid == cid) && (iscsi_conn_get_sid(conn) == sid)) {
216 spin_unlock_irqrestore(&connlock, flags);
220 spin_unlock_irqrestore(&connlock, flags);
225 * The following functions can be used by LLDs that allocate
226 * their own scsi_hosts or by software iscsi LLDs
228 static void iscsi_session_release(struct device *dev)
230 struct iscsi_cls_session *session = iscsi_dev_to_session(dev);
231 struct Scsi_Host *shost;
233 shost = iscsi_session_to_shost(session);
234 scsi_host_put(shost);
238 static int iscsi_is_session_dev(const struct device *dev)
240 return dev->release == iscsi_session_release;
243 static int iscsi_user_scan(struct Scsi_Host *shost, uint channel,
246 struct iscsi_host *ihost = shost->shost_data;
247 struct iscsi_cls_session *session;
249 mutex_lock(&ihost->mutex);
250 list_for_each_entry(session, &ihost->sessions, host_list) {
251 if ((channel == SCAN_WILD_CARD || channel == 0) &&
252 (id == SCAN_WILD_CARD || id == session->target_id))
253 scsi_scan_target(&session->dev, 0,
254 session->target_id, lun, 1);
256 mutex_unlock(&ihost->mutex);
261 static void session_recovery_timedout(void *data)
263 struct iscsi_cls_session *session = data;
265 dev_printk(KERN_INFO, &session->dev, "iscsi: session recovery timed "
266 "out after %d secs\n", session->recovery_tmo);
268 if (session->transport->session_recovery_timedout)
269 session->transport->session_recovery_timedout(session);
271 scsi_target_unblock(&session->dev);
274 void iscsi_unblock_session(struct iscsi_cls_session *session)
276 if (!cancel_delayed_work(&session->recovery_work))
277 flush_scheduled_work();
278 scsi_target_unblock(&session->dev);
280 EXPORT_SYMBOL_GPL(iscsi_unblock_session);
282 void iscsi_block_session(struct iscsi_cls_session *session)
284 scsi_target_block(&session->dev);
285 schedule_delayed_work(&session->recovery_work,
286 session->recovery_tmo * HZ);
288 EXPORT_SYMBOL_GPL(iscsi_block_session);
291 * iscsi_create_session - create iscsi class session
293 * @transport: iscsi transport
295 * This can be called from a LLD or iscsi_transport.
297 struct iscsi_cls_session *
298 iscsi_create_session(struct Scsi_Host *shost,
299 struct iscsi_transport *transport)
301 struct iscsi_host *ihost;
302 struct iscsi_cls_session *session;
305 session = kzalloc(sizeof(*session) + transport->sessiondata_size,
310 session->transport = transport;
311 session->recovery_tmo = 120;
312 INIT_WORK(&session->recovery_work, session_recovery_timedout, session);
313 INIT_LIST_HEAD(&session->host_list);
314 INIT_LIST_HEAD(&session->sess_list);
316 if (transport->sessiondata_size)
317 session->dd_data = &session[1];
319 /* this is released in the dev's release function */
320 scsi_host_get(shost);
321 ihost = shost->shost_data;
323 session->sid = iscsi_session_nr++;
324 session->target_id = ihost->next_target_id++;
326 snprintf(session->dev.bus_id, BUS_ID_SIZE, "session%u",
328 session->dev.parent = &shost->shost_gendev;
329 session->dev.release = iscsi_session_release;
330 err = device_register(&session->dev);
332 dev_printk(KERN_ERR, &session->dev, "iscsi: could not "
333 "register session's dev\n");
336 transport_register_device(&session->dev);
338 mutex_lock(&ihost->mutex);
339 list_add(&session->host_list, &ihost->sessions);
340 mutex_unlock(&ihost->mutex);
349 EXPORT_SYMBOL_GPL(iscsi_create_session);
352 * iscsi_destroy_session - destroy iscsi session
353 * @session: iscsi_session
355 * Can be called by a LLD or iscsi_transport. There must not be
356 * any running connections.
358 int iscsi_destroy_session(struct iscsi_cls_session *session)
360 struct Scsi_Host *shost = iscsi_session_to_shost(session);
361 struct iscsi_host *ihost = shost->shost_data;
363 if (!cancel_delayed_work(&session->recovery_work))
364 flush_scheduled_work();
366 mutex_lock(&ihost->mutex);
367 list_del(&session->host_list);
368 mutex_unlock(&ihost->mutex);
370 transport_unregister_device(&session->dev);
371 device_unregister(&session->dev);
375 EXPORT_SYMBOL_GPL(iscsi_destroy_session);
377 static void iscsi_conn_release(struct device *dev)
379 struct iscsi_cls_conn *conn = iscsi_dev_to_conn(dev);
380 struct device *parent = conn->dev.parent;
386 static int iscsi_is_conn_dev(const struct device *dev)
388 return dev->release == iscsi_conn_release;
392 * iscsi_create_conn - create iscsi class connection
393 * @session: iscsi cls session
394 * @cid: connection id
396 * This can be called from a LLD or iscsi_transport. The connection
397 * is child of the session so cid must be unique for all connections
400 * Since we do not support MCS, cid will normally be zero. In some cases
401 * for software iscsi we could be trying to preallocate a connection struct
402 * in which case there could be two connection structs and cid would be
405 struct iscsi_cls_conn *
406 iscsi_create_conn(struct iscsi_cls_session *session, uint32_t cid)
408 struct iscsi_transport *transport = session->transport;
409 struct iscsi_cls_conn *conn;
412 conn = kzalloc(sizeof(*conn) + transport->conndata_size, GFP_KERNEL);
416 if (transport->conndata_size)
417 conn->dd_data = &conn[1];
419 INIT_LIST_HEAD(&conn->conn_list);
420 conn->transport = transport;
423 /* this is released in the dev's release function */
424 if (!get_device(&session->dev))
427 snprintf(conn->dev.bus_id, BUS_ID_SIZE, "connection%d:%u",
429 conn->dev.parent = &session->dev;
430 conn->dev.release = iscsi_conn_release;
431 err = device_register(&conn->dev);
433 dev_printk(KERN_ERR, &conn->dev, "iscsi: could not register "
434 "connection's dev\n");
435 goto release_parent_ref;
437 transport_register_device(&conn->dev);
441 put_device(&session->dev);
447 EXPORT_SYMBOL_GPL(iscsi_create_conn);
450 * iscsi_destroy_conn - destroy iscsi class connection
451 * @session: iscsi cls session
453 * This can be called from a LLD or iscsi_transport.
455 int iscsi_destroy_conn(struct iscsi_cls_conn *conn)
457 transport_unregister_device(&conn->dev);
458 device_unregister(&conn->dev);
462 EXPORT_SYMBOL_GPL(iscsi_destroy_conn);
465 * iscsi interface functions
467 static struct iscsi_internal *
468 iscsi_if_transport_lookup(struct iscsi_transport *tt)
470 struct iscsi_internal *priv;
473 spin_lock_irqsave(&iscsi_transport_lock, flags);
474 list_for_each_entry(priv, &iscsi_transports, list) {
475 if (tt == priv->iscsi_transport) {
476 spin_unlock_irqrestore(&iscsi_transport_lock, flags);
480 spin_unlock_irqrestore(&iscsi_transport_lock, flags);
484 static inline struct list_head *skb_to_lh(struct sk_buff *skb)
486 return (struct list_head *)&skb->cb;
490 mempool_zone_alloc_skb(gfp_t gfp_mask, void *pool_data)
492 struct mempool_zone *zone = pool_data;
494 return alloc_skb(zone->size, gfp_mask);
498 mempool_zone_free_skb(void *element, void *pool_data)
504 mempool_zone_complete(struct mempool_zone *zone)
507 struct list_head *lh, *n;
509 spin_lock_irqsave(&zone->freelock, flags);
510 list_for_each_safe(lh, n, &zone->freequeue) {
511 struct sk_buff *skb = (struct sk_buff *)((char *)lh -
512 offsetof(struct sk_buff, cb));
513 if (!skb_shared(skb)) {
514 list_del(skb_to_lh(skb));
515 mempool_free(skb, zone->pool);
516 atomic_dec(&zone->allocated);
519 spin_unlock_irqrestore(&zone->freelock, flags);
522 static struct mempool_zone *
523 mempool_zone_init(unsigned max, unsigned size, unsigned hiwat)
525 struct mempool_zone *zp;
527 zp = kzalloc(sizeof(*zp), GFP_KERNEL);
533 INIT_LIST_HEAD(&zp->freequeue);
534 spin_lock_init(&zp->freelock);
535 atomic_set(&zp->allocated, 0);
537 zp->pool = mempool_create(max, mempool_zone_alloc_skb,
538 mempool_zone_free_skb, zp);
547 static void mempool_zone_destroy(struct mempool_zone *zp)
549 mempool_destroy(zp->pool);
553 static struct sk_buff*
554 mempool_zone_get_skb(struct mempool_zone *zone)
558 skb = mempool_alloc(zone->pool, GFP_ATOMIC);
560 atomic_inc(&zone->allocated);
565 iscsi_unicast_skb(struct mempool_zone *zone, struct sk_buff *skb, int pid)
571 rc = netlink_unicast(nls, skb, pid, MSG_DONTWAIT);
573 mempool_free(skb, zone->pool);
574 printk(KERN_ERR "iscsi: can not unicast skb (%d)\n", rc);
578 spin_lock_irqsave(&zone->freelock, flags);
579 INIT_LIST_HEAD(skb_to_lh(skb));
580 list_add(skb_to_lh(skb), &zone->freequeue);
581 spin_unlock_irqrestore(&zone->freelock, flags);
586 int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
587 char *data, uint32_t data_size)
589 struct nlmsghdr *nlh;
591 struct iscsi_uevent *ev;
593 struct iscsi_internal *priv;
594 int len = NLMSG_SPACE(sizeof(*ev) + sizeof(struct iscsi_hdr) +
597 priv = iscsi_if_transport_lookup(conn->transport);
601 mempool_zone_complete(conn->z_pdu);
603 skb = mempool_zone_get_skb(conn->z_pdu);
605 iscsi_conn_error(conn, ISCSI_ERR_CONN_FAILED);
606 dev_printk(KERN_ERR, &conn->dev, "iscsi: can not deliver "
607 "control PDU: OOM\n");
611 nlh = __nlmsg_put(skb, priv->daemon_pid, 0, 0, (len - sizeof(*nlh)), 0);
612 ev = NLMSG_DATA(nlh);
613 memset(ev, 0, sizeof(*ev));
614 ev->transport_handle = iscsi_handle(conn->transport);
615 ev->type = ISCSI_KEVENT_RECV_PDU;
616 if (atomic_read(&conn->z_pdu->allocated) >= conn->z_pdu->hiwat)
617 ev->iferror = -ENOMEM;
618 ev->r.recv_req.cid = conn->cid;
619 ev->r.recv_req.sid = iscsi_conn_get_sid(conn);
620 pdu = (char*)ev + sizeof(*ev);
621 memcpy(pdu, hdr, sizeof(struct iscsi_hdr));
622 memcpy(pdu + sizeof(struct iscsi_hdr), data, data_size);
624 return iscsi_unicast_skb(conn->z_pdu, skb, priv->daemon_pid);
626 EXPORT_SYMBOL_GPL(iscsi_recv_pdu);
628 void iscsi_conn_error(struct iscsi_cls_conn *conn, enum iscsi_err error)
630 struct nlmsghdr *nlh;
632 struct iscsi_uevent *ev;
633 struct iscsi_internal *priv;
634 int len = NLMSG_SPACE(sizeof(*ev));
636 priv = iscsi_if_transport_lookup(conn->transport);
640 mempool_zone_complete(conn->z_error);
642 skb = mempool_zone_get_skb(conn->z_error);
644 dev_printk(KERN_ERR, &conn->dev, "iscsi: gracefully ignored "
645 "conn error (%d)\n", error);
649 nlh = __nlmsg_put(skb, priv->daemon_pid, 0, 0, (len - sizeof(*nlh)), 0);
650 ev = NLMSG_DATA(nlh);
651 ev->transport_handle = iscsi_handle(conn->transport);
652 ev->type = ISCSI_KEVENT_CONN_ERROR;
653 if (atomic_read(&conn->z_error->allocated) >= conn->z_error->hiwat)
654 ev->iferror = -ENOMEM;
655 ev->r.connerror.error = error;
656 ev->r.connerror.cid = conn->cid;
657 ev->r.connerror.sid = iscsi_conn_get_sid(conn);
659 iscsi_unicast_skb(conn->z_error, skb, priv->daemon_pid);
661 dev_printk(KERN_INFO, &conn->dev, "iscsi: detected conn error (%d)\n",
664 EXPORT_SYMBOL_GPL(iscsi_conn_error);
667 iscsi_if_send_reply(int pid, int seq, int type, int done, int multi,
668 void *payload, int size)
671 struct nlmsghdr *nlh;
672 int len = NLMSG_SPACE(size);
673 int flags = multi ? NLM_F_MULTI : 0;
674 int t = done ? NLMSG_DONE : type;
676 mempool_zone_complete(z_reply);
678 skb = mempool_zone_get_skb(z_reply);
681 * user is supposed to react on iferror == -ENOMEM;
686 nlh = __nlmsg_put(skb, pid, seq, t, (len - sizeof(*nlh)), 0);
687 nlh->nlmsg_flags = flags;
688 memcpy(NLMSG_DATA(nlh), payload, size);
689 return iscsi_unicast_skb(z_reply, skb, pid);
693 iscsi_if_get_stats(struct iscsi_transport *transport, struct nlmsghdr *nlh)
695 struct iscsi_uevent *ev = NLMSG_DATA(nlh);
696 struct iscsi_stats *stats;
697 struct sk_buff *skbstat;
698 struct iscsi_cls_conn *conn;
699 struct nlmsghdr *nlhstat;
700 struct iscsi_uevent *evstat;
701 struct iscsi_internal *priv;
702 int len = NLMSG_SPACE(sizeof(*ev) +
703 sizeof(struct iscsi_stats) +
704 sizeof(struct iscsi_stats_custom) *
705 ISCSI_STATS_CUSTOM_MAX);
708 priv = iscsi_if_transport_lookup(transport);
712 conn = iscsi_conn_lookup(ev->u.get_stats.sid, ev->u.get_stats.cid);
719 mempool_zone_complete(conn->z_pdu);
721 skbstat = mempool_zone_get_skb(conn->z_pdu);
723 dev_printk(KERN_ERR, &conn->dev, "iscsi: can not "
724 "deliver stats: OOM\n");
728 nlhstat = __nlmsg_put(skbstat, priv->daemon_pid, 0, 0,
729 (len - sizeof(*nlhstat)), 0);
730 evstat = NLMSG_DATA(nlhstat);
731 memset(evstat, 0, sizeof(*evstat));
732 evstat->transport_handle = iscsi_handle(conn->transport);
733 evstat->type = nlh->nlmsg_type;
734 if (atomic_read(&conn->z_pdu->allocated) >= conn->z_pdu->hiwat)
735 evstat->iferror = -ENOMEM;
736 evstat->u.get_stats.cid =
738 evstat->u.get_stats.sid =
740 stats = (struct iscsi_stats *)
741 ((char*)evstat + sizeof(*evstat));
742 memset(stats, 0, sizeof(*stats));
744 transport->get_stats(conn, stats);
745 actual_size = NLMSG_SPACE(sizeof(struct iscsi_uevent) +
746 sizeof(struct iscsi_stats) +
747 sizeof(struct iscsi_stats_custom) *
748 stats->custom_length);
749 actual_size -= sizeof(*nlhstat);
750 actual_size = NLMSG_LENGTH(actual_size);
751 skb_trim(skbstat, NLMSG_ALIGN(actual_size));
752 nlhstat->nlmsg_len = actual_size;
754 err = iscsi_unicast_skb(conn->z_pdu, skbstat, priv->daemon_pid);
755 } while (err < 0 && err != -ECONNREFUSED);
761 iscsi_if_create_session(struct iscsi_internal *priv, struct iscsi_uevent *ev)
763 struct iscsi_transport *transport = priv->iscsi_transport;
764 struct iscsi_cls_session *session;
768 session = transport->create_session(transport, &priv->t,
769 ev->u.c_session.initial_cmdsn,
774 spin_lock_irqsave(&sesslock, flags);
775 list_add(&session->sess_list, &sesslist);
776 spin_unlock_irqrestore(&sesslock, flags);
778 ev->r.c_session_ret.host_no = hostno;
779 ev->r.c_session_ret.sid = session->sid;
784 iscsi_if_create_conn(struct iscsi_transport *transport, struct iscsi_uevent *ev)
786 struct iscsi_cls_conn *conn;
787 struct iscsi_cls_session *session;
790 session = iscsi_session_lookup(ev->u.c_conn.sid);
792 printk(KERN_ERR "iscsi: invalid session %d\n",
797 conn = transport->create_conn(session, ev->u.c_conn.cid);
799 printk(KERN_ERR "iscsi: couldn't create a new "
800 "connection for session %d\n",
805 conn->z_pdu = mempool_zone_init(Z_MAX_PDU,
806 NLMSG_SPACE(sizeof(struct iscsi_uevent) +
807 sizeof(struct iscsi_hdr) +
808 DEFAULT_MAX_RECV_DATA_SEGMENT_LENGTH),
811 dev_printk(KERN_ERR, &conn->dev, "iscsi: can not allocate "
812 "pdu zone for new conn\n");
816 conn->z_error = mempool_zone_init(Z_MAX_ERROR,
817 NLMSG_SPACE(sizeof(struct iscsi_uevent)),
819 if (!conn->z_error) {
820 dev_printk(KERN_ERR, &conn->dev, "iscsi: can not allocate "
821 "error zone for new conn\n");
825 ev->r.c_conn_ret.sid = session->sid;
826 ev->r.c_conn_ret.cid = conn->cid;
828 spin_lock_irqsave(&connlock, flags);
829 list_add(&conn->conn_list, &connlist);
831 spin_unlock_irqrestore(&connlock, flags);
836 mempool_zone_destroy(conn->z_pdu);
838 if (transport->destroy_conn)
839 transport->destroy_conn(conn->dd_data);
844 iscsi_if_destroy_conn(struct iscsi_transport *transport, struct iscsi_uevent *ev)
847 struct iscsi_cls_conn *conn;
848 struct mempool_zone *z_error, *z_pdu;
850 conn = iscsi_conn_lookup(ev->u.d_conn.sid, ev->u.d_conn.cid);
853 spin_lock_irqsave(&connlock, flags);
855 list_del(&conn->conn_list);
856 spin_unlock_irqrestore(&connlock, flags);
859 z_error = conn->z_error;
861 if (transport->destroy_conn)
862 transport->destroy_conn(conn);
864 mempool_zone_destroy(z_pdu);
865 mempool_zone_destroy(z_error);
871 iscsi_set_param(struct iscsi_transport *transport, struct iscsi_uevent *ev)
873 char *data = (char*)ev + sizeof(*ev);
874 struct iscsi_cls_conn *conn;
875 struct iscsi_cls_session *session;
876 int err = 0, value = 0;
878 session = iscsi_session_lookup(ev->u.set_param.sid);
879 conn = iscsi_conn_lookup(ev->u.set_param.sid, ev->u.set_param.cid);
880 if (!conn || !session)
883 switch (ev->u.set_param.param) {
884 case ISCSI_PARAM_SESS_RECOVERY_TMO:
885 sscanf(data, "%d", &value);
887 session->recovery_tmo = value;
890 err = transport->set_param(conn, ev->u.set_param.param,
891 data, ev->u.set_param.len);
898 iscsi_if_transport_ep(struct iscsi_transport *transport,
899 struct iscsi_uevent *ev, int msg_type)
901 struct sockaddr *dst_addr;
905 case ISCSI_UEVENT_TRANSPORT_EP_CONNECT:
906 if (!transport->ep_connect)
909 dst_addr = (struct sockaddr *)((char*)ev + sizeof(*ev));
910 rc = transport->ep_connect(dst_addr,
911 ev->u.ep_connect.non_blocking,
912 &ev->r.ep_connect_ret.handle);
914 case ISCSI_UEVENT_TRANSPORT_EP_POLL:
915 if (!transport->ep_poll)
918 ev->r.retcode = transport->ep_poll(ev->u.ep_poll.ep_handle,
919 ev->u.ep_poll.timeout_ms);
921 case ISCSI_UEVENT_TRANSPORT_EP_DISCONNECT:
922 if (!transport->ep_disconnect)
925 transport->ep_disconnect(ev->u.ep_disconnect.ep_handle);
932 iscsi_tgt_dscvr(struct iscsi_transport *transport,
933 struct iscsi_uevent *ev)
935 struct sockaddr *dst_addr;
937 if (!transport->tgt_dscvr)
940 dst_addr = (struct sockaddr *)((char*)ev + sizeof(*ev));
941 return transport->tgt_dscvr(ev->u.tgt_dscvr.type,
942 ev->u.tgt_dscvr.host_no,
943 ev->u.tgt_dscvr.enable, dst_addr);
947 iscsi_if_recv_msg(struct sk_buff *skb, struct nlmsghdr *nlh)
950 struct iscsi_uevent *ev = NLMSG_DATA(nlh);
951 struct iscsi_transport *transport = NULL;
952 struct iscsi_internal *priv;
953 struct iscsi_cls_session *session;
954 struct iscsi_cls_conn *conn;
957 priv = iscsi_if_transport_lookup(iscsi_ptr(ev->transport_handle));
960 transport = priv->iscsi_transport;
962 if (!try_module_get(transport->owner))
965 priv->daemon_pid = NETLINK_CREDS(skb)->pid;
967 switch (nlh->nlmsg_type) {
968 case ISCSI_UEVENT_CREATE_SESSION:
969 err = iscsi_if_create_session(priv, ev);
971 case ISCSI_UEVENT_DESTROY_SESSION:
972 session = iscsi_session_lookup(ev->u.d_session.sid);
974 spin_lock_irqsave(&sesslock, flags);
975 list_del(&session->sess_list);
976 spin_unlock_irqrestore(&sesslock, flags);
978 transport->destroy_session(session);
982 case ISCSI_UEVENT_CREATE_CONN:
983 err = iscsi_if_create_conn(transport, ev);
985 case ISCSI_UEVENT_DESTROY_CONN:
986 err = iscsi_if_destroy_conn(transport, ev);
988 case ISCSI_UEVENT_BIND_CONN:
989 session = iscsi_session_lookup(ev->u.b_conn.sid);
990 conn = iscsi_conn_lookup(ev->u.b_conn.sid, ev->u.b_conn.cid);
993 ev->r.retcode = transport->bind_conn(session, conn,
994 ev->u.b_conn.transport_eph,
995 ev->u.b_conn.is_leading);
999 case ISCSI_UEVENT_SET_PARAM:
1000 err = iscsi_set_param(transport, ev);
1002 case ISCSI_UEVENT_START_CONN:
1003 conn = iscsi_conn_lookup(ev->u.start_conn.sid, ev->u.start_conn.cid);
1005 ev->r.retcode = transport->start_conn(conn);
1009 case ISCSI_UEVENT_STOP_CONN:
1010 conn = iscsi_conn_lookup(ev->u.stop_conn.sid, ev->u.stop_conn.cid);
1012 transport->stop_conn(conn, ev->u.stop_conn.flag);
1016 case ISCSI_UEVENT_SEND_PDU:
1017 conn = iscsi_conn_lookup(ev->u.send_pdu.sid, ev->u.send_pdu.cid);
1019 ev->r.retcode = transport->send_pdu(conn,
1020 (struct iscsi_hdr*)((char*)ev + sizeof(*ev)),
1021 (char*)ev + sizeof(*ev) + ev->u.send_pdu.hdr_size,
1022 ev->u.send_pdu.data_size);
1026 case ISCSI_UEVENT_GET_STATS:
1027 err = iscsi_if_get_stats(transport, nlh);
1029 case ISCSI_UEVENT_TRANSPORT_EP_CONNECT:
1030 case ISCSI_UEVENT_TRANSPORT_EP_POLL:
1031 case ISCSI_UEVENT_TRANSPORT_EP_DISCONNECT:
1032 err = iscsi_if_transport_ep(transport, ev, nlh->nlmsg_type);
1034 case ISCSI_UEVENT_TGT_DSCVR:
1035 err = iscsi_tgt_dscvr(transport, ev);
1042 module_put(transport->owner);
1047 * Get message from skb (based on rtnetlink_rcv_skb). Each message is
1048 * processed by iscsi_if_recv_msg. Malformed skbs with wrong lengths or
1049 * invalid creds are discarded silently.
1052 iscsi_if_rx(struct sock *sk, int len)
1054 struct sk_buff *skb;
1056 mutex_lock(&rx_queue_mutex);
1057 while ((skb = skb_dequeue(&sk->sk_receive_queue)) != NULL) {
1058 if (NETLINK_CREDS(skb)->uid) {
1059 skb_pull(skb, skb->len);
1063 while (skb->len >= NLMSG_SPACE(0)) {
1066 struct nlmsghdr *nlh;
1067 struct iscsi_uevent *ev;
1069 nlh = (struct nlmsghdr *)skb->data;
1070 if (nlh->nlmsg_len < sizeof(*nlh) ||
1071 skb->len < nlh->nlmsg_len) {
1075 ev = NLMSG_DATA(nlh);
1076 rlen = NLMSG_ALIGN(nlh->nlmsg_len);
1077 if (rlen > skb->len)
1080 err = iscsi_if_recv_msg(skb, nlh);
1082 ev->type = ISCSI_KEVENT_IF_ERROR;
1087 * special case for GET_STATS:
1088 * on success - sending reply and stats from
1089 * inside of if_recv_msg(),
1090 * on error - fall through.
1092 if (ev->type == ISCSI_UEVENT_GET_STATS && !err)
1094 err = iscsi_if_send_reply(
1095 NETLINK_CREDS(skb)->pid, nlh->nlmsg_seq,
1096 nlh->nlmsg_type, 0, 0, ev, sizeof(*ev));
1097 if (atomic_read(&z_reply->allocated) >=
1099 ev->iferror = -ENOMEM;
1100 } while (err < 0 && err != -ECONNREFUSED);
1101 skb_pull(skb, rlen);
1106 mutex_unlock(&rx_queue_mutex);
1109 #define iscsi_cdev_to_conn(_cdev) \
1110 iscsi_dev_to_conn(_cdev->dev)
1112 #define ISCSI_CLASS_ATTR(_prefix,_name,_mode,_show,_store) \
1113 struct class_device_attribute class_device_attr_##_prefix##_##_name = \
1114 __ATTR(_name,_mode,_show,_store)
1117 * iSCSI connection attrs
1119 #define iscsi_conn_attr_show(param) \
1121 show_conn_param_##param(struct class_device *cdev, char *buf) \
1123 struct iscsi_cls_conn *conn = iscsi_cdev_to_conn(cdev); \
1124 struct iscsi_transport *t = conn->transport; \
1125 return t->get_conn_param(conn, param, buf); \
1128 #define iscsi_conn_attr(field, param) \
1129 iscsi_conn_attr_show(param) \
1130 static ISCSI_CLASS_ATTR(conn, field, S_IRUGO, show_conn_param_##param, \
1133 iscsi_conn_attr(max_recv_dlength, ISCSI_PARAM_MAX_RECV_DLENGTH);
1134 iscsi_conn_attr(max_xmit_dlength, ISCSI_PARAM_MAX_XMIT_DLENGTH);
1135 iscsi_conn_attr(header_digest, ISCSI_PARAM_HDRDGST_EN);
1136 iscsi_conn_attr(data_digest, ISCSI_PARAM_DATADGST_EN);
1137 iscsi_conn_attr(ifmarker, ISCSI_PARAM_IFMARKER_EN);
1138 iscsi_conn_attr(ofmarker, ISCSI_PARAM_OFMARKER_EN);
1139 iscsi_conn_attr(persistent_port, ISCSI_PARAM_PERSISTENT_PORT);
1140 iscsi_conn_attr(port, ISCSI_PARAM_CONN_PORT);
1141 iscsi_conn_attr(exp_statsn, ISCSI_PARAM_EXP_STATSN);
1142 iscsi_conn_attr(persistent_address, ISCSI_PARAM_PERSISTENT_ADDRESS);
1143 iscsi_conn_attr(address, ISCSI_PARAM_CONN_ADDRESS);
1145 #define iscsi_cdev_to_session(_cdev) \
1146 iscsi_dev_to_session(_cdev->dev)
1149 * iSCSI session attrs
1151 #define iscsi_session_attr_show(param) \
1153 show_session_param_##param(struct class_device *cdev, char *buf) \
1155 struct iscsi_cls_session *session = iscsi_cdev_to_session(cdev); \
1156 struct iscsi_transport *t = session->transport; \
1157 return t->get_session_param(session, param, buf); \
1160 #define iscsi_session_attr(field, param) \
1161 iscsi_session_attr_show(param) \
1162 static ISCSI_CLASS_ATTR(sess, field, S_IRUGO, show_session_param_##param, \
1165 iscsi_session_attr(targetname, ISCSI_PARAM_TARGET_NAME);
1166 iscsi_session_attr(initial_r2t, ISCSI_PARAM_INITIAL_R2T_EN);
1167 iscsi_session_attr(max_outstanding_r2t, ISCSI_PARAM_MAX_R2T);
1168 iscsi_session_attr(immediate_data, ISCSI_PARAM_IMM_DATA_EN);
1169 iscsi_session_attr(first_burst_len, ISCSI_PARAM_FIRST_BURST);
1170 iscsi_session_attr(max_burst_len, ISCSI_PARAM_MAX_BURST);
1171 iscsi_session_attr(data_pdu_in_order, ISCSI_PARAM_PDU_INORDER_EN);
1172 iscsi_session_attr(data_seq_in_order, ISCSI_PARAM_DATASEQ_INORDER_EN);
1173 iscsi_session_attr(erl, ISCSI_PARAM_ERL);
1174 iscsi_session_attr(tpgt, ISCSI_PARAM_TPGT);
1176 #define iscsi_priv_session_attr_show(field, format) \
1178 show_priv_session_##field(struct class_device *cdev, char *buf) \
1180 struct iscsi_cls_session *session = iscsi_cdev_to_session(cdev);\
1181 return sprintf(buf, format"\n", session->field); \
1184 #define iscsi_priv_session_attr(field, format) \
1185 iscsi_priv_session_attr_show(field, format) \
1186 static ISCSI_CLASS_ATTR(priv_sess, field, S_IRUGO, show_priv_session_##field, \
1188 iscsi_priv_session_attr(recovery_tmo, "%d");
1190 #define SETUP_PRIV_SESSION_RD_ATTR(field) \
1192 priv->session_attrs[count] = &class_device_attr_priv_sess_##field; \
1197 #define SETUP_SESSION_RD_ATTR(field, param_flag) \
1199 if (tt->param_mask & param_flag) { \
1200 priv->session_attrs[count] = &class_device_attr_sess_##field; \
1205 #define SETUP_CONN_RD_ATTR(field, param_flag) \
1207 if (tt->param_mask & param_flag) { \
1208 priv->conn_attrs[count] = &class_device_attr_conn_##field; \
1213 static int iscsi_session_match(struct attribute_container *cont,
1216 struct iscsi_cls_session *session;
1217 struct Scsi_Host *shost;
1218 struct iscsi_internal *priv;
1220 if (!iscsi_is_session_dev(dev))
1223 session = iscsi_dev_to_session(dev);
1224 shost = iscsi_session_to_shost(session);
1225 if (!shost->transportt)
1228 priv = to_iscsi_internal(shost->transportt);
1229 if (priv->session_cont.ac.class != &iscsi_session_class.class)
1232 return &priv->session_cont.ac == cont;
1235 static int iscsi_conn_match(struct attribute_container *cont,
1238 struct iscsi_cls_session *session;
1239 struct iscsi_cls_conn *conn;
1240 struct Scsi_Host *shost;
1241 struct iscsi_internal *priv;
1243 if (!iscsi_is_conn_dev(dev))
1246 conn = iscsi_dev_to_conn(dev);
1247 session = iscsi_dev_to_session(conn->dev.parent);
1248 shost = iscsi_session_to_shost(session);
1250 if (!shost->transportt)
1253 priv = to_iscsi_internal(shost->transportt);
1254 if (priv->conn_cont.ac.class != &iscsi_connection_class.class)
1257 return &priv->conn_cont.ac == cont;
1260 static int iscsi_host_match(struct attribute_container *cont,
1263 struct Scsi_Host *shost;
1264 struct iscsi_internal *priv;
1266 if (!scsi_is_host_device(dev))
1269 shost = dev_to_shost(dev);
1270 if (!shost->transportt ||
1271 shost->transportt->host_attrs.ac.class != &iscsi_host_class.class)
1274 priv = to_iscsi_internal(shost->transportt);
1275 return &priv->t.host_attrs.ac == cont;
1278 struct scsi_transport_template *
1279 iscsi_register_transport(struct iscsi_transport *tt)
1281 struct iscsi_internal *priv;
1282 unsigned long flags;
1287 priv = iscsi_if_transport_lookup(tt);
1291 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
1294 INIT_LIST_HEAD(&priv->list);
1295 priv->iscsi_transport = tt;
1296 priv->t.user_scan = iscsi_user_scan;
1298 priv->cdev.class = &iscsi_transport_class;
1299 snprintf(priv->cdev.class_id, BUS_ID_SIZE, "%s", tt->name);
1300 err = class_device_register(&priv->cdev);
1304 err = sysfs_create_group(&priv->cdev.kobj, &iscsi_transport_group);
1306 goto unregister_cdev;
1308 /* host parameters */
1309 priv->t.host_attrs.ac.attrs = &priv->host_attrs[0];
1310 priv->t.host_attrs.ac.class = &iscsi_host_class.class;
1311 priv->t.host_attrs.ac.match = iscsi_host_match;
1312 priv->t.host_size = sizeof(struct iscsi_host);
1313 priv->host_attrs[0] = NULL;
1314 transport_container_register(&priv->t.host_attrs);
1316 /* connection parameters */
1317 priv->conn_cont.ac.attrs = &priv->conn_attrs[0];
1318 priv->conn_cont.ac.class = &iscsi_connection_class.class;
1319 priv->conn_cont.ac.match = iscsi_conn_match;
1320 transport_container_register(&priv->conn_cont);
1322 SETUP_CONN_RD_ATTR(max_recv_dlength, ISCSI_MAX_RECV_DLENGTH);
1323 SETUP_CONN_RD_ATTR(max_xmit_dlength, ISCSI_MAX_XMIT_DLENGTH);
1324 SETUP_CONN_RD_ATTR(header_digest, ISCSI_HDRDGST_EN);
1325 SETUP_CONN_RD_ATTR(data_digest, ISCSI_DATADGST_EN);
1326 SETUP_CONN_RD_ATTR(ifmarker, ISCSI_IFMARKER_EN);
1327 SETUP_CONN_RD_ATTR(ofmarker, ISCSI_OFMARKER_EN);
1328 SETUP_CONN_RD_ATTR(address, ISCSI_CONN_ADDRESS);
1329 SETUP_CONN_RD_ATTR(port, ISCSI_CONN_PORT);
1330 SETUP_CONN_RD_ATTR(exp_statsn, ISCSI_EXP_STATSN);
1331 SETUP_CONN_RD_ATTR(persistent_address, ISCSI_PERSISTENT_ADDRESS);
1332 SETUP_CONN_RD_ATTR(persistent_port, ISCSI_PERSISTENT_PORT);
1334 BUG_ON(count > ISCSI_CONN_ATTRS);
1335 priv->conn_attrs[count] = NULL;
1338 /* session parameters */
1339 priv->session_cont.ac.attrs = &priv->session_attrs[0];
1340 priv->session_cont.ac.class = &iscsi_session_class.class;
1341 priv->session_cont.ac.match = iscsi_session_match;
1342 transport_container_register(&priv->session_cont);
1344 SETUP_SESSION_RD_ATTR(initial_r2t, ISCSI_INITIAL_R2T_EN);
1345 SETUP_SESSION_RD_ATTR(max_outstanding_r2t, ISCSI_MAX_R2T);
1346 SETUP_SESSION_RD_ATTR(immediate_data, ISCSI_IMM_DATA_EN);
1347 SETUP_SESSION_RD_ATTR(first_burst_len, ISCSI_FIRST_BURST);
1348 SETUP_SESSION_RD_ATTR(max_burst_len, ISCSI_MAX_BURST);
1349 SETUP_SESSION_RD_ATTR(data_pdu_in_order, ISCSI_PDU_INORDER_EN);
1350 SETUP_SESSION_RD_ATTR(data_seq_in_order, ISCSI_DATASEQ_INORDER_EN);
1351 SETUP_SESSION_RD_ATTR(erl, ISCSI_ERL);
1352 SETUP_SESSION_RD_ATTR(targetname, ISCSI_TARGET_NAME);
1353 SETUP_SESSION_RD_ATTR(tpgt, ISCSI_TPGT);
1354 SETUP_PRIV_SESSION_RD_ATTR(recovery_tmo);
1356 BUG_ON(count > ISCSI_SESSION_ATTRS);
1357 priv->session_attrs[count] = NULL;
1359 spin_lock_irqsave(&iscsi_transport_lock, flags);
1360 list_add(&priv->list, &iscsi_transports);
1361 spin_unlock_irqrestore(&iscsi_transport_lock, flags);
1363 printk(KERN_NOTICE "iscsi: registered transport (%s)\n", tt->name);
1367 class_device_unregister(&priv->cdev);
1372 EXPORT_SYMBOL_GPL(iscsi_register_transport);
1374 int iscsi_unregister_transport(struct iscsi_transport *tt)
1376 struct iscsi_internal *priv;
1377 unsigned long flags;
1381 mutex_lock(&rx_queue_mutex);
1383 priv = iscsi_if_transport_lookup(tt);
1386 spin_lock_irqsave(&iscsi_transport_lock, flags);
1387 list_del(&priv->list);
1388 spin_unlock_irqrestore(&iscsi_transport_lock, flags);
1390 transport_container_unregister(&priv->conn_cont);
1391 transport_container_unregister(&priv->session_cont);
1392 transport_container_unregister(&priv->t.host_attrs);
1394 sysfs_remove_group(&priv->cdev.kobj, &iscsi_transport_group);
1395 class_device_unregister(&priv->cdev);
1396 mutex_unlock(&rx_queue_mutex);
1400 EXPORT_SYMBOL_GPL(iscsi_unregister_transport);
1403 iscsi_rcv_nl_event(struct notifier_block *this, unsigned long event, void *ptr)
1405 struct netlink_notify *n = ptr;
1407 if (event == NETLINK_URELEASE &&
1408 n->protocol == NETLINK_ISCSI && n->pid) {
1409 struct iscsi_cls_conn *conn;
1410 unsigned long flags;
1412 mempool_zone_complete(z_reply);
1413 spin_lock_irqsave(&connlock, flags);
1414 list_for_each_entry(conn, &connlist, conn_list) {
1415 mempool_zone_complete(conn->z_error);
1416 mempool_zone_complete(conn->z_pdu);
1418 spin_unlock_irqrestore(&connlock, flags);
1424 static struct notifier_block iscsi_nl_notifier = {
1425 .notifier_call = iscsi_rcv_nl_event,
1428 static __init int iscsi_transport_init(void)
1432 err = class_register(&iscsi_transport_class);
1436 err = transport_class_register(&iscsi_host_class);
1438 goto unregister_transport_class;
1440 err = transport_class_register(&iscsi_connection_class);
1442 goto unregister_host_class;
1444 err = transport_class_register(&iscsi_session_class);
1446 goto unregister_conn_class;
1448 err = netlink_register_notifier(&iscsi_nl_notifier);
1450 goto unregister_session_class;
1452 nls = netlink_kernel_create(NETLINK_ISCSI, 1, iscsi_if_rx,
1456 goto unregister_notifier;
1459 z_reply = mempool_zone_init(Z_MAX_REPLY,
1460 NLMSG_SPACE(sizeof(struct iscsi_uevent)), Z_HIWAT_REPLY);
1464 sock_release(nls->sk_socket);
1465 unregister_notifier:
1466 netlink_unregister_notifier(&iscsi_nl_notifier);
1467 unregister_session_class:
1468 transport_class_unregister(&iscsi_session_class);
1469 unregister_conn_class:
1470 transport_class_unregister(&iscsi_connection_class);
1471 unregister_host_class:
1472 transport_class_unregister(&iscsi_host_class);
1473 unregister_transport_class:
1474 class_unregister(&iscsi_transport_class);
1478 static void __exit iscsi_transport_exit(void)
1480 mempool_zone_destroy(z_reply);
1481 sock_release(nls->sk_socket);
1482 netlink_unregister_notifier(&iscsi_nl_notifier);
1483 transport_class_unregister(&iscsi_connection_class);
1484 transport_class_unregister(&iscsi_session_class);
1485 transport_class_unregister(&iscsi_host_class);
1486 class_unregister(&iscsi_transport_class);
1489 module_init(iscsi_transport_init);
1490 module_exit(iscsi_transport_exit);
1492 MODULE_AUTHOR("Mike Christie <michaelc@cs.wisc.edu>, "
1493 "Dmitry Yusupov <dmitry_yus@yahoo.com>, "
1494 "Alex Aizman <itn780@yahoo.com>");
1495 MODULE_DESCRIPTION("iSCSI Transport Interface");
1496 MODULE_LICENSE("GPL");