From 9034899b3e8158cb35d3d62a64082ce67c72d669 Mon Sep 17 00:00:00 2001 From: Baitinq Date: Sat, 4 Jan 2025 00:02:56 +0100 Subject: Call c from zig --- .gitignore | 3 ++ build.zig | 70 +++++++++++++++++++++++++++++++++ build.zig.zon | 72 ++++++++++++++++++++++++++++++++++ lib/hashtable.c | 119 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ lib/hashtable.h | 16 ++++++++ src/hashtable.c | 119 -------------------------------------------------------- src/hashtable.h | 16 -------- src/main.c | 54 ------------------------- src/main.zig | 31 +++++++++++++++ 9 files changed, 311 insertions(+), 189 deletions(-) create mode 100644 build.zig create mode 100644 build.zig.zon create mode 100644 lib/hashtable.c create mode 100644 lib/hashtable.h delete mode 100644 src/hashtable.c delete mode 100644 src/hashtable.h delete mode 100644 src/main.c create mode 100644 src/main.zig diff --git a/.gitignore b/.gitignore index f480dc4..23b6b27 100644 --- a/.gitignore +++ b/.gitignore @@ -2,4 +2,7 @@ *.o +zig-out/ +.zig-cache/ + main diff --git a/build.zig b/build.zig new file mode 100644 index 0000000..faca0bd --- /dev/null +++ b/build.zig @@ -0,0 +1,70 @@ +const std = @import("std"); + +// Although this function looks imperative, note that its job is to +// declaratively construct a build graph that will be executed by an external +// runner. +pub fn build(b: *std.Build) void { + // Standard target options allows 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(.{}); + + const exe = b.addExecutable(.{ + .name = "c-hashtable", + .root_source_file = b.path("src/main.zig"), + .target = target, + .optimize = optimize, + }); + exe.addIncludePath(b.path("lib")); + exe.linkLibC(); + + // This declares intent for the executable to be installed into the + // standard location when the user invokes the "install" step (the default + // step when running `zig build`). + b.installArtifact(exe); + + // This *creates* a Run step in the build graph, to be executed when another + // step is evaluated that depends on it. The next line below will establish + // such a dependency. + const run_cmd = b.addRunArtifact(exe); + + // 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. + // 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()); + + // 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_cmd.addArgs(args); + } + + // This creates a build step. It will be visible in the `zig build --help` menu, + // and can be selected like this: `zig build run` + // This will evaluate the `run` step rather than the default, which is "install". + const run_step = b.step("run", "Run the app"); + run_step.dependOn(&run_cmd.step); + + const exe_unit_tests = b.addTest(.{ + .root_source_file = b.path("src/main.zig"), + .target = target, + .optimize = optimize, + }); + exe_unit_tests.addIncludePath(b.path("lib")); + exe_unit_tests.linkLibC(); + + const run_exe_unit_tests = b.addRunArtifact(exe_unit_tests); + + // Similar to creating the run step earlier, this exposes a `test` step to + // the `zig build --help` menu, providing a way for the user to request + // running the unit tests. + const test_step = b.step("test", "Run unit tests"); + test_step.dependOn(&run_exe_unit_tests.step); +} diff --git a/build.zig.zon b/build.zig.zon new file mode 100644 index 0000000..497b8db --- /dev/null +++ b/build.zig.zon @@ -0,0 +1,72 @@ +.{ + // This is the default name used by packages depending on this one. For + // example, when a user runs `zig fetch --save `, 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 = "c-hashtable", + + // 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", + + // This field is optional. + // This is currently advisory only; Zig does not yet do anything + // with this value. + //.minimum_zig_version = "0.11.0", + + // This field is optional. + // Each dependency must either provide a `url` and `hash`, or a `path`. + // `zig build --fetch` can be used to fetch all dependencies of a package, recursively. + // Once all dependencies are fetched, `zig build` no longer requires + // internet connectivity. + .dependencies = .{ + // See `zig fetch --save ` for a command-line interface for adding dependencies. + //.example = .{ + // // When updating this field to a new URL, be sure to delete the corresponding + // // `hash`, otherwise you are communicating that you expect to find the old hash at + // // the new URL. + // .url = "https://example.com/foo.tar.gz", + // + // // This is computed from the file contents of the directory of files that is + // // obtained after fetching `url` and applying the inclusion rules given by + // // `paths`. + // // + // // This field is the source of truth; packages do not come from a `url`; they + // // come from a `hash`. `url` is just one of many possible mirrors for how to + // // obtain a package matching this `hash`. + // // + // // Uses the [multihash](https://multiformats.io/multihash/) format. + // .hash = "...", + // + // // When this is provided, the package is found in a directory relative to the + // // build root. In this case the package's hash is irrelevant and therefore not + // // computed. This field and `url` are mutually exclusive. + // .path = "foo", + + // // When this is set to `true`, a package is declared to be lazily + // // fetched. This makes the dependency only get fetched if it is + // // actually used. + // .lazy = false, + //}, + }, + + // Specifies the set of files and directories that are included in this package. + // Only files and directories listed here are included in the `hash` that + // is computed for this package. Only files listed here will remain on disk + // when using the zig package manager. As a rule of thumb, one should list + // files required for compilation plus any license(s). + // Paths are relative to the build root. Use the empty string (`""`) to refer to + // the build root itself. + // A directory listed here means that all files within, recursively, are included. + .paths = .{ + "build.zig", + "build.zig.zon", + "src", + // For example... + //"LICENSE", + //"README.md", + }, +} diff --git a/lib/hashtable.c b/lib/hashtable.c new file mode 100644 index 0000000..00e05d7 --- /dev/null +++ b/lib/hashtable.c @@ -0,0 +1,119 @@ +#include +#include +#include +#include + +#include "hashtable.h" + +struct { + char* key; + void* data; + int deleted; +} typedef HashTableData; + +struct { + HashTableData* data; + size_t length; +} typedef HashTableBucket; + +struct { + HashTableBucket* buckets; + size_t capacity; +} typedef HashTableImpl; + +static int hash(char* key, size_t bucket_len) { + int sum = 0; + while(*key != '\0') { + sum += *key++; + } + + return sum % bucket_len; +} + +HashTable hashtable_init() { + HashTableImpl* ht = (HashTableImpl*) malloc(sizeof(HashTableImpl)); + + int capacity = 8; + ht->buckets = (HashTableBucket*) calloc(sizeof(HashTableBucket), capacity); + ht->capacity = capacity; + + return (HashTable) ht; +} + +int hashtable_deinit(HashTable* ht) { + HashTableImpl* ht_impl = (HashTableImpl*) *ht; + + for (int i = 0; i < ht_impl->capacity; ++i) { + HashTableBucket bucket = ht_impl->buckets[i]; + free(bucket.data); + } + + free(ht_impl->buckets); + free(ht_impl); + ht = NULL; + return 0; +} + +void* hashtable_get(HashTable ht, char* key) { + HashTableImpl* ht_impl = (HashTableImpl*) ht; + + int index = hash(key, ht_impl->capacity); + + HashTableBucket bucket = ht_impl->buckets[index]; + + for (int i = 0; i < bucket.length; ++i) { + HashTableData data = bucket.data[i]; + if (!data.deleted && strcmp(data.key, key) == 0) return data.data; + } + + return NULL; +} + +int hashtable_put(HashTable ht, char* key, void* val) { + HashTableImpl* ht_impl = (HashTableImpl*) ht; + + int index = hash(key, ht_impl->capacity); + HashTableBucket* bucket = &ht_impl->buckets[index]; + + + //TODO: reuse the deleted? + for (int i = 0; i < bucket->length; ++i) { + HashTableData* data = &bucket->data[i]; + if (strcmp(data->key, key) == 0) { + data->data = val; + data->deleted = 0; + return 0; + } + } + + + //otherwise, realloc + bucket->length++; + bucket->data = realloc(bucket->data, sizeof(HashTableData) * bucket->length); + + HashTableData newData = { + .key = key, + .data = val, + .deleted = 0 + }; + bucket->data[bucket->length - 1] = newData; + + return 0; +} + +int hashtable_remove(HashTable ht, char* key) { + HashTableImpl* ht_impl = (HashTableImpl*) ht; + + int index = hash(key, ht_impl->capacity); + HashTableBucket* bucket = &ht_impl->buckets[index]; + + for (int i = 0; i < bucket->length; ++i) { + HashTableData* data = &bucket->data[i]; + if (strcmp(data->key, key) == 0) { + data->deleted = 1; + return 0; + } + } + + return 0; +} diff --git a/lib/hashtable.h b/lib/hashtable.h new file mode 100644 index 0000000..5bdcb08 --- /dev/null +++ b/lib/hashtable.h @@ -0,0 +1,16 @@ +#ifndef __HASHTABLE_H__ +#define __HASHTABLE_H__ + +void typedef *HashTable; + +HashTable hashtable_init(); + +int hashtable_deinit(HashTable*); + +int hashtable_put(HashTable, char*, void*); + +int hashtable_remove(HashTable, char*); + +void* hashtable_get(HashTable, char*); + +#endif diff --git a/src/hashtable.c b/src/hashtable.c deleted file mode 100644 index 00e05d7..0000000 --- a/src/hashtable.c +++ /dev/null @@ -1,119 +0,0 @@ -#include -#include -#include -#include - -#include "hashtable.h" - -struct { - char* key; - void* data; - int deleted; -} typedef HashTableData; - -struct { - HashTableData* data; - size_t length; -} typedef HashTableBucket; - -struct { - HashTableBucket* buckets; - size_t capacity; -} typedef HashTableImpl; - -static int hash(char* key, size_t bucket_len) { - int sum = 0; - while(*key != '\0') { - sum += *key++; - } - - return sum % bucket_len; -} - -HashTable hashtable_init() { - HashTableImpl* ht = (HashTableImpl*) malloc(sizeof(HashTableImpl)); - - int capacity = 8; - ht->buckets = (HashTableBucket*) calloc(sizeof(HashTableBucket), capacity); - ht->capacity = capacity; - - return (HashTable) ht; -} - -int hashtable_deinit(HashTable* ht) { - HashTableImpl* ht_impl = (HashTableImpl*) *ht; - - for (int i = 0; i < ht_impl->capacity; ++i) { - HashTableBucket bucket = ht_impl->buckets[i]; - free(bucket.data); - } - - free(ht_impl->buckets); - free(ht_impl); - ht = NULL; - return 0; -} - -void* hashtable_get(HashTable ht, char* key) { - HashTableImpl* ht_impl = (HashTableImpl*) ht; - - int index = hash(key, ht_impl->capacity); - - HashTableBucket bucket = ht_impl->buckets[index]; - - for (int i = 0; i < bucket.length; ++i) { - HashTableData data = bucket.data[i]; - if (!data.deleted && strcmp(data.key, key) == 0) return data.data; - } - - return NULL; -} - -int hashtable_put(HashTable ht, char* key, void* val) { - HashTableImpl* ht_impl = (HashTableImpl*) ht; - - int index = hash(key, ht_impl->capacity); - HashTableBucket* bucket = &ht_impl->buckets[index]; - - - //TODO: reuse the deleted? - for (int i = 0; i < bucket->length; ++i) { - HashTableData* data = &bucket->data[i]; - if (strcmp(data->key, key) == 0) { - data->data = val; - data->deleted = 0; - return 0; - } - } - - - //otherwise, realloc - bucket->length++; - bucket->data = realloc(bucket->data, sizeof(HashTableData) * bucket->length); - - HashTableData newData = { - .key = key, - .data = val, - .deleted = 0 - }; - bucket->data[bucket->length - 1] = newData; - - return 0; -} - -int hashtable_remove(HashTable ht, char* key) { - HashTableImpl* ht_impl = (HashTableImpl*) ht; - - int index = hash(key, ht_impl->capacity); - HashTableBucket* bucket = &ht_impl->buckets[index]; - - for (int i = 0; i < bucket->length; ++i) { - HashTableData* data = &bucket->data[i]; - if (strcmp(data->key, key) == 0) { - data->deleted = 1; - return 0; - } - } - - return 0; -} diff --git a/src/hashtable.h b/src/hashtable.h deleted file mode 100644 index 5bdcb08..0000000 --- a/src/hashtable.h +++ /dev/null @@ -1,16 +0,0 @@ -#ifndef __HASHTABLE_H__ -#define __HASHTABLE_H__ - -void typedef *HashTable; - -HashTable hashtable_init(); - -int hashtable_deinit(HashTable*); - -int hashtable_put(HashTable, char*, void*); - -int hashtable_remove(HashTable, char*); - -void* hashtable_get(HashTable, char*); - -#endif diff --git a/src/main.c b/src/main.c deleted file mode 100644 index aa15631..0000000 --- a/src/main.c +++ /dev/null @@ -1,54 +0,0 @@ -#include -#include "hashtable.h" - -int main(int argc, char** argv) { - printf("Testing hashing:\n"); - - HashTable ht = hashtable_init(); - - char* res = (char*) hashtable_get(ht, "a"); - - printf("Result: %s\n", res); - - hashtable_put(ht, "aa", (void*)"x"); - - res = hashtable_get(ht, "aa"); - - printf("Result: %s\n", res); - - hashtable_put(ht, "b", (void*)"1"); - - printf("This should still be x\n"); - - res = hashtable_get(ht, "aa"); - - printf("Result: %s\n", res); - - res = hashtable_get(ht, "b"); - - printf("Result: %s\n", res); - - hashtable_remove(ht, "b"); - - res = hashtable_get(ht, "b"); - - printf("Result: %s\n", res); - - struct test { - int value; - }; - - struct test example = { - .value = 7 - }; - - hashtable_put(ht, "b", (void*)&example); - - struct test* res2 = hashtable_get(ht, "b"); - - printf("Result: %d\n", res2->value); - - hashtable_deinit(&ht); - - return 0; -} diff --git a/src/main.zig b/src/main.zig new file mode 100644 index 0000000..926f26b --- /dev/null +++ b/src/main.zig @@ -0,0 +1,31 @@ +const std = @import("std"); + +const hashtable = @cImport({ + @cInclude("hashtable.c"); +}); + +pub fn main() !void { + std.debug.print("Testing hashmap!\n", .{}); + + var ht = hashtable.hashtable_init(); + defer _ = hashtable.hashtable_deinit(&ht); + + const Example = struct { + data: i32 align(1), + }; + + const data = Example{ + .data = 7, + }; + + _ = hashtable.hashtable_put(ht, @constCast("key"), @constCast(&data)); + const res: *Example = @ptrCast(hashtable.hashtable_get(ht, @constCast("key"))); + std.debug.print("Result: {d}\n", .{res.*.data}); +} + +test "simple test" { + var list = std.ArrayList(i32).init(std.testing.allocator); + defer list.deinit(); // try commenting this out and see if zig detects the memory leak! + try list.append(42); + try std.testing.expectEqual(@as(i32, 42), list.pop()); +} -- cgit 1.4.1