1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause
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 #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
db_print_sotype(short so_type)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
db_print_sooptions(int so_options)78 db_print_sooptions(int 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_REUSEPORT_LB) {
124 db_printf("%sSO_REUSEPORT_LB", comma ? ", " : "");
125 comma = 1;
126 }
127 if (so_options & SO_TIMESTAMP) {
128 db_printf("%sSO_TIMESTAMP", comma ? ", " : "");
129 comma = 1;
130 }
131 if (so_options & SO_NOSIGPIPE) {
132 db_printf("%sSO_NOSIGPIPE", comma ? ", " : "");
133 comma = 1;
134 }
135 if (so_options & SO_ACCEPTFILTER) {
136 db_printf("%sSO_ACCEPTFILTER", comma ? ", " : "");
137 comma = 1;
138 }
139 if (so_options & SO_BINTIME) {
140 db_printf("%sSO_BINTIME", comma ? ", " : "");
141 comma = 1;
142 }
143 if (so_options & SO_NO_OFFLOAD) {
144 db_printf("%sSO_NO_OFFLOAD", comma ? ", " : "");
145 comma = 1;
146 }
147 if (so_options & SO_NO_DDP) {
148 db_printf("%sSO_NO_DDP", comma ? ", " : "");
149 comma = 1;
150 }
151 }
152
153 static void
db_print_sostate(short so_state)154 db_print_sostate(short so_state)
155 {
156 int comma;
157
158 comma = 0;
159 if (so_state & SS_ISCONNECTED) {
160 db_printf("%sSS_ISCONNECTED", comma ? ", " : "");
161 comma = 1;
162 }
163 if (so_state & SS_ISCONNECTING) {
164 db_printf("%sSS_ISCONNECTING", comma ? ", " : "");
165 comma = 1;
166 }
167 if (so_state & SS_ISDISCONNECTING) {
168 db_printf("%sSS_ISDISCONNECTING", comma ? ", " : "");
169 comma = 1;
170 }
171 if (so_state & SS_NBIO) {
172 db_printf("%sSS_NBIO", comma ? ", " : "");
173 comma = 1;
174 }
175 if (so_state & SS_ASYNC) {
176 db_printf("%sSS_ASYNC", comma ? ", " : "");
177 comma = 1;
178 }
179 if (so_state & SS_ISCONFIRMING) {
180 db_printf("%sSS_ISCONFIRMING", comma ? ", " : "");
181 comma = 1;
182 }
183 }
184
185 static void
db_print_soqstate(int so_qstate)186 db_print_soqstate(int so_qstate)
187 {
188 int comma;
189
190 comma = 0;
191 if (so_qstate & SQ_INCOMP) {
192 db_printf("%sSQ_INCOMP", comma ? ", " : "");
193 comma = 1;
194 }
195 if (so_qstate & SQ_COMP) {
196 db_printf("%sSQ_COMP", comma ? ", " : "");
197 comma = 1;
198 }
199 }
200
201 static void
db_print_sbstate(short sb_state)202 db_print_sbstate(short sb_state)
203 {
204 int comma;
205
206 comma = 0;
207 if (sb_state & SBS_CANTSENDMORE) {
208 db_printf("%sSBS_CANTSENDMORE", comma ? ", " : "");
209 comma = 1;
210 }
211 if (sb_state & SBS_CANTRCVMORE) {
212 db_printf("%sSBS_CANTRCVMORE", comma ? ", " : "");
213 comma = 1;
214 }
215 if (sb_state & SBS_RCVATMARK) {
216 db_printf("%sSBS_RCVATMARK", comma ? ", " : "");
217 comma = 1;
218 }
219 }
220
221 static void
db_print_indent(int indent)222 db_print_indent(int indent)
223 {
224 int i;
225
226 for (i = 0; i < indent; i++)
227 db_printf(" ");
228 }
229
230 static void
db_print_domain(struct domain * d,const char * domain_name,int indent)231 db_print_domain(struct domain *d, const char *domain_name, int indent)
232 {
233
234 db_print_indent(indent);
235 db_printf("%s at %p\n", domain_name, d);
236
237 indent += 2;
238
239 db_print_indent(indent);
240 db_printf("dom_family: %d ", d->dom_family);
241 db_printf("dom_name: %s\n", d->dom_name);
242
243 db_print_indent(indent);
244 db_printf("dom_externalize: %p ", d->dom_externalize);
245 db_printf("dom_dispose: %p\n", d->dom_dispose);
246
247 db_print_indent(indent);
248 db_printf("dom_protosw: %p ", d->dom_protosw);
249 db_printf("dom_next: %p\n", d->dom_next.sle_next);
250
251 db_print_indent(indent);
252 db_printf("dom_rtattach: %p ", d->dom_rtattach);
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
db_print_prflags(short pr_flags)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 }
290
291 static void
db_print_protosw(struct protosw * pr,const char * prname,int indent)292 db_print_protosw(struct protosw *pr, const char *prname, int indent)
293 {
294
295 db_print_indent(indent);
296 db_printf("%s at %p\n", prname, pr);
297
298 indent += 2;
299
300 db_print_indent(indent);
301 db_printf("pr_type: %d ", pr->pr_type);
302 db_printf("pr_domain: %p\n", pr->pr_domain);
303 if (pr->pr_domain != NULL)
304 db_print_domain(pr->pr_domain, "pr_domain", indent);
305
306 db_print_indent(indent);
307 db_printf("pr_protocol: %d\n", pr->pr_protocol);
308
309 db_print_indent(indent);
310 db_printf("pr_flags: %d (", pr->pr_flags);
311 db_print_prflags(pr->pr_flags);
312 db_printf(")\n");
313
314 db_print_indent(indent);
315 db_printf("pr_ctloutput: %p ", pr->pr_ctloutput);
316 }
317
318 static void
db_print_sbflags(short sb_flags)319 db_print_sbflags(short sb_flags)
320 {
321 int comma;
322
323 comma = 0;
324 if (sb_flags & SB_WAIT) {
325 db_printf("%sSB_WAIT", comma ? ", " : "");
326 comma = 1;
327 }
328 if (sb_flags & SB_SEL) {
329 db_printf("%sSB_SEL", comma ? ", " : "");
330 comma = 1;
331 }
332 if (sb_flags & SB_ASYNC) {
333 db_printf("%sSB_ASYNC", comma ? ", " : "");
334 comma = 1;
335 }
336 if (sb_flags & SB_UPCALL) {
337 db_printf("%sSB_UPCALL", comma ? ", " : "");
338 comma = 1;
339 }
340 if (sb_flags & SB_NOINTR) {
341 db_printf("%sSB_NOINTR", comma ? ", " : "");
342 comma = 1;
343 }
344 if (sb_flags & SB_AIO) {
345 db_printf("%sSB_AIO", comma ? ", " : "");
346 comma = 1;
347 }
348 if (sb_flags & SB_KNOTE) {
349 db_printf("%sSB_KNOTE", comma ? ", " : "");
350 comma = 1;
351 }
352 if (sb_flags & SB_AUTOSIZE) {
353 db_printf("%sSB_AUTOSIZE", comma ? ", " : "");
354 comma = 1;
355 }
356 }
357
358 static void
db_print_sockbuf(struct sockbuf * sb,const char * sockbufname,int indent)359 db_print_sockbuf(struct sockbuf *sb, const char *sockbufname, int indent)
360 {
361
362 db_print_indent(indent);
363 db_printf("%s at %p\n", sockbufname, sb);
364
365 indent += 2;
366
367 db_print_indent(indent);
368 db_printf("sb_state: 0x%x (", sb->sb_state);
369 db_print_sbstate(sb->sb_state);
370 db_printf(")\n");
371
372 db_print_indent(indent);
373 db_printf("sb_mb: %p ", sb->sb_mb);
374 db_printf("sb_mbtail: %p ", sb->sb_mbtail);
375 db_printf("sb_lastrecord: %p\n", sb->sb_lastrecord);
376
377 db_print_indent(indent);
378 db_printf("sb_sndptr: %p ", sb->sb_sndptr);
379 db_printf("sb_sndptroff: %u\n", sb->sb_sndptroff);
380
381 db_print_indent(indent);
382 db_printf("sb_acc: %u ", sb->sb_acc);
383 db_printf("sb_ccc: %u ", sb->sb_ccc);
384 db_printf("sb_hiwat: %u ", sb->sb_hiwat);
385 db_printf("sb_mbcnt: %u ", sb->sb_mbcnt);
386 db_printf("sb_mbmax: %u\n", sb->sb_mbmax);
387
388 db_print_indent(indent);
389 db_printf("sb_ctl: %u ", sb->sb_ctl);
390 db_printf("sb_lowat: %d ", sb->sb_lowat);
391 db_printf("sb_timeo: %jd\n", sb->sb_timeo);
392
393 db_print_indent(indent);
394 db_printf("sb_flags: 0x%x (", sb->sb_flags);
395 db_print_sbflags(sb->sb_flags);
396 db_printf(")\n");
397
398 db_print_indent(indent);
399 db_printf("sb_aiojobq first: %p\n", TAILQ_FIRST(&sb->sb_aiojobq));
400 }
401
402 static void
db_print_socket(struct socket * so,const char * socketname,int indent)403 db_print_socket(struct socket *so, const char *socketname, int indent)
404 {
405
406 db_print_indent(indent);
407 db_printf("%s at %p\n", socketname, so);
408
409 indent += 2;
410
411 db_print_indent(indent);
412 db_printf("so_count: %d ", so->so_count);
413 db_printf("so_type: %d (", so->so_type);
414 db_print_sotype(so->so_type);
415 db_printf(")\n");
416
417 db_print_indent(indent);
418 db_printf("so_options: 0x%x (", so->so_options);
419 db_print_sooptions(so->so_options);
420 db_printf(")\n");
421
422 db_print_indent(indent);
423 db_printf("so_linger: %d ", so->so_linger);
424 db_printf("so_state: 0x%x (", so->so_state);
425 db_print_sostate(so->so_state);
426 db_printf(")\n");
427
428 db_print_indent(indent);
429 db_printf("so_pcb: %p ", so->so_pcb);
430 db_printf("so_proto: %p\n", so->so_proto);
431
432 if (so->so_proto != NULL)
433 db_print_protosw(so->so_proto, "so_proto", indent);
434
435 db_print_indent(indent);
436 if (so->so_options & SO_ACCEPTCONN) {
437 db_printf("sol_incomp first: %p ",
438 TAILQ_FIRST(&so->sol_incomp));
439 db_printf("sol_comp first: %p\n", TAILQ_FIRST(&so->sol_comp));
440 db_printf("sol_qlen: %d ", so->sol_qlen);
441 db_printf("sol_incqlen: %d ", so->sol_incqlen);
442 db_printf("sol_qlimit: %d ", so->sol_qlimit);
443 } else {
444 db_printf("so_qstate: 0x%x (", so->so_qstate);
445 db_print_soqstate(so->so_qstate);
446 db_printf(") ");
447 db_printf("so_listen: %p ", so->so_listen);
448 /* so_list skipped */
449 db_printf("so_timeo: %d ", so->so_timeo);
450 db_printf("so_error: %d\n", so->so_error);
451
452 db_print_indent(indent);
453 db_printf("so_sigio: %p ", so->so_sigio);
454 db_printf("so_oobmark: %lu\n", so->so_oobmark);
455
456 db_print_sockbuf(&so->so_rcv, "so_rcv", indent);
457 db_print_sockbuf(&so->so_snd, "so_snd", indent);
458 }
459 }
460
DB_SHOW_COMMAND(socket,db_show_socket)461 DB_SHOW_COMMAND(socket, db_show_socket)
462 {
463 struct socket *so;
464
465 if (!have_addr) {
466 db_printf("usage: show socket <addr>\n");
467 return;
468 }
469 so = (struct socket *)addr;
470
471 db_print_socket(so, "socket", 0);
472 }
473
DB_SHOW_COMMAND(sockbuf,db_show_sockbuf)474 DB_SHOW_COMMAND(sockbuf, db_show_sockbuf)
475 {
476 struct sockbuf *sb;
477
478 if (!have_addr) {
479 db_printf("usage: show sockbuf <addr>\n");
480 return;
481 }
482 sb = (struct sockbuf *)addr;
483
484 db_print_sockbuf(sb, "sockbuf", 0);
485 }
486
DB_SHOW_COMMAND(protosw,db_show_protosw)487 DB_SHOW_COMMAND(protosw, db_show_protosw)
488 {
489 struct protosw *pr;
490
491 if (!have_addr) {
492 db_printf("usage: show protosw <addr>\n");
493 return;
494 }
495 pr = (struct protosw *)addr;
496
497 db_print_protosw(pr, "protosw", 0);
498 }
499
DB_SHOW_COMMAND(domain,db_show_domain)500 DB_SHOW_COMMAND(domain, db_show_domain)
501 {
502 struct domain *d;
503
504 if (!have_addr) {
505 db_printf("usage: show protosw <addr>\n");
506 return;
507 }
508 d = (struct domain *)addr;
509
510 db_print_domain(d, "domain", 0);
511 }
512 #endif
513