include/lldb/lldb-defines.h

0001 //===-- lldb-defines.h ------------------------------------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLDB_LLDB_DEFINES_H
0010 #define LLDB_LLDB_DEFINES_H
0011
0012 #include "lldb/lldb-types.h"
0013
0014 #if !defined(INT32_MAX)
0015 #define INT32_MAX 2147483647
0016 #endif
0017
0018 #if !defined(UINT32_MAX)
0019 #define UINT32_MAX 4294967295U
0020 #endif
0021
0022 #if !defined(UINT64_MAX)
0023 #define UINT64_MAX 18446744073709551615ULL
0024 #endif
0025
0026 // LLDB version
0027 //
0028 // A build script phase can modify this version number if needed.
0029 //#define LLDB_VERSION
0030 //#define LLDB_REVISION
0031 //#define LLDB_VERSION_STRING
0032
0033 // LLDB defines
0034 #define LLDB_GENERIC_ERROR UINT32_MAX
0035
0036 // Breakpoints
0037 #define LLDB_INVALID_BREAK_ID 0
0038 #define LLDB_DEFAULT_BREAK_SIZE 0
0039 #define LLDB_BREAK_ID_IS_VALID(bid) ((bid) != (LLDB_INVALID_BREAK_ID))
0040 #define LLDB_BREAK_ID_IS_INTERNAL(bid) ((bid) < 0)
0041
0042 // Watchpoints
0043 #define LLDB_INVALID_WATCH_ID 0
0044 #define LLDB_WATCH_ID_IS_VALID(uid) ((uid) != (LLDB_INVALID_WATCH_ID))
0045 #define LLDB_WATCH_TYPE_READ (1u << 0)
0046 #define LLDB_WATCH_TYPE_WRITE (1u << 1)
0047 #define LLDB_WATCH_TYPE_MODIFY (1u << 2)
0048 #define LLDB_WATCH_TYPE_IS_VALID(type)                                         \
0049   ((type & LLDB_WATCH_TYPE_READ) || (type & LLDB_WATCH_TYPE_WRITE) ||          \
0050    (type & LLDB_WATCH_TYPE_MODIFY))
0051
0052 // StopPointSites
0053 #define LLDB_INVALID_SITE_ID UINT32_MAX
0054
0055 // Generic Register Numbers
0056 #define LLDB_REGNUM_GENERIC_PC 0    // Program Counter
0057 #define LLDB_REGNUM_GENERIC_SP 1    // Stack Pointer
0058 #define LLDB_REGNUM_GENERIC_FP 2    // Frame Pointer
0059 #define LLDB_REGNUM_GENERIC_RA 3    // Return Address
0060 #define LLDB_REGNUM_GENERIC_FLAGS 4 // Processor flags register
0061 #define LLDB_REGNUM_GENERIC_ARG1                                               \
0062   5 // The register that would contain pointer size or less argument 1 (if any)
0063 #define LLDB_REGNUM_GENERIC_ARG2                                               \
0064   6 // The register that would contain pointer size or less argument 2 (if any)
0065 #define LLDB_REGNUM_GENERIC_ARG3                                               \
0066   7 // The register that would contain pointer size or less argument 3 (if any)
0067 #define LLDB_REGNUM_GENERIC_ARG4                                               \
0068   8 // The register that would contain pointer size or less argument 4 (if any)
0069 #define LLDB_REGNUM_GENERIC_ARG5                                               \
0070   9 // The register that would contain pointer size or less argument 5 (if any)
0071 #define LLDB_REGNUM_GENERIC_ARG6                                               \
0072   10 // The register that would contain pointer size or less argument 6 (if any)
0073 #define LLDB_REGNUM_GENERIC_ARG7                                               \
0074   11 // The register that would contain pointer size or less argument 7 (if any)
0075 #define LLDB_REGNUM_GENERIC_ARG8                                               \
0076   12 // The register that would contain pointer size or less argument 8 (if any)
0077 #define LLDB_REGNUM_GENERIC_TP                                                 \
0078   13 // The register that would contain thread specific data, like TLS data and
0079      // thread control block pointer
0080 /// Invalid value definitions
0081 #define LLDB_INVALID_STOP_ID 0
0082 #define LLDB_INVALID_ADDRESS UINT64_MAX
0083 #define LLDB_INVALID_INDEX32 UINT32_MAX
0084 #define LLDB_INVALID_IVAR_OFFSET UINT32_MAX
0085 #define LLDB_INVALID_IMAGE_TOKEN UINT32_MAX
0086 #define LLDB_INVALID_MODULE_VERSION UINT32_MAX
0087 #define LLDB_INVALID_REGNUM UINT32_MAX
0088 #define LLDB_INVALID_UID UINT64_MAX
0089 #define LLDB_INVALID_PROCESS_ID 0
0090 #define LLDB_INVALID_THREAD_ID 0
0091 #define LLDB_INVALID_FRAME_ID UINT32_MAX
0092 #define LLDB_INVALID_SIGNAL_NUMBER INT32_MAX
0093 #define LLDB_INVALID_OFFSET UINT64_MAX // Must match max of lldb::offset_t
0094 #define LLDB_INVALID_LINE_NUMBER UINT32_MAX
0095 #define LLDB_INVALID_COLUMN_NUMBER 0
0096 #define LLDB_INVALID_QUEUE_ID 0
0097 #define LLDB_INVALID_CPU_ID UINT32_MAX
0098 #define LLDB_INVALID_WATCHPOINT_RESOURCE_ID UINT32_MAX
0099
0100 /// CPU Type definitions
0101 #define LLDB_ARCH_DEFAULT "systemArch"
0102 #define LLDB_ARCH_DEFAULT_32BIT "systemArch32"
0103 #define LLDB_ARCH_DEFAULT_64BIT "systemArch64"
0104 #define LLDB_INVALID_CPUTYPE (0xFFFFFFFEu)
0105
0106 /// Option Set definitions
0107 // FIXME: I'm sure there's some #define magic that can create all 32 sets on the
0108 // fly.  That would have the added benefit of making this unreadable.
0109 #define LLDB_MAX_NUM_OPTION_SETS 32
0110 #define LLDB_OPT_SET_ALL 0xFFFFFFFFU
0111 #define LLDB_OPT_SET_1 (1U << 0)
0112 #define LLDB_OPT_SET_2 (1U << 1)
0113 #define LLDB_OPT_SET_3 (1U << 2)
0114 #define LLDB_OPT_SET_4 (1U << 3)
0115 #define LLDB_OPT_SET_5 (1U << 4)
0116 #define LLDB_OPT_SET_6 (1U << 5)
0117 #define LLDB_OPT_SET_7 (1U << 6)
0118 #define LLDB_OPT_SET_8 (1U << 7)
0119 #define LLDB_OPT_SET_9 (1U << 8)
0120 #define LLDB_OPT_SET_10 (1U << 9)
0121 #define LLDB_OPT_SET_11 (1U << 10)
0122 #define LLDB_OPT_SET_12 (1U << 11)
0123 #define LLDB_OPT_SET_FROM_TO(A, B)                                             \
0124   (((1U << (B)) - 1) ^ (((1U << (A)) - 1) >> 1))
0125
0126 #if defined(_WIN32) && !defined(MAX_PATH)
0127 #define MAX_PATH 260
0128 #endif
0129
0130 /// Address Mask
0131 /// Bits not used for addressing are set to 1 in the mask;
0132 /// all mask bits set is an invalid value.
0133 #define LLDB_INVALID_ADDRESS_MASK UINT64_MAX
0134
0135 // ignore GCC function attributes
0136 #if defined(_MSC_VER) && !defined(__clang__)
0137 #define __attribute__(X)
0138 #endif
0139
0140 #define UNUSED_IF_ASSERT_DISABLED(x) ((void)(x))
0141
0142 #define LLDB_DEPRECATED(MSG)                                                   \
0143   [[deprecated("This method is no longer supported: " MSG)]]
0144
0145 #if defined(__clang__)
0146 #define LLDB_DEPRECATED_FIXME(MSG, FIX) __attribute__((deprecated(MSG, FIX)))
0147 #else
0148 #define LLDB_DEPRECATED_FIXME(MSG, FIX) LLDB_DEPRECATED(MSG)
0149 #endif
0150
0151 #endif // LLDB_LLDB_DEFINES_H