]> git.proxmox.com Git - mirror_frr.git/blobdiff - ospf6d/ospf6_lsa.h
Merge pull request #5288 from SumitAgarwal123/bfd_docs
[mirror_frr.git] / ospf6d / ospf6_lsa.h
index 36cf5598681eb7f09af04876e719c2d2fdcf4441..d871a8842ecb3969fe8b0eea28433db9e6fdebdb 100644 (file)
 #define OSPF6_LSA_DEBUG_EXAMIN    0x04
 #define OSPF6_LSA_DEBUG_FLOOD     0x08
 
-#define IS_OSPF6_DEBUG_LSA(name)                        \
-  (ospf6_lstype_debug (htons (OSPF6_LSTYPE_ ## name)) & \
-   OSPF6_LSA_DEBUG)
-#define IS_OSPF6_DEBUG_ORIGINATE(name)                  \
-  (ospf6_lstype_debug (htons (OSPF6_LSTYPE_ ## name)) & \
-   OSPF6_LSA_DEBUG_ORIGINATE)
-#define IS_OSPF6_DEBUG_EXAMIN(name)                     \
-  (ospf6_lstype_debug (htons (OSPF6_LSTYPE_ ## name)) & \
-   OSPF6_LSA_DEBUG_EXAMIN)
-#define IS_OSPF6_DEBUG_LSA_TYPE(type) \
-  (ospf6_lstype_debug (type) & OSPF6_LSA_DEBUG)
-#define IS_OSPF6_DEBUG_ORIGINATE_TYPE(type) \
-  (ospf6_lstype_debug (type) & OSPF6_LSA_DEBUG_ORIGINATE)
-#define IS_OSPF6_DEBUG_EXAMIN_TYPE(type) \
-  (ospf6_lstype_debug (type) & OSPF6_LSA_DEBUG_EXAMIN)
-#define IS_OSPF6_DEBUG_FLOOD_TYPE(type) \
-  (ospf6_lstype_debug (type) & OSPF6_LSA_DEBUG_FLOOD)
+#define IS_OSPF6_DEBUG_LSA(name)                                               \
+       (ospf6_lstype_debug(htons(OSPF6_LSTYPE_##name)) & OSPF6_LSA_DEBUG)
+#define IS_OSPF6_DEBUG_ORIGINATE(name)                                         \
+       (ospf6_lstype_debug(htons(OSPF6_LSTYPE_##name))                        \
+        & OSPF6_LSA_DEBUG_ORIGINATE)
+#define IS_OSPF6_DEBUG_EXAMIN(name)                                            \
+       (ospf6_lstype_debug(htons(OSPF6_LSTYPE_##name))                        \
+        & OSPF6_LSA_DEBUG_EXAMIN)
+#define IS_OSPF6_DEBUG_LSA_TYPE(type)                                          \
+       (ospf6_lstype_debug(type) & OSPF6_LSA_DEBUG)
+#define IS_OSPF6_DEBUG_ORIGINATE_TYPE(type)                                    \
+       (ospf6_lstype_debug(type) & OSPF6_LSA_DEBUG_ORIGINATE)
+#define IS_OSPF6_DEBUG_EXAMIN_TYPE(type)                                       \
+       (ospf6_lstype_debug(type) & OSPF6_LSA_DEBUG_EXAMIN)
+#define IS_OSPF6_DEBUG_FLOOD_TYPE(type)                                        \
+       (ospf6_lstype_debug(type) & OSPF6_LSA_DEBUG_FLOOD)
 
 /* LSA definition */
 
 #define OSPF6_SCOPE_RESERVED   0x6000
 
 /* XXX U-bit handling should be treated here */
-#define OSPF6_LSA_SCOPE(type) \
-  (ntohs (type) & OSPF6_LSTYPE_SCOPE_MASK)
+#define OSPF6_LSA_SCOPE(type) (ntohs(type) & OSPF6_LSTYPE_SCOPE_MASK)
 
 /* LSA Header */
 #define OSPF6_LSA_HEADER_SIZE                 20U
-struct ospf6_lsa_header
-{
-  u_int16_t age;        /* LS age */
-  u_int16_t type;       /* LS type */
-  u_int32_t id;         /* Link State ID */
-  u_int32_t adv_router; /* Advertising Router */
-  u_int32_t seqnum;     /* LS sequence number */
-  u_int16_t checksum;   /* LS checksum */
-  u_int16_t length;     /* LSA length */
+struct ospf6_lsa_header {
+       uint16_t age;   /* LS age */
+       uint16_t type;       /* LS type */
+       uint32_t id;     /* Link State ID */
+       uint32_t adv_router; /* Advertising Router */
+       uint32_t seqnum;     /* LS sequence number */
+       uint16_t checksum;   /* LS checksum */
+       uint16_t length;     /* LSA length */
 };
 
-#define OSPF6_LSA_HEADER_END(h) \
-  ((caddr_t)(h) + sizeof (struct ospf6_lsa_header))
-#define OSPF6_LSA_SIZE(h) \
-  (ntohs (((struct ospf6_lsa_header *) (h))->length))
-#define OSPF6_LSA_END(h) \
-  ((caddr_t)(h) + ntohs (((struct ospf6_lsa_header *) (h))->length))
-#define OSPF6_LSA_IS_TYPE(t, L) \
-  ((L)->header->type == htons (OSPF6_LSTYPE_ ## t) ? 1 : 0)
-#define OSPF6_LSA_IS_SAME(L1, L2) \
-  ((L1)->header->adv_router == (L2)->header->adv_router && \
-   (L1)->header->id == (L2)->header->id && \
-   (L1)->header->type == (L2)->header->type)
-#define OSPF6_LSA_IS_MATCH(t, i, a, L) \
-  ((L)->header->adv_router == (a) && (L)->header->id == (i) && \
-   (L)->header->type == (t))
+#define OSPF6_LSA_HEADER_END(h) ((caddr_t)(h) + sizeof(struct ospf6_lsa_header))
+#define OSPF6_LSA_SIZE(h) (ntohs(((struct ospf6_lsa_header *)(h))->length))
+#define OSPF6_LSA_END(h)                                                       \
+       ((caddr_t)(h) + ntohs(((struct ospf6_lsa_header *)(h))->length))
+#define OSPF6_LSA_IS_TYPE(t, L)                                                \
+       ((L)->header->type == htons(OSPF6_LSTYPE_##t) ? 1 : 0)
+#define OSPF6_LSA_IS_SAME(L1, L2)                                              \
+       ((L1)->header->adv_router == (L2)->header->adv_router                  \
+        && (L1)->header->id == (L2)->header->id                               \
+        && (L1)->header->type == (L2)->header->type)
+#define OSPF6_LSA_IS_MATCH(t, i, a, L)                                         \
+       ((L)->header->adv_router == (a) && (L)->header->id == (i)              \
+        && (L)->header->type == (t))
 #define OSPF6_LSA_IS_DIFFER(L1, L2)  ospf6_lsa_is_differ (L1, L2)
 #define OSPF6_LSA_IS_MAXAGE(L) (ospf6_lsa_age_current (L) == OSPF_LSA_MAXAGE)
 #define OSPF6_LSA_IS_CHANGED(L1, L2) ospf6_lsa_is_changed (L1, L2)
 #define OSPF6_LSA_IS_SEQWRAP(L) ((L)->header->seqnum == htonl(OSPF_MAX_SEQUENCE_NUMBER + 1))
 
+struct ospf6_lsa {
+       char name[64]; /* dump string */
 
-struct ospf6_lsa
-{
-  char              name[64];   /* dump string */
+       struct route_node *rn;
 
-  struct route_node *rn;
+       unsigned char lock; /* reference counter */
+       unsigned char flag; /* special meaning (e.g. floodback) */
 
-  unsigned char     lock;           /* reference counter */
-  unsigned char     flag;           /* special meaning (e.g. floodback) */
+       struct timeval birth;      /* tv_sec when LS age 0 */
+       struct timeval originated; /* used by MinLSInterval check */
+       struct timeval received;   /* used by MinLSArrival check */
+       struct timeval installed;
 
-  struct timeval    birth;          /* tv_sec when LS age 0 */
-  struct timeval    originated;     /* used by MinLSInterval check */
-  struct timeval    received;       /* used by MinLSArrival check */
-  struct timeval    installed;
+       struct thread *expire;
+       struct thread *refresh; /* For self-originated LSA */
 
-  struct thread    *expire;
-  struct thread    *refresh;        /* For self-originated LSA */
+       int retrans_count;
 
-  int               retrans_count;
+       struct ospf6_lsdb *lsdb;
 
-  struct ospf6_lsdb *lsdb;
-
-  /* lsa instance */
-  struct ospf6_lsa_header *header;
+       /* lsa instance */
+       struct ospf6_lsa_header *header;
 };
 
 #define OSPF6_LSA_HEADERONLY 0x01
@@ -143,119 +136,116 @@ struct ospf6_lsa
 #define OSPF6_LSA_UNAPPROVED 0x10
 #define OSPF6_LSA_SEQWRAPPED 0x20
 
-struct ospf6_lsa_handler
-{
-  u_int16_t type; /* host byte order */
-  const char *name;
-  const char *short_name;
-  int (*show) (struct vty *, struct ospf6_lsa *);
-  char *(*get_prefix_str) (struct ospf6_lsa *, char *buf, int buflen, int pos);
-  u_char debug;
+struct ospf6_lsa_handler {
+       uint16_t lh_type; /* host byte order */
+       const char *lh_name;
+       const char *lh_short_name;
+       int (*lh_show)(struct vty *, struct ospf6_lsa *);
+       char *(*lh_get_prefix_str)(struct ospf6_lsa *, char *buf,
+                                  int buflen, int pos);
+
+       uint8_t lh_debug;
 };
 
-extern struct ospf6_lsa_handler unknown_handler;
-#define OSPF6_LSA_IS_KNOWN(type) \
-  (ospf6_get_lsa_handler (type) != &unknown_handler ? 1 : 0)
+#define OSPF6_LSA_IS_KNOWN(t)                                                  \
+       (ospf6_get_lsa_handler(t)->lh_type != OSPF6_LSTYPE_UNKNOWN ? 1 : 0)
 
 extern vector ospf6_lsa_handler_vector;
 
 /* Macro for LSA Origination */
 /* addr is (struct prefix *) */
-#define CONTINUE_IF_ADDRESS_LINKLOCAL(debug,addr)      \
-  if (IN6_IS_ADDR_LINKLOCAL (&(addr)->u.prefix6))      \
-    {                                                  \
-      char buf[PREFIX2STR_BUFFER];                     \
-      prefix2str (addr, buf, sizeof (buf));            \
-      if (debug)                                       \
-        zlog_debug ("Filter out Linklocal: %s", buf);  \
-      continue;                                        \
-    }
-
-#define CONTINUE_IF_ADDRESS_UNSPECIFIED(debug,addr)    \
-  if (IN6_IS_ADDR_UNSPECIFIED (&(addr)->u.prefix6))    \
-    {                                                  \
-      char buf[PREFIX2STR_BUFFER];                     \
-      prefix2str (addr, buf, sizeof (buf));            \
-      if (debug)                                       \
-        zlog_debug ("Filter out Unspecified: %s", buf);\
-      continue;                                        \
-    }
-
-#define CONTINUE_IF_ADDRESS_LOOPBACK(debug,addr)       \
-  if (IN6_IS_ADDR_LOOPBACK (&(addr)->u.prefix6))       \
-    {                                                  \
-      char buf[PREFIX2STR_BUFFER];                     \
-      prefix2str (addr, buf, sizeof (buf));            \
-      if (debug)                                       \
-        zlog_debug ("Filter out Loopback: %s", buf);   \
-      continue;                                        \
-    }
-
-#define CONTINUE_IF_ADDRESS_V4COMPAT(debug,addr)       \
-  if (IN6_IS_ADDR_V4COMPAT (&(addr)->u.prefix6))       \
-    {                                                  \
-      char buf[PREFIX2STR_BUFFER];                     \
-      prefix2str (addr, buf, sizeof (buf));            \
-      if (debug)                                       \
-        zlog_debug ("Filter out V4Compat: %s", buf);   \
-      continue;                                        \
-    }
-
-#define CONTINUE_IF_ADDRESS_V4MAPPED(debug,addr)       \
-  if (IN6_IS_ADDR_V4MAPPED (&(addr)->u.prefix6))       \
-    {                                                  \
-      char buf[PREFIX2STR_BUFFER];                     \
-      prefix2str (addr, buf, sizeof (buf));            \
-      if (debug)                                       \
-        zlog_debug ("Filter out V4Mapped: %s", buf);   \
-      continue;                                        \
-    }
+#define CONTINUE_IF_ADDRESS_LINKLOCAL(debug, addr)                             \
+       if (IN6_IS_ADDR_LINKLOCAL(&(addr)->u.prefix6)) {                       \
+               char buf[PREFIX2STR_BUFFER];                                   \
+               prefix2str(addr, buf, sizeof(buf));                            \
+               if (debug)                                                     \
+                       zlog_debug("Filter out Linklocal: %s", buf);           \
+               continue;                                                      \
+       }
+
+#define CONTINUE_IF_ADDRESS_UNSPECIFIED(debug, addr)                           \
+       if (IN6_IS_ADDR_UNSPECIFIED(&(addr)->u.prefix6)) {                     \
+               char buf[PREFIX2STR_BUFFER];                                   \
+               prefix2str(addr, buf, sizeof(buf));                            \
+               if (debug)                                                     \
+                       zlog_debug("Filter out Unspecified: %s", buf);         \
+               continue;                                                      \
+       }
+
+#define CONTINUE_IF_ADDRESS_LOOPBACK(debug, addr)                              \
+       if (IN6_IS_ADDR_LOOPBACK(&(addr)->u.prefix6)) {                        \
+               char buf[PREFIX2STR_BUFFER];                                   \
+               prefix2str(addr, buf, sizeof(buf));                            \
+               if (debug)                                                     \
+                       zlog_debug("Filter out Loopback: %s", buf);            \
+               continue;                                                      \
+       }
+
+#define CONTINUE_IF_ADDRESS_V4COMPAT(debug, addr)                              \
+       if (IN6_IS_ADDR_V4COMPAT(&(addr)->u.prefix6)) {                        \
+               char buf[PREFIX2STR_BUFFER];                                   \
+               prefix2str(addr, buf, sizeof(buf));                            \
+               if (debug)                                                     \
+                       zlog_debug("Filter out V4Compat: %s", buf);            \
+               continue;                                                      \
+       }
+
+#define CONTINUE_IF_ADDRESS_V4MAPPED(debug, addr)                              \
+       if (IN6_IS_ADDR_V4MAPPED(&(addr)->u.prefix6)) {                        \
+               char buf[PREFIX2STR_BUFFER];                                   \
+               prefix2str(addr, buf, sizeof(buf));                            \
+               if (debug)                                                     \
+                       zlog_debug("Filter out V4Mapped: %s", buf);            \
+               continue;                                                      \
+       }
 
 
 /* Function Prototypes */
-extern const char *ospf6_lstype_name (u_int16_t type);
-extern const char *ospf6_lstype_short_name (u_int16_t type);
-extern u_char ospf6_lstype_debug (u_int16_t type);
-extern int ospf6_lsa_is_differ (struct ospf6_lsa *lsa1, struct ospf6_lsa *lsa2);
-extern int ospf6_lsa_is_changed (struct ospf6_lsa *lsa1, struct ospf6_lsa *lsa2);
-extern u_int16_t ospf6_lsa_age_current (struct ospf6_lsa *);
-extern void ospf6_lsa_age_update_to_send (struct ospf6_lsa *, u_int32_t);
-extern void ospf6_lsa_premature_aging (struct ospf6_lsa *);
-extern int ospf6_lsa_compare (struct ospf6_lsa *, struct ospf6_lsa *);
-
-extern char *ospf6_lsa_printbuf (struct ospf6_lsa *lsa, char *buf, int size);
-extern void ospf6_lsa_header_print_raw (struct ospf6_lsa_header *header);
-extern void ospf6_lsa_header_print (struct ospf6_lsa *lsa);
-extern void ospf6_lsa_show_summary_header (struct vty *vty);
-extern void ospf6_lsa_show_summary (struct vty *vty, struct ospf6_lsa *lsa);
-extern void ospf6_lsa_show_dump (struct vty *vty, struct ospf6_lsa *lsa);
-extern void ospf6_lsa_show_internal (struct vty *vty, struct ospf6_lsa *lsa);
-extern void ospf6_lsa_show (struct vty *vty, struct ospf6_lsa *lsa);
-
-extern struct ospf6_lsa *ospf6_lsa_create (struct ospf6_lsa_header *header);
-extern struct ospf6_lsa *ospf6_lsa_create_headeronly (struct ospf6_lsa_header *header);
-extern void ospf6_lsa_delete (struct ospf6_lsa *lsa);
-extern struct ospf6_lsa *ospf6_lsa_copy (struct ospf6_lsa *);
-
-extern void ospf6_lsa_lock (struct ospf6_lsa *);
-extern void ospf6_lsa_unlock (struct ospf6_lsa *);
-
-extern int ospf6_lsa_expire (struct thread *);
-extern int ospf6_lsa_refresh (struct thread *);
-
-extern unsigned short ospf6_lsa_checksum (struct ospf6_lsa_header *);
-extern int ospf6_lsa_checksum_valid (struct ospf6_lsa_header *);
-extern int ospf6_lsa_prohibited_duration (u_int16_t type, u_int32_t id,
-                                          u_int32_t adv_router, void *scope);
-
-extern void ospf6_install_lsa_handler (struct ospf6_lsa_handler *handler);
-extern struct ospf6_lsa_handler *ospf6_get_lsa_handler (u_int16_t type);
-
-extern void ospf6_lsa_init (void);
-extern void ospf6_lsa_terminate (void);
-
-extern int config_write_ospf6_debug_lsa (struct vty *vty);
-extern void install_element_ospf6_debug_lsa (void);
+extern const char *ospf6_lstype_name(uint16_t type);
+extern const char *ospf6_lstype_short_name(uint16_t type);
+extern uint8_t ospf6_lstype_debug(uint16_t type);
+extern int ospf6_lsa_is_differ(struct ospf6_lsa *lsa1, struct ospf6_lsa *lsa2);
+extern int ospf6_lsa_is_changed(struct ospf6_lsa *lsa1, struct ospf6_lsa *lsa2);
+extern uint16_t ospf6_lsa_age_current(struct ospf6_lsa *);
+extern void ospf6_lsa_age_update_to_send(struct ospf6_lsa *, uint32_t);
+extern void ospf6_lsa_premature_aging(struct ospf6_lsa *);
+extern int ospf6_lsa_compare(struct ospf6_lsa *, struct ospf6_lsa *);
+
+extern char *ospf6_lsa_printbuf(struct ospf6_lsa *lsa, char *buf, int size);
+extern void ospf6_lsa_header_print_raw(struct ospf6_lsa_header *header);
+extern void ospf6_lsa_header_print(struct ospf6_lsa *lsa);
+extern void ospf6_lsa_show_summary_header(struct vty *vty);
+extern void ospf6_lsa_show_summary(struct vty *vty, struct ospf6_lsa *lsa);
+extern void ospf6_lsa_show_dump(struct vty *vty, struct ospf6_lsa *lsa);
+extern void ospf6_lsa_show_internal(struct vty *vty, struct ospf6_lsa *lsa);
+extern void ospf6_lsa_show(struct vty *vty, struct ospf6_lsa *lsa);
+
+extern struct ospf6_lsa *ospf6_lsa_create(struct ospf6_lsa_header *header);
+extern struct ospf6_lsa *
+ospf6_lsa_create_headeronly(struct ospf6_lsa_header *header);
+extern void ospf6_lsa_delete(struct ospf6_lsa *lsa);
+extern struct ospf6_lsa *ospf6_lsa_copy(struct ospf6_lsa *);
+
+extern void ospf6_lsa_lock(struct ospf6_lsa *);
+extern void ospf6_lsa_unlock(struct ospf6_lsa *);
+
+extern int ospf6_lsa_expire(struct thread *);
+extern int ospf6_lsa_refresh(struct thread *);
+
+extern unsigned short ospf6_lsa_checksum(struct ospf6_lsa_header *);
+extern int ospf6_lsa_checksum_valid(struct ospf6_lsa_header *);
+extern int ospf6_lsa_prohibited_duration(uint16_t type, uint32_t id,
+                                        uint32_t adv_router, void *scope);
+
+extern void ospf6_install_lsa_handler(const struct ospf6_lsa_handler *handler);
+extern const struct ospf6_lsa_handler *ospf6_get_lsa_handler(uint16_t type);
+
+extern void ospf6_lsa_init(void);
+extern void ospf6_lsa_terminate(void);
+
+extern int config_write_ospf6_debug_lsa(struct vty *vty);
+extern void install_element_ospf6_debug_lsa(void);
+extern void ospf6_lsa_age_set(struct ospf6_lsa *lsa);
+extern void ospf6_flush_self_originated_lsas_now(void);
 
 #endif /* OSPF6_LSA_H */
-