]>
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 | */ | |
76a8c447 AE |
7 | #ifndef INCLUDE_common_h__ |
8 | #define INCLUDE_common_h__ | |
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 | |
72556cc6 RB |
17 | /** Declare a function as always inlined. */ |
18 | #if defined(_MSC_VER) | |
19 | # define GIT_INLINE(type) static __inline type | |
ac3d33df JK |
20 | #elif defined(__GNUC__) |
21 | # define GIT_INLINE(type) static __inline__ type | |
c25aa7cd PP |
22 | #elif defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) |
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" | |
22a2d3d5 | 70 | # include "win32/w32_common.h" |
360dd4da | 71 | # include "win32/win32-compat.h" |
c70455c7 | 72 | # include "win32/error.h" |
5c5eeba6 | 73 | # include "win32/version.h" |
bb3de0c4 | 74 | # ifdef GIT_THREADS |
8aaa9fb6 | 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" |
22a2d3d5 | 102 | #include "errors.h" |
c25aa7cd | 103 | #include "thread.h" |
190b76a6 | 104 | #include "integer.h" |
22a2d3d5 | 105 | #include "assert_safe.h" |
c25aa7cd | 106 | #include "utf8.h" |
5ee2fe77 | 107 | |
ac3d33df JK |
108 | /* |
109 | * Include the declarations for deprecated functions; this ensures | |
110 | * that they're decorated with the proper extern/visibility attributes. | |
111 | */ | |
112 | #include "git2/deprecated.h" | |
113 | ||
22a2d3d5 | 114 | #include "posix.h" |
dda708e7 | 115 | |
7dd22538 W |
116 | #define DEFAULT_BUFSIZE 65536 |
117 | #define FILEIO_BUFSIZE DEFAULT_BUFSIZE | |
118 | #define FILTERIO_BUFSIZE DEFAULT_BUFSIZE | |
119 | #define NETIO_BUFSIZE DEFAULT_BUFSIZE | |
120 | ||
1a628100 RB |
121 | /** |
122 | * Check a pointer allocation result, returning -1 if it failed. | |
123 | */ | |
ac3d33df | 124 | #define GIT_ERROR_CHECK_ALLOC(ptr) if (ptr == NULL) { return -1; } |
dda708e7 | 125 | |
859ed5dd PS |
126 | /** |
127 | * Check a buffer allocation result, returning -1 if it failed. | |
128 | */ | |
ac3d33df | 129 | #define GIT_ERROR_CHECK_ALLOC_BUF(buf) if ((void *)(buf) == NULL || git_buf_oom(buf)) { return -1; } |
859ed5dd | 130 | |
5540d947 | 131 | /** |
b874629b | 132 | * Check a return value and propagate result if non-zero. |
5540d947 | 133 | */ |
ac3d33df | 134 | #define GIT_ERROR_CHECK_ERROR(code) \ |
25e0b157 | 135 | do { int _err = (code); if (_err) return _err; } while (0) |
5540d947 | 136 | |
c7231c45 BS |
137 | /** |
138 | * Check a versioned structure for validity | |
139 | */ | |
ac3d33df | 140 | GIT_INLINE(int) git_error__check_version(const void *structure, unsigned int expected_max, const char *name) |
c7231c45 | 141 | { |
43efaabd | 142 | unsigned int actual; |
8ff66112 | 143 | |
c7231c45 | 144 | if (!structure) |
bf192cdb | 145 | return 0; |
c7231c45 | 146 | |
43efaabd | 147 | actual = *(const unsigned int*)structure; |
c7231c45 | 148 | if (actual > 0 && actual <= expected_max) |
bf192cdb | 149 | return 0; |
c7231c45 | 150 | |
ac3d33df | 151 | git_error_set(GIT_ERROR_INVALID, "invalid version %d on %s", actual, name); |
bf192cdb | 152 | return -1; |
c7231c45 | 153 | } |
ac3d33df | 154 | #define GIT_ERROR_CHECK_VERSION(S,V,N) if (git_error__check_version(S,V,N) < 0) return -1 |
c7231c45 | 155 | |
0ab3a2ab BS |
156 | /** |
157 | * Initialize a structure with a version. | |
158 | */ | |
159 | GIT_INLINE(void) git__init_structure(void *structure, size_t len, unsigned int version) | |
160 | { | |
161 | memset(structure, 0, len); | |
162 | *((int*)structure) = version; | |
163 | } | |
164 | #define GIT_INIT_STRUCTURE(S,V) git__init_structure(S, sizeof(*S), V) | |
165 | ||
702efc89 RB |
166 | #define GIT_INIT_STRUCTURE_FROM_TEMPLATE(PTR,VERSION,TYPE,TPL) do { \ |
167 | TYPE _tmpl = TPL; \ | |
ac3d33df | 168 | GIT_ERROR_CHECK_VERSION(&(VERSION), _tmpl.version, #TYPE); \ |
702efc89 RB |
169 | memcpy((PTR), &_tmpl, sizeof(_tmpl)); } while (0) |
170 | ||
190b76a6 | 171 | |
f1453c59 ET |
172 | /** Check for additive overflow, setting an error if would occur. */ |
173 | #define GIT_ADD_SIZET_OVERFLOW(out, one, two) \ | |
ac3d33df | 174 | (git__add_sizet_overflow(out, one, two) ? (git_error_set_oom(), 1) : 0) |
392702ee | 175 | |
f1453c59 ET |
176 | /** Check for additive overflow, setting an error if would occur. */ |
177 | #define GIT_MULTIPLY_SIZET_OVERFLOW(out, nelem, elsize) \ | |
ac3d33df | 178 | (git__multiply_sizet_overflow(out, nelem, elsize) ? (git_error_set_oom(), 1) : 0) |
392702ee ET |
179 | |
180 | /** Check for additive overflow, failing if it would occur. */ | |
ac3d33df | 181 | #define GIT_ERROR_CHECK_ALLOC_ADD(out, one, two) \ |
f1453c59 | 182 | if (GIT_ADD_SIZET_OVERFLOW(out, one, two)) { return -1; } |
392702ee | 183 | |
ac3d33df | 184 | #define GIT_ERROR_CHECK_ALLOC_ADD3(out, one, two, three) \ |
4bc9b74c ET |
185 | if (GIT_ADD_SIZET_OVERFLOW(out, one, two) || \ |
186 | GIT_ADD_SIZET_OVERFLOW(out, *(out), three)) { return -1; } | |
187 | ||
ac3d33df | 188 | #define GIT_ERROR_CHECK_ALLOC_ADD4(out, one, two, three, four) \ |
4bc9b74c ET |
189 | if (GIT_ADD_SIZET_OVERFLOW(out, one, two) || \ |
190 | GIT_ADD_SIZET_OVERFLOW(out, *(out), three) || \ | |
191 | GIT_ADD_SIZET_OVERFLOW(out, *(out), four)) { return -1; } | |
192 | ||
ac3d33df | 193 | #define GIT_ERROR_CHECK_ALLOC_ADD5(out, one, two, three, four, five) \ |
eae0bfdc PP |
194 | if (GIT_ADD_SIZET_OVERFLOW(out, one, two) || \ |
195 | GIT_ADD_SIZET_OVERFLOW(out, *(out), three) || \ | |
196 | GIT_ADD_SIZET_OVERFLOW(out, *(out), four) || \ | |
197 | GIT_ADD_SIZET_OVERFLOW(out, *(out), five)) { return -1; } | |
198 | ||
392702ee | 199 | /** Check for multiplicative overflow, failing if it would occur. */ |
ac3d33df | 200 | #define GIT_ERROR_CHECK_ALLOC_MULTIPLY(out, nelem, elsize) \ |
f1453c59 | 201 | if (GIT_MULTIPLY_SIZET_OVERFLOW(out, nelem, elsize)) { return -1; } |
392702ee | 202 | |
ac3d33df | 203 | /* NOTE: other git_error functions are in the public errors.h header file */ |
1a628100 | 204 | |
3f53c971 VM |
205 | #include "util.h" |
206 | ||
eae0bfdc | 207 | #endif |