]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - usr.sbin/iscsid/iscsid.c
Add UPDATING entries and bump version.
[FreeBSD/FreeBSD.git] / usr.sbin / iscsid / iscsid.c
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2012 The FreeBSD Foundation
5  * All rights reserved.
6  *
7  * This software was developed by Edward Tomasz Napierala under sponsorship
8  * from the FreeBSD Foundation.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
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.
18  *
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
29  * SUCH DAMAGE.
30  *
31  */
32
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
35
36 #include <sys/types.h>
37 #include <sys/time.h>
38 #include <sys/ioctl.h>
39 #include <sys/param.h>
40 #include <sys/linker.h>
41 #include <sys/socket.h>
42 #include <sys/capsicum.h>
43 #include <sys/wait.h>
44 #include <netinet/in.h>
45 #include <assert.h>
46 #include <errno.h>
47 #include <fcntl.h>
48 #include <libutil.h>
49 #include <netdb.h>
50 #include <signal.h>
51 #include <stdbool.h>
52 #include <stdint.h>
53 #include <stdio.h>
54 #include <stdlib.h>
55 #include <string.h>
56 #include <unistd.h>
57
58 #include "iscsid.h"
59
60 static volatile bool sigalrm_received = false;
61
62 static int nchildren = 0;
63
64 static void
65 usage(void)
66 {
67
68         fprintf(stderr, "usage: iscsid [-P pidfile][-d][-m maxproc][-t timeout]\n");
69         exit(1);
70 }
71
72 char *
73 checked_strdup(const char *s)
74 {
75         char *c;
76
77         c = strdup(s);
78         if (c == NULL)
79                 log_err(1, "strdup");
80         return (c);
81 }
82
83 static void
84 resolve_addr(const struct connection *conn, const char *address,
85     struct addrinfo **ai, bool initiator_side)
86 {
87         struct addrinfo hints;
88         char *arg, *addr, *ch;
89         const char *port;
90         int error, colons = 0;
91
92         arg = checked_strdup(address);
93
94         if (arg[0] == '\0') {
95                 fail(conn, "empty address");
96                 log_errx(1, "empty address");
97         }
98         if (arg[0] == '[') {
99                 /*
100                  * IPv6 address in square brackets, perhaps with port.
101                  */
102                 arg++;
103                 addr = strsep(&arg, "]");
104                 if (arg == NULL) {
105                         fail(conn, "malformed address");
106                         log_errx(1, "malformed address %s", address);
107                 }
108                 if (arg[0] == '\0') {
109                         port = NULL;
110                 } else if (arg[0] == ':') {
111                         port = arg + 1;
112                 } else {
113                         fail(conn, "malformed address");
114                         log_errx(1, "malformed address %s", address);
115                 }
116         } else {
117                 /*
118                  * Either IPv6 address without brackets - and without
119                  * a port - or IPv4 address.  Just count the colons.
120                  */
121                 for (ch = arg; *ch != '\0'; ch++) {
122                         if (*ch == ':')
123                                 colons++;
124                 }
125                 if (colons > 1) {
126                         addr = arg;
127                         port = NULL;
128                 } else {
129                         addr = strsep(&arg, ":");
130                         if (arg == NULL)
131                                 port = NULL;
132                         else
133                                 port = arg;
134                 }
135         }
136
137         if (port == NULL && !initiator_side)
138                 port = "3260";
139
140         memset(&hints, 0, sizeof(hints));
141         hints.ai_family = PF_UNSPEC;
142         hints.ai_socktype = SOCK_STREAM;
143         hints.ai_flags = AI_ADDRCONFIG | AI_NUMERICSERV;
144         if (initiator_side)
145                 hints.ai_flags |= AI_PASSIVE;
146
147         error = getaddrinfo(addr, port, &hints, ai);
148         if (error != 0) {
149                 fail(conn, gai_strerror(error));
150                 log_errx(1, "getaddrinfo for %s failed: %s",
151                     address, gai_strerror(error));
152         }
153 }
154
155 static struct connection *
156 connection_new(int iscsi_fd, const struct iscsi_daemon_request *request)
157 {
158         struct connection *conn;
159         struct iscsi_session_limits *isl;
160         struct addrinfo *from_ai, *to_ai;
161         const char *from_addr, *to_addr;
162 #ifdef ICL_KERNEL_PROXY
163         struct iscsi_daemon_connect idc;
164 #endif
165         int error, sockbuf;
166
167         conn = calloc(1, sizeof(*conn));
168         if (conn == NULL)
169                 log_err(1, "calloc");
170
171         /*
172          * Default values, from RFC 3720, section 12.
173          */
174         conn->conn_protocol_level = 0;
175         conn->conn_header_digest = CONN_DIGEST_NONE;
176         conn->conn_data_digest = CONN_DIGEST_NONE;
177         conn->conn_initial_r2t = true;
178         conn->conn_immediate_data = true;
179         conn->conn_max_recv_data_segment_length = 8192;
180         conn->conn_max_send_data_segment_length = 8192;
181         conn->conn_max_burst_length = 262144;
182         conn->conn_first_burst_length = 65536;
183         conn->conn_iscsi_fd = iscsi_fd;
184
185         conn->conn_session_id = request->idr_session_id;
186         memcpy(&conn->conn_conf, &request->idr_conf, sizeof(conn->conn_conf));
187         memcpy(&conn->conn_isid, &request->idr_isid, sizeof(conn->conn_isid));
188         conn->conn_tsih = request->idr_tsih;
189
190         /*
191          * Read the driver limits and provide reasonable defaults for the ones
192          * the driver doesn't care about.  If a max_snd_dsl is not explicitly
193          * provided by the driver then we'll make sure both conn->max_snd_dsl
194          * and isl->max_snd_dsl are set to the rcv_dsl.  This preserves historic
195          * behavior.
196          */
197         isl = &conn->conn_limits;
198         memcpy(isl, &request->idr_limits, sizeof(*isl));
199         if (isl->isl_max_recv_data_segment_length == 0)
200                 isl->isl_max_recv_data_segment_length = (1 << 24) - 1;
201         if (isl->isl_max_send_data_segment_length == 0)
202                 isl->isl_max_send_data_segment_length =
203                     isl->isl_max_recv_data_segment_length;
204         if (isl->isl_max_burst_length == 0)
205                 isl->isl_max_burst_length = (1 << 24) - 1;
206         if (isl->isl_first_burst_length == 0)
207                 isl->isl_first_burst_length = (1 << 24) - 1;
208         if (isl->isl_first_burst_length > isl->isl_max_burst_length)
209                 isl->isl_first_burst_length = isl->isl_max_burst_length;
210
211         /*
212          * Limit default send length in case it won't be negotiated.
213          * We can't do it for other limits, since they may affect both
214          * sender and receiver operation, and we must obey defaults.
215          */
216         if (conn->conn_max_send_data_segment_length >
217             isl->isl_max_send_data_segment_length) {
218                 conn->conn_max_send_data_segment_length =
219                     isl->isl_max_send_data_segment_length;
220         }
221
222         from_addr = conn->conn_conf.isc_initiator_addr;
223         to_addr = conn->conn_conf.isc_target_addr;
224
225         if (from_addr[0] != '\0')
226                 resolve_addr(conn, from_addr, &from_ai, true);
227         else
228                 from_ai = NULL;
229
230         resolve_addr(conn, to_addr, &to_ai, false);
231
232 #ifdef ICL_KERNEL_PROXY
233         if (conn->conn_conf.isc_iser) {
234                 memset(&idc, 0, sizeof(idc));
235                 idc.idc_session_id = conn->conn_session_id;
236                 if (conn->conn_conf.isc_iser)
237                         idc.idc_iser = 1;
238                 idc.idc_domain = to_ai->ai_family;
239                 idc.idc_socktype = to_ai->ai_socktype;
240                 idc.idc_protocol = to_ai->ai_protocol;
241                 if (from_ai != NULL) {
242                         idc.idc_from_addr = from_ai->ai_addr;
243                         idc.idc_from_addrlen = from_ai->ai_addrlen;
244                 }
245                 idc.idc_to_addr = to_ai->ai_addr;
246                 idc.idc_to_addrlen = to_ai->ai_addrlen;
247
248                 log_debugx("connecting to %s using ICL kernel proxy", to_addr);
249                 error = ioctl(iscsi_fd, ISCSIDCONNECT, &idc);
250                 if (error != 0) {
251                         fail(conn, strerror(errno));
252                         log_err(1, "failed to connect to %s "
253                             "using ICL kernel proxy: ISCSIDCONNECT", to_addr);
254                 }
255
256                 return (conn);
257         }
258 #endif /* ICL_KERNEL_PROXY */
259
260         if (conn->conn_conf.isc_iser) {
261                 fail(conn, "iSER not supported");
262                 log_errx(1, "iscsid(8) compiled without ICL_KERNEL_PROXY "
263                     "does not support iSER");
264         }
265
266         conn->conn_socket = socket(to_ai->ai_family, to_ai->ai_socktype,
267             to_ai->ai_protocol);
268         if (conn->conn_socket < 0) {
269                 fail(conn, strerror(errno));
270                 log_err(1, "failed to create socket for %s", from_addr);
271         }
272         sockbuf = SOCKBUF_SIZE;
273         if (setsockopt(conn->conn_socket, SOL_SOCKET, SO_RCVBUF,
274             &sockbuf, sizeof(sockbuf)) == -1)
275                 log_warn("setsockopt(SO_RCVBUF) failed");
276         sockbuf = SOCKBUF_SIZE;
277         if (setsockopt(conn->conn_socket, SOL_SOCKET, SO_SNDBUF,
278             &sockbuf, sizeof(sockbuf)) == -1)
279                 log_warn("setsockopt(SO_SNDBUF) failed");
280         if (conn->conn_conf.isc_dscp != -1) {
281                 int tos = conn->conn_conf.isc_dscp << 2;
282                 if (to_ai->ai_family == AF_INET) {
283                         if (setsockopt(conn->conn_socket,
284                             IPPROTO_IP, IP_TOS,
285                             &tos, sizeof(tos)) == -1)
286                                 log_warn("setsockopt(IP_TOS) "
287                                     "failed for %s",
288                                     from_addr);
289                 } else
290                 if (to_ai->ai_family == AF_INET6) {
291                         if (setsockopt(conn->conn_socket,
292                             IPPROTO_IPV6, IPV6_TCLASS,
293                             &tos, sizeof(tos)) == -1)
294                                 log_warn("setsockopt(IPV6_TCLASS) "
295                                     "failed for %s",
296                                     from_addr);
297                 }
298         }
299         if (from_ai != NULL) {
300                 error = bind(conn->conn_socket, from_ai->ai_addr,
301                     from_ai->ai_addrlen);
302                 if (error != 0) {
303                         fail(conn, strerror(errno));
304                         log_err(1, "failed to bind to %s", from_addr);
305                 }
306         }
307         log_debugx("connecting to %s", to_addr);
308         error = connect(conn->conn_socket, to_ai->ai_addr, to_ai->ai_addrlen);
309         if (error != 0) {
310                 fail(conn, strerror(errno));
311                 log_err(1, "failed to connect to %s", to_addr);
312         }
313
314         return (conn);
315 }
316
317 static void
318 handoff(struct connection *conn)
319 {
320         struct iscsi_daemon_handoff idh;
321         int error;
322
323         log_debugx("handing off connection to the kernel");
324
325         memset(&idh, 0, sizeof(idh));
326         idh.idh_session_id = conn->conn_session_id;
327         idh.idh_socket = conn->conn_socket;
328         strlcpy(idh.idh_target_alias, conn->conn_target_alias,
329             sizeof(idh.idh_target_alias));
330         idh.idh_tsih = conn->conn_tsih;
331         idh.idh_statsn = conn->conn_statsn;
332         idh.idh_protocol_level = conn->conn_protocol_level;
333         idh.idh_header_digest = conn->conn_header_digest;
334         idh.idh_data_digest = conn->conn_data_digest;
335         idh.idh_initial_r2t = conn->conn_initial_r2t;
336         idh.idh_immediate_data = conn->conn_immediate_data;
337         idh.idh_max_recv_data_segment_length =
338             conn->conn_max_recv_data_segment_length;
339         idh.idh_max_send_data_segment_length =
340             conn->conn_max_send_data_segment_length;
341         idh.idh_max_burst_length = conn->conn_max_burst_length;
342         idh.idh_first_burst_length = conn->conn_first_burst_length;
343
344         error = ioctl(conn->conn_iscsi_fd, ISCSIDHANDOFF, &idh);
345         if (error != 0)
346                 log_err(1, "ISCSIDHANDOFF");
347 }
348
349 void
350 fail(const struct connection *conn, const char *reason)
351 {
352         struct iscsi_daemon_fail idf;
353         int error, saved_errno;
354
355         saved_errno = errno;
356
357         memset(&idf, 0, sizeof(idf));
358         idf.idf_session_id = conn->conn_session_id;
359         strlcpy(idf.idf_reason, reason, sizeof(idf.idf_reason));
360
361         error = ioctl(conn->conn_iscsi_fd, ISCSIDFAIL, &idf);
362         if (error != 0)
363                 log_err(1, "ISCSIDFAIL");
364
365         errno = saved_errno;
366 }
367
368 /*
369  * XXX: I CANT INTO LATIN
370  */
371 static void
372 capsicate(struct connection *conn)
373 {
374         int error;
375         cap_rights_t rights;
376 #ifdef ICL_KERNEL_PROXY
377         const unsigned long cmds[] = { ISCSIDCONNECT, ISCSIDSEND, ISCSIDRECEIVE,
378             ISCSIDHANDOFF, ISCSIDFAIL, ISCSISADD, ISCSISREMOVE, ISCSISMODIFY };
379 #else
380         const unsigned long cmds[] = { ISCSIDHANDOFF, ISCSIDFAIL, ISCSISADD,
381             ISCSISREMOVE, ISCSISMODIFY };
382 #endif
383
384         cap_rights_init(&rights, CAP_IOCTL);
385         error = cap_rights_limit(conn->conn_iscsi_fd, &rights);
386         if (error != 0 && errno != ENOSYS)
387                 log_err(1, "cap_rights_limit");
388
389         error = cap_ioctls_limit(conn->conn_iscsi_fd, cmds, nitems(cmds));
390
391         if (error != 0 && errno != ENOSYS)
392                 log_err(1, "cap_ioctls_limit");
393
394         error = cap_enter();
395         if (error != 0 && errno != ENOSYS)
396                 log_err(1, "cap_enter");
397
398         if (cap_sandboxed())
399                 log_debugx("Capsicum capability mode enabled");
400         else
401                 log_warnx("Capsicum capability mode not supported");
402 }
403
404 bool
405 timed_out(void)
406 {
407
408         return (sigalrm_received);
409 }
410
411 static void
412 sigalrm_handler(int dummy __unused)
413 {
414         /*
415          * It would be easiest to just log an error and exit.  We can't
416          * do this, though, because log_errx() is not signal safe, since
417          * it calls syslog(3).  Instead, set a flag checked by pdu_send()
418          * and pdu_receive(), to call log_errx() there.  Should they fail
419          * to notice, we'll exit here one second later.
420          */
421         if (sigalrm_received) {
422                 /*
423                  * Oh well.  Just give up and quit.
424                  */
425                 _exit(2);
426         }
427
428         sigalrm_received = true;
429 }
430
431 static void
432 set_timeout(int timeout)
433 {
434         struct sigaction sa;
435         struct itimerval itv;
436         int error;
437
438         if (timeout <= 0) {
439                 log_debugx("session timeout disabled");
440                 return;
441         }
442
443         bzero(&sa, sizeof(sa));
444         sa.sa_handler = sigalrm_handler;
445         sigfillset(&sa.sa_mask);
446         error = sigaction(SIGALRM, &sa, NULL);
447         if (error != 0)
448                 log_err(1, "sigaction");
449
450         /*
451          * First SIGALRM will arive after conf_timeout seconds.
452          * If we do nothing, another one will arrive a second later.
453          */
454         bzero(&itv, sizeof(itv));
455         itv.it_interval.tv_sec = 1;
456         itv.it_value.tv_sec = timeout;
457
458         log_debugx("setting session timeout to %d seconds",
459             timeout);
460         error = setitimer(ITIMER_REAL, &itv, NULL);
461         if (error != 0)
462                 log_err(1, "setitimer");
463 }
464
465 static void
466 sigchld_handler(int dummy __unused)
467 {
468
469         /*
470          * The only purpose of this handler is to make SIGCHLD
471          * interrupt the ISCSIDWAIT ioctl(2), so we can call
472          * wait_for_children().
473          */
474 }
475
476 static void
477 register_sigchld(void)
478 {
479         struct sigaction sa;
480         int error;
481
482         bzero(&sa, sizeof(sa));
483         sa.sa_handler = sigchld_handler;
484         sigfillset(&sa.sa_mask);
485         error = sigaction(SIGCHLD, &sa, NULL);
486         if (error != 0)
487                 log_err(1, "sigaction");
488
489 }
490
491 static void
492 handle_request(int iscsi_fd, const struct iscsi_daemon_request *request, int timeout)
493 {
494         struct connection *conn;
495
496         log_set_peer_addr(request->idr_conf.isc_target_addr);
497         if (request->idr_conf.isc_target[0] != '\0') {
498                 log_set_peer_name(request->idr_conf.isc_target);
499                 setproctitle("%s (%s)", request->idr_conf.isc_target_addr, request->idr_conf.isc_target);
500         } else {
501                 setproctitle("%s", request->idr_conf.isc_target_addr);
502         }
503
504         conn = connection_new(iscsi_fd, request);
505         set_timeout(timeout);
506         capsicate(conn);
507         login(conn);
508         if (conn->conn_conf.isc_discovery != 0)
509                 discovery(conn);
510         else
511                 handoff(conn);
512
513         log_debugx("nothing more to do; exiting");
514         exit (0);
515 }
516
517 static int
518 wait_for_children(bool block)
519 {
520         pid_t pid;
521         int status;
522         int num = 0;
523
524         for (;;) {
525                 /*
526                  * If "block" is true, wait for at least one process.
527                  */
528                 if (block && num == 0)
529                         pid = wait4(-1, &status, 0, NULL);
530                 else
531                         pid = wait4(-1, &status, WNOHANG, NULL);
532                 if (pid <= 0)
533                         break;
534                 if (WIFSIGNALED(status)) {
535                         log_warnx("child process %d terminated with signal %d",
536                             pid, WTERMSIG(status));
537                 } else if (WEXITSTATUS(status) != 0) {
538                         log_warnx("child process %d terminated with exit status %d",
539                             pid, WEXITSTATUS(status));
540                 } else {
541                         log_debugx("child process %d terminated gracefully", pid);
542                 }
543                 num++;
544         }
545
546         return (num);
547 }
548
549 int
550 main(int argc, char **argv)
551 {
552         int ch, debug = 0, error, iscsi_fd, maxproc = 30, retval, saved_errno,
553             timeout = 60;
554         bool dont_daemonize = false;
555         struct pidfh *pidfh;
556         pid_t pid, otherpid;
557         const char *pidfile_path = DEFAULT_PIDFILE;
558         struct iscsi_daemon_request request;
559
560         while ((ch = getopt(argc, argv, "P:dl:m:t:")) != -1) {
561                 switch (ch) {
562                 case 'P':
563                         pidfile_path = optarg;
564                         break;
565                 case 'd':
566                         dont_daemonize = true;
567                         debug++;
568                         break;
569                 case 'l':
570                         debug = atoi(optarg);
571                         break;
572                 case 'm':
573                         maxproc = atoi(optarg);
574                         break;
575                 case 't':
576                         timeout = atoi(optarg);
577                         break;
578                 case '?':
579                 default:
580                         usage();
581                 }
582         }
583         argc -= optind;
584         if (argc != 0)
585                 usage();
586
587         log_init(debug);
588
589         pidfh = pidfile_open(pidfile_path, 0600, &otherpid);
590         if (pidfh == NULL) {
591                 if (errno == EEXIST)
592                         log_errx(1, "daemon already running, pid: %jd.",
593                             (intmax_t)otherpid);
594                 log_err(1, "cannot open or create pidfile \"%s\"",
595                     pidfile_path);
596         }
597
598         iscsi_fd = open(ISCSI_PATH, O_RDWR);
599         if (iscsi_fd < 0 && errno == ENOENT) {
600                 saved_errno = errno;
601                 retval = kldload("iscsi");
602                 if (retval != -1)
603                         iscsi_fd = open(ISCSI_PATH, O_RDWR);
604                 else
605                         errno = saved_errno;
606         }
607         if (iscsi_fd < 0)
608                 log_err(1, "failed to open %s", ISCSI_PATH);
609
610         if (dont_daemonize == false) {
611                 if (daemon(0, 0) == -1) {
612                         log_warn("cannot daemonize");
613                         pidfile_remove(pidfh);
614                         exit(1);
615                 }
616         }
617
618         pidfile_write(pidfh);
619
620         register_sigchld();
621
622         for (;;) {
623                 log_debugx("waiting for request from the kernel");
624
625                 memset(&request, 0, sizeof(request));
626                 error = ioctl(iscsi_fd, ISCSIDWAIT, &request);
627                 if (error != 0) {
628                         if (errno == EINTR) {
629                                 nchildren -= wait_for_children(false);
630                                 assert(nchildren >= 0);
631                                 continue;
632                         }
633
634                         log_err(1, "ISCSIDWAIT");
635                 }
636
637                 if (dont_daemonize) {
638                         log_debugx("not forking due to -d flag; "
639                             "will exit after servicing a single request");
640                 } else {
641                         nchildren -= wait_for_children(false);
642                         assert(nchildren >= 0);
643
644                         while (maxproc > 0 && nchildren >= maxproc) {
645                                 log_debugx("maxproc limit of %d child processes hit; "
646                                     "waiting for child process to exit", maxproc);
647                                 nchildren -= wait_for_children(true);
648                                 assert(nchildren >= 0);
649                         }
650                         log_debugx("incoming connection; forking child process #%d",
651                             nchildren);
652                         nchildren++;
653
654                         pid = fork();
655                         if (pid < 0)
656                                 log_err(1, "fork");
657                         if (pid > 0)
658                                 continue;
659                 }
660
661                 pidfile_close(pidfh);
662                 handle_request(iscsi_fd, &request, timeout);
663         }
664
665         return (0);
666 }