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 #include "lib/json.h"
  26
  27 struct ospf6_area {
  28         /* Reference to Top data structure */
  29         struct ospf6 *ospf6;
  30
  31         /* Area-ID */
  32         in_addr_t area_id;
  33
  34 #define OSPF6_AREA_FMT_UNSET      0
  35 #define OSPF6_AREA_FMT_DOTTEDQUAD 1
  36 #define OSPF6_AREA_FMT_DECIMAL    2
  37         /* Area-ID string */
  38         char name[16];
  39
  40         /* flag */
  41         uint8_t flag;
  42
  43         /* OSPF Option */
  44         uint8_t options[3];
  45
  46         /* Summary routes to be originated (includes Configured Address Ranges)
  47          */
  48         struct ospf6_route_table *range_table;
  49         struct ospf6_route_table *summary_prefix;
  50         struct ospf6_route_table *summary_router;
  51
  52         /* Area type */
  53         int no_summary;
  54
  55         /* Brouter traversal protection */
  56         int intra_brouter_calc;
  57
  58         /* OSPF interface list */
  59         struct list *if_list;
  60
  61         struct ospf6_lsdb *lsdb;
  62         struct ospf6_lsdb *lsdb_self;
  63         struct ospf6_lsdb *temp_router_lsa_lsdb;
  64
  65         struct ospf6_route_table *spf_table;
  66         struct ospf6_route_table *route_table;
  67
  68         uint32_t spf_calculation; /* SPF calculation count */
  69
  70         struct thread *thread_router_lsa;
  71         struct thread *thread_intra_prefix_lsa;
  72         uint32_t router_lsa_size_limit;
  73
  74         /* Area announce list */
  75         struct {
  76                 char *name;
  77                 struct access_list *list;
  78         } _export;
  79 #define EXPORT_NAME(A)  (A)->_export.name
  80 #define EXPORT_LIST(A)  (A)->_export.list
  81
  82         /* Area acceptance list */
  83         struct {
  84                 char *name;
  85                 struct access_list *list;
  86         } import;
  87 #define IMPORT_NAME(A)  (A)->import.name
  88 #define IMPORT_LIST(A)  (A)->import.list
  89
  90         /* Type 3 LSA Area prefix-list */
  91         struct {
  92                 char *name;
  93                 struct prefix_list *list;
  94         } plist_in;
  95 #define PREFIX_NAME_IN(A)  (A)->plist_in.name
  96 #define PREFIX_LIST_IN(A)  (A)->plist_in.list
  97
  98         struct {
  99                 char *name;
 100                 struct prefix_list *list;
 101         } plist_out;
 102 #define PREFIX_NAME_OUT(A)  (A)->plist_out.name
 103 #define PREFIX_LIST_OUT(A)  (A)->plist_out.list
 104
 105         /* Time stamps. */
 106         struct timeval ts_spf; /* SPF calculation time stamp. */
 107
 108         uint32_t full_nbrs; /* Fully adjacent neighbors. */
 109         uint8_t intra_prefix_originate; /* Force intra_prefix lsa originate */
 110         uint8_t NSSATranslatorRole;     /* NSSA configured role */
 111 #define OSPF6_NSSA_ROLE_NEVER     0
 112 #define OSPF6_NSSA_ROLE_CANDIDATE 1
 113 #define OSPF6_NSSA_ROLE_ALWAYS    2
 114         uint8_t NSSATranslatorState; /* NSSA operational role */
 115 #define OSPF6_NSSA_TRANSLATE_DISABLED 0
 116 #define OSPF6_NSSA_TRANSLATE_ENABLED  1
 117 };
 118
 119 #define OSPF6_AREA_DEFAULT    0x00
 120 #define OSPF6_AREA_ENABLE     0x01
 121 #define OSPF6_AREA_ACTIVE     0x02
 122 #define OSPF6_AREA_TRANSIT    0x04 /* TransitCapability */
 123 #define OSPF6_AREA_STUB       0x08
 124 #define OSPF6_AREA_NSSA       0x10
 125
 126 #define IS_AREA_ENABLED(oa) (CHECK_FLAG ((oa)->flag, OSPF6_AREA_ENABLE))
 127 #define IS_AREA_ACTIVE(oa) (CHECK_FLAG ((oa)->flag, OSPF6_AREA_ACTIVE))
 128 #define IS_AREA_TRANSIT(oa) (CHECK_FLAG ((oa)->flag, OSPF6_AREA_TRANSIT))
 129 #define IS_AREA_STUB(oa) (CHECK_FLAG ((oa)->flag, OSPF6_AREA_STUB))
 130 #define IS_AREA_NSSA(oa) (CHECK_FLAG((oa)->flag, OSPF6_AREA_NSSA))
 131
 132 #define OSPF6_CMD_AREA_GET(str, oa, ospf6)                                     \
 133         {                                                                      \
 134                 uint32_t area_id;                                              \
 135                 int format, ret;                                               \
 136                 ret = str2area_id(str, &area_id, &format);                     \
 137                 if (ret) {                                                     \
 138                         vty_out(vty, "Malformed Area-ID: %s\n", str);          \
 139                         return CMD_WARNING;                                    \
 140                 }                                                              \
 141                 oa = ospf6_area_lookup(area_id, ospf6);                        \
 142                 if (oa == NULL)                                                \
 143                         oa = ospf6_area_create(area_id, ospf6, format);        \
 144         }
 145
 146 /* prototypes */
 147 extern int str2area_id(const char *str, uint32_t *area_id, int *area_id_fmt);
 148 extern void area_id2str(char *buf, int len, uint32_t area_id, int area_id_fmt);
 149
 150 extern int ospf6_area_cmp(void *va, void *vb);
 151
 152 extern struct ospf6_area *ospf6_area_create(uint32_t, struct ospf6 *, int);
 153 extern void ospf6_area_delete(struct ospf6_area *);
 154 extern struct ospf6_area *ospf6_area_lookup(uint32_t, struct ospf6 *);
 155 extern struct ospf6_area *ospf6_area_lookup_by_area_id(uint32_t area_id);
 156
 157 extern void ospf6_area_enable(struct ospf6_area *);
 158 extern void ospf6_area_disable(struct ospf6_area *);
 159
 160 extern void ospf6_area_show(struct vty *, struct ospf6_area *,
 161                             json_object *json_areas, bool use_json);
 162
 163 extern void ospf6_area_plist_update(struct prefix_list *plist, int add);
 164 extern void ospf6_filter_update(struct access_list *access);
 165 extern void ospf6_area_config_write(struct vty *vty, struct ospf6 *ospf6);
 166 extern void ospf6_area_init(void);
 167 struct ospf6_interface;
 168 extern void ospf6_area_interface_delete(struct ospf6_interface *oi);
 169
 170 #endif /* OSPF_AREA_H */