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