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(short 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_TIMESTAMP) { 126 db_printf("%sSO_TIMESTAMP", comma ? ", " : ""); 127 comma = 1; 128 } 129 if (so_options & SO_NOSIGPIPE) { 130 db_printf("%sSO_NOSIGPIPE", comma ? ", " : ""); 131 comma = 1; 132 } 133 if (so_options & SO_ACCEPTFILTER) { 134 db_printf("%sSO_ACCEPTFILTER", comma ? ", " : ""); 135 comma = 1; 136 } 137 if (so_options & SO_BINTIME) { 138 db_printf("%sSO_BINTIME", comma ? ", " : ""); 139 comma = 1; 140 } 141 if (so_options & SO_NO_OFFLOAD) { 142 db_printf("%sSO_NO_OFFLOAD", comma ? ", " : ""); 143 comma = 1; 144 } 145 if (so_options & SO_NO_DDP) { 146 db_printf("%sSO_NO_DDP", comma ? ", " : ""); 147 comma = 1; 148 } 149 } 150 151 static void 152 db_print_sostate(short so_state) 153 { 154 int comma; 155 156 comma = 0; 157 if (so_state & SS_NOFDREF) { 158 db_printf("%sSS_NOFDREF", comma ? ", " : ""); 159 comma = 1; 160 } 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 if (so_state & SS_PROTOREF) { 186 db_printf("%sSS_PROTOREF", comma ? ", " : ""); 187 comma = 1; 188 } 189 } 190 191 static void 192 db_print_soqstate(int so_qstate) 193 { 194 int comma; 195 196 comma = 0; 197 if (so_qstate & SQ_INCOMP) { 198 db_printf("%sSQ_INCOMP", comma ? ", " : ""); 199 comma = 1; 200 } 201 if (so_qstate & SQ_COMP) { 202 db_printf("%sSQ_COMP", comma ? ", " : ""); 203 comma = 1; 204 } 205 } 206 207 static void 208 db_print_sbstate(short sb_state) 209 { 210 int comma; 211 212 comma = 0; 213 if (sb_state & SBS_CANTSENDMORE) { 214 db_printf("%sSBS_CANTSENDMORE", comma ? ", " : ""); 215 comma = 1; 216 } 217 if (sb_state & SBS_CANTRCVMORE) { 218 db_printf("%sSBS_CANTRCVMORE", comma ? ", " : ""); 219 comma = 1; 220 } 221 if (sb_state & SBS_RCVATMARK) { 222 db_printf("%sSBS_RCVATMARK", comma ? ", " : ""); 223 comma = 1; 224 } 225 } 226 227 static void 228 db_print_indent(int indent) 229 { 230 int i; 231 232 for (i = 0; i < indent; i++) 233 db_printf(" "); 234 } 235 236 static void 237 db_print_domain(struct domain *d, const char *domain_name, int indent) 238 { 239 240 db_print_indent(indent); 241 db_printf("%s at %p\n", domain_name, d); 242 243 indent += 2; 244 245 db_print_indent(indent); 246 db_printf("dom_family: %d ", d->dom_family); 247 db_printf("dom_name: %s\n", d->dom_name); 248 249 db_print_indent(indent); 250 db_printf("dom_init: %p ", d->dom_init); 251 db_printf("dom_externalize: %p ", d->dom_externalize); 252 db_printf("dom_dispose: %p\n", d->dom_dispose); 253 254 db_print_indent(indent); 255 db_printf("dom_protosw: %p ", d->dom_protosw); 256 db_printf("dom_next: %p\n", d->dom_next); 257 258 db_print_indent(indent); 259 db_printf("dom_rtattach: %p ", d->dom_rtattach); 260 261 db_print_indent(indent); 262 db_printf("dom_ifattach: %p ", d->dom_ifattach); 263 db_printf("dom_ifdetach: %p\n", d->dom_ifdetach); 264 } 265 266 static void 267 db_print_prflags(short pr_flags) 268 { 269 int comma; 270 271 comma = 0; 272 if (pr_flags & PR_ATOMIC) { 273 db_printf("%sPR_ATOMIC", comma ? ", " : ""); 274 comma = 1; 275 } 276 if (pr_flags & PR_ADDR) { 277 db_printf("%sPR_ADDR", comma ? ", " : ""); 278 comma = 1; 279 } 280 if (pr_flags & PR_CONNREQUIRED) { 281 db_printf("%sPR_CONNREQUIRED", comma ? ", " : ""); 282 comma = 1; 283 } 284 if (pr_flags & PR_WANTRCVD) { 285 db_printf("%sPR_WANTRCVD", comma ? ", " : ""); 286 comma = 1; 287 } 288 if (pr_flags & PR_RIGHTS) { 289 db_printf("%sPR_RIGHTS", comma ? ", " : ""); 290 comma = 1; 291 } 292 if (pr_flags & PR_IMPLOPCL) { 293 db_printf("%sPR_IMPLOPCL", comma ? ", " : ""); 294 comma = 1; 295 } 296 if (pr_flags & PR_LASTHDR) { 297 db_printf("%sPR_LASTHDR", comma ? ", " : ""); 298 comma = 1; 299 } 300 } 301 302 static void 303 db_print_protosw(struct protosw *pr, const char *prname, int indent) 304 { 305 306 db_print_indent(indent); 307 db_printf("%s at %p\n", prname, pr); 308 309 indent += 2; 310 311 db_print_indent(indent); 312 db_printf("pr_type: %d ", pr->pr_type); 313 db_printf("pr_domain: %p\n", pr->pr_domain); 314 if (pr->pr_domain != NULL) 315 db_print_domain(pr->pr_domain, "pr_domain", indent); 316 317 db_print_indent(indent); 318 db_printf("pr_protocol: %d\n", pr->pr_protocol); 319 320 db_print_indent(indent); 321 db_printf("pr_flags: %d (", pr->pr_flags); 322 db_print_prflags(pr->pr_flags); 323 db_printf(")\n"); 324 325 db_print_indent(indent); 326 db_printf("pr_input: %p ", pr->pr_input); 327 db_printf("pr_output: %p ", pr->pr_output); 328 db_printf("pr_ctlinput: %p\n", pr->pr_ctlinput); 329 330 db_print_indent(indent); 331 db_printf("pr_ctloutput: %p ", pr->pr_ctloutput); 332 db_printf("pr_init: %p\n", pr->pr_init); 333 334 db_print_indent(indent); 335 db_printf("pr_fasttimo: %p ", pr->pr_fasttimo); 336 db_printf("pr_slowtimo: %p ", pr->pr_slowtimo); 337 db_printf("pr_drain: %p\n", pr->pr_drain); 338 } 339 340 static void 341 db_print_sbflags(short sb_flags) 342 { 343 int comma; 344 345 comma = 0; 346 if (sb_flags & SB_WAIT) { 347 db_printf("%sSB_WAIT", comma ? ", " : ""); 348 comma = 1; 349 } 350 if (sb_flags & SB_SEL) { 351 db_printf("%sSB_SEL", comma ? ", " : ""); 352 comma = 1; 353 } 354 if (sb_flags & SB_ASYNC) { 355 db_printf("%sSB_ASYNC", comma ? ", " : ""); 356 comma = 1; 357 } 358 if (sb_flags & SB_UPCALL) { 359 db_printf("%sSB_UPCALL", comma ? ", " : ""); 360 comma = 1; 361 } 362 if (sb_flags & SB_NOINTR) { 363 db_printf("%sSB_NOINTR", comma ? ", " : ""); 364 comma = 1; 365 } 366 if (sb_flags & SB_AIO) { 367 db_printf("%sSB_AIO", comma ? ", " : ""); 368 comma = 1; 369 } 370 if (sb_flags & SB_KNOTE) { 371 db_printf("%sSB_KNOTE", comma ? ", " : ""); 372 comma = 1; 373 } 374 if (sb_flags & SB_AUTOSIZE) { 375 db_printf("%sSB_AUTOSIZE", comma ? ", " : ""); 376 comma = 1; 377 } 378 } 379 380 static void 381 db_print_sockbuf(struct sockbuf *sb, const char *sockbufname, int indent) 382 { 383 384 db_print_indent(indent); 385 db_printf("%s at %p\n", sockbufname, sb); 386 387 indent += 2; 388 389 db_print_indent(indent); 390 db_printf("sb_state: 0x%x (", sb->sb_state); 391 db_print_sbstate(sb->sb_state); 392 db_printf(")\n"); 393 394 db_print_indent(indent); 395 db_printf("sb_mb: %p ", sb->sb_mb); 396 db_printf("sb_mbtail: %p ", sb->sb_mbtail); 397 db_printf("sb_lastrecord: %p\n", sb->sb_lastrecord); 398 399 db_print_indent(indent); 400 db_printf("sb_sndptr: %p ", sb->sb_sndptr); 401 db_printf("sb_sndptroff: %u\n", sb->sb_sndptroff); 402 403 db_print_indent(indent); 404 db_printf("sb_acc: %u ", sb->sb_acc); 405 db_printf("sb_ccc: %u ", sb->sb_ccc); 406 db_printf("sb_hiwat: %u ", sb->sb_hiwat); 407 db_printf("sb_mbcnt: %u ", sb->sb_mbcnt); 408 db_printf("sb_mbmax: %u\n", sb->sb_mbmax); 409 410 db_print_indent(indent); 411 db_printf("sb_mcnt: %u ", sb->sb_mcnt); 412 db_printf("sb_ccnt: %u ", sb->sb_ccnt); 413 db_printf("sb_ctl: %u ", sb->sb_ctl); 414 db_printf("sb_lowat: %d ", sb->sb_lowat); 415 db_printf("sb_timeo: %jd\n", sb->sb_timeo); 416 417 db_print_indent(indent); 418 db_printf("sb_flags: 0x%x (", sb->sb_flags); 419 db_print_sbflags(sb->sb_flags); 420 db_printf(")\n"); 421 422 db_print_indent(indent); 423 db_printf("sb_aiojobq first: %p\n", TAILQ_FIRST(&sb->sb_aiojobq)); 424 } 425 426 static void 427 db_print_socket(struct socket *so, const char *socketname, int indent) 428 { 429 430 db_print_indent(indent); 431 db_printf("%s at %p\n", socketname, so); 432 433 indent += 2; 434 435 db_print_indent(indent); 436 db_printf("so_count: %d ", so->so_count); 437 db_printf("so_type: %d (", so->so_type); 438 db_print_sotype(so->so_type); 439 db_printf(")\n"); 440 441 db_print_indent(indent); 442 db_printf("so_options: 0x%x (", so->so_options); 443 db_print_sooptions(so->so_options); 444 db_printf(")\n"); 445 446 db_print_indent(indent); 447 db_printf("so_linger: %d ", so->so_linger); 448 db_printf("so_state: 0x%x (", so->so_state); 449 db_print_sostate(so->so_state); 450 db_printf(")\n"); 451 452 db_print_indent(indent); 453 db_printf("so_pcb: %p ", so->so_pcb); 454 db_printf("so_proto: %p\n", so->so_proto); 455 456 if (so->so_proto != NULL) 457 db_print_protosw(so->so_proto, "so_proto", indent); 458 459 db_print_indent(indent); 460 if (so->so_options & SO_ACCEPTCONN) { 461 db_printf("sol_incomp first: %p ", 462 TAILQ_FIRST(&so->sol_incomp)); 463 db_printf("sol_comp first: %p\n", TAILQ_FIRST(&so->sol_comp)); 464 db_printf("sol_qlen: %d ", so->sol_qlen); 465 db_printf("sol_incqlen: %d ", so->sol_incqlen); 466 db_printf("sol_qlimit: %d ", so->sol_qlimit); 467 } else { 468 db_printf("so_qstate: 0x%x (", so->so_qstate); 469 db_print_soqstate(so->so_qstate); 470 db_printf(") "); 471 db_printf("so_listen: %p ", so->so_listen); 472 /* so_list skipped */ 473 db_printf("so_timeo: %d ", so->so_timeo); 474 db_printf("so_error: %d\n", so->so_error); 475 476 db_print_indent(indent); 477 db_printf("so_sigio: %p ", so->so_sigio); 478 db_printf("so_oobmark: %lu\n", so->so_oobmark); 479 480 db_print_sockbuf(&so->so_rcv, "so_rcv", indent); 481 db_print_sockbuf(&so->so_snd, "so_snd", indent); 482 } 483 } 484 485 DB_SHOW_COMMAND(socket, db_show_socket) 486 { 487 struct socket *so; 488 489 if (!have_addr) { 490 db_printf("usage: show socket <addr>\n"); 491 return; 492 } 493 so = (struct socket *)addr; 494 495 db_print_socket(so, "socket", 0); 496 } 497 498 DB_SHOW_COMMAND(sockbuf, db_show_sockbuf) 499 { 500 struct sockbuf *sb; 501 502 if (!have_addr) { 503 db_printf("usage: show sockbuf <addr>\n"); 504 return; 505 } 506 sb = (struct sockbuf *)addr; 507 508 db_print_sockbuf(sb, "sockbuf", 0); 509 } 510 511 DB_SHOW_COMMAND(protosw, db_show_protosw) 512 { 513 struct protosw *pr; 514 515 if (!have_addr) { 516 db_printf("usage: show protosw <addr>\n"); 517 return; 518 } 519 pr = (struct protosw *)addr; 520 521 db_print_protosw(pr, "protosw", 0); 522 } 523 524 DB_SHOW_COMMAND(domain, db_show_domain) 525 { 526 struct domain *d; 527 528 if (!have_addr) { 529 db_printf("usage: show protosw <addr>\n"); 530 return; 531 } 532 d = (struct domain *)addr; 533 534 db_print_domain(d, "domain", 0); 535 } 536 #endif 537