2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2012 The FreeBSD Foundation
7 * This software was developed by Edward Tomasz Napierala under sponsorship
8 * from the FreeBSD Foundation.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * iSCSI Common Layer. It's used by both the initiator and target to send
35 * and receive iSCSI PDUs.
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
41 #include <sys/param.h>
42 #include <sys/condvar.h>
45 #include <sys/kernel.h>
46 #include <sys/malloc.h>
47 #include <sys/mutex.h>
48 #include <sys/module.h>
49 #include <sys/queue.h>
51 #include <sys/socket.h>
52 #include <sys/sysctl.h>
53 #include <sys/systm.h>
56 #include <dev/iscsi/icl.h>
57 #include <icl_conn_if.h>
60 TAILQ_ENTRY(icl_module) im_next;
64 int (*im_limits)(struct icl_drv_limits *idl);
65 struct icl_conn *(*im_new_conn)(const char *name,
71 TAILQ_HEAD(, icl_module) sc_modules;
74 static int sysctl_kern_icl_offloads(SYSCTL_HANDLER_ARGS);
75 static MALLOC_DEFINE(M_ICL, "icl", "iSCSI Common Layer");
76 static struct icl_softc *sc;
78 SYSCTL_NODE(_kern, OID_AUTO, icl, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
79 "iSCSI Common Layer");
81 SYSCTL_INT(_kern_icl, OID_AUTO, debug, CTLFLAG_RWTUN,
82 &icl_debug, 0, "Enable debug messages");
83 SYSCTL_PROC(_kern_icl, OID_AUTO, offloads,
84 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE,
85 NULL, false, sysctl_kern_icl_offloads, "A",
86 "List of ICL modules");
87 SYSCTL_PROC(_kern_icl, OID_AUTO, iser_offloads,
88 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE,
89 NULL, true, sysctl_kern_icl_offloads, "A",
90 "List of iSER ICL modules");
93 sysctl_kern_icl_offloads(SYSCTL_HANDLER_ARGS)
95 const struct icl_module *im;
100 sbuf_new(&sb, NULL, 256, SBUF_AUTOEXTEND | SBUF_INCLUDENUL);
102 sx_slock(&sc->sc_lock);
103 TAILQ_FOREACH(im, &sc->sc_modules, im_next) {
104 if (im->im_iser != iser)
106 if (im != TAILQ_FIRST(&sc->sc_modules))
108 sbuf_printf(&sb, "%s", im->im_name);
110 sx_sunlock(&sc->sc_lock);
112 error = sbuf_finish(&sb);
114 error = SYSCTL_OUT(req, sbuf_data(&sb), sbuf_len(&sb));
119 static struct icl_module *
120 icl_find(const char *name, bool iser, bool quiet)
122 struct icl_module *im, *im_max;
124 sx_assert(&sc->sc_lock, SA_LOCKED);
127 * If the name was not specified, pick a module with highest
130 if (name == NULL || name[0] == '\0') {
132 TAILQ_FOREACH(im, &sc->sc_modules, im_next) {
133 if (im->im_iser != iser)
135 if (im_max == NULL ||
136 im->im_priority > im_max->im_priority)
140 if (iser && im_max == NULL && !quiet)
141 ICL_WARN("no iSER-capable offload found");
146 TAILQ_FOREACH(im, &sc->sc_modules, im_next) {
147 if (strcasecmp(im->im_name, name) != 0)
150 if (!im->im_iser && iser && !quiet) {
151 ICL_WARN("offload \"%s\" is not iSER-capable", name);
154 if (im->im_iser && !iser && !quiet) {
155 ICL_WARN("offload \"%s\" is iSER-only", name);
163 ICL_WARN("offload \"%s\" not found", name);
169 icl_new_conn(const char *offload, bool iser, const char *name, struct mtx *lock)
171 struct icl_module *im;
174 sx_slock(&sc->sc_lock);
175 im = icl_find(offload, iser, false);
177 sx_sunlock(&sc->sc_lock);
181 ic = im->im_new_conn(name, lock);
182 sx_sunlock(&sc->sc_lock);
188 icl_limits(const char *offload, bool iser, struct icl_drv_limits *idl)
190 struct icl_module *im;
193 bzero(idl, sizeof(*idl));
194 sx_slock(&sc->sc_lock);
195 im = icl_find(offload, iser, false);
197 sx_sunlock(&sc->sc_lock);
201 error = im->im_limits(idl);
202 sx_sunlock(&sc->sc_lock);
205 * Validate the limits provided by the driver against values allowed by
206 * the iSCSI RFC. 0 means iscsid/ctld should pick a reasonable value.
208 * Note that max_send_dsl is an internal implementation detail and not
211 #define OUT_OF_RANGE(x, lo, hi) ((x) != 0 && ((x) < (lo) || (x) > (hi)))
213 (OUT_OF_RANGE(idl->idl_max_recv_data_segment_length, 512, 16777215) ||
214 OUT_OF_RANGE(idl->idl_max_send_data_segment_length, 512, 16777215) ||
215 OUT_OF_RANGE(idl->idl_max_burst_length, 512, 16777215) ||
216 OUT_OF_RANGE(idl->idl_first_burst_length, 512, 16777215))) {
222 * If both first_burst and max_burst are provided then first_burst must
223 * not exceed max_burst.
225 if (error == 0 && idl->idl_first_burst_length > 0 &&
226 idl->idl_max_burst_length > 0 &&
227 idl->idl_first_burst_length > idl->idl_max_burst_length) {
235 icl_register(const char *offload, bool iser, int priority,
236 int (*limits)(struct icl_drv_limits *),
237 struct icl_conn *(*new_conn)(const char *, struct mtx *))
239 struct icl_module *im;
241 sx_xlock(&sc->sc_lock);
242 im = icl_find(offload, iser, true);
244 ICL_WARN("offload \"%s\" already registered", offload);
245 sx_xunlock(&sc->sc_lock);
249 im = malloc(sizeof(*im), M_ICL, M_ZERO | M_WAITOK);
250 im->im_name = strdup(offload, M_ICL);
252 im->im_priority = priority;
253 im->im_limits = limits;
254 im->im_new_conn = new_conn;
256 TAILQ_INSERT_HEAD(&sc->sc_modules, im, im_next);
257 sx_xunlock(&sc->sc_lock);
259 ICL_DEBUG("offload \"%s\" registered", offload);
264 icl_unregister(const char *offload, bool rdma)
266 struct icl_module *im;
268 sx_xlock(&sc->sc_lock);
269 im = icl_find(offload, rdma, true);
271 ICL_WARN("offload \"%s\" not registered", offload);
272 sx_xunlock(&sc->sc_lock);
276 TAILQ_REMOVE(&sc->sc_modules, im, im_next);
277 sx_xunlock(&sc->sc_lock);
279 free(im->im_name, M_ICL);
282 ICL_DEBUG("offload \"%s\" unregistered", offload);
290 sc = malloc(sizeof(*sc), M_ICL, M_ZERO | M_WAITOK);
291 sx_init(&sc->sc_lock, "icl");
292 TAILQ_INIT(&sc->sc_modules);
301 sx_slock(&sc->sc_lock);
302 KASSERT(TAILQ_EMPTY(&sc->sc_modules), ("still have modules"));
303 sx_sunlock(&sc->sc_lock);
305 sx_destroy(&sc->sc_lock);
312 icl_modevent(module_t mod, int what, void *arg)
319 return (icl_unload());
325 moduledata_t icl_data = {
331 DECLARE_MODULE(icl, icl_data, SI_SUB_DRIVERS, SI_ORDER_FIRST);
332 MODULE_VERSION(icl, 1);