include/lldb/lldb-defines.h

   1 //===-- lldb-defines.h ------------------------------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #ifndef LLDB_lldb_defines_h_
  11 #define LLDB_lldb_defines_h_
  12
  13 #include "lldb/lldb-types.h"
  14
  15 #if defined(_MSC_VER)
  16 #if defined(EXPORT_LIBLLDB)
  17 #define LLDB_API __declspec(dllexport)
  18 #elif defined(IMPORT_LIBLLDB)
  19 #define LLDB_API __declspec(dllimport)
  20 #else
  21 #define LLDB_API
  22 #endif
  23 #else // defined (_MSC_VER)
  24 #define LLDB_API
  25 #endif
  26
  27 #if !defined(INT32_MAX)
  28 #define INT32_MAX 2147483647
  29 #endif
  30
  31 #if !defined(UINT32_MAX)
  32 #define UINT32_MAX 4294967295U
  33 #endif
  34
  35 #if !defined(UINT64_MAX)
  36 #define UINT64_MAX 18446744073709551615ULL
  37 #endif
  38
  39 //----------------------------------------------------------------------
  40 // LLDB version
  41 //
  42 // A build script phase can modify this version number if needed.
  43 //----------------------------------------------------------------------
  44 //#define LLDB_VERSION
  45 //#define LLDB_REVISION
  46 //#define LLDB_VERSION_STRING
  47
  48 //----------------------------------------------------------------------
  49 // LLDB defines
  50 //----------------------------------------------------------------------
  51 #define LLDB_GENERIC_ERROR UINT32_MAX
  52
  53 //----------------------------------------------------------------------
  54 // Breakpoints
  55 //----------------------------------------------------------------------
  56 #define LLDB_INVALID_BREAK_ID 0
  57 #define LLDB_DEFAULT_BREAK_SIZE 0
  58 #define LLDB_BREAK_ID_IS_VALID(bid) ((bid) != (LLDB_INVALID_BREAK_ID))
  59 #define LLDB_BREAK_ID_IS_INTERNAL(bid) ((bid) < 0)
  60
  61 //----------------------------------------------------------------------
  62 // Watchpoints
  63 //----------------------------------------------------------------------
  64 #define LLDB_INVALID_WATCH_ID 0
  65 #define LLDB_WATCH_ID_IS_VALID(uid) ((uid) != (LLDB_INVALID_WATCH_ID))
  66 #define LLDB_WATCH_TYPE_READ (1u << 0)
  67 #define LLDB_WATCH_TYPE_WRITE (1u << 1)
  68 #define LLDB_WATCH_TYPE_IS_VALID(type)                                         \
  69   ((type | LLDB_WATCH_TYPE_READ) || (type | LLDB_WATCH_TYPE_WRITE))
  70
  71 //----------------------------------------------------------------------
  72 // Generic Register Numbers
  73 //----------------------------------------------------------------------
  74 #define LLDB_REGNUM_GENERIC_PC 0    // Program Counter
  75 #define LLDB_REGNUM_GENERIC_SP 1    // Stack Pointer
  76 #define LLDB_REGNUM_GENERIC_FP 2    // Frame Pointer
  77 #define LLDB_REGNUM_GENERIC_RA 3    // Return Address
  78 #define LLDB_REGNUM_GENERIC_FLAGS 4 // Processor flags register
  79 #define LLDB_REGNUM_GENERIC_ARG1                                               \
  80   5 // The register that would contain pointer size or less argument 1 (if any)
  81 #define LLDB_REGNUM_GENERIC_ARG2                                               \
  82   6 // The register that would contain pointer size or less argument 2 (if any)
  83 #define LLDB_REGNUM_GENERIC_ARG3                                               \
  84   7 // The register that would contain pointer size or less argument 3 (if any)
  85 #define LLDB_REGNUM_GENERIC_ARG4                                               \
  86   8 // The register that would contain pointer size or less argument 4 (if any)
  87 #define LLDB_REGNUM_GENERIC_ARG5                                               \
  88   9 // The register that would contain pointer size or less argument 5 (if any)
  89 #define LLDB_REGNUM_GENERIC_ARG6                                               \
  90   10 // The register that would contain pointer size or less argument 6 (if any)
  91 #define LLDB_REGNUM_GENERIC_ARG7                                               \
  92   11 // The register that would contain pointer size or less argument 7 (if any)
  93 #define LLDB_REGNUM_GENERIC_ARG8                                               \
  94   12 // The register that would contain pointer size or less argument 8 (if any)
  95 //---------------------------------------------------------------------
  96 /// Invalid value definitions
  97 //----------------------------------------------------------------------
  98 #define LLDB_INVALID_ADDRESS UINT64_MAX
  99 #define LLDB_INVALID_INDEX32 UINT32_MAX
 100 #define LLDB_INVALID_IVAR_OFFSET UINT32_MAX
 101 #define LLDB_INVALID_IMAGE_TOKEN UINT32_MAX
 102 #define LLDB_INVALID_MODULE_VERSION UINT32_MAX
 103 #define LLDB_INVALID_REGNUM UINT32_MAX
 104 #define LLDB_INVALID_UID UINT64_MAX
 105 #define LLDB_INVALID_PROCESS_ID 0
 106 #define LLDB_INVALID_THREAD_ID 0
 107 #define LLDB_INVALID_FRAME_ID UINT32_MAX
 108 #define LLDB_INVALID_SIGNAL_NUMBER INT32_MAX
 109 #define LLDB_INVALID_OFFSET UINT64_MAX // Must match max of lldb::offset_t
 110 #define LLDB_INVALID_LINE_NUMBER UINT32_MAX
 111 #define LLDB_INVALID_QUEUE_ID 0
 112
 113 //----------------------------------------------------------------------
 114 /// CPU Type definitions
 115 //----------------------------------------------------------------------
 116 #define LLDB_ARCH_DEFAULT "systemArch"
 117 #define LLDB_ARCH_DEFAULT_32BIT "systemArch32"
 118 #define LLDB_ARCH_DEFAULT_64BIT "systemArch64"
 119 #define LLDB_INVALID_CPUTYPE (0xFFFFFFFEu)
 120
 121 //----------------------------------------------------------------------
 122 /// Option Set definitions
 123 //----------------------------------------------------------------------
 124 // FIXME: I'm sure there's some #define magic that can create all 32 sets on the
 125 // fly.  That would have the added benefit of making this unreadable.
 126 #define LLDB_MAX_NUM_OPTION_SETS 32
 127 #define LLDB_OPT_SET_ALL 0xFFFFFFFFU
 128 #define LLDB_OPT_SET_1 (1U << 0)
 129 #define LLDB_OPT_SET_2 (1U << 1)
 130 #define LLDB_OPT_SET_3 (1U << 2)
 131 #define LLDB_OPT_SET_4 (1U << 3)
 132 #define LLDB_OPT_SET_5 (1U << 4)
 133 #define LLDB_OPT_SET_6 (1U << 5)
 134 #define LLDB_OPT_SET_7 (1U << 6)
 135 #define LLDB_OPT_SET_8 (1U << 7)
 136 #define LLDB_OPT_SET_9 (1U << 8)
 137 #define LLDB_OPT_SET_10 (1U << 9)
 138 #define LLDB_OPT_SET_FROM_TO(A, B)                                             \
 139   (((1U << (B)) - 1) ^ (((1U << (A)) - 1) >> 1))
 140
 141 #if defined(_WIN32) && !defined(MAX_PATH)
 142 #define MAX_PATH 260
 143 #endif
 144
 145 // ignore GCC function attributes
 146 #if defined(_MSC_VER) && !defined(__clang__)
 147 #define __attribute__(X)
 148 #endif
 149
 150 #define UNUSED_IF_ASSERT_DISABLED(x) ((void)(x))
 151
 152 #if defined(__cplusplus)
 153
 154 //----------------------------------------------------------------------
 155 /// @def DISALLOW_COPY_AND_ASSIGN(TypeName)
 156 ///     Macro definition for easily disallowing copy constructor and
 157 ///     assignment operators in C++ classes.
 158 //----------------------------------------------------------------------
 159 #define DISALLOW_COPY_AND_ASSIGN(TypeName)                                     \
 160   TypeName(const TypeName &) = delete;                                         \
 161   const TypeName &operator=(const TypeName &) = delete
 162
 163 #endif // #if defined(__cplusplus)
 164
 165 #endif // LLDB_lldb_defines_h_