2 * Copyright (c) 2016 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.
18 * @brief Definitions for punt infrastructure.
20 #ifndef included_punt_h
21 #define included_punt_h
25 #include <vnet/ip/ip.h>
27 #define foreach_punt_type \
29 _(EXCEPTION, "exception")
31 typedef enum punt_type_t_
33 #define _(v, s) PUNT_TYPE_##v,
38 typedef struct punt_l4_t_
40 ip_address_family_t af;
41 ip_protocol_t protocol;
45 typedef struct punt_exception_t_
47 vlib_punt_reason_t reason;
50 typedef struct punt_union_t_
52 punt_exception_t exception;
56 typedef struct punt_reg_t_
63 clib_error_t *vnet_punt_add_del (vlib_main_t * vm,
64 const punt_reg_t * pr, bool is_add);
65 clib_error_t *vnet_punt_socket_add (vlib_main_t * vm,
67 const punt_reg_t * pr,
68 char *client_pathname);
69 clib_error_t *vnet_punt_socket_del (vlib_main_t * vm, const punt_reg_t * pr);
70 char *vnet_punt_get_server_pathname (void);
80 * Packet descriptor header. Version 1
81 * If this header changes, the version must also change to notify clients.
83 #define PUNT_PACKETDESC_VERSION 1
84 typedef struct __attribute__ ((packed))
86 u32 sw_if_index; /* RX or TX interface */
87 enum punt_action_e action;
96 struct sockaddr_un caddr;
99 typedef struct punt_client_db_t_
101 void *clients_by_l4_port;
102 u32 *clients_by_exception;
108 char sun_path[sizeof (struct sockaddr_un)];
110 punt_client_t *punt_client_pool;
113 vlib_node_t *interface_output_node;
119 extern punt_main_t punt_main;
121 typedef walk_rc_t (*punt_client_walk_cb_t) (const punt_client_t * pc,
123 extern void punt_client_walk (punt_type_t pt,
124 punt_client_walk_cb_t cb, void *ctx);
127 * inlines for the data-plane
129 static_always_inline u32
130 punt_client_l4_mk_key (ip_address_family_t af, u16 port)
132 return (af << BITS (port) | port);
135 static_always_inline punt_client_t *
136 punt_client_l4_get (ip_address_family_t af, u16 port)
138 punt_main_t *pm = &punt_main;
141 p = hash_get (pm->db.clients_by_l4_port, punt_client_l4_mk_key (af, port));
144 return (pool_elt_at_index (pm->punt_client_pool, p[0]));
149 static_always_inline punt_client_t *
150 punt_client_exception_get (vlib_punt_reason_t reason)
152 punt_main_t *pm = &punt_main;
155 if (reason >= vec_len (pm->db.clients_by_exception))
158 pci = pm->db.clients_by_exception[reason];
161 return (pool_elt_at_index (pm->punt_client_pool, pci));
166 extern vlib_node_registration_t udp4_punt_node;
167 extern vlib_node_registration_t udp6_punt_node;
168 extern vlib_node_registration_t udp4_punt_socket_node;
169 extern vlib_node_registration_t udp6_punt_socket_node;
170 extern vlib_node_registration_t punt_socket_rx_node;
175 * fd.io coding-style-patch-verification: ON
178 * eval: (c-set-style "gnu")