Merge pull request #7 from arceos-hypervisor/bqs

Enhance IVC framework with multi-publisher support and refactor

Author: Josen-B

.clang-format

@@ -0,0 +1,14 @@
+{ 
+    BasedOnStyle: LLVM, 
+    UseTab: Always, 
+    IndentWidth: 4, 
+    TabWidth: 4, 
+    AlignAfterOpenBracket: AlwaysBreak,
+    BreakBeforeBraces: Allman, 
+    # AllowShortIfStatementsOnASingleLine: false, 
+    # IndentCaseLabels: false, 
+    # ColumnLimit: 0, 
+    # AccessModifierOffset: -4, 
+    # NamespaceIndentation: All, 
+    # FixNamespaceComments: false 
+}

arceos-driver/main.c

@@ -0,0 +1 @@
+build/

ivc/.gitignore

@@ -0,0 +1,62 @@
+# Makefile for building components of the IVC (Inter-VM Communication) library: kernel driver, user
+# library, python bindings, and demo applications.
+
+# Basic information
+LIB_NAME 		:= ivc
+
+# Architecture and cross-compilation settings
+ARCH 			?= arm64
+CROSS 			?= aarch64-linux-musl-
+CCOMP 			?= $(CROSS)gcc
+CAR 			?= $(CROSS)ar
+
+# Input, output, and kernel dependency directories
+MAKEFILE_DIR 	:= $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
+
+BUILD_DIR 		?= $(MAKEFILE_DIR)build
+INCLUDE_DIR 	:= $(MAKEFILE_DIR)include
+
+ULIB_SRC_DIR 	:= $(MAKEFILE_DIR)ulib
+DEMO_SRC_DIR 	:= $(MAKEFILE_DIR)demo
+
+# Source files and outputs
+ULIB_SRC 		:= $(wildcard $(ULIB_SRC_DIR)/*.c)
+ULIB_OBJ 		:= $(patsubst $(ULIB_SRC_DIR)/%.c,$(BUILD_DIR)/ulib/%.o,$(ULIB_SRC))
+ULIB_STATIC		:= $(BUILD_DIR)/lib$(LIB_NAME).a
+ULIB_SHARED		:= $(BUILD_DIR)/lib$(LIB_NAME).so
+
+DEMO_SRC 		:= $(wildcard $(DEMO_SRC_DIR)/*.c)
+DEMO_BIN 		:= $(patsubst $(DEMO_SRC_DIR)/%.c,$(BUILD_DIR)/demo/%, $(DEMO_SRC))
+
+
+# Compiler flags
+CFLAGS 			?= -I$(INCLUDE_DIR)
+ULIB_CFLAGS 	?= $(CFLAGS) -Wall -Wextra -Os -s -Wl,--gc-sections -fPIC
+DEMO_CFLAGS 	?= $(CFLAGS) -Wall -Wextra -Os -s -Wl,--gc-sections -static
+
+.PHONY: all ulib demo output_dir clean rebuild
+all: ulib demo
+
+ulib: output_dir $(ULIB_STATIC) $(ULIB_SHARED)
+demo: output_dir $(DEMO_BIN)
+
+$(ULIB_STATIC): $(ULIB_OBJ)
+	$(CAR) rcs $@ $^
+
+$(ULIB_SHARED): $(ULIB_OBJ)
+	$(CCOMP) -shared -o $@ $^
+
+$(BUILD_DIR)/ulib/%.o: $(ULIB_SRC_DIR)/%.c
+	$(CCOMP) $(ULIB_CFLAGS) -c $< -o $@
+
+$(BUILD_DIR)/demo/%: $(DEMO_SRC_DIR)/%.c $(ULIB_STATIC)
+	$(CCOMP) $(DEMO_CFLAGS) -o $@ $< -L$(BUILD_DIR) -l$(LIB_NAME)
+
+output_dir:
+	@mkdir -p $(BUILD_DIR)/ulib
+	@mkdir -p $(BUILD_DIR)/demo
+
+clean:
+	rm -rf $(BUILD_DIR)
+
+rebuild: clean all

ivc/Makefile

@@ -0,0 +1,49 @@
+#include <ivc/ulib.h>
+#include <stdio.h>
+#include <string.h>
+#include <stdlib.h>
+
+char message[1024];
+int main(int argc, char *argv[]) {
+    if (argc != 2) {
+        fprintf(stderr, "Usage: %s <channel_key>\n", argv[0]);
+        return 1;
+    }
+    uint64_t channel_key = strtoull(argv[1], NULL, 0);
+
+    int ret = 0;
+
+    ivc_manager_p manager = ivc_open_manager();
+    if (!manager) {
+        fprintf(stderr, "Failed to open IVC manager\n");
+        return 1;
+    }
+
+    ivc_publisher_p publisher = ivc_publish(manager, channel_key, 16 * 1024);
+    if (!publisher) {
+        fprintf(stderr, "Failed to publish channel\n");
+        ret = 2;
+        goto close_manager;
+    }
+
+    while (scanf("%1023s", message) == 1) {
+        if (ivc_write_all(publisher, message, strlen(message)) < 0) {
+            fprintf(stderr, "Failed to write to publisher\n");
+            ret = 3;
+            break;
+        }
+        printf("Published: %s, total published: %lu\n", message, publisher->write);
+    }
+
+    if (ivc_unpublish(publisher) < 0) {
+        fprintf(stderr, "Failed to unpublish publisher\n");
+        ret = 4;
+    }
+close_manager:
+    if (ivc_close_manager(manager) < 0) {
+        fprintf(stderr, "Failed to close IVC manager\n");
+        ret = 5;
+    }
+    printf("IVC publisher example finished.\n");
+    return ret;
+}

ivc/demo/publish.c

@@ -0,0 +1,72 @@
+#include <ivc/ulib.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <unistd.h>
+
+char message[1024];
+int main(int argc, char *argv[]) {
+    unsigned long target_count = 5;
+    unsigned long received = 0;
+    unsigned long empty_polls = 0;
+
+    if (argc != 3 && argc != 4) {
+        fprintf(stderr, "Usage: %s <target_publisher_id> <channel_key> [message_count]\n", argv[0]);
+        return 1;
+    }
+    uint64_t target_publisher_id = strtoull(argv[1], NULL, 0);
+    uint64_t channel_key = strtoull(argv[2], NULL, 0);
+    if (argc == 4) {
+        target_count = strtoul(argv[3], NULL, 0);
+    }
+
+    int ret = 0;
+
+    ivc_manager_p manager = ivc_open_manager();
+    if (!manager) {
+        fprintf(stderr, "Failed to open IVC manager\n");
+        return 1;
+    }
+
+    ivc_subscriber_p subscriber = ivc_subscribe(manager, target_publisher_id, channel_key);
+    if (!subscriber) {
+        fprintf(stderr, "Failed to subscribe to channel\n");
+        ret = 2;
+        goto close_manager;
+    }
+
+    while (received < target_count) {
+        int bytes_read = ivc_read(subscriber, message, sizeof(message) - 1);
+        if (bytes_read < 0) {
+            fprintf(stderr, "Failed to read from subscriber\n");
+            ret = 2;
+            break;
+        } else if (bytes_read == 0) {
+            if (++empty_polls > 200000) {
+                fprintf(stderr, "Timed out waiting for IVC messages\n");
+                ret = 5;
+                break;
+            }
+            usleep(10000);
+        } else {
+            message[bytes_read] = '\0'; // Null-terminate the string
+            received++;
+            empty_polls = 0;
+            printf("linux ivc recv %lu/%lu: %s\n", received, target_count, message);
+        }
+    }
+    if (ret == 0) {
+        printf("linux ivc demo pass\n");
+    }
+
+    if (ivc_unsubscribe(subscriber) < 0) {
+        fprintf(stderr, "Failed to unsubscribe from channel\n");
+        ret = 3;
+    }
+close_manager:
+    if (ivc_close_manager(manager) < 0) {
+        fprintf(stderr, "Failed to close IVC manager\n");
+        ret = 4;
+    }
+    printf("IVC subscriber example finished.\n");
+    return ret;
+}

ivc/demo/subscribe.c

@@ -0,0 +1,25 @@
+#pragma once
+
+#include "./ivc_dev.h"
+
+#ifndef __KERNEL__
+# include <sys/ioctl.h>
+# include <stdint.h>
+#endif
+
+typedef struct ivc_publish_arg {
+    uint64_t    channel_key;                            // Unique key for the channel
+    uint64_t    channel_size;                           // Size of the channel in bytes
+    char        device_name[MAX_IVC_DEV_NAME_LENGTH];   // Returns the device name for the channel
+} ivc_publish_arg_t, *ivc_publish_arg_p;
+
+typedef struct ivc_subscribe_arg {
+    uint64_t    target_publisher_id;                    // ID of the publisher to subscribe to (VM ID is used as for now)
+    uint64_t    channel_key;                            // Key of the channel to subscribe to
+    char        device_name[MAX_IVC_DEV_NAME_LENGTH];   // Returns the device name for the channel
+} ivc_subscribe_arg_t, *ivc_subscribe_arg_p;
+
+#define IVC_PUBLISH_CHANNEL _IOW(0, 0, ivc_publish_arg_t)
+#define IVC_UNPUBLISH_CHANNEL _IOW(0, 1, ivc_publish_arg_t)
+#define IVC_SUBSCRIBE_CHANNEL _IOW(0, 2, ivc_subscribe_arg_t)
+#define IVC_UNSUBSCRIBE_CHANNEL _IOW(0, 3, ivc_subscribe_arg_t)

ivc/include/ivc/ioctl_args.h

@@ -0,0 +1,11 @@
+#pragma once
+
+#define IVC_DEV_NAME    "axivc"
+
+#define IVC_PUBLISHER_DEV_NAME_PREFIX   "axivc_publisher_"
+#define IVC_SUBSCRIBER_DEV_NAME_PREFIX  "axivc_subscriber_"
+
+#define MAX_IVC_DEV_NAME_LENGTH  64
+
+#define DEV_PATH_PREFIX "/dev/"
+#define IVC_DEV_PATH (DEV_PATH_PREFIX IVC_DEV_NAME)

ivc/include/ivc/ivc_dev.h

@@ -0,0 +1,47 @@
+#pragma once
+
+#include "./ioctl_args.h"
+
+#include <stdio.h>
+#include <stddef.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// TODO: record publishers and subscribers created and recycle them when close the IVC manager.
+typedef struct ivc_manager {
+    int64_t             fd;                 // File descriptor for the IVC device
+} ivc_manager_t, *ivc_manager_p;
+
+ivc_manager_p ivc_open_manager(void);
+int ivc_close_manager(ivc_manager_p manager);
+
+
+typedef struct ivc_subscriber {
+    ivc_manager_p       manager;            // Pointer to the IVC manager
+    ivc_subscribe_arg_t subscribe_arg;      // Subscription argument structure
+    int64_t             fd;                 // File descriptor for the subscriber's device
+    uint64_t            read;               // Number of bytes read from the channel
+} ivc_subscriber_t, *ivc_subscriber_p;
+
+ivc_subscriber_p ivc_subscribe(ivc_manager_p manager, uint64_t publisher_id, uint64_t channel_key);
+int ivc_read(ivc_subscriber_p subscriber, void *buf, size_t count);
+int ivc_unsubscribe(ivc_subscriber_p subscriber);
+
+
+typedef struct ivc_publisher {
+    ivc_manager_p       manager;            // Pointer to the IVC manager
+    ivc_publish_arg_t   publish_arg;        // Publish argument structure
+    int64_t             fd;                 // File descriptor for the publisher's device
+    uint64_t            write;              // Number of bytes written to the channel
+} ivc_publisher_t, *ivc_publisher_p;
+
+ivc_publisher_p ivc_publish(ivc_manager_p manager, uint64_t channel_key, uint64_t channel_size);
+int ivc_write(ivc_publisher_p publisher, const void *buf, size_t count);
+int ivc_write_all(ivc_publisher_p publisher, const void *buf, size_t count);
+int ivc_unpublish(ivc_publisher_p publisher);
+
+#ifdef __cplusplus
+}
+#endif

ivc/include/ivc/ulib.h

@@ -0,0 +1,18 @@
+bin
+modules
+.tmp_versions
+.vscode
+__pycache__
+
+*.so
+*.ko
+*.mod
+*.o
+*.d
+*.cmd
+*.d
+**/Module.*
+**/modules.*
+*_wrap.c
+**/*.dat
+*.mod.c