ospf6d/ospf6_area.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 OSPF_AREA_H
  22 #define OSPF_AREA_H
  23
  24 #include "ospf6_top.h"
  25
  26 struct ospf6_area {
  27         /* Reference to Top data structure */
  28         struct ospf6 *ospf6;
  29
  30         /* Area-ID */
  31         uint32_t area_id;
  32
  33 #define OSPF6_AREA_FMT_DOTTEDQUAD 1
  34 #define OSPF6_AREA_FMT_DECIMAL    2
  35         /* Area-ID string */
  36         char name[16];
  37
  38         /* flag */
  39         uint8_t flag;
  40
  41         /* OSPF Option */
  42         uint8_t options[3];
  43
  44         /* Summary routes to be originated (includes Configured Address Ranges)
  45          */
  46         struct ospf6_route_table *range_table;
  47         struct ospf6_route_table *summary_prefix;
  48         struct ospf6_route_table *summary_router;
  49
  50         /* Area type */
  51         int no_summary;
  52
  53         /* OSPF interface list */
  54         struct list *if_list;
  55
  56         struct ospf6_lsdb *lsdb;
  57         struct ospf6_lsdb *lsdb_self;
  58         struct ospf6_lsdb *temp_router_lsa_lsdb;
  59
  60         struct ospf6_route_table *spf_table;
  61         struct ospf6_route_table *route_table;
  62
  63         uint32_t spf_calculation; /* SPF calculation count */
  64
  65         struct thread *thread_router_lsa;
  66         struct thread *thread_intra_prefix_lsa;
  67         uint32_t router_lsa_size_limit;
  68
  69         /* Area announce list */
  70         struct {
  71                 char *name;
  72                 struct access_list *list;
  73         } _export;
  74 #define EXPORT_NAME(A)  (A)->_export.name
  75 #define EXPORT_LIST(A)  (A)->_export.list
  76
  77         /* Area acceptance list */
  78         struct {
  79                 char *name;
  80                 struct access_list *list;
  81         } import;
  82 #define IMPORT_NAME(A)  (A)->import.name
  83 #define IMPORT_LIST(A)  (A)->import.list
  84
  85         /* Type 3 LSA Area prefix-list */
  86         struct {
  87                 char *name;
  88                 struct prefix_list *list;
  89         } plist_in;
  90 #define PREFIX_NAME_IN(A)  (A)->plist_in.name
  91 #define PREFIX_LIST_IN(A)  (A)->plist_in.list
  92
  93         struct {
  94                 char *name;
  95                 struct prefix_list *list;
  96         } plist_out;
  97 #define PREFIX_NAME_OUT(A)  (A)->plist_out.name
  98 #define PREFIX_LIST_OUT(A)  (A)->plist_out.list
  99
 100         /* Time stamps. */
 101         struct timeval ts_spf; /* SPF calculation time stamp. */
 102
 103         uint32_t full_nbrs; /* Fully adjacent neighbors. */
 104         uint8_t intra_prefix_originate; /* Force intra_prefix lsa originate */
 105 };
 106
 107 #define OSPF6_AREA_ENABLE     0x01
 108 #define OSPF6_AREA_ACTIVE     0x02
 109 #define OSPF6_AREA_TRANSIT    0x04 /* TransitCapability */
 110 #define OSPF6_AREA_STUB       0x08
 111
 112 #define IS_AREA_ENABLED(oa) (CHECK_FLAG ((oa)->flag, OSPF6_AREA_ENABLE))
 113 #define IS_AREA_ACTIVE(oa) (CHECK_FLAG ((oa)->flag, OSPF6_AREA_ACTIVE))
 114 #define IS_AREA_TRANSIT(oa) (CHECK_FLAG ((oa)->flag, OSPF6_AREA_TRANSIT))
 115 #define IS_AREA_STUB(oa) (CHECK_FLAG ((oa)->flag, OSPF6_AREA_STUB))
 116
 117 /* prototypes */
 118 extern int ospf6_area_cmp(void *va, void *vb);
 119
 120 extern struct ospf6_area *ospf6_area_create(uint32_t, struct ospf6 *, int);
 121 extern void ospf6_area_delete(struct ospf6_area *);
 122 extern struct ospf6_area *ospf6_area_lookup(uint32_t, struct ospf6 *);
 123
 124 extern void ospf6_area_enable(struct ospf6_area *);
 125 extern void ospf6_area_disable(struct ospf6_area *);
 126
 127 extern void ospf6_area_show(struct vty *, struct ospf6_area *);
 128
 129 extern void ospf6_area_plist_update(struct prefix_list *plist, int add);
 130 extern void ospf6_area_config_write(struct vty *vty);
 131 extern void ospf6_area_init(void);
 132
 133 #endif /* OSPF_AREA_H */