kvisc/karch/arch.h

// The OS/K Team licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <assert.h>
#include <stdarg.h>

#define log printf
#define vlog vprintf

#define packed __attribute__ ((__packed__))
#define static_assert _Static_assert
#define alignof _Alignof

typedef unsigned int        bool;
typedef unsigned char       uchar;
typedef unsigned short      ushort;
typedef unsigned int        uint;
typedef unsigned long       ulong;

typedef struct reg_t        reg_t;
typedef struct ctx_t        ctx_t;
typedef struct instr_t      instr_t;
typedef struct acc_t        acc_t;
typedef struct arch_t       arch_t;

enum
{
    RAX, RBX, RCX, RDX, RDI, RSI, RBP, RSP,
    R08, R09, R10, R11, R12, R13, R14, R15,
    K00, K01, K02, K03, K04, K05, K06, K07,
    CR0, CR1, CR2, CR3, CR4, CR5, CR6, CR7,
    RIP, FLG,

    NREGS
};

enum 
{
    GPR = 1 << 0,   // General
    CTL = 1 << 1,   // Control
    SEG = 1 << 2,   // Segment
    RES = 1 << 8,   // Reserved for insternal use
    SYS = 1 << 9,   // Reserved for supervisor mode
};

struct reg_t
{
    char   *name;
    char   *desc;
    ulong   val;
    ulong   flags;
};

// A_REG is implicit
// A_MEM denotes a memory access
// A_OFF is A_MEM but a 16-bit offset is expected immediatly next
enum { A_REG=0, A_MEM=0x7000, A_OFF, A_IMM16, A_IMM32, A_IMM64 };
struct acc_t
{
    bool mem; // A_MEM?
    uint type;
    
    ulong val;
    short off;
};

enum { NOPREF, PREF_REP=0x8000, PREF_LOCK, NPREFS };

#define ISPREF(x) ((x) & 0x8000 && (x)<NPREFS)
#define ISINSTR(x)  ((x) < NINSTRS)

enum { NOPRM, P_REG, P_IMM, P_MEM=4 };

struct instr_t
{
    char   *name;
    char   *full;

    uint    prm1;
    uint    prm2;

    void  (*func)(ctx_t *, acc_t *, acc_t *);
};

struct ctx_t
{
    reg_t   *r;
    instr_t *i;

    // Memory and memory size
    ushort *mp;
    ulong   mz;

    // Read next instruction
    ushort (*get)(ctx_t *ctx);
};

enum
{
    E_SHT,          // Shutdown instruction
    E_IMP,          // Not implemented
    E_ILL,          // Ill-formed
    E_ACC,          // Invalid access
    E_SYS,          // Supervisor only
    E_ALI,          // Alignment error
    E_STK,          // Stack error
    NEXCPTS
};

void dumpregs(ctx_t *);
void dumpinstr(ctx_t *, ulong, ushort, acc_t *, acc_t *);
void dumpmem(ctx_t *, ulong, ulong);
void dumpfwstack(ctx_t *);

static inline void _except(ctx_t *ctx, int code, char *fmt, ...)
{
    va_list ap;

    log("\nException %d - ", code);
    
    va_start(ap, fmt);
    vlog(fmt, ap);
    va_end(ap);
    
    log("\n");

    dumpregs(ctx);
    dumpfwstack(ctx);

    free(ctx->mp);
    exit(code+1);
}

void decode(ctx_t *ctx);

#define MEMOFF (1 * 1024 * 1024)
#define MEMSIZE (16 * 1024 * 1024)  // 16MB

#define addr2real(p) ((p) - MEMOFF)
#define real2addr(p) ((p) + MEMOFF)

// Address of boot firmware stack
#define FWSTACK (MEMOFF * 2)        // 2MB

static inline ulong readmem64(ctx_t *ctx, ulong addr)
{
    ulong real = addr2real(addr);

    if (addr % alignof(ulong) > 0) {
        _except(ctx, E_ALI, "Non-aligned memory access: 0x%012lX(0x%012lX)", addr, real);
    }

    if (addr < MEMOFF || real >= MEMSIZE) {
        _except(ctx, E_ACC, "Invalid MEM access: 0x%012lX(0x%012lX)", addr, real);
    }

    ulong val = (ulong)ctx->mp[real++];
    val = (val << 16) | (ulong)ctx->mp[real++];
    val = (val << 16) | (ulong)ctx->mp[real++];
    val = (val << 16) | (ulong)ctx->mp[real++];
    
    return val;
}

static inline void writemem64(ctx_t *ctx, ulong val, ulong addr)
{
    ulong real = addr2real(addr);

    if (addr % alignof(ulong) > 0) {
        _except(ctx, E_ALI, "Non-aligned memory access: 0x%012lX(0x%012lX)", addr, real);
    }

    if (addr < MEMOFF || real >= MEMSIZE) {
        _except(ctx, E_ACC, "Invalid MEM access: 0x%012lX(0x%012lX)", addr, real);
    }

    ctx->mp[real++] = val >> 48;
    ctx->mp[real++] = (val >> 32) & 0xFFFF;
    ctx->mp[real++] = (val >> 16) & 0xFFFF;
    ctx->mp[real++] = val & 0xFFFF;
}

#include "../instr/arch_i.h"