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         uint32_t area_id;
  43         int area_id_format;
  44
  45         /* list of ospf6 neighbor */
  46         struct list *neighbor_list;
  47
  48         /* linklocal address of this I/F */
  49         struct in6_addr *linklocal_addr;
  50
  51         /* Interface ID; use interface->ifindex */
  52
  53         /* ospf6 instance id */
  54         uint8_t instance_id;
  55
  56         /* I/F transmission delay */
  57         uint32_t transdelay;
  58
  59         /* Packet send buffer. */
  60         struct ospf6_fifo *obuf; /* Output queue */
  61
  62         /* Network Type */
  63         uint8_t type;
  64         bool type_cfg;
  65
  66         /* Router Priority */
  67         uint8_t priority;
  68
  69         /* Time Interval */
  70         uint16_t hello_interval;
  71         uint16_t dead_interval;
  72         uint32_t rxmt_interval;
  73
  74         uint32_t state_change;
  75
  76         /* Cost */
  77         uint32_t cost;
  78
  79         /* I/F MTU */
  80         uint32_t ifmtu;
  81
  82         /* Configured MTU */
  83         uint32_t c_ifmtu;
  84
  85         /* Interface State */
  86         uint8_t state;
  87
  88         /* Interface socket setting trial counter, resets on success */
  89         uint8_t sso_try_cnt;
  90         struct thread *thread_sso;
  91
  92         /* OSPF6 Interface flag */
  93         char flag;
  94
  95         /* MTU mismatch check */
  96         uint8_t mtu_ignore;
  97
  98         /* Decision of DR Election */
  99         in_addr_t drouter;
 100         in_addr_t bdrouter;
 101         in_addr_t prev_drouter;
 102         in_addr_t prev_bdrouter;
 103
 104         /* Linklocal LSA Database: includes Link-LSA */
 105         struct ospf6_lsdb *lsdb;
 106         struct ospf6_lsdb *lsdb_self;
 107
 108         struct ospf6_lsdb *lsupdate_list;
 109         struct ospf6_lsdb *lsack_list;
 110
 111         /* Ongoing Tasks */
 112         struct thread *thread_send_hello;
 113         struct thread *thread_send_lsupdate;
 114         struct thread *thread_send_lsack;
 115
 116         struct thread *thread_network_lsa;
 117         struct thread *thread_link_lsa;
 118         struct thread *thread_intra_prefix_lsa;
 119         struct thread *thread_as_extern_lsa;
 120         struct thread *thread_wait_timer;
 121
 122         struct ospf6_route_table *route_connected;
 123
 124         /* last hello sent */
 125         struct timeval last_hello;
 126
 127         /* prefix-list name to filter connected prefix */
 128         char *plist_name;
 129
 130         /* BFD information */
 131         struct {
 132                 bool enabled;
 133                 uint8_t detection_multiplier;
 134                 uint32_t min_rx;
 135                 uint32_t min_tx;
 136                 char *profile;
 137         } bfd_config;
 138
 139         int on_write_q;
 140
 141         /* Statistics Fields */
 142         uint32_t hello_in;
 143         uint32_t hello_out;
 144         uint32_t db_desc_in;
 145         uint32_t db_desc_out;
 146         uint32_t ls_req_in;
 147         uint32_t ls_req_out;
 148         uint32_t ls_upd_in;
 149         uint32_t ls_upd_out;
 150         uint32_t ls_ack_in;
 151         uint32_t ls_ack_out;
 152         uint32_t discarded;
 153
 154         QOBJ_FIELDS;
 155 };
 156 DECLARE_QOBJ_TYPE(ospf6_interface);
 157
 158 /* interface state */
 159 #define OSPF6_INTERFACE_NONE             0
 160 #define OSPF6_INTERFACE_DOWN             1
 161 #define OSPF6_INTERFACE_LOOPBACK         2
 162 #define OSPF6_INTERFACE_WAITING          3
 163 #define OSPF6_INTERFACE_POINTTOPOINT     4
 164 #define OSPF6_INTERFACE_DROTHER          5
 165 #define OSPF6_INTERFACE_BDR              6
 166 #define OSPF6_INTERFACE_DR               7
 167 #define OSPF6_INTERFACE_MAX              8
 168
 169 extern const char *const ospf6_interface_state_str[];
 170
 171 /* flags */
 172 #define OSPF6_INTERFACE_DISABLE      0x01
 173 #define OSPF6_INTERFACE_PASSIVE      0x02
 174 #define OSPF6_INTERFACE_NOAUTOCOST   0x04
 175
 176 /* default values */
 177 #define OSPF6_INTERFACE_HELLO_INTERVAL 10
 178 #define OSPF6_INTERFACE_DEAD_INTERVAL  40
 179 #define OSPF6_INTERFACE_RXMT_INTERVAL  5
 180 #define OSPF6_INTERFACE_COST           1
 181 #define OSPF6_INTERFACE_PRIORITY       1
 182 #define OSPF6_INTERFACE_TRANSDELAY     1
 183 #define OSPF6_INTERFACE_INSTANCE_ID    0
 184 #define OSPF6_INTERFACE_BANDWIDTH      10000   /* Mbps */
 185 #define OSPF6_REFERENCE_BANDWIDTH      100000  /* Mbps */
 186 #define OSPF6_INTERFACE_SSO_RETRY_INT  1
 187 #define OSPF6_INTERFACE_SSO_RETRY_MAX  5
 188
 189 /* Function Prototypes */
 190
 191 extern void ospf6_interface_start(struct ospf6_interface *oi);
 192 extern void ospf6_interface_stop(struct ospf6_interface *oi);
 193
 194 extern struct ospf6_interface *
 195 ospf6_interface_lookup_by_ifindex(ifindex_t, vrf_id_t vrf_id);
 196 extern struct ospf6_interface *ospf6_interface_create(struct interface *ifp);
 197 extern void ospf6_interface_delete(struct ospf6_interface *oi);
 198
 199 extern void ospf6_interface_enable(struct ospf6_interface *oi);
 200 extern void ospf6_interface_disable(struct ospf6_interface *oi);
 201
 202 extern void ospf6_interface_state_update(struct interface *ifp);
 203 extern void ospf6_interface_connected_route_update(struct interface *ifp);
 204 extern struct in6_addr *
 205 ospf6_interface_get_global_address(struct interface *ifp);
 206
 207 /* interface event */
 208 extern int interface_up(struct thread *thread);
 209 extern int interface_down(struct thread *thread);
 210 extern int wait_timer(struct thread *thread);
 211 extern int backup_seen(struct thread *thread);
 212 extern int neighbor_change(struct thread *thread);
 213
 214 extern void ospf6_interface_init(void);
 215 extern void ospf6_interface_clear(struct interface *ifp);
 216
 217 extern void install_element_ospf6_clear_interface(void);
 218
 219 extern int config_write_ospf6_debug_interface(struct vty *vty);
 220 extern void install_element_ospf6_debug_interface(void);
 221 extern int ospf6_interface_neighbor_count(struct ospf6_interface *oi);
 222 extern uint8_t dr_election(struct ospf6_interface *oi);
 223
 224 DECLARE_HOOK(ospf6_interface_change,
 225              (struct ospf6_interface * oi, int state, int old_state),
 226              (oi, state, old_state));
 227
 228 #endif /* OSPF6_INTERFACE_H */