|
150
|
1 .. title:: LLDB Homepage
|
|
|
2
|
|
|
3 The LLDB Debugger
|
|
|
4 =================
|
|
|
5
|
|
|
6 Welcome to the LLDB version |release| documentation!
|
|
|
7
|
|
|
8 LLDB is a next generation, high-performance debugger. It is built as a set of
|
|
|
9 reusable components which highly leverage existing libraries in the larger LLVM
|
|
|
10 Project, such as the Clang expression parser and LLVM disassembler.
|
|
|
11
|
|
|
12 LLDB is the default debugger in Xcode on macOS and supports debugging C,
|
|
|
13 Objective-C and C++ on the desktop and iOS devices and simulator.
|
|
|
14
|
|
|
15 All of the code in the LLDB project is available under the
|
|
|
16 `"Apache 2.0 License with LLVM exceptions"`_.
|
|
|
17
|
|
|
18 .. _"Apache 2.0 License with LLVM exceptions": https://llvm.org/docs/DeveloperPolicy.html#new-llvm-project-license-framework
|
|
|
19
|
|
|
20 Using LLDB
|
|
|
21 ----------
|
|
|
22
|
|
|
23 For an introduction into the LLDB command language, head over to the `LLDB
|
|
|
24 Tutorial <https://lldb.llvm.org/use/tutorial.html>`_. For users already familiar
|
|
|
25 with GDB there is a cheat sheet listing common tasks and their LLDB equivalent
|
|
|
26 in the `GDB to LLDB command map <https://lldb.llvm.org/use/map.html>`_.
|
|
|
27
|
|
|
28 There are also multiple resources on how to script LLDB using Python `Python
|
|
|
29 Reference <https://lldb.llvm.org/use/python-reference.html>`_ is a great
|
|
|
30 starting point for that.
|
|
|
31
|
|
|
32 Compiler Integration Benefits
|
|
|
33 -----------------------------
|
|
|
34
|
|
|
35 LLDB converts debug information into Clang types so that it can
|
|
|
36 leverage the Clang compiler infrastructure. This allows LLDB to support the
|
|
|
37 latest C, C++, Objective-C and Objective-C++ language features and runtimes in
|
|
|
38 expressions without having to reimplement any of this functionality. It also
|
|
|
39 leverages the compiler to take care of all ABI details when making functions
|
|
|
40 calls for expressions, when disassembling instructions and extracting
|
|
|
41 instruction details, and much more.
|
|
|
42
|
|
|
43 The major benefits include:
|
|
|
44
|
|
|
45 - Up to date language support for C, C++, Objective-C
|
|
|
46 - Multi-line expressions that can declare local variables and types
|
|
|
47 - Utilize the JIT for expressions when supported
|
|
|
48 - Evaluate expression Intermediate Representation (IR) when JIT can't be used
|
|
|
49
|
|
|
50 Reusability
|
|
|
51 -----------
|
|
|
52
|
|
|
53 The LLDB debugger APIs are exposed as a C++ object oriented interface in a
|
|
|
54 shared library. The lldb command line tool links to, and uses this public API.
|
|
|
55 On macOS the shared library is exposed as a framework named LLDB.framework,
|
|
|
56 and Unix systems expose it as lldb.so. The entire API is also then exposed
|
|
|
57 through Python script bindings which allow the API to be used within the LLDB
|
|
|
58 embedded script interpreter, and also in any python script that loads the
|
|
|
59 lldb.py module in standard python script files. See the Python Reference page
|
|
|
60 for more details on how and where Python can be used with the LLDB API.
|
|
|
61
|
|
|
62 Sharing the LLDB API allows LLDB to not only be used for debugging, but also
|
|
|
63 for symbolication, disassembly, object and symbol file introspection, and much
|
|
|
64 more.
|
|
|
65
|
|
|
66 Platform Support
|
|
|
67 ----------------
|
|
|
68
|
|
|
69 LLDB is known to work on the following platforms, but ports to new platforms
|
|
|
70 are welcome:
|
|
|
71
|
|
|
72 * macOS desktop user space debugging for i386 and x86_64
|
|
|
73 * iOS, tvOS, and watchOS simulator debugging on i386 and x86_64
|
|
|
74 * iOS, tvOS, and watchOS device debugging on ARM and AArch64
|
|
|
75 * Linux local user-space debugging for i386, x86_64 and PPC64le
|
|
|
76 * FreeBSD local user-space debugging for i386 and x86_64
|
|
|
77 * Windows local user-space debugging for i386 (*)
|
|
|
78
|
|
|
79 (*) Support for Windows is under active development. Basic functionality is
|
|
|
80 expected to work, with functionality improving rapidly.
|
|
|
81
|
|
|
82 Get Involved
|
|
|
83 ------------
|
|
|
84
|
|
|
85 Check out the LLVM source-tree with git and find the sources in the `lldb`
|
|
|
86 subdirectory:
|
|
|
87
|
|
|
88 ::
|
|
|
89
|
|
|
90 > git clone https://github.com/llvm/llvm-project.git
|
|
|
91
|
|
|
92 Note that LLDB generally builds from top-of-trunk using CMake and Ninja.
|
|
|
93 Additionally it builds:
|
|
|
94
|
|
|
95 * on macOS with a :ref:`generated Xcode project <CMakeGeneratedXcodeProject>`
|
|
|
96 * on Linux and FreeBSD with Clang and libstdc++/libc++
|
|
|
97 * on NetBSD with GCC/Clang and libstdc++/libc++
|
|
|
98 * on Windows with a generated project for VS 2017 or higher
|
|
|
99
|
|
|
100 See the :doc:`LLDB Build Page <resources/build>` for build instructions.
|
|
|
101
|
|
|
102 Discussions about LLDB should go to the `lldb-dev
|
|
|
103 <http://lists.llvm.org/mailman/listinfo/lldb-dev>`__ mailing list. Commit
|
|
|
104 messages are automatically sent to the `lldb-commits
|
|
|
105 <http://lists.llvm.org/mailman/listinfo/lldb-commits>`__ mailing list , and
|
|
|
106 this is also the preferred mailing list for patch submissions.
|
|
|
107
|
|
|
108 See the :doc:`Projects page <status/projects>` if you are looking for some
|
|
|
109 interesting areas to contribute to lldb.
|
|
|
110
|
|
|
111 .. toctree::
|
|
|
112 :hidden:
|
|
|
113 :maxdepth: 1
|
|
|
114 :caption: Project
|
|
|
115
|
|
|
116 status/goals
|
|
|
117 status/features
|
|
|
118 status/status
|
|
|
119 status/projects
|
|
|
120 status/releases
|
|
|
121
|
|
|
122 .. toctree::
|
|
|
123 :hidden:
|
|
|
124 :maxdepth: 1
|
|
|
125 :caption: Use & Extension
|
|
|
126
|
|
|
127 use/tutorial
|
|
|
128 use/map
|
|
|
129 use/formatting
|
|
|
130 use/variable
|
|
|
131 use/symbolication
|
|
|
132 use/symbols
|
|
|
133 use/python
|
|
|
134 use/python-reference
|
|
|
135 use/remote
|
|
|
136 use/troubleshooting
|
|
|
137
|
|
|
138 .. toctree::
|
|
|
139 :hidden:
|
|
|
140 :maxdepth: 1
|
|
|
141 :caption: Development
|
|
|
142
|
|
|
143 resources/architecture
|
|
|
144 resources/contributing
|
|
|
145 resources/build
|
|
|
146 resources/test
|
|
|
147 resources/bots
|
|
|
148 resources/reproducers
|
|
|
149 resources/sbapi
|
|
|
150 resources/caveats
|
|
|
151
|
|
|
152 .. toctree::
|
|
|
153 :hidden:
|
|
|
154 :maxdepth: 1
|
|
|
155 :caption: Reference
|
|
|
156
|
|
|
157 Public Python API <https://lldb.llvm.org/python_reference/index.html>
|
|
|
158 Public C++ API <https://lldb.llvm.org/cpp_reference/namespacelldb.html>
|
|
|
159 Private C++ API <https://lldb.llvm.org/cpp_reference/index.html>
|
|
|
160 Man Page <man/lldb>
|
|
|
161
|
|
|
162 .. toctree::
|
|
|
163 :hidden:
|
|
|
164 :maxdepth: 1
|
|
|
165 :caption: External Links
|
|
|
166
|
|
|
167 Source Code <https://github.com/llvm/llvm-project>
|
|
|
168 Code Reviews <https://reviews.llvm.org>
|
|
|
169 Bug Reports <https://bugs.llvm.org/>
|
