lib/nexthop.h

   1 /*
   2  * Nexthop structure definition.
   3  * Copyright (C) 1997, 98, 99, 2001 Kunihiro Ishiguro
   4  * Copyright (C) 2013 Cumulus Networks, Inc.
   5  *
   6  * This file is part of Quagga.
   7  *
   8  * Quagga is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU General Public License as published by the
  10  * Free Software Foundation; either version 2, or (at your option) any
  11  * later version.
  12  *
  13  * Quagga is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with Quagga; see the file COPYING.  If not, write to the Free
  20  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  21  * 02111-1307, USA.
  22  */
  23
  24 #ifndef _LIB_NEXTHOP_H
  25 #define _LIB_NEXTHOP_H
  26
  27 #include "prefix.h"
  28
  29 union g_addr {
  30   struct in_addr ipv4;
  31 #ifdef HAVE_IPV6
  32   struct in6_addr ipv6;
  33 #endif /* HAVE_IPV6 */
  34 };
  35
  36 enum nexthop_types_t
  37 {
  38   NEXTHOP_TYPE_IFINDEX = 1,      /* Directly connected.  */
  39   NEXTHOP_TYPE_IFNAME,           /* Interface route.  */
  40   NEXTHOP_TYPE_IPV4,             /* IPv4 nexthop.  */
  41   NEXTHOP_TYPE_IPV4_IFINDEX,     /* IPv4 nexthop with ifindex.  */
  42   NEXTHOP_TYPE_IPV4_IFNAME,      /* IPv4 nexthop with ifname.  */
  43   NEXTHOP_TYPE_IPV6,             /* IPv6 nexthop.  */
  44   NEXTHOP_TYPE_IPV6_IFINDEX,     /* IPv6 nexthop with ifindex.  */
  45   NEXTHOP_TYPE_IPV6_IFNAME,      /* IPv6 nexthop with ifname.  */
  46   NEXTHOP_TYPE_BLACKHOLE,        /* Null0 nexthop.  */
  47 };
  48
  49 /* Nexthop structure. */
  50 struct nexthop
  51 {
  52   struct nexthop *next;
  53   struct nexthop *prev;
  54
  55   /* Interface index. */
  56   char *ifname;
  57   ifindex_t ifindex;
  58
  59   enum nexthop_types_t type;
  60
  61   u_char flags;
  62 #define NEXTHOP_FLAG_ACTIVE     (1 << 0) /* This nexthop is alive. */
  63 #define NEXTHOP_FLAG_FIB        (1 << 1) /* FIB nexthop. */
  64 #define NEXTHOP_FLAG_RECURSIVE  (1 << 2) /* Recursive nexthop. */
  65 #define NEXTHOP_FLAG_ONLINK     (1 << 3) /* Nexthop should be installed onlink. */
  66 #define NEXTHOP_FLAG_MATCHED    (1 << 4) /* Already matched vs a nexthop */
  67
  68   /* Nexthop address */
  69   union g_addr gate;
  70   union g_addr src;
  71
  72   /* Nexthops obtained by recursive resolution.
  73    *
  74    * If the nexthop struct needs to be resolved recursively,
  75    * NEXTHOP_FLAG_RECURSIVE will be set in flags and the nexthops
  76    * obtained by recursive resolution will be added to `resolved'.
  77    * Only one level of recursive resolution is currently supported. */
  78   struct nexthop *resolved;
  79 };
  80
  81 struct nexthop *nexthop_new (void);
  82 void nexthop_add (struct nexthop **target, struct nexthop *nexthop);
  83
  84 void copy_nexthops (struct nexthop **tnh, struct nexthop *nh);
  85 void nexthop_free (struct nexthop *nexthop);
  86 void nexthops_free (struct nexthop *nexthop);
  87
  88 extern const char *nexthop_type_to_str (enum nexthop_types_t nh_type);
  89 extern int nexthop_same_no_recurse (struct nexthop *next1, struct nexthop *next2);
  90
  91 #endif /*_LIB_NEXTHOP_H */