s3:unix_msg: fix a tab<->space mixup in unix_msg_recv()
[obnox/samba/samba-obnox.git] / source3 / lib / unix_msg / unix_msg.c
1 /*
2  * Unix SMB/CIFS implementation.
3  * Copyright (C) Volker Lendecke 2013
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 3 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
17  */
18
19 #include "replace.h"
20 #include "unix_msg.h"
21 #include "system/select.h"
22 #include "system/time.h"
23 #include "system/network.h"
24 #include "dlinklist.h"
25 #include "pthreadpool/pthreadpool.h"
26 #include <fcntl.h>
27
28 /*
29  * This file implements two abstractions: The "unix_dgram" functions implement
30  * queueing for unix domain datagram sockets. You can send to a destination
31  * socket, and if that has no free space available, it will fall back to an
32  * anonymous socket that will poll for writability. "unix_dgram" expects the
33  * data size not to exceed the system limit.
34  *
35  * The "unix_msg" functions implement the fragmentation of large messages on
36  * top of "unix_dgram". This is what is exposed to the user of this API.
37  */
38
39 struct unix_dgram_msg {
40         struct unix_dgram_msg *prev, *next;
41
42         int sock;
43         ssize_t sent;
44         int sys_errno;
45         size_t num_fds;
46         int *fds;
47         size_t buflen;
48         uint8_t buf[];
49 };
50
51 struct unix_dgram_send_queue {
52         struct unix_dgram_send_queue *prev, *next;
53         struct unix_dgram_ctx *ctx;
54         int sock;
55         struct unix_dgram_msg *msgs;
56         char path[];
57 };
58
59 struct unix_dgram_ctx {
60         int sock;
61         pid_t created_pid;
62         const struct poll_funcs *ev_funcs;
63         size_t max_msg;
64
65         void (*recv_callback)(struct unix_dgram_ctx *ctx,
66                               uint8_t *msg, size_t msg_len,
67                               int *fds, size_t num_fds,
68                               void *private_data);
69         void *private_data;
70
71         struct poll_watch *sock_read_watch;
72         struct unix_dgram_send_queue *send_queues;
73
74         struct pthreadpool *send_pool;
75         struct poll_watch *pool_read_watch;
76
77         uint8_t *recv_buf;
78         char path[];
79 };
80
81 static ssize_t iov_buflen(const struct iovec *iov, int iovlen);
82 static void unix_dgram_recv_handler(struct poll_watch *w, int fd, short events,
83                                     void *private_data);
84
85 /* Set socket non blocking. */
86 static int prepare_socket_nonblock(int sock)
87 {
88         int flags;
89 #ifdef O_NONBLOCK
90 #define FLAG_TO_SET O_NONBLOCK
91 #else
92 #ifdef SYSV
93 #define FLAG_TO_SET O_NDELAY
94 #else /* BSD */
95 #define FLAG_TO_SET FNDELAY
96 #endif
97 #endif
98
99         flags = fcntl(sock, F_GETFL);
100         if (flags == -1) {
101                 return errno;
102         }
103         flags |= FLAG_TO_SET;
104         if (fcntl(sock, F_SETFL, flags) == -1) {
105                 return errno;
106         }
107
108 #undef FLAG_TO_SET
109         return 0;
110 }
111
112 /* Set socket close on exec. */
113 static int prepare_socket_cloexec(int sock)
114 {
115 #ifdef FD_CLOEXEC
116         int flags;
117
118         flags = fcntl(sock, F_GETFD, 0);
119         if (flags == -1) {
120                 return errno;
121         }
122         flags |= FD_CLOEXEC;
123         if (fcntl(sock, F_SETFD, flags) == -1) {
124                 return errno;
125         }
126 #endif
127         return 0;
128 }
129
130 /* Set socket non blocking and close on exec. */
131 static int prepare_socket(int sock)
132 {
133         int ret = prepare_socket_nonblock(sock);
134
135         if (ret) {
136                 return ret;
137         }
138         return prepare_socket_cloexec(sock);
139 }
140
141 static void close_fd_array(int *fds, size_t num_fds)
142 {
143         size_t i;
144
145         for (i = 0; i < num_fds; i++) {
146                 if (fds[i] == -1) {
147                         continue;
148                 }
149
150                 close(fds[i]);
151                 fds[i] = -1;
152         }
153 }
154
155 static int unix_dgram_init(const struct sockaddr_un *addr, size_t max_msg,
156                            const struct poll_funcs *ev_funcs,
157                            void (*recv_callback)(struct unix_dgram_ctx *ctx,
158                                                  uint8_t *msg, size_t msg_len,
159                                                  int *fds, size_t num_fds,
160                                                  void *private_data),
161                            void *private_data,
162                            struct unix_dgram_ctx **result)
163 {
164         struct unix_dgram_ctx *ctx;
165         size_t pathlen;
166         int ret;
167
168         if (addr != NULL) {
169                 pathlen = strlen(addr->sun_path)+1;
170         } else {
171                 pathlen = 1;
172         }
173
174         ctx = malloc(offsetof(struct unix_dgram_ctx, path) + pathlen);
175         if (ctx == NULL) {
176                 return ENOMEM;
177         }
178         if (addr != NULL) {
179                 memcpy(ctx->path, addr->sun_path, pathlen);
180         } else {
181                 ctx->path[0] = '\0';
182         }
183
184         *ctx = (struct unix_dgram_ctx) {
185                 .max_msg = max_msg,
186                 .ev_funcs = ev_funcs,
187                 .recv_callback = recv_callback,
188                 .private_data = private_data,
189                 .created_pid = (pid_t)-1
190         };
191
192         ctx->recv_buf = malloc(max_msg);
193         if (ctx->recv_buf == NULL) {
194                 free(ctx);
195                 return ENOMEM;
196         }
197
198         ctx->sock = socket(AF_UNIX, SOCK_DGRAM, 0);
199         if (ctx->sock == -1) {
200                 ret = errno;
201                 goto fail_free;
202         }
203
204         /* Set non-blocking and close-on-exec. */
205         ret = prepare_socket(ctx->sock);
206         if (ret != 0) {
207                 goto fail_close;
208         }
209
210         if (addr != NULL) {
211                 ret = bind(ctx->sock,
212                            (const struct sockaddr *)(const void *)addr,
213                            sizeof(*addr));
214                 if (ret == -1) {
215                         ret = errno;
216                         goto fail_close;
217                 }
218
219                 ctx->created_pid = getpid();
220
221                 ctx->sock_read_watch = ctx->ev_funcs->watch_new(
222                         ctx->ev_funcs, ctx->sock, POLLIN,
223                         unix_dgram_recv_handler, ctx);
224
225                 if (ctx->sock_read_watch == NULL) {
226                         ret = ENOMEM;
227                         goto fail_close;
228                 }
229         }
230
231         *result = ctx;
232         return 0;
233
234 fail_close:
235         close(ctx->sock);
236 fail_free:
237         free(ctx->recv_buf);
238         free(ctx);
239         return ret;
240 }
241
242 static void unix_dgram_recv_handler(struct poll_watch *w, int fd, short events,
243                                     void *private_data)
244 {
245         struct unix_dgram_ctx *ctx = (struct unix_dgram_ctx *)private_data;
246         ssize_t received;
247         int flags = 0;
248         struct msghdr msg;
249         struct iovec iov;
250 #ifdef HAVE_STRUCT_MSGHDR_MSG_CONTROL
251         char buf[CMSG_SPACE(sizeof(int)*INT8_MAX)] = { 0, };
252         struct cmsghdr *cmsg;
253 #endif /* HAVE_STRUCT_MSGHDR_MSG_CONTROL */
254         int *fds = NULL;
255         size_t i, num_fds = 0;
256
257         iov = (struct iovec) {
258                 .iov_base = (void *)ctx->recv_buf,
259                 .iov_len = ctx->max_msg,
260         };
261
262         msg = (struct msghdr) {
263                 .msg_iov = &iov,
264                 .msg_iovlen = 1,
265 #ifdef HAVE_STRUCT_MSGHDR_MSG_CONTROL
266                 .msg_control = buf,
267                 .msg_controllen = sizeof(buf),
268 #endif
269         };
270
271 #ifdef MSG_CMSG_CLOEXEC
272         flags |= MSG_CMSG_CLOEXEC;
273 #endif
274
275         received = recvmsg(fd, &msg, flags);
276         if (received == -1) {
277                 if ((errno == EAGAIN) ||
278                     (errno == EWOULDBLOCK) ||
279                     (errno == EINTR) || (errno == ENOMEM)) {
280                         /* Not really an error - just try again. */
281                         return;
282                 }
283                 /* Problem with the socket. Set it unreadable. */
284                 ctx->ev_funcs->watch_update(w, 0);
285                 return;
286         }
287         if (received > ctx->max_msg) {
288                 /* More than we expected, not for us */
289                 return;
290         }
291
292 #ifdef HAVE_STRUCT_MSGHDR_MSG_CONTROL
293         for(cmsg = CMSG_FIRSTHDR(&msg); cmsg != NULL;
294             cmsg = CMSG_NXTHDR(&msg, cmsg))
295         {
296                 void *data = CMSG_DATA(cmsg);
297
298                 if (cmsg->cmsg_type != SCM_RIGHTS) {
299                         continue;
300                 }
301                 if (cmsg->cmsg_level != SOL_SOCKET) {
302                         continue;
303                 }
304
305                 fds = (int *)data;
306                 num_fds = (cmsg->cmsg_len - CMSG_LEN(0)) / sizeof (int);
307                 break;
308         }
309 #endif
310
311         for (i = 0; i < num_fds; i++) {
312                 int err;
313
314                 err = prepare_socket_cloexec(fds[i]);
315                 if (err != 0) {
316                         goto cleanup_fds;
317                 }
318         }
319
320         ctx->recv_callback(ctx, ctx->recv_buf, received,
321                            fds, num_fds, ctx->private_data);
322         return;
323
324 cleanup_fds:
325         close_fd_array(fds, num_fds);
326
327         ctx->recv_callback(ctx, ctx->recv_buf, received,
328                            NULL, 0, ctx->private_data);
329 }
330
331 static void unix_dgram_job_finished(struct poll_watch *w, int fd, short events,
332                                     void *private_data);
333
334 static int unix_dgram_init_pthreadpool(struct unix_dgram_ctx *ctx)
335 {
336         int ret, signalfd;
337
338         if (ctx->send_pool != NULL) {
339                 return 0;
340         }
341
342         ret = pthreadpool_init(0, &ctx->send_pool);
343         if (ret != 0) {
344                 return ret;
345         }
346
347         signalfd = pthreadpool_signal_fd(ctx->send_pool);
348
349         ctx->pool_read_watch = ctx->ev_funcs->watch_new(
350                 ctx->ev_funcs, signalfd, POLLIN,
351                 unix_dgram_job_finished, ctx);
352         if (ctx->pool_read_watch == NULL) {
353                 pthreadpool_destroy(ctx->send_pool);
354                 ctx->send_pool = NULL;
355                 return ENOMEM;
356         }
357
358         return 0;
359 }
360
361 static int unix_dgram_send_queue_init(
362         struct unix_dgram_ctx *ctx, const struct sockaddr_un *dst,
363         struct unix_dgram_send_queue **result)
364 {
365         struct unix_dgram_send_queue *q;
366         size_t pathlen;
367         int ret, err;
368
369         pathlen = strlen(dst->sun_path)+1;
370
371         q = malloc(offsetof(struct unix_dgram_send_queue, path) + pathlen);
372         if (q == NULL) {
373                 return ENOMEM;
374         }
375         q->ctx = ctx;
376         q->msgs = NULL;
377         memcpy(q->path, dst->sun_path, pathlen);
378
379         q->sock = socket(AF_UNIX, SOCK_DGRAM, 0);
380         if (q->sock == -1) {
381                 err = errno;
382                 goto fail_free;
383         }
384
385         err = prepare_socket_cloexec(q->sock);
386         if (err != 0) {
387                 goto fail_close;
388         }
389
390         do {
391                 ret = connect(q->sock,
392                               (const struct sockaddr *)(const void *)dst,
393                               sizeof(*dst));
394         } while ((ret == -1) && (errno == EINTR));
395
396         if (ret == -1) {
397                 err = errno;
398                 goto fail_close;
399         }
400
401         err = unix_dgram_init_pthreadpool(ctx);
402         if (err != 0) {
403                 goto fail_close;
404         }
405
406         DLIST_ADD(ctx->send_queues, q);
407
408         *result = q;
409         return 0;
410
411 fail_close:
412         close(q->sock);
413 fail_free:
414         free(q);
415         return err;
416 }
417
418 static void unix_dgram_send_queue_free(struct unix_dgram_send_queue *q)
419 {
420         struct unix_dgram_ctx *ctx = q->ctx;
421
422         while (q->msgs != NULL) {
423                 struct unix_dgram_msg *msg;
424                 msg = q->msgs;
425                 DLIST_REMOVE(q->msgs, msg);
426                 close_fd_array(msg->fds, msg->num_fds);
427                 free(msg);
428         }
429         close(q->sock);
430         DLIST_REMOVE(ctx->send_queues, q);
431         free(q);
432 }
433
434 static struct unix_dgram_send_queue *find_send_queue(
435         struct unix_dgram_ctx *ctx, const char *dst_sock)
436 {
437         struct unix_dgram_send_queue *s;
438
439         for (s = ctx->send_queues; s != NULL; s = s->next) {
440                 if (strcmp(s->path, dst_sock) == 0) {
441                         return s;
442                 }
443         }
444         return NULL;
445 }
446
447 static int queue_msg(struct unix_dgram_send_queue *q,
448                      const struct iovec *iov, int iovlen,
449                      const int *fds, size_t num_fds)
450 {
451         struct unix_dgram_msg *msg;
452         ssize_t buflen;
453         size_t msglen;
454         size_t fds_size = sizeof(int) * num_fds;
455         int fds_copy[MIN(num_fds, INT8_MAX)];
456         size_t fds_padding = 0;
457         int i;
458         size_t tmp;
459         int ret = -1;
460
461         if (num_fds > INT8_MAX) {
462                 return EINVAL;
463         }
464
465         for (i = 0; i < num_fds; i++) {
466                 fds_copy[i] = -1;
467         }
468
469         for (i = 0; i < num_fds; i++) {
470                 fds_copy[i] = dup(fds[i]);
471                 if (fds_copy[i] == -1) {
472                         ret = errno;
473                         goto fail;
474                 }
475         }
476
477         buflen = iov_buflen(iov, iovlen);
478         if (buflen == -1) {
479                 goto invalid;
480         }
481
482         msglen = offsetof(struct unix_dgram_msg, buf);
483         tmp = msglen + buflen;
484         if ((tmp < msglen) || (tmp < buflen)) {
485                 /* overflow */
486                 goto invalid;
487         }
488         msglen = tmp;
489
490         if (num_fds > 0) {
491                 const size_t fds_align = sizeof(int) - 1;
492
493                 tmp = msglen + fds_align;
494                 if ((tmp < msglen) || (tmp < fds_align)) {
495                         /* overflow */
496                         goto invalid;
497                 }
498                 tmp &= ~fds_align;
499
500                 fds_padding = tmp - msglen;
501                 msglen = tmp;
502
503                 tmp = msglen + fds_size;
504                 if ((tmp < msglen) || (tmp < fds_size)) {
505                         /* overflow */
506                         goto invalid;
507                 }
508                 msglen = tmp;
509         }
510
511         msg = malloc(msglen);
512         if (msg == NULL) {
513                 ret = ENOMEM;
514                 goto fail;
515         }
516         msg->buflen = buflen;
517         msg->sock = q->sock;
518
519         buflen = 0;
520         for (i=0; i<iovlen; i++) {
521                 memcpy(&msg->buf[buflen], iov[i].iov_base, iov[i].iov_len);
522                 buflen += iov[i].iov_len;
523         }
524
525         msg->num_fds = num_fds;
526         if (msg->num_fds > 0) {
527                 void *fds_ptr = (void *)&msg->buf[buflen+fds_padding];
528                 memcpy(fds_ptr, fds_copy, fds_size);
529                 msg->fds = (int *)fds_ptr;
530         } else {
531                 msg->fds = NULL;
532         }
533
534         DLIST_ADD_END(q->msgs, msg, struct unix_dgram_msg);
535         return 0;
536
537 invalid:
538         ret = EINVAL;
539 fail:
540         close_fd_array(fds_copy, num_fds);
541         return ret;
542 }
543
544 static void unix_dgram_send_job(void *private_data)
545 {
546         struct unix_dgram_msg *dmsg = private_data;
547         struct iovec iov = {
548                 .iov_base = (void *)dmsg->buf,
549                 .iov_len = dmsg->buflen,
550         };
551         struct msghdr msg = {
552                 .msg_iov = &iov,
553                 .msg_iovlen = 1,
554         };
555 #ifdef HAVE_STRUCT_MSGHDR_MSG_CONTROL
556         struct cmsghdr *cmsg;
557         size_t fds_size = sizeof(int) * dmsg->num_fds;
558         size_t cmsg_len = CMSG_LEN(fds_size);
559         size_t cmsg_space = CMSG_SPACE(fds_size);
560         char cmsg_buf[cmsg_space];
561
562         if (dmsg->num_fds > 0) {
563                 void *fdptr;
564
565                 memset(cmsg_buf, 0, cmsg_space);
566
567                 msg.msg_control = cmsg_buf;
568                 msg.msg_controllen = cmsg_space;
569                 cmsg = CMSG_FIRSTHDR(&msg);
570                 cmsg->cmsg_level = SOL_SOCKET;
571                 cmsg->cmsg_type = SCM_RIGHTS;
572                 cmsg->cmsg_len = cmsg_len;
573                 fdptr = CMSG_DATA(cmsg);
574                 memcpy(fdptr, dmsg->fds, fds_size);
575                 msg.msg_controllen = cmsg->cmsg_len;
576         }
577 #endif /*  HAVE_STRUCT_MSGHDR_MSG_CONTROL */
578
579         do {
580                 dmsg->sent = sendmsg(dmsg->sock, &msg, 0);
581         } while ((dmsg->sent == -1) && (errno == EINTR));
582
583         close_fd_array(dmsg->fds, dmsg->num_fds);
584 }
585
586 static void unix_dgram_job_finished(struct poll_watch *w, int fd, short events,
587                                     void *private_data)
588 {
589         struct unix_dgram_ctx *ctx = private_data;
590         struct unix_dgram_send_queue *q;
591         struct unix_dgram_msg *msg;
592         int ret, job;
593
594         ret = pthreadpool_finished_jobs(ctx->send_pool, &job, 1);
595         if (ret != 1) {
596                 return;
597         }
598
599         for (q = ctx->send_queues; q != NULL; q = q->next) {
600                 if (job == q->sock) {
601                         break;
602                 }
603         }
604
605         if (q == NULL) {
606                 /* Huh? Should not happen */
607                 return;
608         }
609
610         msg = q->msgs;
611         DLIST_REMOVE(q->msgs, msg);
612         close_fd_array(msg->fds, msg->num_fds);
613         free(msg);
614
615         if (q->msgs != NULL) {
616                 ret = pthreadpool_add_job(ctx->send_pool, q->sock,
617                                           unix_dgram_send_job, q->msgs);
618                 if (ret == 0) {
619                         return;
620                 }
621         }
622
623         unix_dgram_send_queue_free(q);
624 }
625
626 static int unix_dgram_send(struct unix_dgram_ctx *ctx,
627                            const struct sockaddr_un *dst,
628                            const struct iovec *iov, int iovlen,
629                            const int *fds, size_t num_fds)
630 {
631         struct unix_dgram_send_queue *q;
632         struct msghdr msg;
633 #ifdef HAVE_STRUCT_MSGHDR_MSG_CONTROL
634         struct cmsghdr *cmsg;
635         size_t fds_size = sizeof(int) * num_fds;
636         size_t cmsg_len = CMSG_LEN(fds_size);
637         size_t cmsg_space = CMSG_SPACE(fds_size);
638         char cmsg_buf[cmsg_space];
639 #endif /* HAVE_STRUCT_MSGHDR_MSG_CONTROL */
640         int ret;
641         int i;
642
643         if (num_fds > INT8_MAX) {
644                 return EINVAL;
645         }
646
647 #ifndef HAVE_STRUCT_MSGHDR_MSG_CONTROL
648         if (num_fds > 0) {
649                 return ENOSYS;
650         }
651 #endif /* ! HAVE_STRUCT_MSGHDR_MSG_CONTROL */
652
653         for (i = 0; i < num_fds; i++) {
654                 /*
655                  * Make sure we only allow fd passing
656                  * for communication channels,
657                  * e.g. sockets, pipes, fifos, ...
658                  */
659                 ret = lseek(fds[i], 0, SEEK_CUR);
660                 if (ret == -1 && errno == ESPIPE) {
661                         /* ok */
662                         continue;
663                 }
664
665                 /*
666                  * Reject the message as we may need to call dup(),
667                  * if we queue the message.
668                  *
669                  * That might result in unexpected behavior for the caller
670                  * for files and broken posix locking.
671                  */
672                 return EINVAL;
673         }
674
675         /*
676          * To preserve message ordering, we have to queue a message when
677          * others are waiting in line already.
678          */
679         q = find_send_queue(ctx, dst->sun_path);
680         if (q != NULL) {
681                 return queue_msg(q, iov, iovlen, fds, num_fds);
682         }
683
684         /*
685          * Try a cheap nonblocking send
686          */
687
688         msg = (struct msghdr) {
689                 .msg_name = discard_const_p(struct sockaddr_un, dst),
690                 .msg_namelen = sizeof(*dst),
691                 .msg_iov = discard_const_p(struct iovec, iov),
692                 .msg_iovlen = iovlen
693         };
694 #ifdef HAVE_STRUCT_MSGHDR_MSG_CONTROL
695         if (num_fds > 0) {
696                 void *fdptr;
697
698                 memset(cmsg_buf, 0, cmsg_space);
699
700                 msg.msg_control = cmsg_buf;
701                 msg.msg_controllen = cmsg_space;
702                 cmsg = CMSG_FIRSTHDR(&msg);
703                 cmsg->cmsg_level = SOL_SOCKET;
704                 cmsg->cmsg_type = SCM_RIGHTS;
705                 cmsg->cmsg_len = cmsg_len;
706                 fdptr = CMSG_DATA(cmsg);
707                 memcpy(fdptr, fds, fds_size);
708                 msg.msg_controllen = cmsg->cmsg_len;
709         }
710 #endif /*  HAVE_STRUCT_MSGHDR_MSG_CONTROL */
711
712         ret = sendmsg(ctx->sock, &msg, 0);
713         if (ret >= 0) {
714                 return 0;
715         }
716         if ((errno != EWOULDBLOCK) && (errno != EAGAIN) && (errno != EINTR)) {
717                 return errno;
718         }
719
720         ret = unix_dgram_send_queue_init(ctx, dst, &q);
721         if (ret != 0) {
722                 return ret;
723         }
724         ret = queue_msg(q, iov, iovlen, fds, num_fds);
725         if (ret != 0) {
726                 unix_dgram_send_queue_free(q);
727                 return ret;
728         }
729         ret = pthreadpool_add_job(ctx->send_pool, q->sock,
730                                   unix_dgram_send_job, q->msgs);
731         if (ret != 0) {
732                 unix_dgram_send_queue_free(q);
733                 return ret;
734         }
735         return 0;
736 }
737
738 static int unix_dgram_sock(struct unix_dgram_ctx *ctx)
739 {
740         return ctx->sock;
741 }
742
743 static int unix_dgram_free(struct unix_dgram_ctx *ctx)
744 {
745         if (ctx->send_queues != NULL) {
746                 return EBUSY;
747         }
748
749         if (ctx->send_pool != NULL) {
750                 int ret = pthreadpool_destroy(ctx->send_pool);
751                 if (ret != 0) {
752                         return ret;
753                 }
754                 ctx->ev_funcs->watch_free(ctx->pool_read_watch);
755         }
756
757         ctx->ev_funcs->watch_free(ctx->sock_read_watch);
758
759         if (getpid() == ctx->created_pid) {
760                 /* If we created it, unlink. Otherwise someone else might
761                  * still have it open */
762                 unlink(ctx->path);
763         }
764
765         close(ctx->sock);
766         free(ctx->recv_buf);
767         free(ctx);
768         return 0;
769 }
770
771 /*
772  * Every message starts with a uint64_t cookie.
773  *
774  * A value of 0 indicates a single-fragment message which is complete in
775  * itself. The data immediately follows the cookie.
776  *
777  * Every multi-fragment message has a cookie != 0 and starts with a cookie
778  * followed by a struct unix_msg_header and then the data. The pid and sock
779  * fields are used to assure uniqueness on the receiver side.
780  */
781
782 struct unix_msg_hdr {
783         size_t msglen;
784         pid_t pid;
785         int sock;
786 };
787
788 struct unix_msg {
789         struct unix_msg *prev, *next;
790         size_t msglen;
791         size_t received;
792         pid_t sender_pid;
793         int sender_sock;
794         uint64_t cookie;
795         uint8_t buf[1];
796 };
797
798 struct unix_msg_ctx {
799         struct unix_dgram_ctx *dgram;
800         size_t fragment_len;
801         uint64_t cookie;
802
803         void (*recv_callback)(struct unix_msg_ctx *ctx,
804                               uint8_t *msg, size_t msg_len,
805                               int *fds, size_t num_fds,
806                               void *private_data);
807         void *private_data;
808
809         struct unix_msg *msgs;
810 };
811
812 static void unix_msg_recv(struct unix_dgram_ctx *dgram_ctx,
813                           uint8_t *buf, size_t buflen,
814                           int *fds, size_t num_fds,
815                           void *private_data);
816
817 int unix_msg_init(const struct sockaddr_un *addr,
818                   const struct poll_funcs *ev_funcs,
819                   size_t fragment_len, uint64_t cookie,
820                   void (*recv_callback)(struct unix_msg_ctx *ctx,
821                                         uint8_t *msg, size_t msg_len,
822                                         int *fds, size_t num_fds,
823                                         void *private_data),
824                   void *private_data,
825                   struct unix_msg_ctx **result)
826 {
827         struct unix_msg_ctx *ctx;
828         int ret;
829
830         ctx = malloc(sizeof(*ctx));
831         if (ctx == NULL) {
832                 return ENOMEM;
833         }
834
835         *ctx = (struct unix_msg_ctx) {
836                 .fragment_len = fragment_len,
837                 .cookie = cookie,
838                 .recv_callback = recv_callback,
839                 .private_data = private_data
840         };
841
842         ret = unix_dgram_init(addr, fragment_len, ev_funcs,
843                               unix_msg_recv, ctx, &ctx->dgram);
844         if (ret != 0) {
845                 free(ctx);
846                 return ret;
847         }
848
849         *result = ctx;
850         return 0;
851 }
852
853 int unix_msg_send(struct unix_msg_ctx *ctx, const struct sockaddr_un *dst,
854                   const struct iovec *iov, int iovlen,
855                   const int *fds, size_t num_fds)
856 {
857         ssize_t msglen;
858         size_t sent;
859         int ret = 0;
860         struct iovec iov_copy[iovlen+2];
861         struct unix_msg_hdr hdr;
862         struct iovec src_iov;
863
864         if (iovlen < 0) {
865                 return EINVAL;
866         }
867
868         msglen = iov_buflen(iov, iovlen);
869         if (msglen == -1) {
870                 return EINVAL;
871         }
872
873 #ifndef HAVE_STRUCT_MSGHDR_MSG_CONTROL
874         if (num_fds > 0) {
875                 return ENOSYS;
876         }
877 #endif /* ! HAVE_STRUCT_MSGHDR_MSG_CONTROL */
878
879         if (num_fds > INT8_MAX) {
880                 return EINVAL;
881         }
882
883         if (msglen <= (ctx->fragment_len - sizeof(uint64_t))) {
884                 uint64_t cookie = 0;
885
886                 iov_copy[0].iov_base = &cookie;
887                 iov_copy[0].iov_len = sizeof(cookie);
888                 if (iovlen > 0) {
889                         memcpy(&iov_copy[1], iov,
890                                sizeof(struct iovec) * iovlen);
891                 }
892
893                 return unix_dgram_send(ctx->dgram, dst, iov_copy, iovlen+1,
894                                        fds, num_fds);
895         }
896
897         hdr = (struct unix_msg_hdr) {
898                 .msglen = msglen,
899                 .pid = getpid(),
900                 .sock = unix_dgram_sock(ctx->dgram)
901         };
902
903         iov_copy[0].iov_base = &ctx->cookie;
904         iov_copy[0].iov_len = sizeof(ctx->cookie);
905         iov_copy[1].iov_base = &hdr;
906         iov_copy[1].iov_len = sizeof(hdr);
907
908         sent = 0;
909         src_iov = iov[0];
910
911         /*
912          * The following write loop sends the user message in pieces. We have
913          * filled the first two iovecs above with "cookie" and "hdr". In the
914          * following loops we pull message chunks from the user iov array and
915          * fill iov_copy piece by piece, possibly truncating chunks from the
916          * caller's iov array. Ugly, but hopefully efficient.
917          */
918
919         while (sent < msglen) {
920                 size_t fragment_len;
921                 size_t iov_index = 2;
922
923                 fragment_len = sizeof(ctx->cookie) + sizeof(hdr);
924
925                 while (fragment_len < ctx->fragment_len) {
926                         size_t space, chunk;
927
928                         space = ctx->fragment_len - fragment_len;
929                         chunk = MIN(space, src_iov.iov_len);
930
931                         iov_copy[iov_index].iov_base = src_iov.iov_base;
932                         iov_copy[iov_index].iov_len = chunk;
933                         iov_index += 1;
934
935                         src_iov.iov_base = (char *)src_iov.iov_base + chunk;
936                         src_iov.iov_len -= chunk;
937                         fragment_len += chunk;
938
939                         if (src_iov.iov_len == 0) {
940                                 iov += 1;
941                                 iovlen -= 1;
942                                 if (iovlen == 0) {
943                                         break;
944                                 }
945                                 src_iov = iov[0];
946                         }
947                 }
948                 sent += (fragment_len - sizeof(ctx->cookie) - sizeof(hdr));
949
950                 /*
951                  * only the last fragment should pass the fd array.
952                  * That simplifies the receiver a lot.
953                  */
954                 if (sent < msglen) {
955                         ret = unix_dgram_send(ctx->dgram, dst,
956                                               iov_copy, iov_index,
957                                               NULL, 0);
958                 } else {
959                         ret = unix_dgram_send(ctx->dgram, dst,
960                                               iov_copy, iov_index,
961                                               fds, num_fds);
962                 }
963                 if (ret != 0) {
964                         break;
965                 }
966         }
967
968         ctx->cookie += 1;
969         if (ctx->cookie == 0) {
970                 ctx->cookie += 1;
971         }
972
973         return ret;
974 }
975
976 static void unix_msg_recv(struct unix_dgram_ctx *dgram_ctx,
977                           uint8_t *buf, size_t buflen,
978                           int *fds, size_t num_fds,
979                           void *private_data)
980 {
981         struct unix_msg_ctx *ctx = (struct unix_msg_ctx *)private_data;
982         struct unix_msg_hdr hdr;
983         struct unix_msg *msg;
984         size_t space;
985         uint64_t cookie;
986
987         if (buflen < sizeof(cookie)) {
988                 close_fd_array(fds, num_fds);
989                 return;
990         }
991         memcpy(&cookie, buf, sizeof(cookie));
992
993         buf += sizeof(cookie);
994         buflen -= sizeof(cookie);
995
996         if (cookie == 0) {
997                 ctx->recv_callback(ctx, buf, buflen, fds, num_fds, ctx->private_data);
998                 return;
999         }
1000
1001         if (buflen < sizeof(hdr)) {
1002                 close_fd_array(fds, num_fds);
1003                 return;
1004         }
1005         memcpy(&hdr, buf, sizeof(hdr));
1006
1007         buf += sizeof(hdr);
1008         buflen -= sizeof(hdr);
1009
1010         for (msg = ctx->msgs; msg != NULL; msg = msg->next) {
1011                 if ((msg->sender_pid == hdr.pid) &&
1012                     (msg->sender_sock == hdr.sock)) {
1013                         break;
1014                 }
1015         }
1016
1017         if ((msg != NULL) && (msg->cookie != cookie)) {
1018                 DLIST_REMOVE(ctx->msgs, msg);
1019                 free(msg);
1020                 msg = NULL;
1021         }
1022
1023         if (msg == NULL) {
1024                 msg = malloc(offsetof(struct unix_msg, buf) + hdr.msglen);
1025                 if (msg == NULL) {
1026                         close_fd_array(fds, num_fds);
1027                         return;
1028                 }
1029                 *msg = (struct unix_msg) {
1030                         .msglen = hdr.msglen,
1031                         .sender_pid = hdr.pid,
1032                         .sender_sock = hdr.sock,
1033                         .cookie = cookie
1034                 };
1035                 DLIST_ADD(ctx->msgs, msg);
1036         }
1037
1038         space = msg->msglen - msg->received;
1039         if (buflen > space) {
1040                 close_fd_array(fds, num_fds);
1041                 return;
1042         }
1043
1044         memcpy(msg->buf + msg->received, buf, buflen);
1045         msg->received += buflen;
1046
1047         if (msg->received < msg->msglen) {
1048                 close_fd_array(fds, num_fds);
1049                 return;
1050         }
1051
1052         DLIST_REMOVE(ctx->msgs, msg);
1053         ctx->recv_callback(ctx, msg->buf, msg->msglen, fds, num_fds, ctx->private_data);
1054         free(msg);
1055 }
1056
1057 int unix_msg_free(struct unix_msg_ctx *ctx)
1058 {
1059         int ret;
1060
1061         ret = unix_dgram_free(ctx->dgram);
1062         if (ret != 0) {
1063                 return ret;
1064         }
1065
1066         while (ctx->msgs != NULL) {
1067                 struct unix_msg *msg = ctx->msgs;
1068                 DLIST_REMOVE(ctx->msgs, msg);
1069                 free(msg);
1070         }
1071
1072         free(ctx);
1073         return 0;
1074 }
1075
1076 static ssize_t iov_buflen(const struct iovec *iov, int iovlen)
1077 {
1078         size_t buflen = 0;
1079         int i;
1080
1081         for (i=0; i<iovlen; i++) {
1082                 size_t thislen = iov[i].iov_len;
1083                 size_t tmp = buflen + thislen;
1084
1085                 if ((tmp < buflen) || (tmp < thislen)) {
1086                         /* overflow */
1087                         return -1;
1088                 }
1089                 buflen = tmp;
1090         }
1091         return buflen;
1092 }