src/plugins/http/http.h

   1 /*
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15
  16 #ifndef SRC_PLUGINS_HTTP_HTTP_H_
  17 #define SRC_PLUGINS_HTTP_HTTP_H_
  18
  19 #include <vnet/plugin/plugin.h>
  20 #include <vpp/app/version.h>
  21
  22 #include <vppinfra/time_range.h>
  23
  24 #include <vnet/session/application_interface.h>
  25 #include <vnet/session/application.h>
  26 #include <http/http_buffer.h>
  27
  28 #define HTTP_DEBUG 0
  29
  30 #if HTTP_DEBUG
  31 #define HTTP_DBG(_lvl, _fmt, _args...)                                        \
  32   if (_lvl <= HTTP_DEBUG)                                                     \
  33   clib_warning (_fmt, ##_args)
  34 #else
  35 #define HTTP_DBG(_lvl, _fmt, _args...)
  36 #endif
  37
  38 typedef struct http_conn_id_
  39 {
  40   union
  41   {
  42     session_handle_t app_session_handle;
  43     u32 parent_app_api_ctx;
  44   };
  45   session_handle_t tc_session_handle;
  46   u32 parent_app_wrk_index;
  47 } http_conn_id_t;
  48
  49 STATIC_ASSERT (sizeof (http_conn_id_t) <= TRANSPORT_CONN_ID_LEN,
  50                "ctx id must be less than TRANSPORT_CONN_ID_LEN");
  51
  52 typedef enum http_conn_state_
  53 {
  54   HTTP_CONN_STATE_LISTEN,
  55   HTTP_CONN_STATE_CONNECTING,
  56   HTTP_CONN_STATE_ESTABLISHED,
  57   HTTP_CONN_STATE_TRANSPORT_CLOSED,
  58   HTTP_CONN_STATE_APP_CLOSED,
  59   HTTP_CONN_STATE_CLOSED
  60 } http_conn_state_t;
  61
  62 typedef enum http_state_
  63 {
  64   HTTP_STATE_WAIT_METHOD,
  65   HTTP_STATE_WAIT_APP,
  66   HTTP_STATE_IO_MORE_DATA,
  67   HTTP_N_STATES,
  68 } http_state_t;
  69
  70 typedef enum http_req_method_
  71 {
  72   HTTP_REQ_GET = 0,
  73   HTTP_REQ_POST,
  74 } http_req_method_t;
  75
  76 typedef enum http_msg_type_
  77 {
  78   HTTP_MSG_REQUEST,
  79   HTTP_MSG_REPLY
  80 } http_msg_type_t;
  81
  82 #define foreach_http_content_type                                             \
  83   _ (TEXT_HTML, "text/html")                                                  \
  84   _ (TEXT_CSS, "text/css")                                                    \
  85   _ (TEXT_JS, "text/javascript")                                              \
  86   _ (APP_JSON, "application/json")                                            \
  87   _ (APP_OCTET_STREAM, "application/octet-stream")
  88
  89 typedef enum http_content_type_
  90 {
  91 #define _(s, str) HTTP_CONTENT_##s,
  92   foreach_http_content_type
  93 #undef _
  94 } http_content_type_t;
  95
  96 #define foreach_http_status_code                                              \
  97   _ (200, OK, "200 OK")                                                       \
  98   _ (301, MOVED, "301 Moved Permanently")                                     \
  99   _ (400, BAD_REQUEST, "400 Bad Request")                                     \
 100   _ (404, NOT_FOUND, "404 Not Found")                                         \
 101   _ (405, METHOD_NOT_ALLOWED, "405 Method Not Allowed")                       \
 102   _ (500, INTERNAL_ERROR, "500 Internal Server Error")
 103
 104 typedef enum http_status_code_
 105 {
 106 #define _(c, s, str) HTTP_STATUS_##s,
 107   foreach_http_status_code
 108 #undef _
 109     HTTP_N_STATUS
 110 } http_status_code_t;
 111
 112 typedef enum http_msg_data_type_
 113 {
 114   HTTP_MSG_DATA_INLINE,
 115   HTTP_MSG_DATA_PTR
 116 } http_msg_data_type_t;
 117
 118 typedef struct http_msg_data_
 119 {
 120   http_msg_data_type_t type;
 121   u64 len;
 122   u8 data[0];
 123 } http_msg_data_t;
 124
 125 typedef struct http_msg_
 126 {
 127   http_msg_type_t type;
 128   union
 129   {
 130     http_req_method_t method_type;
 131     http_status_code_t code;
 132   };
 133   http_content_type_t content_type;
 134   http_msg_data_t data;
 135 } http_msg_t;
 136
 137 typedef struct http_tc_
 138 {
 139   union
 140   {
 141     transport_connection_t connection;
 142     http_conn_id_t c_http_conn_id;
 143   };
 144 #define h_tc_session_handle c_http_conn_id.tc_session_handle
 145 #define h_pa_wrk_index      c_http_conn_id.parent_app_wrk_index
 146 #define h_pa_session_handle c_http_conn_id.app_session_handle
 147 #define h_pa_app_api_ctx    c_http_conn_id.parent_app_api_ctx
 148 #define h_hc_index          connection.c_index
 149
 150   http_conn_state_t state;
 151   u32 timer_handle;
 152
 153   /*
 154    * Current request
 155    */
 156   http_state_t http_state;
 157   http_req_method_t method;
 158   u8 *rx_buf;
 159   u32 rx_buf_offset;
 160   http_buffer_t tx_buf;
 161   u8 is_client;
 162   u32 to_recv;
 163   u32 bytes_dequeued;
 164 } http_conn_t;
 165
 166 typedef struct http_worker_
 167 {
 168   http_conn_t *conn_pool;
 169 } http_worker_t;
 170
 171 typedef struct http_main_
 172 {
 173   http_worker_t *wrk;
 174   http_conn_t *listener_pool;
 175   u32 app_index;
 176
 177   clib_timebase_t timebase;
 178
 179   /*
 180    * Runtime config
 181    */
 182   u8 debug_level;
 183
 184   /*
 185    * Config
 186    */
 187   u64 first_seg_size;
 188   u64 add_seg_size;
 189   u32 fifo_size;
 190 } http_main_t;
 191
 192 #endif /* SRC_PLUGINS_HTTP_HTTP_H_ */
 193
 194 /*
 195  * fd.io coding-style-patch-verification: ON
 196  *
 197  * Local Variables:
 198  * eval: (c-set-style "gnu")
 199  * End:
 200  */