/
cache.h
146 lines (119 loc) · 4.52 KB
/
cache.h
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* Cherokee
*
* Authors:
* Alvaro Lopez Ortega <alvaro@alobbs.com>
*
* Copyright (C) 2001-2014 Alvaro Lopez Ortega
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of version 2 of the GNU General Public
* License as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301, USA.
*/
#if !defined (CHEROKEE_INSIDE_CHEROKEE_H) && !defined (CHEROKEE_COMPILATION)
# error "Only <cherokee/cherokee.h> can be included directly, this file may disappear or change contents."
#endif
#ifndef CHEROKEE_CACHE_H
#define CHEROKEE_CACHE_H
#include <cherokee/common.h>
#include <cherokee/list.h>
#include <cherokee/avl.h>
#include <cherokee/config_node.h>
/* Forward declaration */
typedef struct cherokee_cache cherokee_cache_t;
typedef struct cherokee_cache_priv cherokee_cache_priv_t;
typedef struct cherokee_cache_entry cherokee_cache_entry_t;
/* Callback prototypes */
typedef ret_t (* cherokee_cache_new_func_t) (struct cherokee_cache *cache,
cherokee_buffer_t *key,
void *param,
struct cherokee_cache_entry **ret);
typedef ret_t (* cherokee_cache_get_stats_t) (struct cherokee_cache *cache,
cherokee_buffer_t *key);
typedef ret_t (* cherokee_cache_entry_clean_t) (struct cherokee_cache_entry *entry);
typedef ret_t (* cherokee_cache_entry_fetch_t) (struct cherokee_cache_entry *entry);
typedef ret_t (* cherokee_cache_entry_free_t) (struct cherokee_cache_entry *entry);
/* Enums */
typedef enum {
cache_no_list = 0,
cache_t1,
cache_t2,
cache_b1,
cache_b2
} cherokee_cache_list_t;
/* Classes */
struct cherokee_cache {
/* Lookup table */
cherokee_avl_t map;
/* LRU (Least Recently Used) */
cherokee_list_t _t1;
cherokee_list_t _b1;
cint_t len_t1;
cint_t len_b1;
/* LFU (Least Frequently Used) */
cherokee_list_t _t2;
cherokee_list_t _b2;
cint_t len_t2;
cint_t len_b2;
/* Configuration */
cint_t max_size;
cint_t target_t1;
/* Stats */
cuint_t count;
cuint_t count_hit;
cuint_t count_miss;
/* Callbacks */
cherokee_cache_new_func_t new_cb;
void *new_cb_param;
cherokee_cache_get_stats_t stats_cb;
/* Private properties */
cherokee_cache_priv_t *priv;
};
struct cherokee_cache_entry {
/* Internal stuff */
cherokee_list_t listed;
cherokee_buffer_t key;
cherokee_cache_list_t in_list;
cint_t ref_count;
void *mutex;
cherokee_cache_t *cache;
/* Callbacks */
cherokee_cache_entry_clean_t clean_cb;
cherokee_cache_entry_fetch_t fetch_cb;
cherokee_cache_entry_free_t free_cb;
};
/* Castings */
#define CACHE(x) ((cherokee_cache_t *)(x))
#define CACHE_ENTRY(x) ((cherokee_cache_entry_t *)(x))
/* Cache Entries
*/
ret_t cherokee_cache_entry_init (cherokee_cache_entry_t *entry,
cherokee_buffer_t *key,
cherokee_cache_t *cache,
void *mutex);
ret_t cherokee_cache_entry_unref (cherokee_cache_entry_t **entry);
/* Cache Objects
*/
ret_t cherokee_cache_init (cherokee_cache_t *cache);
ret_t cherokee_cache_mrproper (cherokee_cache_t *cache);
ret_t cherokee_cache_clean (cherokee_cache_t *cache);
/* Cache Functionality
*/
ret_t cherokee_cache_configure (cherokee_cache_t *cache,
cherokee_config_node_t *conf);
ret_t cherokee_cache_get (cherokee_cache_t *cache,
cherokee_buffer_t *key,
cherokee_cache_entry_t **entry);
ret_t cherokee_cache_get_stats (cherokee_cache_t *cache,
cherokee_buffer_t *info);
#endif /* CHEROKEE_CACHE_H */