util.h 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405
  1. #ifndef GIT_COMPAT_UTIL_H
  2. #define GIT_COMPAT_UTIL_H
  3. #define _FILE_OFFSET_BITS 64
  4. #ifndef FLEX_ARRAY
  5. /*
  6. * See if our compiler is known to support flexible array members.
  7. */
  8. #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
  9. # define FLEX_ARRAY /* empty */
  10. #elif defined(__GNUC__)
  11. # if (__GNUC__ >= 3)
  12. # define FLEX_ARRAY /* empty */
  13. # else
  14. # define FLEX_ARRAY 0 /* older GNU extension */
  15. # endif
  16. #endif
  17. /*
  18. * Otherwise, default to safer but a bit wasteful traditional style
  19. */
  20. #ifndef FLEX_ARRAY
  21. # define FLEX_ARRAY 1
  22. #endif
  23. #endif
  24. #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
  25. #ifdef __GNUC__
  26. #define TYPEOF(x) (__typeof__(x))
  27. #else
  28. #define TYPEOF(x)
  29. #endif
  30. #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
  31. #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
  32. /* Approximation of the length of the decimal representation of this type. */
  33. #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
  34. #define _ALL_SOURCE 1
  35. #define _GNU_SOURCE 1
  36. #define _BSD_SOURCE 1
  37. #include <unistd.h>
  38. #include <stdio.h>
  39. #include <sys/stat.h>
  40. #include <sys/statfs.h>
  41. #include <fcntl.h>
  42. #include <stddef.h>
  43. #include <stdlib.h>
  44. #include <stdarg.h>
  45. #include <string.h>
  46. #include <errno.h>
  47. #include <limits.h>
  48. #include <sys/param.h>
  49. #include <sys/types.h>
  50. #include <dirent.h>
  51. #include <sys/time.h>
  52. #include <time.h>
  53. #include <signal.h>
  54. #include <fnmatch.h>
  55. #include <assert.h>
  56. #include <regex.h>
  57. #include <utime.h>
  58. #include <sys/wait.h>
  59. #include <sys/poll.h>
  60. #include <sys/socket.h>
  61. #include <sys/ioctl.h>
  62. #ifndef NO_SYS_SELECT_H
  63. #include <sys/select.h>
  64. #endif
  65. #include <netinet/in.h>
  66. #include <netinet/tcp.h>
  67. #include <arpa/inet.h>
  68. #include <netdb.h>
  69. #include <pwd.h>
  70. #include <inttypes.h>
  71. #include "../../../include/linux/magic.h"
  72. #ifndef NO_ICONV
  73. #include <iconv.h>
  74. #endif
  75. /* On most systems <limits.h> would have given us this, but
  76. * not on some systems (e.g. GNU/Hurd).
  77. */
  78. #ifndef PATH_MAX
  79. #define PATH_MAX 4096
  80. #endif
  81. #ifndef PRIuMAX
  82. #define PRIuMAX "llu"
  83. #endif
  84. #ifndef PRIu32
  85. #define PRIu32 "u"
  86. #endif
  87. #ifndef PRIx32
  88. #define PRIx32 "x"
  89. #endif
  90. #ifndef PATH_SEP
  91. #define PATH_SEP ':'
  92. #endif
  93. #ifndef STRIP_EXTENSION
  94. #define STRIP_EXTENSION ""
  95. #endif
  96. #ifndef has_dos_drive_prefix
  97. #define has_dos_drive_prefix(path) 0
  98. #endif
  99. #ifndef is_dir_sep
  100. #define is_dir_sep(c) ((c) == '/')
  101. #endif
  102. #ifdef __GNUC__
  103. #define NORETURN __attribute__((__noreturn__))
  104. #else
  105. #define NORETURN
  106. #ifndef __attribute__
  107. #define __attribute__(x)
  108. #endif
  109. #endif
  110. /* General helper functions */
  111. extern void usage(const char *err) NORETURN;
  112. extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
  113. extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
  114. extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
  115. #include "../../../include/linux/stringify.h"
  116. #define DIE_IF(cnd) \
  117. do { if (cnd) \
  118. die(" at (" __FILE__ ":" __stringify(__LINE__) "): " \
  119. __stringify(cnd) "\n"); \
  120. } while (0)
  121. extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
  122. extern int prefixcmp(const char *str, const char *prefix);
  123. extern time_t tm_to_time_t(const struct tm *tm);
  124. static inline const char *skip_prefix(const char *str, const char *prefix)
  125. {
  126. size_t len = strlen(prefix);
  127. return strncmp(str, prefix, len) ? NULL : str + len;
  128. }
  129. #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
  130. #ifndef PROT_READ
  131. #define PROT_READ 1
  132. #define PROT_WRITE 2
  133. #define MAP_PRIVATE 1
  134. #define MAP_FAILED ((void*)-1)
  135. #endif
  136. #define mmap git_mmap
  137. #define munmap git_munmap
  138. extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
  139. extern int git_munmap(void *start, size_t length);
  140. #else /* NO_MMAP || USE_WIN32_MMAP */
  141. #include <sys/mman.h>
  142. #endif /* NO_MMAP || USE_WIN32_MMAP */
  143. #ifdef NO_MMAP
  144. /* This value must be multiple of (pagesize * 2) */
  145. #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
  146. #else /* NO_MMAP */
  147. /* This value must be multiple of (pagesize * 2) */
  148. #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
  149. (sizeof(void*) >= 8 \
  150. ? 1 * 1024 * 1024 * 1024 \
  151. : 32 * 1024 * 1024)
  152. #endif /* NO_MMAP */
  153. #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
  154. #define on_disk_bytes(st) ((st).st_size)
  155. #else
  156. #define on_disk_bytes(st) ((st).st_blocks * 512)
  157. #endif
  158. #define DEFAULT_PACKED_GIT_LIMIT \
  159. ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
  160. #ifdef NO_PREAD
  161. #define pread git_pread
  162. extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
  163. #endif
  164. /*
  165. * Forward decl that will remind us if its twin in cache.h changes.
  166. * This function is used in compat/pread.c. But we can't include
  167. * cache.h there.
  168. */
  169. extern ssize_t read_in_full(int fd, void *buf, size_t count);
  170. #ifdef NO_SETENV
  171. #define setenv gitsetenv
  172. extern int gitsetenv(const char *, const char *, int);
  173. #endif
  174. #ifdef NO_MKDTEMP
  175. #define mkdtemp gitmkdtemp
  176. extern char *gitmkdtemp(char *);
  177. #endif
  178. #ifdef NO_UNSETENV
  179. #define unsetenv gitunsetenv
  180. extern void gitunsetenv(const char *);
  181. #endif
  182. #ifdef NO_STRCASESTR
  183. #define strcasestr gitstrcasestr
  184. extern char *gitstrcasestr(const char *haystack, const char *needle);
  185. #endif
  186. #ifdef NO_STRLCPY
  187. #define strlcpy gitstrlcpy
  188. extern size_t gitstrlcpy(char *, const char *, size_t);
  189. #endif
  190. #ifdef NO_STRTOUMAX
  191. #define strtoumax gitstrtoumax
  192. extern uintmax_t gitstrtoumax(const char *, char **, int);
  193. #endif
  194. #ifdef NO_HSTRERROR
  195. #define hstrerror githstrerror
  196. extern const char *githstrerror(int herror);
  197. #endif
  198. #ifdef NO_MEMMEM
  199. #define memmem gitmemmem
  200. void *gitmemmem(const void *haystack, size_t haystacklen,
  201. const void *needle, size_t needlelen);
  202. #endif
  203. #ifdef FREAD_READS_DIRECTORIES
  204. #ifdef fopen
  205. #undef fopen
  206. #endif
  207. #define fopen(a,b) git_fopen(a,b)
  208. extern FILE *git_fopen(const char*, const char*);
  209. #endif
  210. #ifdef SNPRINTF_RETURNS_BOGUS
  211. #define snprintf git_snprintf
  212. extern int git_snprintf(char *str, size_t maxsize,
  213. const char *format, ...);
  214. #define vsnprintf git_vsnprintf
  215. extern int git_vsnprintf(char *str, size_t maxsize,
  216. const char *format, va_list ap);
  217. #endif
  218. #ifdef __GLIBC_PREREQ
  219. #if __GLIBC_PREREQ(2, 1)
  220. #define HAVE_STRCHRNUL
  221. #endif
  222. #endif
  223. #ifndef HAVE_STRCHRNUL
  224. #define strchrnul gitstrchrnul
  225. static inline char *gitstrchrnul(const char *s, int c)
  226. {
  227. while (*s && *s != c)
  228. s++;
  229. return (char *)s;
  230. }
  231. #endif
  232. /*
  233. * Wrappers:
  234. */
  235. extern char *xstrdup(const char *str);
  236. extern void *xmalloc(size_t size);
  237. extern void *xmemdupz(const void *data, size_t len);
  238. extern char *xstrndup(const char *str, size_t len);
  239. extern void *xrealloc(void *ptr, size_t size);
  240. extern void *xcalloc(size_t nmemb, size_t size);
  241. extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
  242. extern ssize_t xread(int fd, void *buf, size_t len);
  243. extern ssize_t xwrite(int fd, const void *buf, size_t len);
  244. extern int xdup(int fd);
  245. extern FILE *xfdopen(int fd, const char *mode);
  246. extern int xmkstemp(char *template);
  247. static inline size_t xsize_t(off_t len)
  248. {
  249. return (size_t)len;
  250. }
  251. static inline int has_extension(const char *filename, const char *ext)
  252. {
  253. size_t len = strlen(filename);
  254. size_t extlen = strlen(ext);
  255. return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
  256. }
  257. /* Sane ctype - no locale, and works with signed chars */
  258. #undef isascii
  259. #undef isspace
  260. #undef isdigit
  261. #undef isxdigit
  262. #undef isalpha
  263. #undef isprint
  264. #undef isalnum
  265. #undef tolower
  266. #undef toupper
  267. extern unsigned char sane_ctype[256];
  268. #define GIT_SPACE 0x01
  269. #define GIT_DIGIT 0x02
  270. #define GIT_ALPHA 0x04
  271. #define GIT_GLOB_SPECIAL 0x08
  272. #define GIT_REGEX_SPECIAL 0x10
  273. #define GIT_PRINT_EXTRA 0x20
  274. #define GIT_PRINT 0x3E
  275. #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
  276. #define isascii(x) (((x) & ~0x7f) == 0)
  277. #define isspace(x) sane_istest(x,GIT_SPACE)
  278. #define isdigit(x) sane_istest(x,GIT_DIGIT)
  279. #define isxdigit(x) \
  280. (sane_istest(toupper(x), GIT_ALPHA | GIT_DIGIT) && toupper(x) < 'G')
  281. #define isalpha(x) sane_istest(x,GIT_ALPHA)
  282. #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
  283. #define isprint(x) sane_istest(x,GIT_PRINT)
  284. #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
  285. #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
  286. #define tolower(x) sane_case((unsigned char)(x), 0x20)
  287. #define toupper(x) sane_case((unsigned char)(x), 0)
  288. static inline int sane_case(int x, int high)
  289. {
  290. if (sane_istest(x, GIT_ALPHA))
  291. x = (x & ~0x20) | high;
  292. return x;
  293. }
  294. static inline int strtoul_ui(char const *s, int base, unsigned int *result)
  295. {
  296. unsigned long ul;
  297. char *p;
  298. errno = 0;
  299. ul = strtoul(s, &p, base);
  300. if (errno || *p || p == s || (unsigned int) ul != ul)
  301. return -1;
  302. *result = ul;
  303. return 0;
  304. }
  305. static inline int strtol_i(char const *s, int base, int *result)
  306. {
  307. long ul;
  308. char *p;
  309. errno = 0;
  310. ul = strtol(s, &p, base);
  311. if (errno || *p || p == s || (int) ul != ul)
  312. return -1;
  313. *result = ul;
  314. return 0;
  315. }
  316. #ifdef INTERNAL_QSORT
  317. void git_qsort(void *base, size_t nmemb, size_t size,
  318. int(*compar)(const void *, const void *));
  319. #define qsort git_qsort
  320. #endif
  321. #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
  322. # define FORCE_DIR_SET_GID S_ISGID
  323. #else
  324. # define FORCE_DIR_SET_GID 0
  325. #endif
  326. #ifdef NO_NSEC
  327. #undef USE_NSEC
  328. #define ST_CTIME_NSEC(st) 0
  329. #define ST_MTIME_NSEC(st) 0
  330. #else
  331. #ifdef USE_ST_TIMESPEC
  332. #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
  333. #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
  334. #else
  335. #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
  336. #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
  337. #endif
  338. #endif
  339. #endif