2 * Syscall wrappers to ensure that nothing gets done in dry_run mode
3 * and to handle system peculiarities.
5 * Copyright (C) 1998 Andrew Tridgell
6 * Copyright (C) 2002 Martin Pool
7 * Copyright (C) 2003-2022 Wayne Davison
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.
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.
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.
25 #if !defined MKNOD_CREATES_SOCKETS && defined HAVE_SYS_UN_H
28 #ifdef HAVE_SYS_ATTR_H
32 #if defined HAVE_SYS_FALLOCATE && !defined HAVE_FALLOCATE
33 #include <sys/syscall.h>
42 extern int preallocate_files;
43 extern int preserve_perms;
44 extern int preserve_executability;
45 extern int open_noatime;
48 # if defined hpux || defined __hpux__ || defined __hpux
49 # define S_BLKSIZE 1024
50 # elif defined _AIX && defined _I386
51 # define S_BLKSIZE 4096
53 # define S_BLKSIZE 512
57 #ifdef SUPPORT_CRTIMES
58 #ifdef HAVE_GETATTRLIST
62 struct timespec crtime;
65 #elif defined __CYGWIN__
70 #define RETURN_ERROR_IF(x,e) \
78 #define RETURN_ERROR_IF_RO_OR_LO RETURN_ERROR_IF(read_only || list_only, EROFS)
80 int do_unlink(const char *path)
82 if (dry_run) return 0;
83 RETURN_ERROR_IF_RO_OR_LO;
88 int do_symlink(const char *lnk, const char *path)
90 if (dry_run) return 0;
91 RETURN_ERROR_IF_RO_OR_LO;
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. */
97 int ok, len = strlen(lnk);
98 int fd = open(path, O_WRONLY|O_CREAT|O_TRUNC, S_IWUSR|S_IRUSR);
101 ok = write(fd, lnk, len) == len;
108 return symlink(lnk, path);
111 #if defined NO_SYMLINK_XATTRS || defined NO_SYMLINK_USER_XATTRS
112 ssize_t do_readlink(const char *path, char *buf, size_t bufsiz)
114 /* For --fake-super, we read the link from the file. */
116 int fd = do_open_nofollow(path, O_RDONLY);
118 int len = read(fd, buf, bufsiz);
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. */
128 /* Otherwise fall through and let the sender report the real length. */
131 return readlink(path, buf, bufsiz);
136 #if defined HAVE_LINK || defined HAVE_LINKAT
137 int do_link(const char *old_path, const char *new_path)
139 if (dry_run) return 0;
140 RETURN_ERROR_IF_RO_OR_LO;
142 return linkat(AT_FDCWD, old_path, AT_FDCWD, new_path, 0);
144 return link(old_path, new_path);
149 int do_lchown(const char *path, uid_t owner, gid_t group)
151 if (dry_run) return 0;
152 RETURN_ERROR_IF_RO_OR_LO;
156 return lchown(path, owner, group);
159 int do_mknod(const char *pathname, mode_t mode, dev_t dev)
161 if (dry_run) return 0;
162 RETURN_ERROR_IF_RO_OR_LO;
164 /* For --fake-super, we create a normal file with mode 0600. */
166 int fd = open(pathname, O_WRONLY|O_CREAT|O_TRUNC, S_IWUSR|S_IRUSR);
167 if (fd < 0 || close(fd) < 0)
172 #if !defined MKNOD_CREATES_FIFOS && defined HAVE_MKFIFO
174 return mkfifo(pathname, mode);
176 #if !defined MKNOD_CREATES_SOCKETS && defined HAVE_SYS_UN_H
177 if (S_ISSOCK(mode)) {
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;
185 #ifdef HAVE_SOCKADDR_UN_LEN
186 saddr.sun_len = len + 1;
188 saddr.sun_family = AF_UNIX;
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)
196 return do_chmod(pathname, mode);
203 return mknod(pathname, mode, dev);
209 int do_rmdir(const char *pathname)
211 if (dry_run) return 0;
212 RETURN_ERROR_IF_RO_OR_LO;
213 return rmdir(pathname);
216 int do_open(const char *pathname, int flags, mode_t mode)
218 if (flags != O_RDONLY) {
219 RETURN_ERROR_IF(dry_run, 0);
220 RETURN_ERROR_IF_RO_OR_LO;
228 return open(pathname, flags | O_BINARY, mode);
232 int do_chmod(const char *path, mode_t mode)
234 static int switch_step = 0;
237 if (dry_run) return 0;
238 RETURN_ERROR_IF_RO_OR_LO;
240 switch (switch_step) {
243 if ((code = lchmod(path, mode & CHMOD_BITS)) == 0)
247 else if (errno != ENOTSUP)
253 # if defined HAVE_SETATTRLIST
254 struct attrlist attrList;
255 uint32_t m = mode & CHMOD_BITS; /* manpage is wrong: not mode_t! */
257 memset(&attrList, 0, sizeof attrList);
258 attrList.bitmapcount = ATTR_BIT_MAP_COUNT;
259 attrList.commonattr = ATTR_CMN_ACCESSMASK;
260 code = setattrlist(path, &attrList, &m, sizeof m, FSOPT_NOFOLLOW);
265 code = chmod(path, mode & CHMOD_BITS); /* DISCOURAGED FUNCTION */
268 if (code != 0 && (preserve_perms || preserve_executability))
274 int do_rename(const char *old_path, const char *new_path)
276 if (dry_run) return 0;
277 RETURN_ERROR_IF_RO_OR_LO;
278 return rename(old_path, new_path);
281 #ifdef HAVE_FTRUNCATE
282 int do_ftruncate(int fd, OFF_T size)
286 if (dry_run) return 0;
287 RETURN_ERROR_IF_RO_OR_LO;
290 ret = ftruncate(fd, size);
291 } while (ret < 0 && errno == EINTR);
297 void trim_trailing_slashes(char *name)
300 /* Some BSD systems cannot make a directory if the name
301 * contains a trailing slash.
302 * <http://www.opensource.apple.com/bugs/X/BSD%20Kernel/2734739.html> */
304 /* Don't change empty string; and also we can't improve on
309 if (name[--l] != '/')
315 int do_mkdir(char *path, mode_t mode)
317 if (dry_run) return 0;
318 RETURN_ERROR_IF_RO_OR_LO;
319 trim_trailing_slashes(path);
320 return mkdir(path, mode);
323 /* like mkstemp but forces permissions */
324 int do_mkstemp(char *template, mode_t perms)
326 RETURN_ERROR_IF(dry_run, 0);
327 RETURN_ERROR_IF(read_only, EROFS);
330 #if defined HAVE_SECURE_MKSTEMP && defined HAVE_FCHMOD && (!defined HAVE_OPEN64 || defined HAVE_MKSTEMP64)
332 int fd = mkstemp(template);
335 if (fchmod(fd, perms) != 0 && preserve_perms) {
336 int errno_save = errno;
342 #if defined HAVE_SETMODE && O_BINARY
343 setmode(fd, O_BINARY);
348 if (!mktemp(template))
350 return do_open(template, O_RDWR|O_EXCL|O_CREAT, perms);
354 int do_stat(const char *path, STRUCT_STAT *st)
356 #ifdef USE_STAT64_FUNCS
357 return stat64(path, st);
359 return stat(path, st);
363 int do_lstat(const char *path, STRUCT_STAT *st)
366 # ifdef USE_STAT64_FUNCS
367 return lstat64(path, st);
369 return lstat(path, st);
372 return do_stat(path, st);
376 int do_fstat(int fd, STRUCT_STAT *st)
378 #ifdef USE_STAT64_FUNCS
379 return fstat64(fd, st);
381 return fstat(fd, st);
385 OFF_T do_lseek(int fd, OFF_T offset, int whence)
393 return lseek64(fd, offset, whence);
395 return lseek(fd, offset, whence);
399 #ifdef HAVE_SETATTRLIST
400 int do_setattrlist_times(const char *path, STRUCT_STAT *stp)
402 struct attrlist attrList;
403 struct timespec ts[2];
405 if (dry_run) return 0;
406 RETURN_ERROR_IF_RO_OR_LO;
408 /* Yes, this is in the opposite order of utime and similar. */
409 ts[0].tv_sec = stp->st_mtime;
410 ts[0].tv_nsec = stp->ST_MTIME_NSEC;
412 ts[1].tv_sec = stp->st_atime;
413 ts[1].tv_nsec = stp->ST_ATIME_NSEC;
415 memset(&attrList, 0, sizeof attrList);
416 attrList.bitmapcount = ATTR_BIT_MAP_COUNT;
417 attrList.commonattr = ATTR_CMN_MODTIME | ATTR_CMN_ACCTIME;
418 return setattrlist(path, &attrList, ts, sizeof ts, FSOPT_NOFOLLOW);
421 #ifdef SUPPORT_CRTIMES
422 int do_setattrlist_crtime(const char *path, time_t crtime)
424 struct attrlist attrList;
427 if (dry_run) return 0;
428 RETURN_ERROR_IF_RO_OR_LO;
433 memset(&attrList, 0, sizeof attrList);
434 attrList.bitmapcount = ATTR_BIT_MAP_COUNT;
435 attrList.commonattr = ATTR_CMN_CRTIME;
436 return setattrlist(path, &attrList, &ts, sizeof ts, FSOPT_NOFOLLOW);
439 #endif /* HAVE_SETATTRLIST */
441 #ifdef SUPPORT_CRTIMES
442 time_t get_create_time(const char *path, STRUCT_STAT *stp)
444 #ifdef HAVE_GETATTRLIST
445 static struct create_time attrBuf;
446 struct attrlist attrList;
449 memset(&attrList, 0, sizeof attrList);
450 attrList.bitmapcount = ATTR_BIT_MAP_COUNT;
451 attrList.commonattr = ATTR_CMN_CRTIME;
452 if (getattrlist(path, &attrList, &attrBuf, sizeof attrBuf, FSOPT_NOFOLLOW) < 0)
454 return attrBuf.crtime.tv_sec;
455 #elif defined __CYGWIN__
457 return stp->st_birthtime;
459 #error Unknown crtimes implementation
463 #if defined __CYGWIN__
464 int do_SetFileTime(const char *path, time_t crtime)
466 if (dry_run) return 0;
467 RETURN_ERROR_IF_RO_OR_LO;
469 int cnt = MultiByteToWideChar(CP_UTF8, 0, path, -1, NULL, 0);
472 WCHAR *pathw = new_array(WCHAR, cnt);
475 MultiByteToWideChar(CP_UTF8, 0, path, -1, pathw, cnt);
476 HANDLE handle = CreateFileW(pathw, FILE_WRITE_ATTRIBUTES, FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
477 NULL, OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS, NULL);
479 if (handle == INVALID_HANDLE_VALUE)
481 int64 temp_time = Int32x32To64(crtime, 10000000) + 116444736000000000LL;
483 birth_time.dwLowDateTime = (DWORD)temp_time;
484 birth_time.dwHighDateTime = (DWORD)(temp_time >> 32);
485 int ok = SetFileTime(handle, &birth_time, NULL, NULL);
490 #endif /* SUPPORT_CRTIMES */
492 #ifdef HAVE_UTIMENSAT
493 int do_utimensat(const char *path, STRUCT_STAT *stp)
495 struct timespec t[2];
497 if (dry_run) return 0;
498 RETURN_ERROR_IF_RO_OR_LO;
500 t[0].tv_sec = stp->st_atime;
502 t[0].tv_nsec = stp->ST_ATIME_NSEC;
506 t[1].tv_sec = stp->st_mtime;
508 t[1].tv_nsec = stp->ST_MTIME_NSEC;
512 return utimensat(AT_FDCWD, path, t, AT_SYMLINK_NOFOLLOW);
517 int do_lutimes(const char *path, STRUCT_STAT *stp)
521 if (dry_run) return 0;
522 RETURN_ERROR_IF_RO_OR_LO;
524 t[0].tv_sec = stp->st_atime;
526 t[0].tv_usec = stp->ST_ATIME_NSEC / 1000;
530 t[1].tv_sec = stp->st_mtime;
532 t[1].tv_usec = stp->ST_MTIME_NSEC / 1000;
536 return lutimes(path, t);
541 int do_utimes(const char *path, STRUCT_STAT *stp)
545 if (dry_run) return 0;
546 RETURN_ERROR_IF_RO_OR_LO;
548 t[0].tv_sec = stp->st_atime;
550 t[0].tv_usec = stp->ST_ATIME_NSEC / 1000;
554 t[1].tv_sec = stp->st_mtime;
556 t[1].tv_usec = stp->ST_MTIME_NSEC / 1000;
560 return utimes(path, t);
563 #elif defined HAVE_UTIME
564 int do_utime(const char *path, STRUCT_STAT *stp)
566 #ifdef HAVE_STRUCT_UTIMBUF
572 if (dry_run) return 0;
573 RETURN_ERROR_IF_RO_OR_LO;
575 # ifdef HAVE_STRUCT_UTIMBUF
576 tbuf.actime = stp->st_atime;
577 tbuf.modtime = stp->st_mtime;
578 return utime(path, &tbuf);
580 t[0] = stp->st_atime;
581 t[1] = stp->st_mtime;
582 return utime(path, t);
587 #error Need utimes or utime function.
590 #ifdef SUPPORT_PREALLOCATION
591 #ifdef FALLOC_FL_KEEP_SIZE
592 #define DO_FALLOC_OPTIONS FALLOC_FL_KEEP_SIZE
594 #define DO_FALLOC_OPTIONS 0
597 OFF_T do_fallocate(int fd, OFF_T offset, OFF_T length)
599 int opts = inplace || preallocate_files ? DO_FALLOC_OPTIONS : 0;
601 RETURN_ERROR_IF(dry_run, 0);
602 RETURN_ERROR_IF_RO_OR_LO;
603 if (length & 1) /* make the length not match the desired length */
607 #if defined HAVE_FALLOCATE
608 ret = fallocate(fd, opts, offset, length);
609 #elif defined HAVE_SYS_FALLOCATE
610 ret = syscall(SYS_fallocate, fd, opts, (loff_t)offset, (loff_t)length);
611 #elif defined HAVE_EFFICIENT_POSIX_FALLOCATE
612 ret = posix_fallocate(fd, offset, length);
614 #error Coding error in SUPPORT_PREALLOCATION logic.
620 if (do_fstat(fd, &st) < 0)
622 return st.st_blocks * S_BLKSIZE;
628 /* Punch a hole at pos for len bytes. The current file position must be at pos and will be
629 * changed to be at pos + len. */
630 int do_punch_hole(int fd, OFF_T pos, OFF_T len)
632 #ifdef HAVE_FALLOCATE
633 # ifdef HAVE_FALLOC_FL_PUNCH_HOLE
634 if (fallocate(fd, FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE, pos, len) == 0) {
635 if (do_lseek(fd, len, SEEK_CUR) != pos + len)
640 # ifdef HAVE_FALLOC_FL_ZERO_RANGE
641 if (fallocate(fd, FALLOC_FL_ZERO_RANGE, pos, len) == 0) {
642 if (do_lseek(fd, len, SEEK_CUR) != pos + len)
652 memset(zeros, 0, sizeof zeros);
654 int chunk = len > (int)sizeof zeros ? (int)sizeof zeros : len;
655 int wrote = write(fd, zeros, chunk);
657 if (wrote < 0 && errno == EINTR)
667 int do_open_nofollow(const char *pathname, int flags)
670 STRUCT_STAT f_st, l_st;
674 if (flags != O_RDONLY) {
675 RETURN_ERROR_IF(dry_run, 0);
676 RETURN_ERROR_IF_RO_OR_LO;
678 /* This function doesn't support write attempts w/o O_NOFOLLOW. */
685 fd = open(pathname, flags|O_NOFOLLOW);
687 if (do_lstat(pathname, &l_st) < 0)
689 if (S_ISLNK(l_st.st_mode)) {
693 if ((fd = open(pathname, flags)) < 0)
695 if (do_fstat(fd, &f_st) < 0) {
696 close_and_return_error:
698 int save_errno = errno;
704 if (l_st.st_dev != f_st.st_dev || l_st.st_ino != f_st.st_ino) {
706 goto close_and_return_error;