summaryrefslogtreecommitdiffstats
path: root/src/vnet/vnet.h
blob: 54988aec6675e8cb2c8ecbaa3604f372c8c3cef0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/*
 * Copyright (c) 2015 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/*
 * vnet.h: general networking definitions
 *
 * Copyright (c) 2011 Eliot Dresselhaus
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef included_vnet_vnet_h
#define included_vnet_vnet_h

#include <stddef.h>

#include <vppinfra/types.h>

#include <vppinfra/pcap.h>
#include <vnet/error.h>
#include <vnet/buffer.h>
#include <vnet/config.h>
#include <vnet/interface.h>
#include <vnet/api_errno.h>

/* ip table add delete callback */
typedef struct _vnet_ip_table_function_list_elt
{
  struct _vnet_ip_table_function_list_elt *next_ip_table_function;
  clib_error_t *(*fp) (struct vnet_main_t * vnm, u32 table_id, u32 flags);
} _vnet_ip_table_function_list_elt_t;

typedef struct
{
  /* Trace RX pkts */
  u8 pcap_rx_enable;
  /* Trace TX pkts */
  u8 pcap_tx_enable;
  /* Trace drop pkts */
  u8 pcap_drop_enable;
  u8 pad1;
  u32 max_bytes_per_pkt;
  u32 pcap_sw_if_index;
  pcap_main_t pcap_main;
  u32 filter_classify_table_index;
  vlib_is_packet_traced_fn_t *current_filter_function;
  vlib_error_t pcap_error_index;
} vnet_pcap_t;

typedef struct vnet_main_t
{
  u32 local_interface_hw_if_index;
  u32 local_interface_sw_if_index;

  vnet_interface_main_t interface_main;

  /* set up by constructors */
  vnet_device_class_t *device_class_registrations;
  vnet_hw_interface_class_t *hw_interface_class_registrations;
    _vnet_interface_function_list_elt_t
    * hw_interface_add_del_functions[VNET_ITF_FUNC_N_PRIO];
    _vnet_interface_function_list_elt_t
    * hw_interface_link_up_down_functions[VNET_ITF_FUNC_N_PRIO];
    _vnet_interface_function_list_elt_t
    * sw_interface_add_del_functions[VNET_ITF_FUNC_N_PRIO];
    _vnet_interface_function_list_elt_t
    * sw_interface_admin_up_down_functions[VNET_ITF_FUNC_N_PRIO];
    _vnet_interface_function_list_elt_t
    * sw_interface_mtu_change_functions[VNET_ITF_FUNC_N_PRIO];

  uword *interface_tag_by_sw_if_index;

    _vnet_ip_table_function_list_elt_t
    * ip_table_add_del_functions[VNET_ITF_FUNC_N_PRIO];

    /* pcap rx / tx tracing */
    vnet_pcap_t pcap;

    /*
     * Last "api" error, preserved so we can issue reasonable diagnostics
     * at or near the top of the food chain
     */
    vnet_api_error_t api_errno;

    vlib_main_t *vlib_main;
} vnet_main_t;

extern vnet_main_t vnet_main;

#include <vppinfra/pcap_funcs.h>
#include <vnet/interface_funcs.h>
#include <vnet/global_funcs.h>

#endif /* included_vnet_vnet_h */

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */
="p">(*session_accept_callback) (session_t * new_session); /** Connection request callback */ int (*session_connected_callback) (u32 app_wrk_index, u32 opaque, session_t * s, u8 code); /** Notify app that session is closing */ void (*session_disconnect_callback) (session_t * s); /** Notify app that session was reset */ void (*session_reset_callback) (session_t * s); /** Direct RX callback for built-in application */ int (*builtin_app_rx_callback) (session_t * session); /** Direct TX callback for built-in application */ int (*builtin_app_tx_callback) (session_t * session); } session_cb_vft_t; typedef struct app_worker_ { CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /** Worker index in global worker pool*/ u32 wrk_index; /** Worker index in app's map pool */ u32 wrk_map_index; /** Index of owning app */ u32 app_index; /** Application listens for events on this svm queue */ svm_msg_q_t *event_queue; /** Segment manager used for outgoing connects issued by the app */ u32 connects_seg_manager; /** Lookup tables for listeners. Value is segment manager index */ uword *listeners_table; /** * First segment manager has in the the first segment the application's * event fifo. Depending on what the app does, it may be either used for * a listener or for connects. */ u32 first_segment_manager; u8 first_segment_manager_in_use; /* * Local "cut through" connections specific */ /** Segment manager used for incoming "cut through" connects */ u32 local_segment_manager; /** Pool of local sessions the app owns (as a server) */ local_session_t *local_sessions; /** Hash table of the app's local connects */ uword *local_connects; /** API index for the worker. Needed for multi-process apps */ u32 api_client_index; u8 app_is_builtin; } app_worker_t; typedef struct app_worker_map_ { u32 wrk_index; } app_worker_map_t; typedef struct app_listener_ { clib_bitmap_t *workers; /**< workers accepting connections */ u32 accept_rotor; /**< last worker to accept a connection */ u32 al_index; } app_listener_t; typedef struct application_ { /** App index in app pool */ u32 app_index; /** Flags */ u32 flags; /** Callbacks: shoulder-taps for the server/client */ session_cb_vft_t cb_fns; /** Segment manager properties. Shared by all segment managers */ segment_manager_properties_t sm_properties; /** Pool of mappings that keep track of workers associated to this app */ app_worker_map_t *worker_maps; /** Name registered by builtin apps */ u8 *name; /** Namespace the application belongs to */ u32 ns_index; u16 proxied_transports; /** Pool of listeners for the app */ app_listener_t *listeners; /** Pool of local listeners for app */ app_listener_t *local_listeners; /** Pool of local listen sessions */ local_session_t *local_listen_sessions; /* * TLS Specific */ /** Certificate to be used for listen sessions */ u8 *tls_cert; /** PEM encoded key */ u8 *tls_key; /** Preferred tls engine */ u8 tls_engine; } application_t; typedef struct app_main_ { /** * Pool from which we allocate all applications */ application_t *app_pool; /** * Hash table of apps by api client index */ uword *app_by_api_client_index; /** * Hash table of builtin apps by name */ uword *app_by_name; } app_main_t; #define foreach_app_init_args \ _(u32, api_client_index) \ _(u8 *, name) \ _(u64 *, options) \ _(u8 *, namespace_id) \ _(session_cb_vft_t *, session_cb_vft) \ _(u32, app_index) \ typedef struct app_init_args_ { #define _(_type, _name) _type _name; foreach_app_init_args #undef _ } app_init_args_t; typedef struct _vnet_app_worker_add_del_args { u32 app_index; /**< App for which a new worker is requested */ u32 wrk_map_index; /**< Index to delete or return value if add */ u32 api_client_index; /**< Binary API client index */ ssvm_private_t *segment; /**< First segment in segment manager */ u64 segment_handle; /**< Handle for the segment */ svm_msg_q_t *evt_q; /**< Worker message queue */ u8 is_add; /**< Flag set if addition */ } vnet_app_worker_add_del_args_t; #define APP_INVALID_INDEX ((u32)~0) #define APP_NS_INVALID_INDEX ((u32)~0) #define APP_INVALID_SEGMENT_MANAGER_INDEX ((u32) ~0) application_t *application_alloc (void); int application_alloc_and_init (app_init_args_t * args); void application_free (application_t * app); void application_detach_process (application_t * app, u32 api_client_index); application_t *application_get (u32 index); application_t *application_get_if_valid (u32 index); application_t *application_lookup (u32 api_client_index); application_t *application_lookup_name (const u8 * name); app_worker_t *application_get_worker (application_t * app, u32 wrk_index); app_worker_t *application_get_default_worker (application_t * app); app_worker_t *application_listener_select_worker (session_t * ls, u8 is_local); int application_start_listen (application_t * app, session_endpoint_cfg_t * tep, session_handle_t * handle); int application_stop_listen (u32 app_index, u32 app_or_wrk, session_handle_t handle); int application_change_listener_owner (session_t * s, app_worker_t * app_wrk); int application_is_proxy (application_t * app); int application_is_builtin (application_t * app); int application_is_builtin_proxy (application_t * app); u32 application_session_table (application_t * app, u8 fib_proto); u32 application_local_session_table (application_t * app); const u8 *application_name_from_index (u32 app_or_wrk); u8 application_has_local_scope (application_t * app); u8 application_has_global_scope (application_t * app); u8 application_use_mq_for_ctrl (application_t * app); void application_setup_proxy (application_t * app); void application_remove_proxy (application_t * app); segment_manager_properties_t *application_get_segment_manager_properties (u32 app_index); segment_manager_properties_t * application_segment_manager_properties (application_t * app); /* * App worker */ app_worker_t *app_worker_alloc (application_t * app); int application_alloc_worker_and_init (application_t * app, app_worker_t ** wrk); app_worker_t *app_worker_get (u32 wrk_index); app_worker_t *app_worker_get_if_valid (u32 wrk_index); application_t *app_worker_get_app (u32 wrk_index); int app_worker_own_session (app_worker_t * app_wrk, session_t * s); void app_worker_free (app_worker_t * app_wrk); int app_worker_open_session (app_worker_t * app, session_endpoint_t * tep, u32 api_context); int app_worker_start_listen (app_worker_t * app_wrk, session_t * ls); int app_worker_stop_listen (app_worker_t * app_wrk, session_handle_t handle); segment_manager_t *app_worker_get_listen_segment_manager (app_worker_t *, session_t *); segment_manager_t *app_worker_get_connect_segment_manager (app_worker_t *); segment_manager_t * app_worker_get_or_alloc_connect_segment_manager (app_worker_t *); int app_worker_alloc_connects_segment_manager (app_worker_t * app); int app_worker_add_segment_notify (u32 app_or_wrk, u64 segment_handle); u32 app_worker_n_listeners (app_worker_t * app); session_t *app_worker_first_listener (app_worker_t * app, u8 fib_proto, u8 transport_proto); u8 app_worker_application_is_builtin (app_worker_t * app_wrk); int app_worker_send_event (app_worker_t * app, session_t * s, u8 evt); int app_worker_lock_and_send_event (app_worker_t * app, session_t * s, u8 evt_type); session_t *app_worker_proxy_listener (app_worker_t * app, u8 fib_proto, u8 transport_proto); u8 *format_app_worker (u8 * s, va_list * args); u8 *format_app_worker_listener (u8 * s, va_list * args); void app_worker_format_connects (app_worker_t * app_wrk, int verbose); clib_error_t *vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a); /* * Local session */ local_session_t *app_worker_local_session_alloc (app_worker_t * app); void app_worker_local_session_free (app_worker_t * app, local_session_t * ls); local_session_t *app_worker_get_local_session (app_worker_t * app, u32 session_index); local_session_t *app_worker_get_local_session_from_handle (session_handle_t handle); local_session_t * application_get_local_listen_session_from_handle (session_handle_t lh); int application_start_local_listen (application_t * server, session_endpoint_cfg_t * sep, session_handle_t * handle); int application_stop_local_listen (u32 app_index, u32 app_or_wrk, session_handle_t lh); int app_worker_local_session_connect (app_worker_t * client, app_worker_t * server, local_session_t * ls, u32 opaque); int app_worker_local_session_connect_notify (local_session_t * ls); int app_worker_local_session_disconnect (u32 app_or_wrk, local_session_t * ls); int app_worker_local_session_disconnect_w_index (u32 app_or_wrk, u32 ls_index); void app_worker_format_local_sessions (app_worker_t * app_wrk, int verbose); void app_worker_format_local_connects (app_worker_t * app, int verbose); always_inline local_session_t * application_get_local_listen_session (application_t * app, u32 session_index) { return pool_elt_at_index (app->local_listen_sessions, session_index); } always_inline local_session_t * application_get_local_listener_w_handle (session_handle_t handle) { u32 server_index, session_index; application_t *app; local_session_parse_handle (handle, &server_index, &session_index); app = application_get (server_index); return application_get_local_listen_session (app, session_index); } always_inline u8 application_local_session_listener_has_transport (local_session_t * ls) { transport_proto_t tp; tp = session_type_transport_proto (ls->listener_session_type); return (tp != TRANSPORT_PROTO_NONE); } void mq_send_local_session_disconnected_cb (u32 app_or_wrk, local_session_t * ls); uword unformat_application_proto (unformat_input_t * input, va_list * args); #endif /* SRC_VNET_SESSION_APPLICATION_H_ */ /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */