Files
Xenia-Canary/src/xenia/cpu/libjit/libjit_emitter.cc
2013-05-22 21:53:21 -07:00

1361 lines
42 KiB
C++

/**
******************************************************************************
* Xenia : Xbox 360 Emulator Research Project *
******************************************************************************
* Copyright 2013 Ben Vanik. All rights reserved. *
* Released under the BSD license - see LICENSE in the root for more details. *
******************************************************************************
*/
#include <xenia/cpu/libjit/libjit_emitter.h>
#include <xenia/cpu/cpu-private.h>
#include <xenia/cpu/ppc/state.h>
using namespace xe::cpu::libjit;
using namespace xe::cpu::ppc;
using namespace xe::cpu::sdb;
DEFINE_bool(memory_address_verification, false,
"Whether to add additional checks to generated memory load/stores.");
DEFINE_bool(log_codegen, false,
"Log codegen to stdout.");
/**
* This generates function code.
* One context is created and shared for each function to generate.
* Each basic block in the function is created and stashed in one pass, then
* filled in the next.
*
* This context object is a stateful representation of the current machine state
* and all accessors to registers should occur through it. By doing so it's
* possible to exploit the SSA nature of LLVM to reuse register values within
* a function without needing to flush to memory.
*
* Function calls (any branch outside of the function) will result in an
* expensive flush of registers.
*
* TODO(benvanik): track arguments by looking for register reads without writes
* TODO(benvanik): avoid flushing registers for leaf nodes
* TODO(benvnaik): pass return value in LLVM return, not by memory
*/
LibjitEmitter::LibjitEmitter(xe_memory_ref memory, jit_context_t context) {
memory_ = memory;
context_ = context;
// Grab global exports.
cpu::GetGlobalExports(&global_exports_);
// Function type for all functions.
// TODO(benvanik): evaluate using jit_abi_fastcall
jit_type_t fn_params[] = {
jit_type_void_ptr,
jit_type_uint
};
fn_signature_ = jit_type_create_signature(
jit_abi_cdecl,
jit_type_void,
fn_params, XECOUNT(fn_params),
0);
jit_type_t shim_params[] = {
jit_type_void_ptr,
jit_type_void_ptr,
};
shim_signature_ = jit_type_create_signature(
jit_abi_cdecl,
jit_type_void,
shim_params, XECOUNT(shim_params),
0);
jit_type_t global_export_params_2[] = {
jit_type_void_ptr,
jit_type_ulong,
};
global_export_signature_2_ = jit_type_create_signature(
jit_abi_cdecl,
jit_type_void,
global_export_params_2, XECOUNT(global_export_params_2),
0);
jit_type_t global_export_params_3[] = {
jit_type_void_ptr,
jit_type_ulong,
jit_type_ulong,
};
global_export_signature_3_ = jit_type_create_signature(
jit_abi_cdecl,
jit_type_void,
global_export_params_3, XECOUNT(global_export_params_3),
0);
jit_type_t global_export_params_4[] = {
jit_type_void_ptr,
jit_type_ulong,
jit_type_ulong,
jit_type_void_ptr,
};
global_export_signature_4_ = jit_type_create_signature(
jit_abi_cdecl,
jit_type_void,
global_export_params_4, XECOUNT(global_export_params_4),
0);
}
LibjitEmitter::~LibjitEmitter() {
jit_type_free(fn_signature_);
jit_type_free(shim_signature_);
jit_type_free(global_export_signature_2_);
jit_type_free(global_export_signature_3_);
jit_type_free(global_export_signature_4_);
}
jit_context_t LibjitEmitter::context() {
return context_;
}
namespace {
int libjit_on_demand_compile(jit_function_t fn) {
LibjitEmitter* emitter = (LibjitEmitter*)jit_function_get_meta(fn, 0x1000);
FunctionSymbol* symbol = (FunctionSymbol*)jit_function_get_meta(fn, 0x1001);
XELOGE("Compile(%s): beginning on-demand compilation...", symbol->name());
int result_code = emitter->MakeFunction(symbol, fn);
if (result_code) {
XELOGCPU("Compile(%s): failed to make function", symbol->name());
return JIT_RESULT_COMPILE_ERROR;
}
return JIT_RESULT_OK;
}
}
int LibjitEmitter::PrepareFunction(FunctionSymbol* symbol) {
if (symbol->impl_value) {
return 0;
}
jit_context_build_start(context_);
// Create the function and setup for on-demand compilation.
jit_function_t fn = jit_function_create(context_, fn_signature_);
jit_function_set_meta(fn, 0x1000, this, NULL, 0);
jit_function_set_meta(fn, 0x1001, symbol, NULL, 0);
jit_function_set_on_demand_compiler(fn, libjit_on_demand_compile);
// Set optimization options.
// TODO(benvanik): add gflags
uint32_t max_level = jit_function_get_max_optimization_level();
uint32_t opt_level = max_level; // 0
opt_level = MIN(max_level, MAX(0, opt_level));
jit_function_set_optimization_level(fn, opt_level);
// Stash for later.
symbol->impl_value = fn;
jit_context_build_end(context_);
return 0;
}
int LibjitEmitter::MakeFunction(FunctionSymbol* symbol, jit_function_t fn) {
symbol_ = symbol;
fn_ = fn;
fn_block_ = NULL;
return_block_ = jit_label_undefined;
internal_indirection_block_ = jit_label_undefined;
external_indirection_block_ = jit_label_undefined;
bbs_.clear();
cia_ = 0;
access_bits_.Clear();
locals_.indirection_target = NULL;
locals_.indirection_cia = NULL;
locals_.xer = NULL;
locals_.lr = NULL;
locals_.ctr = NULL;
for (size_t n = 0; n < XECOUNT(locals_.cr); n++) {
locals_.cr[n] = NULL;
}
for (size_t n = 0; n < XECOUNT(locals_.gpr); n++) {
locals_.gpr[n] = NULL;
}
for (size_t n = 0; n < XECOUNT(locals_.fpr); n++) {
locals_.fpr[n] = NULL;
}
if (FLAGS_log_codegen) {
printf("%s:\n", symbol->name());
}
int result_code = 0;
switch (symbol->type) {
case FunctionSymbol::User:
result_code = MakeUserFunction();
break;
case FunctionSymbol::Kernel:
if (symbol->kernel_export && symbol->kernel_export->is_implemented) {
result_code = MakePresentImportFunction();
} else {
result_code = MakeMissingImportFunction();
}
break;
default:
XEASSERTALWAYS();
result_code = 1;
break;
}
if (!result_code) {
// TODO(benvanik): flag
// pre
jit_dump_function(stdout, fn_, symbol->name());
jit_function_compile(fn_);
// post
jit_dump_function(stdout, fn_, symbol->name());
XELOGE("Compile(%s): compiled to 0x%p - 0x%p (%db)",
symbol->name(),
jit_function_get_code_start_address(fn_),
jit_function_get_code_end_address(fn_),
(uint32_t)(
(intptr_t)jit_function_get_code_end_address(fn_) -
(intptr_t)jit_function_get_code_start_address(fn_)));
}
return result_code;
}
int LibjitEmitter::MakeUserFunction() {
if (FLAGS_trace_user_calls) {
jit_value_t trace_args[] = {
jit_value_get_param(fn_, 0),
jit_value_create_long_constant(fn_, jit_type_ulong,
(jit_ulong)symbol_->start_address),
jit_value_get_param(fn_, 1),
jit_value_create_long_constant(fn_, jit_type_ulong,
(jit_ulong)symbol_),
};
jit_insn_call_native(
fn_,
"XeTraceUserCall",
global_exports_.XeTraceUserCall,
global_export_signature_4_,
trace_args, XECOUNT(trace_args),
0);
}
// Emit.
GenerateBasicBlocks();
return 0;
}
int LibjitEmitter::MakePresentImportFunction() {
if (FLAGS_trace_kernel_calls) {
jit_value_t trace_args[] = {
jit_value_get_param(fn_, 0),
jit_value_create_long_constant(fn_, jit_type_ulong,
(jit_ulong)symbol_->start_address),
jit_value_get_param(fn_, 1),
jit_value_create_long_constant(fn_, jit_type_ulong,
(jit_ulong)symbol_->kernel_export),
};
jit_insn_call_native(
fn_,
"XeTraceKernelCall",
global_exports_.XeTraceKernelCall,
global_export_signature_4_,
trace_args, XECOUNT(trace_args),
0);
}
// void shim(ppc_state*, shim_data*)
jit_value_t shim_args[] = {
jit_value_get_param(fn_, 0),
jit_value_create_long_constant(fn_, jit_type_ulong,
(jit_ulong)symbol_->kernel_export->function_data.shim_data),
};
jit_insn_call_native(
fn_,
symbol_->kernel_export->name,
symbol_->kernel_export->function_data.shim,
shim_signature_,
shim_args, XECOUNT(shim_args),
0);
jit_insn_return(fn_, NULL);
return 0;
}
int LibjitEmitter::MakeMissingImportFunction() {
if (FLAGS_trace_kernel_calls) {
jit_value_t trace_args[] = {
jit_value_get_param(fn_, 0),
jit_value_create_long_constant(fn_, jit_type_ulong,
(jit_ulong)symbol_->start_address),
jit_value_get_param(fn_, 1),
jit_value_create_long_constant(fn_, jit_type_ulong,
(jit_ulong)symbol_->kernel_export),
};
jit_insn_call_native(
fn_,
"XeTraceKernelCall",
global_exports_.XeTraceKernelCall,
global_export_signature_4_,
trace_args, XECOUNT(trace_args),
0);
}
jit_insn_return(fn_, NULL);
return 0;
}
FunctionSymbol* LibjitEmitter::symbol() {
return symbol_;
}
jit_function_t LibjitEmitter::fn() {
return fn_;
}
FunctionBlock* LibjitEmitter::fn_block() {
return fn_block_;
}
void LibjitEmitter::GenerateBasicBlocks() {
// If this function is empty, abort!
if (!symbol_->blocks.size()) {
jit_insn_return(fn_, NULL);
return;
}
// Pass 1 creates all of the labels - this way we can branch to them.
// We also track registers used so that when know which ones to fill/spill.
// No actual blocks or instructions are created here.
// TODO(benvanik): move this to SDB? would remove an entire pass over the
// code.
for (std::map<uint32_t, FunctionBlock*>::iterator it =
symbol_->blocks.begin(); it != symbol_->blocks.end(); ++it) {
FunctionBlock* block = it->second;
XEIGNORE(PrepareBasicBlock(block));
}
// Setup all local variables now that we know what we need.
// This happens in the entry block.
SetupLocals();
// Setup initial register fill in the entry block.
// We can only do this once all the locals have been created.
FillRegisters();
// Pass 2 fills in instructions.
for (std::map<uint32_t, FunctionBlock*>::iterator it = symbol_->blocks.begin();
it != symbol_->blocks.end(); ++it) {
FunctionBlock* block = it->second;
GenerateBasicBlock(block);
}
// Setup the shared return/indirection/etc blocks now that we know all the
// blocks we need and all the registers used.
GenerateSharedBlocks();
}
void LibjitEmitter::GenerateSharedBlocks() {
// Create a return block.
// This spills registers and returns. All non-tail returns should branch
// here to do the return and ensure registers are spilled.
// This will be moved to the end after all the other blocks are created.
jit_insn_label(fn_, &return_block_);
SpillRegisters();
jit_insn_return(fn_, NULL);
// jit_value_t indirect_branch = gen_module_->getFunction("XeIndirectBranch");
//
// // Build indirection block on demand.
// // We have already prepped all basic blocks, so we can build these tables now.
// if (external_indirection_block_) {
// // This will spill registers and call the external function.
// // It is only meant for LK=0.
// b.SetInsertPoint(external_indirection_block_);
// SpillRegisters();
// b.CreateCall3(indirect_branch,
// fn_->arg_begin(),
// b.CreateLoad(locals_.indirection_target),
// b.CreateLoad(locals_.indirection_cia));
// b.CreateRetVoid();
// }
//
// if (internal_indirection_block_) {
// // This will not spill registers and instead try to switch on local blocks.
// // If it fails then the external indirection path is taken.
// // NOTE: we only generate this if a likely local branch is taken.
// b.SetInsertPoint(internal_indirection_block_);
// SwitchInst* switch_i = b.CreateSwitch(
// b.CreateLoad(locals_.indirection_target),
// external_indirection_block_,
// static_cast<int>(bbs_.size()));
// for (std::map<uint32_t, BasicBlock*>::iterator it = bbs_.begin();
// it != bbs_.end(); ++it) {
// switch_i->addCase(b.getInt64(it->first), it->second);
// }
// }
}
int LibjitEmitter::PrepareBasicBlock(FunctionBlock* block) {
// Add an undefined entry in the table.
// The label will be created on-demand.
bbs_.insert(std::pair<uint32_t, jit_label_t>(
block->start_address, jit_label_undefined));
// TODO(benvanik): set label name? would help debugging disasm
// char name[32];
// xesnprintfa(name, XECOUNT(name), "loc_%.8X", block->start_address);
// Scan and disassemble each instruction in the block to get accurate
// register access bits. In the future we could do other optimization checks
// in this pass.
// TODO(benvanik): perhaps we want to stash this for each basic block?
// We could use this for faster checking of cr/ca checks/etc.
InstrAccessBits access_bits;
uint8_t* p = xe_memory_addr(memory_, 0);
for (uint32_t ia = block->start_address; ia <= block->end_address; ia += 4) {
InstrData i;
i.address = ia;
i.code = XEGETUINT32BE(p + ia);
i.type = ppc::GetInstrType(i.code);
// Ignore unknown or ones with no disassembler fn.
if (!i.type || !i.type->disassemble) {
continue;
}
// We really need to know the registers modified, so die if we've been lazy
// and haven't implemented the disassemble method yet.
ppc::InstrDisasm d;
XEASSERTNOTNULL(i.type->disassemble);
int result_code = i.type->disassemble(i, d);
XEASSERTZERO(result_code);
if (result_code) {
return result_code;
}
// Accumulate access bits.
access_bits.Extend(d.access_bits);
}
// Add in access bits to function access bits.
access_bits_.Extend(access_bits);
return 0;
}
void LibjitEmitter::GenerateBasicBlock(FunctionBlock* block) {
fn_block_ = block;
// Create new block.
// This will create a label if it hasn't already been done.
std::map<uint32_t, jit_label_t>::iterator label_it =
bbs_.find(block->start_address);
XEASSERT(label_it != bbs_.end());
jit_insn_label(fn_, &label_it->second);
if (FLAGS_log_codegen) {
printf(" bb %.8X-%.8X:\n", block->start_address, block->end_address);
}
// Walk instructions in block.
uint8_t* p = xe_memory_addr(memory_, 0);
for (uint32_t ia = block->start_address; ia <= block->end_address; ia += 4) {
InstrData i;
i.address = ia;
i.code = XEGETUINT32BE(p + ia);
i.type = ppc::GetInstrType(i.code);
jit_value_t trace_args[] = {
jit_value_get_param(fn_, 0),
jit_value_create_long_constant(fn_, jit_type_ulong,
(jit_ulong)i.address),
jit_value_create_long_constant(fn_, jit_type_ulong,
(jit_ulong)i.code),
};
// Add debugging tag.
// TODO(benvanik): mark type.
//jit_insn_mark_breakpoint(fn_, 1, ia);
if (FLAGS_trace_instructions) {
SpillRegisters();
jit_insn_call_native(
fn_,
"XeTraceInstruction",
global_exports_.XeTraceInstruction,
global_export_signature_3_,
trace_args, XECOUNT(trace_args),
0);
}
if (!i.type) {
XELOGCPU("Invalid instruction %.8X %.8X", ia, i.code);
SpillRegisters();
jit_insn_call_native(
fn_,
"XeInvalidInstruction",
global_exports_.XeInvalidInstruction,
global_export_signature_3_,
trace_args, XECOUNT(trace_args),
0);
continue;
}
if (FLAGS_log_codegen) {
if (i.type->disassemble) {
ppc::InstrDisasm d;
i.type->disassemble(i, d);
std::string disasm;
d.Dump(disasm);
printf(" %.8X: %.8X %s\n", ia, i.code, disasm.c_str());
} else {
printf(" %.8X: %.8X %s ???\n", ia, i.code, i.type->name);
}
}
typedef int (*InstrEmitter)(LibjitEmitter& g, jit_function_t f,
InstrData& i);
InstrEmitter emit = (InstrEmitter)i.type->emit;
if (!i.type->emit || emit(*this, fn_, i)) {
// This printf is handy for sort/uniquify to find instructions.
//printf("unimplinstr %s\n", i.type->name);
XELOGCPU("Unimplemented instr %.8X %.8X %s",
ia, i.code, i.type->name);
SpillRegisters();
jit_insn_call_native(
fn_,
"XeInvalidInstruction",
global_exports_.XeInvalidInstruction,
global_export_signature_3_,
trace_args, XECOUNT(trace_args),
0);
}
}
// If we fall through, create the branch.
if (block->outgoing_type == FunctionBlock::kTargetNone) {
// BasicBlock* next_bb = GetNextBasicBlock();
// XEASSERTNOTNULL(next_bb);
// b.CreateBr(next_bb);
} else if (block->outgoing_type == FunctionBlock::kTargetUnknown) {
// Hrm.
// TODO(benvanik): assert this doesn't occur - means a bad sdb run!
XELOGCPU("SDB function scan error in %.8X: bb %.8X has unknown exit",
symbol_->start_address, block->start_address);
jit_insn_return(fn_, NULL);
}
// TODO(benvanik): finish up BB
}
jit_value_t LibjitEmitter::get_int32(int32_t value) {
return jit_value_create_nint_constant(fn_, jit_type_int, value);
}
jit_value_t LibjitEmitter::get_uint32(uint32_t value) {
return jit_value_create_nint_constant(fn_, jit_type_uint, value);
}
jit_value_t LibjitEmitter::get_int64(int64_t value) {
return jit_value_create_nint_constant(fn_, jit_type_nint, value);
}
jit_value_t LibjitEmitter::get_uint64(uint64_t value) {
return jit_value_create_nint_constant(fn_, jit_type_nuint, value);
}
jit_value_t LibjitEmitter::make_signed(jit_value_t value) {
jit_type_t source_type = jit_value_get_type(value);
source_type = jit_type_normalize(source_type);
jit_type_t signed_source_type = source_type;
switch (jit_type_get_kind(source_type)) {
case JIT_TYPE_UBYTE: signed_source_type = jit_type_sbyte; break;
case JIT_TYPE_USHORT: signed_source_type = jit_type_short; break;
case JIT_TYPE_UINT: signed_source_type = jit_type_int; break;
case JIT_TYPE_NUINT: signed_source_type = jit_type_nint; break;
case JIT_TYPE_ULONG: signed_source_type = jit_type_long; break;
}
if (signed_source_type != source_type) {
value = jit_insn_convert(fn_, value, signed_source_type, 0);
}
return value;
}
jit_value_t LibjitEmitter::make_unsigned(jit_value_t value) {
jit_type_t source_type = jit_value_get_type(value);
source_type = jit_type_normalize(source_type);
jit_type_t unsigned_source_type = source_type;
switch (jit_type_get_kind(source_type)) {
case JIT_TYPE_SBYTE: unsigned_source_type = jit_type_ubyte; break;
case JIT_TYPE_SHORT: unsigned_source_type = jit_type_ushort; break;
case JIT_TYPE_INT: unsigned_source_type = jit_type_uint; break;
case JIT_TYPE_NINT: unsigned_source_type = jit_type_nuint; break;
case JIT_TYPE_LONG: unsigned_source_type = jit_type_ulong; break;
}
if (unsigned_source_type != source_type) {
value = jit_insn_convert(fn_, value, unsigned_source_type, 0);
}
return value;
}
jit_value_t LibjitEmitter::sign_extend(jit_value_t value,
jit_type_t target_type) {
// TODO(benvanik): better conversion checking.
// Libjit follows the C rules, which is that the source type indicates whether
// sign extension occurs.
// For example, int -> ulong is sign extended,
// uint -> ulong is zero extended.
// We convert to the same type with the expected sign and then use the built
// in convert, only if needed.
// No-op if the same types.
jit_type_t source_type = jit_value_get_type(value);
source_type = jit_type_normalize(source_type);
target_type = jit_type_normalize(target_type);
if (source_type == target_type) {
return value;
}
// If just a sign change, simple conversion.
if (jit_type_get_size(source_type) == jit_type_get_size(target_type)) {
return jit_insn_convert(fn_, value, target_type, 0);
}
// Otherwise, need to convert to signed of the current type then extend.
value = make_signed(value);
return jit_insn_convert(fn_, value, target_type, 0);
}
jit_value_t LibjitEmitter::zero_extend(jit_value_t value,
jit_type_t target_type) {
// See the comment in ::sign_extend for more information.
// No-op if the same types.
jit_type_t source_type = jit_value_get_type(value);
source_type = jit_type_normalize(source_type);
target_type = jit_type_normalize(target_type);
if (source_type == target_type) {
return value;
}
// If just a sign change, simple conversion.
if (jit_type_get_size(source_type) == jit_type_get_size(target_type)) {
return jit_insn_convert(fn_, value, target_type, 0);
}
// Otherwise, need to convert to signed of the current type then extend.
value = make_unsigned(value);
return jit_insn_convert(fn_, value, target_type, 0);
}
jit_value_t LibjitEmitter::trunc_to_sbyte(jit_value_t value) {
jit_type_t source_type = jit_value_get_type(value);
source_type = jit_type_normalize(source_type);
if (source_type == jit_type_sbyte) {
return value;
}
return jit_insn_convert(fn_, value, jit_type_sbyte, 0);
}
jit_value_t LibjitEmitter::trunc_to_ubyte(jit_value_t value) {
jit_type_t source_type = jit_value_get_type(value);
source_type = jit_type_normalize(source_type);
if (source_type == jit_type_ubyte) {
return value;
}
return jit_insn_convert(fn_, value, jit_type_ubyte, 0);
}
jit_value_t LibjitEmitter::trunc_to_short(jit_value_t value) {
jit_type_t source_type = jit_value_get_type(value);
source_type = jit_type_normalize(source_type);
if (source_type == jit_type_sbyte) {
return value;
}
return jit_insn_convert(fn_, value, jit_type_short, 0);
}
jit_value_t LibjitEmitter::trunc_to_int(jit_value_t value) {
jit_type_t source_type = jit_value_get_type(value);
source_type = jit_type_normalize(source_type);
if (source_type == jit_type_sbyte) {
return value;
}
return jit_insn_convert(fn_, value, jit_type_int, 0);
}
int LibjitEmitter::branch_to_block(uint32_t address) {
std::map<uint32_t, jit_label_t>::iterator it = bbs_.find(address);
return jit_insn_branch(fn_, &it->second);
}
int LibjitEmitter::branch_to_block_if(uint32_t address, jit_value_t value) {
std::map<uint32_t, jit_label_t>::iterator it = bbs_.find(address);
if (value) {
return jit_insn_branch_if(fn_, value, &it->second);
} else {
return jit_insn_branch(fn_, &it->second);
}
}
int LibjitEmitter::branch_to_block_if_not(uint32_t address, jit_value_t value) {
XEASSERTNOTNULL(value);
std::map<uint32_t, jit_label_t>::iterator it = bbs_.find(address);
return jit_insn_branch_if_not(fn_, value, &it->second);
}
int LibjitEmitter::branch_to_return() {
return jit_insn_branch(fn_, &return_block_);
}
int LibjitEmitter::branch_to_return_if(jit_value_t value) {
return jit_insn_branch_if(fn_, value, &return_block_);
}
int LibjitEmitter::branch_to_return_if_not(jit_value_t value) {
return jit_insn_branch_if_not(fn_, value, &return_block_);
}
int LibjitEmitter::call_function(FunctionSymbol* target_symbol,
jit_value_t lr, bool tail) {
PrepareFunction(target_symbol);
jit_function_t target_fn = (jit_function_t)target_symbol->impl_value;
XEASSERTNOTNULL(target_fn);
int flags = 0;
if (tail) {
flags |= JIT_CALL_TAIL;
}
jit_value_t args[] = {jit_value_get_param(fn_, 0), lr};
jit_insn_call(fn_, target_symbol->name(), target_fn, fn_signature_,
args, XECOUNT(args), flags);
return 1;
}
int LibjitEmitter::GenerateIndirectionBranch(uint32_t cia, jit_value_t target,
bool lk, bool likely_local) {
// This function is called by the control emitters when they know that an
// indirect branch is required.
// It first tries to see if the branch is to an address within the function
// and, if so, uses a local switch table. If that fails because we don't know
// the block the function is regenerated (ACK!). If the target is external
// then an external call occurs.
// TODO(benvanik): port indirection.
//XEASSERTALWAYS();
// BasicBlock* next_block = GetNextBasicBlock();
// PushInsertPoint();
// // Request builds of the indirection blocks on demand.
// // We can't build here because we don't know what registers will be needed
// // yet, so we just create the blocks and let GenerateSharedBlocks handle it
// // after we are done with all user instructions.
// if (!external_indirection_block_) {
// // Setup locals in the entry block.
// b.SetInsertPoint(&fn_->getEntryBlock());
// locals_.indirection_target = b.CreateAlloca(
// jit_type_nuint, 0, "indirection_target");
// locals_.indirection_cia = b.CreateAlloca(
// jit_type_nuint, 0, "indirection_cia");
// external_indirection_block_ = BasicBlock::Create(
// *context_, "external_indirection_block", fn_, return_block_);
// }
// if (likely_local && !internal_indirection_block_) {
// internal_indirection_block_ = BasicBlock::Create(
// *context_, "internal_indirection_block", fn_, return_block_);
// }
// PopInsertPoint();
// // Check to see if the target address is within the function.
// // If it is jump to that basic block. If the basic block is not found it means
// // we have a jump inside the function that wasn't identified via static
// // analysis. These are bad as they require function regeneration.
// if (likely_local) {
// // Note that we only support LK=0, as we are using shared tables.
// XEASSERT(!lk);
// b.CreateStore(target, locals_.indirection_target);
// b.CreateStore(b.getInt64(cia), locals_.indirection_cia);
// jit_value_t symbol_ge_cmp = b.CreateICmpUGE(target, b.getInt64(symbol_->start_address));
// jit_value_t symbol_l_cmp = b.CreateICmpULT(target, b.getInt64(symbol_->end_address));
// jit_value_t symbol_target_cmp = jit_insn_and(fn_, symbol_ge_cmp, symbol_l_cmp);
// b.CreateCondBr(symbol_target_cmp,
// internal_indirection_block_, external_indirection_block_);
// return 0;
// }
// // If we are LK=0 jump to the shared indirection block. This prevents us
// // from needing to fill the registers again after the call and shares more
// // code.
// if (!lk) {
// b.CreateStore(target, locals_.indirection_target);
// b.CreateStore(b.getInt64(cia), locals_.indirection_cia);
// b.CreateBr(external_indirection_block_);
// } else {
// // Slowest path - spill, call the external function, and fill.
// // We should avoid this at all costs.
// // Spill registers. We could probably share this.
// SpillRegisters();
// // Issue the full indirection branch.
// jit_value_t branch_args[] = {
// jit_value_get_param(fn_, 0),
// target,
// get_uint64(cia),
// };
// jit_insn_call_native(
// fn_,
// "XeIndirectBranch",
// global_exports_.XeIndirectBranch,
// global_export_signature_3_,
// branch_args, XECOUNT(branch_args),
// 0);
// if (next_block) {
// // Only refill if not a tail call.
// FillRegisters();
// b.CreateBr(next_block);
// } else {
// jit_insn_return(fn_, NULL);
// }
// }
return 0;
}
jit_value_t LibjitEmitter::LoadStateValue(size_t offset, jit_type_t type,
const char* name) {
// Load from ppc_state[offset].
// TODO(benvanik): tag with debug info?
return jit_insn_load_relative(
fn_, jit_value_get_param(fn_, 0), offset, type);
}
void LibjitEmitter::StoreStateValue(size_t offset, jit_type_t type,
jit_value_t value) {
// Store to ppc_state[offset].
jit_insn_store_relative(
fn_, jit_value_get_param(fn_, 0), offset, value);
}
void LibjitEmitter::SetupLocals() {
uint64_t spr_t = access_bits_.spr;
if (spr_t & 0x3) {
locals_.xer = SetupLocal(jit_type_nuint, "xer");
}
spr_t >>= 2;
if (spr_t & 0x3) {
locals_.lr = SetupLocal(jit_type_nuint, "lr");
}
spr_t >>= 2;
if (spr_t & 0x3) {
locals_.ctr = SetupLocal(jit_type_nuint, "ctr");
}
spr_t >>= 2;
// TODO: FPCSR
char name[32];
uint64_t cr_t = access_bits_.cr;
for (int n = 0; n < 8; n++) {
if (cr_t & 3) {
//xesnprintfa(name, XECOUNT(name), "cr%d", n);
locals_.cr[n] = SetupLocal(jit_type_ubyte, name);
}
cr_t >>= 2;
}
uint64_t gpr_t = access_bits_.gpr;
for (int n = 0; n < 32; n++) {
if (gpr_t & 3) {
//xesnprintfa(name, XECOUNT(name), "r%d", n);
locals_.gpr[n] = SetupLocal(jit_type_nuint, name);
}
gpr_t >>= 2;
}
uint64_t fpr_t = access_bits_.fpr;
for (int n = 0; n < 32; n++) {
if (fpr_t & 3) {
//xesnprintfa(name, XECOUNT(name), "f%d", n);
locals_.fpr[n] = SetupLocal(jit_type_float64, name);
}
fpr_t >>= 2;
}
}
jit_value_t LibjitEmitter::SetupLocal(jit_type_t type, const char* name) {
// Note that the value is created in the current block, but will be pushed
// up to function level if used in another block.
jit_value_t value = jit_value_create(fn_, type);
// TODO(benvanik): set a name?
return value;
}
void LibjitEmitter::FillRegisters() {
// This updates all of the local register values from the state memory.
// It should be called on function entry for initial setup and after any
// calls that may modify the registers.
// TODO(benvanik): use access flags to see if we need to do reads/writes.
if (locals_.xer) {
jit_insn_store(fn_,
locals_.xer,
LoadStateValue(offsetof(xe_ppc_state_t, xer), jit_type_nuint));
}
if (locals_.lr) {
jit_insn_store(fn_,
locals_.lr,
LoadStateValue(offsetof(xe_ppc_state_t, lr), jit_type_nuint));
}
if (locals_.ctr) {
jit_insn_store(fn_,
locals_.ctr,
LoadStateValue(offsetof(xe_ppc_state_t, ctr), jit_type_nuint));
}
// Fill the split CR values by extracting each one from the CR.
// This could probably be done faster via an extractvalues or something.
// Perhaps we could also change it to be a vector<8*i8>.
jit_value_t cr = NULL;
for (size_t n = 0; n < XECOUNT(locals_.cr); n++) {
jit_value_t cr_n = locals_.cr[n];
if (!cr_n) {
continue;
}
if (!cr) {
// Only fetch once. Doing this in here prevents us from having to
// always fetch even if unused.
cr = LoadStateValue(offsetof(xe_ppc_state_t, cr), jit_type_nuint);
}
// (cr >> 28 - n * 4) & 0xF
jit_value_t shamt = jit_value_create_nint_constant(
fn_, jit_type_nuint, 28 - n * 4);
jit_insn_store(fn_, cr_n,
jit_insn_and(fn_,
jit_insn_ushr(fn_, cr, shamt),
jit_value_create_nint_constant(fn_, jit_type_ubyte, 0xF)));
}
for (size_t n = 0; n < XECOUNT(locals_.gpr); n++) {
if (locals_.gpr[n]) {
jit_insn_store(fn_,
locals_.gpr[n],
LoadStateValue(offsetof(xe_ppc_state_t, r) + 8 * n, jit_type_nuint));
}
}
for (size_t n = 0; n < XECOUNT(locals_.fpr); n++) {
if (locals_.fpr[n]) {
jit_insn_store(fn_,
locals_.fpr[n],
LoadStateValue(offsetof(xe_ppc_state_t, f) + 8 * n,
jit_type_float64));
}
}
}
void LibjitEmitter::SpillRegisters() {
// This flushes all local registers (if written) to the register bank and
// resets their values.
// TODO(benvanik): only flush if actually required, or selective flushes.
if (locals_.xer) {
StoreStateValue(
offsetof(xe_ppc_state_t, xer),
jit_type_nuint,
jit_insn_load(fn_, locals_.xer));
}
if (locals_.lr) {
StoreStateValue(
offsetof(xe_ppc_state_t, lr),
jit_type_nuint,
jit_insn_load(fn_, locals_.lr));
}
if (locals_.ctr) {
StoreStateValue(
offsetof(xe_ppc_state_t, ctr),
jit_type_nuint,
jit_insn_load(fn_, locals_.ctr));
}
// Stitch together all split CR values.
// TODO(benvanik): don't flush across calls?
jit_value_t cr = NULL;
for (size_t n = 0; n < XECOUNT(locals_.cr); n++) {
jit_value_t cr_n = locals_.cr[n];
if (!cr_n) {
continue;
}
// cr |= (cr_n << n * 4)
jit_value_t shamt = jit_value_create_nint_constant(
fn_, jit_type_nuint, n * 4);
cr_n = jit_insn_convert(fn_, jit_insn_load(fn_, cr_n), jit_type_nuint, 0);
cr_n = jit_insn_shl(fn_, cr_n, shamt);
if (!cr) {
cr = cr_n;
} else {
cr = jit_insn_or(fn_, cr, cr_n);
}
}
if (cr) {
StoreStateValue(
offsetof(xe_ppc_state_t, cr),
jit_type_nuint,
cr);
}
for (uint32_t n = 0; n < XECOUNT(locals_.gpr); n++) {
jit_value_t v = locals_.gpr[n];
if (v) {
StoreStateValue(
offsetof(xe_ppc_state_t, r) + 8 * n,
jit_type_nuint,
jit_insn_load(fn_, v));
}
}
for (uint32_t n = 0; n < XECOUNT(locals_.fpr); n++) {
jit_value_t v = locals_.fpr[n];
if (v) {
StoreStateValue(
offsetof(xe_ppc_state_t, f) + 8 * n,
jit_type_float64,
jit_insn_load(fn_, v));
}
}
}
jit_value_t LibjitEmitter::xer_value() {
XEASSERTNOTNULL(locals_.xer);
return jit_insn_load(fn_, locals_.xer);
}
void LibjitEmitter::update_xer_value(jit_value_t value) {
XEASSERTNOTNULL(locals_.xer);
// Extend to 64bits if needed.
value = zero_extend(value, jit_type_nuint);
jit_insn_store(fn_, locals_.xer, value);
}
void LibjitEmitter::update_xer_with_overflow(jit_value_t value) {
XEASSERTNOTNULL(locals_.xer);
// Expects a i1 indicating overflow.
// Trust the caller that if it's larger than that it's already truncated.
value = zero_extend(value, jit_type_nuint);
jit_value_t xer = xer_value();
xer = jit_insn_and(fn_, xer, get_uint64(0xFFFFFFFFBFFFFFFF)); // clear bit 30
xer = jit_insn_or(fn_, xer, jit_insn_shl(fn_, value, get_uint32(31)));
xer = jit_insn_or(fn_, xer, jit_insn_shl(fn_, value, get_uint32(30)));
jit_insn_store(fn_, locals_.xer, value);
}
void LibjitEmitter::update_xer_with_carry(jit_value_t value) {
XEASSERTNOTNULL(locals_.xer);
// Expects a i1 indicating carry.
// Trust the caller that if it's larger than that it's already truncated.
value = zero_extend(value, jit_type_nuint);
jit_value_t xer = xer_value();
xer = jit_insn_and(fn_, xer, get_uint64(0xFFFFFFFFDFFFFFFF)); // clear bit 29
xer = jit_insn_or(fn_, xer, jit_insn_shl(fn_, value, get_uint32(29)));
jit_insn_store(fn_, locals_.xer, value);
}
void LibjitEmitter::update_xer_with_overflow_and_carry(jit_value_t value) {
XEASSERTNOTNULL(locals_.xer);
// Expects a i1 indicating overflow.
// Trust the caller that if it's larger than that it's already truncated.
value = zero_extend(value, jit_type_nuint);
// This is effectively an update_xer_with_overflow followed by an
// update_xer_with_carry, but since the logic is largely the same share it.
jit_value_t xer = xer_value();
// clear bit 30 & 29
xer = jit_insn_and(fn_, xer, get_uint64(0xFFFFFFFF9FFFFFFF));
xer = jit_insn_or(fn_, xer, jit_insn_shl(fn_, value, get_uint32(31)));
xer = jit_insn_or(fn_, xer, jit_insn_shl(fn_, value, get_uint32(30)));
xer = jit_insn_or(fn_, xer, jit_insn_shl(fn_, value, get_uint32(29)));
jit_insn_store(fn_, locals_.xer, value);
}
jit_value_t LibjitEmitter::lr_value() {
XEASSERTNOTNULL(locals_.lr);
return jit_insn_load(fn_, locals_.lr);
}
void LibjitEmitter::update_lr_value(jit_value_t value) {
XEASSERTNOTNULL(locals_.lr);
// Extend to 64bits if needed.
value = zero_extend(value, jit_type_nuint);
jit_insn_store(fn_, locals_.lr, value);
}
jit_value_t LibjitEmitter::ctr_value() {
XEASSERTNOTNULL(locals_.ctr);
return jit_insn_load(fn_, locals_.ctr);
}
void LibjitEmitter::update_ctr_value(jit_value_t value) {
XEASSERTNOTNULL(locals_.ctr);
// Extend to 64bits if needed.
value = zero_extend(value, jit_type_nuint);
jit_insn_store(fn_, locals_.ctr, value);
}
jit_value_t LibjitEmitter::cr_value(uint32_t n) {
XEASSERT(n >= 0 && n < 8);
XEASSERTNOTNULL(locals_.cr[n]);
jit_value_t value = jit_insn_load(fn_, locals_.cr[n]);
value = zero_extend(value, jit_type_nuint);
return value;
}
void LibjitEmitter::update_cr_value(uint32_t n, jit_value_t value) {
XEASSERT(n >= 0 && n < 8);
XEASSERTNOTNULL(locals_.cr[n]);
// Truncate to 8 bits if needed.
// TODO(benvanik): also widen?
value = trunc_to_ubyte(value);
jit_insn_store(fn_, locals_.cr[n], value);
}
void LibjitEmitter::update_cr_with_cond(
uint32_t n, jit_value_t lhs, jit_value_t rhs, bool is_signed) {
// bit0 = RA < RB
// bit1 = RA > RB
// bit2 = RA = RB
// bit3 = XER[SO]
// TODO(benvanik): inline this using the x86 cmp instruction - this prevents
// the need for a lot of the compares and ensures we lower to the best
// possible x86.
// jit_value_t cmp = InlineAsm::get(
// FunctionType::get(),
// "cmp $0, $1 \n"
// "mov from compare registers \n",
// "r,r", ??
// true);
// Convert input signs, if needed.
if (is_signed) {
lhs = make_signed(lhs);
rhs = make_signed(rhs);
} else {
lhs = make_unsigned(lhs);
rhs = make_unsigned(rhs);
}
jit_value_t c = jit_insn_lt(fn_, lhs, rhs);
c = jit_insn_or(fn_, c,
jit_insn_shl(fn_, jit_insn_gt(fn_, lhs, rhs), get_uint32(1)));
c = jit_insn_or(fn_, c,
jit_insn_shl(fn_, jit_insn_eq(fn_, lhs, rhs), get_uint32(2)));
// TODO(benvanik): set bit 4 to XER[SO]
// Insert the 4 bits into their location in the CR.
update_cr_value(n, c);
}
jit_value_t LibjitEmitter::gpr_value(uint32_t n) {
XEASSERT(n >= 0 && n < 32);
XEASSERTNOTNULL(locals_.gpr[n]);
// Actually r0 is writable, even though nobody should ever do that.
// Perhaps we can check usage and enable this if safe?
// if (n == 0) {
// return get_uint64(0);
// }
return jit_insn_load(fn_, locals_.gpr[n]);
}
void LibjitEmitter::update_gpr_value(uint32_t n, jit_value_t value) {
XEASSERT(n >= 0 && n < 32);
XEASSERTNOTNULL(locals_.gpr[n]);
// See above - r0 can be written.
// if (n == 0) {
// // Ignore writes to zero.
// return;
// }
// Extend to 64bits if needed.
value = zero_extend(value, jit_type_nuint);
jit_insn_store(fn_, locals_.gpr[n], value);
}
jit_value_t LibjitEmitter::fpr_value(uint32_t n) {
XEASSERT(n >= 0 && n < 32);
XEASSERTNOTNULL(locals_.fpr[n]);
return jit_insn_load(fn_, locals_.fpr[n]);
}
void LibjitEmitter::update_fpr_value(uint32_t n, jit_value_t value) {
XEASSERT(n >= 0 && n < 32);
XEASSERTNOTNULL(locals_.fpr[n]);
jit_insn_store(fn_, locals_.fpr[n], value);
}
jit_value_t LibjitEmitter::GetMemoryAddress(uint32_t cia, jit_value_t addr) {
// Input address is always in 32-bit space.
// TODO(benvanik): is this required? It's one extra instruction on every
// access...
addr = jit_insn_and(fn_, addr,
jit_value_create_nint_constant(fn_, jit_type_nuint, UINT_MAX));
// Add runtime memory address checks, if needed.
// if (FLAGS_memory_address_verification) {
// BasicBlock* invalid_bb = BasicBlock::Create(*context_, "", fn_);
// BasicBlock* valid_bb = BasicBlock::Create(*context_, "", fn_);
// // The heap starts at 0x1000 - if we write below that we're boned.
// jit_value_t gt = b.CreateICmpUGE(addr, b.getInt64(0x00001000));
// b.CreateCondBr(gt, valid_bb, invalid_bb);
// b.SetInsertPoint(invalid_bb);
// jit_value_t access_violation = gen_module_->getFunction("XeAccessViolation");
// SpillRegisters();
// b.CreateCall3(access_violation,
// fn_->arg_begin(),
// b.getInt32(cia),
// addr);
// b.CreateBr(valid_bb);
// b.SetInsertPoint(valid_bb);
// }
// Rebase off of memory base pointer.
// We could store the memory base as a global value (or indirection off of
// state) if we wanted to avoid embedding runtime values into the code.
jit_value_t membase = get_uint64((uint64_t)xe_memory_addr(memory_, 0));
return jit_insn_add(fn_, addr, membase);
}
jit_value_t LibjitEmitter::ReadMemory(
uint32_t cia, jit_value_t addr, uint32_t size, bool acquire) {
jit_type_t data_type = NULL;
bool needs_swap = false;
switch (size) {
case 1:
data_type = jit_type_ubyte;
break;
case 2:
data_type = jit_type_ushort;
needs_swap = true;
break;
case 4:
data_type = jit_type_uint;
needs_swap = true;
break;
case 8:
data_type = jit_type_ulong;
needs_swap = true;
break;
default:
XEASSERTALWAYS();
return NULL;
}
jit_value_t address = GetMemoryAddress(cia, addr);
jit_value_t value = jit_insn_load_relative(fn_, address, 0, data_type);
if (acquire) {
// TODO(benvanik): acquire semantics.
// load_value->setAlignment(size);
// load_value->setVolatile(true);
// load_value->setAtomic(Acquire);
jit_value_set_volatile(value);
}
// Swap after loading.
// TODO(benvanik): find a way to avoid this!
if (needs_swap) {
value = jit_insn_bswap(fn_, value);
}
return value;
}
void LibjitEmitter::WriteMemory(
uint32_t cia, jit_value_t addr, uint32_t size, jit_value_t value,
bool release) {
jit_type_t data_type = NULL;
bool needs_swap = false;
switch (size) {
case 1:
data_type = jit_type_ubyte;
break;
case 2:
data_type = jit_type_ushort;
needs_swap = true;
break;
case 4:
data_type = jit_type_uint;
needs_swap = true;
break;
case 8:
data_type = jit_type_ulong;
needs_swap = true;
break;
default:
XEASSERTALWAYS();
return;
}
jit_value_t address = GetMemoryAddress(cia, addr);
// Truncate, if required.
if (jit_value_get_type(value) != data_type) {
value = jit_insn_convert(fn_, value, data_type, 0);
}
// Swap before storing.
// TODO(benvanik): find a way to avoid this!
if (needs_swap) {
value = jit_insn_bswap(fn_, value);
}
// TODO(benvanik): release semantics
// if (release) {
// store_value->setAlignment(size);
// store_value->setVolatile(true);
// store_value->setAtomic(Release);
// }
jit_insn_store_relative(fn_, address, 0, value);
}