xref: /freebsd/sys/kern/uipc_debug.c (revision 9336e0699bda8a301cd2bfa37106b6ec5e32012e)
1 /*-
2  * Copyright (c) 2007 Robert N. M. Watson
3  * All rights reserved.
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  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 /*
28  * Debugger routines relating to sockets, protocols, etc, for use in DDB.
29  */
30 
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
33 
34 #include "opt_ddb.h"
35 
36 #include <sys/param.h>
37 #include <sys/domain.h>
38 #include <sys/kernel.h>
39 #include <sys/protosw.h>
40 #include <sys/socket.h>
41 #include <sys/socketvar.h>
42 
43 #ifdef DDB
44 #include <ddb/ddb.h>
45 
46 static void
47 db_print_sotype(short so_type)
48 {
49 
50 	switch (so_type) {
51 	case SOCK_STREAM:
52 		db_printf("SOCK_STREAM");
53 		break;
54 
55 	case SOCK_DGRAM:
56 		db_printf("SOCK_DGRAM");
57 		break;
58 
59 	case SOCK_RAW:
60 		db_printf("SOCK_RAW");
61 		break;
62 
63 	case SOCK_RDM:
64 		db_printf("SOCK_RDM");
65 		break;
66 
67 	case SOCK_SEQPACKET:
68 		db_printf("SOCK_SEQPACKET");
69 		break;
70 
71 	default:
72 		db_printf("unknown");
73 		break;
74 	}
75 }
76 
77 static void
78 db_print_sooptions(short so_options)
79 {
80 	int comma;
81 
82 	comma = 0;
83 	if (so_options & SO_DEBUG) {
84 		db_printf("%sSO_DEBUG", comma ? ", " : "");
85 		comma = 1;
86 	}
87 	if (so_options & SO_ACCEPTCONN) {
88 		db_printf("%sSO_ACCEPTCONN", comma ? ", " : "");
89 		comma = 1;
90 	}
91 	if (so_options & SO_REUSEADDR) {
92 		db_printf("%sSO_REUSEADDR", comma ? ", " : "");
93 		comma = 1;
94 	}
95 	if (so_options & SO_KEEPALIVE) {
96 		db_printf("%sSO_KEEPALIVE", comma ? ", " : "");
97 		comma = 1;
98 	}
99 	if (so_options & SO_DONTROUTE) {
100 		db_printf("%sSO_DONTROUTE", comma ? ", " : "");
101 		comma = 1;
102 	}
103 	if (so_options & SO_BROADCAST) {
104 		db_printf("%sSO_BROADCAST", comma ? ", " : "");
105 		comma = 1;
106 	}
107 	if (so_options & SO_USELOOPBACK) {
108 		db_printf("%sSO_USELOOPBACK", comma ? ", " : "");
109 		comma = 1;
110 	}
111 	if (so_options & SO_LINGER) {
112 		db_printf("%sSO_LINGER", comma ? ", " : "");
113 		comma = 1;
114 	}
115 	if (so_options & SO_OOBINLINE) {
116 		db_printf("%sSO_OOBINLINE", comma ? ", " : "");
117 		comma = 1;
118 	}
119 	if (so_options & SO_REUSEPORT) {
120 		db_printf("%sSO_REUSEPORT", comma ? ", " : "");
121 		comma = 1;
122 	}
123 	if (so_options & SO_TIMESTAMP) {
124 		db_printf("%sSO_TIMESTAMP", comma ? ", " : "");
125 		comma = 1;
126 	}
127 	if (so_options & SO_NOSIGPIPE) {
128 		db_printf("%sSO_NOSIGPIPE", comma ? ", " : "");
129 		comma = 1;
130 	}
131 	if (so_options & SO_ACCEPTFILTER) {
132 		db_printf("%sSO_ACCEPTFILTER", comma ? ", " : "");
133 		comma = 1;
134 	}
135 	if (so_options & SO_BINTIME) {
136 		db_printf("%sSO_BINTIME", comma ? ", " : "");
137 		comma = 1;
138 	}
139 }
140 
141 static void
142 db_print_sostate(short so_state)
143 {
144 	int comma;
145 
146 	comma = 0;
147 	if (so_state & SS_NOFDREF) {
148 		db_printf("%sSS_FDREF", comma ? ", " : "");
149 		comma = 1;
150 	}
151 	if (so_state & SS_ISCONNECTED) {
152 		db_printf("%sSS_ISCONNECTED", comma ? ", " : "");
153 		comma = 1;
154 	}
155 	if (so_state & SS_ISCONNECTING) {
156 		db_printf("%sSS_ISCONNECTING", comma ? ", " : "");
157 		comma = 1;
158 	}
159 	if (so_state & SS_ISDISCONNECTING) {
160 		db_printf("%sSS_ISDISCONNECTING", comma ? ", " : "");
161 		comma = 1;
162 	}
163 	if (so_state & SS_NBIO) {
164 		db_printf("%sSS_NBIO", comma ? ", " : "");
165 		comma = 1;
166 	}
167 	if (so_state & SS_ASYNC) {
168 		db_printf("%sSS_ASYNC", comma ? ", " : "");
169 		comma = 1;
170 	}
171 	if (so_state & SS_ISCONFIRMING) {
172 		db_printf("%sSS_ISCONFIRMING", comma ? ", " : "");
173 		comma = 1;
174 	}
175 	comma = 0;
176 	if (so_state & SS_PROTOREF) {
177 		db_printf("%sSS_PROTOREF", comma ? ", " : "");
178 		comma = 1;
179 	}
180 }
181 
182 static void
183 db_print_soqstate(int so_qstate)
184 {
185 	int comma;
186 
187 	comma = 0;
188 	if (so_qstate & SQ_INCOMP) {
189 		db_printf("%sSQ_INCOMP", comma ? ", " : "");
190 		comma = 1;
191 	}
192 	if (so_qstate & SQ_COMP) {
193 		db_printf("%sSQ_COMP", comma ? ", " : "");
194 		comma = 1;
195 	}
196 }
197 
198 static void
199 db_print_sbstate(short sb_state)
200 {
201 	int comma;
202 
203 	comma = 0;
204 	if (sb_state & SBS_CANTSENDMORE) {
205 		db_printf("%sSS_CANTSENDMORE", comma ? ", " : "");
206 		comma = 1;
207 	}
208 	if (sb_state & SBS_CANTRCVMORE) {
209 		db_printf("%sSS_CANTRCVMORE", comma ? ", " : "");
210 		comma = 1;
211 	}
212 	if (sb_state & SBS_RCVATMARK) {
213 		db_printf("%sSS_RCVATMARK", comma ? ", " : "");
214 		comma = 1;
215 	}
216 }
217 
218 static void
219 db_print_indent(int indent)
220 {
221 	int i;
222 
223 	for (i = 0; i < indent; i++)
224 		db_printf(" ");
225 }
226 
227 static void
228 db_print_domain(struct domain *d, const char *domainname, int indent)
229 {
230 
231 	db_print_indent(indent);
232 	db_printf("%s at %p\n", domainname, d);
233 
234 	indent += 2;
235 
236 	db_print_indent(indent);
237 	db_printf("dom_family: %d   ", d->dom_family);
238 	db_printf("dom_name: %s\n", d->dom_name);
239 
240 	db_print_indent(indent);
241 	db_printf("dom_init: %p   ", d->dom_init);
242 	db_printf("dom_externalize: %p   ", d->dom_externalize);
243 	db_printf("dom_dispose: %p\n", d->dom_dispose);
244 
245 	db_print_indent(indent);
246 	db_printf("dom_protosw: %p   ", d->dom_protosw);
247 	db_printf("dom_next: %p\n", d->dom_next);
248 
249 	db_print_indent(indent);
250 	db_printf("dom_rtattach: %p   ", d->dom_rtattach);
251 	db_printf("dom_rtoffset: %d   ", d->dom_rtoffset);
252 	db_printf("dom_maxrtkey: %d\n", d->dom_maxrtkey);
253 
254 	db_print_indent(indent);
255 	db_printf("dom_ifattach: %p   ", d->dom_ifattach);
256 	db_printf("dom_ifdetach: %p\n", d->dom_ifdetach);
257 }
258 
259 static void
260 db_print_prflags(short pr_flags)
261 {
262 	int comma;
263 
264 	comma = 0;
265 	if (pr_flags & PR_ATOMIC) {
266 		db_printf("%sPR_ATOMIC", comma ? ", " : "");
267 		comma = 1;
268 	}
269 	if (pr_flags & PR_ADDR) {
270 		db_printf("%sPR_ADDR", comma ? ", " : "");
271 		comma = 1;
272 	}
273 	if (pr_flags & PR_CONNREQUIRED) {
274 		db_printf("%sPR_CONNREQUIRED", comma ? ", " : "");
275 		comma = 1;
276 	}
277 	if (pr_flags & PR_WANTRCVD) {
278 		db_printf("%sPR_WANTRCVD", comma ? ", " : "");
279 		comma = 1;
280 	}
281 	if (pr_flags & PR_RIGHTS) {
282 		db_printf("%sPR_RIGHTS", comma ? ", " : "");
283 		comma = 1;
284 	}
285 	if (pr_flags & PR_IMPLOPCL) {
286 		db_printf("%sPR_IMPLOPCL", comma ? ", " : "");
287 		comma = 1;
288 	}
289 	if (pr_flags & PR_LASTHDR) {
290 		db_printf("%sPR_LASTHDR", comma ? ", " : "");
291 		comma = 1;
292 	}
293 }
294 
295 static void
296 db_print_protosw(struct protosw *pr, const char *prname, int indent)
297 {
298 
299 	db_print_indent(indent);
300 	db_printf("%s at %p\n", prname, pr);
301 
302 	indent += 2;
303 
304 	db_print_indent(indent);
305 	db_printf("pr_type: %d   ", pr->pr_type);
306 	db_printf("pr_domain: %p\n", pr->pr_domain);
307 	if (pr->pr_domain != NULL)
308 		db_print_domain(pr->pr_domain, "pr_domain", indent);
309 
310 	db_print_indent(indent);
311 	db_printf("pr_protocol: %d\n", pr->pr_protocol);
312 
313 	db_print_indent(indent);
314 	db_printf("pr_flags: %d (", pr->pr_flags);
315 	db_print_prflags(pr->pr_flags);
316 	db_printf(")\n");
317 
318 	db_print_indent(indent);
319 	db_printf("pr_input: %p   ", pr->pr_input);
320 	db_printf("pr_output: %p   ", pr->pr_output);
321 	db_printf("pr_ctlinput: %p\n", pr->pr_ctlinput);
322 
323 	db_print_indent(indent);
324 	db_printf("pr_ctloutput: %p   ", pr->pr_ctloutput);
325 	db_printf("pr_ousrreq: %p   ", pr->pr_ousrreq);
326 	db_printf("pr_init: %p\n", pr->pr_init);
327 
328 	db_print_indent(indent);
329 	db_printf("pr_fasttimo: %p   ", pr->pr_fasttimo);
330 	db_printf("pr_slowtimo: %p   ", pr->pr_slowtimo);
331 	db_printf("pr_drain: %p\n", pr->pr_drain);
332 
333 	db_print_indent(indent);
334 	db_printf("pr_ousrreq: %p\n", pr->pr_ousrreq);
335 }
336 
337 static void
338 db_print_sbflags(short sb_flags)
339 {
340 	int comma;
341 
342 	comma = 0;
343 	if (sb_flags & SB_WAIT) {
344 		db_printf("%sSB_WAIT", comma ? ", " : "");
345 		comma = 1;
346 	}
347 	if (sb_flags & SB_SEL) {
348 		db_printf("%sSB_SEL", comma ? ", " : "");
349 		comma = 1;
350 	}
351 	if (sb_flags & SB_ASYNC) {
352 		db_printf("%sSB_ASYNC", comma ? ", " : "");
353 		comma = 1;
354 	}
355 	if (sb_flags & SB_UPCALL) {
356 		db_printf("%sSB_UPCALL", comma ? ", " : "");
357 		comma = 1;
358 	}
359 	if (sb_flags & SB_NOINTR) {
360 		db_printf("%sSB_NOINTR", comma ? ", " : "");
361 		comma = 1;
362 	}
363 	if (sb_flags & SB_AIO) {
364 		db_printf("%sSB_AIO", comma ? ", " : "");
365 		comma = 1;
366 	}
367 	if (sb_flags & SB_KNOTE) {
368 		db_printf("%sSB_KNOTE", comma ? ", " : "");
369 		comma = 1;
370 	}
371 	if (sb_flags & SB_AUTOSIZE) {
372 		db_printf("%sSB_AUTOSIZE", comma ? ", " : "");
373 		comma = 1;
374 	}
375 }
376 
377 static void
378 db_print_sockbuf(struct sockbuf *sb, const char *sockbufname, int indent)
379 {
380 
381 	db_print_indent(indent);
382 	db_printf("%s at %p\n", sockbufname, sb);
383 
384 	indent += 2;
385 
386 	db_print_indent(indent);
387 	db_printf("sb_state: 0x%x (", sb->sb_state);
388 	db_print_sbstate(sb->sb_state);
389 	db_printf(")\n");
390 
391 	db_print_indent(indent);
392 	db_printf("sb_mb: %p   ", sb->sb_mb);
393 	db_printf("sb_mbtail: %p   ", sb->sb_mbtail);
394 	db_printf("sb_lastrecord: %p\n", sb->sb_lastrecord);
395 
396 	db_print_indent(indent);
397 	db_printf("sb_cc: %d   ", sb->sb_cc);
398 	db_printf("sb_hiwat: %d   ", sb->sb_hiwat);
399 	db_printf("sb_mbcnt: %d   ", sb->sb_mbcnt);
400 	db_printf("sb_mbmax: %d\n", sb->sb_mbmax);
401 
402 	db_print_indent(indent);
403 	db_printf("sb_ctl: %d   ", sb->sb_ctl);
404 	db_printf("sb_lowat: %d   ", sb->sb_lowat);
405 	db_printf("sb_timeo: %d\n", sb->sb_timeo);
406 
407 	db_print_indent(indent);
408 	db_printf("sb_flags: 0x%x (", sb->sb_flags);
409 	db_print_sbflags(sb->sb_flags);
410 	db_printf(")\n");
411 }
412 
413 static void
414 db_print_socket(struct socket *so, const char *socketname, int indent)
415 {
416 
417 	db_print_indent(indent);
418 	db_printf("%s at %p\n", socketname, so);
419 
420 	indent += 2;
421 
422 	db_print_indent(indent);
423 	db_printf("so_count: %d   ", so->so_count);
424 	db_printf("so_type: %d (", so->so_type);
425 	db_print_sotype(so->so_type);
426 	db_printf(")\n");
427 
428 	db_print_indent(indent);
429 	db_printf("so_options: 0x%x (", so->so_options);
430 	db_print_sooptions(so->so_options);
431 	db_printf(")\n");
432 
433 	db_print_indent(indent);
434 	db_printf("so_linger: %d   ", so->so_linger);
435 	db_printf("so_state: 0x%x (", so->so_state);
436 	db_print_sostate(so->so_state);
437 	db_printf(")\n");
438 
439 	db_print_indent(indent);
440 	db_printf("so_qstate: 0x%x (", so->so_qstate);
441 	db_print_soqstate(so->so_qstate);
442 	db_printf(")   ");
443 	db_printf("so_pcb: %p   ", so->so_pcb);
444 	db_printf("so_proto: %p\n", so->so_proto);
445 
446 	if (so->so_proto != NULL)
447 		db_print_protosw(so->so_proto, "so_proto", indent);
448 
449 	db_print_indent(indent);
450 	db_printf("so_head: %p   ", so->so_head);
451 	db_printf("so_incomp first: %p   ", TAILQ_FIRST(&so->so_incomp));
452 	db_printf("so_comp first: %p\n", TAILQ_FIRST(&so->so_comp));
453 
454 	db_print_indent(indent);
455 	/* so_list skipped */
456 	db_printf("so_qlen: %d   ", so->so_qlen);
457 	db_printf("so_incqlen: %d   ", so->so_incqlen);
458 	db_printf("so_qlimit: %d   ", so->so_qlimit);
459 	db_printf("so_timeo: %d   ", so->so_timeo);
460 	db_printf("so_error: %d\n", so->so_error);
461 
462 	db_print_indent(indent);
463 	db_printf("so_sigio: %p   ", so->so_sigio);
464 	db_printf("so_oobmark: %lu   ", so->so_oobmark);
465 	db_printf("so_aiojobq first: %p\n", TAILQ_FIRST(&so->so_aiojobq));
466 
467 	db_print_sockbuf(&so->so_rcv, "so_rcv", indent);
468 	db_print_sockbuf(&so->so_snd, "so_snd", indent);
469 }
470 
471 DB_SHOW_COMMAND(socket, db_show_socket)
472 {
473 	struct socket *so;
474 
475 	if (!have_addr) {
476 		db_printf("usage: show socket <addr>\n");
477 		return;
478 	}
479 	so = (struct socket *)addr;
480 
481 	db_print_socket(so, "socket", 0);
482 }
483 
484 DB_SHOW_COMMAND(sockbuf, db_show_sockbuf)
485 {
486 	struct sockbuf *sb;
487 
488 	if (!have_addr) {
489 		db_printf("usage: show sockbuf <addr>\n");
490 		return;
491 	}
492 	sb = (struct sockbuf *)addr;
493 
494 	db_print_sockbuf(sb, "sockbuf", 0);
495 }
496 
497 DB_SHOW_COMMAND(protosw, db_show_protosw)
498 {
499 	struct protosw *pr;
500 
501 	if (!have_addr) {
502 		db_printf("usage: show protosw <addr>\n");
503 		return;
504 	}
505 	pr = (struct protosw *)addr;
506 
507 	db_print_protosw(pr, "protosw", 0);
508 }
509 
510 DB_SHOW_COMMAND(domain, db_show_domain)
511 {
512 	struct domain *d;
513 
514 	if (!have_addr) {
515 		db_printf("usage: show protosw <addr>\n");
516 		return;
517 	}
518 	d = (struct domain *)addr;
519 
520 	db_print_domain(d, "domain", 0);
521 }
522 #endif
523