chore: update zba-gdbstub to zig master

.github/workflows/main.yml

@@ -14,8 +14,7 @@ jobs:
   build:
     strategy:
       matrix:
-        # os: [ubuntu-latest, windows-latest, macos-latest]
-        os: [ubuntu-latest, windows-latest]
+        os: [ubuntu-latest, windows-latest, macos-latest]
     runs-on: ${{matrix.os}}
     steps:
       - uses: goto-bus-stop/setup-zig@v2
@@ -38,9 +37,9 @@ jobs:
             brew install sdl2
       - uses: actions/checkout@v3
         with:
-          submodules: recursive
+          submodules: true
       - name: build 
-        run: zig build -Doptimize=ReleaseSafe -Dcpu=baseline
+        run: zig build -Doptimize=ReleaseSafe
       - name: upload
         uses: actions/upload-artifact@v3
         with:
@@ -51,7 +50,7 @@ jobs:
     steps: 
       - uses: actions/checkout@v3
         with:
-          submodules: recursive
+          submodules: true
       - uses: goto-bus-stop/setup-zig@v2
         with:
           version: master

README.md

@@ -77,7 +77,7 @@ arm7wrestler GBA Fixed | [destoer](https://github.com/destoer)
 
 ## Compiling
 
-Most recently built on Zig [v0.11.0-dev.1580+a5b34a61a](https://github.com/ziglang/zig/tree/a5b34a61a)
+Most recently built on Zig [v0.11.0-dev.1557+03cdb4fb5](https://github.com/ziglang/zig/tree/03cdb4fb5)
 
 ### Dependencies
 
@@ -96,7 +96,7 @@ Use `git submodule update --init` from the project root to pull the git relevant
 Be sure to provide SDL2 using:
 
 - Linux: Your distro's package manager
-- macOS: ¯\\\_(ツ)_/¯ (try [this formula](https://formulae.brew.sh/formula/sdl2)?)
+- MacOS: `brew` (install [this formula](https://formulae.brew.sh/formula/sdl2))
 - Windows: [`vcpkg`](https://github.com/Microsoft/vcpkg) (install `sdl2:x64-windows`)
 
 `SDL.zig` will provide a helpful compile error if the zig compiler is unable to find SDL2.

build.zig

@@ -6,7 +6,7 @@ const Gdbstub = @import("lib/zba-gdbstub/build.zig");
 
 pub fn build(b: *std.build.Builder) void {
     // Minimum Zig Version
-    const min_ver = std.SemanticVersion.parse("0.11.0-dev.1580+a5b34a61a") catch return; // https://github.com/ziglang/zig/commit/a5b34a61a
+    const min_ver = std.SemanticVersion.parse("0.11.0-dev.1557+03cdb4fb5") catch return; // https://github.com/ziglang/zig/commit/03cdb4fb5
     if (builtin.zig_version.order(min_ver).compare(.lt)) {
         std.log.err("{s}", .{b.fmt("Zig v{} does not meet the minimum version requirement. (Zig v{})", .{ builtin.zig_version, min_ver })});
         std.os.exit(1);

src/core/Bus.zig

@@ -105,7 +105,7 @@ pub fn deinit(self: *Self) void {
 fn fillReadTable(self: *Self, table: *[table_len]?*const anyopaque) void {
     const vramMirror = @import("ppu/Vram.zig").mirror;
 
-    for (table, 0..) |*ptr, i| {
+    for (table) |*ptr, i| {
         const addr = @intCast(u32, page_size * i);
 
         ptr.* = switch (addr) {
@@ -132,7 +132,7 @@ fn fillWriteTable(self: *Self, comptime T: type, table: *[table_len]?*const anyo
     comptime std.debug.assert(T == u32 or T == u16 or T == u8);
     const vramMirror = @import("ppu/Vram.zig").mirror;
 
-    for (table, 0..) |*ptr, i| {
+    for (table) |*ptr, i| {
         const addr = @intCast(u32, page_size * i);
 
         ptr.* = switch (addr) {

src/core/bus/GamePak.zig

@@ -213,7 +213,6 @@ fn guessDevice(buf: []const u8) Gpio.Device.Kind {
     // Try to Guess if ROM uses RTC
     const needle = "RTC_V"; // I was told SIIRTC_V, though Pokemen Firered (USA) is a false negative
 
-    // TODO: Use new for loop syntax?
     var i: usize = 0;
     while ((i + needle.len) < buf.len) : (i += 1) {
         if (std.mem.eql(u8, needle, buf[i..(i + needle.len)])) return .Rtc;

src/core/bus/backup.zig

@@ -137,7 +137,6 @@ pub const Backup = struct {
         for (backup_kinds) |needle| {
             const needle_len = needle.str.len;
 
-            // TODO: Use new for loop syntax?
             var i: usize = 0;
             while ((i + needle_len) < rom.len) : (i += 1) {
                 if (std.mem.eql(u8, needle.str, rom[i..][0..needle_len])) return needle.kind;

src/core/bus/dma.zig

@@ -339,7 +339,10 @@ fn DmaController(comptime id: u2) type {
 }
 
 pub fn onBlanking(bus: *Bus, comptime kind: DmaKind) void {
-    inline for (0..4) |i| bus.dma[i].poll(kind);
+    comptime var i: usize = 0;
+    inline while (i < 4) : (i += 1) {
+        bus.dma[i].poll(kind);
+    }
 }
 
 const Adjustment = enum(u2) {

src/core/bus/gpio.zig

@@ -293,13 +293,13 @@ pub const Clock = struct {
         self.cpu.sched.push(.RealTimeClock, (1 << 24) -| late); // Reschedule
 
         const now = DateTime.now();
-        self.year = bcd(@intCast(u8, now.date.year - 2000));
-        self.month = @truncate(u5, bcd(now.date.month));
-        self.day = @truncate(u6, bcd(now.date.day));
-        self.weekday = @truncate(u3, bcd((now.date.weekday() + 1) % 7)); // API is Monday = 0, Sunday = 6. We want Sunday = 0, Saturday = 6
-        self.hour = @truncate(u6, bcd(now.time.hour));
-        self.minute = @truncate(u7, bcd(now.time.minute));
-        self.second = @truncate(u7, bcd(now.time.second));
+        self.year = bcd(u8, @intCast(u8, now.date.year - 2000));
+        self.month = bcd(u5, now.date.month);
+        self.day = bcd(u6, now.date.day);
+        self.weekday = bcd(u3, (now.date.weekday() + 1) % 7); // API is Monday = 0, Sunday = 6. We want Sunday = 0, Saturday = 6
+        self.hour = bcd(u6, now.time.hour);
+        self.minute = bcd(u7, now.time.minute);
+        self.second = bcd(u7, now.time.second);
     }
 
     fn step(self: *Self, value: Data) u4 {
@@ -449,8 +449,16 @@ pub const Clock = struct {
     }
 };
 
-/// Converts an 8-bit unsigned integer to its BCD representation.
-/// Note: Algorithm only works for values between 0 and 99 inclusive.
-fn bcd(value: u8) u8 {
-    return ((value / 10) << 4) + (value % 10);
+fn bcd(comptime T: type, value: u8) T {
+    var input = value;
+    var ret: u8 = 0;
+    var shift: u3 = 0;
+
+    while (input > 0) {
+        ret |= (input % 10) << (shift << 2);
+        shift += 1;
+        input /= 10;
+    }
+
+    return @truncate(T, ret);
 }

src/core/cpu.zig

@@ -39,12 +39,13 @@ pub const arm = struct {
     }
 
     fn populate() [0x1000]InstrFn {
-        comptime {
+        return comptime {
             @setEvalBranchQuota(0xE000);
-            var table = [_]InstrFn{und} ** 0x1000;
+            var ret = [_]InstrFn{und} ** 0x1000;
 
-            for (&table, 0..) |*handler, i| {
-                handler.* = switch (@as(u2, i >> 10)) {
+            var i: usize = 0;
+            while (i < ret.len) : (i += 1) {
+                ret[i] = switch (@as(u2, i >> 10)) {
                     0b00 => if (i == 0x121) blk: {
                         break :blk branchExchange;
                     } else if (i & 0xFCF == 0x009) blk: {
@@ -106,8 +107,8 @@ pub const arm = struct {
                 };
             }
 
-            return table;
-        }
+            return ret;
+        };
     }
 };
 
@@ -135,12 +136,13 @@ pub const thumb = struct {
     }
 
     fn populate() [0x400]InstrFn {
-        comptime {
+        return comptime {
             @setEvalBranchQuota(5025); // This is exact
-            var table = [_]InstrFn{und} ** 0x400;
+            var ret = [_]InstrFn{und} ** 0x400;
 
-            for (&table, 0..) |*handler, i| {
-                handler.* = switch (@as(u3, i >> 7 & 0x7)) {
+            var i: usize = 0;
+            while (i < ret.len) : (i += 1) {
+                ret[i] = switch (@as(u3, i >> 7 & 0x7)) {
                     0b000 => if (i >> 5 & 0x3 == 0b11) blk: {
                         const I = i >> 4 & 1 == 1;
                         const is_sub = i >> 3 & 1 == 1;
@@ -228,8 +230,8 @@ pub const thumb = struct {
                 };
             }
 
-            return table;
-        }
+            return ret;
+        };
     }
 };
 
@@ -383,7 +385,8 @@ pub const Arm7tdmi = struct {
         const now = getModeChecked(self, self.cpsr.mode.read());
 
         // Bank R8 -> r12
-        for (0..5) |i| {
+        var i: usize = 0;
+        while (i < 5) : (i += 1) {
             self.bank.fiq[Bank.fiqIdx(i, now)] = self.r[8 + i];
         }
 
@@ -401,7 +404,8 @@ pub const Arm7tdmi = struct {
         }
 
         // Grab R8 -> R12
-        for (0..5) |i| {
+        i = 0;
+        while (i < 5) : (i += 1) {
             self.r[8 + i] = self.bank.fiq[Bank.fiqIdx(i, next)];
         }
 
@@ -466,7 +470,8 @@ pub const Arm7tdmi = struct {
     }
 
     pub fn stepDmaTransfer(self: *Self) bool {
-        inline for (0..4) |i| {
+        comptime var i: usize = 0;
+        inline while (i < 4) : (i += 1) {
             if (self.bus.dma[i].in_progress) {
                 self.bus.dma[i].step(self);
                 return true;

src/core/cpu/thumb/block_data_transfer.zig

@@ -92,7 +92,8 @@ pub fn fmt15(comptime L: bool, comptime rb: u3) InstrFn {
 inline fn countRlist(opcode: u16) u32 {
     var count: u32 = 0;
 
-    inline for (0..8) |i| {
+    comptime var i: u4 = 0;
+    inline while (i < 8) : (i += 1) {
         if (opcode >> (7 - i) & 1 == 1) count += 1;
     }
 

src/core/emu.zig

@@ -146,8 +146,9 @@ fn sleep(timer: *Timer, wake_time: u64) ?u64 {
 
     const step = 2 * std.time.ns_per_ms; // Granularity of 2ms
     const times = sleep_for / step;
+    var i: usize = 0;
 
-    for (0..times) |_| {
+    while (i < times) : (i += 1) {
         std.time.sleep(step);
 
         // Upon wakeup, check to see if this particular sleep was longer than expected
@@ -199,18 +200,15 @@ pub const EmuThing = struct {
         const cpu = self.cpu;
         const sched = self.scheduler;
 
-        // Is true when we have executed one (1) instruction
-        var did_step: bool = false;
-
         // TODO: How can I make it easier to keep this in lock-step with runFrame?
-        while (!did_step) {
+        while (true) {
             if (!cpu.stepDmaTransfer()) {
                 if (cpu.isHalted()) {
                     // Fast-forward to next Event
                     sched.tick = sched.queue.peek().?.tick;
                 } else {
                     cpu.step();
-                    did_step = true;
+                    break; // this function won't return until we've actually stepped once
                 }
             }
 

src/core/ppu.zig

@@ -625,7 +625,8 @@ pub const Ppu = struct {
                 const framebuf_base = width * @as(usize, scanline);
                 if (obj_enable) self.fetchSprites();
 
-                for (0..4) |layer| {
+                var layer: usize = 0;
+                while (layer < 4) : (layer += 1) {
                     self.drawSprites(@truncate(u2, layer));
                     if (layer == self.bg[0].cnt.priority.read() and bg_enable & 1 == 1) self.drawBackground(0);
                     if (layer == self.bg[1].cnt.priority.read() and bg_enable >> 1 & 1 == 1) self.drawBackground(1);
@@ -639,7 +640,8 @@ pub const Ppu = struct {
                 const framebuf_base = width * @as(usize, scanline);
                 if (obj_enable) self.fetchSprites();
 
-                for (0..4) |layer| {
+                var layer: usize = 0;
+                while (layer < 4) : (layer += 1) {
                     self.drawSprites(@truncate(u2, layer));
                     if (layer == self.bg[0].cnt.priority.read() and bg_enable & 1 == 1) self.drawBackground(0);
                     if (layer == self.bg[1].cnt.priority.read() and bg_enable >> 1 & 1 == 1) self.drawBackground(1);
@@ -652,7 +654,8 @@ pub const Ppu = struct {
                 const framebuf_base = width * @as(usize, scanline);
                 if (obj_enable) self.fetchSprites();
 
-                for (0..4) |layer| {
+                var layer: usize = 0;
+                while (layer < 4) : (layer += 1) {
                     self.drawSprites(@truncate(u2, layer));
                     if (layer == self.bg[2].cnt.priority.read() and bg_enable >> 2 & 1 == 1) self.drawAffineBackground(2);
                     if (layer == self.bg[3].cnt.priority.read() and bg_enable >> 3 & 1 == 1) self.drawAffineBackground(3);
@@ -668,7 +671,7 @@ pub const Ppu = struct {
                 const vram_buf = @ptrCast([*]const u16, @alignCast(@alignOf(u16), self.vram.buf));
                 const framebuf = @ptrCast([*]u32, @alignCast(@alignOf(u32), self.framebuf.get(.Emulator)));
 
-                for (vram_buf[vram_base .. vram_base + width], 0..) |bgr555, i| {
+                for (vram_buf[vram_base .. vram_base + width]) |bgr555, i| {
                     framebuf[framebuf_base + i] = rgba888(bgr555);
                 }
             },
@@ -682,7 +685,7 @@ pub const Ppu = struct {
                 const pal_buf = @ptrCast([*]const u16, @alignCast(@alignOf(u16), self.palette.buf));
                 const framebuf = @ptrCast([*]u32, @alignCast(@alignOf(u32), self.framebuf.get(.Emulator)));
 
-                for (self.vram.buf[vram_base .. vram_base + width], 0..) |pal_id, i| {
+                for (self.vram.buf[vram_base .. vram_base + width]) |pal_id, i| {
                     framebuf[framebuf_base + i] = rgba888(pal_buf[pal_id]);
                 }
             },
@@ -698,7 +701,8 @@ pub const Ppu = struct {
                 const vram_buf = @ptrCast([*]const u16, @alignCast(@alignOf(u16), self.vram.buf));
                 const framebuf = @ptrCast([*]u32, @alignCast(@alignOf(u32), self.framebuf.get(.Emulator)));
 
-                for (0..width) |i| {
+                var i: usize = 0;
+                while (i < width) : (i += 1) {
                     const bgr555 = if (scanline < m5_height and i < m5_width) vram_buf[vram_base + i] else self.palette.backdrop();
                     framebuf[framebuf_base + i] = rgba888(bgr555);
                 }
@@ -714,7 +718,7 @@ pub const Ppu = struct {
         // FIXME: @ptrCast between slices changing the length isn't implemented yet
         const framebuf = @ptrCast([*]u32, @alignCast(@alignOf(u32), self.framebuf.get(.Emulator)));
 
-        for (self.scanline.top(), 0..) |maybe_top, i| {
+        for (self.scanline.top()) |maybe_top, i| {
             const maybe_btm = self.scanline.btm()[i];
 
             const bgr555 = self.getBgr555(maybe_top, maybe_btm);
@@ -986,7 +990,8 @@ pub const Ppu = struct {
             cpu.handleInterrupt();
         }
 
-        // If we're not also in VBlank, attempt to run any pending DMA Reqs
+        // See if HBlank DMA is present and not enabled
+
         if (!self.dispstat.vblank.read())
             dma.onBlanking(cpu.bus, .HBlank);
 

src/core/scheduler.zig

@@ -73,7 +73,7 @@ pub const Scheduler = struct {
 
     /// Removes the **first** scheduled event of type `needle`
     pub fn removeScheduledEvent(self: *Self, needle: EventKind) void {
-        for (self.queue.items, 0..) |event, i| {
+        for (self.queue.items) |event, i| {
             if (std.meta.eql(event.kind, needle)) {
 
                 // invalidates the slice we're iterating over

src/main.zig

@@ -4,17 +4,14 @@ const known_folders = @import("known_folders");
 const clap = @import("clap");
 
 const config = @import("config.zig");
-const emu = @import("core/emu.zig");
 
 const Gui = @import("platform.zig").Gui;
 const Bus = @import("core/Bus.zig");
 const Arm7tdmi = @import("core/cpu.zig").Arm7tdmi;
 const Scheduler = @import("core/scheduler.zig").Scheduler;
 const FilePaths = @import("util.zig").FilePaths;
-const FpsTracker = @import("util.zig").FpsTracker;
-const Allocator = std.mem.Allocator;
-const Atomic = std.atomic.Atomic;
 
+const Allocator = std.mem.Allocator;
 const log = std.log.scoped(.Cli);
 const width = @import("core/ppu.zig").width;
 const height = @import("core/ppu.zig").height;
@@ -91,10 +88,6 @@ pub fn main() void {
         cpu.fastBoot();
     }
 
-    var quit = Atomic(bool).init(false);
-    var gui = Gui.init(&bus.pak.title, &bus.apu, width, height) catch |e| exitln("failed to init gui: {}", .{e});
-    defer gui.deinit();
-
     if (result.args.gdb) {
         const Server = @import("gdbstub").Server;
         const EmuThing = @import("core/emu.zig").EmuThing;
@@ -103,37 +96,33 @@ pub fn main() void {
         var emulator = wrapper.interface(allocator);
         defer emulator.deinit();
 
+        {
+            const frames_per_second: usize = 60;
+            const emu = @import("core/emu.zig");
+
+            var i: usize = 0;
+            while (i < frames_per_second * 120) : (i += 1) {
+                emu.runFrame(&scheduler, &cpu);
+
+                std.debug.print("Frame {:0>3}/{:0>3}\r", .{ i, frames_per_second * 120 });
+            }
+        }
+
         log.info("Ready to connect", .{});
 
         var server = Server.init(emulator) catch |e| exitln("failed to init gdb server: {}", .{e});
         defer server.deinit(allocator);
 
-        log.info("Starting GDB Server Thread", .{});
-
-        const thread = std.Thread.spawn(.{}, Server.run, .{ &server, allocator, &quit }) catch |e| exitln("gdb server thread crashed: {}", .{e});
-        defer thread.join();
-
-        gui.run(.{
-            .cpu = &cpu,
-            .scheduler = &scheduler,
-            .quit = &quit,
-        }) catch |e| exitln("main thread panicked: {}", .{e});
+        server.run(allocator) catch |e| exitln("gdb server crashed: {}", .{e});
     } else {
-        var tracker = FpsTracker.init();
+        var gui = Gui.init(&bus.pak.title, &bus.apu, width, height) catch |e| exitln("failed to init gui: {}", .{e});
+        defer gui.deinit();
 
-        const thread = std.Thread.spawn(.{}, emu.run, .{ &quit, &scheduler, &cpu, &tracker }) catch |e| exitln("emu thread panicked: {}", .{e});
-        defer thread.join();
-
-        gui.run(.{
-            .cpu = &cpu,
-            .scheduler = &scheduler,
-            .tracker = &tracker,
-            .quit = &quit,
-        }) catch |e| exitln("main thread panicked: {}", .{e});
+        gui.run(&cpu, &scheduler) catch |e| exitln("failed to run gui thread: {}", .{e});
     }
 }
 
-fn handleArguments(allocator: Allocator, data_path: []const u8, result: *const clap.Result(clap.Help, &params, clap.parsers.default)) !FilePaths {
+pub fn handleArguments(allocator: Allocator, data_path: []const u8, result: *const clap.Result(clap.Help, &params, clap.parsers.default)) !FilePaths {
     const rom_path = romPath(result);
     log.info("ROM path: {s}", .{rom_path});
 

src/platform.zig

@@ -154,17 +154,9 @@ pub const Gui = struct {
         return tex_id;
     }
 
-    const RunOptions = struct {
-        quit: *std.atomic.Atomic(bool),
-        tracker: ?*FpsTracker = null,
-        cpu: *Arm7tdmi,
-        scheduler: *Scheduler,
-    };
-
-    pub fn run(self: *Self, opt: RunOptions) !void {
-        const cpu = opt.cpu;
-        const tracker = opt.tracker;
-        const quit = opt.quit;
+    pub fn run(self: *Self, cpu: *Arm7tdmi, scheduler: *Scheduler) !void {
+        var quit = std.atomic.Atomic(bool).init(false);
+        var tracker = FpsTracker.init();
 
         var buffer_ids = Self.generateBuffers();
         defer {
@@ -177,15 +169,13 @@ pub const Gui = struct {
         const tex_id = Self.generateTexture(cpu.bus.ppu.framebuf.get(.Renderer));
         defer gl.deleteTextures(1, &tex_id);
 
+        const thread = try std.Thread.spawn(.{}, emu.run, .{ &quit, scheduler, cpu, &tracker });
+        defer thread.join();
+
         var title_buf: [0x100]u8 = undefined;
 
         emu_loop: while (true) {
             var event: SDL.SDL_Event = undefined;
-
-            // This might be true if the emu is running via a gdbstub server
-            // and the gdb stub exits first
-            if (quit.load(.Monotonic)) break :emu_loop;
-
             while (SDL.SDL_PollEvent(&event) != 0) {
                 switch (event.type) {
                     SDL.SDL_QUIT => break :emu_loop,
@@ -248,10 +238,8 @@ pub const Gui = struct {
             gl.drawElements(gl.TRIANGLES, 6, gl.UNSIGNED_INT, null);
             SDL.SDL_GL_SwapWindow(self.window);
 
-            if (tracker) |t| {
-                const dyn_title = std.fmt.bufPrintZ(&title_buf, "ZBA | {s} [Emu: {}fps] ", .{ self.title, t.value() }) catch unreachable;
-                SDL.SDL_SetWindowTitle(self.window, dyn_title.ptr);
-            }
+            const dyn_title = std.fmt.bufPrintZ(&title_buf, "ZBA | {s} [Emu: {}fps] ", .{ self.title, tracker.value() }) catch unreachable;
+            SDL.SDL_SetWindowTitle(self.window, dyn_title.ptr);
         }
 
         quit.store(true, .Monotonic); // Terminate Emulator Thread