1//===-- source/Host/freebsd/Host.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 <sys/types.h>
10
11#include <sys/exec.h>
12#include <sys/proc.h>
13#include <sys/ptrace.h>
14#include <sys/sysctl.h>
15#include <sys/user.h>
16
17#include <machine/elf.h>
18
19#include <cstdio>
20#include <dlfcn.h>
21#include <execinfo.h>
22
23#include "lldb/Host/Host.h"
24#include "lldb/Host/HostInfo.h"
25#include "lldb/Utility/DataBufferHeap.h"
26#include "lldb/Utility/DataExtractor.h"
27#include "lldb/Utility/Endian.h"
28#include "lldb/Utility/Log.h"
29#include "lldb/Utility/NameMatches.h"
30#include "lldb/Utility/ProcessInfo.h"
31#include "lldb/Utility/Status.h"
32#include "lldb/Utility/StreamString.h"
33
34#include "llvm/TargetParser/Host.h"
35
36namespace lldb_private {
37class ProcessLaunchInfo;
38}
39
40using namespace lldb;
41using namespace lldb_private;
42
43static bool
44GetFreeBSDProcessArgs(const ProcessInstanceInfoMatch *match_info_ptr,
45 ProcessInstanceInfo &process_info) {
46 if (!process_info.ProcessIDIsValid())
47 return false;
48
49 int pid = process_info.GetProcessID();
50
51 int mib[4] = {CTL_KERN, KERN_PROC, KERN_PROC_ARGS, pid};
52
53 char arg_data[8192];
54 size_t arg_data_size = sizeof(arg_data);
55 if (::sysctl(mib, 4, arg_data, &arg_data_size, NULL, 0) != 0)
56 return false;
57
58 DataExtractor data(arg_data, arg_data_size, endian::InlHostByteOrder(),
59 sizeof(void *));
60 lldb::offset_t offset = 0;
61 const char *cstr;
62
63 cstr = data.GetCStr(offset_ptr: &offset);
64 if (!cstr)
65 return false;
66
67 // Get pathname for pid. If that fails fall back to argv[0].
68 char pathname[MAXPATHLEN];
69 size_t pathname_len = sizeof(pathname);
70 mib[2] = KERN_PROC_PATHNAME;
71 if (::sysctl(sysno: mib, 4, pathname, &pathname_len, NULL, 0) == 0)
72 process_info.GetExecutableFile().SetFile(pathname, FileSpec::Style::native);
73 else
74 process_info.GetExecutableFile().SetFile(path: cstr, style: FileSpec::Style::native);
75
76 if (!(match_info_ptr == NULL ||
77 NameMatches(name: process_info.GetExecutableFile().GetFilename().GetCString(),
78 match_type: match_info_ptr->GetNameMatchType(),
79 match: match_info_ptr->GetProcessInfo().GetName())))
80 return false;
81
82 process_info.SetArg0(cstr);
83 Args &proc_args = process_info.GetArguments();
84 while (1) {
85 const uint8_t *p = data.PeekData(offset, length: 1);
86 while ((p != NULL) && (*p == '\0') && offset < arg_data_size) {
87 ++offset;
88 p = data.PeekData(offset, length: 1);
89 }
90 if (p == NULL || offset >= arg_data_size)
91 break;
92
93 cstr = data.GetCStr(offset_ptr: &offset);
94 if (!cstr)
95 break;
96
97 proc_args.AppendArgument(arg_str: llvm::StringRef(cstr));
98 }
99
100 return true;
101}
102
103static bool GetFreeBSDProcessCPUType(ProcessInstanceInfo &process_info) {
104 if (process_info.ProcessIDIsValid()) {
105 process_info.GetArchitecture() =
106 HostInfo::GetArchitecture(arch_kind: HostInfo::eArchKindDefault);
107 return true;
108 }
109 process_info.GetArchitecture().Clear();
110 return false;
111}
112
113static bool GetFreeBSDProcessUserAndGroup(ProcessInstanceInfo &process_info) {
114 struct kinfo_proc proc_kinfo;
115 size_t proc_kinfo_size;
116 const int pid = process_info.GetProcessID();
117 int mib[4] = {CTL_KERN, KERN_PROC, KERN_PROC_PID, pid};
118
119 if (!process_info.ProcessIDIsValid())
120 goto error;
121
122 proc_kinfo_size = sizeof(struct kinfo_proc);
123
124 if (::sysctl(sysno: mib, 4, &proc_kinfo, &proc_kinfo_size, NULL, 0) != 0)
125 goto error;
126
127 if (proc_kinfo_size == 0)
128 goto error;
129
130 process_info.SetParentProcessID(proc_kinfo.ki_ppid);
131 process_info.SetUserID(proc_kinfo.ki_ruid);
132 process_info.SetGroupID(proc_kinfo.ki_rgid);
133 process_info.SetEffectiveUserID(proc_kinfo.ki_uid);
134 if (proc_kinfo.ki_ngroups > 0)
135 process_info.SetEffectiveGroupID(proc_kinfo.ki_groups[0]);
136 else
137 process_info.SetEffectiveGroupID(UINT32_MAX);
138 return true;
139
140error:
141 process_info.SetParentProcessID(LLDB_INVALID_PROCESS_ID);
142 process_info.SetUserID(UINT32_MAX);
143 process_info.SetGroupID(UINT32_MAX);
144 process_info.SetEffectiveUserID(UINT32_MAX);
145 process_info.SetEffectiveGroupID(UINT32_MAX);
146 return false;
147}
148
149uint32_t Host::FindProcessesImpl(const ProcessInstanceInfoMatch &match_info,
150 ProcessInstanceInfoList &process_infos) {
151 const ::pid_t our_pid = ::getpid();
152 const ::uid_t our_uid = ::getuid();
153 std::vector<struct kinfo_proc> kinfos;
154 // Special case, if lldb is being run as root we can attach to anything.
155 bool all_users = match_info.GetMatchAllUsers() || (our_uid == 0);
156
157 int mib[3] = {CTL_KERN, KERN_PROC, KERN_PROC_ALL};
158
159 size_t pid_data_size = 0;
160 if (::sysctl(mib, 3, NULL, &pid_data_size, NULL, 0) != 0)
161 return 0;
162
163 // Add a few extra in case a few more show up
164 const size_t estimated_pid_count =
165 (pid_data_size / sizeof(struct kinfo_proc)) + 10;
166
167 kinfos.resize(new_size: estimated_pid_count);
168 pid_data_size = kinfos.size() * sizeof(struct kinfo_proc);
169
170 if (::sysctl(mib, 3, &kinfos[0], &pid_data_size, NULL, 0) != 0)
171 return 0;
172
173 const size_t actual_pid_count = (pid_data_size / sizeof(struct kinfo_proc));
174
175 ProcessInstanceInfoMatch match_info_noname{match_info};
176 match_info_noname.SetNameMatchType(NameMatch::Ignore);
177
178 for (size_t i = 0; i < actual_pid_count; i++) {
179 const struct kinfo_proc &kinfo = kinfos[i];
180
181 /* Make sure the user is acceptable */
182 if (!all_users && kinfo.ki_ruid != our_uid)
183 continue;
184
185 if (kinfo.ki_pid == our_pid || // Skip this process
186 kinfo.ki_pid == 0 || // Skip kernel (kernel pid is 0)
187 kinfo.ki_stat == SZOMB || // Zombies are bad
188 kinfo.ki_flag & P_TRACED || // Being debugged?
189 kinfo.ki_flag & P_WEXIT) // Working on exiting
190 continue;
191
192 // Every thread is a process in FreeBSD, but all the threads of a single
193 // process have the same pid. Do not store the process info in the result
194 // list if a process with given identifier is already registered there.
195 bool already_registered = false;
196 for (uint32_t pi = 0;
197 !already_registered && (const int)kinfo.ki_numthreads > 1 &&
198 pi < (const uint32_t)process_infos.size();
199 pi++)
200 already_registered =
201 (process_infos[pi].GetProcessID() == (uint32_t)kinfo.ki_pid);
202
203 if (already_registered)
204 continue;
205
206 ProcessInstanceInfo process_info;
207 process_info.SetProcessID(kinfo.ki_pid);
208 process_info.SetParentProcessID(kinfo.ki_ppid);
209 process_info.SetUserID(kinfo.ki_ruid);
210 process_info.SetGroupID(kinfo.ki_rgid);
211 process_info.SetEffectiveUserID(kinfo.ki_svuid);
212 process_info.SetEffectiveGroupID(kinfo.ki_svgid);
213
214 // Make sure our info matches before we go fetch the name and cpu type
215 if (match_info_noname.Matches(proc_info: process_info) &&
216 GetFreeBSDProcessArgs(match_info_ptr: &match_info, process_info)) {
217 GetFreeBSDProcessCPUType(process_info);
218 if (match_info.Matches(proc_info: process_info))
219 process_infos.push_back(x: process_info);
220 }
221 }
222
223 return process_infos.size();
224}
225
226bool Host::GetProcessInfo(lldb::pid_t pid, ProcessInstanceInfo &process_info) {
227 process_info.SetProcessID(pid);
228
229 if (GetFreeBSDProcessArgs(NULL, process_info)) {
230 // should use libprocstat instead of going right into sysctl?
231 GetFreeBSDProcessCPUType(process_info);
232 GetFreeBSDProcessUserAndGroup(process_info);
233 return true;
234 }
235
236 process_info.Clear();
237 return false;
238}
239
240Status Host::ShellExpandArguments(ProcessLaunchInfo &launch_info) {
241 return Status::FromErrorString(str: "unimplemented");
242}
243

source code of lldb/source/Host/freebsd/Host.cpp