]>
git.ipfire.org Git - thirdparty/git.git/blob - wrapper.c
2 * Various trivial helper wrappers around standard functions
7 static void do_nothing(size_t size
)
11 static void (*try_to_free_routine
)(size_t size
) = do_nothing
;
13 static int memory_limit_check(size_t size
, int gentle
)
15 static size_t limit
= 0;
17 limit
= git_env_ulong("GIT_ALLOC_LIMIT", 0);
23 error("attempting to allocate %"PRIuMAX
" over limit %"PRIuMAX
,
24 (uintmax_t)size
, (uintmax_t)limit
);
27 die("attempting to allocate %"PRIuMAX
" over limit %"PRIuMAX
,
28 (uintmax_t)size
, (uintmax_t)limit
);
33 try_to_free_t
set_try_to_free_routine(try_to_free_t routine
)
35 try_to_free_t old
= try_to_free_routine
;
38 try_to_free_routine
= routine
;
42 char *xstrdup(const char *str
)
44 char *ret
= strdup(str
);
46 try_to_free_routine(strlen(str
) + 1);
49 die("Out of memory, strdup failed");
54 static void *do_xmalloc(size_t size
, int gentle
)
58 if (memory_limit_check(size
, gentle
))
64 try_to_free_routine(size
);
70 die("Out of memory, malloc failed (tried to allocate %lu bytes)",
73 error("Out of memory, malloc failed (tried to allocate %lu bytes)",
80 memset(ret
, 0xA5, size
);
85 void *xmalloc(size_t size
)
87 return do_xmalloc(size
, 0);
90 static void *do_xmallocz(size_t size
, int gentle
)
93 if (unsigned_add_overflows(size
, 1)) {
95 error("Data too large to fit into virtual memory space.");
98 die("Data too large to fit into virtual memory space.");
100 ret
= do_xmalloc(size
+ 1, gentle
);
102 ((char*)ret
)[size
] = 0;
106 void *xmallocz(size_t size
)
108 return do_xmallocz(size
, 0);
111 void *xmallocz_gently(size_t size
)
113 return do_xmallocz(size
, 1);
117 * xmemdupz() allocates (len + 1) bytes of memory, duplicates "len" bytes of
118 * "data" to the allocated memory, zero terminates the allocated memory,
119 * and returns a pointer to the allocated memory. If the allocation fails,
122 void *xmemdupz(const void *data
, size_t len
)
124 return memcpy(xmallocz(len
), data
, len
);
127 char *xstrndup(const char *str
, size_t len
)
129 char *p
= memchr(str
, '\0', len
);
130 return xmemdupz(str
, p
? p
- str
: len
);
133 void *xrealloc(void *ptr
, size_t size
)
137 memory_limit_check(size
, 0);
138 ret
= realloc(ptr
, size
);
140 ret
= realloc(ptr
, 1);
142 try_to_free_routine(size
);
143 ret
= realloc(ptr
, size
);
145 ret
= realloc(ptr
, 1);
147 die("Out of memory, realloc failed");
152 void *xcalloc(size_t nmemb
, size_t size
)
156 if (unsigned_mult_overflows(nmemb
, size
))
157 die("data too large to fit into virtual memory space");
159 memory_limit_check(size
* nmemb
, 0);
160 ret
= calloc(nmemb
, size
);
161 if (!ret
&& (!nmemb
|| !size
))
164 try_to_free_routine(nmemb
* size
);
165 ret
= calloc(nmemb
, size
);
166 if (!ret
&& (!nmemb
|| !size
))
169 die("Out of memory, calloc failed");
175 * Limit size of IO chunks, because huge chunks only cause pain. OS X
176 * 64-bit is buggy, returning EINVAL if len >= INT_MAX; and even in
177 * the absence of bugs, large chunks can result in bad latencies when
178 * you decide to kill the process.
180 * We pick 8 MiB as our default, but if the platform defines SSIZE_MAX
181 * that is smaller than that, clip it to SSIZE_MAX, as a call to
182 * read(2) or write(2) larger than that is allowed to fail. As the last
183 * resort, we allow a port to pass via CFLAGS e.g. "-DMAX_IO_SIZE=value"
184 * to override this, if the definition of SSIZE_MAX given by the platform
188 # define MAX_IO_SIZE_DEFAULT (8*1024*1024)
189 # if defined(SSIZE_MAX) && (SSIZE_MAX < MAX_IO_SIZE_DEFAULT)
190 # define MAX_IO_SIZE SSIZE_MAX
192 # define MAX_IO_SIZE MAX_IO_SIZE_DEFAULT
197 * xopen() is the same as open(), but it die()s if the open() fails.
199 int xopen(const char *path
, int oflag
, ...)
205 * va_arg() will have undefined behavior if the specified type is not
206 * compatible with the argument type. Since integers are promoted to
207 * ints, we fetch the next argument as an int, and then cast it to a
208 * mode_t to avoid undefined behavior.
212 mode
= va_arg(ap
, int);
216 int fd
= open(path
, oflag
, mode
);
222 if ((oflag
& O_RDWR
) == O_RDWR
)
223 die_errno(_("could not open '%s' for reading and writing"), path
);
224 else if ((oflag
& O_WRONLY
) == O_WRONLY
)
225 die_errno(_("could not open '%s' for writing"), path
);
227 die_errno(_("could not open '%s' for reading"), path
);
231 static int handle_nonblock(int fd
, short poll_events
, int err
)
235 if (err
!= EAGAIN
&& err
!= EWOULDBLOCK
)
239 pfd
.events
= poll_events
;
242 * no need to check for errors, here;
243 * a subsequent read/write will detect unrecoverable errors
250 * xread() is the same a read(), but it automatically restarts read()
251 * operations with a recoverable error (EAGAIN and EINTR). xread()
252 * DOES NOT GUARANTEE that "len" bytes is read even if the data is available.
254 ssize_t
xread(int fd
, void *buf
, size_t len
)
257 if (len
> MAX_IO_SIZE
)
260 nr
= read(fd
, buf
, len
);
264 if (handle_nonblock(fd
, POLLIN
, errno
))
272 * xwrite() is the same a write(), but it automatically restarts write()
273 * operations with a recoverable error (EAGAIN and EINTR). xwrite() DOES NOT
274 * GUARANTEE that "len" bytes is written even if the operation is successful.
276 ssize_t
xwrite(int fd
, const void *buf
, size_t len
)
279 if (len
> MAX_IO_SIZE
)
282 nr
= write(fd
, buf
, len
);
286 if (handle_nonblock(fd
, POLLOUT
, errno
))
295 * xpread() is the same as pread(), but it automatically restarts pread()
296 * operations with a recoverable error (EAGAIN and EINTR). xpread() DOES
297 * NOT GUARANTEE that "len" bytes is read even if the data is available.
299 ssize_t
xpread(int fd
, void *buf
, size_t len
, off_t offset
)
302 if (len
> MAX_IO_SIZE
)
305 nr
= pread(fd
, buf
, len
, offset
);
306 if ((nr
< 0) && (errno
== EAGAIN
|| errno
== EINTR
))
312 ssize_t
read_in_full(int fd
, void *buf
, size_t count
)
318 ssize_t loaded
= xread(fd
, p
, count
);
331 ssize_t
write_in_full(int fd
, const void *buf
, size_t count
)
337 ssize_t written
= xwrite(fd
, p
, count
);
352 ssize_t
pread_in_full(int fd
, void *buf
, size_t count
, off_t offset
)
358 ssize_t loaded
= xpread(fd
, p
, count
, offset
);
376 die_errno("dup failed");
381 * xfopen() is the same as fopen(), but it die()s if the fopen() fails.
383 FILE *xfopen(const char *path
, const char *mode
)
386 FILE *fp
= fopen(path
, mode
);
392 if (*mode
&& mode
[1] == '+')
393 die_errno(_("could not open '%s' for reading and writing"), path
);
394 else if (*mode
== 'w' || *mode
== 'a')
395 die_errno(_("could not open '%s' for writing"), path
);
397 die_errno(_("could not open '%s' for reading"), path
);
401 FILE *xfdopen(int fd
, const char *mode
)
403 FILE *stream
= fdopen(fd
, mode
);
405 die_errno("Out of memory? fdopen failed");
409 FILE *fopen_for_writing(const char *path
)
411 FILE *ret
= fopen(path
, "w");
413 if (!ret
&& errno
== EPERM
) {
415 ret
= fopen(path
, "w");
422 static void warn_on_inaccessible(const char *path
)
424 warning_errno(_("unable to access '%s'"), path
);
427 int warn_on_fopen_errors(const char *path
)
429 if (errno
!= ENOENT
&& errno
!= ENOTDIR
) {
430 warn_on_inaccessible(path
);
437 FILE *fopen_or_warn(const char *path
, const char *mode
)
439 FILE *fp
= fopen(path
, mode
);
444 warn_on_fopen_errors(path
);
448 int xmkstemp(char *filename_template
)
451 char origtemplate
[PATH_MAX
];
452 strlcpy(origtemplate
, filename_template
, sizeof(origtemplate
));
454 fd
= mkstemp(filename_template
);
456 int saved_errno
= errno
;
457 const char *nonrelative_template
;
459 if (strlen(filename_template
) != strlen(origtemplate
))
460 filename_template
= origtemplate
;
462 nonrelative_template
= absolute_path(filename_template
);
464 die_errno("Unable to create temporary file '%s'",
465 nonrelative_template
);
470 /* Adapted from libiberty's mkstemp.c. */
473 #define TMP_MAX 16384
475 int git_mkstemps_mode(char *pattern
, int suffix_len
, int mode
)
477 static const char letters
[] =
478 "abcdefghijklmnopqrstuvwxyz"
479 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
481 static const int num_letters
= 62;
484 char *filename_template
;
488 len
= strlen(pattern
);
490 if (len
< 6 + suffix_len
) {
495 if (strncmp(&pattern
[len
- 6 - suffix_len
], "XXXXXX", 6)) {
501 * Replace pattern's XXXXXX characters with randomness.
502 * Try TMP_MAX different filenames.
504 gettimeofday(&tv
, NULL
);
505 value
= ((size_t)(tv
.tv_usec
<< 16)) ^ tv
.tv_sec
^ getpid();
506 filename_template
= &pattern
[len
- 6 - suffix_len
];
507 for (count
= 0; count
< TMP_MAX
; ++count
) {
509 /* Fill in the random bits. */
510 filename_template
[0] = letters
[v
% num_letters
]; v
/= num_letters
;
511 filename_template
[1] = letters
[v
% num_letters
]; v
/= num_letters
;
512 filename_template
[2] = letters
[v
% num_letters
]; v
/= num_letters
;
513 filename_template
[3] = letters
[v
% num_letters
]; v
/= num_letters
;
514 filename_template
[4] = letters
[v
% num_letters
]; v
/= num_letters
;
515 filename_template
[5] = letters
[v
% num_letters
]; v
/= num_letters
;
517 fd
= open(pattern
, O_CREAT
| O_EXCL
| O_RDWR
, mode
);
521 * Fatal error (EPERM, ENOSPC etc).
522 * It doesn't make sense to loop.
527 * This is a random value. It is only necessary that
528 * the next TMP_MAX values generated by adding 7777 to
529 * VALUE are different with (module 2^32).
533 /* We return the null string if we can't find a unique file name. */
538 int git_mkstemp_mode(char *pattern
, int mode
)
540 /* mkstemp is just mkstemps with no suffix */
541 return git_mkstemps_mode(pattern
, 0, mode
);
544 int xmkstemp_mode(char *filename_template
, int mode
)
547 char origtemplate
[PATH_MAX
];
548 strlcpy(origtemplate
, filename_template
, sizeof(origtemplate
));
550 fd
= git_mkstemp_mode(filename_template
, mode
);
552 int saved_errno
= errno
;
553 const char *nonrelative_template
;
555 if (!filename_template
[0])
556 filename_template
= origtemplate
;
558 nonrelative_template
= absolute_path(filename_template
);
560 die_errno("Unable to create temporary file '%s'",
561 nonrelative_template
);
566 static int warn_if_unremovable(const char *op
, const char *file
, int rc
)
569 if (!rc
|| errno
== ENOENT
)
572 warning_errno("unable to %s '%s'", op
, file
);
577 int unlink_or_msg(const char *file
, struct strbuf
*err
)
579 int rc
= unlink(file
);
583 if (!rc
|| errno
== ENOENT
)
586 strbuf_addf(err
, "unable to unlink '%s': %s",
587 file
, strerror(errno
));
591 int unlink_or_warn(const char *file
)
593 return warn_if_unremovable("unlink", file
, unlink(file
));
596 int rmdir_or_warn(const char *file
)
598 return warn_if_unremovable("rmdir", file
, rmdir(file
));
601 int remove_or_warn(unsigned int mode
, const char *file
)
603 return S_ISGITLINK(mode
) ? rmdir_or_warn(file
) : unlink_or_warn(file
);
606 static int access_error_is_ok(int err
, unsigned flag
)
608 return (is_missing_file_error(err
) ||
609 ((flag
& ACCESS_EACCES_OK
) && err
== EACCES
));
612 int access_or_warn(const char *path
, int mode
, unsigned flag
)
614 int ret
= access(path
, mode
);
615 if (ret
&& !access_error_is_ok(errno
, flag
))
616 warn_on_inaccessible(path
);
620 int access_or_die(const char *path
, int mode
, unsigned flag
)
622 int ret
= access(path
, mode
);
623 if (ret
&& !access_error_is_ok(errno
, flag
))
624 die_errno(_("unable to access '%s'"), path
);
630 struct strbuf sb
= STRBUF_INIT
;
631 if (strbuf_getcwd(&sb
))
632 die_errno(_("unable to get current working directory"));
633 return strbuf_detach(&sb
, NULL
);
636 int xsnprintf(char *dst
, size_t max
, const char *fmt
, ...)
642 len
= vsnprintf(dst
, max
, fmt
, ap
);
646 BUG("your snprintf is broken");
648 BUG("attempt to snprintf into too-small buffer");
652 void write_file_buf(const char *path
, const char *buf
, size_t len
)
654 int fd
= xopen(path
, O_WRONLY
| O_CREAT
| O_TRUNC
, 0666);
655 if (write_in_full(fd
, buf
, len
) < 0)
656 die_errno(_("could not write to '%s'"), path
);
658 die_errno(_("could not close '%s'"), path
);
661 void write_file(const char *path
, const char *fmt
, ...)
664 struct strbuf sb
= STRBUF_INIT
;
666 va_start(params
, fmt
);
667 strbuf_vaddf(&sb
, fmt
, params
);
670 strbuf_complete_line(&sb
);
672 write_file_buf(path
, sb
.buf
, sb
.len
);
676 void sleep_millisec(int millisec
)
678 poll(NULL
, 0, millisec
);
681 int xgethostname(char *buf
, size_t len
)
684 * If the full hostname doesn't fit in buf, POSIX does not
685 * specify whether the buffer will be null-terminated, so to
686 * be safe, do it ourselves.
688 int ret
= gethostname(buf
, len
);