2 * Copyright (c) 2015 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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
15 #ifndef __POLICE_INLINES_H__
16 #define __POLICE_INLINES_H__
18 #include <vnet/policer/police.h>
19 #include <vnet/vnet.h>
20 #include <vnet/ip/ip.h>
22 #define IP4_NON_DSCP_BITS 0x03
23 #define IP4_DSCP_SHIFT 2
24 #define IP6_NON_DSCP_BITS 0xf03fffff
25 #define IP6_DSCP_SHIFT 22
27 static_always_inline void
28 vnet_policer_mark (vlib_buffer_t *b, ip_dscp_t dscp)
30 ethernet_header_t *eh;
35 eh = (ethernet_header_t *) b->data;
36 type = clib_net_to_host_u16 (eh->type);
38 if (PREDICT_TRUE (type == ETHERNET_TYPE_IP4))
40 ip4h = (ip4_header_t *) & (b->data[sizeof (ethernet_header_t)]);;
41 ip4h->tos &= IP4_NON_DSCP_BITS;
42 ip4h->tos |= dscp << IP4_DSCP_SHIFT;
43 ip4h->checksum = ip4_header_checksum (ip4h);
47 if (PREDICT_TRUE (type == ETHERNET_TYPE_IP6))
49 ip6h = (ip6_header_t *) & (b->data[sizeof (ethernet_header_t)]);
50 ip6h->ip_version_traffic_class_and_flow_label &=
51 clib_host_to_net_u32 (IP6_NON_DSCP_BITS);
52 ip6h->ip_version_traffic_class_and_flow_label |=
53 clib_host_to_net_u32 (dscp << IP6_DSCP_SHIFT);
58 static_always_inline u8
59 vnet_policer_police (vlib_main_t *vm, vlib_buffer_t *b, u32 policer_index,
60 u64 time_in_policer_periods,
61 policer_result_e packet_color, bool handoff)
63 qos_action_type_en act;
67 vnet_policer_main_t *pm = &vnet_policer_main;
69 /* Speculative prefetch assuming a conform result */
70 vlib_prefetch_combined_counter (&policer_counters[POLICE_CONFORM],
71 vm->thread_index, policer_index);
73 pol = &pm->policers[policer_index];
77 if (PREDICT_FALSE (pol->thread_index == ~0))
79 * This is the first packet to use this policer. Set the
80 * thread index in the policer to this thread and any
81 * packets seen by this node on other threads will
82 * be handed off to this one.
84 * This could happen simultaneously on another thread.
86 clib_atomic_cmp_and_swap (&pol->thread_index, ~0, vm->thread_index);
87 else if (PREDICT_FALSE (pol->thread_index != vm->thread_index))
88 return QOS_ACTION_HANDOFF;
91 len = vlib_buffer_length_in_chain (vm, b);
92 col = vnet_police_packet (pol, len, packet_color, time_in_policer_periods);
93 act = pol->action[col];
94 vlib_increment_combined_counter (&policer_counters[col], vm->thread_index,
95 policer_index, 1, len);
96 if (PREDICT_TRUE (act == QOS_ACTION_MARK_AND_TRANSMIT))
97 vnet_policer_mark (b, pol->mark_dscp[col]);
104 POLICER_HANDOFF_ERROR_CONGESTION_DROP,
105 } policer_handoff_error_t;
107 typedef struct policer_handoff_trace_t_
110 u32 current_worker_index;
111 u32 next_worker_index;
112 } policer_handoff_trace_t;
114 extern u8 *format_policer_handoff_trace (u8 *s, va_list *args);
116 /* Do worker handoff based on the policer's thread_index */
117 static_always_inline uword
118 policer_handoff (vlib_main_t *vm, vlib_node_runtime_t *node,
119 vlib_frame_t *frame, u32 fq_index, u32 policer_index)
121 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
122 u16 thread_indices[VLIB_FRAME_SIZE], *ti;
123 u32 n_enq, n_left_from, *from;
124 vnet_policer_main_t *pm;
126 u32 this_thread, policer_thread = 0;
127 bool single_policer_node = (policer_index != ~0);
129 pm = &vnet_policer_main;
130 if (single_policer_node)
132 policer = &pm->policers[policer_index];
133 policer_thread = policer->thread_index;
136 this_thread = vm->thread_index;
137 from = vlib_frame_vector_args (frame);
138 n_left_from = frame->n_vectors;
139 vlib_get_buffers (vm, from, bufs, n_left_from);
144 while (n_left_from > 0)
146 if (!single_policer_node)
148 policer_index = vnet_buffer (b[0])->policer.index;
149 policer = &pm->policers[policer_index];
150 ti[0] = policer->thread_index;
154 ti[0] = policer_thread;
157 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE) &&
158 b[0]->flags & VLIB_BUFFER_IS_TRACED))
160 policer_handoff_trace_t *t =
161 vlib_add_trace (vm, node, b[0], sizeof (*t));
162 t->current_worker_index = this_thread;
163 t->next_worker_index = ti[0];
164 t->policer_index = policer_index;
172 n_enq = vlib_buffer_enqueue_to_thread (vm, node, fq_index, from,
173 thread_indices, frame->n_vectors, 1);
175 if (n_enq < frame->n_vectors)
176 vlib_node_increment_counter (vm, node->node_index,
177 POLICER_HANDOFF_ERROR_CONGESTION_DROP,
178 frame->n_vectors - n_enq);
182 #endif // __POLICE_INLINES_H__
185 * fd.io coding-style-patch-verification: ON
188 * eval: (c-set-style "gnu")