PlatformWasm.h

Go to the documentation of this file.

//===----------------------------------------------------------------------===//
//
// 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_SOURCE_PLUGINS_PLATFORM_WEBASSEMBLY_PLATFORMWASM_H
#define LLDB_SOURCE_PLUGINS_PLATFORM_WEBASSEMBLY_PLATFORMWASM_H
 
#include "lldb/Host/Host.h"
#include "lldb/Host/HostInfo.h"
#include "lldb/Target/Platform.h"
#include "lldb/Target/RemoteAwarePlatform.h"
 
namespace lldb_private {
 
class PlatformWasm : public RemoteAwarePlatform {
public:
  static void Initialize();
  static void Terminate();
 
  static llvm::StringRef GetPluginNameStatic() { return "wasm"; }
  static llvm::StringRef GetPluginDescriptionStatic();
 
  llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
  llvm::StringRef GetDescription() override {
    return GetPluginDescriptionStatic();
  }
 
  UserIDResolver &GetUserIDResolver() override {
    return HostInfo::GetUserIDResolver();
  }
 
  std::vector<ArchSpec>
  GetSupportedArchitectures(const ArchSpec &process_host_arch) override;
 
  lldb::ProcessSP DebugProcess(ProcessLaunchInfo &launch_info,
                               Debugger &debugger, Target &target,
                               Status &error) override;
 
  lldb::ProcessSP Attach(ProcessAttachInfo &attach_info, Debugger &debugger,
                         Target *target, Status &status) override;
 
  /// Assemble the command line that launches the runtime on \p module_path,
  /// serving its GDB remote stub on \p port. Extra \p runtime_args precede the
  /// port argument, so they can carry a subcommand the runtime expects first,
  /// such as WasmKit's `run`. An empty \p env_arg forwards no environment.
  static Args
  MakeRuntimeCommand(llvm::StringRef runtime_path, const Args &runtime_args,
                     llvm::StringRef port_arg, uint16_t port,
                     llvm::StringRef env_arg, const Environment &env,
                     llvm::StringRef module_path, const Args &inferior_args);
 
  Status ConnectRemote(Args &args) override;
 
  void CalculateTrapHandlerSymbolNames() override {}
 
  MmapArgList GetMmapArgumentList(const ArchSpec &arch, lldb::addr_t addr,
                                  lldb::addr_t length, unsigned prot,
                                  unsigned flags, lldb::addr_t fd,
                                  lldb::addr_t offset) override {
    return Platform::GetHostPlatform()->GetMmapArgumentList(
        arch, addr, length, prot, flags, fd, offset);
  }
 
protected:
  /// Find a free TCP port by binding to port 0.
  static llvm::Expected<uint16_t> FindFreeTCPPort();
 
  static auto GetArgRange(const Args &args) {
    return llvm::make_range(args.GetArgumentArrayRef().begin(),
                            args.GetArgumentArrayRef().end());
  }
 
  PlatformWasm() : RemoteAwarePlatform(/*is_host=*/false) {}
 
private:
  static lldb::PlatformSP CreateInstance(bool force, const ArchSpec *arch);
  static void DebuggerInitialize(Debugger &debugger);
};
 
} // namespace lldb_private
 
#endif // LLDB_SOURCE_PLUGINS_PLATFORM_WEBASSEMBLY_PLATFORMWASM_H