LLDB mainline
PlatformFreeBSD.cpp
Go to the documentation of this file.
1//===-- PlatformFreeBSD.cpp -----------------------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include "PlatformFreeBSD.h"
10#include "lldb/Host/Config.h"
11
12#include <cstdio>
13#if LLDB_ENABLE_POSIX
14#include <sys/utsname.h>
15#endif
16
19#include "lldb/Core/Debugger.h"
21#include "lldb/Host/HostInfo.h"
22#include "lldb/Target/Process.h"
23#include "lldb/Target/Target.h"
26#include "lldb/Utility/Log.h"
27#include "lldb/Utility/State.h"
28#include "lldb/Utility/Status.h"
30
31#include "llvm/ADT/Triple.h"
32#include "llvm/Support/Host.h"
33
34// Define these constants from FreeBSD mman.h for use when targeting remote
35// FreeBSD systems even when host has different values.
36#define MAP_PRIVATE 0x0002
37#define MAP_ANON 0x1000
38
39using namespace lldb;
40using namespace lldb_private;
41using namespace lldb_private::platform_freebsd;
42
44
46
47
48PlatformSP PlatformFreeBSD::CreateInstance(bool force, const ArchSpec *arch) {
49 Log *log = GetLog(LLDBLog::Platform);
50 LLDB_LOG(log, "force = {0}, arch=({1}, {2})", force,
51 arch ? arch->GetArchitectureName() : "<null>",
52 arch ? arch->GetTriple().getTriple() : "<null>");
53
54 bool create = force;
55 if (!create && arch && arch->IsValid()) {
56 const llvm::Triple &triple = arch->GetTriple();
57 switch (triple.getOS()) {
58 case llvm::Triple::FreeBSD:
59 create = true;
60 break;
61
62#if defined(__FreeBSD__)
63 // Only accept "unknown" for the OS if the host is BSD and it "unknown"
64 // wasn't specified (it was just returned because it was NOT specified)
65 case llvm::Triple::OSType::UnknownOS:
66 create = !arch->TripleOSWasSpecified();
67 break;
68#endif
69 default:
70 break;
71 }
72 }
73 LLDB_LOG(log, "create = {0}", create);
74 if (create) {
75 return PlatformSP(new PlatformFreeBSD(false));
76 }
77 return PlatformSP();
78}
79
80llvm::StringRef PlatformFreeBSD::GetPluginDescriptionStatic(bool is_host) {
81 if (is_host)
82 return "Local FreeBSD user platform plug-in.";
83 return "Remote FreeBSD user platform plug-in.";
84}
85
88
89 if (g_initialize_count++ == 0) {
90#if defined(__FreeBSD__)
91 PlatformSP default_platform_sp(new PlatformFreeBSD(true));
92 default_platform_sp->SetSystemArchitecture(HostInfo::GetArchitecture());
93 Platform::SetHostPlatform(default_platform_sp);
94#endif
99 }
100}
101
103 if (g_initialize_count > 0) {
104 if (--g_initialize_count == 0) {
106 }
107 }
108
110}
111
112/// Default Constructor
114 : PlatformPOSIX(is_host) // This is the local host platform
115{
116 if (is_host) {
117 ArchSpec hostArch = HostInfo::GetArchitecture(HostInfo::eArchKindDefault);
118 m_supported_architectures.push_back(hostArch);
119 if (hostArch.GetTriple().isArch64Bit()) {
121 HostInfo::GetArchitecture(HostInfo::eArchKind32));
122 }
123 } else {
125 {llvm::Triple::x86_64, llvm::Triple::x86, llvm::Triple::aarch64,
126 llvm::Triple::arm, llvm::Triple::mips64, llvm::Triple::ppc64,
127 llvm::Triple::ppc},
128 llvm::Triple::FreeBSD);
129 }
130}
131
132std::vector<ArchSpec>
135 return m_remote_platform_sp->GetSupportedArchitectures(process_host_arch);
137}
138
141
142#if LLDB_ENABLE_POSIX
143 // Display local kernel information only when we are running in host mode.
144 // Otherwise, we would end up printing non-FreeBSD information (when running
145 // on Mac OS for example).
146 if (IsHost()) {
147 struct utsname un;
148
149 if (uname(&un))
150 return;
151
152 strm.Printf(" Kernel: %s\n", un.sysname);
153 strm.Printf(" Release: %s\n", un.release);
154 strm.Printf(" Version: %s\n", un.version);
155 }
156#endif
157}
158
160 if (IsHost()) {
161 return true;
162 } else {
163 // If we're connected, we can debug.
164 return IsConnected();
165 }
166}
167
169 m_trap_handlers.push_back(ConstString("_sigtramp"));
170}
171
173 addr_t addr, addr_t length,
174 unsigned prot, unsigned flags,
175 addr_t fd, addr_t offset) {
176 uint64_t flags_platform = 0;
177
178 if (flags & eMmapFlagsPrivate)
179 flags_platform |= MAP_PRIVATE;
180 if (flags & eMmapFlagsAnon)
181 flags_platform |= MAP_ANON;
182
183 MmapArgList args({addr, length, prot, flags_platform, fd, offset});
184 if (arch.GetTriple().getArch() == llvm::Triple::x86)
185 args.push_back(0);
186 return args;
187}
188
190 {
191 std::lock_guard<std::mutex> guard(m_mutex);
192 if (!m_type_system)
193 m_type_system = std::make_shared<TypeSystemClang>("siginfo", triple);
194 }
195 TypeSystemClang *ast = m_type_system.get();
196
197 // generic types
198 CompilerType int_type = ast->GetBasicType(eBasicTypeInt);
200 CompilerType long_type = ast->GetBasicType(eBasicTypeLong);
202
203 // platform-specific types
204 CompilerType &pid_type = int_type;
205 CompilerType &uid_type = uint_type;
206
207 CompilerType sigval_type = ast->CreateRecordType(
208 nullptr, OptionalClangModuleID(), lldb::eAccessPublic, "__lldb_sigval_t",
209 clang::TTK_Union, lldb::eLanguageTypeC);
210 ast->StartTagDeclarationDefinition(sigval_type);
211 ast->AddFieldToRecordType(sigval_type, "sival_int", int_type,
213 ast->AddFieldToRecordType(sigval_type, "sival_ptr", voidp_type,
215 ast->CompleteTagDeclarationDefinition(sigval_type);
216
217 // siginfo_t
218 CompilerType siginfo_type = ast->CreateRecordType(
219 nullptr, OptionalClangModuleID(), lldb::eAccessPublic, "__lldb_siginfo_t",
220 clang::TTK_Struct, lldb::eLanguageTypeC);
221 ast->StartTagDeclarationDefinition(siginfo_type);
222 ast->AddFieldToRecordType(siginfo_type, "si_signo", int_type,
224 ast->AddFieldToRecordType(siginfo_type, "si_errno", int_type,
226 ast->AddFieldToRecordType(siginfo_type, "si_code", int_type,
228 ast->AddFieldToRecordType(siginfo_type, "si_pid", pid_type,
230 ast->AddFieldToRecordType(siginfo_type, "si_uid", uid_type,
232 ast->AddFieldToRecordType(siginfo_type, "si_status", int_type,
234 ast->AddFieldToRecordType(siginfo_type, "si_addr", voidp_type,
236 ast->AddFieldToRecordType(siginfo_type, "si_value", sigval_type,
238
239 // union used to hold the signal data
240 CompilerType union_type = ast->CreateRecordType(
242 clang::TTK_Union, lldb::eLanguageTypeC);
243 ast->StartTagDeclarationDefinition(union_type);
244
246 union_type, "_fault",
248 {
249 {"_trapno", int_type},
250 }),
252
254 union_type, "_timer",
256 {
257 {"_timerid", int_type},
258 {"_overrun", int_type},
259 }),
261
263 union_type, "_mesgq",
265 {
266 {"_mqd", int_type},
267 }),
269
271 union_type, "_poll",
273 {
274 {"_band", long_type},
275 }),
277
278 ast->CompleteTagDeclarationDefinition(union_type);
279 ast->AddFieldToRecordType(siginfo_type, "_reason", union_type,
281
282 ast->CompleteTagDeclarationDefinition(siginfo_type);
283 return siginfo_type;
284}
#define LLDB_LOG(log,...)
The LLDB_LOG* macros defined below are the way to emit log messages.
Definition: Log.h:337
static uint32_t g_initialize_count
#define MAP_ANON
#define MAP_PRIVATE
static uint32_t g_initialize_count
#define LLDB_PLUGIN_DEFINE(PluginName)
Definition: PluginManager.h:31
An architecture specification class.
Definition: ArchSpec.h:32
llvm::Triple & GetTriple()
Architecture triple accessor.
Definition: ArchSpec.h:463
Generic representation of a type in a programming language.
Definition: CompilerType.h:36
CompilerType GetPointerType() const
Return a new CompilerType that is a pointer to this type.
A uniqued constant string class.
Definition: ConstString.h:39
std::vector< ConstString > m_trap_handlers
Definition: Platform.h:926
static void Terminate()
Definition: Platform.cpp:141
static void SetHostPlatform(const lldb::PlatformSP &platform_sp)
Definition: Platform.cpp:148
virtual void GetStatus(Stream &strm)
Report the current status for this platform.
Definition: Platform.cpp:286
static void Initialize()
Definition: Platform.cpp:139
static std::vector< ArchSpec > CreateArchList(llvm::ArrayRef< llvm::Triple::ArchType > archs, llvm::Triple::OSType os)
Create a list of ArchSpecs with the given OS and a architectures.
Definition: Platform.cpp:1145
bool IsHost() const
Definition: Platform.h:421
static bool RegisterPlugin(llvm::StringRef name, llvm::StringRef description, ABICreateInstance create_callback)
static bool UnregisterPlugin(ABICreateInstance create_callback)
A stream class that can stream formatted output to a file.
Definition: Stream.h:28
size_t Printf(const char *format,...) __attribute__((format(printf
Output printf formatted output to the stream.
Definition: Stream.cpp:107
A TypeSystem implementation based on Clang.
CompilerType GetBasicType(lldb::BasicType type)
static clang::FieldDecl * AddFieldToRecordType(const CompilerType &type, llvm::StringRef name, const CompilerType &field_type, lldb::AccessType access, uint32_t bitfield_bit_size)
static bool CompleteTagDeclarationDefinition(const CompilerType &type)
CompilerType CreateStructForIdentifier(ConstString type_name, const std::initializer_list< std::pair< const char *, CompilerType > > &type_fields, bool packed=false)
static bool StartTagDeclarationDefinition(const CompilerType &type)
CompilerType CreateRecordType(clang::DeclContext *decl_ctx, OptionalClangModuleID owning_module, lldb::AccessType access_type, llvm::StringRef name, int kind, lldb::LanguageType language, ClangASTMetadata *metadata=nullptr, bool exports_symbols=false)
bool CanDebugProcess() override
Not all platforms will support debugging a process by spawning somehow halted for a debugger (specifi...
MmapArgList GetMmapArgumentList(const ArchSpec &arch, lldb::addr_t addr, lldb::addr_t length, unsigned prot, unsigned flags, lldb::addr_t fd, lldb::addr_t offset) override
PlatformFreeBSD(bool is_host)
Default Constructor.
static llvm::StringRef GetPluginNameStatic(bool is_host)
static lldb::PlatformSP CreateInstance(bool force, const ArchSpec *arch)
static llvm::StringRef GetPluginDescriptionStatic(bool is_host)
std::vector< ArchSpec > GetSupportedArchitectures(const ArchSpec &process_host_arch) override
Get the platform's supported architectures in the order in which they should be searched.
CompilerType GetSiginfoType(const llvm::Triple &triple) override
std::shared_ptr< TypeSystemClang > m_type_system
void GetStatus(Stream &strm) override
Report the current status for this platform.
void CalculateTrapHandlerSymbolNames() override
Ask the Platform subclass to fill in the list of trap handler names.
A class that represents a running process on the host machine.
Log * GetLog(Cat mask)
Retrieve the Log object for the channel associated with the given log enum.
Definition: Log.h:309
llvm::SmallVector< lldb::addr_t, 6 > MmapArgList
Definition: Platform.h:59
@ eMmapFlagsPrivate
Definition: Platform.h:41
@ eMmapFlagsAnon
Definition: Platform.h:41
Definition: SBAddress.h:15
@ eBasicTypeUnsignedInt
@ eLanguageTypeC
Non-standardized C, such as K&R.
uint64_t addr_t
Definition: lldb-types.h:83