2 * Copyright (c) 2015-2019 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 option version = "2.1.0";
17 import "vnet/ip/ip_types.api";
19 /** \brief The types of packets to be punted
23 /* L4 (UDP) packets */
25 /* Exception packets handled by the VLIB punt infra */
26 PUNT_API_TYPE_EXCEPTION,
29 /** \brief Punt L4 traffic definition
30 @param af - Address Family, IPv4 or IPV6
31 @param protocol - L4 protocol to be punted
32 @param port - TCP/UDP port to be punted
36 vl_api_address_family_t af;
37 vl_api_ip_proto_t protocol;
41 /** \brief The ID of the punt exception reason
42 Dump all the reasons to obtain this
44 typedef punt_exception
49 /** \brief Union of the different punt packet descriptions
53 vl_api_punt_exception_t exception;
57 /** \brief Full description of which packets are requested to be punted
58 @param type - Which packet type
59 @param punt - Description corresponding to the type
63 vl_api_punt_type_t type;
64 vl_api_punt_union_t punt;
67 /** \brief Punt traffic to the host
68 @param client_index - opaque cookie to identify the sender
69 @param context - sender context, to match reply w/ request
70 @param is_add - add punt if non-zero, else delete
71 @param punt - punt definition, only UDP (0x11) is supported
73 autoreply define set_punt {
80 /** \brief Punt traffic to the host via socket
81 @param client_index - opaque cookie to identify the sender
82 @param context - sender context, to match reply w/ request
83 @param header_version - expected meta data header version (currently 1)
84 @param punt - punt definition
86 define punt_socket_register {
91 u8 pathname[108]; /* Linux sun_path defined to be 108 bytes, see unix(7) */
94 define punt_socket_register_reply
101 define punt_socket_dump
105 vl_api_punt_type_t type;
108 define punt_socket_details
115 autoreply define punt_socket_deregister {
121 /** \brief Dump all of the excpetion punt reasons
123 define punt_reason_dump
135 define punt_reason_details
138 vl_api_punt_reason_t reason;
143 * eval: (c-set-style "gnu")