lib: shared memory map

The shared memory map will allow passing SDU's between IPCPs
efficiently. It is a single block of managed memory. SDU's are stored
in a shm_du_buff datastructure, which is a list of blocks inside the
shared memory region. The mechanism for passing SDU's is not yet
implemented and could be either within the region or using another
local IPC mechanism.

The following things are configured at compile time:

SHM_FILE_NAME         : the name. Default is "ouroboros_du_map".
SHM_DU_BUFF_BLOCK_SIZE: size of a block inside the shared memory
                        region. Default is the pagesize of the system.
SHM_DU_MAP_SIZE       : the approximate size in bytes of the shared
                        memory map. The actual filesize may differ by
                        a small margin. Default is 4MB.

4 files changed, 337 insertions, 1 deletions

diff --git a/src/lib/tests/CMakeLists.txt b/src/lib/tests/CMakeLists.txt
index 99df7232..d4bcb4e4 100644
--- a/src/lib/tests/CMakeLists.txt
+++ b/src/lib/tests/CMakeLists.txt
@@ -1,14 +1,27 @@
 get_filename_component(tmp ".." ABSOLUTE)
 get_filename_component(src_folder "${tmp}" NAME)
 
+find_library(LIBRT_LIBRARIES rt)
+if(NOT LIBRT_LIBRARIES)
+       message(FATAL_ERROR "librt not found")
+endif()
+
+find_library(LIBPTHREAD_LIBRARIES pthread)
+if(NOT LIBPTHREAD_LIBRARIES)
+       message(FATAL_ERROR "libpthread not found")
+endif()
+
 create_test_sourcelist(${src_folder}_tests test_suite.c
                        # Add new tests here
                        bitmap_test.c
                        du_buff_test.c
+                       shm_du_map_test_create.c
+                       shm_du_map_test_du_buff_create.c
+                       shm_du_map_test_prod_cons.c
 )
 
 add_executable(${src_folder}_test EXCLUDE_FROM_ALL ${${src_folder}_tests})
-target_link_libraries(${src_folder}_test ouroboros)
+target_link_libraries(${src_folder}_test ouroboros rt pthread)
 
 add_dependencies(check ${src_folder}_test)
 
diff --git a/src/lib/tests/shm_du_map_test_create.c b/src/lib/tests/shm_du_map_test_create.c
new file mode 100644
index 00000000..dcf3bd45
--- /dev/null
+++ b/src/lib/tests/shm_du_map_test_create.c
@@ -0,0 +1,51 @@
+/*
+ * Ouroboros - Copyright (C) 2016
+ *
+ * Test of the Shared Memory Map
+ *
+ *    Dimitri Staessens <dimitri.staessens@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.
+ */
+
+#include <ouroboros/shm_du_map.h>
+#include <ouroboros/common.h>
+#include <sys/mman.h>
+
+int shm_du_map_test_create(int argc, char ** argv)
+{
+        struct shm_du_map * dum;
+        struct shm_du_map * dum2;
+
+        shm_unlink(SHM_DU_MAP_FILENAME);
+
+        dum = shm_du_map_create();
+
+        if (dum == NULL)
+                return -1;
+
+        dum2 = shm_du_map_open();
+
+        if (dum2 == NULL) {
+                shm_du_map_close(dum);
+                return 1;
+        }
+
+        shm_du_map_close(dum2);
+
+        shm_du_map_close(dum);
+
+        return 0; /* tests succeeded */
+}
diff --git a/src/lib/tests/shm_du_map_test_du_buff_create.c b/src/lib/tests/shm_du_map_test_du_buff_create.c
new file mode 100644
index 00000000..9f66b20c
--- /dev/null
+++ b/src/lib/tests/shm_du_map_test_du_buff_create.c
@@ -0,0 +1,93 @@
+/*
+ * Ouroboros - Copyright (C) 2016
+ *
+ * Test of the Shared Memory Map
+ *
+ *    Dimitri Staessens <dimitri.staessens@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.
+ */
+
+#include <ouroboros/shm_du_map.h>
+#include <sys/mman.h>
+
+
+#define SHM_DU_BLOCK_DATA_SIZE (SHM_DU_BUFF_BLOCK_SIZE - 3 * sizeof(long))
+#define TEST_BUFF_SIZE (16 * SHM_DU_BLOCK_DATA_SIZE)
+
+#define MAX(a,b) (a > b ? a : b)
+#define MIN(a,b) (a < b ? a : b)
+
+int shm_du_map_test_du_buff_create(int argc, char ** argv)
+{
+        struct shm_du_map * dum;
+        struct shm_du_map * dum2;
+
+        int i, j, k;
+        int i_inc, j_inc, k_inc;
+
+        uint8_t bits[TEST_BUFF_SIZE];
+
+        shm_unlink(SHM_DU_MAP_FILENAME);
+
+        dum = shm_du_map_create();
+
+        if (dum == NULL)
+                return -1;
+
+        for (i = 0; i < TEST_BUFF_SIZE; i++)
+                bits[i] = 0;
+
+        i_inc = MAX(1, SHM_DU_BLOCK_DATA_SIZE / 4);
+        j_inc = MAX(1, SHM_DU_BLOCK_DATA_SIZE / 8);
+        k_inc = MAX(1, SHM_DU_BLOCK_DATA_SIZE / 16);
+
+        for (i = SHM_DU_BUFF_BLOCK_SIZE / 4; i <= TEST_BUFF_SIZE; i += i_inc) {
+                for (j = 0; j < i; j += j_inc) {
+                        for (k = 0; k < i - j; k += k_inc) {
+                                if (k > SHM_DU_BLOCK_DATA_SIZE)
+                                        continue;
+
+                                if (i - (j + k) > SHM_DU_BLOCK_DATA_SIZE)
+                                        continue;
+
+                                struct shm_du_buff * dub = shm_create_du_buff(
+                                        dum,
+                                        i,
+                                        k,
+                                        bits,
+                                        j);
+                                if (dub == NULL) {
+                                        shm_du_map_close(dum);
+                                        return -1;
+                                }
+                                shm_release_du_buff(dum, dub);
+                        }
+                }
+        }
+
+        dum2 = shm_du_map_open();
+
+        if (dum2 == NULL) {
+                shm_du_map_close(dum);
+                return 1;
+        }
+
+        shm_du_map_close(dum2);
+
+        shm_du_map_close(dum);
+
+        return 0; /* tests succeeded */
+}
diff --git a/src/lib/tests/shm_du_map_test_prod_cons.c b/src/lib/tests/shm_du_map_test_prod_cons.c
new file mode 100644
index 00000000..945104c1
--- /dev/null
+++ b/src/lib/tests/shm_du_map_test_prod_cons.c
@@ -0,0 +1,179 @@
+/*
+ * Ouroboros - Copyright (C) 2016
+ *
+ * Test of the Shared Memory Map
+ *
+ *    Dimitri Staessens <dimitri.staessens@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.
+ */
+
+#include <ouroboros/shm_du_map.h>
+#include <sys/types.h>
+#include <stdlib.h>
+#include <time.h>
+#include <pthread.h>
+#include "shm_du_map.c"
+
+#define TEST_BUFF_SIZE (3 * SHM_DU_BLOCK_DATA_SIZE)
+
+#define MAX(a,b) (a > b ? a : b)
+#define MIN(a,b) (a < b ? a : b)
+
+int * sync;
+
+void * produce()
+{
+        struct shm_du_map * dum;
+        long                test_buf_size = 0;
+        uint8_t           * test_values;
+        int                 headspace;
+        int                 tailspace;
+        long                i;
+        long                bytes_written = 0;
+        struct timespec     starttime;
+        struct timespec     stoptime;
+        double              elapsed;
+        long                overruns = 0;
+
+        dum = shm_du_map_open();
+        if (dum == NULL)
+                return (void *)-1;
+
+        srand(time(NULL));
+        clock_gettime(CLOCK_MONOTONIC, &starttime);
+
+        test_values = malloc (sizeof *test_values * TEST_BUFF_SIZE);
+        for (i = 0; i < TEST_BUFF_SIZE; i++)
+                test_values[i] = 170;
+
+        for (i = 0; i < 4 * SHM_BLOCKS_IN_MAP; i++) {
+                struct shm_du_buff * sdb;
+                size_t               len;
+                struct timespec      ts;
+
+                test_buf_size = rand() % (TEST_BUFF_SIZE - 512) + 512;
+
+                headspace     = MAX(4, rand() % 64);
+                tailspace     = MAX(1, rand() % 24);
+
+                ts.tv_sec     = 0;
+                ts.tv_nsec    = rand() % 90000;
+
+                len = test_buf_size - (headspace + tailspace);
+
+                sdb = shm_create_du_buff(dum,
+                                         test_buf_size,
+                                         headspace,
+                                         test_values,
+                                         len);
+
+                if (sdb != NULL) {
+                        sync[i] = du_buff_ptr_to_idx(dum, sdb);
+                        bytes_written += len;
+                }
+                else {
+                        i--;
+                        ++overruns;
+                        ts.tv_nsec = 10000;
+                        nanosleep(&ts, NULL);
+                }
+                nanosleep(&ts, NULL);
+
+                if (overruns > 100) {
+                        LOG_INFO("Bugging out due to overruns.");
+                        sync[i+1] = -2;
+                        break;
+                }
+
+        }
+
+        clock_gettime(CLOCK_MONOTONIC, &stoptime);
+        elapsed =(stoptime.tv_sec + stoptime.tv_nsec / 1000000000.0) -
+                (starttime.tv_sec + starttime.tv_nsec / 1000000000.0);
+        LOG_INFO("%ld bytes written in %.1lf ms = %lf Gb/s",
+                 bytes_written,
+                 elapsed * 1000.0,
+                 bytes_written * 8 / (elapsed * 1000000000));
+
+        free(test_values);
+        shm_du_map_close(dum);
+        return 0;
+}
+
+void * consume()
+{
+        struct shm_du_map * dum;
+
+        long                i;
+
+        struct timespec     ts;
+
+        ts.tv_sec = 0;
+        ts.tv_nsec = 5000;
+
+        dum = shm_du_map_open();
+
+        if (dum == NULL)
+                pthread_exit((void *) -1);
+
+        for (i = 0; i < 4 * SHM_BLOCKS_IN_MAP; i++) {
+                while (sync[i] == -1)
+                        nanosleep(&ts, NULL); /* wait for the producer */
+                if (sync[i] == -2)
+                        break;
+                shm_release_du_buff(dum, idx_to_du_buff_ptr(dum, sync[i]));
+        }
+
+        shm_du_map_close(dum);
+
+        return 0;
+}
+
+int shm_du_map_test_prod_cons(int argc, char ** argv)
+{
+        struct shm_du_map * dum;
+
+        int res1;
+
+        int i;
+
+        pthread_t producer;
+        pthread_t consumer;
+
+        shm_unlink(SHM_DU_MAP_FILENAME);
+
+        dum = shm_du_map_create();
+
+        if (dum == NULL)
+                return -1;
+
+        sync = malloc(sizeof *sync * 4 * SHM_BLOCKS_IN_MAP);
+
+        for (i = 0; i < 4 * SHM_BLOCKS_IN_MAP; i++)
+                sync[i] = -1;
+
+        res1 = (int) pthread_create(&producer, NULL, produce, NULL);
+        pthread_create(&consumer, NULL, consume, NULL);
+
+        pthread_join(producer, NULL);
+        pthread_join(consumer, NULL);
+
+        free(sync);
+
+        shm_du_map_close(dum);
+
+        return res1;
+}