staticd/static_debug.h

   1 /*
   2  * Staticd debug related functions
   3  * Copyright (C) 2019 Volta Networks Inc.
   4  * Mark Stapp
   5  *
   6  * This file is part of FRRouting (FRR).
   7  *
   8  * GNU Zebra is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU General Public License as published by the
  10  * Free Software Foundation; either version 2, or (at your option) any
  11  * later version.
  12  *
  13  * GNU Zebra is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; see the file COPYING; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  21  */
  22
  23 #ifndef _STATIC_DEBUG_H
  24 #define _STATIC_DEBUG_H
  25
  26 #include <zebra.h>
  27
  28 #include "lib/debug.h"
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 /* staticd debugging records */
  35 extern struct debug static_dbg_events;
  36 extern struct debug static_dbg_route;
  37 extern struct debug static_dbg_bfd;
  38
  39 /*
  40  * Initialize staticd debugging.
  41  *
  42  * Installs VTY commands and registers callbacks.
  43  */
  44 void static_debug_init(void);
  45
  46 /*
  47  * Print staticd debugging configuration.
  48  *
  49  * vty
  50  *    VTY to print debugging configuration to.
  51  */
  52 int static_config_write_debug(struct vty *vty);
  53
  54 /*
  55  * Print staticd debugging configuration, human readable form.
  56  *
  57  * vty
  58  *    VTY to print debugging configuration to.
  59  */
  60 int static_debug_status_write(struct vty *vty);
  61
  62 /*
  63  * Set debugging status.
  64  *
  65  * vtynode
  66  *    vty->node
  67  *
  68  * onoff
  69  *    Whether to turn the specified debugs on or off
  70  *
  71  * events
  72  *    Debug general internal events
  73  *
  74  */
  75 void static_debug_set(int vtynode, bool onoff, bool events, bool route,
  76                       bool bfd);
  77
  78 #ifdef __cplusplus
  79 }
  80 #endif
  81
  82 #endif /* _STATIC_DEBUG_H */