blob: 400e92108687e31dd16fbcea1a43e04556b98566 [file] [log] [blame]
Junio C Hamano4050c0d2005-12-05 11:54:29 -08001#ifndef GIT_COMPAT_UTIL_H
2#define GIT_COMPAT_UTIL_H
3
Martin Waitzb97e9112007-02-17 10:13:10 +01004#define _FILE_OFFSET_BITS 64
5
Junio C Hamano8f1d2e62006-01-07 01:33:54 -08006#ifndef FLEX_ARRAY
Junio C Hamano8e973992007-11-20 12:08:06 -08007/*
8 * See if our compiler is known to support flexible array members.
9 */
Brandon Casey203ee912009-06-08 18:53:48 -050010#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
Junio C Hamano8e973992007-11-20 12:08:06 -080011# define FLEX_ARRAY /* empty */
12#elif defined(__GNUC__)
13# if (__GNUC__ >= 3)
14# define FLEX_ARRAY /* empty */
15# else
16# define FLEX_ARRAY 0 /* older GNU extension */
17# endif
18#endif
19
20/*
21 * Otherwise, default to safer but a bit wasteful traditional style
22 */
23#ifndef FLEX_ARRAY
24# define FLEX_ARRAY 1
Junio C Hamano8f1d2e62006-01-07 01:33:54 -080025#endif
26#endif
27
Junio C Hamanob4f2a6a2006-03-09 11:58:05 -080028#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
Pierre Habouzitf630cfd2009-07-22 23:34:34 +020029#define bitsizeof(x) (CHAR_BIT * sizeof(x))
Junio C Hamanob4f2a6a2006-03-09 11:58:05 -080030
Erik Faye-Lundc03c8312010-10-05 09:24:10 +020031#define maximum_signed_value_of_type(a) \
32 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
33
Jonathan Nieder1368f652010-10-10 21:59:26 -050034#define maximum_unsigned_value_of_type(a) \
35 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
36
Erik Faye-Lundc03c8312010-10-05 09:24:10 +020037/*
38 * Signed integer overflow is undefined in C, so here's a helper macro
39 * to detect if the sum of two integers will overflow.
40 *
41 * Requires: a >= 0, typeof(a) equals typeof(b)
42 */
43#define signed_add_overflows(a, b) \
44 ((b) > maximum_signed_value_of_type(a) - (a))
45
Jonathan Nieder1368f652010-10-10 21:59:26 -050046#define unsigned_add_overflows(a, b) \
47 ((b) > maximum_unsigned_value_of_type(a) - (a))
48
Nicolas Pitre8723f212007-04-09 01:06:29 -040049#ifdef __GNUC__
50#define TYPEOF(x) (__typeof__(x))
51#else
52#define TYPEOF(x)
53#endif
54
Pierre Habouzitf630cfd2009-07-22 23:34:34 +020055#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
Pierre Habouzitdb7244b2007-11-07 11:20:27 +010056#define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
Nicolas Pitre8723f212007-04-09 01:06:29 -040057
Pierre Habouzit98cb6f32009-07-22 23:34:35 +020058#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
59
Andy Whitcroftcf606e32007-05-15 17:33:25 +010060/* Approximation of the length of the decimal representation of this type. */
61#define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
62
Brandon Casey4cb18a42009-06-05 18:36:13 -050063#if defined(__sun__)
64 /*
65 * On Solaris, when _XOPEN_EXTENDED is set, its header file
66 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
67 * setting to say we are XPG5 or XPG6. Also on Solaris,
68 * XPG6 programs must be compiled with a c99 compiler, while
69 * non XPG6 programs must be compiled with a pre-c99 compiler.
70 */
71# if __STDC_VERSION__ - 0 >= 199901L
72# define _XOPEN_SOURCE 600
73# else
74# define _XOPEN_SOURCE 500
75# endif
YONETANI Tomokazu6555b192010-04-02 16:52:09 +090076#elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
Joachim Schmitz6c109902012-09-19 12:03:30 +020077 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
Benny Siegert92164af2013-12-31 14:36:45 +000078 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__)
Junio C Hamano85023572006-12-19 14:34:12 -080079#define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
80#define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
Terje Sten Bjerksethc902c9a2006-12-20 17:32:21 -080081#endif
Jason Riedyfb952202007-01-15 17:34:49 -080082#define _ALL_SOURCE 1
83#define _GNU_SOURCE 1
84#define _BSD_SOURCE 1
Sergey Senozhatskyf978a992014-09-14 14:33:35 +090085#define _DEFAULT_SOURCE 1
Patrick Welche9a695fb2009-04-26 14:49:00 +010086#define _NETBSD_SOURCE 1
Brandon Casey9398b852009-07-10 12:10:44 -050087#define _SGI_SOURCE 1
Junio C Hamano85023572006-12-19 14:34:12 -080088
Jonathan Nieder380395d2013-05-02 20:26:08 +010089#if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
Sebastian Schuberth8453c122013-09-11 18:06:31 +020090# if defined (_MSC_VER) && !defined(_WIN32_WINNT)
Ramsay Jones41f29992013-01-31 18:28:35 +000091# define _WIN32_WINNT 0x0502
92# endif
Marius Storm-Olsen435bdf82009-09-16 10:20:26 +020093#define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
94#include <winsock2.h>
95#include <windows.h>
Jonathan Nieder380395d2013-05-02 20:26:08 +010096#define GIT_WINDOWS_NATIVE
Marius Storm-Olsen435bdf82009-09-16 10:20:26 +020097#endif
98
Junio C Hamano4050c0d2005-12-05 11:54:29 -080099#include <unistd.h>
100#include <stdio.h>
101#include <sys/stat.h>
102#include <fcntl.h>
103#include <stddef.h>
104#include <stdlib.h>
105#include <stdarg.h>
106#include <string.h>
David Michaelb3e103d2012-12-14 14:57:01 -0500107#ifdef HAVE_STRINGS_H
Joachim Schmitz6c109902012-09-19 12:03:30 +0200108#include <strings.h> /* for strcasecmp() */
109#endif
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800110#include <errno.h>
111#include <limits.h>
Junio C Hamanob2d05e02012-12-18 09:35:33 -0800112#ifdef NEEDS_SYS_PARAM_H
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800113#include <sys/param.h>
David Michael6ede7202012-12-14 14:56:58 -0500114#endif
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800115#include <sys/types.h>
116#include <dirent.h>
Junio C Hamano85023572006-12-19 14:34:12 -0800117#include <sys/time.h>
118#include <time.h>
119#include <signal.h>
Johannes Sixtf4626df2007-12-01 21:24:59 +0100120#include <assert.h>
121#include <regex.h>
122#include <utime.h>
Mike Pape088d8802010-11-04 02:35:10 +0100123#include <syslog.h>
Markus Duft28449232010-10-27 10:39:52 +0200124#ifndef NO_SYS_POLL_H
Erik Faye-Lundfdc12112010-11-04 02:35:21 +0100125#include <sys/poll.h>
Markus Duft28449232010-10-27 10:39:52 +0200126#else
127#include <poll.h>
128#endif
Ramsay Jones2f0aaaf2013-05-30 00:53:28 +0100129
Vincent van Ravesteijncfc755d2011-10-31 20:12:42 +0100130#if defined(__MINGW32__)
131/* pull in Windows compatibility stuff */
132#include "compat/mingw.h"
133#elif defined(_MSC_VER)
134#include "compat/msvc.h"
135#else
Johannes Sixtf4626df2007-12-01 21:24:59 +0100136#include <sys/wait.h>
Jonathan Niederebae9ff2011-03-18 15:23:52 -0500137#include <sys/resource.h>
Junio C Hamano85023572006-12-19 14:34:12 -0800138#include <sys/socket.h>
Johannes Sixt80bbe722007-11-13 21:05:01 +0100139#include <sys/ioctl.h>
Nguyễn Thái Ngọc Duyeb800422010-01-11 17:41:01 +0700140#include <termios.h>
Robert Schiele26009732008-01-24 19:34:46 +0100141#ifndef NO_SYS_SELECT_H
Johannes Sixt80bbe722007-11-13 21:05:01 +0100142#include <sys/select.h>
Robert Schiele26009732008-01-24 19:34:46 +0100143#endif
Junio C Hamano85023572006-12-19 14:34:12 -0800144#include <netinet/in.h>
145#include <netinet/tcp.h>
146#include <arpa/inet.h>
147#include <netdb.h>
148#include <pwd.h>
Jeff Kinge2770972011-12-10 05:34:14 -0500149#include <sys/un.h>
Markus Duft28449232010-10-27 10:39:52 +0200150#ifndef NO_INTTYPES_H
Jason Riedy007e2ba2007-01-25 13:11:40 -0800151#include <inttypes.h>
Markus Duft28449232010-10-27 10:39:52 +0200152#else
153#include <stdint.h>
154#endif
Joachim Schmitz6c109902012-09-19 12:03:30 +0200155#ifdef NO_INTPTR_T
156/*
157 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
158 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
159 * while on IP16 and IP16L32 it is "int" (resp. "short")
160 * Size needs to match (or exceed) 'sizeof(void *)'.
161 * We can't take "long long" here as not everybody has it.
162 */
163typedef long intptr_t;
164typedef unsigned long uintptr_t;
165#endif
Ramsay Jones41b20012007-03-03 18:28:52 +0000166#if defined(__CYGWIN__)
167#undef _XOPEN_SOURCE
168#include <grp.h>
169#define _XOPEN_SOURCE 600
170#else
Jason Riedyfb952202007-01-15 17:34:49 -0800171#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
Junio C Hamano85023572006-12-19 14:34:12 -0800172#include <grp.h>
Jason Riedyfb952202007-01-15 17:34:49 -0800173#define _ALL_SOURCE 1
Ramsay Jones41b20012007-03-03 18:28:52 +0000174#endif
Frank Lid75f8e62009-09-16 10:20:25 +0200175#endif
Junio C Hamano85023572006-12-19 14:34:12 -0800176
Torsten Bögershausen76759c72012-07-08 15:50:25 +0200177/* used on Mac OS X */
178#ifdef PRECOMPOSE_UNICODE
179#include "compat/precompose_utf8.h"
180#else
181#define precompose_str(in,i_nfd2nfc)
182#define precompose_argv(c,v)
183#define probe_utf8_pathname_composition(a,b)
184#endif
185
Joachim Schmitz0539ecf2012-08-24 12:31:03 +0200186#ifdef MKDIR_WO_TRAILING_SLASH
187#define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
188extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
189#endif
190
Joachim Schmitz7f9e8482012-09-08 18:54:34 +0200191#ifdef NO_STRUCT_ITIMERVAL
192struct itimerval {
193 struct timeval it_interval;
194 struct timeval it_value;
Jonas 'Sortie' Termansen981ff522014-08-29 09:42:33 -0700195};
Joachim Schmitz7f9e8482012-09-08 18:54:34 +0200196#endif
197
198#ifdef NO_SETITIMER
199#define setitimer(which,value,ovalue)
200#endif
201
David Aguilare1c06882009-05-31 01:35:51 -0700202#ifndef NO_LIBGEN_H
203#include <libgen.h>
204#else
205#define basename gitbasename
206extern char *gitbasename(char *);
207#endif
208
Junio C Hamano85023572006-12-19 14:34:12 -0800209#ifndef NO_ICONV
210#include <iconv.h>
211#endif
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800212
Robert Shearman684ec6c2008-07-09 22:29:00 +0100213#ifndef NO_OPENSSL
214#include <openssl/ssl.h>
215#include <openssl/err.h>
216#endif
217
David Michael3b130ade2013-02-25 14:30:19 -0500218/* On most systems <netdb.h> would have given us this, but
219 * not on some systems (e.g. z/OS).
220 */
221#ifndef NI_MAXHOST
222#define NI_MAXHOST 1025
223#endif
224
225#ifndef NI_MAXSERV
226#define NI_MAXSERV 32
227#endif
228
Junio C Hamanod0c24492006-09-15 22:47:21 -0700229/* On most systems <limits.h> would have given us this, but
230 * not on some systems (e.g. GNU/Hurd).
231 */
232#ifndef PATH_MAX
233#define PATH_MAX 4096
234#endif
235
Shawn O. Pearcec4001d92007-03-06 20:44:30 -0500236#ifndef PRIuMAX
237#define PRIuMAX "llu"
238#endif
239
Johannes Sixt607bb3f2008-07-09 22:38:14 +0200240#ifndef PRIu32
241#define PRIu32 "u"
242#endif
243
244#ifndef PRIx32
245#define PRIx32 "x"
246#endif
247
Ramsay Jones5418d962010-09-09 18:24:06 +0100248#ifndef PRIo32
249#define PRIo32 "o"
250#endif
251
Johannes Sixt80ba0742007-12-03 21:55:57 +0100252#ifndef PATH_SEP
253#define PATH_SEP ':'
254#endif
255
Chris Webbcb6a22c2010-04-13 10:07:13 +0100256#ifdef HAVE_PATHS_H
257#include <paths.h>
258#endif
259#ifndef _PATH_DEFPATH
260#define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
261#endif
262
Johannes Sixt23326d12007-12-08 20:57:25 +0100263#ifndef STRIP_EXTENSION
264#define STRIP_EXTENSION ""
265#endif
266
Johannes Sixt25fe2172008-03-05 21:51:27 +0100267#ifndef has_dos_drive_prefix
René Scharfebf728342014-08-16 23:48:33 +0200268static inline int git_has_dos_drive_prefix(const char *path)
269{
270 return 0;
271}
272#define has_dos_drive_prefix git_has_dos_drive_prefix
Cezary Zawadkac2369bd2010-07-13 16:17:43 +0200273#endif
274
Johannes Sixt25fe2172008-03-05 21:51:27 +0100275#ifndef is_dir_sep
René Scharfebf728342014-08-16 23:48:33 +0200276static inline int git_is_dir_sep(int c)
277{
278 return c == '/';
279}
280#define is_dir_sep git_is_dir_sep
281#endif
282
283#ifndef offset_1st_component
284static inline int git_offset_1st_component(const char *path)
285{
286 return is_dir_sep(path[0]);
287}
288#define offset_1st_component git_offset_1st_component
Johannes Sixt25fe2172008-03-05 21:51:27 +0100289#endif
290
Theo Niessinkd1c69252011-05-27 18:00:39 +0200291#ifndef find_last_dir_sep
René Scharfebf728342014-08-16 23:48:33 +0200292static inline char *git_find_last_dir_sep(const char *path)
293{
294 return strrchr(path, '/');
295}
296#define find_last_dir_sep git_find_last_dir_sep
Theo Niessinkd1c69252011-05-27 18:00:39 +0200297#endif
298
Ramkumar Ramachandrae4ac9532011-11-15 23:01:09 +0530299#if defined(__HP_cc) && (__HP_cc >= 61000)
Michal Rokosb6ab3492011-03-07 13:13:15 +0100300#define NORETURN __attribute__((noreturn))
301#define NORETURN_PTR
Junio C Hamano6520c842011-06-18 18:07:03 -0700302#elif defined(__GNUC__) && !defined(NO_NORETURN)
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800303#define NORETURN __attribute__((__noreturn__))
Erik Faye-Lund18660bc2009-09-30 18:05:50 +0000304#define NORETURN_PTR __attribute__((__noreturn__))
Ramsay Jonesaba7dea2010-01-20 19:45:12 +0000305#elif defined(_MSC_VER)
306#define NORETURN __declspec(noreturn)
307#define NORETURN_PTR
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800308#else
309#define NORETURN
Erik Faye-Lund18660bc2009-09-30 18:05:50 +0000310#define NORETURN_PTR
Andi Kleen8cd7ebc2014-07-04 16:43:49 -0700311#ifndef __GNUC__
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800312#ifndef __attribute__
313#define __attribute__(x)
314#endif
315#endif
Andi Kleen8cd7ebc2014-07-04 16:43:49 -0700316#endif
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800317
Ramsay Jones9fe3edc2013-07-18 21:02:12 +0100318/* The sentinel attribute is valid from gcc version 4.0 */
319#if defined(__GNUC__) && (__GNUC__ >= 4)
320#define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
321#else
322#define LAST_ARG_MUST_BE_NULL
323#endif
324
Nicolas Pitre51ea5512009-08-18 15:26:55 -0400325#include "compat/bswap.h"
326
Nguyễn Thái Ngọc Duycebcab12013-01-01 09:44:11 +0700327#include "wildmatch.h"
Nguyễn Thái Ngọc Duycebcab12013-01-01 09:44:11 +0700328
Ronnie Sahlberg9ccc0c02014-07-16 11:20:36 -0700329struct strbuf;
330
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800331/* General helper functions */
Johannes Sixtebaa79f2010-03-06 16:40:39 +0100332extern void vreportf(const char *prefix, const char *err, va_list params);
Clemens Buchacher3bc41812011-07-27 23:32:34 +0200333extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
Erik Faye-Lunda4f31312009-09-30 18:05:49 +0000334extern NORETURN void usage(const char *err);
Jonathan Nieder64b1cb72009-11-09 09:05:02 -0600335extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
Erik Faye-Lunda4f31312009-09-30 18:05:49 +0000336extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
337extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800338extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
Theodore Ts'o46efd2d2007-03-30 19:07:05 -0400339extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800340
Brian Gernhardtf2be0342013-08-05 11:59:23 -0400341#ifndef NO_OPENSSL
342#ifdef APPLE_COMMON_CRYPTO
343#include "compat/apple-common-crypto.h"
344#else
345#include <openssl/evp.h>
346#include <openssl/hmac.h>
347#endif /* APPLE_COMMON_CRYPTO */
348#include <openssl/x509v3.h>
349#endif /* NO_OPENSSL */
350
Jeff Kinge208f9c2012-12-15 12:37:36 -0500351/*
352 * Let callers be aware of the constant return value; this can help
Matt Kraai9798f7e2013-02-08 07:09:28 -0800353 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
354 * because some compilers may not support variadic macros. Since we're only
355 * trying to help gcc, anyway, it's OK; other compilers will fall back to
356 * using the function as usual.
Jeff Kinge208f9c2012-12-15 12:37:36 -0500357 */
Jeff Kingff0a80a2014-05-06 11:17:50 -0400358#if defined(__GNUC__)
Jeff King87fe5df2014-05-06 11:14:42 -0400359static inline int const_error(void)
360{
361 return -1;
362}
363#define error(...) (error(__VA_ARGS__), const_error())
Jeff Kinge208f9c2012-12-15 12:37:36 -0500364#endif
365
Erik Faye-Lund18660bc2009-09-30 18:05:50 +0000366extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
Clemens Buchacher3bc41812011-07-27 23:32:34 +0200367extern void set_error_routine(void (*routine)(const char *err, va_list params));
Jeff Kingc19a4902013-04-16 15:46:22 -0400368extern void set_die_is_recursing_routine(int (*routine)(void));
Petr Baudis39a3f5e2006-06-24 04:34:38 +0200369
Christian Couder95662312013-12-01 08:49:16 +0100370extern int starts_with(const char *str, const char *prefix);
Junio C Hamano698a68b2008-01-03 01:23:12 -0800371
Jeff Kingcf4fff52014-06-18 15:44:19 -0400372/*
373 * If the string "str" begins with the string found in "prefix", return 1.
374 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
375 * the string right after the prefix).
376 *
377 * Otherwise, return 0 and leave "out" untouched.
378 *
379 * Examples:
380 *
381 * [extract branch name, fail if not a branch]
382 * if (!skip_prefix(ref, "refs/heads/", &branch)
383 * return -1;
384 *
385 * [skip prefix if present, otherwise use whole string]
386 * skip_prefix(name, "refs/heads/", &name);
387 */
388static inline int skip_prefix(const char *str, const char *prefix,
389 const char **out)
Miklos Vajnafbca5832008-06-27 18:21:56 +0200390{
David Kastrupba399c42014-03-04 00:22:15 +0100391 do {
Jeff Kingcf4fff52014-06-18 15:44:19 -0400392 if (!*prefix) {
393 *out = str;
394 return 1;
395 }
David Kastrupba399c42014-03-04 00:22:15 +0100396 } while (*str++ == *prefix++);
Jeff Kingcf4fff52014-06-18 15:44:19 -0400397 return 0;
Miklos Vajnafbca5832008-06-27 18:21:56 +0200398}
399
Jeff King35480f02014-06-30 12:57:51 -0400400/*
401 * If buf ends with suffix, return 1 and subtract the length of the suffix
402 * from *len. Otherwise, return 0 and leave *len untouched.
403 */
404static inline int strip_suffix_mem(const char *buf, size_t *len,
405 const char *suffix)
406{
407 size_t suflen = strlen(suffix);
408 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
409 return 0;
410 *len -= suflen;
411 return 1;
412}
413
414/*
415 * If str ends with suffix, return 1 and set *len to the size of the string
416 * without the suffix. Otherwise, return 0 and set *len to the size of the
417 * string.
418 *
419 * Note that we do _not_ NUL-terminate str to the new length.
420 */
421static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
422{
423 *len = strlen(str);
424 return strip_suffix_mem(str, len, suffix);
425}
426
Jeff Kingf52a35f2014-06-30 12:58:08 -0400427static inline int ends_with(const char *str, const char *suffix)
428{
429 size_t len;
430 return strip_suffix(str, suffix, &len);
431}
432
Janos Laubeb130a722009-03-13 16:50:45 +0100433#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800434
435#ifndef PROT_READ
436#define PROT_READ 1
437#define PROT_WRITE 2
438#define MAP_PRIVATE 1
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800439#endif
440
Shawn O. Pearced6779122006-12-24 00:45:37 -0500441#define mmap git_mmap
442#define munmap git_munmap
443extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
444extern int git_munmap(void *start, size_t length);
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800445
Janos Laubeb130a722009-03-13 16:50:45 +0100446#else /* NO_MMAP || USE_WIN32_MMAP */
447
448#include <sys/mman.h>
449
450#endif /* NO_MMAP || USE_WIN32_MMAP */
451
452#ifdef NO_MMAP
453
Junio C Hamano5faaf242007-02-14 13:20:41 -0800454/* This value must be multiple of (pagesize * 2) */
Shawn O. Pearce8c825342006-12-24 00:46:13 -0500455#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
456
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800457#else /* NO_MMAP */
458
Junio C Hamano5faaf242007-02-14 13:20:41 -0800459/* This value must be multiple of (pagesize * 2) */
Shawn O. Pearce22bac0e2007-01-04 22:28:08 -0500460#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
461 (sizeof(void*) >= 8 \
462 ? 1 * 1024 * 1024 * 1024 \
463 : 32 * 1024 * 1024)
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800464
465#endif /* NO_MMAP */
466
Gary V. Vaughanfcf3a212010-05-14 09:31:39 +0000467#ifndef MAP_FAILED
468#define MAP_FAILED ((void *)-1)
469#endif
470
Junio C Hamanofdb2a2a2008-08-18 21:57:16 +0200471#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
472#define on_disk_bytes(st) ((st).st_size)
473#else
474#define on_disk_bytes(st) ((st).st_blocks * 512)
475#endif
476
Shawn O. Pearce22bac0e2007-01-04 22:28:08 -0500477#define DEFAULT_PACKED_GIT_LIMIT \
Junio C Hamanoecaebf42007-01-07 00:11:11 -0800478 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
Shawn O. Pearce8c825342006-12-24 00:46:13 -0500479
Stefan-W. Hahn69006792007-01-09 22:04:12 +0100480#ifdef NO_PREAD
481#define pread git_pread
482extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
483#endif
Steffen Prohaska14086b02007-11-17 20:48:14 +0100484/*
485 * Forward decl that will remind us if its twin in cache.h changes.
486 * This function is used in compat/pread.c. But we can't include
487 * cache.h there.
488 */
489extern ssize_t read_in_full(int fd, void *buf, size_t count);
Stefan-W. Hahn69006792007-01-09 22:04:12 +0100490
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800491#ifdef NO_SETENV
492#define setenv gitsetenv
493extern int gitsetenv(const char *, const char *, int);
494#endif
495
Shawn O. Pearceca5bb5d2007-10-20 16:03:49 -0400496#ifdef NO_MKDTEMP
497#define mkdtemp gitmkdtemp
498extern char *gitmkdtemp(char *);
499#endif
500
David Aguilar0620b392009-05-31 01:35:50 -0700501#ifdef NO_MKSTEMPS
502#define mkstemps gitmkstemps
503extern int gitmkstemps(char *, int);
504#endif
505
Jason Riedy731043f2006-01-25 12:38:36 -0800506#ifdef NO_UNSETENV
507#define unsetenv gitunsetenv
508extern void gitunsetenv(const char *);
509#endif
510
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800511#ifdef NO_STRCASESTR
512#define strcasestr gitstrcasestr
513extern char *gitstrcasestr(const char *haystack, const char *needle);
514#endif
515
Peter Eriksen817151e2006-06-24 16:01:25 +0200516#ifdef NO_STRLCPY
517#define strlcpy gitstrlcpy
518extern size_t gitstrlcpy(char *, const char *, size_t);
519#endif
520
Jason Riedybc6b4f52007-02-19 16:22:56 -0800521#ifdef NO_STRTOUMAX
522#define strtoumax gitstrtoumax
523extern uintmax_t gitstrtoumax(const char *, char **, int);
Johannes Sixt97000ba2011-11-05 16:37:34 +0100524#define strtoimax gitstrtoimax
525extern intmax_t gitstrtoimax(const char *, char **, int);
Jason Riedybc6b4f52007-02-19 16:22:56 -0800526#endif
527
Alex Riesenfa0c87c2007-06-13 20:54:32 +0200528#ifdef NO_HSTRERROR
529#define hstrerror githstrerror
530extern const char *githstrerror(int herror);
531#endif
532
René Scharfeb21b9f12007-09-07 00:32:54 +0200533#ifdef NO_MEMMEM
534#define memmem gitmemmem
535void *gitmemmem(const void *haystack, size_t haystacklen,
536 const void *needle, size_t needlelen);
537#endif
538
Matt Kraai40036be2012-12-18 14:03:55 -0800539#ifdef NO_GETPAGESIZE
540#define getpagesize() sysconf(_SC_PAGESIZE)
541#endif
542
Brandon Caseycba22522008-02-08 20:32:47 -0600543#ifdef FREAD_READS_DIRECTORIES
Johannes Sixtc5445fe2008-05-08 09:34:49 +0200544#ifdef fopen
545#undef fopen
546#endif
Brandon Caseycba22522008-02-08 20:32:47 -0600547#define fopen(a,b) git_fopen(a,b)
548extern FILE *git_fopen(const char*, const char*);
549#endif
550
Michal Rokosc4582f92008-03-05 16:46:13 +0100551#ifdef SNPRINTF_RETURNS_BOGUS
Benoit Sigoureab038032014-01-30 22:25:12 -0800552#ifdef snprintf
553#undef snprintf
554#endif
Michal Rokosc4582f92008-03-05 16:46:13 +0100555#define snprintf git_snprintf
556extern int git_snprintf(char *str, size_t maxsize,
557 const char *format, ...);
Benoit Sigoureab038032014-01-30 22:25:12 -0800558#ifdef vsnprintf
559#undef vsnprintf
560#endif
Michal Rokosc4582f92008-03-05 16:46:13 +0100561#define vsnprintf git_vsnprintf
562extern int git_vsnprintf(char *str, size_t maxsize,
563 const char *format, va_list ap);
564#endif
565
Johannes Sixt726c8ef2007-11-12 11:09:05 +0100566#ifdef __GLIBC_PREREQ
567#if __GLIBC_PREREQ(2, 1)
568#define HAVE_STRCHRNUL
Jonathan Nieder137c6ea2010-03-20 19:43:32 -0500569#define HAVE_MEMPCPY
Johannes Sixt726c8ef2007-11-12 11:09:05 +0100570#endif
571#endif
572
573#ifndef HAVE_STRCHRNUL
René Scharfe659c69c2007-11-09 01:49:36 +0100574#define strchrnul gitstrchrnul
Andreas Ericsson9e79f002007-11-10 12:55:48 +0100575static inline char *gitstrchrnul(const char *s, int c)
576{
577 while (*s && *s != c)
578 s++;
579 return (char *)s;
580}
René Scharfe659c69c2007-11-09 01:49:36 +0100581#endif
582
Jonathan Nieder137c6ea2010-03-20 19:43:32 -0500583#ifndef HAVE_MEMPCPY
584#define mempcpy gitmempcpy
585static inline void *gitmempcpy(void *dest, const void *src, size_t n)
586{
587 return (char *)memcpy(dest, src, n) + n;
588}
589#endif
590
Mike Papeda523cc2010-11-04 02:35:11 +0100591#ifdef NO_INET_PTON
592int inet_pton(int af, const char *src, void *dst);
593#endif
594
595#ifdef NO_INET_NTOP
596const char *inet_ntop(int af, const void *src, char *dst, size_t size);
597#endif
598
Etienne Buira0f4b6db2014-10-18 14:31:15 +0200599#ifdef NO_PTHREADS
600#define atexit git_atexit
601extern int git_atexit(void (*handler)(void));
602#endif
603
Brandon Casey7c3ecb32013-07-31 12:51:37 -0700604extern void release_pack_memory(size_t);
Shawn O. Pearce97bfeb32006-12-24 00:47:19 -0500605
Johannes Sixt851c34b2010-05-08 17:13:49 +0200606typedef void (*try_to_free_t)(size_t);
607extern try_to_free_t set_try_to_free_routine(try_to_free_t);
Nicolas Pitrea9a74632010-03-24 16:22:34 -0400608
Kirill Smelkov61f76a32014-03-27 18:22:50 +0400609#ifdef HAVE_ALLOCA_H
610# include <alloca.h>
611# define xalloca(size) (alloca(size))
612# define xalloca_free(p) do {} while (0)
613#else
614# define xalloca(size) (xmalloc(size))
615# define xalloca_free(p) (free(p))
616#endif
Linus Torvalds112db552008-06-22 12:19:25 -0700617extern char *xstrdup(const char *str);
618extern void *xmalloc(size_t size);
Ilari Liusvaara5bf92192010-01-26 20:24:12 +0200619extern void *xmallocz(size_t size);
Nguyễn Thái Ngọc Duyf8bb1d92014-08-16 10:08:02 +0700620extern void *xmallocz_gently(size_t size);
Linus Torvalds112db552008-06-22 12:19:25 -0700621extern void *xmemdupz(const void *data, size_t len);
622extern char *xstrndup(const char *str, size_t len);
623extern void *xrealloc(void *ptr, size_t size);
624extern void *xcalloc(size_t nmemb, size_t size);
625extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
626extern ssize_t xread(int fd, void *buf, size_t len);
627extern ssize_t xwrite(int fd, const void *buf, size_t len);
Yiannis Marangos9aa91af2014-04-10 21:54:12 +0300628extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
Linus Torvalds112db552008-06-22 12:19:25 -0700629extern int xdup(int fd);
630extern FILE *xfdopen(int fd, const char *mode);
631extern int xmkstemp(char *template);
Jonathan Nieder463db9b2010-11-06 06:45:38 -0500632extern int xmkstemp_mode(char *template, int mode);
Junio C Hamano6e180cd2009-02-24 23:11:29 -0800633extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
Nguyễn Thái Ngọc Duy8640d492014-03-16 20:35:00 +0700634extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
René Scharfeaa14e982014-07-28 20:29:50 +0200635extern char *xgetcwd(void);
Luiz Fernando N. Capitulinof21a47b2007-08-14 16:44:53 -0300636
René Scharfe3ac22f82014-09-16 20:56:48 +0200637#define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), (alloc) * sizeof(*(x)))
638
Shawn O. Pearcedc49cd72007-03-06 20:44:37 -0500639static inline size_t xsize_t(off_t len)
640{
Thomas Rast46be82d2010-07-28 18:36:31 +0200641 if (len > (size_t) len)
642 die("Cannot handle files this big");
Shawn O. Pearcedc49cd72007-03-06 20:44:37 -0500643 return (size_t)len;
644}
645
Ramsay Jonesf1589d12012-03-04 19:10:57 +0000646/* in ctype.c, for kwset users */
647extern const char tolower_trans_tbl[256];
648
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800649/* Sane ctype - no locale, and works with signed chars */
René Scharfec2e93642009-03-07 14:06:49 +0100650#undef isascii
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800651#undef isspace
652#undef isdigit
653#undef isalpha
654#undef isalnum
Jan H. Schönherr0fcec2c2012-10-18 16:43:32 +0200655#undef isprint
Namhyung Kim43ccdf52012-02-10 11:13:31 +0900656#undef islower
657#undef isupper
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800658#undef tolower
659#undef toupper
Nguyễn Thái Ngọc Duy1c149ab2012-10-15 13:25:51 +0700660#undef iscntrl
661#undef ispunct
662#undef isxdigit
Junio C Hamano2adf7242013-01-10 13:47:15 -0800663
Nguyễn Thái Ngọc Duyca5ab7d2012-10-15 13:25:50 +0700664extern const unsigned char sane_ctype[256];
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800665#define GIT_SPACE 0x01
666#define GIT_DIGIT 0x02
667#define GIT_ALPHA 0x04
René Scharfe8cc32992009-01-17 16:50:34 +0100668#define GIT_GLOB_SPECIAL 0x08
René Scharfef9b7cce2009-01-17 16:50:37 +0100669#define GIT_REGEX_SPECIAL 0x10
Junio C Hamano2f6c9762011-04-08 16:18:46 -0700670#define GIT_PATHSPEC_MAGIC 0x20
Nguyễn Thái Ngọc Duy1c149ab2012-10-15 13:25:51 +0700671#define GIT_CNTRL 0x40
672#define GIT_PUNCT 0x80
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800673#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
René Scharfec2e93642009-03-07 14:06:49 +0100674#define isascii(x) (((x) & ~0x7f) == 0)
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800675#define isspace(x) sane_istest(x,GIT_SPACE)
676#define isdigit(x) sane_istest(x,GIT_DIGIT)
677#define isalpha(x) sane_istest(x,GIT_ALPHA)
678#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
Jan H. Schönherr0fcec2c2012-10-18 16:43:32 +0200679#define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
Namhyung Kim43ccdf52012-02-10 11:13:31 +0900680#define islower(x) sane_iscase(x, 1)
681#define isupper(x) sane_iscase(x, 0)
René Scharfe8cc32992009-01-17 16:50:34 +0100682#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
René Scharfef9b7cce2009-01-17 16:50:37 +0100683#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
Nguyễn Thái Ngọc Duy1c149ab2012-10-15 13:25:51 +0700684#define iscntrl(x) (sane_istest(x,GIT_CNTRL))
685#define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
686 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
Jeff King50a71772014-10-15 18:34:05 -0400687#define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800688#define tolower(x) sane_case((unsigned char)(x), 0x20)
689#define toupper(x) sane_case((unsigned char)(x), 0)
Junio C Hamano2f6c9762011-04-08 16:18:46 -0700690#define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800691
692static inline int sane_case(int x, int high)
693{
694 if (sane_istest(x, GIT_ALPHA))
695 x = (x & ~0x20) | high;
696 return x;
697}
698
Namhyung Kim43ccdf52012-02-10 11:13:31 +0900699static inline int sane_iscase(int x, int is_lower)
700{
701 if (!sane_istest(x, GIT_ALPHA))
702 return 0;
703
704 if (is_lower)
705 return (x & 0x20) != 0;
706 else
707 return (x & 0x20) == 0;
708}
709
Jim Meyering6aead432007-04-10 01:01:44 +0200710static inline int strtoul_ui(char const *s, int base, unsigned int *result)
711{
712 unsigned long ul;
713 char *p;
714
715 errno = 0;
716 ul = strtoul(s, &p, base);
717 if (errno || *p || p == s || (unsigned int) ul != ul)
718 return -1;
719 *result = ul;
720 return 0;
721}
722
Junio C Hamano7791ecb2007-10-23 13:33:26 -0700723static inline int strtol_i(char const *s, int base, int *result)
724{
725 long ul;
726 char *p;
727
728 errno = 0;
729 ul = strtol(s, &p, base);
730 if (errno || *p || p == s || (int) ul != ul)
731 return -1;
732 *result = ul;
733 return 0;
734}
735
Brian Downing43fe9012008-02-05 15:10:44 -0600736#ifdef INTERNAL_QSORT
737void git_qsort(void *base, size_t nmemb, size_t size,
738 int(*compar)(const void *, const void *));
739#define qsort git_qsort
740#endif
741
Alex Riesen81a24b52008-03-05 00:15:39 +0100742#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
743# define FORCE_DIR_SET_GID S_ISGID
744#else
745# define FORCE_DIR_SET_GID 0
746#endif
747
Kjetil Barvikc06ff492009-03-04 18:47:40 +0100748#ifdef NO_NSEC
749#undef USE_NSEC
750#define ST_CTIME_NSEC(st) 0
751#define ST_MTIME_NSEC(st) 0
752#else
Brian Gernhardtc5673832009-03-08 16:04:28 -0400753#ifdef USE_ST_TIMESPEC
754#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
755#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
756#else
Kjetil Barvikc06ff492009-03-04 18:47:40 +0100757#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
758#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
759#endif
Brian Gernhardtc5673832009-03-08 16:04:28 -0400760#endif
Kjetil Barvikc06ff492009-03-04 18:47:40 +0100761
Johannes Sixt34779c52009-04-20 10:17:00 +0200762#ifdef UNRELIABLE_FSTAT
763#define fstat_is_reliable() 0
764#else
765#define fstat_is_reliable() 1
766#endif
767
Jeff Kingab8632a2011-02-25 23:08:25 -0600768#ifndef va_copy
Jonathan Nieder26db0f22011-03-08 02:33:44 -0600769/*
770 * Since an obvious implementation of va_list would be to make it a
771 * pointer into the stack frame, a simple assignment will work on
772 * many systems. But let's try to be more portable.
773 */
774#ifdef __va_copy
775#define va_copy(dst, src) __va_copy(dst, src)
776#else
777#define va_copy(dst, src) ((dst) = (src))
778#endif
Jeff Kingab8632a2011-02-25 23:08:25 -0600779#endif
780
David Michaelf51140c2014-10-26 13:33:12 -0400781#if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
Karsten Bleese05bed92014-07-12 02:05:03 +0200782#define HAVE_VARIADIC_MACROS 1
783#endif
784
Alex Riesenfc71db32009-04-29 23:21:46 +0200785/*
786 * Preserves errno, prints a message, but gives no warning for ENOENT.
Ronnie Sahlberg1054af72014-07-16 11:01:18 -0700787 * Returns 0 on success, which includes trying to unlink an object that does
788 * not exist.
Alex Riesenfc71db32009-04-29 23:21:46 +0200789 */
790int unlink_or_warn(const char *path);
Ronnie Sahlberg9ccc0c02014-07-16 11:20:36 -0700791 /*
792 * Tries to unlink file. Returns 0 if unlink succeeded
793 * or the file already didn't exist. Returns -1 and
794 * appends a message to err suitable for
795 * 'error("%s", err->buf)' on error.
796 */
797int unlink_or_msg(const char *file, struct strbuf *err);
Peter Collingbourned1723292010-03-26 15:25:33 +0000798/*
Ronnie Sahlberg1054af72014-07-16 11:01:18 -0700799 * Preserves errno, prints a message, but gives no warning for ENOENT.
800 * Returns 0 on success, which includes trying to remove a directory that does
801 * not exist.
Peter Collingbourned1723292010-03-26 15:25:33 +0000802 */
803int rmdir_or_warn(const char *path);
Peter Collingbourne80d706a2010-03-26 15:25:34 +0000804/*
805 * Calls the correct function out of {unlink,rmdir}_or_warn based on
806 * the supplied file mode.
807 */
808int remove_or_warn(unsigned int mode, const char *path);
Alex Riesenfc71db32009-04-29 23:21:46 +0200809
Jonathan Niedere5c52c92012-10-13 17:03:07 -0700810/*
811 * Call access(2), but warn for any error except "missing file"
812 * (ENOENT or ENOTDIR).
813 */
Jonathan Nieder4698c8f2013-04-12 14:03:18 -0700814#define ACCESS_EACCES_OK (1U << 0)
815int access_or_warn(const char *path, int mode, unsigned flag);
816int access_or_die(const char *path, int mode, unsigned flag);
Jeff Kingba8bd832012-08-21 02:10:59 -0400817
Junio C Hamano55b38a42012-08-21 14:52:07 -0700818/* Warn on an inaccessible file that ought to be accessible */
819void warn_on_inaccessible(const char *path);
820
Jeff King2f705872012-05-21 19:10:20 -0400821/* Get the passwd entry for the UID of the current process. */
822struct passwd *xgetpwuid_self(void);
823
Jeff King66547542014-04-01 17:28:42 -0400824#ifdef GMTIME_UNRELIABLE_ERRORS
825struct tm *git_gmtime(const time_t *);
826struct tm *git_gmtime_r(const time_t *, struct tm *);
827#define gmtime git_gmtime
828#define gmtime_r git_gmtime_r
829#endif
830
Junio C Hamano4050c0d2005-12-05 11:54:29 -0800831#endif