Files
archived-ballistic/include/bal_decoder.h
Ronald Caesar f72da3e121 decoder: add ir opcode to metadata struct
Instead of using strcmp() on each decoded intruction's mnemonic to
translate it, we embedd an IR opcode into the struct. This is a very
barebones implementation and does not cover the entire ARM instruction
set. ARM instructions that does not have an IR opcode equivalent will be
marked with `OPCODE_TRAP` and should be implemented in the future.

Signed-off-by: Ronald Caesar <github43132@proton.me>
2026-01-13 23:31:06 -04:00

77 lines
1.9 KiB
C

/**
* @file bal_decoder.h
* @brief ARM Instruction Decoder Interface.
*
* @details
* This module provides the interface for decoding ARM instructions.
*/
#ifndef BAL_DECODER_H
#define BAL_DECODER_H
#include "bal_attributes.h"
#include "bal_types.h"
#include <stdint.h>
#ifdef __cplusplus
extern "C"
{
#endif
/*!
* @brief Represents static metadata associated with a specific ARM32
* instruction.
*/
BAL_ALIGNED(32) typedef struct
{
/*!
* @brief The instruction mnemonic (e.g., "ADD", "LDR").
*/
const char *name;
/*!
* @brief The bitmask indicating which bits in the instruction word are
* significant.
*
* @details 1 = significant bit, 0 = variable field (register,
* immediate, etc.).
*/
uint32_t mask;
/*!
* @brief The expected value of the instruction after applying the mask.
* @details (instruction & mask) == expected.
*/
uint32_t expected;
/*!
* @brief The IR opcode equivalent to this instruction's mnemonic.
*/
bal_opcode_t ir_opcode;
char _pad[8];
} bal_decoder_instruction_metadata_t;
/*!
* @brief Decodes a raw ARM64 instruction.
*
* @details
* Performs a hash lookup on the provided instruction word to find a
* matching definition.
*
* @param[in] instruction The raw ARM64 machine code to decode.
*
* @return A pointer to the instruction metadata if a match is found.
* @return `NULL` if the instruction is undefined or invalid.
*
* @post The returned pointer (if not null) points to static read-only
* memory.
*/
BAL_HOT const bal_decoder_instruction_metadata_t *bal_decoder_arm64_decode(
const uint32_t instruction);
#ifdef __cplusplus
}
#endif
#endif // POUND_JIT_DECODER_ARM32_H