/* * Copyright (C) the libgit2 contributors. All rights reserved. * * This file is part of libgit2, distributed under the GNU GPL v2 with * a Linking Exception. For full terms see the included COPYING file. */ #ifndef INCLUDE_git2_util_h__ #define INCLUDE_git2_util_h__ #if !defined(LIBGIT2_NO_FEATURES_H) # include "git2_features.h" #endif #include "git2/common.h" #include "cc-compat.h" typedef struct git_str git_str; /** Declare a function as always inlined. */ #if defined(_MSC_VER) # define GIT_INLINE(type) static __inline type #elif defined(__GNUC__) # define GIT_INLINE(type) static __inline__ type #else # define GIT_INLINE(type) static type #endif /** Support for gcc/clang __has_builtin intrinsic */ #ifndef __has_builtin # define __has_builtin(x) 0 #endif /** * 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 #include #include #include #include #include #include #include #include #ifdef GIT_WIN32 # include # include # include # include # include # include "win32/msvc-compat.h" # include "win32/mingw-compat.h" # include "win32/win32-compat.h" # include "win32/w32_common.h" # include "win32/version.h" # include "win32/error.h" # ifdef GIT_THREADS # include "win32/thread.h" # endif #else # include # include # ifdef GIT_THREADS # include # include # endif #define GIT_LIBGIT2_CALL #define GIT_SYSTEM_CALL #ifdef GIT_USE_STAT_ATIMESPEC # define st_atim st_atimespec # define st_ctim st_ctimespec # define st_mtim st_mtimespec #endif # include #endif #include "git2/types.h" #include "git2/errors.h" #include "thread.h" #include "integer.h" #include "assert_safe.h" #include "posix.h" #define GIT_BUFSIZE_DEFAULT 65536 #define GIT_BUFSIZE_FILEIO GIT_BUFSIZE_DEFAULT #define GIT_BUFSIZE_FILTERIO GIT_BUFSIZE_DEFAULT #define GIT_BUFSIZE_NETIO GIT_BUFSIZE_DEFAULT /** * Check a pointer allocation result, returning -1 if it failed. */ #define GIT_ERROR_CHECK_ALLOC(ptr) do { \ if ((ptr) == NULL) { return -1; } \ } while(0) /** * Check a buffer allocation result, returning -1 if it failed. */ #define GIT_ERROR_CHECK_ALLOC_STR(buf) do { \ if ((void *)(buf) == NULL || git_str_oom(buf)) { return -1; } \ } while(0) /** * Check a return value and propagate result if non-zero. */ #define GIT_ERROR_CHECK_ERROR(code) \ do { int _err = (code); if (_err) return _err; } while (0) /** Check for additive overflow, setting an error if would occur. */ #define GIT_ADD_SIZET_OVERFLOW(out, one, two) \ (git__add_sizet_overflow(out, one, two) ? (git_error_set_oom(), 1) : 0) /** Check for additive overflow, setting an error if would occur. */ #define GIT_MULTIPLY_SIZET_OVERFLOW(out, nelem, elsize) \ (git__multiply_sizet_overflow(out, nelem, elsize) ? (git_error_set_oom(), 1) : 0) /** Check for additive overflow, failing if it would occur. */ #define GIT_ERROR_CHECK_ALLOC_ADD(out, one, two) \ if (GIT_ADD_SIZET_OVERFLOW(out, one, two)) { return -1; } #define GIT_ERROR_CHECK_ALLOC_ADD3(out, one, two, three) \ if (GIT_ADD_SIZET_OVERFLOW(out, one, two) || \ GIT_ADD_SIZET_OVERFLOW(out, *(out), three)) { return -1; } #define GIT_ERROR_CHECK_ALLOC_ADD4(out, one, two, three, four) \ if (GIT_ADD_SIZET_OVERFLOW(out, one, two) || \ GIT_ADD_SIZET_OVERFLOW(out, *(out), three) || \ GIT_ADD_SIZET_OVERFLOW(out, *(out), four)) { return -1; } #define GIT_ERROR_CHECK_ALLOC_ADD5(out, one, two, three, four, five) \ 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; } /** Check for multiplicative overflow, failing if it would occur. */ #define GIT_ERROR_CHECK_ALLOC_MULTIPLY(out, nelem, elsize) \ if (GIT_MULTIPLY_SIZET_OVERFLOW(out, nelem, elsize)) { return -1; } #include "util.h" #endif