]>
Commit | Line | Data |
---|---|---|
bb742ede | 1 | /* |
359fc2d2 | 2 | * Copyright (C) the libgit2 contributors. All rights reserved. |
bb742ede VM |
3 | * |
4 | * This file is part of libgit2, distributed under the GNU GPL v2 with | |
5 | * a Linking Exception. For full terms see the included COPYING file. | |
6 | */ | |
ad5611d8 TR |
7 | #ifndef INCLUDE_git2_util_h__ |
8 | #define INCLUDE_git2_util_h__ | |
76a8c447 | 9 | |
eae0bfdc PP |
10 | #ifndef LIBGIT2_NO_FEATURES_H |
11 | # include "git2/sys/features.h" | |
12 | #endif | |
13 | ||
0657e46d | 14 | #include "git2/common.h" |
8a086f87 | 15 | #include "cc-compat.h" |
b3039bee | 16 | |
ad5611d8 TR |
17 | typedef struct git_str git_str; |
18 | ||
72556cc6 RB |
19 | /** Declare a function as always inlined. */ |
20 | #if defined(_MSC_VER) | |
21 | # define GIT_INLINE(type) static __inline type | |
ac3d33df JK |
22 | #elif defined(__GNUC__) |
23 | # define GIT_INLINE(type) static __inline__ type | |
72556cc6 | 24 | #else |
ac3d33df | 25 | # define GIT_INLINE(type) static type |
72556cc6 RB |
26 | #endif |
27 | ||
16942c6f ET |
28 | /** Support for gcc/clang __has_builtin intrinsic */ |
29 | #ifndef __has_builtin | |
30 | # define __has_builtin(x) 0 | |
31 | #endif | |
32 | ||
c25aa7cd PP |
33 | /** |
34 | * Declare that a function's return value must be used. | |
35 | * | |
36 | * Used mostly to guard against potential silent bugs at runtime. This is | |
37 | * recommended to be added to functions that: | |
38 | * | |
39 | * - Allocate / reallocate memory. This prevents memory leaks or errors where | |
40 | * buffers are expected to have grown to a certain size, but could not be | |
41 | * resized. | |
42 | * - Acquire locks. When a lock cannot be acquired, that will almost certainly | |
43 | * cause a data race / undefined behavior. | |
44 | */ | |
45 | #if defined(__GNUC__) | |
46 | # define GIT_WARN_UNUSED_RESULT __attribute__((warn_unused_result)) | |
47 | #else | |
48 | # define GIT_WARN_UNUSED_RESULT | |
49 | #endif | |
50 | ||
75d58430 | 51 | #include <assert.h> |
76a8c447 | 52 | #include <errno.h> |
028ef0de | 53 | #include <limits.h> |
76a8c447 | 54 | #include <stdlib.h> |
840fb8b7 | 55 | #include <stdio.h> |
76a8c447 AE |
56 | #include <string.h> |
57 | ||
840fb8b7 | 58 | #include <sys/types.h> |
90d4d2f0 | 59 | #include <sys/stat.h> |
840fb8b7 RJ |
60 | |
61 | #ifdef GIT_WIN32 | |
62 | ||
63 | # include <io.h> | |
502acd16 | 64 | # include <direct.h> |
ac8eac2f | 65 | # include <winsock2.h> |
79ca2edc | 66 | # include <windows.h> |
45df2237 | 67 | # include <ws2tcpip.h> |
678e9e04 VM |
68 | # include "win32/msvc-compat.h" |
69 | # include "win32/mingw-compat.h" | |
360dd4da | 70 | # include "win32/win32-compat.h" |
ad5611d8 | 71 | # include "win32/w32_common.h" |
5c5eeba6 | 72 | # include "win32/version.h" |
ad5611d8 | 73 | # include "win32/error.h" |
bb3de0c4 | 74 | # ifdef GIT_THREADS |
ad5611d8 | 75 | # include "win32/thread.h" |
5c5eeba6 | 76 | # endif |
79ca2edc | 77 | |
840fb8b7 | 78 | #else |
840fb8b7 | 79 | |
f443a72d | 80 | # include <unistd.h> |
6b05240c | 81 | # include <strings.h> |
bb3de0c4 | 82 | # ifdef GIT_THREADS |
87d9869f | 83 | # include <pthread.h> |
8a2834d3 | 84 | # include <sched.h> |
bb3de0c4 | 85 | # endif |
c25aa7cd PP |
86 | |
87 | #define GIT_LIBGIT2_CALL | |
88 | #define GIT_SYSTEM_CALL | |
97b71374 | 89 | |
9447b9e5 ET |
90 | #ifdef GIT_USE_STAT_ATIMESPEC |
91 | # define st_atim st_atimespec | |
92 | # define st_ctim st_ctimespec | |
93 | # define st_mtim st_mtimespec | |
94 | #endif | |
95 | ||
5588f073 ET |
96 | # include <arpa/inet.h> |
97 | ||
840fb8b7 RJ |
98 | #endif |
99 | ||
e52e38d3 | 100 | #include "git2/types.h" |
6810bf28 | 101 | #include "git2/errors.h" |
c25aa7cd | 102 | #include "thread.h" |
190b76a6 | 103 | #include "integer.h" |
22a2d3d5 | 104 | #include "assert_safe.h" |
ac3d33df | 105 | |
22a2d3d5 | 106 | #include "posix.h" |
dda708e7 | 107 | |
ad5611d8 TR |
108 | #define GIT_BUFSIZE_DEFAULT 65536 |
109 | #define GIT_BUFSIZE_FILEIO GIT_BUFSIZE_DEFAULT | |
110 | #define GIT_BUFSIZE_FILTERIO GIT_BUFSIZE_DEFAULT | |
111 | #define GIT_BUFSIZE_NETIO GIT_BUFSIZE_DEFAULT | |
112 | ||
7dd22538 | 113 | |
1a628100 RB |
114 | /** |
115 | * Check a pointer allocation result, returning -1 if it failed. | |
116 | */ | |
e579e0f7 MB |
117 | #define GIT_ERROR_CHECK_ALLOC(ptr) do { \ |
118 | if ((ptr) == NULL) { return -1; } \ | |
119 | } while(0) | |
dda708e7 | 120 | |
859ed5dd | 121 | /** |
ad5611d8 | 122 | * Check a buffer allocation result, returning -1 if it failed. |
859ed5dd | 123 | */ |
e579e0f7 MB |
124 | #define GIT_ERROR_CHECK_ALLOC_STR(buf) do { \ |
125 | if ((void *)(buf) == NULL || git_str_oom(buf)) { return -1; } \ | |
126 | } while(0) | |
859ed5dd | 127 | |
5540d947 | 128 | /** |
b874629b | 129 | * Check a return value and propagate result if non-zero. |
5540d947 | 130 | */ |
ac3d33df | 131 | #define GIT_ERROR_CHECK_ERROR(code) \ |
25e0b157 | 132 | do { int _err = (code); if (_err) return _err; } while (0) |
5540d947 | 133 | |
190b76a6 | 134 | |
f1453c59 ET |
135 | /** Check for additive overflow, setting an error if would occur. */ |
136 | #define GIT_ADD_SIZET_OVERFLOW(out, one, two) \ | |
ac3d33df | 137 | (git__add_sizet_overflow(out, one, two) ? (git_error_set_oom(), 1) : 0) |
392702ee | 138 | |
f1453c59 ET |
139 | /** Check for additive overflow, setting an error if would occur. */ |
140 | #define GIT_MULTIPLY_SIZET_OVERFLOW(out, nelem, elsize) \ | |
ac3d33df | 141 | (git__multiply_sizet_overflow(out, nelem, elsize) ? (git_error_set_oom(), 1) : 0) |
392702ee ET |
142 | |
143 | /** Check for additive overflow, failing if it would occur. */ | |
ac3d33df | 144 | #define GIT_ERROR_CHECK_ALLOC_ADD(out, one, two) \ |
f1453c59 | 145 | if (GIT_ADD_SIZET_OVERFLOW(out, one, two)) { return -1; } |
392702ee | 146 | |
ac3d33df | 147 | #define GIT_ERROR_CHECK_ALLOC_ADD3(out, one, two, three) \ |
4bc9b74c ET |
148 | if (GIT_ADD_SIZET_OVERFLOW(out, one, two) || \ |
149 | GIT_ADD_SIZET_OVERFLOW(out, *(out), three)) { return -1; } | |
150 | ||
ac3d33df | 151 | #define GIT_ERROR_CHECK_ALLOC_ADD4(out, one, two, three, four) \ |
4bc9b74c ET |
152 | if (GIT_ADD_SIZET_OVERFLOW(out, one, two) || \ |
153 | GIT_ADD_SIZET_OVERFLOW(out, *(out), three) || \ | |
154 | GIT_ADD_SIZET_OVERFLOW(out, *(out), four)) { return -1; } | |
155 | ||
ac3d33df | 156 | #define GIT_ERROR_CHECK_ALLOC_ADD5(out, one, two, three, four, five) \ |
eae0bfdc PP |
157 | if (GIT_ADD_SIZET_OVERFLOW(out, one, two) || \ |
158 | GIT_ADD_SIZET_OVERFLOW(out, *(out), three) || \ | |
159 | GIT_ADD_SIZET_OVERFLOW(out, *(out), four) || \ | |
160 | GIT_ADD_SIZET_OVERFLOW(out, *(out), five)) { return -1; } | |
161 | ||
392702ee | 162 | /** Check for multiplicative overflow, failing if it would occur. */ |
ac3d33df | 163 | #define GIT_ERROR_CHECK_ALLOC_MULTIPLY(out, nelem, elsize) \ |
f1453c59 | 164 | if (GIT_MULTIPLY_SIZET_OVERFLOW(out, nelem, elsize)) { return -1; } |
392702ee | 165 | |
3f53c971 VM |
166 | #include "util.h" |
167 | ||
eae0bfdc | 168 | #endif |