1//===-- TargetList.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 "lldb/Target/TargetList.h"
10#include "lldb/Core/Debugger.h"
11#include "lldb/Core/Module.h"
12#include "lldb/Core/ModuleSpec.h"
13#include "lldb/Host/Host.h"
14#include "lldb/Host/HostInfo.h"
15#include "lldb/Interpreter/CommandInterpreter.h"
16#include "lldb/Interpreter/OptionGroupPlatform.h"
17#include "lldb/Symbol/ObjectFile.h"
18#include "lldb/Target/Platform.h"
19#include "lldb/Target/Process.h"
20#include "lldb/Utility/Broadcaster.h"
21#include "lldb/Utility/Event.h"
22#include "lldb/Utility/State.h"
23#include "lldb/Utility/TildeExpressionResolver.h"
24#include "lldb/Utility/Timer.h"
25
26#include "llvm/ADT/SmallString.h"
27#include "llvm/Support/FileSystem.h"
28
29using namespace lldb;
30using namespace lldb_private;
31
32llvm::StringRef TargetList::GetStaticBroadcasterClass() {
33 static constexpr llvm::StringLiteral class_name("lldb.targetList");
34 return class_name;
35}
36
37// TargetList constructor
38TargetList::TargetList(Debugger &debugger)
39 : Broadcaster(debugger.GetBroadcasterManager(),
40 TargetList::GetStaticBroadcasterClass().str()),
41 m_target_list(), m_target_list_mutex(), m_selected_target_idx(0) {
42 CheckInWithManager();
43}
44
45Status TargetList::CreateTarget(Debugger &debugger,
46 llvm::StringRef user_exe_path,
47 llvm::StringRef triple_str,
48 LoadDependentFiles load_dependent_files,
49 const OptionGroupPlatform *platform_options,
50 TargetSP &target_sp) {
51 std::lock_guard<std::recursive_mutex> guard(m_target_list_mutex);
52 auto result = TargetList::CreateTargetInternal(
53 debugger, user_exe_path, triple_str, load_dependent_files,
54 platform_options, target_sp);
55
56 if (target_sp && result.Success())
57 AddTargetInternal(target_sp, /*do_select*/ true);
58 return result;
59}
60
61Status TargetList::CreateTarget(Debugger &debugger,
62 llvm::StringRef user_exe_path,
63 const ArchSpec &specified_arch,
64 LoadDependentFiles load_dependent_files,
65 PlatformSP &platform_sp, TargetSP &target_sp) {
66 std::lock_guard<std::recursive_mutex> guard(m_target_list_mutex);
67 auto result = TargetList::CreateTargetInternal(
68 debugger, user_exe_path, arch: specified_arch, get_dependent_modules: load_dependent_files,
69 platform_sp, target_sp);
70
71 if (target_sp && result.Success())
72 AddTargetInternal(target_sp, /*do_select*/ true);
73 return result;
74}
75
76Status TargetList::CreateTargetInternal(
77 Debugger &debugger, llvm::StringRef user_exe_path,
78 llvm::StringRef triple_str, LoadDependentFiles load_dependent_files,
79 const OptionGroupPlatform *platform_options, TargetSP &target_sp) {
80 Status error;
81
82 PlatformList &platform_list = debugger.GetPlatformList();
83 // Let's start by looking at the selected platform.
84 PlatformSP platform_sp = platform_list.GetSelectedPlatform();
85
86 // This variable corresponds to the architecture specified by the triple
87 // string. If that string was empty the currently selected platform will
88 // determine the architecture.
89 const ArchSpec arch(triple_str);
90 if (!triple_str.empty() && !arch.IsValid()) {
91 error = Status::FromErrorStringWithFormat(format: "invalid triple '%s'",
92 triple_str.str().c_str());
93 return error;
94 }
95
96 ArchSpec platform_arch(arch);
97
98 // Create a new platform if a platform was specified in the platform options
99 // and doesn't match the selected platform.
100 if (platform_options && platform_options->PlatformWasSpecified() &&
101 !platform_options->PlatformMatches(platform_sp)) {
102 const bool select_platform = true;
103 platform_sp = platform_options->CreatePlatformWithOptions(
104 interpreter&: debugger.GetCommandInterpreter(), arch, make_selected: select_platform, error,
105 platform_arch);
106 if (!platform_sp)
107 return error;
108 }
109
110 bool prefer_platform_arch = false;
111 auto update_platform_arch = [&](const ArchSpec &module_arch) {
112 // If the OS or vendor weren't specified, then adopt the module's
113 // architecture so that the platform matching can be more accurate.
114 if (!platform_arch.TripleOSWasSpecified() ||
115 !platform_arch.TripleVendorWasSpecified()) {
116 prefer_platform_arch = true;
117 platform_arch = module_arch;
118 }
119 };
120
121 if (!user_exe_path.empty()) {
122 ModuleSpec module_spec(FileSpec(user_exe_path, FileSpec::Style::native));
123 FileSystem::Instance().Resolve(file_spec&: module_spec.GetFileSpec());
124
125 // Try to resolve the exe based on PATH and/or platform-specific suffixes,
126 // but only if using the host platform.
127 if (platform_sp->IsHost() &&
128 !FileSystem::Instance().Exists(file_spec: module_spec.GetFileSpec()))
129 FileSystem::Instance().ResolveExecutableLocation(
130 file_spec&: module_spec.GetFileSpec());
131
132 // Resolve the executable in case we are given a path to a application
133 // bundle like a .app bundle on MacOSX.
134 Host::ResolveExecutableInBundle(file&: module_spec.GetFileSpec());
135
136 lldb::offset_t file_offset = 0;
137 lldb::offset_t file_size = 0;
138 ModuleSpecList module_specs;
139 const size_t num_specs = ObjectFile::GetModuleSpecifications(
140 file: module_spec.GetFileSpec(), file_offset, file_size, specs&: module_specs);
141
142 if (num_specs > 0) {
143 ModuleSpec matching_module_spec;
144
145 if (num_specs == 1) {
146 if (module_specs.GetModuleSpecAtIndex(i: 0, module_spec&: matching_module_spec)) {
147 if (platform_arch.IsValid()) {
148 if (platform_arch.IsCompatibleMatch(
149 rhs: matching_module_spec.GetArchitecture())) {
150 // If the OS or vendor weren't specified, then adopt the module's
151 // architecture so that the platform matching can be more
152 // accurate.
153 update_platform_arch(matching_module_spec.GetArchitecture());
154 } else {
155 StreamString platform_arch_strm;
156 StreamString module_arch_strm;
157
158 platform_arch.DumpTriple(s&: platform_arch_strm.AsRawOstream());
159 matching_module_spec.GetArchitecture().DumpTriple(
160 s&: module_arch_strm.AsRawOstream());
161 error = Status::FromErrorStringWithFormat(
162 format: "the specified architecture '%s' is not compatible with '%s' "
163 "in '%s'",
164 platform_arch_strm.GetData(), module_arch_strm.GetData(),
165 module_spec.GetFileSpec().GetPath().c_str());
166 return error;
167 }
168 } else {
169 // Only one arch and none was specified.
170 prefer_platform_arch = true;
171 platform_arch = matching_module_spec.GetArchitecture();
172 }
173 }
174 } else if (arch.IsValid()) {
175 // Fat binary. A (valid) architecture was specified.
176 module_spec.GetArchitecture() = arch;
177 if (module_specs.FindMatchingModuleSpec(module_spec,
178 match_module_spec&: matching_module_spec))
179 update_platform_arch(matching_module_spec.GetArchitecture());
180 } else {
181 // Fat binary. No architecture specified, check if there is
182 // only one platform for all of the architectures.
183 std::vector<PlatformSP> candidates;
184 std::vector<ArchSpec> archs;
185 for (const ModuleSpec &spec : module_specs.ModuleSpecs())
186 archs.push_back(x: spec.GetArchitecture());
187 if (PlatformSP platform_for_archs_sp =
188 platform_list.GetOrCreate(archs, process_host_arch: {}, candidates)) {
189 platform_sp = platform_for_archs_sp;
190 } else if (candidates.empty()) {
191 error = Status::FromErrorString(
192 str: "no matching platforms found for this file");
193 return error;
194 } else {
195 // More than one platform claims to support this file.
196 StreamString error_strm;
197 std::set<llvm::StringRef> platform_set;
198 error_strm.Printf(
199 format: "more than one platform supports this executable (");
200 for (const auto &candidate : candidates) {
201 llvm::StringRef platform_name = candidate->GetName();
202 if (platform_set.count(x: platform_name))
203 continue;
204 if (!platform_set.empty())
205 error_strm.PutCString(cstr: ", ");
206 error_strm.PutCString(cstr: platform_name);
207 platform_set.insert(x: platform_name);
208 }
209 error_strm.Printf(format: "), specify an architecture to disambiguate");
210 error = Status(error_strm.GetString().str());
211 return error;
212 }
213 }
214 }
215 }
216
217 // If we have a valid architecture, make sure the current platform is
218 // compatible with that architecture.
219 if (!prefer_platform_arch && arch.IsValid()) {
220 if (!platform_sp->IsCompatibleArchitecture(
221 arch, process_host_arch: {}, match: ArchSpec::CompatibleMatch, compatible_arch_ptr: nullptr)) {
222 platform_sp = platform_list.GetOrCreate(arch, process_host_arch: {}, platform_arch_ptr: &platform_arch);
223 if (platform_sp)
224 platform_list.SetSelectedPlatform(platform_sp);
225 }
226 } else if (platform_arch.IsValid()) {
227 // If "arch" isn't valid, yet "platform_arch" is, it means we have an
228 // executable file with a single architecture which should be used.
229 ArchSpec fixed_platform_arch;
230 if (!platform_sp->IsCompatibleArchitecture(
231 arch: platform_arch, process_host_arch: {}, match: ArchSpec::CompatibleMatch, compatible_arch_ptr: nullptr)) {
232 platform_sp =
233 platform_list.GetOrCreate(arch: platform_arch, process_host_arch: {}, platform_arch_ptr: &fixed_platform_arch);
234 if (platform_sp)
235 platform_list.SetSelectedPlatform(platform_sp);
236 }
237 }
238
239 if (!platform_arch.IsValid())
240 platform_arch = arch;
241
242 return TargetList::CreateTargetInternal(debugger, user_exe_path,
243 arch: platform_arch, get_dependent_modules: load_dependent_files,
244 platform_sp, target_sp);
245}
246
247Status TargetList::CreateTargetInternal(Debugger &debugger,
248 llvm::StringRef user_exe_path,
249 const ArchSpec &specified_arch,
250 LoadDependentFiles load_dependent_files,
251 lldb::PlatformSP &platform_sp,
252 lldb::TargetSP &target_sp) {
253 LLDB_SCOPED_TIMERF("TargetList::CreateTarget (file = '%s', arch = '%s')",
254 user_exe_path.str().c_str(),
255 specified_arch.GetArchitectureName());
256 Status error;
257 const bool is_dummy_target = false;
258
259 ArchSpec arch(specified_arch);
260
261 if (arch.IsValid()) {
262 if (!platform_sp || !platform_sp->IsCompatibleArchitecture(
263 arch, process_host_arch: {}, match: ArchSpec::CompatibleMatch, compatible_arch_ptr: nullptr))
264 platform_sp =
265 debugger.GetPlatformList().GetOrCreate(arch: specified_arch, process_host_arch: {}, platform_arch_ptr: &arch);
266 }
267
268 if (!platform_sp)
269 platform_sp = debugger.GetPlatformList().GetSelectedPlatform();
270
271 if (!arch.IsValid())
272 arch = specified_arch;
273
274 FileSpec file(user_exe_path);
275 if (!FileSystem::Instance().Exists(file_spec: file) && user_exe_path.starts_with(Prefix: "~")) {
276 // we want to expand the tilde but we don't want to resolve any symbolic
277 // links so we can't use the FileSpec constructor's resolve flag
278 llvm::SmallString<64> unglobbed_path;
279 StandardTildeExpressionResolver Resolver;
280 Resolver.ResolveFullPath(Expr: user_exe_path, Output&: unglobbed_path);
281
282 if (unglobbed_path.empty())
283 file = FileSpec(user_exe_path);
284 else
285 file = FileSpec(unglobbed_path.c_str());
286 }
287
288 bool user_exe_path_is_bundle = false;
289 char resolved_bundle_exe_path[PATH_MAX];
290 resolved_bundle_exe_path[0] = '\0';
291 if (file) {
292 if (FileSystem::Instance().IsDirectory(file_spec: file))
293 user_exe_path_is_bundle = true;
294
295 if (file.IsRelative() && !user_exe_path.empty()) {
296 llvm::SmallString<64> cwd;
297 if (! llvm::sys::fs::current_path(result&: cwd)) {
298 FileSpec cwd_file(cwd.c_str());
299 cwd_file.AppendPathComponent(new_path: file);
300 if (FileSystem::Instance().Exists(file_spec: cwd_file))
301 file = cwd_file;
302 }
303 }
304
305 ModuleSP exe_module_sp;
306 if (platform_sp) {
307 FileSpecList executable_search_paths(
308 Target::GetDefaultExecutableSearchPaths());
309 ModuleSpec module_spec(file, arch);
310 error = platform_sp->ResolveExecutable(module_spec, exe_module_sp,
311 module_search_paths_ptr: executable_search_paths.GetSize()
312 ? &executable_search_paths
313 : nullptr);
314 }
315
316 if (error.Success() && exe_module_sp) {
317 if (exe_module_sp->GetObjectFile() == nullptr) {
318 if (arch.IsValid()) {
319 error = Status::FromErrorStringWithFormat(
320 format: "\"%s\" doesn't contain architecture %s", file.GetPath().c_str(),
321 arch.GetArchitectureName());
322 } else {
323 error = Status::FromErrorStringWithFormat(
324 format: "unsupported file type \"%s\"", file.GetPath().c_str());
325 }
326 return error;
327 }
328 target_sp.reset(p: new Target(debugger, arch, platform_sp, is_dummy_target));
329 debugger.GetTargetList().RegisterInProcessTarget(target_sp);
330 target_sp->SetExecutableModule(module_sp&: exe_module_sp, load_dependent_files);
331 if (user_exe_path_is_bundle)
332 exe_module_sp->GetFileSpec().GetPath(path: resolved_bundle_exe_path,
333 max_path_length: sizeof(resolved_bundle_exe_path));
334 if (target_sp->GetPreloadSymbols())
335 exe_module_sp->PreloadSymbols();
336 }
337 } else {
338 // No file was specified, just create an empty target with any arch if a
339 // valid arch was specified
340 target_sp.reset(p: new Target(debugger, arch, platform_sp, is_dummy_target));
341 debugger.GetTargetList().RegisterInProcessTarget(target_sp);
342 }
343
344 if (!target_sp)
345 return error;
346
347 // Set argv0 with what the user typed, unless the user specified a
348 // directory. If the user specified a directory, then it is probably a
349 // bundle that was resolved and we need to use the resolved bundle path
350 if (!user_exe_path.empty()) {
351 // Use exactly what the user typed as the first argument when we exec or
352 // posix_spawn
353 if (user_exe_path_is_bundle && resolved_bundle_exe_path[0]) {
354 target_sp->SetArg0(resolved_bundle_exe_path);
355 } else {
356 // Use resolved path
357 target_sp->SetArg0(file.GetPath().c_str());
358 }
359 }
360 if (file.GetDirectory()) {
361 FileSpec file_dir;
362 file_dir.SetDirectory(file.GetDirectory());
363 target_sp->AppendExecutableSearchPaths(file_dir);
364 }
365
366 // Now prime this from the dummy target:
367 target_sp->PrimeFromDummyTarget(target&: debugger.GetDummyTarget());
368
369 return error;
370}
371
372bool TargetList::DeleteTarget(TargetSP &target_sp) {
373 std::lock_guard<std::recursive_mutex> guard(m_target_list_mutex);
374 auto it = llvm::find(Range&: m_target_list, Val: target_sp);
375 if (it == m_target_list.end())
376 return false;
377
378 m_target_list.erase(position: it);
379 return true;
380}
381
382TargetSP TargetList::FindTargetWithExecutableAndArchitecture(
383 const FileSpec &exe_file_spec, const ArchSpec *exe_arch_ptr) const {
384 std::lock_guard<std::recursive_mutex> guard(m_target_list_mutex);
385 auto it = llvm::find_if(
386 Range: m_target_list, P: [&exe_file_spec, exe_arch_ptr](const TargetSP &item) {
387 Module *exe_module = item->GetExecutableModulePointer();
388 if (!exe_module ||
389 !FileSpec::Match(pattern: exe_file_spec, file: exe_module->GetFileSpec()))
390 return false;
391
392 return !exe_arch_ptr ||
393 exe_arch_ptr->IsCompatibleMatch(rhs: exe_module->GetArchitecture());
394 });
395
396 if (it != m_target_list.end())
397 return *it;
398
399 return TargetSP();
400}
401
402TargetSP TargetList::FindTargetWithProcessID(lldb::pid_t pid) const {
403 std::lock_guard<std::recursive_mutex> guard(m_target_list_mutex);
404 auto it = llvm::find_if(Range: m_target_list, P: [pid](const TargetSP &item) {
405 auto *process_ptr = item->GetProcessSP().get();
406 return process_ptr && (process_ptr->GetID() == pid);
407 });
408
409 if (it != m_target_list.end())
410 return *it;
411
412 return TargetSP();
413}
414
415TargetSP TargetList::FindTargetWithProcess(Process *process) const {
416 TargetSP target_sp;
417 if (!process)
418 return target_sp;
419
420 std::lock_guard<std::recursive_mutex> guard(m_target_list_mutex);
421 auto it = llvm::find_if(Range: m_target_list, P: [process](const TargetSP &item) {
422 return item->GetProcessSP().get() == process;
423 });
424
425 if (it != m_target_list.end())
426 target_sp = *it;
427
428 return target_sp;
429}
430
431TargetSP TargetList::GetTargetSP(Target *target) const {
432 TargetSP target_sp;
433 if (!target)
434 return target_sp;
435
436 std::lock_guard<std::recursive_mutex> guard(m_target_list_mutex);
437 auto it = llvm::find_if(Range: m_target_list, P: [target](const TargetSP &item) {
438 return item.get() == target;
439 });
440 if (it != m_target_list.end())
441 target_sp = *it;
442
443 return target_sp;
444}
445
446uint32_t TargetList::SendAsyncInterrupt(lldb::pid_t pid) {
447 uint32_t num_async_interrupts_sent = 0;
448
449 if (pid != LLDB_INVALID_PROCESS_ID) {
450 TargetSP target_sp(FindTargetWithProcessID(pid));
451 if (target_sp) {
452 Process *process = target_sp->GetProcessSP().get();
453 if (process) {
454 process->SendAsyncInterrupt();
455 ++num_async_interrupts_sent;
456 }
457 }
458 } else {
459 // We don't have a valid pid to broadcast to, so broadcast to the target
460 // list's async broadcaster...
461 BroadcastEvent(event_type: Process::eBroadcastBitInterrupt, event_data_sp: nullptr);
462 }
463
464 return num_async_interrupts_sent;
465}
466
467uint32_t TargetList::SignalIfRunning(lldb::pid_t pid, int signo) {
468 uint32_t num_signals_sent = 0;
469 Process *process = nullptr;
470 if (pid == LLDB_INVALID_PROCESS_ID) {
471 // Signal all processes with signal
472 std::lock_guard<std::recursive_mutex> guard(m_target_list_mutex);
473 for (const auto &target_sp : m_target_list) {
474 process = target_sp->GetProcessSP().get();
475 if (process && process->IsAlive()) {
476 ++num_signals_sent;
477 process->Signal(signal: signo);
478 }
479 }
480 } else {
481 // Signal a specific process with signal
482 TargetSP target_sp(FindTargetWithProcessID(pid));
483 if (target_sp) {
484 process = target_sp->GetProcessSP().get();
485 if (process && process->IsAlive()) {
486 ++num_signals_sent;
487 process->Signal(signal: signo);
488 }
489 }
490 }
491 return num_signals_sent;
492}
493
494size_t TargetList::GetNumTargets() const {
495 std::lock_guard<std::recursive_mutex> guard(m_target_list_mutex);
496 return m_target_list.size();
497}
498
499lldb::TargetSP TargetList::GetTargetAtIndex(uint32_t idx) const {
500 TargetSP target_sp;
501 std::lock_guard<std::recursive_mutex> guard(m_target_list_mutex);
502 if (idx < m_target_list.size())
503 target_sp = m_target_list[idx];
504 return target_sp;
505}
506
507uint32_t TargetList::GetIndexOfTarget(lldb::TargetSP target_sp) const {
508 std::lock_guard<std::recursive_mutex> guard(m_target_list_mutex);
509 auto it = llvm::find(Range: m_target_list, Val: target_sp);
510 if (it != m_target_list.end())
511 return std::distance(first: m_target_list.begin(), last: it);
512 return UINT32_MAX;
513}
514
515void TargetList::AddTargetInternal(TargetSP target_sp, bool do_select) {
516 lldbassert(!llvm::is_contained(m_target_list, target_sp) &&
517 "target already exists it the list");
518 UnregisterInProcessTarget(target_sp);
519 m_target_list.push_back(x: std::move(target_sp));
520 if (do_select)
521 SetSelectedTargetInternal(m_target_list.size() - 1);
522}
523
524void TargetList::SetSelectedTargetInternal(uint32_t index) {
525 lldbassert(!m_target_list.empty());
526 m_selected_target_idx = index < m_target_list.size() ? index : 0;
527}
528
529void TargetList::SetSelectedTarget(uint32_t index) {
530 std::lock_guard<std::recursive_mutex> guard(m_target_list_mutex);
531 SetSelectedTargetInternal(index);
532}
533
534void TargetList::SetSelectedTarget(const TargetSP &target_sp) {
535 // Don't allow an invalid target shared pointer or a target that has been
536 // destroyed to become the selected target.
537 if (target_sp && target_sp->IsValid()) {
538 std::lock_guard<std::recursive_mutex> guard(m_target_list_mutex);
539 auto it = llvm::find(Range&: m_target_list, Val: target_sp);
540 SetSelectedTargetInternal(std::distance(first: m_target_list.begin(), last: it));
541 }
542}
543
544lldb::TargetSP TargetList::GetSelectedTarget() {
545 std::lock_guard<std::recursive_mutex> guard(m_target_list_mutex);
546 if (m_selected_target_idx >= m_target_list.size())
547 m_selected_target_idx = 0;
548 return GetTargetAtIndex(idx: m_selected_target_idx);
549}
550
551bool TargetList::AnyTargetContainsModule(Module &module) {
552 std::lock_guard<std::recursive_mutex> guard(m_target_list_mutex);
553 for (const auto &target_sp : m_target_list) {
554 if (target_sp->GetImages().FindModule(module_ptr: &module))
555 return true;
556 }
557 for (const auto &target_sp: m_in_process_target_list) {
558 if (target_sp->GetImages().FindModule(module_ptr: &module))
559 return true;
560 }
561 return false;
562}
563
564 void TargetList::RegisterInProcessTarget(TargetSP target_sp) {
565 std::lock_guard<std::recursive_mutex> guard(m_target_list_mutex);
566 [[maybe_unused]] bool was_added;
567 std::tie(args: std::ignore, args&: was_added) =
568 m_in_process_target_list.insert(x: target_sp);
569 assert(was_added && "Target pointer was left in the in-process map");
570 }
571
572 void TargetList::UnregisterInProcessTarget(TargetSP target_sp) {
573 std::lock_guard<std::recursive_mutex> guard(m_target_list_mutex);
574 [[maybe_unused]] bool was_present =
575 m_in_process_target_list.erase(x: target_sp);
576 assert(was_present && "Target pointer being removed was not registered");
577 }
578
579 bool TargetList::IsTargetInProcess(TargetSP target_sp) {
580 std::lock_guard<std::recursive_mutex> guard(m_target_list_mutex);
581 return m_in_process_target_list.count(x: target_sp) == 1;
582 }
583

source code of lldb/source/Target/TargetList.cpp