gdb/gdbsupport/common-defs.h

   1 /* Common definitions.
   2
   3    Copyright (C) 1986-2019 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef COMMON_COMMON_DEFS_H
  21 #define COMMON_COMMON_DEFS_H
  22
  23 #include "config.h"
  24
  25 #undef PACKAGE_NAME
  26 #undef PACKAGE_VERSION
  27 #undef PACKAGE_STRING
  28 #undef PACKAGE_TARNAME
  29
  30 #ifdef GDBSERVER
  31 #include "build-gnulib-gdbserver/config.h"
  32 #else
  33 #include "../../gnulib/config.h"
  34 #endif
  35
  36 #undef PACKAGE_NAME
  37 #undef PACKAGE_VERSION
  38 #undef PACKAGE_STRING
  39 #undef PACKAGE_TARNAME
  40
  41 /* From:
  42     https://www.gnu.org/software/gnulib/manual/html_node/stdint_002eh.html
  43
  44    "On some hosts that predate C++11, when using C++ one must define
  45    __STDC_CONSTANT_MACROS to make visible the definitions of constant
  46    macros such as INTMAX_C, and one must define __STDC_LIMIT_MACROS to
  47    make visible the definitions of limit macros such as INTMAX_MAX.".
  48
  49    And:
  50     https://www.gnu.org/software/gnulib/manual/html_node/inttypes_002eh.html
  51
  52    "On some hosts that predate C++11, when using C++ one must define
  53    __STDC_FORMAT_MACROS to make visible the declarations of format
  54    macros such as PRIdMAX."
  55
  56    Must do this before including any system header, since other system
  57    headers may include stdint.h/inttypes.h.  */
  58 #define __STDC_CONSTANT_MACROS 1
  59 #define __STDC_LIMIT_MACROS 1
  60 #define __STDC_FORMAT_MACROS 1
  61
  62 /* Some distros enable _FORTIFY_SOURCE by default, which on occasion
  63    has caused build failures with -Wunused-result when a patch is
  64    developed on a distro that does not enable _FORTIFY_SOURCE.  We
  65    enable it here in order to try to catch these problems earlier;
  66    plus this seems like a reasonable safety measure.  The check for
  67    optimization is required because _FORTIFY_SOURCE only works when
  68    optimization is enabled.  If _FORTIFY_SOURCE is already defined,
  69    then we don't do anything.  */
  70
  71 #if !defined _FORTIFY_SOURCE && defined __OPTIMIZE__ && __OPTIMIZE__ > 0
  72 #define _FORTIFY_SOURCE 2
  73 #endif
  74
  75 /* We don't support Windows versions before XP, so we define
  76    _WIN32_WINNT correspondingly to ensure the Windows API headers
  77    expose the required symbols.  */
  78 #if defined (__MINGW32__) || defined (__CYGWIN__)
  79 # ifdef _WIN32_WINNT
  80 #  if _WIN32_WINNT < 0x0501
  81 #   undef _WIN32_WINNT
  82 #   define _WIN32_WINNT 0x0501
  83 #  endif
  84 # else
  85 #  define _WIN32_WINNT 0x0501
  86 # endif
  87 #endif  /* __MINGW32__ || __CYGWIN__ */
  88
  89 #include <stdarg.h>
  90 #include <stdio.h>
  91 #include <stdlib.h>
  92 #include <stddef.h>
  93 #include <stdint.h>
  94 #include <string.h>
  95 #ifdef HAVE_STRINGS_H
  96 #include <strings.h>    /* for strcasecmp and strncasecmp */
  97 #endif
  98 #include <errno.h>
  99 #include <alloca.h>
 100 /* Must be included before pathmax.h to avoid build errors about localtime_r
 101    and gmtime_r in gnulib on MinGW.  This is a gnulib bug:
 102    https://lists.gnu.org/archive/html/bug-gnulib/2019-11/msg00022.html  */
 103 #include <time.h>
 104
 105
 106 #include "ansidecl.h"
 107 /* This is defined by ansidecl.h, but we prefer gnulib's version.  On
 108    MinGW, gnulib might enable __USE_MINGW_ANSI_STDIO, which may or not
 109    require use of attribute gnu_printf instead of printf.  gnulib
 110    checks that at configure time.  Since _GL_ATTRIBUTE_FORMAT_PRINTF
 111    is compatible with ATTRIBUTE_PRINTF, simply use it.  */
 112 #undef ATTRIBUTE_PRINTF
 113 #define ATTRIBUTE_PRINTF _GL_ATTRIBUTE_FORMAT_PRINTF
 114
 115 #if GCC_VERSION >= 3004
 116 #define ATTRIBUTE_UNUSED_RESULT __attribute__ ((__warn_unused_result__))
 117 #else
 118 #define ATTRIBUTE_UNUSED_RESULT
 119 #endif
 120
 121 #include "libiberty.h"
 122 #include "pathmax.h"
 123 #include "gdb/signals.h"
 124 #include "gdb_locale.h"
 125 #include "ptid.h"
 126 #include "common-types.h"
 127 #include "common-utils.h"
 128 #include "gdb_assert.h"
 129 #include "errors.h"
 130 #include "print-utils.h"
 131 #include "common-debug.h"
 132 #include "cleanups.h"
 133 #include "common-exceptions.h"
 134 #include "gdbsupport/poison.h"
 135
 136 #define EXTERN_C extern "C"
 137 #define EXTERN_C_PUSH extern "C" {
 138 #define EXTERN_C_POP }
 139
 140 /* Pull in gdb::unique_xmalloc_ptr.  */
 141 #include "gdbsupport/gdb_unique_ptr.h"
 142
 143 /* String containing the current directory (what getwd would return).  */
 144 extern char *current_directory;
 145
 146 /* sbrk on macOS is not useful for our purposes, since sbrk(0) always
 147    returns the same value.  brk/sbrk on macOS is just an emulation
 148    that always returns a pointer to a 4MB section reserved for
 149    that.  */
 150
 151 #if defined (HAVE_SBRK) && !__APPLE__
 152 #define HAVE_USEFUL_SBRK 1
 153 #endif
 154
 155 #endif /* COMMON_COMMON_DEFS_H */