2 * Copyright (c) 2022 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 <http/http.h>
17 #include <vnet/session/session.h>
18 #include <http/http_timer.h>
20 static http_main_t http_main;
22 #define HTTP_FIFO_THRESH (16 << 10)
23 #define CONTENT_LEN_STR "Content-Length: "
25 /* HTTP state machine result */
26 typedef enum http_sm_result_t_
33 const char *http_status_code_str[] = {
34 #define _(c, s, str) str,
35 foreach_http_status_code
39 const char *http_content_type_str[] = {
40 #define _(s, ext, str) str,
41 foreach_http_content_type
45 const http_buffer_type_t msg_to_buf_type[] = {
46 [HTTP_MSG_DATA_INLINE] = HTTP_BUFFER_FIFO,
47 [HTTP_MSG_DATA_PTR] = HTTP_BUFFER_PTR,
51 format_http_state (u8 *s, va_list *va)
53 http_state_t state = va_arg (*va, http_state_t);
58 return format (s, "idle");
59 case HTTP_STATE_WAIT_APP_METHOD:
60 return format (s, "wait app method");
61 case HTTP_STATE_WAIT_SERVER_REPLY:
62 return format (s, "wait server reply");
63 case HTTP_STATE_CLIENT_IO_MORE_DATA:
64 return format (s, "client io more data");
65 case HTTP_STATE_WAIT_CLIENT_METHOD:
66 return format (s, "wait client method");
67 case HTTP_STATE_WAIT_APP_REPLY:
68 return format (s, "wait app reply");
69 case HTTP_STATE_APP_IO_MORE_DATA:
70 return format (s, "app io more data");
74 return format (s, "unknown");
77 #define http_state_change(_hc, _state) \
80 HTTP_DBG (1, "changing http state %U -> %U", format_http_state, \
81 (_hc)->http_state, format_http_state, _state); \
82 (_hc)->http_state = _state; \
86 static inline http_worker_t *
87 http_worker_get (u32 thread_index)
89 return &http_main.wrk[thread_index];
93 http_conn_alloc_w_thread (u32 thread_index)
95 http_worker_t *wrk = http_worker_get (thread_index);
98 pool_get_aligned_safe (wrk->conn_pool, hc, CLIB_CACHE_LINE_BYTES);
99 clib_memset (hc, 0, sizeof (*hc));
100 hc->c_thread_index = thread_index;
101 hc->h_hc_index = hc - wrk->conn_pool;
102 hc->h_pa_session_handle = SESSION_INVALID_HANDLE;
103 hc->h_tc_session_handle = SESSION_INVALID_HANDLE;
104 return hc->h_hc_index;
107 static inline http_conn_t *
108 http_conn_get_w_thread (u32 hc_index, u32 thread_index)
110 http_worker_t *wrk = http_worker_get (thread_index);
111 return pool_elt_at_index (wrk->conn_pool, hc_index);
115 http_conn_free (http_conn_t *hc)
117 http_worker_t *wrk = http_worker_get (hc->c_thread_index);
118 pool_put (wrk->conn_pool, hc);
122 http_listener_alloc (void)
124 http_main_t *hm = &http_main;
127 pool_get_zero (hm->listener_pool, lhc);
128 lhc->c_c_index = lhc - hm->listener_pool;
129 return lhc->c_c_index;
133 http_listener_get (u32 lhc_index)
135 return pool_elt_at_index (http_main.listener_pool, lhc_index);
139 http_listener_free (http_conn_t *lhc)
141 http_main_t *hm = &http_main;
144 memset (lhc, 0xfc, sizeof (*lhc));
145 pool_put (hm->listener_pool, lhc);
149 http_disconnect_transport (http_conn_t *hc)
151 vnet_disconnect_args_t a = {
152 .handle = hc->h_tc_session_handle,
153 .app_index = http_main.app_index,
156 hc->state = HTTP_CONN_STATE_CLOSED;
158 if (vnet_disconnect_session (&a))
159 clib_warning ("disconnect returned");
163 http_conn_timeout_cb (void *hc_handlep)
168 hs_handle = pointer_to_uword (hc_handlep);
169 hc = http_conn_get_w_thread (hs_handle & 0x00FFFFFF, hs_handle >> 24);
171 HTTP_DBG (1, "terminate thread %d index %d hs %llx", hs_handle >> 24,
172 hs_handle & 0x00FFFFFF, hc);
176 hc->timer_handle = ~0;
177 session_transport_closing_notify (&hc->connection);
178 http_disconnect_transport (hc);
182 http_ts_accept_callback (session_t *ts)
184 session_t *ts_listener, *as, *asl;
185 app_worker_t *app_wrk;
186 http_conn_t *lhc, *hc;
187 u32 hc_index, thresh;
190 ts_listener = listen_session_get_from_handle (ts->listener_handle);
191 lhc = http_listener_get (ts_listener->opaque);
193 hc_index = http_conn_alloc_w_thread (ts->thread_index);
194 hc = http_conn_get_w_thread (hc_index, ts->thread_index);
195 clib_memcpy_fast (hc, lhc, sizeof (*lhc));
196 hc->c_thread_index = ts->thread_index;
197 hc->h_hc_index = hc_index;
199 hc->h_tc_session_handle = session_handle (ts);
200 hc->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
202 hc->state = HTTP_CONN_STATE_ESTABLISHED;
203 http_state_change (hc, HTTP_STATE_WAIT_CLIENT_METHOD);
205 ts->session_state = SESSION_STATE_READY;
206 ts->opaque = hc_index;
209 * Alloc session and initialize
211 as = session_alloc (hc->c_thread_index);
212 hc->c_s_index = as->session_index;
214 as->app_wrk_index = hc->h_pa_wrk_index;
215 as->connection_index = hc->c_c_index;
216 as->session_state = SESSION_STATE_ACCEPTING;
218 asl = listen_session_get_from_handle (lhc->h_pa_session_handle);
219 as->session_type = asl->session_type;
220 as->listener_handle = lhc->h_pa_session_handle;
223 * Init session fifos and notify app
225 if ((rv = app_worker_init_accepted (as)))
227 HTTP_DBG (1, "failed to allocate fifos");
232 hc->h_pa_session_handle = session_handle (as);
233 hc->h_pa_wrk_index = as->app_wrk_index;
234 app_wrk = app_worker_get (as->app_wrk_index);
236 HTTP_DBG (1, "Accepted on listener %u new connection [%u]%x",
237 ts_listener->opaque, vlib_get_thread_index (), hc_index);
239 if ((rv = app_worker_accept_notify (app_wrk, as)))
241 HTTP_DBG (0, "app accept returned");
246 /* Avoid enqueuing small chunks of data on transport tx notifications. If
247 * the fifo is small (under 16K) we set the threshold to it's size, meaning
248 * a notification will be given when the fifo empties.
250 ts = session_get_from_handle (hc->h_tc_session_handle);
251 thresh = clib_min (svm_fifo_size (ts->tx_fifo), HTTP_FIFO_THRESH);
252 svm_fifo_set_deq_thresh (ts->tx_fifo, thresh);
254 http_conn_timer_start (hc);
260 http_ts_connected_callback (u32 http_app_index, u32 ho_hc_index, session_t *ts,
265 http_conn_t *hc, *ho_hc;
266 app_worker_t *app_wrk;
271 clib_warning ("ERROR: %d", err);
275 new_hc_index = http_conn_alloc_w_thread (ts->thread_index);
276 hc = http_conn_get_w_thread (new_hc_index, ts->thread_index);
277 ho_hc = http_conn_get_w_thread (ho_hc_index, 0);
279 ASSERT (ho_hc->state == HTTP_CONN_STATE_CONNECTING);
281 clib_memcpy_fast (hc, ho_hc, sizeof (*hc));
283 hc->c_thread_index = ts->thread_index;
284 hc->h_tc_session_handle = session_handle (ts);
285 hc->c_c_index = new_hc_index;
286 hc->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
287 hc->state = HTTP_CONN_STATE_ESTABLISHED;
288 http_state_change (hc, HTTP_STATE_WAIT_APP_METHOD);
290 ts->session_state = SESSION_STATE_READY;
291 ts->opaque = new_hc_index;
293 /* allocate app session and initialize */
295 as = session_alloc (hc->c_thread_index);
296 hc->c_s_index = as->session_index;
297 as->connection_index = hc->c_c_index;
298 as->app_wrk_index = hc->h_pa_wrk_index;
299 as->session_state = SESSION_STATE_READY;
300 as->opaque = hc->h_pa_app_api_ctx;
301 as->session_type = session_type_from_proto_and_ip (
302 TRANSPORT_PROTO_HTTP, session_type_is_ip4 (ts->session_type));
304 HTTP_DBG (1, "half-open hc index %d, hc index %d", ho_hc_index,
307 app_wrk = app_worker_get (hc->h_pa_wrk_index);
310 clib_warning ("no app worker");
314 if ((rv = app_worker_init_connected (app_wrk, as)))
316 HTTP_DBG (1, "failed to allocate fifos");
320 app_worker_connect_notify (app_wrk, as, err, hc->h_pa_app_api_ctx);
321 hc->h_pa_session_handle = session_handle (as);
322 http_conn_timer_start (hc);
328 http_ts_disconnect_callback (session_t *ts)
332 hc = http_conn_get_w_thread (ts->opaque, ts->thread_index);
334 if (hc->state < HTTP_CONN_STATE_TRANSPORT_CLOSED)
335 hc->state = HTTP_CONN_STATE_TRANSPORT_CLOSED;
337 /* Nothing more to rx, propagate to app */
338 if (!svm_fifo_max_dequeue_cons (ts->rx_fifo))
339 session_transport_closing_notify (&hc->connection);
343 http_ts_reset_callback (session_t *ts)
347 hc = http_conn_get_w_thread (ts->opaque, ts->thread_index);
349 hc->state = HTTP_CONN_STATE_CLOSED;
350 http_buffer_free (&hc->tx_buf);
351 http_state_change (hc, HTTP_STATE_WAIT_CLIENT_METHOD);
352 session_transport_reset_notify (&hc->connection);
354 http_disconnect_transport (hc);
358 * http error boilerplate
360 static const char *http_error_template = "HTTP/1.1 %s\r\n"
362 "Content-Type: text/html\r\n"
363 "Connection: close\r\n"
364 "Pragma: no-cache\r\n"
365 "Content-Length: 0\r\n\r\n";
367 static const char *http_redirect_template = "HTTP/1.1 %s\r\n";
370 * http response boilerplate
372 static const char *http_response_template = "HTTP/1.1 %s\r\n"
374 "Expires: %U GMT\r\n"
375 "Server: VPP Static\r\n"
376 "Content-Type: %s\r\n"
377 "Content-Length: %lu\r\n\r\n";
379 static const char *http_request_template = "GET %s HTTP/1.1\r\n"
380 "User-Agent: VPP HTTP client\r\n"
384 http_send_data (http_conn_t *hc, u8 *data, u32 length, u32 offset)
386 const u32 max_burst = 64 << 10;
391 ts = session_get_from_handle (hc->h_tc_session_handle);
393 to_send = clib_min (length - offset, max_burst);
394 sent = svm_fifo_enqueue (ts->tx_fifo, to_send, data + offset);
399 if (svm_fifo_set_event (ts->tx_fifo))
400 session_send_io_evt_to_thread (ts->tx_fifo, SESSION_IO_EVT_TX);
402 return (offset + sent);
406 http_send_error (http_conn_t *hc, http_status_code_t ec)
408 http_main_t *hm = &http_main;
412 if (ec >= HTTP_N_STATUS)
413 ec = HTTP_STATUS_INTERNAL_ERROR;
415 now = clib_timebase_now (&hm->timebase);
416 data = format (0, http_error_template, http_status_code_str[ec],
417 format_clib_timebase_time, now);
418 http_send_data (hc, data, vec_len (data), 0);
423 http_read_message (http_conn_t *hc)
425 u32 max_deq, cursize;
429 ts = session_get_from_handle (hc->h_tc_session_handle);
431 cursize = vec_len (hc->rx_buf);
432 max_deq = svm_fifo_max_dequeue (ts->rx_fifo);
433 if (PREDICT_FALSE (max_deq == 0))
436 vec_validate (hc->rx_buf, cursize + max_deq - 1);
437 n_read = svm_fifo_dequeue (ts->rx_fifo, max_deq, hc->rx_buf + cursize);
438 ASSERT (n_read == max_deq);
440 if (svm_fifo_is_empty (ts->rx_fifo))
441 svm_fifo_unset_event (ts->rx_fifo);
443 vec_set_len (hc->rx_buf, cursize + n_read);
448 v_find_index (u8 *vec, u32 offset, char *str)
450 int start_index = offset;
451 u32 slen = (u32) strnlen_s_inline (str, 16);
452 u32 vlen = vec_len (vec);
459 for (; start_index < (vlen - slen); start_index++)
461 if (!memcmp (vec + start_index, str, slen))
469 http_parse_header (http_conn_t *hc, int *content_length)
471 unformat_input_t input;
475 i = v_find_index (hc->rx_buf, hc->rx_buf_offset, CONTENT_LEN_STR);
478 clib_warning ("cannot find '%s' in the header!", CONTENT_LEN_STR);
482 hc->rx_buf_offset = i;
484 i = v_find_index (hc->rx_buf, hc->rx_buf_offset, "\n");
487 clib_warning ("end of line missing; incomplete data");
491 len = i - hc->rx_buf_offset;
492 line = vec_new (u8, len);
493 clib_memcpy (line, hc->rx_buf + hc->rx_buf_offset, len);
495 unformat_init_vector (&input, line);
496 if (!unformat (&input, CONTENT_LEN_STR "%d", content_length))
498 clib_warning ("failed to unformat content length!");
501 unformat_free (&input);
503 /* skip rest of the header */
504 hc->rx_buf_offset += len;
505 i = v_find_index (hc->rx_buf, hc->rx_buf_offset, "<html>");
508 clib_warning ("<html> tag not found");
511 hc->rx_buf_offset = i;
516 static http_sm_result_t
517 http_state_wait_server_reply (http_conn_t *hc, transport_send_params_t *sp)
519 int i, rv, content_length;
521 app_worker_t *app_wrk;
523 http_status_code_t ec;
525 rv = http_read_message (hc);
527 /* Nothing yet, wait for data or timer expire */
531 if (vec_len (hc->rx_buf) < 8)
533 ec = HTTP_STATUS_BAD_REQUEST;
537 if ((i = v_find_index (hc->rx_buf, 0, "200 OK")) >= 0)
539 msg.type = HTTP_MSG_REPLY;
540 msg.content_type = HTTP_CONTENT_TEXT_HTML;
541 msg.code = HTTP_STATUS_OK;
542 msg.data.type = HTTP_MSG_DATA_INLINE;
545 rv = http_parse_header (hc, &content_length);
548 clib_warning ("failed to parse http reply");
549 session_transport_closing_notify (&hc->connection);
550 http_disconnect_transport (hc);
553 msg.data.len = content_length;
554 u32 dlen = vec_len (hc->rx_buf) - hc->rx_buf_offset;
555 as = session_get_from_handle (hc->h_pa_session_handle);
556 svm_fifo_seg_t segs[2] = { { (u8 *) &msg, sizeof (msg) },
557 { &hc->rx_buf[hc->rx_buf_offset], dlen } };
559 rv = svm_fifo_enqueue_segments (as->rx_fifo, segs, 2,
560 0 /* allow partial */);
563 clib_warning ("error enqueue");
564 return HTTP_SM_ERROR;
567 hc->rx_buf_offset += dlen;
568 hc->to_recv = content_length - dlen;
570 if (hc->rx_buf_offset == vec_len (hc->rx_buf))
572 vec_reset_length (hc->rx_buf);
573 hc->rx_buf_offset = 0;
576 if (hc->to_recv == 0)
578 hc->rx_buf_offset = 0;
579 vec_reset_length (hc->rx_buf);
580 http_state_change (hc, HTTP_STATE_WAIT_APP_METHOD);
584 http_state_change (hc, HTTP_STATE_CLIENT_IO_MORE_DATA);
587 app_wrk = app_worker_get_if_valid (as->app_wrk_index);
589 app_worker_rx_notify (app_wrk, as);
594 HTTP_DBG (0, "Unknown http method %v", hc->rx_buf);
595 ec = HTTP_STATUS_METHOD_NOT_ALLOWED;
601 http_send_error (hc, ec);
602 session_transport_closing_notify (&hc->connection);
603 http_disconnect_transport (hc);
605 return HTTP_SM_ERROR;
608 static http_sm_result_t
609 http_state_wait_client_method (http_conn_t *hc, transport_send_params_t *sp)
611 http_status_code_t ec;
612 app_worker_t *app_wrk;
619 rv = http_read_message (hc);
621 /* Nothing yet, wait for data or timer expire */
625 if (vec_len (hc->rx_buf) < 8)
627 ec = HTTP_STATUS_BAD_REQUEST;
631 if ((i = v_find_index (hc->rx_buf, 0, "GET ")) >= 0)
633 hc->method = HTTP_REQ_GET;
634 hc->rx_buf_offset = i + 5;
636 i = v_find_index (hc->rx_buf, hc->rx_buf_offset, "HTTP");
639 ec = HTTP_STATUS_BAD_REQUEST;
643 HTTP_DBG (0, "GET method %v", hc->rx_buf);
644 len = i - hc->rx_buf_offset - 1;
646 else if ((i = v_find_index (hc->rx_buf, 0, "POST ")) >= 0)
648 hc->method = HTTP_REQ_POST;
649 hc->rx_buf_offset = i + 6;
650 len = vec_len (hc->rx_buf) - hc->rx_buf_offset - 1;
651 HTTP_DBG (0, "POST method %v", hc->rx_buf);
655 HTTP_DBG (0, "Unknown http method %v", hc->rx_buf);
656 ec = HTTP_STATUS_METHOD_NOT_ALLOWED;
660 buf = &hc->rx_buf[hc->rx_buf_offset];
662 msg.type = HTTP_MSG_REQUEST;
663 msg.method_type = hc->method;
664 msg.content_type = HTTP_CONTENT_TEXT_HTML;
665 msg.data.type = HTTP_MSG_DATA_INLINE;
668 svm_fifo_seg_t segs[2] = { { (u8 *) &msg, sizeof (msg) }, { buf, len } };
670 as = session_get_from_handle (hc->h_pa_session_handle);
671 rv = svm_fifo_enqueue_segments (as->rx_fifo, segs, 2, 0 /* allow partial */);
672 if (rv < 0 || rv != sizeof (msg) + len)
674 clib_warning ("failed app enqueue");
675 /* This should not happen as we only handle 1 request per session,
676 * and fifo is allocated, but going forward we should consider
678 return HTTP_SM_ERROR;
681 vec_free (hc->rx_buf);
682 http_state_change (hc, HTTP_STATE_WAIT_APP_REPLY);
684 app_wrk = app_worker_get_if_valid (as->app_wrk_index);
686 app_worker_rx_notify (app_wrk, as);
692 http_send_error (hc, ec);
693 session_transport_closing_notify (&hc->connection);
694 http_disconnect_transport (hc);
696 return HTTP_SM_ERROR;
699 static http_sm_result_t
700 http_state_wait_app_reply (http_conn_t *hc, transport_send_params_t *sp)
702 http_main_t *hm = &http_main;
707 http_status_code_t sc;
711 as = session_get_from_handle (hc->h_pa_session_handle);
713 rv = svm_fifo_dequeue (as->tx_fifo, sizeof (msg), (u8 *) &msg);
714 ASSERT (rv == sizeof (msg));
716 if (msg.data.type > HTTP_MSG_DATA_PTR)
718 clib_warning ("no data");
719 sc = HTTP_STATUS_INTERNAL_ERROR;
723 if (msg.type != HTTP_MSG_REPLY)
725 clib_warning ("unexpected message type %d", msg.type);
726 sc = HTTP_STATUS_INTERNAL_ERROR;
730 http_buffer_init (&hc->tx_buf, msg_to_buf_type[msg.data.type], as->tx_fifo,
734 * Add headers. For now:
740 now = clib_timebase_now (&hm->timebase);
746 format (0, http_response_template, http_status_code_str[msg.code],
748 format_clib_timebase_time, now,
750 format_clib_timebase_time, now + 600.0,
752 http_content_type_str[msg.content_type],
756 case HTTP_STATUS_MOVED:
758 format (0, http_redirect_template, http_status_code_str[msg.code]);
759 /* Location: http(s)://new-place already queued up as data */
762 return HTTP_SM_ERROR;
765 offset = http_send_data (hc, header, vec_len (header), 0);
766 if (offset != vec_len (header))
768 clib_warning ("couldn't send response header!");
769 sc = HTTP_STATUS_INTERNAL_ERROR;
775 /* Start sending the actual data */
776 http_state_change (hc, HTTP_STATE_APP_IO_MORE_DATA);
778 ASSERT (sp->max_burst_size >= offset);
779 sp->max_burst_size -= offset;
780 return HTTP_SM_CONTINUE;
783 clib_warning ("unexpected msg type from app %u", msg.type);
784 http_send_error (hc, sc);
785 http_state_change (hc, HTTP_STATE_WAIT_CLIENT_METHOD);
786 session_transport_closing_notify (&hc->connection);
787 http_disconnect_transport (hc);
791 static http_sm_result_t
792 http_state_wait_app_method (http_conn_t *hc, transport_send_params_t *sp)
796 u8 *buf = 0, *request;
800 as = session_get_from_handle (hc->h_pa_session_handle);
802 rv = svm_fifo_dequeue (as->tx_fifo, sizeof (msg), (u8 *) &msg);
803 ASSERT (rv == sizeof (msg));
805 if (msg.data.type > HTTP_MSG_DATA_PTR)
807 clib_warning ("no data");
811 if (msg.type != HTTP_MSG_REQUEST)
813 clib_warning ("unexpected message type %d", msg.type);
817 vec_validate (buf, msg.data.len - 1);
818 rv = svm_fifo_dequeue (as->tx_fifo, msg.data.len, buf);
819 ASSERT (rv == msg.data.len);
821 request = format (0, http_request_template, buf);
822 offset = http_send_data (hc, request, vec_len (request), 0);
823 if (offset != vec_len (request))
825 clib_warning ("sending request failed!");
829 http_state_change (hc, HTTP_STATE_WAIT_SERVER_REPLY);
837 session_transport_closing_notify (&hc->connection);
838 http_disconnect_transport (hc);
839 return HTTP_SM_ERROR;
842 static http_sm_result_t
843 http_state_client_io_more_data (http_conn_t *hc, transport_send_params_t *sp)
846 app_worker_t *app_wrk;
847 svm_fifo_seg_t _seg, *seg = &_seg;
848 u32 max_len, max_deq, max_enq, n_segs = 1;
851 as = session_get_from_handle (hc->h_pa_session_handle);
852 ts = session_get_from_handle (hc->h_tc_session_handle);
854 max_deq = svm_fifo_max_dequeue (ts->rx_fifo);
857 HTTP_DBG (1, "no data to deq");
861 max_enq = svm_fifo_max_enqueue (as->rx_fifo);
864 HTTP_DBG (1, "app's rx fifo full");
865 svm_fifo_add_want_deq_ntf (as->rx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
869 max_len = clib_min (max_enq, max_deq);
870 len = svm_fifo_segments (ts->rx_fifo, 0, seg, &n_segs, max_len);
873 HTTP_DBG (1, "svm_fifo_segments() len %d", len);
877 rv = svm_fifo_enqueue_segments (as->rx_fifo, seg, 1, 0 /* allow partial */);
880 clib_warning ("data enqueue failed, rv: %d", rv);
881 return HTTP_SM_ERROR;
884 svm_fifo_dequeue_drop (ts->rx_fifo, rv);
885 if (rv > hc->to_recv)
887 clib_warning ("http protocol error: received more data than expected");
888 session_transport_closing_notify (&hc->connection);
889 http_disconnect_transport (hc);
890 http_state_change (hc, HTTP_STATE_WAIT_APP_METHOD);
891 return HTTP_SM_ERROR;
894 HTTP_DBG (1, "drained %d from ts; remains %d", rv, hc->to_recv);
896 app_wrk = app_worker_get_if_valid (as->app_wrk_index);
898 app_worker_rx_notify (app_wrk, as);
900 if (svm_fifo_max_dequeue_cons (ts->rx_fifo))
901 session_enqueue_notify (ts);
906 static http_sm_result_t
907 http_state_app_io_more_data (http_conn_t *hc, transport_send_params_t *sp)
909 u32 max_send = 64 << 10, n_segs;
910 http_buffer_t *hb = &hc->tx_buf;
915 max_send = clib_min (max_send, sp->max_burst_size);
916 ts = session_get_from_handle (hc->h_tc_session_handle);
917 if ((seg = http_buffer_get_segs (hb, max_send, &n_segs)))
918 sent = svm_fifo_enqueue_segments (ts->tx_fifo, seg, n_segs,
919 1 /* allow partial */);
923 /* Ask scheduler to notify app of deq event if needed */
924 sp->bytes_dequeued += http_buffer_drain (hb, sent);
925 sp->max_burst_size -= sent;
928 /* Not finished sending all data */
929 if (!http_buffer_is_drained (hb))
931 if (sent && svm_fifo_set_event (ts->tx_fifo))
932 session_send_io_evt_to_thread (ts->tx_fifo, SESSION_IO_EVT_TX);
934 if (svm_fifo_max_enqueue (ts->tx_fifo) < HTTP_FIFO_THRESH)
936 /* Deschedule http session and wait for deq notification if
937 * underlying ts tx fifo almost full */
938 svm_fifo_add_want_deq_ntf (ts->tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
939 transport_connection_deschedule (&hc->connection);
940 sp->flags |= TRANSPORT_SND_F_DESCHED;
945 if (sent && svm_fifo_set_event (ts->tx_fifo))
946 session_send_io_evt_to_thread (ts->tx_fifo, SESSION_IO_EVT_TX_FLUSH);
948 /* Finished transaction, back to HTTP_STATE_WAIT_METHOD */
949 http_state_change (hc, HTTP_STATE_WAIT_CLIENT_METHOD);
950 http_buffer_free (&hc->tx_buf);
956 typedef http_sm_result_t (*http_sm_handler) (http_conn_t *,
957 transport_send_params_t *sp);
959 static http_sm_handler state_funcs[HTTP_N_STATES] = {
961 http_state_wait_app_method,
962 http_state_wait_client_method,
963 http_state_wait_server_reply,
964 http_state_wait_app_reply,
965 http_state_client_io_more_data,
966 http_state_app_io_more_data,
970 http_req_run_state_machine (http_conn_t *hc, transport_send_params_t *sp)
972 http_sm_result_t res;
976 res = state_funcs[hc->http_state](hc, sp);
977 if (res == HTTP_SM_ERROR)
979 HTTP_DBG (1, "error in state machine %d", res);
983 while (res == HTTP_SM_CONTINUE);
985 /* Reset the session expiration timer */
986 http_conn_timer_update (hc);
990 http_ts_rx_callback (session_t *ts)
994 hc = http_conn_get_w_thread (ts->opaque, ts->thread_index);
997 clib_warning ("http connection not found (ts %d)", ts->opaque);
1001 if (hc->state == HTTP_CONN_STATE_CLOSED)
1003 svm_fifo_dequeue_drop_all (ts->tx_fifo);
1007 http_req_run_state_machine (hc, 0);
1009 if (hc->state == HTTP_CONN_STATE_TRANSPORT_CLOSED)
1011 if (!svm_fifo_max_dequeue_cons (ts->rx_fifo))
1012 session_transport_closing_notify (&hc->connection);
1018 http_ts_builtin_tx_callback (session_t *ts)
1022 hc = http_conn_get_w_thread (ts->opaque, ts->thread_index);
1023 transport_connection_reschedule (&hc->connection);
1029 http_ts_cleanup_callback (session_t *ts, session_cleanup_ntf_t ntf)
1033 if (ntf == SESSION_CLEANUP_TRANSPORT)
1036 hc = http_conn_get_w_thread (ts->opaque, ts->thread_index);
1039 clib_warning ("no http connection for %u", ts->session_index);
1043 vec_free (hc->rx_buf);
1045 http_buffer_free (&hc->tx_buf);
1046 http_conn_timer_stop (hc);
1048 session_transport_delete_notify (&hc->connection);
1049 http_conn_free (hc);
1053 http_add_segment_callback (u32 client_index, u64 segment_handle)
1055 /* No-op for builtin */
1060 http_del_segment_callback (u32 client_index, u64 segment_handle)
1065 static session_cb_vft_t http_app_cb_vft = {
1066 .session_accept_callback = http_ts_accept_callback,
1067 .session_disconnect_callback = http_ts_disconnect_callback,
1068 .session_connected_callback = http_ts_connected_callback,
1069 .session_reset_callback = http_ts_reset_callback,
1070 .session_cleanup_callback = http_ts_cleanup_callback,
1071 .add_segment_callback = http_add_segment_callback,
1072 .del_segment_callback = http_del_segment_callback,
1073 .builtin_app_rx_callback = http_ts_rx_callback,
1074 .builtin_app_tx_callback = http_ts_builtin_tx_callback,
1077 static clib_error_t *
1078 http_transport_enable (vlib_main_t *vm, u8 is_en)
1080 vnet_app_detach_args_t _da, *da = &_da;
1081 vnet_app_attach_args_t _a, *a = &_a;
1082 u64 options[APP_OPTIONS_N_OPTIONS];
1083 http_main_t *hm = &http_main;
1087 da->app_index = hm->app_index;
1088 da->api_client_index = APP_INVALID_INDEX;
1089 vnet_application_detach (da);
1093 vec_validate (hm->wrk, vlib_num_workers ());
1095 clib_memset (a, 0, sizeof (*a));
1096 clib_memset (options, 0, sizeof (options));
1098 a->session_cb_vft = &http_app_cb_vft;
1099 a->api_client_index = APP_INVALID_INDEX;
1100 a->options = options;
1101 a->name = format (0, "http");
1102 a->options[APP_OPTIONS_SEGMENT_SIZE] = hm->first_seg_size;
1103 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = hm->add_seg_size;
1104 a->options[APP_OPTIONS_RX_FIFO_SIZE] = hm->fifo_size;
1105 a->options[APP_OPTIONS_TX_FIFO_SIZE] = hm->fifo_size;
1106 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1107 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1108 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
1110 if (vnet_application_attach (a))
1111 return clib_error_return (0, "failed to attach http app");
1113 hm->app_index = a->app_index;
1116 clib_timebase_init (&hm->timebase, 0 /* GMT */, CLIB_TIMEBASE_DAYLIGHT_NONE,
1117 &vm->clib_time /* share the system clock */);
1119 http_timers_init (vm, http_conn_timeout_cb);
1125 http_transport_connect (transport_endpoint_cfg_t *tep)
1127 vnet_connect_args_t _cargs, *cargs = &_cargs;
1128 http_main_t *hm = &http_main;
1129 session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) tep;
1134 app_worker_t *app_wrk = app_worker_get (sep->app_wrk_index);
1136 clib_memset (cargs, 0, sizeof (*cargs));
1137 clib_memcpy (&cargs->sep_ext, sep, sizeof (session_endpoint_cfg_t));
1138 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
1139 cargs->app_index = hm->app_index;
1140 app = application_get (app_wrk->app_index);
1141 cargs->sep_ext.ns_index = app->ns_index;
1143 hc_index = http_conn_alloc_w_thread (0 /* ts->thread_index */);
1144 hc = http_conn_get_w_thread (hc_index, 0);
1145 hc->h_pa_wrk_index = sep->app_wrk_index;
1146 hc->h_pa_app_api_ctx = sep->opaque;
1147 hc->state = HTTP_CONN_STATE_CONNECTING;
1148 cargs->api_context = hc_index;
1150 HTTP_DBG (1, "hc ho_index %x", hc_index);
1152 if ((error = vnet_connect (cargs)))
1159 http_start_listen (u32 app_listener_index, transport_endpoint_cfg_t *tep)
1161 vnet_listen_args_t _args = {}, *args = &_args;
1162 session_t *ts_listener, *app_listener;
1163 http_main_t *hm = &http_main;
1164 session_endpoint_cfg_t *sep;
1165 app_worker_t *app_wrk;
1166 transport_proto_t tp;
1172 sep = (session_endpoint_cfg_t *) tep;
1174 app_wrk = app_worker_get (sep->app_wrk_index);
1175 app = application_get (app_wrk->app_index);
1177 args->app_index = hm->app_index;
1178 args->sep_ext = *sep;
1179 args->sep_ext.ns_index = app->ns_index;
1180 tp = sep->ext_cfg ? TRANSPORT_PROTO_TLS : TRANSPORT_PROTO_TCP;
1181 args->sep_ext.transport_proto = tp;
1183 if (vnet_listen (args))
1184 return SESSION_INVALID_INDEX;
1186 lhc_index = http_listener_alloc ();
1187 lhc = http_listener_get (lhc_index);
1189 /* Grab transport connection listener and link to http listener */
1190 lhc->h_tc_session_handle = args->handle;
1191 al = app_listener_get_w_handle (lhc->h_tc_session_handle);
1192 ts_listener = app_listener_get_session (al);
1193 ts_listener->opaque = lhc_index;
1195 /* Grab application listener and link to http listener */
1196 app_listener = listen_session_get (app_listener_index);
1197 lhc->h_pa_wrk_index = sep->app_wrk_index;
1198 lhc->h_pa_session_handle = listen_session_get_handle (app_listener);
1199 lhc->c_s_index = app_listener_index;
1200 lhc->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
1206 http_stop_listen (u32 listener_index)
1211 lhc = http_listener_get (listener_index);
1213 vnet_unlisten_args_t a = {
1214 .handle = lhc->h_tc_session_handle,
1215 .app_index = http_main.app_index,
1216 .wrk_map_index = 0 /* default wrk */
1219 if ((rv = vnet_unlisten (&a)))
1220 clib_warning ("unlisten returned %d", rv);
1222 http_listener_free (lhc);
1228 http_transport_close (u32 hc_index, u32 thread_index)
1233 HTTP_DBG (1, "App disconnecting %x", hc_index);
1235 hc = http_conn_get_w_thread (hc_index, thread_index);
1236 if (hc->state == HTTP_CONN_STATE_CONNECTING)
1238 hc->state = HTTP_CONN_STATE_APP_CLOSED;
1239 http_disconnect_transport (hc);
1243 as = session_get_from_handle (hc->h_pa_session_handle);
1245 /* Nothing more to send, confirm close */
1246 if (!svm_fifo_max_dequeue_cons (as->tx_fifo))
1248 session_transport_closed_notify (&hc->connection);
1249 http_disconnect_transport (hc);
1253 /* Wait for all data to be written to ts */
1254 hc->state = HTTP_CONN_STATE_APP_CLOSED;
1258 static transport_connection_t *
1259 http_transport_get_connection (u32 hc_index, u32 thread_index)
1261 http_conn_t *hc = http_conn_get_w_thread (hc_index, thread_index);
1262 return &hc->connection;
1265 static transport_connection_t *
1266 http_transport_get_listener (u32 listener_index)
1268 http_conn_t *lhc = http_listener_get (listener_index);
1269 return &lhc->connection;
1273 http_app_tx_callback (void *session, transport_send_params_t *sp)
1275 session_t *as = (session_t *) session;
1276 u32 max_burst_sz, sent;
1279 HTTP_DBG (1, "app session conn index %x", as->connection_index);
1281 hc = http_conn_get_w_thread (as->connection_index, as->thread_index);
1282 if (!http_state_is_tx_valid (hc))
1284 if (hc->state != HTTP_CONN_STATE_CLOSED)
1285 clib_warning ("app data req state '%U' session state %u",
1286 format_http_state, hc->http_state, hc->state);
1287 svm_fifo_dequeue_drop_all (as->tx_fifo);
1291 max_burst_sz = sp->max_burst_size * TRANSPORT_PACER_MIN_MSS;
1292 sp->max_burst_size = max_burst_sz;
1294 http_req_run_state_machine (hc, sp);
1296 if (hc->state == HTTP_CONN_STATE_APP_CLOSED)
1298 if (!svm_fifo_max_dequeue_cons (as->tx_fifo))
1299 http_disconnect_transport (hc);
1302 sent = max_burst_sz - sp->max_burst_size;
1304 return sent > 0 ? clib_max (sent / TRANSPORT_PACER_MIN_MSS, 1) : 0;
1308 http_transport_get_endpoint (u32 hc_index, u32 thread_index,
1309 transport_endpoint_t *tep, u8 is_lcl)
1311 http_conn_t *hc = http_conn_get_w_thread (hc_index, thread_index);
1314 ts = session_get_from_handle (hc->h_tc_session_handle);
1315 session_get_endpoint (ts, tep, is_lcl);
1319 format_http_connection (u8 *s, va_list *args)
1321 http_conn_t *hc = va_arg (*args, http_conn_t *);
1324 ts = session_get_from_handle (hc->h_tc_session_handle);
1325 s = format (s, "[%d:%d][H] app_wrk %u ts %d:%d", hc->c_thread_index,
1326 hc->c_s_index, hc->h_pa_wrk_index, ts->thread_index,
1333 format_http_listener (u8 *s, va_list *args)
1335 http_conn_t *lhc = va_arg (*args, http_conn_t *);
1339 al = app_listener_get_w_handle (lhc->h_tc_session_handle);
1340 lts = app_listener_get_session (al);
1341 s = format (s, "[%d:%d][H] app_wrk %u ts %d:%d", lhc->c_thread_index,
1342 lhc->c_s_index, lhc->h_pa_wrk_index, lts->thread_index,
1343 lts->session_index);
1349 format_http_conn_state (u8 *s, va_list *args)
1351 http_conn_t *hc = va_arg (*args, http_conn_t *);
1355 case HTTP_CONN_STATE_LISTEN:
1356 s = format (s, "LISTEN");
1358 case HTTP_CONN_STATE_CONNECTING:
1359 s = format (s, "CONNECTING");
1361 case HTTP_CONN_STATE_ESTABLISHED:
1362 s = format (s, "ESTABLISHED");
1364 case HTTP_CONN_STATE_TRANSPORT_CLOSED:
1365 s = format (s, "TRANSPORT_CLOSED");
1367 case HTTP_CONN_STATE_APP_CLOSED:
1368 s = format (s, "APP_CLOSED");
1370 case HTTP_CONN_STATE_CLOSED:
1371 s = format (s, "CLOSED");
1379 format_http_transport_connection (u8 *s, va_list *args)
1381 u32 tc_index = va_arg (*args, u32);
1382 u32 thread_index = va_arg (*args, u32);
1383 u32 verbose = va_arg (*args, u32);
1386 hc = http_conn_get_w_thread (tc_index, thread_index);
1388 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_http_connection, hc);
1392 format (s, "%-" SESSION_CLI_STATE_LEN "U", format_http_conn_state, hc);
1394 s = format (s, "\n");
1401 format_http_transport_listener (u8 *s, va_list *args)
1403 u32 tc_index = va_arg (*args, u32);
1404 u32 __clib_unused thread_index = va_arg (*args, u32);
1405 u32 __clib_unused verbose = va_arg (*args, u32);
1406 http_conn_t *lhc = http_listener_get (tc_index);
1408 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_http_listener, lhc);
1411 format (s, "%-" SESSION_CLI_STATE_LEN "U", format_http_conn_state, lhc);
1415 static const transport_proto_vft_t http_proto = {
1416 .enable = http_transport_enable,
1417 .connect = http_transport_connect,
1418 .start_listen = http_start_listen,
1419 .stop_listen = http_stop_listen,
1420 .close = http_transport_close,
1421 .custom_tx = http_app_tx_callback,
1422 .get_connection = http_transport_get_connection,
1423 .get_listener = http_transport_get_listener,
1424 .get_transport_endpoint = http_transport_get_endpoint,
1425 .format_connection = format_http_transport_connection,
1426 .format_listener = format_http_transport_listener,
1427 .transport_options = {
1430 .tx_type = TRANSPORT_TX_INTERNAL,
1431 .service_type = TRANSPORT_SERVICE_APP,
1435 static clib_error_t *
1436 http_transport_init (vlib_main_t *vm)
1438 http_main_t *hm = &http_main;
1440 transport_register_protocol (TRANSPORT_PROTO_HTTP, &http_proto,
1441 FIB_PROTOCOL_IP4, ~0);
1442 transport_register_protocol (TRANSPORT_PROTO_HTTP, &http_proto,
1443 FIB_PROTOCOL_IP6, ~0);
1445 /* Default values, configurable via startup conf */
1446 hm->add_seg_size = 256 << 20;
1447 hm->first_seg_size = 32 << 20;
1448 hm->fifo_size = 512 << 10;
1453 VLIB_INIT_FUNCTION (http_transport_init);
1455 static clib_error_t *
1456 http_config_fn (vlib_main_t *vm, unformat_input_t *input)
1458 http_main_t *hm = &http_main;
1461 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1463 if (unformat (input, "first-segment-size %U", unformat_memory_size,
1466 hm->first_seg_size = clib_max (mem_sz, 1 << 20);
1467 if (hm->first_seg_size != mem_sz)
1468 clib_warning ("first seg size too small %u", mem_sz);
1470 else if (unformat (input, "add-segment-size %U", unformat_memory_size,
1473 hm->add_seg_size = clib_max (mem_sz, 1 << 20);
1474 if (hm->add_seg_size != mem_sz)
1475 clib_warning ("add seg size too small %u", mem_sz);
1477 else if (unformat (input, "fifo-size %U", unformat_memory_size, &mem_sz))
1479 hm->fifo_size = clib_clamp (mem_sz, 4 << 10, 2 << 30);
1480 if (hm->fifo_size != mem_sz)
1481 clib_warning ("invalid fifo size %lu", mem_sz);
1484 return clib_error_return (0, "unknown input `%U'",
1485 format_unformat_error, input);
1490 VLIB_CONFIG_FUNCTION (http_config_fn, "http");
1492 VLIB_PLUGIN_REGISTER () = {
1493 .version = VPP_BUILD_VER,
1494 .description = "Hypertext Transfer Protocol (HTTP)",
1495 .default_disabled = 0,
1499 * fd.io coding-style-patch-verification: ON
1502 * eval: (c-set-style "gnu")