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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
/*
* http_static.h - skeleton vpp engine plug-in header file
*
* Copyright (c) <current-year> <your-organization>
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef __included_http_static_h__
#define __included_http_static_h__
#include <vnet/vnet.h>
#include <vnet/session/application.h>
#include <vnet/session/application_interface.h>
#include <vnet/session/session.h>
#include <vnet/ip/ip.h>
#include <vnet/ethernet/ethernet.h>
#include <vppinfra/hash.h>
#include <vppinfra/error.h>
#include <vppinfra/time_range.h>
#include <vppinfra/tw_timer_2t_1w_2048sl.h>
#include <vppinfra/bihash_vec8_8.h>
/** @file Static http server definitions
*/
typedef struct
{
/* API message ID base */
u16 msg_id_base;
/* convenience */
vlib_main_t *vlib_main;
vnet_main_t *vnet_main;
} http_static_main_t;
extern http_static_main_t http_static_main;
/** \brief Session States
*/
typedef enum
{
/** Session is closed */
HTTP_STATE_CLOSED,
/** Session is established */
HTTP_STATE_ESTABLISHED,
/** Session has sent an OK response */
HTTP_STATE_OK_SENT,
/** Session has sent an HTML response */
HTTP_STATE_SEND_MORE_DATA,
/** Number of states */
HTTP_STATE_N_STATES,
} http_session_state_t;
typedef enum
{
CALLED_FROM_RX,
CALLED_FROM_TX,
CALLED_FROM_TIMER,
} http_state_machine_called_from_t;
typedef enum
{
HTTP_BUILTIN_METHOD_GET = 0,
HTTP_BUILTIN_METHOD_POST,
} http_builtin_method_type_t;
/** \brief Application session
*/
typedef struct
{
CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
/** Base class instance variables */
#define _(type, name) type name;
foreach_app_session_field
#undef _
/** rx thread index */
u32 thread_index;
/** rx buffer */
u8 *rx_buf;
/** vpp session index, handle */
u32 vpp_session_index;
u64 vpp_session_handle;
/** Timeout timer handle */
u32 timer_handle;
/** Fully-resolved file path */
u8 *path;
/** File data, a vector */
u8 *data;
/** Current data send offset */
u32 data_offset;
/** Need to free data in detach_cache_entry */
int free_data;
/** File cache pool index */
u32 cache_pool_index;
/** state machine called from... */
http_state_machine_called_from_t called_from;
} http_session_t;
/** \brief In-memory file data cache entry
*/
typedef struct
{
/** Name of the file */
u8 *filename;
/** Contents of the file, as a u8 * vector */
u8 *data;
/** Last time the cache entry was used */
f64 last_used;
/** Cache LRU links */
u32 next_index;
u32 prev_index;
/** Reference count, so we don't recycle while referenced */
int inuse;
} file_data_cache_t;
/** \brief Main data structure
*/
typedef struct
{
/** Per thread vector of session pools */
http_session_t **sessions;
/** Session pool reader writer lock */
clib_rwlock_t sessions_lock;
/** vpp session to http session index map */
u32 **session_to_http_session;
/** Enable debug messages */
int debug_level;
/** vpp message/event queue */
svm_msg_q_t **vpp_queue;
/** Unified file data cache pool */
file_data_cache_t *cache_pool;
/** Hash table which maps file name to file data */
BVT (clib_bihash) name_to_data;
/** Hash tables for built-in GET and POST handlers */
uword *get_url_handlers;
uword *post_url_handlers;
/** Current cache size */
u64 cache_size;
/** Max cache size in bytes */
u64 cache_limit;
/** Number of cache evictions */
u64 cache_evictions;
/** Cache LRU listheads */
u32 first_index;
u32 last_index;
/** root path to be served */
u8 *www_root;
/** Server's event queue */
svm_queue_t *vl_input_queue;
/** API client handle */
u32 my_client_index;
/** Application index */
u32 app_index;
/** Process node index for event scheduling */
u32 node_index;
/** Session cleanup timer wheel */
tw_timer_wheel_2t_1w_2048sl_t tw;
clib_spinlock_t tw_lock;
/** Time base, so we can generate browser cache control http spew */
clib_timebase_t timebase;
/** Number of preallocated fifos, usually 0 */
u32 prealloc_fifos;
/** Private segment size, usually 0 */
u32 private_segment_size;
/** Size of the allocated rx, tx fifos, roughly 8K or so */
u32 fifo_size;
/** The bind URI, defaults to tcp://0.0.0.0/80 */
u8 *uri;
vlib_main_t *vlib_main;
} http_static_server_main_t;
extern http_static_server_main_t http_static_server_main;
int http_static_server_enable_api (u32 fifo_size, u32 cache_limit,
u32 prealloc_fifos,
u32 private_segment_size,
u8 * www_root, u8 * uri);
void http_static_server_register_builtin_handler
(void *fp, char *url, int type);
#endif /* __included_http_static_h__ */
/*
* fd.io coding-style-patch-verification: ON
*
* Local Variables:
* eval: (c-set-style "gnu")
* End:
*/
|
