nest/iface.h

   1 /*
   2  *      BIRD Internet Routing Daemon -- Network Interfaces
   3  *
   4  *      (c) 1998--2000 Martin Mares <mj@ucw.cz>
   5  *
   6  *      Can be freely distributed and used under the terms of the GNU GPL.
   7  */
   8
   9 #ifndef _BIRD_IFACE_H_
  10 #define _BIRD_IFACE_H_
  11
  12 #include "lib/lists.h"
  13 #include "lib/ip.h"
  14
  15 extern list iface_list;
  16
  17 struct proto;
  18 struct pool;
  19
  20 struct ifa {                            /* Interface address */
  21   node n;
  22   struct iface *iface;                  /* Interface this address belongs to */
  23   net_addr prefix;                      /* Network prefix */
  24   ip_addr ip;                           /* IP address of this host */
  25   ip_addr brd;                          /* Broadcast address */
  26   ip_addr opposite;                     /* Opposite end of a point-to-point link */
  27   unsigned scope;                       /* Interface address scope */
  28   unsigned flags;                       /* Analogous to iface->flags */
  29 };
  30
  31 struct iface {
  32   node n;
  33   char name[16];
  34   unsigned flags;
  35   unsigned mtu;
  36   unsigned index;                       /* OS-dependent interface index */
  37   unsigned master_index;                /* Interface index of master iface */
  38   struct iface *master;                 /* Master iface (e.g. for VRF) */
  39   list addrs;                           /* Addresses assigned to this interface */
  40   struct ifa *addr4;                    /* Primary address for IPv4 */
  41   struct ifa *addr6;                    /* Primary address for IPv6 */
  42   struct ifa *llv6;                     /* Primary link-local address for IPv6 */
  43   ip4_addr sysdep;                      /* Arbitrary IPv4 address for internal sysdep use */
  44   list neighbors;                       /* All neighbors on this interface */
  45 };
  46
  47 #define IF_UP 1                         /* Currently just IF_ADMIN_UP */
  48 #define IF_MULTIACCESS 2
  49 #define IF_BROADCAST 4
  50 #define IF_MULTICAST 8
  51 #define IF_SHUTDOWN 0x10                /* Interface disappeared */
  52 #define IF_LOOPBACK 0x20
  53 #define IF_IGNORE 0x40                  /* Not to be used by routing protocols (loopbacks etc.) */
  54 #define IF_ADMIN_UP 0x80                /* Administrative up (e.g. IFF_UP in Linux) */
  55 #define IF_LINK_UP 0x100                /* Link available (e.g. IFF_LOWER_UP in Linux) */
  56 #define IF_VRF 0x200                    /* Iface is VRF master */
  57
  58 #define IA_PRIMARY 0x10000              /* This address is primary */
  59 #define IA_SECONDARY 0x20000            /* This address has been reported as secondary by the kernel */
  60 #define IA_PEER 0x40000                 /* A peer/ptp address */
  61 #define IA_HOST 0x80000                 /* A host/loopback address */
  62 #define IA_FLAGS 0xff0000
  63
  64 /*
  65  * There are three kinds of addresses in BIRD:
  66  *  - Standard (prefix-based) addresses, these may define ifa.opposite (for /30 or /31).
  67  *  - Peer/ptp addresses, without common prefix for ifa.ip and ifa.opposite.
  68  *    ifa.opposite is defined and ifa.prefix/pxlen == ifa.opposite/32 (for simplicity).
  69  *  - Host addresses, with ifa.prefix/pxlen == ifa.ip/32 (or /128).
  70  *    May be considered a special case of standard addresses.
  71  *
  72  * Peer addresses (AFAIK) do not exist in IPv6. Linux also supports generalized peer
  73  * addresses (with pxlen < 32 and ifa.ip outside prefix), we do not support that.
  74  */
  75
  76
  77 #define IF_JUST_CREATED 0x10000000      /* Send creation event as soon as possible */
  78 #define IF_TMP_DOWN     0x20000000      /* Temporary shutdown due to interface reconfiguration */
  79 #define IF_UPDATED      0x40000000      /* Iface touched in last scan */
  80 #define IF_NEEDS_RECALC 0x80000000      /* Preferred address recalculation is needed */
  81 #define IF_LOST_ADDR4   0x01000000      /* Preferred address was deleted, notification needed */
  82 #define IF_LOST_ADDR6   0x02000000
  83 #define IF_LOST_LLV6    0x04000000
  84
  85 #define IA_UPDATED      IF_UPDATED      /* Address touched in last scan */
  86
  87 /* Interface change events */
  88
  89 #define IF_CHANGE_UP 1
  90 #define IF_CHANGE_DOWN 2
  91 #define IF_CHANGE_MTU 4
  92 #define IF_CHANGE_CREATE 8              /* Seen this interface for the first time */
  93 #define IF_CHANGE_LINK 0x10
  94 #define IF_CHANGE_ADDR4 0x100           /* Change of iface->addr4 */
  95 #define IF_CHANGE_ADDR6 0x200           /* ... */
  96 #define IF_CHANGE_LLV6 0x400
  97 #define IF_CHANGE_SYSDEP 0x800
  98 #define IF_CHANGE_TOO_MUCH 0x40000000   /* Used internally */
  99
 100 #define IF_CHANGE_UPDOWN (IF_CHANGE_UP | IF_CHANGE_DOWN)
 101 #define IF_CHANGE_PREFERRED (IF_CHANGE_ADDR4 | IF_CHANGE_ADDR6 | IF_CHANGE_LLV6)
 102
 103 void if_init(void);
 104 void if_dump(struct iface *);
 105 void if_dump_all(void);
 106 void ifa_dump(struct ifa *);
 107 void if_show(void);
 108 void if_show_summary(void);
 109 struct iface *if_update(struct iface *);
 110 void if_delete(struct iface *old);
 111 struct ifa *ifa_update(struct ifa *);
 112 void ifa_delete(struct ifa *);
 113 void if_start_update(void);
 114 void if_end_partial_update(struct iface *);
 115 void if_end_update(void);
 116 void if_flush_ifaces(struct proto *p);
 117 void if_feed_baby(struct proto *);
 118 struct iface *if_find_by_index(unsigned);
 119 struct iface *if_find_by_name(const char *);
 120 struct iface *if_get_by_name(const char *);
 121 void if_recalc_all_preferred_addresses(void);
 122
 123 static inline int if_in_vrf(struct iface *i, struct iface *vrf)
 124 { return (i->flags & IF_VRF) ? (i == vrf) : (i->master == vrf); }
 125
 126
 127 /* The Neighbor Cache */
 128
 129 typedef struct neighbor {
 130   node n;                               /* Node in neighbor hash table chain */
 131   node if_n;                            /* Node in per-interface neighbor list */
 132   ip_addr addr;                         /* Address of the neighbor */
 133   struct ifa *ifa;                      /* Ifa on related iface */
 134   struct iface *iface;                  /* Interface it's connected to */
 135   struct iface *ifreq;                  /* Requested iface, NULL for any */
 136   struct proto *proto;                  /* Protocol this belongs to */
 137   void *data;                           /* Protocol-specific data */
 138   uint aux;                             /* Protocol-specific data */
 139   u16 flags;                            /* NEF_* flags */
 140   s16 scope;                            /* Address scope, -1 for unreachable neighbors,
 141                                            SCOPE_HOST when it's our own address */
 142 } neighbor;
 143
 144 #define NEF_STICKY      1
 145 #define NEF_ONLINK      2
 146 #define NEF_IFACE       4               /* Entry for whole iface */
 147
 148
 149 neighbor *neigh_find(struct proto *p, ip_addr a, struct iface *ifa, uint flags);
 150
 151 void neigh_dump(neighbor *);
 152 void neigh_dump_all(void);
 153 void neigh_prune(void);
 154 void neigh_if_up(struct iface *);
 155 void neigh_if_down(struct iface *);
 156 void neigh_if_link(struct iface *);
 157 void neigh_ifa_up(struct ifa *a);
 158 void neigh_ifa_down(struct ifa *a);
 159 void neigh_init(struct pool *);
 160
 161 /*
 162  *      Interface Pattern Lists
 163  */
 164
 165 struct iface_patt_node {
 166   node n;
 167   int positive;
 168   const byte *pattern;
 169   net_addr prefix;
 170 };
 171
 172 struct iface_patt {
 173   node n;
 174   list ipn_list;                        /* A list of struct iface_patt_node */
 175
 176   /* Protocol-specific data follow after this structure */
 177 };
 178
 179 int iface_patt_match(struct iface_patt *ifp, struct iface *i, struct ifa *a);
 180 struct iface_patt *iface_patt_find(list *l, struct iface *i, struct ifa *a);
 181 int iface_patts_equal(list *, list *, int (*)(struct iface_patt *, struct iface_patt *));
 182
 183
 184 u32 if_choose_router_id(struct iface_patt *mask, u32 old_id);
 185
 186 #endif