Add platform files for porting to MSVC
[git/git.git] / git-compat-util.h
1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
3
4 #define _FILE_OFFSET_BITS 64
5
6 #ifndef FLEX_ARRAY
7 /*
8 * See if our compiler is known to support flexible array members.
9 */
10 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
11 # 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
25 #endif
26 #endif
27
28 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
29 #define bitsizeof(x) (CHAR_BIT * sizeof(x))
30
31 #ifdef __GNUC__
32 #define TYPEOF(x) (__typeof__(x))
33 #else
34 #define TYPEOF(x)
35 #endif
36
37 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
38 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
39
40 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
41
42 /* Approximation of the length of the decimal representation of this type. */
43 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
44
45 #if defined(__sun__)
46 /*
47 * On Solaris, when _XOPEN_EXTENDED is set, its header file
48 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
49 * setting to say we are XPG5 or XPG6. Also on Solaris,
50 * XPG6 programs must be compiled with a c99 compiler, while
51 * non XPG6 programs must be compiled with a pre-c99 compiler.
52 */
53 # if __STDC_VERSION__ - 0 >= 199901L
54 # define _XOPEN_SOURCE 600
55 # else
56 # define _XOPEN_SOURCE 500
57 # endif
58 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && !defined(_M_UNIX) && !defined(sgi)
59 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
60 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
61 #endif
62 #define _ALL_SOURCE 1
63 #define _GNU_SOURCE 1
64 #define _BSD_SOURCE 1
65 #define _NETBSD_SOURCE 1
66 #define _SGI_SOURCE 1
67
68 #include <unistd.h>
69 #include <stdio.h>
70 #include <sys/stat.h>
71 #include <fcntl.h>
72 #include <stddef.h>
73 #include <stdlib.h>
74 #include <stdarg.h>
75 #include <string.h>
76 #include <errno.h>
77 #include <limits.h>
78 #include <sys/param.h>
79 #include <sys/types.h>
80 #include <dirent.h>
81 #include <sys/time.h>
82 #include <time.h>
83 #include <signal.h>
84 #include <fnmatch.h>
85 #include <assert.h>
86 #include <regex.h>
87 #include <utime.h>
88 #ifndef __MINGW32__
89 #include <sys/wait.h>
90 #include <sys/poll.h>
91 #include <sys/socket.h>
92 #include <sys/ioctl.h>
93 #ifndef NO_SYS_SELECT_H
94 #include <sys/select.h>
95 #endif
96 #include <netinet/in.h>
97 #include <netinet/tcp.h>
98 #include <arpa/inet.h>
99 #include <netdb.h>
100 #include <pwd.h>
101 #include <inttypes.h>
102 #if defined(__CYGWIN__)
103 #undef _XOPEN_SOURCE
104 #include <grp.h>
105 #define _XOPEN_SOURCE 600
106 #include "compat/cygwin.h"
107 #else
108 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
109 #include <grp.h>
110 #define _ALL_SOURCE 1
111 #endif
112 #else /* __MINGW32__ */
113 /* pull in Windows compatibility stuff */
114 #include "compat/mingw.h"
115 #endif /* __MINGW32__ */
116 #ifdef _MSC_VER
117 #include "compat/msvc.h"
118 #endif
119
120 #ifndef NO_LIBGEN_H
121 #include <libgen.h>
122 #else
123 #define basename gitbasename
124 extern char *gitbasename(char *);
125 #endif
126
127 #ifndef NO_ICONV
128 #include <iconv.h>
129 #endif
130
131 #ifndef NO_OPENSSL
132 #include <openssl/ssl.h>
133 #include <openssl/err.h>
134 #endif
135
136 /* On most systems <limits.h> would have given us this, but
137 * not on some systems (e.g. GNU/Hurd).
138 */
139 #ifndef PATH_MAX
140 #define PATH_MAX 4096
141 #endif
142
143 #ifndef PRIuMAX
144 #define PRIuMAX "llu"
145 #endif
146
147 #ifndef PRIu32
148 #define PRIu32 "u"
149 #endif
150
151 #ifndef PRIx32
152 #define PRIx32 "x"
153 #endif
154
155 #ifndef PATH_SEP
156 #define PATH_SEP ':'
157 #endif
158
159 #ifndef STRIP_EXTENSION
160 #define STRIP_EXTENSION ""
161 #endif
162
163 #ifndef has_dos_drive_prefix
164 #define has_dos_drive_prefix(path) 0
165 #endif
166
167 #ifndef is_dir_sep
168 #define is_dir_sep(c) ((c) == '/')
169 #endif
170
171 #ifdef __GNUC__
172 #define NORETURN __attribute__((__noreturn__))
173 #else
174 #define NORETURN
175 #ifndef __attribute__
176 #define __attribute__(x)
177 #endif
178 #endif
179
180 #include "compat/bswap.h"
181
182 /* General helper functions */
183 extern void usage(const char *err) NORETURN;
184 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
185 extern void die_errno(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
186 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
187 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
188
189 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
190
191 extern int prefixcmp(const char *str, const char *prefix);
192 extern time_t tm_to_time_t(const struct tm *tm);
193
194 static inline const char *skip_prefix(const char *str, const char *prefix)
195 {
196 size_t len = strlen(prefix);
197 return strncmp(str, prefix, len) ? NULL : str + len;
198 }
199
200 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
201
202 #ifndef PROT_READ
203 #define PROT_READ 1
204 #define PROT_WRITE 2
205 #define MAP_PRIVATE 1
206 #define MAP_FAILED ((void*)-1)
207 #endif
208
209 #define mmap git_mmap
210 #define munmap git_munmap
211 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
212 extern int git_munmap(void *start, size_t length);
213
214 #else /* NO_MMAP || USE_WIN32_MMAP */
215
216 #include <sys/mman.h>
217
218 #endif /* NO_MMAP || USE_WIN32_MMAP */
219
220 #ifdef NO_MMAP
221
222 /* This value must be multiple of (pagesize * 2) */
223 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
224
225 #else /* NO_MMAP */
226
227 /* This value must be multiple of (pagesize * 2) */
228 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
229 (sizeof(void*) >= 8 \
230 ? 1 * 1024 * 1024 * 1024 \
231 : 32 * 1024 * 1024)
232
233 #endif /* NO_MMAP */
234
235 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
236 #define on_disk_bytes(st) ((st).st_size)
237 #else
238 #define on_disk_bytes(st) ((st).st_blocks * 512)
239 #endif
240
241 #define DEFAULT_PACKED_GIT_LIMIT \
242 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
243
244 #ifdef NO_PREAD
245 #define pread git_pread
246 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
247 #endif
248 /*
249 * Forward decl that will remind us if its twin in cache.h changes.
250 * This function is used in compat/pread.c. But we can't include
251 * cache.h there.
252 */
253 extern ssize_t read_in_full(int fd, void *buf, size_t count);
254
255 #ifdef NO_SETENV
256 #define setenv gitsetenv
257 extern int gitsetenv(const char *, const char *, int);
258 #endif
259
260 #ifdef NO_MKDTEMP
261 #define mkdtemp gitmkdtemp
262 extern char *gitmkdtemp(char *);
263 #endif
264
265 #ifdef NO_MKSTEMPS
266 #define mkstemps gitmkstemps
267 extern int gitmkstemps(char *, int);
268 #endif
269
270 #ifdef NO_UNSETENV
271 #define unsetenv gitunsetenv
272 extern void gitunsetenv(const char *);
273 #endif
274
275 #ifdef NO_STRCASESTR
276 #define strcasestr gitstrcasestr
277 extern char *gitstrcasestr(const char *haystack, const char *needle);
278 #endif
279
280 #ifdef NO_STRLCPY
281 #define strlcpy gitstrlcpy
282 extern size_t gitstrlcpy(char *, const char *, size_t);
283 #endif
284
285 #ifdef NO_STRTOUMAX
286 #define strtoumax gitstrtoumax
287 extern uintmax_t gitstrtoumax(const char *, char **, int);
288 #endif
289
290 #ifdef NO_HSTRERROR
291 #define hstrerror githstrerror
292 extern const char *githstrerror(int herror);
293 #endif
294
295 #ifdef NO_MEMMEM
296 #define memmem gitmemmem
297 void *gitmemmem(const void *haystack, size_t haystacklen,
298 const void *needle, size_t needlelen);
299 #endif
300
301 #ifdef FREAD_READS_DIRECTORIES
302 #ifdef fopen
303 #undef fopen
304 #endif
305 #define fopen(a,b) git_fopen(a,b)
306 extern FILE *git_fopen(const char*, const char*);
307 #endif
308
309 #ifdef SNPRINTF_RETURNS_BOGUS
310 #define snprintf git_snprintf
311 extern int git_snprintf(char *str, size_t maxsize,
312 const char *format, ...);
313 #define vsnprintf git_vsnprintf
314 extern int git_vsnprintf(char *str, size_t maxsize,
315 const char *format, va_list ap);
316 #endif
317
318 #ifdef __GLIBC_PREREQ
319 #if __GLIBC_PREREQ(2, 1)
320 #define HAVE_STRCHRNUL
321 #endif
322 #endif
323
324 #ifndef HAVE_STRCHRNUL
325 #define strchrnul gitstrchrnul
326 static inline char *gitstrchrnul(const char *s, int c)
327 {
328 while (*s && *s != c)
329 s++;
330 return (char *)s;
331 }
332 #endif
333
334 extern void release_pack_memory(size_t, int);
335
336 extern char *xstrdup(const char *str);
337 extern void *xmalloc(size_t size);
338 extern void *xmemdupz(const void *data, size_t len);
339 extern char *xstrndup(const char *str, size_t len);
340 extern void *xrealloc(void *ptr, size_t size);
341 extern void *xcalloc(size_t nmemb, size_t size);
342 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
343 extern ssize_t xread(int fd, void *buf, size_t len);
344 extern ssize_t xwrite(int fd, const void *buf, size_t len);
345 extern int xdup(int fd);
346 extern FILE *xfdopen(int fd, const char *mode);
347 extern int xmkstemp(char *template);
348 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
349 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
350
351 static inline size_t xsize_t(off_t len)
352 {
353 return (size_t)len;
354 }
355
356 static inline int has_extension(const char *filename, const char *ext)
357 {
358 size_t len = strlen(filename);
359 size_t extlen = strlen(ext);
360 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
361 }
362
363 /* Sane ctype - no locale, and works with signed chars */
364 #undef isascii
365 #undef isspace
366 #undef isdigit
367 #undef isalpha
368 #undef isalnum
369 #undef tolower
370 #undef toupper
371 extern unsigned char sane_ctype[256];
372 #define GIT_SPACE 0x01
373 #define GIT_DIGIT 0x02
374 #define GIT_ALPHA 0x04
375 #define GIT_GLOB_SPECIAL 0x08
376 #define GIT_REGEX_SPECIAL 0x10
377 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
378 #define isascii(x) (((x) & ~0x7f) == 0)
379 #define isspace(x) sane_istest(x,GIT_SPACE)
380 #define isdigit(x) sane_istest(x,GIT_DIGIT)
381 #define isalpha(x) sane_istest(x,GIT_ALPHA)
382 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
383 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
384 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
385 #define tolower(x) sane_case((unsigned char)(x), 0x20)
386 #define toupper(x) sane_case((unsigned char)(x), 0)
387
388 static inline int sane_case(int x, int high)
389 {
390 if (sane_istest(x, GIT_ALPHA))
391 x = (x & ~0x20) | high;
392 return x;
393 }
394
395 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
396 {
397 unsigned long ul;
398 char *p;
399
400 errno = 0;
401 ul = strtoul(s, &p, base);
402 if (errno || *p || p == s || (unsigned int) ul != ul)
403 return -1;
404 *result = ul;
405 return 0;
406 }
407
408 static inline int strtol_i(char const *s, int base, int *result)
409 {
410 long ul;
411 char *p;
412
413 errno = 0;
414 ul = strtol(s, &p, base);
415 if (errno || *p || p == s || (int) ul != ul)
416 return -1;
417 *result = ul;
418 return 0;
419 }
420
421 #ifdef INTERNAL_QSORT
422 void git_qsort(void *base, size_t nmemb, size_t size,
423 int(*compar)(const void *, const void *));
424 #define qsort git_qsort
425 #endif
426
427 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
428 # define FORCE_DIR_SET_GID S_ISGID
429 #else
430 # define FORCE_DIR_SET_GID 0
431 #endif
432
433 #ifdef NO_NSEC
434 #undef USE_NSEC
435 #define ST_CTIME_NSEC(st) 0
436 #define ST_MTIME_NSEC(st) 0
437 #else
438 #ifdef USE_ST_TIMESPEC
439 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
440 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
441 #else
442 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
443 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
444 #endif
445 #endif
446
447 #ifdef UNRELIABLE_FSTAT
448 #define fstat_is_reliable() 0
449 #else
450 #define fstat_is_reliable() 1
451 #endif
452
453 /*
454 * Preserves errno, prints a message, but gives no warning for ENOENT.
455 * Always returns the return value of unlink(2).
456 */
457 int unlink_or_warn(const char *path);
458
459 #endif