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 /* Punting reason flags bitfield
28 * (position, length, value, name, string)
30 #define foreach_vnet_punt_reason_flag \
31 _ (0, 1, 0, IP4_PACKET, "ip4-packet") \
32 _ (0, 1, 1, IP6_PACKET, "ip6-packet")
34 typedef enum vnet_punt_reason_flag_t_
36 #define _(pos, len, value, name, str) \
37 VNET_PUNT_REASON_F_##name = ((value) << (pos)),
38 foreach_vnet_punt_reason_flag
40 } __clib_packed vnet_punt_reason_flag_t;
42 enum vnet_punt_reason_flag_mask_t_
44 #define _(pos, len, value, name, str) \
45 VNET_PUNT_REASON_F_MASK_##name = (((1 << (len)) - 1) << (pos)),
46 foreach_vnet_punt_reason_flag
50 /* predicates associated with vlib_punt_reason_flag_t*/
51 #define _(pos, len, value, name, str) \
52 static_always_inline int vnet_punt_reason_flag_is_##name ( \
53 vnet_punt_reason_flag_t f) \
55 return (f & VNET_PUNT_REASON_F_MASK_##name) == VNET_PUNT_REASON_F_##name; \
57 foreach_vnet_punt_reason_flag
60 #define foreach_punt_type \
62 _(EXCEPTION, "exception") \
63 _(IP_PROTO, "ip-proto")
65 typedef enum punt_type_t_ {
66 #define _(v, s) PUNT_TYPE_##v,
71 typedef struct punt_l4_t_
73 ip_address_family_t af;
74 ip_protocol_t protocol;
78 typedef struct punt_ip_proto_t_
80 ip_address_family_t af;
81 ip_protocol_t protocol;
84 typedef struct punt_exception_t_
86 vlib_punt_reason_t reason;
89 typedef struct punt_union_t_
91 punt_exception_t exception;
93 punt_ip_proto_t ip_proto;
96 typedef struct punt_reg_t_
103 clib_error_t *vnet_punt_add_del (vlib_main_t * vm,
104 const punt_reg_t * pr, bool is_add);
105 clib_error_t *vnet_punt_socket_add (vlib_main_t * vm,
107 const punt_reg_t * pr,
108 char *client_pathname);
109 clib_error_t *vnet_punt_socket_del (vlib_main_t * vm, const punt_reg_t * pr);
110 char *vnet_punt_get_server_pathname (void);
120 * Packet descriptor header. Version 1
121 * If this header changes, the version must also change to notify clients.
123 #define PUNT_PACKETDESC_VERSION 1
124 typedef struct __attribute__ ((packed))
126 u32 sw_if_index; /* RX or TX interface */
127 enum punt_action_e action;
131 * Client registration
136 struct sockaddr_un caddr;
139 typedef struct punt_client_db_t_
141 void *clients_by_l4_port;
142 u32 *clients_by_exception;
143 void *clients_by_ip_proto;
146 typedef struct punt_thread_data_t_
148 struct iovec *iovecs;
149 } punt_thread_data_t;
154 char sun_path[sizeof (struct sockaddr_un)];
156 punt_client_t *punt_client_pool;
159 vlib_node_t *interface_output_node;
162 punt_thread_data_t *thread_data;
167 extern punt_main_t punt_main;
169 typedef walk_rc_t (*punt_client_walk_cb_t) (const punt_client_t * pc,
171 extern void punt_client_walk (punt_type_t pt,
172 punt_client_walk_cb_t cb, void *ctx);
174 extern u8 *format_vnet_punt_reason_flags (u8 *s, va_list *args);
177 * inlines for the data-plane
179 static_always_inline u32
180 punt_client_l4_mk_key (ip_address_family_t af, u16 port)
182 return (af << BITS (port) | port);
185 static_always_inline punt_client_t *
186 punt_client_l4_get (ip_address_family_t af, u16 port)
188 punt_main_t *pm = &punt_main;
191 p = hash_get (pm->db.clients_by_l4_port, punt_client_l4_mk_key (af, port));
194 return (pool_elt_at_index (pm->punt_client_pool, p[0]));
199 static_always_inline u32
200 punt_client_ip_proto_mk_key (ip_address_family_t af, ip_protocol_t proto)
202 return (af << 16 | proto);
205 static_always_inline punt_client_t *
206 punt_client_ip_proto_get (ip_address_family_t af, ip_protocol_t proto)
208 punt_main_t *pm = &punt_main;
212 hash_get (pm->db.clients_by_ip_proto,
213 punt_client_ip_proto_mk_key (af, proto));
216 return (pool_elt_at_index (pm->punt_client_pool, p[0]));
221 static_always_inline punt_client_t *
222 punt_client_exception_get (vlib_punt_reason_t reason)
224 punt_main_t *pm = &punt_main;
227 if (reason >= vec_len (pm->db.clients_by_exception))
230 pci = pm->db.clients_by_exception[reason];
233 return (pool_elt_at_index (pm->punt_client_pool, pci));
238 extern vlib_node_registration_t udp4_punt_node;
239 extern vlib_node_registration_t udp6_punt_node;
240 extern vlib_node_registration_t udp4_punt_socket_node;
241 extern vlib_node_registration_t udp6_punt_socket_node;
242 extern vlib_node_registration_t ip4_proto_punt_socket_node;
243 extern vlib_node_registration_t ip6_proto_punt_socket_node;
244 extern vlib_node_registration_t punt_socket_rx_node;
249 * fd.io coding-style-patch-verification: ON
252 * eval: (c-set-style "gnu")