1 //===-- Platform.cpp --------------------------------------------*- C++ -*-===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 10 #include "lldb/Target/Platform.h" 11 12 // C Includes 13 // C++ Includes 14 // Other libraries and framework includes 15 // Project includes 16 #include "lldb/Breakpoint/BreakpointIDList.h" 17 #include "lldb/Core/Error.h" 18 #include "lldb/Core/Log.h" 19 #include "lldb/Core/ModuleSpec.h" 20 #include "lldb/Core/PluginManager.h" 21 #include "lldb/Host/FileSpec.h" 22 #include "lldb/Host/Host.h" 23 #include "lldb/Target/Process.h" 24 #include "lldb/Target/Target.h" 25 #include "lldb/Utility/Utils.h" 26 27 using namespace lldb; 28 using namespace lldb_private; 29 30 // Use a singleton function for g_local_platform_sp to avoid init 31 // constructors since LLDB is often part of a shared library 32 static PlatformSP& 33 GetDefaultPlatformSP () 34 { 35 static PlatformSP g_default_platform_sp; 36 return g_default_platform_sp; 37 } 38 39 static Mutex & 40 GetConnectedPlatformListMutex () 41 { 42 static Mutex g_remote_connected_platforms_mutex (Mutex::eMutexTypeRecursive); 43 return g_remote_connected_platforms_mutex; 44 } 45 static std::vector<PlatformSP> & 46 GetConnectedPlatformList () 47 { 48 static std::vector<PlatformSP> g_remote_connected_platforms; 49 return g_remote_connected_platforms; 50 } 51 52 53 const char * 54 Platform::GetHostPlatformName () 55 { 56 return "host"; 57 } 58 59 //------------------------------------------------------------------ 60 /// Get the native host platform plug-in. 61 /// 62 /// There should only be one of these for each host that LLDB runs 63 /// upon that should be statically compiled in and registered using 64 /// preprocessor macros or other similar build mechanisms. 65 /// 66 /// This platform will be used as the default platform when launching 67 /// or attaching to processes unless another platform is specified. 68 //------------------------------------------------------------------ 69 PlatformSP 70 Platform::GetDefaultPlatform () 71 { 72 return GetDefaultPlatformSP (); 73 } 74 75 void 76 Platform::SetDefaultPlatform (const lldb::PlatformSP &platform_sp) 77 { 78 // The native platform should use its static void Platform::Initialize() 79 // function to register itself as the native platform. 80 GetDefaultPlatformSP () = platform_sp; 81 } 82 83 Error 84 Platform::GetFile (const FileSpec &platform_file, 85 const UUID *uuid_ptr, 86 FileSpec &local_file) 87 { 88 // Default to the local case 89 local_file = platform_file; 90 return Error(); 91 } 92 93 FileSpecList 94 Platform::LocateExecutableScriptingResources (Target *target, Module &module) 95 { 96 return FileSpecList(); 97 } 98 99 Platform* 100 Platform::FindPlugin (Process *process, const ConstString &plugin_name) 101 { 102 PlatformCreateInstance create_callback = NULL; 103 if (plugin_name) 104 { 105 create_callback = PluginManager::GetPlatformCreateCallbackForPluginName (plugin_name); 106 if (create_callback) 107 { 108 ArchSpec arch; 109 if (process) 110 { 111 arch = process->GetTarget().GetArchitecture(); 112 } 113 std::unique_ptr<Platform> instance_ap(create_callback(process, &arch)); 114 if (instance_ap.get()) 115 return instance_ap.release(); 116 } 117 } 118 else 119 { 120 for (uint32_t idx = 0; (create_callback = PluginManager::GetPlatformCreateCallbackAtIndex(idx)) != NULL; ++idx) 121 { 122 std::unique_ptr<Platform> instance_ap(create_callback(process, nullptr)); 123 if (instance_ap.get()) 124 return instance_ap.release(); 125 } 126 } 127 return NULL; 128 } 129 130 Error 131 Platform::GetSharedModule (const ModuleSpec &module_spec, 132 ModuleSP &module_sp, 133 const FileSpecList *module_search_paths_ptr, 134 ModuleSP *old_module_sp_ptr, 135 bool *did_create_ptr) 136 { 137 // Don't do any path remapping for the default implementation 138 // of the platform GetSharedModule function, just call through 139 // to our static ModuleList function. Platform subclasses that 140 // implement remote debugging, might have a developer kits 141 // installed that have cached versions of the files for the 142 // remote target, or might implement a download and cache 143 // locally implementation. 144 const bool always_create = false; 145 return ModuleList::GetSharedModule (module_spec, 146 module_sp, 147 module_search_paths_ptr, 148 old_module_sp_ptr, 149 did_create_ptr, 150 always_create); 151 } 152 153 PlatformSP 154 Platform::Create (const char *platform_name, Error &error) 155 { 156 PlatformCreateInstance create_callback = NULL; 157 lldb::PlatformSP platform_sp; 158 if (platform_name && platform_name[0]) 159 { 160 ConstString const_platform_name (platform_name); 161 create_callback = PluginManager::GetPlatformCreateCallbackForPluginName (const_platform_name); 162 if (create_callback) 163 platform_sp.reset(create_callback(true, NULL)); 164 else 165 error.SetErrorStringWithFormat ("unable to find a plug-in for the platform named \"%s\"", platform_name); 166 } 167 else 168 error.SetErrorString ("invalid platform name"); 169 return platform_sp; 170 } 171 172 173 PlatformSP 174 Platform::Create (const ArchSpec &arch, ArchSpec *platform_arch_ptr, Error &error) 175 { 176 lldb::PlatformSP platform_sp; 177 if (arch.IsValid()) 178 { 179 uint32_t idx; 180 PlatformCreateInstance create_callback; 181 // First try exact arch matches across all platform plug-ins 182 bool exact = true; 183 for (idx = 0; (create_callback = PluginManager::GetPlatformCreateCallbackAtIndex (idx)); ++idx) 184 { 185 if (create_callback) 186 { 187 platform_sp.reset(create_callback(false, &arch)); 188 if (platform_sp && platform_sp->IsCompatibleArchitecture(arch, exact, platform_arch_ptr)) 189 return platform_sp; 190 } 191 } 192 // Next try compatible arch matches across all platform plug-ins 193 exact = false; 194 for (idx = 0; (create_callback = PluginManager::GetPlatformCreateCallbackAtIndex (idx)); ++idx) 195 { 196 if (create_callback) 197 { 198 platform_sp.reset(create_callback(false, &arch)); 199 if (platform_sp && platform_sp->IsCompatibleArchitecture(arch, exact, platform_arch_ptr)) 200 return platform_sp; 201 } 202 } 203 } 204 else 205 error.SetErrorString ("invalid platform name"); 206 if (platform_arch_ptr) 207 platform_arch_ptr->Clear(); 208 platform_sp.reset(); 209 return platform_sp; 210 } 211 212 uint32_t 213 Platform::GetNumConnectedRemotePlatforms () 214 { 215 Mutex::Locker locker (GetConnectedPlatformListMutex ()); 216 return GetConnectedPlatformList().size(); 217 } 218 219 PlatformSP 220 Platform::GetConnectedRemotePlatformAtIndex (uint32_t idx) 221 { 222 PlatformSP platform_sp; 223 { 224 Mutex::Locker locker (GetConnectedPlatformListMutex ()); 225 if (idx < GetConnectedPlatformList().size()) 226 platform_sp = GetConnectedPlatformList ()[idx]; 227 } 228 return platform_sp; 229 } 230 231 //------------------------------------------------------------------ 232 /// Default Constructor 233 //------------------------------------------------------------------ 234 Platform::Platform (bool is_host) : 235 m_is_host (is_host), 236 m_os_version_set_while_connected (false), 237 m_system_arch_set_while_connected (false), 238 m_sdk_sysroot (), 239 m_sdk_build (), 240 m_working_dir (), 241 m_remote_url (), 242 m_name (), 243 m_major_os_version (UINT32_MAX), 244 m_minor_os_version (UINT32_MAX), 245 m_update_os_version (UINT32_MAX), 246 m_system_arch(), 247 m_uid_map_mutex (Mutex::eMutexTypeNormal), 248 m_gid_map_mutex (Mutex::eMutexTypeNormal), 249 m_uid_map(), 250 m_gid_map(), 251 m_max_uid_name_len (0), 252 m_max_gid_name_len (0), 253 m_supports_rsync (false), 254 m_rsync_opts (), 255 m_rsync_prefix (), 256 m_supports_ssh (false), 257 m_ssh_opts (), 258 m_ignores_remote_hostname (false) 259 { 260 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT)); 261 if (log) 262 log->Printf ("%p Platform::Platform()", this); 263 } 264 265 //------------------------------------------------------------------ 266 /// Destructor. 267 /// 268 /// The destructor is virtual since this class is designed to be 269 /// inherited from by the plug-in instance. 270 //------------------------------------------------------------------ 271 Platform::~Platform() 272 { 273 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT)); 274 if (log) 275 log->Printf ("%p Platform::~Platform()", this); 276 } 277 278 void 279 Platform::GetStatus (Stream &strm) 280 { 281 uint32_t major = UINT32_MAX; 282 uint32_t minor = UINT32_MAX; 283 uint32_t update = UINT32_MAX; 284 std::string s; 285 strm.Printf (" Platform: %s\n", GetPluginName().GetCString()); 286 287 ArchSpec arch (GetSystemArchitecture()); 288 if (arch.IsValid()) 289 { 290 if (!arch.GetTriple().str().empty()) 291 strm.Printf(" Triple: %s\n", arch.GetTriple().str().c_str()); 292 } 293 294 if (GetOSVersion(major, minor, update)) 295 { 296 strm.Printf("OS Version: %u", major); 297 if (minor != UINT32_MAX) 298 strm.Printf(".%u", minor); 299 if (update != UINT32_MAX) 300 strm.Printf(".%u", update); 301 302 if (GetOSBuildString (s)) 303 strm.Printf(" (%s)", s.c_str()); 304 305 strm.EOL(); 306 } 307 308 if (GetOSKernelDescription (s)) 309 strm.Printf(" Kernel: %s\n", s.c_str()); 310 311 if (IsHost()) 312 { 313 strm.Printf(" Hostname: %s\n", GetHostname()); 314 } 315 else 316 { 317 const bool is_connected = IsConnected(); 318 if (is_connected) 319 strm.Printf(" Hostname: %s\n", GetHostname()); 320 strm.Printf(" Connected: %s\n", is_connected ? "yes" : "no"); 321 } 322 323 if (GetWorkingDirectory()) 324 { 325 strm.Printf("WorkingDir: %s\n", GetWorkingDirectory().GetCString()); 326 } 327 if (!IsConnected()) 328 return; 329 330 std::string specific_info(GetPlatformSpecificConnectionInformation()); 331 332 if (specific_info.empty() == false) 333 strm.Printf("Platform-specific connection: %s\n", specific_info.c_str()); 334 } 335 336 337 bool 338 Platform::GetOSVersion (uint32_t &major, 339 uint32_t &minor, 340 uint32_t &update) 341 { 342 bool success = m_major_os_version != UINT32_MAX; 343 if (IsHost()) 344 { 345 if (!success) 346 { 347 // We have a local host platform 348 success = Host::GetOSVersion (m_major_os_version, 349 m_minor_os_version, 350 m_update_os_version); 351 m_os_version_set_while_connected = success; 352 } 353 } 354 else 355 { 356 // We have a remote platform. We can only fetch the remote 357 // OS version if we are connected, and we don't want to do it 358 // more than once. 359 360 const bool is_connected = IsConnected(); 361 362 bool fetch = false; 363 if (success) 364 { 365 // We have valid OS version info, check to make sure it wasn't 366 // manually set prior to connecting. If it was manually set prior 367 // to connecting, then lets fetch the actual OS version info 368 // if we are now connected. 369 if (is_connected && !m_os_version_set_while_connected) 370 fetch = true; 371 } 372 else 373 { 374 // We don't have valid OS version info, fetch it if we are connected 375 fetch = is_connected; 376 } 377 378 if (fetch) 379 { 380 success = GetRemoteOSVersion (); 381 m_os_version_set_while_connected = success; 382 } 383 } 384 385 if (success) 386 { 387 major = m_major_os_version; 388 minor = m_minor_os_version; 389 update = m_update_os_version; 390 } 391 return success; 392 } 393 394 bool 395 Platform::GetOSBuildString (std::string &s) 396 { 397 if (IsHost()) 398 return Host::GetOSBuildString (s); 399 else 400 return GetRemoteOSBuildString (s); 401 } 402 403 bool 404 Platform::GetOSKernelDescription (std::string &s) 405 { 406 if (IsHost()) 407 return Host::GetOSKernelDescription (s); 408 else 409 return GetRemoteOSKernelDescription (s); 410 } 411 412 ConstString 413 Platform::GetWorkingDirectory () 414 { 415 if (IsHost()) 416 { 417 char cwd[PATH_MAX]; 418 if (getcwd(cwd, sizeof(cwd))) 419 return ConstString(cwd); 420 else 421 return ConstString(); 422 } 423 else 424 { 425 if (!m_working_dir) 426 m_working_dir = GetRemoteWorkingDirectory(); 427 return m_working_dir; 428 } 429 } 430 431 432 struct RecurseCopyBaton 433 { 434 const FileSpec& dst; 435 Platform *platform_ptr; 436 Error error; 437 }; 438 439 440 static FileSpec::EnumerateDirectoryResult 441 RecurseCopy_Callback (void *baton, 442 FileSpec::FileType file_type, 443 const FileSpec &src) 444 { 445 RecurseCopyBaton* rc_baton = (RecurseCopyBaton*)baton; 446 switch (file_type) 447 { 448 case FileSpec::eFileTypePipe: 449 case FileSpec::eFileTypeSocket: 450 // we have no way to copy pipes and sockets - ignore them and continue 451 return FileSpec::eEnumerateDirectoryResultNext; 452 break; 453 454 case FileSpec::eFileTypeDirectory: 455 { 456 // make the new directory and get in there 457 FileSpec dst_dir = rc_baton->dst; 458 if (!dst_dir.GetFilename()) 459 dst_dir.GetFilename() = src.GetLastPathComponent(); 460 std::string dst_dir_path (dst_dir.GetPath()); 461 Error error = rc_baton->platform_ptr->MakeDirectory(dst_dir_path.c_str(), lldb::eFilePermissionsDirectoryDefault); 462 if (error.Fail()) 463 { 464 rc_baton->error.SetErrorStringWithFormat("unable to setup directory %s on remote end", dst_dir_path.c_str()); 465 return FileSpec::eEnumerateDirectoryResultQuit; // got an error, bail out 466 } 467 468 // now recurse 469 std::string src_dir_path (src.GetPath()); 470 471 // Make a filespec that only fills in the directory of a FileSpec so 472 // when we enumerate we can quickly fill in the filename for dst copies 473 FileSpec recurse_dst; 474 recurse_dst.GetDirectory().SetCString(dst_dir.GetPath().c_str()); 475 RecurseCopyBaton rc_baton2 = { recurse_dst, rc_baton->platform_ptr, Error() }; 476 FileSpec::EnumerateDirectory(src_dir_path.c_str(), true, true, true, RecurseCopy_Callback, &rc_baton2); 477 if (rc_baton2.error.Fail()) 478 { 479 rc_baton->error.SetErrorString(rc_baton2.error.AsCString()); 480 return FileSpec::eEnumerateDirectoryResultQuit; // got an error, bail out 481 } 482 return FileSpec::eEnumerateDirectoryResultNext; 483 } 484 break; 485 486 case FileSpec::eFileTypeSymbolicLink: 487 { 488 // copy the file and keep going 489 FileSpec dst_file = rc_baton->dst; 490 if (!dst_file.GetFilename()) 491 dst_file.GetFilename() = src.GetFilename(); 492 493 char buf[PATH_MAX]; 494 495 rc_baton->error = Host::Readlink (src.GetPath().c_str(), buf, sizeof(buf)); 496 497 if (rc_baton->error.Fail()) 498 return FileSpec::eEnumerateDirectoryResultQuit; // got an error, bail out 499 500 rc_baton->error = rc_baton->platform_ptr->CreateSymlink(dst_file.GetPath().c_str(), buf); 501 502 if (rc_baton->error.Fail()) 503 return FileSpec::eEnumerateDirectoryResultQuit; // got an error, bail out 504 505 return FileSpec::eEnumerateDirectoryResultNext; 506 } 507 break; 508 case FileSpec::eFileTypeRegular: 509 { 510 // copy the file and keep going 511 FileSpec dst_file = rc_baton->dst; 512 if (!dst_file.GetFilename()) 513 dst_file.GetFilename() = src.GetFilename(); 514 Error err = rc_baton->platform_ptr->PutFile(src, dst_file); 515 if (err.Fail()) 516 { 517 rc_baton->error.SetErrorString(err.AsCString()); 518 return FileSpec::eEnumerateDirectoryResultQuit; // got an error, bail out 519 } 520 return FileSpec::eEnumerateDirectoryResultNext; 521 } 522 break; 523 524 case FileSpec::eFileTypeInvalid: 525 case FileSpec::eFileTypeOther: 526 case FileSpec::eFileTypeUnknown: 527 rc_baton->error.SetErrorStringWithFormat("invalid file detected during copy: %s", src.GetPath().c_str()); 528 return FileSpec::eEnumerateDirectoryResultQuit; // got an error, bail out 529 break; 530 } 531 } 532 533 Error 534 Platform::Install (const FileSpec& src, const FileSpec& dst) 535 { 536 Error error; 537 538 Log *log = GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM); 539 if (log) 540 log->Printf ("Platform::Install (src='%s', dst='%s')", src.GetPath().c_str(), dst.GetPath().c_str()); 541 FileSpec fixed_dst(dst); 542 543 if (!fixed_dst.GetFilename()) 544 fixed_dst.GetFilename() = src.GetFilename(); 545 546 ConstString working_dir = GetWorkingDirectory(); 547 548 if (dst) 549 { 550 if (dst.GetDirectory()) 551 { 552 const char first_dst_dir_char = dst.GetDirectory().GetCString()[0]; 553 if (first_dst_dir_char == '/' || first_dst_dir_char == '\\') 554 { 555 fixed_dst.GetDirectory() = dst.GetDirectory(); 556 } 557 // If the fixed destination file doesn't have a directory yet, 558 // then we must have a relative path. We will resolve this relative 559 // path against the platform's working directory 560 if (!fixed_dst.GetDirectory()) 561 { 562 FileSpec relative_spec; 563 std::string path; 564 if (working_dir) 565 { 566 relative_spec.SetFile(working_dir.GetCString(), false); 567 relative_spec.AppendPathComponent(dst.GetPath().c_str()); 568 fixed_dst.GetDirectory() = relative_spec.GetDirectory(); 569 } 570 else 571 { 572 error.SetErrorStringWithFormat("platform working directory must be valid for relative path '%s'", dst.GetPath().c_str()); 573 return error; 574 } 575 } 576 } 577 else 578 { 579 if (working_dir) 580 { 581 fixed_dst.GetDirectory() = working_dir; 582 } 583 else 584 { 585 error.SetErrorStringWithFormat("platform working directory must be valid for relative path '%s'", dst.GetPath().c_str()); 586 return error; 587 } 588 } 589 } 590 else 591 { 592 if (working_dir) 593 { 594 fixed_dst.GetDirectory() = working_dir; 595 } 596 else 597 { 598 error.SetErrorStringWithFormat("platform working directory must be valid when destination directory is empty"); 599 return error; 600 } 601 } 602 603 if (log) 604 log->Printf ("Platform::Install (src='%s', dst='%s') fixed_dst='%s'", src.GetPath().c_str(), dst.GetPath().c_str(), fixed_dst.GetPath().c_str()); 605 606 if (GetSupportsRSync()) 607 { 608 error = PutFile(src, dst); 609 } 610 else 611 { 612 switch (src.GetFileType()) 613 { 614 case FileSpec::eFileTypeDirectory: 615 { 616 if (GetFileExists (fixed_dst)) 617 Unlink (fixed_dst.GetPath().c_str()); 618 uint32_t permissions = src.GetPermissions(); 619 if (permissions == 0) 620 permissions = eFilePermissionsDirectoryDefault; 621 std::string dst_dir_path(fixed_dst.GetPath()); 622 error = MakeDirectory(dst_dir_path.c_str(), permissions); 623 if (error.Success()) 624 { 625 // Make a filespec that only fills in the directory of a FileSpec so 626 // when we enumerate we can quickly fill in the filename for dst copies 627 FileSpec recurse_dst; 628 recurse_dst.GetDirectory().SetCString(dst_dir_path.c_str()); 629 std::string src_dir_path (src.GetPath()); 630 RecurseCopyBaton baton = { recurse_dst, this, Error() }; 631 FileSpec::EnumerateDirectory(src_dir_path.c_str(), true, true, true, RecurseCopy_Callback, &baton); 632 return baton.error; 633 } 634 } 635 break; 636 637 case FileSpec::eFileTypeRegular: 638 if (GetFileExists (fixed_dst)) 639 Unlink (fixed_dst.GetPath().c_str()); 640 error = PutFile(src, fixed_dst); 641 break; 642 643 case FileSpec::eFileTypeSymbolicLink: 644 { 645 if (GetFileExists (fixed_dst)) 646 Unlink (fixed_dst.GetPath().c_str()); 647 char buf[PATH_MAX]; 648 error = Host::Readlink(src.GetPath().c_str(), buf, sizeof(buf)); 649 if (error.Success()) 650 error = CreateSymlink(dst.GetPath().c_str(), buf); 651 } 652 break; 653 case FileSpec::eFileTypePipe: 654 error.SetErrorString("platform install doesn't handle pipes"); 655 break; 656 case FileSpec::eFileTypeSocket: 657 error.SetErrorString("platform install doesn't handle sockets"); 658 break; 659 case FileSpec::eFileTypeInvalid: 660 case FileSpec::eFileTypeUnknown: 661 case FileSpec::eFileTypeOther: 662 error.SetErrorString("platform install doesn't handle non file or directory items"); 663 break; 664 } 665 } 666 return error; 667 } 668 669 bool 670 Platform::SetWorkingDirectory (const ConstString &path) 671 { 672 if (IsHost()) 673 { 674 #ifdef _WIN32 675 // Not implemented on Windows 676 return false; 677 #else 678 if (path) 679 { 680 if (chdir(path.GetCString()) == 0) 681 return true; 682 } 683 return false; 684 #endif 685 } 686 else 687 { 688 return SetRemoteWorkingDirectory(path); 689 } 690 } 691 692 Error 693 Platform::MakeDirectory (const char *path, uint32_t permissions) 694 { 695 if (IsHost()) 696 return Host::MakeDirectory (path, permissions); 697 else 698 { 699 Error error; 700 error.SetErrorStringWithFormat("remote platform %s doesn't support %s", GetPluginName().GetCString(), __PRETTY_FUNCTION__); 701 return error; 702 } 703 } 704 705 Error 706 Platform::GetFilePermissions (const char *path, uint32_t &file_permissions) 707 { 708 if (IsHost()) 709 return Host::GetFilePermissions(path, file_permissions); 710 else 711 { 712 Error error; 713 error.SetErrorStringWithFormat("remote platform %s doesn't support %s", GetPluginName().GetCString(), __PRETTY_FUNCTION__); 714 return error; 715 } 716 } 717 718 Error 719 Platform::SetFilePermissions (const char *path, uint32_t file_permissions) 720 { 721 if (IsHost()) 722 return Host::SetFilePermissions(path, file_permissions); 723 else 724 { 725 Error error; 726 error.SetErrorStringWithFormat("remote platform %s doesn't support %s", GetPluginName().GetCString(), __PRETTY_FUNCTION__); 727 return error; 728 } 729 } 730 731 ConstString 732 Platform::GetName () 733 { 734 return GetPluginName(); 735 } 736 737 const char * 738 Platform::GetHostname () 739 { 740 if (IsHost()) 741 return "localhost"; 742 743 if (m_name.empty()) 744 return NULL; 745 return m_name.c_str(); 746 } 747 748 const char * 749 Platform::GetUserName (uint32_t uid) 750 { 751 const char *user_name = GetCachedUserName(uid); 752 if (user_name) 753 return user_name; 754 if (IsHost()) 755 { 756 std::string name; 757 if (Host::GetUserName(uid, name)) 758 return SetCachedUserName (uid, name.c_str(), name.size()); 759 } 760 return NULL; 761 } 762 763 const char * 764 Platform::GetGroupName (uint32_t gid) 765 { 766 const char *group_name = GetCachedGroupName(gid); 767 if (group_name) 768 return group_name; 769 if (IsHost()) 770 { 771 std::string name; 772 if (Host::GetGroupName(gid, name)) 773 return SetCachedGroupName (gid, name.c_str(), name.size()); 774 } 775 return NULL; 776 } 777 778 bool 779 Platform::SetOSVersion (uint32_t major, 780 uint32_t minor, 781 uint32_t update) 782 { 783 if (IsHost()) 784 { 785 // We don't need anyone setting the OS version for the host platform, 786 // we should be able to figure it out by calling Host::GetOSVersion(...). 787 return false; 788 } 789 else 790 { 791 // We have a remote platform, allow setting the target OS version if 792 // we aren't connected, since if we are connected, we should be able to 793 // request the remote OS version from the connected platform. 794 if (IsConnected()) 795 return false; 796 else 797 { 798 // We aren't connected and we might want to set the OS version 799 // ahead of time before we connect so we can peruse files and 800 // use a local SDK or PDK cache of support files to disassemble 801 // or do other things. 802 m_major_os_version = major; 803 m_minor_os_version = minor; 804 m_update_os_version = update; 805 return true; 806 } 807 } 808 return false; 809 } 810 811 812 Error 813 Platform::ResolveExecutable (const FileSpec &exe_file, 814 const ArchSpec &exe_arch, 815 lldb::ModuleSP &exe_module_sp, 816 const FileSpecList *module_search_paths_ptr) 817 { 818 Error error; 819 if (exe_file.Exists()) 820 { 821 ModuleSpec module_spec (exe_file, exe_arch); 822 if (module_spec.GetArchitecture().IsValid()) 823 { 824 error = ModuleList::GetSharedModule (module_spec, 825 exe_module_sp, 826 module_search_paths_ptr, 827 NULL, 828 NULL); 829 } 830 else 831 { 832 // No valid architecture was specified, ask the platform for 833 // the architectures that we should be using (in the correct order) 834 // and see if we can find a match that way 835 for (uint32_t idx = 0; GetSupportedArchitectureAtIndex (idx, module_spec.GetArchitecture()); ++idx) 836 { 837 error = ModuleList::GetSharedModule (module_spec, 838 exe_module_sp, 839 module_search_paths_ptr, 840 NULL, 841 NULL); 842 // Did we find an executable using one of the 843 if (error.Success() && exe_module_sp) 844 break; 845 } 846 } 847 } 848 else 849 { 850 error.SetErrorStringWithFormat ("'%s' does not exist", 851 exe_file.GetPath().c_str()); 852 } 853 return error; 854 } 855 856 Error 857 Platform::ResolveSymbolFile (Target &target, 858 const ModuleSpec &sym_spec, 859 FileSpec &sym_file) 860 { 861 Error error; 862 if (sym_spec.GetSymbolFileSpec().Exists()) 863 sym_file = sym_spec.GetSymbolFileSpec(); 864 else 865 error.SetErrorString("unable to resolve symbol file"); 866 return error; 867 868 } 869 870 871 872 bool 873 Platform::ResolveRemotePath (const FileSpec &platform_path, 874 FileSpec &resolved_platform_path) 875 { 876 resolved_platform_path = platform_path; 877 return resolved_platform_path.ResolvePath(); 878 } 879 880 881 const ArchSpec & 882 Platform::GetSystemArchitecture() 883 { 884 if (IsHost()) 885 { 886 if (!m_system_arch.IsValid()) 887 { 888 // We have a local host platform 889 m_system_arch = Host::GetArchitecture(); 890 m_system_arch_set_while_connected = m_system_arch.IsValid(); 891 } 892 } 893 else 894 { 895 // We have a remote platform. We can only fetch the remote 896 // system architecture if we are connected, and we don't want to do it 897 // more than once. 898 899 const bool is_connected = IsConnected(); 900 901 bool fetch = false; 902 if (m_system_arch.IsValid()) 903 { 904 // We have valid OS version info, check to make sure it wasn't 905 // manually set prior to connecting. If it was manually set prior 906 // to connecting, then lets fetch the actual OS version info 907 // if we are now connected. 908 if (is_connected && !m_system_arch_set_while_connected) 909 fetch = true; 910 } 911 else 912 { 913 // We don't have valid OS version info, fetch it if we are connected 914 fetch = is_connected; 915 } 916 917 if (fetch) 918 { 919 m_system_arch = GetRemoteSystemArchitecture (); 920 m_system_arch_set_while_connected = m_system_arch.IsValid(); 921 } 922 } 923 return m_system_arch; 924 } 925 926 927 Error 928 Platform::ConnectRemote (Args& args) 929 { 930 Error error; 931 if (IsHost()) 932 error.SetErrorStringWithFormat ("The currently selected platform (%s) is the host platform and is always connected.", GetPluginName().GetCString()); 933 else 934 error.SetErrorStringWithFormat ("Platform::ConnectRemote() is not supported by %s", GetPluginName().GetCString()); 935 return error; 936 } 937 938 Error 939 Platform::DisconnectRemote () 940 { 941 Error error; 942 if (IsHost()) 943 error.SetErrorStringWithFormat ("The currently selected platform (%s) is the host platform and is always connected.", GetPluginName().GetCString()); 944 else 945 error.SetErrorStringWithFormat ("Platform::DisconnectRemote() is not supported by %s", GetPluginName().GetCString()); 946 return error; 947 } 948 949 bool 950 Platform::GetProcessInfo (lldb::pid_t pid, ProcessInstanceInfo &process_info) 951 { 952 // Take care of the host case so that each subclass can just 953 // call this function to get the host functionality. 954 if (IsHost()) 955 return Host::GetProcessInfo (pid, process_info); 956 return false; 957 } 958 959 uint32_t 960 Platform::FindProcesses (const ProcessInstanceInfoMatch &match_info, 961 ProcessInstanceInfoList &process_infos) 962 { 963 // Take care of the host case so that each subclass can just 964 // call this function to get the host functionality. 965 uint32_t match_count = 0; 966 if (IsHost()) 967 match_count = Host::FindProcesses (match_info, process_infos); 968 return match_count; 969 } 970 971 972 Error 973 Platform::LaunchProcess (ProcessLaunchInfo &launch_info) 974 { 975 Error error; 976 // Take care of the host case so that each subclass can just 977 // call this function to get the host functionality. 978 if (IsHost()) 979 { 980 if (::getenv ("LLDB_LAUNCH_FLAG_LAUNCH_IN_TTY")) 981 launch_info.GetFlags().Set (eLaunchFlagLaunchInTTY); 982 983 if (launch_info.GetFlags().Test (eLaunchFlagLaunchInShell)) 984 { 985 const bool is_localhost = true; 986 const bool will_debug = launch_info.GetFlags().Test(eLaunchFlagDebug); 987 const bool first_arg_is_full_shell_command = false; 988 uint32_t num_resumes = GetResumeCountForLaunchInfo (launch_info); 989 if (!launch_info.ConvertArgumentsForLaunchingInShell (error, 990 is_localhost, 991 will_debug, 992 first_arg_is_full_shell_command, 993 num_resumes)) 994 return error; 995 } 996 997 error = Host::LaunchProcess (launch_info); 998 } 999 else 1000 error.SetErrorString ("base lldb_private::Platform class can't launch remote processes"); 1001 return error; 1002 } 1003 1004 lldb::ProcessSP 1005 Platform::DebugProcess (ProcessLaunchInfo &launch_info, 1006 Debugger &debugger, 1007 Target *target, // Can be NULL, if NULL create a new target, else use existing one 1008 Listener &listener, 1009 Error &error) 1010 { 1011 ProcessSP process_sp; 1012 // Make sure we stop at the entry point 1013 launch_info.GetFlags ().Set (eLaunchFlagDebug); 1014 // We always launch the process we are going to debug in a separate process 1015 // group, since then we can handle ^C interrupts ourselves w/o having to worry 1016 // about the target getting them as well. 1017 launch_info.SetLaunchInSeparateProcessGroup(true); 1018 1019 error = LaunchProcess (launch_info); 1020 if (error.Success()) 1021 { 1022 if (launch_info.GetProcessID() != LLDB_INVALID_PROCESS_ID) 1023 { 1024 ProcessAttachInfo attach_info (launch_info); 1025 process_sp = Attach (attach_info, debugger, target, listener, error); 1026 if (process_sp) 1027 { 1028 // Since we attached to the process, it will think it needs to detach 1029 // if the process object just goes away without an explicit call to 1030 // Process::Kill() or Process::Detach(), so let it know to kill the 1031 // process if this happens. 1032 process_sp->SetShouldDetach (false); 1033 1034 // If we didn't have any file actions, the pseudo terminal might 1035 // have been used where the slave side was given as the file to 1036 // open for stdin/out/err after we have already opened the master 1037 // so we can read/write stdin/out/err. 1038 int pty_fd = launch_info.GetPTY().ReleaseMasterFileDescriptor(); 1039 if (pty_fd != lldb_utility::PseudoTerminal::invalid_fd) 1040 { 1041 process_sp->SetSTDIOFileDescriptor(pty_fd); 1042 } 1043 } 1044 } 1045 } 1046 return process_sp; 1047 } 1048 1049 1050 lldb::PlatformSP 1051 Platform::GetPlatformForArchitecture (const ArchSpec &arch, ArchSpec *platform_arch_ptr) 1052 { 1053 lldb::PlatformSP platform_sp; 1054 Error error; 1055 if (arch.IsValid()) 1056 platform_sp = Platform::Create (arch, platform_arch_ptr, error); 1057 return platform_sp; 1058 } 1059 1060 1061 //------------------------------------------------------------------ 1062 /// Lets a platform answer if it is compatible with a given 1063 /// architecture and the target triple contained within. 1064 //------------------------------------------------------------------ 1065 bool 1066 Platform::IsCompatibleArchitecture (const ArchSpec &arch, bool exact_arch_match, ArchSpec *compatible_arch_ptr) 1067 { 1068 // If the architecture is invalid, we must answer true... 1069 if (arch.IsValid()) 1070 { 1071 ArchSpec platform_arch; 1072 // Try for an exact architecture match first. 1073 if (exact_arch_match) 1074 { 1075 for (uint32_t arch_idx=0; GetSupportedArchitectureAtIndex (arch_idx, platform_arch); ++arch_idx) 1076 { 1077 if (arch.IsExactMatch(platform_arch)) 1078 { 1079 if (compatible_arch_ptr) 1080 *compatible_arch_ptr = platform_arch; 1081 return true; 1082 } 1083 } 1084 } 1085 else 1086 { 1087 for (uint32_t arch_idx=0; GetSupportedArchitectureAtIndex (arch_idx, platform_arch); ++arch_idx) 1088 { 1089 if (arch.IsCompatibleMatch(platform_arch)) 1090 { 1091 if (compatible_arch_ptr) 1092 *compatible_arch_ptr = platform_arch; 1093 return true; 1094 } 1095 } 1096 } 1097 } 1098 if (compatible_arch_ptr) 1099 compatible_arch_ptr->Clear(); 1100 return false; 1101 } 1102 1103 Error 1104 Platform::PutFile (const FileSpec& source, 1105 const FileSpec& destination, 1106 uint32_t uid, 1107 uint32_t gid) 1108 { 1109 Error error("unimplemented"); 1110 return error; 1111 } 1112 1113 Error 1114 Platform::GetFile (const FileSpec& source, 1115 const FileSpec& destination) 1116 { 1117 Error error("unimplemented"); 1118 return error; 1119 } 1120 1121 Error 1122 Platform::CreateSymlink (const char *src, // The name of the link is in src 1123 const char *dst)// The symlink points to dst 1124 { 1125 Error error("unimplemented"); 1126 return error; 1127 } 1128 1129 bool 1130 Platform::GetFileExists (const lldb_private::FileSpec& file_spec) 1131 { 1132 return false; 1133 } 1134 1135 Error 1136 Platform::Unlink (const char *path) 1137 { 1138 Error error("unimplemented"); 1139 return error; 1140 } 1141 1142 1143 1144 lldb_private::Error 1145 Platform::RunShellCommand (const char *command, // Shouldn't be NULL 1146 const char *working_dir, // Pass NULL to use the current working directory 1147 int *status_ptr, // Pass NULL if you don't want the process exit status 1148 int *signo_ptr, // Pass NULL if you don't want the signal that caused the process to exit 1149 std::string *command_output, // Pass NULL if you don't want the command output 1150 uint32_t timeout_sec) // Timeout in seconds to wait for shell program to finish 1151 { 1152 if (IsHost()) 1153 return Host::RunShellCommand (command, working_dir, status_ptr, signo_ptr, command_output, timeout_sec); 1154 else 1155 return Error("unimplemented"); 1156 } 1157 1158 1159 bool 1160 Platform::CalculateMD5 (const FileSpec& file_spec, 1161 uint64_t &low, 1162 uint64_t &high) 1163 { 1164 if (IsHost()) 1165 return Host::CalculateMD5(file_spec, low, high); 1166 else 1167 return false; 1168 } 1169 1170 void 1171 Platform::SetLocalCacheDirectory (const char* local) 1172 { 1173 m_local_cache_directory.assign(local); 1174 } 1175 1176 const char* 1177 Platform::GetLocalCacheDirectory () 1178 { 1179 return m_local_cache_directory.c_str(); 1180 } 1181 1182 static OptionDefinition 1183 g_rsync_option_table[] = 1184 { 1185 { LLDB_OPT_SET_ALL, false, "rsync" , 'r', OptionParser::eNoArgument, NULL, 0, eArgTypeNone , "Enable rsync." }, 1186 { LLDB_OPT_SET_ALL, false, "rsync-opts" , 'R', OptionParser::eRequiredArgument, NULL, 0, eArgTypeCommandName , "Platform-specific options required for rsync to work." }, 1187 { LLDB_OPT_SET_ALL, false, "rsync-prefix" , 'P', OptionParser::eRequiredArgument, NULL, 0, eArgTypeCommandName , "Platform-specific rsync prefix put before the remote path." }, 1188 { LLDB_OPT_SET_ALL, false, "ignore-remote-hostname" , 'i', OptionParser::eNoArgument, NULL, 0, eArgTypeNone , "Do not automatically fill in the remote hostname when composing the rsync command." }, 1189 }; 1190 1191 static OptionDefinition 1192 g_ssh_option_table[] = 1193 { 1194 { LLDB_OPT_SET_ALL, false, "ssh" , 's', OptionParser::eNoArgument, NULL, 0, eArgTypeNone , "Enable SSH." }, 1195 { LLDB_OPT_SET_ALL, false, "ssh-opts" , 'S', OptionParser::eRequiredArgument, NULL, 0, eArgTypeCommandName , "Platform-specific options required for SSH to work." }, 1196 }; 1197 1198 static OptionDefinition 1199 g_caching_option_table[] = 1200 { 1201 { LLDB_OPT_SET_ALL, false, "local-cache-dir" , 'c', OptionParser::eRequiredArgument, NULL, 0, eArgTypePath , "Path in which to store local copies of files." }, 1202 }; 1203 1204 OptionGroupPlatformRSync::OptionGroupPlatformRSync () 1205 { 1206 } 1207 1208 OptionGroupPlatformRSync::~OptionGroupPlatformRSync () 1209 { 1210 } 1211 1212 const lldb_private::OptionDefinition* 1213 OptionGroupPlatformRSync::GetDefinitions () 1214 { 1215 return g_rsync_option_table; 1216 } 1217 1218 void 1219 OptionGroupPlatformRSync::OptionParsingStarting (CommandInterpreter &interpreter) 1220 { 1221 m_rsync = false; 1222 m_rsync_opts.clear(); 1223 m_rsync_prefix.clear(); 1224 m_ignores_remote_hostname = false; 1225 } 1226 1227 lldb_private::Error 1228 OptionGroupPlatformRSync::SetOptionValue (CommandInterpreter &interpreter, 1229 uint32_t option_idx, 1230 const char *option_arg) 1231 { 1232 Error error; 1233 char short_option = (char) GetDefinitions()[option_idx].short_option; 1234 switch (short_option) 1235 { 1236 case 'r': 1237 m_rsync = true; 1238 break; 1239 1240 case 'R': 1241 m_rsync_opts.assign(option_arg); 1242 break; 1243 1244 case 'P': 1245 m_rsync_prefix.assign(option_arg); 1246 break; 1247 1248 case 'i': 1249 m_ignores_remote_hostname = true; 1250 break; 1251 1252 default: 1253 error.SetErrorStringWithFormat ("unrecognized option '%c'", short_option); 1254 break; 1255 } 1256 1257 return error; 1258 } 1259 1260 uint32_t 1261 OptionGroupPlatformRSync::GetNumDefinitions () 1262 { 1263 return llvm::array_lengthof(g_rsync_option_table); 1264 } 1265 1266 lldb::BreakpointSP 1267 Platform::SetThreadCreationBreakpoint (lldb_private::Target &target) 1268 { 1269 return lldb::BreakpointSP(); 1270 } 1271 1272 OptionGroupPlatformSSH::OptionGroupPlatformSSH () 1273 { 1274 } 1275 1276 OptionGroupPlatformSSH::~OptionGroupPlatformSSH () 1277 { 1278 } 1279 1280 const lldb_private::OptionDefinition* 1281 OptionGroupPlatformSSH::GetDefinitions () 1282 { 1283 return g_ssh_option_table; 1284 } 1285 1286 void 1287 OptionGroupPlatformSSH::OptionParsingStarting (CommandInterpreter &interpreter) 1288 { 1289 m_ssh = false; 1290 m_ssh_opts.clear(); 1291 } 1292 1293 lldb_private::Error 1294 OptionGroupPlatformSSH::SetOptionValue (CommandInterpreter &interpreter, 1295 uint32_t option_idx, 1296 const char *option_arg) 1297 { 1298 Error error; 1299 char short_option = (char) GetDefinitions()[option_idx].short_option; 1300 switch (short_option) 1301 { 1302 case 's': 1303 m_ssh = true; 1304 break; 1305 1306 case 'S': 1307 m_ssh_opts.assign(option_arg); 1308 break; 1309 1310 default: 1311 error.SetErrorStringWithFormat ("unrecognized option '%c'", short_option); 1312 break; 1313 } 1314 1315 return error; 1316 } 1317 1318 uint32_t 1319 OptionGroupPlatformSSH::GetNumDefinitions () 1320 { 1321 return llvm::array_lengthof(g_ssh_option_table); 1322 } 1323 1324 OptionGroupPlatformCaching::OptionGroupPlatformCaching () 1325 { 1326 } 1327 1328 OptionGroupPlatformCaching::~OptionGroupPlatformCaching () 1329 { 1330 } 1331 1332 const lldb_private::OptionDefinition* 1333 OptionGroupPlatformCaching::GetDefinitions () 1334 { 1335 return g_caching_option_table; 1336 } 1337 1338 void 1339 OptionGroupPlatformCaching::OptionParsingStarting (CommandInterpreter &interpreter) 1340 { 1341 m_cache_dir.clear(); 1342 } 1343 1344 lldb_private::Error 1345 OptionGroupPlatformCaching::SetOptionValue (CommandInterpreter &interpreter, 1346 uint32_t option_idx, 1347 const char *option_arg) 1348 { 1349 Error error; 1350 char short_option = (char) GetDefinitions()[option_idx].short_option; 1351 switch (short_option) 1352 { 1353 case 'c': 1354 m_cache_dir.assign(option_arg); 1355 break; 1356 1357 default: 1358 error.SetErrorStringWithFormat ("unrecognized option '%c'", short_option); 1359 break; 1360 } 1361 1362 return error; 1363 } 1364 1365 uint32_t 1366 OptionGroupPlatformCaching::GetNumDefinitions () 1367 { 1368 return llvm::array_lengthof(g_caching_option_table); 1369 } 1370 1371 size_t 1372 Platform::GetEnvironment (StringList &environment) 1373 { 1374 environment.Clear(); 1375 return false; 1376 } 1377