Compare commits

..

4 Commits

Author SHA1 Message Date
9a50607d5f feat: update to Zig v0.13.0 2024-07-03 19:45:52 -05:00
bc47ff4883 feat: implement qThreadExtraInfo
TODO: figure out what this exactly does lol
2024-03-05 23:14:50 -06:00
3670bebbc4 feat: implement 'T' packet 2024-03-05 23:14:32 -06:00
309851ab06 fix: make xml memory map optional
Can make it mandatory once I've figured out the whole NDS memory map thing
2024-03-05 23:13:47 -06:00
5 changed files with 105 additions and 26 deletions

1
.gitignore vendored
View File

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

View File

@@ -15,21 +15,21 @@ pub fn build(b: *std.Build) void {
// set a preferred release mode, allowing the user to decide how to optimize.
const optimize = b.standardOptimizeOption(.{});
_ = b.addModule("gdbstub", .{ .root_source_file = .{ .path = "src/lib.zig" } });
_ = b.addModule("zba-gdbstub", .{ .root_source_file = b.path("src/lib.zig") });
// Creates a step for unit testing. This only builds the test executable
// but does not run it.
const tests = b.addTest(.{
.root_source_file = .{ .path = "src/lib.zig" },
const lib_unit_tests = b.addTest(.{
.root_source_file = b.path("src/lib.zig"),
.target = target,
.optimize = optimize,
});
const run_tests = b.addRunArtifact(tests);
const run_lib_unit_tests = b.addRunArtifact(lib_unit_tests);
// This creates a build step. It will be visible in the `zig build --help` menu,
// and can be selected like this: `zig build test`
// This will evaluate the `test` step rather than the default, which is "install".
const test_step = b.step("test", "Run library tests");
test_step.dependOn(&run_tests.step);
// Similar to creating the run step earlier, this exposes a `test` step to
// the `zig build --help` menu, providing a way for the user to request
// running the unit tests.
const test_step = b.step("test", "Run unit tests");
test_step.dependOn(&run_lib_unit_tests.step);
}

View File

@@ -1,9 +1,72 @@
.{
// 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.1.0",
// This field is optional.
// This is currently advisory only; Zig does not yet do anything
// with this value.
//.minimum_zig_version = "0.11.0",
// 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.
// .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",
},
}

View File

@@ -195,12 +195,19 @@ pub fn parse(self: *Self, allocator: Allocator, state: *Server.State, emu: *Emul
},
'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,11 +215,19 @@ pub fn parse(self: *Self, allocator: Allocator, state: *Server.State, emu: *Emul
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 };
}
@@ -249,6 +264,8 @@ pub fn parse(self: *Self, allocator: Allocator, state: *Server.State, emu: *Emul
}
if (substr(self.contents[1..], "Xfer:memory-map:read")) {
const mem_map = state.memmap_xml.?;
var tokens = std.mem.tokenize(u8, self.contents[1..], ":,");
_ = tokens.next(); // Xfer
_ = tokens.next(); // memory-map
@@ -260,11 +277,11 @@ pub fn parse(self: *Self, allocator: Allocator, state: *Server.State, emu: *Emul
const length = try std.fmt.parseInt(usize, length_str, 16);
// see above
const len = @min(length, (state.memmap_xml.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';
@memcpy(ret[1..], state.memmap_xml[offset..]);
@memcpy(ret[1..], mem_map[offset..]);
return .{ .alloc = ret };
}

View File

@@ -3,8 +3,7 @@ const Packet = @import("Packet.zig");
const Emulator = @import("lib.zig").Emulator;
const Allocator = std.mem.Allocator;
const Server = std.net.StreamServer;
const Connection = Server.Connection;
const Server = std.net.Server;
const Self = @This();
const log = std.log.scoped(.Server);
@@ -21,18 +20,17 @@ emu: Emulator,
pub const State = struct {
should_quit: bool = false,
target_xml: []const u8,
memmap_xml: []const u8,
memmap_xml: ?[]const u8,
};
const Xml = struct { target: []const u8, memory_map: []const u8 };
const Xml = struct { target: []const u8, memory_map: ?[]const u8 };
pub fn init(emulator: Emulator, xml: Xml) !Self {
var server = std.net.StreamServer.init(.{});
try server.listen(std.net.Address.initIp4(.{ 127, 0, 0, 1 }, port));
const localhost = std.net.Address.initIp4(.{ 127, 0, 0, 1 }, port);
return .{
.emu = emulator,
.socket = server,
.socket = try localhost.listen(.{}),
.state = .{ .target_xml = xml.target, .memmap_xml = xml.memory_map },
};
}
@@ -58,11 +56,11 @@ pub fn run(self: *Self, allocator: Allocator, should_quit: *std.atomic.Value(boo
var client = try self.socket.accept();
log.info("client connected from {}", .{client.address});
while (!should_quit.load(.Monotonic)) {
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);
should_quit.store(true, .monotonic);
break;
}