FD.io VPP  v20.01-48-g3e0dafb74
Vector Packet Processing
abf.api
Go to the documentation of this file.
1 /* Hey Emacs use -*- mode: C -*- */
2 /*
3  * Copyright (c) 2016 Cisco and/or its affiliates.
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 /** \file
18  This file defines the vpp control-plane API messages
19  used to control the ABF plugin
20 */
21 
22 option version = "1.0.0";
23 import "vnet/ip/ip_types.api";
24 import "vnet/fib/fib_types.api";
25 import "vnet/interface_types.api";
26 
27 /** \brief Get the plugin version
28  @param client_index - opaque cookie to identify the sender
29  @param context - sender context, to match reply w/ request
30 */
31 define abf_plugin_get_version
32 {
35 };
36 
37 /** \brief Reply to get the plugin version
38  @param context - returned sender context, to match reply w/ request
39  @param major - Incremented every time a known breaking behavior change is introduced
40  @param minor - Incremented with small changes, may be used to avoid buggy versions
41 */
42 define abf_plugin_get_version_reply
43 {
47 };
48 
49 /** \brief A description of an ABF policy
50  @param policy_id User chosen Identifier for the policy
51  @param acl_index The ACL that the policy will match against
52  @param n_paths Number of paths
53  @param paths The set of forwarding paths that are being added or removed.
54  */
55 typedef abf_policy
56 {
57  u32 policy_id;
60  vl_api_fib_path_t paths[n_paths];
61 };
62 
63 /** \brief A description of an ABF policy
64  @param is_add Is this the addition or removal of paths from the policy
65  If the policy does not exist it is created. If the last path
66  Is being removed, the policy is deleted
67  @param policy The policy
68  */
69 autoreply define abf_policy_add_del
70 {
73  bool is_add;
74  vl_api_abf_policy_t policy;
75 };
76 
77 /** \brief Policy description returned in the dump
78  */
79 define abf_policy_details
80 {
82  vl_api_abf_policy_t policy;
83 };
84 
85 /** \brief Dump all ABF policies
86  */
87 define abf_policy_dump
88 {
91 };
92 
93 /** \brief A description of a policy attachment to an interface
94  @param The policy ID to attach
95  @param sw_if_index The interface to attach to
96  @param priority The priority of the attachment, w.r.t. to other attachments
97  on this interface. lower value is 'better'
98  @param is_ipv6 Does this attachment apply to IPv6 packets (or IPv4)
99 */
100 typedef abf_itf_attach
101 {
102  u32 policy_id;
103  vl_api_interface_index_t sw_if_index;
105  bool is_ipv6;
106 };
107 
108 /** \brief Add or delete a policy attachment to an interface
109  */
110 autoreply define abf_itf_attach_add_del
111 {
114  bool is_add;
115  vl_api_abf_itf_attach_t attach;
116 };
117 
118 /** \brief Attachment details from a dump
119  */
120 define abf_itf_attach_details
121 {
123  vl_api_abf_itf_attach_t attach;
124 };
125 
126 /** \brief Dump all the policy attachments
127  */
128 define abf_itf_attach_dump
129 {
132 };
133 
u8 n_paths
Definition: abf.api:59
u32 acl_index
Definition: abf.api:58
vl_api_abf_policy_t policy
Definition: abf.api:82
option version
Definition: abf.api:22
unsigned char u8
Definition: types.h:56
vl_api_abf_itf_attach_t attach
Definition: abf.api:123
unsigned int u32
Definition: types.h:88
typedef abf_policy
A description of an ABF policy.
Definition: abf.api:56
vl_api_interface_index_t sw_if_index
Definition: abf.api:103
vl_api_fib_path_t paths[n_paths]
Definition: abf.api:60
vl_api_abf_policy_t policy
Definition: abf.api:74
bool is_ipv6
Definition: abf.api:105
u32 priority
Definition: abf.api:104
typedef abf_itf_attach
A description of a policy attachment to an interface.
Definition: abf.api:101
vl_api_abf_itf_attach_t attach
Definition: abf.api:115