src/vnet/dpo/dvr_dpo.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 __DVR_DPO_H__
  17 #define __DVR_DPO_H__
  18
  19 #include <vnet/dpo/dpo.h>
  20
  21 /**
  22  * @brief
  23  * The DVR DPO. Used as the resolving object for a DVR route.
  24  * This is used, in place of the usual L3 Adjacency, to retransmit
  25  * the packet with the original L2 header intact but also to run L3 features.
  26  * After running L3 features the packet is re-injected back into the L2 path
  27  * so it can pick up the necessary VLAN tags of the egress interface.
  28  * This re-injection is done with an output feature.
  29  */
  30 typedef struct dvr_dpo_t_
  31 {
  32     /**
  33      * The Software interface index that the packets will output on
  34      */
  35     u32 dd_sw_if_index;
  36
  37     /**
  38      * The protocol of packets using this DPO
  39      */
  40     dpo_proto_t dd_proto;
  41
  42     /**
  43      * number of locks.
  44      */
  45     u16 dd_locks;
  46 } dvr_dpo_t;
  47
  48 extern void dvr_dpo_add_or_lock (u32 sw_if_index,
  49                                  dpo_proto_t dproto,
  50                                  dpo_id_t *dpo);
  51
  52 extern void dvr_dpo_module_init(void);
  53
  54 /**
  55  * @brief pool of all interface DPOs
  56  */
  57 dvr_dpo_t *dvr_dpo_pool;
  58
  59 static inline dvr_dpo_t *
  60 dvr_dpo_get (index_t index)
  61 {
  62     return (pool_elt_at_index(dvr_dpo_pool, index));
  63 }
  64
  65 #endif