guest.h

Go to the documentation of this file.

 
#pragma once
 
#include <cstddef>
#include <span>
#include <stop_token>
#include <string_view>
 
#include <rex/platform.h>
#include <rex/result.h>
#include <rex/types.h>
#include <rex/utility.h>
 
namespace rex {
 
struct PhysicalRange {
  u32 address = 0;
  u32 length = 0;
};
 
class IPhysicalWriteListener {
 public:
  virtual ~IPhysicalWriteListener() = default;

  virtual PhysicalRange OnPhysicalWrite(PhysicalRange range, bool exact) = 0;
};

class IPhysicalMemory {
 public:
  virtual ~IPhysicalMemory() = default;

  [[nodiscard]] virtual Result<void> CopyFromPhysical(u32 address, std::span<std::byte> out) = 0;

  [[nodiscard]] virtual Result<void> CopyToPhysical(u32 address,
                                                    std::span<const std::byte> data) = 0;

  [[nodiscard]] virtual Result<std::span<const std::byte>> GetReadOnlyPhysicalSpan(
      PhysicalRange range) = 0;

  [[nodiscard]] virtual Result<std::span<std::byte>> GetWritablePhysicalSpan(
      PhysicalRange range) = 0;

  [[nodiscard]] virtual Result<void> StoreRelease32(u32 address, u32 value) = 0;

  [[nodiscard]] virtual Result<u32> LoadAcquire32(u32 address) = 0;
};
 
class IPhysicalWriteWatch {
 public:
  virtual ~IPhysicalWriteWatch() = default;

  [[nodiscard]] virtual ScopeGuard AddWriteListener(IPhysicalWriteListener& listener) = 0;

  virtual void WatchPhysicalWrites(PhysicalRange range) = 0;

  [[nodiscard]] virtual ScopeGuard LockWriteWatches() = 0;
};

class IGuestInterrupts {
 public:
  virtual ~IGuestInterrupts() = default;

  [[nodiscard]] virtual Result<void> RaiseGraphicsInterrupt(u32 source, u32 cpu) = 0;

  [[nodiscard]] virtual Result<ScopeGuard> StartHostThread(
      std::string_view name, MoveOnlyFunction<void(std::stop_token)> fn) = 0;
};
 
}  // namespace rex