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-2020 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 *fname)
82 if (dry_run) return 0;
83 RETURN_ERROR_IF_RO_OR_LO;
88 int do_symlink(const char *lnk, const char *fname)
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(fname, O_WRONLY|O_CREAT|O_TRUNC, S_IWUSR|S_IRUSR);
101 ok = write(fd, lnk, len) == len;
108 return symlink(lnk, fname);
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)
235 if (dry_run) return 0;
236 RETURN_ERROR_IF_RO_OR_LO;
238 if ((code = lchmod(path, mode & CHMOD_BITS)) < 0 && errno == ENOTSUP)
242 # if defined HAVE_SETATTRLIST
243 struct attrlist attrList;
244 uint32_t m = mode & CHMOD_BITS; /* manpage is wrong: not mode_t! */
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);
254 code = chmod(path, mode & CHMOD_BITS); /* DISCOURAGED FUNCTION */
256 if (code != 0 && (preserve_perms || preserve_executability))
262 int do_rename(const char *old_path, const char *new_path)
264 if (dry_run) return 0;
265 RETURN_ERROR_IF_RO_OR_LO;
266 return rename(old_path, new_path);
269 #ifdef HAVE_FTRUNCATE
270 int do_ftruncate(int fd, OFF_T size)
274 if (dry_run) return 0;
275 RETURN_ERROR_IF_RO_OR_LO;
278 ret = ftruncate(fd, size);
279 } while (ret < 0 && errno == EINTR);
285 void trim_trailing_slashes(char *name)
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> */
292 /* Don't change empty string; and also we can't improve on
297 if (name[--l] != '/')
303 int do_mkdir(char *fname, mode_t mode)
305 if (dry_run) return 0;
306 RETURN_ERROR_IF_RO_OR_LO;
307 trim_trailing_slashes(fname);
308 return mkdir(fname, mode);
311 /* like mkstemp but forces permissions */
312 int do_mkstemp(char *template, mode_t perms)
314 RETURN_ERROR_IF(dry_run, 0);
315 RETURN_ERROR_IF(read_only, EROFS);
318 #if defined HAVE_SECURE_MKSTEMP && defined HAVE_FCHMOD && (!defined HAVE_OPEN64 || defined HAVE_MKSTEMP64)
320 int fd = mkstemp(template);
323 if (fchmod(fd, perms) != 0 && preserve_perms) {
324 int errno_save = errno;
330 #if defined HAVE_SETMODE && O_BINARY
331 setmode(fd, O_BINARY);
336 if (!mktemp(template))
338 return do_open(template, O_RDWR|O_EXCL|O_CREAT, perms);
342 int do_stat(const char *fname, STRUCT_STAT *st)
344 #ifdef USE_STAT64_FUNCS
345 return stat64(fname, st);
347 return stat(fname, st);
351 int do_lstat(const char *fname, STRUCT_STAT *st)
354 # ifdef USE_STAT64_FUNCS
355 return lstat64(fname, st);
357 return lstat(fname, st);
360 return do_stat(fname, st);
364 int do_fstat(int fd, STRUCT_STAT *st)
366 #ifdef USE_STAT64_FUNCS
367 return fstat64(fd, st);
369 return fstat(fd, st);
373 OFF_T do_lseek(int fd, OFF_T offset, int whence)
381 return lseek64(fd, offset, whence);
383 return lseek(fd, offset, whence);
387 #ifdef HAVE_SETATTRLIST
388 int do_setattrlist_times(const char *fname, STRUCT_STAT *stp)
390 struct attrlist attrList;
391 struct timespec ts[2];
393 if (dry_run) return 0;
394 RETURN_ERROR_IF_RO_OR_LO;
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;
400 ts[1].tv_sec = stp->st_atime;
401 ts[1].tv_nsec = stp->ST_ATIME_NSEC;
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);
410 #ifdef SUPPORT_CRTIMES
411 time_t get_create_time(const char *path, STRUCT_STAT *stp)
413 #ifdef HAVE_GETATTRLIST
414 static struct create_time attrBuf;
415 struct attrlist attrList;
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)
423 return attrBuf.crtime.tv_sec;
424 #elif defined __CYGWIN__
426 return stp->st_birthtime;
428 #error Unknown crtimes implementation
432 int set_create_time(const char *path, time_t crtime)
434 if (dry_run) return 0;
435 RETURN_ERROR_IF_RO_OR_LO;
438 #ifdef HAVE_GETATTRLIST
439 struct attrlist attrList;
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);
453 WCHAR *pathw = new_array(WCHAR, cnt);
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);
460 if (handle == INVALID_HANDLE_VALUE)
462 int64 temp_time = Int32x32To64(crtime, 10000000) + 116444736000000000LL;
464 birth_time.dwLowDateTime = (DWORD)temp_time;
465 birth_time.dwHighDateTime = (DWORD)(temp_time >> 32);
466 int ok = SetFileTime(handle, &birth_time, NULL, NULL);
472 #endif /* SUPPORT_CRTIMES */
474 #ifdef HAVE_UTIMENSAT
475 int do_utimensat(const char *fname, STRUCT_STAT *stp)
477 struct timespec t[2];
479 if (dry_run) return 0;
480 RETURN_ERROR_IF_RO_OR_LO;
482 t[0].tv_sec = stp->st_atime;
484 t[0].tv_nsec = stp->ST_ATIME_NSEC;
488 t[1].tv_sec = stp->st_mtime;
490 t[1].tv_nsec = stp->ST_MTIME_NSEC;
494 return utimensat(AT_FDCWD, fname, t, AT_SYMLINK_NOFOLLOW);
499 int do_lutimes(const char *fname, STRUCT_STAT *stp)
503 if (dry_run) return 0;
504 RETURN_ERROR_IF_RO_OR_LO;
506 t[0].tv_sec = stp->st_atime;
508 t[0].tv_usec = stp->ST_ATIME_NSEC / 1000;
512 t[1].tv_sec = stp->st_mtime;
514 t[1].tv_usec = stp->ST_MTIME_NSEC / 1000;
518 return lutimes(fname, t);
523 int do_utimes(const char *fname, STRUCT_STAT *stp)
527 if (dry_run) return 0;
528 RETURN_ERROR_IF_RO_OR_LO;
530 t[0].tv_sec = stp->st_atime;
532 t[0].tv_usec = stp->ST_ATIME_NSEC / 1000;
536 t[1].tv_sec = stp->st_mtime;
538 t[1].tv_usec = stp->ST_MTIME_NSEC / 1000;
542 return utimes(fname, t);
545 #elif defined HAVE_UTIME
546 int do_utime(const char *fname, STRUCT_STAT *stp)
548 #ifdef HAVE_STRUCT_UTIMBUF
554 if (dry_run) return 0;
555 RETURN_ERROR_IF_RO_OR_LO;
557 # ifdef HAVE_STRUCT_UTIMBUF
558 tbuf.actime = stp->st_atime;
559 tbuf.modtime = stp->st_mtime;
560 return utime(fname, &tbuf);
562 t[0] = stp->st_atime;
563 t[1] = stp->st_mtime;
564 return utime(fname, t);
569 #error Need utimes or utime function.
572 #ifdef SUPPORT_PREALLOCATION
573 #ifdef FALLOC_FL_KEEP_SIZE
574 #define DO_FALLOC_OPTIONS FALLOC_FL_KEEP_SIZE
576 #define DO_FALLOC_OPTIONS 0
579 OFF_T do_fallocate(int fd, OFF_T offset, OFF_T length)
581 int opts = inplace || preallocate_files ? DO_FALLOC_OPTIONS : 0;
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 */
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);
596 #error Coding error in SUPPORT_PREALLOCATION logic.
602 if (do_fstat(fd, &st) < 0)
604 return st.st_blocks * S_BLKSIZE;
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)
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)
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)
634 memset(zeros, 0, sizeof zeros);
636 int chunk = len > (int)sizeof zeros ? (int)sizeof zeros : len;
637 int wrote = write(fd, zeros, chunk);
639 if (wrote < 0 && errno == EINTR)
649 int do_open_nofollow(const char *pathname, int flags)
652 STRUCT_STAT f_st, l_st;
656 if (flags != O_RDONLY) {
657 RETURN_ERROR_IF(dry_run, 0);
658 RETURN_ERROR_IF_RO_OR_LO;
660 /* This function doesn't support write attempts w/o O_NOFOLLOW. */
667 fd = open(pathname, flags|O_NOFOLLOW);
669 if (do_lstat(pathname, &l_st) < 0)
671 if (S_ISLNK(l_st.st_mode)) {
675 if ((fd = open(pathname, flags)) < 0)
677 if (do_fstat(fd, &f_st) < 0) {
678 close_and_return_error:
680 int save_errno = errno;
686 if (l_st.st_dev != f_st.st_dev || l_st.st_ino != f_st.st_ino) {
688 goto close_and_return_error;