]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - usr.sbin/iscsid/iscsid.c
MFC r366573: Add DSCP support for network QoS to iscsi initiator.
[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_header_digest = CONN_DIGEST_NONE;
175         conn->conn_data_digest = CONN_DIGEST_NONE;
176         conn->conn_initial_r2t = true;
177         conn->conn_immediate_data = true;
178         conn->conn_max_recv_data_segment_length = 8192;
179         conn->conn_max_send_data_segment_length = 8192;
180         conn->conn_max_burst_length = 262144;
181         conn->conn_first_burst_length = 65536;
182         conn->conn_iscsi_fd = iscsi_fd;
183
184         conn->conn_session_id = request->idr_session_id;
185         memcpy(&conn->conn_conf, &request->idr_conf, sizeof(conn->conn_conf));
186         memcpy(&conn->conn_isid, &request->idr_isid, sizeof(conn->conn_isid));
187         conn->conn_tsih = request->idr_tsih;
188
189         /*
190          * Read the driver limits and provide reasonable defaults for the ones
191          * the driver doesn't care about.  If a max_snd_dsl is not explicitly
192          * provided by the driver then we'll make sure both conn->max_snd_dsl
193          * and isl->max_snd_dsl are set to the rcv_dsl.  This preserves historic
194          * behavior.
195          */
196         isl = &conn->conn_limits;
197         memcpy(isl, &request->idr_limits, sizeof(*isl));
198         if (isl->isl_max_recv_data_segment_length == 0)
199                 isl->isl_max_recv_data_segment_length = (1 << 24) - 1;
200         if (isl->isl_max_send_data_segment_length == 0)
201                 isl->isl_max_send_data_segment_length =
202                     isl->isl_max_recv_data_segment_length;
203         if (isl->isl_max_burst_length == 0)
204                 isl->isl_max_burst_length = (1 << 24) - 1;
205         if (isl->isl_first_burst_length == 0)
206                 isl->isl_first_burst_length = (1 << 24) - 1;
207         if (isl->isl_first_burst_length > isl->isl_max_burst_length)
208                 isl->isl_first_burst_length = isl->isl_max_burst_length;
209
210         /*
211          * Limit default send length in case it won't be negotiated.
212          * We can't do it for other limits, since they may affect both
213          * sender and receiver operation, and we must obey defaults.
214          */
215         if (conn->conn_max_send_data_segment_length >
216             isl->isl_max_send_data_segment_length) {
217                 conn->conn_max_send_data_segment_length =
218                     isl->isl_max_send_data_segment_length;
219         }
220
221         from_addr = conn->conn_conf.isc_initiator_addr;
222         to_addr = conn->conn_conf.isc_target_addr;
223
224         if (from_addr[0] != '\0')
225                 resolve_addr(conn, from_addr, &from_ai, true);
226         else
227                 from_ai = NULL;
228
229         resolve_addr(conn, to_addr, &to_ai, false);
230
231 #ifdef ICL_KERNEL_PROXY
232         if (conn->conn_conf.isc_iser) {
233                 memset(&idc, 0, sizeof(idc));
234                 idc.idc_session_id = conn->conn_session_id;
235                 if (conn->conn_conf.isc_iser)
236                         idc.idc_iser = 1;
237                 idc.idc_domain = to_ai->ai_family;
238                 idc.idc_socktype = to_ai->ai_socktype;
239                 idc.idc_protocol = to_ai->ai_protocol;
240                 if (from_ai != NULL) {
241                         idc.idc_from_addr = from_ai->ai_addr;
242                         idc.idc_from_addrlen = from_ai->ai_addrlen;
243                 }
244                 idc.idc_to_addr = to_ai->ai_addr;
245                 idc.idc_to_addrlen = to_ai->ai_addrlen;
246
247                 log_debugx("connecting to %s using ICL kernel proxy", to_addr);
248                 error = ioctl(iscsi_fd, ISCSIDCONNECT, &idc);
249                 if (error != 0) {
250                         fail(conn, strerror(errno));
251                         log_err(1, "failed to connect to %s "
252                             "using ICL kernel proxy: ISCSIDCONNECT", to_addr);
253                 }
254
255                 return (conn);
256         }
257 #endif /* ICL_KERNEL_PROXY */
258
259         if (conn->conn_conf.isc_iser) {
260                 fail(conn, "iSER not supported");
261                 log_errx(1, "iscsid(8) compiled without ICL_KERNEL_PROXY "
262                     "does not support iSER");
263         }
264
265         conn->conn_socket = socket(to_ai->ai_family, to_ai->ai_socktype,
266             to_ai->ai_protocol);
267         if (conn->conn_socket < 0) {
268                 fail(conn, strerror(errno));
269                 log_err(1, "failed to create socket for %s", from_addr);
270         }
271         sockbuf = SOCKBUF_SIZE;
272         if (setsockopt(conn->conn_socket, SOL_SOCKET, SO_RCVBUF,
273             &sockbuf, sizeof(sockbuf)) == -1)
274                 log_warn("setsockopt(SO_RCVBUF) failed");
275         sockbuf = SOCKBUF_SIZE;
276         if (setsockopt(conn->conn_socket, SOL_SOCKET, SO_SNDBUF,
277             &sockbuf, sizeof(sockbuf)) == -1)
278                 log_warn("setsockopt(SO_SNDBUF) failed");
279         if (conn->conn_conf.isc_dscp != -1) {
280                 int tos = conn->conn_conf.isc_dscp << 2;
281                 if (to_ai->ai_family == AF_INET) {
282                         if (setsockopt(conn->conn_socket,
283                             IPPROTO_IP, IP_TOS,
284                             &tos, sizeof(tos)) == -1)
285                                 log_warn("setsockopt(IP_TOS) "
286                                     "failed for %s",
287                                     from_addr);
288                 } else
289                 if (to_ai->ai_family == AF_INET6) {
290                         if (setsockopt(conn->conn_socket,
291                             IPPROTO_IPV6, IPV6_TCLASS,
292                             &tos, sizeof(tos)) == -1)
293                                 log_warn("setsockopt(IPV6_TCLASS) "
294                                     "failed for %s",
295                                     from_addr);
296                 }
297         }
298         if (from_ai != NULL) {
299                 error = bind(conn->conn_socket, from_ai->ai_addr,
300                     from_ai->ai_addrlen);
301                 if (error != 0) {
302                         fail(conn, strerror(errno));
303                         log_err(1, "failed to bind to %s", from_addr);
304                 }
305         }
306         log_debugx("connecting to %s", to_addr);
307         error = connect(conn->conn_socket, to_ai->ai_addr, to_ai->ai_addrlen);
308         if (error != 0) {
309                 fail(conn, strerror(errno));
310                 log_err(1, "failed to connect to %s", to_addr);
311         }
312
313         return (conn);
314 }
315
316 static void
317 handoff(struct connection *conn)
318 {
319         struct iscsi_daemon_handoff idh;
320         int error;
321
322         log_debugx("handing off connection to the kernel");
323
324         memset(&idh, 0, sizeof(idh));
325         idh.idh_session_id = conn->conn_session_id;
326         idh.idh_socket = conn->conn_socket;
327         strlcpy(idh.idh_target_alias, conn->conn_target_alias,
328             sizeof(idh.idh_target_alias));
329         idh.idh_tsih = conn->conn_tsih;
330         idh.idh_statsn = conn->conn_statsn;
331         idh.idh_header_digest = conn->conn_header_digest;
332         idh.idh_data_digest = conn->conn_data_digest;
333         idh.idh_initial_r2t = conn->conn_initial_r2t;
334         idh.idh_immediate_data = conn->conn_immediate_data;
335         idh.idh_max_recv_data_segment_length =
336             conn->conn_max_recv_data_segment_length;
337         idh.idh_max_send_data_segment_length =
338             conn->conn_max_send_data_segment_length;
339         idh.idh_max_burst_length = conn->conn_max_burst_length;
340         idh.idh_first_burst_length = conn->conn_first_burst_length;
341
342         error = ioctl(conn->conn_iscsi_fd, ISCSIDHANDOFF, &idh);
343         if (error != 0)
344                 log_err(1, "ISCSIDHANDOFF");
345 }
346
347 void
348 fail(const struct connection *conn, const char *reason)
349 {
350         struct iscsi_daemon_fail idf;
351         int error, saved_errno;
352
353         saved_errno = errno;
354
355         memset(&idf, 0, sizeof(idf));
356         idf.idf_session_id = conn->conn_session_id;
357         strlcpy(idf.idf_reason, reason, sizeof(idf.idf_reason));
358
359         error = ioctl(conn->conn_iscsi_fd, ISCSIDFAIL, &idf);
360         if (error != 0)
361                 log_err(1, "ISCSIDFAIL");
362
363         errno = saved_errno;
364 }
365
366 /*
367  * XXX: I CANT INTO LATIN
368  */
369 static void
370 capsicate(struct connection *conn)
371 {
372         int error;
373         cap_rights_t rights;
374 #ifdef ICL_KERNEL_PROXY
375         const unsigned long cmds[] = { ISCSIDCONNECT, ISCSIDSEND, ISCSIDRECEIVE,
376             ISCSIDHANDOFF, ISCSIDFAIL, ISCSISADD, ISCSISREMOVE, ISCSISMODIFY };
377 #else
378         const unsigned long cmds[] = { ISCSIDHANDOFF, ISCSIDFAIL, ISCSISADD,
379             ISCSISREMOVE, ISCSISMODIFY };
380 #endif
381
382         cap_rights_init(&rights, CAP_IOCTL);
383         error = cap_rights_limit(conn->conn_iscsi_fd, &rights);
384         if (error != 0 && errno != ENOSYS)
385                 log_err(1, "cap_rights_limit");
386
387         error = cap_ioctls_limit(conn->conn_iscsi_fd, cmds, nitems(cmds));
388
389         if (error != 0 && errno != ENOSYS)
390                 log_err(1, "cap_ioctls_limit");
391
392         error = cap_enter();
393         if (error != 0 && errno != ENOSYS)
394                 log_err(1, "cap_enter");
395
396         if (cap_sandboxed())
397                 log_debugx("Capsicum capability mode enabled");
398         else
399                 log_warnx("Capsicum capability mode not supported");
400 }
401
402 bool
403 timed_out(void)
404 {
405
406         return (sigalrm_received);
407 }
408
409 static void
410 sigalrm_handler(int dummy __unused)
411 {
412         /*
413          * It would be easiest to just log an error and exit.  We can't
414          * do this, though, because log_errx() is not signal safe, since
415          * it calls syslog(3).  Instead, set a flag checked by pdu_send()
416          * and pdu_receive(), to call log_errx() there.  Should they fail
417          * to notice, we'll exit here one second later.
418          */
419         if (sigalrm_received) {
420                 /*
421                  * Oh well.  Just give up and quit.
422                  */
423                 _exit(2);
424         }
425
426         sigalrm_received = true;
427 }
428
429 static void
430 set_timeout(int timeout)
431 {
432         struct sigaction sa;
433         struct itimerval itv;
434         int error;
435
436         if (timeout <= 0) {
437                 log_debugx("session timeout disabled");
438                 return;
439         }
440
441         bzero(&sa, sizeof(sa));
442         sa.sa_handler = sigalrm_handler;
443         sigfillset(&sa.sa_mask);
444         error = sigaction(SIGALRM, &sa, NULL);
445         if (error != 0)
446                 log_err(1, "sigaction");
447
448         /*
449          * First SIGALRM will arive after conf_timeout seconds.
450          * If we do nothing, another one will arrive a second later.
451          */
452         bzero(&itv, sizeof(itv));
453         itv.it_interval.tv_sec = 1;
454         itv.it_value.tv_sec = timeout;
455
456         log_debugx("setting session timeout to %d seconds",
457             timeout);
458         error = setitimer(ITIMER_REAL, &itv, NULL);
459         if (error != 0)
460                 log_err(1, "setitimer");
461 }
462
463 static void
464 sigchld_handler(int dummy __unused)
465 {
466
467         /*
468          * The only purpose of this handler is to make SIGCHLD
469          * interrupt the ISCSIDWAIT ioctl(2), so we can call
470          * wait_for_children().
471          */
472 }
473
474 static void
475 register_sigchld(void)
476 {
477         struct sigaction sa;
478         int error;
479
480         bzero(&sa, sizeof(sa));
481         sa.sa_handler = sigchld_handler;
482         sigfillset(&sa.sa_mask);
483         error = sigaction(SIGCHLD, &sa, NULL);
484         if (error != 0)
485                 log_err(1, "sigaction");
486
487 }
488
489 static void
490 handle_request(int iscsi_fd, const struct iscsi_daemon_request *request, int timeout)
491 {
492         struct connection *conn;
493
494         log_set_peer_addr(request->idr_conf.isc_target_addr);
495         if (request->idr_conf.isc_target[0] != '\0') {
496                 log_set_peer_name(request->idr_conf.isc_target);
497                 setproctitle("%s (%s)", request->idr_conf.isc_target_addr, request->idr_conf.isc_target);
498         } else {
499                 setproctitle("%s", request->idr_conf.isc_target_addr);
500         }
501
502         conn = connection_new(iscsi_fd, request);
503         set_timeout(timeout);
504         capsicate(conn);
505         login(conn);
506         if (conn->conn_conf.isc_discovery != 0)
507                 discovery(conn);
508         else
509                 handoff(conn);
510
511         log_debugx("nothing more to do; exiting");
512         exit (0);
513 }
514
515 static int
516 wait_for_children(bool block)
517 {
518         pid_t pid;
519         int status;
520         int num = 0;
521
522         for (;;) {
523                 /*
524                  * If "block" is true, wait for at least one process.
525                  */
526                 if (block && num == 0)
527                         pid = wait4(-1, &status, 0, NULL);
528                 else
529                         pid = wait4(-1, &status, WNOHANG, NULL);
530                 if (pid <= 0)
531                         break;
532                 if (WIFSIGNALED(status)) {
533                         log_warnx("child process %d terminated with signal %d",
534                             pid, WTERMSIG(status));
535                 } else if (WEXITSTATUS(status) != 0) {
536                         log_warnx("child process %d terminated with exit status %d",
537                             pid, WEXITSTATUS(status));
538                 } else {
539                         log_debugx("child process %d terminated gracefully", pid);
540                 }
541                 num++;
542         }
543
544         return (num);
545 }
546
547 int
548 main(int argc, char **argv)
549 {
550         int ch, debug = 0, error, iscsi_fd, maxproc = 30, retval, saved_errno,
551             timeout = 60;
552         bool dont_daemonize = false;
553         struct pidfh *pidfh;
554         pid_t pid, otherpid;
555         const char *pidfile_path = DEFAULT_PIDFILE;
556         struct iscsi_daemon_request request;
557
558         while ((ch = getopt(argc, argv, "P:dl:m:t:")) != -1) {
559                 switch (ch) {
560                 case 'P':
561                         pidfile_path = optarg;
562                         break;
563                 case 'd':
564                         dont_daemonize = true;
565                         debug++;
566                         break;
567                 case 'l':
568                         debug = atoi(optarg);
569                         break;
570                 case 'm':
571                         maxproc = atoi(optarg);
572                         break;
573                 case 't':
574                         timeout = atoi(optarg);
575                         break;
576                 case '?':
577                 default:
578                         usage();
579                 }
580         }
581         argc -= optind;
582         if (argc != 0)
583                 usage();
584
585         log_init(debug);
586
587         pidfh = pidfile_open(pidfile_path, 0600, &otherpid);
588         if (pidfh == NULL) {
589                 if (errno == EEXIST)
590                         log_errx(1, "daemon already running, pid: %jd.",
591                             (intmax_t)otherpid);
592                 log_err(1, "cannot open or create pidfile \"%s\"",
593                     pidfile_path);
594         }
595
596         iscsi_fd = open(ISCSI_PATH, O_RDWR);
597         if (iscsi_fd < 0 && errno == ENOENT) {
598                 saved_errno = errno;
599                 retval = kldload("iscsi");
600                 if (retval != -1)
601                         iscsi_fd = open(ISCSI_PATH, O_RDWR);
602                 else
603                         errno = saved_errno;
604         }
605         if (iscsi_fd < 0)
606                 log_err(1, "failed to open %s", ISCSI_PATH);
607
608         if (dont_daemonize == false) {
609                 if (daemon(0, 0) == -1) {
610                         log_warn("cannot daemonize");
611                         pidfile_remove(pidfh);
612                         exit(1);
613                 }
614         }
615
616         pidfile_write(pidfh);
617
618         register_sigchld();
619
620         for (;;) {
621                 log_debugx("waiting for request from the kernel");
622
623                 memset(&request, 0, sizeof(request));
624                 error = ioctl(iscsi_fd, ISCSIDWAIT, &request);
625                 if (error != 0) {
626                         if (errno == EINTR) {
627                                 nchildren -= wait_for_children(false);
628                                 assert(nchildren >= 0);
629                                 continue;
630                         }
631
632                         log_err(1, "ISCSIDWAIT");
633                 }
634
635                 if (dont_daemonize) {
636                         log_debugx("not forking due to -d flag; "
637                             "will exit after servicing a single request");
638                 } else {
639                         nchildren -= wait_for_children(false);
640                         assert(nchildren >= 0);
641
642                         while (maxproc > 0 && nchildren >= maxproc) {
643                                 log_debugx("maxproc limit of %d child processes hit; "
644                                     "waiting for child process to exit", maxproc);
645                                 nchildren -= wait_for_children(true);
646                                 assert(nchildren >= 0);
647                         }
648                         log_debugx("incoming connection; forking child process #%d",
649                             nchildren);
650                         nchildren++;
651
652                         pid = fork();
653                         if (pid < 0)
654                                 log_err(1, "fork");
655                         if (pid > 0)
656                                 continue;
657                 }
658
659                 pidfile_close(pidfh);
660                 handle_request(iscsi_fd, &request, timeout);
661         }
662
663         return (0);
664 }