Baguette/libipc
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Ready for Zig v0.15.2. Details in commit message.

Browse source 
The library jumped to Zig v0.15.2 which implies a new build system.
`build.zig` now compiles libipc as both static and dynamic libraries,
and provides an entry point to use `libipc` as-is for Zig applications.

Some examples have been added to help new users play with the library.

Thanks to these fairly complete examples, two (very small) leaks related
to sentinel values (in arrays containing paths) were fixed.
This commit is contained in:
Philippe Pittoli 2025-10-25 16:35:02 +02:00
parent b2e811df19
commit 76e3144436
15 changed files with 714 additions and 104 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -18,12 +18,19 @@ make install PREFIX=/usr/
# Usage
See the [dedicated repository][examples].
See the `examples/` directory.
More examples in the [dedicated repository][examples].
# Status
LibIPC reached a stable state and is usable.
Performance is fine for most projects, but can be largely improved.
The `poll` syscall is used instead of more recent and *faster* syscalls (`epoll`, `kqueue`, etc.).
Performance is fine for most projects.
The `poll` syscall is used instead of more recent and *faster* syscalls (`epoll`, `kqueue`, etc.) because it is simpler and available on most systems.
Since the API is great and performances are fine for what I do, I don't plan to change it, not even for faster syscalls.
A new library will be implemented if I ever change my mind.
So, again, the API should be fairly stable.
Enjoy!
[examples]: https://git.baguette.netlib.re/Baguette/libipc-examples

228
build.zig
View file

@ -1,70 +1,208 @@
const std = @import("std");
const VERSION = "0.2.0";
// Although this function looks imperative, note that its job is to
// declaratively construct a build graph that will be executed by an external
// runner.
// 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 allows the person running `zig build` to choose
// 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(.{});
// Standard optimization options allow the person running `zig build` to select
// between Debug, ReleaseSafe, ReleaseFast, and ReleaseSmall. Here we do not
// set a preferred release mode, allowing the user to decide how to optimize.
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.
const static_lib = b.addStaticLibrary(.{
.name = "ipc",
// 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 = .{ .cwd_relative = "src/bindings.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("ipc", .{
// 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/zigroot.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,
.optimize = optimize,
// libc is required since libipc uses umask.
.link_libc = true,
});
// Link with the libc of the target system since the C allocator
// is required in the bindings.
static_lib.linkLibC();
// This declares intent for the library to be installed into the standard
// location when the user invokes the "install" step (the default step when
// running `zig build`).
// Compile libipc as a static library with C bindings.
const static_lib = b.addLibrary(.{
.name = "ipc", // name of the library
.linkage = .static,
.root_module = b.createModule(.{
.root_source_file = b.path("src/root.zig"),
.target = target,
.optimize = optimize,
.link_libc = true, // libc is required since libipc uses umask.
}),
});
b.installArtifact(static_lib);
const shared_lib = b.addSharedLibrary(.{
.name = "ipc",
.root_source_file = .{ .cwd_relative = "src/bindings.zig" },
.version = comptime (try std.SemanticVersion.parse(VERSION)),
.target = target,
.optimize = optimize,
// Compile libipc as a dynamic library with C bindings.
const dynamic_lib = b.addLibrary(.{
.name = "ipc", // name of the library
.linkage = .dynamic,
.version = .{ .major = 0, .minor = 2, .patch = 3 },
.root_module = b.createModule(.{
.root_source_file = b.path("src/root.zig"),
.target = target,
.optimize = optimize,
.link_libc = true, // libc is required since libipc uses umask.
}),
});
shared_lib.linkLibC();
b.installArtifact(shared_lib);
b.installArtifact(dynamic_lib);
// Creates a step for unit testing.
const main_tests = b.addTest(.{
.root_source_file = .{ .cwd_relative = "src/main.zig" },
.target = target,
.optimize = optimize,
// pong client using the c client.
const pong_with_c_bindings = b.addExecutable(.{
.name = "pong-with-c-bindings", // name of the executable
.root_module = b.createModule(.{
// 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("examples/pong-with-c-bindings.zig"),
.target = target,
.optimize = optimize,
// There is no list of modules to import since the application
// uses `libipc.h` to type-check the API then it is statically
// linked to libipc (see `linkLibrary(static_lib)`).
}),
});
main_tests.linkLibC();
// 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(&main_tests.step);
// This declares intent for the executable to be installed into the
// install prefix when running `zig build` (i.e. when executing the default
// step). By default the install prefix is `zig-out/` but can be overridden
// by passing `--prefix` or `-p`.
b.installArtifact(pong_with_c_bindings);
const install_static_lib = b.addInstallArtifact(static_lib, .{});
const static_lib_step = b.step("static", "Compile LibIPC as a static library.");
static_lib_step.dependOn(&install_static_lib.step);
// Statically link the executable to the library.
pong_with_c_bindings.linkLibrary(static_lib);
const install_shared_lib = b.addInstallArtifact(shared_lib, .{});
// b.getInstallStep().dependOn(&install_shared_lib.step);
const shared_lib_step = b.step("shared", "Compile LibIPC as a shared library.");
shared_lib_step.dependOn(&install_shared_lib.step);
// pong service using the c client.
const pongd_with_c_bindings = b.addExecutable(.{
.name = "pongd-with-c-bindings", // name of the executable
.root_module = b.createModule(.{
.root_source_file = b.path("examples/pongd-with-c-bindings.zig"),
.target = target,
.optimize = optimize,
// Again, no need for external modules to import.
}),
});
b.installArtifact(pongd_with_c_bindings);
pongd_with_c_bindings.linkLibrary(static_lib);
// pong client using the zig library directly.
const pong = b.addExecutable(.{
.name = "pong", // name of the executable
.root_module = b.createModule(.{
.root_source_file = b.path("examples/pong.zig"),
.target = target,
.optimize = optimize,
.imports = &.{
.{ .name = "ipc", .module = mod },
},
}),
});
b.installArtifact(pong);
// pong service using the zig library directly.
const pongd = b.addExecutable(.{
.name = "pongd", // name of the executable
.root_module = b.createModule(.{
.root_source_file = b.path("examples/pongd.zig"),
.target = target,
.optimize = optimize,
.imports = &.{
.{ .name = "ipc", .module = mod },
},
}),
});
b.installArtifact(pongd);
// This creates a top level step. Top level steps have a name and can be
// invoked by name when running `zig build` (e.g. `zig build run`).
// This will evaluate the `run` step rather than the default step.
// 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_pong_with_c_bindings_step = b.step("run-pong", "Run the pong client");
// 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_pong_with_c_bindings_cmd = b.addRunArtifact(pong_with_c_bindings);
run_pong_with_c_bindings_step.dependOn(&run_pong_with_c_bindings_cmd.step);
// By making the run step depend on the default step, it will be run from the
// installation directory rather than directly from within the cache directory.
run_pong_with_c_bindings_cmd.step.dependOn(b.getInstallStep());
// This allows the user to pass arguments to the application in the build
// command itself, like this: `zig build run -- arg1 arg2 etc`
if (b.args) |args| {
run_pong_with_c_bindings_cmd.addArgs(args);
}
// 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,
});
// A run step that will run the test executable.
const run_mod_tests = b.addRunArtifact(mod_tests);
// Creates an executable that will run `test` blocks from the executable's
// root module. Note that test executables only test one module at a time,
// hence why we have to create two separate ones.
const exe_tests = b.addTest(.{
.root_module = pong_with_c_bindings.root_module,
});
// 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.
}

81
build.zig.zon Normal file
View file

@ -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 = .ipc,
// 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 = 0x43c360a97dd00013, // 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",
},
}

9
examples/README.md Normal file
View file

@ -0,0 +1,9 @@
This directory provides a few examples of libipc usages.
# Pong
The `pong` service is a simple `echoing` service.
A server (named `pongd`) echoes what is sent to it from a client (`pong`).
There are two implementations of these applications: one using the C bindings of libipc, one using the library directly.
Since the communication protocol is the same (raw libipc messages), any client works with any server.

96
examples/pong-with-c-bindings.zig Normal file
View file

@ -0,0 +1,96 @@
// Example of a `pong` client using the C bindings.
const std = @import("std");
// Only bindings are available.
const libipc = @cImport({
@cInclude("../../../libipc.h");
});
const SERVICE = "pong";
const SERVICE_LEN = 4;
const MAX_MSG_SIZE = 10000;
pub fn main() !u8 {
var ctx : *anyopaque = undefined;
var ret : c_int = 0;
var servicefd : c_int = undefined;
var buffer : [MAX_MSG_SIZE]u8 = undefined;
var size : usize = MAX_MSG_SIZE;
var event_type : u8 = undefined;
var index : usize = 0;
var originfd : c_int = undefined;
std.debug.print("Init context.\n", .{});
ret = libipc.ipc_context_init (@ptrCast(&ctx));
if (ret != 0) {
std.debug.print("Cannot init context.\n", .{});
return 1;
}
defer {
std.debug.print("Deinit context.\n", .{});
libipc.ipc_context_deinit (@ptrCast(&ctx));
}
std.debug.print ("Connect to a 'pong' service.\n", .{});
ret = libipc.ipc_connect_service (ctx, &servicefd, SERVICE, SERVICE_LEN);
if (ret != 0) {
std.debug.print("Cannot connect to a service.\n", .{});
return 1;
}
std.debug.print ("Let's schedule a message.\n", .{});
ret = libipc.ipc_schedule (ctx, servicefd, "hello, plz bounce me", 21);
if (ret != 0) {
std.debug.print("Cannot schedule a message.\n", .{});
return 1;
}
std.debug.print("Let's set the timer to one second.\n", .{});
libipc.ipc_context_timer (ctx, 1000);
var should_continue : bool = true;
// var event_count : u32 = 0;
std.debug.print("Let's loop over events.\n", .{});
while(should_continue) {
size = MAX_MSG_SIZE;
var newfd : c_int = undefined;
const pbuffer : [*c]u8 = &buffer;
ret = libipc.ipc_wait_event (ctx, &event_type, &index, &originfd, &newfd, pbuffer, &size);
if (ret != 0) {
std.debug.print("Error while waiting for an event.", .{});
return 1;
}
// event_count += 1;
// std.debug.print("EVENT n°{d} type {d}\t", .{ event_count, event_type });
switch (event_type) {
libipc.ERROR => { std.debug.print("Error.", .{}); return 1; },
libipc.EXTERNAL => { std.debug.print("External (shouldn't happen).", .{}); return 1; },
libipc.SWITCH_RX => { std.debug.print("Switch RX (shouldn't happen).", .{}); return 1; },
libipc.SWITCH_TX => { std.debug.print("Switch TX (shouldn't happen).", .{}); return 1; },
libipc.CONNECTION => { std.debug.print("Connection (shouldn't happen).", .{}); return 1; },
libipc.DISCONNECTION => { std.debug.print("Disconnection (shouldn't happen).", .{}); return 1; },
libipc.TIMER => { std.debug.print("TIMER.\n", .{}); },
libipc.MESSAGE_TX => { std.debug.print("A message has been sent.\n", .{}); },
libipc.MESSAGE_RX => {
if (size == 0) {
std.debug.print("No message returned.\n", .{});
return 1;
}
buffer[size] = 0;
std.debug.print("Response (size {d}): {s}.\n", .{ size, buffer[0..size] });
// We received the response, quitting.
should_continue = false;
},
else => { std.debug.print("Unknown IPC message type.\n", .{}); return 1; },
}
}
return 0;
}

91
examples/pong.zig Normal file
View file

@ -0,0 +1,91 @@
// Example of a `pong` client using the Zig library directly (not the C bindings).
const std = @import("std");
const ipc = @import("ipc");
const hexdump = ipc.hexdump;
const Message = ipc.Message;
const util = ipc.util;
const builtin = @import("builtin");
const native_os = builtin.target.os.tag;
const print = std.debug.print;
const testing = std.testing;
const service_name = "pong";
fn create_service() !void {
var gpa = std.heap.DebugAllocator(.{.safety = true}){};
defer _ = gpa.deinit();
const allocator = gpa.allocator();
var ctx = try ipc.Context.init(allocator);
defer {
std.debug.print("Deinit context.\n", .{});
ctx.deinit(); // There. Can't leak. Isn't Zig wonderful?
}
// CLIENT SIDE: connect to a service.
const servicefd = try ctx.connect_service(service_name);
// Listen to the standard input (to quit the application).
try ctx.add_external(0);
// Schedule a message.
const message = try Message.init(servicefd, allocator, "hello, plz bounce me");
try ctx.schedule (message);
var some_event: ipc.Event = undefined;
ctx.timer = 20000; // 2 seconds
var count: u32 = 0;
var should_continue = true;
while(should_continue) {
some_event = try ctx.wait_event();
switch (some_event.t) {
.EXTERNAL => {
should_continue = false;
},
.TIMER => {
std.debug.print("\rTimer! ({d})", .{count});
count += 1;
},
.CONNECTION => {
std.debug.print("Connection.\n", .{});
},
.DISCONNECTION => {
std.debug.print("Disconnection.\n", .{});
},
.MESSAGE_RX => {
if (some_event.m) |m| {
std.debug.print("Message received from {d} ({d} bytes)\n", .{m.fd, m.payload.len});
util.print_message ("RECEIVED MESSAGE", m);
should_continue = false;
m.deinit();
}
else {
std.debug.print("Error while receiving new message. Ignoring.\n", .{});
}
},
.MESSAGE_TX => {
std.debug.print("Message sent to {d}.\n", .{some_event.origin});
},
else => {
std.debug.print("Error: unexpected event\n", .{});
std.debug.print("Quitting.\n", .{});
should_continue = false;
},
}
}
std.debug.print("Goodbye\n", .{});
}
pub fn main() !u8 {
try create_service();
return 0;
}

100
examples/pongd-with-c-bindings.zig Normal file
View file

@ -0,0 +1,100 @@
// Example of a `pong` service using the C bindings.
const std = @import("std");
// Only bindings are available.
const libipc = @cImport({
@cInclude("../../../libipc.h");
});
const SERVICE = "pong";
const SERVICE_LEN = 4;
const MAX_MSG_SIZE = 10000;
pub fn main() !u8 {
var ctx : *anyopaque = undefined;
var ret : c_int = 0;
var servicefd : c_int = undefined;
var buffer : [MAX_MSG_SIZE]u8 = undefined;
var size : usize = MAX_MSG_SIZE;
var event_type : u8 = undefined;
var index : usize = 0;
var originfd : c_int = undefined;
std.debug.print("Init context.\n", .{});
ret = libipc.ipc_context_init (@ptrCast(&ctx));
if (ret != 0) {
std.debug.print("Cannot init context.\n", .{});
return 1;
}
defer {
std.debug.print("Deinit context.\n", .{});
libipc.ipc_context_deinit (@ptrCast(&ctx));
}
std.debug.print ("Create the 'pong' service.\n", .{});
ret = libipc.ipc_service_init (ctx, &servicefd, SERVICE, SERVICE_LEN);
if (ret != 0) {
std.debug.print("Cannot create the service.\n", .{});
return 1;
}
std.debug.print ("Listening to the standard input (press enter to quit).\n", .{});
ret = libipc.ipc_add_external (ctx, 0);
if (ret != 0) {
std.debug.print ("Cannot listen to standard input.", .{});
return 1;
}
std.debug.print("Set the timer to two seconds.\n", .{});
libipc.ipc_context_timer (ctx, 2000);
var event_count : u32 = 0;
std.debug.print("Let's loop over events.\n", .{});
while(true) {
size = MAX_MSG_SIZE;
var newfd : c_int = undefined;
const pbuffer : [*c]u8 = &buffer;
ret = libipc.ipc_wait_event (ctx, &event_type, &index, &originfd, &newfd, pbuffer, &size);
if (ret != 0) {
std.debug.print("Error while waiting for an event.", .{});
return 1;
}
event_count += 1;
switch (event_type) {
libipc.ERROR => { std.debug.print("Error.", .{}); return 1; },
libipc.EXTERNAL => { std.debug.print("Quitting.\n", .{}); return 0; },
libipc.SWITCH_RX => { std.debug.print("Switch RX (shouldn't happen).", .{}); return 1; },
libipc.SWITCH_TX => { std.debug.print("Switch TX (shouldn't happen).", .{}); return 1; },
libipc.CONNECTION => { std.debug.print("Connection (fd {d}).\n", .{newfd}); },
libipc.DISCONNECTION => { std.debug.print("Disconnection (fd {d}).\n", .{originfd}); },
libipc.TIMER => { std.debug.print("\rTIMER ({d}).\r", .{event_count}); },
libipc.MESSAGE_TX => { std.debug.print("A message has been sent.\n", .{}); },
libipc.MESSAGE_RX => {
if (size == 0) {
std.debug.print("No message returned.\n", .{});
return 1;
}
buffer[size] = 0;
std.debug.print("Message from {d} (size {d}): {s}.\n", .{ originfd, size, buffer[0..size] });
std.debug.print ("Schedule a message for {d}.\n", .{originfd});
ret = libipc.ipc_schedule (ctx, originfd, pbuffer, size);
if (ret != 0) {
std.debug.print("Cannot schedule a message.\n", .{});
return 1;
}
},
else => { std.debug.print("Unknown IPC message type.\n", .{}); return 1; },
}
}
return 0;
}

86
examples/pongd.zig Normal file
View file

@ -0,0 +1,86 @@
// Example of a `pong` service using the Zig library directly (not the C bindings).
const std = @import("std");
const ipc = @import("ipc");
const hexdump = ipc.hexdump;
const Message = ipc.Message;
const util = ipc.util;
const builtin = @import("builtin");
const native_os = builtin.target.os.tag;
const print = std.debug.print;
const testing = std.testing;
const service_name = "pong";
fn create_service() !void {
var gpa = std.heap.DebugAllocator(.{.safety = true}){};
defer _ = gpa.deinit();
const allocator = gpa.allocator();
var ctx = try ipc.Context.init(allocator);
defer {
std.debug.print("Deinit context.\n", .{});
ctx.deinit(); // There. Can't leak. Isn't Zig wonderful?
}
// SERVER SIDE: creating a service.
_ = try ctx.server_init(service_name);
// Listen to the standard input (to quit the application).
try ctx.add_external(0);
var some_event: ipc.Event = undefined;
ctx.timer = 20000; // 2 seconds
var count: u32 = 0;
var should_continue = true;
while(should_continue) {
some_event = try ctx.wait_event();
switch (some_event.t) {
.EXTERNAL => {
should_continue = false;
},
.TIMER => {
std.debug.print("\rTimer! ({d})", .{count});
count += 1;
},
.CONNECTION => {
std.debug.print("Connection (fd {d}): {d} so far!\n", .{some_event.newfd, ctx.pollfd.items.len - 1});
},
.DISCONNECTION => {
std.debug.print("User {d} disconnected, {d} remainaing.\n"
, .{some_event.origin, ctx.pollfd.items.len - 1});
},
.MESSAGE_RX => {
if (some_event.m) |m| {
std.debug.print("Message received from {d} ({d} bytes)\n", .{m.fd, m.payload.len});
util.print_message ("RECEIVED MESSAGE", m);
try ctx.schedule(m);
}
else {
std.debug.print("Error while receiving new message. Ignoring.\n", .{});
}
},
.MESSAGE_TX => {
std.debug.print("Message sent to {d}.\n", .{some_event.origin});
},
else => {
std.debug.print("Error: unexpected event\n", .{});
std.debug.print("Quitting.\n", .{});
break;
},
}
}
std.debug.print("Goodbye\n", .{});
}
pub fn main() !u8 {
try create_service();
return 0;
}

1
libipc.h
View file

@ -1,6 +1,7 @@
#ifndef LIBIPC
#define LIBIPC
#include <stdio.h> // Required to have types such as `size_t`.
#include <stdint.h>
/**

7
makefile
View file

@ -4,12 +4,15 @@ help:
@echo "usage: make [build|install|doc|serve-doc]"
ZIGOPTS ?=
ZIGOPTIM ?= ReleaseSafe
ZIGRELEASE ?= small
-include makefile.target
build:
zig build -Doptimize=$(ZIGOPTIM) $(ZIGOPTS) $(TARGET_OPTION)
zig build --release=$(ZIGRELEASE) $(ZIGOPTS) $(TARGET_OPTION)
clean:
-rm -r zig-out/
PREFIX ?= /usr/local
LIBDIR ?= $(PREFIX)/lib

4
src/connection.zig
View file

@ -15,11 +15,11 @@ pub const Connection = struct {
};
t: Connection.Type,
path: ?[]const u8, // Not always needed.
path: ?[:0]const u8, // Not always needed.
const Self = @This();
pub fn init(t: Connection.Type, path: ?[]const u8) Self {
pub fn init(t: Connection.Type, path: ?[:0]const u8) Self {
return Self{
.t = t,
.path = path,

30
src/context.zig
View file

@ -22,7 +22,7 @@ const print_eq = @import("./util.zig").print_eq;
const Messages = @import("./message.zig").Messages;
const SwitchDB = @import("./switch.zig").SwitchDB;
const Connections = @import("./connection.zig").Connections;
const CBEventType = @import("./main.zig").CBEvent.Type;
const CBEventType = CBEvent.Type;
pub const PollFD = std.ArrayList(posix.pollfd);
@ -51,7 +51,7 @@ pub const Context = struct {
pub fn init(allocator: std.mem.Allocator) !Self {
const rundir = std.process.getEnvVarOwned(allocator, "RUNDIR") catch |err| switch (err) {
error.EnvironmentVariableNotFound => blk: {
break :blk try allocator.dupeZ(u8, "/tmp/.libipc-run/");
break :blk try allocator.dupe(u8, "/tmp/.libipc-run/");
},
else => {
return err;
@ -74,10 +74,10 @@ pub const Context = struct {
};
return Self{ .rundir = rundir
, .connections = Connections.init(allocator)
, .pollfd = PollFD.init(allocator)
, .tx = Messages.init(allocator)
, .switchdb = SwitchDB.init(allocator)
, .connections = Connections{}
, .pollfd = PollFD{}
, .tx = Messages{}
, .switchdb = SwitchDB.init(allocator)
, .allocator = allocator };
}
@ -88,12 +88,12 @@ pub const Context = struct {
},
};
self.allocator.free(self.rundir);
self.connections.deinit();
self.pollfd.deinit();
self.connections.deinit(self.allocator);
self.pollfd.deinit(self.allocator);
for (self.tx.items) |m| {
m.deinit();
}
self.tx.deinit();
self.tx.deinit(self.allocator);
self.switchdb.deinit();
}
@ -173,8 +173,8 @@ pub const Context = struct {
/// in case one of the arrays cannot sustain another entry, the other
/// won't be added.
fn add_(self: *Self, new_connection: Connection, fd: posix.socket_t) !void {
try self.connections.append(new_connection);
try self.pollfd.append(.{ .fd = fd, .events = std.os.linux.POLL.IN, .revents = 0 });
try self.connections.append(self.allocator, new_connection);
try self.pollfd.append(self.allocator, .{ .fd = fd, .events = std.os.linux.POLL.IN, .revents = 0 });
}
fn fd_to_index(self: Self, fd: i32) !usize {
@ -253,7 +253,7 @@ pub const Context = struct {
// While the program is running, the lock is enabled.
// Once the program stops (even if it crashes), the lock is then disabled.
// Quit if the lock is still active.
const lock_opts = .{ .lock = .exclusive, .lock_nonblocking = true };
const lock_opts : std.fs.File.CreateFlags = .{ .lock = .exclusive, .lock_nonblocking = true };
_ = std.fs.createFileAbsolute(lock, lock_opts) catch |err| {
log.err("cannot init server at {s}, lock {s} is causing a problem: {any}", .{ path, lock, err });
log.err("you may have lauched the service twice.", .{});
@ -298,7 +298,7 @@ pub const Context = struct {
}
pub fn schedule(self: *Self, m: Message) !void {
try self.tx.append(m);
try self.tx.append(self.allocator, m);
}
/// Read from a client (indexed by a FD).
@ -317,8 +317,8 @@ pub const Context = struct {
}
pub fn set_switch_callbacks(self: *Self, fd: i32,
in: ?*const fn (origin: i32, mcontent: [*]u8, mlen: *usize) callconv(.C) u8,
out: ?*const fn (origin: i32, mcontent: [*]const u8, mlen: usize) callconv(.C) u8) !void {
in: ?*const fn (origin: i32, mcontent: [*]u8, mlen: *usize) callconv(.c) u8,
out: ?*const fn (origin: i32, mcontent: [*]const u8, mlen: usize) callconv(.c) u8) !void {
try self.switchdb.set_callbacks(fd, in, out);
}

41
src/bindings.zig → src/root.zig
View file

@ -1,11 +1,10 @@
const std = @import("std");
const log = std.log.scoped(.libipc_bindings);
const ipc = @import("./main.zig");
const Context = ipc.Context;
const Message = ipc.Message;
const CBEventType = ipc.CBEvent.Type;
const Context = @import("./context.zig").Context;
const Message = @import("./message.zig").Message;
const CBEventType = @import("./callback.zig").CBEvent.Type;
export fn ipc_context_init(ptr: **Context) callconv(.C) i32 {
export fn ipc_context_init(ptr: **Context) callconv(.c) i32 {
ptr.* = std.heap.c_allocator.create(Context) catch return -1;
ptr.*.* = Context.init(std.heap.c_allocator) catch |err| {
@ -16,27 +15,27 @@ export fn ipc_context_init(ptr: **Context) callconv(.C) i32 {
}
/// Start a libipc service.
export fn ipc_service_init(ctx: *Context, servicefd: *i32, service_name: [*]const u8, service_name_len: u16) callconv(.C) i32 {
export fn ipc_service_init(ctx: *Context, servicefd: *i32, service_name: [*]const u8, service_name_len: u16) callconv(.c) i32 {
const streamserver = ctx.server_init(service_name[0..service_name_len]) catch return -1;
servicefd.* = streamserver.stream.handle;
return 0;
}
/// Connect to a libipc service, possibly through IPCd.
export fn ipc_connect_service(ctx: *Context, servicefd: *i32, service_name: [*]const u8, service_name_len: u16) callconv(.C) i32 {
export fn ipc_connect_service(ctx: *Context, servicefd: *i32, service_name: [*]const u8, service_name_len: u16) callconv(.c) i32 {
const fd = ctx.connect_ipc(service_name[0..service_name_len]) catch return -1;
servicefd.* = fd;
return 0;
}
export fn ipc_context_deinit(ctx: **Context) callconv(.C) void {
export fn ipc_context_deinit(ctx: **Context) callconv(.c) void {
var ptr: *Context = ctx.*;
ptr.deinit();
std.heap.c_allocator.destroy(ptr);
}
/// Write a message (no waiting).
export fn ipc_write(ctx: *Context, servicefd: i32, mcontent: [*]const u8, mlen: usize) callconv(.C) i32 {
export fn ipc_write(ctx: *Context, servicefd: i32, mcontent: [*]const u8, mlen: usize) callconv(.c) i32 {
// TODO: better default length.
var buffer = [_]u8{0} ** 100000;
var fba = std.heap.FixedBufferAllocator.init(&buffer);
@ -48,7 +47,7 @@ export fn ipc_write(ctx: *Context, servicefd: i32, mcontent: [*]const u8, mlen:
/// Schedule a message.
/// Use the same allocator as the context.
export fn ipc_schedule(ctx: *Context, servicefd: i32, mcontent: [*]const u8, mlen: usize) callconv(.C) i32 {
export fn ipc_schedule(ctx: *Context, servicefd: i32, mcontent: [*]const u8, mlen: usize) callconv(.c) i32 {
const message = Message.init(servicefd, ctx.allocator, mcontent[0..mlen]) catch return -1;
ctx.schedule(message) catch return -2;
return 0;
@ -56,7 +55,7 @@ export fn ipc_schedule(ctx: *Context, servicefd: i32, mcontent: [*]const u8, mle
/// Read a message from a file descriptor.
/// Buffer length will be changed to the size of the received message.
export fn ipc_read_fd(ctx: *Context, fd: i32, buffer: [*]u8, buflen: *usize) callconv(.C) i32 {
export fn ipc_read_fd(ctx: *Context, fd: i32, buffer: [*]u8, buflen: *usize) callconv(.c) i32 {
var m = ctx.read_fd(fd) catch {
return -1;
} orelse return -2;
@ -73,7 +72,7 @@ export fn ipc_read_fd(ctx: *Context, fd: i32, buffer: [*]u8, buflen: *usize) cal
/// Read a message.
/// Buffer length will be changed to the size of the received message.
export fn ipc_read(ctx: *Context, index: usize, buffer: [*]u8, buflen: *usize) callconv(.C) i32 {
export fn ipc_read(ctx: *Context, index: usize, buffer: [*]u8, buflen: *usize) callconv(.c) i32 {
var m = ctx.read(index) catch {
return -1;
} orelse return -2;
@ -90,7 +89,7 @@ export fn ipc_read(ctx: *Context, index: usize, buffer: [*]u8, buflen: *usize) c
/// Wait for an event.
/// Buffer length will be changed to the size of the received message.
export fn ipc_wait_event(ctx: *Context, t: *u8, index: *usize, originfd: *i32, newfd: *i32, buffer: [*]u8, buflen: *usize) callconv(.C) i32 {
export fn ipc_wait_event(ctx: *Context, t: *u8, index: *usize, originfd: *i32, newfd: *i32, buffer: [*]u8, buflen: *usize) callconv(.c) i32 {
const event = ctx.wait_event() catch |err| switch (err) {
else => {
log.warn("error while waiting for an event: {}\n", .{err});
@ -119,21 +118,21 @@ export fn ipc_wait_event(ctx: *Context, t: *u8, index: *usize, originfd: *i32, n
}
/// Change the timer (ms).
export fn ipc_context_timer(ctx: *Context, timer: i32) callconv(.C) void {
export fn ipc_context_timer(ctx: *Context, timer: i32) callconv(.c) void {
ctx.timer = timer;
}
export fn ipc_close_fd(ctx: *Context, fd: i32) callconv(.C) i32 {
export fn ipc_close_fd(ctx: *Context, fd: i32) callconv(.c) i32 {
ctx.close_fd(fd) catch return -1;
return 0;
}
export fn ipc_close(ctx: *Context, index: usize) callconv(.C) i32 {
export fn ipc_close(ctx: *Context, index: usize) callconv(.c) i32 {
ctx.close(index) catch return -1;
return 0;
}
export fn ipc_close_all(ctx: *Context) callconv(.C) i32 {
export fn ipc_close_all(ctx: *Context) callconv(.c) i32 {
ctx.close_all() catch return -1;
return 0;
}
@ -141,19 +140,19 @@ export fn ipc_close_all(ctx: *Context) callconv(.C) i32 {
/// Add a new file descriptor to listen to.
/// The FD is marked as "external"; it isn't a simple libipc connection.
/// You may want to handle any operation on it by yourself.
export fn ipc_add_external(ctx: *Context, newfd: i32) callconv(.C) i32 {
export fn ipc_add_external(ctx: *Context, newfd: i32) callconv(.c) i32 {
ctx.add_external(newfd) catch return -1;
return 0;
}
export fn ipc_add_switch(ctx: *Context, fd1: i32, fd2: i32) callconv(.C) i32 {
export fn ipc_add_switch(ctx: *Context, fd1: i32, fd2: i32) callconv(.c) i32 {
ctx.add_switch(fd1, fd2) catch return -1;
return 0;
}
export fn ipc_set_switch_callbacks(ctx: *Context, fd: i32,
in: ?*const fn (origin: i32, mcontent: [*]u8, mlen: *usize) callconv(.C) u8,
out: ?*const fn (origin: i32, mcontent: [*]const u8, mlen: usize) callconv(.C) u8) callconv(.C) i32 {
in: ?*const fn (origin: i32, mcontent: [*]u8, mlen: *usize) callconv(.c) u8,
out: ?*const fn (origin: i32, mcontent: [*]const u8, mlen: usize) callconv(.c) u8) callconv(.c) i32 {
ctx.set_switch_callbacks(fd, in, out) catch return -1;
return 0;
}

27
src/switch.zig
View file

@ -4,9 +4,8 @@ const fmt = std.fmt;
const net = std.net;
const ipc = @import("./main.zig");
const Message = ipc.Message;
const CBEventType = ipc.CBEvent.Type;
const Message = @import("./message.zig").Message;
const CBEventType = @import("./callback.zig").CBEvent.Type;
const Allocator = std.mem.Allocator;
@ -14,7 +13,7 @@ const util = @import("./util.zig");
const print_eq = util.print_eq;
const log = std.log.scoped(.libipc_switch);
const Event = ipc.Event;
const Event = @import("./event.zig").Event;
/// SwitchDB: store relations between clients and services.
///
@ -65,8 +64,8 @@ pub const SwitchDB = struct {
}
pub fn set_callbacks(self: *Self, fd: i32,
in: ?*const fn (origin: i32, mcontent: [*]u8, mlen: *usize) callconv(.C) u8,
out: ?*const fn (origin: i32, mcontent: [*]const u8, mlen: usize) callconv(.C) u8) !void {
in: ?*const fn (origin: i32, mcontent: [*]u8, mlen: *usize) callconv(.c) u8,
out: ?*const fn (origin: i32, mcontent: [*]const u8, mlen: usize) callconv(.c) u8) !void {
var managedconnection = self.db.get(fd) orelse return error.unregisteredFD;
if (in) |f| { managedconnection.in = f; }
if (out) |f| { managedconnection.out = f; }
@ -186,13 +185,13 @@ pub const SwitchDB = struct {
const ManagedConnection = struct {
dest: i32,
in: *const fn (origin: i32, mcontent: [*]u8, mlen: *usize) callconv(.C) u8 = default_in,
out: *const fn (origin: i32, mcontent: [*]const u8, mlen: usize) callconv(.C) u8 = default_out,
in: *const fn (origin: i32, mcontent: [*]u8, mlen: *usize) callconv(.c) u8 = default_in,
out: *const fn (origin: i32, mcontent: [*]const u8, mlen: usize) callconv(.c) u8 = default_out,
};
test "creation and display" {
const config = .{ .safety = true };
var gpa = std.heap.GeneralPurposeAllocator(config){};
var gpa = std.heap.DebugAllocator(config){};
defer _ = gpa.deinit();
const allocator = gpa.allocator();
@ -222,7 +221,7 @@ fn successful_out(_: i32, _: [*]const u8, _: usize) CBEventType {
test "successful exchanges" {
const config = .{ .safety = true };
var gpa = std.heap.GeneralPurposeAllocator(config){};
var gpa = std.heap.DebugAllocator(config){};
defer _ = gpa.deinit();
const allocator = gpa.allocator();
@ -265,7 +264,7 @@ fn unsuccessful_out(_: i32, _: [*]const u8, _: usize) CBEventType {
test "unsuccessful exchanges" {
const config = .{ .safety = true };
var gpa = std.heap.GeneralPurposeAllocator(config){};
var gpa = std.heap.DebugAllocator(config){};
defer _ = gpa.deinit();
const allocator = gpa.allocator();
@ -296,7 +295,7 @@ test "unsuccessful exchanges" {
test "nuke 'em" {
const config = .{ .safety = true };
var gpa = std.heap.GeneralPurposeAllocator(config){};
var gpa = std.heap.DebugAllocator(config){};
defer _ = gpa.deinit();
const allocator = gpa.allocator();
@ -311,7 +310,7 @@ test "nuke 'em" {
try testing.expect(switchdb.db.count() == 0);
}
fn default_in(origin: i32, mcontent: [*]u8, mlen: *usize) callconv(.C) u8 {
fn default_in(origin: i32, mcontent: [*]u8, mlen: *usize) callconv(.c) u8 {
// This may be kinda hacky, idk.
var stream: net.Stream = .{ .handle = origin };
const packet_size: usize = stream.read(mcontent[0..mlen.*]) catch return @intFromEnum(CBEventType.ERROR);
@ -327,7 +326,7 @@ fn default_in(origin: i32, mcontent: [*]u8, mlen: *usize) callconv(.C) u8 {
return @intFromEnum(CBEventType.NO_ERROR);
}
fn default_out(fd: i32, mcontent: [*]const u8, mlen: usize) callconv(.C) u8 {
fn default_out(fd: i32, mcontent: [*]const u8, mlen: usize) callconv(.c) u8 {
// Message contains the fd, no need to search for the right structure to copy,
// let's just recreate a Stream from the fd.

4
src/main.zig → src/zigroot.zig
View file

@ -1,14 +1,14 @@
// Provide a convenient access to all `libipc` functions for Zig applications.
pub const CBEvent = @import("./callback.zig").CBEvent;
pub const Connection = @import("./connection.zig").Connection;
pub const Message = @import("./message.zig").Message;
pub const Event = @import("./event.zig").Event;
pub const Switch = @import("./switch.zig").Switch;
pub const Messages = @import("./message.zig").Messages;
pub const Switches = @import("./switch.zig").Switches;
pub const Connections = @import("./connection.zig").Connections;
pub const Context = @import("./context.zig").Context;
pub const util = @import("./util.zig");
pub const hexdump = @import("./hexdump.zig");
pub const exchangefd = @import("./exchange-fd.zig");