HostInfoBase.h

Go to the documentation of this file.

//===-- HostInfoBase.h ------------------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
 
#ifndef LLDB_HOST_HOSTINFOBASE_H
#define LLDB_HOST_HOSTINFOBASE_H
 
#include "lldb/Utility/ArchSpec.h"
#include "lldb/Utility/DataExtractor.h"
#include "lldb/Utility/FileSpec.h"
#include "lldb/Utility/UUID.h"
#include "lldb/Utility/UserIDResolver.h"
#include "lldb/Utility/XcodeSDK.h"
#include "lldb/lldb-enumerations.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/Errc.h"
 
#include <cstdint>
 
#include <optional>
#include <string>
 
namespace lldb_private {
 
class FileSpec;
 
struct SharedCacheImageInfo {
  SharedCacheImageInfo()
      : m_filename(), m_uuid(), m_extractor_sp(),
        m_create_data_extractor(nullptr), m_image_baton(nullptr) {}
  SharedCacheImageInfo(ConstString filename, UUID uuid,
                       lldb::DataExtractorSP extractor_sp)
      : m_filename(filename), m_uuid(uuid), m_extractor_sp(extractor_sp),
        m_create_data_extractor(nullptr), m_image_baton(nullptr) {}
  SharedCacheImageInfo(
      ConstString filename, UUID uuid,
      lldb::DataExtractorSP (*create_data_extractor)(void *image),
      void *image_baton)
      : m_filename(filename), m_uuid(uuid), m_extractor_sp(),
        m_create_data_extractor(create_data_extractor),
        m_image_baton(image_baton) {}
 
  lldb::DataExtractorSP GetExtractor() {
    if (!m_extractor_sp && m_image_baton)
      m_extractor_sp = m_create_data_extractor(m_image_baton);
    return m_extractor_sp;
  }
  ConstString GetFilename() const { return m_filename; }
  const UUID &GetUUID() const { return m_uuid; }
  void *GetImageBaton();
  void SetExtractor(lldb::DataExtractorSP extractor_sp) {
    m_extractor_sp = extractor_sp;
  }
  void SetImageBaton(void *image_baton) { m_image_baton = image_baton; }
  void SetDataExtractorCreateFunction(
      lldb::DataExtractorSP (*create_data_extractor)(void *image));
 
private:
  ConstString m_filename;
  UUID m_uuid;
  lldb::DataExtractorSP m_extractor_sp;
  lldb::DataExtractorSP (*m_create_data_extractor)(void *image);
  void *m_image_baton;
};
 
namespace {
struct HostInfoError : public llvm::ErrorInfo<HostInfoError> {
  static char ID;
  const std::string message_;
 
  HostInfoError(const std::string message) : message_(std::move(message)) {}
 
  void log(llvm::raw_ostream &OS) const override { OS << "HostInfoError"; }
 
  std::error_code convertToErrorCode() const override {
    return llvm::inconvertibleErrorCode();
  }
};
 
char HostInfoError::ID = 0;
} // namespace
 
class HostInfoBase {
private:
  // Static class, unconstructable.
  HostInfoBase() = default;
  ~HostInfoBase() = default;
 
public:
  /// A helper function for determining the liblldb location. It receives a
  /// FileSpec with the location of file containing _this_ code. It can
  /// (optionally) replace it with a file spec pointing to a more canonical
  /// copy.
  using SharedLibraryDirectoryHelper = void(FileSpec &this_file);
  static void
  SetSharedLibraryDirectoryHelper(SharedLibraryDirectoryHelper *helper);
 
  static void Initialize();
  static void Terminate();
 
  /// Gets the host target triple.
  ///
  /// \return
  ///     The host target triple.
  static llvm::Triple GetTargetTriple();
 
  enum ArchitectureKind {
    eArchKindDefault, // The overall default architecture that applications will
                      // run on this host
    eArchKind32, // If this host supports 32 bit programs, return the default 32
                 // bit arch
    eArchKind64  // If this host supports 64 bit programs, return the default 64
                 // bit arch
  };
 
  static const ArchSpec &
  GetArchitecture(ArchitectureKind arch_kind = eArchKindDefault);
 
  static std::optional<ArchitectureKind>
  ParseArchitectureKind(llvm::StringRef kind);
 
  /// Returns the directory containing the lldb shared library. Only the
  /// directory member of the FileSpec is filled in.
  static FileSpec GetShlibDir();
 
  /// Returns the directory containing the support executables (debugserver,
  /// ...). Only the directory member of the FileSpec is filled in.
  static FileSpec GetSupportExeDir();
 
  /// Returns the directory containing the lldb headers. Only the directory
  /// member of the FileSpec is filled in.
  static FileSpec GetHeaderDir();
 
  /// Returns the directory containing the system plugins. Only the directory
  /// member of the FileSpec is filled in.
  static FileSpec GetSystemPluginDir();
 
  /// Returns the directory containing the users home (e.g. `~/`). Only the
  /// directory member of the FileSpec is filled in.
  static FileSpec GetUserHomeDir();
 
  /// Returns the directory containing the users lldb home (e.g. `~/.lldb/`).
  /// Only the directory member of the FileSpec is filled in.
  static FileSpec GetUserLLDBDir();
 
  /// Returns the directory containing the user plugins. Only the directory
  /// member of the FileSpec is filled in.
  static FileSpec GetUserPluginDir();
 
  /// Returns the process temporary directory. This directory will be cleaned up
  /// when this process exits. Only the directory member of the FileSpec is
  /// filled in.
  static FileSpec GetProcessTempDir();
 
  /// Returns the global temporary directory. This directory will **not** be
  /// cleaned up when this process exits. Only the directory member of the
  /// FileSpec is filled in.
  static FileSpec GetGlobalTempDir();
 
  /// If the triple does not specify the vendor, os, and environment parts, we
  /// "augment" these using information from the host and return the resulting
  /// ArchSpec object.
  static ArchSpec GetAugmentedArchSpec(llvm::StringRef triple);
 
  static bool ComputePathRelativeToLibrary(FileSpec &file_spec,
                                           llvm::StringRef dir);
 
  static FileSpec GetXcodeContentsDirectory() { return {}; }
  static FileSpec GetXcodeDeveloperDirectory() { return {}; }
  static FileSpec GetCurrentXcodeToolchainDirectory() { return {}; }
  static FileSpec GetCurrentCommandLineToolsDirectory() { return {}; }
 
  struct SDKOptions {
    std::optional<XcodeSDK> XcodeSDKSelection;
  };
 
  /// Return the directory containing something like a SDK (reused for Swift).
  static llvm::Expected<llvm::StringRef> GetSDKRoot(SDKOptions options) {
    return llvm::make_error<HostInfoError>("cannot determine SDK root");
  }
 
  /// Return the path to a specific tool in the specified Xcode SDK.
  static llvm::Expected<llvm::StringRef> FindSDKTool(XcodeSDK sdk,
                                                     llvm::StringRef tool) {
    return llvm::errorCodeToError(llvm::errc::no_such_file_or_directory);
  }
 
  /// Return information about module \p filepath if it is loaded in
  /// the current process's address space.
  ///
  /// \param[in] sc_mode
  ///     Flag to control if this method can try to read a shared
  ///     cache binary blob directly, needed to keep user settings out of
  ///     Host.
  static SharedCacheImageInfo
  GetSharedCacheImageInfo(ConstString filepath,
                          lldb::SymbolSharedCacheUse sc_mode) {
    return {};
  }
 
  /// Return information about module \p uuid if it is loaded in
  /// the current process's address space.
  ///
  /// \param[in] sc_mode
  ///     Flag to control if this method can try to read a shared
  ///     cache binary blob directly, needed to keep user settings out of
  ///     Host.
  static SharedCacheImageInfo
  GetSharedCacheImageInfo(const UUID &uuid,
                          lldb::SymbolSharedCacheUse sc_mode) {
    return {};
  }
 
  /// Return information about module \p filepath, if it is loaded in
  /// the current process's address space using shared cache \p sc_uuid.
  /// The shared cache must have been previously indexed.
  ///
  /// \param[in] sc_mode
  ///     Flag to control if this method can try to read a shared
  ///     cache binary blob directly, needed to keep user settings out of
  ///     Host.
  static SharedCacheImageInfo
  GetSharedCacheImageInfo(ConstString filepath, const UUID &sc_uuid,
                          lldb::SymbolSharedCacheUse sc_mode) {
    return {};
  }
 
  /// Return information about module \p uuid, if it is loaded in
  /// the current process's address space using shared cache \p sc_uuid.
  /// The shared cache must have been previously indexed.
  ///
  /// \param[in] sc_mode
  ///     Flag to control if this method can try to read a shared
  ///     cache binary blob directly, needed to keep user settings out of
  ///     Host.
  static SharedCacheImageInfo
  GetSharedCacheImageInfo(const UUID &uuid, const UUID &sc_uuid,
                          lldb::SymbolSharedCacheUse sc_mode) {
    return {};
  }
 
  /// Return information about module \p image_name if it is loaded in
  /// the current process's address space using shared cache \p uuid.
  /// The shared cache UUID must have been previously indexed.
  ///
  /// \param[in] use_sc_binary_directly
  ///     Flag to control if this method can try to read a shared
  ///     cache binary blob directly, needed to keep user settings out of
  ///     Host.
  static SharedCacheImageInfo
  GetSharedCacheImageInfo(llvm::StringRef image_name, const UUID &uuid,
                          lldb::SymbolSharedCacheUse sc_mode) {
    return {};
  }
 
  /// Scan the files in a shared cache, if the filepath and uuid match
  /// on the debug host.
  /// Returns false if the shared cache filepath did not exist, or uuid
  /// did not match.
  static bool SharedCacheIndexFiles(FileSpec &filepath, UUID &uuid,
                                    lldb::SymbolSharedCacheUse sc_mode) {
    return false;
  }
 
  /// Returns the distribution id of the host
  ///
  /// This will be something like "ubuntu", "fedora", etc. on Linux.
  ///
  /// \return Returns either std::nullopt or a reference to a const std::string
  /// containing the distribution id
  static llvm::StringRef GetDistributionId() { return llvm::StringRef(); }
 
protected:
  static bool
  ComputeSharedLibraryDirectory(FileSpec &file_spec,
                                SharedLibraryDirectoryHelper *helper);
  static bool ComputeSupportExeDirectory(FileSpec &file_spec);
  static bool ComputeProcessTempFileDirectory(FileSpec &file_spec);
  static bool ComputeGlobalTempFileDirectory(FileSpec &file_spec);
  static bool ComputeTempFileBaseDirectory(FileSpec &file_spec);
  static bool ComputeHeaderDirectory(FileSpec &file_spec);
  static bool ComputeSystemPluginsDirectory(FileSpec &file_spec);
  static bool ComputeUserHomeDirectory(FileSpec &file_spec);
  static bool ComputeUserLLDBHomeDirectory(FileSpec &file_spec);
  static bool ComputeUserPluginsDirectory(FileSpec &file_spec);
 
  static void ComputeHostArchitectureSupport(ArchSpec &arch_32,
                                             ArchSpec &arch_64);
};
} // namespace lldb_private
 
#endif