all repos — xyw @ 4e816282d361f040ba2e89d9d9afe8875d126e51

A minimal virtual machine and assembler for terminals.

xywrun.c

 1
 2
 3
 4
 5
 6
 7
 8
 9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
#include <stdio.h>
#include "xyw.h"

#include "devices/system.c"

#define MEMORY_SIZE 0xffff
#define STACK_SIZE 0xff

#define USER_MEMORY_START 0x000
#define SYSTEM_MEMORY_START 0xfd00
#define USER_STACK_START 0xfd00
#define SYSTEM_STACK_START 0xfe00
#define DEVICE_AREA_START 0xff00

typedef enum
{
    XYW_ERROR_NONE = 0,
    XYW_ERROR_INVALID_INSTRUCTION,
    XYW_ERROR_STACK_UNDERFLOW,
    XYW_ERROR_STACK_OVERFLOW,
    XYW_ERROR_DEVICE_UNAVAILABLE,
    XYW_ERROR_INVALID_DEVICE_PORT
} xyw_error;

/// Main memory and stacks
xyw_byte xyw_memory[MEMORY_SIZE];
xyw_byte system_stack[STACK_SIZE];
xyw_byte user_stack[STACK_SIZE];

#define DIRECT_PAGE (xyw_memory[XYW_SYSTEM_PAGE] << 8)

//// 1-byte pointers and registers
xyw_byte *s = &xyw_memory[XYW_SYSTEM_S];
xyw_byte *u = &xyw_memory[XYW_SYSTEM_U];
static xyw_byte x_val = 0; // X register storage
static xyw_byte y_val = 0; // Y register storage
xyw_byte *x = &x_val;
xyw_byte *y = &y_val;
xyw_byte *error = &xyw_memory[XYW_SYSTEM_ERROR];

//// 2-byte registers
static xyw_word pc_storage = 0; // Program counter storage
static xyw_word xw_storage = 0; // 16-bit X register storage
static xyw_word yw_storage = 0; // 16-bit Y register storage
xyw_word *pc = &pc_storage;
xyw_word *xw = &xw_storage;
xyw_word *yw = &yw_storage;

//// Helpers to retrieve device number and address within the device
static inline xyw_byte get_device(xyw_word addr)
{
    return (addr - DEVICE_AREA_START) / 16;
}

static inline xyw_byte get_device_port(xyw_word addr)
{
    // Should return a number between 0 and 15, add validation
    xyw_byte port = (addr - DEVICE_AREA_START) % 16;
    if (port >= 16)
    {
        *error = XYW_ERROR_DEVICE_UNAVAILABLE;
        return -1;
    }
    return port;
}

//// Read/write memory helpers

static inline xyw_word readw(xyw_word addr)
{
    if (addr >= DEVICE_AREA_START)
    {
        xyw_byte dev_num = get_device(addr);
        if (dev_num >= XYW_TOTAL_DEVICES || !xyw_devices[dev_num].readw)
        {
            *error = XYW_ERROR_DEVICE_UNAVAILABLE;
            return (xyw_word)-1;
        }
        xyw_byte dev_addr = get_device_port(addr);
        return xyw_devices[dev_num].readw(dev_addr, error);
    }
    return XYW_PEEKW(&xyw_memory[addr]);
}

static inline void writew(xyw_word addr, xyw_word val)
{
    if (addr >= DEVICE_AREA_START)
    {
        xyw_byte dev_num = get_device(addr);
        if (dev_num >= XYW_TOTAL_DEVICES || !xyw_devices[dev_num].writew)
        {
            *error = XYW_ERROR_DEVICE_UNAVAILABLE;
            return;
        }
        xyw_byte dev_addr = get_device_port(addr);
        xyw_devices[dev_num].writew(dev_addr, val, error);
        return;
    }
    XYW_POKEW(&xyw_memory[addr], val);
}

static inline xyw_byte read(xyw_word addr)
{
    if (addr >= DEVICE_AREA_START)
    {
        xyw_byte dev_num = get_device(addr);
        if (dev_num >= XYW_TOTAL_DEVICES || !xyw_devices[dev_num].read)
        {
            *error = XYW_ERROR_DEVICE_UNAVAILABLE;
            return (xyw_byte)-1;
        }
        xyw_byte dev_addr = get_device_port(addr);
        return xyw_devices[dev_num].read(dev_addr, error);
    }
    return xyw_memory[addr];
}

static inline void write(xyw_word addr, xyw_byte val)
{
    if (addr >= DEVICE_AREA_START)
    {
        xyw_byte dev_num = get_device(addr);
        if (dev_num >= XYW_TOTAL_DEVICES || !xyw_devices[dev_num].write)
        {
            *error = XYW_ERROR_DEVICE_UNAVAILABLE;
            return;
        }
        xyw_byte dev_addr = get_device_port(addr);
        xyw_devices[dev_num].write(dev_addr, val, error);
        return;
    }
    xyw_memory[addr] = val;
}

//// Device dispatchers

//// System stack management

static xyw_word ss_popw()
{
    if (*s < 2)
    {
        xyw_memory[XYW_SYSTEM_ERROR] = XYW_ERROR_STACK_UNDERFLOW;
        return -1;
    }
    xyw_word val = readw(SYSTEM_STACK_START + (*s) - 2);
    writew(SYSTEM_STACK_START + (*s) - 2, 0);
    (*s) -= 2;
    return val;
}

static void ss_pushw(xyw_word val)
{
    if (*s > STACK_SIZE - 2)
    {
        xyw_memory[XYW_SYSTEM_ERROR] = XYW_ERROR_STACK_OVERFLOW;
        return;
    }
    writew(SYSTEM_STACK_START + *s, val);
    (*s) += 2;
}

//// User stack management

static void us_push(xyw_byte val)
{
    if (*u > STACK_SIZE - 1)
    {
        xyw_memory[XYW_SYSTEM_ERROR] = XYW_ERROR_STACK_OVERFLOW;
        return;
    }
    xyw_dbg(" => %02X\n", val);
    xyw_memory[USER_STACK_START + (*u)++] = val;
}

static void us_pushw(xyw_word val)
{
    if (*u > STACK_SIZE - 2)
    {
        xyw_memory[XYW_SYSTEM_ERROR] = XYW_ERROR_STACK_OVERFLOW;
        return;
    }
    writew(USER_STACK_START + *u, val);
    xyw_dbg(" => %04X\n", val);
    (*u) += 2;
}

static xyw_byte us_pop()
{
    if (*u < 1)
    {
        xyw_memory[XYW_SYSTEM_ERROR] = XYW_ERROR_STACK_UNDERFLOW;
        return -1;
    }
    (*u) -= 1;
    xyw_byte val = xyw_memory[USER_STACK_START + (*u)];
    xyw_memory[USER_STACK_START + (*u)] = 0;
    return val;
}

static xyw_word us_popw()
{
    if (*u < 2)
    {
        xyw_memory[XYW_SYSTEM_ERROR] = XYW_ERROR_STACK_UNDERFLOW;
        return -1;
    }
    xyw_word val = readw(USER_STACK_START + (*u) - 2);
    writew(USER_STACK_START + (*u) - 2, 0);
    (*u) -= 2;
    return val;
}

// clang-format off

//// Operations that support stack and all registers
#define OPC_SR2(opc, body) { \
    case opc: { const xyw_byte w = 0, a = us_pop(), b = us_pop(); body; } break; \
    case XYW_MODE_X|opc: { const xyw_byte w = 0, a = *x, b = us_pop(); body; } break; \
    case XYW_MODE_Y|opc: { const xyw_byte w = 0, a = *y, b = us_pop(); body; } break; \
    case XYW_MODE_X|XYW_MODE_Y|opc: { const xyw_byte w = 0, a = *x, b = *y; body; } break; \
    case XYW_MODE_W|opc: { const xyw_byte w = 1; xyw_word a = us_popw(); xyw_word b = us_popw(); body; } break; \
    case XYW_MODE_X|XYW_MODE_W|opc: { const xyw_byte w = 1; xyw_word a = *xw; xyw_word b = us_popw(); body; } break; \
    case XYW_MODE_Y|XYW_MODE_W|opc: { const xyw_byte w = 1; xyw_word a = *yw; xyw_word b = us_popw(); body; } break; \
    case XYW_MODE_X|XYW_MODE_Y|XYW_MODE_W|opc: { const xyw_byte w = 1; xyw_word a = *xw; xyw_word b = *yw; body; } break; \
}

//// Operations that support stack and one register
#define OPC_SR1(opc, init, body) { \
    case opc: { const int w=0, rx=0, ry=0; init; body; } break; \
    case XYW_MODE_X|opc: { const int w=0, rx=1, ry=0; init; body; } break; \
    case XYW_MODE_Y|opc: { const int w=0, rx=0, ry=1; init; body; } break; \
    case XYW_MODE_W|opc: { const int w=1, rx=0, ry=0; init; body; } break; \
    case XYW_MODE_X|XYW_MODE_W|opc: { const int w=1, rx=1, ry=0; init; body; } break; \
    case XYW_MODE_Y|XYW_MODE_W|opc: { const int w=1, rx=0, ry=1; init; body; } break; \
}

//// Operations that support one register only and no stack
#define OPC_R1(opc, body) { \
    case XYW_MODE_X|opc: { const xyw_byte w = 0, a = *x; body; } break; \
    case XYW_MODE_Y|opc: { const xyw_byte w = 0, a = *y; body; } break; \
    case XYW_MODE_X|XYW_MODE_W|opc: { const xyw_byte w = 1; xyw_word a = *xw; body; } break; \
    case XYW_MODE_Y|XYW_MODE_W|opc: { const xyw_byte w = 1; xyw_word a = *yw; body; } break; \
}

//// Operations that support stack only
#define OPC_S(opc, body) { \
    case opc: { const xyw_byte w = 0; body; } break; \
    case XYW_MODE_W|opc: { const xyw_byte w = 1; body; } break; \
}

//// POP operations 
#define OPC_POP(opc) { \
    case opc: { us_pop(); } break; \
    case XYW_MODE_X|opc: { *x = us_pop(); } break; \
    case XYW_MODE_Y|opc: { *y = us_pop(); } break; \
    case XYW_MODE_W|opc: { us_pop(); } break; \
    case XYW_MODE_X|XYW_MODE_W|opc: { *xw = us_popw(); } break; \
    case XYW_MODE_Y|XYW_MODE_W|opc: { *yw = us_popw(); } break; \
}

//// PSH operations
#define OPC_PSH(opc) { \
    case opc: { (*pc)++; us_push(xyw_memory[*pc]); } break; \
    case XYW_MODE_X|opc: { us_push(*x); } break; \
    case XYW_MODE_Y|opc: { us_push(*y); } break; \
    case XYW_MODE_W|opc: { (*pc)++; us_pushw(readw(*pc)); (*pc)++; } break; \
    case XYW_MODE_X|XYW_MODE_W|opc: { us_pushw(*xw); } break; \
    case XYW_MODE_Y|XYW_MODE_W|opc: { us_pushw(*yw); } break; \
}
//// Increment/decrement operations
#define OPC_IDC(opc, delta) { \
    case opc: { us_push(us_pop() + delta);} break; \
    case XYW_MODE_X|opc: { *x = *x + delta; } break; \
    case XYW_MODE_Y|opc: { *y = *y + delta; } break; \
    case XYW_MODE_W|opc: { us_pushw(us_popw() + delta); } break; \
    case XYW_MODE_X|XYW_MODE_W|opc: { *xw = *xw + delta; } break; \
    case XYW_MODE_Y|XYW_MODE_W|opc: { *yw = *yw + delta; } break; \
}

//// SWP operations
#define OPC_SWP(opc) { \
    case opc: { xyw_byte a = us_pop(); xyw_byte b = us_pop(); us_push(a); us_push(b); } break; \
    case XYW_MODE_W|opc: { xyw_word a = us_popw(); xyw_word b = us_popw(); us_pushw(a); us_pushw(b); } break; \
    case XYW_MODE_X|opc: { xyw_byte a = us_pop(); xyw_byte b = *x; *x = a; us_push(b); } break; \
    case XYW_MODE_Y|opc: { xyw_byte a = us_pop(); xyw_byte b = *y; *y = a; us_push(b); } break; \
    case XYW_MODE_X|XYW_MODE_W|opc: { xyw_word a = us_popw(); xyw_word b = *xw; *xw = a; us_pushw(b); } break; \
    case XYW_MODE_Y|XYW_MODE_W|opc: { xyw_word a = us_popw(); xyw_word b = *yw; *yw = a; us_pushw(b); } break; \
    case XYW_MODE_X|XYW_MODE_Y|opc: { xyw_byte a = *x; xyw_byte b = *y; *x = b; *y = a; } break; \
    case XYW_MODE_X|XYW_MODE_Y|XYW_MODE_W|opc: { xyw_word a = *xw; xyw_word b = *yw; *xw = b; *yw = a; } break; \
}

//// "Microcode" similar to Uxn's, to be used with above macros
// Get argument from x or stack
#define ARGX rx ? (w ? *xw : *x) : (w ? us_popw() : us_pop())
// Get argument from y or stack
#define ARGY ry ? (w ? *yw : *y) : (w ? us_popw() : us_pop())
// Get arguments from x/y or stack
#define ARGXY rx ? (rx ? (w ? *xw : *x) : (w ? us_popw() : us_pop())) : (ry ? (w ? *yw : *y) : (w ? us_popw() : us_pop()))
// Push a value to stack
#define PUSH(n) do { if (w) { us_pushw(n); } else { us_push(n); } } while(0)
// Pop value from stack
#define POP() (w ? us_popw() : (xyw_word)us_pop())
// Read value from address
#define READ(addr) (w ? readw(addr) : (xyw_byte)xyw_memory[addr])
// Write value as word or byte depending on width flag 'w'
#define WRITE(addr, val) w ? writew(addr, val) : write(addr, (xyw_byte)(val))

// clang-format on
int xyw_run(const char *input)
{

    // Load bytecode into memory
    FILE *fp = fopen(input, "rb");
    if (!fp)
    {
        fprintf(stderr, "Error - Could not open file [%s]\n", input);
        return -1;
    }
    // Check header
    xyw_byte header[6];
    xyw_dbg("Reading header from file [%s]\n", input);
    fread(header, 1, 6, fp);
    if (header[0] != 0x0F || header[1] != 'x' || header[2] != 'y' || header[3] != 'w' || header[4] != 0x00 || header[5] != 0xF0)
    {
        fprintf(stderr, "Error - Invalid file header [%s]\n", input);
        fclose(fp);
        return -1;
    }
    xyw_dbg("File header OK\n");
    // Load the rest of the file into memory
    size_t bytes_read = fread(&xyw_memory[USER_MEMORY_START], 1, MEMORY_SIZE - USER_MEMORY_START, fp);
    if (bytes_read == 0)
    {
        fprintf(stderr, "Error - Could not read file contents [%s]\n", input);
        fclose(fp);
        return -1;
    }
    xyw_dbg("Loaded %zu bytes into memory\n", bytes_read);
    fclose(fp);
    xyw_memory[XYW_SYSTEM_STATE] = 1;
    while (xyw_memory[XYW_SYSTEM_STATE] && *pc < SYSTEM_MEMORY_START)
    {
        xyw_dbg("PC: %04X -> %02X (%s)\n", *pc, xyw_memory[*pc], xyw_instructions[xyw_memory[*pc] & 0x1F]);
        switch (xyw_memory[*pc])
        {
            // clang-format off
            /* BRK */ case 0x00: break;
            /* PSH */ OPC_PSH(0x01);
            /* POP */ OPC_POP(0x02);
            /* LDR */ OPC_R1(0x03, PUSH(READ(a)));
            /* LDA */ OPC_S(0x04, READ(us_popw()));
            /* STA */ OPC_SR1(0x05, xyw_word a = us_popw(), WRITE(a, ARGXY));
            /* LDP */ OPC_S(0x06, READ(DIRECT_PAGE | us_pop()));
            /* STP */ OPC_SR1(0x07, xyw_word a = DIRECT_PAGE | us_pop(), WRITE(a, ARGXY));
            /* INC */ OPC_IDC(0x08, +1);
            /* DEC */ OPC_IDC(0x09, -1);
            /* SHL */ OPC_SR2(0x0A, PUSH(b << a));
            /* SHR */ OPC_SR2(0x0B, PUSH(b >> a));
            /* ADD */ OPC_SR2(0x0C, PUSH(a + b));
            /* SUB */ OPC_SR2(0x0D, PUSH(b - a));
            /* MUL */ OPC_SR2(0x0E, PUSH(a * b));
            /* DIV */ OPC_SR2(0x0F, PUSH(b / a));
            /* EQU */ OPC_SR2(0x10, PUSH(b == a));
            /* NEQ */ OPC_SR2(0x11, PUSH(b != a));
            /* GTH */ OPC_SR2(0x12, PUSH(b > a));
            /* LTH */ OPC_SR2(0x13, PUSH(b < a));
            /* AND */ OPC_SR2(0x14, PUSH(b & a));
            /* IOR */ OPC_SR2(0x15, PUSH(b | a));
            /* XOR */ OPC_SR2(0x16, PUSH(b ^ a));
            /* NOT */ OPC_SR1(0x17, , PUSH(~ARGXY));
            /* SWP */ OPC_SWP(0x18);
            /* DUP */ OPC_SR1(0x19, , PUSH(ARGXY));
            /* OVR */ OPC_SR2(0x1A, PUSH(b); PUSH(a); PUSH(b));
            /* ROT */ OPC_SR2(0x1B, PUSH(b); PUSH(POP()); PUSH(a));
            /* JMP */ case 0x1C: *pc = us_popw(); break;
            /* JCN */ OPC_SR1(0x1D, , if (ARGXY) { *pc = POP(); } );
            /* JSR */ case 0x1E: xyw_word addr = us_popw(); ss_pushw(*pc); *pc = addr; break;
            /* RTS */ case 0x1F: *pc = ss_popw(); break;
            // clang-format on
        }
        // TODO: error handling etc.
        (*pc)++;
    }

    return 0;
}