threads: add support for multiple worker handoff queues
[vpp.git] / vnet / vnet / handoff.h
1 /*
2  * Copyright (c) 2016 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 #ifndef included_vnet_handoff_h
17 #define included_vnet_handoff_h
18
19 #include <vlib/vlib.h>
20 #include <vnet/ethernet/ethernet.h>
21 #include <vnet/ip/ip4_packet.h>
22 #include <vnet/ip/ip6_packet.h>
23 #include <vnet/mpls/packet.h>
24
25 typedef enum
26 {
27   HANDOFF_DISPATCH_NEXT_IP4_INPUT,
28   HANDOFF_DISPATCH_NEXT_IP6_INPUT,
29   HANDOFF_DISPATCH_NEXT_MPLS_INPUT,
30   HANDOFF_DISPATCH_NEXT_ETHERNET_INPUT,
31   HANDOFF_DISPATCH_NEXT_DROP,
32   HANDOFF_DISPATCH_N_NEXT,
33 } handoff_dispatch_next_t;
34
35
36 static inline u64
37 ipv4_get_key (ip4_header_t * ip)
38 {
39   u64 hash_key;
40
41   hash_key = *((u64 *) (&ip->address_pair)) ^ ip->protocol;
42
43   return hash_key;
44 }
45
46 static inline u64
47 ipv6_get_key (ip6_header_t * ip)
48 {
49   u64 hash_key;
50
51   hash_key = ip->src_address.as_u64[0] ^
52     rotate_left (ip->src_address.as_u64[1], 13) ^
53     rotate_left (ip->dst_address.as_u64[0], 26) ^
54     rotate_left (ip->dst_address.as_u64[1], 39) ^ ip->protocol;
55
56   return hash_key;
57 }
58
59 #define MPLS_BOTTOM_OF_STACK_BIT_MASK   0x00000100U
60 #define MPLS_LABEL_MASK                 0xFFFFF000U
61
62 static inline u64
63 mpls_get_key (mpls_unicast_header_t * m)
64 {
65   u64 hash_key;
66   u8 ip_ver;
67
68
69   /* find the bottom of the MPLS label stack. */
70   if (PREDICT_TRUE (m->label_exp_s_ttl &
71                     clib_net_to_host_u32 (MPLS_BOTTOM_OF_STACK_BIT_MASK)))
72     {
73       goto bottom_lbl_found;
74     }
75   m++;
76
77   if (PREDICT_TRUE (m->label_exp_s_ttl &
78                     clib_net_to_host_u32 (MPLS_BOTTOM_OF_STACK_BIT_MASK)))
79     {
80       goto bottom_lbl_found;
81     }
82   m++;
83
84   if (m->label_exp_s_ttl &
85       clib_net_to_host_u32 (MPLS_BOTTOM_OF_STACK_BIT_MASK))
86     {
87       goto bottom_lbl_found;
88     }
89   m++;
90
91   if (m->label_exp_s_ttl &
92       clib_net_to_host_u32 (MPLS_BOTTOM_OF_STACK_BIT_MASK))
93     {
94       goto bottom_lbl_found;
95     }
96   m++;
97
98   if (m->label_exp_s_ttl &
99       clib_net_to_host_u32 (MPLS_BOTTOM_OF_STACK_BIT_MASK))
100     {
101       goto bottom_lbl_found;
102     }
103
104   /* the bottom label was not found - use the last label */
105   hash_key = m->label_exp_s_ttl & clib_net_to_host_u32 (MPLS_LABEL_MASK);
106
107   return hash_key;
108
109 bottom_lbl_found:
110   m++;
111   ip_ver = (*((u8 *) m) >> 4);
112
113   /* find out if it is IPV4 or IPV6 header */
114   if (PREDICT_TRUE (ip_ver == 4))
115     {
116       hash_key = ipv4_get_key ((ip4_header_t *) m);
117     }
118   else if (PREDICT_TRUE (ip_ver == 6))
119     {
120       hash_key = ipv6_get_key ((ip6_header_t *) m);
121     }
122   else
123     {
124       /* use the bottom label */
125       hash_key =
126         (m - 1)->label_exp_s_ttl & clib_net_to_host_u32 (MPLS_LABEL_MASK);
127     }
128
129   return hash_key;
130
131 }
132
133
134 static inline u64
135 eth_get_key (ethernet_header_t * h0)
136 {
137   u64 hash_key;
138
139   if (PREDICT_TRUE (h0->type) == clib_host_to_net_u16 (ETHERNET_TYPE_IP4))
140     {
141       hash_key = ipv4_get_key ((ip4_header_t *) (h0 + 1));
142     }
143   else if (h0->type == clib_host_to_net_u16 (ETHERNET_TYPE_IP6))
144     {
145       hash_key = ipv6_get_key ((ip6_header_t *) (h0 + 1));
146     }
147   else if (h0->type == clib_host_to_net_u16 (ETHERNET_TYPE_MPLS_UNICAST))
148     {
149       hash_key = mpls_get_key ((mpls_unicast_header_t *) (h0 + 1));
150     }
151   else if ((h0->type == clib_host_to_net_u16 (ETHERNET_TYPE_VLAN)) ||
152            (h0->type == clib_host_to_net_u16 (ETHERNET_TYPE_DOT1AD)))
153     {
154       ethernet_vlan_header_t *outer = (ethernet_vlan_header_t *) (h0 + 1);
155
156       outer = (outer->type == clib_host_to_net_u16 (ETHERNET_TYPE_VLAN)) ?
157         outer + 1 : outer;
158       if (PREDICT_TRUE (outer->type) ==
159           clib_host_to_net_u16 (ETHERNET_TYPE_IP4))
160         {
161           hash_key = ipv4_get_key ((ip4_header_t *) (outer + 1));
162         }
163       else if (outer->type == clib_host_to_net_u16 (ETHERNET_TYPE_IP6))
164         {
165           hash_key = ipv6_get_key ((ip6_header_t *) (outer + 1));
166         }
167       else if (outer->type ==
168                clib_host_to_net_u16 (ETHERNET_TYPE_MPLS_UNICAST))
169         {
170           hash_key = mpls_get_key ((mpls_unicast_header_t *) (outer + 1));
171         }
172       else
173         {
174           hash_key = outer->type;
175         }
176     }
177   else
178     {
179       hash_key = 0;
180     }
181
182   return hash_key;
183 }
184
185 #endif /* included_vnet_handoff_h */
186
187 /*
188  * fd.io coding-style-patch-verification: ON
189  *
190  * Local Variables:
191  * eval: (c-set-style "gnu")
192  * End:
193  */