mdata.h

Go to the documentation of this file.

 
#ifndef MDATA_H
#define MDATA_H

 
#ifndef MDATA_TRACE_LVL
#  define MDATA_TRACE_LVL 0
#endif /* !MDATA_TRACE_LVL */


#define MDATA_VECTOR_FLAG_REFCOUNT 0x01
 
#define MDATA_VECTOR_FLAG_IS_LOCKED 0x02
 
#ifndef MDATA_VECTOR_INIT_STEP_SZ
#  define MDATA_VECTOR_INIT_STEP_SZ 10
#endif /* !MDATA_VECTOR_INIT_STEP_SZ */


 
typedef ssize_t mdata_strpool_idx_t;

struct MDATA_STRPOOL {
   size_t sz;
   MAUG_MHANDLE str_h;
   size_t str_sz;
   size_t str_sz_max;
};
 /* mdata_strpool */


struct MDATA_VECTOR {
   size_t sz;
   uint8_t flags;
   MAUG_MHANDLE data_h;
   uint8_t* data_bytes;
   size_t ct_max;
   size_t ct;
   size_t ct_step;
   size_t item_sz;
   ssize_t locks;
};
 /* mdata_vector */

 
struct MDATA_TABLE {
   struct MDATA_VECTOR data_cols[2];
   size_t key_sz;
};


 
ssize_t mdata_strpool_find(
   struct MDATA_STRPOOL* strpool, const char* str, size_t str_sz );
 
MAUG_MHANDLE mdata_strpool_extract( struct MDATA_STRPOOL* s, size_t i );
 
ssize_t mdata_strpool_append(
   struct MDATA_STRPOOL* strpool, const char* str, size_t str_sz );
 
MERROR_RETVAL mdata_strpool_alloc(
   struct MDATA_STRPOOL* strpool, size_t alloc_sz );
 
void mdata_strpool_free( struct MDATA_STRPOOL* strpool );



ssize_t mdata_vector_append(
   struct MDATA_VECTOR* v, const void* item, size_t item_sz );

MERROR_RETVAL mdata_vector_remove( struct MDATA_VECTOR* v, size_t idx );

void* mdata_vector_get_void( struct MDATA_VECTOR* v, size_t idx );
 
MERROR_RETVAL mdata_vector_copy(
   struct MDATA_VECTOR* v_dest, struct MDATA_VECTOR* v_src );

MERROR_RETVAL mdata_vector_alloc(
   struct MDATA_VECTOR* v, size_t item_sz, size_t item_ct_init );
 
void mdata_vector_free( struct MDATA_VECTOR* v );
 /* mdata_vector */

 
MERROR_RETVAL mdata_table_set(
   struct MDATA_TABLE* t, const char* key, size_t key_sz,
   void* value, size_t value_sz );
 
MERROR_RETVAL mdata_table_get_void(
   struct MDATA_TABLE* t, const char* key, void** value_out, size_t value_sz );


 
#define mdata_strpool_sz( strpool ) ((strpool)->str_sz_max)
 
#define mdata_strpool_lock( strpool, ptr ) \
   maug_mlock( (strpool)->str_h, ptr ); \
   maug_cleanup_if_null_lock( char*, ptr );
 
#define mdata_strpool_unlock( strpool, ptr ) \
   if( NULL != ptr ) { \
      maug_munlock( (strpool)->str_h, ptr ); \
   }
 /* mdata_strpool */


#define mdata_vector_lock( v ) \
   if( \
      mdata_vector_get_flag( v, MDATA_VECTOR_FLAG_REFCOUNT ) && \
      0 < (v)->locks \
   ) { \
      (v)->locks++; \
      debug_printf( MDATA_TRACE_LVL, "vector " #v " locks: " SSIZE_T_FMT, \
         (v)->locks ); \
   } else { \
      assert( !mdata_vector_is_locked( v ) ); \
      if( mdata_vector_is_locked( v ) ) { \
         error_printf( "attempting to double-lock vector!" ); \
         retval = MERROR_OVERFLOW; \
         goto cleanup; \
      } \
      maug_mlock( (v)->data_h, (v)->data_bytes ); \
      maug_cleanup_if_null_lock( uint8_t*, (v)->data_bytes ); \
      (v)->flags |= MDATA_VECTOR_FLAG_IS_LOCKED; \
      debug_printf( MDATA_TRACE_LVL, "locked vector " #v ); \
   }

#define mdata_vector_unlock( v ) \
   if( \
      mdata_vector_get_flag( v, MDATA_VECTOR_FLAG_REFCOUNT ) && \
      0 < (v)->locks \
   ) { \
      (v)->locks--; \
      debug_printf( MDATA_TRACE_LVL, "vector " #v " locks: " SSIZE_T_FMT, \
         (v)->locks ); \
   } \
   if( 0 == (v)->locks && NULL != (v)->data_bytes ) { \
      assert( mdata_vector_is_locked( v ) ); \
      maug_munlock( (v)->data_h, (v)->data_bytes ); \
      (v)->flags &= ~MDATA_VECTOR_FLAG_IS_LOCKED; \
      debug_printf( MDATA_TRACE_LVL, "unlocked vector " #v ); \
   }
 
#define mdata_vector_get( v, idx, type ) \
   ((type*)mdata_vector_get_void( v, idx ))
 
#define mdata_vector_get_last( v, type ) \
   (0 < mdata_vector_ct( v ) ? \
      ((type*)mdata_vector_get_void( v, \
         mdata_vector_ct( v ) - 1 )) : NULL)
 
#define mdata_vector_remove_last( v ) \
   (0 < mdata_vector_ct( v ) ? \
      (mdata_vector_remove( v, mdata_vector_ct( v ) - 1 )) : MERROR_OVERFLOW)
 
#define mdata_vector_set_ct_step( v, step ) \
   (v)->ct_step = step;

#define mdata_vector_ct( v ) ((v)->ct)

#define mdata_vector_sz( v ) (((v)->ct_max) * ((v)->item_sz))

#define mdata_vector_fill( v, ct_new, sz ) \
   retval = mdata_vector_alloc( v, sz, ct_new ); \
   maug_cleanup_if_not_ok(); \
   (v)->ct = (ct_new);
 
#define mdata_vector_is_locked( v ) \
   (MDATA_VECTOR_FLAG_IS_LOCKED == \
   (MDATA_VECTOR_FLAG_IS_LOCKED & (v)->flags))
 
/* TODO: Implement insert sorting. */
#define mdata_vector_insert_sort( v, i, t, field )
 
/* TODO: Implement sorting. */
#define mdata_vector_sort( v, t, field )
 
#define _mdata_vector_item_ptr( v, idx ) \
   (&((v)->data_bytes[((idx) * ((v)->item_sz))]))
 
#define mdata_vector_set_flag( v, flag ) (v)->flags |= (flag)
 
#define mdata_vector_get_flag( v, flag ) ((flag) == ((v)->flags & (flag)))
 /* mdata_vector */
 
#define mdata_retval( idx ) (0 > idx ? ((idx) * -1) : MERROR_OK)
 
#ifdef MDATA_C
 
ssize_t mdata_strpool_find(
   struct MDATA_STRPOOL* strpool, const char* str, size_t str_sz
) {
   MERROR_RETVAL retval = MERROR_OK;
   ssize_t i = 0;
   char* strpool_p = NULL;
   size_t* p_str_iter_sz = NULL;
 
   if( (MAUG_MHANDLE)NULL == strpool->str_h ) {
      error_printf( "strpool not allocated!" );
      i = -1;
      goto cleanup;
   }
 
   maug_mlock( strpool->str_h, strpool_p );
 
   while( i < strpool->str_sz ) {
      p_str_iter_sz = (size_t*)&(strpool_p[i]);
      if(
         0 == strncmp( &(strpool_p[i + sizeof( size_t )]), str, str_sz + 1 )
      ) {
         /* String found. Advance past the size before returning. */
         i += sizeof( size_t );
         debug_printf( MDATA_TRACE_LVL,
            "found strpool_idx: " SIZE_T_FMT " (" SIZE_T_FMT " bytes): \"%s\"",
            i, *p_str_iter_sz, &(strpool_p[i]) );
 
         goto cleanup;
      } else {
         debug_printf( MDATA_TRACE_LVL,
            "skipping strpool_idx: " SIZE_T_FMT " (" SIZE_T_FMT
               " bytes): \"%s\"",
            i + sizeof( size_t ), *p_str_iter_sz,
               &(strpool_p[i + sizeof( size_t )]) );
      }
      i += *p_str_iter_sz;
   }
 
   /* String not found. */
   i = -1;
 
cleanup:
 
   if( MERROR_OK != retval ) {
      i = retval * -1;
   }
 
   if( NULL != strpool_p ) {
      maug_munlock( strpool->str_h, strpool_p );
   }
 
   return i;
}
 
/* === */
 
MAUG_MHANDLE mdata_strpool_extract( struct MDATA_STRPOOL* s, size_t i ) {
   MERROR_RETVAL retval = MERROR_OK;
   char* strpool = NULL;
   MAUG_MHANDLE out_h = (MAUG_MHANDLE)NULL;
   size_t out_sz = 0;
   char* out_tmp = NULL;
 
   mdata_strpool_lock( s, strpool );
 
   out_sz = maug_strlen( &(strpool[i]) );
   out_h = maug_malloc( out_sz + 1, 1 );
   maug_cleanup_if_null_alloc( MAUG_MHANDLE, out_h );
 
   maug_mlock( out_h, out_tmp );
   maug_cleanup_if_null_lock( char*, out_tmp );
 
   maug_mzero( out_tmp, out_sz + 1 );
   maug_strncpy( out_tmp, &(strpool[i]), out_sz );
 
cleanup:
 
   if( NULL != out_tmp ) {
      maug_munlock( out_h, out_tmp );
   }
 
   if( MERROR_OK != retval && (MAUG_MHANDLE)NULL != out_h ) {
      maug_mfree( out_h );
   }
 
   if( NULL != strpool ) {
      mdata_strpool_unlock( s, strpool );
   }
 
   return out_h;
}
 
/* === */
 
ssize_t mdata_strpool_append(
   struct MDATA_STRPOOL* strpool, const char* str, size_t str_sz
) {
   ssize_t idx_p_out = 0;
   char* strpool_p = NULL;
   MERROR_RETVAL retval = MERROR_OK;
   size_t* p_str_sz = NULL;
   size_t padding = 0;
   size_t alloc_sz = 0;
 
   if( 0 < strpool->str_sz ) {
      /* Search the str_stable for an identical string and return that index.
      */
      idx_p_out = mdata_strpool_find( strpool, str, str_sz );
      if( -1 != idx_p_out ) {
         /* Found, or error returned. */
         goto cleanup;
      }
   }
 
   assert( 0 < str_sz );
 
   /* Pad out allocated space so size_t is always aligned. */
   padding = sizeof( size_t ) - ((str_sz + 1 /* NULL */) % sizeof( size_t ));
   alloc_sz = sizeof( size_t ) + str_sz + 1 /* NULL */ + padding;
   assert( 0 == alloc_sz % sizeof( size_t ) );
 
   debug_printf( MDATA_TRACE_LVL,
      "adding size_t (" SIZE_T_FMT " bytes) + string %s (" SIZE_T_FMT
         " bytes) + 1 NULL + " SIZE_T_FMT " bytes padding to strpool...",
      sizeof( size_t ), str, str_sz, padding );
 
   retval = mdata_strpool_alloc( strpool, alloc_sz );
   maug_cleanup_if_not_ok();
 
   maug_mlock( strpool->str_h, strpool_p );
   maug_cleanup_if_null_alloc( char*, strpool_p );
 
   debug_printf( MDATA_TRACE_LVL,
      "strpool (" SIZE_T_FMT " bytes) locked to: %p",
      strpool->str_sz, strpool_p );
 
   /* Add this string at the end of the string table. */
   maug_strncpy( &(strpool_p[strpool->str_sz + sizeof( size_t )]), str, str_sz );
   strpool_p[strpool->str_sz + sizeof( size_t ) + str_sz] = '\0';
 
   /* Add the size of the string to the strpool. */
   assert( 0 == strpool->str_sz % sizeof( size_t ) );
   p_str_sz = (size_t*)&(strpool_p[strpool->str_sz]);
   *p_str_sz = alloc_sz;
 
   idx_p_out = strpool->str_sz + sizeof( size_t );
 
   debug_printf(
      MDATA_TRACE_LVL, "set strpool_idx: " SIZE_T_FMT ": \"%s\"",
      strpool->str_sz, &(strpool_p[idx_p_out]) );
 
   /* Set the string table cursor to the next available spot. */
   strpool->str_sz += alloc_sz;
 
cleanup:
 
   if( MERROR_OK != retval ) {
      idx_p_out = retval * -1;
   }
 
   if( NULL != strpool_p ) {
      maug_munlock( strpool->str_h, strpool_p );
   }
 
   return idx_p_out;
}
 
/* === */
 
MERROR_RETVAL mdata_strpool_alloc(
   struct MDATA_STRPOOL* strpool, size_t alloc_sz
) {
   MERROR_RETVAL retval = MERROR_OK;
   MAUG_MHANDLE str_h_new = (MAUG_MHANDLE)NULL;
 
   if( (MAUG_MHANDLE)NULL == strpool->str_h ) {
      debug_printf(
         MDATA_TRACE_LVL, "creating string table of " SIZE_T_FMT " chars...",
         alloc_sz );
      assert( (MAUG_MHANDLE)NULL == strpool->str_h );
      strpool->str_h = maug_malloc( alloc_sz, 1 );
      maug_cleanup_if_null_alloc( MAUG_MHANDLE, strpool->str_h );
      strpool->str_sz_max = alloc_sz;
      strpool->sz = sizeof( struct MDATA_STRPOOL );
 
   } else if( strpool->str_sz_max <= strpool->str_sz + alloc_sz ) {
      while( strpool->str_sz_max <= strpool->str_sz + alloc_sz ) {
         debug_printf(
            MDATA_TRACE_LVL, "enlarging string table to " SIZE_T_FMT "...",
            strpool->str_sz_max * 2 );
         maug_mrealloc_test(
            str_h_new, strpool->str_h, strpool->str_sz_max, (size_t)2 );
         strpool->str_sz_max *= 2;
      }
   }
 
cleanup:
   return retval;
}
 
/* === */
 
void mdata_strpool_free( struct MDATA_STRPOOL* strpool ) {
   if( (MAUG_MHANDLE)NULL != strpool->str_h ) {
      maug_mfree( strpool->str_h );
   }
}
 
/* === */
 
ssize_t mdata_vector_append(
   struct MDATA_VECTOR* v, const void* item, size_t item_sz
) {
   MERROR_RETVAL retval = MERROR_OK;
   ssize_t idx_out = -1;
 
   if( 0 < v->item_sz && item_sz != v->item_sz ) {
      error_printf( "attempting to add item of " SIZE_T_FMT " bytes to vector, "
         "but vector is already sized for " SIZE_T_FMT "-byte items!",
         item_sz, v->item_sz );
      retval = MERROR_OVERFLOW;
      goto cleanup;
   }
 
   mdata_vector_alloc( v, item_sz, v->ct_step );
 
   /* Lock the vector to work in it a bit. */
   mdata_vector_lock( v );
 
   idx_out = v->ct;
 
   if( NULL != item ) {
      /* Copy provided item. */
      debug_printf(
         MDATA_TRACE_LVL, "inserting into vector at index: " SIZE_T_FMT,
         idx_out );
 
      memcpy( _mdata_vector_item_ptr( v, idx_out ), item, item_sz );
   }
 
   v->ct++;
 
cleanup:
 
   if( MERROR_OK != retval ) {
      error_printf( "error adding to vector: %d", retval );
      idx_out = retval * -1;
      assert( 0 > idx_out );
   }
 
   mdata_vector_unlock( v );
 
   return idx_out;
}
 
/* === */
 
MERROR_RETVAL mdata_vector_remove( struct MDATA_VECTOR* v, size_t idx ) {
   MERROR_RETVAL retval = MERROR_OK;
   size_t i = 0;
 
   if( NULL != v->data_bytes ) {
      error_printf( "vector cannot be resized while locked!" );
      retval = MERROR_ALLOC;
      goto cleanup;
   }
 
   if( v->ct <= idx ) {
      error_printf( "index out of range!" );
      retval = MERROR_OVERFLOW;
      goto cleanup;
   }
 
   debug_printf( MDATA_TRACE_LVL, "removing vector item: " SIZE_T_FMT, idx );
 
   assert( 0 < v->item_sz );
 
   mdata_vector_lock( v );
 
   for( i = idx ; v->ct > i + 1 ; i++ ) {
      debug_printf( MDATA_TRACE_LVL,
         "shifting " SIZE_T_FMT "-byte vector item " SIZE_T_FMT " up by 1...",
         v->item_sz, i );
      memcpy(
         &(v->data_bytes[i * v->item_sz]),
         &(v->data_bytes[(i + 1) * v->item_sz]),
         v->item_sz );
   }
 
   v->ct--;
 
cleanup:
 
   mdata_vector_unlock( v );
 
   return retval;
}
 
/* === */
 
void* mdata_vector_get_void( struct MDATA_VECTOR* v, size_t idx ) {
 
   debug_printf( MDATA_TRACE_LVL,
      "getting vector item " SIZE_T_FMT " (of " SIZE_T_FMT ")...",
      idx, v->ct );
 
   assert( 0 == v->ct || NULL != v->data_bytes );
 
   if( idx >= v->ct ) {
      return NULL;
   } else {
      return _mdata_vector_item_ptr( v, idx );
   }
}
 
/* === */
 
MERROR_RETVAL mdata_vector_copy(
   struct MDATA_VECTOR* v_dest, struct MDATA_VECTOR* v_src
) {
   MERROR_RETVAL retval = MERROR_OK;
 
   if( NULL != v_src->data_bytes ) {
      error_printf( "vector cannot be copied while locked!" );
      retval = MERROR_ALLOC;
      goto cleanup;
   }
 
   assert( 0 < v_src->item_sz );
   assert( 0 < v_src->ct_max );
 
   v_dest->ct_max = v_src->ct_max;
   v_dest->ct = v_src->ct;
   v_dest->item_sz = v_src->item_sz;
   debug_printf(
      MDATA_TRACE_LVL,
      "copying " SIZE_T_FMT " vector of " SIZE_T_FMT "-byte nodes...",
      v_src->ct_max, v_src->item_sz );
   assert( (MAUG_MHANDLE)NULL == v_dest->data_h );
   v_dest->data_h = maug_malloc( v_src->ct_max, v_src->item_sz );
   maug_cleanup_if_null_alloc( MAUG_MHANDLE, v_dest->data_h );
 
   mdata_vector_lock( v_dest );
   mdata_vector_lock( v_src );
 
   memcpy( v_dest->data_bytes, v_src->data_bytes,
      v_src->ct_max * v_src->item_sz );
 
cleanup:
 
   mdata_vector_unlock( v_src );
   mdata_vector_unlock( v_dest );
 
   return retval;
}
 
/* === */
 
MERROR_RETVAL mdata_vector_alloc(
   struct MDATA_VECTOR* v, size_t item_sz, size_t item_ct_init
) {
   MERROR_RETVAL retval = MERROR_OK;
   MAUG_MHANDLE data_h_new = (MAUG_MHANDLE)NULL;
   size_t new_ct = item_ct_init,
      new_bytes_start = 0,
      new_bytes_sz = 0;
 
   if( NULL != v->data_bytes ) {
      error_printf( "vector cannot be resized while locked!" );
      retval = MERROR_ALLOC;
      goto cleanup;
   }
 
   /* Make sure there are free nodes. */
   if( (MAUG_MHANDLE)NULL == v->data_h ) {
      assert( 0 == v->ct_max );
 
      if( 0 < item_ct_init ) {
         debug_printf( MDATA_TRACE_LVL, "setting step sz: " SIZE_T_FMT,
            item_ct_init );
         v->ct_step = item_ct_init;
      } else if( 0 == v->ct_step ) {
         debug_printf( MDATA_TRACE_LVL, "setting step sz: %d",
            MDATA_VECTOR_INIT_STEP_SZ );
         v->ct_step = MDATA_VECTOR_INIT_STEP_SZ;
      }
      v->ct_max = v->ct_step;
      debug_printf(
         MDATA_TRACE_LVL,
         "creating " SIZE_T_FMT " vector of " SIZE_T_FMT "-byte nodes...",
         v->ct_max, item_sz );
      assert( (MAUG_MHANDLE)NULL == v->data_h );
      v->data_h = maug_malloc( v->ct_max, item_sz );
      v->item_sz = item_sz;
      maug_cleanup_if_null_alloc( MAUG_MHANDLE, v->data_h );
 
      /* Zero out the new space. */
      mdata_vector_lock( v );
      maug_mzero( v->data_bytes, v->ct_max * item_sz );
      mdata_vector_unlock( v );
 
      v->sz = sizeof( struct MDATA_VECTOR );
 
   } else if( v->ct_max <= v->ct + 1 || v->ct_max <= item_ct_init ) {
      assert( item_sz == v->item_sz );
      
      /* Use ct * 2 or ct_init... whichever is larger! */
      if( item_ct_init < v->ct_max + v->ct_step ) {
         assert( v->ct_max + v->ct_step > v->ct_max );
         new_ct = v->ct_max + v->ct_step;
      }
 
      /* Perform the resize. */
      debug_printf(
         MDATA_TRACE_LVL, "enlarging vector to " SIZE_T_FMT "...",
         new_ct );
      maug_mrealloc_test( data_h_new, v->data_h, new_ct, item_sz );
      
      /* Zero out the new space. */
      new_bytes_start = v->ct_max * v->item_sz;
      assert( new_bytes_start >= v->ct_max );
      new_bytes_sz = (new_ct * v->item_sz) - new_bytes_start;
      assert( new_bytes_sz >= v->item_sz );
      mdata_vector_lock( v );
      maug_mzero( &(v->data_bytes[new_bytes_start]), new_bytes_sz );
      mdata_vector_unlock( v );
 
      v->ct_max = new_ct;
   }
 
cleanup:
 
   return retval;
}
 
/* === */
 
void mdata_vector_free( struct MDATA_VECTOR* v ) {
   if( 0 < v->ct_max ) {
      maug_mfree( v->data_h );
   }
   v->ct = 0;
   v->ct_max = 0;
   v->item_sz = 0;
}
 
/* === */
 
MERROR_RETVAL mdata_table_set(
   struct MDATA_TABLE* t, const char* key, size_t key_sz,
   void* value, size_t value_sz
) {
   MERROR_RETVAL retval = MERROR_OK;
   ssize_t idx_key = -1;
   ssize_t idx_val = -1;
 
   /* TODO: This has all kinds of issues, obviously. At some point, turn it
    *       into a proper hashtable that can operate in tiny conditions!
    */
   
   assert(
      mdata_vector_ct( &(t->data_cols[0]) ) ==
      mdata_vector_ct( &(t->data_cols[1]) ) );
 
   idx_key = mdata_vector_append( &(t->data_cols[0]), key, key_sz + 1 );
   assert( 0 <= idx_key );
 
   /* TODO: Atomicity: remove key if value fails! */
 
   idx_val = mdata_vector_append( &(t->data_cols[1]), value, value_sz );
   assert( 0 <= idx_val );
 
/* cleanup: */
 
   /* TODO: Set retval! */
 
   return retval;
}
 
/* === */
 
MERROR_RETVAL mdata_table_get_void(
   struct MDATA_TABLE* t, const char* key, void** value_out, size_t value_sz
) {
   MERROR_RETVAL retval = MERROR_OK;
   char* c = NULL;
   size_t i = 0;
 
   assert( NULL == *value_out );
 
   mdata_vector_lock( &(t->data_cols[0]) );
   mdata_vector_lock( &(t->data_cols[1]) );
   for( i = 0 ; mdata_vector_ct( &(t->data_cols[0]) ) > i ; i++ ) {
      /* TODO: Maybe strpool would be better for this? */
      c = mdata_vector_get( &(t->data_cols[0]), i, char );
      assert( NULL != c );
      if( 0 == strncmp( key, c, t->data_cols[0].item_sz - 1 ) ) {
         *value_out = mdata_vector_get_void( &(t->data_cols[1]), i );
         goto cleanup;
      }
   }
 
   /* Not found! */
   retval = MERROR_OVERFLOW;
 
cleanup:
   
   mdata_vector_unlock( &(t->data_cols[0]) );
   mdata_vector_unlock( &(t->data_cols[1]) );
 
   return retval;
}
 
#endif /* MDATA_C */
 /* maug_data */
 
#endif /* MDATA_H */