2 * node.c - skeleton vpp engine plug-in dual-loop node skeleton
4 * Copyright (c) <current-year> <your-organization>
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:
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #include <vlib/vlib.h>
18 #include <vnet/vnet.h>
19 #include <vppinfra/error.h>
20 #include <mactime/mactime.h>
21 #include <vnet/ip/ip4.h>
31 vlib_node_registration_t mactime_node;
32 vlib_node_registration_t mactime_tx_node;
34 #define foreach_mactime_error \
35 _(OK, "Permitted packets") \
36 _(STATIC_DROP, "Static drop packets") \
37 _(RANGE_DROP, "Range drop packets") \
38 _(QUOTA_DROP, "Data quota drop packets") \
39 _(DROP_10001, "Dropped UDP DST-port 10001")
43 #define _(sym,str) MACTIME_ERROR_##sym,
49 static char *mactime_error_strings[] = {
50 #define _(sym,string) string,
58 MACTIME_NEXT_ETHERNET_INPUT,
62 /* packet trace format function */
64 format_mactime_trace (u8 * s, va_list * args)
66 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
67 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
68 mactime_trace_t *t = va_arg (*args, mactime_trace_t *);
70 s = format (s, "MACTIME: src mac %U device %s result %s\n",
71 format_mac_address, t->src_mac,
72 (t->device_index != ~0) ? t->device_name : (u8 *) "unknown",
73 t->next_index == MACTIME_NEXT_DROP ? "drop" : "pass");
78 mactime_node_inline (vlib_main_t * vm,
79 vlib_node_runtime_t * node, vlib_frame_t * frame,
82 u32 n_left_from, *from, *to_next;
83 mactime_next_t next_index;
84 mactime_main_t *mm = &mactime_main;
86 clib_bihash_kv_8_8_t kv;
87 clib_bihash_8_8_t *lut = &mm->lookup_table;
90 u32 thread_index = vm->thread_index;
91 vnet_main_t *vnm = vnet_get_main ();
92 vnet_interface_main_t *im = &vnm->interface_main;
93 u8 arc = im->output_feature_arc_index;
94 vnet_feature_config_main_t *fcm;
97 fcm = vnet_feature_get_config_main (arc);
99 now = clib_timebase_now (&mm->timebase);
101 if (PREDICT_FALSE ((now - mm->sunday_midnight) > 86400.0 * 7.0))
102 mm->sunday_midnight = clib_timebase_find_sunday_midnight (now);
104 from = vlib_frame_vector_args (frame);
105 n_left_from = frame->n_vectors;
106 next_index = node->cached_next_index;
108 while (n_left_from > 0)
112 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
114 while (n_left_from > 0 && n_left_to_next > 0)
121 ethernet_header_t *en0;
122 int has_dynamic_range_allow = 0;
125 /* speculatively enqueue b0 to the current next frame */
133 b0 = vlib_get_buffer (vm, bi0);
135 /* Set next0 to e.g. interface-tx */
137 vnet_get_config_data (&fcm->config_main,
138 &b0->current_config_index, &next0,
139 /* # bytes of config data */ 0);
141 next0 = MACTIME_NEXT_ETHERNET_INPUT;
143 vlib_buffer_advance (b0, -(word) vnet_buffer (b0)->l2_hdr_offset);
145 len0 = vlib_buffer_length_in_chain (vm, b0);
146 en0 = vlib_buffer_get_current (b0);
149 clib_memcpy_fast (&kv.key, en0->dst_address, 6);
151 clib_memcpy_fast (&kv.key, en0->src_address, 6);
153 /* Lookup the src/dst mac address */
154 if (clib_bihash_search_8_8 (lut, &kv, &kv) < 0)
156 /* Create a table entry... */
157 mactime_send_create_entry_message
158 (is_tx ? en0->dst_address : en0->src_address);
160 /* and let this packet pass */
167 device_index0 = kv.value;
169 dp = pool_elt_at_index (mm->devices, device_index0);
171 /* Known device, check for an always-on traffic quota */
172 if ((dp->flags & MACTIME_DEVICE_FLAG_DYNAMIC_ALLOW)
173 && PREDICT_FALSE (dp->data_quota))
175 vlib_counter_t device_current_count;
176 vlib_get_combined_counter (&mm->allow_counters,
178 &device_current_count);
179 if (device_current_count.bytes >= dp->data_quota)
181 next0 = MACTIME_NEXT_DROP;
182 b0->error = node->errors[MACTIME_ERROR_QUOTA_DROP];
183 vlib_increment_combined_counter
184 (&mm->drop_counters, thread_index, dp - mm->devices, 1,
190 /* Static drop / allow? */
193 (MACTIME_DEVICE_FLAG_STATIC_DROP
194 | MACTIME_DEVICE_FLAG_STATIC_ALLOW)))
196 if (dp->flags & MACTIME_DEVICE_FLAG_STATIC_DROP)
198 next0 = MACTIME_NEXT_DROP;
199 b0->error = node->errors[MACTIME_ERROR_STATIC_DROP];
200 vlib_increment_combined_counter
201 (&mm->drop_counters, thread_index, dp - mm->devices, 1,
204 else /* note next0 set to allow */
207 * Special-case mini-ACL for a certain species of
208 * home security DVR which likes to "call home."
211 (dp->flags & MACTIME_DEVICE_FLAG_DROP_UDP_10001))
213 ip4_header_t *ip = (void *) (((u8 *) en0) + 14);
214 udp_header_t *udp = (udp_header_t *) (ip + 1);
215 if (ip->protocol != IP_PROTOCOL_UDP)
217 if (clib_net_to_host_u16 (udp->dst_port) == 10001 ||
218 clib_net_to_host_u16 (udp->dst_port) == 9603)
220 next0 = MACTIME_NEXT_DROP;
221 b0->error = node->errors[MACTIME_ERROR_DROP_10001];
229 vlib_increment_combined_counter
230 (&mm->allow_counters, thread_index, dp - mm->devices,
238 /* Known device, see if traffic allowed at the moment */
239 for (i = 0; i < vec_len (dp->ranges); i++)
241 clib_timebase_range_t *r = dp->ranges + i;
244 start0 = r->start + mm->sunday_midnight;
245 end0 = r->end + mm->sunday_midnight;
246 if (dp->flags & MACTIME_DEVICE_FLAG_DYNAMIC_ALLOW_QUOTA)
247 has_dynamic_range_allow = 1;
249 /* Packet within time range */
250 if (now >= start0 && now <= end0)
252 /* And it's a drop range, drop it */
253 if (dp->flags & MACTIME_DEVICE_FLAG_DYNAMIC_DROP)
255 vlib_increment_combined_counter
256 (&mm->drop_counters, thread_index,
257 dp - mm->devices, 1, len0);
258 next0 = MACTIME_NEXT_DROP;
259 b0->error = node->errors[MACTIME_ERROR_RANGE_DROP];
262 /* Quota-check allow range? */
263 else if (has_dynamic_range_allow)
265 if (dp->data_used_in_range + len0 >= dp->data_quota)
267 next0 = MACTIME_NEXT_DROP;
268 b0->error = node->errors[MACTIME_ERROR_QUOTA_DROP];
269 vlib_increment_combined_counter
270 (&mm->drop_counters, thread_index,
271 dp - mm->devices, 1, len0);
276 dp->data_used_in_range += len0;
281 { /* it's an allow range, allow it */
283 vlib_increment_combined_counter
284 (&mm->allow_counters, thread_index,
285 dp - mm->devices, 1, len0);
292 * Didn't hit a range, so *drop* if allow configured, or
293 * *allow* if drop configured.
295 if (dp->flags & MACTIME_DEVICE_FLAG_DYNAMIC_ALLOW)
297 next0 = MACTIME_NEXT_DROP;
298 b0->error = node->errors[MACTIME_ERROR_STATIC_DROP];
299 vlib_increment_combined_counter
300 (&mm->drop_counters, thread_index, dp - mm->devices, 1, len0);
302 else /* DYNAMIC_DROP, DYNAMIC_RANGE_ALLOW_QUOTA */
304 vlib_increment_combined_counter
305 (&mm->allow_counters, thread_index, dp - mm->devices, 1,
307 /* Clear the data quota accumulater */
308 dp->data_used_in_range = 0;
313 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
314 && (b0->flags & VLIB_BUFFER_IS_TRACED)))
316 mactime_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
317 clib_memcpy_fast (t->src_mac, en0->src_address,
318 sizeof (t->src_mac));
320 t->next_index = next0;
321 t->device_index = device_index0;
325 clib_memcpy_fast (t->device_name, dp->device_name,
326 ARRAY_LEN (t->device_name));
327 t->device_name[ARRAY_LEN (t->device_name) - 1] = 0;
331 /* verify speculative enqueue, maybe switch current next frame */
332 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
333 to_next, n_left_to_next,
337 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
340 vlib_node_increment_counter (vm, node->node_index,
341 MACTIME_ERROR_OK, packets_ok);
342 return frame->n_vectors;
346 mactime_node_fn (vlib_main_t * vm,
347 vlib_node_runtime_t * node, vlib_frame_t * frame)
349 return mactime_node_inline (vm, node, frame, 0 /* is_tx */ );
353 VLIB_REGISTER_NODE (mactime_node) =
355 .function = mactime_node_fn,
357 .vector_size = sizeof (u32),
358 .format_trace = format_mactime_trace,
359 .type = VLIB_NODE_TYPE_INTERNAL,
361 .n_errors = ARRAY_LEN(mactime_error_strings),
362 .error_strings = mactime_error_strings,
364 .n_next_nodes = MACTIME_N_NEXT,
366 /* edit / add dispositions here */
369 [MACTIME_NEXT_ETHERNET_INPUT] = "ethernet-input",
370 [MACTIME_NEXT_DROP] = "error-drop",
376 mactime_tx_node_fn (vlib_main_t * vm,
377 vlib_node_runtime_t * node, vlib_frame_t * frame)
379 return mactime_node_inline (vm, node, frame, 1 /* is_tx */ );
383 VLIB_REGISTER_NODE (mactime_tx_node) =
385 .function = mactime_tx_node_fn,
386 .name = "mactime-tx",
387 .vector_size = sizeof (u32),
388 .format_trace = format_mactime_trace,
389 .type = VLIB_NODE_TYPE_INTERNAL,
391 .n_errors = ARRAY_LEN(mactime_error_strings),
392 .error_strings = mactime_error_strings,
394 .n_next_nodes = MACTIME_N_NEXT,
396 /* edit / add dispositions here */
399 [MACTIME_NEXT_DROP] = "error-drop",
400 [MACTIME_NEXT_ETHERNET_INPUT] = "ethernet-input", /* notused */
406 * fd.io coding-style-patch-verification: ON
409 * eval: (c-set-style "gnu")