ofpbuf: New function ofpbuf_push_zeros().
[openvswitch] / lib / socket-util.c
1 /*
2  * Copyright (c) 2008, 2009, 2010 Nicira Networks.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #include <config.h>
18 #include "socket-util.h"
19 #include <arpa/inet.h>
20 #include <errno.h>
21 #include <fcntl.h>
22 #include <netdb.h>
23 #include <poll.h>
24 #include <stddef.h>
25 #include <stdio.h>
26 #include <stdlib.h>
27 #include <string.h>
28 #include <sys/resource.h>
29 #include <sys/un.h>
30 #include <unistd.h>
31 #include "fatal-signal.h"
32 #include "util.h"
33
34 #include "vlog.h"
35 #define THIS_MODULE VLM_socket_util
36
37 /* Sets 'fd' to non-blocking mode.  Returns 0 if successful, otherwise a
38  * positive errno value. */
39 int
40 set_nonblocking(int fd)
41 {
42     int flags = fcntl(fd, F_GETFL, 0);
43     if (flags != -1) {
44         if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) != -1) {
45             return 0;
46         } else {
47             VLOG_ERR("fcntl(F_SETFL) failed: %s", strerror(errno));
48             return errno;
49         }
50     } else {
51         VLOG_ERR("fcntl(F_GETFL) failed: %s", strerror(errno));
52         return errno;
53     }
54 }
55
56 /* Returns the maximum valid FD value, plus 1. */
57 int
58 get_max_fds(void)
59 {
60     static int max_fds = -1;
61     if (max_fds < 0) {
62         struct rlimit r;
63         if (!getrlimit(RLIMIT_NOFILE, &r)
64             && r.rlim_cur != RLIM_INFINITY
65             && r.rlim_cur != RLIM_SAVED_MAX
66             && r.rlim_cur != RLIM_SAVED_CUR) {
67             max_fds = r.rlim_cur;
68         } else {
69             VLOG_WARN("failed to obtain fd limit, defaulting to 1024");
70             max_fds = 1024;
71         }
72     }
73     return max_fds;
74 }
75
76 /* Translates 'host_name', which must be a string representation of an IP
77  * address, into a numeric IP address in '*addr'.  Returns 0 if successful,
78  * otherwise a positive errno value. */
79 int
80 lookup_ip(const char *host_name, struct in_addr *addr) 
81 {
82     if (!inet_aton(host_name, addr)) {
83         struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
84         VLOG_ERR_RL(&rl, "\"%s\" is not a valid IP address", host_name);
85         return ENOENT;
86     }
87     return 0;
88 }
89
90 /* Returns the error condition associated with socket 'fd' and resets the
91  * socket's error status. */
92 int
93 get_socket_error(int fd) 
94 {
95     int error;
96     socklen_t len = sizeof(error);
97     if (getsockopt(fd, SOL_SOCKET, SO_ERROR, &error, &len) < 0) {
98         struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
99         error = errno;
100         VLOG_ERR_RL(&rl, "getsockopt(SO_ERROR): %s", strerror(error));
101     }
102     return error;
103 }
104
105 int
106 check_connection_completion(int fd) 
107 {
108     struct pollfd pfd;
109     int retval;
110
111     pfd.fd = fd;
112     pfd.events = POLLOUT;
113     do {
114         retval = poll(&pfd, 1, 0);
115     } while (retval < 0 && errno == EINTR);
116     if (retval == 1) {
117         return get_socket_error(fd);
118     } else if (retval < 0) {
119         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
120         VLOG_ERR_RL(&rl, "poll: %s", strerror(errno));
121         return errno;
122     } else {
123         return EAGAIN;
124     }
125 }
126
127 /* Drain all the data currently in the receive queue of a datagram socket (and
128  * possibly additional data).  There is no way to know how many packets are in
129  * the receive queue, but we do know that the total number of bytes queued does
130  * not exceed the receive buffer size, so we pull packets until none are left
131  * or we've read that many bytes. */
132 int
133 drain_rcvbuf(int fd)
134 {
135     socklen_t rcvbuf_len;
136     size_t rcvbuf;
137
138     rcvbuf_len = sizeof rcvbuf;
139     if (getsockopt(fd, SOL_SOCKET, SO_RCVBUF, &rcvbuf, &rcvbuf_len) < 0) {
140         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
141         VLOG_ERR_RL(&rl, "getsockopt(SO_RCVBUF) failed: %s", strerror(errno));
142         return errno;
143     }
144     while (rcvbuf > 0) {
145         /* In Linux, specifying MSG_TRUNC in the flags argument causes the
146          * datagram length to be returned, even if that is longer than the
147          * buffer provided.  Thus, we can use a 1-byte buffer to discard the
148          * incoming datagram and still be able to account how many bytes were
149          * removed from the receive buffer.
150          *
151          * On other Unix-like OSes, MSG_TRUNC has no effect in the flags
152          * argument. */
153 #ifdef __linux__
154 #define BUFFER_SIZE 1
155 #else
156 #define BUFFER_SIZE 2048
157 #endif
158         char buffer[BUFFER_SIZE];
159         ssize_t n_bytes = recv(fd, buffer, sizeof buffer,
160                                MSG_TRUNC | MSG_DONTWAIT);
161         if (n_bytes <= 0 || n_bytes >= rcvbuf) {
162             break;
163         }
164         rcvbuf -= n_bytes;
165     }
166     return 0;
167 }
168
169 /* Reads and discards up to 'n' datagrams from 'fd', stopping as soon as no
170  * more data can be immediately read.  ('fd' should therefore be in
171  * non-blocking mode.)*/
172 void
173 drain_fd(int fd, size_t n_packets)
174 {
175     for (; n_packets > 0; n_packets--) {
176         /* 'buffer' only needs to be 1 byte long in most circumstances.  This
177          * size is defensive against the possibility that we someday want to
178          * use a Linux tap device without TUN_NO_PI, in which case a buffer
179          * smaller than sizeof(struct tun_pi) will give EINVAL on read. */
180         char buffer[128];
181         if (read(fd, buffer, sizeof buffer) <= 0) {
182             break;
183         }
184     }
185 }
186
187 /* Stores in '*un' a sockaddr_un that refers to file 'name'.  Stores in
188  * '*un_len' the size of the sockaddr_un. */
189 static void
190 make_sockaddr_un(const char *name, struct sockaddr_un* un, socklen_t *un_len)
191 {
192     un->sun_family = AF_UNIX;
193     strncpy(un->sun_path, name, sizeof un->sun_path);
194     un->sun_path[sizeof un->sun_path - 1] = '\0';
195     *un_len = (offsetof(struct sockaddr_un, sun_path)
196                 + strlen (un->sun_path) + 1);
197 }
198
199 /* Creates a Unix domain socket in the given 'style' (either SOCK_DGRAM or
200  * SOCK_STREAM) that is bound to '*bind_path' (if 'bind_path' is non-null) and
201  * connected to '*connect_path' (if 'connect_path' is non-null).  If 'nonblock'
202  * is true, the socket is made non-blocking.  If 'passcred' is true, the socket
203  * is configured to receive SCM_CREDENTIALS control messages.
204  *
205  * Returns the socket's fd if successful, otherwise a negative errno value. */
206 int
207 make_unix_socket(int style, bool nonblock, bool passcred OVS_UNUSED,
208                  const char *bind_path, const char *connect_path)
209 {
210     int error;
211     int fd;
212
213     fd = socket(PF_UNIX, style, 0);
214     if (fd < 0) {
215         return -errno;
216     }
217
218     /* Set nonblocking mode right away, if we want it.  This prevents blocking
219      * in connect(), if connect_path != NULL.  (In turn, that's a corner case:
220      * it will only happen if style is SOCK_STREAM or SOCK_SEQPACKET, and only
221      * if a backlog of un-accepted connections has built up in the kernel.)  */
222     if (nonblock) {
223         int flags = fcntl(fd, F_GETFL, 0);
224         if (flags == -1) {
225             goto error;
226         }
227         if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) == -1) {
228             goto error;
229         }
230     }
231
232     if (bind_path) {
233         struct sockaddr_un un;
234         socklen_t un_len;
235         make_sockaddr_un(bind_path, &un, &un_len);
236         if (unlink(un.sun_path) && errno != ENOENT) {
237             VLOG_WARN("unlinking \"%s\": %s\n", un.sun_path, strerror(errno));
238         }
239         fatal_signal_add_file_to_unlink(bind_path);
240         if (bind(fd, (struct sockaddr*) &un, un_len)
241             || fchmod(fd, S_IRWXU)) {
242             goto error;
243         }
244     }
245
246     if (connect_path) {
247         struct sockaddr_un un;
248         socklen_t un_len;
249         make_sockaddr_un(connect_path, &un, &un_len);
250         if (connect(fd, (struct sockaddr*) &un, un_len)
251             && errno != EINPROGRESS) {
252             printf("connect failed with %s\n", strerror(errno));
253             goto error;
254         }
255     }
256
257 #ifdef SCM_CREDENTIALS
258     if (passcred) {
259         int enable = 1;
260         if (setsockopt(fd, SOL_SOCKET, SO_PASSCRED, &enable, sizeof(enable))) {
261             goto error;
262         }
263     }
264 #endif
265
266     return fd;
267
268 error:
269     error = errno == EAGAIN ? EPROTO : errno;
270     if (bind_path) {
271         fatal_signal_remove_file_to_unlink(bind_path);
272     }
273     close(fd);
274     return -error;
275 }
276
277 int
278 get_unix_name_len(socklen_t sun_len)
279 {
280     return (sun_len >= offsetof(struct sockaddr_un, sun_path)
281             ? sun_len - offsetof(struct sockaddr_un, sun_path)
282             : 0);
283 }
284
285 uint32_t
286 guess_netmask(uint32_t ip)
287 {
288     ip = ntohl(ip);
289     return ((ip >> 31) == 0 ? htonl(0xff000000)   /* Class A */
290             : (ip >> 30) == 2 ? htonl(0xffff0000) /* Class B */
291             : (ip >> 29) == 6 ? htonl(0xffffff00) /* Class C */
292             : htonl(0));                          /* ??? */
293 }
294
295 /* Parses 'target', which should be a string in the format "<host>[:<port>]".
296  * <host> is required.  If 'default_port' is nonzero then <port> is optional
297  * and defaults to 'default_port'.
298  *
299  * On success, returns true and stores the parsed remote address into '*sinp'.
300  * On failure, logs an error, stores zeros into '*sinp', and returns false. */
301 bool
302 inet_parse_active(const char *target_, uint16_t default_port,
303                   struct sockaddr_in *sinp)
304 {
305     char *target = xstrdup(target_);
306     char *save_ptr = NULL;
307     const char *host_name;
308     const char *port_string;
309     bool ok = false;
310
311     /* Defaults. */
312     sinp->sin_family = AF_INET;
313     sinp->sin_port = htons(default_port);
314
315     /* Tokenize. */
316     host_name = strtok_r(target, ":", &save_ptr);
317     port_string = strtok_r(NULL, ":", &save_ptr);
318     if (!host_name) {
319         VLOG_ERR("%s: bad peer name format", target_);
320         goto exit;
321     }
322
323     /* Look up IP, port. */
324     if (lookup_ip(host_name, &sinp->sin_addr)) {
325         goto exit;
326     }
327     if (port_string && atoi(port_string)) {
328         sinp->sin_port = htons(atoi(port_string));
329     } else if (!default_port) {
330         VLOG_ERR("%s: port number must be specified", target_);
331         goto exit;
332     }
333
334     ok = true;
335
336 exit:
337     if (!ok) {
338         memset(sinp, 0, sizeof *sinp);
339     }
340     free(target);
341     return ok;
342 }
343
344 /* Opens a non-blocking IPv4 socket of the specified 'style' and connects to
345  * 'target', which should be a string in the format "<host>[:<port>]".  <host>
346  * is required.  If 'default_port' is nonzero then <port> is optional and
347  * defaults to 'default_port'.
348  *
349  * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
350  *
351  * On success, returns 0 (indicating connection complete) or EAGAIN (indicating
352  * connection in progress), in which case the new file descriptor is stored
353  * into '*fdp'.  On failure, returns a positive errno value other than EAGAIN
354  * and stores -1 into '*fdp'.
355  *
356  * If 'sinp' is non-null, then on success the target address is stored into
357  * '*sinp'. */
358 int
359 inet_open_active(int style, const char *target, uint16_t default_port,
360                  struct sockaddr_in *sinp, int *fdp)
361 {
362     struct sockaddr_in sin;
363     int fd = -1;
364     int error;
365
366     /* Parse. */
367     if (!inet_parse_active(target, default_port, &sin)) {
368         error = EAFNOSUPPORT;
369         goto exit;
370     }
371
372     /* Create non-blocking socket. */
373     fd = socket(AF_INET, style, 0);
374     if (fd < 0) {
375         VLOG_ERR("%s: socket: %s", target, strerror(errno));
376         error = errno;
377         goto exit;
378     }
379     error = set_nonblocking(fd);
380     if (error) {
381         goto exit_close;
382     }
383
384     /* Connect. */
385     error = connect(fd, (struct sockaddr *) &sin, sizeof sin) == 0 ? 0 : errno;
386     if (error == EINPROGRESS) {
387         error = EAGAIN;
388     } else if (error && error != EAGAIN) {
389         goto exit_close;
390     }
391
392     /* Success: error is 0 or EAGAIN. */
393     goto exit;
394
395 exit_close:
396     close(fd);
397 exit:
398     if (!error || error == EAGAIN) {
399         if (sinp) {
400             *sinp = sin;
401         }
402         *fdp = fd;
403     } else {
404         *fdp = -1;
405     }
406     return error;
407 }
408
409 /* Opens a non-blocking IPv4 socket of the specified 'style', binds to
410  * 'target', and listens for incoming connections.  'target' should be a string
411  * in the format "[<port>][:<ip>]":
412  *
413  *      - If 'default_port' is -1, then <port> is required.  Otherwise, if
414  *        <port> is omitted, then 'default_port' is used instead.
415  *
416  *      - If <port> (or 'default_port', if used) is 0, then no port is bound
417  *        and the TCP/IP stack will select a port.
418  *
419  *      - If <ip> is omitted then the IP address is wildcarded.
420  *
421  * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
422  *
423  * For TCP, the socket will have SO_REUSEADDR turned on.
424  *
425  * On success, returns a non-negative file descriptor.  On failure, returns a
426  * negative errno value.
427  *
428  * If 'sinp' is non-null, then on success the bound address is stored into
429  * '*sinp'. */
430 int
431 inet_open_passive(int style, const char *target_, int default_port,
432                   struct sockaddr_in *sinp)
433 {
434     char *target = xstrdup(target_);
435     char *string_ptr = target;
436     struct sockaddr_in sin;
437     const char *host_name;
438     const char *port_string;
439     int fd, error, port;
440     unsigned int yes  = 1;
441
442     /* Address defaults. */
443     memset(&sin, 0, sizeof sin);
444     sin.sin_family = AF_INET;
445     sin.sin_addr.s_addr = htonl(INADDR_ANY);
446     sin.sin_port = htons(default_port);
447
448     /* Parse optional port number. */
449     port_string = strsep(&string_ptr, ":");
450     if (port_string && str_to_int(port_string, 10, &port)) {
451         sin.sin_port = htons(port);
452     } else if (default_port < 0) {
453         VLOG_ERR("%s: port number must be specified", target_);
454         error = EAFNOSUPPORT;
455         goto exit;
456     }
457
458     /* Parse optional bind IP. */
459     host_name = strsep(&string_ptr, ":");
460     if (host_name && host_name[0]) {
461         error = lookup_ip(host_name, &sin.sin_addr);
462         if (error) {
463             goto exit;
464         }
465     }
466
467     /* Create non-blocking socket, set SO_REUSEADDR. */
468     fd = socket(AF_INET, style, 0);
469     if (fd < 0) {
470         error = errno;
471         VLOG_ERR("%s: socket: %s", target_, strerror(error));
472         goto exit;
473     }
474     error = set_nonblocking(fd);
475     if (error) {
476         goto exit_close;
477     }
478     if (style == SOCK_STREAM
479         && setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) {
480         error = errno;
481         VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s", target_, strerror(error));
482         goto exit_close;
483     }
484
485     /* Bind. */
486     if (bind(fd, (struct sockaddr *) &sin, sizeof sin) < 0) {
487         error = errno;
488         VLOG_ERR("%s: bind: %s", target_, strerror(error));
489         goto exit_close;
490     }
491
492     /* Listen. */
493     if (listen(fd, 10) < 0) {
494         error = errno;
495         VLOG_ERR("%s: listen: %s", target_, strerror(error));
496         goto exit_close;
497     }
498
499     if (sinp) {
500         socklen_t sin_len = sizeof sin;
501         if (getsockname(fd, (struct sockaddr *) &sin, &sin_len) < 0){
502             error = errno;
503             VLOG_ERR("%s: getsockname: %s", target_, strerror(error));
504             goto exit_close;
505         }
506         if (sin.sin_family != AF_INET || sin_len != sizeof sin) {
507             VLOG_ERR("%s: getsockname: invalid socket name", target_);
508             goto exit_close;
509         }
510         *sinp = sin;
511     }
512
513     error = 0;
514     goto exit;
515
516 exit_close:
517     close(fd);
518 exit:
519     free(target);
520     return error ? -error : fd;
521 }
522
523 /* Returns a readable and writable fd for /dev/null, if successful, otherwise
524  * a negative errno value.  The caller must not close the returned fd (because
525  * the same fd will be handed out to subsequent callers). */
526 int
527 get_null_fd(void)
528 {
529     static int null_fd = -1;
530     if (null_fd < 0) {
531         null_fd = open("/dev/null", O_RDWR);
532         if (null_fd < 0) {
533             int error = errno;
534             VLOG_ERR("could not open /dev/null: %s", strerror(error));
535             return -error;
536         }
537     }
538     return null_fd;
539 }
540
541 int
542 read_fully(int fd, void *p_, size_t size, size_t *bytes_read)
543 {
544     uint8_t *p = p_;
545
546     *bytes_read = 0;
547     while (size > 0) {
548         ssize_t retval = read(fd, p, size);
549         if (retval > 0) {
550             *bytes_read += retval;
551             size -= retval;
552             p += retval;
553         } else if (retval == 0) {
554             return EOF;
555         } else if (errno != EINTR) {
556             return errno;
557         }
558     }
559     return 0;
560 }
561
562 int
563 write_fully(int fd, const void *p_, size_t size, size_t *bytes_written)
564 {
565     const uint8_t *p = p_;
566
567     *bytes_written = 0;
568     while (size > 0) {
569         ssize_t retval = write(fd, p, size);
570         if (retval > 0) {
571             *bytes_written += retval;
572             size -= retval;
573             p += retval;
574         } else if (retval == 0) {
575             VLOG_WARN("write returned 0");
576             return EPROTO;
577         } else if (errno != EINTR) {
578             return errno;
579         }
580     }
581     return 0;
582 }
583
584 /* Given file name 'file_name', fsyncs the directory in which it is contained.
585  * Returns 0 if successful, otherwise a positive errno value. */
586 int
587 fsync_parent_dir(const char *file_name)
588 {
589     int error = 0;
590     char *dir;
591     int fd;
592
593     dir = dir_name(file_name);
594     fd = open(dir, O_RDONLY);
595     if (fd >= 0) {
596         if (fsync(fd)) {
597             if (errno == EINVAL || errno == EROFS) {
598                 /* This directory does not support synchronization.  Not
599                  * really an error. */
600             } else {
601                 error = errno;
602                 VLOG_ERR("%s: fsync failed (%s)", dir, strerror(error));
603             }
604         }
605         close(fd);
606     } else {
607         error = errno;
608         VLOG_ERR("%s: open failed (%s)", dir, strerror(error));
609     }
610     free(dir);
611
612     return error;
613 }
614
615 /* Obtains the modification time of the file named 'file_name' to the greatest
616  * supported precision.  If successful, stores the mtime in '*mtime' and
617  * returns 0.  On error, returns a positive errno value and stores zeros in
618  * '*mtime'. */
619 int
620 get_mtime(const char *file_name, struct timespec *mtime)
621 {
622     struct stat s;
623
624     if (!stat(file_name, &s)) {
625         mtime->tv_sec = s.st_mtime;
626
627 #if HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
628         mtime->tv_nsec = s.st_mtim.tv_nsec;
629 #elif HAVE_STRUCT_STAT_ST_MTIMENSEC
630         mtime->tv_nsec = s.st_mtimensec;
631 #else
632         mtime->tv_nsec = 0;
633 #endif
634
635         return 0;
636     } else {
637         mtime->tv_sec = mtime->tv_nsec = 0;
638         return errno;
639     }
640 }
641