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/unix.h>
21 #include <sys/types.h>
24 #include <http_static/http_static.h>
26 #include <vppinfra/bihash_template.c>
28 /** @file Static http server, sufficient to
29 serve .html / .css / .js content.
31 /*? %%clicmd:group_label Static HTTP Server %% ?*/
33 http_static_server_main_t http_static_server_main;
35 /** \brief Format the called-from enum
39 format_state_machine_called_from (u8 * s, va_list * args)
41 http_state_machine_called_from_t cf =
42 va_arg (*args, http_state_machine_called_from_t);
43 char *which = "bogus!";
53 case CALLED_FROM_TIMER:
61 s = format (s, "%s", which);
66 /** \brief Acquire reader lock on the sessions pools
69 http_static_server_sessions_reader_lock (void)
71 clib_rwlock_reader_lock (&http_static_server_main.sessions_lock);
74 /** \brief Drop reader lock on the sessions pools
77 http_static_server_sessions_reader_unlock (void)
79 clib_rwlock_reader_unlock (&http_static_server_main.sessions_lock);
82 /** \brief Acquire writer lock on the sessions pools
85 http_static_server_sessions_writer_lock (void)
87 clib_rwlock_writer_lock (&http_static_server_main.sessions_lock);
90 /** \brief Drop writer lock on the sessions pools
93 http_static_server_sessions_writer_unlock (void)
95 clib_rwlock_writer_unlock (&http_static_server_main.sessions_lock);
98 /** \brief Start a session cleanup timer
101 http_static_server_session_timer_start (http_session_t * hs)
103 http_static_server_main_t *hsm = &http_static_server_main;
106 /* The session layer may fire a callback at a later date... */
107 if (!pool_is_free (hsm->sessions[hs->thread_index], hs))
109 hs_handle = hs->thread_index << 24 | hs->session_index;
110 clib_spinlock_lock (&http_static_server_main.tw_lock);
111 hs->timer_handle = tw_timer_start_2t_1w_2048sl
112 (&http_static_server_main.tw, hs_handle, 0, 60);
113 clib_spinlock_unlock (&http_static_server_main.tw_lock);
117 /** \brief stop a session cleanup timer
120 http_static_server_session_timer_stop (http_session_t * hs)
122 if (hs->timer_handle == ~0)
124 clib_spinlock_lock (&http_static_server_main.tw_lock);
125 tw_timer_stop_2t_1w_2048sl (&http_static_server_main.tw, hs->timer_handle);
126 clib_spinlock_unlock (&http_static_server_main.tw_lock);
129 /** \brief Allocate an http session
131 static http_session_t *
132 http_static_server_session_alloc (u32 thread_index)
134 http_static_server_main_t *hsm = &http_static_server_main;
136 pool_get (hsm->sessions[thread_index], hs);
137 memset (hs, 0, sizeof (*hs));
138 hs->session_index = hs - hsm->sessions[thread_index];
139 hs->thread_index = thread_index;
140 hs->timer_handle = ~0;
141 hs->cache_pool_index = ~0;
145 /** \brief Get an http session by index
147 static http_session_t *
148 http_static_server_session_get (u32 thread_index, u32 hs_index)
150 http_static_server_main_t *hsm = &http_static_server_main;
151 if (pool_is_free_index (hsm->sessions[thread_index], hs_index))
153 return pool_elt_at_index (hsm->sessions[thread_index], hs_index);
156 /** \brief Free an http session
159 http_static_server_session_free (http_session_t * hs)
161 http_static_server_main_t *hsm = &http_static_server_main;
163 /* Make sure the timer is stopped... */
164 http_static_server_session_timer_stop (hs);
165 pool_put (hsm->sessions[hs->thread_index], hs);
169 u32 save_thread_index;
170 save_thread_index = hs->thread_index;
171 /* Poison the entry, preserve timer state and thread index */
172 memset (hs, 0xfa, sizeof (*hs));
173 hs->timer_handle = ~0;
174 hs->thread_index = save_thread_index;
178 /** \brief add a session to the vpp < -- > http session index map
181 http_static_server_session_lookup_add (u32 thread_index, u32 s_index,
184 http_static_server_main_t *hsm = &http_static_server_main;
185 vec_validate (hsm->session_to_http_session[thread_index], s_index);
186 hsm->session_to_http_session[thread_index][s_index] = hs_index;
189 /** \brief Remove a session from the vpp < -- > http session index map
192 http_static_server_session_lookup_del (u32 thread_index, u32 s_index)
194 http_static_server_main_t *hsm = &http_static_server_main;
195 hsm->session_to_http_session[thread_index][s_index] = ~0;
198 /** \brief lookup a session in the vpp < -- > http session index map
201 static http_session_t *
202 http_static_server_session_lookup (u32 thread_index, u32 s_index)
204 http_static_server_main_t *hsm = &http_static_server_main;
207 if (s_index < vec_len (hsm->session_to_http_session[thread_index]))
209 hs_index = hsm->session_to_http_session[thread_index][s_index];
210 return http_static_server_session_get (thread_index, hs_index);
215 /** \brief Detach cache entry from session
219 http_static_server_detach_cache_entry (http_session_t * hs)
221 http_static_server_main_t *hsm = &http_static_server_main;
222 file_data_cache_t *ep;
225 * Decrement cache pool entry reference count
226 * Note that if e.g. a file lookup fails, the cache pool index
229 if (hs->cache_pool_index != ~0)
231 ep = pool_elt_at_index (hsm->cache_pool, hs->cache_pool_index);
233 if (hsm->debug_level > 1)
234 clib_warning ("index %d refcnt now %d", hs->cache_pool_index,
237 hs->cache_pool_index = ~0;
246 /** \brief Disconnect a session
249 http_static_server_session_disconnect (http_session_t * hs)
251 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
252 a->handle = hs->vpp_session_handle;
253 a->app_index = http_static_server_main.app_index;
254 vnet_disconnect_session (a);
258 /** \brief http error boilerplate
260 static const char *http_error_template =
263 "Content-Type: text/html\r\n"
264 "Connection: close\r\n"
265 "Pragma: no-cache\r\n"
266 "Content-Length: 0\r\n\r\n";
268 /** \brief http response boilerplate
270 static const char *http_response_template =
272 "Expires: %U GMT\r\n"
273 "Server: VPP Static\r\n"
274 "Content-Type: %s\r\n"
275 "Content-Length: %d\r\n\r\n";
279 /** \brief send http data
280 @param hs - http session
281 @param data - the data vector to transmit
282 @param offset - transmit offset for this operation
283 @return offset for next transmit operation, may be unchanged w/ full fifo
287 static_send_data (http_session_t * hs, u8 * data, u32 length, u32 offset)
290 http_static_server_main_t *hsm = &http_static_server_main;
292 bytes_to_send = length - offset;
294 while (bytes_to_send > 0)
298 actual_transfer = svm_fifo_enqueue
299 (hs->tx_fifo, bytes_to_send, data + offset);
301 /* Made any progress? */
302 if (actual_transfer <= 0)
304 if (hsm->debug_level > 0 && bytes_to_send > 0)
305 clib_warning ("WARNING: still %d bytes to send", bytes_to_send);
310 offset += actual_transfer;
311 bytes_to_send -= actual_transfer;
313 if (hsm->debug_level && bytes_to_send > 0)
314 clib_warning ("WARNING: still %d bytes to send", bytes_to_send);
316 if (svm_fifo_set_event (hs->tx_fifo))
317 session_send_io_evt_to_thread (hs->tx_fifo,
318 SESSION_IO_EVT_TX_FLUSH);
326 /** \brief Send an http error string
327 @param hs - the http session
328 @param str - the error string, e.g. "404 Not Found"
331 send_error (http_session_t * hs, char *str)
333 http_static_server_main_t *hsm = &http_static_server_main;
337 now = clib_timebase_now (&hsm->timebase);
338 data = format (0, http_error_template, str, format_clib_timebase_time, now);
339 static_send_data (hs, data, vec_len (data), 0);
343 /** \brief Retrieve data from the application layer
346 session_rx_request (http_session_t * hs)
348 u32 max_dequeue, cursize;
351 cursize = vec_len (hs->rx_buf);
352 max_dequeue = svm_fifo_max_dequeue (hs->rx_fifo);
353 if (PREDICT_FALSE (max_dequeue == 0))
356 vec_validate (hs->rx_buf, cursize + max_dequeue - 1);
357 n_read = app_recv_stream_raw (hs->rx_fifo, hs->rx_buf + cursize,
358 max_dequeue, 0, 0 /* peek */ );
359 ASSERT (n_read == max_dequeue);
360 if (svm_fifo_is_empty (hs->rx_fifo))
361 svm_fifo_unset_event (hs->rx_fifo);
363 _vec_len (hs->rx_buf) = cursize + n_read;
367 /** \brief Sanity-check the forward and reverse LRU lists
370 lru_validate (http_static_server_main_t * hsm)
376 file_data_cache_t *ep;
378 last_timestamp = 1e70;
379 for (i = 1, index = hsm->first_index; index != ~0;)
381 ep = pool_elt_at_index (hsm->cache_pool, index);
382 index = ep->next_index;
383 /* Timestamps should be smaller (older) as we walk the fwd list */
384 if (ep->last_used > last_timestamp)
386 clib_warning ("%d[%d]: last used %.6f, last_timestamp %.6f",
387 ep - hsm->cache_pool, i,
388 ep->last_used, last_timestamp);
390 last_timestamp = ep->last_used;
394 last_timestamp = 0.0;
395 for (i = 1, index = hsm->last_index; index != ~0;)
397 ep = pool_elt_at_index (hsm->cache_pool, index);
398 index = ep->prev_index;
399 /* Timestamps should be larger (newer) as we walk the rev list */
400 if (ep->last_used < last_timestamp)
402 clib_warning ("%d[%d]: last used %.6f, last_timestamp %.6f",
403 ep - hsm->cache_pool, i,
404 ep->last_used, last_timestamp);
406 last_timestamp = ep->last_used;
412 /** \brief Remove a data cache entry from the LRU lists
415 lru_remove (http_static_server_main_t * hsm, file_data_cache_t * ep)
417 file_data_cache_t *next_ep, *prev_ep;
422 ep_index = ep - hsm->cache_pool;
424 /* Deal with list heads */
425 if (ep_index == hsm->first_index)
426 hsm->first_index = ep->next_index;
427 if (ep_index == hsm->last_index)
428 hsm->last_index = ep->prev_index;
431 if (ep->next_index != ~0)
433 next_ep = pool_elt_at_index (hsm->cache_pool, ep->next_index);
434 next_ep->prev_index = ep->prev_index;
437 if (ep->prev_index != ~0)
439 prev_ep = pool_elt_at_index (hsm->cache_pool, ep->prev_index);
440 prev_ep->next_index = ep->next_index;
445 /** \brief Add an entry to the LRU lists, tag w/ supplied timestamp
449 lru_add (http_static_server_main_t * hsm, file_data_cache_t * ep, f64 now)
451 file_data_cache_t *next_ep;
456 ep_index = ep - hsm->cache_pool;
459 * Re-add at the head of the forward LRU list,
460 * tail of the reverse LRU list
462 if (hsm->first_index != ~0)
464 next_ep = pool_elt_at_index (hsm->cache_pool, hsm->first_index);
465 next_ep->prev_index = ep_index;
470 /* ep now the new head of the LRU forward list */
471 ep->next_index = hsm->first_index;
472 hsm->first_index = ep_index;
474 /* single session case: also the tail of the reverse LRU list */
475 if (hsm->last_index == ~0)
476 hsm->last_index = ep_index;
482 /** \brief Remove and re-add a cache entry from/to the LRU lists
486 lru_update (http_static_server_main_t * hsm, file_data_cache_t * ep, f64 now)
488 lru_remove (hsm, ep);
489 lru_add (hsm, ep, now);
492 /** \brief Session-layer (main) data rx callback.
493 Parse the http request, and reply to it.
494 Future extensions might include POST processing, active content, etc.
497 /* svm_fifo_add_want_deq_ntf (tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL)
498 get shoulder-tap when transport dequeues something, set in
501 /** \brief closed state - should never really get here
504 state_closed (session_t * s, http_session_t * hs,
505 http_state_machine_called_from_t cf)
507 clib_warning ("WARNING: http session %d, called from %U",
508 hs->session_index, format_state_machine_called_from, cf);
513 close_session (http_session_t * hs)
515 http_static_server_session_disconnect (hs);
518 /** \brief Register a builtin GET or POST handler
520 void http_static_server_register_builtin_handler
521 (void *fp, char *url, int request_type)
523 http_static_server_main_t *hsm = &http_static_server_main;
524 uword *p, *builtin_table;
526 builtin_table = (request_type == HTTP_BUILTIN_METHOD_GET)
527 ? hsm->get_url_handlers : hsm->post_url_handlers;
529 p = hash_get_mem (builtin_table, url);
533 clib_warning ("WARNING: attempt to replace handler for %s '%s' ignored",
534 (request_type == HTTP_BUILTIN_METHOD_GET) ?
535 "GET" : "POST", url);
539 hash_set_mem (builtin_table, url, (uword) fp);
542 * Need to update the hash table pointer in http_static_server_main
543 * in case we just expanded it...
545 if (request_type == HTTP_BUILTIN_METHOD_GET)
546 hsm->get_url_handlers = builtin_table;
548 hsm->post_url_handlers = builtin_table;
552 v_find_index (u8 * vec, char *str)
555 u32 slen = (u32) strnlen_s_inline (str, 8);
556 u32 vlen = vec_len (vec);
563 for (start_index = 0; start_index < (vlen - slen); start_index++)
565 if (!memcmp (vec, str, slen))
572 /** \brief established state - waiting for GET, POST, etc.
575 state_established (session_t * s, http_session_t * hs,
576 http_state_machine_called_from_t cf)
578 http_static_server_main_t *hsm = &http_static_server_main;
582 struct stat _sb, *sb = &_sb;
584 u8 request_type = HTTP_BUILTIN_METHOD_GET;
586 uword *p, *builtin_table;
588 /* Read data from the sessison layer */
589 rv = session_rx_request (hs);
591 /* No data? Odd, but stay in this state and await further instructions */
595 /* Process the client request */
596 request = hs->rx_buf;
597 if (vec_len (request) < 8)
599 send_error (hs, "400 Bad Request");
604 if ((i = v_find_index (request, "GET ")) >= 0)
606 else if ((i = v_find_index (request, "POST ")) >= 0)
608 request_type = HTTP_BUILTIN_METHOD_POST;
612 if (hsm->debug_level > 1)
613 clib_warning ("Unknown http method");
615 send_error (hs, "405 Method Not Allowed");
621 /* Lose "GET " or "POST " */
622 vec_delete (request, i + 5 + request_type, 0);
624 /* Temporarily drop in a NULL byte for lookup purposes */
625 for (i = 0; i < vec_len (request); i++)
627 if (request[i] == ' ' || request[i] == '?')
629 save_byte = request[i];
636 * Now we can construct the file to open
637 * Browsers are capable of sporadically including a leading '/'
639 if (request[0] == '/')
640 path = format (0, "%s%s%c", hsm->www_root, request, 0);
642 path = format (0, "%s/%s%c", hsm->www_root, request, 0);
644 if (hsm->debug_level > 0)
645 clib_warning ("%s '%s'", (request_type) == HTTP_BUILTIN_METHOD_GET ?
646 "GET" : "POST", path);
648 /* Look for built-in GET / POST handlers */
649 builtin_table = (request_type == HTTP_BUILTIN_METHOD_GET) ?
650 hsm->get_url_handlers : hsm->post_url_handlers;
652 p = hash_get_mem (builtin_table, request);
655 request[i] = save_byte;
660 int (*fp) (u8 *, http_session_t *);
663 rv = (*fp) (request, hs);
666 clib_warning ("builtin handler %llx hit on %s '%s' but failed!",
667 p[0], (request_type == HTTP_BUILTIN_METHOD_GET) ?
668 "GET" : "POST", request);
669 send_error (hs, "404 Not Found");
673 vec_reset_length (hs->rx_buf);
676 vec_reset_length (hs->rx_buf);
677 /* poison request, it's not valid anymore */
679 /* The static server itself doesn't do POSTs */
680 if (request_type == HTTP_BUILTIN_METHOD_POST)
682 send_error (hs, "404 Not Found");
687 /* Try to find the file. 2x special cases to find index.html */
688 if (stat ((char *) path, sb) < 0 /* cant even stat the file */
689 || sb->st_size < 20 /* file too small */
690 || (sb->st_mode & S_IFMT) != S_IFREG /* not a regular file */ )
692 u32 save_length = vec_len (path) - 1;
693 /* Try appending "index.html"... */
694 _vec_len (path) -= 1;
695 path = format (path, "index.html%c", 0);
696 if (stat ((char *) path, sb) < 0 /* cant even stat the file */
697 || sb->st_size < 20 /* file too small */
698 || (sb->st_mode & S_IFMT) != S_IFREG /* not a regular file */ )
700 _vec_len (path) = save_length;
701 path = format (path, "/index.html%c", 0);
703 /* Send a redirect, otherwise the browser will confuse itself */
704 if (stat ((char *) path, sb) < 0 /* cant even stat the file */
705 || sb->st_size < 20 /* file too small */
706 || (sb->st_mode & S_IFMT) != S_IFREG /* not a regular file */ )
709 send_error (hs, "404 Not Found");
715 transport_endpoint_t endpoint;
716 transport_proto_t proto;
722 * To make this bit work correctly, we need to know our local
723 * IP address, etc. and send it in the redirect...
727 vec_delete (path, vec_len (hsm->www_root) - 1, 0);
729 session_get_endpoint (s, &endpoint, 1 /* is_local */ );
731 local_port = clib_net_to_host_u16 (endpoint.port);
733 proto = session_type_transport_proto (s->session_type);
735 if ((proto == TRANSPORT_PROTO_TCP && local_port != 80)
736 || (proto == TRANSPORT_PROTO_TLS && local_port != 443))
739 port_str = format (0, ":%u", (u32) local_port);
742 redirect = format (0, "HTTP/1.1 301 Moved Permanently\r\n"
743 "Location: http%s://%U%s%s\r\n\r\n",
744 proto == TRANSPORT_PROTO_TLS ? "s" : "",
745 format_ip46_address, &endpoint.ip,
747 print_port ? port_str : (u8 *) "", path);
748 if (hsm->debug_level > 0)
749 clib_warning ("redirect: %s", redirect);
753 static_send_data (hs, redirect, vec_len (redirect), 0);
754 hs->session_state = HTTP_STATE_CLOSED;
764 /* find or read the file if we haven't done so yet. */
767 BVT (clib_bihash_kv) kv;
768 file_data_cache_t *dp;
772 /* First, try the cache */
773 kv.key = (u64) hs->path;
774 if (BV (clib_bihash_search) (&hsm->name_to_data, &kv, &kv) == 0)
776 if (hsm->debug_level > 1)
777 clib_warning ("lookup '%s' returned %lld", kv.key, kv.value);
779 /* found the data.. */
780 dp = pool_elt_at_index (hsm->cache_pool, kv.value);
782 /* Update the cache entry, mark it in-use */
783 lru_update (hsm, dp, vlib_time_now (vlib_get_main ()));
784 hs->cache_pool_index = dp - hsm->cache_pool;
786 if (hsm->debug_level > 1)
787 clib_warning ("index %d refcnt now %d", hs->cache_pool_index,
792 if (hsm->debug_level > 1)
793 clib_warning ("lookup '%s' failed", kv.key, kv.value);
794 /* Need to recycle one (or more cache) entries? */
795 if (hsm->cache_size > hsm->cache_limit)
797 int free_index = hsm->last_index;
799 while (free_index != ~0)
802 dp = pool_elt_at_index (hsm->cache_pool, free_index);
803 free_index = dp->prev_index;
804 /* Which could be in use... */
807 if (hsm->debug_level > 1)
808 clib_warning ("index %d in use refcnt %d",
809 dp - hsm->cache_pool, dp->inuse);
812 kv.key = (u64) (dp->filename);
814 if (BV (clib_bihash_add_del) (&hsm->name_to_data, &kv,
815 0 /* is_add */ ) < 0)
817 clib_warning ("LRU delete '%s' FAILED!", dp->filename);
819 else if (hsm->debug_level > 1)
820 clib_warning ("LRU delete '%s' ok", dp->filename);
822 lru_remove (hsm, dp);
823 hsm->cache_size -= vec_len (dp->data);
824 hsm->cache_evictions++;
825 vec_free (dp->filename);
827 if (hsm->debug_level > 1)
828 clib_warning ("pool put index %d", dp - hsm->cache_pool);
829 pool_put (hsm->cache_pool, dp);
830 if (hsm->cache_size < hsm->cache_limit)
836 error = clib_file_contents ((char *) (hs->path), &hs->data);
839 clib_warning ("Error reading '%s'", hs->path);
840 clib_error_report (error);
845 /* Create a cache entry for it */
846 pool_get (hsm->cache_pool, dp);
847 memset (dp, 0, sizeof (*dp));
848 dp->filename = vec_dup (hs->path);
850 hs->cache_pool_index = dp - hsm->cache_pool;
852 if (hsm->debug_level > 1)
853 clib_warning ("index %d refcnt now %d", hs->cache_pool_index,
855 lru_add (hsm, dp, vlib_time_now (vlib_get_main ()));
856 kv.key = (u64) vec_dup (hs->path);
857 kv.value = dp - hsm->cache_pool;
858 /* Add to the lookup table */
859 if (hsm->debug_level > 1)
860 clib_warning ("add '%s' value %lld", kv.key, kv.value);
862 if (BV (clib_bihash_add_del) (&hsm->name_to_data, &kv,
863 1 /* is_add */ ) < 0)
865 clib_warning ("BUG: add failed!");
867 hsm->cache_size += vec_len (dp->data);
871 /* send 200 OK first */
873 static_send_data (hs, (u8 *) "HTTP/1.1 200 OK\r\n", 17, 0);
874 hs->session_state = HTTP_STATE_OK_SENT;
879 state_send_more_data (session_t * s, http_session_t * hs,
880 http_state_machine_called_from_t cf)
883 /* Start sending data */
884 hs->data_offset = static_send_data (hs, hs->data, vec_len (hs->data),
888 if (hs->data_offset < vec_len (hs->data))
890 /* No: ask for a shoulder-tap when the tx fifo has space */
891 svm_fifo_add_want_deq_ntf (hs->tx_fifo,
892 SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
893 hs->session_state = HTTP_STATE_SEND_MORE_DATA;
896 /* Finished with this transaction, back to HTTP_STATE_ESTABLISHED */
898 /* Let go of the file cache entry */
899 http_static_server_detach_cache_entry (hs);
900 hs->session_state = HTTP_STATE_ESTABLISHED;
905 state_sent_ok (session_t * s, http_session_t * hs,
906 http_state_machine_called_from_t cf)
908 http_static_server_main_t *hsm = &http_static_server_main;
915 /* What kind of dog food are we serving? */
916 suffix = (char *) (hs->path + vec_len (hs->path) - 1);
917 while ((u8 *) suffix >= hs->path && *suffix != '.')
920 http_type = "text/html";
921 if (!clib_strcmp (suffix, "css"))
922 http_type = "text/css";
923 else if (!clib_strcmp (suffix, "js"))
924 http_type = "text/javascript";
925 else if (!clib_strcmp (suffix, "json"))
926 http_type = "application/json";
930 clib_warning ("BUG: hs->data not set for session %d",
937 * Send an http response, which needs the current time,
938 * the expiration time, and the data length
940 now = clib_timebase_now (&hsm->timebase);
941 http_response = format (0, http_response_template,
943 format_clib_timebase_time, now,
945 format_clib_timebase_time, now + 600.0,
946 http_type, vec_len (hs->data));
947 offset = static_send_data (hs, http_response, vec_len (http_response), 0);
948 if (offset != vec_len (http_response))
950 clib_warning ("BUG: couldn't send response header!");
954 vec_free (http_response);
956 /* Send data from the beginning... */
958 hs->session_state = HTTP_STATE_SEND_MORE_DATA;
962 static void *state_funcs[HTTP_STATE_N_STATES] = {
964 /* Waiting for GET, POST, etc. */
969 state_send_more_data,
973 http_static_server_rx_tx_callback (session_t * s,
974 http_state_machine_called_from_t cf)
977 int (*fp) (session_t *, http_session_t *, http_state_machine_called_from_t);
980 /* Acquire a reader lock on the session table */
981 http_static_server_sessions_reader_lock ();
982 hs = http_static_server_session_lookup (s->thread_index, s->session_index);
986 clib_warning ("No http session for thread %d session_index %d",
987 s->thread_index, s->session_index);
988 http_static_server_sessions_reader_unlock ();
992 /* Execute state machine for this session */
995 fp = state_funcs[hs->session_state];
996 rv = (*fp) (s, hs, cf);
1002 /* Reset the session expiration timer */
1003 http_static_server_session_timer_stop (hs);
1004 http_static_server_session_timer_start (hs);
1007 http_static_server_sessions_reader_unlock ();
1012 http_static_server_rx_callback (session_t * s)
1014 return http_static_server_rx_tx_callback (s, CALLED_FROM_RX);
1018 http_static_server_tx_callback (session_t * s)
1020 return http_static_server_rx_tx_callback (s, CALLED_FROM_TX);
1024 /** \brief Session accept callback
1028 http_static_server_session_accept_callback (session_t * s)
1030 http_static_server_main_t *hsm = &http_static_server_main;
1033 hsm->vpp_queue[s->thread_index] =
1034 session_main_get_vpp_event_queue (s->thread_index);
1036 http_static_server_sessions_writer_lock ();
1038 hs = http_static_server_session_alloc (s->thread_index);
1039 http_static_server_session_lookup_add (s->thread_index, s->session_index,
1041 hs->rx_fifo = s->rx_fifo;
1042 hs->tx_fifo = s->tx_fifo;
1043 hs->vpp_session_index = s->session_index;
1044 hs->vpp_session_handle = session_handle (s);
1045 hs->session_state = HTTP_STATE_ESTABLISHED;
1046 http_static_server_session_timer_start (hs);
1048 http_static_server_sessions_writer_unlock ();
1050 s->session_state = SESSION_STATE_READY;
1054 /** \brief Session disconnect callback
1058 http_static_server_session_disconnect_callback (session_t * s)
1060 http_static_server_main_t *hsm = &http_static_server_main;
1061 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
1063 a->handle = session_handle (s);
1064 a->app_index = hsm->app_index;
1065 vnet_disconnect_session (a);
1068 /** \brief Session reset callback
1072 http_static_server_session_reset_callback (session_t * s)
1074 http_static_server_main_t *hsm = &http_static_server_main;
1075 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
1077 a->handle = session_handle (s);
1078 a->app_index = hsm->app_index;
1079 vnet_disconnect_session (a);
1083 http_static_server_session_connected_callback (u32 app_index, u32 api_context,
1084 session_t * s, u8 is_fail)
1086 clib_warning ("called...");
1091 http_static_server_add_segment_callback (u32 client_index, u64 segment_handle)
1093 clib_warning ("called...");
1098 http_static_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
1102 if (ntf == SESSION_CLEANUP_TRANSPORT)
1105 http_static_server_sessions_writer_lock ();
1107 hs = http_static_server_session_lookup (s->thread_index, s->session_index);
1111 http_static_server_detach_cache_entry (hs);
1112 http_static_server_session_lookup_del (hs->thread_index,
1113 hs->vpp_session_index);
1114 vec_free (hs->rx_buf);
1115 http_static_server_session_free (hs);
1118 http_static_server_sessions_writer_unlock ();
1121 /** \brief Session-layer virtual function table
1123 static session_cb_vft_t http_static_server_session_cb_vft = {
1124 .session_accept_callback = http_static_server_session_accept_callback,
1125 .session_disconnect_callback =
1126 http_static_server_session_disconnect_callback,
1127 .session_connected_callback = http_static_server_session_connected_callback,
1128 .add_segment_callback = http_static_server_add_segment_callback,
1129 .builtin_app_rx_callback = http_static_server_rx_callback,
1130 .builtin_app_tx_callback = http_static_server_tx_callback,
1131 .session_reset_callback = http_static_server_session_reset_callback,
1132 .session_cleanup_callback = http_static_session_cleanup,
1136 http_static_server_attach ()
1138 vnet_app_add_tls_cert_args_t _a_cert, *a_cert = &_a_cert;
1139 vnet_app_add_tls_key_args_t _a_key, *a_key = &_a_key;
1140 http_static_server_main_t *hsm = &http_static_server_main;
1141 u64 options[APP_OPTIONS_N_OPTIONS];
1142 vnet_app_attach_args_t _a, *a = &_a;
1143 u32 segment_size = 128 << 20;
1145 clib_memset (a, 0, sizeof (*a));
1146 clib_memset (options, 0, sizeof (options));
1148 if (hsm->private_segment_size)
1149 segment_size = hsm->private_segment_size;
1151 a->api_client_index = ~0;
1152 a->name = format (0, "test_http_static_server");
1153 a->session_cb_vft = &http_static_server_session_cb_vft;
1154 a->options = options;
1155 a->options[APP_OPTIONS_SEGMENT_SIZE] = segment_size;
1156 a->options[APP_OPTIONS_RX_FIFO_SIZE] =
1157 hsm->fifo_size ? hsm->fifo_size : 8 << 10;
1158 a->options[APP_OPTIONS_TX_FIFO_SIZE] =
1159 hsm->fifo_size ? hsm->fifo_size : 32 << 10;
1160 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1161 a->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] = hsm->prealloc_fifos;
1162 a->options[APP_OPTIONS_TLS_ENGINE] = TLS_ENGINE_OPENSSL;
1164 if (vnet_application_attach (a))
1167 clib_warning ("failed to attach server");
1171 hsm->app_index = a->app_index;
1173 clib_memset (a_cert, 0, sizeof (*a_cert));
1174 a_cert->app_index = a->app_index;
1175 vec_validate (a_cert->cert, test_srv_crt_rsa_len);
1176 clib_memcpy_fast (a_cert->cert, test_srv_crt_rsa, test_srv_crt_rsa_len);
1177 vnet_app_add_tls_cert (a_cert);
1179 clib_memset (a_key, 0, sizeof (*a_key));
1180 a_key->app_index = a->app_index;
1181 vec_validate (a_key->key, test_srv_key_rsa_len);
1182 clib_memcpy_fast (a_key->key, test_srv_key_rsa, test_srv_key_rsa_len);
1183 vnet_app_add_tls_key (a_key);
1189 http_static_server_listen ()
1191 http_static_server_main_t *hsm = &http_static_server_main;
1192 vnet_listen_args_t _a, *a = &_a;
1193 clib_memset (a, 0, sizeof (*a));
1194 a->app_index = hsm->app_index;
1195 a->uri = "tcp://0.0.0.0/80";
1197 a->uri = (char *) hsm->uri;
1198 return vnet_bind_uri (a);
1202 http_static_server_session_close_cb (void *hs_handlep)
1204 http_static_server_main_t *hsm = &http_static_server_main;
1207 hs_handle = pointer_to_uword (hs_handlep);
1209 http_static_server_session_get (hs_handle >> 24, hs_handle & 0x00FFFFFF);
1211 if (hsm->debug_level > 1)
1212 clib_warning ("terminate thread %d index %d hs %llx",
1213 hs_handle >> 24, hs_handle & 0x00FFFFFF, hs);
1216 hs->timer_handle = ~0;
1217 http_static_server_session_disconnect (hs);
1220 /** \brief Expired session timer-wheel callback
1223 http_expired_timers_dispatch (u32 * expired_timers)
1228 for (i = 0; i < vec_len (expired_timers); i++)
1230 /* Get session handle. The first bit is the timer id */
1231 hs_handle = expired_timers[i] & 0x7FFFFFFF;
1232 session_send_rpc_evt_to_thread (hs_handle >> 24,
1233 http_static_server_session_close_cb,
1234 uword_to_pointer (hs_handle, void *));
1238 /** \brief Timer-wheel expiration process
1241 http_static_server_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1244 http_static_server_main_t *hsm = &http_static_server_main;
1245 f64 now, timeout = 1.0;
1246 uword *event_data = 0;
1247 uword __clib_unused event_type;
1251 vlib_process_wait_for_event_or_clock (vm, timeout);
1252 now = vlib_time_now (vm);
1253 event_type = vlib_process_get_events (vm, (uword **) & event_data);
1256 clib_spinlock_lock (&http_static_server_main.tw_lock);
1257 tw_timer_expire_timers_2t_1w_2048sl (&hsm->tw, now);
1258 clib_spinlock_unlock (&http_static_server_main.tw_lock);
1260 vec_reset_length (event_data);
1266 VLIB_REGISTER_NODE (http_static_server_process_node) =
1268 .function = http_static_server_process,
1269 .type = VLIB_NODE_TYPE_PROCESS,
1270 .name = "static-http-server-process",
1271 .state = VLIB_NODE_STATE_DISABLED,
1276 http_static_server_create (vlib_main_t * vm)
1278 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1279 http_static_server_main_t *hsm = &http_static_server_main;
1283 num_threads = 1 /* main thread */ + vtm->n_threads;
1284 vec_validate (hsm->vpp_queue, num_threads - 1);
1285 vec_validate (hsm->sessions, num_threads - 1);
1286 vec_validate (hsm->session_to_http_session, num_threads - 1);
1288 clib_rwlock_init (&hsm->sessions_lock);
1289 clib_spinlock_init (&hsm->tw_lock);
1291 if (http_static_server_attach ())
1293 clib_warning ("failed to attach server");
1296 if (http_static_server_listen ())
1298 clib_warning ("failed to start listening");
1302 /* Init path-to-cache hash table */
1303 BV (clib_bihash_init) (&hsm->name_to_data, "http cache", 128, 32 << 20);
1305 hsm->get_url_handlers = hash_create_string (0, sizeof (uword));
1306 hsm->post_url_handlers = hash_create_string (0, sizeof (uword));
1308 /* Init timer wheel and process */
1309 tw_timer_wheel_init_2t_1w_2048sl (&hsm->tw, http_expired_timers_dispatch,
1310 1.0 /* timer interval */ , ~0);
1311 vlib_node_set_state (vm, http_static_server_process_node.index,
1312 VLIB_NODE_STATE_POLLING);
1313 n = vlib_get_node (vm, http_static_server_process_node.index);
1314 vlib_start_process (vm, n->runtime_index);
1319 /** \brief API helper function for vl_api_http_static_enable_t messages
1322 http_static_server_enable_api (u32 fifo_size, u32 cache_limit,
1324 u32 private_segment_size,
1325 u8 * www_root, u8 * uri)
1327 http_static_server_main_t *hsm = &http_static_server_main;
1330 hsm->fifo_size = fifo_size;
1331 hsm->cache_limit = cache_limit;
1332 hsm->prealloc_fifos = prealloc_fifos;
1333 hsm->private_segment_size = private_segment_size;
1334 hsm->www_root = format (0, "%s%c", www_root, 0);
1335 hsm->uri = format (0, "%s%c", uri, 0);
1337 if (vec_len (hsm->www_root) < 2)
1338 return VNET_API_ERROR_INVALID_VALUE;
1340 if (hsm->my_client_index != ~0)
1341 return VNET_API_ERROR_APP_ALREADY_ATTACHED;
1343 vnet_session_enable_disable (hsm->vlib_main, 1 /* turn on TCP, etc. */ );
1345 rv = http_static_server_create (hsm->vlib_main);
1351 vec_free (hsm->www_root);
1352 vec_free (hsm->uri);
1353 return VNET_API_ERROR_INIT_FAILED;
1358 static clib_error_t *
1359 http_static_server_create_command_fn (vlib_main_t * vm,
1360 unformat_input_t * input,
1361 vlib_cli_command_t * cmd)
1363 http_static_server_main_t *hsm = &http_static_server_main;
1364 unformat_input_t _line_input, *line_input = &_line_input;
1369 hsm->prealloc_fifos = 0;
1370 hsm->private_segment_size = 0;
1372 /* 10mb cache limit, before LRU occurs */
1373 hsm->cache_limit = 10 << 20;
1375 /* Get a line of input. */
1376 if (!unformat_user (input, unformat_line_input, line_input))
1379 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1381 if (unformat (line_input, "www-root %s", &www_root))
1384 if (unformat (line_input, "prealloc-fifos %d", &hsm->prealloc_fifos))
1386 else if (unformat (line_input, "private-segment-size %U",
1387 unformat_memory_size, &seg_size))
1389 if (seg_size >= 0x100000000ULL)
1391 vlib_cli_output (vm, "private segment size %llu, too large",
1395 hsm->private_segment_size = seg_size;
1397 else if (unformat (line_input, "fifo-size %d", &hsm->fifo_size))
1398 hsm->fifo_size <<= 10;
1399 else if (unformat (line_input, "cache-size %U", unformat_memory_size,
1402 if (hsm->cache_limit < (128 << 10))
1404 return clib_error_return (0,
1405 "cache-size must be at least 128kb");
1409 else if (unformat (line_input, "uri %s", &hsm->uri))
1411 else if (unformat (line_input, "debug %d", &hsm->debug_level))
1413 else if (unformat (line_input, "debug"))
1414 hsm->debug_level = 1;
1416 return clib_error_return (0, "unknown input `%U'",
1417 format_unformat_error, line_input);
1419 unformat_free (line_input);
1424 return clib_error_return (0, "Must specify www-root <path>");
1427 if (hsm->my_client_index != (u32) ~ 0)
1429 vec_free (www_root);
1430 return clib_error_return (0, "http server already running...");
1433 hsm->www_root = www_root;
1435 vnet_session_enable_disable (vm, 1 /* turn on TCP, etc. */ );
1437 rv = http_static_server_create (vm);
1443 vec_free (hsm->www_root);
1444 return clib_error_return (0, "server_create returned %d", rv);
1450 * Enable the static http server
1453 * This command enables the static http server. Only the www-root
1454 * parameter is required
1456 * http static server www-root /tmp/www uri tcp://0.0.0.0/80 cache-size 2m
1458 * @cliexcmd{http static server www-root <path> [prealloc-fios <nn>]
1459 * [private-segment-size <nnMG>] [fifo-size <nbytes>] [uri <uri>]}
1462 VLIB_CLI_COMMAND (http_static_server_create_command, static) =
1464 .path = "http static server",
1465 .short_help = "http static server www-root <path> [prealloc-fifos <nn>]\n"
1466 "[private-segment-size <nnMG>] [fifo-size <nbytes>] [uri <uri>]\n"
1468 .function = http_static_server_create_command_fn,
1472 /** \brief format a file cache entry
1475 format_hsm_cache_entry (u8 * s, va_list * args)
1477 file_data_cache_t *ep = va_arg (*args, file_data_cache_t *);
1478 f64 now = va_arg (*args, f64);
1483 s = format (s, "%40s%12s%20s", "File", "Size", "Age");
1486 s = format (s, "%40s%12lld%20.2f", ep->filename, vec_len (ep->data),
1487 now - ep->last_used);
1492 format_http_session_state (u8 * s, va_list * args)
1494 http_session_state_t state = va_arg (*args, http_session_state_t);
1495 char *state_string = "bogus!";
1499 case HTTP_STATE_CLOSED:
1500 state_string = "closed";
1502 case HTTP_STATE_ESTABLISHED:
1503 state_string = "established";
1505 case HTTP_STATE_OK_SENT:
1506 state_string = "ok sent";
1508 case HTTP_STATE_SEND_MORE_DATA:
1509 state_string = "send more data";
1515 return format (s, "%s", state_string);
1519 format_http_session (u8 * s, va_list * args)
1521 http_session_t *hs = va_arg (*args, http_session_t *);
1522 int verbose = va_arg (*args, int);
1524 s = format (s, "[%d]: state %U", hs->session_index,
1525 format_http_session_state, hs->session_state);
1528 s = format (s, "\n path %s, data length %u, data_offset %u",
1529 hs->path ? hs->path : (u8 *) "[none]",
1530 vec_len (hs->data), hs->data_offset);
1535 static clib_error_t *
1536 http_show_static_server_command_fn (vlib_main_t * vm,
1537 unformat_input_t * input,
1538 vlib_cli_command_t * cmd)
1540 http_static_server_main_t *hsm = &http_static_server_main;
1541 file_data_cache_t *ep, **entries = 0;
1544 int show_sessions = 0;
1548 if (hsm->www_root == 0)
1549 return clib_error_return (0, "Static server disabled");
1551 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1553 if (unformat (input, "verbose %d", &verbose))
1555 else if (unformat (input, "verbose"))
1557 else if (unformat (input, "cache"))
1559 else if (unformat (input, "sessions"))
1565 if ((show_cache + show_sessions) == 0)
1566 return clib_error_return (0, "specify one or more of cache, sessions");
1573 (vm, "www_root %s, cache size %lld bytes, limit %lld bytes, "
1575 hsm->www_root, hsm->cache_size, hsm->cache_limit,
1576 hsm->cache_evictions);
1580 now = vlib_time_now (vm);
1582 vlib_cli_output (vm, "%U", format_hsm_cache_entry, 0 /* header */ ,
1585 for (index = hsm->first_index; index != ~0;)
1587 ep = pool_elt_at_index (hsm->cache_pool, index);
1588 index = ep->next_index;
1589 vlib_cli_output (vm, "%U", format_hsm_cache_entry, ep, now);
1592 vlib_cli_output (vm, "%40s%12lld", "Total Size", hsm->cache_size);
1599 u32 *session_indices = 0;
1603 http_static_server_sessions_reader_lock ();
1605 for (i = 0; i < vec_len (hsm->sessions); i++)
1608 pool_foreach (hs, hsm->sessions[i],
1610 vec_add1 (session_indices, hs - hsm->sessions[i]);
1614 for (j = 0; j < vec_len (session_indices); j++)
1616 vlib_cli_output (vm, "%U", format_http_session,
1618 (hsm->sessions[i], session_indices[j]),
1621 vec_reset_length (session_indices);
1623 http_static_server_sessions_reader_unlock ();
1624 vec_free (session_indices);
1630 * Display static http server cache statistics
1633 * This command shows the contents of the static http server cache
1635 * show http static server
1637 * @cliexcmd{show http static server sessions cache [verbose [nn]]}
1640 VLIB_CLI_COMMAND (http_show_static_server_command, static) =
1642 .path = "show http static server",
1643 .short_help = "show http static server sessions cache [verbose [<nn>]]",
1644 .function = http_show_static_server_command_fn,
1648 static clib_error_t *
1649 http_static_server_main_init (vlib_main_t * vm)
1651 http_static_server_main_t *hsm = &http_static_server_main;
1653 hsm->my_client_index = ~0;
1654 hsm->vlib_main = vm;
1655 hsm->first_index = hsm->last_index = ~0;
1657 clib_timebase_init (&hsm->timebase, 0 /* GMT */ ,
1658 CLIB_TIMEBASE_DAYLIGHT_NONE);
1663 VLIB_INIT_FUNCTION (http_static_server_main_init);
1666 * fd.io coding-style-patch-verification: ON
1669 * eval: (c-set-style "gnu")