2 * Various trivial helper wrappers around standard functions
5 #define DISABLE_SIGN_COMPARE_WARNINGS
7 #include "git-compat-util.h"
14 #ifdef HAVE_RTLGENRANDOM
15 /* This is required to get access to RtlGenRandom. */
16 #define SystemFunction036 NTAPI SystemFunction036
18 #undef SystemFunction036
21 static int memory_limit_check(size_t size
, int gentle
)
23 static size_t limit
= 0;
25 limit
= git_env_ulong("GIT_ALLOC_LIMIT", 0);
31 error("attempting to allocate %"PRIuMAX
" over limit %"PRIuMAX
,
32 (uintmax_t)size
, (uintmax_t)limit
);
35 die("attempting to allocate %"PRIuMAX
" over limit %"PRIuMAX
,
36 (uintmax_t)size
, (uintmax_t)limit
);
41 char *xstrdup(const char *str
)
43 char *ret
= strdup(str
);
45 die("Out of memory, strdup failed");
49 static void *do_xmalloc(size_t size
, int gentle
)
53 if (memory_limit_check(size
, gentle
))
60 die("Out of memory, malloc failed (tried to allocate %lu bytes)",
63 error("Out of memory, malloc failed (tried to allocate %lu bytes)",
69 memset(ret
, 0xA5, size
);
74 void *xmalloc(size_t size
)
76 return do_xmalloc(size
, 0);
79 static void *do_xmallocz(size_t size
, int gentle
)
82 if (unsigned_add_overflows(size
, 1)) {
84 error("Data too large to fit into virtual memory space.");
87 die("Data too large to fit into virtual memory space.");
89 ret
= do_xmalloc(size
+ 1, gentle
);
91 ((char*)ret
)[size
] = 0;
95 void *xmallocz(size_t size
)
97 return do_xmallocz(size
, 0);
100 void *xmallocz_gently(size_t size
)
102 return do_xmallocz(size
, 1);
106 * xmemdupz() allocates (len + 1) bytes of memory, duplicates "len" bytes of
107 * "data" to the allocated memory, zero terminates the allocated memory,
108 * and returns a pointer to the allocated memory. If the allocation fails,
111 void *xmemdupz(const void *data
, size_t len
)
113 return memcpy(xmallocz(len
), data
, len
);
116 char *xstrndup(const char *str
, size_t len
)
118 char *p
= memchr(str
, '\0', len
);
119 return xmemdupz(str
, p
? p
- str
: len
);
122 int xstrncmpz(const char *s
, const char *t
, size_t len
)
124 int res
= strncmp(s
, t
, len
);
127 return s
[len
] == '\0' ? 0 : 1;
130 void *xrealloc(void *ptr
, size_t size
)
139 memory_limit_check(size
, 0);
140 ret
= realloc(ptr
, size
);
142 die("Out of memory, realloc failed");
146 void *xcalloc(size_t nmemb
, size_t size
)
150 if (unsigned_mult_overflows(nmemb
, size
))
151 die("data too large to fit into virtual memory space");
153 memory_limit_check(size
* nmemb
, 0);
154 ret
= calloc(nmemb
, size
);
155 if (!ret
&& (!nmemb
|| !size
))
158 die("Out of memory, calloc failed");
162 void xsetenv(const char *name
, const char *value
, int overwrite
)
164 if (setenv(name
, value
, overwrite
))
165 die_errno(_("could not setenv '%s'"), name
? name
: "(null)");
169 * xopen() is the same as open(), but it die()s if the open() fails.
171 int xopen(const char *path
, int oflag
, ...)
177 * va_arg() will have undefined behavior if the specified type is not
178 * compatible with the argument type. Since integers are promoted to
179 * ints, we fetch the next argument as an int, and then cast it to a
180 * mode_t to avoid undefined behavior.
184 mode
= va_arg(ap
, int);
188 int fd
= open(path
, oflag
, mode
);
194 if ((oflag
& (O_CREAT
| O_EXCL
)) == (O_CREAT
| O_EXCL
))
195 die_errno(_("unable to create '%s'"), path
);
196 else if ((oflag
& O_RDWR
) == O_RDWR
)
197 die_errno(_("could not open '%s' for reading and writing"), path
);
198 else if ((oflag
& O_WRONLY
) == O_WRONLY
)
199 die_errno(_("could not open '%s' for writing"), path
);
201 die_errno(_("could not open '%s' for reading"), path
);
205 static int handle_nonblock(int fd
, short poll_events
, int err
)
209 if (err
!= EAGAIN
&& err
!= EWOULDBLOCK
)
213 pfd
.events
= poll_events
;
216 * no need to check for errors, here;
217 * a subsequent read/write will detect unrecoverable errors
224 * xread() is the same a read(), but it automatically restarts read()
225 * operations with a recoverable error (EAGAIN and EINTR). xread()
226 * DOES NOT GUARANTEE that "len" bytes is read even if the data is available.
228 ssize_t
xread(int fd
, void *buf
, size_t len
)
231 if (len
> MAX_IO_SIZE
)
234 nr
= read(fd
, buf
, len
);
238 if (handle_nonblock(fd
, POLLIN
, errno
))
246 * xwrite() is the same a write(), but it automatically restarts write()
247 * operations with a recoverable error (EAGAIN and EINTR). xwrite() DOES NOT
248 * GUARANTEE that "len" bytes is written even if the operation is successful.
250 ssize_t
xwrite(int fd
, const void *buf
, size_t len
)
253 if (len
> MAX_IO_SIZE
)
256 nr
= write(fd
, buf
, len
);
260 if (handle_nonblock(fd
, POLLOUT
, errno
))
269 * xpread() is the same as pread(), but it automatically restarts pread()
270 * operations with a recoverable error (EAGAIN and EINTR). xpread() DOES
271 * NOT GUARANTEE that "len" bytes is read even if the data is available.
273 ssize_t
xpread(int fd
, void *buf
, size_t len
, off_t offset
)
276 if (len
> MAX_IO_SIZE
)
279 nr
= pread(fd
, buf
, len
, offset
);
280 if ((nr
< 0) && (errno
== EAGAIN
|| errno
== EINTR
))
286 ssize_t
read_in_full(int fd
, void *buf
, size_t count
)
292 ssize_t loaded
= xread(fd
, p
, count
);
305 ssize_t
write_in_full(int fd
, const void *buf
, size_t count
)
311 ssize_t written
= xwrite(fd
, p
, count
);
326 ssize_t
pread_in_full(int fd
, void *buf
, size_t count
, off_t offset
)
332 ssize_t loaded
= xpread(fd
, p
, count
, offset
);
350 die_errno("dup failed");
355 * xfopen() is the same as fopen(), but it die()s if the fopen() fails.
357 FILE *xfopen(const char *path
, const char *mode
)
360 FILE *fp
= fopen(path
, mode
);
366 if (*mode
&& mode
[1] == '+')
367 die_errno(_("could not open '%s' for reading and writing"), path
);
368 else if (*mode
== 'w' || *mode
== 'a')
369 die_errno(_("could not open '%s' for writing"), path
);
371 die_errno(_("could not open '%s' for reading"), path
);
375 FILE *xfdopen(int fd
, const char *mode
)
377 FILE *stream
= fdopen(fd
, mode
);
379 die_errno("Out of memory? fdopen failed");
383 FILE *fopen_for_writing(const char *path
)
385 FILE *ret
= fopen(path
, "w");
387 if (!ret
&& errno
== EPERM
) {
389 ret
= fopen(path
, "w");
396 static void warn_on_inaccessible(const char *path
)
398 warning_errno(_("unable to access '%s'"), path
);
401 int warn_on_fopen_errors(const char *path
)
403 if (errno
!= ENOENT
&& errno
!= ENOTDIR
) {
404 warn_on_inaccessible(path
);
411 FILE *fopen_or_warn(const char *path
, const char *mode
)
413 FILE *fp
= fopen(path
, mode
);
418 warn_on_fopen_errors(path
);
422 int xmkstemp(char *filename_template
)
425 char origtemplate
[PATH_MAX
];
426 strlcpy(origtemplate
, filename_template
, sizeof(origtemplate
));
428 fd
= mkstemp(filename_template
);
430 int saved_errno
= errno
;
431 const char *nonrelative_template
;
433 if (strlen(filename_template
) != strlen(origtemplate
))
434 filename_template
= origtemplate
;
436 nonrelative_template
= absolute_path(filename_template
);
438 die_errno("Unable to create temporary file '%s'",
439 nonrelative_template
);
444 /* Adapted from libiberty's mkstemp.c. */
447 #define TMP_MAX 16384
449 int git_mkstemps_mode(char *pattern
, int suffix_len
, int mode
)
451 static const char letters
[] =
452 "abcdefghijklmnopqrstuvwxyz"
453 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
455 static const int num_letters
= ARRAY_SIZE(letters
) - 1;
456 static const char x_pattern
[] = "XXXXXX";
457 static const int num_x
= ARRAY_SIZE(x_pattern
) - 1;
458 char *filename_template
;
462 len
= strlen(pattern
);
464 if (len
< num_x
+ suffix_len
) {
469 if (strncmp(&pattern
[len
- num_x
- suffix_len
], x_pattern
, num_x
)) {
475 * Replace pattern's XXXXXX characters with randomness.
476 * Try TMP_MAX different filenames.
478 filename_template
= &pattern
[len
- num_x
- suffix_len
];
479 for (count
= 0; count
< TMP_MAX
; ++count
) {
482 if (csprng_bytes(&v
, sizeof(v
), 0) < 0)
483 return error_errno("unable to get random bytes for temporary file");
485 /* Fill in the random bits. */
486 for (i
= 0; i
< num_x
; i
++) {
487 filename_template
[i
] = letters
[v
% num_letters
];
491 fd
= open(pattern
, O_CREAT
| O_EXCL
| O_RDWR
, mode
);
495 * Fatal error (EPERM, ENOSPC etc).
496 * It doesn't make sense to loop.
501 /* We return the null string if we can't find a unique file name. */
506 int git_mkstemp_mode(char *pattern
, int mode
)
508 /* mkstemp is just mkstemps with no suffix */
509 return git_mkstemps_mode(pattern
, 0, mode
);
512 int xmkstemp_mode(char *filename_template
, int mode
)
515 char origtemplate
[PATH_MAX
];
516 strlcpy(origtemplate
, filename_template
, sizeof(origtemplate
));
518 fd
= git_mkstemp_mode(filename_template
, mode
);
520 int saved_errno
= errno
;
521 const char *nonrelative_template
;
523 if (!filename_template
[0])
524 filename_template
= origtemplate
;
526 nonrelative_template
= absolute_path(filename_template
);
528 die_errno("Unable to create temporary file '%s'",
529 nonrelative_template
);
535 * Some platforms return EINTR from fsync. Since fsync is invoked in some
536 * cases by a wrapper that dies on failure, do not expose EINTR to callers.
538 static int fsync_loop(int fd
)
544 } while (err
< 0 && errno
== EINTR
);
548 int git_fsync(int fd
, enum fsync_action action
)
551 case FSYNC_WRITEOUT_ONLY
:
552 trace2_counter_add(TRACE2_COUNTER_ID_FSYNC_WRITEOUT_ONLY
, 1);
556 * On macOS, fsync just causes filesystem cache writeback but
557 * does not flush hardware caches.
559 return fsync_loop(fd
);
562 #ifdef HAVE_SYNC_FILE_RANGE
564 * On linux 2.6.17 and above, sync_file_range is the way to
565 * issue a writeback without a hardware flush. An offset of
566 * 0 and size of 0 indicates writeout of the entire file and the
567 * wait flags ensure that all dirty data is written to the disk
568 * (potentially in a disk-side cache) before we continue.
571 return sync_file_range(fd
, 0, 0, SYNC_FILE_RANGE_WAIT_BEFORE
|
572 SYNC_FILE_RANGE_WRITE
|
573 SYNC_FILE_RANGE_WAIT_AFTER
);
576 #ifdef fsync_no_flush
577 return fsync_no_flush(fd
);
583 case FSYNC_HARDWARE_FLUSH
:
584 trace2_counter_add(TRACE2_COUNTER_ID_FSYNC_HARDWARE_FLUSH
, 1);
587 * On macOS, a special fcntl is required to really flush the
588 * caches within the storage controller. As of this writing,
589 * this is a very expensive operation on Apple SSDs.
592 return fcntl(fd
, F_FULLFSYNC
);
594 return fsync_loop(fd
);
597 BUG("unexpected git_fsync(%d) call", action
);
601 static int warn_if_unremovable(const char *op
, const char *file
, int rc
)
604 if (!rc
|| errno
== ENOENT
)
607 warning_errno("unable to %s '%s'", op
, file
);
612 int unlink_or_msg(const char *file
, struct strbuf
*err
)
614 int rc
= unlink(file
);
618 if (!rc
|| errno
== ENOENT
)
621 strbuf_addf(err
, "unable to unlink '%s': %s",
622 file
, strerror(errno
));
626 int unlink_or_warn(const char *file
)
628 return warn_if_unremovable("unlink", file
, unlink(file
));
631 int rmdir_or_warn(const char *file
)
633 return warn_if_unremovable("rmdir", file
, rmdir(file
));
636 static int access_error_is_ok(int err
, unsigned flag
)
638 return (is_missing_file_error(err
) ||
639 ((flag
& ACCESS_EACCES_OK
) && err
== EACCES
));
642 int access_or_warn(const char *path
, int mode
, unsigned flag
)
644 int ret
= access(path
, mode
);
645 if (ret
&& !access_error_is_ok(errno
, flag
))
646 warn_on_inaccessible(path
);
650 int access_or_die(const char *path
, int mode
, unsigned flag
)
652 int ret
= access(path
, mode
);
653 if (ret
&& !access_error_is_ok(errno
, flag
))
654 die_errno(_("unable to access '%s'"), path
);
660 struct strbuf sb
= STRBUF_INIT
;
661 if (strbuf_getcwd(&sb
))
662 die_errno(_("unable to get current working directory"));
663 return strbuf_detach(&sb
, NULL
);
666 int xsnprintf(char *dst
, size_t max
, const char *fmt
, ...)
672 len
= vsnprintf(dst
, max
, fmt
, ap
);
676 die(_("unable to format message: %s"), fmt
);
678 BUG("attempt to snprintf into too-small buffer");
682 void write_file_buf(const char *path
, const char *buf
, size_t len
)
684 int fd
= xopen(path
, O_WRONLY
| O_CREAT
| O_TRUNC
, 0666);
685 if (write_in_full(fd
, buf
, len
) < 0)
686 die_errno(_("could not write to '%s'"), path
);
688 die_errno(_("could not close '%s'"), path
);
691 void write_file(const char *path
, const char *fmt
, ...)
694 struct strbuf sb
= STRBUF_INIT
;
696 va_start(params
, fmt
);
697 strbuf_vaddf(&sb
, fmt
, params
);
700 strbuf_complete_line(&sb
);
702 write_file_buf(path
, sb
.buf
, sb
.len
);
706 void sleep_millisec(int millisec
)
708 poll(NULL
, 0, millisec
);
711 int xgethostname(char *buf
, size_t len
)
714 * If the full hostname doesn't fit in buf, POSIX does not
715 * specify whether the buffer will be null-terminated, so to
716 * be safe, do it ourselves.
718 int ret
= gethostname(buf
, len
);
724 int is_empty_or_missing_file(const char *filename
)
728 if (stat(filename
, &st
) < 0) {
731 die_errno(_("could not stat %s"), filename
);
737 int open_nofollow(const char *path
, int flags
)
740 int ret
= open(path
, flags
| O_NOFOLLOW
);
742 * NetBSD sets errno to EFTYPE when path is a symlink. The only other
743 * time this errno occurs when O_REGULAR is used. Since we don't use
744 * it anywhere we can avoid an lstat here. FreeBSD does the same with
748 # define SYMLINK_ERRNO EFTYPE
749 # elif defined(__FreeBSD__)
750 # define SYMLINK_ERRNO EMLINK
753 if (ret
< 0 && errno
== SYMLINK_ERRNO
) {
757 # undef SYMLINK_ERRNO
762 if (lstat(path
, &st
) < 0)
764 if (S_ISLNK(st
.st_mode
)) {
768 return open(path
, flags
);
772 int csprng_bytes(void *buf
, size_t len
, MAYBE_UNUSED
unsigned flags
)
774 #if defined(HAVE_ARC4RANDOM) || defined(HAVE_ARC4RANDOM_LIBBSD)
775 /* This function never returns an error. */
776 arc4random_buf(buf
, len
);
778 #elif defined(HAVE_GETRANDOM)
782 res
= getrandom(p
, len
, 0);
789 #elif defined(HAVE_GETENTROPY)
793 /* getentropy has a maximum size of 256 bytes. */
794 size_t chunk
= len
< 256 ? len
: 256;
795 res
= getentropy(p
, chunk
);
802 #elif defined(HAVE_RTLGENRANDOM)
803 if (!RtlGenRandom(buf
, len
))
806 #elif defined(HAVE_OPENSSL_CSPRNG)
807 switch (RAND_pseudo_bytes(buf
, len
)) {
811 if (flags
& CSPRNG_BYTES_INSECURE
)
823 fd
= open("/dev/urandom", O_RDONLY
);
827 res
= xread(fd
, p
, len
);
842 uint32_t git_rand(unsigned flags
)
846 if (csprng_bytes(&result
, sizeof(result
), flags
) < 0)
847 die(_("unable to get random bytes"));
852 static void mmap_limit_check(size_t length
)
854 static size_t limit
= 0;
856 limit
= git_env_ulong("GIT_MMAP_LIMIT", 0);
861 die(_("attempting to mmap %"PRIuMAX
" over limit %"PRIuMAX
),
862 (uintmax_t)length
, (uintmax_t)limit
);
865 void *xmmap_gently(void *start
, size_t length
,
866 int prot
, int flags
, int fd
, off_t offset
)
870 mmap_limit_check(length
);
871 ret
= mmap(start
, length
, prot
, flags
, fd
, offset
);
872 if (ret
== MAP_FAILED
&& !length
)
877 const char *mmap_os_err(void)
879 static const char blank
[] = "";
880 #if defined(__linux__)
881 if (errno
== ENOMEM
) {
882 /* this continues an existing error message: */
883 static const char enomem
[] =
884 ", check sys.vm.max_map_count and/or RLIMIT_DATA";
887 #endif /* OS-specific bits */
891 void *xmmap(void *start
, size_t length
,
892 int prot
, int flags
, int fd
, off_t offset
)
894 void *ret
= xmmap_gently(start
, length
, prot
, flags
, fd
, offset
);
895 if (ret
== MAP_FAILED
)
896 die_errno(_("mmap failed%s"), mmap_os_err());