1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
#ifndef __LIBCACHE_H__
#define __LIBCACHE_H__
#include <stdint.h>
/* Codes representing the result of some functions */
typedef enum {
CACHE_NO_ERROR = 0,
CACHE_CONTAINS_FALSE = 0,
CACHE_CONTAINS_TRUE,
CACHE_INVALID_INPUT,
CACHE_REMOVE_NOT_FOUND,
CACHE_MALLOC_ERROR
} cache_result;
/* CACHE_T */
typedef struct cache_t cache_t;
/* CACHE_ENTRY */
typedef struct cache_entry cache_entry;
/* CACHE_ENTRY_MAP */
typedef struct cache_entry_map cache_entry_map;
/* STRUCT CACHE_T */
struct cache_t {
uint32_t size;
uint32_t max_size;
cache_entry *head;
cache_entry *tail;
cache_entry_map **map;
};
/* STRUCT CACHE_ENTRY */
struct cache_entry_map {
cache_entry *entry;
cache_entry_map *next;
};
/* STRUCT CACHE_ENTRY_MAP */
struct cache_entry {
void *item;
uint32_t item_size;
cache_entry *prev;
cache_entry *next;
};
/**
* 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);
/**
* 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);
/**
* 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);
/**
* 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);
/**
* Free the specified cache_t
*
* @par alist = the cache
*
*/
void cache_free(cache_t *cache);
#endif
|