2 * Various trivial helper wrappers around standard functions
10 static intmax_t count_fsync_writeout_only
;
11 static intmax_t count_fsync_hardware_flush
;
13 #ifdef HAVE_RTLGENRANDOM
14 /* This is required to get access to RtlGenRandom. */
15 #define SystemFunction036 NTAPI SystemFunction036
17 #undef SystemFunction036
20 static int memory_limit_check(size_t size
, int gentle
)
22 static size_t limit
= 0;
24 limit
= git_env_ulong("GIT_ALLOC_LIMIT", 0);
30 error("attempting to allocate %"PRIuMAX
" over limit %"PRIuMAX
,
31 (uintmax_t)size
, (uintmax_t)limit
);
34 die("attempting to allocate %"PRIuMAX
" over limit %"PRIuMAX
,
35 (uintmax_t)size
, (uintmax_t)limit
);
40 char *xstrdup(const char *str
)
42 char *ret
= strdup(str
);
44 die("Out of memory, strdup failed");
48 static void *do_xmalloc(size_t size
, int gentle
)
52 if (memory_limit_check(size
, gentle
))
59 die("Out of memory, malloc failed (tried to allocate %lu bytes)",
62 error("Out of memory, malloc failed (tried to allocate %lu bytes)",
68 memset(ret
, 0xA5, size
);
73 void *xmalloc(size_t size
)
75 return do_xmalloc(size
, 0);
78 static void *do_xmallocz(size_t size
, int gentle
)
81 if (unsigned_add_overflows(size
, 1)) {
83 error("Data too large to fit into virtual memory space.");
86 die("Data too large to fit into virtual memory space.");
88 ret
= do_xmalloc(size
+ 1, gentle
);
90 ((char*)ret
)[size
] = 0;
94 void *xmallocz(size_t size
)
96 return do_xmallocz(size
, 0);
99 void *xmallocz_gently(size_t size
)
101 return do_xmallocz(size
, 1);
105 * xmemdupz() allocates (len + 1) bytes of memory, duplicates "len" bytes of
106 * "data" to the allocated memory, zero terminates the allocated memory,
107 * and returns a pointer to the allocated memory. If the allocation fails,
110 void *xmemdupz(const void *data
, size_t len
)
112 return memcpy(xmallocz(len
), data
, len
);
115 char *xstrndup(const char *str
, size_t len
)
117 char *p
= memchr(str
, '\0', len
);
118 return xmemdupz(str
, p
? p
- str
: len
);
121 int xstrncmpz(const char *s
, const char *t
, size_t len
)
123 int res
= strncmp(s
, t
, len
);
126 return s
[len
] == '\0' ? 0 : 1;
129 void *xrealloc(void *ptr
, size_t size
)
138 memory_limit_check(size
, 0);
139 ret
= realloc(ptr
, size
);
141 die("Out of memory, realloc failed");
145 void *xcalloc(size_t nmemb
, size_t size
)
149 if (unsigned_mult_overflows(nmemb
, size
))
150 die("data too large to fit into virtual memory space");
152 memory_limit_check(size
* nmemb
, 0);
153 ret
= calloc(nmemb
, size
);
154 if (!ret
&& (!nmemb
|| !size
))
157 die("Out of memory, calloc failed");
161 void xsetenv(const char *name
, const char *value
, int overwrite
)
163 if (setenv(name
, value
, overwrite
))
164 die_errno(_("could not setenv '%s'"), name
? name
: "(null)");
168 * xopen() is the same as open(), but it die()s if the open() fails.
170 int xopen(const char *path
, int oflag
, ...)
176 * va_arg() will have undefined behavior if the specified type is not
177 * compatible with the argument type. Since integers are promoted to
178 * ints, we fetch the next argument as an int, and then cast it to a
179 * mode_t to avoid undefined behavior.
183 mode
= va_arg(ap
, int);
187 int fd
= open(path
, oflag
, mode
);
193 if ((oflag
& (O_CREAT
| O_EXCL
)) == (O_CREAT
| O_EXCL
))
194 die_errno(_("unable to create '%s'"), path
);
195 else if ((oflag
& O_RDWR
) == O_RDWR
)
196 die_errno(_("could not open '%s' for reading and writing"), path
);
197 else if ((oflag
& O_WRONLY
) == O_WRONLY
)
198 die_errno(_("could not open '%s' for writing"), path
);
200 die_errno(_("could not open '%s' for reading"), path
);
204 static int handle_nonblock(int fd
, short poll_events
, int err
)
208 if (err
!= EAGAIN
&& err
!= EWOULDBLOCK
)
212 pfd
.events
= poll_events
;
215 * no need to check for errors, here;
216 * a subsequent read/write will detect unrecoverable errors
223 * xread() is the same a read(), but it automatically restarts read()
224 * operations with a recoverable error (EAGAIN and EINTR). xread()
225 * DOES NOT GUARANTEE that "len" bytes is read even if the data is available.
227 ssize_t
xread(int fd
, void *buf
, size_t len
)
230 if (len
> MAX_IO_SIZE
)
233 nr
= read(fd
, buf
, len
);
237 if (handle_nonblock(fd
, POLLIN
, errno
))
245 * xwrite() is the same a write(), but it automatically restarts write()
246 * operations with a recoverable error (EAGAIN and EINTR). xwrite() DOES NOT
247 * GUARANTEE that "len" bytes is written even if the operation is successful.
249 ssize_t
xwrite(int fd
, const void *buf
, size_t len
)
252 if (len
> MAX_IO_SIZE
)
255 nr
= write(fd
, buf
, len
);
259 if (handle_nonblock(fd
, POLLOUT
, errno
))
268 * xpread() is the same as pread(), but it automatically restarts pread()
269 * operations with a recoverable error (EAGAIN and EINTR). xpread() DOES
270 * NOT GUARANTEE that "len" bytes is read even if the data is available.
272 ssize_t
xpread(int fd
, void *buf
, size_t len
, off_t offset
)
275 if (len
> MAX_IO_SIZE
)
278 nr
= pread(fd
, buf
, len
, offset
);
279 if ((nr
< 0) && (errno
== EAGAIN
|| errno
== EINTR
))
285 ssize_t
read_in_full(int fd
, void *buf
, size_t count
)
291 ssize_t loaded
= xread(fd
, p
, count
);
304 ssize_t
write_in_full(int fd
, const void *buf
, size_t count
)
310 ssize_t written
= xwrite(fd
, p
, count
);
325 ssize_t
pread_in_full(int fd
, void *buf
, size_t count
, off_t offset
)
331 ssize_t loaded
= xpread(fd
, p
, count
, offset
);
349 die_errno("dup failed");
354 * xfopen() is the same as fopen(), but it die()s if the fopen() fails.
356 FILE *xfopen(const char *path
, const char *mode
)
359 FILE *fp
= fopen(path
, mode
);
365 if (*mode
&& mode
[1] == '+')
366 die_errno(_("could not open '%s' for reading and writing"), path
);
367 else if (*mode
== 'w' || *mode
== 'a')
368 die_errno(_("could not open '%s' for writing"), path
);
370 die_errno(_("could not open '%s' for reading"), path
);
374 FILE *xfdopen(int fd
, const char *mode
)
376 FILE *stream
= fdopen(fd
, mode
);
378 die_errno("Out of memory? fdopen failed");
382 FILE *fopen_for_writing(const char *path
)
384 FILE *ret
= fopen(path
, "w");
386 if (!ret
&& errno
== EPERM
) {
388 ret
= fopen(path
, "w");
395 static void warn_on_inaccessible(const char *path
)
397 warning_errno(_("unable to access '%s'"), path
);
400 int warn_on_fopen_errors(const char *path
)
402 if (errno
!= ENOENT
&& errno
!= ENOTDIR
) {
403 warn_on_inaccessible(path
);
410 FILE *fopen_or_warn(const char *path
, const char *mode
)
412 FILE *fp
= fopen(path
, mode
);
417 warn_on_fopen_errors(path
);
421 int xmkstemp(char *filename_template
)
424 char origtemplate
[PATH_MAX
];
425 strlcpy(origtemplate
, filename_template
, sizeof(origtemplate
));
427 fd
= mkstemp(filename_template
);
429 int saved_errno
= errno
;
430 const char *nonrelative_template
;
432 if (strlen(filename_template
) != strlen(origtemplate
))
433 filename_template
= origtemplate
;
435 nonrelative_template
= absolute_path(filename_template
);
437 die_errno("Unable to create temporary file '%s'",
438 nonrelative_template
);
443 /* Adapted from libiberty's mkstemp.c. */
446 #define TMP_MAX 16384
448 int git_mkstemps_mode(char *pattern
, int suffix_len
, int mode
)
450 static const char letters
[] =
451 "abcdefghijklmnopqrstuvwxyz"
452 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
454 static const int num_letters
= ARRAY_SIZE(letters
) - 1;
455 static const char x_pattern
[] = "XXXXXX";
456 static const int num_x
= ARRAY_SIZE(x_pattern
) - 1;
457 char *filename_template
;
461 len
= strlen(pattern
);
463 if (len
< num_x
+ suffix_len
) {
468 if (strncmp(&pattern
[len
- num_x
- suffix_len
], x_pattern
, num_x
)) {
474 * Replace pattern's XXXXXX characters with randomness.
475 * Try TMP_MAX different filenames.
477 filename_template
= &pattern
[len
- num_x
- suffix_len
];
478 for (count
= 0; count
< TMP_MAX
; ++count
) {
481 if (csprng_bytes(&v
, sizeof(v
)) < 0)
482 return error_errno("unable to get random bytes for temporary file");
484 /* Fill in the random bits. */
485 for (i
= 0; i
< num_x
; i
++) {
486 filename_template
[i
] = letters
[v
% num_letters
];
490 fd
= open(pattern
, O_CREAT
| O_EXCL
| O_RDWR
, mode
);
494 * Fatal error (EPERM, ENOSPC etc).
495 * It doesn't make sense to loop.
500 /* We return the null string if we can't find a unique file name. */
505 int git_mkstemp_mode(char *pattern
, int mode
)
507 /* mkstemp is just mkstemps with no suffix */
508 return git_mkstemps_mode(pattern
, 0, mode
);
511 int xmkstemp_mode(char *filename_template
, int mode
)
514 char origtemplate
[PATH_MAX
];
515 strlcpy(origtemplate
, filename_template
, sizeof(origtemplate
));
517 fd
= git_mkstemp_mode(filename_template
, mode
);
519 int saved_errno
= errno
;
520 const char *nonrelative_template
;
522 if (!filename_template
[0])
523 filename_template
= origtemplate
;
525 nonrelative_template
= absolute_path(filename_template
);
527 die_errno("Unable to create temporary file '%s'",
528 nonrelative_template
);
534 * Some platforms return EINTR from fsync. Since fsync is invoked in some
535 * cases by a wrapper that dies on failure, do not expose EINTR to callers.
537 static int fsync_loop(int fd
)
543 } while (err
< 0 && errno
== EINTR
);
547 int git_fsync(int fd
, enum fsync_action action
)
550 case FSYNC_WRITEOUT_ONLY
:
551 count_fsync_writeout_only
+= 1;
555 * On macOS, fsync just causes filesystem cache writeback but
556 * does not flush hardware caches.
558 return fsync_loop(fd
);
561 #ifdef HAVE_SYNC_FILE_RANGE
563 * On linux 2.6.17 and above, sync_file_range is the way to
564 * issue a writeback without a hardware flush. An offset of
565 * 0 and size of 0 indicates writeout of the entire file and the
566 * wait flags ensure that all dirty data is written to the disk
567 * (potentially in a disk-side cache) before we continue.
570 return sync_file_range(fd
, 0, 0, SYNC_FILE_RANGE_WAIT_BEFORE
|
571 SYNC_FILE_RANGE_WRITE
|
572 SYNC_FILE_RANGE_WAIT_AFTER
);
575 #ifdef fsync_no_flush
576 return fsync_no_flush(fd
);
582 case FSYNC_HARDWARE_FLUSH
:
583 count_fsync_hardware_flush
+= 1;
586 * On macOS, a special fcntl is required to really flush the
587 * caches within the storage controller. As of this writing,
588 * this is a very expensive operation on Apple SSDs.
591 return fcntl(fd
, F_FULLFSYNC
);
593 return fsync_loop(fd
);
596 BUG("unexpected git_fsync(%d) call", action
);
600 static void log_trace_fsync_if(const char *key
, intmax_t value
)
603 trace2_data_intmax("fsync", the_repository
, key
, value
);
606 void trace_git_fsync_stats(void)
608 log_trace_fsync_if("fsync/writeout-only", count_fsync_writeout_only
);
609 log_trace_fsync_if("fsync/hardware-flush", count_fsync_hardware_flush
);
612 static int warn_if_unremovable(const char *op
, const char *file
, int rc
)
615 if (!rc
|| errno
== ENOENT
)
618 warning_errno("unable to %s '%s'", op
, file
);
623 int unlink_or_msg(const char *file
, struct strbuf
*err
)
625 int rc
= unlink(file
);
629 if (!rc
|| errno
== ENOENT
)
632 strbuf_addf(err
, "unable to unlink '%s': %s",
633 file
, strerror(errno
));
637 int unlink_or_warn(const char *file
)
639 return warn_if_unremovable("unlink", file
, unlink(file
));
642 int rmdir_or_warn(const char *file
)
644 return warn_if_unremovable("rmdir", file
, rmdir(file
));
647 int remove_or_warn(unsigned int mode
, const char *file
)
649 return S_ISGITLINK(mode
) ? rmdir_or_warn(file
) : unlink_or_warn(file
);
652 static int access_error_is_ok(int err
, unsigned flag
)
654 return (is_missing_file_error(err
) ||
655 ((flag
& ACCESS_EACCES_OK
) && err
== EACCES
));
658 int access_or_warn(const char *path
, int mode
, unsigned flag
)
660 int ret
= access(path
, mode
);
661 if (ret
&& !access_error_is_ok(errno
, flag
))
662 warn_on_inaccessible(path
);
666 int access_or_die(const char *path
, int mode
, unsigned flag
)
668 int ret
= access(path
, mode
);
669 if (ret
&& !access_error_is_ok(errno
, flag
))
670 die_errno(_("unable to access '%s'"), path
);
676 struct strbuf sb
= STRBUF_INIT
;
677 if (strbuf_getcwd(&sb
))
678 die_errno(_("unable to get current working directory"));
679 return strbuf_detach(&sb
, NULL
);
682 int xsnprintf(char *dst
, size_t max
, const char *fmt
, ...)
688 len
= vsnprintf(dst
, max
, fmt
, ap
);
692 BUG("your snprintf is broken");
694 BUG("attempt to snprintf into too-small buffer");
698 void write_file_buf(const char *path
, const char *buf
, size_t len
)
700 int fd
= xopen(path
, O_WRONLY
| O_CREAT
| O_TRUNC
, 0666);
701 if (write_in_full(fd
, buf
, len
) < 0)
702 die_errno(_("could not write to '%s'"), path
);
704 die_errno(_("could not close '%s'"), path
);
707 void write_file(const char *path
, const char *fmt
, ...)
710 struct strbuf sb
= STRBUF_INIT
;
712 va_start(params
, fmt
);
713 strbuf_vaddf(&sb
, fmt
, params
);
716 strbuf_complete_line(&sb
);
718 write_file_buf(path
, sb
.buf
, sb
.len
);
722 void sleep_millisec(int millisec
)
724 poll(NULL
, 0, millisec
);
727 int xgethostname(char *buf
, size_t len
)
730 * If the full hostname doesn't fit in buf, POSIX does not
731 * specify whether the buffer will be null-terminated, so to
732 * be safe, do it ourselves.
734 int ret
= gethostname(buf
, len
);
740 int is_empty_or_missing_file(const char *filename
)
744 if (stat(filename
, &st
) < 0) {
747 die_errno(_("could not stat %s"), filename
);
753 int open_nofollow(const char *path
, int flags
)
756 return open(path
, flags
| O_NOFOLLOW
);
759 if (lstat(path
, &st
) < 0)
761 if (S_ISLNK(st
.st_mode
)) {
765 return open(path
, flags
);
769 int csprng_bytes(void *buf
, size_t len
)
771 #if defined(HAVE_ARC4RANDOM) || defined(HAVE_ARC4RANDOM_LIBBSD)
772 /* This function never returns an error. */
773 arc4random_buf(buf
, len
);
775 #elif defined(HAVE_GETRANDOM)
779 res
= getrandom(p
, len
, 0);
786 #elif defined(HAVE_GETENTROPY)
790 /* getentropy has a maximum size of 256 bytes. */
791 size_t chunk
= len
< 256 ? len
: 256;
792 res
= getentropy(p
, chunk
);
799 #elif defined(HAVE_RTLGENRANDOM)
800 if (!RtlGenRandom(buf
, len
))
803 #elif defined(HAVE_OPENSSL_CSPRNG)
804 int res
= RAND_bytes(buf
, len
);
816 fd
= open("/dev/urandom", O_RDONLY
);
820 res
= xread(fd
, p
, len
);