2014-04-09 03:19:26 +04:00
|
|
|
// Copyright 2014 Citra Emulator Project
|
2014-12-17 08:38:14 +03:00
|
|
|
// Licensed under GPLv2 or any later version
|
2014-11-19 11:49:13 +03:00
|
|
|
// Refer to the license.txt file included.
|
2014-04-05 06:26:06 +04:00
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2018-01-10 00:33:46 +03:00
|
|
|
#include <array>
|
2014-04-09 04:15:08 +04:00
|
|
|
#include "common/common_types.h"
|
2018-09-21 02:28:48 +03:00
|
|
|
|
|
|
|
namespace Kernel {
|
|
|
|
enum class VMAPermission : u8;
|
|
|
|
}
|
2014-04-05 06:26:06 +04:00
|
|
|
|
2018-08-25 04:43:32 +03:00
|
|
|
namespace Core {
|
|
|
|
|
2018-09-18 09:49:40 +03:00
|
|
|
/// Generic ARMv8 CPU interface
|
2014-04-28 02:29:51 +04:00
|
|
|
class ARM_Interface : NonCopyable {
|
2014-04-05 06:26:06 +04:00
|
|
|
public:
|
2016-09-19 04:01:46 +03:00
|
|
|
virtual ~ARM_Interface() {}
|
2014-04-05 06:26:06 +04:00
|
|
|
|
2016-12-22 08:08:09 +03:00
|
|
|
struct ThreadContext {
|
2018-01-10 00:33:46 +03:00
|
|
|
std::array<u64, 31> cpu_registers;
|
2017-08-29 04:09:42 +03:00
|
|
|
u64 sp;
|
|
|
|
u64 pc;
|
2018-09-30 00:58:26 +03:00
|
|
|
u32 pstate;
|
|
|
|
std::array<u8, 4> padding;
|
2018-09-18 09:49:40 +03:00
|
|
|
std::array<u128, 32> vector_registers;
|
2018-09-30 00:58:26 +03:00
|
|
|
u32 fpcr;
|
|
|
|
u32 fpsr;
|
|
|
|
u64 tpidr;
|
2016-12-22 08:08:09 +03:00
|
|
|
};
|
2018-09-30 00:58:26 +03:00
|
|
|
// Internally within the kernel, it expects the AArch64 version of the
|
|
|
|
// thread context to be 800 bytes in size.
|
|
|
|
static_assert(sizeof(ThreadContext) == 0x320);
|
2016-12-22 08:08:09 +03:00
|
|
|
|
2018-02-14 20:47:48 +03:00
|
|
|
/// Runs the CPU until an event happens
|
|
|
|
virtual void Run() = 0;
|
2014-05-17 19:59:18 +04:00
|
|
|
|
2014-04-05 23:23:59 +04:00
|
|
|
/// Step CPU by one instruction
|
2018-02-14 20:47:48 +03:00
|
|
|
virtual void Step() = 0;
|
2014-05-17 19:59:18 +04:00
|
|
|
|
2018-03-17 01:22:14 +03:00
|
|
|
/// Maps a backing memory region for the CPU
|
2018-09-15 16:21:06 +03:00
|
|
|
virtual void MapBackingMemory(VAddr address, std::size_t size, u8* memory,
|
2018-03-17 01:22:14 +03:00
|
|
|
Kernel::VMAPermission perms) = 0;
|
|
|
|
|
|
|
|
/// Unmaps a region of memory that was previously mapped using MapBackingMemory
|
2018-09-15 16:21:06 +03:00
|
|
|
virtual void UnmapMemory(VAddr address, std::size_t size) = 0;
|
2017-10-10 06:56:20 +03:00
|
|
|
|
2016-06-27 21:38:49 +03:00
|
|
|
/// Clear all instruction cache
|
|
|
|
virtual void ClearInstructionCache() = 0;
|
|
|
|
|
2017-09-25 00:44:13 +03:00
|
|
|
/// Notify CPU emulation that page tables have changed
|
|
|
|
virtual void PageTableChanged() = 0;
|
|
|
|
|
2014-04-05 23:23:59 +04:00
|
|
|
/**
|
|
|
|
* Set the Program Counter to an address
|
|
|
|
* @param addr Address to set PC to
|
|
|
|
*/
|
2017-08-29 04:09:42 +03:00
|
|
|
virtual void SetPC(u64 addr) = 0;
|
2014-04-05 23:23:59 +04:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Get the current Program Counter
|
|
|
|
* @return Returns current PC
|
|
|
|
*/
|
2017-08-29 04:09:42 +03:00
|
|
|
virtual u64 GetPC() const = 0;
|
2014-04-05 23:23:59 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get an ARM register
|
2017-08-29 04:09:42 +03:00
|
|
|
* @param index Register index
|
2014-04-05 23:23:59 +04:00
|
|
|
* @return Returns the value in the register
|
|
|
|
*/
|
2017-08-29 04:09:42 +03:00
|
|
|
virtual u64 GetReg(int index) const = 0;
|
2014-04-05 23:23:59 +04:00
|
|
|
|
2014-04-11 03:57:56 +04:00
|
|
|
/**
|
|
|
|
* Set an ARM register
|
2017-08-29 04:09:42 +03:00
|
|
|
* @param index Register index
|
2014-04-11 03:57:56 +04:00
|
|
|
* @param value Value to set register to
|
|
|
|
*/
|
2017-08-29 04:09:42 +03:00
|
|
|
virtual void SetReg(int index, u64 value) = 0;
|
2014-04-11 03:57:56 +04:00
|
|
|
|
2015-08-07 04:24:25 +03:00
|
|
|
/**
|
2018-09-18 09:49:40 +03:00
|
|
|
* Gets the value of a specified vector register.
|
|
|
|
*
|
|
|
|
* @param index The index of the vector register.
|
|
|
|
* @return the value within the vector register.
|
2015-08-07 04:24:25 +03:00
|
|
|
*/
|
2018-09-18 09:49:40 +03:00
|
|
|
virtual u128 GetVectorReg(int index) const = 0;
|
2015-08-07 04:24:25 +03:00
|
|
|
|
|
|
|
/**
|
2018-09-18 09:49:40 +03:00
|
|
|
* Sets a given value into a vector register.
|
|
|
|
*
|
|
|
|
* @param index The index of the vector register.
|
|
|
|
* @param value The new value to place in the register.
|
2015-08-07 04:24:25 +03:00
|
|
|
*/
|
2018-09-18 09:49:40 +03:00
|
|
|
virtual void SetVectorReg(int index, u128 value) = 0;
|
2015-08-07 04:24:25 +03:00
|
|
|
|
2014-04-05 23:23:59 +04:00
|
|
|
/**
|
2018-09-18 09:49:40 +03:00
|
|
|
* Get the current PSTATE register
|
|
|
|
* @return Returns the value of the PSTATE register
|
2014-04-05 23:23:59 +04:00
|
|
|
*/
|
2018-09-18 09:49:40 +03:00
|
|
|
virtual u32 GetPSTATE() const = 0;
|
2014-04-05 09:23:28 +04:00
|
|
|
|
2014-05-12 06:14:13 +04:00
|
|
|
/**
|
2018-09-18 09:49:40 +03:00
|
|
|
* Set the current PSTATE register
|
|
|
|
* @param pstate Value to set PSTATE to
|
2014-05-12 06:14:13 +04:00
|
|
|
*/
|
2018-09-18 09:49:40 +03:00
|
|
|
virtual void SetPSTATE(u32 pstate) = 0;
|
2014-05-12 06:14:13 +04:00
|
|
|
|
2017-09-30 21:16:39 +03:00
|
|
|
virtual VAddr GetTlsAddress() const = 0;
|
|
|
|
|
|
|
|
virtual void SetTlsAddress(VAddr address) = 0;
|
|
|
|
|
2018-09-18 09:49:40 +03:00
|
|
|
/**
|
|
|
|
* Gets the value within the TPIDR_EL0 (read/write software thread ID) register.
|
|
|
|
*
|
|
|
|
* @return the value within the register.
|
|
|
|
*/
|
2018-07-21 03:57:45 +03:00
|
|
|
virtual u64 GetTPIDR_EL0() const = 0;
|
|
|
|
|
2018-09-18 09:49:40 +03:00
|
|
|
/**
|
|
|
|
* Sets a new value within the TPIDR_EL0 (read/write software thread ID) register.
|
|
|
|
*
|
|
|
|
* @param value The new value to place in the register.
|
|
|
|
*/
|
2018-07-21 03:57:45 +03:00
|
|
|
virtual void SetTPIDR_EL0(u64 value) = 0;
|
|
|
|
|
2014-05-21 02:50:16 +04:00
|
|
|
/**
|
|
|
|
* Saves the current CPU context
|
|
|
|
* @param ctx Thread context to save
|
|
|
|
*/
|
2016-12-22 08:08:09 +03:00
|
|
|
virtual void SaveContext(ThreadContext& ctx) = 0;
|
2014-05-21 02:50:16 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Loads a CPU context
|
|
|
|
* @param ctx Thread context to load
|
|
|
|
*/
|
2016-12-22 08:08:09 +03:00
|
|
|
virtual void LoadContext(const ThreadContext& ctx) = 0;
|
2014-05-21 02:50:16 +04:00
|
|
|
|
2018-09-18 09:49:40 +03:00
|
|
|
/// Clears the exclusive monitor's state.
|
2018-07-16 13:24:00 +03:00
|
|
|
virtual void ClearExclusiveState() = 0;
|
|
|
|
|
2014-06-02 05:40:10 +04:00
|
|
|
/// Prepare core for thread reschedule (if needed to correctly handle state)
|
|
|
|
virtual void PrepareReschedule() = 0;
|
2018-12-03 12:13:48 +03:00
|
|
|
|
|
|
|
virtual void LogBacktrace() = 0;
|
2014-04-05 06:26:06 +04:00
|
|
|
};
|
2018-08-25 04:43:32 +03:00
|
|
|
|
|
|
|
} // namespace Core
|