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 
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/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 
39 using namespace lldb;
40 using namespace lldb_private;
41 using namespace lldb_private::platform_freebsd;
42 
43 LLDB_PLUGIN_DEFINE(PlatformFreeBSD)
44 
45 static uint32_t g_initialize_count = 0;
46 
47 
48 PlatformSP 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 
80 llvm::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 
86 void 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 #endif
95     PluginManager::RegisterPlugin(
96         PlatformFreeBSD::GetPluginNameStatic(false),
97         PlatformFreeBSD::GetPluginDescriptionStatic(false),
98         PlatformFreeBSD::CreateInstance, nullptr);
99   }
100 }
101 
102 void 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 Constructor
113 PlatformFreeBSD::PlatformFreeBSD(bool is_host)
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()) {
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 
132 std::vector<ArchSpec> PlatformFreeBSD::GetSupportedArchitectures() {
133   if (m_remote_platform_sp)
134     return m_remote_platform_sp->GetSupportedArchitectures();
135   return m_supported_architectures;
136 }
137 
138 void PlatformFreeBSD::GetStatus(Stream &strm) {
139   Platform::GetStatus(strm);
140 
141 #if LLDB_ENABLE_POSIX
142   // Display local kernel information only when we are running in host mode.
143   // Otherwise, we would end up printing non-FreeBSD information (when running
144   // on Mac OS for example).
145   if (IsHost()) {
146     struct utsname un;
147 
148     if (uname(&un))
149       return;
150 
151     strm.Printf("    Kernel: %s\n", un.sysname);
152     strm.Printf("   Release: %s\n", un.release);
153     strm.Printf("   Version: %s\n", un.version);
154   }
155 #endif
156 }
157 
158 bool PlatformFreeBSD::CanDebugProcess() {
159   if (IsHost()) {
160     return true;
161   } else {
162     // If we're connected, we can debug.
163     return IsConnected();
164   }
165 }
166 
167 void PlatformFreeBSD::CalculateTrapHandlerSymbolNames() {
168   m_trap_handlers.push_back(ConstString("_sigtramp"));
169 }
170 
171 MmapArgList PlatformFreeBSD::GetMmapArgumentList(const ArchSpec &arch,
172                                                  addr_t addr, addr_t length,
173                                                  unsigned prot, unsigned flags,
174                                                  addr_t fd, addr_t offset) {
175   uint64_t flags_platform = 0;
176 
177   if (flags & eMmapFlagsPrivate)
178     flags_platform |= MAP_PRIVATE;
179   if (flags & eMmapFlagsAnon)
180     flags_platform |= MAP_ANON;
181 
182   MmapArgList args({addr, length, prot, flags_platform, fd, offset});
183   if (arch.GetTriple().getArch() == llvm::Triple::x86)
184     args.push_back(0);
185   return args;
186 }
187 
188 CompilerType PlatformFreeBSD::GetSiginfoType(const llvm::Triple &triple) {
189   if (!m_type_system_up)
190     m_type_system_up.reset(new TypeSystemClang("siginfo", triple));
191   TypeSystemClang *ast = m_type_system_up.get();
192 
193   // generic types
194   CompilerType int_type = ast->GetBasicType(eBasicTypeInt);
195   CompilerType uint_type = ast->GetBasicType(eBasicTypeUnsignedInt);
196   CompilerType long_type = ast->GetBasicType(eBasicTypeLong);
197   CompilerType voidp_type = ast->GetBasicType(eBasicTypeVoid).GetPointerType();
198 
199   // platform-specific types
200   CompilerType &pid_type = int_type;
201   CompilerType &uid_type = uint_type;
202 
203   CompilerType sigval_type = ast->CreateRecordType(
204       nullptr, OptionalClangModuleID(), lldb::eAccessPublic, "__lldb_sigval_t",
205       clang::TTK_Union, lldb::eLanguageTypeC);
206   ast->StartTagDeclarationDefinition(sigval_type);
207   ast->AddFieldToRecordType(sigval_type, "sival_int", int_type,
208                             lldb::eAccessPublic, 0);
209   ast->AddFieldToRecordType(sigval_type, "sival_ptr", voidp_type,
210                             lldb::eAccessPublic, 0);
211   ast->CompleteTagDeclarationDefinition(sigval_type);
212 
213   // siginfo_t
214   CompilerType siginfo_type = ast->CreateRecordType(
215       nullptr, OptionalClangModuleID(), lldb::eAccessPublic, "__lldb_siginfo_t",
216       clang::TTK_Struct, lldb::eLanguageTypeC);
217   ast->StartTagDeclarationDefinition(siginfo_type);
218   ast->AddFieldToRecordType(siginfo_type, "si_signo", int_type,
219                             lldb::eAccessPublic, 0);
220   ast->AddFieldToRecordType(siginfo_type, "si_errno", int_type,
221                             lldb::eAccessPublic, 0);
222   ast->AddFieldToRecordType(siginfo_type, "si_code", int_type,
223                             lldb::eAccessPublic, 0);
224   ast->AddFieldToRecordType(siginfo_type, "si_pid", pid_type,
225                             lldb::eAccessPublic, 0);
226   ast->AddFieldToRecordType(siginfo_type, "si_uid", uid_type,
227                             lldb::eAccessPublic, 0);
228   ast->AddFieldToRecordType(siginfo_type, "si_status", int_type,
229                             lldb::eAccessPublic, 0);
230   ast->AddFieldToRecordType(siginfo_type, "si_addr", voidp_type,
231                             lldb::eAccessPublic, 0);
232   ast->AddFieldToRecordType(siginfo_type, "si_value", sigval_type,
233                             lldb::eAccessPublic, 0);
234 
235   // union used to hold the signal data
236   CompilerType union_type = ast->CreateRecordType(
237       nullptr, OptionalClangModuleID(), lldb::eAccessPublic, "",
238       clang::TTK_Union, lldb::eLanguageTypeC);
239   ast->StartTagDeclarationDefinition(union_type);
240 
241   ast->AddFieldToRecordType(
242       union_type, "_fault",
243       ast->CreateStructForIdentifier(ConstString(),
244                                      {
245                                          {"_trapno", int_type},
246                                      }),
247       lldb::eAccessPublic, 0);
248 
249   ast->AddFieldToRecordType(
250       union_type, "_timer",
251       ast->CreateStructForIdentifier(ConstString(),
252                                      {
253                                          {"_timerid", int_type},
254                                          {"_overrun", int_type},
255                                      }),
256       lldb::eAccessPublic, 0);
257 
258   ast->AddFieldToRecordType(
259       union_type, "_mesgq",
260       ast->CreateStructForIdentifier(ConstString(),
261                                      {
262                                          {"_mqd", int_type},
263                                      }),
264       lldb::eAccessPublic, 0);
265 
266   ast->AddFieldToRecordType(
267       union_type, "_poll",
268       ast->CreateStructForIdentifier(ConstString(),
269                                      {
270                                          {"_band", long_type},
271                                      }),
272       lldb::eAccessPublic, 0);
273 
274   ast->CompleteTagDeclarationDefinition(union_type);
275   ast->AddFieldToRecordType(siginfo_type, "_reason", union_type,
276                             lldb::eAccessPublic, 0);
277 
278   ast->CompleteTagDeclarationDefinition(siginfo_type);
279   return siginfo_type;
280 }
281