ipcpd: Add broadcast IPCP

This adds a broadcast IPCP that allows us to easily create multicast
applications. The broadcast IPCP accepts flows for "<layer_name>.mc".
A tool, obc (Ouroboros broadcast), is added that sends and reads a
message to a broadcast layer.

Signed-off-by: Dimitri Staessens <dimitri.staessens@ugent.be>
Signed-off-by: Sander Vrijders <sander.vrijders@ugent.be>

1 files changed, 359 insertions, 0 deletions

diff --git a/src/ipcpd/broadcast/main.c b/src/ipcpd/broadcast/main.c
new file mode 100644
index 00000000..8c6bfa71
--- /dev/null
+++ b/src/ipcpd/broadcast/main.c
@@ -0,0 +1,359 @@
+/*
+ * Ouroboros - Copyright (C) 2016 - 2018
+ *
+ * Broadcast IPC Process
+ *
+ *    Dimitri Staessens <dimitri.staessens@ugent.be>
+ *    Sander Vrijders   <sander.vrijders@ugent.be>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., http://www.fsf.org/about/contact/.
+ */
+
+#if defined(__linux__) || defined(__CYGWIN__)
+#define _DEFAULT_SOURCE
+#else
+#define _POSIX_C_SOURCE 200809L
+#endif
+
+#include "config.h"
+
+#define OUROBOROS_PREFIX "broadcast-ipcp"
+
+#include <ouroboros/errno.h>
+#include <ouroboros/hash.h>
+#include <ouroboros/dev.h>
+#include <ouroboros/ipcp-dev.h>
+#include <ouroboros/logs.h>
+#include <ouroboros/notifier.h>
+#include <ouroboros/rib.h>
+#include <ouroboros/time_utils.h>
+
+#include "connmgr.h"
+#include "dt.h"
+#include "enroll.h"
+#include "ipcp.h"
+
+#include <stdbool.h>
+#include <signal.h>
+#include <stdlib.h>
+#include <string.h>
+#include <assert.h>
+#include <inttypes.h>
+
+#define THIS_TYPE IPCP_BROADCAST
+
+static int initialize_components(const struct ipcp_config * conf)
+{
+        ipcpi.layer_name = strdup(conf->layer_info.layer_name);
+        if (ipcpi.layer_name == NULL) {
+                log_err("Failed to set layer name.");
+                goto fail_layer_name;
+        }
+
+        ipcpi.dir_hash_algo = conf->layer_info.dir_hash_algo;
+
+        assert(ipcp_dir_hash_len() != 0);
+
+        if (dt_init()) {
+                log_err("Failed to initialize forwarding component.");
+                goto fail_dt;
+        }
+
+        ipcp_set_state(IPCP_INIT);
+
+        return 0;
+
+ fail_dt:
+        free(ipcpi.layer_name);
+ fail_layer_name:
+        return -1;
+}
+
+static void finalize_components(void)
+{
+        dt_fini();
+
+        free(ipcpi.layer_name);
+}
+
+static int start_components(void)
+{
+        assert(ipcp_get_state() == IPCP_INIT);
+
+        ipcp_set_state(IPCP_OPERATIONAL);
+
+        if (enroll_start()) {
+                log_err("Failed to start enrollment.");
+                goto fail_enroll_start;
+        }
+
+        if (connmgr_start()) {
+                log_err("Failed to start AP connection manager.");
+                goto fail_connmgr_start;
+        }
+
+        return 0;
+
+ fail_connmgr_start:
+        enroll_stop();
+ fail_enroll_start:
+        ipcp_set_state(IPCP_INIT);
+        return -1;
+}
+
+static void stop_components(void)
+{
+        assert(ipcp_get_state() == IPCP_OPERATIONAL ||
+               ipcp_get_state() == IPCP_SHUTDOWN);
+
+        connmgr_stop();
+
+        enroll_stop();
+
+        ipcp_set_state(IPCP_INIT);
+}
+
+static int broadcast_ipcp_enroll(const char *        dst,
+                                 struct layer_info * info)
+{
+        struct conn conn;
+
+        if (connmgr_alloc(COMPID_ENROLL, dst, NULL, &conn)) {
+                log_err("Failed to get connection.");
+                goto fail_er_flow;
+        }
+
+        /* Get boot state from peer. */
+        if (enroll_boot(&conn)) {
+                log_err("Failed to get boot information.");
+                goto fail_enroll_boot;
+        }
+
+        if (initialize_components(enroll_get_conf())) {
+                log_err("Failed to initialize IPCP components.");
+                goto fail_enroll_boot;
+        }
+
+        if (start_components()) {
+                log_err("Failed to start components.");
+                goto fail_start_comp;
+        }
+
+        if (enroll_done(&conn, 0))
+                log_warn("Failed to confirm enrollment with peer.");
+
+        if (connmgr_dealloc(COMPID_ENROLL, &conn))
+                log_warn("Failed to deallocate enrollment flow.");
+
+        log_info("Enrolled with %s.", dst);
+
+        info->dir_hash_algo = ipcpi.dir_hash_algo;
+        strcpy(info->layer_name, ipcpi.layer_name);
+
+        return 0;
+
+ fail_start_comp:
+        finalize_components();
+ fail_enroll_boot:
+        connmgr_dealloc(COMPID_ENROLL, &conn);
+ fail_er_flow:
+        return -1;
+}
+
+static int broadcast_ipcp_bootstrap(const struct ipcp_config * conf)
+{
+        assert(conf);
+        assert(conf->type == THIS_TYPE);
+
+        enroll_bootstrap(conf);
+
+        if (initialize_components(conf)) {
+                log_err("Failed to init IPCP components.");
+                goto fail_init;
+        }
+
+        if (start_components()) {
+                log_err("Failed to init IPCP components.");
+                goto fail_start;
+        }
+
+        log_dbg("Bootstrapped in layer %s.", conf->layer_info.layer_name);
+
+        return 0;
+
+ fail_start:
+        finalize_components();
+ fail_init:
+        return -1;
+}
+
+static int broadcast_ipcp_query(const uint8_t * dst)
+{
+        uint8_t * buf;
+        size_t    len;
+        int       ret;
+        char *    multicast_name;
+        char *    suffix = ".mc";
+
+        len = hash_len(ipcpi.dir_hash_algo);
+        buf =  malloc(len);
+        if (buf == NULL)
+                return -ENOMEM;
+
+        multicast_name = malloc(strlen(ipcpi.layer_name) + strlen(suffix) + 1);
+        if (multicast_name == NULL) {
+                free(buf);
+                return -ENOMEM;
+        }
+
+        strcpy(multicast_name, ipcpi.layer_name);
+        strcat(multicast_name, suffix);
+
+        str_hash(ipcpi.dir_hash_algo, buf, multicast_name);
+
+        free(multicast_name);
+
+        ret = memcmp(buf, dst, len);
+
+        free(buf);
+
+        return ret;
+}
+
+static int broadcast_ipcp_alloc(int             fd,
+                                const uint8_t * dst,
+                                qosspec_t       qs)
+{
+        struct conn conn;
+
+        (void) qs;
+
+        memset(&conn, 0, sizeof(conn));
+
+        conn.flow_info.fd = fd;
+
+        if (broadcast_ipcp_query(dst) != 0)
+                return -1;
+
+        notifier_event(NOTIFY_DT_CONN_ADD, &conn);
+
+        ipcp_flow_alloc_reply(fd, 0);
+
+        return 0;
+}
+
+int broadcast_ipcp_dealloc(int fd)
+{
+        struct conn conn;
+
+        memset(&conn, 0, sizeof(conn));
+
+        conn.flow_info.fd = fd;
+
+        notifier_event(NOTIFY_DT_CONN_DEL, &conn);
+
+        flow_dealloc(fd);
+
+        return 0;
+}
+
+
+static struct ipcp_ops broadcast_ops = {
+        .ipcp_bootstrap       = broadcast_ipcp_bootstrap,
+        .ipcp_enroll          = broadcast_ipcp_enroll,
+        .ipcp_connect         = connmgr_ipcp_connect,
+        .ipcp_disconnect      = connmgr_ipcp_disconnect,
+        .ipcp_reg             = NULL,
+        .ipcp_unreg           = NULL,
+        .ipcp_query           = broadcast_ipcp_query,
+        .ipcp_flow_alloc      = broadcast_ipcp_alloc,
+        .ipcp_flow_alloc_resp = NULL,
+        .ipcp_flow_dealloc    = broadcast_ipcp_dealloc
+};
+
+int main(int    argc,
+         char * argv[])
+{
+        if (ipcp_init(argc, argv, &broadcast_ops) < 0) {
+                log_err("Failed to init IPCP.");
+                goto fail_init;
+        }
+
+        /* These components must be init at creation. */
+        if (rib_init(ipcpi.name)) {
+                log_err("Failed to initialize RIB.");
+                goto fail_rib_init;
+        }
+
+        if (notifier_init()) {
+                log_err("Failed to initialize notifier component.");
+                goto fail_notifier_init;
+        }
+
+        if (connmgr_init()) {
+                log_err("Failed to initialize connection manager.");
+                goto fail_connmgr_init;
+        }
+
+        if (enroll_init()) {
+                log_err("Failed to initialize enrollment component.");
+                goto fail_enroll_init;
+        }
+
+        if (ipcp_boot() < 0) {
+                log_err("Failed to boot IPCP.");
+                goto fail_boot;
+        }
+
+        if (ipcp_create_r(getpid(), 0)) {
+                log_err("Failed to notify IRMd we are initialized.");
+                ipcp_set_state(IPCP_NULL);
+                goto fail_create_r;
+        }
+
+        ipcp_shutdown();
+
+        if (ipcp_get_state() == IPCP_SHUTDOWN) {
+                stop_components();
+                finalize_components();
+        }
+
+        enroll_fini();
+
+        connmgr_fini();
+
+        notifier_fini();
+
+        rib_fini();
+
+        ipcp_fini();
+
+        exit(EXIT_SUCCESS);
+
+ fail_create_r:
+        ipcp_shutdown();
+ fail_boot:
+        enroll_fini();
+ fail_enroll_init:
+        connmgr_fini();
+ fail_connmgr_init:
+        notifier_fini();
+ fail_notifier_init:
+        rib_fini();
+ fail_rib_init:
+        ipcp_fini();
+ fail_init:
+        ipcp_create_r(getpid(), -1);
+        exit(EXIT_FAILURE);
+}