afcc7724cef0cf898b79568a6df480f59a4daaff
[vpp.git] / src / vnet / policer / police_inlines.h
1 /*
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:
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 #ifndef __POLICE_INLINES_H__
16 #define __POLICE_INLINES_H__
17
18 #include <vnet/policer/police.h>
19 #include <vnet/vnet.h>
20 #include <vnet/ip/ip.h>
21
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
26
27 static_always_inline void
28 vnet_policer_mark (vlib_buffer_t * b, u8 dscp)
29 {
30   ethernet_header_t *eh;
31   ip4_header_t *ip4h;
32   ip6_header_t *ip6h;
33   u16 type;
34
35   eh = (ethernet_header_t *) b->data;
36   type = clib_net_to_host_u16 (eh->type);
37
38   if (PREDICT_TRUE (type == ETHERNET_TYPE_IP4))
39     {
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);
44     }
45   else
46     {
47       if (PREDICT_TRUE (type == ETHERNET_TYPE_IP6))
48         {
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);
54         }
55     }
56 }
57
58 static_always_inline u8
59 vnet_policer_police (vlib_main_t * vm,
60                      vlib_buffer_t * b,
61                      u32 policer_index,
62                      u64 time_in_policer_periods,
63                      policer_result_e packet_color)
64 {
65   u8 act;
66   u32 len;
67   u32 col;
68   policer_read_response_type_st *pol;
69   vnet_policer_main_t *pm = &vnet_policer_main;
70
71   len = vlib_buffer_length_in_chain (vm, b);
72   pol = &pm->policers[policer_index];
73   col = vnet_police_packet (pol, len, packet_color, time_in_policer_periods);
74   act = pol->action[col];
75   if (PREDICT_TRUE (act == SSE2_QOS_ACTION_MARK_AND_TRANSMIT))
76     vnet_policer_mark (b, pol->mark_dscp[col]);
77
78   return act;
79 }
80
81 typedef enum
82 {
83   POLICER_HANDOFF_ERROR_CONGESTION_DROP,
84 } policer_handoff_error_t;
85
86 typedef struct policer_handoff_trace_t_
87 {
88   u32 policer_index;
89   u32 current_worker_index;
90   u32 next_worker_index;
91 } policer_handoff_trace_t;
92
93 extern u8 *format_policer_handoff_trace (u8 *s, va_list *args);
94
95 /* Do worker handoff based on the policer's thread_index */
96 static_always_inline uword
97 policer_handoff (vlib_main_t *vm, vlib_node_runtime_t *node,
98                  vlib_frame_t *frame, u32 fq_index, u32 policer_index)
99 {
100   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
101   u16 thread_indices[VLIB_FRAME_SIZE], *ti;
102   u32 n_enq, n_left_from, *from;
103   vnet_policer_main_t *pm;
104   policer_read_response_type_st *policer;
105   u32 this_thread, policer_thread;
106
107   pm = &vnet_policer_main;
108   policer = &pm->policers[policer_index];
109   policer_thread = policer->thread_index;
110
111   this_thread = vm->thread_index;
112   from = vlib_frame_vector_args (frame);
113   n_left_from = frame->n_vectors;
114   vlib_get_buffers (vm, from, bufs, n_left_from);
115
116   b = bufs;
117   ti = thread_indices;
118
119   while (n_left_from > 0)
120     {
121       ti[0] = policer_thread;
122
123       if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE) &&
124                          b[0]->flags & VLIB_BUFFER_IS_TRACED))
125         {
126           policer_handoff_trace_t *t =
127             vlib_add_trace (vm, node, b[0], sizeof (*t));
128           t->current_worker_index = this_thread;
129           t->next_worker_index = policer_thread;
130           t->policer_index = policer_index;
131         }
132
133       n_left_from--;
134       ti++;
135       b++;
136     }
137
138   n_enq = vlib_buffer_enqueue_to_thread (vm, fq_index, from, thread_indices,
139                                          frame->n_vectors, 1);
140
141   if (n_enq < frame->n_vectors)
142     vlib_node_increment_counter (vm, node->node_index,
143                                  POLICER_HANDOFF_ERROR_CONGESTION_DROP,
144                                  frame->n_vectors - n_enq);
145
146   return n_enq;
147 }
148 #endif // __POLICE_INLINES_H__
149
150 /*
151  * fd.io coding-style-patch-verification: ON
152  *
153  * Local Variables:
154  * eval: (c-set-style "gnu")
155  * End:
156  */