🌐 AI搜索 & 代理 主页
blob: 36e12119d76556a710dbc8da2953a4710e630fdb [file] [log] [blame]
Linus Torvalds112db552008-06-22 19:19:251/*
2 * Various trivial helper wrappers around standard functions
3 */
4#include "cache.h"
Brandon Williamsb2141fc2017-06-14 18:07:365#include "config.h"
Linus Torvalds112db552008-06-22 19:19:256
Nguyễn Thái Ngọc Duyf8bb1d92014-08-16 03:08:027static int memory_limit_check(size_t size, int gentle)
Nguyễn Thái Ngọc Duyd41489a2012-03-07 10:54:168{
Steffen Prohaska9927d962014-08-26 15:23:229 static size_t limit = 0;
10 if (!limit) {
11 limit = git_env_ulong("GIT_ALLOC_LIMIT", 0);
12 if (!limit)
13 limit = SIZE_MAX;
Nguyễn Thái Ngọc Duyd41489a2012-03-07 10:54:1614 }
Junio C Hamanof0d89002014-10-08 20:05:3215 if (size > limit) {
Nguyễn Thái Ngọc Duyf8bb1d92014-08-16 03:08:0216 if (gentle) {
Junio C Hamanof0d89002014-10-08 20:05:3217 error("attempting to allocate %"PRIuMAX" over limit %"PRIuMAX,
18 (uintmax_t)size, (uintmax_t)limit);
Nguyễn Thái Ngọc Duyf8bb1d92014-08-16 03:08:0219 return -1;
20 } else
Junio C Hamanof0d89002014-10-08 20:05:3221 die("attempting to allocate %"PRIuMAX" over limit %"PRIuMAX,
22 (uintmax_t)size, (uintmax_t)limit);
Nguyễn Thái Ngọc Duyf8bb1d92014-08-16 03:08:0223 }
24 return 0;
Nguyễn Thái Ngọc Duyd41489a2012-03-07 10:54:1625}
26
Linus Torvalds112db552008-06-22 19:19:2527char *xstrdup(const char *str)
28{
29 char *ret = strdup(str);
Jeff King9827d4c2019-08-12 20:50:2130 if (!ret)
31 die("Out of memory, strdup failed");
Linus Torvalds112db552008-06-22 19:19:2532 return ret;
33}
34
Nguyễn Thái Ngọc Duyf8bb1d92014-08-16 03:08:0235static void *do_xmalloc(size_t size, int gentle)
Linus Torvalds112db552008-06-22 19:19:2536{
Nguyễn Thái Ngọc Duyd41489a2012-03-07 10:54:1637 void *ret;
38
Nguyễn Thái Ngọc Duyf8bb1d92014-08-16 03:08:0239 if (memory_limit_check(size, gentle))
40 return NULL;
Nguyễn Thái Ngọc Duyd41489a2012-03-07 10:54:1641 ret = malloc(size);
Linus Torvalds112db552008-06-22 19:19:2542 if (!ret && !size)
43 ret = malloc(1);
44 if (!ret) {
Jeff King9827d4c2019-08-12 20:50:2145 if (!gentle)
46 die("Out of memory, malloc failed (tried to allocate %lu bytes)",
47 (unsigned long)size);
48 else {
49 error("Out of memory, malloc failed (tried to allocate %lu bytes)",
50 (unsigned long)size);
51 return NULL;
Nguyễn Thái Ngọc Duyf8bb1d92014-08-16 03:08:0252 }
Linus Torvalds112db552008-06-22 19:19:2553 }
54#ifdef XMALLOC_POISON
55 memset(ret, 0xA5, size);
56#endif
57 return ret;
58}
59
Nguyễn Thái Ngọc Duyf8bb1d92014-08-16 03:08:0260void *xmalloc(size_t size)
61{
62 return do_xmalloc(size, 0);
63}
64
65static void *do_xmallocz(size_t size, int gentle)
Ilari Liusvaara5bf92192010-01-26 18:24:1266{
67 void *ret;
Nguyễn Thái Ngọc Duyf8bb1d92014-08-16 03:08:0268 if (unsigned_add_overflows(size, 1)) {
69 if (gentle) {
70 error("Data too large to fit into virtual memory space.");
71 return NULL;
72 } else
73 die("Data too large to fit into virtual memory space.");
74 }
75 ret = do_xmalloc(size + 1, gentle);
76 if (ret)
77 ((char*)ret)[size] = 0;
Ilari Liusvaara5bf92192010-01-26 18:24:1278 return ret;
79}
80
Nguyễn Thái Ngọc Duyf8bb1d92014-08-16 03:08:0281void *xmallocz(size_t size)
82{
83 return do_xmallocz(size, 0);
84}
85
86void *xmallocz_gently(size_t size)
87{
88 return do_xmallocz(size, 1);
89}
90
Linus Torvalds112db552008-06-22 19:19:2591/*
92 * xmemdupz() allocates (len + 1) bytes of memory, duplicates "len" bytes of
93 * "data" to the allocated memory, zero terminates the allocated memory,
94 * and returns a pointer to the allocated memory. If the allocation fails,
95 * the program dies.
96 */
97void *xmemdupz(const void *data, size_t len)
98{
Ilari Liusvaara5bf92192010-01-26 18:24:1299 return memcpy(xmallocz(len), data, len);
Linus Torvalds112db552008-06-22 19:19:25100}
101
102char *xstrndup(const char *str, size_t len)
103{
104 char *p = memchr(str, '\0', len);
105 return xmemdupz(str, p ? p - str : len);
106}
107
brian m. carlson14570dc2020-05-25 19:58:50108int xstrncmpz(const char *s, const char *t, size_t len)
109{
110 int res = strncmp(s, t, len);
111 if (res)
112 return res;
113 return s[len] == '\0' ? 0 : 1;
114}
115
Linus Torvalds112db552008-06-22 19:19:25116void *xrealloc(void *ptr, size_t size)
117{
Nguyễn Thái Ngọc Duyd41489a2012-03-07 10:54:16118 void *ret;
119
Jeff King6479ea42020-09-02 07:54:39120 if (!size) {
121 free(ptr);
122 return xmalloc(0);
123 }
124
Nguyễn Thái Ngọc Duyf8bb1d92014-08-16 03:08:02125 memory_limit_check(size, 0);
Nguyễn Thái Ngọc Duyd41489a2012-03-07 10:54:16126 ret = realloc(ptr, size);
Jeff King9827d4c2019-08-12 20:50:21127 if (!ret)
128 die("Out of memory, realloc failed");
Linus Torvalds112db552008-06-22 19:19:25129 return ret;
130}
131
132void *xcalloc(size_t nmemb, size_t size)
133{
Nguyễn Thái Ngọc Duyd41489a2012-03-07 10:54:16134 void *ret;
135
Jeff Kinge7792a72016-02-22 22:43:18136 if (unsigned_mult_overflows(nmemb, size))
137 die("data too large to fit into virtual memory space");
138
Nguyễn Thái Ngọc Duyf8bb1d92014-08-16 03:08:02139 memory_limit_check(size * nmemb, 0);
Nguyễn Thái Ngọc Duyd41489a2012-03-07 10:54:16140 ret = calloc(nmemb, size);
Linus Torvalds112db552008-06-22 19:19:25141 if (!ret && (!nmemb || !size))
142 ret = calloc(1, 1);
Jeff King9827d4c2019-08-12 20:50:21143 if (!ret)
144 die("Out of memory, calloc failed");
Linus Torvalds112db552008-06-22 19:19:25145 return ret;
146}
147
Ævar Arnfjörð Bjarmason3540c712021-09-21 13:12:59148void xsetenv(const char *name, const char *value, int overwrite)
149{
150 if (setenv(name, value, overwrite))
151 die_errno(_("could not setenv '%s'"), name ? name : "(null)");
152}
153
Linus Torvalds112db552008-06-22 19:19:25154/*
Steffen Prohaska0b6806b2013-08-20 06:43:54155 * Limit size of IO chunks, because huge chunks only cause pain. OS X
156 * 64-bit is buggy, returning EINVAL if len >= INT_MAX; and even in
Masanari Iida382d20e2013-11-12 15:17:42157 * the absence of bugs, large chunks can result in bad latencies when
Steffen Prohaska0b6806b2013-08-20 06:43:54158 * you decide to kill the process.
Junio C Hamanoa983e6a2015-02-11 21:13:10159 *
160 * We pick 8 MiB as our default, but if the platform defines SSIZE_MAX
161 * that is smaller than that, clip it to SSIZE_MAX, as a call to
162 * read(2) or write(2) larger than that is allowed to fail. As the last
163 * resort, we allow a port to pass via CFLAGS e.g. "-DMAX_IO_SIZE=value"
164 * to override this, if the definition of SSIZE_MAX given by the platform
165 * is broken.
Steffen Prohaska0b6806b2013-08-20 06:43:54166 */
Junio C Hamanoa983e6a2015-02-11 21:13:10167#ifndef MAX_IO_SIZE
168# define MAX_IO_SIZE_DEFAULT (8*1024*1024)
169# if defined(SSIZE_MAX) && (SSIZE_MAX < MAX_IO_SIZE_DEFAULT)
170# define MAX_IO_SIZE SSIZE_MAX
171# else
172# define MAX_IO_SIZE MAX_IO_SIZE_DEFAULT
173# endif
174#endif
Steffen Prohaska0b6806b2013-08-20 06:43:54175
Paul Tan3ff53df2015-08-04 13:51:22176/**
177 * xopen() is the same as open(), but it die()s if the open() fails.
178 */
179int xopen(const char *path, int oflag, ...)
180{
181 mode_t mode = 0;
182 va_list ap;
183
184 /*
185 * va_arg() will have undefined behavior if the specified type is not
186 * compatible with the argument type. Since integers are promoted to
187 * ints, we fetch the next argument as an int, and then cast it to a
188 * mode_t to avoid undefined behavior.
189 */
190 va_start(ap, oflag);
191 if (oflag & O_CREAT)
192 mode = va_arg(ap, int);
193 va_end(ap);
194
195 for (;;) {
196 int fd = open(path, oflag, mode);
197 if (fd >= 0)
198 return fd;
199 if (errno == EINTR)
200 continue;
201
René Scharfea7439d02021-08-25 20:14:09202 if ((oflag & (O_CREAT | O_EXCL)) == (O_CREAT | O_EXCL))
203 die_errno(_("unable to create '%s'"), path);
204 else if ((oflag & O_RDWR) == O_RDWR)
Paul Tan3ff53df2015-08-04 13:51:22205 die_errno(_("could not open '%s' for reading and writing"), path);
206 else if ((oflag & O_WRONLY) == O_WRONLY)
207 die_errno(_("could not open '%s' for writing"), path);
208 else
209 die_errno(_("could not open '%s' for reading"), path);
210 }
211}
212
Eric Wongd751dd12016-07-10 08:20:46213static int handle_nonblock(int fd, short poll_events, int err)
214{
215 struct pollfd pfd;
216
217 if (err != EAGAIN && err != EWOULDBLOCK)
218 return 0;
219
220 pfd.fd = fd;
221 pfd.events = poll_events;
222
223 /*
224 * no need to check for errors, here;
225 * a subsequent read/write will detect unrecoverable errors
226 */
227 poll(&pfd, 1, -1);
228 return 1;
229}
230
Steffen Prohaska0b6806b2013-08-20 06:43:54231/*
Linus Torvalds112db552008-06-22 19:19:25232 * xread() is the same a read(), but it automatically restarts read()
233 * operations with a recoverable error (EAGAIN and EINTR). xread()
234 * DOES NOT GUARANTEE that "len" bytes is read even if the data is available.
235 */
236ssize_t xread(int fd, void *buf, size_t len)
237{
238 ssize_t nr;
Steffen Prohaska0b6806b2013-08-20 06:43:54239 if (len > MAX_IO_SIZE)
Denton Liu7cd54d32020-03-28 02:57:34240 len = MAX_IO_SIZE;
Linus Torvalds112db552008-06-22 19:19:25241 while (1) {
242 nr = read(fd, buf, len);
Stefan Beller1079c4b2015-12-16 00:04:07243 if (nr < 0) {
244 if (errno == EINTR)
245 continue;
Eric Wongd751dd12016-07-10 08:20:46246 if (handle_nonblock(fd, POLLIN, errno))
Eric Wongc22f6202016-06-27 03:56:35247 continue;
Stefan Beller1079c4b2015-12-16 00:04:07248 }
Linus Torvalds112db552008-06-22 19:19:25249 return nr;
250 }
251}
252
253/*
254 * xwrite() is the same a write(), but it automatically restarts write()
255 * operations with a recoverable error (EAGAIN and EINTR). xwrite() DOES NOT
256 * GUARANTEE that "len" bytes is written even if the operation is successful.
257 */
258ssize_t xwrite(int fd, const void *buf, size_t len)
259{
260 ssize_t nr;
Steffen Prohaska0b6806b2013-08-20 06:43:54261 if (len > MAX_IO_SIZE)
Denton Liu7cd54d32020-03-28 02:57:34262 len = MAX_IO_SIZE;
Linus Torvalds112db552008-06-22 19:19:25263 while (1) {
264 nr = write(fd, buf, len);
Eric Wongef1cf012016-06-26 23:21:12265 if (nr < 0) {
266 if (errno == EINTR)
267 continue;
Eric Wongd751dd12016-07-10 08:20:46268 if (handle_nonblock(fd, POLLOUT, errno))
Eric Wongef1cf012016-06-26 23:21:12269 continue;
Eric Wongef1cf012016-06-26 23:21:12270 }
271
Linus Torvalds112db552008-06-22 19:19:25272 return nr;
273 }
274}
275
Yiannis Marangos9aa91af2014-04-10 18:54:12276/*
277 * xpread() is the same as pread(), but it automatically restarts pread()
278 * operations with a recoverable error (EAGAIN and EINTR). xpread() DOES
279 * NOT GUARANTEE that "len" bytes is read even if the data is available.
280 */
281ssize_t xpread(int fd, void *buf, size_t len, off_t offset)
282{
283 ssize_t nr;
284 if (len > MAX_IO_SIZE)
285 len = MAX_IO_SIZE;
286 while (1) {
287 nr = pread(fd, buf, len, offset);
288 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
289 continue;
290 return nr;
291 }
292}
293
Junio C Hamano559e8402008-07-20 23:13:05294ssize_t read_in_full(int fd, void *buf, size_t count)
295{
296 char *p = buf;
297 ssize_t total = 0;
298
299 while (count > 0) {
300 ssize_t loaded = xread(fd, p, count);
Jeff King56d7c272011-05-26 16:30:27301 if (loaded < 0)
302 return -1;
303 if (loaded == 0)
304 return total;
Junio C Hamano559e8402008-07-20 23:13:05305 count -= loaded;
306 p += loaded;
307 total += loaded;
308 }
309
310 return total;
311}
312
313ssize_t write_in_full(int fd, const void *buf, size_t count)
314{
315 const char *p = buf;
316 ssize_t total = 0;
317
318 while (count > 0) {
319 ssize_t written = xwrite(fd, p, count);
320 if (written < 0)
321 return -1;
322 if (!written) {
323 errno = ENOSPC;
324 return -1;
325 }
326 count -= written;
327 p += written;
328 total += written;
329 }
330
331 return total;
332}
333
Yiannis Marangos426ddee2014-04-10 18:31:21334ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset)
335{
336 char *p = buf;
337 ssize_t total = 0;
338
339 while (count > 0) {
340 ssize_t loaded = xpread(fd, p, count, offset);
341 if (loaded < 0)
342 return -1;
343 if (loaded == 0)
344 return total;
345 count -= loaded;
346 p += loaded;
347 total += loaded;
348 offset += loaded;
349 }
350
351 return total;
352}
353
Linus Torvalds112db552008-06-22 19:19:25354int xdup(int fd)
355{
356 int ret = dup(fd);
357 if (ret < 0)
Thomas Rastd824cbb2009-06-27 15:58:46358 die_errno("dup failed");
Linus Torvalds112db552008-06-22 19:19:25359 return ret;
360}
361
Paul Tan260eec22015-08-04 13:51:23362/**
363 * xfopen() is the same as fopen(), but it die()s if the fopen() fails.
364 */
365FILE *xfopen(const char *path, const char *mode)
366{
367 for (;;) {
368 FILE *fp = fopen(path, mode);
369 if (fp)
370 return fp;
371 if (errno == EINTR)
372 continue;
373
374 if (*mode && mode[1] == '+')
375 die_errno(_("could not open '%s' for reading and writing"), path);
376 else if (*mode == 'w' || *mode == 'a')
377 die_errno(_("could not open '%s' for writing"), path);
378 else
379 die_errno(_("could not open '%s' for reading"), path);
380 }
381}
382
Linus Torvalds112db552008-06-22 19:19:25383FILE *xfdopen(int fd, const char *mode)
384{
385 FILE *stream = fdopen(fd, mode);
386 if (stream == NULL)
Thomas Rastd824cbb2009-06-27 15:58:46387 die_errno("Out of memory? fdopen failed");
Linus Torvalds112db552008-06-22 19:19:25388 return stream;
389}
390
Johannes Schindelin79d75822016-01-06 13:09:43391FILE *fopen_for_writing(const char *path)
392{
393 FILE *ret = fopen(path, "w");
394
395 if (!ret && errno == EPERM) {
396 if (!unlink(path))
397 ret = fopen(path, "w");
398 else
399 errno = EPERM;
400 }
401 return ret;
402}
403
Nguyễn Thái Ngọc Duy382fb072017-05-08 10:40:37404static void warn_on_inaccessible(const char *path)
405{
406 warning_errno(_("unable to access '%s'"), path);
407}
408
Nguyễn Thái Ngọc Duy11dc1fc2017-05-03 10:16:49409int warn_on_fopen_errors(const char *path)
410{
411 if (errno != ENOENT && errno != ENOTDIR) {
412 warn_on_inaccessible(path);
413 return -1;
414 }
415
416 return 0;
417}
418
Nguyễn Thái Ngọc Duye9d983f2017-05-03 10:16:50419FILE *fopen_or_warn(const char *path, const char *mode)
420{
421 FILE *fp = fopen(path, mode);
422
423 if (fp)
424 return fp;
425
426 warn_on_fopen_errors(path);
427 return NULL;
428}
429
Brandon Williamseb78e232018-02-14 18:59:56430int xmkstemp(char *filename_template)
Linus Torvalds112db552008-06-22 19:19:25431{
432 int fd;
Arnout Engelen6cf6bb32010-12-18 21:28:00433 char origtemplate[PATH_MAX];
Brandon Williamseb78e232018-02-14 18:59:56434 strlcpy(origtemplate, filename_template, sizeof(origtemplate));
Linus Torvalds112db552008-06-22 19:19:25435
Brandon Williamseb78e232018-02-14 18:59:56436 fd = mkstemp(filename_template);
Arnout Engelen6cf6bb32010-12-18 21:28:00437 if (fd < 0) {
438 int saved_errno = errno;
439 const char *nonrelative_template;
440
Brandon Williamseb78e232018-02-14 18:59:56441 if (strlen(filename_template) != strlen(origtemplate))
442 filename_template = origtemplate;
Arnout Engelen6cf6bb32010-12-18 21:28:00443
Brandon Williamseb78e232018-02-14 18:59:56444 nonrelative_template = absolute_path(filename_template);
Arnout Engelen6cf6bb32010-12-18 21:28:00445 errno = saved_errno;
446 die_errno("Unable to create temporary file '%s'",
447 nonrelative_template);
448 }
Linus Torvalds112db552008-06-22 19:19:25449 return fd;
450}
Linus Torvalds39c68542009-01-08 03:54:47451
Jonathan Nieder33f23932010-11-06 11:46:31452/* Adapted from libiberty's mkstemp.c. */
453
454#undef TMP_MAX
455#define TMP_MAX 16384
456
457int git_mkstemps_mode(char *pattern, int suffix_len, int mode)
458{
459 static const char letters[] =
460 "abcdefghijklmnopqrstuvwxyz"
461 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
462 "0123456789";
Jeff King53d687b2019-10-02 15:32:07463 static const int num_letters = ARRAY_SIZE(letters) - 1;
464 static const char x_pattern[] = "XXXXXX";
465 static const int num_x = ARRAY_SIZE(x_pattern) - 1;
Jonathan Nieder33f23932010-11-06 11:46:31466 uint64_t value;
467 struct timeval tv;
Brandon Williamseb78e232018-02-14 18:59:56468 char *filename_template;
Jonathan Nieder33f23932010-11-06 11:46:31469 size_t len;
470 int fd, count;
471
472 len = strlen(pattern);
473
Jeff King53d687b2019-10-02 15:32:07474 if (len < num_x + suffix_len) {
Jonathan Nieder33f23932010-11-06 11:46:31475 errno = EINVAL;
476 return -1;
477 }
478
Jeff King53d687b2019-10-02 15:32:07479 if (strncmp(&pattern[len - num_x - suffix_len], x_pattern, num_x)) {
Jonathan Nieder33f23932010-11-06 11:46:31480 errno = EINVAL;
481 return -1;
482 }
483
484 /*
485 * Replace pattern's XXXXXX characters with randomness.
486 * Try TMP_MAX different filenames.
487 */
488 gettimeofday(&tv, NULL);
Carlo Marcelo Arenas Belón729a9b52019-06-16 18:40:03489 value = ((uint64_t)tv.tv_usec << 16) ^ tv.tv_sec ^ getpid();
Jeff King53d687b2019-10-02 15:32:07490 filename_template = &pattern[len - num_x - suffix_len];
Jonathan Nieder33f23932010-11-06 11:46:31491 for (count = 0; count < TMP_MAX; ++count) {
492 uint64_t v = value;
Alex Henrie54a80a92019-10-01 02:29:36493 int i;
Jonathan Nieder33f23932010-11-06 11:46:31494 /* Fill in the random bits. */
Jeff King53d687b2019-10-02 15:32:07495 for (i = 0; i < num_x; i++) {
Alex Henrie54a80a92019-10-01 02:29:36496 filename_template[i] = letters[v % num_letters];
497 v /= num_letters;
498 }
Jonathan Nieder33f23932010-11-06 11:46:31499
500 fd = open(pattern, O_CREAT | O_EXCL | O_RDWR, mode);
Dale R. Worleya2cb86c2013-07-12 08:58:35501 if (fd >= 0)
Jonathan Nieder33f23932010-11-06 11:46:31502 return fd;
503 /*
504 * Fatal error (EPERM, ENOSPC etc).
505 * It doesn't make sense to loop.
506 */
507 if (errno != EEXIST)
508 break;
509 /*
510 * This is a random value. It is only necessary that
511 * the next TMP_MAX values generated by adding 7777 to
512 * VALUE are different with (module 2^32).
513 */
514 value += 7777;
515 }
516 /* We return the null string if we can't find a unique file name. */
517 pattern[0] = '\0';
518 return -1;
519}
520
521int git_mkstemp_mode(char *pattern, int mode)
522{
523 /* mkstemp is just mkstemps with no suffix */
524 return git_mkstemps_mode(pattern, 0, mode);
525}
526
Brandon Williamseb78e232018-02-14 18:59:56527int xmkstemp_mode(char *filename_template, int mode)
Matthieu Moyb862b612010-02-22 22:32:13528{
529 int fd;
Arnout Engelen6cf6bb32010-12-18 21:28:00530 char origtemplate[PATH_MAX];
Brandon Williamseb78e232018-02-14 18:59:56531 strlcpy(origtemplate, filename_template, sizeof(origtemplate));
Matthieu Moyb862b612010-02-22 22:32:13532
Brandon Williamseb78e232018-02-14 18:59:56533 fd = git_mkstemp_mode(filename_template, mode);
Arnout Engelen6cf6bb32010-12-18 21:28:00534 if (fd < 0) {
535 int saved_errno = errno;
536 const char *nonrelative_template;
537
Brandon Williamseb78e232018-02-14 18:59:56538 if (!filename_template[0])
539 filename_template = origtemplate;
Arnout Engelen6cf6bb32010-12-18 21:28:00540
Brandon Williamseb78e232018-02-14 18:59:56541 nonrelative_template = absolute_path(filename_template);
Arnout Engelen6cf6bb32010-12-18 21:28:00542 errno = saved_errno;
543 die_errno("Unable to create temporary file '%s'",
544 nonrelative_template);
545 }
Matthieu Moyb862b612010-02-22 22:32:13546 return fd;
547}
548
Peter Collingbourne10e13ec2010-03-26 15:25:32549static int warn_if_unremovable(const char *op, const char *file, int rc)
Alex Riesenfc71db32009-04-29 21:21:46550{
Ronnie Sahlberg1054af72014-07-16 18:01:18551 int err;
552 if (!rc || errno == ENOENT)
553 return 0;
554 err = errno;
Simon Ruderich0a288d12017-11-01 14:44:44555 warning_errno("unable to %s '%s'", op, file);
Ronnie Sahlberg1054af72014-07-16 18:01:18556 errno = err;
Alex Riesenfc71db32009-04-29 21:21:46557 return rc;
558}
559
Ronnie Sahlberg9ccc0c02014-07-16 18:20:36560int unlink_or_msg(const char *file, struct strbuf *err)
561{
562 int rc = unlink(file);
563
564 assert(err);
565
566 if (!rc || errno == ENOENT)
567 return 0;
568
Simon Ruderich0a288d12017-11-01 14:44:44569 strbuf_addf(err, "unable to unlink '%s': %s",
Ronnie Sahlberg9ccc0c02014-07-16 18:20:36570 file, strerror(errno));
571 return -1;
572}
573
Peter Collingbourne10e13ec2010-03-26 15:25:32574int unlink_or_warn(const char *file)
575{
576 return warn_if_unremovable("unlink", file, unlink(file));
577}
Peter Collingbourned1723292010-03-26 15:25:33578
579int rmdir_or_warn(const char *file)
580{
581 return warn_if_unremovable("rmdir", file, rmdir(file));
582}
Peter Collingbourne80d706a2010-03-26 15:25:34583
584int remove_or_warn(unsigned int mode, const char *file)
585{
586 return S_ISGITLINK(mode) ? rmdir_or_warn(file) : unlink_or_warn(file);
587}
Jeff King2f705872012-05-21 23:10:20588
Jonathan Nieder4698c8f2013-04-12 21:03:18589static int access_error_is_ok(int err, unsigned flag)
590{
Junio C Hamanoc7054202017-05-30 00:23:33591 return (is_missing_file_error(err) ||
592 ((flag & ACCESS_EACCES_OK) && err == EACCES));
Jonathan Nieder4698c8f2013-04-12 21:03:18593}
594
595int access_or_warn(const char *path, int mode, unsigned flag)
Jeff Kingba8bd832012-08-21 06:10:59596{
597 int ret = access(path, mode);
Jonathan Nieder4698c8f2013-04-12 21:03:18598 if (ret && !access_error_is_ok(errno, flag))
Junio C Hamano55b38a42012-08-21 21:52:07599 warn_on_inaccessible(path);
Jeff Kingba8bd832012-08-21 06:10:59600 return ret;
601}
602
Jonathan Nieder4698c8f2013-04-12 21:03:18603int access_or_die(const char *path, int mode, unsigned flag)
Jonathan Nieder96b9e0e2012-10-14 00:04:02604{
605 int ret = access(path, mode);
Jonathan Nieder4698c8f2013-04-12 21:03:18606 if (ret && !access_error_is_ok(errno, flag))
Jonathan Nieder96b9e0e2012-10-14 00:04:02607 die_errno(_("unable to access '%s'"), path);
608 return ret;
609}
610
René Scharfeaa14e982014-07-28 18:29:50611char *xgetcwd(void)
612{
613 struct strbuf sb = STRBUF_INIT;
614 if (strbuf_getcwd(&sb))
615 die_errno(_("unable to get current working directory"));
616 return strbuf_detach(&sb, NULL);
617}
Nguyễn Thái Ngọc Duy316e53e2014-11-30 08:24:45618
Jeff King7b03c892015-09-24 21:05:37619int xsnprintf(char *dst, size_t max, const char *fmt, ...)
620{
621 va_list ap;
622 int len;
623
624 va_start(ap, fmt);
625 len = vsnprintf(dst, max, fmt, ap);
626 va_end(ap);
627
628 if (len < 0)
Johannes Schindelin033abf92018-05-02 09:38:39629 BUG("your snprintf is broken");
Jeff King7b03c892015-09-24 21:05:37630 if (len >= max)
Johannes Schindelin033abf92018-05-02 09:38:39631 BUG("attempt to snprintf into too-small buffer");
Jeff King7b03c892015-09-24 21:05:37632 return len;
633}
634
Jeff King52563d72016-07-08 09:12:22635void write_file_buf(const char *path, const char *buf, size_t len)
Nguyễn Thái Ngọc Duy316e53e2014-11-30 08:24:45636{
Jeff King52563d72016-07-08 09:12:22637 int fd = xopen(path, O_WRONLY | O_CREAT | O_TRUNC, 0666);
Jeff King06f46f22017-09-13 17:16:03638 if (write_in_full(fd, buf, len) < 0)
Simon Ruderich0a288d12017-11-01 14:44:44639 die_errno(_("could not write to '%s'"), path);
Jeff King52563d72016-07-08 09:12:22640 if (close(fd))
Simon Ruderich0a288d12017-11-01 14:44:44641 die_errno(_("could not close '%s'"), path);
Jeff King52563d72016-07-08 09:12:22642}
643
Jeff Kingef223182016-07-08 09:09:34644void write_file(const char *path, const char *fmt, ...)
Nguyễn Thái Ngọc Duy316e53e2014-11-30 08:24:45645{
Jeff Kingef223182016-07-08 09:09:34646 va_list params;
Nguyễn Thái Ngọc Duy316e53e2014-11-30 08:24:45647 struct strbuf sb = STRBUF_INIT;
Jeff Kingef223182016-07-08 09:09:34648
649 va_start(params, fmt);
Nguyễn Thái Ngọc Duy316e53e2014-11-30 08:24:45650 strbuf_vaddf(&sb, fmt, params);
Jeff Kingef223182016-07-08 09:09:34651 va_end(params);
652
Junio C Hamanoe7ffa382015-08-24 16:39:48653 strbuf_complete_line(&sb);
Jeff King52563d72016-07-08 09:12:22654
655 write_file_buf(path, sb.buf, sb.len);
Nguyễn Thái Ngọc Duy316e53e2014-11-30 08:24:45656 strbuf_release(&sb);
Junio C Hamano12d6ce12015-08-24 20:03:07657}
658
Johannes Sixt2024d312015-06-05 19:45:05659void sleep_millisec(int millisec)
660{
661 poll(NULL, 0, millisec);
662}
David Turner5781a9a2017-04-18 21:57:43663
664int xgethostname(char *buf, size_t len)
665{
666 /*
667 * If the full hostname doesn't fit in buf, POSIX does not
668 * specify whether the buffer will be null-terminated, so to
669 * be safe, do it ourselves.
670 */
671 int ret = gethostname(buf, len);
672 if (!ret)
673 buf[len - 1] = 0;
674 return ret;
675}
Pranit Bauvae3b1e3b2019-01-02 15:38:32676
677int is_empty_or_missing_file(const char *filename)
678{
679 struct stat st;
680
681 if (stat(filename, &st) < 0) {
682 if (errno == ENOENT)
683 return 1;
684 die_errno(_("could not stat %s"), filename);
685 }
686
687 return !st.st_size;
688}
Jeff King00611d82021-02-16 14:44:22689
690int open_nofollow(const char *path, int flags)
691{
692#ifdef O_NOFOLLOW
693 return open(path, flags | O_NOFOLLOW);
694#else
695 struct stat st;
696 if (lstat(path, &st) < 0)
697 return -1;
698 if (S_ISLNK(st.st_mode)) {
699 errno = ELOOP;
700 return -1;
701 }
702 return open(path, flags);
703#endif
704}