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