zebra/irdp.h

   1 /* ICMP Router Discovery Messages
   2  * Copyright (C) 1997, 2000 Kunihiro Ishiguro
   3  *
   4  * This file is part of GNU Zebra.
   5  *
   6  * GNU Zebra is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; either version 2, or (at your option) any
   9  * later version.
  10  *
  11  * GNU Zebra is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; see the file COPYING; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 /*
  22  * This file is modified and completed for the Zebra IRDP implementation
  23  * by Robert Olsson, Swedish University of Agricultural Sciences
  24  */
  25
  26 #ifndef _IRDP_H
  27 #define _IRDP_H
  28
  29 #include "lib/vty.h"
  30
  31 #define TRUE 1
  32 #define FALSE 0
  33
  34 /* ICMP Messages */
  35 #ifndef ICMP_ROUTERADVERT
  36 #define ICMP_ROUTERADVERT 9
  37 #endif /* ICMP_ROUTERADVERT */
  38
  39 #ifndef ICMP_ROUTERSOLICIT
  40 #define ICMP_ROUTERSOLICIT 10
  41 #endif /* ICMP_ROUTERSOLICT */
  42
  43 /* Multicast groups */
  44 #ifndef INADDR_ALLHOSTS_GROUP
  45 #define INADDR_ALLHOSTS_GROUP 0xe0000001U    /* 224.0.0.1 */
  46 #endif /* INADDR_ALLHOSTS_GROUP */
  47
  48 #ifndef INADDR_ALLRTRS_GROUP
  49 #define INADDR_ALLRTRS_GROUP  0xe0000002U    /* 224.0.0.2 */
  50 #endif /* INADDR_ALLRTRS_GROUP */
  51
  52 /* Default irdp packet interval */
  53 #define IRDP_DEFAULT_INTERVAL 300
  54
  55 /* Router constants from RFC1256 */
  56 #define MAX_INITIAL_ADVERT_INTERVAL 16
  57 #define MAX_INITIAL_ADVERTISEMENTS   3
  58 #define MAX_RESPONSE_DELAY           2
  59
  60 #define IRDP_MAXADVERTINTERVAL 600
  61 #define IRDP_MINADVERTINTERVAL 450 /* 0.75*600 */
  62 #define IRDP_LIFETIME         1350 /* 3*450 */
  63 #define IRDP_PREFERENCE 0
  64
  65 #define ICMP_MINLEN 8
  66
  67 #define IRDP_LAST_ADVERT_MESSAGES 2 /* The last adverts with Holdtime 0 */
  68
  69 #define IRDP_RX_BUF 1500
  70
  71 /*
  72      Comments comes from RFC1256 ICMP Router Discovery Messages.
  73
  74      The IP destination address to be used for multicast Router
  75      Advertisements sent from the interface.  The only permissible
  76      values are the all-systems multicast address, 224.0.0.1, or the
  77      limited-broadcast address, 255.255.255.255.  (The all-systems
  78      address is preferred wherever possible, i.e., on any link where
  79      all listening hosts support IP multicast.)
  80
  81      Default: 224.0.0.1 if the router supports IP multicast on the
  82      interface, else 255.255.255.255
  83
  84      The maximum time allowed between sending multicast Router
  85      Advertisements from the interface, in seconds.  Must be no less
  86      than 4 seconds and no greater than 1800 seconds.
  87
  88      Default: 600 seconds
  89
  90      The minimum time allowed between sending unsolicited multicast
  91      Router Advertisements from the interface, in seconds.  Must be no
  92      less than 3 seconds and no greater than MaxAdvertisementInterval.
  93
  94      Default: 0.75 * MaxAdvertisementInterval
  95
  96      The value to be placed in the Lifetime field of Router
  97      Advertisements sent from the interface, in seconds.  Must be no
  98      less than MaxAdvertisementInterval and no greater than 9000
  99      seconds.
 100
 101      Default: 3 * MaxAdvertisementInterval
 102
 103      The preferability of the address as a default router address,
 104      relative to other router addresses on the same subnet.  A 32-bit,
 105      signed, twos-complement integer, with higher values meaning more
 106      preferable.  The minimum value (hex 80000000) is used to indicate
 107      that the address, even though it may be advertised, is not to be
 108      used by neighboring hosts as a default router address.
 109
 110      Default: 0
 111 */
 112
 113 struct irdp_interface {
 114         bool started;
 115
 116         unsigned long MaxAdvertInterval;
 117         unsigned long MinAdvertInterval;
 118         unsigned long Preference;
 119
 120         uint32_t flags;
 121
 122 #define IF_ACTIVE               (1<<0) /* ICMP Active */
 123 #define IF_BROADCAST            (1<<1) /* 255.255.255.255 */
 124 #define IF_SOLICIT              (1<<2) /* Solicit active */
 125 #define IF_DEBUG_MESSAGES       (1<<3)
 126 #define IF_DEBUG_PACKET         (1<<4)
 127 #define IF_DEBUG_MISC           (1<<5)
 128 #define IF_SHUTDOWN             (1<<6)
 129
 130         struct interface *ifp;
 131         struct thread *t_advertise;
 132         unsigned long irdp_sent;
 133         uint16_t Lifetime;
 134
 135         struct list *AdvPrefList;
 136 };
 137
 138 struct Adv {
 139         struct in_addr ip;
 140         int pref;
 141 };
 142
 143 extern void irdp_if_init(void);
 144 extern int irdp_sock_init(void);
 145 extern int irdp_config_write(struct vty *, struct interface *);
 146 extern int irdp_send_thread(struct thread *t_advert);
 147 extern void irdp_advert_off(struct interface *ifp);
 148 extern void process_solicit(struct interface *ifp);
 149 extern int irdp_read_raw(struct thread *r);
 150 extern void send_packet(struct interface *ifp, struct stream *s, uint32_t dst,
 151                         struct prefix *p, uint32_t ttl);
 152
 153
 154 #endif /* _IRDP_H */