image.h

Go to the documentation of this file.

 
#pragma once
 
#include <span>
#include <cstddef>
#include <cstdint>
#include <filesystem>
#include <optional>
#include <string_view>
 
#include <rex/types.h>
#include <rex/platform.h>
 
struct PPCFuncMapping;
 
namespace rex::kernel {
class IModuleRegistry;
}  // namespace rex::kernel
 
namespace rex::ppc {

using RegisterModulesFunc = void (*)(kernel::IModuleRegistry& modules);

using RecompiledCodeFunc = std::span<const u8> (*)();

struct PPCCodegenFlags {
  bool skip_lr = false;
  bool ctr_as_local = false;
  bool xer_as_local = false;
  bool reserved_as_local = false;
  bool skip_msr = false;
  bool cr_as_local = false;
  bool non_argument_as_local = false;
  bool non_volatile_as_local = false;
};

struct PPCCallUsage {
  u32 address;
  u8 gpr_mask;  
  u16 fpr_mask; 
};

struct PPCImage {
  u32 code_base; 
  u32 code_size;
  u32 image_base;
  u32 image_size;
  const PPCFuncMapping* func_mappings;
  bool shim_heap = false; 
  RegisterModulesFunc register_modules = nullptr; 
  PPCCodegenFlags codegen_flags{};                
  RecompiledCodeFunc recompiled_code =
      nullptr; 
  const PPCCallUsage* call_usage = nullptr;
};

struct EmbeddedMetadataAsset {
  std::span<const u8> bytes;
};

REX_PPC_API bool RegisterEmbeddedMetadataAsset(std::string_view relative_path, const u8* data,
                                               std::size_t size);

REX_PPC_API std::optional<EmbeddedMetadataAsset> FindEmbeddedMetadataAsset(
    const std::filesystem::path& relative_path);

enum class RuntimeFunctionType : u8 {
  kSaveMillicode,    
  kNoHandler,        
  kRestoreMillicode, 
  kHandler           
};
 
struct RuntimeFunction {
  u32 begin; 
  RuntimeFunctionType type;
  u32 length;   
  u32 prologue; 
};

constexpr RuntimeFunction DecodeRuntimeFunction(u32 begin, u32 word) {
  return RuntimeFunction{begin, static_cast<RuntimeFunctionType>(word >> 30),
                         (word >> 8) & 0x3FFFFFu, word & 0xFFu};
}
 
}  // namespace rex::ppc