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