2 * Copyright (c) 2017-2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #include <vnet/vnet.h>
17 #include <vnet/session/application.h>
18 #include <vnet/session/application_interface.h>
19 #include <vnet/session/session.h>
20 #include <vppinfra/tw_timer_2t_1w_2048sl.h>
21 #include <vppinfra/unix.h>
22 #include <sys/types.h>
25 #include <http_static/http_static.h>
26 #include <vppinfra/bihash_vec8_8.h>
28 #include <vppinfra/bihash_template.c>
31 Simple Static http server, sufficient to
32 serve .html / .css / .js content.
34 /*? %%clicmd:group_label Static HTTP Server %% ?*/
36 /** \brief Session States
41 /** Session is closed */
43 /** Session is established */
44 HTTP_STATE_ESTABLISHED,
45 /** Session has sent an OK response */
47 /** Session has sent an HTML response */
48 HTTP_STATE_SEND_MORE_DATA,
49 /** Number of states */
51 } http_session_state_t;
58 } state_machine_called_from_t;
61 /** \brief Application session
65 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
66 /** Base class instance variables */
67 #define _(type, name) type name;
68 foreach_app_session_field
70 /** rx thread index */
74 /** vpp session index, handle */
75 u32 vpp_session_index;
76 u64 vpp_session_handle;
77 /** Timeout timer handle */
79 /** Fully-resolved file path */
81 /** File data, a vector */
83 /** Current data send offset */
85 /** File cache pool index */
87 /** state machine called from... */
88 state_machine_called_from_t called_from;
91 /** \brief In-memory file data cache entry
95 /** Name of the file */
97 /** Contents of the file, as a u8 * vector */
99 /** Last time the cache entry was used */
101 /** Cache LRU links */
104 /** Reference count, so we don't recycle while referenced */
108 /** \brief Main data structure
113 /** Per thread vector of session pools */
114 http_session_t **sessions;
115 /** Session pool reader writer lock */
116 clib_rwlock_t sessions_lock;
117 /** vpp session to http session index map */
118 u32 **session_to_http_session;
120 /** Enable debug messages */
123 /** vpp message/event queue */
124 svm_msg_q_t **vpp_queue;
126 /** Unified file data cache pool */
127 file_data_cache_t *cache_pool;
128 /** Hash table which maps file name to file data */
129 BVT (clib_bihash) name_to_data;
131 /** Current cache size */
133 /** Max cache size in bytes */
135 /** Number of cache evictions */
138 /** Cache LRU listheads */
142 /** root path to be served */
145 /** Server's event queue */
146 svm_queue_t *vl_input_queue;
148 /** API client handle */
151 /** Application index */
154 /** Process node index for event scheduling */
157 /** Session cleanup timer wheel */
158 tw_timer_wheel_2t_1w_2048sl_t tw;
159 clib_spinlock_t tw_lock;
161 /** Time base, so we can generate browser cache control http spew */
162 clib_timebase_t timebase;
164 /** Number of preallocated fifos, usually 0 */
166 /** Private segment size, usually 0 */
167 u32 private_segment_size;
168 /** Size of the allocated rx, tx fifos, roughly 8K or so */
170 /** The bind URI, defaults to tcp://0.0.0.0/80 */
172 vlib_main_t *vlib_main;
173 } http_static_server_main_t;
175 http_static_server_main_t http_static_server_main;
177 /** \brief Format the called-from enum
181 format_state_machine_called_from (u8 * s, va_list * args)
183 state_machine_called_from_t cf =
184 va_arg (*args, state_machine_called_from_t);
185 char *which = "bogus!";
195 case CALLED_FROM_TIMER:
196 which = "from timer";
203 s = format (s, "%s", which);
208 /** \brief Acquire reader lock on the sessions pools
211 http_static_server_sessions_reader_lock (void)
213 clib_rwlock_reader_lock (&http_static_server_main.sessions_lock);
216 /** \brief Drop reader lock on the sessions pools
219 http_static_server_sessions_reader_unlock (void)
221 clib_rwlock_reader_unlock (&http_static_server_main.sessions_lock);
224 /** \brief Acquire writer lock on the sessions pools
227 http_static_server_sessions_writer_lock (void)
229 clib_rwlock_writer_lock (&http_static_server_main.sessions_lock);
232 /** \brief Drop writer lock on the sessions pools
235 http_static_server_sessions_writer_unlock (void)
237 clib_rwlock_writer_unlock (&http_static_server_main.sessions_lock);
240 /** \brief Start a session cleanup timer
243 http_static_server_session_timer_start (http_session_t * hs)
245 http_static_server_main_t *hsm = &http_static_server_main;
248 /* The session layer may fire a callback at a later date... */
249 if (!pool_is_free (hsm->sessions[hs->thread_index], hs))
251 hs_handle = hs->thread_index << 24 | hs->session_index;
252 clib_spinlock_lock (&http_static_server_main.tw_lock);
253 hs->timer_handle = tw_timer_start_2t_1w_2048sl
254 (&http_static_server_main.tw, hs_handle, 0, 60);
255 clib_spinlock_unlock (&http_static_server_main.tw_lock);
259 /** \brief stop a session cleanup timer
262 http_static_server_session_timer_stop (http_session_t * hs)
264 if (hs->timer_handle == ~0)
266 clib_spinlock_lock (&http_static_server_main.tw_lock);
267 tw_timer_stop_2t_1w_2048sl (&http_static_server_main.tw, hs->timer_handle);
268 clib_spinlock_unlock (&http_static_server_main.tw_lock);
271 /** \brief Allocate an http session
273 static http_session_t *
274 http_static_server_session_alloc (u32 thread_index)
276 http_static_server_main_t *hsm = &http_static_server_main;
278 pool_get (hsm->sessions[thread_index], hs);
279 memset (hs, 0, sizeof (*hs));
280 hs->session_index = hs - hsm->sessions[thread_index];
281 hs->thread_index = thread_index;
282 hs->timer_handle = ~0;
283 hs->cache_pool_index = ~0;
287 /** \brief Get an http session by index
289 static http_session_t *
290 http_static_server_session_get (u32 thread_index, u32 hs_index)
292 http_static_server_main_t *hsm = &http_static_server_main;
293 if (pool_is_free_index (hsm->sessions[thread_index], hs_index))
295 return pool_elt_at_index (hsm->sessions[thread_index], hs_index);
298 /** \brief Free an http session
301 http_static_server_session_free (http_session_t * hs)
303 http_static_server_main_t *hsm = &http_static_server_main;
305 /* Make sure the timer is stopped... */
306 http_static_server_session_timer_stop (hs);
307 pool_put (hsm->sessions[hs->thread_index], hs);
311 u32 save_thread_index;
312 save_thread_index = hs->thread_index;
313 /* Poison the entry, preserve timer state and thread index */
314 memset (hs, 0xfa, sizeof (*hs));
315 hs->timer_handle = ~0;
316 hs->thread_index = save_thread_index;
320 /** \brief add a session to the vpp < -- > http session index map
323 http_static_server_session_lookup_add (u32 thread_index, u32 s_index,
326 http_static_server_main_t *hsm = &http_static_server_main;
327 vec_validate (hsm->session_to_http_session[thread_index], s_index);
328 hsm->session_to_http_session[thread_index][s_index] = hs_index;
331 /** \brief Remove a session from the vpp < -- > http session index map
334 http_static_server_session_lookup_del (u32 thread_index, u32 s_index)
336 http_static_server_main_t *hsm = &http_static_server_main;
337 hsm->session_to_http_session[thread_index][s_index] = ~0;
340 /** \brief lookup a session in the vpp < -- > http session index map
343 static http_session_t *
344 http_static_server_session_lookup (u32 thread_index, u32 s_index)
346 http_static_server_main_t *hsm = &http_static_server_main;
349 if (s_index < vec_len (hsm->session_to_http_session[thread_index]))
351 hs_index = hsm->session_to_http_session[thread_index][s_index];
352 return http_static_server_session_get (thread_index, hs_index);
357 /** \brief Detach cache entry from session
361 http_static_server_detach_cache_entry (http_session_t * hs)
363 http_static_server_main_t *hsm = &http_static_server_main;
364 file_data_cache_t *ep;
367 * Decrement cache pool entry reference count
368 * Note that if e.g. a file lookup fails, the cache pool index
371 if (hs->cache_pool_index != ~0)
373 ep = pool_elt_at_index (hsm->cache_pool, hs->cache_pool_index);
375 if (hsm->debug_level > 1)
376 clib_warning ("index %d refcnt now %d", hs->cache_pool_index,
379 hs->cache_pool_index = ~0;
385 /** \brief clean up a session
389 http_static_server_session_cleanup (http_session_t * hs)
394 http_static_server_detach_cache_entry (hs);
396 http_static_server_session_lookup_del (hs->thread_index,
397 hs->vpp_session_index);
398 vec_free (hs->rx_buf);
399 http_static_server_session_free (hs);
402 /** \brief Disconnect a session
406 http_static_server_session_disconnect (http_session_t * hs)
408 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
409 a->handle = hs->vpp_session_handle;
410 a->app_index = http_static_server_main.app_index;
411 vnet_disconnect_session (a);
415 /** \brief http error boilerplate
417 static const char *http_error_template =
420 "Content-Type: text/html\r\n"
421 "Connection: close\r\n"
422 "Pragma: no-cache\r\n"
423 "Content-Length: 0\r\n\r\n";
425 /** \brief http response boilerplate
427 static const char *http_response_template =
429 "Expires: %U GMT\r\n"
430 "Server: VPP Static\r\n"
431 "Content-Type: text/%s\r\n"
432 "Content-Length: %d\r\n\r\n";
436 /** \brief send http data
437 @param hs - http session
438 @param data - the data vector to transmit
439 @param offset - transmit offset for this operation
440 @return offset for next transmit operation, may be unchanged w/ full fifo
444 static_send_data (http_session_t * hs, u8 * data, u32 length, u32 offset)
447 http_static_server_main_t *hsm = &http_static_server_main;
449 bytes_to_send = length - offset;
451 while (bytes_to_send > 0)
455 actual_transfer = svm_fifo_enqueue
456 (hs->tx_fifo, bytes_to_send, data + offset);
458 /* Made any progress? */
459 if (actual_transfer <= 0)
461 if (hsm->debug_level > 0 && bytes_to_send > 0)
462 clib_warning ("WARNING: still %d bytes to send", bytes_to_send);
467 offset += actual_transfer;
468 bytes_to_send -= actual_transfer;
470 if (hsm->debug_level && bytes_to_send > 0)
471 clib_warning ("WARNING: still %d bytes to send", bytes_to_send);
473 if (svm_fifo_set_event (hs->tx_fifo))
474 session_send_io_evt_to_thread (hs->tx_fifo,
475 SESSION_IO_EVT_TX_FLUSH);
483 /** \brief Send an http error string
484 @param hs - the http session
485 @param str - the error string, e.g. "404 Not Found"
488 send_error (http_session_t * hs, char *str)
490 http_static_server_main_t *hsm = &http_static_server_main;
494 now = clib_timebase_now (&hsm->timebase);
495 data = format (0, http_error_template, str, format_clib_timebase_time, now);
496 static_send_data (hs, data, vec_len (data), 0);
500 /** \brief Retrieve data from the application layer
503 session_rx_request (http_session_t * hs)
505 u32 max_dequeue, cursize;
508 cursize = vec_len (hs->rx_buf);
509 max_dequeue = svm_fifo_max_dequeue (hs->rx_fifo);
510 if (PREDICT_FALSE (max_dequeue == 0))
513 vec_validate (hs->rx_buf, cursize + max_dequeue - 1);
514 n_read = app_recv_stream_raw (hs->rx_fifo, hs->rx_buf + cursize,
515 max_dequeue, 0, 0 /* peek */ );
516 ASSERT (n_read == max_dequeue);
517 if (svm_fifo_is_empty (hs->rx_fifo))
518 svm_fifo_unset_event (hs->rx_fifo);
520 _vec_len (hs->rx_buf) = cursize + n_read;
524 /** \brief Sanity-check the forward and reverse LRU lists
527 lru_validate (http_static_server_main_t * hsm)
533 file_data_cache_t *ep;
535 last_timestamp = 1e70;
536 for (i = 1, index = hsm->first_index; index != ~0;)
538 ep = pool_elt_at_index (hsm->cache_pool, index);
539 index = ep->next_index;
540 /* Timestamps should be smaller (older) as we walk the fwd list */
541 if (ep->last_used > last_timestamp)
543 clib_warning ("%d[%d]: last used %.6f, last_timestamp %.6f",
544 ep - hsm->cache_pool, i,
545 ep->last_used, last_timestamp);
547 last_timestamp = ep->last_used;
551 last_timestamp = 0.0;
552 for (i = 1, index = hsm->last_index; index != ~0;)
554 ep = pool_elt_at_index (hsm->cache_pool, index);
555 index = ep->prev_index;
556 /* Timestamps should be larger (newer) as we walk the rev list */
557 if (ep->last_used < last_timestamp)
559 clib_warning ("%d[%d]: last used %.6f, last_timestamp %.6f",
560 ep - hsm->cache_pool, i,
561 ep->last_used, last_timestamp);
563 last_timestamp = ep->last_used;
569 /** \brief Remove a data cache entry from the LRU lists
572 lru_remove (http_static_server_main_t * hsm, file_data_cache_t * ep)
574 file_data_cache_t *next_ep, *prev_ep;
579 ep_index = ep - hsm->cache_pool;
581 /* Deal with list heads */
582 if (ep_index == hsm->first_index)
583 hsm->first_index = ep->next_index;
584 if (ep_index == hsm->last_index)
585 hsm->last_index = ep->prev_index;
588 if (ep->next_index != ~0)
590 next_ep = pool_elt_at_index (hsm->cache_pool, ep->next_index);
591 next_ep->prev_index = ep->prev_index;
594 if (ep->prev_index != ~0)
596 prev_ep = pool_elt_at_index (hsm->cache_pool, ep->prev_index);
597 prev_ep->next_index = ep->next_index;
602 /** \brief Add an entry to the LRU lists, tag w/ supplied timestamp
606 lru_add (http_static_server_main_t * hsm, file_data_cache_t * ep, f64 now)
608 file_data_cache_t *next_ep;
613 ep_index = ep - hsm->cache_pool;
616 * Re-add at the head of the forward LRU list,
617 * tail of the reverse LRU list
619 if (hsm->first_index != ~0)
621 next_ep = pool_elt_at_index (hsm->cache_pool, hsm->first_index);
622 next_ep->prev_index = ep_index;
627 /* ep now the new head of the LRU forward list */
628 ep->next_index = hsm->first_index;
629 hsm->first_index = ep_index;
631 /* single session case: also the tail of the reverse LRU list */
632 if (hsm->last_index == ~0)
633 hsm->last_index = ep_index;
639 /** \brief Remove and re-add a cache entry from/to the LRU lists
643 lru_update (http_static_server_main_t * hsm, file_data_cache_t * ep, f64 now)
645 lru_remove (hsm, ep);
646 lru_add (hsm, ep, now);
649 /** \brief Session-layer (main) data rx callback.
650 Parse the http request, and reply to it.
651 Future extensions might include POST processing, active content, etc.
654 /* svm_fifo_add_want_deq_ntf (tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL)
655 get shoulder-tap when transport dequeues something, set in
658 /** \brief closed state - should never really get here
661 state_closed (session_t * s, http_session_t * hs,
662 state_machine_called_from_t cf)
664 clib_warning ("WARNING: http session %d, called from %U",
665 hs->session_index, format_state_machine_called_from, cf);
670 close_session (http_session_t * hs)
672 http_static_server_session_disconnect (hs);
673 http_static_server_session_cleanup (hs);
676 /** \brief established state - waiting for GET, POST, etc.
679 state_established (session_t * s, http_session_t * hs,
680 state_machine_called_from_t cf)
682 http_static_server_main_t *hsm = &http_static_server_main;
687 struct stat _sb, *sb = &_sb;
690 /* Read data from the sessison layer */
691 rv = session_rx_request (hs);
693 /* No data? Odd, but stay in this state and await further instructions */
697 /* Process the client request */
698 request = hs->rx_buf;
699 request_len = vec_len (request);
700 if (vec_len (request) < 7)
702 send_error (hs, "400 Bad Request");
707 /* We only handle GET requests at the moment */
708 for (i = 0; i < request_len - 4; i++)
710 if (request[i] == 'G' &&
711 request[i + 1] == 'E' &&
712 request[i + 2] == 'T' && request[i + 3] == ' ')
715 if (hsm->debug_level > 1)
716 clib_warning ("Unknown http method");
718 send_error (hs, "405 Method Not Allowed");
725 vec_delete (request, i + 5, 0);
727 /* Lose stuff to the right of the path */
728 for (i = 0; i < vec_len (request); i++)
730 if (request[i] == ' ' || request[i] == '?')
738 * Now we can construct the file to open
739 * Browsers are capable of sporadically including a leading '/'
741 if (request[0] == '/')
742 path = format (0, "%s%s%c", hsm->www_root, request, 0);
744 path = format (0, "%s/%s%c", hsm->www_root, request, 0);
746 if (hsm->debug_level > 0)
747 clib_warning ("GET '%s'", path);
749 /* Try to find the file. 2x special cases to find index.html */
750 if (stat ((char *) path, sb) < 0 /* cant even stat the file */
751 || sb->st_size < 20 /* file too small */
752 || (sb->st_mode & S_IFMT) != S_IFREG /* not a regular file */ )
754 u32 save_length = vec_len (path) - 1;
755 /* Try appending "index.html"... */
756 _vec_len (path) -= 1;
757 path = format (path, "index.html%c", 0);
758 if (stat ((char *) path, sb) < 0 /* cant even stat the file */
759 || sb->st_size < 20 /* file too small */
760 || (sb->st_mode & S_IFMT) != S_IFREG /* not a regular file */ )
762 _vec_len (path) = save_length;
763 path = format (path, "/index.html%c", 0);
765 /* Send a redirect, otherwise the browser will confuse itself */
766 if (stat ((char *) path, sb) < 0 /* cant even stat the file */
767 || sb->st_size < 20 /* file too small */
768 || (sb->st_mode & S_IFMT) != S_IFREG /* not a regular file */ )
771 send_error (hs, "404 Not Found");
777 transport_endpoint_t endpoint;
778 transport_proto_t proto;
784 * To make this bit work correctly, we need to know our local
785 * IP address, etc. and send it in the redirect...
789 vec_delete (path, vec_len (hsm->www_root) - 1, 0);
791 session_get_endpoint (s, &endpoint, 1 /* is_local */ );
793 local_port = clib_net_to_host_u16 (endpoint.port);
795 proto = session_type_transport_proto (s->session_type);
797 if ((proto == TRANSPORT_PROTO_TCP && local_port != 80)
798 || (proto == TRANSPORT_PROTO_TLS && local_port != 443))
801 port_str = format (0, ":%u", (u32) local_port);
804 redirect = format (0, "HTTP/1.1 301 Moved Permanently\r\n"
805 "Location: http%s://%U%s%s\r\n\r\n",
806 proto == TRANSPORT_PROTO_TLS ? "s" : "",
807 format_ip46_address, &endpoint.ip,
809 print_port ? port_str : (u8 *) "", path);
810 if (hsm->debug_level > 0)
811 clib_warning ("redirect: %s", redirect);
815 static_send_data (hs, redirect, vec_len (redirect), 0);
816 hs->session_state = HTTP_STATE_CLOSED;
826 /* find or read the file if we haven't done so yet. */
829 BVT (clib_bihash_kv) kv;
830 file_data_cache_t *dp;
834 /* First, try the cache */
835 kv.key = (u64) hs->path;
836 if (BV (clib_bihash_search) (&hsm->name_to_data, &kv, &kv) == 0)
838 if (hsm->debug_level > 1)
839 clib_warning ("lookup '%s' returned %lld", kv.key, kv.value);
841 /* found the data.. */
842 dp = pool_elt_at_index (hsm->cache_pool, kv.value);
844 /* Update the cache entry, mark it in-use */
845 lru_update (hsm, dp, vlib_time_now (hsm->vlib_main));
846 hs->cache_pool_index = dp - hsm->cache_pool;
848 if (hsm->debug_level > 1)
849 clib_warning ("index %d refcnt now %d", hs->cache_pool_index,
854 if (hsm->debug_level > 1)
855 clib_warning ("lookup '%s' failed", kv.key, kv.value);
856 /* Need to recycle one (or more cache) entries? */
857 if (hsm->cache_size > hsm->cache_limit)
859 int free_index = hsm->last_index;
861 while (free_index != ~0)
864 dp = pool_elt_at_index (hsm->cache_pool, free_index);
865 free_index = dp->prev_index;
866 /* Which could be in use... */
869 if (hsm->debug_level > 1)
870 clib_warning ("index %d in use refcnt %d",
871 dp - hsm->cache_pool, dp->inuse);
874 kv.key = (u64) (dp->filename);
876 if (BV (clib_bihash_add_del) (&hsm->name_to_data, &kv,
877 0 /* is_add */ ) < 0)
879 clib_warning ("LRU delete '%s' FAILED!", dp->filename);
881 else if (hsm->debug_level > 1)
882 clib_warning ("LRU delete '%s' ok", dp->filename);
884 lru_remove (hsm, dp);
885 hsm->cache_size -= vec_len (dp->data);
886 hsm->cache_evictions++;
887 vec_free (dp->filename);
889 if (hsm->debug_level > 1)
890 clib_warning ("pool put index %d", dp - hsm->cache_pool);
891 pool_put (hsm->cache_pool, dp);
892 if (hsm->cache_size < hsm->cache_limit)
898 error = clib_file_contents ((char *) (hs->path), &hs->data);
901 clib_warning ("Error reading '%s'", hs->path);
902 clib_error_report (error);
907 /* Create a cache entry for it */
908 pool_get (hsm->cache_pool, dp);
909 memset (dp, 0, sizeof (*dp));
910 dp->filename = vec_dup (hs->path);
912 hs->cache_pool_index = dp - hsm->cache_pool;
914 if (hsm->debug_level > 1)
915 clib_warning ("index %d refcnt now %d", hs->cache_pool_index,
917 lru_add (hsm, dp, vlib_time_now (hsm->vlib_main));
918 kv.key = (u64) vec_dup (hs->path);
919 kv.value = dp - hsm->cache_pool;
920 /* Add to the lookup table */
921 if (hsm->debug_level > 1)
922 clib_warning ("add '%s' value %lld", kv.key, kv.value);
924 if (BV (clib_bihash_add_del) (&hsm->name_to_data, &kv,
925 1 /* is_add */ ) < 0)
927 clib_warning ("BUG: add failed!");
929 hsm->cache_size += vec_len (dp->data);
933 /* send 200 OK first */
934 static_send_data (hs, (u8 *) "HTTP/1.1 200 OK\r\n", 17, 0);
935 hs->session_state = HTTP_STATE_OK_SENT;
940 state_send_more_data (session_t * s, http_session_t * hs,
941 state_machine_called_from_t cf)
944 /* Start sending data */
945 hs->data_offset = static_send_data (hs, hs->data, vec_len (hs->data),
949 if (hs->data_offset < vec_len (hs->data))
951 /* No: ask for a shoulder-tap when the tx fifo has space */
952 svm_fifo_add_want_deq_ntf (hs->tx_fifo,
953 SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
954 hs->session_state = HTTP_STATE_SEND_MORE_DATA;
957 /* Finished with this transaction, back to HTTP_STATE_ESTABLISHED */
959 /* Let go of the file cache entry */
960 http_static_server_detach_cache_entry (hs);
961 hs->session_state = HTTP_STATE_ESTABLISHED;
966 state_sent_ok (session_t * s, http_session_t * hs,
967 state_machine_called_from_t cf)
969 http_static_server_main_t *hsm = &http_static_server_main;
976 /* What kind of dog food are we serving? */
977 suffix = (char *) (hs->path + vec_len (hs->path) - 1);
978 while (*suffix != '.')
982 if (!clib_strcmp (suffix, "css"))
984 else if (!clib_strcmp (suffix, "js"))
985 http_type = "javascript";
990 clib_warning ("BUG: hs->data not set for session %d",
997 * Send an http response, which needs the current time,
998 * the expiration time, and the data length
1000 now = clib_timebase_now (&hsm->timebase);
1001 http_response = format (0, http_response_template,
1003 format_clib_timebase_time, now,
1005 format_clib_timebase_time, now + 600.0,
1006 http_type, vec_len (hs->data));
1007 offset = static_send_data (hs, http_response, vec_len (http_response), 0);
1008 if (offset != vec_len (http_response))
1010 clib_warning ("BUG: couldn't send response header!");
1014 vec_free (http_response);
1016 /* Send data from the beginning... */
1017 hs->data_offset = 0;
1018 hs->session_state = HTTP_STATE_SEND_MORE_DATA;
1022 static void *state_funcs[HTTP_STATE_N_STATES] = {
1024 /* Waiting for GET, POST, etc. */
1028 /* Send more data */
1029 state_send_more_data,
1033 http_static_server_rx_tx_callback (session_t * s,
1034 state_machine_called_from_t cf)
1037 int (*fp) (session_t *, http_session_t *, state_machine_called_from_t);
1040 /* Acquire a reader lock on the session table */
1041 http_static_server_sessions_reader_lock ();
1042 hs = http_static_server_session_lookup (s->thread_index, s->session_index);
1046 clib_warning ("No http session for thread %d session_index %d",
1047 s->thread_index, s->session_index);
1048 http_static_server_sessions_reader_unlock ();
1052 /* Execute state machine for this session */
1055 fp = state_funcs[hs->session_state];
1056 rv = (*fp) (s, hs, cf);
1058 goto session_closed;
1062 /* Reset the session expiration timer */
1063 http_static_server_session_timer_stop (hs);
1064 http_static_server_session_timer_start (hs);
1067 http_static_server_sessions_reader_unlock ();
1072 http_static_server_rx_callback (session_t * s)
1074 return http_static_server_rx_tx_callback (s, CALLED_FROM_RX);
1078 http_static_server_tx_callback (session_t * s)
1080 return http_static_server_rx_tx_callback (s, CALLED_FROM_TX);
1084 /** \brief Session accept callback
1088 http_static_server_session_accept_callback (session_t * s)
1090 http_static_server_main_t *hsm = &http_static_server_main;
1093 hsm->vpp_queue[s->thread_index] =
1094 session_main_get_vpp_event_queue (s->thread_index);
1096 http_static_server_sessions_writer_lock ();
1098 hs = http_static_server_session_alloc (s->thread_index);
1099 http_static_server_session_lookup_add (s->thread_index, s->session_index,
1101 hs->rx_fifo = s->rx_fifo;
1102 hs->tx_fifo = s->tx_fifo;
1103 hs->vpp_session_index = s->session_index;
1104 hs->vpp_session_handle = session_handle (s);
1105 hs->session_state = HTTP_STATE_ESTABLISHED;
1106 http_static_server_session_timer_start (hs);
1108 http_static_server_sessions_writer_unlock ();
1110 s->session_state = SESSION_STATE_READY;
1114 /** \brief Session disconnect callback
1118 http_static_server_session_disconnect_callback (session_t * s)
1120 http_static_server_main_t *hsm = &http_static_server_main;
1121 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
1124 http_static_server_sessions_writer_lock ();
1126 hs = http_static_server_session_lookup (s->thread_index, s->session_index);
1127 http_static_server_session_cleanup (hs);
1129 http_static_server_sessions_writer_unlock ();
1131 a->handle = session_handle (s);
1132 a->app_index = hsm->app_index;
1133 vnet_disconnect_session (a);
1136 /** \brief Session reset callback
1140 http_static_server_session_reset_callback (session_t * s)
1142 http_static_server_main_t *hsm = &http_static_server_main;
1143 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
1146 http_static_server_sessions_writer_lock ();
1148 hs = http_static_server_session_lookup (s->thread_index, s->session_index);
1149 http_static_server_session_cleanup (hs);
1151 http_static_server_sessions_writer_unlock ();
1153 a->handle = session_handle (s);
1154 a->app_index = hsm->app_index;
1155 vnet_disconnect_session (a);
1159 http_static_server_session_connected_callback (u32 app_index, u32 api_context,
1160 session_t * s, u8 is_fail)
1162 clib_warning ("called...");
1167 http_static_server_add_segment_callback (u32 client_index, u64 segment_handle)
1169 clib_warning ("called...");
1173 /** \brief Session-layer virtual function table
1175 static session_cb_vft_t http_static_server_session_cb_vft = {
1176 .session_accept_callback = http_static_server_session_accept_callback,
1177 .session_disconnect_callback =
1178 http_static_server_session_disconnect_callback,
1179 .session_connected_callback = http_static_server_session_connected_callback,
1180 .add_segment_callback = http_static_server_add_segment_callback,
1181 .builtin_app_rx_callback = http_static_server_rx_callback,
1182 .builtin_app_tx_callback = http_static_server_tx_callback,
1183 .session_reset_callback = http_static_server_session_reset_callback
1187 http_static_server_attach ()
1189 vnet_app_add_tls_cert_args_t _a_cert, *a_cert = &_a_cert;
1190 vnet_app_add_tls_key_args_t _a_key, *a_key = &_a_key;
1191 http_static_server_main_t *hsm = &http_static_server_main;
1192 u64 options[APP_OPTIONS_N_OPTIONS];
1193 vnet_app_attach_args_t _a, *a = &_a;
1194 u32 segment_size = 128 << 20;
1196 clib_memset (a, 0, sizeof (*a));
1197 clib_memset (options, 0, sizeof (options));
1199 if (hsm->private_segment_size)
1200 segment_size = hsm->private_segment_size;
1202 a->api_client_index = ~0;
1203 a->name = format (0, "test_http_static_server");
1204 a->session_cb_vft = &http_static_server_session_cb_vft;
1205 a->options = options;
1206 a->options[APP_OPTIONS_SEGMENT_SIZE] = segment_size;
1207 a->options[APP_OPTIONS_RX_FIFO_SIZE] =
1208 hsm->fifo_size ? hsm->fifo_size : 8 << 10;
1209 a->options[APP_OPTIONS_TX_FIFO_SIZE] =
1210 hsm->fifo_size ? hsm->fifo_size : 32 << 10;
1211 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1212 a->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] = hsm->prealloc_fifos;
1213 a->options[APP_OPTIONS_TLS_ENGINE] = TLS_ENGINE_OPENSSL;
1215 if (vnet_application_attach (a))
1218 clib_warning ("failed to attach server");
1222 hsm->app_index = a->app_index;
1224 clib_memset (a_cert, 0, sizeof (*a_cert));
1225 a_cert->app_index = a->app_index;
1226 vec_validate (a_cert->cert, test_srv_crt_rsa_len);
1227 clib_memcpy_fast (a_cert->cert, test_srv_crt_rsa, test_srv_crt_rsa_len);
1228 vnet_app_add_tls_cert (a_cert);
1230 clib_memset (a_key, 0, sizeof (*a_key));
1231 a_key->app_index = a->app_index;
1232 vec_validate (a_key->key, test_srv_key_rsa_len);
1233 clib_memcpy_fast (a_key->key, test_srv_key_rsa, test_srv_key_rsa_len);
1234 vnet_app_add_tls_key (a_key);
1240 http_static_server_listen ()
1242 http_static_server_main_t *hsm = &http_static_server_main;
1243 vnet_listen_args_t _a, *a = &_a;
1244 clib_memset (a, 0, sizeof (*a));
1245 a->app_index = hsm->app_index;
1246 a->uri = "tcp://0.0.0.0/80";
1248 a->uri = (char *) hsm->uri;
1249 return vnet_bind_uri (a);
1253 http_static_server_session_cleanup_cb (void *hs_handlep)
1255 http_static_server_main_t *hsm = &http_static_server_main;
1258 hs_handle = pointer_to_uword (hs_handlep);
1260 http_static_server_session_get (hs_handle >> 24, hs_handle & 0x00FFFFFF);
1262 if (hsm->debug_level > 1)
1263 clib_warning ("terminate thread %d index %d hs %llx",
1264 hs_handle >> 24, hs_handle & 0x00FFFFFF, hs);
1267 hs->timer_handle = ~0;
1268 http_static_server_session_disconnect (hs);
1269 http_static_server_session_cleanup (hs);
1272 /** \brief Expired session timer-wheel callback
1275 http_expired_timers_dispatch (u32 * expired_timers)
1280 for (i = 0; i < vec_len (expired_timers); i++)
1282 /* Get session handle. The first bit is the timer id */
1283 hs_handle = expired_timers[i] & 0x7FFFFFFF;
1284 session_send_rpc_evt_to_thread (hs_handle >> 24,
1285 http_static_server_session_cleanup_cb,
1286 uword_to_pointer (hs_handle, void *));
1290 /** \brief Timer-wheel expiration process
1293 http_static_server_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1296 http_static_server_main_t *hsm = &http_static_server_main;
1297 f64 now, timeout = 1.0;
1298 uword *event_data = 0;
1299 uword __clib_unused event_type;
1303 vlib_process_wait_for_event_or_clock (vm, timeout);
1304 now = vlib_time_now (vm);
1305 event_type = vlib_process_get_events (vm, (uword **) & event_data);
1308 clib_spinlock_lock (&http_static_server_main.tw_lock);
1309 tw_timer_expire_timers_2t_1w_2048sl (&hsm->tw, now);
1310 clib_spinlock_unlock (&http_static_server_main.tw_lock);
1312 vec_reset_length (event_data);
1318 VLIB_REGISTER_NODE (http_static_server_process_node) =
1320 .function = http_static_server_process,
1321 .type = VLIB_NODE_TYPE_PROCESS,
1322 .name = "static-http-server-process",
1323 .state = VLIB_NODE_STATE_DISABLED,
1328 http_static_server_create (vlib_main_t * vm)
1330 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1331 http_static_server_main_t *hsm = &http_static_server_main;
1335 num_threads = 1 /* main thread */ + vtm->n_threads;
1336 vec_validate (hsm->vpp_queue, num_threads - 1);
1337 vec_validate (hsm->sessions, num_threads - 1);
1338 vec_validate (hsm->session_to_http_session, num_threads - 1);
1340 clib_rwlock_init (&hsm->sessions_lock);
1341 clib_spinlock_init (&hsm->tw_lock);
1343 if (http_static_server_attach ())
1345 clib_warning ("failed to attach server");
1348 if (http_static_server_listen ())
1350 clib_warning ("failed to start listening");
1354 /* Init path-to-cache hash table */
1355 BV (clib_bihash_init) (&hsm->name_to_data, "http cache", 128, 32 << 20);
1357 /* Init timer wheel and process */
1358 tw_timer_wheel_init_2t_1w_2048sl (&hsm->tw, http_expired_timers_dispatch,
1359 1.0 /* timer interval */ , ~0);
1360 vlib_node_set_state (vm, http_static_server_process_node.index,
1361 VLIB_NODE_STATE_POLLING);
1362 n = vlib_get_node (vm, http_static_server_process_node.index);
1363 vlib_start_process (vm, n->runtime_index);
1368 /** \brief API helper function for vl_api_http_static_enable_t messages
1371 http_static_server_enable_api (u32 fifo_size, u32 cache_limit,
1373 u32 private_segment_size,
1374 u8 * www_root, u8 * uri)
1376 http_static_server_main_t *hsm = &http_static_server_main;
1379 hsm->fifo_size = fifo_size;
1380 hsm->cache_limit = cache_limit;
1381 hsm->prealloc_fifos = prealloc_fifos;
1382 hsm->private_segment_size = private_segment_size;
1383 hsm->www_root = format (0, "%s%c", www_root, 0);
1384 hsm->uri = format (0, "%s%c", uri, 0);
1386 if (vec_len (hsm->www_root) < 2)
1387 return VNET_API_ERROR_INVALID_VALUE;
1389 if (hsm->my_client_index != ~0)
1390 return VNET_API_ERROR_APP_ALREADY_ATTACHED;
1392 vnet_session_enable_disable (hsm->vlib_main, 1 /* turn on TCP, etc. */ );
1394 rv = http_static_server_create (hsm->vlib_main);
1400 vec_free (hsm->www_root);
1401 vec_free (hsm->uri);
1402 return VNET_API_ERROR_INIT_FAILED;
1407 static clib_error_t *
1408 http_static_server_create_command_fn (vlib_main_t * vm,
1409 unformat_input_t * input,
1410 vlib_cli_command_t * cmd)
1412 http_static_server_main_t *hsm = &http_static_server_main;
1413 unformat_input_t _line_input, *line_input = &_line_input;
1418 hsm->prealloc_fifos = 0;
1419 hsm->private_segment_size = 0;
1421 /* 10mb cache limit, before LRU occurs */
1422 hsm->cache_limit = 10 << 20;
1424 /* Get a line of input. */
1425 if (!unformat_user (input, unformat_line_input, line_input))
1428 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1430 if (unformat (line_input, "www-root %s", &www_root))
1433 if (unformat (line_input, "prealloc-fifos %d", &hsm->prealloc_fifos))
1435 else if (unformat (line_input, "private-segment-size %U",
1436 unformat_memory_size, &seg_size))
1438 if (seg_size >= 0x100000000ULL)
1440 vlib_cli_output (vm, "private segment size %llu, too large",
1444 hsm->private_segment_size = seg_size;
1446 else if (unformat (line_input, "fifo-size %d", &hsm->fifo_size))
1447 hsm->fifo_size <<= 10;
1448 else if (unformat (line_input, "cache-size %U", unformat_memory_size,
1451 if (hsm->cache_limit < (128 << 10))
1453 return clib_error_return (0,
1454 "cache-size must be at least 128kb");
1458 else if (unformat (line_input, "uri %s", &hsm->uri))
1460 else if (unformat (line_input, "debug %d", &hsm->debug_level))
1462 else if (unformat (line_input, "debug"))
1463 hsm->debug_level = 1;
1465 return clib_error_return (0, "unknown input `%U'",
1466 format_unformat_error, line_input);
1468 unformat_free (line_input);
1473 return clib_error_return (0, "Must specify www-root <path>");
1476 if (hsm->my_client_index != (u32) ~ 0)
1478 vec_free (www_root);
1479 return clib_error_return (0, "http server already running...");
1482 hsm->www_root = www_root;
1484 vnet_session_enable_disable (vm, 1 /* turn on TCP, etc. */ );
1486 rv = http_static_server_create (vm);
1492 vec_free (hsm->www_root);
1493 return clib_error_return (0, "server_create returned %d", rv);
1499 * Enable the static http server
1502 * This command enables the static http server. Only the www-root
1503 * parameter is required
1505 * http static server www-root /tmp/www uri tcp://0.0.0.0/80 cache-size 2m
1507 * @cliexcmd{http static server www-root <path> [prealloc-fios <nn>]
1508 * [private-segment-size <nnMG>] [fifo-size <nbytes>] [uri <uri>]}
1511 VLIB_CLI_COMMAND (http_static_server_create_command, static) =
1513 .path = "http static server",
1514 .short_help = "http static server www-root <path> [prealloc-fifos <nn>]\n"
1515 "[private-segment-size <nnMG>] [fifo-size <nbytes>] [uri <uri>]\n"
1517 .function = http_static_server_create_command_fn,
1521 /** \brief format a file cache entry
1524 format_hsm_cache_entry (u8 * s, va_list * args)
1526 file_data_cache_t *ep = va_arg (*args, file_data_cache_t *);
1527 f64 now = va_arg (*args, f64);
1532 s = format (s, "%40s%12s%20s", "File", "Size", "Age");
1535 s = format (s, "%40s%12lld%20.2f", ep->filename, vec_len (ep->data),
1536 now - ep->last_used);
1541 format_http_session_state (u8 * s, va_list * args)
1543 http_session_state_t state = va_arg (*args, http_session_state_t);
1544 char *state_string = "bogus!";
1548 case HTTP_STATE_CLOSED:
1549 state_string = "closed";
1551 case HTTP_STATE_ESTABLISHED:
1552 state_string = "established";
1554 case HTTP_STATE_OK_SENT:
1555 state_string = "ok sent";
1557 case HTTP_STATE_SEND_MORE_DATA:
1558 state_string = "send more data";
1564 return format (s, "%s", state_string);
1568 format_http_session (u8 * s, va_list * args)
1570 http_session_t *hs = va_arg (*args, http_session_t *);
1571 int verbose = va_arg (*args, int);
1573 s = format (s, "[%d]: state %U", hs->session_index,
1574 format_http_session_state, hs->session_state);
1577 s = format (s, "\n path %s, data length %u, data_offset %u",
1578 hs->path ? hs->path : (u8 *) "[none]",
1579 vec_len (hs->data), hs->data_offset);
1584 static clib_error_t *
1585 http_show_static_server_command_fn (vlib_main_t * vm,
1586 unformat_input_t * input,
1587 vlib_cli_command_t * cmd)
1589 http_static_server_main_t *hsm = &http_static_server_main;
1590 file_data_cache_t *ep, **entries = 0;
1593 int show_sessions = 0;
1597 if (hsm->www_root == 0)
1598 return clib_error_return (0, "Static server disabled");
1600 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1602 if (unformat (input, "verbose %d", &verbose))
1604 else if (unformat (input, "verbose"))
1606 else if (unformat (input, "cache"))
1608 else if (unformat (input, "sessions"))
1614 if ((show_cache + show_sessions) == 0)
1615 return clib_error_return (0, "specify one or more of cache, sessions");
1622 (vm, "www_root %s, cache size %lld bytes, limit %lld bytes, "
1624 hsm->www_root, hsm->cache_size, hsm->cache_limit,
1625 hsm->cache_evictions);
1629 now = vlib_time_now (vm);
1631 vlib_cli_output (vm, "%U", format_hsm_cache_entry, 0 /* header */ ,
1634 for (index = hsm->first_index; index != ~0;)
1636 ep = pool_elt_at_index (hsm->cache_pool, index);
1637 index = ep->next_index;
1638 vlib_cli_output (vm, "%U", format_hsm_cache_entry, ep, now);
1641 vlib_cli_output (vm, "%40s%12lld", "Total Size", hsm->cache_size);
1648 u32 *session_indices = 0;
1652 http_static_server_sessions_reader_lock ();
1654 for (i = 0; i < vec_len (hsm->sessions); i++)
1657 pool_foreach (hs, hsm->sessions[i],
1659 vec_add1 (session_indices, hs - hsm->sessions[i]);
1663 for (j = 0; j < vec_len (session_indices); j++)
1665 vlib_cli_output (vm, "%U", format_http_session,
1667 (hsm->sessions[i], session_indices[j]),
1670 vec_reset_length (session_indices);
1672 http_static_server_sessions_reader_unlock ();
1673 vec_free (session_indices);
1679 * Display static http server cache statistics
1682 * This command shows the contents of the static http server cache
1684 * show http static server
1686 * @cliexcmd{show http static server sessions cache [verbose [nn]]}
1689 VLIB_CLI_COMMAND (http_show_static_server_command, static) =
1691 .path = "show http static server",
1692 .short_help = "show http static server sessions cache [verbose [<nn>]]",
1693 .function = http_show_static_server_command_fn,
1697 static clib_error_t *
1698 http_static_server_main_init (vlib_main_t * vm)
1700 http_static_server_main_t *hsm = &http_static_server_main;
1702 hsm->my_client_index = ~0;
1703 hsm->vlib_main = vm;
1704 hsm->first_index = hsm->last_index = ~0;
1706 clib_timebase_init (&hsm->timebase, 0 /* GMT */ ,
1707 CLIB_TIMEBASE_DAYLIGHT_NONE);
1712 VLIB_INIT_FUNCTION (http_static_server_main_init);
1715 * fd.io coding-style-patch-verification: ON
1718 * eval: (c-set-style "gnu")