* killed lots of #ifdef ... #endif which make the source quite unreadable
[olsrd.git] / src / tc_set.h
index 0c16691..34c1601 100644 (file)
@@ -1,6 +1,8 @@
+
 /*
  * The olsr.org Optimized Link-State Routing daemon(olsrd)
- * Copyright (c) 2004, Andreas T√łnnesen(andreto@olsr.org)
+ * Copyright (c) 2004, Andreas T√łnnesen(andreto@olsr.org)
+ * LSDB rewrite (c) 2007, Hannes Gredler (hannes@gredler.at)
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without 
@@ -36,7 +38,6 @@
  * to the project. For more information see the website or contact
  * the copyright holders.
  *
- * $Id: tc_set.h,v 1.15 2005/05/29 12:47:46 br1 Exp $
  */
 
 #ifndef _OLSR_TOP_SET
 
 #include "defs.h"
 #include "packet.h"
+#include "common/avl.h"
+#include "common/list.h"
+#include "scheduler.h"
 
-struct topo_dst
-{
-  union olsr_ip_addr T_dest_addr;
-  clock_t            T_time;
-  olsr_u16_t         T_seq;
-  struct topo_dst   *next;
-  struct topo_dst   *prev;
-  double             link_quality;
-  double             inverse_link_quality;
-  double             saved_link_quality;
-  double             saved_inverse_link_quality;
-};
-
+/*
+ * This file holds the definitions for the link state database.
+ * The lsdb consists of nodes and edges.
+ * During input parsing all nodes and edges are extracted and synthesized.
+ * The SPF calculation operates on these datasets.
+ */
 
-struct tc_entry
-{
-  union olsr_ip_addr T_last_addr;
-  struct topo_dst    destinations;
-  struct tc_entry   *next;
-  struct tc_entry   *prev;
+struct tc_edge_entry {
+  struct avl_node edge_node;          /* edge_tree node in tc_entry */
+  union olsr_ip_addr T_dest_addr;      /* edge_node key */
+  struct tc_edge_entry *edge_inv;      /* shortcut, used during SPF calculation */
+  struct tc_entry *tc;                /* backpointer to owning tc entry */
+  olsr_linkcost cost;                 /* metric used for SPF calculation */
+  olsr_u16_t ansn;                    /* ansn of this edge, used for multipart msgs */
+  olsr_u32_t linkquality[0];
 };
 
+AVLNODE2STRUCT(edge_tree2tc_edge, struct tc_edge_entry, edge_node);
+
+struct tc_entry {
+  struct avl_node vertex_node;        /* node keyed by ip address */
+  union olsr_ip_addr addr;            /* vertex_node key */
+  struct avl_node cand_tree_node;      /* SPF candidate heap, node keyed by path_etx */
+  olsr_linkcost path_cost;            /* SPF calculated distance, cand_tree_node key */
+  struct list_node path_list_node;     /* SPF result list */
+  struct avl_tree edge_tree;          /* subtree for edges */
+  struct avl_tree prefix_tree;        /* subtree for prefixes */
+  struct link_entry *next_hop;        /* SPF calculated link to the 1st hop neighbor */
+  struct timer_entry *edge_gc_timer;   /* used for edge garbage collection */
+  struct timer_entry *validity_timer;  /* tc validity time */
+  olsr_u32_t refcount;                /* reference counter */
+  olsr_u16_t msg_seq;                 /* sequence number of the tc message */
+  olsr_u8_t msg_hops;                 /* hopcount as per the tc message */
+  olsr_u8_t hops;                     /* SPF calculated hopcount */
+  olsr_u16_t ansn;                    /* ANSN number of the tc message */
+  olsr_u16_t ignored;                 /* how many TC messages ignored in a sequence
+                                          (kindof emergency brake) */
+  olsr_u16_t err_seq;                 /* sequence number of an unplausible TC */
+  olsr_bool err_seq_valid;            /* do we have an error (unplauible seq/ansn) */
+};
 
-/* Queue */
-extern struct tc_entry tc_table[HASHSIZE];
-
-
-int
-olsr_init_tc(void);
-
-
-int
-olsr_tc_delete_mprs(struct tc_entry *, struct tc_message *);
-
-
-struct tc_entry *
-olsr_lookup_tc_entry(union olsr_ip_addr *);
-
-
-struct topo_dst *
-olsr_tc_lookup_dst(struct tc_entry *, union olsr_ip_addr *);
-
-
-int
-olsr_tc_delete_entry_if_empty(struct tc_entry *);
-
-
-struct tc_entry *
-olsr_add_tc_entry(union olsr_ip_addr *);
+/*
+ * Garbage collection time for edges.
+ * This is used for multipart messages.
+ */
+#define OLSR_TC_EDGE_GC_TIME (2*1000)  /* milliseconds */
+#define OLSR_TC_EDGE_GC_JITTER 5       /* percent */
 
+#define OLSR_TC_VTIME_JITTER 25        /* percent */
 
-int
-olsr_tc_update_mprs(struct tc_entry *, struct tc_message *);
 
-int
-olsr_print_tc_table(void);
+AVLNODE2STRUCT(vertex_tree2tc, struct tc_entry, vertex_node);
+AVLNODE2STRUCT(cand_tree2tc, struct tc_entry, cand_tree_node);
+LISTNODE2STRUCT(pathlist2tc, struct tc_entry, path_list_node);
 
-void
-olsr_time_out_tc_set(void);
+/*
+ * macros for traversing vertices, edges and prefixes in the link state database.
+ * it is recommended to use this because it hides all the internal
+ * datastructure from the callers.
+ *
+ * the loop prefetches the next node in order to not loose context if
+ * for example the caller wants to delete the current entry.
+ */
+#define OLSR_FOR_ALL_TC_ENTRIES(tc) \
+{ \
+  struct avl_node *tc_tree_node, *next_tc_tree_node; \
+  for (tc_tree_node = avl_walk_first(&tc_tree); \
+    tc_tree_node; tc_tree_node = next_tc_tree_node) { \
+    next_tc_tree_node = avl_walk_next(tc_tree_node); \
+    tc = vertex_tree2tc(tc_tree_node);
+#define OLSR_FOR_ALL_TC_ENTRIES_END(tc) }}
+
+#define OLSR_FOR_ALL_TC_EDGE_ENTRIES(tc, tc_edge) \
+{ \
+  struct avl_node *tc_edge_node, *next_tc_edge_node; \
+  for (tc_edge_node = avl_walk_first(&tc->edge_tree); \
+    tc_edge_node; tc_edge_node = next_tc_edge_node) { \
+    next_tc_edge_node = avl_walk_next(tc_edge_node); \
+    tc_edge = edge_tree2tc_edge(tc_edge_node);
+#define OLSR_FOR_ALL_TC_EDGE_ENTRIES_END(tc, tc_edge) }}
+
+#define OLSR_FOR_ALL_PREFIX_ENTRIES(tc, rtp) \
+{ \
+  struct avl_node *rtp_node, *next_rtp_node; \
+  for (rtp_node = avl_walk_first(&tc->prefix_tree); \
+    rtp_node; rtp_node = next_rtp_node) { \
+    next_rtp_node = avl_walk_next(rtp_node); \
+    rtp = rtp_prefix_tree2rtp(rtp_node);
+#define OLSR_FOR_ALL_PREFIX_ENTRIES_END(tc, rtp) }}
+
+extern struct avl_tree tc_tree;
+extern struct tc_entry *tc_myself;
+
+void olsr_init_tc(void);
+void olsr_change_myself_tc(void);
+void olsr_print_tc_table(void);
+void olsr_time_out_tc_set(void);
+
+/* tc msg input parser */
+void olsr_input_tc(union olsr_message *, struct interface *,
+                  union olsr_ip_addr *from);
+
+/* tc_entry manipulation */
+struct tc_entry *olsr_lookup_tc_entry(union olsr_ip_addr *);
+struct tc_entry *olsr_locate_tc_entry(union olsr_ip_addr *);
+void olsr_lock_tc_entry(struct tc_entry *);
+void olsr_unlock_tc_entry(struct tc_entry *);
+
+/* tc_edge_entry manipulation */
+olsr_bool olsr_delete_outdated_tc_edges(struct tc_entry *);
+char *olsr_tc_edge_to_string(struct tc_edge_entry *);
+struct tc_edge_entry *olsr_lookup_tc_edge(struct tc_entry *,
+                                         union olsr_ip_addr *);
+struct tc_edge_entry *olsr_add_tc_edge_entry(struct tc_entry *,
+                                            union olsr_ip_addr *, olsr_u16_t);
+void olsr_delete_tc_entry(struct tc_entry *);
+void olsr_delete_tc_edge_entry(struct tc_edge_entry *);
+olsr_bool olsr_calc_tc_edge_entry_etx(struct tc_edge_entry *);
+void olsr_set_tc_edge_timer(struct tc_edge_entry *, unsigned int);
+// static olsr_bool olsr_etx_significant_change(float, float);
 
 #endif
+
+/*
+ * Local Variables:
+ * c-basic-offset: 2
+ * End:
+ */