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