3 * http_static.h - skeleton vpp engine plug-in header file
5 * Copyright (c) <current-year> <your-organization>
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 #ifndef __included_http_static_h__
19 #define __included_http_static_h__
21 #include <vnet/vnet.h>
22 #include <vnet/session/application.h>
23 #include <vnet/session/application_interface.h>
24 #include <vnet/session/session.h>
25 #include <vnet/ip/ip.h>
26 #include <vnet/ethernet/ethernet.h>
28 #include <vppinfra/hash.h>
29 #include <vppinfra/error.h>
30 #include <vppinfra/time_range.h>
31 #include <vppinfra/tw_timer_2t_1w_2048sl.h>
32 #include <vppinfra/bihash_vec8_8.h>
34 /** @file Static http server definitions
39 /* API message ID base */
43 vlib_main_t *vlib_main;
44 vnet_main_t *vnet_main;
47 extern http_static_main_t http_static_main;
49 /** \brief Session States
54 /** Session is closed */
56 /** Session is established */
57 HTTP_STATE_ESTABLISHED,
58 /** Session has sent an OK response */
60 /** Session has sent an HTML response */
61 HTTP_STATE_SEND_MORE_DATA,
62 /** Number of states */
64 } http_session_state_t;
71 } http_state_machine_called_from_t;
75 HTTP_BUILTIN_METHOD_GET = 0,
76 HTTP_BUILTIN_METHOD_POST,
77 } http_builtin_method_type_t;
80 /** \brief Application session
84 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
85 /** Base class instance variables */
86 #define _(type, name) type name;
87 foreach_app_session_field
89 /** rx thread index */
93 /** vpp session index, handle */
94 u32 vpp_session_index;
95 u64 vpp_session_handle;
96 /** Timeout timer handle */
98 /** Fully-resolved file path */
100 /** File data, a vector */
102 /** Current data send offset */
104 /** Need to free data in detach_cache_entry */
107 /** File cache pool index */
108 u32 cache_pool_index;
109 /** state machine called from... */
110 http_state_machine_called_from_t called_from;
113 /** \brief In-memory file data cache entry
117 /** Name of the file */
119 /** Contents of the file, as a u8 * vector */
121 /** Last time the cache entry was used */
123 /** Cache LRU links */
126 /** Reference count, so we don't recycle while referenced */
130 /** \brief Main data structure
135 /** Per thread vector of session pools */
136 http_session_t **sessions;
137 /** Session pool reader writer lock */
138 clib_rwlock_t sessions_lock;
139 /** vpp session to http session index map */
140 u32 **session_to_http_session;
142 /** Enable debug messages */
145 /** vpp message/event queue */
146 svm_msg_q_t **vpp_queue;
148 /** Unified file data cache pool */
149 file_data_cache_t *cache_pool;
150 /** Hash table which maps file name to file data */
151 BVT (clib_bihash) name_to_data;
153 /** Hash tables for built-in GET and POST handlers */
154 uword *get_url_handlers;
155 uword *post_url_handlers;
157 /** Current cache size */
159 /** Max cache size in bytes */
161 /** Number of cache evictions */
164 /** Cache LRU listheads */
168 /** root path to be served */
171 /** Server's event queue */
172 svm_queue_t *vl_input_queue;
174 /** API client handle */
177 /** Application index */
180 /** Process node index for event scheduling */
183 /** Session cleanup timer wheel */
184 tw_timer_wheel_2t_1w_2048sl_t tw;
185 clib_spinlock_t tw_lock;
187 /** Time base, so we can generate browser cache control http spew */
188 clib_timebase_t timebase;
190 /** Number of preallocated fifos, usually 0 */
192 /** Private segment size, usually 0 */
193 u32 private_segment_size;
194 /** Size of the allocated rx, tx fifos, roughly 8K or so */
196 /** The bind URI, defaults to tcp://0.0.0.0/80 */
198 vlib_main_t *vlib_main;
199 } http_static_server_main_t;
201 extern http_static_server_main_t http_static_server_main;
203 int http_static_server_enable_api (u32 fifo_size, u32 cache_limit,
205 u32 private_segment_size,
206 u8 * www_root, u8 * uri);
208 void http_static_server_register_builtin_handler
209 (void *fp, char *url, int type);
211 #endif /* __included_http_static_h__ */
214 * fd.io coding-style-patch-verification: ON
217 * eval: (c-set-style "gnu")