LLDB mainline
HostNetBSD.cpp
Go to the documentation of this file.
1//===-- source/Host/netbsd/HostNetBSD.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 <cstdio>
10#include <dlfcn.h>
11#include <execinfo.h>
12#include <sys/proc.h>
13#include <sys/sysctl.h>
14#include <sys/types.h>
15
16#include <climits>
17
18#include <kvm.h>
19#include <sys/exec.h>
20#include <sys/ptrace.h>
21
23#include "lldb/Host/Host.h"
24#include "lldb/Host/HostInfo.h"
27#include "lldb/Utility/Endian.h"
29#include "lldb/Utility/Log.h"
32#include "lldb/Utility/Status.h"
34
35#include "llvm/Object/ELF.h"
36#include "llvm/TargetParser/Host.h"
37
38extern "C" {
39extern char **environ;
40}
41
42using namespace lldb;
43using namespace lldb_private;
44
45namespace lldb_private {
47}
48
50
51static bool GetNetBSDProcessArgs(const ProcessInstanceInfoMatch *match_info_ptr,
52 ProcessInstanceInfo &process_info) {
53 if (!process_info.ProcessIDIsValid())
54 return false;
55
56 int pid = process_info.GetProcessID();
57
58 int mib[4] = {CTL_KERN, KERN_PROC_ARGS, pid, KERN_PROC_ARGV};
59
60 char arg_data[8192];
61 size_t arg_data_size = sizeof(arg_data);
62 if (::sysctl(mib, 4, arg_data, &arg_data_size, NULL, 0) != 0)
63 return false;
64
65 DataExtractor data(arg_data, arg_data_size, endian::InlHostByteOrder(),
66 sizeof(void *));
67 lldb::offset_t offset = 0;
68 const char *cstr;
69
70 cstr = data.GetCStr(&offset);
71 if (!cstr)
72 return false;
73
74 process_info.GetExecutableFile().SetFile(cstr,
75 FileSpec::Style::native);
76
77 if (!(match_info_ptr == NULL ||
79 match_info_ptr->GetNameMatchType(),
80 match_info_ptr->GetProcessInfo().GetName())))
81 return false;
82
83 process_info.SetArg0(cstr);
84 Args &proc_args = process_info.GetArguments();
85 while (1) {
86 const uint8_t *p = data.PeekData(offset, 1);
87 while ((p != NULL) && (*p == '\0') && offset < arg_data_size) {
88 ++offset;
89 p = data.PeekData(offset, 1);
90 }
91 if (p == NULL || offset >= arg_data_size)
92 break;
93
94 cstr = data.GetCStr(&offset);
95 if (!cstr)
96 break;
97
98 proc_args.AppendArgument(llvm::StringRef(cstr));
99 }
100
101 return true;
102}
103
105 Log *log = GetLog(LLDBLog::Host);
106
107 if (process_info.ProcessIDIsValid()) {
108 auto buffer_sp = FileSystem::Instance().CreateDataBuffer(
109 process_info.GetExecutableFile(), 0x20, 0);
110 if (buffer_sp) {
111 uint8_t exe_class =
112 llvm::object::getElfArchType(
113 {reinterpret_cast<const char *>(buffer_sp->GetBytes()),
114 size_t(buffer_sp->GetByteSize())})
115 .first;
116
117 switch (exe_class) {
118 case llvm::ELF::ELFCLASS32:
119 process_info.GetArchitecture() =
120 HostInfo::GetArchitecture(HostInfo::eArchKind32);
121 return true;
122 case llvm::ELF::ELFCLASS64:
123 process_info.GetArchitecture() =
124 HostInfo::GetArchitecture(HostInfo::eArchKind64);
125 return true;
126 default:
127 LLDB_LOG(log, "Unknown elf class ({0}) in file {1}", exe_class,
128 process_info.GetExecutableFile());
129 }
130 }
131 }
132 process_info.GetArchitecture().Clear();
133 return false;
134}
135
137 ::kvm_t *kdp;
138 char errbuf[_POSIX2_LINE_MAX]; /* XXX: error string unused */
139
140 struct ::kinfo_proc2 *proc_kinfo;
141 const int pid = process_info.GetProcessID();
142 int nproc;
143
144 if (!process_info.ProcessIDIsValid())
145 goto error;
146
147 if ((kdp = ::kvm_openfiles(NULL, NULL, NULL, KVM_NO_FILES, errbuf)) == NULL)
148 goto error;
149
150 if ((proc_kinfo = ::kvm_getproc2(kdp, KERN_PROC_PID, pid,
151 sizeof(struct ::kinfo_proc2), &nproc)) ==
152 NULL) {
153 ::kvm_close(kdp);
154 goto error;
155 }
156
157 if (nproc < 1) {
158 ::kvm_close(kdp); /* XXX: we don't check for error here */
159 goto error;
160 }
161
162 process_info.SetParentProcessID(proc_kinfo->p_ppid);
163 process_info.SetUserID(proc_kinfo->p_ruid);
164 process_info.SetGroupID(proc_kinfo->p_rgid);
165 process_info.SetEffectiveUserID(proc_kinfo->p_uid);
166 process_info.SetEffectiveGroupID(proc_kinfo->p_gid);
167
168 ::kvm_close(kdp); /* XXX: we don't check for error here */
169
170 return true;
171
172error:
174 process_info.SetUserID(UINT32_MAX);
175 process_info.SetGroupID(UINT32_MAX);
176 process_info.SetEffectiveUserID(UINT32_MAX);
177 process_info.SetEffectiveGroupID(UINT32_MAX);
178 return false;
179}
180
181uint32_t Host::FindProcessesImpl(const ProcessInstanceInfoMatch &match_info,
182 ProcessInstanceInfoList &process_infos) {
183 const ::pid_t our_pid = ::getpid();
184 const ::uid_t our_uid = ::getuid();
185
186 const bool all_users =
187 match_info.GetMatchAllUsers() ||
188 // Special case, if lldb is being run as root we can attach to anything
189 (our_uid == 0);
190
191 kvm_t *kdp;
192 char errbuf[_POSIX2_LINE_MAX]; /* XXX: error string unused */
193 if ((kdp = ::kvm_openfiles(NULL, NULL, NULL, KVM_NO_FILES, errbuf)) == NULL)
194 return 0;
195
196 struct ::kinfo_proc2 *proc_kinfo;
197 int nproc;
198 if ((proc_kinfo = ::kvm_getproc2(kdp, KERN_PROC_ALL, 0,
199 sizeof(struct ::kinfo_proc2), &nproc)) ==
200 NULL) {
201 ::kvm_close(kdp);
202 return 0;
203 }
204
205 ProcessInstanceInfoMatch match_info_noname{match_info};
206 match_info_noname.SetNameMatchType(NameMatch::Ignore);
207
208 for (int i = 0; i < nproc; i++) {
209 if (proc_kinfo[i].p_pid < 1)
210 continue; /* not valid */
211 /* Make sure the user is acceptable */
212 if (!all_users && proc_kinfo[i].p_ruid != our_uid)
213 continue;
214
215 if (proc_kinfo[i].p_pid == our_pid || // Skip this process
216 proc_kinfo[i].p_pid == 0 || // Skip kernel (kernel pid is 0)
217 proc_kinfo[i].p_stat == LSZOMB || // Zombies are bad
218 proc_kinfo[i].p_flag & P_TRACED || // Being debugged?
219 proc_kinfo[i].p_flag & P_WEXIT) // Working on exiting
220 continue;
221
222 // Every thread is a process in NetBSD, but all the threads of a single
223 // process have the same pid. Do not store the process info in the result
224 // list if a process with given identifier is already registered there.
225 if (proc_kinfo[i].p_nlwps > 1) {
226 bool already_registered = false;
227 for (size_t pi = 0; pi < process_infos.size(); pi++) {
228 if ((::pid_t)process_infos[pi].GetProcessID() == proc_kinfo[i].p_pid) {
229 already_registered = true;
230 break;
231 }
232 }
233
234 if (already_registered)
235 continue;
236 }
237 ProcessInstanceInfo process_info;
238 process_info.SetProcessID(proc_kinfo[i].p_pid);
239 process_info.SetParentProcessID(proc_kinfo[i].p_ppid);
240 process_info.SetUserID(proc_kinfo[i].p_ruid);
241 process_info.SetGroupID(proc_kinfo[i].p_rgid);
242 process_info.SetEffectiveUserID(proc_kinfo[i].p_uid);
243 process_info.SetEffectiveGroupID(proc_kinfo[i].p_gid);
244 // Make sure our info matches before we go fetch the name and cpu type
245 if (match_info_noname.Matches(process_info) &&
246 GetNetBSDProcessArgs(&match_info, process_info)) {
247 GetNetBSDProcessCPUType(process_info);
248 if (match_info.Matches(process_info))
249 process_infos.push_back(process_info);
250 }
251 }
252
253 kvm_close(kdp); /* XXX: we don't check for error here */
254
255 return process_infos.size();
256}
257
259 process_info.SetProcessID(pid);
260
261 if (GetNetBSDProcessArgs(NULL, process_info)) {
262 GetNetBSDProcessCPUType(process_info);
263 GetNetBSDProcessUserAndGroup(process_info);
264 return true;
265 }
266
267 process_info.Clear();
268 return false;
269}
270
272 return Status("unimplemented");
273}
static llvm::raw_ostream & error(Stream &strm)
static bool GetNetBSDProcessArgs(const ProcessInstanceInfoMatch *match_info_ptr, ProcessInstanceInfo &process_info)
Definition: HostNetBSD.cpp:51
static bool GetNetBSDProcessUserAndGroup(ProcessInstanceInfo &process_info)
Definition: HostNetBSD.cpp:136
char ** environ
static bool GetNetBSDProcessCPUType(ProcessInstanceInfo &process_info)
Definition: HostNetBSD.cpp:104
#define LLDB_LOG(log,...)
The LLDB_LOG* macros defined below are the way to emit log messages.
Definition: Log.h:359
void Clear()
Clears the object state.
Definition: ArchSpec.cpp:542
A command line argument class.
Definition: Args.h:33
void AppendArgument(llvm::StringRef arg_str, char quote_char='\0')
Appends a new argument to the end of the list argument list.
Definition: Args.cpp:322
const char * GetCString() const
Get the string value as a C string.
Definition: ConstString.h:216
An data extractor class.
Definition: DataExtractor.h:48
const char * GetCStr(lldb::offset_t *offset_ptr) const
Extract a C string from *offset_ptr.
const uint8_t * PeekData(lldb::offset_t offset, lldb::offset_t length) const
Peek at a bytes at offset.
void SetFile(llvm::StringRef path, Style style)
Change the file specified with a new path.
Definition: FileSpec.cpp:174
const ConstString & GetFilename() const
Filename string const get accessor.
Definition: FileSpec.h:240
static FileSystem & Instance()
std::shared_ptr< DataBuffer > CreateDataBuffer(const llvm::Twine &path, uint64_t size=0, uint64_t offset=0)
Create memory buffer from path.
static Status ShellExpandArguments(ProcessLaunchInfo &launch_info)
Perform expansion of the command-line for this launch info This can potentially involve wildcard expa...
static Environment GetEnvironment()
static uint32_t FindProcessesImpl(const ProcessInstanceInfoMatch &match_info, ProcessInstanceInfoList &proc_infos)
static bool GetProcessInfo(lldb::pid_t pid, ProcessInstanceInfo &proc_info)
void SetGroupID(uint32_t gid)
Definition: ProcessInfo.h:60
bool ProcessIDIsValid() const
Definition: ProcessInfo.h:72
void SetArg0(llvm::StringRef arg)
Definition: ProcessInfo.cpp:82
const char * GetName() const
Definition: ProcessInfo.cpp:45
lldb::pid_t GetProcessID() const
Definition: ProcessInfo.h:68
void SetProcessID(lldb::pid_t pid)
Definition: ProcessInfo.h:70
FileSpec & GetExecutableFile()
Definition: ProcessInfo.h:43
void SetUserID(uint32_t uid)
Definition: ProcessInfo.h:58
ArchSpec & GetArchitecture()
Definition: ProcessInfo.h:62
bool Matches(const ProcessInstanceInfo &proc_info) const
void SetNameMatchType(NameMatch name_match_type)
Definition: ProcessInfo.h:318
ProcessInstanceInfo & GetProcessInfo()
Definition: ProcessInfo.h:308
void SetEffectiveGroupID(uint32_t gid)
Definition: ProcessInfo.h:170
void SetParentProcessID(lldb::pid_t pid)
Definition: ProcessInfo.h:174
void SetEffectiveUserID(uint32_t uid)
Definition: ProcessInfo.h:168
An error handling class.
Definition: Status.h:44
char ** environ
#define UINT32_MAX
Definition: lldb-defines.h:19
#define LLDB_INVALID_PROCESS_ID
Definition: lldb-defines.h:89
lldb::ByteOrder InlHostByteOrder()
Definition: Endian.h:25
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:331
bool NameMatches(llvm::StringRef name, NameMatch match_type, llvm::StringRef match)
Definition: NameMatches.cpp:15
std::vector< ProcessInstanceInfo > ProcessInstanceInfoList
Definition: Host.h:32
Definition: SBAddress.h:15
uint64_t offset_t
Definition: lldb-types.h:85
uint64_t pid_t
Definition: lldb-types.h:83