chore: upgrade to zig v0.15.1

TODO: figure out what this exactly does lol

.gitignore

@@ -1,2 +1,3 @@
 zig-out/
 zig-cache/
+.zig-cache/

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "lib/zig-network"]
-	path = lib/zig-network
-	url = https://github.com/MasterQ32/zig-network

build.zig

@@ -1,55 +1,63 @@
 const std = @import("std");
-const CompileStep = std.Build.CompileStep;
-
-fn path(comptime suffix: []const u8) []const u8 {
-    if (suffix[0] == '/') @compileError("expected a relative path");
-    return comptime (std.fs.path.dirname(@src().file) orelse ".") ++ std.fs.path.sep_str ++ suffix;
-}
-
-pub fn link(exe: *CompileStep) void {
-    // create zig-network module
-    const b = exe.builder;
-
-    // https://github.com/MasterQ32/zig-network
-    const network = b.createModule(.{ .source_file = .{ .path = path("lib/zig-network/network.zig") } });
-
-    const gdbstub = b.createModule(.{
-        .source_file = .{ .path = path("src/lib.zig") },
-        .dependencies = &.{.{ .name = "network", .module = network }},
-    });
-
-    exe.addModule("gdbstub", gdbstub);
-}
 
+// Although this function looks imperative, it does not perform the build
+// directly and instead it mutates the build graph (`b`) that will be then
+// executed by an external runner. The functions in `std.Build` implement a DSL
+// for defining build steps and express dependencies between them, allowing the
+// build runner to parallelize the build automatically (and the cache system to
+// know when a step doesn't need to be re-run).
 pub fn build(b: *std.Build) void {
+    // Standard target options allow the person running `zig build` to choose
+    // what target to build for. Here we do not override the defaults, which
+    // means any target is allowed, and the default is native. Other options
+    // for restricting supported target set are available.
     const target = b.standardTargetOptions(.{});
-    // const optimize = b.standardOptimizeOption(.{});
 
-    // -- Library --
-
-    const lib_test = b.addTest(.{
-        .root_source_file = .{ .path = "src/lib.zig" },
+    // This creates a module, which represents a collection of source files alongside
+    // some compilation options, such as optimization mode and linked system libraries.
+    // Zig modules are the preferred way of making Zig code available to consumers.
+    // addModule defines a module that we intend to make available for importing
+    // to our consumers. We must give it a name because a Zig package can expose
+    // multiple modules and consumers will need to be able to specify which
+    // module they want to access.
+    const mod = b.addModule("zba_gdbstub", .{
+        // The root source file is the "entry point" of this module. Users of
+        // this module will only be able to access public declarations contained
+        // in this file, which means that if you have declarations that you
+        // intend to expose to consumers that were defined in other files part
+        // of this module, you will have to make sure to re-export them from
+        // the root file.
+        .root_source_file = b.path("src/lib.zig"),
+        // Later on we'll use this module as the root module of a test executable
+        // which requires us to specify a target.
         .target = target,
     });
 
-    const test_step = b.step("test", "Run Library Tests");
-    test_step.dependOn(&lib_test.step);
+    // Creates an executable that will run `test` blocks from the provided module.
+    // Here `mod` needs to define a target, which is why earlier we made sure to
+    // set the releative field.
+    const mod_tests = b.addTest(.{
+        .root_module = mod,
+    });
 
-    // -- Executable --
+    // A run step that will run the test executable.
+    const run_mod_tests = b.addRunArtifact(mod_tests);
 
-    // const exe = b.addExecutable(.{
-    //     .name = "gdbserver",
-    //     .root_source_file = .{ .path = "src/main.zig" },
-    //     .target = target,
-    //     .optimize = optimize,
-    // });
-    // link(exe);
-    // exe.install();
+    // A top level step for running all tests. dependOn can be called multiple
+    // times and since the two run steps do not depend on one another, this will
+    // make the two of them run in parallel.
+    const test_step = b.step("test", "Run tests");
+    test_step.dependOn(&run_mod_tests.step);
 
-    // const run_cmd = exe.run();
-    // run_cmd.step.dependOn(b.getInstallStep());
-    // if (b.args) |args| run_cmd.addArgs(args);
-
-    // const run_step = b.step("run", "Run the app");
-    // run_step.dependOn(&run_cmd.step);
+    // Just like flags, top level steps are also listed in the `--help` menu.
+    //
+    // The Zig build system is entirely implemented in userland, which means
+    // that it cannot hook into private compiler APIs. All compilation work
+    // orchestrated by the build system will result in other Zig compiler
+    // subcommands being invoked with the right flags defined. You can observe
+    // these invocations when one fails (or you pass a flag to increase
+    // verbosity) to validate assumptions and diagnose problems.
+    //
+    // Lastly, the Zig build system is relatively simple and self-contained,
+    // and reading its source code will allow you to master it.
 }

build.zig.zon

@@ -0,0 +1,81 @@
+.{
+    // This is the default name used by packages depending on this one. For
+    // example, when a user runs `zig fetch --save <url>`, this field is used
+    // as the key in the `dependencies` table. Although the user can choose a
+    // different name, most users will stick with this provided value.
+    //
+    // It is redundant to include "zig" in this name because it is already
+    // within the Zig package namespace.
+    .name = .zba_gdbstub,
+    // This is a [Semantic Version](https://semver.org/).
+    // In a future version of Zig it will be used for package deduplication.
+    .version = "0.0.0",
+    // Together with name, this represents a globally unique package
+    // identifier. This field is generated by the Zig toolchain when the
+    // package is first created, and then *never changes*. This allows
+    // unambiguous detection of one package being an updated version of
+    // another.
+    //
+    // When forking a Zig project, this id should be regenerated (delete the
+    // field and run `zig build`) if the upstream project is still maintained.
+    // Otherwise, the fork is *hostile*, attempting to take control over the
+    // original project's identity. Thus it is recommended to leave the comment
+    // on the following line intact, so that it shows up in code reviews that
+    // modify the field.
+    .fingerprint = 0x8006426818f63728, // Changing this has security and trust implications.
+    // Tracks the earliest Zig version that the package considers to be a
+    // supported use case.
+    .minimum_zig_version = "0.15.1",
+    // This field is optional.
+    // Each dependency must either provide a `url` and `hash`, or a `path`.
+    // `zig build --fetch` can be used to fetch all dependencies of a package, recursively.
+    // Once all dependencies are fetched, `zig build` no longer requires
+    // internet connectivity.
+    .dependencies = .{
+        // See `zig fetch --save <url>` for a command-line interface for adding dependencies.
+        //.example = .{
+        //    // When updating this field to a new URL, be sure to delete the corresponding
+        //    // `hash`, otherwise you are communicating that you expect to find the old hash at
+        //    // the new URL. If the contents of a URL change this will result in a hash mismatch
+        //    // which will prevent zig from using it.
+        //    .url = "https://example.com/foo.tar.gz",
+        //
+        //    // This is computed from the file contents of the directory of files that is
+        //    // obtained after fetching `url` and applying the inclusion rules given by
+        //    // `paths`.
+        //    //
+        //    // This field is the source of truth; packages do not come from a `url`; they
+        //    // come from a `hash`. `url` is just one of many possible mirrors for how to
+        //    // obtain a package matching this `hash`.
+        //    //
+        //    // Uses the [multihash](https://multiformats.io/multihash/) format.
+        //    .hash = "...",
+        //
+        //    // When this is provided, the package is found in a directory relative to the
+        //    // build root. In this case the package's hash is irrelevant and therefore not
+        //    // computed. This field and `url` are mutually exclusive.
+        //    .path = "foo",
+        //
+        //    // When this is set to `true`, a package is declared to be lazily
+        //    // fetched. This makes the dependency only get fetched if it is
+        //    // actually used.
+        //    .lazy = false,
+        //},
+    },
+    // Specifies the set of files and directories that are included in this package.
+    // Only files and directories listed here are included in the `hash` that
+    // is computed for this package. Only files listed here will remain on disk
+    // when using the zig package manager. As a rule of thumb, one should list
+    // files required for compilation plus any license(s).
+    // Paths are relative to the build root. Use the empty string (`""`) to refer to
+    // the build root itself.
+    // A directory listed here means that all files within, recursively, are included.
+    .paths = .{
+        "build.zig",
+        "build.zig.zon",
+        "src",
+        // For example...
+        //"LICENSE",
+        //"README.md",
+    },
+}

src/Packet.zig

@@ -3,9 +3,7 @@ const std = @import("std");
 const Allocator = std.mem.Allocator;
 const Emulator = @import("lib.zig").Emulator;
 const State = @import("State.zig");
-
-const target = @import("Server.zig").target;
-const memory_map = @import("Server.zig").memory_map;
+const Server = @import("Server.zig");
 
 const Self = @This();
 const log = std.log.scoped(.Packet);
@@ -14,7 +12,7 @@ pub const max_len: usize = 0x1000;
 contents: []const u8,
 
 pub fn from(allocator: Allocator, str: []const u8) !Self {
-    var tokens = std.mem.tokenize(u8, str, "$#");
+    var tokens = std.mem.tokenizeAny(u8, str, "$#");
     const contents = tokens.next() orelse return error.InvalidPacket;
 
     const chksum_str = tokens.next() orelse return error.MissingCheckSum;
@@ -46,7 +44,7 @@ const String = union(enum) {
     }
 };
 
-pub fn parse(self: *Self, allocator: Allocator, emu: *Emulator) !String {
+pub fn parse(self: *Self, allocator: Allocator, state: *Server.State, emu: *Emulator) !String {
     switch (self.contents[0]) {
         // Required
         '?' => return .{ .static = "T05" }, // FIXME: which errno?
@@ -61,11 +59,13 @@ pub fn parse(self: *Self, allocator: Allocator, emu: *Emulator) !String {
                 var i: u32 = 0;
                 while (i < r.len + 1) : (i += 1) {
                     var reg: u32 = if (i < r.len) r[i] else cpsr;
-                    if (i == 15) reg -= if (cpsr >> 5 & 1 == 1) 4 else 8; // PC is ahead
+                    if (i == 15) reg -|= if (cpsr >> 5 & 1 == 1) 4 else 8; // PC is ahead
 
                     // writes the formatted integer to the buffer, returns a slice to the buffer but we ignore that
                     // GDB also expects the bytes to be in the opposite order for whatever reason
-                    _ = std.fmt.bufPrintIntToSlice(ret[i * 8 ..][0..8], @byteSwap(reg), 16, .lower, .{ .fill = '0', .width = 8 });
+
+                    _ = try std.fmt.bufPrint(ret[i * 8 ..][0..8], "{x:0>8}", .{@byteSwap(reg)});
+                    // _ = std.fmt.bufPrintIntToSlice(ret[i * 8 ..][0..8], @byteSwap(reg), 16, .lower, .{ .fill = '0', .width = 8 });
                 }
             }
 
@@ -73,7 +73,7 @@ pub fn parse(self: *Self, allocator: Allocator, emu: *Emulator) !String {
         },
         'G' => @panic("TODO: Register Write"),
         'm' => {
-            var tokens = std.mem.tokenize(u8, self.contents[1..], ",");
+            var tokens = std.mem.tokenizeAny(u8, self.contents[1..], ",");
             const addr_str = tokens.next() orelse return error.InvalidPacket;
             const length_str = tokens.next() orelse return error.InvalidPacket;
 
@@ -86,14 +86,16 @@ pub fn parse(self: *Self, allocator: Allocator, emu: *Emulator) !String {
                 var i: u32 = 0;
                 while (i < len) : (i += 1) {
                     // writes the formatted integer to the buffer, returns a slice to the buffer but we ignore that
-                    _ = std.fmt.bufPrintIntToSlice(ret[i * 2 ..][0..2], emu.read(addr + i), 16, .lower, .{ .fill = '0', .width = 2 });
+
+                    _ = try std.fmt.bufPrint(ret[i * 2 ..][0..2], "{x:0>2}", .{emu.read(addr + i)});
+                    // _ = std.fmt.bufPrintIntToSlice(ret[i * 2 ..][0..2], emu.read(addr + i), 16, .lower, .{ .fill = '0', .width = 2 });
                 }
             }
 
             return .{ .alloc = ret };
         },
         'M' => {
-            var tokens = std.mem.tokenize(u8, self.contents[1..], ",:");
+            var tokens = std.mem.tokenizeAny(u8, self.contents[1..], ",:");
 
             const addr_str = tokens.next() orelse return error.InvalidPacket;
             const length_str = tokens.next() orelse return error.InvalidPacket;
@@ -124,7 +126,7 @@ pub fn parse(self: *Self, allocator: Allocator, emu: *Emulator) !String {
             }
         },
         's' => {
-            // var tokens = std.mem.tokenize(u8, self.contents[1..], " ");
+            // var tokens = std.mem.tokenizeAny(u8, self.contents[1..], " ");
             // const addr = if (tokens.next()) |s| try std.fmt.parseInt(u32, s, 16) else null;
 
             switch (emu.step()) {
@@ -138,7 +140,7 @@ pub fn parse(self: *Self, allocator: Allocator, emu: *Emulator) !String {
 
         // Breakpoints
         'z' => {
-            var tokens = std.mem.tokenize(u8, self.contents[2..], ",");
+            var tokens = std.mem.tokenizeAny(u8, self.contents[2..], ",");
 
             const addr_str = tokens.next() orelse return error.InvalidPacket;
             const addr = try std.fmt.parseInt(u32, addr_str, 16);
@@ -159,7 +161,7 @@ pub fn parse(self: *Self, allocator: Allocator, emu: *Emulator) !String {
             }
         },
         'Z' => {
-            var tokens = std.mem.tokenize(u8, self.contents[2..], ",");
+            var tokens = std.mem.tokenizeAny(u8, self.contents[2..], ",");
             const addr_str = tokens.next() orelse return error.InvalidPacket;
             const kind_str = tokens.next() orelse return error.InvalidPacket;
 
@@ -168,11 +170,11 @@ pub fn parse(self: *Self, allocator: Allocator, emu: *Emulator) !String {
 
             switch (self.contents[1]) {
                 '0' => {
-                    try emu.addBkpt(.Software, addr, kind);
+                    try emu.addBkpt(.Software, allocator, addr, kind);
                     return .{ .static = "OK" };
                 },
                 '1' => {
-                    emu.addBkpt(.Hardware, addr, kind) catch |e| {
+                    emu.addBkpt(.Hardware, allocator, addr, kind) catch |e| {
                         switch (e) {
                             error.OutOfSpace => return .{ .static = "E22" }, // FIXME: which errno?
                             else => return e,
@@ -191,16 +193,25 @@ pub fn parse(self: *Self, allocator: Allocator, emu: *Emulator) !String {
         // TODO: Figure out the difference between 'M' and 'X'
         'D' => {
             log.info("Disconnecting...", .{});
+
+            state.should_quit = true;
             return .{ .static = "OK" };
         },
         'H' => return .{ .static = "" },
         'v' => {
-            if (!substr(self.contents[1..], "MustReplyEmpty")) {
-                log.warn("Unimplemented: {s}", .{self.contents});
+            if (substr(self.contents[1..], "MustReplyEmpty")) return .{ .static = "" };
+
+            if (substr(self.contents[1..], "Cont")) {
+                switch (self.contents[5]) {
+                    '?' => return .{ .static = "" }, // TODO: Implement vCont
+                    else => {},
+                }
             }
 
+            log.warn("Unimplemented: {s}", .{self.contents});
             return .{ .static = "" };
         },
+        'T' => return .{ .static = "OK " }, // We assume single threaded here
         'q' => {
             if (self.contents[1] == 'C' and self.contents.len == 2) return .{ .static = "QC1" };
 
@@ -208,16 +219,24 @@ pub fn parse(self: *Self, allocator: Allocator, emu: *Emulator) !String {
             if (substr(self.contents[1..], "sThreadInfo")) return .{ .static = "l" };
             if (substr(self.contents[1..], "Attached")) return .{ .static = "1" }; // Tell GDB we're attached to a process
 
-            if (substr(self.contents[1..], "Supported")) {
-                const format = "PacketSize={x:};swbreak+;hwbreak+;qXfer:features:read+;qXfer:memory-map:read+";
-                // TODO: Anything else?
+            if (substr(self.contents[1..], "ThreadExtraInfo")) {
+                const extra_info = "FIXME: what is even expected here?";
+                const ret = try allocator.dupe(u8, &std.fmt.bytesToHex(extra_info, .lower));
 
-                const ret = try std.fmt.allocPrint(allocator, format, .{Self.max_len});
+                return .{ .alloc = ret };
+            }
+
+            if (substr(self.contents[1..], "Supported")) {
+                const format = "PacketSize={x:};swbreak+;hwbreak+;qXfer:features:read+;{s}";
+                const mem_map = if (state.memmap_xml == null) "" else "qXfer:memory-map:read+";
+
+                // TODO: Anything else?
+                const ret = try std.fmt.allocPrint(allocator, format, .{ Self.max_len, mem_map });
                 return .{ .alloc = ret };
             }
 
             if (substr(self.contents[1..], "Xfer:features:read")) {
-                var tokens = std.mem.tokenize(u8, self.contents[1..], ":,");
+                var tokens = std.mem.tokenizeAny(u8, self.contents[1..], ":,");
                 _ = tokens.next(); // Xfer
                 _ = tokens.next(); // features
                 _ = tokens.next(); // read
@@ -233,11 +252,11 @@ pub fn parse(self: *Self, allocator: Allocator, emu: *Emulator) !String {
                     // + 2 to account for the "m " in the response
                     // subtract offset so that the allocated buffer isn't
                     // larger than it needs to be TODO: Test this?
-                    const len = @min(length, (target.len + 1) - offset);
+                    const len = @min(length, (state.target_xml.len + 1) - offset);
                     const ret = try allocator.alloc(u8, len);
 
                     ret[0] = if (ret.len < length) 'l' else 'm';
-                    std.mem.copy(u8, ret[1..], target[offset..]);
+                    @memcpy(ret[1..], state.target_xml[offset..]);
 
                     return .{ .alloc = ret };
                 } else {
@@ -249,7 +268,9 @@ pub fn parse(self: *Self, allocator: Allocator, emu: *Emulator) !String {
             }
 
             if (substr(self.contents[1..], "Xfer:memory-map:read")) {
-                var tokens = std.mem.tokenize(u8, self.contents[1..], ":,");
+                const mem_map = state.memmap_xml.?;
+
+                var tokens = std.mem.tokenizeAny(u8, self.contents[1..], ":,");
                 _ = tokens.next(); // Xfer
                 _ = tokens.next(); // memory-map
                 _ = tokens.next(); // read
@@ -260,11 +281,11 @@ pub fn parse(self: *Self, allocator: Allocator, emu: *Emulator) !String {
                 const length = try std.fmt.parseInt(usize, length_str, 16);
 
                 // see above
-                const len = @min(length, (memory_map.len + 1) - offset);
+                const len = @min(length, (mem_map.len + 1) - offset);
                 const ret = try allocator.alloc(u8, len);
 
                 ret[0] = if (ret.len < length) 'l' else 'm';
-                std.mem.copy(u8, ret[1..], memory_map[offset..]);
+                @memcpy(ret[1..], mem_map[offset..]);
 
                 return .{ .alloc = ret };
             }
@@ -293,7 +314,7 @@ pub fn checksum(input: []const u8) u8 {
     var sum: usize = 0;
     for (input) |char| sum += char;
 
-    return @truncate(u8, sum);
+    return @truncate(sum);
 }
 
 fn verify(input: []const u8, chksum: u8) bool {

src/Server.zig

@@ -1,88 +1,43 @@
 const std = @import("std");
-const network = @import("network");
 const Packet = @import("Packet.zig");
-
-const Socket = network.Socket;
-const Allocator = std.mem.Allocator;
-const Atomic = std.atomic.Atomic;
 const Emulator = @import("lib.zig").Emulator;
 
+const Allocator = std.mem.Allocator;
+const Server = std.net.Server;
+
 const Self = @This();
 const log = std.log.scoped(.Server);
 const port: u16 = 2424;
 
-pub const target: []const u8 =
-    \\<target version="1.0">
-    \\    <architecture>armv4t</architecture>
-    \\    <feature name="org.gnu.gdb.arm.core">
-    \\        <reg name="r0" bitsize="32" type="uint32"/>
-    \\        <reg name="r1" bitsize="32" type="uint32"/>
-    \\        <reg name="r2" bitsize="32" type="uint32"/>
-    \\        <reg name="r3" bitsize="32" type="uint32"/>
-    \\        <reg name="r4" bitsize="32" type="uint32"/>
-    \\        <reg name="r5" bitsize="32" type="uint32"/>
-    \\        <reg name="r6" bitsize="32" type="uint32"/>
-    \\        <reg name="r7" bitsize="32" type="uint32"/>
-    \\        <reg name="r8" bitsize="32" type="uint32"/>
-    \\        <reg name="r9" bitsize="32" type="uint32"/>
-    \\        <reg name="r10" bitsize="32" type="uint32"/>
-    \\        <reg name="r11" bitsize="32" type="uint32"/>
-    \\        <reg name="r12" bitsize="32" type="uint32"/>
-    \\        <reg name="sp" bitsize="32" type="data_ptr"/>
-    \\        <reg name="lr" bitsize="32"/>
-    \\        <reg name="pc" bitsize="32" type="code_ptr"/>
-    \\
-    \\        <reg name="cpsr" bitsize="32" regnum="25"/>
-    \\    </feature>
-    \\</target>
-;
-
-// Game Pak SRAM isn't included
-// TODO: Can i be more specific here?
-pub const memory_map: []const u8 =
-    \\ <memory-map version="1.0">
-    \\     <memory type="rom" start="0x00000000" length="0x00004000"/>
-    \\     <memory type="ram" start="0x02000000" length="0x00040000"/>
-    \\     <memory type="ram" start="0x03000000" length="0x00008000"/>
-    \\     <memory type="ram" start="0x04000000" length="0x00000400"/>
-    \\     <memory type="ram" start="0x05000000" length="0x00000400"/>
-    \\     <memory type="ram" start="0x06000000" length="0x00018000"/>
-    \\     <memory type="ram" start="0x07000000" length="0x00000400"/>
-    \\     <memory type="rom" start="0x08000000" length="0x02000000"/>
-    \\     <memory type="rom" start="0x0A000000" length="0x02000000"/>
-    \\     <memory type="rom" start="0x0C000000" length="0x02000000"/>
-    \\ </memory-map>
-;
-
 // FIXME: Shouldn't this be a Packet Struct?
 pkt_cache: ?[]const u8 = null,
 
-client: Socket,
-_socket: Socket,
+socket: Server,
+state: State,
 
 emu: Emulator,
 
-pub fn init(emulator: Emulator) !Self {
-    try network.init();
+pub const State = struct {
+    should_quit: bool = false,
+    target_xml: []const u8,
+    memmap_xml: ?[]const u8,
+};
 
-    var socket = try Socket.create(.ipv4, .tcp);
-    try socket.bindToPort(port);
-    try socket.listen();
+const Xml = struct { target: []const u8, memory_map: ?[]const u8 };
 
-    var client = try socket.accept(); // TODO: This blocks, is this OK?
+pub fn init(emulator: Emulator, xml: Xml) !Self {
+    const localhost = std.net.Address.initIp4(.{ 127, 0, 0, 1 }, port);
 
-    const endpoint = try client.getLocalEndPoint();
-    log.info("client connected from {}", .{endpoint});
-
-    return .{ .emu = emulator, ._socket = socket, .client = client };
+    return .{
+        .emu = emulator,
+        .socket = try localhost.listen(.{}),
+        .state = .{ .target_xml = xml.target, .memmap_xml = xml.memory_map },
+    };
 }
 
 pub fn deinit(self: *Self, allocator: Allocator) void {
     self.reset(allocator);
-
-    self.client.close();
-    self._socket.close();
-    network.deinit();
+    self.socket.deinit();
 
     self.* = undefined;
 }
@@ -95,25 +50,30 @@ const Action = union(enum) {
     nack,
 };
 
-pub fn run(self: *Self, allocator: Allocator, quit: *Atomic(bool)) !void {
+pub fn run(self: *Self, allocator: Allocator, should_quit: *std.atomic.Value(bool)) !void {
     var buf: [Packet.max_len]u8 = undefined;
 
-    while (true) {
-        const len = try self.client.receive(&buf);
+    var client = try self.socket.accept();
+    log.info("client connected from {f}", .{client.address});
+
+    while (!should_quit.load(.monotonic)) {
+        if (self.state.should_quit) {
+            // Just in case its the gdbstub that exited first,
+            // attempt to signal to the GUI that it should also exit
+            should_quit.store(true, .monotonic);
+            break;
+        }
+
+        const len = try client.stream.read(&buf);
         if (len == 0) break;
 
-        if (quit.load(.Monotonic)) break;
         const action = try self.parse(allocator, buf[0..len]);
-        try self.send(allocator, action);
+        try self.send(allocator, client, action);
     }
-
-    // Just in case its the gdbstub that exited first,
-    // attempt to signal to the GUI that it should also exit
-    quit.store(true, .Monotonic);
 }
 
 fn parse(self: *Self, allocator: Allocator, input: []const u8) !Action {
-    // log.debug("-> {s}", .{input});
+    log.debug("-> {s}", .{input});
 
     return switch (input[0]) {
         '+' => blk: {
@@ -135,7 +95,7 @@ fn handlePacket(self: *Self, allocator: Allocator, input: []const u8) !Action {
     var packet = Packet.from(allocator, input) catch return .nack;
     defer packet.deinit(allocator);
 
-    var string = packet.parse(allocator, &self.emu) catch return .nack;
+    var string = packet.parse(allocator, &self.state, &self.emu) catch return .nack;
     defer string.deinit(allocator);
 
     const reply = string.inner();
@@ -146,11 +106,11 @@ fn handlePacket(self: *Self, allocator: Allocator, input: []const u8) !Action {
     return .{ .send = response };
 }
 
-fn send(self: *Self, allocator: Allocator, action: Action) !void {
+fn send(self: *Self, allocator: Allocator, client: Server.Connection, action: Action) !void {
     switch (action) {
         .send => |pkt| {
-            _ = try self.client.send(pkt);
-            // log.debug("<- {s}", .{pkt});
+            _ = try client.stream.writeAll(pkt);
+            log.debug("<- {s}", .{pkt});
 
             self.reset(allocator);
             self.pkt_cache = pkt;
@@ -159,19 +119,19 @@ fn send(self: *Self, allocator: Allocator, action: Action) !void {
             log.warn("received nack, resending: \"{?s}\"", .{self.pkt_cache});
 
             if (self.pkt_cache) |pkt| {
-                _ = try self.client.send(pkt);
-                // log.debug("<- {s}", .{pkt});
+                _ = try client.stream.writeAll(pkt);
+                log.debug("<- {s}", .{pkt});
             }
         },
         .ack => {
-            _ = try self.client.send("+");
-            // log.debug("<- +", .{});
+            _ = try client.stream.writeAll("+");
+            log.debug("<- +", .{});
 
             self.reset(allocator);
         },
         .nack => {
-            _ = try self.client.send("-");
-            // log.debug("<- -", .{});
+            _ = try client.stream.writeAll("-");
+            log.debug("<- -", .{});
 
             self.reset(allocator);
         },

src/State.zig

@@ -1,31 +1,21 @@
 const std = @import("std");
-
 const Allocator = std.mem.Allocator;
-const ArrayList = std.ArrayList;
 
 hw_bkpt: HwBkpt = .{},
-sw_bkpt: SwBkpt,
+sw_bkpt: SwBkpt = .{},
 
-pub fn init(allocator: Allocator) @This() {
-    return .{ .sw_bkpt = SwBkpt.init(allocator) };
-}
-
-pub fn deinit(self: *@This()) void {
-    self.sw_bkpt.deinit();
+pub fn deinit(self: *@This(), allocator: Allocator) void {
+    self.sw_bkpt.deinit(allocator);
     self.* = undefined;
 }
 
 const SwBkpt = struct {
     const log = std.log.scoped(.SwBkpt);
 
-    list: std.ArrayList(Bkpt),
+    list: std.ArrayList(Bkpt) = .empty,
 
-    pub fn init(allocator: Allocator) @This() {
-        return .{ .list = ArrayList(Bkpt).init(allocator) };
-    }
-
-    pub fn deinit(self: *@This()) void {
-        self.list.deinit();
+    pub fn deinit(self: *@This(), allocator: Allocator) void {
+        self.list.deinit(allocator);
         self.* = undefined;
     }
 
@@ -37,17 +27,17 @@ const SwBkpt = struct {
         return false;
     }
 
-    pub fn add(self: *@This(), addr: u32, kind: u32) !void {
+    pub fn add(self: *@This(), allocator: Allocator, addr: u32, kind: u32) !void {
         for (self.list.items) |bkpt| {
             if (bkpt.addr == addr) return; // indempotent
         }
 
-        try self.list.append(.{ .addr = addr, .kind = try Bkpt.Kind.from(u32, kind) });
+        try self.list.append(allocator, .{ .addr = addr, .kind = try Bkpt.Kind.from(u32, kind) });
         log.warn("Added Breakpoint at 0x{X:0>8}", .{addr});
     }
 
     pub fn remove(self: *@This(), addr: u32) void {
-        for (self.list.items) |bkpt, i| {
+        for (self.list.items, 0..) |bkpt, i| {
             if (bkpt.addr == addr) {
                 _ = self.list.orderedRemove(i);
                 log.debug("Removed Breakpoint at 0x{X:0>8}", .{addr});
@@ -73,7 +63,7 @@ const HwBkpt = struct {
     }
 
     pub fn add(self: *@This(), addr: u32, kind: u32) !void {
-        for (self.list) |*bkpt_opt| {
+        for (&self.list) |*bkpt_opt| {
             if (bkpt_opt.*) |bkpt| {
                 if (bkpt.addr == addr) return; // idempotent
             } else {
@@ -88,7 +78,7 @@ const HwBkpt = struct {
     }
 
     pub fn remove(self: *@This(), addr: u32) void {
-        for (self.list) |*bkpt_opt| {
+        for (&self.list) |*bkpt_opt| {
             const bkpt = bkpt_opt.* orelse continue;
 
             if (bkpt.addr == addr) {
@@ -110,7 +100,7 @@ const Bkpt = struct {
         Thumb = 4,
 
         pub fn from(comptime T: type, num: T) !@This() {
-            comptime std.debug.assert(@typeInfo(T) == .Int);
+            comptime std.debug.assert(@typeInfo(T) == .int);
 
             return switch (num) {
                 2 => .Arm,

src/lib.zig

@@ -16,7 +16,7 @@ pub const Emulator = struct {
         SingleStep: void,
     };
 
-    state: State,
+    state: State = .{},
 
     ptr: *anyopaque,
 
@@ -28,44 +28,42 @@ pub const Emulator = struct {
 
     stepFn: *const fn (*anyopaque) void,
 
-    pub fn init(allocator: Allocator, ptr: anytype) Self {
+    pub fn init(ptr: anytype) Self {
         const Ptr = @TypeOf(ptr);
         const ptr_info = @typeInfo(Ptr);
 
-        if (ptr_info != .Pointer) @compileError("ptr must be a pointer");
-        if (ptr_info.Pointer.size != .One) @compileError("ptr must be a single-item pointer");
-
-        const alignment = ptr_info.Pointer.alignment;
+        if (ptr_info != .pointer) @compileError("ptr must be a pointer");
+        if (ptr_info.pointer.size != .one) @compileError("ptr must be a single-item pointer");
 
         const gen = struct {
             pub fn readImpl(pointer: *anyopaque, addr: u32) u8 {
-                const self = @ptrCast(Ptr, @alignCast(alignment, pointer));
+                const self: Ptr = @ptrCast(@alignCast(pointer));
 
-                return @call(.always_inline, ptr_info.Pointer.child.read, .{ self, addr });
+                return @call(.always_inline, ptr_info.pointer.child.read, .{ self, addr });
             }
 
             pub fn writeImpl(pointer: *anyopaque, addr: u32, value: u8) void {
-                const self = @ptrCast(Ptr, @alignCast(alignment, pointer));
+                const self: Ptr = @ptrCast(@alignCast(pointer));
 
-                return @call(.always_inline, ptr_info.Pointer.child.write, .{ self, addr, value });
+                return @call(.always_inline, ptr_info.pointer.child.write, .{ self, addr, value });
             }
 
             pub fn registersImpl(pointer: *anyopaque) *[16]u32 {
-                const self = @ptrCast(Ptr, @alignCast(alignment, pointer));
+                const self: Ptr = @ptrCast(@alignCast(pointer));
 
-                return @call(.always_inline, ptr_info.Pointer.child.registers, .{self});
+                return @call(.always_inline, ptr_info.pointer.child.registers, .{self});
             }
 
             pub fn cpsrImpl(pointer: *anyopaque) u32 {
-                const self = @ptrCast(Ptr, @alignCast(alignment, pointer));
+                const self: Ptr = @ptrCast(@alignCast(pointer));
 
-                return @call(.always_inline, ptr_info.Pointer.child.cpsr, .{self});
+                return @call(.always_inline, ptr_info.pointer.child.cpsr, .{self});
             }
 
             pub fn stepImpl(pointer: *anyopaque) void {
-                const self = @ptrCast(Ptr, @alignCast(alignment, pointer));
+                const self: Ptr = @ptrCast(@alignCast(pointer));
 
-                return @call(.always_inline, ptr_info.Pointer.child.step, .{self});
+                return @call(.always_inline, ptr_info.pointer.child.step, .{self});
             }
         };
 
@@ -76,13 +74,11 @@ pub const Emulator = struct {
             .registersFn = gen.registersImpl,
             .cpsrFn = gen.cpsrImpl,
             .stepFn = gen.stepImpl,
-
-            .state = State.init(allocator),
         };
     }
 
-    pub fn deinit(self: *Self) void {
-        self.state.deinit();
+    pub fn deinit(self: *Self, allocator: Allocator) void {
+        self.state.deinit(allocator);
         self.* = undefined;
     }
 
@@ -130,10 +126,10 @@ pub const Emulator = struct {
     const BkptType = enum { Hardware, Software };
 
     // TODO: Consider properly implementing Software interrupts?
-    pub fn addBkpt(self: *Self, comptime @"type": BkptType, addr: u32, kind: u32) !void {
+    pub fn addBkpt(self: *Self, comptime @"type": BkptType, allocator: Allocator, addr: u32, kind: u32) !void {
         switch (@"type") {
             .Hardware => try self.state.hw_bkpt.add(addr, kind),
-            .Software => try self.state.sw_bkpt.add(addr, kind),
+            .Software => try self.state.sw_bkpt.add(allocator, addr, kind),
         }
     }
 
@@ -144,3 +140,7 @@ pub const Emulator = struct {
         }
     }
 };
+
+test {
+    _ = @import("test.zig");
+}

src/main.zig

@@ -1,18 +0,0 @@
-const std = @import("std");
-const Server = @import("gdbstub").Server;
-
-pub fn main() !void {
-    const log = std.log.scoped(.Main);
-
-    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
-    defer std.debug.assert(!gpa.deinit());
-
-    const allocator = gpa.allocator();
-
-    var server = try Server.init();
-    defer server.deinit(allocator);
-
-    try server.run(allocator);
-
-    log.info("Client disconnected", .{});
-}

src/test.zig

@@ -0,0 +1,158 @@
+const std = @import("std");
+const builtin = @import("builtin");
+
+const Emulator = @import("lib.zig").Emulator;
+const Server = @import("Server.zig");
+
+const Allocator = std.mem.Allocator;
+
+const BarebonesEmulator = struct {
+
+    // I have this ARMv4T and GBA memory map xml lying around so we'll reuse it here
+    const target: []const u8 =
+        \\<target version="1.0">
+        \\    <architecture>armv4t</architecture>
+        \\    <feature name="org.gnu.gdb.arm.core">
+        \\        <reg name="r0" bitsize="32" type="uint32"/>
+        \\        <reg name="r1" bitsize="32" type="uint32"/>
+        \\        <reg name="r2" bitsize="32" type="uint32"/>
+        \\        <reg name="r3" bitsize="32" type="uint32"/>
+        \\        <reg name="r4" bitsize="32" type="uint32"/>
+        \\        <reg name="r5" bitsize="32" type="uint32"/>
+        \\        <reg name="r6" bitsize="32" type="uint32"/>
+        \\        <reg name="r7" bitsize="32" type="uint32"/>
+        \\        <reg name="r8" bitsize="32" type="uint32"/>
+        \\        <reg name="r9" bitsize="32" type="uint32"/>
+        \\        <reg name="r10" bitsize="32" type="uint32"/>
+        \\        <reg name="r11" bitsize="32" type="uint32"/>
+        \\        <reg name="r12" bitsize="32" type="uint32"/>
+        \\        <reg name="sp" bitsize="32" type="data_ptr"/>
+        \\        <reg name="lr" bitsize="32"/>
+        \\        <reg name="pc" bitsize="32" type="code_ptr"/>
+        \\
+        \\        <reg name="cpsr" bitsize="32" regnum="25"/>
+        \\    </feature>
+        \\</target>
+    ;
+
+    const memory_map: []const u8 =
+        \\ <memory-map version="1.0">
+        \\     <memory type="rom" start="0x00000000" length="0x00004000"/>
+        \\     <memory type="ram" start="0x02000000" length="0x00040000"/>
+        \\     <memory type="ram" start="0x03000000" length="0x00008000"/>
+        \\     <memory type="ram" start="0x04000000" length="0x00000400"/>
+        \\     <memory type="ram" start="0x05000000" length="0x00000400"/>
+        \\     <memory type="ram" start="0x06000000" length="0x00018000"/>
+        \\     <memory type="ram" start="0x07000000" length="0x00000400"/>
+        \\     <memory type="rom" start="0x08000000" length="0x02000000"/>
+        \\     <memory type="rom" start="0x0A000000" length="0x02000000"/>
+        \\     <memory type="rom" start="0x0C000000" length="0x02000000"/>
+        \\ </memory-map>
+    ;
+
+    r: [16]u32 = [_]u32{0} ** 16,
+
+    pub fn interface(self: *@This()) Emulator {
+        return Emulator.init(self);
+    }
+
+    pub fn read(_: *const @This(), _: u32) u8 {
+        return 0;
+    }
+
+    pub fn write(_: *@This(), _: u32, _: u8) void {}
+
+    pub fn registers(self: *@This()) *[16]u32 {
+        return &self.r;
+    }
+
+    pub fn cpsr(_: *const @This()) u32 {
+        return 0;
+    }
+
+    pub fn step(_: *@This()) void {
+        // execute 1 instruction
+    }
+};
+
+test Server {
+    // https://github.com/ziglang/zig/blob/225fe6ddbfae016395762850e0cd5c51f9e7751c/lib/std/net/test.zig#L146C1-L156
+    if (builtin.single_threaded) return error.SkipZigTest;
+    if (builtin.os.tag == .wasi) return error.SkipZigTest;
+
+    if (builtin.os.tag == .windows)
+        _ = try std.os.windows.WSAStartup(2, 2);
+
+    defer if (builtin.os.tag == .windows) std.os.windows.WSACleanup() catch unreachable;
+
+    const allocator = std.testing.allocator;
+
+    var impl = BarebonesEmulator{};
+    var iface = impl.interface();
+    defer iface.deinit(allocator);
+
+    const clientFn = struct {
+        fn inner(address: std.net.Address) !void {
+            const socket = try std.net.tcpConnectToAddress(address);
+            defer socket.close();
+
+            var buf: [1024]u8 = undefined;
+
+            var writer = socket.writer(&buf).interface;
+
+            _ = try writer.writeAll("+");
+        }
+    }.inner;
+
+    var server = try Server.init(
+        iface,
+        .{ .target = BarebonesEmulator.target, .memory_map = BarebonesEmulator.memory_map },
+    );
+    defer server.deinit(allocator);
+
+    const t = try std.Thread.spawn(.{}, clientFn, .{server.socket.listen_address});
+    defer t.join();
+
+    var should_quit = std.atomic.Value(bool).init(false);
+
+    try server.run(std.testing.allocator, &should_quit);
+}
+
+test Emulator {
+    const ExampleImpl = struct {
+        r: [16]u32 = [_]u32{0} ** 16,
+
+        pub fn interface(self: *@This(), allocator: std.mem.Allocator) Emulator {
+            return Emulator.init(allocator, self);
+        }
+
+        pub fn read(_: *const @This(), _: u32) u8 {
+            return 0;
+        }
+
+        pub fn write(_: *@This(), _: u32, _: u8) void {}
+
+        pub fn registers(self: *@This()) *[16]u32 {
+            return &self.r;
+        }
+
+        pub fn cpsr(_: *const @This()) u32 {
+            return 0;
+        }
+
+        pub fn step(_: *@This()) void {
+            // execute 1 instruction
+        }
+    };
+
+    var impl = ExampleImpl{};
+    var emu = Emulator.init(&impl);
+
+    _ = emu.read(0x0000_0000);
+    emu.write(0x0000_0000, 0x00);
+
+    _ = emu.registers();
+    _ = emu.cpsr();
+
+    _ = emu.step();
+}