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