BIER
[vpp.git] / src / vnet / bier / bier_output.c
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 #include <vnet/buffer.h>
17
18 #include <vnet/bier/bier_fmask.h>
19 #include <vnet/bier/bier_hdr_inlines.h>
20 #include <vlib/vlib.h>
21
22 static char * bier_output_error_strings[] = {
23 #define bier_error(n,s) s,
24 #include <vnet/bier/bier_output_error.def>
25 #undef bier_error
26 };
27
28 /*
29  * Keep these values sematically the same as BIER output
30  */
31 #define foreach_bier_output_next                \
32     _(DROP, "bier-drop")
33
34 typedef enum {
35 #define _(s,n) BIER_OUTPUT_NEXT_##s,
36     foreach_bier_output_next
37 #undef _
38     BIER_OUTPUT_N_NEXT,
39 } bier_output_next_t;
40
41 typedef enum {
42 #define bier_error(n,s) BIER_OUTPUT_ERROR_##n,
43 #include <vnet/bier/bier_output_error.def>
44 #undef bier_error
45     BIER_OUTPUT_N_ERROR,
46 } bier_output_error_t;
47
48 /**
49  * Forward declaration
50  */
51 vlib_node_registration_t bier_output_node;
52
53 /**
54  * @brief Packet trace recoed for a BIER output
55  */
56 typedef struct bier_output_trace_t_
57 {
58     u32 next_index;
59     index_t bfm_index;
60 } bier_output_trace_t;
61
62 static uword
63 bier_output (vlib_main_t * vm,
64              vlib_node_runtime_t * node,
65              vlib_frame_t * from_frame)
66 {
67     u32 n_left_from, next_index, * from, * to_next;
68
69     from = vlib_frame_vector_args (from_frame);
70     n_left_from = from_frame->n_vectors;
71
72     // vnet_buffer(b0)->sw_if_index[VLIB_TX] = d0->tx_fib_index;
73
74     /*
75      * objection your honour! speculation!
76      */
77     next_index = node->cached_next_index;
78
79     while (n_left_from > 0)
80     {
81         u32 n_left_to_next;
82
83         vlib_get_next_frame (vm, node, next_index,
84                              to_next, n_left_to_next);
85
86         while (n_left_from > 0 && n_left_to_next > 0)
87         {
88             bier_output_next_t next0;
89             bier_bit_string_t bbs;
90             vlib_buffer_t * b0;
91             bier_fmask_t *bfm0;
92             bier_hdr_t *bh0;
93             u32 bi0, *h0;
94             u32 bfmi0;
95
96             bi0 = from[0];
97             to_next[0] = bi0;
98             from += 1;
99             to_next += 1;
100             n_left_from -= 1;
101             n_left_to_next -= 1;
102
103             b0 = vlib_get_buffer (vm, bi0);
104             bh0 = vlib_buffer_get_current (b0);
105             bier_bit_string_init_from_hdr(bh0, &bbs);
106
107             /*
108              * In the BIER Lookup node we squirelled away the
109              * BIER fmask index as the adj index
110              */
111             bfmi0 = vnet_buffer (b0)->ip.adj_index[VLIB_TX];
112             bfm0 = bier_fmask_get(bfmi0);
113
114             /*
115              * perform the logical AND of the packet's mask with
116              * that of the fmask objects, to reset the bits that
117              * are only on the shortest path the the fmask NH.
118              */
119             bier_bit_string_logical_and_string(
120                 &bfm0->bfm_bits.bfmb_input_reset_string,
121                 &bbs);
122
123             /*
124              * this is the last time we touch the BIER header
125              * so flip to network order
126              */
127             bier_hdr_hton(bh0);
128
129             /*
130              * paint the BIER peer's label
131              */
132             if (!(bfm0->bfm_flags & BIER_FMASK_FLAG_DISP))
133             {
134                 vlib_buffer_advance(b0, -(word)sizeof(mpls_label_t));
135                 h0 = vlib_buffer_get_current(b0);
136                 h0[0] = bfm0->bfm_label;
137             }
138
139             /*
140              * setup next graph node
141              */
142             next0 = bfm0->bfm_dpo.dpoi_next_node;
143             vnet_buffer(b0)->ip.adj_index[VLIB_TX] = bfm0->bfm_dpo.dpoi_index;
144
145             if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
146             {
147                 bier_output_trace_t *tr;
148
149                 tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
150                 tr->next_index = next0;
151                 tr->bfm_index = bfmi0;
152             }
153
154             vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
155                                              to_next, n_left_to_next,
156                                              bi0, next0);
157         }
158
159         vlib_put_next_frame (vm, node, next_index, n_left_to_next);
160     }
161
162     vlib_node_increment_counter (vm, bier_output_node.index,
163                                  BIER_OUTPUT_ERROR_NONE,
164                                  from_frame->n_vectors);
165     return (from_frame->n_vectors);
166 }
167
168 static u8 *
169 format_bier_output_trace (u8 * s, va_list * args)
170 {
171     CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
172     CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
173     bier_output_trace_t * t = va_arg (*args, bier_output_trace_t *);
174
175     s = format (s, " next [%d], BFM index %d",
176                 t->next_index, t->bfm_index);
177     return s;
178 }
179
180 VLIB_REGISTER_NODE (bier_output_node) = {
181     .function = bier_output,
182     .name = "bier-output",
183     /* Takes a vector of packets. */
184     .vector_size = sizeof (u32),
185
186     .n_errors = BIER_OUTPUT_N_ERROR,
187     .error_strings = bier_output_error_strings,
188
189     .n_next_nodes = BIER_OUTPUT_N_NEXT,
190     .next_nodes = {
191         [BIER_OUTPUT_NEXT_DROP] = "bier-drop",
192     },
193
194     .format_trace = format_bier_output_trace,
195 };