lib: Add lockfile

The pid of the IRMd is stored in a lockfile in shared memory. This
makes checking if the IRMd is running independent of the
configuration, as previously the IRMd pid was stored at the end of the
shm_du_map, which could not be read by an IRMd that would be compiled
with different configuration options.

Also corrects some unnecessary includes

Fixes #21.

9 files changed, 244 insertions, 31 deletions

diff --git a/include/ouroboros/config.h.in b/include/ouroboros/config.h.in
index c11c2d05..7bb4cee0 100644
--- a/include/ouroboros/config.h.in
+++ b/include/ouroboros/config.h.in
@@ -34,12 +34,13 @@
 #define AP_MAX_FLOWS           256
 #define SHM_DU_BUFF_BLOCK_SIZE sysconf(_SC_PAGESIZE)
 #define SHM_DU_MAP_MULTI_BLOCK
-#define SHM_DU_MAP_FILENAME    "ouroboros_du_map"
+#define SHM_DU_MAP_FILENAME    "ouroboros.shm"
+#define LOCKFILE_NAME          "ouroboros.lockfile"
 #define SHM_BLOCKS_IN_MAP      (1 << 14)
 #define SHM_DU_TIMEOUT_MICROS  15000
 #define DU_BUFF_HEADSPACE      128
 #define DU_BUFF_TAILSPACE      0
-#define SHM_AP_RBUFF_PREFIX    "ouroboros_rb_"
+#define SHM_AP_RBUFF_PREFIX    "ouroboros.rbuff."
 #define SHM_RBUFF_SIZE         (1 << 14)
 #define IRMD_MAX_FLOWS         4096
 #define IRMD_THREADPOOL_SIZE   3
diff --git a/include/ouroboros/lockfile.h b/include/ouroboros/lockfile.h
new file mode 100644
index 00000000..c2cf4572
--- /dev/null
+++ b/include/ouroboros/lockfile.h
@@ -0,0 +1,37 @@
+/*
+ * Ouroboros - Copyright (C) 2016
+ *
+ * Lockfile for ouroboros system
+ *
+ *    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.
+ */
+
+#ifndef OUROBOROS_LOCKFILE_H
+#define OUROBOROS_LOCKFILE_H
+
+#include <sys/types.h>
+
+struct lockfile;
+
+struct lockfile * lockfile_create();
+struct lockfile * lockfile_open();
+void              lockfile_close(struct lockfile * lf);
+void              lockfile_destroy(struct lockfile * lf);
+
+pid_t             lockfile_owner(struct lockfile * lf);
+
+#endif
diff --git a/include/ouroboros/shm_du_map.h b/include/ouroboros/shm_du_map.h
index 59cd94a1..23c0c3aa 100644
--- a/include/ouroboros/shm_du_map.h
+++ b/include/ouroboros/shm_du_map.h
@@ -24,11 +24,9 @@
 #ifndef OUROBOROS_SHM_DU_MAP_H
 #define OUROBOROS_SHM_DU_MAP_H
 
-#include <errno.h>
-#include <unistd.h>
 #include <stdint.h>
-#include <sys/types.h>
 #include <pthread.h>
+#include <sys/types.h>
 
 struct shm_du_buff;
 struct shm_du_map;
@@ -38,7 +36,6 @@ struct shm_du_map * shm_du_map_open();
 void                shm_du_map_close(struct shm_du_map * dum);
 void                shm_du_map_close_on_exit(struct shm_du_map * dum);
 void                shm_du_map_destroy(struct shm_du_map * dum);
-pid_t               shm_du_map_owner(struct shm_du_map * dum);
 void *              shm_du_map_sanitize(void * o);
 
 /* returns the index of the buffer in the DU map */
diff --git a/src/ipcpd/local/main.c b/src/ipcpd/local/main.c
index ae75ae5e..fee7fd22 100644
--- a/src/ipcpd/local/main.c
+++ b/src/ipcpd/local/main.c
@@ -38,6 +38,7 @@
 
 #include <ouroboros/logs.h>
 
+#include <errno.h>
 #include <string.h>
 #include <signal.h>
 #include <stdlib.h>
diff --git a/src/irmd/main.c b/src/irmd/main.c
index 1f72fa1a..c1481a67 100644
--- a/src/irmd/main.c
+++ b/src/irmd/main.c
@@ -31,6 +31,7 @@
 #include <ouroboros/list.h>
 #include <ouroboros/utils.h>
 #include <ouroboros/irm_config.h>
+#include <ouroboros/lockfile.h>
 #include <ouroboros/shm_ap_rbuff.h>
 #include <ouroboros/shm_du_map.h>
 #include <ouroboros/bitmap.h>
@@ -106,6 +107,7 @@ struct irm {
         pthread_rwlock_t    flows_lock;
 
         enum irm_state      state;
+        struct lockfile *   lf;
         struct shm_du_map * dum;
         pthread_t *         threadpool;
         int                 sockfd;
@@ -1331,6 +1333,9 @@ static void irm_destroy()
         if (instance->dum != NULL)
                 shm_du_map_destroy(instance->dum);
 
+        if (instance->lf != NULL)
+                lockfile_destroy(instance->lf);
+
         close(instance->sockfd);
 
         pthread_rwlock_unlock(&instance->state_lock);
@@ -1698,28 +1703,28 @@ static struct irm * irm_create()
 
         instance->state = IRMD_NULL;
 
-        if (access("/dev/shm/" SHM_DU_MAP_FILENAME, F_OK) != -1) {
-                struct shm_du_map * dum = shm_du_map_open();
-
-                if (dum == NULL) {
-                        LOG_ERR("Could not examine existing shm file.");
+        if (access("/dev/shm/" LOCKFILE_NAME, F_OK) != -1) {
+                struct lockfile * lf = lockfile_open();
+                if (lf == NULL) {
+                        LOG_ERR("Failed to open existing lockfile.");
                         free(instance);
                         return NULL;
                 }
 
-                if (kill(shm_du_map_owner(dum), 0) < 0) {
+                if (kill(lockfile_owner(lf), 0) < 0) {
                         LOG_INFO("IRMd didn't properly shut down last time.");
-                        shm_du_map_destroy(dum);
-                        LOG_INFO("Stale shm file removed.");
+                        shm_du_map_destroy(shm_du_map_open());
+                        LOG_INFO("Stale resources cleaned");
+                        lockfile_destroy(lf);
                 } else {
                         LOG_INFO("IRMd already running (%d), exiting.",
-                                 shm_du_map_owner(dum));
-                        shm_du_map_close(dum);
+                                 lockfile_owner(lf));
+                        lockfile_close(lf);
                         free(instance);
                         return NULL;
                 }
 
-                shm_du_map_close(dum);
+                lockfile_close(lf);
         }
 
         if (pthread_rwlock_init(&instance->state_lock, NULL)) {
@@ -1777,6 +1782,11 @@ static struct irm * irm_create()
                 return NULL;
         }
 
+        if ((instance->lf = lockfile_create()) == NULL) {
+                irm_destroy();
+                return NULL;
+        }
+
         if ((instance->dum = shm_du_map_create()) == NULL) {
                 irm_destroy();
                 return NULL;
diff --git a/src/lib/CMakeLists.txt b/src/lib/CMakeLists.txt
index 9c45269c..a440f7be 100644
--- a/src/lib/CMakeLists.txt
+++ b/src/lib/CMakeLists.txt
@@ -31,6 +31,7 @@ set(SOURCE_FILES
   ipcp.c
   irm.c
   list.c
+  lockfile.c
   logs.c
   nsm.c
   shm_ap_rbuff.c
diff --git a/src/lib/lockfile.c b/src/lib/lockfile.c
new file mode 100644
index 00000000..a93d5f17
--- /dev/null
+++ b/src/lib/lockfile.c
@@ -0,0 +1,170 @@
+/*
+ * Ouroboros - Copyright (C) 2016
+ *
+ * Lockfile for ouroboros system
+ *
+ *    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/config.h>
+#include <ouroboros/lockfile.h>
+
+#define OUROBOROS_PREFIX "lockfile"
+
+#include <ouroboros/logs.h>
+
+#include <stdlib.h>
+#include <unistd.h>
+#include <fcntl.h>
+#include <string.h>
+#include <signal.h>
+#include <sys/mman.h>
+#include <sys/stat.h>
+
+#define LF_SIZE (sizeof(pid_t))
+
+struct lockfile {
+        pid_t * api;
+        int fd;
+};
+
+struct lockfile * lockfile_create() {
+        struct lockfile * lf = malloc(sizeof(*lf));
+        if (lf == NULL)
+                return NULL;
+
+        lf->fd = shm_open(LOCKFILE_NAME, O_CREAT | O_EXCL | O_RDWR, 0666);
+        if (lf->fd == -1) {
+                LOG_DBGF("Could not create lock file.");
+                free(lf);
+                return NULL;
+        }
+
+        if (fchmod(lf->fd, 0666)) {
+                LOG_DBGF("Failed to chmod lockfile.");
+                free(lf);
+                return NULL;
+        }
+
+        if (lseek(lf->fd, LF_SIZE - 1, SEEK_SET) < 0) {
+                LOG_DBGF("Failed to extend lockfile.");
+                free(lf);
+                return NULL;
+        }
+
+        if (write(lf->fd, "", 1) != 1) {
+                LOG_DBGF("Failed to finalise lockfile.");
+                free(lf);
+                return NULL;
+        }
+
+        lf->api = mmap(NULL,
+                       LF_SIZE, PROT_READ | PROT_WRITE,
+                       MAP_SHARED,
+                       lf->fd,
+                       0);
+
+        if (lf->api == MAP_FAILED) {
+                LOG_DBGF("Failed to map lockfile.");
+
+                if (shm_unlink(LOCKFILE_NAME) == -1)
+                        LOG_DBGF("Failed to remove invalid lockfile.");
+
+                free(lf);
+                return NULL;
+        }
+
+        *lf->api = getpid();
+
+        return lf;
+}
+
+struct lockfile * lockfile_open() {
+        struct lockfile * lf = malloc(sizeof(*lf));
+        if (lf == NULL)
+                return NULL;
+
+        lf->fd = shm_open(LOCKFILE_NAME, O_RDWR, 0666);
+        if (lf->fd == -1) {
+                LOG_DBGF("Could not open lock file.");
+                free(lf);
+                return NULL;
+        }
+
+        lf->api = mmap(NULL,
+                       LF_SIZE, PROT_READ | PROT_WRITE,
+                       MAP_SHARED,
+                       lf->fd,
+                       0);
+
+        if (lf->api == MAP_FAILED) {
+                LOG_DBGF("Failed to map lockfile.");
+
+                if (shm_unlink(LOCKFILE_NAME) == -1)
+                        LOG_DBGF("Failed to remove invalid lockfile.");
+
+                free(lf);
+                return NULL;
+        }
+
+        return lf;
+}
+
+void lockfile_close(struct lockfile * lf)
+{
+        if (lf == NULL) {
+                LOG_DBGF("Bogus input. Bugging out.");
+                return;
+        }
+
+        if (close(lf->fd) < 0)
+                LOG_DBGF("Couldn't close lockfile.");
+
+        if (munmap(lf->api, LF_SIZE) == -1)
+                LOG_DBGF("Couldn't unmap lockfile.");
+
+        free(lf);
+}
+
+void lockfile_destroy(struct lockfile * lf)
+{
+        if (lf == NULL) {
+                LOG_DBGF("Bogus input. Bugging out.");
+                return;
+        }
+
+        if (getpid() != *lf->api && kill(*lf->api, 0) == 0) {
+                LOG_DBGF("Only IRMd can destroy %s.", LOCKFILE_NAME);
+                return;
+        }
+
+        if (close(lf->fd) < 0)
+                LOG_DBGF("Couldn't close lockfile.");
+
+        if (munmap(lf->api, LF_SIZE) == -1)
+                LOG_DBGF("Couldn't unmap lockfile.");
+
+        if (shm_unlink(LOCKFILE_NAME) == -1)
+                LOG_DBGF("Failed to remove lockfile.");
+
+        free(lf);
+}
+
+pid_t lockfile_owner(struct lockfile * lf)
+{
+        return *lf->api;
+}
diff --git a/src/lib/shm_ap_rbuff.c b/src/lib/shm_ap_rbuff.c
index 4eb91136..cf795601 100644
--- a/src/lib/shm_ap_rbuff.c
+++ b/src/lib/shm_ap_rbuff.c
@@ -26,7 +26,7 @@
 
 #include <ouroboros/logs.h>
 #include <ouroboros/shm_ap_rbuff.h>
-#include <ouroboros/shm_du_map.h>
+#include <ouroboros/lockfile.h>
 
 #include <pthread.h>
 #include <sys/mman.h>
@@ -215,7 +215,7 @@ void shm_ap_rbuff_close(struct shm_ap_rbuff * rb)
 void shm_ap_rbuff_destroy(struct shm_ap_rbuff * rb)
 {
         char fn[25];
-        struct shm_du_map * dum = NULL;
+        struct lockfile * lf = NULL;
 
         if (rb == NULL) {
                 LOG_DBGF("Bogus input. Bugging out.");
@@ -223,15 +223,17 @@ void shm_ap_rbuff_destroy(struct shm_ap_rbuff * rb)
         }
 
         if (rb->api != getpid()) {
-                dum = shm_du_map_open();
-                if (shm_du_map_owner(dum) == getpid()) {
+                lf = lockfile_open();
+                if (lf == NULL)
+                        return;
+                if (lockfile_owner(lf) == getpid()) {
                         LOG_DBGF("Ringbuffer %d destroyed by IRMd %d.",
                                  rb->api, getpid());
-                        shm_du_map_close(dum);
+                        lockfile_close(lf);
                 } else {
                         LOG_ERR("AP-I %d tried to destroy rbuff owned by %d.",
                                 getpid(), rb->api);
-                        shm_du_map_close(dum);
+                        lockfile_close(lf);
                         return;
                 }
         }
diff --git a/src/lib/shm_du_map.c b/src/lib/shm_du_map.c
index 53959676..01d1e23d 100644
--- a/src/lib/shm_du_map.c
+++ b/src/lib/shm_du_map.c
@@ -29,9 +29,11 @@
 #include <pthread.h>
 #include <sys/mman.h>
 #include <fcntl.h>
+#include <unistd.h>
 #include <stdlib.h>
 #include <string.h>
 #include <signal.h>
+#include <errno.h>
 #include <sys/stat.h>
 
 #define OUROBOROS_PREFIX "shm_du_map"
@@ -270,14 +272,6 @@ struct shm_du_map * shm_du_map_open()
         return dum;
 }
 
-pid_t shm_du_map_owner(struct shm_du_map * dum)
-{
-        if (dum == NULL)
-                return -1;
-
-        return *dum->api;
-}
-
 void * shm_du_map_sanitize(void * o)
 {
         struct shm_du_map * dum = (struct shm_du_map *) o;