ospf6d/ospf6_interface.h

   1 /*
   2  * Copyright (C) 2003 Yasuhiro Ohara
   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 #ifndef OSPF6_INTERFACE_H
  22 #define OSPF6_INTERFACE_H
  23
  24 #include "qobj.h"
  25 #include "hook.h"
  26 #include "if.h"
  27
  28 /* Debug option */
  29 extern unsigned char conf_debug_ospf6_interface;
  30 #define OSPF6_DEBUG_INTERFACE_ON() (conf_debug_ospf6_interface = 1)
  31 #define OSPF6_DEBUG_INTERFACE_OFF() (conf_debug_ospf6_interface = 0)
  32 #define IS_OSPF6_DEBUG_INTERFACE (conf_debug_ospf6_interface)
  33
  34 /* Interface structure */
  35 struct ospf6_interface {
  36         /* IF info from zebra */
  37         struct interface *interface;
  38
  39         /* back pointer */
  40         struct ospf6_area *area;
  41
  42         /* list of ospf6 neighbor */
  43         struct list *neighbor_list;
  44
  45         /* linklocal address of this I/F */
  46         struct in6_addr *linklocal_addr;
  47
  48         /* Interface ID; use interface->ifindex */
  49
  50         /* ospf6 instance id */
  51         uint8_t instance_id;
  52
  53         /* I/F transmission delay */
  54         uint32_t transdelay;
  55
  56         /* Network Type */
  57         uint8_t type;
  58         bool type_cfg;
  59
  60         /* Router Priority */
  61         uint8_t priority;
  62
  63         /* Time Interval */
  64         uint16_t hello_interval;
  65         uint16_t dead_interval;
  66         uint32_t rxmt_interval;
  67
  68         uint32_t state_change;
  69
  70         /* Cost */
  71         uint32_t cost;
  72
  73         /* I/F MTU */
  74         uint32_t ifmtu;
  75
  76         /* Configured MTU */
  77         uint32_t c_ifmtu;
  78
  79         /* Interface State */
  80         uint8_t state;
  81
  82         /* Interface socket setting trial counter, resets on success */
  83         uint8_t sso_try_cnt;
  84         struct thread *thread_sso;
  85
  86         /* OSPF6 Interface flag */
  87         char flag;
  88
  89         /* MTU mismatch check */
  90         uint8_t mtu_ignore;
  91
  92         /* Decision of DR Election */
  93         uint32_t drouter;
  94         uint32_t bdrouter;
  95         uint32_t prev_drouter;
  96         uint32_t prev_bdrouter;
  97
  98         /* Linklocal LSA Database: includes Link-LSA */
  99         struct ospf6_lsdb *lsdb;
 100         struct ospf6_lsdb *lsdb_self;
 101
 102         struct ospf6_lsdb *lsupdate_list;
 103         struct ospf6_lsdb *lsack_list;
 104
 105         /* Ongoing Tasks */
 106         struct thread *thread_send_hello;
 107         struct thread *thread_send_lsupdate;
 108         struct thread *thread_send_lsack;
 109
 110         struct thread *thread_network_lsa;
 111         struct thread *thread_link_lsa;
 112         struct thread *thread_intra_prefix_lsa;
 113         struct thread *thread_as_extern_lsa;
 114
 115         struct ospf6_route_table *route_connected;
 116
 117         /* prefix-list name to filter connected prefix */
 118         char *plist_name;
 119
 120         /* BFD information */
 121         void *bfd_info;
 122
 123         /* Statistics Fields */
 124         uint32_t hello_in;
 125         uint32_t hello_out;
 126         uint32_t db_desc_in;
 127         uint32_t db_desc_out;
 128         uint32_t ls_req_in;
 129         uint32_t ls_req_out;
 130         uint32_t ls_upd_in;
 131         uint32_t ls_upd_out;
 132         uint32_t ls_ack_in;
 133         uint32_t ls_ack_out;
 134         uint32_t discarded;
 135
 136         QOBJ_FIELDS
 137 };
 138 DECLARE_QOBJ_TYPE(ospf6_interface)
 139
 140 /* interface state */
 141 #define OSPF6_INTERFACE_NONE             0
 142 #define OSPF6_INTERFACE_DOWN             1
 143 #define OSPF6_INTERFACE_LOOPBACK         2
 144 #define OSPF6_INTERFACE_WAITING          3
 145 #define OSPF6_INTERFACE_POINTTOPOINT     4
 146 #define OSPF6_INTERFACE_DROTHER          5
 147 #define OSPF6_INTERFACE_BDR              6
 148 #define OSPF6_INTERFACE_DR               7
 149 #define OSPF6_INTERFACE_MAX              8
 150
 151 extern const char *const ospf6_interface_state_str[];
 152
 153 /* flags */
 154 #define OSPF6_INTERFACE_DISABLE      0x01
 155 #define OSPF6_INTERFACE_PASSIVE      0x02
 156 #define OSPF6_INTERFACE_NOAUTOCOST   0x04
 157
 158 /* default values */
 159 #define OSPF6_INTERFACE_HELLO_INTERVAL 10
 160 #define OSPF6_INTERFACE_DEAD_INTERVAL  40
 161 #define OSPF6_INTERFACE_RXMT_INTERVAL  5
 162 #define OSPF6_INTERFACE_COST           1
 163 #define OSPF6_INTERFACE_PRIORITY       1
 164 #define OSPF6_INTERFACE_TRANSDELAY     1
 165 #define OSPF6_INTERFACE_INSTANCE_ID    0
 166 #define OSPF6_INTERFACE_BANDWIDTH      10000   /* Mbps */
 167 #define OSPF6_REFERENCE_BANDWIDTH      100000  /* Mbps */
 168 #define OSPF6_INTERFACE_SSO_RETRY_INT  1
 169 #define OSPF6_INTERFACE_SSO_RETRY_MAX  5
 170
 171 /* Function Prototypes */
 172
 173 extern struct ospf6_interface *ospf6_interface_lookup_by_ifindex(ifindex_t);
 174 extern struct ospf6_interface *ospf6_interface_create(struct interface *);
 175 extern void ospf6_interface_delete(struct ospf6_interface *);
 176
 177 extern void ospf6_interface_enable(struct ospf6_interface *);
 178 extern void ospf6_interface_disable(struct ospf6_interface *);
 179
 180 extern void ospf6_interface_if_add(struct interface *);
 181 extern void ospf6_interface_state_update(struct interface *);
 182 extern void ospf6_interface_connected_route_update(struct interface *);
 183
 184 /* interface event */
 185 extern int interface_up(struct thread *);
 186 extern int interface_down(struct thread *);
 187 extern int wait_timer(struct thread *);
 188 extern int backup_seen(struct thread *);
 189 extern int neighbor_change(struct thread *);
 190
 191 extern void ospf6_interface_init(void);
 192
 193 extern void install_element_ospf6_clear_interface(void);
 194
 195 extern int config_write_ospf6_debug_interface(struct vty *vty);
 196 extern void install_element_ospf6_debug_interface(void);
 197
 198 DECLARE_HOOK(ospf6_interface_change,
 199              (struct ospf6_interface * oi, int state, int old_state),
 200              (oi, state, old_state))
 201
 202 #endif /* OSPF6_INTERFACE_H */