Annotation of embedaddon/quagga/ospf6d/ospf6_route.h, revision 1.1.1.3

1.1       misho       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
                     17:  * along with GNU Zebra; see the file COPYING.  If not, write to the 
                     18:  * Free Software Foundation, Inc., 59 Temple Place - Suite 330, 
                     19:  * Boston, MA 02111-1307, USA.  
                     20:  */
                     21: 
                     22: #ifndef OSPF6_ROUTE_H
                     23: #define OSPF6_ROUTE_H
                     24: 
                     25: #define OSPF6_MULTI_PATH_LIMIT    4
                     26: 
                     27: /* Debug option */
                     28: extern unsigned char conf_debug_ospf6_route;
                     29: #define OSPF6_DEBUG_ROUTE_TABLE   0x01
                     30: #define OSPF6_DEBUG_ROUTE_INTRA   0x02
                     31: #define OSPF6_DEBUG_ROUTE_INTER   0x04
                     32: #define OSPF6_DEBUG_ROUTE_MEMORY  0x80
                     33: #define OSPF6_DEBUG_ROUTE_ON(level) \
                     34:   (conf_debug_ospf6_route |= (level))
                     35: #define OSPF6_DEBUG_ROUTE_OFF(level) \
                     36:   (conf_debug_ospf6_route &= ~(level))
                     37: #define IS_OSPF6_DEBUG_ROUTE(e) \
                     38:   (conf_debug_ospf6_route & OSPF6_DEBUG_ROUTE_ ## e)
                     39: 
                     40: /* Nexthop */
                     41: struct ospf6_nexthop
                     42: {
                     43:   /* Interface index */
1.1.1.3 ! misho      44:   ifindex_t ifindex;
1.1       misho      45: 
                     46:   /* IP address, if any */
                     47:   struct in6_addr address;
                     48: };
                     49: 
                     50: #define ospf6_nexthop_is_set(x)                                \
                     51:   ((x)->ifindex || ! IN6_IS_ADDR_UNSPECIFIED (&(x)->address))
                     52: #define ospf6_nexthop_is_same(a,b)                             \
                     53:   ((a)->ifindex == (b)->ifindex &&                            \
                     54:    IN6_ARE_ADDR_EQUAL (&(a)->address, &(b)->address))
                     55: #define ospf6_nexthop_clear(x)                                \
                     56:   do {                                                        \
                     57:     (x)->ifindex = 0;                                         \
                     58:     memset (&(x)->address, 0, sizeof (struct in6_addr));      \
                     59:   } while (0)
                     60: #define ospf6_nexthop_copy(a, b)                              \
                     61:   do {                                                        \
                     62:     (a)->ifindex = (b)->ifindex;                              \
                     63:     memcpy (&(a)->address, &(b)->address,                     \
                     64:             sizeof (struct in6_addr));                        \
                     65:   } while (0)
                     66: 
                     67: /* Path */
                     68: struct ospf6_ls_origin
                     69: {
                     70:   u_int16_t type;
                     71:   u_int32_t id;
                     72:   u_int32_t adv_router;
                     73: };
                     74: 
                     75: struct ospf6_path
                     76: {
                     77:   /* Link State Origin */
                     78:   struct ospf6_ls_origin origin;
                     79: 
                     80:   /* Router bits */
                     81:   u_char router_bits;
                     82: 
                     83:   /* Optional Capabilities */
                     84:   u_char options[3];
                     85: 
                     86:   /* Prefix Options */
                     87:   u_char prefix_options;
                     88: 
                     89:   /* Associated Area */
                     90:   u_int32_t area_id;
                     91: 
                     92:   /* Path-type */
                     93:   u_char type;
                     94:   u_char subtype; /* only used for redistribute i.e ZEBRA_ROUTE_XXX */
                     95: 
                     96:   /* Cost */
                     97:   u_int8_t metric_type;
                     98:   u_int32_t cost;
                     99:   u_int32_t cost_e2;
                    100: };
                    101: 
                    102: #define OSPF6_PATH_TYPE_NONE         0
                    103: #define OSPF6_PATH_TYPE_INTRA        1
                    104: #define OSPF6_PATH_TYPE_INTER        2
                    105: #define OSPF6_PATH_TYPE_EXTERNAL1    3
                    106: #define OSPF6_PATH_TYPE_EXTERNAL2    4
                    107: #define OSPF6_PATH_TYPE_REDISTRIBUTE 5
                    108: #define OSPF6_PATH_TYPE_MAX          6
                    109: 
                    110: #include "prefix.h"
                    111: #include "table.h"
                    112: 
                    113: struct ospf6_route
                    114: {
                    115:   struct route_node *rnode;
                    116:   struct ospf6_route_table *table;
                    117:   struct ospf6_route *prev;
                    118:   struct ospf6_route *next;
                    119: 
                    120:   unsigned int lock;
                    121: 
                    122:   /* Destination Type */
                    123:   u_char type;
                    124: 
1.1.1.3 ! misho     125:   /* XXX: It would likely be better to use separate struct in_addr's
        !           126:    * for the advertising router-ID and prefix IDs, instead of stuffing them
        !           127:    * into one. See also XXX below.
        !           128:    */
1.1       misho     129:   /* Destination ID */
                    130:   struct prefix prefix;
                    131: 
                    132:   /* Time */
                    133:   struct timeval installed;
                    134:   struct timeval changed;
                    135: 
                    136:   /* flag */
                    137:   u_char flag;
                    138: 
                    139:   /* path */
                    140:   struct ospf6_path path;
                    141: 
                    142:   /* nexthop */
                    143:   struct ospf6_nexthop nexthop[OSPF6_MULTI_PATH_LIMIT];
                    144: 
                    145:   /* route option */
                    146:   void *route_option;
                    147: 
                    148:   /* link state id for advertising */
                    149:   u_int32_t linkstate_id;
                    150: };
                    151: 
                    152: #define OSPF6_DEST_TYPE_NONE       0
                    153: #define OSPF6_DEST_TYPE_ROUTER     1
                    154: #define OSPF6_DEST_TYPE_NETWORK    2
                    155: #define OSPF6_DEST_TYPE_DISCARD    3
                    156: #define OSPF6_DEST_TYPE_LINKSTATE  4
                    157: #define OSPF6_DEST_TYPE_RANGE      5
                    158: #define OSPF6_DEST_TYPE_MAX        6
                    159: 
                    160: #define OSPF6_ROUTE_CHANGE           0x01
                    161: #define OSPF6_ROUTE_ADD              0x02
                    162: #define OSPF6_ROUTE_REMOVE           0x04
                    163: #define OSPF6_ROUTE_BEST             0x08
                    164: #define OSPF6_ROUTE_ACTIVE_SUMMARY   0x10
                    165: #define OSPF6_ROUTE_DO_NOT_ADVERTISE 0x20
                    166: #define OSPF6_ROUTE_WAS_REMOVED      0x40
                    167: 
                    168: struct ospf6_route_table
                    169: {
                    170:   int scope_type;
                    171:   int table_type;
                    172:   void *scope;
                    173: 
                    174:   /* patricia tree */
                    175:   struct route_table *table;
                    176: 
                    177:   u_int32_t count;
                    178: 
                    179:   /* hooks */
                    180:   void (*hook_add) (struct ospf6_route *);
                    181:   void (*hook_change) (struct ospf6_route *);
                    182:   void (*hook_remove) (struct ospf6_route *);
                    183: };
                    184: 
                    185: #define OSPF6_SCOPE_TYPE_NONE      0
                    186: #define OSPF6_SCOPE_TYPE_GLOBAL    1
                    187: #define OSPF6_SCOPE_TYPE_AREA      2
                    188: #define OSPF6_SCOPE_TYPE_INTERFACE 3
                    189: 
                    190: #define OSPF6_TABLE_TYPE_NONE              0
                    191: #define OSPF6_TABLE_TYPE_ROUTES            1
                    192: #define OSPF6_TABLE_TYPE_BORDER_ROUTERS    2
                    193: #define OSPF6_TABLE_TYPE_CONNECTED_ROUTES  3
                    194: #define OSPF6_TABLE_TYPE_EXTERNAL_ROUTES   4
                    195: #define OSPF6_TABLE_TYPE_SPF_RESULTS       5
                    196: #define OSPF6_TABLE_TYPE_PREFIX_RANGES     6
                    197: #define OSPF6_TABLE_TYPE_SUMMARY_PREFIXES  7
                    198: #define OSPF6_TABLE_TYPE_SUMMARY_ROUTERS   8
                    199: 
                    200: #define OSPF6_ROUTE_TABLE_CREATE(s, t) \
                    201:   ospf6_route_table_create (OSPF6_SCOPE_TYPE_ ## s, \
                    202:                             OSPF6_TABLE_TYPE_ ## t)
                    203: 
                    204: extern const char *ospf6_dest_type_str[OSPF6_DEST_TYPE_MAX];
                    205: extern const char *ospf6_dest_type_substr[OSPF6_DEST_TYPE_MAX];
                    206: #define OSPF6_DEST_TYPE_NAME(x)                       \
                    207:   (0 < (x) && (x) < OSPF6_DEST_TYPE_MAX ?             \
                    208:    ospf6_dest_type_str[(x)] : ospf6_dest_type_str[0])
                    209: #define OSPF6_DEST_TYPE_SUBSTR(x)                           \
                    210:   (0 < (x) && (x) < OSPF6_DEST_TYPE_MAX ?                   \
                    211:    ospf6_dest_type_substr[(x)] : ospf6_dest_type_substr[0])
                    212: 
                    213: extern const char *ospf6_path_type_str[OSPF6_PATH_TYPE_MAX];
                    214: extern const char *ospf6_path_type_substr[OSPF6_PATH_TYPE_MAX];
                    215: #define OSPF6_PATH_TYPE_NAME(x)                       \
                    216:   (0 < (x) && (x) < OSPF6_PATH_TYPE_MAX ?             \
                    217:    ospf6_path_type_str[(x)] : ospf6_path_type_str[0])
                    218: #define OSPF6_PATH_TYPE_SUBSTR(x)                           \
                    219:   (0 < (x) && (x) < OSPF6_PATH_TYPE_MAX ?                   \
                    220:    ospf6_path_type_substr[(x)] : ospf6_path_type_substr[0])
                    221: 
                    222: #define OSPF6_ROUTE_ADDRESS_STR "Display the route bestmatches the address\n"
                    223: #define OSPF6_ROUTE_PREFIX_STR  "Display the route\n"
                    224: #define OSPF6_ROUTE_MATCH_STR   "Display the route matches the prefix\n"
                    225: 
                    226: #define ospf6_route_is_prefix(p, r) \
                    227:   (memcmp (p, &(r)->prefix, sizeof (struct prefix)) == 0)
                    228: #define ospf6_route_is_same(ra, rb) \
                    229:   (prefix_same (&(ra)->prefix, &(rb)->prefix))
                    230: #define ospf6_route_is_same_origin(ra, rb) \
                    231:   ((ra)->path.area_id == (rb)->path.area_id && \
                    232:    memcmp (&(ra)->path.origin, &(rb)->path.origin, \
                    233:            sizeof (struct ospf6_ls_origin)) == 0)
                    234: #define ospf6_route_is_identical(ra, rb) \
                    235:   ((ra)->type == (rb)->type && \
                    236:    memcmp (&(ra)->prefix, &(rb)->prefix, sizeof (struct prefix)) == 0 && \
                    237:    memcmp (&(ra)->path, &(rb)->path, sizeof (struct ospf6_path)) == 0 && \
                    238:    memcmp (&(ra)->nexthop, &(rb)->nexthop,                               \
                    239:            sizeof (struct ospf6_nexthop) * OSPF6_MULTI_PATH_LIMIT) == 0)
                    240: #define ospf6_route_is_best(r) (CHECK_FLAG ((r)->flag, OSPF6_ROUTE_BEST))
                    241: 
                    242: #define ospf6_linkstate_prefix_adv_router(x) \
1.1.1.3 ! misho     243:   ((x)->u.lp.id.s_addr)
1.1       misho     244: #define ospf6_linkstate_prefix_id(x) \
1.1.1.3 ! misho     245:   ((x)->u.lp.adv_router.s_addr)
1.1       misho     246: 
                    247: #define ADV_ROUTER_IN_PREFIX(x) \
1.1.1.3 ! misho     248:   ((x)->u.lp.id.s_addr)
1.1       misho     249: #define ID_IN_PREFIX(x) \
1.1.1.3 ! misho     250:   ((x)->u.lp.adv_router.s_addr)
1.1       misho     251: 
                    252: /* Function prototype */
                    253: extern void ospf6_linkstate_prefix (u_int32_t adv_router, u_int32_t id,
                    254:                                     struct prefix *prefix);
                    255: extern void ospf6_linkstate_prefix2str (struct prefix *prefix, char *buf,
                    256:                                         int size);
                    257: 
                    258: extern struct ospf6_route *ospf6_route_create (void);
                    259: extern void ospf6_route_delete (struct ospf6_route *);
                    260: extern struct ospf6_route *ospf6_route_copy (struct ospf6_route *route);
                    261: 
                    262: extern void ospf6_route_lock (struct ospf6_route *route);
                    263: extern void ospf6_route_unlock (struct ospf6_route *route);
                    264: 
                    265: extern struct ospf6_route *ospf6_route_lookup (struct prefix *prefix,
                    266:                                                struct ospf6_route_table *table);
                    267: extern struct ospf6_route *ospf6_route_lookup_identical (struct ospf6_route *route,
                    268:                                             struct ospf6_route_table *table);
                    269: extern struct ospf6_route *ospf6_route_lookup_bestmatch (struct prefix *prefix,
                    270:                                               struct ospf6_route_table *table);
                    271: 
                    272: extern struct ospf6_route *ospf6_route_add (struct ospf6_route *route,
                    273:                                             struct ospf6_route_table *table);
                    274: extern void ospf6_route_remove (struct ospf6_route *route,
                    275:                                 struct ospf6_route_table *table);
                    276: 
                    277: extern struct ospf6_route *ospf6_route_head (struct ospf6_route_table *table);
                    278: extern struct ospf6_route *ospf6_route_next (struct ospf6_route *route);
                    279: extern struct ospf6_route *ospf6_route_best_next (struct ospf6_route *route);
                    280: 
                    281: extern struct ospf6_route *ospf6_route_match_head (struct prefix *prefix,
                    282:                                             struct ospf6_route_table *table);
                    283: extern struct ospf6_route *ospf6_route_match_next (struct prefix *prefix,
                    284:                                             struct ospf6_route *route);
                    285: 
                    286: extern void ospf6_route_remove_all (struct ospf6_route_table *);
                    287: extern struct ospf6_route_table *ospf6_route_table_create (int s, int t);
                    288: extern void ospf6_route_table_delete (struct ospf6_route_table *);
                    289: extern void ospf6_route_dump (struct ospf6_route_table *table);
                    290: 
                    291: 
                    292: extern void ospf6_route_show (struct vty *vty, struct ospf6_route *route);
                    293: extern void ospf6_route_show_detail (struct vty *vty, struct ospf6_route *route);
                    294: 
                    295: extern int ospf6_route_table_show (struct vty *, int, const char *[],
                    296:                                    struct ospf6_route_table *);
                    297: extern int ospf6_linkstate_table_show (struct vty *vty, int argc,
                    298:                                        const char *argv[],
                    299:                                        struct ospf6_route_table *table);
                    300: 
                    301: extern void ospf6_brouter_show_header (struct vty *vty);
                    302: extern void ospf6_brouter_show (struct vty *vty, struct ospf6_route *route);
                    303: 
                    304: extern int config_write_ospf6_debug_route (struct vty *vty);
                    305: extern void install_element_ospf6_debug_route (void);
                    306: extern void ospf6_route_init (void);
1.1.1.2   misho     307: extern void ospf6_clean (void);
1.1       misho     308: 
                    309: #endif /* OSPF6_ROUTE_H */
                    310: 

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>