1 /*
2 * Copyright (C) the libgit2 contributors. All rights reserved.
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 */
7 #ifndef INCLUDE_common_h__
8 #define INCLUDE_common_h__
9
10 #ifndef LIBGIT2_NO_FEATURES_H
11 # include "git2/sys/features.h"
12 #endif
13
14 #include "git2/common.h"
15 #include "cc-compat.h"
16
17 /** Declare a function as always inlined. */
18 #if defined(_MSC_VER)
19 # define GIT_INLINE(type) static __inline type
20 #elif defined(__GNUC__)
21 # define GIT_INLINE(type) static __inline__ type
22 #else
23 # define GIT_INLINE(type) static type
24 #endif
25
26 /** Support for gcc/clang __has_builtin intrinsic */
27 #ifndef __has_builtin
28 # define __has_builtin(x) 0
29 #endif
30
31 #include <assert.h>
32 #include <errno.h>
33 #include <limits.h>
34 #include <stdlib.h>
35 #include <stdio.h>
36 #include <string.h>
37
38 #include <sys/types.h>
39 #include <sys/stat.h>
40
41 #ifdef GIT_WIN32
42
43 # include <io.h>
44 # include <direct.h>
45 # include <winsock2.h>
46 # include <windows.h>
47 # include <ws2tcpip.h>
48 # include "win32/msvc-compat.h"
49 # include "win32/mingw-compat.h"
50 # include "win32/w32_common.h"
51 # include "win32/win32-compat.h"
52 # include "win32/error.h"
53 # include "win32/version.h"
54 # ifdef GIT_THREADS
55 # include "win32/thread.h"
56 # endif
57
58 #else
59
60 # include <unistd.h>
61 # include <strings.h>
62 # ifdef GIT_THREADS
63 # include <pthread.h>
64 # include <sched.h>
65 # endif
66
67 #define GIT_LIBGIT2_CALL
68 #define GIT_SYSTEM_CALL
69
70 #ifdef GIT_USE_STAT_ATIMESPEC
71 # define st_atim st_atimespec
72 # define st_ctim st_ctimespec
73 # define st_mtim st_mtimespec
74 #endif
75
76 # include <arpa/inet.h>
77
78 #endif
79
80 #include "git2/types.h"
81 #include "git2/errors.h"
82 #include "errors.h"
83 #include "thread.h"
84 #include "integer.h"
85 #include "assert_safe.h"
86
87 /*
88 * Include the declarations for deprecated functions; this ensures
89 * that they're decorated with the proper extern/visibility attributes.
90 */
91 #include "git2/deprecated.h"
92
93 #include "posix.h"
94
95 #define DEFAULT_BUFSIZE 65536
96 #define FILEIO_BUFSIZE DEFAULT_BUFSIZE
97 #define FILTERIO_BUFSIZE DEFAULT_BUFSIZE
98 #define NETIO_BUFSIZE DEFAULT_BUFSIZE
99
100 /**
101 * Check a pointer allocation result, returning -1 if it failed.
102 */
103 #define GIT_ERROR_CHECK_ALLOC(ptr) if (ptr == NULL) { return -1; }
104
105 /**
106 * Check a buffer allocation result, returning -1 if it failed.
107 */
108 #define GIT_ERROR_CHECK_ALLOC_BUF(buf) if ((void *)(buf) == NULL || git_buf_oom(buf)) { return -1; }
109
110 /**
111 * Check a return value and propagate result if non-zero.
112 */
113 #define GIT_ERROR_CHECK_ERROR(code) \
114 do { int _err = (code); if (_err) return _err; } while (0)
115
116 /**
117 * Check a versioned structure for validity
118 */
git_error__check_version(const void * structure,unsigned int expected_max,const char * name)119 GIT_INLINE(int) git_error__check_version(const void *structure, unsigned int expected_max, const char *name)
120 {
121 unsigned int actual;
122
123 if (!structure)
124 return 0;
125
126 actual = *(const unsigned int*)structure;
127 if (actual > 0 && actual <= expected_max)
128 return 0;
129
130 git_error_set(GIT_ERROR_INVALID, "invalid version %d on %s", actual, name);
131 return -1;
132 }
133 #define GIT_ERROR_CHECK_VERSION(S,V,N) if (git_error__check_version(S,V,N) < 0) return -1
134
135 /**
136 * Initialize a structure with a version.
137 */
git__init_structure(void * structure,size_t len,unsigned int version)138 GIT_INLINE(void) git__init_structure(void *structure, size_t len, unsigned int version)
139 {
140 memset(structure, 0, len);
141 *((int*)structure) = version;
142 }
143 #define GIT_INIT_STRUCTURE(S,V) git__init_structure(S, sizeof(*S), V)
144
145 #define GIT_INIT_STRUCTURE_FROM_TEMPLATE(PTR,VERSION,TYPE,TPL) do { \
146 TYPE _tmpl = TPL; \
147 GIT_ERROR_CHECK_VERSION(&(VERSION), _tmpl.version, #TYPE); \
148 memcpy((PTR), &_tmpl, sizeof(_tmpl)); } while (0)
149
150
151 /** Check for additive overflow, setting an error if would occur. */
152 #define GIT_ADD_SIZET_OVERFLOW(out, one, two) \
153 (git__add_sizet_overflow(out, one, two) ? (git_error_set_oom(), 1) : 0)
154
155 /** Check for additive overflow, setting an error if would occur. */
156 #define GIT_MULTIPLY_SIZET_OVERFLOW(out, nelem, elsize) \
157 (git__multiply_sizet_overflow(out, nelem, elsize) ? (git_error_set_oom(), 1) : 0)
158
159 /** Check for additive overflow, failing if it would occur. */
160 #define GIT_ERROR_CHECK_ALLOC_ADD(out, one, two) \
161 if (GIT_ADD_SIZET_OVERFLOW(out, one, two)) { return -1; }
162
163 #define GIT_ERROR_CHECK_ALLOC_ADD3(out, one, two, three) \
164 if (GIT_ADD_SIZET_OVERFLOW(out, one, two) || \
165 GIT_ADD_SIZET_OVERFLOW(out, *(out), three)) { return -1; }
166
167 #define GIT_ERROR_CHECK_ALLOC_ADD4(out, one, two, three, four) \
168 if (GIT_ADD_SIZET_OVERFLOW(out, one, two) || \
169 GIT_ADD_SIZET_OVERFLOW(out, *(out), three) || \
170 GIT_ADD_SIZET_OVERFLOW(out, *(out), four)) { return -1; }
171
172 #define GIT_ERROR_CHECK_ALLOC_ADD5(out, one, two, three, four, five) \
173 if (GIT_ADD_SIZET_OVERFLOW(out, one, two) || \
174 GIT_ADD_SIZET_OVERFLOW(out, *(out), three) || \
175 GIT_ADD_SIZET_OVERFLOW(out, *(out), four) || \
176 GIT_ADD_SIZET_OVERFLOW(out, *(out), five)) { return -1; }
177
178 /** Check for multiplicative overflow, failing if it would occur. */
179 #define GIT_ERROR_CHECK_ALLOC_MULTIPLY(out, nelem, elsize) \
180 if (GIT_MULTIPLY_SIZET_OVERFLOW(out, nelem, elsize)) { return -1; }
181
182 /* NOTE: other git_error functions are in the public errors.h header file */
183
184 #include "util.h"
185
186 #endif
187