Refactor IP input checks for re-use at MPLS disposition
[vpp.git] / src / vnet / ip / ip6_input.h
1 /*
2  * Copyright (c) 2017 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  * ip/ip6_input.c: IP v6 input node
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
20  * Permission is hereby granted, free of charge, to any person obtaining
21  * a copy of this software and associated documentation files (the
22  * "Software"), to deal in the Software without restriction, including
23  * without limitation the rights to use, copy, modify, merge, publish,
24  * distribute, sublicense, and/or sell copies of the Software, and to
25  * permit persons to whom the Software is furnished to do so, subject to
26  * the following conditions:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38  */
39
40 #ifndef included_ip6_input_h
41 #define included_ip6_input_h
42
43 #include <vnet/ip/ip.h>
44
45 extern char *ip6_error_strings[];
46
47 typedef enum
48 {
49   IP6_INPUT_NEXT_DROP,
50   IP6_INPUT_NEXT_LOOKUP,
51   IP6_INPUT_NEXT_LOOKUP_MULTICAST,
52   IP6_INPUT_NEXT_ICMP_ERROR,
53   IP6_INPUT_N_NEXT,
54 } ip6_input_next_t;
55
56 always_inline void
57 ip6_input_check_x2 (vlib_main_t * vm,
58                     vlib_node_runtime_t * error_node,
59                     vlib_buffer_t * p0, vlib_buffer_t * p1,
60                     ip6_header_t * ip0, ip6_header_t * ip1,
61                     u32 * next0, u32 * next1)
62 {
63   u8 error0, error1;
64
65   error0 = error1 = IP6_ERROR_NONE;
66
67   /* Version != 6?  Drop it. */
68   error0 =
69     (clib_net_to_host_u32
70      (ip0->ip_version_traffic_class_and_flow_label) >> 28) !=
71     6 ? IP6_ERROR_VERSION : error0;
72   error1 =
73     (clib_net_to_host_u32
74      (ip1->ip_version_traffic_class_and_flow_label) >> 28) !=
75     6 ? IP6_ERROR_VERSION : error1;
76
77   /* hop limit < 1? Drop it.  for link-local broadcast packets,
78    * like dhcpv6 packets from client has hop-limit 1, which should not
79    * be dropped.
80    */
81   error0 = ip0->hop_limit < 1 ? IP6_ERROR_TIME_EXPIRED : error0;
82   error1 = ip1->hop_limit < 1 ? IP6_ERROR_TIME_EXPIRED : error1;
83
84   /* L2 length must be at least minimal IP header. */
85   error0 =
86     p0->current_length < sizeof (ip0[0]) ? IP6_ERROR_TOO_SHORT : error0;
87   error1 =
88     p1->current_length < sizeof (ip1[0]) ? IP6_ERROR_TOO_SHORT : error1;
89
90   if (PREDICT_FALSE (error0 != IP6_ERROR_NONE))
91     {
92       if (error0 == IP6_ERROR_TIME_EXPIRED)
93         {
94           icmp6_error_set_vnet_buffer (p0, ICMP6_time_exceeded,
95                                        ICMP6_time_exceeded_ttl_exceeded_in_transit,
96                                        0);
97           *next0 = IP6_INPUT_NEXT_ICMP_ERROR;
98         }
99       else
100         {
101           *next0 = IP6_INPUT_NEXT_DROP;
102         }
103     }
104   if (PREDICT_FALSE (error1 != IP6_ERROR_NONE))
105     {
106       if (error1 == IP6_ERROR_TIME_EXPIRED)
107         {
108           icmp6_error_set_vnet_buffer (p1, ICMP6_time_exceeded,
109                                        ICMP6_time_exceeded_ttl_exceeded_in_transit,
110                                        0);
111           *next1 = IP6_INPUT_NEXT_ICMP_ERROR;
112         }
113       else
114         {
115           *next1 = IP6_INPUT_NEXT_DROP;
116         }
117     }
118 }
119
120 always_inline void
121 ip6_input_check_x1 (vlib_main_t * vm,
122                     vlib_node_runtime_t * error_node,
123                     vlib_buffer_t * p0, ip6_header_t * ip0, u32 * next0)
124 {
125   u8 error0;
126
127   error0 = IP6_ERROR_NONE;
128
129   /* Version != 6?  Drop it. */
130   error0 =
131     (clib_net_to_host_u32
132      (ip0->ip_version_traffic_class_and_flow_label) >> 28) !=
133     6 ? IP6_ERROR_VERSION : error0;
134
135   /* hop limit < 1? Drop it.  for link-local broadcast packets,
136    * like dhcpv6 packets from client has hop-limit 1, which should not
137    * be dropped.
138    */
139   error0 = ip0->hop_limit < 1 ? IP6_ERROR_TIME_EXPIRED : error0;
140
141   /* L2 length must be at least minimal IP header. */
142   error0 =
143     p0->current_length < sizeof (ip0[0]) ? IP6_ERROR_TOO_SHORT : error0;
144
145   if (PREDICT_FALSE (error0 != IP6_ERROR_NONE))
146     {
147       if (error0 == IP6_ERROR_TIME_EXPIRED)
148         {
149           icmp6_error_set_vnet_buffer (p0, ICMP6_time_exceeded,
150                                        ICMP6_time_exceeded_ttl_exceeded_in_transit,
151                                        0);
152           *next0 = IP6_INPUT_NEXT_ICMP_ERROR;
153         }
154       else
155         {
156           *next0 = IP6_INPUT_NEXT_DROP;
157         }
158     }
159 }
160
161 #endif
162
163 /*
164  * fd.io coding-style-patch-verification: ON
165  *
166  * Local Variables:
167  * eval: (c-set-style "gnu")
168  * End:
169  */