src/vnet/dpo/mpls_label_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 __MPLS_LABEL_DPO_H__
  17 #define __MPLS_LABEL_DPO_H__
  18
  19 #include <vnet/vnet.h>
  20 #include <vnet/mpls/packet.h>
  21 #include <vnet/dpo/dpo.h>
  22
  23 /**
  24  * A representation of an MPLS label for imposition in the data-path
  25  */
  26 typedef struct mpls_label_dpo_t
  27 {
  28     /**
  29      * The MPLS label header to impose. Outer most label first.
  30      */
  31     mpls_unicast_header_t mld_hdr[8];
  32
  33     /**
  34      * Next DPO in the graph
  35      */
  36     dpo_id_t mld_dpo;
  37
  38     /**
  39      * The protocol of the payload/packets that are being encapped
  40      */
  41     dpo_proto_t mld_payload_proto;
  42
  43     /**
  44      * Size of the label stack
  45      */
  46     u16 mld_n_labels;
  47
  48     /**
  49      * Cached amount of header bytes to paint
  50      */
  51     u16 mld_n_hdr_bytes;
  52
  53     /**
  54      * Number of locks/users of the label
  55      */
  56     u16 mld_locks;
  57 } mpls_label_dpo_t;
  58
  59 /**
  60  * @brief Assert that the MPLS label object is less than a cache line in size.
  61  * Should this get any bigger then we will need to reconsider how many labels
  62  * can be pushed in one object.
  63  */
  64 _Static_assert((sizeof(mpls_label_dpo_t) <= CLIB_CACHE_LINE_BYTES),
  65                "MPLS label DPO is larger than one cache line.");
  66
  67 /**
  68  * @brief Create an MPLS label object
  69  *
  70  * @param label_stack The stack if labels to impose, outer most label first
  71  * @param eos The inner most label's EOS bit
  72  * @param ttl The inner most label's TTL bit
  73  * @param exp The inner most label's EXP bit
  74  * @param payload_proto The ptocool of the payload packets that will
  75  *                      be imposed with this label header.
  76  * @param dpo The parent of the created MPLS label object
  77  */
  78 extern index_t mpls_label_dpo_create(mpls_label_t *label_stack,
  79                                      mpls_eos_bit_t eos,
  80                                      u8 ttl,
  81                                      u8 exp,
  82                                      dpo_proto_t payload_proto,
  83                                      const dpo_id_t *dpo);
  84
  85 extern u8* format_mpls_label_dpo(u8 *s, va_list *args);
  86
  87
  88 /*
  89  * Encapsulation violation for fast data-path access
  90  */
  91 extern mpls_label_dpo_t *mpls_label_dpo_pool;
  92
  93 static inline mpls_label_dpo_t *
  94 mpls_label_dpo_get (index_t index)
  95 {
  96     return (pool_elt_at_index(mpls_label_dpo_pool, index));
  97 }
  98
  99 extern void mpls_label_dpo_module_init(void);
 100
 101 #endif