ospf6d/ospf6_lsdb.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_LSDB_H
  22 #define OSPF6_LSDB_H
  23
  24 #include "prefix.h"
  25 #include "table.h"
  26 #include "ospf6_route.h"
  27
  28 struct ospf6_lsdb {
  29         void *data; /* data structure that holds this lsdb */
  30         struct route_table *table;
  31         uint32_t count;
  32         void (*hook_add)(struct ospf6_lsa *);
  33         void (*hook_remove)(struct ospf6_lsa *);
  34 };
  35
  36 /* Function Prototypes */
  37 extern struct ospf6_lsdb *ospf6_lsdb_create(void *data);
  38 extern void ospf6_lsdb_delete(struct ospf6_lsdb *lsdb);
  39
  40 extern struct ospf6_lsa *ospf6_lsdb_lookup(uint16_t type, uint32_t id,
  41                                            uint32_t adv_router,
  42                                            struct ospf6_lsdb *lsdb);
  43 extern struct ospf6_lsa *ospf6_lsdb_lookup_next(uint16_t type, uint32_t id,
  44                                                 uint32_t adv_router,
  45                                                 struct ospf6_lsdb *lsdb);
  46
  47 extern void ospf6_lsdb_add(struct ospf6_lsa *lsa, struct ospf6_lsdb *lsdb);
  48 extern void ospf6_lsdb_remove(struct ospf6_lsa *lsa, struct ospf6_lsdb *lsdb);
  49
  50 extern const struct route_node *ospf6_lsdb_head(struct ospf6_lsdb *lsdb,
  51                                                 int argmode, uint16_t type,
  52                                                 uint32_t adv_router,
  53                                                 struct ospf6_lsa **lsa);
  54 extern struct ospf6_lsa *ospf6_lsdb_next(const struct route_node *iterend,
  55                                          struct ospf6_lsa *lsa);
  56
  57 #define ALL_LSDB_TYPED_ADVRTR(lsdb, type, adv_router, lsa)                     \
  58         const struct route_node *iterend =                                     \
  59                 ospf6_lsdb_head(lsdb, 2, type, adv_router, &lsa);              \
  60         lsa;                                                                   \
  61         lsa = ospf6_lsdb_next(iterend, lsa)
  62
  63 #define ALL_LSDB_TYPED(lsdb, type, lsa)                                        \
  64         const struct route_node *iterend =                                     \
  65                 ospf6_lsdb_head(lsdb, 1, type, 0, &lsa);                       \
  66         lsa;                                                                   \
  67         lsa = ospf6_lsdb_next(iterend, lsa)
  68
  69 /*
  70  * Since we are locking the lsa in ospf6_lsdb_head
  71  * and then unlocking it in ospf6_lsa_unlock, when
  72  * we cache the next pointer we need to increment
  73  * the lock for the lsa so we don't accidently free
  74  * it really early.
  75  */
  76 #define ALL_LSDB(lsdb, lsa, lsanext)                                           \
  77         const struct route_node *iterend =                                     \
  78                 ospf6_lsdb_head(lsdb, 0, 0, 0, &lsa);                          \
  79         (lsa) != NULL && ospf6_lsa_lock(lsa)                                   \
  80                 && ((lsanext) = ospf6_lsdb_next(iterend, (lsa)), 1);           \
  81         ospf6_lsa_unlock(lsa), (lsa) = (lsanext)
  82
  83 extern void ospf6_lsdb_remove_all(struct ospf6_lsdb *lsdb);
  84 extern void ospf6_lsdb_lsa_unlock(struct ospf6_lsa *lsa);
  85
  86 enum ospf_lsdb_show_level {
  87         OSPF6_LSDB_SHOW_LEVEL_NORMAL = 0,
  88         OSPF6_LSDB_SHOW_LEVEL_DETAIL,
  89         OSPF6_LSDB_SHOW_LEVEL_INTERNAL,
  90         OSPF6_LSDB_SHOW_LEVEL_DUMP,
  91 };
  92
  93 extern void ospf6_lsdb_show(struct vty *vty, enum ospf_lsdb_show_level level,
  94                             uint16_t *type, uint32_t *id, uint32_t *adv_router,
  95                             struct ospf6_lsdb *lsdb, json_object *json,
  96                             bool use_json);
  97
  98 extern uint32_t ospf6_new_ls_id(uint16_t type, uint32_t adv_router,
  99                                 struct ospf6_lsdb *lsdb);
 100 extern uint32_t ospf6_new_ls_seqnum(uint16_t type, uint32_t id,
 101                                     uint32_t adv_router,
 102                                     struct ospf6_lsdb *lsdb);
 103 extern int ospf6_lsdb_maxage_remover(struct ospf6_lsdb *lsdb);
 104
 105 #endif /* OSPF6_LSDB_H */