blob: 61d7fe6c303b126998a1209835642d969f4e1257 [file] [log] [blame]
Pavel Kotucek0f971d82017-01-03 10:48:54 +01001/*
2 * Copyright (c) 2015-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/** \brief Bind/Unbind an MPLS local label to an IP prefix. i.e. create
17 a per-prefix label entry.
18 @param client_index - opaque cookie to identify the sender
19 @param context - sender context, to match reply w/ request
20 @param mb_mpls_table_id - The MPLS table-id the MPLS entry will be added in
21 @param mb_label - The MPLS label value to bind
22 @param mb_ip_table_id - The IP table-id of the IP prefix to bind to.
23 @param mb_create_table_if_needed - Create either/both tables if required.
24 @param mb_is_bind - Bind or unbind
25 @param mb_is_ip4 - The prefix to bind to is IPv4
26 @param mb_address_length - Length of IP prefix
27 @param mb_address[16] - IP prefix/
28*/
Dave Barach11b8dbf2017-04-24 10:46:54 -040029autoreply define mpls_ip_bind_unbind
Pavel Kotucek0f971d82017-01-03 10:48:54 +010030{
31 u32 client_index;
32 u32 context;
33 u32 mb_mpls_table_id;
34 u32 mb_label;
35 u32 mb_ip_table_id;
36 u8 mb_create_table_if_needed;
37 u8 mb_is_bind;
38 u8 mb_is_ip4;
39 u8 mb_address_length;
40 u8 mb_address[16];
41};
42
Pavel Kotucek0f971d82017-01-03 10:48:54 +010043/** \brief MPLS tunnel Add / del route
44 @param client_index - opaque cookie to identify the sender
45 @param context - sender context, to match reply w/ request
46 @param mt_is_add - Is this a route add or delete
47 @param mt_sw_if_index - The SW interface index of the tunnel to delete
Neale Ranns0f26c5a2017-03-01 15:12:11 -080048 @param mt_is_multicast - Is the tunnel's underlying LSP multicast
Pavel Kotucek0f971d82017-01-03 10:48:54 +010049 @param mt_next_hop_proto_is_ip4 - The next-hop is IPV4
50 @param mt_next_hop_weight - The weight, for UCMP
Neale Ranns57b58602017-07-15 07:37:25 -070051 @param mt_next_hop_preference - The preference
Pavel Kotucek0f971d82017-01-03 10:48:54 +010052 @param mt_next_hop[16] - the nextop address
53 @param mt_next_hop_sw_if_index - the next-hop SW interface
54 @param mt_next_hop_table_id - the next-hop table-id (if appropriate)
55 @param mt_next_hop_n_out_labels - the number of next-hop output labels
56 @param mt_next_hop_out_label_stack - the next-hop output label stack, outer most first
57*/
58define mpls_tunnel_add_del
59{
60 u32 client_index;
61 u32 context;
62 u32 mt_sw_if_index;
63 u8 mt_is_add;
64 u8 mt_l2_only;
Neale Ranns0f26c5a2017-03-01 15:12:11 -080065 u8 mt_is_multicast;
Pavel Kotucek0f971d82017-01-03 10:48:54 +010066 u8 mt_next_hop_proto_is_ip4;
67 u8 mt_next_hop_weight;
Neale Ranns57b58602017-07-15 07:37:25 -070068 u8 mt_next_hop_preference;
Pavel Kotucek0f971d82017-01-03 10:48:54 +010069 u8 mt_next_hop[16];
70 u8 mt_next_hop_n_out_labels;
71 u32 mt_next_hop_sw_if_index;
72 u32 mt_next_hop_table_id;
73 u32 mt_next_hop_out_label_stack[mt_next_hop_n_out_labels];
74};
75
76/** \brief Reply for MPLS tunnel add / del request
77 @param context - returned sender context, to match reply w/ request
78 @param retval - return code
79 @param sw_if_index - SW interface index of the tunnel created
80*/
81define mpls_tunnel_add_del_reply
82{
83 u32 context;
84 i32 retval;
85 u32 sw_if_index;
86};
87
88/** \brief Dump mpls eth tunnel table
89 @param client_index - opaque cookie to identify the sender
90 @param tunnel_index - eth tunnel identifier or -1 in case of all tunnels
91*/
92define mpls_tunnel_dump
93{
94 u32 client_index;
95 u32 context;
96 i32 tunnel_index;
97};
98
Pavel Kotucek0f971d82017-01-03 10:48:54 +010099/** \brief FIB path
100 @param sw_if_index - index of the interface
101 @param weight - The weight, for UCMP
102 @param is_local - local if non-zero, else remote
103 @param is_drop - Drop the packet
104 @param is_unreach - Drop the packet and rate limit send ICMP unreachable
105 @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
106 @param afi - the afi of the next hop, IP46_TYPE_IP4=1, IP46_TYPE_IP6=2
107 @param next_hop[16] - the next hop address
108
109 WARNING: this type is replicated, pending cleanup completion
110
111*/
112typeonly manual_print manual_endian define fib_path2
113{
114 u32 sw_if_index;
115 u32 weight;
116 u8 is_local;
117 u8 is_drop;
118 u8 is_unreach;
119 u8 is_prohibit;
120 u8 afi;
121 u8 next_hop[16];
Neale Ranns0f26c5a2017-03-01 15:12:11 -0800122 u32 labels[16];
123};
124
125/** \brief mpls tunnel details
126*/
127manual_endian manual_print define mpls_tunnel_details
128{
129 u32 context;
130 u8 mt_sw_if_index;
131 u8 mt_tunnel_index;
132 u8 mt_l2_only;
133 u8 mt_is_multicast;
134 u32 mt_count;
135 vl_api_fib_path2_t mt_paths[mt_count];
136};
137
138/** \brief MPLS Route Add / del route
139 @param client_index - opaque cookie to identify the sender
140 @param context - sender context, to match reply w/ request
141 @param mr_label - The MPLS label value
142 @param mr_eos - The End of stack bit
143 @param mr_table_id - The MPLS table-id the route is added in
144 @param mr_classify_table_index - If this is a classify route,
145 this is the classify table index
146 @param mr_create_table_if_needed - If the MPLS or IP tables do not exist,
147 create them
148 @param mr_is_add - Is this a route add or delete
149 @param mr_is_classify - Is this route result a classify
150 @param mr_is_multicast - Is this a multicast route
151 @param mr_is_multipath - Is this route update a multipath - i.e. is this
152 a path addition to an existing route
153 @param mr_is_resolve_host - Recurse resolution constraint via a host prefix
154 @param mr_is_resolve_attached - Recurse resolution constraint via attached prefix
155 @param mr_is_interface_rx - Interface Receive path
156 @param mr_is_interface_rx - RPF-ID Receive path. The next-hop interface
157 is used as the RPF-ID
158 @param mr_next_hop_proto_is_ip4 - The next-hop is IPV4
159 @param mr_next_hop_weight - The weight, for UCMP
160 @param mr_next_hop[16] - the nextop address
161 @param mr_next_hop_sw_if_index - the next-hop SW interface
162 @param mr_next_hop_table_id - the next-hop table-id (if appropriate)
163 @param mr_next_hop_n_out_labels - the number of labels in the label stack
164 @param mr_next_hop_out_label_stack - the next-hop output label stack, outer most first
165 @param next_hop_via_label - The next-hop is a resolved via a local label
166*/
Dave Barach11b8dbf2017-04-24 10:46:54 -0400167autoreply define mpls_route_add_del
Neale Ranns0f26c5a2017-03-01 15:12:11 -0800168{
169 u32 client_index;
170 u32 context;
171 u32 mr_label;
172 u8 mr_eos;
173 u32 mr_table_id;
174 u32 mr_classify_table_index;
175 u8 mr_create_table_if_needed;
176 u8 mr_is_add;
177 u8 mr_is_classify;
178 u8 mr_is_multicast;
179 u8 mr_is_multipath;
180 u8 mr_is_resolve_host;
181 u8 mr_is_resolve_attached;
182 u8 mr_is_interface_rx;
183 u8 mr_is_rpf_id;
184 u8 mr_next_hop_proto_is_ip4;
185 u8 mr_next_hop_weight;
Neale Ranns57b58602017-07-15 07:37:25 -0700186 u8 mr_next_hop_preference;
Neale Ranns0f26c5a2017-03-01 15:12:11 -0800187 u8 mr_next_hop[16];
188 u8 mr_next_hop_n_out_labels;
189 u32 mr_next_hop_sw_if_index;
190 u32 mr_next_hop_table_id;
191 u32 mr_next_hop_via_label;
192 u32 mr_next_hop_out_label_stack[mr_next_hop_n_out_labels];
193};
194
Pavel Kotucek0f971d82017-01-03 10:48:54 +0100195/** \brief Dump MPLS fib table
196 @param client_index - opaque cookie to identify the sender
197*/
198define mpls_fib_dump
199{
200 u32 client_index;
201 u32 context;
202};
203
204/** \brief mpls FIB table response
205 @param table_id - MPLS fib table id
206 @param s_bit - End-of-stack bit
207 @param label - MPLS label value
208 @param count - the number of fib_path in path
209 @param path - array of of fib_path structures
210*/
211manual_endian manual_print define mpls_fib_details
212{
213 u32 context;
214 u32 table_id;
215 u8 eos_bit;
216 u32 label;
217 u32 count;
218 vl_api_fib_path2_t path[count];
219};
220
221/*
222 * Local Variables:
223 * eval: (c-set-style "gnu")
224 * End:
225 */
Dave Barach11b8dbf2017-04-24 10:46:54 -0400226