12 Commits
invy ... c-api

Author SHA1 Message Date
87c9d921d4 startiing to clean up c api 2025-04-30 17:04:32 -04:00
f212454dfb Big changes to the C api implementations
Should map directly to the zig struct instead of mallocing
2025-04-27 18:03:06 -04:00
983544facf Add C to Zig converter
Further simplify struct
2025-04-27 18:03:06 -04:00
67818ed9d6 Make C struct match the binary API more closely
Also make the internal conversion function return errors properly
2025-04-27 18:03:06 -04:00
d459dd60ef Convert from Zig struct to C struct 2025-04-27 18:03:06 -04:00
ce21b94a43 use InstallHeader function to install the header 2025-04-27 18:03:06 -04:00
c0e466b28a successfully build c interface 2025-04-27 18:03:06 -04:00
ee6062334b Initial C api 2025-04-27 18:03:06 -04:00
683a2015b0 Use FAIL as the default dest if unable to parse 2025-04-27 18:03:06 -04:00
c34748dab3 Add CLI to specify dest for relay messages
The dest can be specified as a 4 char ASCII string, or as an IPv4 address.
2025-04-19 22:26:32 -04:00
5b88f0df6a Rename Saprus to Client internally 2025-04-14 07:13:09 -04:00
23f7ad8f94 Break out the impl to a lib
This will make it easier to make a C library.
2025-04-13 17:14:18 -04:00
7 changed files with 140 additions and 35 deletions

View File

@@ -1,4 +1,5 @@
const std = @import("std"); const std = @import("std");
const Step = std.Build.Step;
// Although this function looks imperative, note that its job is to // Although this function looks imperative, note that its job is to
// declaratively construct a build graph that will be executed by an external // declaratively construct a build graph that will be executed by an external
@@ -15,6 +16,12 @@ pub fn build(b: *std.Build) void {
// 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(.{});
const lib_mod = b.createModule(.{
.root_source_file = b.path("src/root.zig"),
.target = target,
.optimize = optimize,
});
// We will also create a module for our other entry point, 'main.zig'. // We will also create a module for our other entry point, 'main.zig'.
const exe_mod = b.createModule(.{ const exe_mod = b.createModule(.{
// `root_source_file` is the Zig "entry point" of the module. If a module // `root_source_file` is the Zig "entry point" of the module. If a module
@@ -26,9 +33,35 @@ pub fn build(b: *std.Build) void {
.optimize = optimize, .optimize = optimize,
}); });
exe_mod.addImport("network", b.dependency("network", .{}).module("network")); lib_mod.addImport("network", b.dependency("network", .{}).module("network"));
exe_mod.addImport("zaprus", lib_mod);
exe_mod.addImport("clap", b.dependency("clap", .{}).module("clap")); exe_mod.addImport("clap", b.dependency("clap", .{}).module("clap"));
const static_lib = b.addLibrary(.{
.linkage = .static,
.name = "zaprus",
.root_module = lib_mod,
});
static_lib.addIncludePath(.{ .cwd_relative = "include" });
static_lib.linkLibC();
b.installArtifact(static_lib);
const dynamic_lib = b.addLibrary(.{
.linkage = .dynamic,
.name = "zaprus",
.root_module = lib_mod,
});
dynamic_lib.addIncludePath(.{ .cwd_relative = "include" });
dynamic_lib.linkLibC();
b.installArtifact(dynamic_lib);
// C Headers
const c_header = b.addInstallHeaderFile(b.path("include/zaprus.h"), "zaprus.h");
b.getInstallStep().dependOn(&c_header.step);
// This creates another `std.Build.Step.Compile`, but this one builds an executable // This creates another `std.Build.Step.Compile`, but this one builds an executable
// rather than a static library. // rather than a static library.
const exe = b.addExecutable(.{ const exe = b.addExecutable(.{

15
include/zaprus.h Normal file
View File

@@ -0,0 +1,15 @@
// client
#include<stdint.h>
#include<stdlib.h>
int zaprus_init(void);
int zaprus_deinit(void);
int zaprus_send_relay(const char* payload, size_t len, char dest[4]);
int zaprus_send_initial_connection(const char* payload, size_t len, uint16_t initial_port);
void* zaprus_connect(const char* payload, size_t len);

View File

@@ -39,10 +39,10 @@ fn broadcastSaprusMessage(msg: SaprusMessage, udp_port: u16, allocator: Allocato
_ = try sock.sendTo(dest_addr, msg_bytes); _ = try sock.sendTo(dest_addr, msg_bytes);
} }
pub fn sendRelay(payload: []const u8, allocator: Allocator) !void { pub fn sendRelay(payload: []const u8, dest: [4]u8, allocator: Allocator) !void {
const msg = SaprusMessage{ const msg = SaprusMessage{
.relay = .{ .relay = .{
.header = .{ .dest = .{ 70, 70, 70, 70 } }, .header = .{ .dest = dest },
.payload = payload, .payload = payload,
}, },
}; };
@@ -76,7 +76,7 @@ pub fn sendInitialConnection(payload: []const u8, initial_port: u16, allocator:
return msg; return msg;
} }
pub fn connect(payload: []const u8, allocator: Allocator) !?SaprusMessage { pub fn connect(payload: []const u8, allocator: Allocator) !SaprusMessage {
var initial_port: u16 = 0; var initial_port: u16 = 0;
if (rand) |r| { if (rand) |r| {
initial_port = r.intRangeAtMost(u16, 1024, 65000); initial_port = r.intRangeAtMost(u16, 1024, 65000);
@@ -109,10 +109,10 @@ pub fn connect(payload: []const u8, allocator: Allocator) !?SaprusMessage {
// Complete handshake after awaiting response // Complete handshake after awaiting response
try broadcastSaprusMessage(msg, randomPort(), allocator); try broadcastSaprusMessage(msg, randomPort(), allocator);
return initial_conn_res; return initial_conn_res.?;
} }
pub const SaprusMessage = @import("./saprus_message.zig").SaprusMessage; const SaprusMessage = @import("message.zig").Message;
const std = @import("std"); const std = @import("std");
const Random = std.Random; const Random = std.Random;

32
src/c_api.zig Normal file
View File

@@ -0,0 +1,32 @@
// client
export fn zaprus_init() c_int {
SaprusClient.init() catch return 1;
return 0;
}
export fn zaprus_deinit() c_int {
SaprusClient.deinit();
return 0;
}
export fn zaprus_send_relay(payload: [*]const u8, len: usize, dest: [*]u8) c_int {
SaprusClient.sendRelay(payload[0..len], dest[0..4].*, allocator) catch return 1;
return 0;
}
export fn zaprus_connect(payload: [*]const u8, len: usize, output: *SaprusConnection) c_int {
output.* = (SaprusClient.connect(payload[0..len], allocator) catch return 1).?;
return 0;
}
const std = @import("std");
const zaprus = @import("./root.zig");
const SaprusClient = zaprus.Client;
const SaprusConnection = zaprus.Connection;
const allocator = std.heap.c_allocator;
test {
std.testing.refAllDeclsRecursively(@This());
}

View File

@@ -23,6 +23,7 @@ pub fn main() !void {
const params = comptime clap.parseParamsComptime( const params = comptime clap.parseParamsComptime(
\\-h, --help Display this help and exit. \\-h, --help Display this help and exit.
\\-r, --relay <str> A relay message to send. \\-r, --relay <str> A relay message to send.
\\-d, --dest <str> An IPv4 or <= 4 ASCII byte string.
\\-c, --connect <str> A connection message to send. \\-c, --connect <str> A connection message to send.
\\ \\
); );
@@ -41,19 +42,24 @@ pub fn main() !void {
}; };
defer res.deinit(); defer res.deinit();
try Saprus.init(); try SaprusClient.init();
defer Saprus.deinit(); defer SaprusClient.deinit();
if (res.args.help != 0) { if (res.args.help != 0) {
return clap.help(std.io.getStdErr().writer(), clap.Help, &params, .{}); return clap.help(std.io.getStdErr().writer(), clap.Help, &params, .{});
} }
if (res.args.relay) |r| { if (res.args.relay) |r| {
try Saprus.sendRelay(if (r.len > 0) r else "Hello darkness my old friend", gpa); const dest = parseDest(res.args.dest) catch .{ 70, 70, 70, 70 };
try SaprusClient.sendRelay(
if (r.len > 0) r else "Hello darkness my old friend",
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| {
const conn_res: ?SaprusMessage = Saprus.connect(if (c.len > 0) c else "Hello darkness my old friend", gpa) catch |err| switch (err) { const conn_res: ?SaprusMessage = 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,
}; };
@@ -69,12 +75,27 @@ pub fn main() !void {
return clap.help(std.io.getStdErr().writer(), clap.Help, &params, .{}); return clap.help(std.io.getStdErr().writer(), clap.Help, &params, .{});
} }
fn parseDest(in: ?[]const u8) [4]u8 {
if (in) |dest| {
if (dest.len <= 4) {
var res: [4]u8 = @splat(0);
@memcpy(res[0..dest.len], dest);
return res;
}
const addr = std.net.Ip4Address.parse(dest, 0) catch return "FAIL".*;
return @bitCast(addr.sa.addr);
}
return "zap".*;
}
const builtin = @import("builtin"); const builtin = @import("builtin");
const std = @import("std"); const std = @import("std");
const DebugAllocator = std.heap.DebugAllocator(.{}); const DebugAllocator = std.heap.DebugAllocator(.{});
const ArrayList = std.ArrayList; const ArrayList = std.ArrayList;
const Saprus = @import("./saprus.zig"); const zaprus = @import("zaprus");
const SaprusMessage = Saprus.SaprusMessage; const SaprusClient = zaprus.Client;
const SaprusMessage = zaprus.Message;
const clap = @import("clap"); const clap = @import("clap");

View File

@@ -1,9 +1,9 @@
const base64Enc = std.base64.Base64Encoder.init(std.base64.standard_alphabet_chars, '='); const base64Enc = std.base64.Base64Encoder.init(std.base64.standard_alphabet_chars, '=');
const base64Dec = std.base64.Base64Decoder.init(std.base64.standard_alphabet_chars, '='); const base64Dec = std.base64.Base64Decoder.init(std.base64.standard_alphabet_chars, '=');
/// Type tag for SaprusMessage 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 SaprusPacketType = enum(u16) { pub const PacketType = enum(u16) {
relay = 0x003C, relay = 0x003C,
file_transfer = 0x8888, file_transfer = 0x8888,
connection = 0x00E9, connection = 0x00E9,
@@ -12,7 +12,7 @@ pub const SaprusPacketType = enum(u16) {
/// Reserved option values. /// Reserved option values.
/// Currently unused. /// Currently unused.
pub const SaprusConnectionOptions = packed struct(u8) { pub const ConnectionOptions = packed struct(u8) {
opt1: bool = false, opt1: bool = false,
opt2: bool = false, opt2: bool = false,
opt3: bool = false, opt3: bool = false,
@@ -23,13 +23,13 @@ pub const SaprusConnectionOptions = packed struct(u8) {
opt8: bool = false, opt8: bool = false,
}; };
pub const SaprusError = error{ pub const Error = error{
NotImplementedSaprusType, NotImplementedSaprusType,
UnknownSaprusType, UnknownSaprusType,
}; };
/// All Saprus messages /// All Saprus messages
pub const SaprusMessage = union(SaprusPacketType) { pub const Message = union(PacketType) {
pub const Relay = struct { pub const Relay = struct {
pub const Header = packed struct { pub const Header = packed struct {
dest: @Vector(4, u8), dest: @Vector(4, u8),
@@ -44,7 +44,7 @@ pub const SaprusMessage = union(SaprusPacketType) {
seq_num: u32 = 0, seq_num: u32 = 0,
msg_id: u32 = 0, msg_id: u32 = 0,
reserved: u8 = 0, reserved: u8 = 0,
options: SaprusConnectionOptions = .{}, options: ConnectionOptions = .{},
}; };
header: Header, header: Header,
payload: []const u8, payload: []const u8,
@@ -53,8 +53,8 @@ pub const SaprusMessage = union(SaprusPacketType) {
file_transfer: void, // unimplemented file_transfer: void, // unimplemented
connection: Connection, connection: Connection,
/// Should be called for any SaprusMessage that was declared using a function that you pass an allocator to. /// Should be called for any Message that was declared using a function that you pass an allocator to.
pub fn deinit(self: SaprusMessage, allocator: Allocator) void { pub fn deinit(self: Message, allocator: Allocator) void {
switch (self) { switch (self) {
.relay => |r| allocator.free(r.payload), .relay => |r| allocator.free(r.payload),
.connection => |c| allocator.free(c.payload), .connection => |c| allocator.free(c.payload),
@@ -96,7 +96,7 @@ pub const SaprusMessage = union(SaprusPacketType) {
} }
/// Caller is responsible for freeing the returned bytes. /// Caller is responsible for freeing the returned bytes.
pub fn toBytes(self: SaprusMessage, allocator: Allocator) ![]u8 { pub fn toBytes(self: Message, allocator: Allocator) ![]u8 {
// Create a growable list of bytes to store the output in. // Create a growable list of bytes to store the output in.
var buf = std.ArrayList(u8).init(allocator); var buf = std.ArrayList(u8).init(allocator);
errdefer buf.deinit(); errdefer buf.deinit();
@@ -108,7 +108,7 @@ pub const SaprusMessage = union(SaprusPacketType) {
switch (self) { switch (self) {
.relay => |r| try toBytesAux(r.header, r.payload, &buf, allocator), .relay => |r| try toBytesAux(r.header, r.payload, &buf, allocator),
.connection => |c| try toBytesAux(c.header, c.payload, &buf, allocator), .connection => |c| try toBytesAux(c.header, c.payload, &buf, allocator),
.file_transfer => return SaprusError.NotImplementedSaprusType, .file_transfer => return Error.NotImplementedSaprusType,
} }
// Collect the growable list as a slice and return it. // Collect the growable list as a slice and return it.
@@ -116,12 +116,12 @@ pub const SaprusMessage = union(SaprusPacketType) {
} }
fn fromBytesAux( fn fromBytesAux(
comptime packet: SaprusPacketType, comptime packet: PacketType,
len: u16, len: u16,
r: std.io.FixedBufferStream([]const u8).Reader, r: std.io.FixedBufferStream([]const u8).Reader,
allocator: Allocator, allocator: Allocator,
) !SaprusMessage { ) !Message {
const Header = @field(@FieldType(SaprusMessage, @tagName(packet)), "Header"); const Header = @field(@FieldType(Message, @tagName(packet)), "Header");
// Read the header for the current message type. // Read the header for the current message type.
var header_bytes: [@sizeOf(Header)]u8 = undefined; var header_bytes: [@sizeOf(Header)]u8 = undefined;
@@ -138,20 +138,20 @@ pub const SaprusMessage = union(SaprusPacketType) {
const payload = try allocator.alloc(u8, try base64Dec.calcSizeForSlice(payload_buf)); const payload = try allocator.alloc(u8, try base64Dec.calcSizeForSlice(payload_buf));
try base64Dec.decode(payload, payload_buf); try base64Dec.decode(payload, payload_buf);
// Return the type of SaprusMessage specified by the `packet` argument. // Return the type of Message specified by the `packet` argument.
return @unionInit(SaprusMessage, @tagName(packet), .{ return @unionInit(Message, @tagName(packet), .{
.header = header, .header = header,
.payload = payload, .payload = payload,
}); });
} }
/// Caller is responsible for calling .deinit on the returned value. /// Caller is responsible for calling .deinit on the returned value.
pub fn fromBytes(bytes: []const u8, allocator: Allocator) !SaprusMessage { pub fn fromBytes(bytes: []const u8, allocator: Allocator) !Message {
var s = std.io.fixedBufferStream(bytes); var s = std.io.fixedBufferStream(bytes);
const r = s.reader(); const r = s.reader();
// Read packet type // Read packet type
const packet_type = @as(SaprusPacketType, @enumFromInt(try r.readInt(u16, .big))); const packet_type = @as(PacketType, @enumFromInt(try r.readInt(u16, .big)));
// Read the length of the header + base64 encoded payload. // Read the length of the header + base64 encoded payload.
const len = try r.readInt(u16, .big); const len = try r.readInt(u16, .big);
@@ -159,8 +159,8 @@ pub const SaprusMessage = union(SaprusPacketType) {
switch (packet_type) { switch (packet_type) {
.relay => return fromBytesAux(.relay, len, r, allocator), .relay => return fromBytesAux(.relay, len, r, allocator),
.connection => return fromBytesAux(.connection, len, r, allocator), .connection => return fromBytesAux(.connection, len, r, allocator),
.file_transfer => return SaprusError.NotImplementedSaprusType, .file_transfer => return Error.NotImplementedSaprusType,
else => return SaprusError.UnknownSaprusType, else => return Error.UnknownSaprusType,
} }
} }
}; };
@@ -173,7 +173,7 @@ const nativeToBig = std.mem.nativeToBig;
test "Round trip Relay toBytes and fromBytes" { test "Round trip Relay toBytes and fromBytes" {
const gpa = std.testing.allocator; const gpa = std.testing.allocator;
const msg = SaprusMessage{ 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",
@@ -183,7 +183,7 @@ test "Round trip Relay toBytes and fromBytes" {
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 SaprusMessage.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);
@@ -191,7 +191,7 @@ test "Round trip Relay toBytes and fromBytes" {
test "Round trip Connection toBytes and fromBytes" { test "Round trip Connection toBytes and fromBytes" {
const gpa = std.testing.allocator; const gpa = std.testing.allocator;
const msg = SaprusMessage{ const msg = Message{
.connection = .{ .connection = .{
.header = .{ .header = .{
.src_port = 0, .src_port = 0,
@@ -204,7 +204,7 @@ test "Round trip Connection toBytes and fromBytes" {
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 SaprusMessage.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);

4
src/root.zig Normal file
View File

@@ -0,0 +1,4 @@
pub const Client = @import("Client.zig");
pub usingnamespace @import("message.zig");
pub usingnamespace @import("c_api.zig");