ipcpd: initial IPC processes

Basic functions for implementation of IPC processes, and
implementation of core functions of the shim IPCP over UDP.  Updates
to the build system to compile these IPC processes, as well as some
fixes in the irmd (rudimentary capturing exit signals) and some fixes
in the library, mainly relating to the messaging.

Basic implementation of creation / bootstrapping / deletion of the
shim UDP. Placeholders for other functions.

7 files changed, 468 insertions, 0 deletions

diff --git a/src/ipcpd/normal/CMakeLists.txt b/src/ipcpd/normal/CMakeLists.txt
new file mode 100644
index 00000000..c13cbaa3
--- /dev/null
+++ b/src/ipcpd/normal/CMakeLists.txt
@@ -0,0 +1,32 @@
+get_filename_component(CURRENT_SOURCE_PARENT_DIR ${CMAKE_CURRENT_SOURCE_DIR} DIRECTORY)
+get_filename_component(CURRENT_BINARY_PARENT_DIR ${CMAKE_CURRENT_BINARY_DIR} DIRECTORY)
+
+include_directories(${CMAKE_CURRENT_SOURCE_DIR})
+include_directories(${CMAKE_CURRENT_BINARY_DIR})
+
+include_directories(${CURRENT_SOURCE_PARENT_DIR})
+include_directories(${CURRENT_BINARY_PARENT_DIR})
+
+include_directories(${CMAKE_SOURCE_DIR}/include)
+include_directories(${CMAKE_BINARY_DIR}/include)
+
+SET(IPCP_NORMAL_TARGET ipcpd-normal CACHE STRING "IPCP_NORMAL_TARGET")
+
+set(SOURCE_FILES
+        # Add source files here
+        main.c
+        pci.c
+)
+
+add_executable (ipcpd-normal ${SOURCE_FILES} ${IPCP_SOURCES})
+target_link_libraries (ipcpd-normal LINK_PUBLIC ouroboros)
+
+include(MacroAddCompileFlags)
+if (CMAKE_BUILD_TYPE MATCHES Debug)
+   MACRO_ADD_COMPILE_FLAGS(ipcpd-normal -DCONFIG_OUROBOROS_DEBUG)
+endif (CMAKE_BUILD_TYPE MATCHES Debug)
+
+install(TARGETS ipcpd-normal RUNTIME DESTINATION bin)
+
+# Enable once ipcp-normal has tests
+# add_subdirectory(tests)
diff --git a/src/ipcpd/normal/dt_const.h b/src/ipcpd/normal/dt_const.h
new file mode 100644
index 00000000..bc0c1466
--- /dev/null
+++ b/src/ipcpd/normal/dt_const.h
@@ -0,0 +1,44 @@
+/*
+ * Ouroboros - Copyright (C) 2016
+ *
+ * Data Transfer Constants for the IPCP
+ *
+ *    Dimitri Staessens <[email protected]>
+ *    Sander Vrijders   <[email protected]>
+ *
+ * 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 IPCP_DT_CONST_H
+#define IPCP_DT_CONST_H
+
+#include "ouroboros/common.h"
+
+struct ipcp_dtp_const {
+        /* sizes in octets */
+        uint8_t addr_size;
+        uint8_t cep_id_size;
+        uint8_t pdu_length_size;
+        uint8_t seqno_size;
+        uint8_t qos_id_size;
+        /* uint8_t ctrl_sqnum_sz;  is this in the spec?? */
+};
+
+struct ipcp_dup_const {
+        uint8_t ttl_size;
+        uint8_t chk_size;
+};
+
+#endif /* IPCP_DT_CONST_H */
diff --git a/src/ipcpd/normal/main.c b/src/ipcpd/normal/main.c
new file mode 100644
index 00000000..7ffd1c48
--- /dev/null
+++ b/src/ipcpd/normal/main.c
@@ -0,0 +1,15 @@
+#define OUROBOROS_PREFIX "ipcp"
+
+#include <ouroboros/logs.h>
+#include <stdbool.h>
+
+int main()
+{
+        LOG_DBG("Test of the IPCP");
+
+        while (true) {
+
+        }
+
+        return 0;
+}
diff --git a/src/ipcpd/normal/pci.c b/src/ipcpd/normal/pci.c
new file mode 100644
index 00000000..d7df52b6
--- /dev/null
+++ b/src/ipcpd/normal/pci.c
@@ -0,0 +1,146 @@
+/*
+ * Ouroboros - Copyright (C) 2016
+ *
+ * Protocol Control Information
+ *
+ *    Dimitri Staessens <[email protected]>
+ *    Sander Vrijders   <[email protected]>
+ *
+ * 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.
+ */
+
+#include "pci.h"
+#include <stdlib.h>
+#include <errno.h>
+
+#define OUROBOROS_PREFIX "ipcp/pci"
+
+#include <ouroboros/logs.h>
+
+#define PCI_HEAD_SIZE(a, b) a.addr_size * 2 +  \
+        a.cep_id_size * 2 +                    \
+        a.pdu_length_size +                    \
+        b.ttl_size +                           \
+        a.seqno_size +                         \
+        a.qos_id_size
+#define PCI_TAIL_SIZE(b) b.chk_size
+
+
+struct pci {
+        /* head */
+        uint8_t * dst_addr;
+        uint8_t * src_addr;
+        uint8_t * dst_cep_id;
+        uint8_t * src_cep_id;
+        uint8_t * pdu_length;
+        uint8_t * ttl;
+        uint8_t * seqno;
+        uint8_t * qos_id;
+
+        uint8_t * chk;
+
+        du_buff_t * dub;
+
+        struct ipcp_dtp_const dtpc;
+        struct ipcp_dup_const dupc;
+
+};
+
+pci_t * pci_create(du_buff_t                   * dub,
+                   const struct ipcp_dtp_const * dtpc,
+                   const struct ipcp_dup_const * dupc)
+{
+        struct pci * p;
+
+        if (dub == NULL) {
+                LOG_DBGF("Bogus input. Bugging out.");
+                return NULL;
+        }
+
+        p = malloc(sizeof *p);
+
+        if (p == NULL)
+                return NULL;
+
+        p->dub = dub;
+
+        p->dtpc = *dtpc;
+        p->dupc = *dupc;
+
+        p->dst_addr   = NULL;
+        p->src_addr   = NULL;
+        p->dst_cep_id = NULL;
+        p->src_cep_id = NULL;
+        p->pdu_length = NULL;
+        p->ttl        = NULL;
+        p->seqno      = NULL;
+        p->qos_id     = NULL;
+        p->chk        = NULL;
+
+        return p;
+}
+
+void pci_destroy(pci_t * pci)
+{
+        free(pci);
+}
+
+int pci_init(pci_t                 * pci)
+{
+        if (pci == NULL) {
+                LOG_DBGF("Bogus input. Bugging out.");
+                return -EINVAL;
+        }
+
+        uint8_t * pci_head = du_buff_head_alloc(pci->dub, PCI_HEAD_SIZE(
+                                                        pci->dtpc,pci->dupc));
+        uint8_t * pci_tail = du_buff_tail_alloc(pci->dub, PCI_TAIL_SIZE(
+                                                        pci->dupc));
+
+        if (pci_head == NULL) {
+                LOG_DBG("Failed to allocate space for PCI at head.");
+                return -ENOBUFS;
+        }
+
+        if (pci_tail == NULL) {
+                LOG_DBG("Failed to allocate space for PCI at tail.");
+                return -ENOBUFS;
+        }
+
+        pci->dst_addr   = pci_head;
+        pci->src_addr   = (pci_head += pci->dtpc.addr_size);
+        pci->dst_cep_id = (pci_head += pci->dtpc.addr_size);
+        pci->src_cep_id = (pci_head += pci->dtpc.cep_id_size);
+        pci->pdu_length = (pci_head += pci->dtpc.cep_id_size);
+        pci->ttl        = (pci_head += pci->dtpc.pdu_length_size);
+        pci->seqno      = (pci_head += pci->dupc.ttl_size);
+        pci->qos_id     = (pci_head += pci->dtpc.seqno_size);
+
+        pci->chk        = (pci_tail);
+
+        return 0;
+}
+
+void pci_release(pci_t * pci)
+{
+        if (pci == NULL)
+                return;
+
+        if (pci->dub == NULL)
+                return;
+
+        du_buff_head_release(pci->dub, PCI_HEAD_SIZE(pci->dtpc, pci->dupc));
+        du_buff_tail_release(pci->dub, PCI_TAIL_SIZE(pci->dupc));
+}
diff --git a/src/ipcpd/normal/pci.h b/src/ipcpd/normal/pci.h
new file mode 100644
index 00000000..3c011723
--- /dev/null
+++ b/src/ipcpd/normal/pci.h
@@ -0,0 +1,42 @@
+/*
+ * Ouroboros - Copyright (C) 2016
+ *
+ * Protocol Control Information
+ *
+ *    Dimitri Staessens <[email protected]>
+ *    Sander Vrijders   <[email protected]>
+ *
+ * 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_PCI_H
+#define OUROBOROS_IPCP_PCI_H
+
+#include "ouroboros/du_buff.h"
+#include "dt_const.h"
+
+struct pci;
+
+typedef struct pci pci_t;
+
+pci_t * pci_create(du_buff_t                   * dub,
+                   const struct ipcp_dtp_const * dtpc,
+                   const struct ipcp_dup_const * dupc);
+void    pci_destroy(pci_t * pci);
+
+int     pci_init(pci_t * pci);
+void    pci_release(pci_t * pci);
+
+#endif /* OUROBOROS_IPCP_PCI_H */
diff --git a/src/ipcpd/normal/shm_pci.c b/src/ipcpd/normal/shm_pci.c
new file mode 100644
index 00000000..e76d8009
--- /dev/null
+++ b/src/ipcpd/normal/shm_pci.c
@@ -0,0 +1,146 @@
+/*
+ * Ouroboros - Copyright (C) 2016
+ *
+ * Protocol Control Information in Shared Memory Map
+ *
+ *    Dimitri Staessens <[email protected]>
+ *    Sander Vrijders   <[email protected]>
+ *
+ * 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.
+ */
+
+#include "shm_pci.h"
+#include <stdlib.h>
+#include <errno.h>
+
+#define SHM_PCI_HEAD_SIZE(a, b) a.addr_size * 2 +  \
+        a.cep_id_size * 2 +                    \
+        a.pdu_length_size +                    \
+        b.ttl_size +                           \
+        a.seqno_size +                         \
+        a.qos_id_size
+#define SHM_PCI_TAIL_SIZE(b) b.chk_size
+
+#define OUROBOROS_PREFIX "ipcpd/shm_pci"
+
+#include <ouroboros/logs.h>
+
+struct shm_pci {
+        /* head */
+        uint8_t * dst_addr;
+        uint8_t * src_addr;
+        uint8_t * dst_cep_id;
+        uint8_t * src_cep_id;
+        uint8_t * pdu_length;
+        uint8_t * ttl;
+        uint8_t * seqno;
+        uint8_t * qos_id;
+
+        uint8_t * chk;
+
+        struct shm_du_buff * dub;
+
+        struct ipcp_dtp_const dtpc;
+        struct ipcp_dup_const dupc;
+
+};
+
+shm_pci_t * shm_pci_create(struct shm_du_buff      * dub,
+                           const struct ipcp_dtp_const * dtpc,
+                           const struct ipcp_dup_const * dupc)
+{
+        struct shm_pci * p;
+
+        if (dub == NULL) {
+                LOG_DBGF("Bogus input. Bugging out.");
+                return NULL;
+        }
+
+        p = malloc(sizeof *p);
+
+        if (p == NULL)
+                return NULL;
+
+        p->dub = dub;
+
+        p->dtpc = *dtpc;
+        p->dupc = *dupc;
+
+        p->dst_addr   = NULL;
+        p->src_addr   = NULL;
+        p->dst_cep_id = NULL;
+        p->src_cep_id = NULL;
+        p->pdu_length = NULL;
+        p->ttl        = NULL;
+        p->seqno      = NULL;
+        p->qos_id     = NULL;
+        p->chk        = NULL;
+
+        return p;
+}
+
+void shm_pci_destroy(shm_pci_t * pci)
+{
+        free(pci);
+}
+
+int shm_pci_init(shm_pci_t * pci)
+{
+        if (pci == NULL) {
+                LOG_DBGF("Bogus input. Bugging out.");
+                return -EINVAL;
+        }
+
+        uint8_t * pci_head = shm_du_buff_head_alloc(
+                pci->dub, SHM_PCI_HEAD_SIZE(pci->dtpc, pci->dupc));
+        uint8_t * pci_tail = shm_du_buff_tail_alloc(
+                pci->dub, SHM_PCI_TAIL_SIZE(pci->dupc));
+
+        if (pci_head == NULL) {
+                LOG_DBG("Failed to allocate space for PCI at head.");
+                return -ENOBUFS;
+        }
+
+        if (pci_tail == NULL) {
+                LOG_DBG("Failed to allocate space for PCI at tail.");
+                return -ENOBUFS;
+        }
+
+        pci->dst_addr   = pci_head;
+        pci->src_addr   = (pci_head += pci->dtpc.addr_size);
+        pci->dst_cep_id = (pci_head += pci->dtpc.addr_size);
+        pci->src_cep_id = (pci_head += pci->dtpc.cep_id_size);
+        pci->pdu_length = (pci_head += pci->dtpc.cep_id_size);
+        pci->ttl        = (pci_head += pci->dtpc.pdu_length_size);
+        pci->seqno      = (pci_head += pci->dupc.ttl_size);
+        pci->qos_id     = (pci_head += pci->dtpc.seqno_size);
+
+        pci->chk        = (pci_tail);
+
+        return 0;
+}
+
+void shm_pci_release(shm_pci_t * pci)
+{
+        if (pci == NULL)
+                return;
+
+        if (pci->dub == NULL)
+                return;
+
+        shm_du_buff_head_release(pci->dub, SHM_PCI_HEAD_SIZE(pci->dtpc,
+                                                             pci->dupc));
+        shm_du_buff_tail_release(pci->dub, SHM_PCI_TAIL_SIZE(pci->dupc));
+}
diff --git a/src/ipcpd/normal/shm_pci.h b/src/ipcpd/normal/shm_pci.h
new file mode 100644
index 00000000..cb8dd5dd
--- /dev/null
+++ b/src/ipcpd/normal/shm_pci.h
@@ -0,0 +1,43 @@
+/*
+ * Ouroboros - Copyright (C) 2016
+ *
+ * Protocol Control Information in Shared Memory Map
+ *
+ *    Dimitri Staessens <[email protected]>
+ *    Sander Vrijders   <[email protected]>
+ *
+ * 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_SHM_PCI_H
+#define OUROBOROS_IPCP_SHM_PCI_H
+
+#include <ouroboros/shm_du_map.h>
+
+#include <dt_const.h>
+
+struct shm_pci;
+
+typedef struct shm_pci shm_pci_t;
+
+shm_pci_t * shm_pci_create(struct shm_du_buff          * dub,
+                           const struct ipcp_dtp_const * dtpc,
+                           const struct ipcp_dup_const * dupc);
+void    shm_pci_destroy(shm_pci_t * pci);
+
+int     shm_pci_init(shm_pci_t * pci);
+void    shm_pci_release(shm_pci_t * pci);
+
+#endif /* OUROBOROS_IPCP_SHM_PCI_H */