ospfd/ospf_dump.h

   1 /*
   2  * OSPFd dump routine.
   3  * Copyright (C) 1999 Toshiaki Takada
   4  *
   5  * This file is part of GNU Zebra.
   6  *
   7  * GNU Zebra is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the
   9  * Free Software Foundation; either version 2, or (at your option) any
  10  * later version.
  11  *
  12  * GNU Zebra is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; see the file COPYING; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #ifndef _ZEBRA_OSPF_DUMP_H
  23 #define _ZEBRA_OSPF_DUMP_H
  24
  25 /* Debug Flags. */
  26 #define OSPF_DEBUG_HELLO        0x01
  27 #define OSPF_DEBUG_DB_DESC      0x02
  28 #define OSPF_DEBUG_LS_REQ       0x04
  29 #define OSPF_DEBUG_LS_UPD       0x08
  30 #define OSPF_DEBUG_LS_ACK       0x10
  31 #define OSPF_DEBUG_ALL          0x1f
  32
  33 #define OSPF_DEBUG_SEND         0x01
  34 #define OSPF_DEBUG_RECV         0x02
  35 #define OSPF_DEBUG_SEND_RECV    0x03
  36 #define OSPF_DEBUG_DETAIL       0x04
  37
  38 #define OSPF_DEBUG_ISM_STATUS   0x01
  39 #define OSPF_DEBUG_ISM_EVENTS   0x02
  40 #define OSPF_DEBUG_ISM_TIMERS   0x04
  41 #define OSPF_DEBUG_ISM          0x07
  42 #define OSPF_DEBUG_NSM_STATUS   0x01
  43 #define OSPF_DEBUG_NSM_EVENTS   0x02
  44 #define OSPF_DEBUG_NSM_TIMERS   0x04
  45 #define OSPF_DEBUG_NSM          0x07
  46
  47 #define OSPF_DEBUG_LSA_GENERATE 0x01
  48 #define OSPF_DEBUG_LSA_FLOODING 0x02
  49 #define OSPF_DEBUG_LSA_INSTALL  0x04
  50 #define OSPF_DEBUG_LSA_REFRESH  0x08
  51 #define OSPF_DEBUG_LSA          0x0F
  52 #define OSPF_DEBUG_EXTNL_LSA_AGGR 0x10
  53
  54 #define OSPF_DEBUG_ZEBRA_INTERFACE     0x01
  55 #define OSPF_DEBUG_ZEBRA_REDISTRIBUTE  0x02
  56 #define OSPF_DEBUG_ZEBRA               0x03
  57
  58 #define OSPF_DEBUG_EVENT        0x01
  59 #define OSPF_DEBUG_NSSA         0x02
  60 #define OSPF_DEBUG_TE          0x04
  61 #define OSPF_DEBUG_EXT         0x08
  62 #define OSPF_DEBUG_SR          0x10
  63 #define OSPF_DEBUG_TI_LFA 0x11
  64 #define OSPF_DEBUG_DEFAULTINFO 0x20
  65 #define OSPF_DEBUG_LDP_SYNC 0x40
  66
  67 #define OSPF_DEBUG_GR 0x01
  68
  69 #define OSPF_DEBUG_BFD_LIB 0x01
  70
  71 #define OSPF_DEBUG_CLIENT_API 0x01
  72
  73 /* Macro for setting debug option. */
  74 #define CONF_DEBUG_PACKET_ON(a, b)          conf_debug_ospf_packet[a] |= (b)
  75 #define CONF_DEBUG_PACKET_OFF(a, b)         conf_debug_ospf_packet[a] &= ~(b)
  76 #define TERM_DEBUG_PACKET_ON(a, b)          term_debug_ospf_packet[a] |= (b)
  77 #define TERM_DEBUG_PACKET_OFF(a, b)         term_debug_ospf_packet[a] &= ~(b)
  78 #define DEBUG_PACKET_ON(a, b)                                                  \
  79         do {                                                                   \
  80                 CONF_DEBUG_PACKET_ON(a, b);                                    \
  81                 TERM_DEBUG_PACKET_ON(a, b);                                    \
  82         } while (0)
  83 #define DEBUG_PACKET_OFF(a, b)                                                 \
  84         do {                                                                   \
  85                 CONF_DEBUG_PACKET_OFF(a, b);                                   \
  86                 TERM_DEBUG_PACKET_OFF(a, b);                                   \
  87         } while (0)
  88
  89 #define CONF_DEBUG_ON(a, b)      conf_debug_ospf_ ## a |= (OSPF_DEBUG_ ## b)
  90 #define CONF_DEBUG_OFF(a, b)     conf_debug_ospf_ ## a &= ~(OSPF_DEBUG_ ## b)
  91 #define TERM_DEBUG_ON(a, b)      term_debug_ospf_ ## a |= (OSPF_DEBUG_ ## b)
  92 #define TERM_DEBUG_OFF(a, b)     term_debug_ospf_ ## a &= ~(OSPF_DEBUG_ ## b)
  93 #define DEBUG_ON(a, b)                                                         \
  94         do {                                                                   \
  95                 CONF_DEBUG_ON(a, b);                                           \
  96                 TERM_DEBUG_ON(a, b);                                           \
  97         } while (0)
  98 #define DEBUG_OFF(a, b)                                                        \
  99         do {                                                                   \
 100                 CONF_DEBUG_OFF(a, b);                                          \
 101                 TERM_DEBUG_OFF(a, b);                                          \
 102         } while (0)
 103
 104 /* Macro for checking debug option. */
 105 #define IS_DEBUG_OSPF_PACKET(a, b) (term_debug_ospf_packet[a] & OSPF_DEBUG_##b)
 106 #define IS_DEBUG_OSPF(a, b) (term_debug_ospf_##a & OSPF_DEBUG_##b)
 107 #define IS_DEBUG_OSPF_EVENT IS_DEBUG_OSPF(event, EVENT)
 108
 109 #define IS_DEBUG_OSPF_NSSA  IS_DEBUG_OSPF(nssa, NSSA)
 110
 111 #define IS_DEBUG_OSPF_TE  IS_DEBUG_OSPF(te, TE)
 112
 113 #define IS_DEBUG_OSPF_EXT  IS_DEBUG_OSPF(ext, EXT)
 114
 115 #define IS_DEBUG_OSPF_SR  IS_DEBUG_OSPF(sr, SR)
 116
 117 #define IS_DEBUG_OSPF_TI_LFA IS_DEBUG_OSPF(ti_lfa, TI_LFA)
 118
 119 #define IS_DEBUG_OSPF_DEFAULT_INFO IS_DEBUG_OSPF(defaultinfo, DEFAULTINFO)
 120
 121 #define IS_DEBUG_OSPF_LDP_SYNC IS_DEBUG_OSPF(ldp_sync, LDP_SYNC)
 122 #define IS_DEBUG_OSPF_GR IS_DEBUG_OSPF(gr, GR)
 123 #define IS_DEBUG_OSPF_CLIENT_API IS_DEBUG_OSPF(client_api, CLIENT_API)
 124
 125 #define IS_CONF_DEBUG_OSPF_PACKET(a, b)                                        \
 126         (conf_debug_ospf_packet[a] & OSPF_DEBUG_##b)
 127 #define IS_CONF_DEBUG_OSPF(a, b) (conf_debug_ospf_##a & OSPF_DEBUG_##b)
 128
 129 #define AREA_NAME(A)    ospf_area_name_string ((A))
 130 #define IF_NAME(I)      ospf_if_name_string ((I))
 131
 132 /* Extern debug flag. */
 133 extern unsigned long term_debug_ospf_packet[];
 134 extern unsigned long term_debug_ospf_event;
 135 extern unsigned long term_debug_ospf_ism;
 136 extern unsigned long term_debug_ospf_nsm;
 137 extern unsigned long term_debug_ospf_lsa;
 138 extern unsigned long term_debug_ospf_zebra;
 139 extern unsigned long term_debug_ospf_nssa;
 140 extern unsigned long term_debug_ospf_te;
 141 extern unsigned long term_debug_ospf_ext;
 142 extern unsigned long term_debug_ospf_sr;
 143 extern unsigned long term_debug_ospf_ti_lfa;
 144 extern unsigned long term_debug_ospf_defaultinfo;
 145 extern unsigned long term_debug_ospf_ldp_sync;
 146 extern unsigned long term_debug_ospf_gr;
 147 extern unsigned long term_debug_ospf_bfd;
 148 extern unsigned long term_debug_ospf_client_api;
 149
 150 /* Message Strings. */
 151 extern char *ospf_lsa_type_str[];
 152
 153 /* Prototypes. */
 154 extern const char *ospf_area_name_string(struct ospf_area *);
 155 extern const char *ospf_area_desc_string(struct ospf_area *);
 156 extern const char *ospf_if_name_string(struct ospf_interface *);
 157 extern int ospf_nbr_ism_state(struct ospf_neighbor *nbr);
 158 extern void ospf_nbr_state_message(struct ospf_neighbor *nbr, char *buf,
 159                                    size_t size);
 160 extern void ospf_nbr_ism_state_message(struct ospf_neighbor *nbr, char *buf,
 161                                        size_t size);
 162 extern const char *ospf_timer_dump(struct thread *, char *, size_t);
 163 extern const char *ospf_timeval_dump(struct timeval *, char *, size_t);
 164 extern void ospf_packet_dump(struct stream *);
 165 extern void ospf_debug_init(void);
 166
 167 /* Appropriate buffer size to use with ospf_timer_dump and ospf_timeval_dump: */
 168 #define OSPF_TIME_DUMP_SIZE     16
 169
 170 #endif /* _ZEBRA_OSPF_DUMP_H */