summaryrefslogtreecommitdiff
path: root/include/ouroboros
diff options
context:
space:
mode:
Diffstat (limited to 'include/ouroboros')
-rw-r--r--include/ouroboros/cdap.h171
-rw-r--r--include/ouroboros/common.h56
-rw-r--r--include/ouroboros/da.h31
-rw-r--r--include/ouroboros/dev.h52
-rw-r--r--include/ouroboros/ipcp.h43
-rw-r--r--include/ouroboros/irm.h45
-rw-r--r--include/ouroboros/logs.h48
7 files changed, 446 insertions, 0 deletions
diff --git a/include/ouroboros/cdap.h b/include/ouroboros/cdap.h
new file mode 100644
index 00000000..f1abeff5
--- /dev/null
+++ b/include/ouroboros/cdap.h
@@ -0,0 +1,171 @@
+/*
+ * Ouroboros - Copyright (C) 2016
+ *
+ * The Common Distributed Application Protocol
+ *
+ * Sander Vrijders <sander.vrijders@intec.ugent.be>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * 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., 675 Mass Ave, Cambridge, MA 02139, USA.
+ */
+
+#ifndef OUROBOROS_CDAP_H
+#define OUROBOROS_CDAP_H
+
+#include "common.h"
+#include <stdbool.h>
+
+struct cdap;
+
+struct cdap_ops {
+ /* Sender related callbacks */
+ int (* handle_connect_r)(port_id_t id,
+ int invoke_id,
+ int result);
+ int (* handle_release_r)(port_id_t id,
+ int invoke_id,
+ int result);
+ int (* handle_read_r)(port_id_t id,
+ int invoke_id,
+ int result,
+ char * reason,
+ char * obj_val,
+ bool complete);
+ int (* handle_cancelread_r)(port_id_t id,
+ int invoke_id,
+ int result);
+ int (* handle_write_r)(port_id_t id,
+ int invoke_id,
+ int result,
+ char * reason,
+ char * obj_val);
+ int (* handle_create_r)(port_id_t id,
+ int invoke_id,
+ int result);
+ int (* handle_delete_r)(port_id_t id,
+ int invoke_id,
+ int result);
+ int (* handle_start_r)(port_id_t id,
+ int invoke_id,
+ int result);
+ int (* handle_stop_r)(port_id_t id,
+ int invoke_id,
+ int result);
+
+ /* Receiver related callbacks */
+ int (* handle_connect)(port_id_t id,
+ int invoke_id,
+ rina_name_t src,
+ rina_name_t dst,
+ char * auth_mech,
+ char * auth_val);
+ int (* handle_release)(port_id_t id,
+ int invoke_id);
+ int (* handle_cancelread)(port_id_t id,
+ int invoke_id);
+ int (* handle_write)(port_id_t id,
+ int invoke_id,
+ char * obj_name,
+ char * obj_val);
+ int (* handle_create)(port_id_t id,
+ int invoke_id,
+ char * obj_class,
+ char * obj_name,
+ char * obj_val);
+ int (* handle_delete)(port_id_t id,
+ int invoke_id,
+ char * obj_name);
+ int (* handle_start)(port_id_t id,
+ int invoke_id,
+ char * obj_name,
+ char * obj_val);
+ int (* handle_stop)(port_id_t id,
+ int invoke_id,
+ char * obj_name,
+ char * obj_val);
+};
+
+struct cdap * cdap_create(struct cdap_ops ops,
+ port_id_t id);
+int cdap_destroy(struct cdap * instance);
+
+/* Sender related functions */
+int cdap_send_connect(struct cdap * instance,
+ int invoke_id,
+ rina_name_t src,
+ rina_name_t dst,
+ char * auth_mech,
+ char * auth_val);
+int cdap_send_release(struct cdap * instance,
+ int invoke_id);
+int cdap_send_read(struct cdap * instance,
+ int invoke_id,
+ char * obj_name);
+int cdap_send_cancelread(struct cdap * instance,
+ int invoke_id,
+ char * obj_name);
+int cdap_send_write(struct cdap * instance,
+ int invoke_id,
+ char * obj_name,
+ char * obj_val);
+int cdap_send_create(struct cdap * instance,
+ int invoke_id,
+ char * obj_name,
+ char * obj_val);
+int cdap_send_delete(struct cdap * instance,
+ int invoke_id,
+ char * obj_name);
+int cdap_send_start(struct cdap * instance,
+ int invoke_id,
+ char * obj_name,
+ char * obj_val);
+int cdap_send_stop(struct cdap * instance,
+ int invoke_id,
+ char * obj_name,
+ char * obj_val);
+
+/* Receiver related functions */
+int cdap_send_connect_r(struct cdap * instance,
+ int invoke_id,
+ int result);
+int cdap_send_release_r(struct cdap * instance,
+ int invoke_id,
+ int result);
+int cdap_send_read_r(struct cdap * instance,
+ int invoke_id,
+ int result,
+ char * reason,
+ char * obj_val,
+ bool complete);
+int cdap_send_cancelread_r(struct cdap * instance,
+ int invoke_id,
+ int result);
+int cdap_send_write_r(struct cdap * instance,
+ int invoke_id,
+ int result,
+ char * obj_name,
+ char * obj_val);
+int cdap_send_create_r(struct cdap * instance,
+ int invoke_id,
+ int result);
+int cdap_send_delete_r(struct cdap * instance,
+ int invoke_id,
+ int result);
+int cdap_send_start_r(struct cdap * instance,
+ int invoke_id,
+ int result);
+int cdap_send_stop_r(struct cdap * instance,
+ int invoke_id,
+ int result);
+#endif
diff --git a/include/ouroboros/common.h b/include/ouroboros/common.h
new file mode 100644
index 00000000..f2be815f
--- /dev/null
+++ b/include/ouroboros/common.h
@@ -0,0 +1,56 @@
+/*
+ * Ouroboros - Copyright (C) 2016
+ *
+ * Common definitions
+ *
+ * Sander Vrijders <sander.vrijders@intec.ugent.be>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * 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., 675 Mass Ave, Cambridge, MA 02139, USA.
+ */
+
+#ifndef OUROBOROS_COMMON_H
+#define OUROBOROS_COMMON_H
+
+#include <stdint.h>
+
+typedef uint32_t port_id_t;
+
+/* FIXME: To be moved into a separate file */
+typedef struct {
+ char * data;
+ size_t size;
+} buffer_t;
+
+typedef struct {
+ char * ap_name;
+ int api_id;
+ char * ae_name;
+ int aei_id;
+} rina_name_t;
+
+/* FIXME: To be extended to have all QoS params */
+struct qos_spec {
+ char * name;
+ char * dif_name;
+ double delay;
+ double jitter;
+};
+
+/* FIXME: What should be configurable in the DIF? */
+struct dif_info {
+ int cep_id_size;
+};
+
+#endif
diff --git a/include/ouroboros/da.h b/include/ouroboros/da.h
new file mode 100644
index 00000000..62bc66e5
--- /dev/null
+++ b/include/ouroboros/da.h
@@ -0,0 +1,31 @@
+/*
+ * Ouroboros - Copyright (C) 2016
+ *
+ * The API to consult the DIF Allocator
+ *
+ * Sander Vrijders <sander.vrijders@intec.ugent.be>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * 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., 675 Mass Ave, Cambridge, MA 02139, USA.
+ */
+
+#ifndef OUROBOROS_DA_H
+#define OUROBOROS_DA_H
+
+#include "common.h"
+
+rina_name_t da_resolve_daf(char * daf_name);
+char ** da_resolve_dap(rina_name_t * name);
+
+#endif
diff --git a/include/ouroboros/dev.h b/include/ouroboros/dev.h
new file mode 100644
index 00000000..217352ef
--- /dev/null
+++ b/include/ouroboros/dev.h
@@ -0,0 +1,52 @@
+/*
+ * Ouroboros - Copyright (C) 2016
+ *
+ * API for applications
+ *
+ * Sander Vrijders <sander.vrijders@intec.ugent.be>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * 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., 675 Mass Ave, Cambridge, MA 02139, USA.
+ */
+
+#ifndef OUROBOROS_DEV_H
+#define OUROBOROS_DEV_H
+
+#include "common.h"
+
+struct qos_spec * list_qos_cubes(rina_name_t dst,
+ struct qos_spec min_qos);
+
+/* Returns file descriptor */
+int ap_reg(rina_name_t name, char ** difs);
+int ap_unreg(rina_name_t name, char ** difs);
+
+/* Returns file descriptor (> 0) */
+int flow_accept(int fd, rina_name_t * name);
+int flow_alloc_resp(int fd, int result);
+
+/* Returns file descriptor */
+int flow_alloc(rina_name_t src, rina_name_t dst,
+ struct qos_spec qos, int oflags);
+
+/* If flow is accepted returns a value > 0 */
+int flow_alloc_res(int fd);
+int flow_dealloc(int fd);
+
+/* Wraps around fnctl */
+int flow_cntl(int fd, int oflags);
+int flow_write(int fd, buffer_t * sdu);
+int flow_read(int fd, buffer_t * sdu);
+
+#endif
diff --git a/include/ouroboros/ipcp.h b/include/ouroboros/ipcp.h
new file mode 100644
index 00000000..91223bec
--- /dev/null
+++ b/include/ouroboros/ipcp.h
@@ -0,0 +1,43 @@
+/*
+ * Ouroboros - Copyright (C) 2016
+ *
+ * The API for the IRM to instruct IPCPs
+ *
+ * Sander Vrijders <sander.vrijders@intec.ugent.be>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * 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., 675 Mass Ave, Cambridge, MA 02139, USA.
+ */
+
+#ifndef OUROBOROS_IPCP_H
+#define OUROBOROS_IPCP_H
+
+#include "common.h"
+
+int ipcp_create(rina_name_t name,
+ char * ipcp_type);
+int ipcp_destroy(int instance);
+
+int ipcp_reg(int instance,
+ char ** difs);
+int ipcp_unreg(int instance,
+ char ** difs);
+
+int ipcp_bootstrap(int instance,
+ struct dif_info info);
+int ipcp_enroll(int instance,
+ char * dif_name,
+ rina_name_t member);
+
+#endif
diff --git a/include/ouroboros/irm.h b/include/ouroboros/irm.h
new file mode 100644
index 00000000..954e4b2d
--- /dev/null
+++ b/include/ouroboros/irm.h
@@ -0,0 +1,45 @@
+/*
+ * Ouroboros - Copyright (C) 2016
+ *
+ * The API to instruct the IRM
+ *
+ * Sander Vrijders <sander.vrijders@intec.ugent.be>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * 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., 675 Mass Ave, Cambridge, MA 02139, USA.
+ */
+
+#ifndef OUROBOROS_IRM_H
+#define OUROBOROS_IRM_H
+
+#include "common.h"
+
+int irm_create_ipcp(rina_name_t name,
+ char * ipcp_type);
+int irm_destroy_ipcp(int ipcp_id);
+
+int irm_bootstrap_ipcp(int ipcp_id,
+ struct dif_info info);
+int irm_enroll_ipcp(int ipcp_id,
+ char * dif_name);
+
+int irm_reg_ipcp(int ipcp_id,
+ char ** difs);
+int irm_unreg_ipcp(int ipcp_id,
+ char ** difs);
+
+char ** irm_list_ipcps();
+char ** irm_list_ipcp_types();
+
+#endif
diff --git a/include/ouroboros/logs.h b/include/ouroboros/logs.h
new file mode 100644
index 00000000..c72fb9ae
--- /dev/null
+++ b/include/ouroboros/logs.h
@@ -0,0 +1,48 @@
+/*
+ * Ouroboros - Copyright (C) 2016
+ *
+ * Logging facilities
+ *
+ * Sander Vrijders <sander.vrijders@intec.ugent.be>
+ * Francesco Salvestrini <f.salvestrini@nextworks.it>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * 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., 675 Mass Ave, Cambridge, MA 02139, USA.
+ */
+
+#ifndef OUROBOROS_LOGS_H
+#define OUROBOROS_LOGS_H
+
+#include <stdio.h>
+
+#ifndef OUROBOROS_PREFIX
+#error You must define OUROBOROS_PREFIX before including this file
+#endif
+
+#define __LOG(PFX, LVL, FMT, ARGS...) \
+ do { printf(PFX "(" LVL "): " FMT "\n", ##ARGS); } while (0)
+
+#define LOG_ERR(FMT, ARGS...) __LOG(OUROBOROS_PREFIX, "ERR", FMT, ##ARGS)
+#define LOG_WARN(FMT, ARGS...) __LOG(OUROBOROS_PREFIX, "WARN", FMT, ##ARGS)
+#define LOG_INFO(FMT, ARGS...) __LOG(OUROBOROS_PREFIX, "INFO", FMT, ##ARGS)
+
+#ifdef CONFIG_OUROBOROS_DEBUG
+#define LOG_DBG(FMT, ARGS...) __LOG(OUROBOROS_PREFIX, "DBG", FMT, ##ARGS)
+#else
+#define LOG_DBG(FMT, ARGS...) do { } while (0)
+#endif
+
+#define LOG_MISSING LOG_ERR("Missing code in %s:%d",__FILE__, __LINE__)
+
+#endif