tests: factor out st_ctime-comparison code (a dozen uses)
[gnulib.git] / tests / test-futimens.h
1 /* Test of file timestamp modification functions.
2    Copyright (C) 2009-2011 Free Software Foundation, Inc.
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 3 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    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
16
17 #include "test-utimens-common.h"
18
19 /* This file is designed to test both fdutimens(a,NULL,b) and
20    futimens(a,b).  FUNC is the function to test.  Assumes that BASE
21    and ASSERT are already defined.  If PRINT, warn before skipping
22    tests with status 77.  */
23 static int
24 test_futimens (int (*func) (int, struct timespec const *),
25                bool print)
26 {
27   int fd = creat (BASE "file", 0600);
28   int result;
29   struct stat st1;
30   struct stat st2;
31   ASSERT (0 <= fd);
32
33   /* Sanity check.  */
34   ASSERT (fstat (fd, &st1) == 0);
35   nap ();
36   errno = 0;
37   result = func (fd, NULL);
38   if (result == -1 && errno == ENOSYS)
39     {
40       ASSERT (close (fd) == 0);
41       ASSERT (unlink (BASE "file") == 0);
42       if (print)
43         fputs ("skipping test: "
44                "setting fd time not supported on this file system\n",
45                stderr);
46       return 77;
47     }
48   ASSERT (!result);
49   ASSERT (fstat (fd, &st2) == 0);
50   /* If utimens truncates to less resolution than the file system
51      supports, then time can appear to go backwards between now and a
52      follow-up utimens with UTIME_NOW or a NULL timespec.  Use
53      UTIMECMP_TRUNCATE_SOURCE to compensate, with st1 as the
54      source.  */
55   ASSERT (0 <= utimecmp (BASE "file", &st2, &st1, UTIMECMP_TRUNCATE_SOURCE));
56   if (check_ctime)
57     ASSERT (ctime_compare (&st1, &st2) < 0);
58   {
59     /* On some NFS systems, the 'now' timestamp of creat or a NULL
60        timespec is determined by the server, but the 'now' timestamp
61        determined by gettime() (as is done when using UTIME_NOW) is
62        determined by the client; since the two machines are not
63        necessarily on the same clock, this is another case where time
64        can appear to go backwards.  The rest of this test cares about
65        client time, so manually use gettime() to set both times.  */
66     struct timespec ts[2];
67     gettime (&ts[0]);
68     ts[1] = ts[0];
69     ASSERT (func (fd, ts) == 0);
70     ASSERT (fstat (fd, &st1) == 0);
71     nap ();
72   }
73
74   /* Invalid arguments.  */
75   {
76     errno = 0;
77     ASSERT (func (AT_FDCWD, NULL) == -1);
78     ASSERT (errno == EBADF);
79   }
80   {
81     errno = 0;
82     ASSERT (func (-1, NULL) == -1);
83     ASSERT (errno == EBADF);
84   }
85   {
86     errno = 0;
87     ASSERT (func (99, NULL) == -1);
88     ASSERT (errno == EBADF);
89   }
90   {
91     int fd0 = dup (0);
92     ASSERT (0 <= fd0);
93     ASSERT (close (fd0) == 0);
94     errno = 0;
95     ASSERT (func (fd0, NULL) == -1);
96     ASSERT (errno == EBADF);
97   }
98   {
99     struct timespec ts[2] = { { Y2K, UTIME_BOGUS_POS }, { Y2K, 0 } };
100     errno = 0;
101     ASSERT (func (fd, ts) == -1);
102     ASSERT (errno == EINVAL);
103   }
104   {
105     struct timespec ts[2] = { { Y2K, 0 }, { Y2K, UTIME_BOGUS_NEG } };
106     errno = 0;
107     ASSERT (func (fd, ts) == -1);
108     ASSERT (errno == EINVAL);
109   }
110   ASSERT (fstat (fd, &st2) == 0);
111   ASSERT (st1.st_atime == st2.st_atime);
112   ASSERT (get_stat_atime_ns (&st1) == get_stat_atime_ns (&st2));
113   ASSERT (utimecmp (BASE "file", &st1, &st2, 0) == 0);
114
115   /* Set both times.  */
116   {
117     struct timespec ts[2] = { { Y2K, BILLION / 2 - 1 }, { Y2K, BILLION - 1 } };
118     ASSERT (func (fd, ts) == 0);
119     ASSERT (fstat (fd, &st2) == 0);
120     ASSERT (st2.st_atime == Y2K);
121     ASSERT (0 <= get_stat_atime_ns (&st2));
122     ASSERT (get_stat_atime_ns (&st2) < BILLION / 2);
123     ASSERT (st2.st_mtime == Y2K);
124     ASSERT (0 <= get_stat_mtime_ns (&st2));
125     ASSERT (get_stat_mtime_ns (&st2) < BILLION);
126     if (check_ctime)
127       ASSERT (ctime_compare (&st1, &st2) < 0);
128   }
129
130   /* Play with UTIME_OMIT, UTIME_NOW.  */
131   {
132     struct stat st3;
133     struct timespec ts[2] = { { BILLION, UTIME_OMIT }, { 0, UTIME_NOW } };
134     nap ();
135     ASSERT (func (fd, ts) == 0);
136     ASSERT (fstat (fd, &st3) == 0);
137     ASSERT (st3.st_atime == Y2K);
138     ASSERT (0 <= get_stat_atime_ns (&st3));
139     ASSERT (get_stat_atime_ns (&st3) <= BILLION / 2);
140     ASSERT (utimecmp (BASE "file", &st1, &st3, 0) <= 0);
141     if (check_ctime)
142       ASSERT (ctime_compare (&st2, &st3) < 0);
143     nap ();
144     ts[0].tv_nsec = 0;
145     ts[1].tv_nsec = UTIME_OMIT;
146     ASSERT (func (fd, ts) == 0);
147     ASSERT (fstat (fd, &st2) == 0);
148     ASSERT (st2.st_atime == BILLION);
149     ASSERT (get_stat_atime_ns (&st2) == 0);
150     ASSERT (st3.st_mtime == st2.st_mtime);
151     ASSERT (get_stat_mtime_ns (&st3) == get_stat_mtime_ns (&st2));
152     if (check_ctime)
153       ASSERT (ctime_compare (&st3, &st2) < 0);
154   }
155
156   /* Cleanup.  */
157   ASSERT (close (fd) == 0);
158   ASSERT (unlink (BASE "file") == 0);
159   return 0;
160 }