/** \file util.c Generic utilities library. Contains datastructures such as hash tables, automatically growing array lists, priority queues, etc. */ #include "config.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "fallback.h" #include "util.h" #include "common.h" #include "wutil.h" /** Minimum allocated size for data structures. Used to avoid excessive memory allocations for lists, hash tables, etc, which are nearly empty. */ #define MIN_SIZE 32 /** Minimum size for hash tables */ #define HASH_MIN_SIZE 7 /** Maximum number of characters that can be inserted using a single call to sb_printf. This is needed since vswprintf doesn't tell us what went wrong. We don't know if we ran out of space or something else went wrong. Therefore we assume that any error is an out of memory-error and try again until we reach this size. */ #define SB_MAX_SIZE 32767 #define oom_handler( p ) \ { \ if( oom_handler_internal == util_die_on_oom ) \ { \ DIE_MEM(); \ } \ oom_handler_internal( p ); \ } \ void util_die_on_oom( void * p); void (*oom_handler_internal)(void *) = &util_die_on_oom; void (*util_set_oom_handler( void (*h)(void *) ))(void *) { void (*old)(void *) = oom_handler_internal; if( h ) oom_handler_internal = h; else oom_handler_internal = &util_die_on_oom; return old; } void util_die_on_oom( void * p) { } int mini( int a, int b ) { return ab?a:b; } /* Queue functions */ void q_init( dyn_queue_t *q ) { q->start = (void **)malloc( sizeof(void*)*1 ); if( !q->start ) { oom_handler( q ); return; } q->stop = &q->start[1]; q->put_pos = q->get_pos = q->start; } void q_destroy( dyn_queue_t *q ) { free( q->start ); } /** Reallocate the queue_t */ static int q_realloc( dyn_queue_t *q ) { void **old_start = q->start; void **old_stop = q->stop; int diff; int new_size; new_size = 2*(q->stop-q->start); q->start=(void**)realloc( q->start, sizeof(void*)*new_size ); if( !q->start ) { q->start = old_start; oom_handler( q ); return 0; } diff = q->start - old_start; q->get_pos += diff; q->stop = &q->start[new_size]; memcpy( old_stop + diff, q->start, sizeof(void*)*(q->get_pos-q->start)); q->put_pos = old_stop + diff + (q->get_pos-q->start); return 1; } int q_put( dyn_queue_t *q, void *e ) { *q->put_pos = e; // fprintf( stderr, "Put element %d to queue %d\n", e, q ); if( ++q->put_pos == q->stop ) q->put_pos = q->start; if( q->put_pos == q->get_pos ) return q_realloc( q ); return 1; } void *q_get( dyn_queue_t *q) { void *e = *q->get_pos; if( ++q->get_pos == q->stop ) q->get_pos = q->start; return e; } void *q_peek( dyn_queue_t *q ) { return *q->get_pos; } int q_empty( dyn_queue_t *q ) { // fprintf( stderr, "Queue %d is %s\n", q, (q->put_pos == q->get_pos)?"empty":"non-empty" ); return q->put_pos == q->get_pos; } /* Hash table functions */ void hash_init2( hash_table_t *h, int (*hash_func)(void *key), int (*compare_func)(void *key1, void *key2), size_t capacity) { int i; size_t sz = 32; while( sz < (capacity*4/3) ) sz*=2; /* Make sure the size is a Mersenne number. Should hopfully be a reasonably good size with regard to avoiding patterns of collisions. */ sz--; h->arr = malloc( sizeof(hash_struct_t)*sz ); if( !h->arr ) { oom_handler( h ); return; } h->size = sz; for( i=0; i< sz; i++ ) h->arr[i].key = 0; h->count=0; h->hash_func = hash_func; h->compare_func = compare_func; h->cache=-1; } void hash_init( hash_table_t *h, int (*hash_func)(void *key), int (*compare_func)(void *key1, void *key2) ) { h->arr = 0; h->size = 0; h->count=0; h->hash_func = hash_func; h->compare_func = compare_func; h->cache=-1; } void hash_destroy( hash_table_t *h ) { free( h->arr ); } /** Search for the specified hash key in the table \return index in the table, or to the first free index if the key is not in the table */ static int hash_search( hash_table_t *h, void *key ) { int hv; int pos; if( h->cache>=0 && h->arr[h->cache].key) { if( h->compare_func( h->arr[h->cache].key, key ) ) { return h->cache; } } hv = h->hash_func( key ); pos = (hv & 0x7fffffff) % h->size; while(1) { if( (h->arr[pos].key == 0 ) || ( h->compare_func( h->arr[pos].key, key ) ) ) { h->cache = pos; return pos; } pos++; pos %= h->size; } } /** Reallocate the hash array. This is quite expensive, as every single entry has to be rehashed and moved. */ static int hash_realloc( hash_table_t *h, int sz ) { /* Avoid reallocating when using pathetically small tables */ if( ( sz < h->size ) && (h->size < HASH_MIN_SIZE)) return 1; sz = maxi( sz, HASH_MIN_SIZE ); hash_struct_t *old_arr = h->arr; int old_size = h->size; int i; h->cache = -1; h->arr = malloc( sizeof( hash_struct_t) * sz ); if( h->arr == 0 ) { h->arr = old_arr; oom_handler( h ); return 0; } memset( h->arr, 0, sizeof( hash_struct_t) * sz ); h->size = sz; for( i=0; iarr[pos].key = old_arr[i].key; h->arr[pos].data = old_arr[i].data; } } free( old_arr ); return 1; } int hash_put( hash_table_t *h, const void *key, const void *data ) { int pos; if( (float)(h->count+1)/h->size > 0.75f ) { if( !hash_realloc( h, (h->size+1) * 2 -1 ) ) { return 0; } } pos = hash_search( h, (void *)key ); if( h->arr[pos].key == 0 ) { h->count++; } h->arr[pos].key = (void *)key; h->arr[pos].data = (void *)data; return 1; } void *hash_get( hash_table_t *h, const void *key ) { if( !h->count ) return 0; int pos = hash_search( h, (void *)key ); if( h->arr[pos].key == 0 ) { return 0; } else { void *res =h->arr[pos].data; return res; } } void *hash_get_key( hash_table_t *h, const void *key ) { if( !h->count ) return 0; int pos = hash_search( h, (void *)key ); if( h->arr[pos].key == 0 ) return 0; else return h->arr[pos].key; } int hash_get_count( hash_table_t *h) { return h->count; } void hash_remove( hash_table_t *h, const void *key, void **old_key, void **old_val ) { if( !h->count ) { if( old_key != 0 ) *old_key = 0; if( old_val != 0 ) *old_val = 0; return; } int pos = hash_search( h, (void *)key ); int next_pos; if( h->arr[pos].key == 0 ) { if( old_key != 0 ) *old_key = 0; if( old_val != 0 ) *old_val = 0; return; } h->count--; if( old_key != 0 ) *old_key = h->arr[pos].key; if( old_val != 0 ) *old_val = h->arr[pos].data; h->arr[pos].key = 0; next_pos = pos+1; next_pos %= h->size; while( h->arr[next_pos].key != 0 ) { int hv = h->hash_func( h->arr[next_pos].key ); int ideal_pos = ( hv & 0x7fffffff) % h->size; int dist_old = (next_pos - ideal_pos + h->size)%h->size; int dist_new = (pos - ideal_pos + h->size)%h->size; if ( dist_new < dist_old ) { h->arr[pos].key = h->arr[next_pos].key; h->arr[pos].data = h->arr[next_pos].data; h->arr[next_pos].key = 0; pos = next_pos; } next_pos++; next_pos %= h->size; } if( (float)(h->count+1)/h->size < 0.2f && h->count < 63 ) { hash_realloc( h, (h->size+1) / 2 -1 ); } return; } int hash_contains( hash_table_t *h, const void *key ) { if( !h->count ) return 0; int pos = hash_search( h, (void *)key ); return h->arr[pos].key != 0; } /** Push hash value into array_list_t */ static void hash_put_data( void *key, void *data, void *al ) { al_push( (array_list_t *)al, data ); } void hash_get_data( hash_table_t *h, array_list_t *arr ) { hash_foreach2( h, &hash_put_data, arr ); } /** Push hash key into array_list_t */ static void hash_put_key( void *key, void *data, void *al ) { al_push( (array_list_t *)al, key ); } void hash_get_keys( hash_table_t *h, array_list_t *arr ) { hash_foreach2( h, &hash_put_key, arr ); } void hash_foreach( hash_table_t *h, void (*func)( void *, void *) ) { int i; for( i=0; isize; i++ ) { if( h->arr[i].key != 0 ) { func( h->arr[i].key, h->arr[i].data ); } } } void hash_foreach2( hash_table_t *h, void (*func)( void *, void *, void * ), void *aux ) { int i; for( i=0; isize; i++ ) { if( h->arr[i].key != 0 ) { func( h->arr[i].key, h->arr[i].data, aux ); } } } /** Helper function for hash_wcs_func */ static unsigned int rotl1( unsigned int in ) { return (in<<1|in>>31); } /** Helper function for hash_wcs_func */ static unsigned int rotl5( unsigned int in ) { return (in<<5|in>>27); } /** Helper function for hash_wcs_func */ static unsigned int rotl30( unsigned int in ) { return (in<<30|in>>2); } /** The number of words of input used in each lap by the sha-like string hashing algorithm. */ #define WORD_COUNT 16 int hash_wcs_func( void *data ) { const wchar_t *in = (const wchar_t *)data; unsigned int a,b,c,d,e; int t; unsigned int k0=0x5a827999u; unsigned int k1 =0x6ed9eba1u; unsigned int w[2*WORD_COUNT]; /* Same constants used by sha1 */ a=0x67452301u; b=0xefcdab89u; c=0x98badcfeu; d=0x10325476u; e=0xc3d2e1f0u; if( data == 0 ) return 0; while( *in ) { int i; /* Read WORD_COUNT words of data into w */ for( i=0; iarr=0; q->size=0; q->count=0; q->compare = compare; } int pq_put( priority_queue_t *q, void *e ) { int i; if( q->size == q->count ) { void **old_arr = q->arr; int old_size = q->size; q->size = maxi( 4, 2*q->size ); q->arr = (void **)realloc( q->arr, sizeof(void*)*q->size ); if( q->arr == 0 ) { oom_handler( q ); q->arr = old_arr; q->size = old_size; return 0; } } i = q->count; while( (i>0) && (q->compare( q->arr[(i-1)/2], e )<0 ) ) { q->arr[i] = q->arr[(i-1)/2]; i = (i-1)/2; } q->arr[i]=e; q->count++; return 1; } /** Make a valid head */ static void pq_heapify( priority_queue_t *q, int i ) { int l, r, largest; l = 2*(i)+1; r = 2*(i)+2; if( (l < q->count) && (q->compare(q->arr[l],q->arr[i])>0) ) { largest = l; } else { largest = i; } if( (r < q->count) && (q->compare( q->arr[r],q->arr[largest])>0) ) { largest = r; } if( largest != i ) { void *tmp = q->arr[largest]; q->arr[largest]=q->arr[i]; q->arr[i]=tmp; pq_heapify( q, largest ); } } void *pq_get( priority_queue_t *q ) { void *result = q->arr[0]; q->arr[0] = q->arr[--q->count]; pq_heapify( q, 0 ); /* pq_check(q, 0 ); */ /* pq_print( q ); */ return result; } void *pq_peek( priority_queue_t *q ) { return q->arr[0]; } int pq_empty( priority_queue_t *q ) { return q->count == 0; } int pq_get_count( priority_queue_t *q ) { return q->count; } void pq_destroy( priority_queue_t *q ) { free( q->arr ); } array_list_t *al_new() { array_list_t *res = malloc( sizeof( array_list_t ) ); if( !res ) { oom_handler( 0 ); return 0; } al_init( res ); return res; } void al_init( array_list_t *l ) { memset( l, 0, sizeof( array_list_t ) ); } void al_destroy( array_list_t *l ) { free( l->arr ); } static int al_push_generic( array_list_t *l, anything_t o ) { if( l->pos >= l->size ) { int new_size = l->pos == 0 ? MIN_SIZE : 2 * l->pos; void *tmp = realloc( l->arr, sizeof( anything_t )*new_size ); if( tmp == 0 ) { oom_handler( l ); return 0; } l->arr = tmp; l->size = new_size; } l->arr[l->pos++] = o; return 1; } int al_push( array_list_t *l, const void *o ) { anything_t v; v.ptr_val = (void *)o; return al_push_generic( l, v ); } int al_push_long( array_list_t *l, long val ) { anything_t v; v.long_val = val; return al_push_generic( l, v ); } int al_push_func( array_list_t *l, func_ptr_t f ) { anything_t v; v.func_val = f; return al_push_generic( l, v ); } int al_push_all( array_list_t *a, array_list_t *b ) { int k; for( k=0; k= 0 ); assert( count >= 0 ); assert( a ); if( !count ) return 0; /* Reallocate, if needed */ if( maxi( pos, a->pos) + count > a->size ) { /* If we reallocate, add a few extra elements just in case we want to do some more reallocating any time soon */ size_t new_size = maxi( maxi( pos, a->pos ) + count +32, a->size*2); void *tmp = realloc( a->arr, sizeof( anything_t )*new_size ); if( tmp ) { a->arr = tmp; } else { oom_handler( a ); return 0; } } if( a->pos > pos ) { memmove( &a->arr[pos], &a->arr[pos+count], sizeof(anything_t ) * (a->pos-pos) ); } memset( &a->arr[pos], 0, sizeof(anything_t)*count ); a->pos += count; return 1; } static int al_set_generic( array_list_t *l, int pos, anything_t v ) { int old_pos; if( pos < 0 ) return 0; if( pos < l->pos ) { l->arr[pos]=v; return 1; } old_pos=l->pos; l->pos = pos; if( al_push_generic( l, v ) ) { memset( &l->arr[old_pos], 0, sizeof(anything_t) * (pos - old_pos) ); return 1; } return 0; } int al_set( array_list_t *l, int pos, const void *o ) { anything_t v; v.ptr_val = (void *)o; return al_set_generic( l, pos, v ); } int al_set_long( array_list_t *l, int pos, long o ) { anything_t v; v.long_val = o; return al_set_generic( l, pos, v ); } int al_set_func( array_list_t *l, int pos, func_ptr_t o ) { anything_t v; v.func_val = o; return al_set_generic( l, pos, v ); } static anything_t al_get_generic( array_list_t *l, int pos ) { anything_t res; res.ptr_val=0; if( (pos >= 0) && (pos < l->pos) ) res = l->arr[pos]; return res; } void *al_get( array_list_t *l, int pos ) { return al_get_generic(l,pos).ptr_val; } long al_get_long( array_list_t *l, int pos ) { return al_get_generic(l,pos).long_val; } func_ptr_t al_get_func( array_list_t *l, int pos ) { return al_get_generic(l,pos).func_val; } void al_truncate( array_list_t *l, int new_sz ) { CHECK( l, ); l->pos = new_sz; } static anything_t al_pop_generic( array_list_t *l ) { anything_t e; if( l->pos <= 0 ) { memset( &e, 0, sizeof(anything_t ) ); return e; } e = l->arr[--l->pos]; if( (l->pos*3 < l->size) && (l->size < MIN_SIZE) ) { anything_t *old_arr = l->arr; int old_size = l->size; l->size = l->size/2; l->arr = realloc( l->arr, sizeof(anything_t)*l->size ); if( l->arr == 0 ) { l->arr = old_arr; l->size = old_size; /* We are _shrinking_ the list here, so if the allocation fails (it never should, but hey) then we can keep using the old list - no need to flag any error... */ } } return e; } void *al_pop( array_list_t *l ) { return al_pop_generic(l).ptr_val; } long al_pop_long( array_list_t *l ) { return al_pop_generic(l).long_val; } func_ptr_t al_pop_func( array_list_t *l ) { return al_pop_generic(l).func_val; } static anything_t al_peek_generic( array_list_t *l ) { anything_t res; res.ptr_val=0; if( l->pos>0) res = l->arr[l->pos-1]; return res; } void *al_peek( array_list_t *l ) { return al_peek_generic(l).ptr_val; } long al_peek_long( array_list_t *l ) { return al_peek_generic(l).long_val; } func_ptr_t al_peek_func( array_list_t *l ) { return al_peek_generic(l).func_val; } int al_empty( array_list_t *l ) { CHECK( l, 1 ); return l->pos == 0; } int al_get_count( array_list_t *l ) { CHECK( l, 0 ); return l->pos; } void al_foreach( array_list_t *l, void (*func)( void * )) { int i; CHECK( l, ); CHECK( func, ); for( i=0; ipos; i++ ) func( l->arr[i].ptr_val ); } void al_foreach2( array_list_t *l, void (*func)( void *, void *), void *aux) { int i; CHECK( l, ); CHECK( func, ); for( i=0; ipos; i++ ) func( l->arr[i].ptr_val, aux ); } int wcsfilecmp( const wchar_t *a, const wchar_t *b ) { CHECK( a, 0 ); CHECK( b, 0 ); if( *a==0 ) { if( *b==0) return 0; return -1; } if( *b==0 ) { return 1; } int secondary_diff=0; if( iswdigit( *a ) && iswdigit( *b ) ) { wchar_t *aend, *bend; long al; long bl; int diff; errno = 0; al = wcstol( a, &aend, 10 ); bl = wcstol( b, &bend, 10 ); if( errno ) { /* Huuuuuuuuge numbers - fall back to regular string comparison */ return wcscmp( a, b ); } diff = al - bl; if( diff ) return diff>0?2:-2; secondary_diff = (aend-a) - (bend-b); a=aend-1; b=bend-1; } else { int diff = towlower(*a) - towlower(*b); if( diff != 0 ) return (diff>0)?2:-2; secondary_diff = *a-*b; } int res = wcsfilecmp( a+1, b+1 ); if( abs(res) < 2 ) { /* No primary difference in rest of string. Use secondary difference on this element if found. */ if( secondary_diff ) { return secondary_diff>0?1:-1; } } return res; } void sb_init( string_buffer_t * b) { wchar_t c=0; CHECK( b, ); if( !b ) { return; } memset( b, 0, sizeof(string_buffer_t) ); b_append( b, &c, sizeof( wchar_t)); b->used -= sizeof(wchar_t); } string_buffer_t *sb_new() { string_buffer_t *res = malloc( sizeof( string_buffer_t ) ); if( !res ) { oom_handler( 0 ); return 0; } sb_init( res ); return res; } void sb_append( string_buffer_t *b, const wchar_t * s) { CHECK( b, ); CHECK( s, ); b_append( b, s, sizeof(wchar_t)*(wcslen(s)+1) ); b->used -= sizeof(wchar_t); } void sb_append_substring( string_buffer_t *b, const wchar_t *s, size_t l ) { wchar_t tmp=0; CHECK( b, ); CHECK( s, ); b_append( b, s, sizeof(wchar_t)*l ); b_append( b, &tmp, sizeof(wchar_t) ); b->used -= sizeof(wchar_t); } void sb_append_char( string_buffer_t *b, wchar_t c ) { wchar_t tmp=0; CHECK( b, ); b_append( b, &c, sizeof(wchar_t) ); b_append( b, &tmp, sizeof(wchar_t) ); b->used -= sizeof(wchar_t); } void sb_append2( string_buffer_t *b, ... ) { va_list va; wchar_t *arg; CHECK( b, ); va_start( va, b ); while( (arg=va_arg(va, wchar_t *) )!= 0 ) { sb_append( b, arg ); } va_end( va ); } int sb_printf( string_buffer_t *buffer, const wchar_t *format, ... ) { va_list va; int res; CHECK( buffer, -1 ); CHECK( format, -1 ); va_start( va, format ); res = sb_vprintf( buffer, format, va ); va_end( va ); return res; } int sb_vprintf( string_buffer_t *buffer, const wchar_t *format, va_list va_orig ) { int res; CHECK( buffer, -1 ); CHECK( format, -1 ); if( !buffer->length ) { buffer->length = MIN_SIZE; buffer->buff = malloc( MIN_SIZE ); if( !buffer->buff ) { oom_handler( buffer ); return -1; } } while( 1 ) { va_list va; va_copy( va, va_orig ); res = vswprintf( (wchar_t *)((char *)buffer->buff+buffer->used), (buffer->length-buffer->used)/sizeof(wchar_t), format, va ); va_end( va ); if( res >= 0 ) { buffer->used+= res*sizeof(wchar_t); break; } /* As far as I know, there is no way to check if a vswprintf-call failed because of a badly formated string option or because the supplied destination string was to small. In GLIBC, errno seems to be set to EINVAL either way. Because of this, sb_printf will on failiure try to increase the buffer size until the free space is larger than SB_MAX_SIZE, at which point it will conclude that the error was probably due to a badly formated string option, and return an error. */ if( buffer->length - buffer->used > SB_MAX_SIZE ) break; buffer->buff = realloc( buffer->buff, 2*buffer->length ); if( !buffer->buff ) { oom_handler( buffer ); return -1; } buffer->length *= 2; } return res; } void sb_destroy( string_buffer_t * b ) { CHECK( b, ); free( b->buff ); } void sb_clear( string_buffer_t * b ) { sb_truncate( b, 0 ); assert( !wcslen( (wchar_t *)b->buff) ); } void sb_truncate( string_buffer_t *b, int chars_left ) { wchar_t *arr; CHECK( b, ); b->used = (chars_left)*sizeof( wchar_t); arr = (wchar_t *)b->buff; arr[chars_left] = 0; } ssize_t sb_length( string_buffer_t *b ) { CHECK( b, -1 ); return (b->used-1)/sizeof( wchar_t); } void b_init( buffer_t *b) { CHECK( b, ); memset( b,0,sizeof(buffer_t)); } void b_destroy( buffer_t *b ) { CHECK( b, ); free( b->buff ); } int b_append( buffer_t *b, const void *d, ssize_t len ) { if( len<=0 ) return 0; CHECK( b, -1 ); if( !b ) { return 0; } if( !d ) { return 0; } if( b->length <= (b->used + len) ) { size_t l = maxi( b->length*2, b->used+len+MIN_SIZE ); void *d = realloc( b->buff, l ); if( !d ) { oom_handler( b ); return -1; } b->buff=d; b->length = l; } memcpy( ((char*)b->buff)+b->used, d, len ); // fwprintf( stderr, L"Copy %s, new value %s\n", d, b->buff ); b->used+=len; return 1; } long long get_time() { struct timeval time_struct; gettimeofday( &time_struct, 0 ); return 1000000ll*time_struct.tv_sec+time_struct.tv_usec; }