src/common.h

   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 #define GIT_STDLIB_CALL
  67
  68 #ifdef GIT_USE_STAT_ATIMESPEC
  69 # define st_atim st_atimespec
  70 # define st_ctim st_ctimespec
  71 # define st_mtim st_mtimespec
  72 #endif
  73
  74 # include <arpa/inet.h>
  75
  76 #endif
  77
  78 #include "git2/types.h"
  79 #include "git2/errors.h"
  80 #include "errors.h"
  81 #include "thread-utils.h"
  82 #include "integer.h"
  83
  84 /*
  85  * Include the declarations for deprecated functions; this ensures
  86  * that they're decorated with the proper extern/visibility attributes.
  87  */
  88 #include "git2/deprecated.h"
  89
  90 #include "posix.h"
  91
  92 #define DEFAULT_BUFSIZE 65536
  93 #define FILEIO_BUFSIZE DEFAULT_BUFSIZE
  94 #define FILTERIO_BUFSIZE DEFAULT_BUFSIZE
  95 #define NETIO_BUFSIZE DEFAULT_BUFSIZE
  96
  97 /**
  98  * Check a pointer allocation result, returning -1 if it failed.
  99  */
 100 #define GIT_ERROR_CHECK_ALLOC(ptr) if (ptr == NULL) { return -1; }
 101
 102 /**
 103  * Check a buffer allocation result, returning -1 if it failed.
 104  */
 105 #define GIT_ERROR_CHECK_ALLOC_BUF(buf) if ((void *)(buf) == NULL || git_buf_oom(buf)) { return -1; }
 106
 107 /**
 108  * Check a return value and propagate result if non-zero.
 109  */
 110 #define GIT_ERROR_CHECK_ERROR(code) \
 111         do { int _err = (code); if (_err) return _err; } while (0)
 112
 113 /**
 114  * Check a versioned structure for validity
 115  */
 116 GIT_INLINE(int) git_error__check_version(const void *structure, unsigned int expected_max, const char *name)
 117 {
 118         unsigned int actual;
 119
 120         if (!structure)
 121                 return 0;
 122
 123         actual = *(const unsigned int*)structure;
 124         if (actual > 0 && actual <= expected_max)
 125                 return 0;
 126
 127         git_error_set(GIT_ERROR_INVALID, "invalid version %d on %s", actual, name);
 128         return -1;
 129 }
 130 #define GIT_ERROR_CHECK_VERSION(S,V,N) if (git_error__check_version(S,V,N) < 0) return -1
 131
 132 /**
 133  * Initialize a structure with a version.
 134  */
 135 GIT_INLINE(void) git__init_structure(void *structure, size_t len, unsigned int version)
 136 {
 137         memset(structure, 0, len);
 138         *((int*)structure) = version;
 139 }
 140 #define GIT_INIT_STRUCTURE(S,V) git__init_structure(S, sizeof(*S), V)
 141
 142 #define GIT_INIT_STRUCTURE_FROM_TEMPLATE(PTR,VERSION,TYPE,TPL) do { \
 143         TYPE _tmpl = TPL; \
 144         GIT_ERROR_CHECK_VERSION(&(VERSION), _tmpl.version, #TYPE);      \
 145         memcpy((PTR), &_tmpl, sizeof(_tmpl)); } while (0)
 146
 147
 148 /** Check for additive overflow, setting an error if would occur. */
 149 #define GIT_ADD_SIZET_OVERFLOW(out, one, two) \
 150         (git__add_sizet_overflow(out, one, two) ? (git_error_set_oom(), 1) : 0)
 151
 152 /** Check for additive overflow, setting an error if would occur. */
 153 #define GIT_MULTIPLY_SIZET_OVERFLOW(out, nelem, elsize) \
 154         (git__multiply_sizet_overflow(out, nelem, elsize) ? (git_error_set_oom(), 1) : 0)
 155
 156 /** Check for additive overflow, failing if it would occur. */
 157 #define GIT_ERROR_CHECK_ALLOC_ADD(out, one, two) \
 158         if (GIT_ADD_SIZET_OVERFLOW(out, one, two)) { return -1; }
 159
 160 #define GIT_ERROR_CHECK_ALLOC_ADD3(out, one, two, three) \
 161         if (GIT_ADD_SIZET_OVERFLOW(out, one, two) || \
 162                 GIT_ADD_SIZET_OVERFLOW(out, *(out), three)) { return -1; }
 163
 164 #define GIT_ERROR_CHECK_ALLOC_ADD4(out, one, two, three, four) \
 165         if (GIT_ADD_SIZET_OVERFLOW(out, one, two) || \
 166                 GIT_ADD_SIZET_OVERFLOW(out, *(out), three) || \
 167                 GIT_ADD_SIZET_OVERFLOW(out, *(out), four)) { return -1; }
 168
 169 #define GIT_ERROR_CHECK_ALLOC_ADD5(out, one, two, three, four, five) \
 170         if (GIT_ADD_SIZET_OVERFLOW(out, one, two) || \
 171                 GIT_ADD_SIZET_OVERFLOW(out, *(out), three) || \
 172                 GIT_ADD_SIZET_OVERFLOW(out, *(out), four) || \
 173                 GIT_ADD_SIZET_OVERFLOW(out, *(out), five)) { return -1; }
 174
 175 /** Check for multiplicative overflow, failing if it would occur. */
 176 #define GIT_ERROR_CHECK_ALLOC_MULTIPLY(out, nelem, elsize) \
 177         if (GIT_MULTIPLY_SIZET_OVERFLOW(out, nelem, elsize)) { return -1; }
 178
 179 /* NOTE: other git_error functions are in the public errors.h header file */
 180
 181 #include "util.h"
 182
 183 #endif