src/vnet/dpo/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  * A Data-Path Object is an object that represents actions that are
  18  * applied to packets are they are switched through VPP's data-path.
  19  *
  20  * The DPO can be considered to be like is a base class that is specialised
  21  * by other objects to provide concreate actions
  22  *
  23  * The VLIB graph nodes are graph of DPO types, the DPO graph is a graph of
  24  * instances.
  25  */
  26
  27 #ifndef __DPO_H__
  28 #define __DPO_H__
  29
  30 #include <vnet/vnet.h>
  31
  32 /**
  33  * @brief An index for adjacencies.
  34  * Alas 'C' is not typesafe enough to b0rk when a u32 is used instead of
  35  * an index_t. However, for us humans, we can glean much more intent
  36  * from the declaration
  37  *  foo barindex_t t);
  38  * than we can from
  39  *  foo bar(u32 t);
  40  */
  41 typedef u32 index_t;
  42
  43 /**
  44  * @brief Invalid index - used when no index is known
  45  * blazoned capitals INVALID speak volumes where ~0 does not.
  46  */
  47 #define INDEX_INVALID ((index_t)(~0))
  48
  49 /**
  50  * @brief Data path protocol.
  51  * Actions performed on packets in the data-plane can be described and represented
  52  * by protocol independent objects, i.e. ADJACENCY, but the spceifics actions
  53  * required during ADJACENCY processing can be protocol dependent. For example,
  54  * the adjacency rewrite node performs a ip4 checksum calculation,  ip6 and MPLS
  55  * do not, all 3 perform a TTL decrement. The VLIB graph nodes are thus protocol
  56  * dependent, and thus each graph edge/arc is too.
  57  * When programming a DPO's next node arc from child to parent it is thus required
  58  * to know the parent's data-path protocol so the correct arc index can be used.
  59  */
  60 typedef enum dpo_proto_t_
  61 {
  62 #if CLIB_DEBUG > 0
  63     DPO_PROTO_IP4 = 1,
  64 #else
  65     DPO_PROTO_IP4 = 0,
  66 #endif
  67     DPO_PROTO_IP6,
  68     DPO_PROTO_ETHERNET,
  69     DPO_PROTO_MPLS,
  70 } __attribute__((packed)) dpo_proto_t;
  71
  72 #define DPO_PROTO_NUM ((dpo_proto_t)(DPO_PROTO_MPLS+1))
  73 #define DPO_PROTO_NONE ((dpo_proto_t)(DPO_PROTO_NUM+1))
  74
  75 #define DPO_PROTOS {            \
  76     [DPO_PROTO_IP4]  = "ip4",   \
  77     [DPO_PROTO_IP6]  = "ip6",   \
  78     [DPO_PROTO_ETHERNET]  = "ethernet", \
  79     [DPO_PROTO_MPLS] = "mpls",  \
  80 }
  81
  82 #define FOR_EACH_DPO_PROTO(_proto)    \
  83     for (_proto = DPO_PROTO_IP4;      \
  84          _proto <= DPO_PROTO_MPLS;    \
  85          _proto++)
  86
  87 /**
  88  * @brief Common types of data-path objects
  89  * New types can be dynamically added using dpo_register_new_type()
  90  */
  91 typedef enum dpo_type_t_ {
  92     /**
  93      * A non-zero value first so we can spot unitialisation errors
  94      */
  95     DPO_FIRST,
  96     DPO_DROP,
  97     DPO_IP_NULL,
  98     DPO_PUNT,
  99     /**
 100      * @brief load-balancing over a choice of [un]equal cost paths
 101      */
 102     DPO_LOAD_BALANCE,
 103     DPO_REPLICATE,
 104     DPO_ADJACENCY,
 105     DPO_ADJACENCY_INCOMPLETE,
 106     DPO_ADJACENCY_MIDCHAIN,
 107     DPO_ADJACENCY_GLEAN,
 108     DPO_ADJACENCY_MCAST,
 109     DPO_RECEIVE,
 110     DPO_LOOKUP,
 111     DPO_LISP_CP,
 112     DPO_CLASSIFY,
 113     DPO_MPLS_LABEL,
 114     DPO_MFIB_ENTRY,
 115     DPO_LAST,
 116 } __attribute__((packed)) dpo_type_t;
 117
 118 #define DPO_TYPE_NUM DPO_LAST
 119
 120 #define DPO_TYPES {                     \
 121     [DPO_FIRST] = "dpo-invalid",        \
 122     [DPO_DROP] = "dpo-drop",    \
 123     [DPO_IP_NULL] = "dpo-ip-null",              \
 124     [DPO_PUNT] = "dpo-punt",    \
 125     [DPO_ADJACENCY] = "dpo-adjacency",  \
 126     [DPO_ADJACENCY_INCOMPLETE] = "dpo-adjacency-incomplete",    \
 127     [DPO_ADJACENCY_MIDCHAIN] = "dpo-adjacency-midcahin",        \
 128     [DPO_ADJACENCY_GLEAN] = "dpo-glean",        \
 129     [DPO_ADJACENCY_MCAST] = "dpo-adj-mcast",    \
 130     [DPO_RECEIVE] = "dpo-receive",      \
 131     [DPO_LOOKUP] = "dpo-lookup",        \
 132     [DPO_LOAD_BALANCE] = "dpo-load-balance",    \
 133     [DPO_REPLICATE] = "dpo-replicate",  \
 134     [DPO_LISP_CP] = "dpo-lisp-cp",      \
 135     [DPO_CLASSIFY] = "dpo-classify",    \
 136     [DPO_MPLS_LABEL] = "dpo-mpls-label", \
 137     [DPO_MFIB_ENTRY] = "dpo-mfib_entry" \
 138 }
 139
 140 /**
 141  * @brief The identity of a DPO is a combination of its type and its
 142  * instance number/index of objects of that type
 143  */
 144 typedef struct dpo_id_t_ {
 145     /**
 146      * the type
 147      */
 148     dpo_type_t dpoi_type;
 149     /**
 150      * the data-path protocol of the type.
 151      */
 152     dpo_proto_t dpoi_proto;
 153     /**
 154      * The next VLIB node to follow.
 155      */
 156     u16 dpoi_next_node;
 157     /**
 158      * the index of objects of that type
 159      */
 160     index_t dpoi_index;
 161 } __attribute__ ((aligned(sizeof(u64)))) dpo_id_t;
 162
 163 STATIC_ASSERT(sizeof(dpo_id_t) <= sizeof(u64),
 164               "DPO ID is greater than sizeof u64 "
 165               "atomic updates need to be revisited");
 166
 167 /**
 168  * @brief An initialiser for DPOs declared on the stack.
 169  * Thenext node is set to 0 since VLIB graph nodes should set 0 index to drop.
 170  */
 171 #define DPO_INVALID                \
 172 {                                  \
 173     .dpoi_type = DPO_FIRST,        \
 174     .dpoi_proto = DPO_PROTO_NONE,  \
 175     .dpoi_index = INDEX_INVALID,   \
 176     .dpoi_next_node = 0,           \
 177 }
 178
 179 /**
 180  * @brief Return true if the DPO object is valid, i.e. has been initialised.
 181  */
 182 static inline int
 183 dpo_id_is_valid (const dpo_id_t *dpoi)
 184 {
 185     return (dpoi->dpoi_type != DPO_FIRST &&
 186             dpoi->dpoi_index != INDEX_INVALID);
 187 }
 188
 189 extern dpo_proto_t vnet_link_to_dpo_proto(vnet_link_t linkt);
 190
 191 /**
 192  * @brief
 193  *  Take a reference counting lock on the DPO
 194  */
 195 extern void dpo_lock(dpo_id_t *dpo);
 196
 197 /**
 198  * @brief
 199  *  Release a reference counting lock on the DPO
 200  */
 201 extern void dpo_unlock(dpo_id_t *dpo);
 202
 203 /**
 204  * @brief Set/create a DPO ID
 205  * The DPO will be locked.
 206  *
 207  * @param dpo
 208  *  The DPO object to configure
 209  *
 210  * @param type
 211  *  The dpo_type_t of the DPO
 212  *
 213  * @param proto
 214  *  The dpo_proto_t of the DPO
 215  *
 216  * @param index
 217  *  The type specific index of the DPO
 218  */
 219 extern void dpo_set(dpo_id_t *dpo,
 220                     dpo_type_t type,
 221                     dpo_proto_t proto,
 222                     index_t index);
 223
 224 /**
 225  * @brief reset a DPO ID
 226  * The DPO will be unlocked.
 227  *
 228  * @param dpo
 229  *  The DPO object to reset
 230  */
 231 extern void dpo_reset(dpo_id_t *dpo);
 232
 233 /**
 234  * @brief compare two DPOs for equality
 235  */
 236 extern int dpo_cmp(const dpo_id_t *dpo1,
 237                    const dpo_id_t *dpo2);
 238
 239 /**
 240  * @brief
 241  *  atomic copy a data-plane object.
 242  * This is safe to use when the dst DPO is currently switching packets
 243  */
 244 extern void dpo_copy(dpo_id_t *dst,
 245                      const dpo_id_t *src);
 246
 247 /**
 248  * @brief Return TRUE is the DPO is any type of adjacency
 249  */
 250 extern int dpo_is_adj(const dpo_id_t *dpo);
 251
 252 /**
 253  * @biref Format a DPO_id_t oject
 254  */
 255 extern u8 *format_dpo_id(u8 * s, va_list * args);
 256
 257 /**
 258  * @biref format a DPO type
 259  */
 260 extern u8 *format_dpo_type(u8 * s, va_list * args);
 261
 262 /**
 263  * @brief format a DPO protocol
 264  */
 265 extern u8 *format_dpo_proto(u8 * s, va_list * args);
 266
 267 /**
 268  * @brief
 269  *  Set and stack a DPO.
 270  *  The DPO passed is set to the parent DPO and the necessary
 271  *  VLIB graph arcs are created. The child_type and child_proto
 272  * are used to get the VLID nodes from which the arcs are added.
 273  *
 274  * @param child_type
 275  *  Child DPO type.
 276  *
 277  * @param child_proto
 278  *  Child DPO proto
 279  *
 280  * @parem dpo
 281  *  This is the DPO to stack and set.
 282  *
 283  * @paren parent_dpo
 284  *  The parent DPO to stack onto.
 285  */
 286 extern void dpo_stack(dpo_type_t child_type,
 287                       dpo_proto_t child_proto,
 288                       dpo_id_t *dpo,
 289                       const dpo_id_t *parent_dpo);
 290
 291 /**
 292  * @brief
 293  *  Set and stack a DPO.
 294  *  The DPO passed is set to the parent DPO and the necessary
 295  *  VLIB graph arcs are created, from the child_node passed.
 296  *
 297  * @param child_node
 298  *  The VLIB grpah node index to create an arc from to the parent
 299  *
 300  * @parem dpo
 301  *  This is the DPO to stack and set.
 302  *
 303  * @paren parent_dpo
 304  *  The parent DPO to stack onto.
 305  */
 306 extern void dpo_stack_from_node(u32 child_node,
 307                                 dpo_id_t *dpo,
 308                                 const dpo_id_t *parent);
 309
 310 /**
 311  * @brief  A lock function registered for a DPO type
 312  */
 313 typedef void (*dpo_lock_fn_t)(dpo_id_t *dpo);
 314
 315 /**
 316  * @brief An unlock function registered for a DPO type
 317  */
 318 typedef void (*dpo_unlock_fn_t)(dpo_id_t *dpo);
 319
 320 /**
 321  * @brief An memory usage show command
 322  */
 323 typedef void (*dpo_mem_show_t)(void);
 324
 325 /**
 326  * @brief A virtual function table regisitered for a DPO type
 327  */
 328 typedef struct dpo_vft_t_
 329 {
 330     /**
 331      * A reference counting lock function
 332      */
 333     dpo_lock_fn_t dv_lock;
 334     /**
 335      * A reference counting unlock function
 336      */
 337     dpo_lock_fn_t dv_unlock;
 338     /**
 339      * A format function
 340      */
 341     format_function_t *dv_format;
 342     /**
 343      * A show memory usage function
 344      */
 345     dpo_mem_show_t dv_mem_show;
 346 } dpo_vft_t;
 347
 348
 349 /**
 350  * @brief For a given DPO type Register:
 351  *   - a virtual function table
 352  *   - a NULL terminated array of graph nodes from which that object type
 353  *     will originate packets, i.e. the nodes in which the object type will be
 354  *     the parent DPO in the DP graph. The ndoes are per-data-path protocol
 355  *     (see above).
 356  *
 357  * @param type
 358  *  The type being registered.
 359  *
 360  * @param vft
 361  *  The virtual function table to register for the type.
 362  *
 363  * @param nodes
 364  *  The string description of the per-protocol VLIB graph nodes.
 365  */
 366 extern void dpo_register(dpo_type_t type,
 367                          const dpo_vft_t *vft,
 368                          const char * const * const * nodes);
 369
 370 /**
 371  * @brief Create and register a new DPO type.
 372  *
 373  * This can be used by plugins to create new DPO types that are not listed
 374  * in dpo_type_t enum
 375  *
 376  * @param vft
 377  *  The virtual function table to register for the type.
 378  *
 379  * @param nodes
 380  *  The string description of the per-protocol VLIB graph nodes.
 381  *
 382  * @return The new dpo_type_t
 383  */
 384 extern dpo_type_t dpo_register_new_type(const dpo_vft_t *vft,
 385                                         const char * const * const * nodes);
 386
 387 #endif