FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
ip_null_dpo.h
Go to the documentation of this file.
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  * @brief
17  * The IP NULL DPO represents the rubbish bin for IP traffic. Without specifying an
18  * action (i.e. send IMCP type X to sender) it is equivalent to using a drop DPO.
19  * However, in contrast to the drop DPO any route that resovles via a NULL, is
20  * considered to 'resolved' by FIB, i.e. a IP NULL is used when the control plane
21  * is explicitly expressing the desire to drop packets. Drop DPOs are used
22  * internally by FIB when resolution is not possible.
23  *
24  * Any replies to sender are rate limited.
25  */
26 
27 #ifndef __IP_NULL_DPO_H__
28 #define __IP_NULL_DPO_H__
29 
30 #include <vnet/dpo/dpo.h>
31 
32 /**
33  * @brief Actions to take when a packet encounters the NULL DPO
34  */
36 {
41 
42 #define IP_NULL_ACTIONS { \
43  [IP_NULL_ACTION_NONE] = "discard", \
44  [IP_NULL_ACTION_SEND_ICMP_UNREACH] = "send-unreachable", \
45  [IP_NULL_ACTION_SEND_ICMP_PROHIBIT] = "send-prohibited", \
46 }
47 
48 #define IP_NULL_DPO_ACTION_NUM (IP_NULL_ACTION_SEND_ICMP_PROHIBIT+1)
49 
50 extern void ip_null_dpo_add_and_lock (dpo_proto_t proto,
51  ip_null_dpo_action_t action,
52  dpo_id_t *dpo);
53 
54 extern void ip_null_dpo_module_init(void);
55 
57 
58 #endif
enum ip_null_dpo_action_t_ ip_null_dpo_action_t
The IP NULL DPO represents the rubbish bin for IP traffic.
u32 index_t
A Data-Path Object is an object that represents actions that are applied to packets are they are swit...
Definition: dpo.h:41
enum dpo_proto_t_ dpo_proto_t
Data path protocol.
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:168
ip_null_dpo_action_t_
The IP NULL DPO represents the rubbish bin for IP traffic.
Definition: ip_null_dpo.h:35
void ip_null_dpo_add_and_lock(dpo_proto_t proto, ip_null_dpo_action_t action, dpo_id_t *dpo)
Definition: ip_null_dpo.c:78
void ip_null_dpo_module_init(void)
Definition: ip_null_dpo.c:411
ip_null_dpo_action_t ip_null_dpo_get_action(index_t indi)
Definition: ip_null_dpo.c:100