bgpd/bgp_debug.h

   1 /* BGP message debug header.
   2  * Copyright (C) 1996, 97, 98 Kunihiro Ishiguro
   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 _QUAGGA_BGP_DEBUG_H
  22 #define _QUAGGA_BGP_DEBUG_H
  23
  24 #include "bgp_attr.h"
  25 #include "bgp_updgrp.h"
  26
  27 /* sort of packet direction */
  28 #define DUMP_ON        1
  29 #define DUMP_SEND      2
  30 #define DUMP_RECV      4
  31
  32 /* for dump_update */
  33 #define DUMP_WITHDRAW  8
  34 #define DUMP_NLRI     16
  35
  36 /* dump detail */
  37 #define DUMP_DETAIL   32
  38
  39 /* RD + Prefix + Path-Id */
  40 #define BGP_PRD_PATH_STRLEN                                                    \
  41         (PREFIX_STRLEN + RD_ADDRSTRLEN + INET6_ADDRSTRLEN + 34)
  42
  43 extern int dump_open;
  44 extern int dump_update;
  45 extern int dump_keepalive;
  46 extern int dump_notify;
  47
  48 extern int Debug_Event;
  49 extern int Debug_Keepalive;
  50 extern int Debug_Update;
  51 extern int Debug_Radix;
  52
  53 #define NLRI     1
  54 #define WITHDRAW 2
  55 #define NO_OPT   3
  56 #define SEND     4
  57 #define RECV     5
  58 #define DETAIL   6
  59
  60 /* Prototypes. */
  61 extern void bgp_debug_init(void);
  62 extern void bgp_packet_dump(struct stream *);
  63
  64 extern int debug(unsigned int option);
  65
  66 extern unsigned long conf_bgp_debug_as4;
  67 extern unsigned long conf_bgp_debug_neighbor_events;
  68 extern unsigned long conf_bgp_debug_packet;
  69 extern unsigned long conf_bgp_debug_keepalive;
  70 extern unsigned long conf_bgp_debug_update;
  71 extern unsigned long conf_bgp_debug_bestpath;
  72 extern unsigned long conf_bgp_debug_zebra;
  73 extern unsigned long conf_bgp_debug_allow_martians;
  74 extern unsigned long conf_bgp_debug_nht;
  75 extern unsigned long conf_bgp_debug_update_groups;
  76 extern unsigned long conf_bgp_debug_vpn;
  77 extern unsigned long conf_bgp_debug_flowspec;
  78 extern unsigned long conf_bgp_debug_labelpool;
  79 extern unsigned long conf_bgp_debug_pbr;
  80 extern unsigned long conf_bgp_debug_graceful_restart;
  81 extern unsigned long conf_bgp_debug_evpn_mh;
  82 extern unsigned long conf_bgp_debug_bfd;
  83
  84 extern unsigned long term_bgp_debug_as4;
  85 extern unsigned long term_bgp_debug_neighbor_events;
  86 extern unsigned long term_bgp_debug_packet;
  87 extern unsigned long term_bgp_debug_keepalive;
  88 extern unsigned long term_bgp_debug_update;
  89 extern unsigned long term_bgp_debug_bestpath;
  90 extern unsigned long term_bgp_debug_zebra;
  91 extern unsigned long term_bgp_debug_allow_martians;
  92 extern unsigned long term_bgp_debug_nht;
  93 extern unsigned long term_bgp_debug_update_groups;
  94 extern unsigned long term_bgp_debug_vpn;
  95 extern unsigned long term_bgp_debug_flowspec;
  96 extern unsigned long term_bgp_debug_labelpool;
  97 extern unsigned long term_bgp_debug_pbr;
  98 extern unsigned long term_bgp_debug_graceful_restart;
  99 extern unsigned long term_bgp_debug_evpn_mh;
 100 extern unsigned long term_bgp_debug_bfd;
 101
 102 extern struct list *bgp_debug_neighbor_events_peers;
 103 extern struct list *bgp_debug_keepalive_peers;
 104 extern struct list *bgp_debug_update_in_peers;
 105 extern struct list *bgp_debug_update_out_peers;
 106 extern struct list *bgp_debug_update_prefixes;
 107 extern struct list *bgp_debug_bestpath_prefixes;
 108 extern struct list *bgp_debug_zebra_prefixes;
 109
 110 struct bgp_debug_filter {
 111         char *host;
 112         struct prefix *p;
 113 };
 114
 115 #define BGP_DEBUG_AS4                 0x01
 116 #define BGP_DEBUG_AS4_SEGMENT         0x02
 117
 118 #define BGP_DEBUG_BESTPATH            0x01
 119 #define BGP_DEBUG_NEIGHBOR_EVENTS     0x01
 120 #define BGP_DEBUG_PACKET              0x01
 121 #define BGP_DEBUG_KEEPALIVE           0x01
 122 #define BGP_DEBUG_UPDATE_IN           0x01
 123 #define BGP_DEBUG_UPDATE_OUT          0x02
 124 #define BGP_DEBUG_UPDATE_PREFIX       0x04
 125 #define BGP_DEBUG_ZEBRA               0x01
 126 #define BGP_DEBUG_ALLOW_MARTIANS      0x01
 127 #define BGP_DEBUG_NHT                 0x01
 128 #define BGP_DEBUG_UPDATE_GROUPS       0x01
 129 #define BGP_DEBUG_VPN_LEAK_FROM_VRF   0x01
 130 #define BGP_DEBUG_VPN_LEAK_TO_VRF     0x02
 131 #define BGP_DEBUG_VPN_LEAK_RMAP_EVENT 0x04
 132 #define BGP_DEBUG_VPN_LEAK_LABEL      0x08
 133 #define BGP_DEBUG_FLOWSPEC            0x01
 134 #define BGP_DEBUG_LABELPOOL           0x01
 135 #define BGP_DEBUG_PBR                 0x01
 136 #define BGP_DEBUG_PBR_ERROR           0x02
 137 #define BGP_DEBUG_EVPN_MH_ES          0x01
 138 #define BGP_DEBUG_EVPN_MH_RT          0x02
 139
 140 #define BGP_DEBUG_PACKET_SEND         0x01
 141 #define BGP_DEBUG_PACKET_SEND_DETAIL  0x02
 142
 143 #define BGP_DEBUG_GRACEFUL_RESTART     0x01
 144
 145 #define BGP_DEBUG_BFD_LIB             0x01
 146
 147 #define CONF_DEBUG_ON(a, b)     (conf_bgp_debug_ ## a |= (BGP_DEBUG_ ## b))
 148 #define CONF_DEBUG_OFF(a, b)    (conf_bgp_debug_ ## a &= ~(BGP_DEBUG_ ## b))
 149
 150 #define TERM_DEBUG_ON(a, b)     (term_bgp_debug_ ## a |= (BGP_DEBUG_ ## b))
 151 #define TERM_DEBUG_OFF(a, b)    (term_bgp_debug_ ## a &= ~(BGP_DEBUG_ ## b))
 152
 153 #define DEBUG_ON(a, b)                                                         \
 154         do {                                                                   \
 155                 CONF_DEBUG_ON(a, b);                                           \
 156                 TERM_DEBUG_ON(a, b);                                           \
 157         } while (0)
 158 #define DEBUG_OFF(a, b)                                                        \
 159         do {                                                                   \
 160                 CONF_DEBUG_OFF(a, b);                                          \
 161                 TERM_DEBUG_OFF(a, b);                                          \
 162         } while (0)
 163
 164 #define BGP_DEBUG(a, b)         (term_bgp_debug_ ## a & BGP_DEBUG_ ## b)
 165 #define CONF_BGP_DEBUG(a, b)    (conf_bgp_debug_ ## a & BGP_DEBUG_ ## b)
 166
 167 extern const char *const bgp_type_str[];
 168
 169 extern bool bgp_dump_attr(struct attr *attr, char *buf, size_t size);
 170 extern bool bgp_debug_peer_updout_enabled(char *host);
 171 extern const char *bgp_notify_code_str(char code);
 172 extern const char *bgp_notify_subcode_str(char code, char subcode);
 173 extern void bgp_notify_print(struct peer *peer, struct bgp_notify *bgp_notify,
 174                              const char *direct, bool hard_reset);
 175
 176 extern const struct message bgp_status_msg[];
 177 extern bool bgp_debug_neighbor_events(const struct peer *peer);
 178 extern bool bgp_debug_keepalive(const struct peer *peer);
 179 extern bool bgp_debug_update(const struct peer *peer, const struct prefix *p,
 180                              struct update_group *updgrp, unsigned int inbound);
 181 extern bool bgp_debug_bestpath(struct bgp_dest *dest);
 182 extern bool bgp_debug_zebra(const struct prefix *p);
 183
 184 extern const char *bgp_debug_rdpfxpath2str(
 185         afi_t afi, safi_t safi, const struct prefix_rd *prd,
 186         union prefixconstptr pu, mpls_label_t *label, uint32_t num_labels,
 187         int addpath_valid, uint32_t addpath_id,
 188         struct bgp_route_evpn *overlay_index, char *str, int size);
 189 const char *bgp_notify_admin_message(char *buf, size_t bufsz, uint8_t *data,
 190                                      size_t datalen);
 191
 192 #endif /* _QUAGGA_BGP_DEBUG_H */