2 * Various trivial helper wrappers around standard functions
6 static void do_nothing(size_t size)
10 static void (*try_to_free_routine)(size_t size) = do_nothing;
12 static int memory_limit_check(size_t size, int gentle)
14 static size_t limit = 0;
16 limit = git_env_ulong("GIT_ALLOC_LIMIT", 0);
22 error("attempting to allocate %"PRIuMAX" over limit %"PRIuMAX,
23 (uintmax_t)size, (uintmax_t)limit);
26 die("attempting to allocate %"PRIuMAX" over limit %"PRIuMAX,
27 (uintmax_t)size, (uintmax_t)limit);
32 try_to_free_t set_try_to_free_routine(try_to_free_t routine)
34 try_to_free_t old = try_to_free_routine;
37 try_to_free_routine = routine;
41 char *xstrdup(const char *str)
43 char *ret = strdup(str);
45 try_to_free_routine(strlen(str) + 1);
48 die("Out of memory, strdup failed");
53 static void *do_xmalloc(size_t size, int gentle)
57 if (memory_limit_check(size, gentle))
63 try_to_free_routine(size);
69 die("Out of memory, malloc failed (tried to allocate %lu bytes)",
72 error("Out of memory, malloc failed (tried to allocate %lu bytes)",
79 memset(ret, 0xA5, size);
84 void *xmalloc(size_t size)
86 return do_xmalloc(size, 0);
89 static void *do_xmallocz(size_t size, int gentle)
92 if (unsigned_add_overflows(size, 1)) {
94 error("Data too large to fit into virtual memory space.");
97 die("Data too large to fit into virtual memory space.");
99 ret = do_xmalloc(size + 1, gentle);
101 ((char*)ret)[size] = 0;
105 void *xmallocz(size_t size)
107 return do_xmallocz(size, 0);
110 void *xmallocz_gently(size_t size)
112 return do_xmallocz(size, 1);
116 * xmemdupz() allocates (len + 1) bytes of memory, duplicates "len" bytes of
117 * "data" to the allocated memory, zero terminates the allocated memory,
118 * and returns a pointer to the allocated memory. If the allocation fails,
121 void *xmemdupz(const void *data, size_t len)
123 return memcpy(xmallocz(len), data, len);
126 char *xstrndup(const char *str, size_t len)
128 char *p = memchr(str, '\0', len);
129 return xmemdupz(str, p ? p - str : len);
132 void *xrealloc(void *ptr, size_t size)
136 memory_limit_check(size, 0);
137 ret = realloc(ptr, size);
139 ret = realloc(ptr, 1);
141 try_to_free_routine(size);
142 ret = realloc(ptr, size);
144 ret = realloc(ptr, 1);
146 die("Out of memory, realloc failed");
151 void *xcalloc(size_t nmemb, size_t size)
155 memory_limit_check(size * nmemb, 0);
156 ret = calloc(nmemb, size);
157 if (!ret && (!nmemb || !size))
160 try_to_free_routine(nmemb * size);
161 ret = calloc(nmemb, size);
162 if (!ret && (!nmemb || !size))
165 die("Out of memory, calloc failed");
171 * Limit size of IO chunks, because huge chunks only cause pain. OS X
172 * 64-bit is buggy, returning EINVAL if len >= INT_MAX; and even in
173 * the absence of bugs, large chunks can result in bad latencies when
174 * you decide to kill the process.
176 * We pick 8 MiB as our default, but if the platform defines SSIZE_MAX
177 * that is smaller than that, clip it to SSIZE_MAX, as a call to
178 * read(2) or write(2) larger than that is allowed to fail. As the last
179 * resort, we allow a port to pass via CFLAGS e.g. "-DMAX_IO_SIZE=value"
180 * to override this, if the definition of SSIZE_MAX given by the platform
184 # define MAX_IO_SIZE_DEFAULT (8*1024*1024)
185 # if defined(SSIZE_MAX) && (SSIZE_MAX < MAX_IO_SIZE_DEFAULT)
186 # define MAX_IO_SIZE SSIZE_MAX
188 # define MAX_IO_SIZE MAX_IO_SIZE_DEFAULT
193 * xopen() is the same as open(), but it die()s if the open() fails.
195 int xopen(const char *path, int oflag, ...)
201 * va_arg() will have undefined behavior if the specified type is not
202 * compatible with the argument type. Since integers are promoted to
203 * ints, we fetch the next argument as an int, and then cast it to a
204 * mode_t to avoid undefined behavior.
208 mode = va_arg(ap, int);
212 int fd = open(path, oflag, mode);
218 if ((oflag & O_RDWR) == O_RDWR)
219 die_errno(_("could not open '%s' for reading and writing"), path);
220 else if ((oflag & O_WRONLY) == O_WRONLY)
221 die_errno(_("could not open '%s' for writing"), path);
223 die_errno(_("could not open '%s' for reading"), path);
228 * xread() is the same a read(), but it automatically restarts read()
229 * operations with a recoverable error (EAGAIN and EINTR). xread()
230 * DOES NOT GUARANTEE that "len" bytes is read even if the data is available.
232 ssize_t xread(int fd, void *buf, size_t len)
235 if (len > MAX_IO_SIZE)
238 nr = read(fd, buf, len);
239 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
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);
257 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
264 * xpread() is the same as pread(), but it automatically restarts pread()
265 * operations with a recoverable error (EAGAIN and EINTR). xpread() DOES
266 * NOT GUARANTEE that "len" bytes is read even if the data is available.
268 ssize_t xpread(int fd, void *buf, size_t len, off_t offset)
271 if (len > MAX_IO_SIZE)
274 nr = pread(fd, buf, len, offset);
275 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
281 ssize_t read_in_full(int fd, void *buf, size_t count)
287 ssize_t loaded = xread(fd, p, count);
300 ssize_t write_in_full(int fd, const void *buf, size_t count)
306 ssize_t written = xwrite(fd, p, count);
321 ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset)
327 ssize_t loaded = xpread(fd, p, count, offset);
345 die_errno("dup failed");
350 * xfopen() is the same as fopen(), but it die()s if the fopen() fails.
352 FILE *xfopen(const char *path, const char *mode)
355 FILE *fp = fopen(path, mode);
361 if (*mode && mode[1] == '+')
362 die_errno(_("could not open '%s' for reading and writing"), path);
363 else if (*mode == 'w' || *mode == 'a')
364 die_errno(_("could not open '%s' for writing"), path);
366 die_errno(_("could not open '%s' for reading"), path);
370 FILE *xfdopen(int fd, const char *mode)
372 FILE *stream = fdopen(fd, mode);
374 die_errno("Out of memory? fdopen failed");
378 int xmkstemp(char *template)
381 char origtemplate[PATH_MAX];
382 strlcpy(origtemplate, template, sizeof(origtemplate));
384 fd = mkstemp(template);
386 int saved_errno = errno;
387 const char *nonrelative_template;
389 if (strlen(template) != strlen(origtemplate))
390 template = origtemplate;
392 nonrelative_template = absolute_path(template);
394 die_errno("Unable to create temporary file '%s'",
395 nonrelative_template);
400 /* git_mkstemp() - create tmp file honoring TMPDIR variable */
401 int git_mkstemp(char *path, size_t len, const char *template)
406 tmp = getenv("TMPDIR");
409 n = snprintf(path, len, "%s/%s", tmp, template);
411 errno = ENAMETOOLONG;
414 return mkstemp(path);
417 /* git_mkstemps() - create tmp file with suffix honoring TMPDIR variable. */
418 int git_mkstemps(char *path, size_t len, const char *template, int suffix_len)
423 tmp = getenv("TMPDIR");
426 n = snprintf(path, len, "%s/%s", tmp, template);
428 errno = ENAMETOOLONG;
431 return mkstemps(path, suffix_len);
434 /* Adapted from libiberty's mkstemp.c. */
437 #define TMP_MAX 16384
439 int git_mkstemps_mode(char *pattern, int suffix_len, int mode)
441 static const char letters[] =
442 "abcdefghijklmnopqrstuvwxyz"
443 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
445 static const int num_letters = 62;
452 len = strlen(pattern);
454 if (len < 6 + suffix_len) {
459 if (strncmp(&pattern[len - 6 - suffix_len], "XXXXXX", 6)) {
465 * Replace pattern's XXXXXX characters with randomness.
466 * Try TMP_MAX different filenames.
468 gettimeofday(&tv, NULL);
469 value = ((size_t)(tv.tv_usec << 16)) ^ tv.tv_sec ^ getpid();
470 template = &pattern[len - 6 - suffix_len];
471 for (count = 0; count < TMP_MAX; ++count) {
473 /* Fill in the random bits. */
474 template[0] = letters[v % num_letters]; v /= num_letters;
475 template[1] = letters[v % num_letters]; v /= num_letters;
476 template[2] = letters[v % num_letters]; v /= num_letters;
477 template[3] = letters[v % num_letters]; v /= num_letters;
478 template[4] = letters[v % num_letters]; v /= num_letters;
479 template[5] = letters[v % num_letters]; v /= num_letters;
481 fd = open(pattern, O_CREAT | O_EXCL | O_RDWR, mode);
485 * Fatal error (EPERM, ENOSPC etc).
486 * It doesn't make sense to loop.
491 * This is a random value. It is only necessary that
492 * the next TMP_MAX values generated by adding 7777 to
493 * VALUE are different with (module 2^32).
497 /* We return the null string if we can't find a unique file name. */
502 int git_mkstemp_mode(char *pattern, int mode)
504 /* mkstemp is just mkstemps with no suffix */
505 return git_mkstemps_mode(pattern, 0, mode);
509 int gitmkstemps(char *pattern, int suffix_len)
511 return git_mkstemps_mode(pattern, suffix_len, 0600);
515 int xmkstemp_mode(char *template, int mode)
518 char origtemplate[PATH_MAX];
519 strlcpy(origtemplate, template, sizeof(origtemplate));
521 fd = git_mkstemp_mode(template, mode);
523 int saved_errno = errno;
524 const char *nonrelative_template;
527 template = origtemplate;
529 nonrelative_template = absolute_path(template);
531 die_errno("Unable to create temporary file '%s'",
532 nonrelative_template);
537 static int warn_if_unremovable(const char *op, const char *file, int rc)
540 if (!rc || errno == ENOENT)
543 warning("unable to %s %s: %s", op, file, strerror(errno));
548 int unlink_or_msg(const char *file, struct strbuf *err)
550 int rc = unlink(file);
554 if (!rc || errno == ENOENT)
557 strbuf_addf(err, "unable to unlink %s: %s",
558 file, strerror(errno));
562 int unlink_or_warn(const char *file)
564 return warn_if_unremovable("unlink", file, unlink(file));
567 int rmdir_or_warn(const char *file)
569 return warn_if_unremovable("rmdir", file, rmdir(file));
572 int remove_or_warn(unsigned int mode, const char *file)
574 return S_ISGITLINK(mode) ? rmdir_or_warn(file) : unlink_or_warn(file);
577 void warn_on_inaccessible(const char *path)
579 warning(_("unable to access '%s': %s"), path, strerror(errno));
582 static int access_error_is_ok(int err, unsigned flag)
584 return err == ENOENT || err == ENOTDIR ||
585 ((flag & ACCESS_EACCES_OK) && err == EACCES);
588 int access_or_warn(const char *path, int mode, unsigned flag)
590 int ret = access(path, mode);
591 if (ret && !access_error_is_ok(errno, flag))
592 warn_on_inaccessible(path);
596 int access_or_die(const char *path, int mode, unsigned flag)
598 int ret = access(path, mode);
599 if (ret && !access_error_is_ok(errno, flag))
600 die_errno(_("unable to access '%s'"), path);
606 struct strbuf sb = STRBUF_INIT;
607 if (strbuf_getcwd(&sb))
608 die_errno(_("unable to get current working directory"));
609 return strbuf_detach(&sb, NULL);
612 int xsnprintf(char *dst, size_t max, const char *fmt, ...)
618 len = vsnprintf(dst, max, fmt, ap);
622 die("BUG: your snprintf is broken");
624 die("BUG: attempt to snprintf into too-small buffer");
628 static int write_file_v(const char *path, int fatal,
629 const char *fmt, va_list params)
631 struct strbuf sb = STRBUF_INIT;
632 int fd = open(path, O_RDWR | O_CREAT | O_TRUNC, 0666);
635 die_errno(_("could not open %s for writing"), path);
638 strbuf_vaddf(&sb, fmt, params);
639 strbuf_complete_line(&sb);
640 if (write_in_full(fd, sb.buf, sb.len) != sb.len) {
646 die_errno(_("could not write to %s"), path);
652 die_errno(_("could not close %s"), path);
658 int write_file(const char *path, const char *fmt, ...)
663 va_start(params, fmt);
664 status = write_file_v(path, 1, fmt, params);
669 int write_file_gently(const char *path, const char *fmt, ...)
674 va_start(params, fmt);
675 status = write_file_v(path, 0, fmt, params);
680 void sleep_millisec(int millisec)
682 poll(NULL, 0, millisec);