1 /*- 2 * Copyright (c) 2021 3 * Alexander V. Chernikov <melifaro@FreeBSD.org> 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the University nor the names of its contributors 14 * may be used to endorse or promote products derived from this software 15 * without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 */ 29 30 #ifndef _NET_ROUTE_DEBUG_H_ 31 #define _NET_ROUTE_DEBUG_H_ 32 33 #include <sys/sysctl.h> 34 #include <sys/syslog.h> 35 36 /* DEBUG logic */ 37 #if defined(DEBUG_MOD_NAME) && defined(DEBUG_MAX_LEVEL) 38 39 #ifndef _DEBUG_SYSCTL_OID 40 #define _DEBUG_SYSCTL_OID _net_route_debug 41 SYSCTL_DECL(_net_route_debug); 42 #endif 43 44 #define DEBUG_VAR_NAME _DEBUG_VAR_NAME(DEBUG_MOD_NAME) 45 #define _DEBUG_VAR_NAME(a) _DEBUG_VAR_NAME_INDIRECT(a) 46 #define _DEBUG_VAR_NAME_INDIRECT(prefix) prefix##_debug_level 47 48 #define DEBUG_PREFIX_NAME _DEBUG_PREFIX_NAME(DEBUG_MOD_NAME) 49 #define _DEBUG_PREFIX_NAME(n) __DEBUG_PREFIX_NAME(n) 50 #define __DEBUG_PREFIX_NAME(n) #n 51 52 #define _DECLARE_DEBUG(_default_level) \ 53 static int DEBUG_VAR_NAME = _default_level; \ 54 SYSCTL_INT(_DEBUG_SYSCTL_OID, OID_AUTO, DEBUG_VAR_NAME, \ 55 CTLFLAG_RW | CTLFLAG_RWTUN, \ 56 &(DEBUG_VAR_NAME), 0, "debuglevel") 57 58 /* Additional tracing levels not defined by log.h */ 59 #ifndef LOG_DEBUG2 60 #define LOG_DEBUG2 8 61 #endif 62 #ifndef LOG_DEBUG3 63 #define LOG_DEBUG3 9 64 #endif 65 66 /* 67 * Severity usage guidelines: 68 * 69 * LOG_WARNING - subsystem-global errors ("multipath init failed") 70 * 71 * LOG_INFO - subsystem non-transient errors ("Failed to unlink nexhop"). 72 * All logging <= LOG_INFO by default will be written to syslog. 73 * 74 * LOG_DEBUG - subsystem debug. Not-too often events (hash resizes, recoverable failures). 75 * These are compiled in by default on production. Turning it it should NOT notable affect 76 * performance 77 * LOG_DEBUG2 - more debug. Per-item level (nhg,nh,route) debug, up to multiple lines per item. 78 * This is NOT compiled in by default. Turning it on should NOT seriously impact performance 79 * LOG_DEBUG3 - last debug level. Per-item large debug outputs. 80 * This is NOT compiled in by default. All performance bets are off. 81 * 82 */ 83 84 #define _output printf 85 #define _DEBUG_PASS_MSG(_l) (DEBUG_VAR_NAME >= (_l)) 86 87 #define IF_DEBUG_LEVEL(_l) if ((DEBUG_MAX_LEVEL >= (_l)) && (__predict_false(DEBUG_VAR_NAME >= (_l)))) 88 89 /* 90 * Logging for events specific for particular family and fib 91 * Example: [nhop_neigh] inet.0 find_lle: nhop nh#4/inet/vtnet0/10.0.0.1: mapped to lle NULL 92 */ 93 #define FIB_LOG(_l, _fib, _fam, _fmt, ...) FIB_LOG_##_l(_l, _fib, _fam, _fmt, ## __VA_ARGS__) 94 #define _FIB_LOG(_l, _fib, _fam, _fmt, ...) if (_DEBUG_PASS_MSG(_l)) { \ 95 _output("[" DEBUG_PREFIX_NAME "] %s.%u %s: " _fmt "\n", rib_print_family(_fam), _fib, __func__, ##__VA_ARGS__); \ 96 } 97 98 /* Same as FIB_LOG, but uses nhop to get fib and family */ 99 #define FIB_NH_LOG(_l, _nh, _fmt, ...) FIB_LOG_##_l(_l, nhop_get_fibnum(_nh), nhop_get_upper_family(_nh), _fmt, ## __VA_ARGS__) 100 /* Same as FIB_LOG, but uses rib_head to get fib and family */ 101 #define FIB_RH_LOG(_l, _rh, _fmt, ...) FIB_LOG_##_l(_l, (_rh)->rib_fibnum, (_rh)->rib_family, _fmt, ## __VA_ARGS__) 102 /* Same as FIB_LOG, but uses nh_control to get fib and family from linked rib */ 103 #define FIB_CTL_LOG(_l, _ctl, _fmt, ...) FIB_LOG_##_l(_l, (_ctl)->ctl_rh->rib_fibnum, (_ctl)->ctl_rh->rib_family, _fmt, ## __VA_ARGS__) 104 105 /* 106 * Generic logging for routing subsystem 107 * Example: [nhop_neigh] nhops_update_neigh: L2 prepend update from lle/inet/valid/vtnet0/10.0.0.157 108 */ 109 #define RT_LOG(_l, _fmt, ...) RT_LOG_##_l(_l, _fmt, ## __VA_ARGS__) 110 #define _RT_LOG(_l, _fmt, ...) if (_DEBUG_PASS_MSG(_l)) { \ 111 _output("[" DEBUG_PREFIX_NAME "] %s: " _fmt "\n", __func__, ##__VA_ARGS__); \ 112 } 113 114 115 /* 116 * Wrapper logic to avoid compiling high levels of debugging messages for production systems. 117 */ 118 #if DEBUG_MAX_LEVEL>=LOG_DEBUG3 119 #define FIB_LOG_LOG_DEBUG3 _FIB_LOG 120 #define RT_LOG_LOG_DEBUG3 _RT_LOG 121 #else 122 #define FIB_LOG_LOG_DEBUG3(_l, _fib, _fam, _fmt, ...) 123 #define RT_LOG_LOG_DEBUG3(_l, _fmt, ...) 124 #endif 125 #if DEBUG_MAX_LEVEL>=LOG_DEBUG2 126 #define FIB_LOG_LOG_DEBUG2 _FIB_LOG 127 #define RT_LOG_LOG_DEBUG2 _RT_LOG 128 #else 129 #define FIB_LOG_LOG_DEBUG2(_l, _fib, _fam, _fmt, ...) 130 #define RT_LOG_LOG_DEBUG2(_l, _fmt, ...) 131 #endif 132 #if DEBUG_MAX_LEVEL>=LOG_DEBUG 133 #define FIB_LOG_LOG_DEBUG _FIB_LOG 134 #define RT_LOG_LOG_DEBUG _RT_LOG 135 #else 136 #define FIB_LOG_LOG_DEBUG(_l, _fib, _fam, _fmt, ...) 137 #define RT_LOG_LOG_DEBUG(_l, _fmt, ...) 138 #endif 139 #if DEBUG_MAX_LEVEL>=LOG_INFO 140 #define FIB_LOG_LOG_INFO _FIB_LOG 141 #define RT_LOG_LOG_INFO _RT_LOG 142 #else 143 #define FIB_LOG_LOG_INFO(_l, _fib, _fam, _fmt, ...) 144 #define RT_LOG_LOG_INFO(_l, _fmt, ...) 145 #endif 146 #define FIB_LOG_LOG_NOTICE _FIB_LOG 147 #define FIB_LOG_LOG_ERR _FIB_LOG 148 #define FIB_LOG_LOG_WARNING _FIB_LOG 149 #define RT_LOG_LOG_NOTICE _RT_LOG 150 #define RT_LOG_LOG_ERR _RT_LOG 151 #define RT_LOG_LOG_WARNING _RT_LOG 152 153 #endif 154 155 /* Helpers for fancy-printing various objects */ 156 struct nhop_object; 157 struct nhgrp_object; 158 struct llentry; 159 struct nhop_neigh; 160 struct rtentry; 161 struct ifnet; 162 163 #define NHOP_PRINT_BUFSIZE 48 164 char *nhop_print_buf(const struct nhop_object *nh, char *buf, size_t bufsize); 165 char *nhop_print_buf_any(const struct nhop_object *nh, char *buf, size_t bufsize); 166 char *nhgrp_print_buf(const struct nhgrp_object *nhg, char *buf, size_t bufsize); 167 char *llentry_print_buf(const struct llentry *lle, struct ifnet *ifp, int family, char *buf, 168 size_t bufsize); 169 char *llentry_print_buf_lltable(const struct llentry *lle, char *buf, size_t bufsize); 170 char *neigh_print_buf(const struct nhop_neigh *nn, char *buf, size_t bufsize); 171 char *rt_print_buf(const struct rtentry *rt, char *buf, size_t bufsize); 172 const char *rib_print_cmd(int rib_cmd); 173 174 #endif 175