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