]> arthur.barton.de Git - netatalk.git/blob - libatalk/util/socket.c
Adjust loglevel
[netatalk.git] / libatalk / util / socket.c
1 /*
2    Copyright (c) 2009 Frank Lahm <franklahm@gmail.com>
3
4    This program is free software; you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation; either version 2 of the License, or
7    (at your option) any later version.
8  
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13 */
14
15 /*!
16  * @file
17  * Netatalk utility functions
18  */
19
20 #ifdef HAVE_CONFIG_H
21 #include "config.h"
22 #endif /* HAVE_CONFIG_H */
23
24 #if !defined(__FreeBSD__)
25 # ifndef _XOPEN_SOURCE
26 #  define _XOPEN_SOURCE 600
27 # endif
28 # ifndef __EXTENSIONS__
29 #  define __EXTENSIONS__
30 # endif
31 # ifndef _GNU_SOURCE
32 #  define _GNU_SOURCE
33 # endif
34 #endif
35 #include <unistd.h>
36 #include <fcntl.h>
37 #include <sys/types.h>
38 #include <sys/socket.h>
39 #include <arpa/inet.h>
40 #include <netinet/in.h>
41 #include <stdlib.h>
42 #include <string.h>
43 #include <errno.h>
44 #include <sys/time.h>
45 #include <time.h>
46 #include <sys/ioctl.h>
47
48 #include <atalk/logger.h>
49 #include <atalk/util.h>
50
51 static char ipv4mapprefix[] = {0,0,0,0,0,0,0,0,0,0,0xff,0xff};
52
53 /*!
54  * @brief set or unset non-blocking IO on a fd
55  *
56  * @param     fd         (r) File descriptor
57  * @param     cmd        (r) 0: disable non-blocking IO, ie block\n
58  *                           <>0: enable non-blocking IO
59  *
60  * @returns   0 on success, -1 on failure
61  */
62 int setnonblock(int fd, int cmd)
63 {
64     int ofdflags;
65     int fdflags;
66
67     if ((fdflags = ofdflags = fcntl(fd, F_GETFL, 0)) == -1)
68         return -1;
69
70     if (cmd)
71         fdflags |= O_NONBLOCK;
72     else
73         fdflags &= ~O_NONBLOCK;
74
75     if (fdflags != ofdflags)
76         if (fcntl(fd, F_SETFL, fdflags) == -1)
77             return -1;
78
79     return 0;
80 }
81
82 /*!
83  * non-blocking drop-in replacement for read with timeout using select
84  *
85  * @param socket          (r)  socket, if in blocking mode, pass "setnonblocking" arg as 1
86  * @param data            (rw) buffer for the read data
87  * @param lenght          (r)  how many bytes to read
88  * @param setnonblocking  (r)  when non-zero this func will enable and disable non blocking
89  *                             io mode for the socket
90  * @param timeout         (r)  number of seconds to try reading
91  *
92  * @returns number of bytes actually read or -1 on timeout or error
93  */
94 ssize_t readt(int socket, void *data, const size_t length, int setnonblocking, int timeout)
95 {
96     size_t stored = 0;
97     ssize_t len = 0;
98     struct timeval now, end, tv;
99     fd_set rfds;
100     int ret;
101
102     FD_ZERO(&rfds);
103
104     if (setnonblocking) {
105         if (setnonblock(socket, 1) != 0)
106             return -1;
107     }
108
109     /* Calculate end time */
110     (void)gettimeofday(&now, NULL);
111     end = now;
112     end.tv_sec += timeout;
113
114     while (stored < length) {
115         len = read(socket, (char *) data + stored, length - stored);
116         if (len == -1) {
117             switch (errno) {
118             case EINTR:
119                 continue;
120             case EAGAIN:
121                 FD_SET(socket, &rfds);
122                 tv.tv_usec = 0;
123                 tv.tv_sec  = timeout;
124                         
125                 while ((ret = select(socket + 1, &rfds, NULL, NULL, &tv)) < 1) {
126                     switch (ret) {
127                     case 0:
128                         LOG(log_maxdebug, logtype_afpd, "select timeout %d s", timeout);
129                         errno = EAGAIN;
130                         goto exit;
131
132                     default: /* -1 */
133                         if (errno == EINTR) {
134                             (void)gettimeofday(&now, NULL);
135                             if (now.tv_sec >= end.tv_sec && now.tv_usec >= end.tv_usec) {
136                                 LOG(log_warning, logtype_afpd, "select timeout %d s", timeout);
137                                 goto exit;
138                             }
139                             if (now.tv_usec > end.tv_usec) {
140                                 tv.tv_usec = 1000000 + end.tv_usec - now.tv_usec;
141                                 tv.tv_sec  = end.tv_sec - now.tv_sec - 1;
142                             } else {
143                                 tv.tv_usec = end.tv_usec - now.tv_usec;
144                                 tv.tv_sec  = end.tv_sec - now.tv_sec;
145                             }
146                             FD_SET(socket, &rfds);
147                             continue;
148                         }
149                         LOG(log_error, logtype_afpd, "select: %s", strerror(errno));
150                         stored = -1;
151                         goto exit;
152                     }
153                 } /* while (select) */
154                 continue;
155             } /* switch (errno) */
156             LOG(log_error, logtype_afpd, "read: %s", strerror(errno));
157             stored = -1;
158             goto exit;
159         } /* (len == -1) */
160         else if (len > 0)
161             stored += len;
162         else
163             break;
164     } /* while (stored < length) */
165
166 exit:
167     if (setnonblocking) {
168         if (setnonblock(socket, 0) != 0)
169             return -1;
170     }
171
172     if (len == -1 && stored == 0)
173         /* last read or select got an error and we haven't got yet anything => return -1*/
174         return -1;
175     return stored;
176 }
177
178 /*!
179  * non-blocking drop-in replacement for read with timeout using select
180  *
181  * @param socket          (r)  socket, if in blocking mode, pass "setnonblocking" arg as 1
182  * @param data            (rw) buffer for the read data
183  * @param lenght          (r)  how many bytes to read
184  * @param setnonblocking  (r)  when non-zero this func will enable and disable non blocking
185  *                             io mode for the socket
186  * @param timeout         (r)  number of seconds to try reading
187  *
188  * @returns number of bytes actually read or -1 on fatal error
189  */
190 ssize_t writet(int socket, void *data, const size_t length, int setnonblocking, int timeout)
191 {
192     size_t stored = 0;
193     ssize_t len = 0;
194     struct timeval now, end, tv;
195     fd_set rfds;
196     int ret;
197
198     if (setnonblocking) {
199         if (setnonblock(socket, 1) != 0)
200             return -1;
201     }
202
203     /* Calculate end time */
204     (void)gettimeofday(&now, NULL);
205     end = now;
206     end.tv_sec += timeout;
207
208     while (stored < length) {
209         len = write(socket, (char *) data + stored, length - stored);
210         if (len == -1) {
211             switch (errno) {
212             case EINTR:
213                 continue;
214             case EAGAIN:
215                 FD_ZERO(&rfds);
216                 FD_SET(socket, &rfds);
217                 tv.tv_usec = 0;
218                 tv.tv_sec  = timeout;
219                         
220                 while ((ret = select(socket + 1, &rfds, NULL, NULL, &tv)) < 1) {
221                     switch (ret) {
222                     case 0:
223                         LOG(log_warning, logtype_afpd, "select timeout %d s", timeout);
224                         goto exit;
225
226                     default: /* -1 */
227                         if (errno == EINTR) {
228                             (void)gettimeofday(&now, NULL);
229                             if (now.tv_sec >= end.tv_sec && now.tv_usec >= end.tv_usec) {
230                                 LOG(log_warning, logtype_afpd, "select timeout %d s", timeout);
231                                 goto exit;
232                             }
233                             if (now.tv_usec > end.tv_usec) {
234                                 tv.tv_usec = 1000000 + end.tv_usec - now.tv_usec;
235                                 tv.tv_sec  = end.tv_sec - now.tv_sec - 1;
236                             } else {
237                                 tv.tv_usec = end.tv_usec - now.tv_usec;
238                                 tv.tv_sec  = end.tv_sec - now.tv_sec;
239                             }
240                             FD_ZERO(&rfds);
241                             FD_SET(socket, &rfds);
242                             continue;
243                         }
244                         LOG(log_error, logtype_afpd, "select: %s", strerror(errno));
245                         stored = -1;
246                         goto exit;
247                     }
248                 } /* while (select) */
249                 continue;
250             } /* switch (errno) */
251             LOG(log_error, logtype_afpd, "read: %s", strerror(errno));
252             stored = -1;
253             goto exit;
254         } /* (len == -1) */
255         else if (len > 0)
256             stored += len;
257         else
258             break;
259     } /* while (stored < length) */
260
261 exit:
262     if (setnonblocking) {
263         if (setnonblock(socket, 0) != 0)
264             return -1;
265     }
266
267     if (len == -1 && stored == 0)
268         /* last read or select got an error and we haven't got yet anything => return -1*/
269         return -1;
270     return stored;
271 }
272
273 /*!
274  * @brief convert an IPv4 or IPv6 address to a static string using inet_ntop
275  *
276  * IPv6 mapped IPv4 addresses are returned as IPv4 addreses eg
277  * ::ffff:10.0.0.0 is returned as "10.0.0.0".
278  *
279  * @param  sa        (r) pointer to an struct sockaddr
280  *
281  * @returns pointer to a static string cotaining the converted address as string.\n
282  *          On error pointers to "0.0.0.0" or "::0" are returned.
283  */
284 const char *getip_string(const struct sockaddr *sa)
285 {
286     static char ip4[INET_ADDRSTRLEN];
287     static char ip6[INET6_ADDRSTRLEN];
288
289     switch (sa->sa_family) {
290
291     case AF_INET: {
292         const struct sockaddr_in *sai4 = (const struct sockaddr_in *)sa;
293         if ((inet_ntop(AF_INET, &(sai4->sin_addr), ip4, INET_ADDRSTRLEN)) == NULL)
294             return "0.0.0.0";
295         return ip4;
296     }
297     case AF_INET6: {
298         const struct sockaddr_in6 *sai6 = (const struct sockaddr_in6 *)sa;
299         if ((inet_ntop(AF_INET6, &(sai6->sin6_addr), ip6, INET6_ADDRSTRLEN)) == NULL)
300             return "::0";
301
302         /* Deal with IPv6 mapped IPv4 addresses*/
303         if ((memcmp(sai6->sin6_addr.s6_addr, ipv4mapprefix, sizeof(ipv4mapprefix))) == 0)
304             return (strrchr(ip6, ':') + 1);
305         return ip6;
306     }
307     default:
308         return "getip_string ERROR";
309     }
310
311     /* We never get here */
312 }
313
314 /*!
315  * @brief return port number from struct sockaddr
316  *
317  * @param  sa        (r) pointer to an struct sockaddr
318  *
319  * @returns port as unsigned int
320  */
321 unsigned int getip_port(const struct sockaddr  *sa)
322 {
323     if (sa->sa_family == AF_INET) { /* IPv4 */
324         const struct sockaddr_in *sai4 = (const struct sockaddr_in *)sa;
325         return ntohs(sai4->sin_port);
326     } else {                       /* IPv6 */
327         const struct sockaddr_in6 *sai6 = (const struct sockaddr_in6 *)sa;
328         return ntohs(sai6->sin6_port);
329     }
330
331     /* We never get here */
332 }
333
334 /*!
335  * @brief apply netmask to IP (v4 or v6)
336  *
337  * Modifies IP address in sa->sin[6]_addr-s[6]_addr. The caller is responsible
338  * for passing a value for mask that is sensible to the passed address,
339  * eg 0 <= mask <= 32 for IPv4 or 0<= mask <= 128 for IPv6. mask > 32 for
340  * IPv4 is treated as mask = 32, mask > 128 is set to 128 for IPv6.
341  *
342  * @param  ai        (rw) pointer to an struct sockaddr
343  * @parma  mask      (r) number of maskbits
344  */
345 void apply_ip_mask(struct sockaddr *sa, int mask)
346 {
347
348     switch (sa->sa_family) {
349     case AF_INET: {
350         if (mask >= 32)
351             return;
352
353         struct sockaddr_in *si = (struct sockaddr_in *)sa;
354         uint32_t nmask = mask ? ~((1 << (32 - mask)) - 1) : 0;
355         si->sin_addr.s_addr &= htonl(nmask);
356         break;
357     }
358     case AF_INET6: {
359         if (mask >= 128)
360             return;
361
362         int i, maskbytes, maskbits;
363         struct sockaddr_in6 *si6 = (struct sockaddr_in6 *)sa;
364
365         /* Deal with IPv6 mapped IPv4 addresses*/
366         if ((memcmp(si6->sin6_addr.s6_addr, ipv4mapprefix, sizeof(ipv4mapprefix))) == 0) {
367             mask += 96;
368             if (mask >= 128)
369                 return;
370         }
371
372         maskbytes = (128 - mask) / 8; /* maskbytes really are those that will be 0'ed */
373         maskbits = mask % 8;
374
375         for (i = maskbytes - 1; i >= 0; i--)
376             si6->sin6_addr.s6_addr[15 - i] = 0;
377         if (maskbits)
378             si6->sin6_addr.s6_addr[15 - maskbytes] &= ~((1 << (8 - maskbits)) - 1);
379         break;
380     }
381     default:
382         break;
383     }
384 }
385
386 /*!
387  * @brief compare IP addresses for equality
388  *
389  * @param  sa1       (r) pointer to an struct sockaddr
390  * @param  sa2       (r) pointer to an struct sockaddr
391  *
392  * @returns Addresses are converted to strings and compared with strcmp and
393  *          the result of strcmp is returned.
394  *
395  * @note IPv6 mapped IPv4 addresses are treated as IPv4 addresses.
396  */
397 int compare_ip(const struct sockaddr *sa1, const struct sockaddr *sa2)
398 {
399     int ret;
400     char *ip1;
401     const char *ip2;
402
403     ip1 = strdup(getip_string(sa1));
404     ip2 = getip_string(sa2);
405
406     ret = strcmp(ip1, ip2);
407
408     free(ip1);
409
410     return ret;
411 }
412
413 #define POLL_FD_SET_STARTSIZE 512
414 #define POLL_FD_SET_INCREASE  128
415 /*!
416  * Add a fd to a dynamic pollfd array that is allocated and grown as needed
417  *
418  * This uses an additional array of struct polldata which stores type information
419  * (enum fdtype) and a pointer to anciliary user data.
420  *
421  * 1. Allocate the arrays with an intial size of [POLL_FD_SET_STARTSIZE] if
422  *    *fdsetp is NULL.
423  * 2. Grow array as needed
424  * 3. Fill in both array elements and increase count of used elements
425  * 
426  * @param fdsetp      (rw) pointer to callers pointer to the pollfd array
427  * @param polldatap   (rw) pointer to callers pointer to the polldata array
428  * @param fdset_usedp (rw) pointer to an int with the number of used elements
429  * @param fdset_sizep (rw) pointer to an int which stores the array sizes
430  * @param fd          (r)  file descriptor to add to the arrays
431  * @param fdtype      (r)  type of fd, currently IPC_FD or LISTEN_FD
432  * @param data        (rw) pointer to data the caller want to associate with an fd
433  */
434 void fdset_add_fd(struct pollfd **fdsetp,
435                   struct polldata **polldatap,
436                   int *fdset_usedp,
437                   int *fdset_sizep,
438                   int fd,
439                   enum fdtype fdtype,
440                   void *data)
441 {
442     struct pollfd *fdset = *fdsetp;
443     struct polldata *polldata = *polldatap;
444     int fdset_size = *fdset_sizep;
445
446     LOG(log_debug, logtype_default, "fdset_add_fd: adding fd %i in slot %i", fd, *fdset_usedp);
447
448     if (fdset == NULL) { /* 1 */
449         /* Initialize with space for 512 fds */
450         fdset = calloc(POLL_FD_SET_STARTSIZE, sizeof(struct pollfd));
451         if (! fdset)
452             exit(EXITERR_SYS);
453
454         polldata = calloc(POLL_FD_SET_STARTSIZE, sizeof(struct polldata));
455         if (! polldata)
456             exit(EXITERR_SYS);
457
458         fdset_size = 512;
459         *fdset_sizep = fdset_size;
460         *fdsetp = fdset;
461         *polldatap = polldata;
462     }
463
464     if (*fdset_usedp >= fdset_size) { /* 2 */
465         fdset = realloc(fdset, sizeof(struct pollfd) * (fdset_size + POLL_FD_SET_INCREASE));
466         if (fdset == NULL)
467             exit(EXITERR_SYS);
468
469         polldata = realloc(polldata, sizeof(struct polldata) * (fdset_size + POLL_FD_SET_INCREASE));
470         if (polldata == NULL)
471             exit(EXITERR_SYS);
472
473         fdset_size += POLL_FD_SET_INCREASE;
474         *fdset_sizep = fdset_size;
475         *fdsetp = fdset;
476         *polldatap = polldata;
477     }
478
479     /* 3 */
480     fdset[*fdset_usedp].fd = fd;
481     fdset[*fdset_usedp].events = POLLIN;
482     polldata[*fdset_usedp].fdtype = fdtype;
483     polldata[*fdset_usedp].data = data;
484     (*fdset_usedp)++;
485 }
486
487 /*!
488  * Remove a fd from our pollfd array
489  *
490  * 1. Search fd
491  * 2a 
492  * 2b If we remove the last array elemnt, just decrease count
493  * 3. If found move all following elements down by one
494  * 4. Decrease count of used elements in array
495  *
496  * This currently doesn't shrink the allocated storage of the array.
497  *
498  * @param fdsetp      (rw) pointer to callers pointer to the pollfd array
499  * @param polldatap   (rw) pointer to callers pointer to the polldata array
500  * @param fdset_usedp (rw) pointer to an int with the number of used elements
501  * @param fdset_sizep (rw) pointer to an int which stores the array sizes
502  * @param fd          (r)  file descriptor to remove from the arrays
503  */
504 void fdset_del_fd(struct pollfd **fdsetp,
505                   struct polldata **polldatap,
506                   int *fdset_usedp,
507                   int *fdset_sizep _U_,
508                   int fd)
509 {
510     struct pollfd *fdset = *fdsetp;
511     struct polldata *polldata = *polldatap;
512
513     if (*fdset_usedp < 1)
514         return;
515
516     for (int i = 0; i < *fdset_usedp; i++) {
517         if (fdset[i].fd == fd) { /* 1 */
518             if (i == 0 && *fdset_usedp == 1) { /* 2a */
519                 fdset[i].fd = -1;
520                 memset(&polldata[i], 0, sizeof(struct polldata));
521             } else if (i < (*fdset_usedp - 1)) { /* 2b */
522                 memmove(&fdset[i], &fdset[i+1], (*fdset_usedp - 1) * sizeof(struct pollfd)); /* 3 */
523                 memmove(&polldata[i], &polldata[i+1], (*fdset_usedp - 1) * sizeof(struct polldata)); /* 3 */
524             }
525             (*fdset_usedp)--;
526             break;
527         }
528     }
529 }
530
531 /* Length of the space taken up by a padded control message of length len */
532 #ifndef CMSG_SPACE
533 #define CMSG_SPACE(len) (__CMSG_ALIGN(sizeof(struct cmsghdr)) + __CMSG_ALIGN(len))
534 #endif
535
536 /*
537  * Receive a fd on a suitable socket
538  * @args fd          (r) PF_UNIX socket to receive on
539  * @args nonblocking (r) 0: fd is in blocking mode - 1: fd is nonblocking, poll for 1 sec
540  * @returns fd on success, -1 on error
541  */
542 int recv_fd(int fd, int nonblocking)
543 {
544     int ret;
545     struct msghdr msgh;
546     struct iovec iov[1];
547     struct cmsghdr *cmsgp = NULL;
548     char buf[CMSG_SPACE(sizeof(int))];
549     char dbuf[80];
550     struct pollfd pollfds[1];
551
552     pollfds[0].fd = fd;
553     pollfds[0].events = POLLIN;
554
555     memset(&msgh,0,sizeof(msgh));
556     memset(buf,0,sizeof(buf));
557
558     msgh.msg_name = NULL;
559     msgh.msg_namelen = 0;
560
561     msgh.msg_iov = iov;
562     msgh.msg_iovlen = 1;
563
564     iov[0].iov_base = dbuf;
565     iov[0].iov_len = sizeof(dbuf);
566
567     msgh.msg_control = buf;
568     msgh.msg_controllen = sizeof(buf);
569
570     if (nonblocking) {
571         do {
572             ret = poll(pollfds, 1, 2000); /* poll 2 seconds, evtl. multipe times (EINTR) */
573         } while ( ret == -1 && errno == EINTR );
574         if (ret != 1)
575             return -1;
576         ret = recvmsg(fd, &msgh, 0);
577     } else {
578         do  {
579             ret = recvmsg(fd, &msgh, 0);
580         } while ( ret == -1 && errno == EINTR );
581     }
582
583     if ( ret == -1 ) {
584         return -1;
585     }
586
587     for ( cmsgp = CMSG_FIRSTHDR(&msgh); cmsgp != NULL; cmsgp = CMSG_NXTHDR(&msgh,cmsgp) ) {
588         if ( cmsgp->cmsg_level == SOL_SOCKET && cmsgp->cmsg_type == SCM_RIGHTS ) {
589             return *(int *) CMSG_DATA(cmsgp);
590         }
591     }
592
593     if ( ret == sizeof (int) )
594         errno = *(int *)dbuf; /* Rcvd errno */
595     else
596         errno = ENOENT;    /* Default errno */
597
598     return -1;
599 }
600
601 /*
602  * Send a fd across a suitable socket
603  */
604 int send_fd(int socket, int fd)
605 {
606     int ret;
607     struct msghdr msgh;
608     struct iovec iov[1];
609     struct cmsghdr *cmsgp = NULL;
610     char *buf;
611     size_t size;
612     int er=0;
613
614     size = CMSG_SPACE(sizeof fd);
615     buf = malloc(size);
616     if (!buf) {
617         LOG(log_error, logtype_cnid, "error in sendmsg: %s", strerror(errno));
618         return -1;
619     }
620
621     memset(&msgh,0,sizeof (msgh));
622     memset(buf,0, size);
623
624     msgh.msg_name = NULL;
625     msgh.msg_namelen = 0;
626
627     msgh.msg_iov = iov;
628     msgh.msg_iovlen = 1;
629
630     iov[0].iov_base = &er;
631     iov[0].iov_len = sizeof(er);
632
633     msgh.msg_control = buf;
634     msgh.msg_controllen = size;
635
636     cmsgp = CMSG_FIRSTHDR(&msgh);
637     cmsgp->cmsg_level = SOL_SOCKET;
638     cmsgp->cmsg_type = SCM_RIGHTS;
639     cmsgp->cmsg_len = CMSG_LEN(sizeof(fd));
640
641     *((int *)CMSG_DATA(cmsgp)) = fd;
642     msgh.msg_controllen = cmsgp->cmsg_len;
643
644     do  {
645         ret = sendmsg(socket,&msgh, 0);
646     } while ( ret == -1 && errno == EINTR );
647     if (ret == -1) {
648         LOG(log_error, logtype_cnid, "error in sendmsg: %s", strerror(errno));
649         free(buf);
650         return -1;
651     }
652     free(buf);
653     return 0;
654 }