moo/stix/lib/dic.c

/*
 * $Id$
 *
    Copyright (c) 2014-2016 Chung, Hyung-Hwan. All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:
    1. Redistributions of source code must retain the above copyright
       notice, this list of conditions and the following disclaimer.
    2. Redistributions in binary form must reproduce the above copyright
       notice, this list of conditions and the following disclaimer in the
       documentation and/or other materials provided with the distribution.

    THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR
    IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
    IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
    THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "stix-prv.h"

static stix_oop_oop_t expand_bucket (stix_t* stix, stix_oop_oop_t oldbuc)
{
	stix_oop_oop_t newbuc;
	stix_oow_t oldsz, newsz, index;
	stix_oop_association_t ass;
	stix_oop_char_t key;

	oldsz = STIX_OBJ_GET_SIZE(oldbuc);

	/* TODO: better growth policy? */
	if (oldsz < 5000) newsz = oldsz + oldsz;
	else if (oldsz < 50000) newsz = oldsz + (oldsz / 2);
	else if (oldsz < 100000) newsz = oldsz + (oldsz / 4);
	else if (oldsz < 200000) newsz = oldsz + (oldsz / 8);
	else if (oldsz < 400000) newsz = oldsz + (oldsz / 16);
	else if (oldsz < 800000) newsz = oldsz + (oldsz / 32);
	else if (oldsz < 1600000) newsz = oldsz + (oldsz / 64);
	else 
	{
		stix_oow_t inc, inc_max;

		inc = oldsz / 128;
		inc_max = STIX_OBJ_SIZE_MAX - oldsz;
		if (inc > inc_max) 
		{
			if (inc_max > 0) inc = inc_max;
			else
			{
				stix->errnum = STIX_EOOMEM;
				return STIX_NULL;
			}
		}
		newsz = oldsz + inc;
	}

	stix_pushtmp (stix, (stix_oop_t*)&oldbuc);
	newbuc = (stix_oop_oop_t)stix_instantiate (stix, stix->_array, STIX_NULL, newsz); 
	stix_poptmp (stix);
	if (!newbuc) return STIX_NULL;

	while (oldsz > 0)
	{
		ass = (stix_oop_association_t)oldbuc->slot[--oldsz];
		if ((stix_oop_t)ass != stix->_nil)
		{
			STIX_ASSERT (stix, STIX_CLASSOF(stix,ass) == stix->_association);

			key = (stix_oop_char_t)ass->key;
			STIX_ASSERT (stix, STIX_CLASSOF(stix,key) == (stix_oop_t)stix->_symbol);

			index = stix_hashoochars(key->slot, STIX_OBJ_GET_SIZE(key)) % newsz;
			while (newbuc->slot[index] != stix->_nil) index = (index + 1) % newsz;
			newbuc->slot[index] = (stix_oop_t)ass;
		}
	}

	return newbuc;
}

static stix_oop_association_t find_or_upsert (stix_t* stix, stix_oop_set_t dic, stix_oop_char_t key, stix_oop_t value)
{
	stix_ooi_t tally;
	stix_oow_t hv, index;
	stix_oop_association_t ass;
	stix_oow_t tmp_count = 0;

	/* the system dictionary is not a generic dictionary.
	 * it accepts only a symbol as a key. */
	STIX_ASSERT (stix, STIX_CLASSOF(stix,key) == stix->_symbol);
	STIX_ASSERT (stix, STIX_CLASSOF(stix,dic->tally) == stix->_small_integer);
	STIX_ASSERT (stix, STIX_CLASSOF(stix,dic->bucket) == stix->_array);

	hv = stix_hashoochars(key->slot, STIX_OBJ_GET_SIZE(key));
	index = hv % STIX_OBJ_GET_SIZE(dic->bucket);

	/* find */
	while (dic->bucket->slot[index] != stix->_nil) 
	{
		ass = (stix_oop_association_t)dic->bucket->slot[index];

		STIX_ASSERT (stix, STIX_CLASSOF(stix,ass) == stix->_association);
		STIX_ASSERT (stix, STIX_CLASSOF(stix,ass->key) == stix->_symbol);

		if (STIX_OBJ_GET_SIZE(key) == STIX_OBJ_GET_SIZE(ass->key) &&
		    stix_equaloochars (key->slot, ((stix_oop_char_t)ass->key)->slot, STIX_OBJ_GET_SIZE(key))) 
		{
			/* the value of STIX_NULL indicates no insertion or update. */
			if (value) ass->value = value; /* update */
			return ass;
		}

		index = (index + 1) % STIX_OBJ_GET_SIZE(dic->bucket);
	}

	if (!value)
	{
		/* when value is STIX_NULL, perform no insertion.
		 * the value of STIX_NULL indicates no insertion or update. */
		stix->errnum = STIX_ENOENT;
		return STIX_NULL;
	}

	/* the key is not found. insert it. */
	STIX_ASSERT (stix, STIX_OOP_IS_SMOOI(dic->tally));
	tally = STIX_OOP_TO_SMOOI(dic->tally);
	if (tally >= STIX_SMOOI_MAX)
	{
		/* this built-in dictionary is not allowed to hold more than 
		 * STIX_SMOOI_MAX items for efficiency sake */
		stix->errnum = STIX_EDFULL;
		return STIX_NULL;
	}

	stix_pushtmp (stix, (stix_oop_t*)&dic); tmp_count++;
	stix_pushtmp (stix, (stix_oop_t*)&key); tmp_count++;
	stix_pushtmp (stix, &value); tmp_count++;

	/* no conversion to stix_oow_t is necessary for tally + 1.
	 * the maximum value of tally is checked to be STIX_SMOOI_MAX - 1.
	 * tally + 1 can produce at most STIX_SMOOI_MAX. above all, 
	 * STIX_SMOOI_MAX is way smaller than STIX_TYPE_MAX(stix_ooi_t). */
	if (tally + 1 >= STIX_OBJ_GET_SIZE(dic->bucket))
	{
		stix_oop_oop_t bucket;

		/* TODO: make the growth policy configurable instead of growing
			     it just before it gets full. The polcy can be grow it
			     if it's 70% full */

		/* enlarge the bucket before it gets full to
		 * make sure that it has at least one free slot left
		 * after having added a new symbol. this is to help
		 * traversal end at a _nil slot if no entry is found. */
		bucket = expand_bucket (stix, dic->bucket);
		if (!bucket) goto oops;

		dic->bucket = bucket;

		/* recalculate the index for the expanded bucket */
		index = hv % STIX_OBJ_GET_SIZE(dic->bucket);

		while (dic->bucket->slot[index] != stix->_nil) 
			index = (index + 1) % STIX_OBJ_GET_SIZE(dic->bucket);
	}

	/* create a new assocation of a key and a value since 
	 * the key isn't found in the root dictionary */
	ass = (stix_oop_association_t)stix_instantiate (stix, stix->_association, STIX_NULL, 0);
	if (!ass) goto oops;

	ass->key = (stix_oop_t)key;
	ass->value = value;

	/* the current tally must be less than the maximum value. otherwise,
	 * it overflows after increment below */
	STIX_ASSERT (stix, tally < STIX_SMOOI_MAX);
	dic->tally = STIX_SMOOI_TO_OOP(tally + 1);
	dic->bucket->slot[index] = (stix_oop_t)ass;

	stix_poptmps (stix, tmp_count);
	return ass;

oops:
	stix_poptmps (stix, tmp_count);
	return STIX_NULL;
}

static stix_oop_association_t lookup (stix_t* stix, stix_oop_set_t dic, const stix_oocs_t* name)
{
	/* this is special version of stix_getatsysdic() that performs
	 * lookup using a plain string specified */

	stix_oow_t index;
	stix_oop_association_t ass;

	STIX_ASSERT (stix, STIX_CLASSOF(stix,dic->tally) == stix->_small_integer);
	STIX_ASSERT (stix, STIX_CLASSOF(stix,dic->bucket) == stix->_array);

	index = stix_hashoochars(name->ptr, name->len) % STIX_OBJ_GET_SIZE(dic->bucket);

	while (dic->bucket->slot[index] != stix->_nil) 
	{
		ass = (stix_oop_association_t)dic->bucket->slot[index];

		STIX_ASSERT (stix, STIX_CLASSOF(stix,ass) == stix->_association);
		STIX_ASSERT (stix, STIX_CLASSOF(stix,ass->key) == stix->_symbol);

		if (name->len == STIX_OBJ_GET_SIZE(ass->key) &&
		    stix_equaloochars(name->ptr, ((stix_oop_char_t)ass->key)->slot, name->len)) 
		{
			return ass;
		}

		index = (index + 1) % STIX_OBJ_GET_SIZE(dic->bucket);
	}

	/* when value is STIX_NULL, perform no insertion */
	stix->errnum = STIX_ENOENT;
	return STIX_NULL;
}

stix_oop_association_t stix_putatsysdic (stix_t* stix, stix_oop_t key, stix_oop_t value)
{
	STIX_ASSERT (stix, STIX_CLASSOF(stix,key) == stix->_symbol);
	return find_or_upsert (stix, stix->sysdic, (stix_oop_char_t)key, value);
}

stix_oop_association_t stix_getatsysdic (stix_t* stix, stix_oop_t key)
{
	STIX_ASSERT (stix, STIX_CLASSOF(stix,key) == stix->_symbol);
	return find_or_upsert (stix, stix->sysdic, (stix_oop_char_t)key, STIX_NULL);
}

stix_oop_association_t stix_lookupsysdic (stix_t* stix, const stix_oocs_t* name)
{
	return lookup (stix, stix->sysdic, name);
}

stix_oop_association_t stix_putatdic (stix_t* stix, stix_oop_set_t dic, stix_oop_t key, stix_oop_t value)
{
	STIX_ASSERT (stix, STIX_CLASSOF(stix,key) == stix->_symbol);
	return find_or_upsert (stix, dic, (stix_oop_char_t)key, value);
}

stix_oop_association_t stix_getatdic (stix_t* stix, stix_oop_set_t dic, stix_oop_t key)
{
	STIX_ASSERT (stix, STIX_CLASSOF(stix,key) == stix->_symbol);
	return find_or_upsert (stix, dic, (stix_oop_char_t)key, STIX_NULL);
}

stix_oop_association_t stix_lookupdic (stix_t* stix, stix_oop_set_t dic, const stix_oocs_t* name)
{
	return lookup (stix, dic, name);
}

int stix_deletedic (stix_t* stix, stix_oop_set_t dic, const stix_oocs_t* name)
{
	stix_ooi_t tally;
	stix_oow_t hv, index, bs, i, x, y, z;
	stix_oop_association_t ass;

	STIX_ASSERT (stix, STIX_CLASSOF(stix,dic->tally) == stix->_small_integer);
	STIX_ASSERT (stix, STIX_CLASSOF(stix,dic->bucket) == stix->_array);

	tally = STIX_OOP_TO_SMOOI(dic->tally);

	bs = STIX_OBJ_GET_SIZE(dic->bucket);
	hv = stix_hashoochars(name->ptr, name->len) % bs;
	index = hv % bs;

	/* find */
	while (dic->bucket->slot[index] != stix->_nil) 
	{
		ass = (stix_oop_association_t)dic->bucket->slot[index];

		STIX_ASSERT (stix, STIX_CLASSOF(stix,ass) == stix->_association);
		STIX_ASSERT (stix, STIX_CLASSOF(stix,ass->key) == stix->_symbol);

		if (name->len == STIX_OBJ_GET_SIZE(ass->key) &&
		    stix_equaloochars(name->ptr, ((stix_oop_char_t)ass->key)->slot, name->len)) 
		{
			goto found;
		}

		index = (index + 1) % bs;
	}

	stix->errnum = STIX_ENOENT;
	return -1;

found:
	/* compact the cluster */
	for (i = 0, x = index, y = index; i < tally; i++)
	{
		y = (y + 1) % bs;

		/* done if the slot at the current index is empty */
		if (dic->bucket->slot[y] == stix->_nil) break;

		/* get the natural hash index for the data in the slot at
		 * the current hash index */
		ass = (stix_oop_association_t)dic->bucket->slot[y];
		z = stix_hashoochars(((stix_oop_char_t)ass->key)->slot, STIX_OBJ_GET_SIZE(ass->key)) % bs;

		/* move an element if necesary */
		if ((y > x && (z <= x || z > y)) ||
		    (y < x && (z <= x && z > y)))
		{
			dic->bucket->slot[x] = dic->bucket->slot[y];
			x = y;
		}
	}

	dic->bucket->slot[x] = stix->_nil;

	tally--;
	dic->tally = STIX_SMOOI_TO_OOP(tally);

	return 0;
}

stix_oop_set_t stix_makedic (stix_t* stix, stix_oop_t cls, stix_oow_t size)
{
	stix_oop_set_t dic;
	stix_oop_t tmp;

	STIX_ASSERT (stix, STIX_CLASSOF(stix,cls) == stix->_class);

	dic = (stix_oop_set_t)stix_instantiate (stix, cls, STIX_NULL, 0);
	if (!dic) return STIX_NULL;

	STIX_ASSERT (stix, STIX_OBJ_GET_SIZE(dic) == STIX_SET_NAMED_INSTVARS);

	stix_pushtmp (stix, (stix_oop_t*)&dic);
	tmp = stix_instantiate (stix, stix->_array, STIX_NULL, size);
	stix_poptmp (stix);
	if (!tmp) return STIX_NULL;

	dic->tally = STIX_SMOOI_TO_OOP(0);
	dic->bucket = (stix_oop_oop_t)tmp;

	STIX_ASSERT (stix, STIX_OBJ_GET_SIZE(dic) == STIX_SET_NAMED_INSTVARS);
	STIX_ASSERT (stix, STIX_OBJ_GET_SIZE(dic->bucket) == size);

	return dic;
}