1 //===-- PlatformNetBSD.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 "PlatformNetBSD.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/Core/Debugger.h"
18 #include "lldb/Core/PluginManager.h"
19 #include "lldb/Host/HostInfo.h"
20 #include "lldb/Target/Process.h"
21 #include "lldb/Target/Target.h"
22 #include "lldb/Utility/FileSpec.h"
23 #include "lldb/Utility/Log.h"
24 #include "lldb/Utility/State.h"
25 #include "lldb/Utility/Status.h"
26 #include "lldb/Utility/StreamString.h"
27 
28 // Define these constants from NetBSD mman.h for use when targeting remote
29 // netbsd systems even when host has different values.
30 #define MAP_PRIVATE 0x0002
31 #define MAP_ANON 0x1000
32 
33 using namespace lldb;
34 using namespace lldb_private;
35 using namespace lldb_private::platform_netbsd;
36 
37 LLDB_PLUGIN_DEFINE(PlatformNetBSD)
38 
39 static uint32_t g_initialize_count = 0;
40 
41 
42 PlatformSP PlatformNetBSD::CreateInstance(bool force, const ArchSpec *arch) {
43   Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_PLATFORM));
44   LLDB_LOG(log, "force = {0}, arch=({1}, {2})", force,
45            arch ? arch->GetArchitectureName() : "<null>",
46            arch ? arch->GetTriple().getTriple() : "<null>");
47 
48   bool create = force;
49   if (!create && arch && arch->IsValid()) {
50     const llvm::Triple &triple = arch->GetTriple();
51     switch (triple.getOS()) {
52     case llvm::Triple::NetBSD:
53       create = true;
54       break;
55 
56     default:
57       break;
58     }
59   }
60 
61   LLDB_LOG(log, "create = {0}", create);
62   if (create) {
63     return PlatformSP(new PlatformNetBSD(false));
64   }
65   return PlatformSP();
66 }
67 
68 llvm::StringRef PlatformNetBSD::GetPluginDescriptionStatic(bool is_host) {
69   if (is_host)
70     return "Local NetBSD user platform plug-in.";
71   return "Remote NetBSD user platform plug-in.";
72 }
73 
74 void PlatformNetBSD::Initialize() {
75   PlatformPOSIX::Initialize();
76 
77   if (g_initialize_count++ == 0) {
78 #if defined(__NetBSD__)
79     PlatformSP default_platform_sp(new PlatformNetBSD(true));
80     default_platform_sp->SetSystemArchitecture(HostInfo::GetArchitecture());
81     Platform::SetHostPlatform(default_platform_sp);
82 #endif
83     PluginManager::RegisterPlugin(
84         PlatformNetBSD::GetPluginNameStatic(false),
85         PlatformNetBSD::GetPluginDescriptionStatic(false),
86         PlatformNetBSD::CreateInstance, nullptr);
87   }
88 }
89 
90 void PlatformNetBSD::Terminate() {
91   if (g_initialize_count > 0) {
92     if (--g_initialize_count == 0) {
93       PluginManager::UnregisterPlugin(PlatformNetBSD::CreateInstance);
94     }
95   }
96 
97   PlatformPOSIX::Terminate();
98 }
99 
100 /// Default Constructor
101 PlatformNetBSD::PlatformNetBSD(bool is_host)
102     : PlatformPOSIX(is_host) // This is the local host platform
103 {}
104 
105 bool PlatformNetBSD::GetSupportedArchitectureAtIndex(uint32_t idx,
106                                                      ArchSpec &arch) {
107   if (IsHost()) {
108     ArchSpec hostArch = HostInfo::GetArchitecture(HostInfo::eArchKindDefault);
109     if (hostArch.GetTriple().isOSNetBSD()) {
110       if (idx == 0) {
111         arch = hostArch;
112         return arch.IsValid();
113       } else if (idx == 1) {
114         // If the default host architecture is 64-bit, look for a 32-bit
115         // variant
116         if (hostArch.IsValid() && hostArch.GetTriple().isArch64Bit()) {
117           arch = HostInfo::GetArchitecture(HostInfo::eArchKind32);
118           return arch.IsValid();
119         }
120       }
121     }
122   } else {
123     if (m_remote_platform_sp)
124       return m_remote_platform_sp->GetSupportedArchitectureAtIndex(idx, arch);
125 
126     llvm::Triple triple;
127     // Set the OS to NetBSD
128     triple.setOS(llvm::Triple::NetBSD);
129     // Set the architecture
130     switch (idx) {
131     case 0:
132       triple.setArchName("x86_64");
133       break;
134     case 1:
135       triple.setArchName("i386");
136       break;
137     default:
138       return false;
139     }
140     // Leave the vendor as "llvm::Triple:UnknownVendor" and don't specify the
141     // vendor by calling triple.SetVendorName("unknown") so that it is a
142     // "unspecified unknown". This means when someone calls
143     // triple.GetVendorName() it will return an empty string which indicates
144     // that the vendor can be set when two architectures are merged
145 
146     // Now set the triple into "arch" and return true
147     arch.SetTriple(triple);
148     return true;
149   }
150   return false;
151 }
152 
153 void PlatformNetBSD::GetStatus(Stream &strm) {
154   Platform::GetStatus(strm);
155 
156 #if LLDB_ENABLE_POSIX
157   // Display local kernel information only when we are running in host mode.
158   // Otherwise, we would end up printing non-NetBSD information (when running
159   // on Mac OS for example).
160   if (IsHost()) {
161     struct utsname un;
162 
163     if (uname(&un))
164       return;
165 
166     strm.Printf("    Kernel: %s\n", un.sysname);
167     strm.Printf("   Release: %s\n", un.release);
168     strm.Printf("   Version: %s\n", un.version);
169   }
170 #endif
171 }
172 
173 uint32_t
174 PlatformNetBSD::GetResumeCountForLaunchInfo(ProcessLaunchInfo &launch_info) {
175   uint32_t resume_count = 0;
176 
177   // Always resume past the initial stop when we use eLaunchFlagDebug
178   if (launch_info.GetFlags().Test(eLaunchFlagDebug)) {
179     // Resume past the stop for the final exec into the true inferior.
180     ++resume_count;
181   }
182 
183   // If we're not launching a shell, we're done.
184   const FileSpec &shell = launch_info.GetShell();
185   if (!shell)
186     return resume_count;
187 
188   std::string shell_string = shell.GetPath();
189   // We're in a shell, so for sure we have to resume past the shell exec.
190   ++resume_count;
191 
192   // Figure out what shell we're planning on using.
193   const char *shell_name = strrchr(shell_string.c_str(), '/');
194   if (shell_name == nullptr)
195     shell_name = shell_string.c_str();
196   else
197     shell_name++;
198 
199   if (strcmp(shell_name, "csh") == 0 || strcmp(shell_name, "tcsh") == 0 ||
200       strcmp(shell_name, "zsh") == 0 || strcmp(shell_name, "sh") == 0) {
201     // These shells seem to re-exec themselves.  Add another resume.
202     ++resume_count;
203   }
204 
205   return resume_count;
206 }
207 
208 bool PlatformNetBSD::CanDebugProcess() {
209   if (IsHost()) {
210     return true;
211   } else {
212     // If we're connected, we can debug.
213     return IsConnected();
214   }
215 }
216 
217 void PlatformNetBSD::CalculateTrapHandlerSymbolNames() {
218   m_trap_handlers.push_back(ConstString("_sigtramp"));
219 }
220 
221 MmapArgList PlatformNetBSD::GetMmapArgumentList(const ArchSpec &arch,
222                                                 addr_t addr, addr_t length,
223                                                 unsigned prot, unsigned flags,
224                                                 addr_t fd, addr_t offset) {
225   uint64_t flags_platform = 0;
226 
227   if (flags & eMmapFlagsPrivate)
228     flags_platform |= MAP_PRIVATE;
229   if (flags & eMmapFlagsAnon)
230     flags_platform |= MAP_ANON;
231 
232   MmapArgList args({addr, length, prot, flags_platform, fd, offset});
233   return args;
234 }
235