2 * Various trivial helper wrappers around standard functions
8 static intmax_t count_fsync_writeout_only
;
9 static intmax_t count_fsync_hardware_flush
;
11 #ifdef HAVE_RTLGENRANDOM
12 /* This is required to get access to RtlGenRandom. */
13 #define SystemFunction036 NTAPI SystemFunction036
15 #undef SystemFunction036
18 static int memory_limit_check(size_t size
, int gentle
)
20 static size_t limit
= 0;
22 limit
= git_env_ulong("GIT_ALLOC_LIMIT", 0);
28 error("attempting to allocate %"PRIuMAX
" over limit %"PRIuMAX
,
29 (uintmax_t)size
, (uintmax_t)limit
);
32 die("attempting to allocate %"PRIuMAX
" over limit %"PRIuMAX
,
33 (uintmax_t)size
, (uintmax_t)limit
);
38 char *xstrdup(const char *str
)
40 char *ret
= strdup(str
);
42 die("Out of memory, strdup failed");
46 static void *do_xmalloc(size_t size
, int gentle
)
50 if (memory_limit_check(size
, gentle
))
57 die("Out of memory, malloc failed (tried to allocate %lu bytes)",
60 error("Out of memory, malloc failed (tried to allocate %lu bytes)",
66 memset(ret
, 0xA5, size
);
71 void *xmalloc(size_t size
)
73 return do_xmalloc(size
, 0);
76 static void *do_xmallocz(size_t size
, int gentle
)
79 if (unsigned_add_overflows(size
, 1)) {
81 error("Data too large to fit into virtual memory space.");
84 die("Data too large to fit into virtual memory space.");
86 ret
= do_xmalloc(size
+ 1, gentle
);
88 ((char*)ret
)[size
] = 0;
92 void *xmallocz(size_t size
)
94 return do_xmallocz(size
, 0);
97 void *xmallocz_gently(size_t size
)
99 return do_xmallocz(size
, 1);
103 * xmemdupz() allocates (len + 1) bytes of memory, duplicates "len" bytes of
104 * "data" to the allocated memory, zero terminates the allocated memory,
105 * and returns a pointer to the allocated memory. If the allocation fails,
108 void *xmemdupz(const void *data
, size_t len
)
110 return memcpy(xmallocz(len
), data
, len
);
113 char *xstrndup(const char *str
, size_t len
)
115 char *p
= memchr(str
, '\0', len
);
116 return xmemdupz(str
, p
? p
- str
: len
);
119 int xstrncmpz(const char *s
, const char *t
, size_t len
)
121 int res
= strncmp(s
, t
, len
);
124 return s
[len
] == '\0' ? 0 : 1;
127 void *xrealloc(void *ptr
, size_t size
)
136 memory_limit_check(size
, 0);
137 ret
= realloc(ptr
, size
);
139 die("Out of memory, realloc failed");
143 void *xcalloc(size_t nmemb
, size_t size
)
147 if (unsigned_mult_overflows(nmemb
, size
))
148 die("data too large to fit into virtual memory space");
150 memory_limit_check(size
* nmemb
, 0);
151 ret
= calloc(nmemb
, size
);
152 if (!ret
&& (!nmemb
|| !size
))
155 die("Out of memory, calloc failed");
159 void xsetenv(const char *name
, const char *value
, int overwrite
)
161 if (setenv(name
, value
, overwrite
))
162 die_errno(_("could not setenv '%s'"), name
? name
: "(null)");
166 * xopen() is the same as open(), but it die()s if the open() fails.
168 int xopen(const char *path
, int oflag
, ...)
174 * va_arg() will have undefined behavior if the specified type is not
175 * compatible with the argument type. Since integers are promoted to
176 * ints, we fetch the next argument as an int, and then cast it to a
177 * mode_t to avoid undefined behavior.
181 mode
= va_arg(ap
, int);
185 int fd
= open(path
, oflag
, mode
);
191 if ((oflag
& (O_CREAT
| O_EXCL
)) == (O_CREAT
| O_EXCL
))
192 die_errno(_("unable to create '%s'"), path
);
193 else if ((oflag
& O_RDWR
) == O_RDWR
)
194 die_errno(_("could not open '%s' for reading and writing"), path
);
195 else if ((oflag
& O_WRONLY
) == O_WRONLY
)
196 die_errno(_("could not open '%s' for writing"), path
);
198 die_errno(_("could not open '%s' for reading"), path
);
202 static int handle_nonblock(int fd
, short poll_events
, int err
)
206 if (err
!= EAGAIN
&& err
!= EWOULDBLOCK
)
210 pfd
.events
= poll_events
;
213 * no need to check for errors, here;
214 * a subsequent read/write will detect unrecoverable errors
221 * xread() is the same a read(), but it automatically restarts read()
222 * operations with a recoverable error (EAGAIN and EINTR). xread()
223 * DOES NOT GUARANTEE that "len" bytes is read even if the data is available.
225 ssize_t
xread(int fd
, void *buf
, size_t len
)
228 if (len
> MAX_IO_SIZE
)
231 nr
= read(fd
, buf
, len
);
235 if (handle_nonblock(fd
, POLLIN
, errno
))
243 * xwrite() is the same a write(), but it automatically restarts write()
244 * operations with a recoverable error (EAGAIN and EINTR). xwrite() DOES NOT
245 * GUARANTEE that "len" bytes is written even if the operation is successful.
247 ssize_t
xwrite(int fd
, const void *buf
, size_t len
)
250 if (len
> MAX_IO_SIZE
)
253 nr
= write(fd
, buf
, len
);
257 if (handle_nonblock(fd
, POLLOUT
, errno
))
266 * xpread() is the same as pread(), but it automatically restarts pread()
267 * operations with a recoverable error (EAGAIN and EINTR). xpread() DOES
268 * NOT GUARANTEE that "len" bytes is read even if the data is available.
270 ssize_t
xpread(int fd
, void *buf
, size_t len
, off_t offset
)
273 if (len
> MAX_IO_SIZE
)
276 nr
= pread(fd
, buf
, len
, offset
);
277 if ((nr
< 0) && (errno
== EAGAIN
|| errno
== EINTR
))
283 ssize_t
read_in_full(int fd
, void *buf
, size_t count
)
289 ssize_t loaded
= xread(fd
, p
, count
);
302 ssize_t
write_in_full(int fd
, const void *buf
, size_t count
)
308 ssize_t written
= xwrite(fd
, p
, count
);
323 ssize_t
pread_in_full(int fd
, void *buf
, size_t count
, off_t offset
)
329 ssize_t loaded
= xpread(fd
, p
, count
, offset
);
347 die_errno("dup failed");
352 * xfopen() is the same as fopen(), but it die()s if the fopen() fails.
354 FILE *xfopen(const char *path
, const char *mode
)
357 FILE *fp
= fopen(path
, mode
);
363 if (*mode
&& mode
[1] == '+')
364 die_errno(_("could not open '%s' for reading and writing"), path
);
365 else if (*mode
== 'w' || *mode
== 'a')
366 die_errno(_("could not open '%s' for writing"), path
);
368 die_errno(_("could not open '%s' for reading"), path
);
372 FILE *xfdopen(int fd
, const char *mode
)
374 FILE *stream
= fdopen(fd
, mode
);
376 die_errno("Out of memory? fdopen failed");
380 FILE *fopen_for_writing(const char *path
)
382 FILE *ret
= fopen(path
, "w");
384 if (!ret
&& errno
== EPERM
) {
386 ret
= fopen(path
, "w");
393 static void warn_on_inaccessible(const char *path
)
395 warning_errno(_("unable to access '%s'"), path
);
398 int warn_on_fopen_errors(const char *path
)
400 if (errno
!= ENOENT
&& errno
!= ENOTDIR
) {
401 warn_on_inaccessible(path
);
408 FILE *fopen_or_warn(const char *path
, const char *mode
)
410 FILE *fp
= fopen(path
, mode
);
415 warn_on_fopen_errors(path
);
419 int xmkstemp(char *filename_template
)
422 char origtemplate
[PATH_MAX
];
423 strlcpy(origtemplate
, filename_template
, sizeof(origtemplate
));
425 fd
= mkstemp(filename_template
);
427 int saved_errno
= errno
;
428 const char *nonrelative_template
;
430 if (strlen(filename_template
) != strlen(origtemplate
))
431 filename_template
= origtemplate
;
433 nonrelative_template
= absolute_path(filename_template
);
435 die_errno("Unable to create temporary file '%s'",
436 nonrelative_template
);
441 /* Adapted from libiberty's mkstemp.c. */
444 #define TMP_MAX 16384
446 int git_mkstemps_mode(char *pattern
, int suffix_len
, int mode
)
448 static const char letters
[] =
449 "abcdefghijklmnopqrstuvwxyz"
450 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
452 static const int num_letters
= ARRAY_SIZE(letters
) - 1;
453 static const char x_pattern
[] = "XXXXXX";
454 static const int num_x
= ARRAY_SIZE(x_pattern
) - 1;
455 char *filename_template
;
459 len
= strlen(pattern
);
461 if (len
< num_x
+ suffix_len
) {
466 if (strncmp(&pattern
[len
- num_x
- suffix_len
], x_pattern
, num_x
)) {
472 * Replace pattern's XXXXXX characters with randomness.
473 * Try TMP_MAX different filenames.
475 filename_template
= &pattern
[len
- num_x
- suffix_len
];
476 for (count
= 0; count
< TMP_MAX
; ++count
) {
479 if (csprng_bytes(&v
, sizeof(v
)) < 0)
480 return error_errno("unable to get random bytes for temporary file");
482 /* Fill in the random bits. */
483 for (i
= 0; i
< num_x
; i
++) {
484 filename_template
[i
] = letters
[v
% num_letters
];
488 fd
= open(pattern
, O_CREAT
| O_EXCL
| O_RDWR
, mode
);
492 * Fatal error (EPERM, ENOSPC etc).
493 * It doesn't make sense to loop.
498 /* We return the null string if we can't find a unique file name. */
503 int git_mkstemp_mode(char *pattern
, int mode
)
505 /* mkstemp is just mkstemps with no suffix */
506 return git_mkstemps_mode(pattern
, 0, mode
);
509 int xmkstemp_mode(char *filename_template
, int mode
)
512 char origtemplate
[PATH_MAX
];
513 strlcpy(origtemplate
, filename_template
, sizeof(origtemplate
));
515 fd
= git_mkstemp_mode(filename_template
, mode
);
517 int saved_errno
= errno
;
518 const char *nonrelative_template
;
520 if (!filename_template
[0])
521 filename_template
= origtemplate
;
523 nonrelative_template
= absolute_path(filename_template
);
525 die_errno("Unable to create temporary file '%s'",
526 nonrelative_template
);
532 * Some platforms return EINTR from fsync. Since fsync is invoked in some
533 * cases by a wrapper that dies on failure, do not expose EINTR to callers.
535 static int fsync_loop(int fd
)
541 } while (err
< 0 && errno
== EINTR
);
545 int git_fsync(int fd
, enum fsync_action action
)
548 case FSYNC_WRITEOUT_ONLY
:
549 count_fsync_writeout_only
+= 1;
553 * On macOS, fsync just causes filesystem cache writeback but
554 * does not flush hardware caches.
556 return fsync_loop(fd
);
559 #ifdef HAVE_SYNC_FILE_RANGE
561 * On linux 2.6.17 and above, sync_file_range is the way to
562 * issue a writeback without a hardware flush. An offset of
563 * 0 and size of 0 indicates writeout of the entire file and the
564 * wait flags ensure that all dirty data is written to the disk
565 * (potentially in a disk-side cache) before we continue.
568 return sync_file_range(fd
, 0, 0, SYNC_FILE_RANGE_WAIT_BEFORE
|
569 SYNC_FILE_RANGE_WRITE
|
570 SYNC_FILE_RANGE_WAIT_AFTER
);
573 #ifdef fsync_no_flush
574 return fsync_no_flush(fd
);
580 case FSYNC_HARDWARE_FLUSH
:
581 count_fsync_hardware_flush
+= 1;
584 * On macOS, a special fcntl is required to really flush the
585 * caches within the storage controller. As of this writing,
586 * this is a very expensive operation on Apple SSDs.
589 return fcntl(fd
, F_FULLFSYNC
);
591 return fsync_loop(fd
);
594 BUG("unexpected git_fsync(%d) call", action
);
598 static void log_trace_fsync_if(const char *key
, intmax_t value
)
601 trace2_data_intmax("fsync", the_repository
, key
, value
);
604 void trace_git_fsync_stats(void)
606 log_trace_fsync_if("fsync/writeout-only", count_fsync_writeout_only
);
607 log_trace_fsync_if("fsync/hardware-flush", count_fsync_hardware_flush
);
610 static int warn_if_unremovable(const char *op
, const char *file
, int rc
)
613 if (!rc
|| errno
== ENOENT
)
616 warning_errno("unable to %s '%s'", op
, file
);
621 int unlink_or_msg(const char *file
, struct strbuf
*err
)
623 int rc
= unlink(file
);
627 if (!rc
|| errno
== ENOENT
)
630 strbuf_addf(err
, "unable to unlink '%s': %s",
631 file
, strerror(errno
));
635 int unlink_or_warn(const char *file
)
637 return warn_if_unremovable("unlink", file
, unlink(file
));
640 int rmdir_or_warn(const char *file
)
642 return warn_if_unremovable("rmdir", file
, rmdir(file
));
645 int remove_or_warn(unsigned int mode
, const char *file
)
647 return S_ISGITLINK(mode
) ? rmdir_or_warn(file
) : unlink_or_warn(file
);
650 static int access_error_is_ok(int err
, unsigned flag
)
652 return (is_missing_file_error(err
) ||
653 ((flag
& ACCESS_EACCES_OK
) && err
== EACCES
));
656 int access_or_warn(const char *path
, int mode
, unsigned flag
)
658 int ret
= access(path
, mode
);
659 if (ret
&& !access_error_is_ok(errno
, flag
))
660 warn_on_inaccessible(path
);
664 int access_or_die(const char *path
, int mode
, unsigned flag
)
666 int ret
= access(path
, mode
);
667 if (ret
&& !access_error_is_ok(errno
, flag
))
668 die_errno(_("unable to access '%s'"), path
);
674 struct strbuf sb
= STRBUF_INIT
;
675 if (strbuf_getcwd(&sb
))
676 die_errno(_("unable to get current working directory"));
677 return strbuf_detach(&sb
, NULL
);
680 int xsnprintf(char *dst
, size_t max
, const char *fmt
, ...)
686 len
= vsnprintf(dst
, max
, fmt
, ap
);
690 BUG("your snprintf is broken");
692 BUG("attempt to snprintf into too-small buffer");
696 void write_file_buf(const char *path
, const char *buf
, size_t len
)
698 int fd
= xopen(path
, O_WRONLY
| O_CREAT
| O_TRUNC
, 0666);
699 if (write_in_full(fd
, buf
, len
) < 0)
700 die_errno(_("could not write to '%s'"), path
);
702 die_errno(_("could not close '%s'"), path
);
705 void write_file(const char *path
, const char *fmt
, ...)
708 struct strbuf sb
= STRBUF_INIT
;
710 va_start(params
, fmt
);
711 strbuf_vaddf(&sb
, fmt
, params
);
714 strbuf_complete_line(&sb
);
716 write_file_buf(path
, sb
.buf
, sb
.len
);
720 void sleep_millisec(int millisec
)
722 poll(NULL
, 0, millisec
);
725 int xgethostname(char *buf
, size_t len
)
728 * If the full hostname doesn't fit in buf, POSIX does not
729 * specify whether the buffer will be null-terminated, so to
730 * be safe, do it ourselves.
732 int ret
= gethostname(buf
, len
);
738 int is_empty_or_missing_file(const char *filename
)
742 if (stat(filename
, &st
) < 0) {
745 die_errno(_("could not stat %s"), filename
);
751 int open_nofollow(const char *path
, int flags
)
754 return open(path
, flags
| O_NOFOLLOW
);
757 if (lstat(path
, &st
) < 0)
759 if (S_ISLNK(st
.st_mode
)) {
763 return open(path
, flags
);
767 int csprng_bytes(void *buf
, size_t len
)
769 #if defined(HAVE_ARC4RANDOM) || defined(HAVE_ARC4RANDOM_LIBBSD)
770 /* This function never returns an error. */
771 arc4random_buf(buf
, len
);
773 #elif defined(HAVE_GETRANDOM)
777 res
= getrandom(p
, len
, 0);
784 #elif defined(HAVE_GETENTROPY)
788 /* getentropy has a maximum size of 256 bytes. */
789 size_t chunk
= len
< 256 ? len
: 256;
790 res
= getentropy(p
, chunk
);
797 #elif defined(HAVE_RTLGENRANDOM)
798 if (!RtlGenRandom(buf
, len
))
801 #elif defined(HAVE_OPENSSL_CSPRNG)
802 int res
= RAND_bytes(buf
, len
);
814 fd
= open("/dev/urandom", O_RDONLY
);
818 res
= xread(fd
, p
, len
);