reassembly: feature/concurrency
[vpp.git] / src / vnet / ip / punt.h
1 /*
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:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15
16 /**
17  * @file
18  * @brief Definitions for punt infrastructure.
19  */
20 #ifndef included_punt_h
21 #define included_punt_h
22
23 #include <sys/un.h>
24 #include <stdbool.h>
25
26 typedef enum
27 {
28 #define punt_error(n,s) PUNT_ERROR_##n,
29 #include <vnet/ip/punt_error.def>
30 #undef punt_error
31   PUNT_N_ERROR,
32 } punt_error_t;
33
34
35 clib_error_t *vnet_punt_add_del (vlib_main_t * vm, u8 ipv,
36                                  u8 protocol, u16 port, bool is_add);
37 clib_error_t *vnet_punt_socket_add (vlib_main_t * vm, u32 header_version,
38                                     bool is_ip4, u8 protocol, u16 port,
39                                     char *client_pathname);
40 clib_error_t *vnet_punt_socket_del (vlib_main_t * vm, bool is_ip4,
41                                     u8 l4_protocol, u16 port);
42 char *vnet_punt_get_server_pathname (void);
43
44 enum punt_action_e
45 {
46   PUNT_L2 = 0,
47   PUNT_IP4_ROUTED,
48   PUNT_IP6_ROUTED,
49 };
50
51 /*
52  * Packet descriptor header. Version 1
53  * If this header changes, the version must also change to notify clients.
54  */
55 #define PUNT_PACKETDESC_VERSION 1
56 typedef struct __attribute__ ((packed))
57 {
58   u32 sw_if_index;              /* RX or TX interface */
59   enum punt_action_e action;
60 } punt_packetdesc_t;
61
62 /*
63  * Client registration
64  */
65 typedef struct
66 {
67   u16 port;
68   struct sockaddr_un caddr;
69 } punt_client_t;
70
71 typedef struct
72 {
73   int socket_fd;
74   char sun_path[sizeof (struct sockaddr_un)];
75   punt_client_t *clients_by_dst_port4;
76   punt_client_t *clients_by_dst_port6;
77   u32 clib_file_index;
78   bool is_configured;
79   vlib_node_t *interface_output_node;
80   u32 *ready_fds;
81   u32 *rx_buffers;
82 } punt_main_t;
83 extern punt_main_t punt_main;
84
85 #endif
86
87 /*
88  * fd.io coding-style-patch-verification: ON
89  *
90  * Local Variables:
91  * eval: (c-set-style "gnu")
92  * End:
93  */