1 files changed, 109 insertions, 0 deletions
diff --git a/src/lib/third_party/include/libcache.h b/src/lib/third_party/include/libcache.h
new file mode 100644
index 000000000..7f84b89ad
--- /dev/null
+++ b/src/lib/third_party/include/libcache.h
@@ -0,0 +1,109 @@
+/**
+ * libcache.h
+ *
+Copyright (c) 2017 William Guglielmo <william@deselmo.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+ *
+ */
+
+
+#ifndef __DESELMO_LIBCACHE_H__
+#define __DESELMO_LIBCACHE_H__
+
+#include <stdint.h>
+
+typedef struct cache_entry *cache_entry;
+
+typedef struct cache_entry_map *cache_entry_map;
+
+/**
+ * @brief Codes representing the result of some functions
+ *
+ */
+typedef enum cache_result {
+  CACHE_NO_ERROR = 0,         /**< Returned by a function if no error occurs. */
+  CACHE_CONTAINS_FALSE = 0,   /**< Returned by function cache_contains if item is not present. */
+  CACHE_CONTAINS_TRUE,        /**< Returned by function cache_contains if item is present. */
+  CACHE_INVALID_INPUT,        /**< Returned by a function if it is called with invalid input parameters. */
+  CACHE_REMOVE_NOT_FOUND,     /**< Returned by function cache_remove if item is not present. */
+  CACHE_MALLOC_ERROR          /**< Returned by a function if a malloc fail. */
+} cache_result;
+
+
+typedef struct cache *cache_t;
+
+
+/**
+ * @brief Returns a new cache_t
+ * 
+ * @par    cache_max_size  = max number of item that the new cache_t can contain
+ * @return a new cache_t, or NULL if an error occurred
+ *
+ */
+cache_t cache_new(uint32_t cache_max_size);
+
+
+/**
+ * @brief Add an item in the specified cache_t
+ * 
+ * @par    cache      = the cache_t
+ * @par    item       = pointer to the item to add
+ * @par    item_size  = size of the item
+ * @return a code representing the result of the function
+ *
+ */
+cache_result cache_add(cache_t cache, void *item, uint32_t item_size);
+
+
+/**
+ * @brief Check if an item is in the specified cache_t
+ * 
+ * @par    cache      = the cache_t
+ * @par    item       = pointer to the item to check
+ * @par    item_size  = size of the item
+ * @return a code representing the result of the function
+ *
+ */
+cache_result cache_contains(cache_t cache, void *item, uint32_t item_size);
+
+
+/**
+ * @brief Remove an item in the specified cache_t
+ * 
+ * @par    cache      = the cache_t
+ * @par    item       = pointer to the item to remove
+ * @par    item_size  = size of the item
+ * @return a code representing the result of the function
+ *
+ */
+cache_result cache_remove(cache_t cache, void *item, uint32_t item_size);
+
+/**
+ * @brief Free the specified cache_t
+ * 
+ * @par alist  = the cache
+ *
+ */
+void cache_free(cache_t cache);
+
+cache_entry cache_entry_new(void);
+cache_entry_map cache_entry_map_new(void);
+
+#endif