2 * Copyright (c) 2015 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 * srp.h: types/functions for srp.
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40 #ifndef included_srp_h
41 #define included_srp_h
43 #include <vnet/vnet.h>
44 #include <vnet/srp/packet.h>
45 #include <vnet/ethernet/ethernet.h>
46 #include <vnet/pg/pg.h>
48 extern vnet_hw_interface_class_t srp_hw_interface_class;
51 #define foreach_srp_ips_state \
57 #define _(f) SRP_IPS_STATE_##f,
67 SRP_SIDE_A = SRP_RING_OUTER, /* outer rx, inner tx */
68 SRP_SIDE_B = SRP_RING_INNER, /* inner rx, outer tx */
75 /* Hardware interface for this ring/side. */
78 /* Software interface corresponding to hardware interface. */
81 /* Mac address of neighbor on RX fiber. */
82 u8 rx_neighbor_address[6];
84 u8 rx_neighbor_address_valid;
86 /* True if we are waiting to restore signal. */
87 u8 waiting_to_restore;
89 /* Time stamp when signal became valid. */
90 f64 wait_to_restore_start_time;
91 } srp_interface_ring_t;
93 struct srp_interface_t;
94 typedef void (srp_hw_wrap_function_t) (u32 hw_if_index, u32 wrap_enable);
95 typedef void (srp_hw_enable_function_t) (struct srp_interface_t * si, u32 wrap_enable);
98 /* Delay between wait to restore event and entering idle state in seconds. */
99 f64 wait_to_restore_idle_delay;
101 /* Number of seconds between sending ips messages to neighbors. */
103 } srp_interface_config_t;
105 typedef struct srp_interface_t {
106 /* Current IPS state. */
107 srp_ips_state_t current_ips_state;
109 /* Address for this interface. */
112 /* Enable IPS process handling for this interface. */
113 u8 ips_process_enable;
115 srp_interface_ring_t rings[SRP_N_RING];
117 /* Configurable parameters. */
118 srp_interface_config_t config;
120 srp_hw_wrap_function_t * hw_wrap_function;
122 srp_hw_enable_function_t * hw_enable_function;
126 vlib_main_t * vlib_main;
128 /* Pool of SRP interfaces. */
129 srp_interface_t * interface_pool;
131 uword * interface_index_by_hw_if_index;
133 /* TTL to use for outgoing data packets. */
134 u32 default_data_ttl;
136 vlib_one_time_waiting_process_t * srp_register_interface_waiting_process_pool;
138 uword * srp_register_interface_waiting_process_pool_index_by_hw_if_index;
141 /* Registers sides A/B hardware interface as being SRP capable. */
142 void srp_register_interface (u32 * hw_if_indices);
144 /* Enable sending IPS messages for interface implied by given vlib hardware interface. */
145 void srp_interface_enable_ips (u32 hw_if_index);
147 /* Set function to wrap hardware side of SRP interface. */
148 void srp_interface_set_hw_wrap_function (u32 hw_if_index, srp_hw_wrap_function_t * f);
150 void srp_interface_set_hw_enable_function (u32 hw_if_index, srp_hw_enable_function_t * f);
152 extern vlib_node_registration_t srp_ips_process_node;
154 /* Called when an IPS control packet is received on given interface. */
155 void srp_ips_rx_packet (u32 sw_if_index, srp_ips_header_t * ips_packet);
157 /* Preform local IPS request on given interface. */
158 void srp_ips_local_request (u32 sw_if_index, srp_ips_request_type_t request);
161 srp_ips_link_change (u32 sw_if_index, u32 link_is_up)
163 srp_ips_local_request (sw_if_index,
165 ? SRP_IPS_REQUEST_wait_to_restore
166 : SRP_IPS_REQUEST_signal_fail);
169 void srp_interface_get_interface_config (u32 hw_if_index, srp_interface_config_t * c);
170 void srp_interface_set_interface_config (u32 hw_if_index, srp_interface_config_t * c);
172 extern srp_main_t srp_main;
174 always_inline srp_interface_t *
175 srp_get_interface_from_vnet_hw_interface (u32 hw_if_index)
177 srp_main_t * sm = &srp_main;
178 uword * p = hash_get (sm->interface_index_by_hw_if_index, hw_if_index);
179 return p ? pool_elt_at_index (sm->interface_pool, p[0]) : 0;
182 u8 * format_srp_header (u8 * s, va_list * args);
183 u8 * format_srp_header_with_length (u8 * s, va_list * args);
184 u8 * format_srp_device (u8 * s, va_list * args);
186 /* Parse srp header. */
188 unformat_srp_header (unformat_input_t * input, va_list * args);
190 uword unformat_pg_srp_header (unformat_input_t * input, va_list * args);
193 srp_setup_node (vlib_main_t * vm, u32 node_index)
195 vlib_node_t * n = vlib_get_node (vm, node_index);
196 pg_node_t * pn = pg_get_node (node_index);
197 n->format_buffer = format_srp_header_with_length;
198 n->unformat_buffer = unformat_srp_header;
199 pn->unformat_edit = unformat_pg_srp_header;
202 #define foreach_srp_error \
203 _ (NONE, "no error") \
204 _ (UNKNOWN_MODE, "unknown mode in SRP header") \
205 _ (KEEP_ALIVE_DROPPED, "v1 keep alive mode in SRP header") \
206 _ (CONTROL_PACKETS_PROCESSED, "control packets processed") \
207 _ (IPS_PACKETS_PROCESSED, "IPS packets processed") \
208 _ (UNKNOWN_CONTROL, "unknown control packet") \
209 _ (CONTROL_VERSION_NON_ZERO, "control packet with non-zero version") \
210 _ (CONTROL_BAD_CHECKSUM, "control packet with bad checksum") \
211 _ (TOPOLOGY_BAD_LENGTH, "topology packet with bad length")
214 #define _(n,s) SRP_ERROR_##n,
220 serialize_function_t serialize_srp_main, unserialize_srp_main;
222 #endif /* included_srp_h */