src/vnet/dpo/receive_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 receiveing the packet, i.e. it's for-us
  18  */
  19
  20 #ifndef __RECEIVE_DPO_H__
  21 #define __RECEIVE_DPO_H__
  22
  23 #include <vnet/dpo/dpo.h>
  24 #include <vnet/ip/ip6.h>
  25
  26 typedef struct receive_dpo_t_
  27 {
  28     /**
  29      * The Software interface index on which traffic is received
  30      */
  31     u32 rd_sw_if_index;
  32
  33     /**
  34      * The address on the receive interface. packet are destined to this address
  35      */
  36     ip46_address_t rd_addr;
  37
  38     /**
  39      * number oflocks.
  40      */
  41     u16 rd_locks;
  42 } receive_dpo_t;
  43
  44 extern void receive_dpo_add_or_lock (dpo_proto_t proto,
  45                                      u32 sw_if_index,
  46                                      const ip46_address_t *nh_addr,
  47                                      dpo_id_t *dpo);
  48
  49 extern void receive_dpo_module_init(void);
  50
  51 /**
  52  * @brief pool of all receive DPOs
  53  */
  54 receive_dpo_t *receive_dpo_pool;
  55
  56 static inline receive_dpo_t *
  57 receive_dpo_get (index_t index)
  58 {
  59     return (pool_elt_at_index(receive_dpo_pool, index));
  60 }
  61
  62 #endif