linkat: new module
[gnulib.git] / tests / test-linkat.c
1 /* Tests of linkat.
2    Copyright (C) 2009 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 /* Written by Eric Blake <ebb9@byu.net>, 2009.  */
18
19 #include <config.h>
20
21 #include <unistd.h>
22
23 #include <fcntl.h>
24 #include <errno.h>
25 #include <stdbool.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29
30 #include "areadlink.h"
31 #include "filenamecat.h"
32 #include "same-inode.h"
33 #include "xgetcwd.h"
34
35 #define ASSERT(expr) \
36   do                                                                         \
37     {                                                                        \
38       if (!(expr))                                                           \
39         {                                                                    \
40           fprintf (stderr, "%s:%d: assertion failed\n", __FILE__, __LINE__);  \
41           fflush (stderr);                                                   \
42           abort ();                                                          \
43         }                                                                    \
44     }                                                                        \
45   while (0)
46
47 #define BASE "test-linkat.t"
48
49 #include "test-link.h"
50
51 static int dfd1 = AT_FDCWD;
52 static int dfd2 = AT_FDCWD;
53 static int flag = AT_SYMLINK_FOLLOW;
54
55 /* Wrapper to test linkat like link.  */
56 static int
57 do_link (char const *name1, char const *name2)
58 {
59   return linkat (dfd1, name1, dfd2, name2, flag);
60 }
61
62 /* Wrapper to see if two symlinks act the same.  */
63 static void
64 check_same_link (char const *name1, char const *name2)
65 {
66   struct stat st1;
67   struct stat st2;
68   char *contents1;
69   char *contents2;
70   ASSERT (lstat (name1, &st1) == 0);
71   ASSERT (lstat (name2, &st2) == 0);
72   contents1 = areadlink_with_size (name1, st1.st_size);
73   contents2 = areadlink_with_size (name2, st2.st_size);
74   ASSERT (contents1);
75   ASSERT (contents2);
76   ASSERT (strcmp (contents1, contents2) == 0);
77   if (!LINK_FOLLOWS_SYMLINKS)
78     ASSERT (SAME_INODE (st1, st2));
79   free (contents1);
80   free (contents2);
81 }
82
83 int
84 main ()
85 {
86   int i;
87   int dfd;
88   char *cwd;
89   int result;
90
91   /* Clean up any trash from prior testsuite runs.  */
92   ASSERT (system ("rm -rf " BASE "*") == 0);
93
94   /* Test basic link functionality, without mentioning symlinks.  */
95   {
96     result = test_link (do_link, false);
97     dfd1 = open (".", O_RDONLY);
98     ASSERT (0 <= dfd1);
99     ASSERT (test_link (do_link, false) == result);
100     dfd2 = dfd1;
101     ASSERT (test_link (do_link, false) == result);
102     dfd1 = AT_FDCWD;
103     ASSERT (test_link (do_link, false) == result);
104     flag = 0;
105     ASSERT (test_link (do_link, false) == result);
106     dfd1 = dfd2;
107     ASSERT (test_link (do_link, false) == result);
108     dfd2 = AT_FDCWD;
109     ASSERT (test_link (do_link, false) == result);
110     ASSERT (close (dfd1) == 0);
111     dfd1 = AT_FDCWD;
112     ASSERT (test_link (do_link, false) == result);
113   }
114
115   /* Create locations to manipulate.  */
116   ASSERT (mkdir (BASE "sub1", 0700) == 0);
117   ASSERT (mkdir (BASE "sub2", 0700) == 0);
118   dfd = creat (BASE "00", 0600);
119   ASSERT (0 <= dfd);
120   ASSERT (close (dfd) == 0);
121   cwd = xgetcwd ();
122
123   dfd = open (BASE "sub1", O_RDONLY);
124   ASSERT (0 <= dfd);
125   ASSERT (chdir (BASE "sub2") == 0);
126
127   /* There are 16 possible scenarios, based on whether an fd is
128      AT_FDCWD or real, whether a file is absolute or relative, coupled
129      with whether flag is set for 32 iterations.
130
131      To ensure that we test all of the code paths (rather than
132      triggering early normalization optimizations), we use a loop to
133      repeatedly rename a file in the parent directory, use an fd open
134      on subdirectory 1, all while executing in subdirectory 2; all
135      relative names are thus given with a leading "../".  Finally, the
136      last scenario (two relative paths given, neither one AT_FDCWD)
137      has two paths, based on whether the two fds are equivalent, so we
138      do the other variant after the loop.  */
139   for (i = 0; i < 32; i++)
140     {
141       int flag = (i & 0x10 ? AT_SYMLINK_FOLLOW : 0);
142       int fd1 = (i & 8) ? dfd : AT_FDCWD;
143       char *file1 = file_name_concat ((i & 4) ? ".." : cwd, BASE "xx", NULL);
144       int fd2 = (i & 2) ? dfd : AT_FDCWD;
145       char *file2 = file_name_concat ((i & 1) ? ".." : cwd, BASE "xx", NULL);
146
147       ASSERT (sprintf (strchr (file1, '\0') - 2, "%02d", i) == 2);
148       ASSERT (sprintf (strchr (file2, '\0') - 2, "%02d", i + 1) == 2);
149       ASSERT (linkat (fd1, file1, fd2, file2, flag) == 0);
150       ASSERT (unlinkat (fd1, file1, 0) == 0);
151       free (file1);
152       free (file2);
153     }
154   dfd2 = open ("..", O_RDONLY);
155   ASSERT (0 <= dfd2);
156   ASSERT (linkat (dfd, "../" BASE "32", dfd2, BASE "33", 0) == 0);
157   ASSERT (linkat (dfd, "../" BASE "33", dfd2, BASE "34",
158                   AT_SYMLINK_FOLLOW) == 0);
159   ASSERT (close (dfd2) == 0);
160
161   /* Now we change back to the parent directory, and set dfd to ".",
162      in order to test behavior on symlinks.  */
163   ASSERT (chdir ("..") == 0);
164   ASSERT (close (dfd) == 0);
165   if (symlink (BASE "sub1", BASE "link1"))
166     {
167       ASSERT (unlink (BASE "32") == 0);
168       ASSERT (unlink (BASE "33") == 0);
169       ASSERT (unlink (BASE "34") == 0);
170       ASSERT (rmdir (BASE "sub1") == 0);
171       ASSERT (rmdir (BASE "sub2") == 0);
172       free (cwd);
173       fputs ("skipping test: symlinks not supported on this filesystem\n",
174              stderr);
175       return result;
176     }
177   dfd = open (".", O_RDONLY);
178   ASSERT (0 <= dfd);
179   ASSERT (symlink (BASE "34", BASE "link2") == 0);
180   ASSERT (symlink (BASE "link3", BASE "link3") == 0);
181   ASSERT (symlink (BASE "nowhere", BASE "link4") == 0);
182
183   /* Link cannot overwrite existing files.  */
184   errno = 0;
185   ASSERT (linkat (dfd, BASE "link1", dfd, BASE "sub1", 0) == -1);
186   ASSERT (errno == EEXIST);
187   errno = 0;
188   ASSERT (linkat (dfd, BASE "link1/", dfd, BASE "sub1", 0) == -1);
189   ASSERT (errno == EEXIST || errno == EPERM || errno == EACCES);
190   errno = 0;
191   ASSERT (linkat (dfd, BASE "link1", dfd, BASE "sub1/", 0) == -1);
192   ASSERT (errno == EEXIST);
193   errno = 0;
194   ASSERT (linkat (dfd, BASE "link1", dfd, BASE "sub1",
195                   AT_SYMLINK_FOLLOW) == -1);
196   ASSERT (errno == EEXIST || errno == EPERM || errno == EACCES);
197   errno = 0;
198   ASSERT (linkat (dfd, BASE "link1/", dfd, BASE "sub1",
199                   AT_SYMLINK_FOLLOW) == -1);
200   ASSERT (errno == EEXIST || errno == EPERM || errno == EACCES);
201   errno = 0;
202   ASSERT (linkat (dfd, BASE "link1", dfd, BASE "sub1/",
203                   AT_SYMLINK_FOLLOW) == -1);
204   ASSERT (errno == EEXIST || errno == EPERM || errno == EACCES);
205   errno = 0;
206   ASSERT (linkat (dfd, BASE "link1", dfd, BASE "link2", 0) == -1);
207   ASSERT (errno == EEXIST);
208   errno = 0;
209   ASSERT (linkat (dfd, BASE "link1", dfd, BASE "link2",
210                   AT_SYMLINK_FOLLOW) == -1);
211   ASSERT (errno == EEXIST || errno == EPERM || errno == EACCES);
212   errno = 0;
213   ASSERT (linkat (dfd, BASE "link1", dfd, BASE "link3", 0) == -1);
214   ASSERT (errno == EEXIST || errno == ELOOP);
215   errno = 0;
216   ASSERT (linkat (dfd, BASE "link1", dfd, BASE "link3",
217                   AT_SYMLINK_FOLLOW) == -1);
218   ASSERT (errno == EEXIST || errno == EPERM || errno == EACCES
219           || errno == ELOOP);
220   errno = 0;
221   ASSERT (linkat (dfd, BASE "link2", dfd, BASE "link3", 0) == -1);
222   ASSERT (errno == EEXIST || errno == ELOOP);
223   errno = 0;
224   ASSERT (linkat (dfd, BASE "link2", dfd, BASE "link3",
225                   AT_SYMLINK_FOLLOW) == -1);
226   ASSERT (errno == EEXIST || errno == ELOOP);
227
228   /* AT_SYMLINK_FOLLOW only follows first argument, not second.  */
229   errno = 0;
230   ASSERT (linkat (dfd, BASE "link1", dfd, BASE "link4", 0) == -1);
231   ASSERT (errno == EEXIST);
232   ASSERT (linkat (dfd, BASE "link1", dfd, BASE "link4",
233                   AT_SYMLINK_FOLLOW) == -1);
234   ASSERT (errno == EEXIST || errno == EPERM || errno == EACCES);
235   errno = 0;
236   ASSERT (linkat (dfd, BASE "34", dfd, BASE "link4", 0) == -1);
237   ASSERT (errno == EEXIST);
238   errno = 0;
239   ASSERT (linkat (dfd, BASE "34", dfd, BASE "link4", AT_SYMLINK_FOLLOW) == -1);
240   ASSERT (errno == EEXIST);
241
242   /* Trailing slash handling.  */
243   errno = 0;
244   ASSERT (linkat (dfd, BASE "link2/", dfd, BASE "link5", 0) == -1);
245   ASSERT (errno == ENOTDIR);
246   errno = 0;
247   ASSERT (linkat (dfd, BASE "link2/", dfd, BASE "link5",
248                   AT_SYMLINK_FOLLOW) == -1);
249   ASSERT (errno == ENOTDIR);
250   errno = 0;
251   ASSERT (linkat (dfd, BASE "link3/", dfd, BASE "link5", 0) == -1);
252   ASSERT (errno == ELOOP);
253   errno = 0;
254   ASSERT (linkat (dfd, BASE "link3/", dfd, BASE "link5",
255                   AT_SYMLINK_FOLLOW) == -1);
256   ASSERT (errno == ELOOP);
257   errno = 0;
258   ASSERT (linkat (dfd, BASE "link4/", dfd, BASE "link5", 0) == -1);
259   ASSERT (errno == ENOENT);
260   errno = 0;
261   ASSERT (linkat (dfd, BASE "link4/", dfd, BASE "link5",
262                   AT_SYMLINK_FOLLOW) == -1);
263   ASSERT (errno == ENOENT);
264
265   /* Check for hard links to symlinks.  */
266   ASSERT (linkat (dfd, BASE "link1", dfd, BASE "link5", 0) == 0);
267   check_same_link (BASE "link1", BASE "link5");
268   ASSERT (unlink (BASE "link5") == 0);
269   errno = 0;
270   ASSERT (linkat (dfd, BASE "link1", dfd, BASE "link5",
271                   AT_SYMLINK_FOLLOW) == -1);
272   ASSERT (errno == EPERM || errno == EACCES);
273   ASSERT (linkat (dfd, BASE "link2", dfd, BASE "link5", 0) == 0);
274   check_same_link (BASE "link2", BASE "link5");
275   ASSERT (unlink (BASE "link5") == 0);
276   ASSERT (linkat (dfd, BASE "link2", dfd, BASE "file", AT_SYMLINK_FOLLOW) == 0);
277   errno = 0;
278   ASSERT (areadlink (BASE "file") == NULL);
279   ASSERT (errno == EINVAL);
280   ASSERT (unlink (BASE "file") == 0);
281   ASSERT (linkat (dfd, BASE "link3", dfd, BASE "link5", 0) == 0);
282   check_same_link (BASE "link3", BASE "link5");
283   ASSERT (unlink (BASE "link5") == 0);
284   errno = 0;
285   ASSERT (linkat (dfd, BASE "link3", dfd, BASE "link5",
286                   AT_SYMLINK_FOLLOW) == -1);
287   ASSERT (errno == ELOOP);
288   ASSERT (linkat (dfd, BASE "link4", dfd, BASE "link5", 0) == 0);
289   check_same_link (BASE "link4", BASE "link5");
290   ASSERT (unlink (BASE "link5") == 0);
291   errno = 0;
292   ASSERT (linkat (dfd, BASE "link4", dfd, BASE "link5",
293                   AT_SYMLINK_FOLLOW) == -1);
294   ASSERT (errno == ENOENT);
295
296   /* Check that symlink to symlink to file is followed all the way.  */
297   ASSERT (symlink (BASE "link2", BASE "link5") == 0);
298   ASSERT (linkat (dfd, BASE "link5", dfd, BASE "link6", 0) == 0);
299   check_same_link (BASE "link5", BASE "link6");
300   ASSERT (unlink (BASE "link6") == 0);
301   ASSERT (linkat (dfd, BASE "link5", dfd, BASE "file", AT_SYMLINK_FOLLOW) == 0);
302   errno = 0;
303   ASSERT (areadlink (BASE "file") == NULL);
304   ASSERT (errno == EINVAL);
305   ASSERT (unlink (BASE "link5") == 0);
306   ASSERT (symlink (BASE "link3", BASE "link5") == 0);
307   errno = 0;
308   ASSERT (linkat (dfd, BASE "link5", dfd, BASE "file",
309                   AT_SYMLINK_FOLLOW) == -1);
310   ASSERT (errno == ELOOP);
311   ASSERT (unlink (BASE "link5") == 0);
312   ASSERT (symlink (BASE "link4", BASE "link5") == 0);
313   errno = 0;
314   ASSERT (linkat (dfd, BASE "link5", dfd, BASE "file",
315                   AT_SYMLINK_FOLLOW) == -1);
316   ASSERT (errno == ENOENT);
317
318   /* Now for some real fun with directory crossing.  */
319   ASSERT (symlink (cwd, BASE "sub1/link") == 0);
320   ASSERT (symlink (".././/" BASE "sub1/link/" BASE "link2",
321                    BASE "sub2/link") == 0);
322   ASSERT (close (dfd) == 0);
323   dfd = open (BASE "sub1", O_RDONLY);
324   ASSERT (0 <= dfd);
325   dfd2 = open (BASE "sub2", O_RDONLY);
326   ASSERT (0 < dfd2);
327   ASSERT (linkat (dfd, "../" BASE "sub2/link", dfd2, "./..//" BASE "sub1/file",
328               AT_SYMLINK_FOLLOW) == 0);
329   errno = 0;
330   ASSERT (areadlink (BASE "sub1/file") == NULL);
331   ASSERT (errno == EINVAL);
332
333   /* Cleanup.  */
334   ASSERT (close (dfd) == 0);
335   ASSERT (close (dfd2) == 0);
336   ASSERT (unlink (BASE "sub1/file") == 0);
337   ASSERT (unlink (BASE "sub1/link") == 0);
338   ASSERT (unlink (BASE "sub2/link") == 0);
339   ASSERT (unlink (BASE "32") == 0);
340   ASSERT (unlink (BASE "33") == 0);
341   ASSERT (unlink (BASE "34") == 0);
342   ASSERT (rmdir (BASE "sub1") == 0);
343   ASSERT (rmdir (BASE "sub2") == 0);
344   ASSERT (unlink (BASE "link1") == 0);
345   ASSERT (unlink (BASE "link2") == 0);
346   ASSERT (unlink (BASE "link3") == 0);
347   ASSERT (unlink (BASE "link4") == 0);
348   ASSERT (unlink (BASE "link5") == 0);
349   ASSERT (unlink (BASE "file") == 0);
350   free (cwd);
351   return result;
352 }