1 Commits

7 changed files with 382 additions and 470 deletions

182
build.zig
View File

@@ -1,121 +1,72 @@
const std = @import("std"); const std = @import("std");
// Although this function looks imperative, it does not perform the build // Although this function looks imperative, note that its job is to
// directly and instead it mutates the build graph (`b`) that will be then // declaratively construct a build graph that will be executed by an external
// executed by an external runner. The functions in `std.Build` implement a DSL // runner.
// 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 { pub fn build(b: *std.Build) void {
// Standard target options allow the person running `zig build` to choose // Standard target options allows the person running `zig build` to choose
// what target to build for. Here we do not override the defaults, which // 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 // means any target is allowed, and the default is native. Other options
// for restricting supported target set are available. // for restricting supported target set are available.
const target = b.standardTargetOptions(.{}); const target = b.standardTargetOptions(.{});
// Standard optimization options allow the person running `zig build` to select // Standard optimization options allow the person running `zig build` to select
// between Debug, ReleaseSafe, ReleaseFast, and ReleaseSmall. Here we do not // between Debug, ReleaseSafe, ReleaseFast, and ReleaseSmall. Here we do not
// set a preferred release mode, allowing the user to decide how to optimize. // set a preferred release mode, allowing the user to decide how to optimize.
const optimize = b.standardOptimizeOption(.{}); const optimize = b.standardOptimizeOption(.{});
// It's also possible to define more custom flags to toggle optional features
// of this build script using `b.option()`. All defined flags (including
// target and optimize options) will be listed when running `zig build --help`
// in this directory.
// This creates a module, which represents a collection of source files alongside const lib_mod = b.createModule(.{
// 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("zaprus", .{
// 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/root.zig"), .root_source_file = b.path("src/root.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, .target = target,
.optimize = optimize,
}); });
mod.addImport("network", b.dependency("network", .{}).module("network")); // We will also create a module for our other entry point, 'main.zig'.
mod.addImport("gatorcat", b.dependency("gatorcat", .{}).module("gatorcat")); const exe_mod = b.createModule(.{
// `root_source_file` is the Zig "entry point" of the module. If a module
// only contains e.g. external object files, you can make this `null`.
// In this case the main source file is merely a path, however, in more
// complicated build scripts, this could be a generated file.
.root_source_file = b.path("src/main.zig"),
.target = target,
.optimize = optimize,
});
// Here we define an executable. An executable needs to have a root module lib_mod.addImport("network", b.dependency("network", .{}).module("network"));
// which needs to expose a `main` function. While we could add a main function lib_mod.addImport("gatorcat", b.dependency("gatorcat", .{}).module("gatorcat"));
// to the module defined above, it's sometimes preferable to split business
// business logic and the CLI into two separate modules. exe_mod.addImport("zaprus", lib_mod);
// exe_mod.addImport("clap", b.dependency("clap", .{}).module("clap"));
// If your goal is to create a Zig library for others to use, consider if
// it might benefit from also exposing a CLI tool. A parser library for a const lib = b.addLibrary(.{
// data serialization format could also bundle a CLI syntax checker, for example. .linkage = .static,
// .name = "zaprus",
// If instead your goal is to create an executable, consider if users might .root_module = lib_mod,
// be interested in also being able to embed the core functionality of your });
// program in their own executable in order to avoid the overhead involved in
// subprocessing your CLI tool. b.installArtifact(lib);
//
// If neither case applies to you, feel free to delete the declaration you // This creates another `std.Build.Step.Compile`, but this one builds an executable
// don't need and to put everything under a single module. // rather than a static library.
const exe = b.addExecutable(.{ const exe = b.addExecutable(.{
.name = "zaprus", .name = "zaprus",
.root_module = b.createModule(.{ .root_module = exe_mod,
// b.createModule defines a new module just like b.addModule but,
// unlike b.addModule, it does not expose the module to consumers of
// this package, which is why in this case we don't have to give it a name.
.root_source_file = b.path("src/main.zig"),
// Target and optimization levels must be explicitly wired in when
// defining an executable or library (in the root module), and you
// can also hardcode a specific target for an executable or library
// definition if desireable (e.g. firmware for embedded devices).
.target = target,
.optimize = optimize,
// List of modules available for import in source files part of the
// root module.
.imports = &.{
// Here "zaprus" is the name you will use in your source code to
// import this module (e.g. `@import("zaprus")`). The name is
// repeated because you are allowed to rename your imports, which
// can be extremely useful in case of collisions (which can happen
// importing modules from different packages).
.{ .name = "zaprus", .module = mod },
.{ .name = "clap", .module = b.dependency("clap", .{}).module("clap") },
},
}),
}); });
// This declares intent for the executable to be installed into the // This declares intent for the executable to be installed into the
// install prefix when running `zig build` (i.e. when executing the default // standard location when the user invokes the "install" step (the default
// step). By default the install prefix is `zig-out/` but can be overridden // step when running `zig build`).
// by passing `--prefix` or `-p`.
b.installArtifact(exe); b.installArtifact(exe);
b.installArtifact(b.addLibrary(.{
.linkage = .static,
.name = "zaprus",
.root_module = mod,
}));
// This creates a top level step. Top level steps have a name and can be // This *creates* a Run step in the build graph, to be executed when another
// invoked by name when running `zig build` (e.g. `zig build run`). // step is evaluated that depends on it. The next line below will establish
// This will evaluate the `run` step rather than the default step. // such a dependency.
// For a top level step to actually do something, it must depend on other
// steps (e.g. a Run step, as we will see in a moment).
const run_step = b.step("run", "Run the app");
// This creates a RunArtifact step in the build graph. A RunArtifact step
// invokes an executable compiled by Zig. Steps will only be executed by the
// runner if invoked directly by the user (in the case of top level steps)
// or if another step depends on it, so it's up to you to define when and
// how this Run step will be executed. In our case we want to run it when
// the user runs `zig build run`, so we create a dependency link.
const run_cmd = b.addRunArtifact(exe); const run_cmd = b.addRunArtifact(exe);
run_step.dependOn(&run_cmd.step);
// By making the run step depend on the default step, it will be run from the // By making the run step depend on the install step, it will be run from the
// installation directory rather than directly from within the cache directory. // installation directory rather than directly from within the cache directory.
// This is not necessary, however, if the application depends on other installed
// files, this ensures they will be present and in the expected location.
run_cmd.step.dependOn(b.getInstallStep()); run_cmd.step.dependOn(b.getInstallStep());
// This allows the user to pass arguments to the application in the build // This allows the user to pass arguments to the application in the build
@@ -124,42 +75,21 @@ pub fn build(b: *std.Build) void {
run_cmd.addArgs(args); run_cmd.addArgs(args);
} }
// Creates an executable that will run `test` blocks from the provided module. // This creates a build step. It will be visible in the `zig build --help` menu,
// Here `mod` needs to define a target, which is why earlier we made sure to // and can be selected like this: `zig build run`
// set the releative field. // This will evaluate the `run` step rather than the default, which is "install".
const mod_tests = b.addTest(.{ const run_step = b.step("run", "Run the app");
.root_module = mod, run_step.dependOn(&run_cmd.step);
const exe_unit_tests = b.addTest(.{
.root_module = exe_mod,
}); });
// A run step that will run the test executable. const run_exe_unit_tests = b.addRunArtifact(exe_unit_tests);
const run_mod_tests = b.addRunArtifact(mod_tests);
// Creates an executable that will run `test` blocks from the executable's // Similar to creating the run step earlier, this exposes a `test` step to
// root module. Note that test executables only test one module at a time, // the `zig build --help` menu, providing a way for the user to request
// hence why we have to create two separate ones. // running the unit tests.
const exe_tests = b.addTest(.{ const test_step = b.step("test", "Run unit tests");
.root_module = exe.root_module, test_step.dependOn(&run_exe_unit_tests.step);
});
// A run step that will run the second test executable.
const run_exe_tests = b.addRunArtifact(exe_tests);
// 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);
test_step.dependOn(&run_exe_tests.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.
} }

View File

@@ -37,16 +37,16 @@
// internet connectivity. // internet connectivity.
.dependencies = .{ .dependencies = .{
.network = .{ .network = .{
.url = "git+https://github.com/ikskuh/zig-network#7947237eec317d9458897f82089f343a05450c2b", .url = "https://github.com/ikskuh/zig-network/archive/c76240d2240711a3dcbf1c0fb461d5d1f18be79a.zip",
.hash = "network-0.1.0-Pm-Agl8xAQBmkwohveGOfTk4zQnuqDs0Ptfbms4KP5Ce", .hash = "network-0.1.0-AAAAAOwlAQAQ6zKPUrsibdpGisxld9ftUKGdMvcCSpaj",
}, },
.clap = .{ .clap = .{
.url = "git+https://github.com/Hejsil/zig-clap#9cfa61596cd44ef7be35f8d2e108d2025e09868e", .url = "git+https://github.com/Hejsil/zig-clap?ref=0.10.0#e47028deaefc2fb396d3d9e9f7bd776ae0b2a43a",
.hash = "clap-0.10.0-oBajB_TnAQB0l5UdW9WYhhJDEswbedvwFOzzZwGknYeR", .hash = "clap-0.10.0-oBajB434AQBDh-Ei3YtoKIRxZacVPF1iSwp3IX_ZB8f0",
}, },
.gatorcat = .{ .gatorcat = .{
.url = "git+https://github.com/jeffective/gatorcat#db73d0f7780331d82e785e85773d1afaf154c2e6", .url = "git+https://github.com/kj4tmp/gatorcat#bb1847f6c95852e7a0ec8c07870a948c171d5f98",
.hash = "gatorcat-0.3.11-WcrpTQn0BwArrCFVHy9FPBIPDJQqPrFdJlhiyH7Ng5x4", .hash = "gatorcat-0.3.2-WcrpTf1mBwDrmPaIhKCfLJO064v8Sjjn7DBq4CKZSgHH",
}, },
}, },
.paths = .{ .paths = .{

View File

@@ -1,84 +1,22 @@
const base64Enc = std.base64.Base64Encoder.init(std.base64.standard_alphabet_chars, '='); var rand: ?Random = null;
const base64Dec = std.base64.Base64Decoder.init(std.base64.standard_alphabet_chars, '=');
rand: Random, pub fn init() !void {
writer: *std.Io.Writer,
const Self = @This();
const max_message_size = 2048;
pub fn init(writer: *std.Io.Writer) !Self {
var prng = Random.DefaultPrng.init(blk: { var prng = Random.DefaultPrng.init(blk: {
var seed: u64 = undefined; var seed: u64 = undefined;
try posix.getrandom(mem.asBytes(&seed)); try posix.getrandom(mem.asBytes(&seed));
break :blk seed; break :blk seed;
}); });
const rand = prng.random(); rand = prng.random();
try network.init();
return .{
.rand = rand,
.writer = writer,
};
} }
pub fn deinit(self: *Self) void { pub fn deinit() void {
self.writer.flush() catch {}; network.deinit();
} }
/// Used for relay messages and connection handshake. fn broadcastSaprusMessage(msg: SaprusMessage, udp_port: u16, allocator: Allocator) !void {
/// Assumes Client .init has been called. const msg_bytes = try msg.toBytes(allocator);
fn broadcastInitialInterestMessage(self: *Self, msg_bytes: []align(@alignOf(SaprusMessage)) u8) !void { defer allocator.free(msg_bytes);
var packet_bytes: [max_message_size]u8 = comptime blk: {
var b: [max_message_size]u8 = @splat(0);
// Destination MAC addr to FF:FF:FF:FF:FF:FF
for (0..6) |i| {
b[i] = 0xff;
}
// Set Ethernet type to IPv4
b[0x0c] = 0x08;
b[0x0d] = 0x00;
// Set IPv4 version to 4
b[0x0e] = 0x45;
// Destination broadcast
for (0x1e..0x22) |i| {
b[i] = 0xff;
}
// Set TTL
b[0x16] = 0x40;
// Set IPv4 protocol to UDP
b[0x17] = 0x11;
// Set interest filter value to 8888.
b[0x24] = 0x22;
b[0x25] = 0xb8;
break :blk b;
};
var msg: *SaprusMessage = try .bytesAsValue(msg_bytes);
try msg.networkFromNativeEndian();
defer msg.nativeFromNetworkEndian() catch unreachable;
// The byte position within the packet that the saprus message starts at.
const saprus_start_byte = 42;
@memcpy(packet_bytes[saprus_start_byte .. saprus_start_byte + msg_bytes.len], msg_bytes);
const writer = self.writer;
_ = try writer.write(packet_bytes[0 .. saprus_start_byte + msg_bytes.len]);
try writer.flush();
}
// fn broadcastSaprusMessage(msg_bytes: []align(@alignOf(SaprusMessage)) u8) !void {}
fn broadcastSaprusMessage(msg_bytes: []align(@alignOf(SaprusMessage)) u8, udp_port: u16) !void {
const msg: *SaprusMessage = try .bytesAsValue(msg_bytes);
try msg.networkFromNativeEndian();
defer msg.nativeFromNetworkEndian() catch unreachable;
var sock = try network.Socket.create(.ipv4, .udp); var sock = try network.Socket.create(.ipv4, .udp);
defer sock.close(); defer sock.close();
@@ -98,57 +36,57 @@ fn broadcastSaprusMessage(msg_bytes: []align(@alignOf(SaprusMessage)) u8, udp_po
try sock.bind(bind_addr); try sock.bind(bind_addr);
std.debug.print("{x}\n", .{msg_bytes});
_ = try sock.sendTo(dest_addr, msg_bytes); _ = try sock.sendTo(dest_addr, msg_bytes);
} }
pub fn sendRelay(self: *Self, payload: []const u8, dest: [4]u8) !void { pub fn sendRelay(payload: []const u8, dest: [4]u8, allocator: Allocator) !void {
var buf: [max_message_size]u8 align(@alignOf(SaprusMessage)) = undefined; const msg = SaprusMessage{
const msg_bytes = buf[0..try SaprusMessage.calcSize( .relay = .{
.relay, .header = .{ .dest = dest },
base64Enc.calcSize(payload.len), .payload = payload,
)]; },
const msg: *SaprusMessage = .init(.relay, msg_bytes); };
const relay = (try msg.getSaprusTypePayload()).relay; try broadcastSaprusMessage(msg, 8888, allocator);
relay.dest = dest;
_ = base64Enc.encode(relay.getPayload(), payload);
try self.broadcastInitialInterestMessage(msg_bytes);
} }
fn randomPort(self: Self) u16 { fn randomPort() u16 {
return self.rand.intRangeAtMost(u16, 1024, 65000); var p: u16 = 0;
if (rand) |r| {
p = r.intRangeAtMost(u16, 1024, 65000);
} else unreachable;
return p;
} }
pub fn sendInitialConnection( pub fn sendInitialConnection(payload: []const u8, initial_port: u16, allocator: Allocator) !SaprusMessage {
self: Self, const dest_port = randomPort();
payload: []const u8, const msg = SaprusMessage{
output_bytes: []align(@alignOf(SaprusMessage)) u8, .connection = .{
initial_port: u16, .header = .{
) !*SaprusMessage { .src_port = initial_port,
const dest_port = self.randomPort(); .dest_port = dest_port,
const msg_bytes = output_bytes[0..try SaprusMessage.calcSize( },
.connection, .payload = payload,
base64Enc.calcSize(payload.len), },
)]; };
const msg: *SaprusMessage = .init(.connection, msg_bytes);
const connection = (try msg.getSaprusTypePayload()).connection; try broadcastSaprusMessage(msg, 8888, allocator);
connection.src_port = initial_port;
connection.dest_port = dest_port;
_ = base64Enc.encode(connection.getPayload(), payload);
try broadcastSaprusMessage(msg_bytes, 8888);
return msg; return msg;
} }
pub fn connect(self: Self, payload: []const u8) !?SaprusConnection { pub fn connect(payload: []const u8, allocator: Allocator) !?SaprusConnection {
const initial_port = self.randomPort(); var foo: gcat.nic.RawSocket = try .init("enp7s0"); // /proc/net/dev
defer foo.deinit();
var initial_conn_res: ?*SaprusMessage = null; var initial_port: u16 = 0;
if (rand) |r| {
initial_port = r.intRangeAtMost(u16, 1024, 65000);
} else unreachable;
var initial_conn_res: ?SaprusMessage = null;
errdefer if (initial_conn_res) |c| c.deinit(allocator);
var sock = try network.Socket.create(.ipv4, .udp); var sock = try network.Socket.create(.ipv4, .udp);
defer sock.close(); defer sock.close();
@@ -163,17 +101,16 @@ pub fn connect(self: Self, payload: []const u8) !?SaprusConnection {
try sock.setReadTimeout(1 * std.time.us_per_s); try sock.setReadTimeout(1 * std.time.us_per_s);
try sock.bind(bind_addr); try sock.bind(bind_addr);
var sent_msg_bytes: [max_message_size]u8 align(@alignOf(SaprusMessage)) = undefined; const msg = try sendInitialConnection(payload, initial_port, allocator);
const msg = try self.sendInitialConnection(payload, &sent_msg_bytes, initial_port);
var response_buf: [max_message_size]u8 align(@alignOf(SaprusMessage)) = undefined; var response_buf: [4096]u8 = undefined;
_ = try sock.receive(&response_buf); // Ignore message that I sent. _ = try sock.receive(&response_buf); // Ignore message that I sent.
const len = try sock.receive(&response_buf); const len = try sock.receive(&response_buf);
initial_conn_res = try .networkBytesAsValue(response_buf[0..len]); initial_conn_res = try SaprusMessage.fromBytes(response_buf[0..len], allocator);
// Complete handshake after awaiting response // Complete handshake after awaiting response
try broadcastSaprusMessage(msg.asBytes(), self.randomPort()); try broadcastSaprusMessage(msg, randomPort(), allocator);
if (false) { if (false) {
return initial_conn_res.?; return initial_conn_res.?;
@@ -190,3 +127,6 @@ const posix = std.posix;
const mem = std.mem; const mem = std.mem;
const network = @import("network"); const network = @import("network");
const gcat = @import("gatorcat");
const Allocator = mem.Allocator;

View File

@@ -1,45 +0,0 @@
const std = @import("std");
const gcat = @import("gatorcat");
const Writer = @This();
const assert = std.debug.assert;
interface: std.Io.Writer,
socket: gcat.nic.RawSocket,
alloc: std.mem.Allocator,
fn drain(io_w: *std.Io.Writer, data: []const []const u8, splat: usize) std.Io.Writer.Error!usize {
const w: *Writer = @alignCast(@fieldParentPtr("interface", io_w));
const buffered = io_w.buffered();
var res: usize = 0;
if (buffered.len > 0) {
w.socket.linkLayer().send(buffered) catch return error.WriteFailed;
_ = io_w.consumeAll();
}
for (data[0 .. data.len - 1]) |d| {
w.socket.linkLayer().send(d) catch return error.WriteFailed;
res += d.len;
}
if (splat > 0 and data[data.len - 1].len > 0) {
var splatBuffer: std.ArrayList(u8) = .empty;
defer splatBuffer.deinit(w.alloc);
for (0..splat) |_| {
splatBuffer.appendSlice(w.alloc, data[data.len - 1]) catch return error.WriteFailed;
}
w.socket.linkLayer().send(splatBuffer.items) catch return error.WriteFailed;
}
return res;
}
pub fn init(interface_name: [:0]const u8, buffer: []u8, alloc: std.mem.Allocator) !Writer {
return .{
.interface = .{
.vtable = &.{ .drain = drain },
.buffer = buffer,
},
.socket = try .init(interface_name),
.alloc = alloc,
};
}

View File

@@ -37,37 +37,35 @@ pub fn main() !void {
.allocator = gpa, .allocator = gpa,
}) catch |err| { }) catch |err| {
// Report useful error and exit. // Report useful error and exit.
try diag.reportToFile(.stderr(), err); diag.report(std.io.getStdErr().writer(), err) catch {};
return err; return err;
}; };
defer res.deinit(); defer res.deinit();
if (res.args.help != 0) { try SaprusClient.init();
return clap.helpToFile(.stderr(), clap.Help, &params, .{}); defer SaprusClient.deinit();
}
var sock_buffer: [2048]u8 = undefined; if (res.args.help != 0) {
var rawSocketWriter: RawSocketWriter = try .init("enp7s0", &sock_buffer, gpa); // /proc/net/dev return clap.help(std.io.getStdErr().writer(), clap.Help, &params, .{});
var client = try SaprusClient.init(&rawSocketWriter.interface); }
defer client.deinit();
if (res.args.relay) |r| { if (res.args.relay) |r| {
const dest = parseDest(res.args.dest); const dest = parseDest(res.args.dest);
try client.sendRelay( try SaprusClient.sendRelay(
if (r.len > 0) r else "Hello darkness my old friend", if (r.len > 0) r else "Hello darkness my old friend",
dest, dest,
gpa,
); );
// std.debug.print("Sent: {s}\n", .{r}); // std.debug.print("Sent: {s}\n", .{r});
return; return;
} else if (res.args.connect) |c| { } else if (res.args.connect) |c| {
_ = client.connect(if (c.len > 0) c else "Hello darkness my old friend") catch |err| switch (err) { _ = SaprusClient.connect(if (c.len > 0) c else "Hello darkness my old friend", gpa) catch |err| switch (err) {
error.WouldBlock => null, error.WouldBlock => null,
else => return err, else => return err,
}; };
return;
} }
return clap.helpToFile(.stderr(), clap.Help, &params, .{}); return clap.help(std.io.getStdErr().writer(), clap.Help, &params, .{});
} }
fn parseDest(in: ?[]const u8) [4]u8 { fn parseDest(in: ?[]const u8) [4]u8 {
@@ -92,6 +90,5 @@ const ArrayList = std.ArrayList;
const zaprus = @import("zaprus"); const zaprus = @import("zaprus");
const SaprusClient = zaprus.Client; const SaprusClient = zaprus.Client;
const SaprusMessage = zaprus.Message; const SaprusMessage = zaprus.Message;
const RawSocketWriter = zaprus.RawSocketWriter;
const clap = @import("clap"); const clap = @import("clap");

View File

@@ -1,3 +1,6 @@
const base64Enc = std.base64.Base64Encoder.init(std.base64.standard_alphabet_chars, '=');
const base64Dec = std.base64.Base64Decoder.init(std.base64.standard_alphabet_chars, '=');
/// Type tag for Message union. /// Type tag for Message union.
/// This is the first value in the actual packet sent over the network. /// This is the first value in the actual packet sent over the network.
pub const PacketType = enum(u16) { pub const PacketType = enum(u16) {
@@ -20,25 +23,43 @@ pub const ConnectionOptions = packed struct(u8) {
opt8: bool = false, opt8: bool = false,
}; };
pub const MessageTypeError = error{ pub const Error = error{
NotImplementedSaprusType, NotImplementedSaprusType,
UnknownSaprusType, UnknownSaprusType,
};
pub const MessageParseError = MessageTypeError || error{
InvalidMessage, InvalidMessage,
}; };
// ZERO COPY STUFF // ZERO COPY STUFF
// &payload could be a void value that is treated as a pointer to a [*]u8 // &payload could be a void value that is treated as a pointer to a [*]u8
/// All Saprus messages pub const ZeroCopyMessage = packed struct {
pub const Message = packed struct {
const Relay = packed struct { const Relay = packed struct {
dest: @Vector(4, u8), dest: @Vector(4, u8),
payload: void, payload: void,
pub fn getPayload(self: *align(1) Relay) []u8 { pub fn getPayload(self: *align(@alignOf(ZeroCopyMessage)) Relay) []u8 {
const len: *u16 = @ptrFromInt(@intFromPtr(self) - @sizeOf(u16)); // Cast the 'self' pointer (which points to the Relay header,
return @as([*]u8, @ptrCast(&self.payload))[0 .. len.* - @bitSizeOf(Relay) / 8]; // located at the same memory as the parent's 'bytes' field)
// to a pointer to void, as required by @fieldParentPtr for a void field.
// Preserve the known alignment.
const self_as_void_ptr: *align(@alignOf(ZeroCopyMessage)) void = @ptrCast(self);
// Cast the resulting *void pointer to the parent type *ZeroCopyMessage.
// This cast performs the necessary alignment check.
const parent: *ZeroCopyMessage = @alignCast(@fieldParentPtr("bytes", self_as_void_ptr));
// The 'length' field in the parent ZeroCopyMessage contains
// the size of the header (Relay) + payload length.
const total_len = parent.length;
// Payload length = total_len - size of the Relay header
const payload_len = total_len - @sizeOf(Relay);
// The payload starts immediately after the fixed fields of the Relay struct.
// The address of the 'payload' field represents this starting point.
const payload_start_ptr: [*]u8 = @ptrCast(&self.payload);
// Return a slice from the payload start address with the calculated length.
return payload_start_ptr[0..payload_len];
} }
}; };
const Connection = packed struct { const Connection = packed struct {
@@ -52,17 +73,17 @@ pub const Message = packed struct {
pub fn getPayload(self: *align(1) Connection) []u8 { pub fn getPayload(self: *align(1) Connection) []u8 {
const len: *u16 = @ptrFromInt(@intFromPtr(self) - @sizeOf(u16)); const len: *u16 = @ptrFromInt(@intFromPtr(self) - @sizeOf(u16));
return @as([*]u8, @ptrCast(&self.payload))[0 .. len.* - @bitSizeOf(Connection) / 8]; return @as([*]u8, @ptrCast(&self.payload))[0 .. len.* - @sizeOf(Connection)];
} }
fn nativeFromNetworkEndian(self: *align(1) Connection) void { fn nativeFromNetworkEndian(self: *align(1) Connection) Error!void {
self.src_port = bigToNative(@TypeOf(self.src_port), self.src_port); self.src_port = bigToNative(@TypeOf(self.src_port), self.src_port);
self.dest_port = bigToNative(@TypeOf(self.dest_port), self.dest_port); self.dest_port = bigToNative(@TypeOf(self.dest_port), self.dest_port);
self.seq_num = bigToNative(@TypeOf(self.seq_num), self.seq_num); self.seq_num = bigToNative(@TypeOf(self.seq_num), self.seq_num);
self.msg_id = bigToNative(@TypeOf(self.msg_id), self.msg_id); self.msg_id = bigToNative(@TypeOf(self.msg_id), self.msg_id);
} }
fn networkFromNativeEndian(self: *align(1) Connection) void { fn networkFromNativeEndian(self: *align(1) Connection) Error!void {
self.src_port = nativeToBig(@TypeOf(self.src_port), self.src_port); self.src_port = nativeToBig(@TypeOf(self.src_port), self.src_port);
self.dest_port = nativeToBig(@TypeOf(self.dest_port), self.dest_port); self.dest_port = nativeToBig(@TypeOf(self.dest_port), self.dest_port);
self.seq_num = nativeToBig(@TypeOf(self.seq_num), self.seq_num); self.seq_num = nativeToBig(@TypeOf(self.seq_num), self.seq_num);
@@ -71,87 +92,70 @@ pub const Message = packed struct {
}; };
const Self = @This(); const Self = @This();
const SelfBytes = []align(@alignOf(Self)) u8;
type: PacketType, type: PacketType,
length: u16, length: u16,
bytes: void = {}, bytes: void = {},
/// Takes a byte slice, and returns a Message struct backed by the slice. pub fn init(allocator: Allocator, comptime @"type": PacketType, payload_len: u16) !*Self {
/// This properly initializes the top level headers within the slice. const header_size = @sizeOf(switch (@"type") {
/// This is used for creating new messages. For reading messages from the network, .relay => Relay,
/// see: networkBytesAsValue. .connection => Connection,
pub fn init(@"type": PacketType, bytes: []align(@alignOf(Self)) u8) *Self { else => return error.Bad,
std.debug.assert(bytes.len >= @sizeOf(Self)); });
const size = payload_len + @sizeOf(Self) + header_size;
const bytes = try allocator.alignedAlloc(u8, @alignOf(Self), size);
const res: *Self = @ptrCast(bytes.ptr); const res: *Self = @ptrCast(bytes.ptr);
res.type = @"type"; res.type = @"type";
res.length = @intCast(bytes.len - @sizeOf(Self)); res.length = payload_len + header_size;
return res; return res;
} }
/// Compute the number of bytes required to store a given payload size for a given message type. pub fn deinit(self: *Self, allocator: Allocator) void {
pub fn calcSize(comptime @"type": PacketType, payload_len: usize) MessageTypeError!u16 { allocator.free(self.asBytes());
const header_size = @bitSizeOf(switch (@"type") {
.relay => Relay,
.connection => Connection,
.file_transfer => return MessageTypeError.NotImplementedSaprusType,
else => return MessageTypeError.UnknownSaprusType,
}) / 8;
return @intCast(payload_len + @sizeOf(Self) + header_size);
} }
fn getRelay(self: *Self) *align(1) Relay { fn getRelay(self: *Self) *align(@alignOf(Self)) Relay {
return std.mem.bytesAsValue(Relay, &self.bytes); return std.mem.bytesAsValue(Relay, &self.bytes);
} }
fn getConnection(self: *Self) *align(1) Connection { fn getConnection(self: *Self) *align(@alignOf(Self)) Connection {
return std.mem.bytesAsValue(Connection, &self.bytes); return std.mem.bytesAsValue(Connection, &self.bytes);
} }
/// Access the message Saprus payload. pub fn getSaprusTypePayload(self: *Self) Error!(union(PacketType) {
pub fn getSaprusTypePayload(self: *Self) MessageTypeError!(union(PacketType) { relay: *align(@alignOf(Self)) Relay,
relay: *align(1) Relay,
file_transfer: void, file_transfer: void,
connection: *align(1) Connection, connection: *align(@alignOf(Self)) Connection,
}) { }) {
return switch (self.type) { return switch (self.type) {
.relay => .{ .relay = self.getRelay() }, .relay => .{ .relay = self.getRelay() },
.connection => .{ .connection = self.getConnection() }, .connection => .{ .connection = self.getConnection() },
.file_transfer => MessageTypeError.NotImplementedSaprusType, .file_transfer => Error.NotImplementedSaprusType,
else => MessageTypeError.UnknownSaprusType, else => Error.UnknownSaprusType,
}; };
} }
/// Convert the message to native endianness from network endianness in-place. pub fn nativeFromNetworkEndian(self: *Self) Error!void {
pub fn nativeFromNetworkEndian(self: *Self) MessageTypeError!void {
self.type = @enumFromInt(bigToNative( self.type = @enumFromInt(bigToNative(
@typeInfo(@TypeOf(self.type)).@"enum".tag_type, @typeInfo(@TypeOf(self.type)).@"enum".tag_type,
@intFromEnum(self.type), @intFromEnum(self.type),
)); ));
self.length = bigToNative(@TypeOf(self.length), self.length); self.length = bigToNative(@TypeOf(self.length), self.length);
errdefer {
// If the payload specific headers fail, revert the top level header values
self.type = @enumFromInt(nativeToBig(
@typeInfo(@TypeOf(self.type)).@"enum".tag_type,
@intFromEnum(self.type),
));
self.length = nativeToBig(@TypeOf(self.length), self.length);
}
switch (try self.getSaprusTypePayload()) { switch (try self.getSaprusTypePayload()) {
.relay => {}, .relay => {},
.connection => |*con| con.*.nativeFromNetworkEndian(), .connection => |*con| try con.*.nativeFromNetworkEndian(),
// We know other values are unreachable, // We know other values are unreachable,
// because they would have returned an error from the switch condition. // because they would have returned an error from the switch condition.
else => unreachable, else => unreachable,
} }
} }
/// Convert the message to network endianness from native endianness in-place. pub fn networkFromNativeEndian(self: *Self) Error!void {
pub fn networkFromNativeEndian(self: *Self) MessageTypeError!void {
try switch (try self.getSaprusTypePayload()) { try switch (try self.getSaprusTypePayload()) {
.relay => {}, .relay => {},
.connection => |*con| con.*.networkFromNativeEndian(), .connection => |*con| con.*.networkFromNativeEndian(),
.file_transfer => MessageTypeError.NotImplementedSaprusType, .file_transfer => Error.NotImplementedSaprusType,
else => MessageTypeError.UnknownSaprusType, else => Error.UnknownSaprusType,
}; };
self.type = @enumFromInt(nativeToBig( self.type = @enumFromInt(nativeToBig(
@typeInfo(@TypeOf(self.type)).@"enum".tag_type, @typeInfo(@TypeOf(self.type)).@"enum".tag_type,
@@ -160,106 +164,206 @@ pub const Message = packed struct {
self.length = nativeToBig(@TypeOf(self.length), self.length); self.length = nativeToBig(@TypeOf(self.length), self.length);
} }
/// Convert network endian bytes to a native endian value in-place. pub fn bytesAsValueUnchecked(bytes: []align(@alignOf(Self)) u8) *Self {
pub fn networkBytesAsValue(bytes: SelfBytes) MessageParseError!*Self { return std.mem.bytesAsValue(Self, bytes);
const res = std.mem.bytesAsValue(Self, bytes);
try res.nativeFromNetworkEndian();
return .bytesAsValue(bytes);
} }
/// Create a structured view of the bytes without initializing the length or type, pub fn bytesAsValue(bytes: []align(@alignOf(Self)) u8) !*Self {
/// and without converting the endianness. const res = bytesAsValueUnchecked(bytes);
pub fn bytesAsValue(bytes: SelfBytes) MessageParseError!*Self {
const res = std.mem.bytesAsValue(Self, bytes);
return switch (res.type) { return switch (res.type) {
.relay, .connection => if (bytes.len == res.length + @sizeOf(Self)) .relay, .connection => if (bytes.len == res.length + @sizeOf(Self))
res res
else else
MessageParseError.InvalidMessage, Error.InvalidMessage,
.file_transfer => MessageParseError.NotImplementedSaprusType, .file_transfer => Error.NotImplementedSaprusType,
else => MessageParseError.UnknownSaprusType, else => Error.UnknownSaprusType,
}; };
} }
/// Deprecated. pub fn asBytes(self: *Self) []align(@alignOf(Self)) u8 {
/// If I need the bytes, I should just pass around the slice that is backing this to begin with.
pub fn asBytes(self: *Self) SelfBytes {
const size = @sizeOf(Self) + self.length; const size = @sizeOf(Self) + self.length;
return @as([*]align(@alignOf(Self)) u8, @ptrCast(self))[0..size]; return @as([*]align(@alignOf(Self)) u8, @ptrCast(self))[0..size];
} }
}; };
test "testing variable length zero copy struct" { test "testing variable length zero copy struct" {
const gpa = std.testing.allocator;
const payload = "Hello darkness my old friend";
// Create a view of the byte slice as a ZeroCopyMessage
const zcm: *ZeroCopyMessage = try .init(gpa, .relay, payload.len);
defer zcm.deinit(gpa);
std.debug.print("outer: {*}\n", .{zcm});
{ {
// Relay test // Set the message values
const payload = "Hello darkness my old friend";
var msg_bytes: [try Message.calcSize(.relay, payload.len)]u8 align(@alignOf(Message)) = undefined;
// Create a view of the byte slice as a Message
const msg: *Message = .init(.relay, &msg_bytes);
{ {
// Set the message values // These are both set by the init call.
{ // zcm.type = .relay;
// These are both set by the init call. // zcm.length = payload_len;
// msg.type = .relay;
// msg.length = payload_len;
}
const relay = (try msg.getSaprusTypePayload()).relay;
relay.dest = .{ 1, 2, 3, 4 };
@memcpy(relay.getPayload(), payload);
} }
const relay = (try zcm.getSaprusTypePayload()).relay;
{ relay.dest = .{ 1, 2, 3, 4 };
// Print the message as hex using the network byte order @memcpy(relay.getPayload(), payload);
try msg.networkFromNativeEndian();
// We know the error from nativeFromNetworkEndian is unreachable because
// it would have returned an error from networkFromNativeEndian.
defer msg.nativeFromNetworkEndian() catch unreachable;
std.debug.print("relay network bytes: {x}\n", .{msg_bytes});
std.debug.print("bytes len: {d}\n", .{msg_bytes.len});
}
if (false) {
// Illegal behavior
std.debug.print("{any}\n", .{(try msg.getSaprusTypePayload()).connection});
}
try std.testing.expectEqualDeep(msg, try Message.bytesAsValue(msg.asBytes()));
} }
{ {
// Connection test const bytes = zcm.asBytes();
const payload = "Hello darkness my old friend";
var msg_bytes: [try Message.calcSize(.connection, payload.len)]u8 align(@alignOf(Message)) = undefined;
// Create a view of the byte slice as a Message // Print the message as hex using the network byte order
const msg: *Message = .init(.connection, &msg_bytes); try zcm.networkFromNativeEndian();
// We know the error from nativeFromNetworkEndian is unreachable because
{ // it would have returned an error from networkFromNativeEndian.
// Initializing connection header values defer zcm.nativeFromNetworkEndian() catch unreachable;
const connection = (try msg.getSaprusTypePayload()).connection; std.debug.print("network bytes: {x}\n", .{bytes});
connection.src_port = 1; std.debug.print("bytes len: {d}\n", .{bytes.len});
connection.dest_port = 2;
connection.seq_num = 3;
connection.msg_id = 4;
connection.reserved = 5;
connection.options = @bitCast(@as(u8, 6));
@memcpy(connection.getPayload(), payload);
}
{
// Print the message as hex using the network byte order
try msg.networkFromNativeEndian();
// We know the error from nativeFromNetworkEndian is unreachable because
// it would have returned an error from networkFromNativeEndian.
defer msg.nativeFromNetworkEndian() catch unreachable;
std.debug.print("connection network bytes: {x}\n", .{msg_bytes});
std.debug.print("bytes len: {d}\n", .{msg_bytes.len});
}
} }
if (false) {
// Illegal behavior
std.debug.print("{any}\n", .{(try zcm.getSaprusTypePayload()).connection});
}
try std.testing.expectEqualDeep(zcm, try ZeroCopyMessage.bytesAsValue(zcm.asBytes()));
} }
/// All Saprus messages
pub const Message = union(PacketType) {
pub const Relay = struct {
pub const Header = packed struct {
dest: @Vector(4, u8),
};
header: Header,
payload: []const u8,
};
pub const Connection = struct {
pub const Header = packed struct {
src_port: u16, // random number > 1024
dest_port: u16, // random number > 1024
seq_num: u32 = 0,
msg_id: u32 = 0,
reserved: u8 = 0,
options: ConnectionOptions = .{},
};
header: Header,
payload: []const u8,
};
relay: Relay,
file_transfer: void, // unimplemented
connection: Connection,
/// Should be called for any Message that was declared using a function that you pass an allocator to.
pub fn deinit(self: Message, allocator: Allocator) void {
switch (self) {
.relay => |r| allocator.free(r.payload),
.connection => |c| allocator.free(c.payload),
else => unreachable,
}
}
fn toBytesAux(
header: anytype,
payload: []const u8,
buf: *std.ArrayList(u8),
allocator: Allocator,
) !void {
const Header = @TypeOf(header);
// Create a growable string to store the base64 bytes in.
// Doing this first so I can use the length of the encoded bytes for the length field.
var payload_list = std.ArrayList(u8).init(allocator);
defer payload_list.deinit();
const buf_w = payload_list.writer();
// Write the payload bytes as base64 to the growable string.
try base64Enc.encodeWriter(buf_w, payload);
// At this point, payload_list contains the base64 encoded payload.
// Add the payload length to the output buf.
try buf.*.appendSlice(
asBytes(&nativeToBig(u16, @intCast(payload_list.items.len + @bitSizeOf(Header) / 8))),
);
// Add the header bytes to the output buf.
var header_buf: [@sizeOf(Header)]u8 = undefined;
var header_buf_stream = std.io.fixedBufferStream(&header_buf);
try header_buf_stream.writer().writeStructEndian(header, .big);
// Add the exact number of bits in the header without padding.
try buf.*.appendSlice(header_buf[0 .. @bitSizeOf(Header) / 8]);
try buf.*.appendSlice(payload_list.items);
}
/// Caller is responsible for freeing the returned bytes.
pub fn toBytes(self: Message, allocator: Allocator) ![]u8 {
// Create a growable list of bytes to store the output in.
var buf = std.ArrayList(u8).init(allocator);
errdefer buf.deinit();
// Start with writing the message type, which is the first 16 bits of every Saprus message.
try buf.appendSlice(asBytes(&nativeToBig(u16, @intFromEnum(self))));
// Write the proper header and payload for the given packet type.
switch (self) {
.relay => |r| try toBytesAux(r.header, r.payload, &buf, allocator),
.connection => |c| try toBytesAux(c.header, c.payload, &buf, allocator),
.file_transfer => return Error.NotImplementedSaprusType,
}
// Collect the growable list as a slice and return it.
return buf.toOwnedSlice();
}
fn fromBytesAux(
comptime packet: PacketType,
len: u16,
r: std.io.FixedBufferStream([]const u8).Reader,
allocator: Allocator,
) !Message {
const Header = @field(@FieldType(Message, @tagName(packet)), "Header");
// Read the header for the current message type.
var header_bytes: [@sizeOf(Header)]u8 = undefined;
_ = try r.read(header_bytes[0 .. @bitSizeOf(Header) / 8]);
var header_stream = std.io.fixedBufferStream(&header_bytes);
const header = try header_stream.reader().readStructEndian(Header, .big);
// Read the base64 bytes into a list to be able to call the decoder on it.
const payload_buf = try allocator.alloc(u8, len - @bitSizeOf(Header) / 8);
defer allocator.free(payload_buf);
_ = try r.readAll(payload_buf);
// Create a buffer to store the payload in, and decode the base64 bytes into the payload field.
const payload = try allocator.alloc(u8, try base64Dec.calcSizeForSlice(payload_buf));
try base64Dec.decode(payload, payload_buf);
// Return the type of Message specified by the `packet` argument.
return @unionInit(Message, @tagName(packet), .{
.header = header,
.payload = payload,
});
}
/// Caller is responsible for calling .deinit on the returned value.
pub fn fromBytes(bytes: []const u8, allocator: Allocator) !Message {
var s = std.io.fixedBufferStream(bytes);
const r = s.reader();
// Read packet type
const packet_type = @as(PacketType, @enumFromInt(try r.readInt(u16, .big)));
// Read the length of the header + base64 encoded payload.
const len = try r.readInt(u16, .big);
switch (packet_type) {
.relay => return fromBytesAux(.relay, len, r, allocator),
.connection => return fromBytesAux(.connection, len, r, allocator),
.file_transfer => return Error.NotImplementedSaprusType,
else => return Error.UnknownSaprusType,
}
}
};
const std = @import("std"); const std = @import("std");
const Allocator = std.mem.Allocator; const Allocator = std.mem.Allocator;
@@ -268,48 +372,42 @@ const nativeToBig = std.mem.nativeToBig;
const bigToNative = std.mem.bigToNative; const bigToNative = std.mem.bigToNative;
test "Round trip Relay toBytes and fromBytes" { test "Round trip Relay toBytes and fromBytes" {
if (false) { const gpa = std.testing.allocator;
const gpa = std.testing.allocator; const msg = Message{
const msg = Message{ .relay = .{
.relay = .{ .header = .{ .dest = .{ 255, 255, 255, 255 } },
.header = .{ .dest = .{ 255, 255, 255, 255 } }, .payload = "Hello darkness my old friend",
.payload = "Hello darkness my old friend", },
}, };
};
const to_bytes = try msg.toBytes(gpa); const to_bytes = try msg.toBytes(gpa);
defer gpa.free(to_bytes); defer gpa.free(to_bytes);
const from_bytes = try Message.fromBytes(to_bytes, gpa); const from_bytes = try Message.fromBytes(to_bytes, gpa);
defer from_bytes.deinit(gpa); defer from_bytes.deinit(gpa);
try std.testing.expectEqualDeep(msg, from_bytes); try std.testing.expectEqualDeep(msg, from_bytes);
}
return error.SkipZigTest;
} }
test "Round trip Connection toBytes and fromBytes" { test "Round trip Connection toBytes and fromBytes" {
if (false) { const gpa = std.testing.allocator;
const gpa = std.testing.allocator; const msg = Message{
const msg = Message{ .connection = .{
.connection = .{ .header = .{
.header = .{ .src_port = 0,
.src_port = 0, .dest_port = 0,
.dest_port = 0,
},
.payload = "Hello darkness my old friend",
}, },
}; .payload = "Hello darkness my old friend",
},
};
const to_bytes = try msg.toBytes(gpa); const to_bytes = try msg.toBytes(gpa);
defer gpa.free(to_bytes); defer gpa.free(to_bytes);
const from_bytes = try Message.fromBytes(to_bytes, gpa); const from_bytes = try Message.fromBytes(to_bytes, gpa);
defer from_bytes.deinit(gpa); defer from_bytes.deinit(gpa);
try std.testing.expectEqualDeep(msg, from_bytes); try std.testing.expectEqualDeep(msg, from_bytes);
}
return error.SkipZigTest;
} }
test { test {

View File

@@ -1,12 +1,4 @@
pub const Client = @import("Client.zig"); pub const Client = @import("Client.zig");
pub const Connection = @import("Connection.zig"); pub const Connection = @import("Connection.zig");
pub const RawSocketWriter = @import("RawSocketWriter.zig");
const msg = @import("message.zig"); pub usingnamespace @import("message.zig");
pub const PacketType = msg.PacketType;
pub const foo = msg.foo;
pub const ConnectionOptions = msg.ConnectionOptions;
pub const MessageTypeError = msg.MessageTypeError;
pub const MessageParseError = msg.MessageParseError;
pub const Message = msg.Message;