open_address_file_hash_dictionary_handler.h File Reference

Description

The handler for a hash table using linear probing.

Author
Scott Ronald Fazackerley
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.
3.Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER OR CONTRIBUTORS 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.

Definition in file open_address_file_hash_dictionary_handler.h.

Include dependency graph for open_address_file_hash_dictionary_handler.h:
This graph shows which files directly or indirectly include this file:

Classes

struct  oaf_dictionary
 Struct used to for instance of a given dictionary. More...
 
struct  oafdict_equality_cursor
 Cursor for dictionary specific implementations. More...
 

Typedefs

typedef struct oaf_dictionary ion_oaf_dictionary_t
 Struct used to for instance of a given dictionary. More...
 
typedef struct oafdict_equality_cursor ion_oafdict_equality_cursor_t
 Cursor for dictionary specific implementations. More...
 

Functions

void oafdict_init (ion_dictionary_handler_t *handler)
 Registers a specific handler for a dictionary instance. More...
 
ion_status_t oafdict_insert (ion_dictionary_t *dictionary, ion_key_t key, ion_value_t value)
 Inserts a key and value into the dictionary. More...
 
ion_err_t oafdict_create_dictionary (ion_dictionary_id_t id, ion_key_type_t key_type, ion_key_size_t key_size, ion_value_size_t value_size, ion_dictionary_size_t dictionary_size, ion_dictionary_compare_t compare, ion_dictionary_handler_t *handler, ion_dictionary_t *dictionary)
 Creates an instance of a dictionary. More...
 
ion_status_t oafdict_delete (ion_dictionary_t *dictionary, ion_key_t key)
 Deletes the key and assoicated value from the dictionary instance. More...
 
ion_err_t oafdict_delete_dictionary (ion_dictionary_t *dictionary)
 Deletes an instance of the dictionary and associated data. More...
 
ion_err_t oafdict_destroy_dictionary (ion_dictionary_id_t id)
 Cleans up all files created by the dictionary, and frees any allocated memory, for an already closed dictionary. More...
 
ion_status_t oafdict_update (ion_dictionary_t *dictionary, ion_key_t key, ion_value_t value)
 Updates the value for a given key. More...
 
int oafdict_compare (ion_key_t first_key, ion_key_t second_key)
 Compares two key and returns the difference. More...
 
void oafdict_destroy_cursor (ion_dict_cursor_t **cursor)
 Next function to query and retrieve the next <K,V> that stratifies the predicate of the cursor. More...
 

Typedef Documentation

Struct used to for instance of a given dictionary.

Cursor for dictionary specific implementations.

Dictionary cursor for equality queries.

Used when a dictionary supports multiple vvalues for a given key.

        This subtype should be extended when supported for a given
        dictionary.

Function Documentation

int oafdict_compare ( ion_key_t  first_key,
ion_key_t  second_key 
)

Compares two key and returns the difference.

Compares two key and returns the difference depending on the type of the key defined for the dictionary instance. If the keys are of numeric type, the return value is the difference between the keys. If the value is negative, first_key is smaller than second_key. If return value is positive, then first_key is larger than second_key. If the return value is 0 then first_key is equal to second_key.

If the key type is key_type_char_array then the function memcmp compares the size bytes of memory beginning at a1 against the size bytes of memory beginning at a2. The value returned has the same sign as the difference between the first differing pair of bytes (interpreted as unsigned char objects, then promoted to int).

Parameters
first_keyThe first key in the comparison.
second_keyThe second key in the comparison.
Returns
The difference between the keys.
ion_err_t oafdict_create_dictionary ( ion_dictionary_id_t  id,
ion_key_type_t  key_type,
ion_key_size_t  key_size,
ion_value_size_t  value_size,
ion_dictionary_size_t  dictionary_size,
ion_dictionary_compare_t  compare,
ion_dictionary_handler_t handler,
ion_dictionary_t dictionary 
)

Creates an instance of a dictionary.

Creates as instance of a dictionary given a key_size and value_size, in bytes as well as the dictionary size which is the number of buckets available in the hashmap.

Parameters
id
key_type
key_sizeThe size of the key in bytes.
value_sizeThe size of the value in bytes.
dictionary_sizeThe size of the hashmap in discrete units
compareFunction pointer for the comparison function for the dictionary instance.
handlerTHe handler for the specific dictionary being created.
dictionaryThe pointer declared by the caller that will reference the instance of the dictionary created.
Returns
The status of the creation of the dictionary.

Definition at line 419 of file open_address_file_hash_dictionary_handler.c.

428  {
429  UNUSED(id);
430  /* this is the instance of the hashmap */
431  dictionary->instance = malloc(sizeof(ion_file_hashmap_t));
432 
433  dictionary->instance->compare = compare;
435 
436  /* this registers the dictionary the dictionary */
437  oafh_initialize((ion_file_hashmap_t *) dictionary->instance, oafh_compute_simple_hash, key_type, key_size, value_size, dictionary_size, id);/* just pick an arbitary size for testing atm */
438 
439  /*TODO The correct comparison operator needs to be bound at run time
440  * based on the type of key defined
441  */
442 
443  if (NULL == handler) {
444  return err_uninitialized;
445  }
446 
447  /* register the correct handler */
448  dictionary->handler = handler;
449 
450  return 0;
451 }
ion_dictionary_handler_t * handler
ion_dictionary_parent_t * instance
ion_err_t oafh_initialize(ion_file_hashmap_t *hashmap, ion_hash_t(*hashing_function)(ion_file_hashmap_t *, ion_key_t, int), ion_key_type_t key_type, ion_key_size_t key_size, ion_value_size_t value_size, int size, ion_dictionary_id_t id)
This function initializes an open address in memory hash map.
ion_hash_t oafh_compute_simple_hash(ion_file_hashmap_t *hashmap, ion_key_t key, int size_of_key)
A simple hashing algorithm implementation.
ion_dictionary_type_t type
#define UNUSED(x)
Definition: kv_system.h:102
ion_dictionary_compare_t compare
Struct used to maintain an instance of an in memory hashmap.

Here is the call graph for this function:

Here is the caller graph for this function:

ion_status_t oafdict_delete ( ion_dictionary_t dictionary,
ion_key_t  key 
)

Deletes the key and assoicated value from the dictionary instance.

Parameters
dictionaryThe instance of the dictionary to delete from.
keyThe key that is to be deleted.
Returns
The status of the deletion

Definition at line 454 of file open_address_file_hash_dictionary_handler.c.

457  {
458  return oafh_delete((ion_file_hashmap_t *) dictionary->instance, key);
459 }
ion_status_t oafh_delete(ion_file_hashmap_t *hash_map, ion_key_t key)
Deletes item from map.
ion_dictionary_parent_t * instance
#define key(k)
Definition: bpp_tree.c:75
Struct used to maintain an instance of an in memory hashmap.

Here is the call graph for this function:

Here is the caller graph for this function:

ion_err_t oafdict_delete_dictionary ( ion_dictionary_t dictionary)

Deletes an instance of the dictionary and associated data.

Parameters
dictionaryThe instance of the dictionary to delete.
Returns
The status of the dictionary deletion.

Definition at line 462 of file open_address_file_hash_dictionary_handler.c.

464  {
465  ion_err_t result = oafh_destroy((ion_file_hashmap_t *) dictionary->instance);
466 
467  free(dictionary->instance);
468  dictionary->instance = NULL;/* When releasing memory, set pointer to NULL */
469  return result;
470 }
ion_dictionary_parent_t * instance
char ion_err_t
The error type used to store error codes.
Definition: kv_system.h:226
Struct used to maintain an instance of an in memory hashmap.
ion_err_t oafh_destroy(ion_file_hashmap_t *hash_map)
Destroys the map in memory.

Here is the call graph for this function:

Here is the caller graph for this function:

void oafdict_destroy_cursor ( ion_dict_cursor_t **  cursor)

Next function to query and retrieve the next <K,V> that stratifies the predicate of the cursor.

Parameters
cursorThe cursor to iterate over the results.
Returns
The status of the cursor. Destroys the cursor.

Destroys the cursor when the user is finished with it. The destroy function will free up internally allocated memory as well as freeing up any reference to the cursor itself. Cursor pointers will be set to NULL as per ION_DB specification for de-allocated pointers.

Parameters
cursorpointer to cursor.

Definition at line 525 of file open_address_file_hash_dictionary_handler.c.

527  {
528  (*cursor)->predicate->destroy(&(*cursor)->predicate);
529  free(*cursor);
530  *cursor = NULL;
531 }

Here is the caller graph for this function:

ion_err_t oafdict_destroy_dictionary ( ion_dictionary_id_t  id)

Cleans up all files created by the dictionary, and frees any allocated memory, for an already closed dictionary.

Parameters
idThe identifier identifying the dictionary to delete.
Returns
The resulting status of the operation.

Definition at line 473 of file open_address_file_hash_dictionary_handler.c.

475  {
476  char addr_filename[ION_MAX_FILENAME_LENGTH];
477 
478  int actual_filename_length = dictionary_get_filename(id, "oaf", addr_filename);
479 
480  if (actual_filename_length >= ION_MAX_FILENAME_LENGTH) {
482  }
483 
484  fremove(addr_filename);
485 
486  return err_ok;
487 }
#define fremove(x)
Definition: kv_system.h:56
int dictionary_get_filename(ion_dictionary_id_t id, char *ext, char *filename)
Given the ID, implementation specific extension, and a buffer to write to, writes back the formatted ...
Definition: dictionary.c:41
#define ION_MAX_FILENAME_LENGTH
Since the arduino conforms to 8.3 syntax, that&#39;s 8 + 3 = 11 + 1 (null terminator) characters...
Definition: kv_system.h:73

Here is the call graph for this function:

Here is the caller graph for this function:

void oafdict_init ( ion_dictionary_handler_t handler)

Registers a specific handler for a dictionary instance.

Registers functions for handlers. This only needs to be called once for each type of dictionary that is present.

Parameters
handlerThe handler for the dictionary instance that is to be initialized.

Definition at line 394 of file open_address_file_hash_dictionary_handler.c.

396  {
397  handler->insert = oafdict_insert;
399  handler->get = oafdict_get;
400  handler->update = oafdict_update;
401  handler->find = oafdict_find;
402  handler->remove = oafdict_delete;
407 }
ion_err_t oafdict_open_dictionary(ion_dictionary_handler_t *handler, ion_dictionary_t *dictionary, ion_dictionary_config_info_t *config, ion_dictionary_compare_t compare)
Opens a specific open address file hash instance of a dictionary.
ion_err_t oafdict_find(ion_dictionary_t *dictionary, ion_predicate_t *predicate, ion_dict_cursor_t **cursor)
Finds multiple instances of a keys that satisfy the provided predicate in the dictionary.
ion_status_t oafdict_update(ion_dictionary_t *dictionary, ion_key_t key, ion_value_t value)
Updates the value for a given key.
ion_status_t(* insert)(ion_dictionary_t *, ion_key_t, ion_value_t)
ion_status_t(* remove)(ion_dictionary_t *, ion_key_t)
ion_err_t(* destroy_dictionary)(ion_dictionary_id_t id)
ion_status_t oafdict_insert(ion_dictionary_t *dictionary, ion_key_t key, ion_value_t value)
Inserts a key and value into the dictionary.
ion_err_t oafdict_destroy_dictionary(ion_dictionary_id_t id)
Cleans up all files created by the dictionary, and frees any allocated memory, for an already closed ...
ion_status_t(* update)(ion_dictionary_t *, ion_key_t, ion_value_t)
ion_err_t(* close_dictionary)(ion_dictionary_t *)
ion_err_t(* open_dictionary)(ion_dictionary_handler_t *, ion_dictionary_t *, ion_dictionary_config_info_t *, ion_dictionary_compare_t)
ion_err_t(* create_dictionary)(ion_dictionary_id_t, ion_key_type_t, ion_key_size_t, ion_value_size_t, ion_dictionary_size_t, ion_dictionary_compare_t, ion_dictionary_handler_t *, ion_dictionary_t *)
ion_err_t oafdict_close_dictionary(ion_dictionary_t *dictionary)
Closes an open address file hash instance of a dictionary.
ion_err_t(* delete_dictionary)(ion_dictionary_t *)
ion_err_t oafdict_delete_dictionary(ion_dictionary_t *dictionary)
Deletes an instance of the dictionary and associated data.
ion_err_t(* find)(ion_dictionary_t *, ion_predicate_t *, ion_dict_cursor_t **)
ion_err_t oafdict_create_dictionary(ion_dictionary_id_t id, ion_key_type_t key_type, ion_key_size_t key_size, ion_value_size_t value_size, ion_dictionary_size_t dictionary_size, ion_dictionary_compare_t compare, ion_dictionary_handler_t *handler, ion_dictionary_t *dictionary)
Creates an instance of a dictionary.
ion_status_t oafdict_delete(ion_dictionary_t *dictionary, ion_key_t key)
Deletes the key and assoicated value from the dictionary instance.
ion_status_t oafdict_get(ion_dictionary_t *dictionary, ion_key_t key, ion_value_t value)
Queries a dictionary instance for the given key and returns the associated value. ...
ion_status_t(* get)(ion_dictionary_t *, ion_key_t, ion_value_t)

Here is the call graph for this function:

Here is the caller graph for this function:

ion_status_t oafdict_insert ( ion_dictionary_t dictionary,
ion_key_t  key,
ion_value_t  value 
)

Inserts a key and value into the dictionary.

Parameters
dictionaryThe dictionary instance to insert the value into.
keyThe key to use.
valueThe value to use.
Returns
The status on the insertion of the record.

Definition at line 410 of file open_address_file_hash_dictionary_handler.c.

414  {
415  return oafh_insert((ion_file_hashmap_t *) dictionary->instance, key, value);
416 }
ion_dictionary_parent_t * instance
#define key(k)
Definition: bpp_tree.c:75
ion_status_t oafh_insert(ion_file_hashmap_t *hash_map, ion_key_t key, ion_value_t value)
Insert record into hashmap.
Struct used to maintain an instance of an in memory hashmap.

Here is the call graph for this function:

Here is the caller graph for this function:

ion_status_t oafdict_update ( ion_dictionary_t dictionary,
ion_key_t  key,
ion_value_t  value 
)

Updates the value for a given key.

Updates the value for a given key. If the key does not currently exist in the hashmap, it will be created and the value sorted.

Parameters
dictionaryThe instance of the dictionary to be updated.
keyThe key that is to be updated.
valueThe value that is to be updated.
Returns
The status of the update.

Definition at line 490 of file open_address_file_hash_dictionary_handler.c.

494  {
495  return oafh_update((ion_file_hashmap_t *) dictionary->instance, key, value);
496 }
ion_status_t oafh_update(ion_file_hashmap_t *hash_map, ion_key_t key, ion_value_t value)
Updates a value in the map.
ion_dictionary_parent_t * instance
#define key(k)
Definition: bpp_tree.c:75
Struct used to maintain an instance of an in memory hashmap.

Here is the call graph for this function:

Here is the caller graph for this function: