src/vnet/adj/adj_midchain.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  * Midchain Adjacency sub-type. These adjs represent an L3 peer on a
  17  * tunnel interface. The tunnel's adjacency is thus not the end of the chain,
  18  * and needs to stack on/link to another chain (or portion of the graph) to
  19  * reach the tunnel's destination.
  20  */
  21
  22 #ifndef __ADJ_MIDCHAIN_H__
  23 #define __ADJ_MIDCHAIN_H__
  24
  25 #include <vnet/adj/adj.h>
  26
  27 /**
  28  * @brief
  29  *  Convert an existing neighbour adjacency into a midchain
  30  *
  31  * @param adj_index
  32  *  The index of the neighbour adjacency.
  33  *
  34  * @param post_rewrite_node
  35  *  The VLIB graph node that provides the post-encap fixup.
  36  *  where 'fixup' is e.g., correcting chksum, length, etc.
  37  *
  38  * @param rewrite
  39  *  The rewrite.
  40  */
  41 extern void adj_nbr_midchain_update_rewrite(adj_index_t adj_index,
  42                                             adj_midchain_fixup_t fixup,
  43                                             adj_flags_t flags,
  44                                             u8 *rewrite);
  45
  46 /**
  47  * @brief
  48  *  [re]stack a midchain. 'Stacking' is the act of forming parent-child
  49  *  relationships in the data-plane graph.
  50  *
  51  * @param adj_index
  52  *  The index of the midchain to stack
  53  *
  54  * @param dpo
  55  *  The parent DPO to stack onto (i.e. become a child of).
  56  */
  57 extern void adj_nbr_midchain_stack(adj_index_t adj_index,
  58                                    const dpo_id_t *dpo);
  59
  60 /**
  61  * @brief
  62  *  unstack a midchain. This will break the chain between the midchain and
  63  *  the next graph section. This is a implemented as stack-on-drop
  64  *
  65  * @param adj_index
  66  *  The index of the midchain to stack
  67  */
  68 extern void adj_nbr_midchain_unstack(adj_index_t adj_index);
  69
  70 /**
  71  * @brief
  72  *  Module initialisation
  73  */
  74 extern void adj_midchain_module_init(void);
  75
  76 /**
  77  * @brief
  78  * Format a midchain adjacency
  79  */
  80 extern u8* format_adj_midchain(u8* s, va_list *ap);
  81
  82 #endif