Unify on "path" vs "fname" arg naming.
[rsync.git] / syscall.c
1 /*
2  * Syscall wrappers to ensure that nothing gets done in dry_run mode
3  * and to handle system peculiarities.
4  *
5  * Copyright (C) 1998 Andrew Tridgell
6  * Copyright (C) 2002 Martin Pool
7  * Copyright (C) 2003-2020 Wayne Davison
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License along
20  * with this program; if not, visit the http://fsf.org website.
21  */
22
23 #include "rsync.h"
24
25 #if !defined MKNOD_CREATES_SOCKETS && defined HAVE_SYS_UN_H
26 #include <sys/un.h>
27 #endif
28 #ifdef HAVE_SYS_ATTR_H
29 #include <sys/attr.h>
30 #endif
31
32 #if defined HAVE_SYS_FALLOCATE && !defined HAVE_FALLOCATE
33 #include <sys/syscall.h>
34 #endif
35
36 extern int dry_run;
37 extern int am_root;
38 extern int am_sender;
39 extern int read_only;
40 extern int list_only;
41 extern int inplace;
42 extern int preallocate_files;
43 extern int preserve_perms;
44 extern int preserve_executability;
45 extern int open_noatime;
46
47 #ifndef S_BLKSIZE
48 # if defined hpux || defined __hpux__ || defined __hpux
49 #  define S_BLKSIZE 1024
50 # elif defined _AIX && defined _I386
51 #  define S_BLKSIZE 4096
52 # else
53 #  define S_BLKSIZE 512
54 # endif
55 #endif
56
57 #ifdef SUPPORT_CRTIMES
58 #ifdef HAVE_GETATTRLIST
59 #pragma pack(push, 4)
60 struct create_time {
61         uint32 length;
62         struct timespec crtime;
63 };
64 #pragma pack(pop)
65 #elif defined __CYGWIN__
66 #include <windows.h>
67 #endif
68 #endif
69
70 #define RETURN_ERROR_IF(x,e) \
71         do { \
72                 if (x) { \
73                         errno = (e); \
74                         return -1; \
75                 } \
76         } while (0)
77
78 #define RETURN_ERROR_IF_RO_OR_LO RETURN_ERROR_IF(read_only || list_only, EROFS)
79
80 int do_unlink(const char *path)
81 {
82         if (dry_run) return 0;
83         RETURN_ERROR_IF_RO_OR_LO;
84         return unlink(path);
85 }
86
87 #ifdef SUPPORT_LINKS
88 int do_symlink(const char *lnk, const char *path)
89 {
90         if (dry_run) return 0;
91         RETURN_ERROR_IF_RO_OR_LO;
92
93 #if defined NO_SYMLINK_XATTRS || defined NO_SYMLINK_USER_XATTRS
94         /* For --fake-super, we create a normal file with mode 0600
95          * and write the lnk into it. */
96         if (am_root < 0) {
97                 int ok, len = strlen(lnk);
98                 int fd = open(path, O_WRONLY|O_CREAT|O_TRUNC, S_IWUSR|S_IRUSR);
99                 if (fd < 0)
100                         return -1;
101                 ok = write(fd, lnk, len) == len;
102                 if (close(fd) < 0)
103                         ok = 0;
104                 return ok ? 0 : -1;
105         }
106 #endif
107
108         return symlink(lnk, path);
109 }
110
111 #if defined NO_SYMLINK_XATTRS || defined NO_SYMLINK_USER_XATTRS
112 ssize_t do_readlink(const char *path, char *buf, size_t bufsiz)
113 {
114         /* For --fake-super, we read the link from the file. */
115         if (am_root < 0) {
116                 int fd = do_open_nofollow(path, O_RDONLY);
117                 if (fd >= 0) {
118                         int len = read(fd, buf, bufsiz);
119                         close(fd);
120                         return len;
121                 }
122                 if (errno != ELOOP)
123                         return -1;
124                 /* A real symlink needs to be turned into a fake one on the receiving
125                  * side, so tell the generator that the link has no length. */
126                 if (!am_sender)
127                         return 0;
128                 /* Otherwise fall through and let the sender report the real length. */
129         }
130
131         return readlink(path, buf, bufsiz);
132 }
133 #endif
134 #endif
135
136 #if defined HAVE_LINK || defined HAVE_LINKAT
137 int do_link(const char *old_path, const char *new_path)
138 {
139         if (dry_run) return 0;
140         RETURN_ERROR_IF_RO_OR_LO;
141 #ifdef HAVE_LINKAT
142         return linkat(AT_FDCWD, old_path, AT_FDCWD, new_path, 0);
143 #else
144         return link(old_path, new_path);
145 #endif
146 }
147 #endif
148
149 int do_lchown(const char *path, uid_t owner, gid_t group)
150 {
151         if (dry_run) return 0;
152         RETURN_ERROR_IF_RO_OR_LO;
153 #ifndef HAVE_LCHOWN
154 #define lchown chown
155 #endif
156         return lchown(path, owner, group);
157 }
158
159 int do_mknod(const char *pathname, mode_t mode, dev_t dev)
160 {
161         if (dry_run) return 0;
162         RETURN_ERROR_IF_RO_OR_LO;
163
164         /* For --fake-super, we create a normal file with mode 0600. */
165         if (am_root < 0) {
166                 int fd = open(pathname, O_WRONLY|O_CREAT|O_TRUNC, S_IWUSR|S_IRUSR);
167                 if (fd < 0 || close(fd) < 0)
168                         return -1;
169                 return 0;
170         }
171
172 #if !defined MKNOD_CREATES_FIFOS && defined HAVE_MKFIFO
173         if (S_ISFIFO(mode))
174                 return mkfifo(pathname, mode);
175 #endif
176 #if !defined MKNOD_CREATES_SOCKETS && defined HAVE_SYS_UN_H
177         if (S_ISSOCK(mode)) {
178                 int sock;
179                 struct sockaddr_un saddr;
180                 unsigned int len = strlcpy(saddr.sun_path, pathname, sizeof saddr.sun_path);
181                 if (len >= sizeof saddr.sun_path) {
182                         errno = ENAMETOOLONG;
183                         return -1;
184                 }
185 #ifdef HAVE_SOCKADDR_UN_LEN
186                 saddr.sun_len = len + 1;
187 #endif
188                 saddr.sun_family = AF_UNIX;
189
190                 if ((sock = socket(PF_UNIX, SOCK_STREAM, 0)) < 0
191                  || (unlink(pathname) < 0 && errno != ENOENT)
192                  || (bind(sock, (struct sockaddr*)&saddr, sizeof saddr)) < 0)
193                         return -1;
194                 close(sock);
195 #ifdef HAVE_CHMOD
196                 return do_chmod(pathname, mode);
197 #else
198                 return 0;
199 #endif
200         }
201 #endif
202 #ifdef HAVE_MKNOD
203         return mknod(pathname, mode, dev);
204 #else
205         return -1;
206 #endif
207 }
208
209 int do_rmdir(const char *pathname)
210 {
211         if (dry_run) return 0;
212         RETURN_ERROR_IF_RO_OR_LO;
213         return rmdir(pathname);
214 }
215
216 int do_open(const char *pathname, int flags, mode_t mode)
217 {
218         if (flags != O_RDONLY) {
219                 RETURN_ERROR_IF(dry_run, 0);
220                 RETURN_ERROR_IF_RO_OR_LO;
221         }
222
223 #ifdef O_NOATIME
224         if (open_noatime)
225                 flags |= O_NOATIME;
226 #endif
227
228         return open(pathname, flags | O_BINARY, mode);
229 }
230
231 #ifdef HAVE_CHMOD
232 int do_chmod(const char *path, mode_t mode)
233 {
234         static int switch_step = 0;
235         int code;
236         if (dry_run) return 0;
237         RETURN_ERROR_IF_RO_OR_LO;
238         switch (switch_step) {
239 #ifdef HAVE_LCHMOD
240 #include "case_N.h"
241                 if ((code = lchmod(path, mode & CHMOD_BITS)) == 0)
242                         break;
243                 if (errno == ENOSYS)
244                         switch_step++;
245                 else if (errno != ENOTSUP)
246                         break;
247 #endif
248
249 #include "case_N.h"
250                 if (S_ISLNK(mode)) {
251 # if defined HAVE_SETATTRLIST
252                         struct attrlist attrList;
253                         uint32_t m = mode & CHMOD_BITS; /* manpage is wrong: not mode_t! */
254
255                         memset(&attrList, 0, sizeof attrList);
256                         attrList.bitmapcount = ATTR_BIT_MAP_COUNT;
257                         attrList.commonattr = ATTR_CMN_ACCESSMASK;
258                         code = setattrlist(path, &attrList, &m, sizeof m, FSOPT_NOFOLLOW);
259 # else
260                         code = 1;
261 # endif
262                 } else
263                         code = chmod(path, mode & CHMOD_BITS); /* DISCOURAGED FUNCTION */
264                 break;
265         }
266         if (code != 0 && (preserve_perms || preserve_executability))
267                 return code;
268         return 0;
269 }
270 #endif
271
272 int do_rename(const char *old_path, const char *new_path)
273 {
274         if (dry_run) return 0;
275         RETURN_ERROR_IF_RO_OR_LO;
276         return rename(old_path, new_path);
277 }
278
279 #ifdef HAVE_FTRUNCATE
280 int do_ftruncate(int fd, OFF_T size)
281 {
282         int ret;
283
284         if (dry_run) return 0;
285         RETURN_ERROR_IF_RO_OR_LO;
286
287         do {
288                 ret = ftruncate(fd, size);
289         } while (ret < 0 && errno == EINTR);
290
291         return ret;
292 }
293 #endif
294
295 void trim_trailing_slashes(char *name)
296 {
297         int l;
298         /* Some BSD systems cannot make a directory if the name
299          * contains a trailing slash.
300          * <http://www.opensource.apple.com/bugs/X/BSD%20Kernel/2734739.html> */
301
302         /* Don't change empty string; and also we can't improve on
303          * "/" */
304
305         l = strlen(name);
306         while (l > 1) {
307                 if (name[--l] != '/')
308                         break;
309                 name[l] = '\0';
310         }
311 }
312
313 int do_mkdir(char *path, mode_t mode)
314 {
315         if (dry_run) return 0;
316         RETURN_ERROR_IF_RO_OR_LO;
317         trim_trailing_slashes(path);
318         return mkdir(path, mode);
319 }
320
321 /* like mkstemp but forces permissions */
322 int do_mkstemp(char *template, mode_t perms)
323 {
324         RETURN_ERROR_IF(dry_run, 0);
325         RETURN_ERROR_IF(read_only, EROFS);
326         perms |= S_IWUSR;
327
328 #if defined HAVE_SECURE_MKSTEMP && defined HAVE_FCHMOD && (!defined HAVE_OPEN64 || defined HAVE_MKSTEMP64)
329         {
330                 int fd = mkstemp(template);
331                 if (fd == -1)
332                         return -1;
333                 if (fchmod(fd, perms) != 0 && preserve_perms) {
334                         int errno_save = errno;
335                         close(fd);
336                         unlink(template);
337                         errno = errno_save;
338                         return -1;
339                 }
340 #if defined HAVE_SETMODE && O_BINARY
341                 setmode(fd, O_BINARY);
342 #endif
343                 return fd;
344         }
345 #else
346         if (!mktemp(template))
347                 return -1;
348         return do_open(template, O_RDWR|O_EXCL|O_CREAT, perms);
349 #endif
350 }
351
352 int do_stat(const char *path, STRUCT_STAT *st)
353 {
354 #ifdef USE_STAT64_FUNCS
355         return stat64(path, st);
356 #else
357         return stat(path, st);
358 #endif
359 }
360
361 int do_lstat(const char *path, STRUCT_STAT *st)
362 {
363 #ifdef SUPPORT_LINKS
364 # ifdef USE_STAT64_FUNCS
365         return lstat64(path, st);
366 # else
367         return lstat(path, st);
368 # endif
369 #else
370         return do_stat(path, st);
371 #endif
372 }
373
374 int do_fstat(int fd, STRUCT_STAT *st)
375 {
376 #ifdef USE_STAT64_FUNCS
377         return fstat64(fd, st);
378 #else
379         return fstat(fd, st);
380 #endif
381 }
382
383 OFF_T do_lseek(int fd, OFF_T offset, int whence)
384 {
385 #ifdef HAVE_LSEEK64
386 #if !SIZEOF_OFF64_T
387         OFF_T lseek64();
388 #else
389         off64_t lseek64();
390 #endif
391         return lseek64(fd, offset, whence);
392 #else
393         return lseek(fd, offset, whence);
394 #endif
395 }
396
397 #ifdef HAVE_SETATTRLIST
398 int do_setattrlist_times(const char *path, STRUCT_STAT *stp)
399 {
400         struct attrlist attrList;
401         struct timespec ts[2];
402
403         if (dry_run) return 0;
404         RETURN_ERROR_IF_RO_OR_LO;
405
406         /* Yes, this is in the opposite order of utime and similar. */
407         ts[0].tv_sec = stp->st_mtime;
408         ts[0].tv_nsec = stp->ST_MTIME_NSEC;
409
410         ts[1].tv_sec = stp->st_atime;
411         ts[1].tv_nsec = stp->ST_ATIME_NSEC;
412
413         memset(&attrList, 0, sizeof attrList);
414         attrList.bitmapcount = ATTR_BIT_MAP_COUNT;
415         attrList.commonattr = ATTR_CMN_MODTIME | ATTR_CMN_ACCTIME;
416         return setattrlist(path, &attrList, ts, sizeof ts, FSOPT_NOFOLLOW);
417 }
418 #endif
419
420 #ifdef SUPPORT_CRTIMES
421 time_t get_create_time(const char *path, STRUCT_STAT *stp)
422 {
423 #ifdef HAVE_GETATTRLIST
424         static struct create_time attrBuf;
425         struct attrlist attrList;
426
427         (void)stp;
428         memset(&attrList, 0, sizeof attrList);
429         attrList.bitmapcount = ATTR_BIT_MAP_COUNT;
430         attrList.commonattr = ATTR_CMN_CRTIME;
431         if (getattrlist(path, &attrList, &attrBuf, sizeof attrBuf, FSOPT_NOFOLLOW) < 0)
432                 return 0;
433         return attrBuf.crtime.tv_sec;
434 #elif defined __CYGWIN__
435         (void)path;
436         return stp->st_birthtime;
437 #else
438 #error Unknown crtimes implementation
439 #endif
440 }
441
442 int set_create_time(const char *path, time_t crtime)
443 {
444         if (dry_run) return 0;
445         RETURN_ERROR_IF_RO_OR_LO;
446
447     {
448 #ifdef HAVE_GETATTRLIST
449         struct attrlist attrList;
450         struct timespec ts;
451
452         ts.tv_sec = crtime;
453         ts.tv_nsec = 0;
454
455         memset(&attrList, 0, sizeof attrList);
456         attrList.bitmapcount = ATTR_BIT_MAP_COUNT;
457         attrList.commonattr = ATTR_CMN_CRTIME;
458         return setattrlist(path, &attrList, &ts, sizeof ts, FSOPT_NOFOLLOW);
459 #elif defined __CYGWIN__
460         int cnt = MultiByteToWideChar(CP_UTF8, 0, path, -1, NULL, 0);
461         if (cnt == 0)
462             return -1;
463         WCHAR *pathw = new_array(WCHAR, cnt);
464         if (!pathw)
465             return -1;
466         MultiByteToWideChar(CP_UTF8, 0, path, -1, pathw, cnt);
467         HANDLE handle = CreateFileW(pathw, FILE_WRITE_ATTRIBUTES, FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
468                                     NULL, OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS, NULL);
469         free(pathw);
470         if (handle == INVALID_HANDLE_VALUE)
471             return -1;
472         int64 temp_time = Int32x32To64(crtime, 10000000) + 116444736000000000LL;
473         FILETIME birth_time;
474         birth_time.dwLowDateTime = (DWORD)temp_time;
475         birth_time.dwHighDateTime = (DWORD)(temp_time >> 32);
476         int ok = SetFileTime(handle, &birth_time, NULL, NULL);
477         CloseHandle(handle);
478         return ok ? 0 : -1;
479 #endif
480     }
481 }
482 #endif /* SUPPORT_CRTIMES */
483
484 #ifdef HAVE_UTIMENSAT
485 int do_utimensat(const char *path, STRUCT_STAT *stp)
486 {
487         struct timespec t[2];
488
489         if (dry_run) return 0;
490         RETURN_ERROR_IF_RO_OR_LO;
491
492         t[0].tv_sec = stp->st_atime;
493 #ifdef ST_ATIME_NSEC
494         t[0].tv_nsec = stp->ST_ATIME_NSEC;
495 #else
496         t[0].tv_nsec = 0;
497 #endif
498         t[1].tv_sec = stp->st_mtime;
499 #ifdef ST_MTIME_NSEC
500         t[1].tv_nsec = stp->ST_MTIME_NSEC;
501 #else
502         t[1].tv_nsec = 0;
503 #endif
504         return utimensat(AT_FDCWD, path, t, AT_SYMLINK_NOFOLLOW);
505 }
506 #endif
507
508 #ifdef HAVE_LUTIMES
509 int do_lutimes(const char *path, STRUCT_STAT *stp)
510 {
511         struct timeval t[2];
512
513         if (dry_run) return 0;
514         RETURN_ERROR_IF_RO_OR_LO;
515
516         t[0].tv_sec = stp->st_atime;
517 #ifdef ST_ATIME_NSEC
518         t[0].tv_usec = stp->ST_ATIME_NSEC / 1000;
519 #else
520         t[0].tv_usec = 0;
521 #endif
522         t[1].tv_sec = stp->st_mtime;
523 #ifdef ST_MTIME_NSEC
524         t[1].tv_usec = stp->ST_MTIME_NSEC / 1000;
525 #else
526         t[1].tv_usec = 0;
527 #endif
528         return lutimes(path, t);
529 }
530 #endif
531
532 #ifdef HAVE_UTIMES
533 int do_utimes(const char *path, STRUCT_STAT *stp)
534 {
535         struct timeval t[2];
536
537         if (dry_run) return 0;
538         RETURN_ERROR_IF_RO_OR_LO;
539
540         t[0].tv_sec = stp->st_atime;
541 #ifdef ST_ATIME_NSEC
542         t[0].tv_usec = stp->ST_ATIME_NSEC / 1000;
543 #else
544         t[0].tv_usec = 0;
545 #endif
546         t[1].tv_sec = stp->st_mtime;
547 #ifdef ST_MTIME_NSEC
548         t[1].tv_usec = stp->ST_MTIME_NSEC / 1000;
549 #else
550         t[1].tv_usec = 0;
551 #endif
552         return utimes(path, t);
553 }
554
555 #elif defined HAVE_UTIME
556 int do_utime(const char *path, STRUCT_STAT *stp)
557 {
558 #ifdef HAVE_STRUCT_UTIMBUF
559         struct utimbuf tbuf;
560 #else
561         time_t t[2];
562 #endif
563
564         if (dry_run) return 0;
565         RETURN_ERROR_IF_RO_OR_LO;
566
567 # ifdef HAVE_STRUCT_UTIMBUF
568         tbuf.actime = stp->st_atime;
569         tbuf.modtime = stp->st_mtime;
570         return utime(path, &tbuf);
571 # else
572         t[0] = stp->st_atime;
573         t[1] = stp->st_mtime;
574         return utime(path, t);
575 # endif
576 }
577
578 #else
579 #error Need utimes or utime function.
580 #endif
581
582 #ifdef SUPPORT_PREALLOCATION
583 #ifdef FALLOC_FL_KEEP_SIZE
584 #define DO_FALLOC_OPTIONS FALLOC_FL_KEEP_SIZE
585 #else
586 #define DO_FALLOC_OPTIONS 0
587 #endif
588
589 OFF_T do_fallocate(int fd, OFF_T offset, OFF_T length)
590 {
591         int opts = inplace || preallocate_files ? DO_FALLOC_OPTIONS : 0;
592         int ret;
593         RETURN_ERROR_IF(dry_run, 0);
594         RETURN_ERROR_IF_RO_OR_LO;
595         if (length & 1) /* make the length not match the desired length */
596                 length++;
597         else
598                 length--;
599 #if defined HAVE_FALLOCATE
600         ret = fallocate(fd, opts, offset, length);
601 #elif defined HAVE_SYS_FALLOCATE
602         ret = syscall(SYS_fallocate, fd, opts, (loff_t)offset, (loff_t)length);
603 #elif defined HAVE_EFFICIENT_POSIX_FALLOCATE
604         ret = posix_fallocate(fd, offset, length);
605 #else
606 #error Coding error in SUPPORT_PREALLOCATION logic.
607 #endif
608         if (ret < 0)
609                 return ret;
610         if (opts == 0) {
611                 STRUCT_STAT st;
612                 if (do_fstat(fd, &st) < 0)
613                         return length;
614                 return st.st_blocks * S_BLKSIZE;
615         }
616         return 0;
617 }
618 #endif
619
620 /* Punch a hole at pos for len bytes. The current file position must be at pos and will be
621  * changed to be at pos + len. */
622 int do_punch_hole(int fd, OFF_T pos, OFF_T len)
623 {
624 #ifdef HAVE_FALLOCATE
625 # ifdef HAVE_FALLOC_FL_PUNCH_HOLE
626         if (fallocate(fd, FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE, pos, len) == 0) {
627                 if (do_lseek(fd, len, SEEK_CUR) != pos + len)
628                         return -1;
629                 return 0;
630         }
631 # endif
632 # ifdef HAVE_FALLOC_FL_ZERO_RANGE
633         if (fallocate(fd, FALLOC_FL_ZERO_RANGE, pos, len) == 0) {
634                 if (do_lseek(fd, len, SEEK_CUR) != pos + len)
635                         return -1;
636                 return 0;
637         }
638 # endif
639 #else
640         (void)pos;
641 #endif
642         {
643                 char zeros[4096];
644                 memset(zeros, 0, sizeof zeros);
645                 while (len > 0) {
646                         int chunk = len > (int)sizeof zeros ? (int)sizeof zeros : len;
647                         int wrote = write(fd, zeros, chunk);
648                         if (wrote <= 0) {
649                                 if (wrote < 0 && errno == EINTR)
650                                         continue;
651                                 return -1;
652                         }
653                         len -= wrote;
654                 }
655         }
656         return 0;
657 }
658
659 int do_open_nofollow(const char *pathname, int flags)
660 {
661 #ifndef O_NOFOLLOW
662         STRUCT_STAT f_st, l_st;
663 #endif
664         int fd;
665
666         if (flags != O_RDONLY) {
667                 RETURN_ERROR_IF(dry_run, 0);
668                 RETURN_ERROR_IF_RO_OR_LO;
669 #ifndef O_NOFOLLOW
670                 /* This function doesn't support write attempts w/o O_NOFOLLOW. */
671                 errno = EINVAL;
672                 return -1;
673 #endif
674         }
675
676 #ifdef O_NOFOLLOW
677         fd = open(pathname, flags|O_NOFOLLOW);
678 #else
679         if (do_lstat(pathname, &l_st) < 0)
680                 return -1;
681         if (S_ISLNK(l_st.st_mode)) {
682                 errno = ELOOP;
683                 return -1;
684         }
685         if ((fd = open(pathname, flags)) < 0)
686                 return fd;
687         if (do_fstat(fd, &f_st) < 0) {
688           close_and_return_error:
689                 {
690                         int save_errno = errno;
691                         close(fd);
692                         errno = save_errno;
693                 }
694                 return -1;
695         }
696         if (l_st.st_dev != f_st.st_dev || l_st.st_ino != f_st.st_ino) {
697                 errno = EINVAL;
698                 goto close_and_return_error;
699         }
700 #endif
701
702         return fd;
703 }