2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2003, 2004 Silicon Graphics International Corp.
5 * Copyright (c) 1997-2007 Kenneth D. Merry
6 * Copyright (c) 2012 The FreeBSD Foundation
7 * Copyright (c) 2017 Jakub Wojciech Klama <jceel@FreeBSD.org>
10 * Portions of this software were developed by Edward Tomasz Napierala
11 * under sponsorship from the FreeBSD Foundation.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions, and the following disclaimer,
18 * without modification.
19 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
20 * substantially similar to the "NO WARRANTY" disclaimer below
21 * ("Disclaimer") and any redistribution must be conditioned upon
22 * including a substantially similar Disclaimer requirement for further
23 * binary redistribution.
26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
29 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
30 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
34 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
35 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 * POSSIBILITY OF SUCH DAMAGES.
40 #include <sys/cdefs.h>
41 __FBSDID("$FreeBSD$");
43 #include <sys/param.h>
44 #include <sys/capsicum.h>
45 #include <sys/callout.h>
46 #include <sys/ioctl.h>
47 #include <sys/linker.h>
48 #include <sys/module.h>
49 #include <sys/queue.h>
55 #include <capsicum_helpers.h>
64 #include <cam/scsi/scsi_all.h>
65 #include <cam/scsi/scsi_message.h>
66 #include <cam/ctl/ctl.h>
67 #include <cam/ctl/ctl_io.h>
68 #include <cam/ctl/ctl_backend.h>
69 #include <cam/ctl/ctl_ioctl.h>
70 #include <cam/ctl/ctl_util.h>
71 #include <cam/ctl/ctl_scsi_all.h>
75 #ifdef ICL_KERNEL_PROXY
79 #define NVLIST_BUFSIZE 1024
81 extern bool proxy_mode;
83 static int ctl_fd = 0;
88 int retval, saved_errno;
90 ctl_fd = open(CTL_DEFAULT_DEV, O_RDWR);
91 if (ctl_fd < 0 && errno == ENOENT) {
93 retval = kldload("ctl");
95 ctl_fd = open(CTL_DEFAULT_DEV, O_RDWR);
100 log_err(1, "failed to open %s", CTL_DEFAULT_DEV);
104 if (modfind("cfiscsi") == -1 && kldload("cfiscsi") == -1)
105 log_warn("couldn't load cfiscsi");
112 * Name/value pair used for per-LUN attributes.
117 STAILQ_ENTRY(cctl_lun_nv) links;
121 * Backend LUN information.
127 uint64_t size_blocks;
132 STAILQ_HEAD(,cctl_lun_nv) attr_list;
133 STAILQ_ENTRY(cctl_lun) links;
143 char *cfiscsi_target;
144 uint16_t cfiscsi_portal_group_tag;
145 char *ctld_portal_group_name;
146 STAILQ_HEAD(,cctl_lun_nv) attr_list;
147 STAILQ_ENTRY(cctl_port) links;
150 struct cctl_devlist_data {
152 STAILQ_HEAD(,cctl_lun) lun_list;
153 struct cctl_lun *cur_lun;
155 STAILQ_HEAD(,cctl_port) port_list;
156 struct cctl_port *cur_port;
158 struct sbuf *cur_sb[32];
162 cctl_start_element(void *user_data, const char *name, const char **attr)
165 struct cctl_devlist_data *devlist;
166 struct cctl_lun *cur_lun;
168 devlist = (struct cctl_devlist_data *)user_data;
169 cur_lun = devlist->cur_lun;
171 if ((u_int)devlist->level >= (sizeof(devlist->cur_sb) /
172 sizeof(devlist->cur_sb[0])))
173 log_errx(1, "%s: too many nesting levels, %zd max", __func__,
174 sizeof(devlist->cur_sb) / sizeof(devlist->cur_sb[0]));
176 devlist->cur_sb[devlist->level] = sbuf_new_auto();
177 if (devlist->cur_sb[devlist->level] == NULL)
178 log_err(1, "%s: unable to allocate sbuf", __func__);
180 if (strcmp(name, "lun") == 0) {
182 log_errx(1, "%s: improper lun element nesting",
185 cur_lun = calloc(1, sizeof(*cur_lun));
187 log_err(1, "%s: cannot allocate %zd bytes", __func__,
191 devlist->cur_lun = cur_lun;
193 STAILQ_INIT(&cur_lun->attr_list);
194 STAILQ_INSERT_TAIL(&devlist->lun_list, cur_lun, links);
196 for (i = 0; attr[i] != NULL; i += 2) {
197 if (strcmp(attr[i], "id") == 0) {
198 cur_lun->lun_id = strtoull(attr[i+1], NULL, 0);
200 log_errx(1, "%s: invalid LUN attribute %s = %s",
201 __func__, attr[i], attr[i+1]);
208 cctl_end_element(void *user_data, const char *name)
210 struct cctl_devlist_data *devlist;
211 struct cctl_lun *cur_lun;
214 devlist = (struct cctl_devlist_data *)user_data;
215 cur_lun = devlist->cur_lun;
217 if ((cur_lun == NULL)
218 && (strcmp(name, "ctllunlist") != 0))
219 log_errx(1, "%s: cur_lun == NULL! (name = %s)", __func__, name);
221 if (devlist->cur_sb[devlist->level] == NULL)
222 log_errx(1, "%s: no valid sbuf at level %d (name %s)", __func__,
223 devlist->level, name);
225 sbuf_finish(devlist->cur_sb[devlist->level]);
226 str = checked_strdup(sbuf_data(devlist->cur_sb[devlist->level]));
228 if (strlen(str) == 0) {
233 sbuf_delete(devlist->cur_sb[devlist->level]);
234 devlist->cur_sb[devlist->level] = NULL;
237 if (strcmp(name, "backend_type") == 0) {
238 cur_lun->backend_type = str;
240 } else if (strcmp(name, "lun_type") == 0) {
242 log_errx(1, "%s: %s missing its argument", __func__, name);
243 cur_lun->device_type = strtoull(str, NULL, 0);
244 } else if (strcmp(name, "size") == 0) {
246 log_errx(1, "%s: %s missing its argument", __func__, name);
247 cur_lun->size_blocks = strtoull(str, NULL, 0);
248 } else if (strcmp(name, "blocksize") == 0) {
250 log_errx(1, "%s: %s missing its argument", __func__, name);
251 cur_lun->blocksize = strtoul(str, NULL, 0);
252 } else if (strcmp(name, "serial_number") == 0) {
253 cur_lun->serial_number = str;
255 } else if (strcmp(name, "device_id") == 0) {
256 cur_lun->device_id = str;
258 } else if (strcmp(name, "ctld_name") == 0) {
259 cur_lun->ctld_name = str;
261 } else if (strcmp(name, "lun") == 0) {
262 devlist->cur_lun = NULL;
263 } else if (strcmp(name, "ctllunlist") == 0) {
266 struct cctl_lun_nv *nv;
268 nv = calloc(1, sizeof(*nv));
270 log_err(1, "%s: can't allocate %zd bytes for nv pair",
271 __func__, sizeof(*nv));
273 nv->name = checked_strdup(name);
277 STAILQ_INSERT_TAIL(&cur_lun->attr_list, nv, links);
284 cctl_start_pelement(void *user_data, const char *name, const char **attr)
287 struct cctl_devlist_data *devlist;
288 struct cctl_port *cur_port;
290 devlist = (struct cctl_devlist_data *)user_data;
291 cur_port = devlist->cur_port;
293 if ((u_int)devlist->level >= (sizeof(devlist->cur_sb) /
294 sizeof(devlist->cur_sb[0])))
295 log_errx(1, "%s: too many nesting levels, %zd max", __func__,
296 sizeof(devlist->cur_sb) / sizeof(devlist->cur_sb[0]));
298 devlist->cur_sb[devlist->level] = sbuf_new_auto();
299 if (devlist->cur_sb[devlist->level] == NULL)
300 log_err(1, "%s: unable to allocate sbuf", __func__);
302 if (strcmp(name, "targ_port") == 0) {
303 if (cur_port != NULL)
304 log_errx(1, "%s: improper port element nesting (%s)",
307 cur_port = calloc(1, sizeof(*cur_port));
308 if (cur_port == NULL)
309 log_err(1, "%s: cannot allocate %zd bytes", __func__,
312 devlist->num_ports++;
313 devlist->cur_port = cur_port;
315 STAILQ_INIT(&cur_port->attr_list);
316 STAILQ_INSERT_TAIL(&devlist->port_list, cur_port, links);
318 for (i = 0; attr[i] != NULL; i += 2) {
319 if (strcmp(attr[i], "id") == 0) {
320 cur_port->port_id = strtoul(attr[i+1], NULL, 0);
322 log_errx(1, "%s: invalid LUN attribute %s = %s",
323 __func__, attr[i], attr[i+1]);
330 cctl_end_pelement(void *user_data, const char *name)
332 struct cctl_devlist_data *devlist;
333 struct cctl_port *cur_port;
336 devlist = (struct cctl_devlist_data *)user_data;
337 cur_port = devlist->cur_port;
339 if ((cur_port == NULL)
340 && (strcmp(name, "ctlportlist") != 0))
341 log_errx(1, "%s: cur_port == NULL! (name = %s)", __func__, name);
343 if (devlist->cur_sb[devlist->level] == NULL)
344 log_errx(1, "%s: no valid sbuf at level %d (name %s)", __func__,
345 devlist->level, name);
347 sbuf_finish(devlist->cur_sb[devlist->level]);
348 str = checked_strdup(sbuf_data(devlist->cur_sb[devlist->level]));
350 if (strlen(str) == 0) {
355 sbuf_delete(devlist->cur_sb[devlist->level]);
356 devlist->cur_sb[devlist->level] = NULL;
359 if (strcmp(name, "frontend_type") == 0) {
360 cur_port->port_frontend = str;
362 } else if (strcmp(name, "port_name") == 0) {
363 cur_port->port_name = str;
365 } else if (strcmp(name, "physical_port") == 0) {
367 log_errx(1, "%s: %s missing its argument", __func__, name);
368 cur_port->pp = strtoul(str, NULL, 0);
369 } else if (strcmp(name, "virtual_port") == 0) {
371 log_errx(1, "%s: %s missing its argument", __func__, name);
372 cur_port->vp = strtoul(str, NULL, 0);
373 } else if (strcmp(name, "cfiscsi_target") == 0) {
374 cur_port->cfiscsi_target = str;
376 } else if (strcmp(name, "cfiscsi_state") == 0) {
378 log_errx(1, "%s: %s missing its argument", __func__, name);
379 cur_port->cfiscsi_state = strtoul(str, NULL, 0);
380 } else if (strcmp(name, "cfiscsi_portal_group_tag") == 0) {
382 log_errx(1, "%s: %s missing its argument", __func__, name);
383 cur_port->cfiscsi_portal_group_tag = strtoul(str, NULL, 0);
384 } else if (strcmp(name, "ctld_portal_group_name") == 0) {
385 cur_port->ctld_portal_group_name = str;
387 } else if (strcmp(name, "targ_port") == 0) {
388 devlist->cur_port = NULL;
389 } else if (strcmp(name, "ctlportlist") == 0) {
392 struct cctl_lun_nv *nv;
394 nv = calloc(1, sizeof(*nv));
396 log_err(1, "%s: can't allocate %zd bytes for nv pair",
397 __func__, sizeof(*nv));
399 nv->name = checked_strdup(name);
403 STAILQ_INSERT_TAIL(&cur_port->attr_list, nv, links);
410 cctl_char_handler(void *user_data, const XML_Char *str, int len)
412 struct cctl_devlist_data *devlist;
414 devlist = (struct cctl_devlist_data *)user_data;
416 sbuf_bcat(devlist->cur_sb[devlist->level], str, len);
420 conf_new_from_kernel(void)
422 struct conf *conf = NULL;
424 struct portal_group *pg;
429 struct ctl_lun_list list;
430 struct cctl_devlist_data devlist;
431 struct cctl_lun *lun;
432 struct cctl_port *port;
437 bzero(&devlist, sizeof(devlist));
438 STAILQ_INIT(&devlist.lun_list);
439 STAILQ_INIT(&devlist.port_list);
441 log_debugx("obtaining previously configured CTL luns from the kernel");
446 str = realloc(str, len);
448 log_err(1, "realloc");
450 bzero(&list, sizeof(list));
451 list.alloc_len = len;
452 list.status = CTL_LUN_LIST_NONE;
455 if (ioctl(ctl_fd, CTL_LUN_LIST, &list) == -1) {
456 log_warn("error issuing CTL_LUN_LIST ioctl");
461 if (list.status == CTL_LUN_LIST_ERROR) {
462 log_warnx("error returned from CTL_LUN_LIST ioctl: %s",
468 if (list.status == CTL_LUN_LIST_NEED_MORE_SPACE) {
473 parser = XML_ParserCreate(NULL);
474 if (parser == NULL) {
475 log_warnx("unable to create XML parser");
480 XML_SetUserData(parser, &devlist);
481 XML_SetElementHandler(parser, cctl_start_element, cctl_end_element);
482 XML_SetCharacterDataHandler(parser, cctl_char_handler);
484 retval = XML_Parse(parser, str, strlen(str), 1);
485 XML_ParserFree(parser);
488 log_warnx("XML_Parse failed");
495 str = realloc(str, len);
497 log_err(1, "realloc");
499 bzero(&list, sizeof(list));
500 list.alloc_len = len;
501 list.status = CTL_LUN_LIST_NONE;
504 if (ioctl(ctl_fd, CTL_PORT_LIST, &list) == -1) {
505 log_warn("error issuing CTL_PORT_LIST ioctl");
510 if (list.status == CTL_LUN_LIST_ERROR) {
511 log_warnx("error returned from CTL_PORT_LIST ioctl: %s",
517 if (list.status == CTL_LUN_LIST_NEED_MORE_SPACE) {
522 parser = XML_ParserCreate(NULL);
523 if (parser == NULL) {
524 log_warnx("unable to create XML parser");
529 XML_SetUserData(parser, &devlist);
530 XML_SetElementHandler(parser, cctl_start_pelement, cctl_end_pelement);
531 XML_SetCharacterDataHandler(parser, cctl_char_handler);
533 retval = XML_Parse(parser, str, strlen(str), 1);
534 XML_ParserFree(parser);
537 log_warnx("XML_Parse failed");
544 STAILQ_FOREACH(port, &devlist.port_list, links) {
545 if (strcmp(port->port_frontend, "ha") == 0)
548 if (port->pp == 0 && port->vp == 0) {
549 name = checked_strdup(port->port_name);
550 } else if (port->vp == 0) {
551 retval = asprintf(&name, "%s/%d",
552 port->port_name, port->pp);
554 log_err(1, "asprintf");
556 retval = asprintf(&name, "%s/%d/%d",
557 port->port_name, port->pp, port->vp);
559 log_err(1, "asprintf");
562 if (port->cfiscsi_target == NULL) {
563 log_debugx("CTL port %u \"%s\" wasn't managed by ctld; ",
564 port->port_id, name);
565 pp = pport_find(conf, name);
568 log_debugx("found new kernel port %u \"%s\"",
569 port->port_id, name);
571 pp = pport_new(conf, name, port->port_id);
573 log_warnx("pport_new failed");
579 if (port->cfiscsi_state != 1) {
580 log_debugx("CTL port %ju is not active (%d); ignoring",
581 (uintmax_t)port->port_id, port->cfiscsi_state);
585 targ = target_find(conf, port->cfiscsi_target);
588 log_debugx("found new kernel target %s for CTL port %ld",
589 port->cfiscsi_target, port->port_id);
591 targ = target_new(conf, port->cfiscsi_target);
593 log_warnx("target_new failed");
598 if (port->ctld_portal_group_name == NULL)
600 pg = portal_group_find(conf, port->ctld_portal_group_name);
603 log_debugx("found new kernel portal group %s for CTL port %ld",
604 port->ctld_portal_group_name, port->port_id);
606 pg = portal_group_new(conf, port->ctld_portal_group_name);
608 log_warnx("portal_group_new failed");
612 pg->pg_tag = port->cfiscsi_portal_group_tag;
613 cp = port_new(conf, targ, pg);
615 log_warnx("port_new failed");
618 cp->p_ctl_port = port->port_id;
622 STAILQ_FOREACH(lun, &devlist.lun_list, links) {
623 struct cctl_lun_nv *nv;
625 if (lun->ctld_name == NULL) {
626 log_debugx("CTL lun %ju wasn't managed by ctld; "
627 "ignoring", (uintmax_t)lun->lun_id);
631 cl = lun_find(conf, lun->ctld_name);
633 log_warnx("found CTL lun %ju \"%s\", "
634 "also backed by CTL lun %d; ignoring",
635 (uintmax_t)lun->lun_id, lun->ctld_name,
640 log_debugx("found CTL lun %ju \"%s\"",
641 (uintmax_t)lun->lun_id, lun->ctld_name);
643 cl = lun_new(conf, lun->ctld_name);
645 log_warnx("lun_new failed");
648 lun_set_backend(cl, lun->backend_type);
649 lun_set_device_type(cl, lun->device_type);
650 lun_set_blocksize(cl, lun->blocksize);
651 lun_set_device_id(cl, lun->device_id);
652 lun_set_serial(cl, lun->serial_number);
653 lun_set_size(cl, lun->size_blocks * cl->l_blocksize);
654 lun_set_ctl_lun(cl, lun->lun_id);
656 STAILQ_FOREACH(nv, &lun->attr_list, links) {
657 if (strcmp(nv->name, "file") == 0 ||
658 strcmp(nv->name, "dev") == 0) {
659 lun_set_path(cl, nv->value);
662 o = option_new(&cl->l_options, nv->name, nv->value);
664 log_warnx("unable to add CTL lun option %s "
665 "for CTL lun %ju \"%s\"",
666 nv->name, (uintmax_t) lun->lun_id,
675 kernel_lun_add(struct lun *lun)
678 struct ctl_lun_req req;
681 bzero(&req, sizeof(req));
683 strlcpy(req.backend, lun->l_backend, sizeof(req.backend));
684 req.reqtype = CTL_LUNREQ_CREATE;
686 req.reqdata.create.blocksize_bytes = lun->l_blocksize;
688 if (lun->l_size != 0)
689 req.reqdata.create.lun_size_bytes = lun->l_size;
691 if (lun->l_ctl_lun >= 0) {
692 req.reqdata.create.req_lun_id = lun->l_ctl_lun;
693 req.reqdata.create.flags |= CTL_LUN_FLAG_ID_REQ;
696 req.reqdata.create.flags |= CTL_LUN_FLAG_DEV_TYPE;
697 req.reqdata.create.device_type = lun->l_device_type;
699 if (lun->l_serial != NULL) {
700 strncpy(req.reqdata.create.serial_num, lun->l_serial,
701 sizeof(req.reqdata.create.serial_num));
702 req.reqdata.create.flags |= CTL_LUN_FLAG_SERIAL_NUM;
705 if (lun->l_device_id != NULL) {
706 strncpy(req.reqdata.create.device_id, lun->l_device_id,
707 sizeof(req.reqdata.create.device_id));
708 req.reqdata.create.flags |= CTL_LUN_FLAG_DEVID;
711 if (lun->l_path != NULL) {
712 o = option_find(&lun->l_options, "file");
714 option_set(o, lun->l_path);
716 o = option_new(&lun->l_options, "file", lun->l_path);
721 o = option_find(&lun->l_options, "ctld_name");
723 option_set(o, lun->l_name);
725 o = option_new(&lun->l_options, "ctld_name", lun->l_name);
729 o = option_find(&lun->l_options, "scsiname");
730 if (o == NULL && lun->l_scsiname != NULL) {
731 o = option_new(&lun->l_options, "scsiname", lun->l_scsiname);
735 if (!TAILQ_EMPTY(&lun->l_options)) {
736 req.args_nvl = nvlist_create(0);
737 if (req.args_nvl == NULL) {
738 log_warn("error allocating nvlist");
742 TAILQ_FOREACH(o, &lun->l_options, o_next)
743 nvlist_add_string(req.args_nvl, o->o_name, o->o_value);
745 req.args = nvlist_pack(req.args_nvl, &req.args_len);
746 if (req.args == NULL) {
747 log_warn("error packing nvlist");
752 error = ioctl(ctl_fd, CTL_LUN_REQ, &req);
753 nvlist_destroy(req.args_nvl);
756 log_warn("error issuing CTL_LUN_REQ ioctl");
760 switch (req.status) {
762 log_warnx("LUN creation error: %s", req.error_str);
764 case CTL_LUN_WARNING:
765 log_warnx("LUN creation warning: %s", req.error_str);
770 log_warnx("unknown LUN creation status: %d",
775 lun_set_ctl_lun(lun, req.reqdata.create.req_lun_id);
780 kernel_lun_modify(struct lun *lun)
783 struct ctl_lun_req req;
786 bzero(&req, sizeof(req));
788 strlcpy(req.backend, lun->l_backend, sizeof(req.backend));
789 req.reqtype = CTL_LUNREQ_MODIFY;
791 req.reqdata.modify.lun_id = lun->l_ctl_lun;
792 req.reqdata.modify.lun_size_bytes = lun->l_size;
794 if (lun->l_path != NULL) {
795 o = option_find(&lun->l_options, "file");
797 option_set(o, lun->l_path);
799 o = option_new(&lun->l_options, "file", lun->l_path);
804 o = option_find(&lun->l_options, "ctld_name");
806 option_set(o, lun->l_name);
808 o = option_new(&lun->l_options, "ctld_name", lun->l_name);
812 o = option_find(&lun->l_options, "scsiname");
813 if (o == NULL && lun->l_scsiname != NULL) {
814 o = option_new(&lun->l_options, "scsiname", lun->l_scsiname);
818 if (!TAILQ_EMPTY(&lun->l_options)) {
819 req.args_nvl = nvlist_create(0);
820 if (req.args_nvl == NULL) {
821 log_warn("error allocating nvlist");
825 TAILQ_FOREACH(o, &lun->l_options, o_next)
826 nvlist_add_string(req.args_nvl, o->o_name, o->o_value);
828 req.args = nvlist_pack(req.args_nvl, &req.args_len);
829 if (req.args == NULL) {
830 log_warn("error packing nvlist");
835 error = ioctl(ctl_fd, CTL_LUN_REQ, &req);
836 nvlist_destroy(req.args_nvl);
839 log_warn("error issuing CTL_LUN_REQ ioctl");
843 switch (req.status) {
845 log_warnx("LUN modification error: %s", req.error_str);
847 case CTL_LUN_WARNING:
848 log_warnx("LUN modification warning: %s", req.error_str);
853 log_warnx("unknown LUN modification status: %d",
862 kernel_lun_remove(struct lun *lun)
864 struct ctl_lun_req req;
866 bzero(&req, sizeof(req));
868 strlcpy(req.backend, lun->l_backend, sizeof(req.backend));
869 req.reqtype = CTL_LUNREQ_RM;
871 req.reqdata.rm.lun_id = lun->l_ctl_lun;
873 if (ioctl(ctl_fd, CTL_LUN_REQ, &req) == -1) {
874 log_warn("error issuing CTL_LUN_REQ ioctl");
878 switch (req.status) {
880 log_warnx("LUN removal error: %s", req.error_str);
882 case CTL_LUN_WARNING:
883 log_warnx("LUN removal warning: %s", req.error_str);
888 log_warnx("unknown LUN removal status: %d", req.status);
896 kernel_handoff(struct ctld_connection *conn)
898 struct ctl_iscsi req;
900 bzero(&req, sizeof(req));
902 req.type = CTL_ISCSI_HANDOFF;
903 strlcpy(req.data.handoff.initiator_name,
904 conn->conn_initiator_name, sizeof(req.data.handoff.initiator_name));
905 strlcpy(req.data.handoff.initiator_addr,
906 conn->conn_initiator_addr, sizeof(req.data.handoff.initiator_addr));
907 if (conn->conn_initiator_alias != NULL) {
908 strlcpy(req.data.handoff.initiator_alias,
909 conn->conn_initiator_alias, sizeof(req.data.handoff.initiator_alias));
911 memcpy(req.data.handoff.initiator_isid, conn->conn_initiator_isid,
912 sizeof(req.data.handoff.initiator_isid));
913 strlcpy(req.data.handoff.target_name,
914 conn->conn_target->t_name, sizeof(req.data.handoff.target_name));
915 if (conn->conn_portal->p_portal_group->pg_offload != NULL) {
916 strlcpy(req.data.handoff.offload,
917 conn->conn_portal->p_portal_group->pg_offload,
918 sizeof(req.data.handoff.offload));
920 #ifdef ICL_KERNEL_PROXY
922 req.data.handoff.connection_id = conn->conn.conn_socket;
924 req.data.handoff.socket = conn->conn.conn_socket;
926 req.data.handoff.socket = conn->conn.conn_socket;
928 req.data.handoff.portal_group_tag =
929 conn->conn_portal->p_portal_group->pg_tag;
930 if (conn->conn.conn_header_digest == CONN_DIGEST_CRC32C)
931 req.data.handoff.header_digest = CTL_ISCSI_DIGEST_CRC32C;
932 if (conn->conn.conn_data_digest == CONN_DIGEST_CRC32C)
933 req.data.handoff.data_digest = CTL_ISCSI_DIGEST_CRC32C;
934 req.data.handoff.cmdsn = conn->conn.conn_cmdsn;
935 req.data.handoff.statsn = conn->conn.conn_statsn;
936 req.data.handoff.max_recv_data_segment_length =
937 conn->conn.conn_max_recv_data_segment_length;
938 req.data.handoff.max_send_data_segment_length =
939 conn->conn.conn_max_send_data_segment_length;
940 req.data.handoff.max_burst_length = conn->conn.conn_max_burst_length;
941 req.data.handoff.first_burst_length =
942 conn->conn.conn_first_burst_length;
943 req.data.handoff.immediate_data = conn->conn.conn_immediate_data;
945 if (ioctl(ctl_fd, CTL_ISCSI, &req) == -1) {
946 log_err(1, "error issuing CTL_ISCSI ioctl; "
947 "dropping connection");
950 if (req.status != CTL_ISCSI_OK) {
951 log_errx(1, "error returned from CTL iSCSI handoff request: "
952 "%s; dropping connection", req.error_str);
957 kernel_limits(const char *offload, int s, int *max_recv_dsl, int *max_send_dsl,
958 int *max_burst_length, int *first_burst_length)
960 struct ctl_iscsi req;
961 struct ctl_iscsi_limits_params *cilp;
963 bzero(&req, sizeof(req));
965 req.type = CTL_ISCSI_LIMITS;
966 cilp = (struct ctl_iscsi_limits_params *)&(req.data.limits);
967 if (offload != NULL) {
968 strlcpy(cilp->offload, offload, sizeof(cilp->offload));
972 if (ioctl(ctl_fd, CTL_ISCSI, &req) == -1) {
973 log_err(1, "error issuing CTL_ISCSI ioctl; "
974 "dropping connection");
977 if (req.status != CTL_ISCSI_OK) {
978 log_errx(1, "error returned from CTL iSCSI limits request: "
979 "%s; dropping connection", req.error_str);
982 if (cilp->max_recv_data_segment_length != 0) {
983 *max_recv_dsl = cilp->max_recv_data_segment_length;
984 *max_send_dsl = cilp->max_recv_data_segment_length;
986 if (cilp->max_send_data_segment_length != 0)
987 *max_send_dsl = cilp->max_send_data_segment_length;
988 if (cilp->max_burst_length != 0)
989 *max_burst_length = cilp->max_burst_length;
990 if (cilp->first_burst_length != 0)
991 *first_burst_length = cilp->first_burst_length;
992 if (*max_burst_length < *first_burst_length)
993 *first_burst_length = *max_burst_length;
995 if (offload != NULL) {
996 log_debugx("Kernel limits for offload \"%s\" are "
997 "MaxRecvDataSegment=%d, max_send_dsl=%d, "
998 "MaxBurstLength=%d, FirstBurstLength=%d",
999 offload, *max_recv_dsl, *max_send_dsl, *max_burst_length,
1000 *first_burst_length);
1002 log_debugx("Kernel limits are "
1003 "MaxRecvDataSegment=%d, max_send_dsl=%d, "
1004 "MaxBurstLength=%d, FirstBurstLength=%d",
1005 *max_recv_dsl, *max_send_dsl, *max_burst_length,
1006 *first_burst_length);
1011 kernel_port_add(struct port *port)
1014 struct ctl_port_entry entry;
1016 struct ctl_lun_map lm;
1017 struct target *targ = port->p_target;
1018 struct portal_group *pg = port->p_portal_group;
1019 char result_buf[NVLIST_BUFSIZE];
1022 /* Create iSCSI port. */
1023 if (port->p_portal_group || port->p_ioctl_port) {
1024 bzero(&req, sizeof(req));
1025 req.reqtype = CTL_REQ_CREATE;
1027 if (port->p_portal_group) {
1028 strlcpy(req.driver, "iscsi", sizeof(req.driver));
1029 req.args_nvl = nvlist_create(0);
1030 nvlist_add_string(req.args_nvl, "cfiscsi_target",
1032 nvlist_add_string(req.args_nvl,
1033 "ctld_portal_group_name", pg->pg_name);
1034 nvlist_add_stringf(req.args_nvl,
1035 "cfiscsi_portal_group_tag", "%u", pg->pg_tag);
1037 if (targ->t_alias) {
1038 nvlist_add_string(req.args_nvl,
1039 "cfiscsi_target_alias", targ->t_alias);
1042 TAILQ_FOREACH(o, &pg->pg_options, o_next)
1043 nvlist_add_string(req.args_nvl, o->o_name,
1047 if (port->p_ioctl_port) {
1048 strlcpy(req.driver, "ioctl", sizeof(req.driver));
1049 req.args_nvl = nvlist_create(0);
1050 nvlist_add_stringf(req.args_nvl, "pp", "%d",
1052 nvlist_add_stringf(req.args_nvl, "vp", "%d",
1056 req.args = nvlist_pack(req.args_nvl, &req.args_len);
1057 if (req.args == NULL) {
1058 log_warn("error packing nvlist");
1062 req.result = result_buf;
1063 req.result_len = sizeof(result_buf);
1064 error = ioctl(ctl_fd, CTL_PORT_REQ, &req);
1065 nvlist_destroy(req.args_nvl);
1068 log_warn("error issuing CTL_PORT_REQ ioctl");
1071 if (req.status == CTL_LUN_ERROR) {
1072 log_warnx("error returned from port creation request: %s",
1076 if (req.status != CTL_LUN_OK) {
1077 log_warnx("unknown port creation request status %d",
1082 req.result_nvl = nvlist_unpack(result_buf, req.result_len, 0);
1083 if (req.result_nvl == NULL) {
1084 log_warnx("error unpacking result nvlist");
1088 port->p_ctl_port = nvlist_get_number(req.result_nvl, "port_id");
1089 nvlist_destroy(req.result_nvl);
1090 } else if (port->p_pport) {
1091 port->p_ctl_port = port->p_pport->pp_ctl_port;
1093 if (strncmp(targ->t_name, "naa.", 4) == 0 &&
1094 strlen(targ->t_name) == 20) {
1095 bzero(&entry, sizeof(entry));
1096 entry.port_type = CTL_PORT_NONE;
1097 entry.targ_port = port->p_ctl_port;
1098 entry.flags |= CTL_PORT_WWNN_VALID;
1099 entry.wwnn = strtoull(targ->t_name + 4, NULL, 16);
1100 if (ioctl(ctl_fd, CTL_SET_PORT_WWNS, &entry) == -1)
1101 log_warn("CTL_SET_PORT_WWNS ioctl failed");
1105 /* Explicitly enable mapping to block any access except allowed. */
1106 lm.port = port->p_ctl_port;
1107 lm.plun = UINT32_MAX;
1109 error = ioctl(ctl_fd, CTL_LUN_MAP, &lm);
1111 log_warn("CTL_LUN_MAP ioctl failed");
1113 /* Map configured LUNs */
1114 for (i = 0; i < MAX_LUNS; i++) {
1115 if (targ->t_luns[i] == NULL)
1117 lm.port = port->p_ctl_port;
1119 lm.lun = targ->t_luns[i]->l_ctl_lun;
1120 error = ioctl(ctl_fd, CTL_LUN_MAP, &lm);
1122 log_warn("CTL_LUN_MAP ioctl failed");
1126 bzero(&entry, sizeof(entry));
1127 entry.targ_port = port->p_ctl_port;
1128 error = ioctl(ctl_fd, CTL_ENABLE_PORT, &entry);
1130 log_warn("CTL_ENABLE_PORT ioctl failed");
1138 kernel_port_update(struct port *port, struct port *oport)
1140 struct ctl_lun_map lm;
1141 struct target *targ = port->p_target;
1142 struct target *otarg = oport->p_target;
1146 /* Map configured LUNs and unmap others */
1147 for (i = 0; i < MAX_LUNS; i++) {
1148 lm.port = port->p_ctl_port;
1150 if (targ->t_luns[i] == NULL)
1151 lm.lun = UINT32_MAX;
1153 lm.lun = targ->t_luns[i]->l_ctl_lun;
1154 if (otarg->t_luns[i] == NULL)
1157 olun = otarg->t_luns[i]->l_ctl_lun;
1160 error = ioctl(ctl_fd, CTL_LUN_MAP, &lm);
1162 log_warn("CTL_LUN_MAP ioctl failed");
1168 kernel_port_remove(struct port *port)
1170 struct ctl_port_entry entry;
1171 struct ctl_lun_map lm;
1173 struct target *targ = port->p_target;
1174 struct portal_group *pg = port->p_portal_group;
1178 bzero(&entry, sizeof(entry));
1179 entry.targ_port = port->p_ctl_port;
1180 error = ioctl(ctl_fd, CTL_DISABLE_PORT, &entry);
1182 log_warn("CTL_DISABLE_PORT ioctl failed");
1186 /* Remove iSCSI or ioctl port. */
1187 if (port->p_portal_group || port->p_ioctl_port) {
1188 bzero(&req, sizeof(req));
1189 strlcpy(req.driver, port->p_ioctl_port ? "ioctl" : "iscsi",
1190 sizeof(req.driver));
1191 req.reqtype = CTL_REQ_REMOVE;
1192 req.args_nvl = nvlist_create(0);
1193 if (req.args_nvl == NULL)
1194 log_err(1, "nvlist_create");
1196 if (port->p_ioctl_port)
1197 nvlist_add_stringf(req.args_nvl, "port_id", "%d",
1200 nvlist_add_string(req.args_nvl, "cfiscsi_target",
1202 nvlist_add_stringf(req.args_nvl,
1203 "cfiscsi_portal_group_tag", "%u", pg->pg_tag);
1206 req.args = nvlist_pack(req.args_nvl, &req.args_len);
1207 if (req.args == NULL) {
1208 log_warn("error packing nvlist");
1212 error = ioctl(ctl_fd, CTL_PORT_REQ, &req);
1213 nvlist_destroy(req.args_nvl);
1216 log_warn("error issuing CTL_PORT_REQ ioctl");
1219 if (req.status == CTL_LUN_ERROR) {
1220 log_warnx("error returned from port removal request: %s",
1224 if (req.status != CTL_LUN_OK) {
1225 log_warnx("unknown port removal request status %d",
1230 /* Disable LUN mapping. */
1231 lm.port = port->p_ctl_port;
1232 lm.plun = UINT32_MAX;
1233 lm.lun = UINT32_MAX;
1234 error = ioctl(ctl_fd, CTL_LUN_MAP, &lm);
1236 log_warn("CTL_LUN_MAP ioctl failed");
1241 #ifdef ICL_KERNEL_PROXY
1243 kernel_listen(struct addrinfo *ai, bool iser, int portal_id)
1245 struct ctl_iscsi req;
1247 bzero(&req, sizeof(req));
1249 req.type = CTL_ISCSI_LISTEN;
1250 req.data.listen.iser = iser;
1251 req.data.listen.domain = ai->ai_family;
1252 req.data.listen.socktype = ai->ai_socktype;
1253 req.data.listen.protocol = ai->ai_protocol;
1254 req.data.listen.addr = ai->ai_addr;
1255 req.data.listen.addrlen = ai->ai_addrlen;
1256 req.data.listen.portal_id = portal_id;
1258 if (ioctl(ctl_fd, CTL_ISCSI, &req) == -1)
1259 log_err(1, "error issuing CTL_ISCSI ioctl");
1261 if (req.status != CTL_ISCSI_OK) {
1262 log_errx(1, "error returned from CTL iSCSI listen: %s",
1268 kernel_accept(int *connection_id, int *portal_id,
1269 struct sockaddr *client_sa, socklen_t *client_salen)
1271 struct ctl_iscsi req;
1272 struct sockaddr_storage ss;
1274 bzero(&req, sizeof(req));
1276 req.type = CTL_ISCSI_ACCEPT;
1277 req.data.accept.initiator_addr = (struct sockaddr *)&ss;
1279 if (ioctl(ctl_fd, CTL_ISCSI, &req) == -1)
1280 log_err(1, "error issuing CTL_ISCSI ioctl");
1282 if (req.status != CTL_ISCSI_OK) {
1283 log_errx(1, "error returned from CTL iSCSI accept: %s",
1287 *connection_id = req.data.accept.connection_id;
1288 *portal_id = req.data.accept.portal_id;
1289 *client_salen = req.data.accept.initiator_addrlen;
1290 memcpy(client_sa, &ss, *client_salen);
1294 kernel_send(struct pdu *pdu)
1296 struct ctl_iscsi req;
1298 bzero(&req, sizeof(req));
1300 req.type = CTL_ISCSI_SEND;
1301 req.data.send.connection_id = pdu->pdu_connection->conn_socket;
1302 req.data.send.bhs = pdu->pdu_bhs;
1303 req.data.send.data_segment_len = pdu->pdu_data_len;
1304 req.data.send.data_segment = pdu->pdu_data;
1306 if (ioctl(ctl_fd, CTL_ISCSI, &req) == -1) {
1307 log_err(1, "error issuing CTL_ISCSI ioctl; "
1308 "dropping connection");
1311 if (req.status != CTL_ISCSI_OK) {
1312 log_errx(1, "error returned from CTL iSCSI send: "
1313 "%s; dropping connection", req.error_str);
1318 kernel_receive(struct pdu *pdu)
1320 struct connection *conn;
1321 struct ctl_iscsi req;
1323 conn = pdu->pdu_connection;
1324 pdu->pdu_data = malloc(conn->conn_max_recv_data_segment_length);
1325 if (pdu->pdu_data == NULL)
1326 log_err(1, "malloc");
1328 bzero(&req, sizeof(req));
1330 req.type = CTL_ISCSI_RECEIVE;
1331 req.data.receive.connection_id = conn->conn_socket;
1332 req.data.receive.bhs = pdu->pdu_bhs;
1333 req.data.receive.data_segment_len =
1334 conn->conn_max_recv_data_segment_length;
1335 req.data.receive.data_segment = pdu->pdu_data;
1337 if (ioctl(ctl_fd, CTL_ISCSI, &req) == -1) {
1338 log_err(1, "error issuing CTL_ISCSI ioctl; "
1339 "dropping connection");
1342 if (req.status != CTL_ISCSI_OK) {
1343 log_errx(1, "error returned from CTL iSCSI receive: "
1344 "%s; dropping connection", req.error_str);
1349 #endif /* ICL_KERNEL_PROXY */
1352 * XXX: I CANT INTO LATIN
1355 kernel_capsicate(void)
1357 cap_rights_t rights;
1358 const unsigned long cmds[] = { CTL_ISCSI };
1360 cap_rights_init(&rights, CAP_IOCTL);
1361 if (caph_rights_limit(ctl_fd, &rights) < 0)
1362 log_err(1, "cap_rights_limit");
1364 if (caph_ioctls_limit(ctl_fd, cmds, nitems(cmds)) < 0)
1365 log_err(1, "cap_ioctls_limit");
1367 if (caph_enter() < 0)
1368 log_err(1, "cap_enter");
1370 if (cap_sandboxed())
1371 log_debugx("Capsicum capability mode enabled");
1373 log_warnx("Capsicum capability mode not supported");