FD.io VPP  v19.08.3-2-gbabecb413
Vector Packet Processing
ip6_ll_dpo.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 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
17  * The data-path object representing performing a lookup in the IPv6
18  * link local table
19  */
20 
21 #include <vnet/dpo/ip6_ll_dpo.h>
22 #include <vnet/ip/ip6_ll_table.h>
23 
24 /**
25  * @brief the IP6 link-local DPO is global
26  */
27 static dpo_id_t ip6_ll_dpo = {
29  .dpoi_proto = DPO_PROTO_IP6,
30  .dpoi_index = 0,
31 };
32 
33 const dpo_id_t *
35 {
36  return (&ip6_ll_dpo);
37 }
38 
39 static void
41 {
42  /*
43  * not maintaining a lock count on the ip6_ll, they are const global and
44  * never die.
45  */
46 }
47 
48 static void
50 {
51 }
52 
53 static u8 *
54 format_ip6_ll_dpo (u8 * s, va_list * ap)
55 {
56  CLIB_UNUSED (index_t index) = va_arg (*ap, index_t);
57  CLIB_UNUSED (u32 indent) = va_arg (*ap, u32);
58 
59  return (format (s, "ip6-link-local"));
60 }
61 
62 const static dpo_vft_t ip6_ll_vft = {
64  .dv_unlock = ip6_ll_dpo_unlock,
65  .dv_format = format_ip6_ll_dpo,
66 };
67 
68 /**
69  * @brief The per-protocol VLIB graph nodes that are assigned to a ip6_ll
70  * object.
71  *
72  * this means that these graph nodes are ones from which a ip6_ll is the
73  * parent object in the DPO-graph.
74  */
75 const static char *const ip6_null_nodes[] = {
76  "ip6-link-local",
77  NULL,
78 };
79 
80 const static char *const *const ip6_ll_nodes[DPO_PROTO_NUM] = {
82 };
83 
84 typedef struct ip6_ll_dpo_trace_t_
85 {
89 
90 /**
91  * @brief Exit nodes from a IP6_LL
92  */
93 typedef enum ip6_ll_next_t_
94 {
99 
102  vlib_node_runtime_t * node, vlib_frame_t * frame)
103 {
104  u32 n_left_from, next_index, *from, *to_next;
105 
106  from = vlib_frame_vector_args (frame);
107  n_left_from = frame->n_vectors;
108  next_index = node->cached_next_index;
109 
110  while (n_left_from > 0)
111  {
112  u32 n_left_to_next;
113 
114  vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
115 
116  while (n_left_from > 0 && n_left_to_next > 0)
117  {
118  u32 bi0, fib_index0, next0;
119  vlib_buffer_t *p0;
120 
121  bi0 = from[0];
122  to_next[0] = bi0;
123  from += 1;
124  to_next += 1;
125  n_left_from -= 1;
126  n_left_to_next -= 1;
127  next0 = IP6_LL_NEXT_LOOKUP;
128 
129  p0 = vlib_get_buffer (vm, bi0);
130 
131  /* use the packet's RX interface to pick the link-local FIB */
132  fib_index0 =
134  /* write that fib index into the packet so it's used in the
135  * lookup node next */
136  vnet_buffer (p0)->sw_if_index[VLIB_TX] = fib_index0;
137 
138  if (PREDICT_FALSE (p0->flags & VLIB_BUFFER_IS_TRACED))
139  {
140  ip6_ll_dpo_trace_t *tr = vlib_add_trace (vm, node, p0,
141  sizeof (*tr));
142  tr->sw_if_index = vnet_buffer (p0)->sw_if_index[VLIB_RX];
143  tr->fib_index = fib_index0;
144  }
145  vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
146  n_left_to_next, bi0, next0);
147  }
148 
149  vlib_put_next_frame (vm, node, next_index, n_left_to_next);
150  }
151 
152  return frame->n_vectors;
153 }
154 
155 static u8 *
156 format_ip6_ll_dpo_trace (u8 * s, va_list * args)
157 {
158  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
159  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
160  ip6_ll_dpo_trace_t *t = va_arg (*args, ip6_ll_dpo_trace_t *);
161 
162  s = format (s, "sw_if_index:%d fib_index:%d", t->sw_if_index, t->fib_index);
163  return s;
164 }
165 
166 static uword
168  vlib_node_runtime_t * node, vlib_frame_t * frame)
169 {
170  return (ip6_ll_dpo_inline (vm, node, frame));
171 }
172 
173 /**
174  * @brief
175  */
176 /* *INDENT-OFF* */
178 {
179  .function = ip6_ll_dpo_switch,
180  .name = "ip6-link-local",
181  .vector_size = sizeof (u32),
182  .format_trace = format_ip6_ll_dpo_trace,
183  .n_next_nodes = IP6_LL_NEXT_NUM,
184  .next_nodes = {
185  [IP6_LL_NEXT_DROP] = "ip6-drop",
186  [IP6_LL_NEXT_LOOKUP] = "ip6-lookup",
187  },
188 };
189 /* *INDENT-ON* */
190 
191 void
193 {
194  dpo_register (DPO_IP6_LL, &ip6_ll_vft, ip6_ll_nodes);
195 }
196 
197 /*
198  * fd.io coding-style-patch-verification: ON
199  *
200  * Local Variables:
201  * eval: (c-set-style "gnu")
202  * End:
203  */
u32 flags
buffer flags: VLIB_BUFFER_FREE_LIST_INDEX_MASK: bits used to store free list index, VLIB_BUFFER_IS_TRACED: trace this buffer.
Definition: buffer.h:124
dpo_lock_fn_t dv_lock
A reference counting lock function.
Definition: dpo.h:406
ip6_ll_next_t_
Exit nodes from a IP6_LL.
Definition: ip6_ll_dpo.c:93
#define CLIB_UNUSED(x)
Definition: clib.h:83
A virtual function table regisitered for a DPO type.
Definition: dpo.h:401
static u8 * format_ip6_ll_dpo_trace(u8 *s, va_list *args)
Definition: ip6_ll_dpo.c:156
vlib_node_registration_t ip6_ll_dpo_node
(constructor) VLIB_REGISTER_NODE (ip6_ll_dpo_node)
Definition: ip6_ll_dpo.c:177
static const char *const *const ip6_ll_nodes[DPO_PROTO_NUM]
Definition: ip6_ll_dpo.c:80
static uword ip6_ll_dpo_switch(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: ip6_ll_dpo.c:167
u32 index_t
A Data-Path Object is an object that represents actions that are applied to packets are they are swit...
Definition: dpo.h:41
static void ip6_ll_dpo_lock(dpo_id_t *dpo)
Definition: ip6_ll_dpo.c:40
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
struct ip6_ll_dpo_trace_t_ ip6_ll_dpo_trace_t
static uword ip6_ll_dpo_inline(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: ip6_ll_dpo.c:101
unsigned char u8
Definition: types.h:56
void dpo_register(dpo_type_t type, const dpo_vft_t *vft, const char *const *const *nodes)
For a given DPO type Register:
Definition: dpo.c:322
#define always_inline
Definition: clib.h:99
unsigned int u32
Definition: types.h:88
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:170
static const char *const ip6_null_nodes[]
The per-protocol VLIB graph nodes that are assigned to a ip6_ll object.
Definition: ip6_ll_dpo.c:75
dpo_type_t dpoi_type
the type
Definition: dpo.h:174
enum ip6_ll_next_t_ ip6_ll_next_t
Exit nodes from a IP6_LL.
u32 ip6_ll_fib_get(u32 sw_if_index)
For use in the data plane.
Definition: ip6_ll_table.c:28
#define PREDICT_FALSE(x)
Definition: clib.h:112
#define vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next, n_left_to_next, bi0, next0)
Finish enqueueing one buffer forward in the graph.
Definition: buffer_node.h:218
#define vlib_get_next_frame(vm, node, next_index, vectors, n_vectors_left)
Get pointer to next frame vector data by (vlib_node_runtime_t, next_index).
Definition: node_funcs.h:338
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:169
u16 n_vectors
Definition: node.h:397
vlib_main_t * vm
Definition: buffer.c:323
const dpo_id_t * ip6_ll_dpo_get(void)
The IP6 link-local DPO represents the lookup of a packet in the link-local IPv6 FIB.
Definition: ip6_ll_dpo.c:34
void vlib_put_next_frame(vlib_main_t *vm, vlib_node_runtime_t *r, u32 next_index, u32 n_vectors_left)
Release pointer to next frame vector data.
Definition: main.c:456
u16 cached_next_index
Next frame index that vector arguments were last enqueued to last time this node ran.
Definition: node.h:515
void ip6_ll_dpo_module_init(void)
Definition: ip6_ll_dpo.c:192
static void * vlib_add_trace(vlib_main_t *vm, vlib_node_runtime_t *r, vlib_buffer_t *b, u32 n_data_bytes)
Definition: trace_funcs.h:55
Definition: defs.h:47
#define DPO_PROTO_NUM
Definition: dpo.h:70
static u8 * format_ip6_ll_dpo(u8 *s, va_list *ap)
Definition: ip6_ll_dpo.c:54
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:244
#define vnet_buffer(b)
Definition: buffer.h:365
static void ip6_ll_dpo_unlock(dpo_id_t *dpo)
Definition: ip6_ll_dpo.c:49
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:85
Definition: defs.h:46