common.h 5.7 KB
Newer Older
Vicent Marti committed
1
/*
Edward Thomson committed
2
 * Copyright (C) the libgit2 contributors. All rights reserved.
Vicent Marti committed
3 4 5 6
 *
 * This file is part of libgit2, distributed under the GNU GPL v2 with
 * a Linking Exception. For full terms see the included COPYING file.
 */
7 8 9
#ifndef INCLUDE_common_h__
#define INCLUDE_common_h__

10 11 12 13
#ifndef LIBGIT2_NO_FEATURES_H
# include "git2/sys/features.h"
#endif

14
#include "git2/common.h"
15
#include "cc-compat.h"
16

Russell Belfer committed
17 18 19
/** Declare a function as always inlined. */
#if defined(_MSC_VER)
# define GIT_INLINE(type) static __inline type
20 21
#elif defined(__GNUC__)
# define GIT_INLINE(type) static __inline__ type
22 23
#elif defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
# define GIT_INLINE(type) static inline type
Russell Belfer committed
24
#else
25
# define GIT_INLINE(type) static type
Russell Belfer committed
26 27
#endif

28 29 30 31 32
/** Support for gcc/clang __has_builtin intrinsic */
#ifndef __has_builtin
# define __has_builtin(x) 0
#endif

lhchavez committed
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
/**
 * Declare that a function's return value must be used.
 *
 * Used mostly to guard against potential silent bugs at runtime. This is
 * recommended to be added to functions that:
 *
 * - Allocate / reallocate memory. This prevents memory leaks or errors where
 *   buffers are expected to have grown to a certain size, but could not be
 *   resized.
 * - Acquire locks. When a lock cannot be acquired, that will almost certainly
 *   cause a data race / undefined behavior.
 */
#if defined(__GNUC__)
# define GIT_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
#else
# define GIT_WARN_UNUSED_RESULT
#endif

51
#include <assert.h>
52
#include <errno.h>
53
#include <limits.h>
54
#include <stdlib.h>
55
#include <stdio.h>
56 57
#include <string.h>

58
#include <sys/types.h>
59
#include <sys/stat.h>
60 61 62 63

#ifdef GIT_WIN32

# include <io.h>
64
# include <direct.h>
65
# include <winsock2.h>
66
# include <windows.h>
67
# include <ws2tcpip.h>
68 69
# include "win32/msvc-compat.h"
# include "win32/mingw-compat.h"
70
# include "win32/w32_common.h"
71
# include "win32/win32-compat.h"
72
# include "win32/error.h"
73
# include "win32/version.h"
Vicent Marti committed
74
# ifdef GIT_THREADS
75
#	include "win32/thread.h"
76
# endif
77

78 79
#else

80
# include <unistd.h>
81
# include <strings.h>
Vicent Marti committed
82
# ifdef GIT_THREADS
Vicent Marti committed
83
#	include <pthread.h>
84
#	include <sched.h>
Vicent Marti committed
85
# endif
86 87 88

#define GIT_LIBGIT2_CALL
#define GIT_SYSTEM_CALL
Russell Belfer committed
89

90 91 92 93 94 95
#ifdef GIT_USE_STAT_ATIMESPEC
# define st_atim st_atimespec
# define st_ctim st_ctimespec
# define st_mtim st_mtimespec
#endif

Edward Thomson committed
96 97
# include <arpa/inet.h>

98 99
#endif

100
#include "git2/types.h"
101
#include "git2/errors.h"
102
#include "errors.h"
103
#include "thread.h"
104
#include "integer.h"
105
#include "assert_safe.h"
106
#include "utf8.h"
107

108 109 110 111 112 113
/*
 * Include the declarations for deprecated functions; this ensures
 * that they're decorated with the proper extern/visibility attributes.
 */
#include "git2/deprecated.h"

114
#include "posix.h"
115

116 117 118 119 120
#define DEFAULT_BUFSIZE 65536
#define FILEIO_BUFSIZE DEFAULT_BUFSIZE
#define FILTERIO_BUFSIZE DEFAULT_BUFSIZE
#define NETIO_BUFSIZE DEFAULT_BUFSIZE

121 122 123
/**
 * Check a pointer allocation result, returning -1 if it failed.
 */
124
#define GIT_ERROR_CHECK_ALLOC(ptr) if (ptr == NULL) { return -1; }
125

126
/**
127 128
 * Check a buffer allocation result, returning -1 if it failed.
 */
129
#define GIT_ERROR_CHECK_ALLOC_BUF(buf) if ((void *)(buf) == NULL || git_buf_oom(buf)) { return -1; }
130 131

/**
Will Stamper committed
132
 * Check a return value and propagate result if non-zero.
133
 */
134
#define GIT_ERROR_CHECK_ERROR(code) \
135
	do { int _err = (code); if (_err) return _err; } while (0)
136 137

/**
Ben Straub committed
138 139
 * Check a versioned structure for validity
 */
140
GIT_INLINE(int) git_error__check_version(const void *structure, unsigned int expected_max, const char *name)
Ben Straub committed
141
{
Vicent Marti committed
142
	unsigned int actual;
Vicent Marti committed
143

Ben Straub committed
144
	if (!structure)
145
		return 0;
Ben Straub committed
146

Vicent Marti committed
147
	actual = *(const unsigned int*)structure;
Ben Straub committed
148
	if (actual > 0 && actual <= expected_max)
149
		return 0;
Ben Straub committed
150

151
	git_error_set(GIT_ERROR_INVALID, "invalid version %d on %s", actual, name);
152
	return -1;
Ben Straub committed
153
}
154
#define GIT_ERROR_CHECK_VERSION(S,V,N) if (git_error__check_version(S,V,N) < 0) return -1
Ben Straub committed
155

Ben Straub committed
156 157 158 159 160 161 162 163 164 165
/**
 * Initialize a structure with a version.
 */
GIT_INLINE(void) git__init_structure(void *structure, size_t len, unsigned int version)
{
	memset(structure, 0, len);
	*((int*)structure) = version;
}
#define GIT_INIT_STRUCTURE(S,V) git__init_structure(S, sizeof(*S), V)

166 167
#define GIT_INIT_STRUCTURE_FROM_TEMPLATE(PTR,VERSION,TYPE,TPL) do { \
	TYPE _tmpl = TPL; \
168
	GIT_ERROR_CHECK_VERSION(&(VERSION), _tmpl.version, #TYPE);	\
169 170
	memcpy((PTR), &_tmpl, sizeof(_tmpl)); } while (0)

171

172 173
/** Check for additive overflow, setting an error if would occur. */
#define GIT_ADD_SIZET_OVERFLOW(out, one, two) \
174
	(git__add_sizet_overflow(out, one, two) ? (git_error_set_oom(), 1) : 0)
175

176 177
/** Check for additive overflow, setting an error if would occur. */
#define GIT_MULTIPLY_SIZET_OVERFLOW(out, nelem, elsize) \
178
	(git__multiply_sizet_overflow(out, nelem, elsize) ? (git_error_set_oom(), 1) : 0)
179 180

/** Check for additive overflow, failing if it would occur. */
181
#define GIT_ERROR_CHECK_ALLOC_ADD(out, one, two) \
182
	if (GIT_ADD_SIZET_OVERFLOW(out, one, two)) { return -1; }
183

184
#define GIT_ERROR_CHECK_ALLOC_ADD3(out, one, two, three) \
185 186 187
	if (GIT_ADD_SIZET_OVERFLOW(out, one, two) || \
		GIT_ADD_SIZET_OVERFLOW(out, *(out), three)) { return -1; }

188
#define GIT_ERROR_CHECK_ALLOC_ADD4(out, one, two, three, four) \
189 190 191 192
	if (GIT_ADD_SIZET_OVERFLOW(out, one, two) || \
		GIT_ADD_SIZET_OVERFLOW(out, *(out), three) || \
		GIT_ADD_SIZET_OVERFLOW(out, *(out), four)) { return -1; }

193
#define GIT_ERROR_CHECK_ALLOC_ADD5(out, one, two, three, four, five) \
194 195 196 197 198
	if (GIT_ADD_SIZET_OVERFLOW(out, one, two) || \
		GIT_ADD_SIZET_OVERFLOW(out, *(out), three) || \
		GIT_ADD_SIZET_OVERFLOW(out, *(out), four) || \
		GIT_ADD_SIZET_OVERFLOW(out, *(out), five)) { return -1; }

199
/** Check for multiplicative overflow, failing if it would occur. */
200
#define GIT_ERROR_CHECK_ALLOC_MULTIPLY(out, nelem, elsize) \
201
	if (GIT_MULTIPLY_SIZET_OVERFLOW(out, nelem, elsize)) { return -1; }
202

203
/* NOTE: other git_error functions are in the public errors.h header file */
204

205 206
#include "util.h"

207
#endif