ospfd/ospf_neighbor.h

   1 /*
   2  * OSPF Neighbor functions.
   3  * Copyright (C) 1999, 2000 Toshiaki Takada
   4  *
   5  * This file is part of GNU Zebra.
   6  *
   7  * GNU Zebra is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published
   9  * by the Free Software Foundation; either version 2, or (at your
  10  * option) any later version.
  11  *
  12  * GNU Zebra is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; see the file COPYING; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #ifndef _ZEBRA_OSPF_NEIGHBOR_H
  23 #define _ZEBRA_OSPF_NEIGHBOR_H
  24
  25 #include <ospfd/ospf_gr.h>
  26 #include <ospfd/ospf_packet.h>
  27
  28 /* Neighbor Data Structure */
  29 struct ospf_neighbor {
  30         /* This neighbor's parent ospf interface. */
  31         struct ospf_interface *oi;
  32
  33         /* OSPF neighbor Information */
  34         uint8_t state;      /* NSM status. */
  35         uint8_t dd_flags;   /* DD bit flags. */
  36         uint32_t dd_seqnum; /* DD Sequence Number. */
  37
  38         /* Neighbor Information from Hello. */
  39         struct prefix address; /* Neighbor Interface Address. */
  40
  41         struct in_addr src;       /* Src address. */
  42         struct in_addr router_id; /* Router ID. */
  43         uint8_t options;          /* Options. */
  44         int priority;             /* Router Priority. */
  45         struct in_addr d_router;  /* Designated Router. */
  46         struct in_addr bd_router; /* Backup Designated Router. */
  47
  48         /* Last sent Database Description packet. */
  49         struct ospf_packet *last_send;
  50         /* Timestemp when last Database Description packet was sent */
  51         struct timeval last_send_ts;
  52
  53         /* Last received Databse Description packet. */
  54         struct {
  55                 uint8_t options;
  56                 uint8_t flags;
  57                 uint32_t dd_seqnum;
  58         } last_recv;
  59
  60         /* LSA data. */
  61         struct ospf_lsdb ls_rxmt;
  62         struct ospf_lsdb db_sum;
  63         struct ospf_lsdb ls_req;
  64         struct ospf_lsa *ls_req_last;
  65
  66         uint32_t crypt_seqnum; /* Cryptographic Sequence Number. */
  67
  68         /* Timer values. */
  69         uint32_t v_inactivity;
  70         uint32_t v_db_desc;
  71         uint32_t v_ls_req;
  72         uint32_t v_ls_upd;
  73
  74         /* Threads. */
  75         struct thread *t_inactivity;
  76         struct thread *t_db_desc;
  77         struct thread *t_ls_req;
  78         struct thread *t_ls_upd;
  79         struct thread *t_hello_reply;
  80
  81         /* NBMA configured neighbour */
  82         struct ospf_nbr_nbma *nbr_nbma;
  83
  84         /* Statistics */
  85         struct timeval ts_last_progress; /* last advance of NSM            */
  86         struct timeval ts_last_regress;  /* last regressive NSM change     */
  87         const char *last_regress_str;    /* Event which last regressed NSM */
  88         uint32_t state_change;           /* NSM state change counter       */
  89
  90         /* BFD information */
  91         struct bfd_session_params *bfd_session;
  92
  93         /* ospf graceful restart HELPER info */
  94         struct ospf_helper_info gr_helper_info;
  95 };
  96
  97 /* Macros. */
  98 #define NBR_IS_DR(n)    IPV4_ADDR_SAME (&n->address.u.prefix4, &n->d_router)
  99 #define NBR_IS_BDR(n)   IPV4_ADDR_SAME (&n->address.u.prefix4, &n->bd_router)
 100
 101 /* Prototypes. */
 102 extern struct ospf_neighbor *ospf_nbr_new(struct ospf_interface *);
 103 extern void ospf_nbr_free(struct ospf_neighbor *);
 104 extern void ospf_nbr_delete(struct ospf_neighbor *);
 105 extern int ospf_nbr_bidirectional(struct in_addr *, struct in_addr *, int);
 106 extern void ospf_nbr_self_reset(struct ospf_interface *, struct in_addr);
 107 extern void ospf_nbr_add_self(struct ospf_interface *, struct in_addr);
 108 extern int ospf_nbr_count(struct ospf_interface *, int);
 109 extern int ospf_nbr_count_opaque_capable(struct ospf_interface *);
 110 extern struct ospf_neighbor *ospf_nbr_get(struct ospf_interface *,
 111                                           struct ospf_header *, struct ip *,
 112                                           struct prefix *);
 113 extern struct ospf_neighbor *ospf_nbr_lookup(struct ospf_interface *,
 114                                              struct ip *, struct ospf_header *);
 115 extern struct ospf_neighbor *ospf_nbr_lookup_by_addr(struct route_table *,
 116                                                      struct in_addr *);
 117 extern struct ospf_neighbor *ospf_nbr_lookup_by_routerid(struct route_table *,
 118                                                          struct in_addr *);
 119 extern void ospf_renegotiate_optional_capabilities(struct ospf *top);
 120 #endif /* _ZEBRA_OSPF_NEIGHBOR_H */