summaryrefslogtreecommitdiffstats
path: root/src/vnet/config.h
blob: b77a7794a6e3249576f4f91cc62bc376a78f4625 (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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
/*
 * 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.
 */
/*
 * config.h: feature configuration
 *
 * Copyright (c) 2008 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_config_h
#define included_vnet_config_h

#include <vlib/vlib.h>
#include <vppinfra/heap.h>

typedef struct
{
  /* Features are prioritized by index.  Smaller indices get
     performed first. */
  u32 feature_index;

  /* VLIB node which performs feature. */
  u32 node_index;

  /* Next index relative to previous node or main node. */
  u32 next_index;

  /* Opaque per feature configuration data. */
  u32 *feature_config;
} vnet_config_feature_t;

always_inline void
vnet_config_feature_free (vnet_config_feature_t * f)
{
  vec_free (f->feature_config);
}

typedef struct
{
  /* Sorted vector of features for this configuration. */
  vnet_config_feature_t *features;

  /* Config string as vector for hashing. */
  u32 *config_string_vector;

  /* Config string including all next indices and feature data as a vector. */
  u32 config_string_heap_index, config_string_heap_handle;

  /* Index in main pool. */
  u32 index;

  /* Number of interfaces/traffic classes that reference this config. */
  u32 reference_count;
} vnet_config_t;

typedef struct
{
  /* Pool of configs.  Index 0 is always null config and is never deleted. */
  vnet_config_t *config_pool;

  /* Hash table mapping vector config string to config pool index. */
  uword *config_string_hash;

  /* Global heap of configuration data. */
  u32 *config_string_heap;

  /* Node index which starts/ends feature processing. */
  u32 *start_node_indices, end_node_index;

  /* Interior feature processing nodes (not including start and end nodes). */
  u32 *node_index_by_feature_index;

  /* vnet_config pool index by user index */
  u32 *config_pool_index_by_user_index;

  /* Temporary vector for holding config strings.  Used to avoid continually
     allocating vectors. */
  u32 *config_string_temp;
} vnet_config_main_t;

always_inline void
vnet_config_free (vnet_config_main_t * cm, vnet_config_t * c)
{
  vnet_config_feature_t *f;
  vec_foreach (f, c->features) vnet_config_feature_free (f);
  vec_free (c->features);
  heap_dealloc (cm->config_string_heap, c->config_string_heap_handle);
  vec_free (c->config_string_vector);
}

always_inline void *
vnet_get_config_data (vnet_config_main_t * cm,
		      u32 * config_index, u32 * next_index, u32 n_data_bytes)
{
  u32 i, n, *d;

  i = *config_index;

  d = heap_elt_at_index (cm->config_string_heap, i);

  n = round_pow2 (n_data_bytes, sizeof (d[0])) / sizeof (d[0]);

  /* Last 32 bits are next index. */
  *next_index = d[n];

  /* Advance config index to next config. */
  *config_index = (i + n + 1);

  /* Return config data to user for this feature. */
  return (void *) d;
}

void vnet_config_init (vlib_main_t * vm,
		       vnet_config_main_t * cm,
		       char *start_node_names[],
		       int n_start_node_names,
		       char *feature_node_names[], int n_feature_node_names);

/* Calls to add/delete features from configurations. */
u32 vnet_config_add_feature (vlib_main_t * vm,
			     vnet_config_main_t * cm,
			     u32 config_id,
			     u32 feature_index,
			     void *feature_config,
			     u32 n_feature_config_bytes);

u32 vnet_config_del_feature (vlib_main_t * vm,
			     vnet_config_main_t * cm,
			     u32 config_id,
			     u32 feature_index,
			     void *feature_config,
			     u32 n_feature_config_bytes);

u8 *vnet_config_format_features (vlib_main_t * vm,
				 vnet_config_main_t * cm,
				 u32 config_index, u8 * s);

#endif /* included_vnet_config_h */

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */
s="p">(u32 conn_idx, u32 thread_idx); transport_connection_t *(*get_listener) (u32 conn_index); transport_connection_t *(*get_half_open) (u32 conn_index); /* * Format */ u8 *(*format_connection) (u8 * s, va_list * args); u8 *(*format_listener) (u8 * s, va_list * args); u8 *(*format_half_open) (u8 * s, va_list * args); /* * Properties retrieval */ void (*get_transport_endpoint) (u32 conn_index, u32 thread_index, transport_endpoint_t *tep, u8 is_lcl); void (*get_transport_listener_endpoint) (u32 conn_index, transport_endpoint_t *tep, u8 is_lcl); /* * Properties */ transport_options_t transport_options; } transport_proto_vft_t; /* *INDENT-ON* */ extern transport_proto_vft_t *tp_vfts; #define transport_proto_foreach(VAR, BODY) \ do { \ for (VAR = 0; VAR < vec_len (tp_vfts); VAR++) \ if (tp_vfts[VAR].push_header != 0) \ do { BODY; } while (0); \ } while (0) int transport_connect (transport_proto_t tp, transport_endpoint_cfg_t * tep); void transport_close (transport_proto_t tp, u32 conn_index, u8 thread_index); void transport_reset (transport_proto_t tp, u32 conn_index, u8 thread_index); u32 transport_start_listen (transport_proto_t tp, u32 session_index, transport_endpoint_t * tep); u32 transport_stop_listen (transport_proto_t tp, u32 conn_index); void transport_cleanup (transport_proto_t tp, u32 conn_index, u8 thread_index); void transport_cleanup_half_open (transport_proto_t tp, u32 conn_index); void transport_get_endpoint (transport_proto_t tp, u32 conn_index, u32 thread_index, transport_endpoint_t * tep, u8 is_lcl); void transport_get_listener_endpoint (transport_proto_t tp, u32 conn_index, transport_endpoint_t * tep, u8 is_lcl); static inline transport_connection_t * transport_get_connection (transport_proto_t tp, u32 conn_index, u8 thread_index) { return tp_vfts[tp].get_connection (conn_index, thread_index); } static inline transport_connection_t * transport_get_listener (transport_proto_t tp, u32 conn_index) { return tp_vfts[tp].get_listener (conn_index); } static inline transport_connection_t * transport_get_half_open (transport_proto_t tp, u32 conn_index) { return tp_vfts[tp].get_half_open (conn_index); } static inline int transport_custom_tx (transport_proto_t tp, void *s, transport_send_params_t * sp) { return tp_vfts[tp].custom_tx (s, sp); } static inline int transport_app_rx_evt (transport_proto_t tp, u32 conn_index, u32 thread_index) { transport_connection_t *tc; if (!tp_vfts[tp].app_rx_evt) return 0; tc = transport_get_connection (tp, conn_index, thread_index); return tp_vfts[tp].app_rx_evt (tc); } /** * Get send parameters for transport connection * * These include maximum tx burst, mss, tx offset and other flags * transport might want to provide to sessin layer * * @param tc transport connection * @param sp send paramaters * */ static inline u32 transport_connection_snd_params (transport_connection_t * tc, transport_send_params_t * sp) { return tp_vfts[tc->proto].send_params (tc, sp); } static inline u8 transport_connection_is_descheduled (transport_connection_t * tc) { return ((tc->flags & TRANSPORT_CONNECTION_F_DESCHED) ? 1 : 0); } static inline void transport_connection_deschedule (transport_connection_t * tc) { tc->flags |= TRANSPORT_CONNECTION_F_DESCHED; } static inline u8 transport_connection_is_cless (transport_connection_t * tc) { return ((tc->flags & TRANSPORT_CONNECTION_F_CLESS) ? 1 : 0); } void transport_connection_reschedule (transport_connection_t * tc); /** * Register transport virtual function table. * * @param transport_proto - transport protocol type (i.e., TCP, UDP ..) * @param vft - virtual function table for transport proto * @param fib_proto - network layer protocol * @param output_node - output node index that session layer will hand off * buffers to, for requested fib proto */ void transport_register_protocol (transport_proto_t transport_proto, const transport_proto_vft_t * vft, fib_protocol_t fib_proto, u32 output_node); transport_proto_t transport_register_new_protocol (const transport_proto_vft_t * vft, fib_protocol_t fib_proto, u32 output_node); transport_proto_vft_t *transport_protocol_get_vft (transport_proto_t tp); void transport_update_time (clib_time_type_t time_now, u8 thread_index); int transport_alloc_local_port (u8 proto, ip46_address_t * ip); int transport_alloc_local_endpoint (u8 proto, transport_endpoint_cfg_t * rmt, ip46_address_t * lcl_addr, u16 * lcl_port); void transport_share_local_endpoint (u8 proto, ip46_address_t * lcl_ip, u16 port); void transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port); void transport_enable_disable (vlib_main_t * vm, u8 is_en); void transport_init (void); always_inline u32 transport_elog_track_index (transport_connection_t * tc) { #if TRANSPORT_DEBUG return tc->elog_track.track_index_plus_one - 1; #else return ~0; #endif } void transport_connection_tx_pacer_reset (transport_connection_t * tc, u64 rate_bytes_per_sec, u32 initial_bucket, clib_us_time_t rtt); /** * Initialize tx pacer for connection * * @param tc transport connection * @param rate_bytes_per_second initial byte rate * @param burst_bytes initial burst size in bytes */ void transport_connection_tx_pacer_init (transport_connection_t * tc, u64 rate_bytes_per_sec, u32 initial_bucket); /** * Update tx pacer pacing rate * * @param tc transport connection * @param bytes_per_sec new pacing rate * @param rtt connection rtt that is used to compute * inactivity time after which pacer bucket is * reset to 1 mtu */ void transport_connection_tx_pacer_update (transport_connection_t * tc, u64 bytes_per_sec, clib_us_time_t rtt); /** * Get tx pacer max burst * * @param tc transport connection * @param time_now current cpu time * @return max burst for connection */ u32 transport_connection_tx_pacer_burst (transport_connection_t * tc); /** * Get tx pacer current rate * * @param tc transport connection * @return rate for connection in bytes/s */ u64 transport_connection_tx_pacer_rate (transport_connection_t * tc); /** * Reset tx pacer bucket * * @param tc transport connection * @param bucket value the bucket will be reset to */ void transport_connection_tx_pacer_reset_bucket (transport_connection_t * tc, u32 bucket); /** * Check if transport connection is paced */ always_inline u8 transport_connection_is_tx_paced (transport_connection_t * tc) { return (tc->flags & TRANSPORT_CONNECTION_F_IS_TX_PACED); } u8 *format_transport_pacer (u8 * s, va_list * args); /** * Update tx bytes for paced transport connection * * If tx pacing is enabled, this update pacer bucket to account for the * amount of bytes that have been sent. * * @param tc transport connection * @param bytes bytes recently sent */ void transport_connection_update_tx_bytes (transport_connection_t * tc, u32 bytes); void transport_connection_tx_pacer_update_bytes (transport_connection_t * tc, u32 bytes); #endif /* SRC_VNET_SESSION_TRANSPORT_H_ */ /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */