285 lines · cpp
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-exception6//7//===----------------------------------------------------------------------===//8 9#include "PlatformFreeBSD.h"10#include "lldb/Host/Config.h"11 12#include <cstdio>13#if LLDB_ENABLE_POSIX14#include <sys/utsname.h>15#endif16 17#include "lldb/Breakpoint/BreakpointLocation.h"18#include "lldb/Breakpoint/BreakpointSite.h"19#include "lldb/Core/Debugger.h"20#include "lldb/Core/PluginManager.h"21#include "lldb/Host/HostInfo.h"22#include "lldb/Target/Process.h"23#include "lldb/Target/Target.h"24#include "lldb/Utility/FileSpec.h"25#include "lldb/Utility/LLDBLog.h"26#include "lldb/Utility/Log.h"27#include "lldb/Utility/State.h"28#include "lldb/Utility/Status.h"29#include "lldb/Utility/StreamString.h"30 31#include "llvm/TargetParser/Host.h"32#include "llvm/TargetParser/Triple.h"33 34// Define these constants from FreeBSD mman.h for use when targeting remote35// FreeBSD systems even when host has different values.36#define MAP_PRIVATE 0x000237#define MAP_ANON 0x100038 39using namespace lldb;40using namespace lldb_private;41using namespace lldb_private::platform_freebsd;42 43LLDB_PLUGIN_DEFINE(PlatformFreeBSD)44 45static uint32_t g_initialize_count = 0;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#endif69 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 86void PlatformFreeBSD::Initialize() {87 Platform::Initialize();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#endif95 PluginManager::RegisterPlugin(96 PlatformFreeBSD::GetPluginNameStatic(false),97 PlatformFreeBSD::GetPluginDescriptionStatic(false),98 PlatformFreeBSD::CreateInstance, nullptr);99 }100}101 102void PlatformFreeBSD::Terminate() {103 if (g_initialize_count > 0) {104 if (--g_initialize_count == 0) {105 PluginManager::UnregisterPlugin(PlatformFreeBSD::CreateInstance);106 }107 }108 109 PlatformPOSIX::Terminate();110}111 112/// Default Constructor113PlatformFreeBSD::PlatformFreeBSD(bool is_host)114 : PlatformPOSIX(is_host) // This is the local host platform115{116 if (is_host) {117 ArchSpec hostArch = HostInfo::GetArchitecture(HostInfo::eArchKindDefault);118 m_supported_architectures.push_back(hostArch);119 if (hostArch.GetTriple().isArch64Bit()) {120 m_supported_architectures.push_back(121 HostInfo::GetArchitecture(HostInfo::eArchKind32));122 }123 } else {124 m_supported_architectures = CreateArchList(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>133PlatformFreeBSD::GetSupportedArchitectures(const ArchSpec &process_host_arch) {134 if (m_remote_platform_sp)135 return m_remote_platform_sp->GetSupportedArchitectures(process_host_arch);136 return m_supported_architectures;137}138 139void PlatformFreeBSD::GetStatus(Stream &strm) {140 Platform::GetStatus(strm);141 142#if LLDB_ENABLE_POSIX143 // Display local kernel information only when we are running in host mode.144 // Otherwise, we would end up printing non-FreeBSD information (when running145 // 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#endif157}158 159bool PlatformFreeBSD::CanDebugProcess() {160 if (IsHost()) {161 return true;162 } else {163 // If we're connected, we can debug.164 return IsConnected();165 }166}167 168void PlatformFreeBSD::CalculateTrapHandlerSymbolNames() {169 m_trap_handlers.push_back(ConstString("_sigtramp"));170}171 172MmapArgList PlatformFreeBSD::GetMmapArgumentList(const ArchSpec &arch,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 189CompilerType PlatformFreeBSD::GetSiginfoType(const llvm::Triple &triple) {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 types198 CompilerType int_type = ast->GetBasicType(eBasicTypeInt);199 CompilerType uint_type = ast->GetBasicType(eBasicTypeUnsignedInt);200 CompilerType long_type = ast->GetBasicType(eBasicTypeLong);201 CompilerType voidp_type = ast->GetBasicType(eBasicTypeVoid).GetPointerType();202 203 // platform-specific types204 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 llvm::to_underlying(clang::TagTypeKind::Union), lldb::eLanguageTypeC);210 ast->StartTagDeclarationDefinition(sigval_type);211 ast->AddFieldToRecordType(sigval_type, "sival_int", int_type,212 lldb::eAccessPublic, 0);213 ast->AddFieldToRecordType(sigval_type, "sival_ptr", voidp_type,214 lldb::eAccessPublic, 0);215 ast->CompleteTagDeclarationDefinition(sigval_type);216 217 // siginfo_t218 CompilerType siginfo_type = ast->CreateRecordType(219 nullptr, OptionalClangModuleID(), lldb::eAccessPublic, "__lldb_siginfo_t",220 llvm::to_underlying(clang::TagTypeKind::Struct), lldb::eLanguageTypeC);221 ast->StartTagDeclarationDefinition(siginfo_type);222 ast->AddFieldToRecordType(siginfo_type, "si_signo", int_type,223 lldb::eAccessPublic, 0);224 ast->AddFieldToRecordType(siginfo_type, "si_errno", int_type,225 lldb::eAccessPublic, 0);226 ast->AddFieldToRecordType(siginfo_type, "si_code", int_type,227 lldb::eAccessPublic, 0);228 ast->AddFieldToRecordType(siginfo_type, "si_pid", pid_type,229 lldb::eAccessPublic, 0);230 ast->AddFieldToRecordType(siginfo_type, "si_uid", uid_type,231 lldb::eAccessPublic, 0);232 ast->AddFieldToRecordType(siginfo_type, "si_status", int_type,233 lldb::eAccessPublic, 0);234 ast->AddFieldToRecordType(siginfo_type, "si_addr", voidp_type,235 lldb::eAccessPublic, 0);236 ast->AddFieldToRecordType(siginfo_type, "si_value", sigval_type,237 lldb::eAccessPublic, 0);238 239 // union used to hold the signal data240 CompilerType union_type = ast->CreateRecordType(241 nullptr, OptionalClangModuleID(), lldb::eAccessPublic, "",242 llvm::to_underlying(clang::TagTypeKind::Union), lldb::eLanguageTypeC);243 ast->StartTagDeclarationDefinition(union_type);244 245 ast->AddFieldToRecordType(246 union_type, "_fault",247 ast->CreateStructForIdentifier(llvm::StringRef(),248 {249 {"_trapno", int_type},250 }),251 lldb::eAccessPublic, 0);252 253 ast->AddFieldToRecordType(254 union_type, "_timer",255 ast->CreateStructForIdentifier(llvm::StringRef(),256 {257 {"_timerid", int_type},258 {"_overrun", int_type},259 }),260 lldb::eAccessPublic, 0);261 262 ast->AddFieldToRecordType(263 union_type, "_mesgq",264 ast->CreateStructForIdentifier(llvm::StringRef(),265 {266 {"_mqd", int_type},267 }),268 lldb::eAccessPublic, 0);269 270 ast->AddFieldToRecordType(271 union_type, "_poll",272 ast->CreateStructForIdentifier(llvm::StringRef(),273 {274 {"_band", long_type},275 }),276 lldb::eAccessPublic, 0);277 278 ast->CompleteTagDeclarationDefinition(union_type);279 ast->AddFieldToRecordType(siginfo_type, "_reason", union_type,280 lldb::eAccessPublic, 0);281 282 ast->CompleteTagDeclarationDefinition(siginfo_type);283 return siginfo_type;284}285