zebra/zebra_fpm_private.h

   1 /*
   2  * Private header file for the zebra FPM module.
   3  *
   4  * Copyright (C) 2012 by Open Source Routing.
   5  * Copyright (C) 2012 by Internet Systems Consortium, Inc. ("ISC")
   6  *
   7  * This file is part of GNU Zebra.
   8  *
   9  * GNU Zebra is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2, or (at your option)
  12  * any later version.
  13  *
  14  * GNU Zebra is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; see the file COPYING; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  22  */
  23
  24 #ifndef _ZEBRA_FPM_PRIVATE_H
  25 #define _ZEBRA_FPM_PRIVATE_H
  26
  27 #include "zebra/debug.h"
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 #if defined __STDC_VERSION__ && __STDC_VERSION__ >= 199901L
  34
  35 #define zfpm_debug(...)                                                        \
  36         do {                                                                   \
  37                 if (IS_ZEBRA_DEBUG_FPM)                                        \
  38                         zlog_debug("FPM: " __VA_ARGS__);                       \
  39         } while (0)
  40
  41 #elif defined __GNUC__
  42
  43 #define zfpm_debug(_args...)                                                   \
  44         do {                                                                   \
  45                 if (IS_ZEBRA_DEBUG_FPM)                                        \
  46                         zlog_debug("FPM: " _args);                             \
  47         } while (0)
  48
  49 #else
  50 static inline void zfpm_debug(const char *format, ...)
  51 {
  52         return;
  53 }
  54 #endif
  55
  56 /* This structure contains the MAC addresses enqueued for FPM processing. */
  57 struct fpm_mac_info_t {
  58         struct ethaddr macaddr;
  59         uint32_t zebra_flags; /* Could be used to build FPM messages */
  60         vni_t vni;
  61         ifindex_t vxlan_if;
  62         ifindex_t svi_if; /* L2 or L3 Bridge interface */
  63         struct in_addr r_vtep_ip; /* Remote VTEP IP */
  64
  65         /* Linkage to put MAC on the FPM processing queue. */
  66         TAILQ_ENTRY(fpm_mac_info_t) fpm_mac_q_entries;
  67
  68         uint8_t fpm_flags;
  69
  70 #define ZEBRA_MAC_UPDATE_FPM 0x1 /* This flag indicates if we want to upadte
  71                                   * data plane for this MAC. If a MAC is added
  72                                   * and then deleted immediately, we do not want
  73                                   * to update data plane for such operation.
  74                                   * Unset the ZEBRA_MAC_UPDATE_FPM flag in this
  75                                   * case. FPM thread while processing the queue
  76                                   * node will check this flag and dequeue the
  77                                   * node silently without sending any update to
  78                                   * the data plane.
  79                                   */
  80 #define ZEBRA_MAC_DELETE_FPM 0x2 /* This flag is set if it is a delete operation
  81                                   * for the MAC.
  82                                   */
  83 };
  84
  85 /*
  86  * Externs
  87  */
  88 extern int zfpm_netlink_encode_route(int cmd, rib_dest_t *dest,
  89                                      struct route_entry *re, char *in_buf,
  90                                      size_t in_buf_len);
  91
  92 extern int zfpm_protobuf_encode_route(rib_dest_t *dest, struct route_entry *re,
  93                                       uint8_t *in_buf, size_t in_buf_len);
  94
  95 extern int zfpm_netlink_encode_mac(struct fpm_mac_info_t *mac, char *in_buf,
  96                                    size_t in_buf_len);
  97
  98 extern struct route_entry *zfpm_route_for_update(rib_dest_t *dest);
  99
 100 #ifdef __cplusplus
 101 }
 102 #endif
 103
 104 #endif /* _ZEBRA_FPM_PRIVATE_H */