Enable --atimes on macOS.
[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 *fname)
81 {
82         if (dry_run) return 0;
83         RETURN_ERROR_IF_RO_OR_LO;
84         return unlink(fname);
85 }
86
87 #ifdef SUPPORT_LINKS
88 int do_symlink(const char *lnk, const char *fname)
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(fname, 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, fname);
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         int code;
235         if (dry_run) return 0;
236         RETURN_ERROR_IF_RO_OR_LO;
237 #ifdef HAVE_LCHMOD
238         if ((code = lchmod(path, mode & CHMOD_BITS)) < 0 && errno == ENOTSUP)
239 #endif
240         {
241                 if (S_ISLNK(mode)) {
242 # if defined HAVE_SETATTRLIST
243                         struct attrlist attrList;
244                         uint32_t m = mode & CHMOD_BITS; /* manpage is wrong: not mode_t! */
245
246                         memset(&attrList, 0, sizeof attrList);
247                         attrList.bitmapcount = ATTR_BIT_MAP_COUNT;
248                         attrList.commonattr = ATTR_CMN_ACCESSMASK;
249                         code = setattrlist(path, &attrList, &m, sizeof m, FSOPT_NOFOLLOW);
250 # else
251                         code = 1;
252 # endif
253                 } else
254                         code = chmod(path, mode & CHMOD_BITS); /* DISCOURAGED FUNCTION */
255         }
256         if (code != 0 && (preserve_perms || preserve_executability))
257                 return code;
258         return 0;
259 }
260 #endif
261
262 int do_rename(const char *old_path, const char *new_path)
263 {
264         if (dry_run) return 0;
265         RETURN_ERROR_IF_RO_OR_LO;
266         return rename(old_path, new_path);
267 }
268
269 #ifdef HAVE_FTRUNCATE
270 int do_ftruncate(int fd, OFF_T size)
271 {
272         int ret;
273
274         if (dry_run) return 0;
275         RETURN_ERROR_IF_RO_OR_LO;
276
277         do {
278                 ret = ftruncate(fd, size);
279         } while (ret < 0 && errno == EINTR);
280
281         return ret;
282 }
283 #endif
284
285 void trim_trailing_slashes(char *name)
286 {
287         int l;
288         /* Some BSD systems cannot make a directory if the name
289          * contains a trailing slash.
290          * <http://www.opensource.apple.com/bugs/X/BSD%20Kernel/2734739.html> */
291
292         /* Don't change empty string; and also we can't improve on
293          * "/" */
294
295         l = strlen(name);
296         while (l > 1) {
297                 if (name[--l] != '/')
298                         break;
299                 name[l] = '\0';
300         }
301 }
302
303 int do_mkdir(char *fname, mode_t mode)
304 {
305         if (dry_run) return 0;
306         RETURN_ERROR_IF_RO_OR_LO;
307         trim_trailing_slashes(fname);
308         return mkdir(fname, mode);
309 }
310
311 /* like mkstemp but forces permissions */
312 int do_mkstemp(char *template, mode_t perms)
313 {
314         RETURN_ERROR_IF(dry_run, 0);
315         RETURN_ERROR_IF(read_only, EROFS);
316         perms |= S_IWUSR;
317
318 #if defined HAVE_SECURE_MKSTEMP && defined HAVE_FCHMOD && (!defined HAVE_OPEN64 || defined HAVE_MKSTEMP64)
319         {
320                 int fd = mkstemp(template);
321                 if (fd == -1)
322                         return -1;
323                 if (fchmod(fd, perms) != 0 && preserve_perms) {
324                         int errno_save = errno;
325                         close(fd);
326                         unlink(template);
327                         errno = errno_save;
328                         return -1;
329                 }
330 #if defined HAVE_SETMODE && O_BINARY
331                 setmode(fd, O_BINARY);
332 #endif
333                 return fd;
334         }
335 #else
336         if (!mktemp(template))
337                 return -1;
338         return do_open(template, O_RDWR|O_EXCL|O_CREAT, perms);
339 #endif
340 }
341
342 int do_stat(const char *fname, STRUCT_STAT *st)
343 {
344 #ifdef USE_STAT64_FUNCS
345         return stat64(fname, st);
346 #else
347         return stat(fname, st);
348 #endif
349 }
350
351 int do_lstat(const char *fname, STRUCT_STAT *st)
352 {
353 #ifdef SUPPORT_LINKS
354 # ifdef USE_STAT64_FUNCS
355         return lstat64(fname, st);
356 # else
357         return lstat(fname, st);
358 # endif
359 #else
360         return do_stat(fname, st);
361 #endif
362 }
363
364 int do_fstat(int fd, STRUCT_STAT *st)
365 {
366 #ifdef USE_STAT64_FUNCS
367         return fstat64(fd, st);
368 #else
369         return fstat(fd, st);
370 #endif
371 }
372
373 OFF_T do_lseek(int fd, OFF_T offset, int whence)
374 {
375 #ifdef HAVE_LSEEK64
376 #if !SIZEOF_OFF64_T
377         OFF_T lseek64();
378 #else
379         off64_t lseek64();
380 #endif
381         return lseek64(fd, offset, whence);
382 #else
383         return lseek(fd, offset, whence);
384 #endif
385 }
386
387 #ifdef HAVE_SETATTRLIST
388 int do_setattrlist_times(const char *fname, STRUCT_STAT *stp)
389 {
390         struct attrlist attrList;
391         struct timespec ts[2];
392
393         if (dry_run) return 0;
394         RETURN_ERROR_IF_RO_OR_LO;
395
396         /* Yes, this is in the opposite order of utime and similar. */
397         ts[0].tv_sec = stp->st_mtime;
398         ts[0].tv_nsec = stp->ST_MTIME_NSEC;
399
400         ts[1].tv_sec = stp->st_atime;
401         ts[1].tv_nsec = stp->ST_ATIME_NSEC;
402
403         memset(&attrList, 0, sizeof attrList);
404         attrList.bitmapcount = ATTR_BIT_MAP_COUNT;
405         attrList.commonattr = ATTR_CMN_MODTIME | ATTR_CMN_ACCTIME;
406         return setattrlist(fname, &attrList, ts, sizeof ts, FSOPT_NOFOLLOW);
407 }
408 #endif
409
410 #ifdef SUPPORT_CRTIMES
411 time_t get_create_time(const char *path, STRUCT_STAT *stp)
412 {
413 #ifdef HAVE_GETATTRLIST
414         static struct create_time attrBuf;
415         struct attrlist attrList;
416
417         (void)stp;
418         memset(&attrList, 0, sizeof attrList);
419         attrList.bitmapcount = ATTR_BIT_MAP_COUNT;
420         attrList.commonattr = ATTR_CMN_CRTIME;
421         if (getattrlist(path, &attrList, &attrBuf, sizeof attrBuf, FSOPT_NOFOLLOW) < 0)
422                 return 0;
423         return attrBuf.crtime.tv_sec;
424 #elif defined __CYGWIN__
425         (void)path;
426         return stp->st_birthtime;
427 #else
428 #error Unknown crtimes implementation
429 #endif
430 }
431
432 int set_create_time(const char *path, time_t crtime)
433 {
434         if (dry_run) return 0;
435         RETURN_ERROR_IF_RO_OR_LO;
436
437     {
438 #ifdef HAVE_GETATTRLIST
439         struct attrlist attrList;
440         struct timespec ts;
441
442         ts.tv_sec = crtime;
443         ts.tv_nsec = 0;
444
445         memset(&attrList, 0, sizeof attrList);
446         attrList.bitmapcount = ATTR_BIT_MAP_COUNT;
447         attrList.commonattr = ATTR_CMN_CRTIME;
448         return setattrlist(path, &attrList, &ts, sizeof ts, FSOPT_NOFOLLOW);
449 #elif defined __CYGWIN__
450         int cnt = MultiByteToWideChar(CP_UTF8, 0, path, -1, NULL, 0);
451         if (cnt == 0)
452             return -1;
453         WCHAR *pathw = new_array(WCHAR, cnt);
454         if (!pathw)
455             return -1;
456         MultiByteToWideChar(CP_UTF8, 0, path, -1, pathw, cnt);
457         HANDLE handle = CreateFileW(pathw, FILE_WRITE_ATTRIBUTES, FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
458                                     NULL, OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS, NULL);
459         free(pathw);
460         if (handle == INVALID_HANDLE_VALUE)
461             return -1;
462         int64 temp_time = Int32x32To64(crtime, 10000000) + 116444736000000000LL;
463         FILETIME birth_time;
464         birth_time.dwLowDateTime = (DWORD)temp_time;
465         birth_time.dwHighDateTime = (DWORD)(temp_time >> 32);
466         int ok = SetFileTime(handle, &birth_time, NULL, NULL);
467         CloseHandle(handle);
468         return ok ? 0 : -1;
469 #endif
470     }
471 }
472 #endif /* SUPPORT_CRTIMES */
473
474 #ifdef HAVE_UTIMENSAT
475 int do_utimensat(const char *fname, STRUCT_STAT *stp)
476 {
477         struct timespec t[2];
478
479         if (dry_run) return 0;
480         RETURN_ERROR_IF_RO_OR_LO;
481
482         t[0].tv_sec = stp->st_atime;
483 #ifdef ST_ATIME_NSEC
484         t[0].tv_nsec = stp->ST_ATIME_NSEC;
485 #else
486         t[0].tv_nsec = 0;
487 #endif
488         t[1].tv_sec = stp->st_mtime;
489 #ifdef ST_MTIME_NSEC
490         t[1].tv_nsec = stp->ST_MTIME_NSEC;
491 #else
492         t[1].tv_nsec = 0;
493 #endif
494         return utimensat(AT_FDCWD, fname, t, AT_SYMLINK_NOFOLLOW);
495 }
496 #endif
497
498 #ifdef HAVE_LUTIMES
499 int do_lutimes(const char *fname, STRUCT_STAT *stp)
500 {
501         struct timeval t[2];
502
503         if (dry_run) return 0;
504         RETURN_ERROR_IF_RO_OR_LO;
505
506         t[0].tv_sec = stp->st_atime;
507 #ifdef ST_ATIME_NSEC
508         t[0].tv_usec = stp->ST_ATIME_NSEC / 1000;
509 #else
510         t[0].tv_usec = 0;
511 #endif
512         t[1].tv_sec = stp->st_mtime;
513 #ifdef ST_MTIME_NSEC
514         t[1].tv_usec = stp->ST_MTIME_NSEC / 1000;
515 #else
516         t[1].tv_usec = 0;
517 #endif
518         return lutimes(fname, t);
519 }
520 #endif
521
522 #ifdef HAVE_UTIMES
523 int do_utimes(const char *fname, STRUCT_STAT *stp)
524 {
525         struct timeval t[2];
526
527         if (dry_run) return 0;
528         RETURN_ERROR_IF_RO_OR_LO;
529
530         t[0].tv_sec = stp->st_atime;
531 #ifdef ST_ATIME_NSEC
532         t[0].tv_usec = stp->ST_ATIME_NSEC / 1000;
533 #else
534         t[0].tv_usec = 0;
535 #endif
536         t[1].tv_sec = stp->st_mtime;
537 #ifdef ST_MTIME_NSEC
538         t[1].tv_usec = stp->ST_MTIME_NSEC / 1000;
539 #else
540         t[1].tv_usec = 0;
541 #endif
542         return utimes(fname, t);
543 }
544
545 #elif defined HAVE_UTIME
546 int do_utime(const char *fname, STRUCT_STAT *stp)
547 {
548 #ifdef HAVE_STRUCT_UTIMBUF
549         struct utimbuf tbuf;
550 #else
551         time_t t[2];
552 #endif
553
554         if (dry_run) return 0;
555         RETURN_ERROR_IF_RO_OR_LO;
556
557 # ifdef HAVE_STRUCT_UTIMBUF
558         tbuf.actime = stp->st_atime;
559         tbuf.modtime = stp->st_mtime;
560         return utime(fname, &tbuf);
561 # else
562         t[0] = stp->st_atime;
563         t[1] = stp->st_mtime;
564         return utime(fname, t);
565 # endif
566 }
567
568 #else
569 #error Need utimes or utime function.
570 #endif
571
572 #ifdef SUPPORT_PREALLOCATION
573 #ifdef FALLOC_FL_KEEP_SIZE
574 #define DO_FALLOC_OPTIONS FALLOC_FL_KEEP_SIZE
575 #else
576 #define DO_FALLOC_OPTIONS 0
577 #endif
578
579 OFF_T do_fallocate(int fd, OFF_T offset, OFF_T length)
580 {
581         int opts = inplace || preallocate_files ? DO_FALLOC_OPTIONS : 0;
582         int ret;
583         RETURN_ERROR_IF(dry_run, 0);
584         RETURN_ERROR_IF_RO_OR_LO;
585         if (length & 1) /* make the length not match the desired length */
586                 length++;
587         else
588                 length--;
589 #if defined HAVE_FALLOCATE
590         ret = fallocate(fd, opts, offset, length);
591 #elif defined HAVE_SYS_FALLOCATE
592         ret = syscall(SYS_fallocate, fd, opts, (loff_t)offset, (loff_t)length);
593 #elif defined HAVE_EFFICIENT_POSIX_FALLOCATE
594         ret = posix_fallocate(fd, offset, length);
595 #else
596 #error Coding error in SUPPORT_PREALLOCATION logic.
597 #endif
598         if (ret < 0)
599                 return ret;
600         if (opts == 0) {
601                 STRUCT_STAT st;
602                 if (do_fstat(fd, &st) < 0)
603                         return length;
604                 return st.st_blocks * S_BLKSIZE;
605         }
606         return 0;
607 }
608 #endif
609
610 /* Punch a hole at pos for len bytes. The current file position must be at pos and will be
611  * changed to be at pos + len. */
612 int do_punch_hole(int fd, OFF_T pos, OFF_T len)
613 {
614 #ifdef HAVE_FALLOCATE
615 # ifdef HAVE_FALLOC_FL_PUNCH_HOLE
616         if (fallocate(fd, FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE, pos, len) == 0) {
617                 if (do_lseek(fd, len, SEEK_CUR) != pos + len)
618                         return -1;
619                 return 0;
620         }
621 # endif
622 # ifdef HAVE_FALLOC_FL_ZERO_RANGE
623         if (fallocate(fd, FALLOC_FL_ZERO_RANGE, pos, len) == 0) {
624                 if (do_lseek(fd, len, SEEK_CUR) != pos + len)
625                         return -1;
626                 return 0;
627         }
628 # endif
629 #else
630         (void)pos;
631 #endif
632         {
633                 char zeros[4096];
634                 memset(zeros, 0, sizeof zeros);
635                 while (len > 0) {
636                         int chunk = len > (int)sizeof zeros ? (int)sizeof zeros : len;
637                         int wrote = write(fd, zeros, chunk);
638                         if (wrote <= 0) {
639                                 if (wrote < 0 && errno == EINTR)
640                                         continue;
641                                 return -1;
642                         }
643                         len -= wrote;
644                 }
645         }
646         return 0;
647 }
648
649 int do_open_nofollow(const char *pathname, int flags)
650 {
651 #ifndef O_NOFOLLOW
652         STRUCT_STAT f_st, l_st;
653 #endif
654         int fd;
655
656         if (flags != O_RDONLY) {
657                 RETURN_ERROR_IF(dry_run, 0);
658                 RETURN_ERROR_IF_RO_OR_LO;
659 #ifndef O_NOFOLLOW
660                 /* This function doesn't support write attempts w/o O_NOFOLLOW. */
661                 errno = EINVAL;
662                 return -1;
663 #endif
664         }
665
666 #ifdef O_NOFOLLOW
667         fd = open(pathname, flags|O_NOFOLLOW);
668 #else
669         if (do_lstat(pathname, &l_st) < 0)
670                 return -1;
671         if (S_ISLNK(l_st.st_mode)) {
672                 errno = ELOOP;
673                 return -1;
674         }
675         if ((fd = open(pathname, flags)) < 0)
676                 return fd;
677         if (do_fstat(fd, &f_st) < 0) {
678           close_and_return_error:
679                 {
680                         int save_errno = errno;
681                         close(fd);
682                         errno = save_errno;
683                 }
684                 return -1;
685         }
686         if (l_st.st_dev != f_st.st_dev || l_st.st_ino != f_st.st_ino) {
687                 errno = EINVAL;
688                 goto close_and_return_error;
689         }
690 #endif
691
692         return fd;
693 }