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 __INTERFACE_RX_DPO_H__
17#define __INTERFACE_RX_DPO_H__
18
19#include <vnet/dpo/dpo.h>
20
21/**
22 * @brief
23 * The data-path object representing a change of receive interface.
24 * If a packet encounters an object of this type in the data-path, it's
25 * RX interface is changed.
26 */
27typedef struct interface_rx_dpo_t_
28{
29    /**
30     * The Software interface index that the packets will be given
31     * as the ingress/rx interface
32     */
33    u32 ido_sw_if_index;
34
35    /**
36     * next VLIB node. A '<proto>-input' node.
37     */
38    u32 ido_next_node;
39
40    /**
41     * DPO protocol that the packets will have as they 'ingress'
42     * on this interface
43     */
44    dpo_proto_t ido_proto;
45
46    /**
47     * number of locks.
48     */
49    u16 ido_locks;
50} interface_rx_dpo_t;
51
52extern void interface_rx_dpo_add_or_lock (dpo_proto_t proto,
53                                          u32 sw_if_index,
54                                          dpo_id_t *dpo);
55
56extern void interface_rx_dpo_module_init(void);
57
58/**
59 * @brief pool of all interface DPOs
60 */
61extern interface_rx_dpo_t *interface_rx_dpo_pool;
62
63static inline interface_rx_dpo_t *
64interface_rx_dpo_get (index_t index)
65{
66    return (pool_elt_at_index(interface_rx_dpo_pool, index));
67}
68
69#endif
70