4 * Copyright (c) 1996-1999 Whistle Communications, Inc.
7 * Subject to the following obligations and disclaimer of warranty, use and
8 * redistribution of this software, in source or object code forms, with or
9 * without modifications are expressly permitted by Whistle Communications;
10 * provided, however, that:
11 * 1. Any and all reproductions of the source or object code must include the
12 * copyright notice above and the following disclaimer of warranties; and
13 * 2. No rights are granted, in any manner or form, to use Whistle
14 * Communications, Inc. trademarks, including the mark "WHISTLE
15 * COMMUNICATIONS" on advertising, endorsements, or otherwise except as
16 * such appears in the above copyright notice or in the software.
18 * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
19 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
20 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
21 * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
23 * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
24 * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
25 * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
26 * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
27 * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
28 * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
29 * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
30 * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
33 * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
36 * Author: Archie Cobbs <archie@whistle.com>
38 * $FreeBSD: src/lib/libnetgraph/debug.c,v 1.9 2005/10/25 20:58:30 ru Exp $
39 * $DragonFly: src/lib/libnetgraph/debug.c,v 1.4 2007/06/17 20:33:14 swildner Exp $
40 * $Whistle: debug.c,v 1.24 1999/01/24 01:15:33 archie Exp $
43 #include <sys/types.h>
45 #include <sys/ioctl.h>
49 #include <netinet/in.h>
50 #include <net/ethernet.h>
53 #include <netgraph7/ng_message.h>
54 #include <netgraph7/socket/ng_socket.h>
59 #include <netgraph7/UI/ng_UI.h>
60 #include <netgraph7/async/ng_async.h>
61 #include <netgraph7/atmllc/ng_atmllc.h>
62 #include <netgraph7/bpf/ng_bpf.h>
63 #include <netgraph/bridge/ng_bridge.h>
64 #include <netgraph7/cisco/ng_cisco.h>
65 #include <netgraph7/deflate/ng_deflate.h>
66 #include <netgraph7/echo/ng_echo.h>
68 #include <netgraph7/eiface/ng_eiface.h>
70 #include <netgraph7/etf/ng_etf.h>
71 #include <netgraph7/ether/ng_ether.h>
73 #include <netgraph7/fec/ng_fec.h>
75 #include <netgraph7/frame_relay/ng_frame_relay.h>
76 #include <netgraph7/hole/ng_hole.h>
78 #include <netgraph7/hub/ng_hub.h>
80 #include <netgraph7/iface/ng_iface.h>
82 #include <netgraph7/ip_input/ng_ip_input.h>
84 #include <netgraph7/ksocket/ng_ksocket.h>
85 #include <netgraph7/l2tp/ng_l2tp.h>
86 #include <netgraph7/lmi/ng_lmi.h>
87 #include <netgraph7/mppc/ng_mppc.h>
88 #include <netgraph7/one2many/ng_one2many.h>
89 #include <netgraph7/ppp/ng_ppp.h>
90 #include <netgraph7/pppoe/ng_pppoe.h>
91 #include <netgraph7/pptpgre/ng_pptpgre.h>
93 #include <netgraph7/rfc1490/ng_rfc1490.h>
94 #include <netgraph7/socket/ng_socket.h>
95 #include <netgraph7/source/ng_source.h>
96 #include <netgraph7/split/ng_split.h>
97 #include <netgraph7/tcpmss/ng_tcpmss.h>
99 #include <netgraph7/tee/ng_tee.h>
101 #include <netgraph7/tty/ng_tty.h>
103 #include <netgraph7/vjc/ng_vjc.h>
105 #include <machine/../isa/df_def.h>
106 #include <machine/../isa/if_wfra.h>
107 #include <machine/../isa/ipac.h>
108 #include <netgraph/ng_df.h>
109 #include <netgraph/ng_ipac.h>
110 #include <netgraph/ng_tn.h>
113 /* Global debug level */
114 int _gNgDebugLevel = 0;
116 /* Debug printing functions */
117 void (*_NgLog) (const char *fmt,...) = warn;
118 void (*_NgLogx) (const char *fmt,...) = warnx;
120 /* Internal functions */
121 static const char *NgCookie(int cookie);
123 /* Known typecookie list */
129 #define COOKIE(c) { NGM_ ## c ## _COOKIE, #c }
131 /* List of known cookies */
132 static const struct ng_cookie cookies[] = {
191 * Set debug level, ie, verbosity, if "level" is non-negative.
192 * Returns old debug level.
195 NgSetDebug(int level)
197 int old = _gNgDebugLevel;
201 _gNgDebugLevel = level;
206 * Set debug logging functions.
209 NgSetErrLog(void (*log) (const char *fmt,...),
210 void (*logx) (const char *fmt,...))
217 * Display a netgraph sockaddr
220 _NgDebugSockaddr(const struct sockaddr_ng *sg)
222 NGLOGX("SOCKADDR: { fam=%d len=%d addr=\"%s\" }",
223 sg->sg_family, sg->sg_len, sg->sg_data);
226 #define ARGS_BUFSIZE 2048
227 #define RECURSIVE_DEBUG_ADJUST 4
230 * Display a negraph message
233 _NgDebugMsg(const struct ng_mesg *msg, const char *path)
235 u_char buf[2 * sizeof(struct ng_mesg) + ARGS_BUFSIZE];
236 struct ng_mesg *const req = (struct ng_mesg *)buf;
237 struct ng_mesg *const bin = (struct ng_mesg *)req->data;
238 int arglen, csock = -1;
240 /* Display header stuff */
242 NGLOGX(" vers %d", msg->header.version);
243 NGLOGX(" arglen %d", msg->header.arglen);
244 NGLOGX(" flags %ld", msg->header.flags);
245 NGLOGX(" token %lu", (u_long)msg->header.token);
246 NGLOGX(" cookie %s (%d)",
247 NgCookie(msg->header.typecookie), msg->header.typecookie);
249 /* At lower debugging levels, skip ASCII translation */
250 if (_gNgDebugLevel <= 2)
253 /* If path is not absolute, don't bother trying to use relative
254 address on a different socket for the ASCII translation */
255 if (strchr(path, ':') == NULL)
258 /* Get a temporary socket */
259 if (NgMkSockNode(NULL, &csock, NULL) < 0)
262 /* Copy binary message into request message payload */
263 arglen = msg->header.arglen;
264 if (arglen > ARGS_BUFSIZE)
265 arglen = ARGS_BUFSIZE;
266 memcpy(bin, msg, sizeof(*msg) + arglen);
267 bin->header.arglen = arglen;
269 /* Lower debugging to avoid infinite recursion */
270 _gNgDebugLevel -= RECURSIVE_DEBUG_ADJUST;
272 /* Ask the node to translate the binary message to ASCII for us */
273 if (NgSendMsg(csock, path, NGM_GENERIC_COOKIE,
274 NGM_BINARY2ASCII, bin, sizeof(*bin) + bin->header.arglen) < 0) {
275 _gNgDebugLevel += RECURSIVE_DEBUG_ADJUST;
278 if (NgRecvMsg(csock, req, sizeof(buf), NULL) < 0) {
279 _gNgDebugLevel += RECURSIVE_DEBUG_ADJUST;
283 /* Restore debugging level */
284 _gNgDebugLevel += RECURSIVE_DEBUG_ADJUST;
286 /* Display command string and arguments */
287 NGLOGX(" cmd %s (%d)", bin->header.cmdstr, bin->header.cmd);
288 NGLOGX(" args %s", bin->data);
292 /* Just display binary version */
293 NGLOGX(" [error decoding message: %s]", strerror(errno));
295 NGLOGX(" cmd %d", msg->header.cmd);
296 NGLOGX(" args (%d bytes)", msg->header.arglen);
297 _NgDebugBytes(msg->data, msg->header.arglen);
305 * Return the name of the node type corresponding to the cookie
312 for (k = 0; cookies[k].cookie != 0; k++) {
313 if (cookies[k].cookie == cookie)
314 return cookies[k].type;
323 _NgDebugBytes(const u_char *ptr, int len)
330 for (count = 0; count < len; ptr += BYPERLINE, count += BYPERLINE) {
333 snprintf(buf, sizeof(buf), "%04x: ", count);
334 for (k = 0; k < BYPERLINE; k++, count++)
336 snprintf(buf + strlen(buf),
337 sizeof(buf) - strlen(buf), "%02x ", ptr[k]);
339 snprintf(buf + strlen(buf),
340 sizeof(buf) - strlen(buf), " ");
341 snprintf(buf + strlen(buf), sizeof(buf) - strlen(buf), " ");
345 for (k = 0; k < BYPERLINE; k++, count++)
347 snprintf(buf + strlen(buf),
348 sizeof(buf) - strlen(buf),
349 "%c", isprint(ptr[k]) ? ptr[k] : '.');
351 snprintf(buf + strlen(buf),
352 sizeof(buf) - strlen(buf), " ");