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
  14 extern list iface_list;
  15
  16 struct proto;
  17 struct pool;
  18
  19 struct ifa {                            /* Interface address */
  20   node n;
  21   struct iface *iface;                  /* Interface this address belongs to */
  22   ip_addr ip;                           /* IP address of this host */
  23   ip_addr prefix;                       /* Network prefix */
  24   unsigned pxlen;                       /* Prefix length */
  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   list addrs;                           /* Addresses assigned to this interface */
  39   struct ifa *addr;                     /* Primary address */
  40   struct iface *master;                 /* Master iface (e.g. for VRF) */
  41   list neighbors;                       /* All neighbors on this interface */
  42 };
  43
  44 #define IF_UP 1                         /* IF_ADMIN_UP and IP address known */
  45 #define IF_MULTIACCESS 2
  46 #define IF_BROADCAST 4
  47 #define IF_MULTICAST 8
  48 #define IF_SHUTDOWN 0x10                /* Interface disappeared */
  49 #define IF_LOOPBACK 0x20
  50 #define IF_IGNORE 0x40                  /* Not to be used by routing protocols (loopbacks etc.) */
  51 #define IF_ADMIN_UP 0x80                /* Administrative up (e.g. IFF_UP in Linux) */
  52 #define IF_LINK_UP 0x100                /* Link available (e.g. IFF_LOWER_UP in Linux) */
  53
  54 #define IA_PRIMARY 0x10000              /* This address is primary */
  55 #define IA_SECONDARY 0x20000            /* This address has been reported as secondary by the kernel */
  56 #define IA_PEER 0x40000                 /* A peer/ptp address */
  57 #define IA_HOST 0x80000                 /* A host/loopback address */
  58 #define IA_FLAGS 0xff0000
  59
  60 /*
  61  * There are three kinds of addresses in BIRD:
  62  *  - Standard (prefix-based) addresses, these may define ifa.opposite (for /30 or /31).
  63  *  - Peer/ptp addresses, without common prefix for ifa.ip and ifa.opposite.
  64  *    ifa.opposite is defined and ifa.prefix/pxlen == ifa.opposite/32 (for simplicity).
  65  *  - Host addresses, with ifa.prefix/pxlen == ifa.ip/32 (or /128).
  66  *    May be considered a special case of standard addresses.
  67  *
  68  * Peer addresses (AFAIK) do not exist in IPv6. Linux also supports generalized peer
  69  * addresses (with pxlen < 32 and ifa.ip outside prefix), we do not support that.
  70  */
  71
  72
  73 #define IF_JUST_CREATED 0x10000000      /* Send creation event as soon as possible */
  74 #define IF_TMP_DOWN 0x20000000          /* Temporary shutdown due to interface reconfiguration */
  75 #define IF_UPDATED 0x40000000           /* Touched in last scan */
  76
  77 /* Interface change events */
  78
  79 #define IF_CHANGE_UP 1
  80 #define IF_CHANGE_DOWN 2
  81 #define IF_CHANGE_MTU 4
  82 #define IF_CHANGE_CREATE 8              /* Seen this interface for the first time */
  83 #define IF_CHANGE_LINK 0x10
  84 #define IF_CHANGE_TOO_MUCH 0x40000000   /* Used internally */
  85
  86 void if_init(void);
  87 void if_dump(struct iface *);
  88 void if_dump_all(void);
  89 void ifa_dump(struct ifa *);
  90 void if_show(void);
  91 void if_show_summary(void);
  92 struct iface *if_update(struct iface *);
  93 void if_delete(struct iface *old);
  94 struct ifa *ifa_update(struct ifa *);
  95 void ifa_delete(struct ifa *);
  96 void if_start_update(void);
  97 void if_end_partial_update(struct iface *);
  98 void if_end_update(void);
  99 void if_flush_ifaces(struct proto *p);
 100 void if_feed_baby(struct proto *);
 101 struct iface *if_find_by_index(unsigned);
 102 struct iface *if_find_by_name(char *);
 103 struct iface *if_get_by_name(char *);
 104 void ifa_recalc_all_primary_addresses(void);
 105
 106
 107 /* The Neighbor Cache */
 108
 109 typedef struct neighbor {
 110   node n;                               /* Node in global neighbor list */
 111   node if_n;                            /* Node in per-interface neighbor list */
 112   ip_addr addr;                         /* Address of the neighbor */
 113   struct ifa *ifa;                      /* Ifa on related iface */
 114   struct iface *iface;                  /* Interface it's connected to */
 115   struct proto *proto;                  /* Protocol this belongs to */
 116   void *data;                           /* Protocol-specific data */
 117   unsigned aux;                         /* Protocol-specific data */
 118   unsigned flags;
 119   int scope;                            /* Address scope, -1 for unreachable sticky neighbors,
 120                                            SCOPE_HOST when it's our own address */
 121 } neighbor;
 122
 123 #define NEF_STICKY 1
 124 #define NEF_ONLINK 2
 125 #define NEF_BIND 4                      /* Used internally for neighbors bound to an iface */
 126
 127 neighbor *neigh_find(struct proto *, ip_addr *, unsigned flags);
 128 neighbor *neigh_find2(struct proto *p, ip_addr *a, struct iface *ifa, unsigned flags);
 129
 130 static inline int neigh_connected_to(struct proto *p, ip_addr *a, struct iface *i)
 131 {
 132   neighbor *n = neigh_find(p, a, 0);
 133   return n && n->iface == i;
 134 }
 135
 136 void neigh_dump(neighbor *);
 137 void neigh_dump_all(void);
 138 void neigh_prune(void);
 139 void neigh_if_up(struct iface *);
 140 void neigh_if_down(struct iface *);
 141 void neigh_if_link(struct iface *);
 142 void neigh_ifa_update(struct ifa *);
 143 void neigh_init(struct pool *);
 144
 145 /*
 146  *      Interface Pattern Lists
 147  */
 148
 149 struct iface_patt_node {
 150   node n;
 151   int positive;
 152   byte *pattern;
 153   ip_addr prefix;
 154   int pxlen;
 155 };
 156
 157 struct iface_patt {
 158   node n;
 159   list ipn_list;                        /* A list of struct iface_patt_node */
 160
 161   /* Protocol-specific data follow after this structure */
 162 };
 163
 164 int iface_patt_match(struct iface_patt *ifp, struct iface *i, struct ifa *a);
 165 struct iface_patt *iface_patt_find(list *l, struct iface *i, struct ifa *a);
 166 int iface_patts_equal(list *, list *, int (*)(struct iface_patt *, struct iface_patt *));
 167
 168
 169 u32 if_choose_router_id(struct iface_patt *mask, u32 old_id);
 170
 171 #endif