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:
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.
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.
24 * Any replies to sender are rate limited.
27 #ifndef __IP_NULL_DPO_H__
28 #define __IP_NULL_DPO_H__
30 #include <vnet/dpo/dpo.h>
33 * @brief Actions to take when a packet encounters the NULL DPO
35 typedef enum ip_null_dpo_action_t_
38 IP_NULL_ACTION_SEND_ICMP_UNREACH,
39 IP_NULL_ACTION_SEND_ICMP_PROHIBIT,
40 } ip_null_dpo_action_t;
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", \
48 #define IP_NULL_DPO_ACTION_NUM (IP_NULL_ACTION_SEND_ICMP_PROHIBIT+1)
50 extern void ip_null_dpo_add_and_lock (dpo_proto_t proto,
51 ip_null_dpo_action_t action,
54 extern void ip_null_dpo_module_init(void);
56 extern ip_null_dpo_action_t ip_null_dpo_get_action(index_t indi);