FD.io VPP  v19.08.3-2-gbabecb413
Vector Packet Processing
dhcp_client_detect.c
Go to the documentation of this file.
1 /*
2  * DHCP feature; applied as an input feature to select DHCP packets
3  *
4  * Copyright (c) 2013 Cisco and/or its affiliates.
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at:
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #include <vnet/dhcp/client.h>
19 #include <vnet/udp/udp.h>
20 
21 #define foreach_dhcp_client_detect \
22  _(EXTRACT, "Extract")
23 
24 typedef enum
25 {
26 #define _(sym,str) DHCP_CLIENT_DETECT_ERROR_##sym,
28 #undef _
31 
33 #define _(sym,string) string,
35 #undef _
36 };
37 
38 typedef enum
39 {
40 #define _(sym,str) DHCP_CLIENT_DETECT_NEXT_##sym,
42 #undef _
45 
46 /**
47  * per-packet trace data
48  */
50 {
51  /* per-pkt trace data */
54 
56  vlib_node_runtime_t * node,
57  vlib_frame_t * frame)
58 {
59  dhcp_client_detect_next_t next_index;
60  u16 dhcp_client_port_network_order;
61  u32 n_left_from, *from, *to_next;
62  u32 extractions;
63 
64  dhcp_client_port_network_order =
65  clib_net_to_host_u16 (UDP_DST_PORT_dhcp_to_client);
66  next_index = 0;
67  extractions = 0;
68  n_left_from = frame->n_vectors;
69  from = vlib_frame_vector_args (frame);
70 
71  while (n_left_from > 0)
72  {
73  u32 n_left_to_next;
74 
75  vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
76 
77  /*
78  * This loop is optimised not so we can really quickly process DHCp
79  * offers... but so we can quickly sift them out when the interface
80  * is also receiving 'normal' packets
81  */
82  while (n_left_from >= 8 && n_left_to_next >= 4)
83  {
84  udp_header_t *udp0, *udp1, *udp2, *udp3;
85  ip4_header_t *ip0, *ip1, *ip2, *ip3;
86  vlib_buffer_t *b0, *b1, *b2, *b3;
87  u32 next0, next1, next2, next3;
88  u32 bi0, bi1, bi2, bi3;
89 
90  next0 = next1 = next2 = next3 = ~0;
91  bi0 = to_next[0] = from[0];
92  bi1 = to_next[1] = from[1];
93  bi2 = to_next[2] = from[2];
94  bi3 = to_next[3] = from[3];
95 
96  /* Prefetch next iteration. */
97  {
98  vlib_buffer_t *p2, *p3, *p4, *p5;
99 
100  p2 = vlib_get_buffer (vm, from[2]);
101  p3 = vlib_get_buffer (vm, from[3]);
102  p4 = vlib_get_buffer (vm, from[4]);
103  p5 = vlib_get_buffer (vm, from[5]);
104 
105  vlib_prefetch_buffer_header (p2, STORE);
106  vlib_prefetch_buffer_header (p3, STORE);
107  vlib_prefetch_buffer_header (p4, STORE);
108  vlib_prefetch_buffer_header (p5, STORE);
109 
110  CLIB_PREFETCH (p2->data, sizeof (ip0[0]) + sizeof (udp0[0]),
111  STORE);
112  CLIB_PREFETCH (p3->data, sizeof (ip0[0]) + sizeof (udp0[0]),
113  STORE);
114  CLIB_PREFETCH (p4->data, sizeof (ip0[0]) + sizeof (udp0[0]),
115  STORE);
116  CLIB_PREFETCH (p5->data, sizeof (ip0[0]) + sizeof (udp0[0]),
117  STORE);
118  }
119 
120  from += 4;
121  to_next += 4;
122  n_left_from -= 4;
123  n_left_to_next -= 4;
124 
125  b0 = vlib_get_buffer (vm, bi0);
126  b1 = vlib_get_buffer (vm, bi1);
127  b2 = vlib_get_buffer (vm, bi2);
128  b3 = vlib_get_buffer (vm, bi3);
129  ip0 = vlib_buffer_get_current (b0);
130  ip1 = vlib_buffer_get_current (b1);
131  ip2 = vlib_buffer_get_current (b2);
132  ip3 = vlib_buffer_get_current (b2);
133 
134  vnet_feature_next (&next0, b0);
135  vnet_feature_next (&next1, b1);
136  vnet_feature_next (&next2, b2);
137  vnet_feature_next (&next3, b3);
138 
139  if (ip0->protocol == IP_PROTOCOL_UDP)
140  {
141  udp0 = (udp_header_t *) (ip0 + 1);
142 
143  if (dhcp_client_port_network_order == udp0->dst_port)
144  {
145  next0 = DHCP_CLIENT_DETECT_NEXT_EXTRACT;
146  extractions++;
147  }
148  }
149  if (ip1->protocol == IP_PROTOCOL_UDP)
150  {
151  udp1 = (udp_header_t *) (ip1 + 1);
152 
153  if (dhcp_client_port_network_order == udp1->dst_port)
154  {
155  next1 = DHCP_CLIENT_DETECT_NEXT_EXTRACT;
156  extractions++;
157  }
158  }
159  if (ip2->protocol == IP_PROTOCOL_UDP)
160  {
161  udp2 = (udp_header_t *) (ip2 + 1);
162 
163  if (dhcp_client_port_network_order == udp2->dst_port)
164  {
165  next2 = DHCP_CLIENT_DETECT_NEXT_EXTRACT;
166  extractions++;
167  }
168  }
169  if (ip3->protocol == IP_PROTOCOL_UDP)
170  {
171  udp3 = (udp_header_t *) (ip3 + 1);
172 
173  if (dhcp_client_port_network_order == udp3->dst_port)
174  {
175  next3 = DHCP_CLIENT_DETECT_NEXT_EXTRACT;
176  extractions++;
177  }
178  }
179 
180  if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
181  {
183  vlib_add_trace (vm, node, b0, sizeof (*t));
184  t->extracted = (next0 == DHCP_CLIENT_DETECT_NEXT_EXTRACT);
185  }
186  if (PREDICT_FALSE (b1->flags & VLIB_BUFFER_IS_TRACED))
187  {
189  vlib_add_trace (vm, node, b1, sizeof (*t));
190  t->extracted = (next1 == DHCP_CLIENT_DETECT_NEXT_EXTRACT);
191  }
192  if (PREDICT_FALSE (b2->flags & VLIB_BUFFER_IS_TRACED))
193  {
195  vlib_add_trace (vm, node, b2, sizeof (*t));
196  t->extracted = (next2 == DHCP_CLIENT_DETECT_NEXT_EXTRACT);
197  }
198  if (PREDICT_FALSE (b3->flags & VLIB_BUFFER_IS_TRACED))
199  {
201  vlib_add_trace (vm, node, b3, sizeof (*t));
202  t->extracted = (next3 == DHCP_CLIENT_DETECT_NEXT_EXTRACT);
203  }
204 
205  /* verify speculative enqueue, maybe switch current next frame */
206  vlib_validate_buffer_enqueue_x4 (vm, node, next_index,
207  to_next, n_left_to_next,
208  bi0, bi1, bi2, bi3,
209  next0, next1, next2, next3);
210  }
211 
212  while (n_left_from > 0 && n_left_to_next > 0)
213  {
214  udp_header_t *udp0;
215  vlib_buffer_t *b0;
216  ip4_header_t *ip0;
217  u32 next0 = ~0;
218  u32 bi0;
219 
220  bi0 = from[0];
221  to_next[0] = bi0;
222  from += 1;
223  to_next += 1;
224  n_left_from -= 1;
225  n_left_to_next -= 1;
226 
227  b0 = vlib_get_buffer (vm, bi0);
228  ip0 = vlib_buffer_get_current (b0);
229 
230  /*
231  * when this feature is applied on an interface that is already
232  * accepting packets (because e.g. the interface has other addresses
233  * assigned) we are looking for the preverbial needle in the haystack
234  * so assume the packet is not the one we are looking for.
235  */
236  vnet_feature_next (&next0, b0);
237 
238  /*
239  * all we are looking for here is DHCP/BOOTP packet-to-client
240  * UDO port.
241  */
242  if (ip0->protocol == IP_PROTOCOL_UDP)
243  {
244  udp0 = (udp_header_t *) (ip0 + 1);
245 
246  if (dhcp_client_port_network_order == udp0->dst_port)
247  {
248  next0 = DHCP_CLIENT_DETECT_NEXT_EXTRACT;
249  extractions++;
250  }
251  }
252 
253  if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
254  {
256  vlib_add_trace (vm, node, b0, sizeof (*t));
257  t->extracted = (next0 == DHCP_CLIENT_DETECT_NEXT_EXTRACT);
258  }
259 
260  /* verify speculative enqueue, maybe switch current next frame */
261  vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
262  to_next, n_left_to_next,
263  bi0, next0);
264  }
265 
266  vlib_put_next_frame (vm, node, next_index, n_left_to_next);
267  }
268 
269  vlib_node_increment_counter (vm, node->node_index,
270  DHCP_CLIENT_DETECT_ERROR_EXTRACT, extractions);
271 
272  return frame->n_vectors;
273 }
274 
275 /* packet trace format function */
276 static u8 *
277 format_dhcp_client_detect_trace (u8 * s, va_list * args)
278 {
279  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
280  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
282  va_arg (*args, dhcp_client_detect_trace_t *);
283 
284  s = format (s, "dhcp-client-detect: %s", (t->extracted ? "yes" : "no"));
285 
286  return s;
287 }
288 
289 /* *INDENT-OFF* */
291  .name = "ip4-dhcp-client-detect",
292  .vector_size = sizeof (u32),
293  .format_trace = format_dhcp_client_detect_trace,
295 
297  .error_strings = dhcp_client_detect_error_strings,
298 
299  .n_next_nodes = DHCP_CLIENT_DETECT_N_NEXT,
300  .next_nodes = {
301  /*
302  * Jump straight to the UDP dispatch node thus avoiding
303  * the RPF checks in ip4-local that will fail
304  */
305  [DHCP_CLIENT_DETECT_NEXT_EXTRACT] = "ip4-udp-lookup",
306  },
307 };
308 
309 VNET_FEATURE_INIT (ip4_dvr_reinject_feat_node, static) =
310 {
311  .arc_name = "ip4-unicast",
312  .node_name = "ip4-dhcp-client-detect",
313  .runs_before = VNET_FEATURES ("ip4-not-enabled"),
314 };
315 
316 /* *INDENT-ON* */
317 
318 /*
319  * fd.io coding-style-patch-verification: ON
320  *
321  * Local Variables:
322  * eval: (c-set-style "gnu")
323  * End:
324  */
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
#define CLIB_UNUSED(x)
Definition: clib.h:83
per-packet trace data
struct dhcp_client_detect_trace_t_ dhcp_client_detect_trace_t
per-packet trace data
#define vlib_validate_buffer_enqueue_x4(vm, node, next_index, to_next, n_left_to_next, bi0, bi1, bi2, bi3, next0, next1, next2, next3)
Finish enqueueing four buffers forward in the graph.
Definition: buffer_node.h:138
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
#define VLIB_NODE_FN(node)
Definition: node.h:202
unsigned char u8
Definition: types.h:56
#define vlib_prefetch_buffer_header(b, type)
Prefetch buffer metadata.
Definition: buffer.h:203
unsigned int u32
Definition: types.h:88
vl_api_fib_path_type_t type
Definition: fib_types.api:123
unsigned short u16
Definition: types.h:57
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:229
dhcp_client_detect_next_t
#define PREDICT_FALSE(x)
Definition: clib.h:112
static u8 * format_dhcp_client_detect_trace(u8 *s, va_list *args)
#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
static void vlib_node_increment_counter(vlib_main_t *vm, u32 node_index, u32 counter_index, u64 increment)
Definition: node_funcs.h:1150
#define foreach_dhcp_client_detect
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:169
#define CLIB_PREFETCH(addr, size, type)
Definition: cache.h:80
vlib_main_t * vm
Definition: buffer.c:323
static_always_inline void vnet_feature_next(u32 *next0, vlib_buffer_t *b0)
Definition: feature.h:302
u8 data[]
Packet data.
Definition: buffer.h:181
#define ARRAY_LEN(x)
Definition: clib.h:63
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
#define VNET_FEATURES(...)
Definition: feature.h:442
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
vlib_node_registration_t dhcp_client_detect_node
(constructor) VLIB_REGISTER_NODE (dhcp_client_detect_node)
VLIB buffer representation.
Definition: buffer.h:102
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:244
dhcp_client_detect_error_t
static char * dhcp_client_detect_error_strings[]
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
VNET_FEATURE_INIT(ip4_dvr_reinject_feat_node, static)