2 Copyright (c) 2009 Frank Lahm <franklahm@gmail.com>
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.
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.
17 * Netatalk utility functions
22 #endif /* HAVE_CONFIG_H */
24 #if !defined(__FreeBSD__)
25 # ifndef _XOPEN_SOURCE
26 # define _XOPEN_SOURCE 600
28 # ifndef __EXTENSIONS__
29 # define __EXTENSIONS__
37 #include <sys/types.h>
38 #include <sys/socket.h>
39 #include <arpa/inet.h>
40 #include <netinet/in.h>
46 #include <sys/ioctl.h>
48 #include <atalk/logger.h>
49 #include <atalk/util.h>
51 static char ipv4mapprefix[] = {0,0,0,0,0,0,0,0,0,0,0xff,0xff};
54 * @brief set or unset non-blocking IO on a fd
56 * @param fd (r) File descriptor
57 * @param cmd (r) 0: disable non-blocking IO, ie block\n
58 * <>0: enable non-blocking IO
60 * @returns 0 on success, -1 on failure
62 int setnonblock(int fd, int cmd)
67 if ((fdflags = ofdflags = fcntl(fd, F_GETFL, 0)) == -1)
71 fdflags |= O_NONBLOCK;
73 fdflags &= ~O_NONBLOCK;
75 if (fdflags != ofdflags)
76 if (fcntl(fd, F_SETFL, fdflags) == -1)
83 * non-blocking drop-in replacement for read with timeout using select
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
92 * @returns number of bytes actually read or -1 on timeout or error
94 ssize_t readt(int socket, void *data, const size_t length, int setnonblocking, int timeout)
98 struct timeval now, end, tv;
104 if (setnonblocking) {
105 if (setnonblock(socket, 1) != 0)
109 /* Calculate end time */
110 (void)gettimeofday(&now, NULL);
112 end.tv_sec += timeout;
114 while (stored < length) {
115 len = read(socket, (char *) data + stored, length - stored);
121 FD_SET(socket, &rfds);
125 while ((ret = select(socket + 1, &rfds, NULL, NULL, &tv)) < 1) {
128 LOG(log_debug, logtype_afpd, "select timeout %d s", timeout);
135 (void)gettimeofday(&now, NULL);
136 if (now.tv_sec >= end.tv_sec && now.tv_usec >= end.tv_usec) {
137 LOG(log_debug, logtype_afpd, "select timeout %d s", timeout);
140 if (now.tv_usec > end.tv_usec) {
141 tv.tv_usec = 1000000 + end.tv_usec - now.tv_usec;
142 tv.tv_sec = end.tv_sec - now.tv_sec - 1;
144 tv.tv_usec = end.tv_usec - now.tv_usec;
145 tv.tv_sec = end.tv_sec - now.tv_sec;
147 FD_SET(socket, &rfds);
150 /* possibly entered disconnected state, don't spam log here */
151 LOG(log_debug, logtype_afpd, "select: %s", strerror(errno));
155 LOG(log_error, logtype_afpd, "select: %s", strerror(errno));
160 } /* while (select) */
162 } /* switch (errno) */
163 LOG(log_error, logtype_afpd, "read: %s", strerror(errno));
171 } /* while (stored < length) */
174 if (setnonblocking) {
175 if (setnonblock(socket, 0) != 0)
179 if (len == -1 && stored == 0)
180 /* last read or select got an error and we haven't got yet anything => return -1*/
186 * non-blocking drop-in replacement for read with timeout using select
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
195 * @returns number of bytes actually read or -1 on fatal error
197 ssize_t writet(int socket, void *data, const size_t length, int setnonblocking, int timeout)
201 struct timeval now, end, tv;
205 if (setnonblocking) {
206 if (setnonblock(socket, 1) != 0)
210 /* Calculate end time */
211 (void)gettimeofday(&now, NULL);
213 end.tv_sec += timeout;
215 while (stored < length) {
216 len = write(socket, (char *) data + stored, length - stored);
223 FD_SET(socket, &rfds);
227 while ((ret = select(socket + 1, &rfds, NULL, NULL, &tv)) < 1) {
230 LOG(log_warning, logtype_afpd, "select timeout %d s", timeout);
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);
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;
244 tv.tv_usec = end.tv_usec - now.tv_usec;
245 tv.tv_sec = end.tv_sec - now.tv_sec;
248 FD_SET(socket, &rfds);
251 LOG(log_error, logtype_afpd, "select: %s", strerror(errno));
255 } /* while (select) */
257 } /* switch (errno) */
258 LOG(log_error, logtype_afpd, "read: %s", strerror(errno));
266 } /* while (stored < length) */
269 if (setnonblocking) {
270 if (setnonblock(socket, 0) != 0)
274 if (len == -1 && stored == 0)
275 /* last read or select got an error and we haven't got yet anything => return -1*/
281 * @brief convert an IPv4 or IPv6 address to a static string using inet_ntop
283 * IPv6 mapped IPv4 addresses are returned as IPv4 addreses eg
284 * ::ffff:10.0.0.0 is returned as "10.0.0.0".
286 * @param sa (r) pointer to an struct sockaddr
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.
291 const char *getip_string(const struct sockaddr *sa)
293 static char ip4[INET_ADDRSTRLEN];
294 static char ip6[INET6_ADDRSTRLEN];
296 switch (sa->sa_family) {
299 const struct sockaddr_in *sai4 = (const struct sockaddr_in *)sa;
300 if ((inet_ntop(AF_INET, &(sai4->sin_addr), ip4, INET_ADDRSTRLEN)) == NULL)
305 const struct sockaddr_in6 *sai6 = (const struct sockaddr_in6 *)sa;
306 if ((inet_ntop(AF_INET6, &(sai6->sin6_addr), ip6, INET6_ADDRSTRLEN)) == NULL)
309 /* Deal with IPv6 mapped IPv4 addresses*/
310 if ((memcmp(sai6->sin6_addr.s6_addr, ipv4mapprefix, sizeof(ipv4mapprefix))) == 0)
311 return (strrchr(ip6, ':') + 1);
315 return "getip_string ERROR";
318 /* We never get here */
322 * @brief return port number from struct sockaddr
324 * @param sa (r) pointer to an struct sockaddr
326 * @returns port as unsigned int
328 unsigned int getip_port(const struct sockaddr *sa)
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);
334 const struct sockaddr_in6 *sai6 = (const struct sockaddr_in6 *)sa;
335 return ntohs(sai6->sin6_port);
338 /* We never get here */
342 * @brief apply netmask to IP (v4 or v6)
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.
349 * @param ai (rw) pointer to an struct sockaddr
350 * @parma mask (r) number of maskbits
352 void apply_ip_mask(struct sockaddr *sa, int mask)
355 switch (sa->sa_family) {
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);
369 int i, maskbytes, maskbits;
370 struct sockaddr_in6 *si6 = (struct sockaddr_in6 *)sa;
372 /* Deal with IPv6 mapped IPv4 addresses*/
373 if ((memcmp(si6->sin6_addr.s6_addr, ipv4mapprefix, sizeof(ipv4mapprefix))) == 0) {
379 maskbytes = (128 - mask) / 8; /* maskbytes really are those that will be 0'ed */
382 for (i = maskbytes - 1; i >= 0; i--)
383 si6->sin6_addr.s6_addr[15 - i] = 0;
385 si6->sin6_addr.s6_addr[15 - maskbytes] &= ~((1 << (8 - maskbits)) - 1);
394 * @brief compare IP addresses for equality
396 * @param sa1 (r) pointer to an struct sockaddr
397 * @param sa2 (r) pointer to an struct sockaddr
399 * @returns Addresses are converted to strings and compared with strcmp and
400 * the result of strcmp is returned.
402 * @note IPv6 mapped IPv4 addresses are treated as IPv4 addresses.
404 int compare_ip(const struct sockaddr *sa1, const struct sockaddr *sa2)
410 ip1 = strdup(getip_string(sa1));
411 ip2 = getip_string(sa2);
413 ret = strcmp(ip1, ip2);
420 #define POLL_FD_SET_STARTSIZE 512
421 #define POLL_FD_SET_INCREASE 128
423 * Add a fd to a dynamic pollfd array that is allocated and grown as needed
425 * This uses an additional array of struct polldata which stores type information
426 * (enum fdtype) and a pointer to anciliary user data.
428 * 1. Allocate the arrays with an intial size of [POLL_FD_SET_STARTSIZE] if
430 * 2. Grow array as needed
431 * 3. Fill in both array elements and increase count of used elements
433 * @param fdsetp (rw) pointer to callers pointer to the pollfd array
434 * @param polldatap (rw) pointer to callers pointer to the polldata array
435 * @param fdset_usedp (rw) pointer to an int with the number of used elements
436 * @param fdset_sizep (rw) pointer to an int which stores the array sizes
437 * @param fd (r) file descriptor to add to the arrays
438 * @param fdtype (r) type of fd, currently IPC_FD or LISTEN_FD
439 * @param data (rw) pointer to data the caller want to associate with an fd
441 void fdset_add_fd(struct pollfd **fdsetp,
442 struct polldata **polldatap,
449 struct pollfd *fdset = *fdsetp;
450 struct polldata *polldata = *polldatap;
451 int fdset_size = *fdset_sizep;
453 LOG(log_debug, logtype_default, "fdset_add_fd: adding fd %i in slot %i", fd, *fdset_usedp);
455 if (fdset == NULL) { /* 1 */
456 /* Initialize with space for 512 fds */
457 fdset = calloc(POLL_FD_SET_STARTSIZE, sizeof(struct pollfd));
461 polldata = calloc(POLL_FD_SET_STARTSIZE, sizeof(struct polldata));
466 *fdset_sizep = fdset_size;
468 *polldatap = polldata;
471 if (*fdset_usedp >= fdset_size) { /* 2 */
472 fdset = realloc(fdset, sizeof(struct pollfd) * (fdset_size + POLL_FD_SET_INCREASE));
476 polldata = realloc(polldata, sizeof(struct polldata) * (fdset_size + POLL_FD_SET_INCREASE));
477 if (polldata == NULL)
480 fdset_size += POLL_FD_SET_INCREASE;
481 *fdset_sizep = fdset_size;
483 *polldatap = polldata;
487 fdset[*fdset_usedp].fd = fd;
488 fdset[*fdset_usedp].events = POLLIN;
489 polldata[*fdset_usedp].fdtype = fdtype;
490 polldata[*fdset_usedp].data = data;
495 * Remove a fd from our pollfd array
499 * 2b If we remove the last array elemnt, just decrease count
500 * 3. If found move all following elements down by one
501 * 4. Decrease count of used elements in array
503 * This currently doesn't shrink the allocated storage of the array.
505 * @param fdsetp (rw) pointer to callers pointer to the pollfd array
506 * @param polldatap (rw) pointer to callers pointer to the polldata array
507 * @param fdset_usedp (rw) pointer to an int with the number of used elements
508 * @param fdset_sizep (rw) pointer to an int which stores the array sizes
509 * @param fd (r) file descriptor to remove from the arrays
511 void fdset_del_fd(struct pollfd **fdsetp,
512 struct polldata **polldatap,
514 int *fdset_sizep _U_,
517 struct pollfd *fdset = *fdsetp;
518 struct polldata *polldata = *polldatap;
520 if (*fdset_usedp < 1)
523 for (int i = 0; i < *fdset_usedp; i++) {
524 if (fdset[i].fd == fd) { /* 1 */
525 if (i == 0 && *fdset_usedp == 1) { /* 2a */
527 memset(&polldata[i], 0, sizeof(struct polldata));
528 } else if (i < (*fdset_usedp - 1)) { /* 2b */
529 memmove(&fdset[i], &fdset[i+1], (*fdset_usedp - 1) * sizeof(struct pollfd)); /* 3 */
530 memmove(&polldata[i], &polldata[i+1], (*fdset_usedp - 1) * sizeof(struct polldata)); /* 3 */
538 /* Length of the space taken up by a padded control message of length len */
540 #define CMSG_SPACE(len) (__CMSG_ALIGN(sizeof(struct cmsghdr)) + __CMSG_ALIGN(len))
544 * Receive a fd on a suitable socket
545 * @args fd (r) PF_UNIX socket to receive on
546 * @args nonblocking (r) 0: fd is in blocking mode - 1: fd is nonblocking, poll for 1 sec
547 * @returns fd on success, -1 on error
549 int recv_fd(int fd, int nonblocking)
554 struct cmsghdr *cmsgp = NULL;
555 char buf[CMSG_SPACE(sizeof(int))];
557 struct pollfd pollfds[1];
560 pollfds[0].events = POLLIN;
562 memset(&msgh,0,sizeof(msgh));
563 memset(buf,0,sizeof(buf));
565 msgh.msg_name = NULL;
566 msgh.msg_namelen = 0;
571 iov[0].iov_base = dbuf;
572 iov[0].iov_len = sizeof(dbuf);
574 msgh.msg_control = buf;
575 msgh.msg_controllen = sizeof(buf);
579 ret = poll(pollfds, 1, 2000); /* poll 2 seconds, evtl. multipe times (EINTR) */
580 } while ( ret == -1 && errno == EINTR );
583 ret = recvmsg(fd, &msgh, 0);
586 ret = recvmsg(fd, &msgh, 0);
587 } while ( ret == -1 && errno == EINTR );
594 for ( cmsgp = CMSG_FIRSTHDR(&msgh); cmsgp != NULL; cmsgp = CMSG_NXTHDR(&msgh,cmsgp) ) {
595 if ( cmsgp->cmsg_level == SOL_SOCKET && cmsgp->cmsg_type == SCM_RIGHTS ) {
596 return *(int *) CMSG_DATA(cmsgp);
600 if ( ret == sizeof (int) )
601 errno = *(int *)dbuf; /* Rcvd errno */
603 errno = ENOENT; /* Default errno */
609 * Send a fd across a suitable socket
611 int send_fd(int socket, int fd)
616 struct cmsghdr *cmsgp = NULL;
621 size = CMSG_SPACE(sizeof fd);
624 LOG(log_error, logtype_cnid, "error in sendmsg: %s", strerror(errno));
628 memset(&msgh,0,sizeof (msgh));
631 msgh.msg_name = NULL;
632 msgh.msg_namelen = 0;
637 iov[0].iov_base = &er;
638 iov[0].iov_len = sizeof(er);
640 msgh.msg_control = buf;
641 msgh.msg_controllen = size;
643 cmsgp = CMSG_FIRSTHDR(&msgh);
644 cmsgp->cmsg_level = SOL_SOCKET;
645 cmsgp->cmsg_type = SCM_RIGHTS;
646 cmsgp->cmsg_len = CMSG_LEN(sizeof(fd));
648 *((int *)CMSG_DATA(cmsgp)) = fd;
649 msgh.msg_controllen = cmsgp->cmsg_len;
652 ret = sendmsg(socket,&msgh, 0);
653 } while ( ret == -1 && errno == EINTR );
655 LOG(log_error, logtype_cnid, "error in sendmsg: %s", strerror(errno));