src/vnet/dpo/interface_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  * @brief
  17  * The data-path object representing interfaceing the packet, i.e. it's for-us
  18  */
  19
  20 #ifndef __INTERFACE_DPO_H__
  21 #define __INTERFACE_DPO_H__
  22
  23 #include <vnet/dpo/dpo.h>
  24
  25 typedef struct interface_dpo_t_
  26 {
  27     /**
  28      * The Software interface index that the packets will be given
  29      * as the ingress/rx interface
  30      */
  31     u32 ido_sw_if_index;
  32
  33     /**
  34      * next VLIB node. A '<proto>-input' node.
  35      */
  36     u32 ido_next_node;
  37
  38     /**
  39      * DPO protocol that the packets will have as they 'ingress'
  40      * on this interface
  41      */
  42     dpo_proto_t ido_proto;
  43
  44     /**
  45      * number of locks.
  46      */
  47     u16 ido_locks;
  48 } interface_dpo_t;
  49
  50 extern void interface_dpo_add_or_lock (dpo_proto_t proto,
  51                                        u32 sw_if_index,
  52                                        dpo_id_t *dpo);
  53
  54 extern void interface_dpo_module_init(void);
  55
  56 /**
  57  * @brief pool of all interface DPOs
  58  */
  59 interface_dpo_t *interface_dpo_pool;
  60
  61 static inline interface_dpo_t *
  62 interface_dpo_get (index_t index)
  63 {
  64     return (pool_elt_at_index(interface_dpo_pool, index));
  65 }
  66
  67 #endif