safeclib wraps some common c library functions and adds some tools

* lumiera_malloc which succeeds or dies
 * some safe string functions
 * Thread local round robin buffers for temporary data

src/lib/Makefile.am

@@ -28,7 +28,9 @@ liblumi_a_SOURCES = \
 	$(liblumi_a_srcdir)/mutex.c \
 	$(liblumi_a_srcdir)/rwlock.c \
 	$(liblumi_a_srcdir)/condition.c \
-	$(liblumi_a_srcdir)/references.c
+	$(liblumi_a_srcdir)/references.c \
+	$(liblumi_a_srcdir)/safeclib.c
+
 
 
 noinst_HEADERS += \
@@ -39,5 +41,6 @@ noinst_HEADERS += \
 	$(liblumi_a_srcdir)/mutex.h \
 	$(liblumi_a_srcdir)/rwlock.h \
 	$(liblumi_a_srcdir)/condition.h \
-	$(liblumi_a_srcdir)/references.h
+	$(liblumi_a_srcdir)/references.h \
+	$(liblumi_a_srcdir)/safeclib.h
 

src/lib/safeclib.c

@@ -0,0 +1,181 @@
+/*
+  safe_clib.c  -  Portable and safe wrapers around some clib functions and some tools
+
+  Copyright (C)         CinelerraCV
+    2008,               Christian Thaeter <ct@pipapo.org>
+
+  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.
+*/
+#define _GNU_SOURCE
+
+#include "error.h"
+
+#include <string.h>
+#include <stdlib.h>
+#include <pthread.h>
+#include <stdint.h>
+
+/**
+ * @file Portable and safe wrapers around some clib functions and some tools
+ */
+
+LUMIERA_ERROR_DEFINE (NO_MEMORY, "Out of Memory!");
+
+/**
+ * Allocate memory.
+ * always succeeds or dies
+ * @param size memory to be allocated
+ * @return pointer to the allocated memory
+ */
+void*
+lumiera_malloc (size_t sz)
+{
+  void* o = malloc (sz);
+  if (!o)
+    LUMIERA_DIE (NO_MEMORY);
+  return o;
+}
+
+
+/**
+ * Duplicate a C string.
+ * always succeeds or dies
+ * @param str string to be copied
+ * @param len maximal length to be copied
+ * @return pointer to the new string, "" if NULL was passed as str
+ */
+char*
+lumiera_strndup (const char* str, size_t len)
+{
+  char* o;
+  if (str)
+    o = strndup (str, len);
+  else
+    o = strdup ("");
+
+  if (!o)
+    LUMIERA_DIE (NO_MEMORY);
+  return o;
+}
+
+
+/**
+ * Compare two C strings.
+ * Handles NULL pointers as "", shortcut for same addresses
+ * @param a first string for comparsion
+ * @param b second string for comparsion
+ * @param len maximal length for the comparsion
+ * @return 0 if the strings are identical, -1 if smaller 1 if bigger.
+ */
+int
+lumiera_strncmp (const char* a, const char* b, size_t len)
+{
+  return a == b ? 0 : strncmp (a?a:"", b?b:"", len);
+}
+
+
+/**
+ * check 2 strings for identity.
+ * @param a first string for comparsion
+ * @param b second string for comparsion
+ * @return 1 when the strings are the the same, 0 if not.
+ */
+int
+lumiera_streq (const char* a, const char* b)
+{
+  return !lumiera_strncmp (a, b, SIZE_MAX);
+}
+
+
+/**
+ * Round robin temporary buffers.
+ * This provides 64 buffers per thread which are recycled with each use.
+ * The idea here is to have fast buffers for temporal data without need for explicit heap management.
+ */
+struct lumiera_buffer_struct
+{
+  void* buffers[64];
+  size_t sizes[64];
+  unsigned idx;
+};
+
+static pthread_once_t lumiera_buffer_tls_once = PTHREAD_ONCE_INIT;
+static pthread_key_t lumiera_buffer_tls_key;
+
+void
+lumiera_buffer_freeall (void);
+
+static void
+lumiera_buffer_destroy (void* buf)
+{
+  lumiera_buffer_freeall ();
+  free (buf);
+}
+
+static void
+lumiera_buffer_init (void)
+{
+  pthread_key_create (&lumiera_buffer_tls_key, lumiera_buffer_destroy);
+}
+
+
+/**
+ * free all buffers associated with this thread.
+ * This function is called automatically, usually one doesnt need to call it.
+ */
+void
+lumiera_buffer_freeall (void)
+{
+  pthread_once (&lumiera_buffer_tls_once, lumiera_buffer_init);
+  struct lumiera_buffer_struct* buf = pthread_getspecific (lumiera_buffer_tls_key);
+  if (!buf)
+    pthread_setspecific (lumiera_buffer_tls_key,
+                         buf = lumiera_malloc (sizeof (struct lumiera_buffer_struct)));
+
+  for (buf->idx = 0; buf->idx < 64; ++buf->idx)
+    {
+      free (buf->buffers[buf->idx]);
+      buf->buffers[buf->idx] = NULL;
+      buf->sizes[buf->idx] = 0;
+    }
+  buf->idx = 0;
+}
+
+
+/**
+ * Query a thread local buffer.
+ * @param size minimal needed size for the buffer
+ * @return the buffer
+ */
+void*
+lumiera_buffer_provide (size_t size)
+{
+  pthread_once (&lumiera_buffer_tls_once, lumiera_buffer_init);
+  struct lumiera_buffer_struct* buf = pthread_getspecific (lumiera_buffer_tls_key);
+  if (!buf)
+    pthread_setspecific (lumiera_buffer_tls_key,
+                         buf = lumiera_malloc (sizeof (struct lumiera_buffer_struct)));
+
+  buf->idx = (buf->idx + 1) & 0x3f;
+
+  if (buf->sizes[buf->idx] < size || buf->sizes[buf->idx] > 8*size)
+    {
+      free (buf->buffers[buf->idx]);
+      buf->sizes[buf->idx] = (size+4*sizeof(long)) & ~(4*sizeof(long)-1);
+      buf->buffers[buf->idx] = lumiera_malloc (buf->sizes[buf->idx]);
+    }
+  return buf->buffers[buf->idx];
+}
+

src/lib/safeclib.h

@@ -0,0 +1,97 @@
+/*
+  safe_clib.h  -  Portable and safe wrapers around some clib functions and some tools
+
+  Copyright (C)         CinelerraCV
+    2008,               Christian Thaeter <ct@pipapo.org>
+
+  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 "error.h"
+
+//#include <string.h>
+//#include <stdlib.h>
+//#include <pthread.h>
+
+/**
+ * @file Portable and safe wrapers around some clib functions and some tools
+ */
+LUMIERA_ERROR_DECLARE(NO_MEMORY);
+
+/**
+ * Allocate memory.
+ * always succeeds or dies
+ * @param size memory to be allocated
+ * @return pointer to the allocated memory
+ */
+void*
+lumiera_malloc (size_t sz);
+
+
+/**
+ * Duplicate a C string.
+ * always succeeds or dies
+ * @param str string to be copied
+ * @param len maximal length to be copied
+ * @return pointer to the new string, "" if NULL was passed as str
+ */
+char*
+lumiera_strndup (const char* str, size_t len);
+
+
+/**
+ * Compare two C strings.
+ * Handles NULL pointers as "", shortcut for same addresses
+ * @param a first string for comparsion
+ * @param b second string for comparsion
+ * @param len maximal length for the comparsion
+ * @return 0 if the strings are identical, -1 if smaller 1 if bigger.
+ */
+int
+lumiera_strncmp (const char* a, const char* b, size_t len);
+
+
+/**
+ * check 2 strings for identity.
+ * @param a first string for comparsion
+ * @param b second string for comparsion
+ * @return 1 when the strings are the the same, 0 if not.
+ */
+int
+lumiera_streq (const char* a, const char* b);
+
+
+/**
+ * Round robin temporary buffers.
+ * This provides 64 buffers per thread which are recycled with each use.
+ * The idea here is to have fast buffers for temporal data without need for explicit heap management.
+ */
+
+/**
+ * free all buffers associated with this thread.
+ * This function is called automatically, usually one doesnt need to call it.
+ */
+void
+lumiera_buffer_freeall (void);
+
+
+/**
+ * Query a thread local buffer.
+ * @param size minimal needed size for the buffer
+ * @return the buffer
+ */
+void*
+lumiera_buffer_provide (size_t size);
+