sys/ddb/db_ps.c

   1 /*-
   2  * Copyright (c) 1993 The Regents of the University of California.
   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  * 4. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 #include <sys/cdefs.h>
  31 __FBSDID("$FreeBSD$");
  32
  33 #include <sys/param.h>
  34 #include <sys/cons.h>
  35 #include <sys/jail.h>
  36 #include <sys/kdb.h>
  37 #include <sys/proc.h>
  38 #include <sys/sysent.h>
  39 #include <sys/systm.h>
  40 #include <sys/_kstack_cache.h>
  41 #include <vm/vm.h>
  42 #include <vm/vm_param.h>
  43 #include <vm/pmap.h>
  44
  45 #include <ddb/ddb.h>
  46
  47 static void     dumpthread(volatile struct proc *p, volatile struct thread *td,
  48                     int all);
  49 /*
  50  * At least one non-optional show-command must be implemented using
  51  * DB_SHOW_ALL_COMMAND() so that db_show_all_cmd_set gets created.
  52  * Here is one.
  53  */
  54 DB_SHOW_ALL_COMMAND(procs, db_procs_cmd)
  55 {
  56         db_ps(addr, have_addr, count, modif);
  57 }
  58
  59 /*
  60  * Layout:
  61  * - column counts
  62  * - header
  63  * - single-threaded process
  64  * - multi-threaded process
  65  * - thread in a MT process
  66  *
  67  *          1         2         3         4         5         6         7
  68  * 1234567890123456789012345678901234567890123456789012345678901234567890
  69  *   pid  ppid  pgrp   uid   state   wmesg     wchan    cmd
  70  * <pid> <ppi> <pgi> <uid>  <stat> < wmesg > < wchan  > <name>
  71  * <pid> <ppi> <pgi> <uid>  <stat>  (threaded)          <command>
  72  * <tid >                   <stat> < wmesg > < wchan  > <name>
  73  *
  74  * For machines with 64-bit pointers, we expand the wchan field 8 more
  75  * characters.
  76  */
  77 void
  78 db_ps(db_expr_t addr, boolean_t hasaddr, db_expr_t count, char *modif)
  79 {
  80         volatile struct proc *p, *pp;
  81         volatile struct thread *td;
  82         struct ucred *cred;
  83         struct pgrp *pgrp;
  84         char state[9];
  85         int np, rflag, sflag, dflag, lflag, wflag;
  86
  87         np = nprocs;
  88
  89         if (!LIST_EMPTY(&allproc))
  90                 p = LIST_FIRST(&allproc);
  91         else
  92                 p = &proc0;
  93
  94 #ifdef __LP64__
  95         db_printf("  pid  ppid  pgrp   uid   state   wmesg         wchan        cmd\n");
  96 #else
  97         db_printf("  pid  ppid  pgrp   uid   state   wmesg     wchan    cmd\n");
  98 #endif
  99         while (--np >= 0 && !db_pager_quit) {
 100                 if (p == NULL) {
 101                         db_printf("oops, ran out of processes early!\n");
 102                         break;
 103                 }
 104                 pp = p->p_pptr;
 105                 if (pp == NULL)
 106                         pp = p;
 107
 108                 cred = p->p_ucred;
 109                 pgrp = p->p_pgrp;
 110                 db_printf("%5d %5d %5d %5d ", p->p_pid, pp->p_pid,
 111                     pgrp != NULL ? pgrp->pg_id : 0,
 112                     cred != NULL ? cred->cr_ruid : 0);
 113
 114                 /* Determine our primary process state. */
 115                 switch (p->p_state) {
 116                 case PRS_NORMAL:
 117                         if (P_SHOULDSTOP(p))
 118                                 state[0] = 'T';
 119                         else {
 120                                 /*
 121                                  * One of D, L, R, S, W.  For a
 122                                  * multithreaded process we will use
 123                                  * the state of the thread with the
 124                                  * highest precedence.  The
 125                                  * precendence order from high to low
 126                                  * is R, L, D, S, W.  If no thread is
 127                                  * in a sane state we use '?' for our
 128                                  * primary state.
 129                                  */
 130                                 rflag = sflag = dflag = lflag = wflag = 0;
 131                                 FOREACH_THREAD_IN_PROC(p, td) {
 132                                         if (td->td_state == TDS_RUNNING ||
 133                                             td->td_state == TDS_RUNQ ||
 134                                             td->td_state == TDS_CAN_RUN)
 135                                                 rflag++;
 136                                         if (TD_ON_LOCK(td))
 137                                                 lflag++;
 138                                         if (TD_IS_SLEEPING(td)) {
 139                                                 if (!(td->td_flags & TDF_SINTR))
 140                                                         dflag++;
 141                                                 else
 142                                                         sflag++;
 143                                         }
 144                                         if (TD_AWAITING_INTR(td))
 145                                                 wflag++;
 146                                 }
 147                                 if (rflag)
 148                                         state[0] = 'R';
 149                                 else if (lflag)
 150                                         state[0] = 'L';
 151                                 else if (dflag)
 152                                         state[0] = 'D';
 153                                 else if (sflag)
 154                                         state[0] = 'S';
 155                                 else if (wflag)
 156                                         state[0] = 'W';
 157                                 else
 158                                         state[0] = '?';
 159                         }
 160                         break;
 161                 case PRS_NEW:
 162                         state[0] = 'N';
 163                         break;
 164                 case PRS_ZOMBIE:
 165                         state[0] = 'Z';
 166                         break;
 167                 default:
 168                         state[0] = 'U';
 169                         break;
 170                 }
 171                 state[1] = '\0';
 172
 173                 /* Additional process state flags. */
 174                 if (!(p->p_flag & P_INMEM))
 175                         strlcat(state, "W", sizeof(state));
 176                 if (p->p_flag & P_TRACED)
 177                         strlcat(state, "X", sizeof(state));
 178                 if (p->p_flag & P_WEXIT && p->p_state != PRS_ZOMBIE)
 179                         strlcat(state, "E", sizeof(state));
 180                 if (p->p_flag & P_PPWAIT)
 181                         strlcat(state, "V", sizeof(state));
 182                 if (p->p_flag & P_SYSTEM || p->p_lock > 0)
 183                         strlcat(state, "L", sizeof(state));
 184                 if (p->p_pgrp != NULL && p->p_session != NULL &&
 185                     SESS_LEADER(p))
 186                         strlcat(state, "s", sizeof(state));
 187                 /* Cheated here and didn't compare pgid's. */
 188                 if (p->p_flag & P_CONTROLT)
 189                         strlcat(state, "+", sizeof(state));
 190                 if (cred != NULL && jailed(cred))
 191                         strlcat(state, "J", sizeof(state));
 192                 db_printf(" %-6.6s ", state);
 193                 if (p->p_flag & P_HADTHREADS) {
 194 #ifdef __LP64__
 195                         db_printf(" (threaded)                  ");
 196 #else
 197                         db_printf(" (threaded)          ");
 198 #endif
 199                         if (p->p_flag & P_SYSTEM)
 200                                 db_printf("[");
 201                         db_printf("%s", p->p_comm);
 202                         if (p->p_flag & P_SYSTEM)
 203                                 db_printf("]");
 204                         db_printf("\n");
 205                 }
 206                 FOREACH_THREAD_IN_PROC(p, td) {
 207                         dumpthread(p, td, p->p_flag & P_HADTHREADS);
 208                         if (db_pager_quit)
 209                                 break;
 210                 }
 211
 212                 p = LIST_NEXT(p, p_list);
 213                 if (p == NULL && np > 0)
 214                         p = LIST_FIRST(&zombproc);
 215         }
 216 }
 217
 218 static void
 219 dumpthread(volatile struct proc *p, volatile struct thread *td, int all)
 220 {
 221         char state[9], wprefix;
 222         const char *wmesg;
 223         void *wchan;
 224
 225         if (all) {
 226                 db_printf("%6d                  ", td->td_tid);
 227                 switch (td->td_state) {
 228                 case TDS_RUNNING:
 229                         snprintf(state, sizeof(state), "Run");
 230                         break;
 231                 case TDS_RUNQ:
 232                         snprintf(state, sizeof(state), "RunQ");
 233                         break;
 234                 case TDS_CAN_RUN:
 235                         snprintf(state, sizeof(state), "CanRun");
 236                         break;
 237                 case TDS_INACTIVE:
 238                         snprintf(state, sizeof(state), "Inactv");
 239                         break;
 240                 case TDS_INHIBITED:
 241                         state[0] = '\0';
 242                         if (TD_ON_LOCK(td))
 243                                 strlcat(state, "L", sizeof(state));
 244                         if (TD_IS_SLEEPING(td)) {
 245                                 if (td->td_flags & TDF_SINTR)
 246                                         strlcat(state, "S", sizeof(state));
 247                                 else
 248                                         strlcat(state, "D", sizeof(state));
 249                         }
 250                         if (TD_IS_SWAPPED(td))
 251                                 strlcat(state, "W", sizeof(state));
 252                         if (TD_AWAITING_INTR(td))
 253                                 strlcat(state, "I", sizeof(state));
 254                         if (TD_IS_SUSPENDED(td))
 255                                 strlcat(state, "s", sizeof(state));
 256                         if (state[0] != '\0')
 257                                 break;
 258                 default:
 259                         snprintf(state, sizeof(state), "???");
 260                 }
 261                 db_printf(" %-6.6s ", state);
 262         }
 263         wprefix = ' ';
 264         if (TD_ON_LOCK(td)) {
 265                 wprefix = '*';
 266                 wmesg = td->td_lockname;
 267                 wchan = td->td_blocked;
 268         } else if (TD_ON_SLEEPQ(td)) {
 269                 wmesg = td->td_wmesg;
 270                 wchan = td->td_wchan;
 271         } else if (TD_IS_RUNNING(td)) {
 272                 snprintf(state, sizeof(state), "CPU %d", td->td_oncpu);
 273                 wmesg = state;
 274                 wchan = NULL;
 275         } else {
 276                 wmesg = "";
 277                 wchan = NULL;
 278         }
 279         db_printf("%c%-8.8s ", wprefix, wmesg);
 280         if (wchan == NULL)
 281 #ifdef __LP64__
 282                 db_printf("%18s ", "");
 283 #else
 284                 db_printf("%10s ", "");
 285 #endif
 286         else
 287                 db_printf("%p ", wchan);
 288         if (p->p_flag & P_SYSTEM)
 289                 db_printf("[");
 290         if (td->td_name[0] != '\0')
 291                 db_printf("%s", td->td_name);
 292         else
 293                 db_printf("%s", td->td_proc->p_comm);
 294         if (p->p_flag & P_SYSTEM)
 295                 db_printf("]");
 296         db_printf("\n");
 297 }
 298
 299 DB_SHOW_COMMAND(thread, db_show_thread)
 300 {
 301         struct thread *td;
 302         struct lock_object *lock;
 303         boolean_t comma;
 304
 305         /* Determine which thread to examine. */
 306         if (have_addr)
 307                 td = db_lookup_thread(addr, FALSE);
 308         else
 309                 td = kdb_thread;
 310         lock = (struct lock_object *)td->td_lock;
 311
 312         db_printf("Thread %d at %p:\n", td->td_tid, td);
 313         db_printf(" proc (pid %d): %p\n", td->td_proc->p_pid, td->td_proc);
 314         if (td->td_name[0] != '\0')
 315                 db_printf(" name: %s\n", td->td_name);
 316         db_printf(" stack: %p-%p\n", (void *)td->td_kstack,
 317             (void *)(td->td_kstack + td->td_kstack_pages * PAGE_SIZE - 1));
 318         db_printf(" flags: %#x ", td->td_flags);
 319         db_printf(" pflags: %#x\n", td->td_pflags);
 320         db_printf(" state: ");
 321         switch (td->td_state) {
 322         case TDS_INACTIVE:
 323                 db_printf("INACTIVE\n");
 324                 break;
 325         case TDS_CAN_RUN:
 326                 db_printf("CAN RUN\n");
 327                 break;
 328         case TDS_RUNQ:
 329                 db_printf("RUNQ\n");
 330                 break;
 331         case TDS_RUNNING:
 332                 db_printf("RUNNING (CPU %d)\n", td->td_oncpu);
 333                 break;
 334         case TDS_INHIBITED:
 335                 db_printf("INHIBITED: {");
 336                 comma = FALSE;
 337                 if (TD_IS_SLEEPING(td)) {
 338                         db_printf("SLEEPING");
 339                         comma = TRUE;
 340                 }
 341                 if (TD_IS_SUSPENDED(td)) {
 342                         if (comma)
 343                                 db_printf(", ");
 344                         db_printf("SUSPENDED");
 345                         comma = TRUE;
 346                 }
 347                 if (TD_IS_SWAPPED(td)) {
 348                         if (comma)
 349                                 db_printf(", ");
 350                         db_printf("SWAPPED");
 351                         comma = TRUE;
 352                 }
 353                 if (TD_ON_LOCK(td)) {
 354                         if (comma)
 355                                 db_printf(", ");
 356                         db_printf("LOCK");
 357                         comma = TRUE;
 358                 }
 359                 if (TD_AWAITING_INTR(td)) {
 360                         if (comma)
 361                                 db_printf(", ");
 362                         db_printf("IWAIT");
 363                 }
 364                 db_printf("}\n");
 365                 break;
 366         default:
 367                 db_printf("??? (%#x)\n", td->td_state);
 368                 break;
 369         }
 370         if (TD_ON_LOCK(td))
 371                 db_printf(" lock: %s  turnstile: %p\n", td->td_lockname,
 372                     td->td_blocked);
 373         if (TD_ON_SLEEPQ(td))
 374                 db_printf(" wmesg: %s  wchan: %p\n", td->td_wmesg,
 375                     td->td_wchan);
 376         db_printf(" priority: %d\n", td->td_priority);
 377         db_printf(" container lock: %s (%p)\n", lock->lo_name, lock);
 378 }
 379
 380 DB_SHOW_COMMAND(proc, db_show_proc)
 381 {
 382         struct thread *td;
 383         struct proc *p;
 384         int i;
 385
 386         /* Determine which process to examine. */
 387         if (have_addr)
 388                 p = db_lookup_proc(addr);
 389         else
 390                 p = kdb_thread->td_proc;
 391
 392         db_printf("Process %d (%s) at %p:\n", p->p_pid, p->p_comm, p);
 393         db_printf(" state: ");
 394         switch (p->p_state) {
 395         case PRS_NEW:
 396                 db_printf("NEW\n");
 397                 break;
 398         case PRS_NORMAL:
 399                 db_printf("NORMAL\n");
 400                 break;
 401         case PRS_ZOMBIE:
 402                 db_printf("ZOMBIE\n");
 403                 break;
 404         default:
 405                 db_printf("??? (%#x)\n", p->p_state);
 406         }
 407         if (p->p_ucred != NULL) {
 408                 db_printf(" uid: %d  gids: ", p->p_ucred->cr_uid);
 409                 for (i = 0; i < p->p_ucred->cr_ngroups; i++) {
 410                         db_printf("%d", p->p_ucred->cr_groups[i]);
 411                         if (i < (p->p_ucred->cr_ngroups - 1))
 412                                 db_printf(", ");
 413                 }
 414                 db_printf("\n");
 415         }
 416         if (p->p_pptr != NULL)
 417                 db_printf(" parent: pid %d at %p\n", p->p_pptr->p_pid,
 418                     p->p_pptr);
 419         if (p->p_leader != NULL && p->p_leader != p)
 420                 db_printf(" leader: pid %d at %p\n", p->p_leader->p_pid,
 421                     p->p_leader);
 422         if (p->p_sysent != NULL)
 423                 db_printf(" ABI: %s\n", p->p_sysent->sv_name);
 424         if (p->p_args != NULL)
 425                 db_printf(" arguments: %.*s\n", (int)p->p_args->ar_length,
 426                     p->p_args->ar_args);
 427         db_printf(" threads: %d\n", p->p_numthreads);
 428         FOREACH_THREAD_IN_PROC(p, td) {
 429                 dumpthread(p, td, 1);
 430                 if (db_pager_quit)
 431                         break;
 432         }
 433 }
 434
 435 void
 436 db_findstack_cmd(db_expr_t addr, boolean_t have_addr,
 437     db_expr_t dummy3 __unused, char *dummy4 __unused)
 438 {
 439         struct proc *p;
 440         struct thread *td;
 441         struct kstack_cache_entry *ks_ce;
 442         vm_offset_t saddr;
 443
 444         if (have_addr)
 445                 saddr = addr;
 446         else {
 447                 db_printf("Usage: findstack <address>\n");
 448                 return;
 449         }
 450
 451         FOREACH_PROC_IN_SYSTEM(p) {
 452                 FOREACH_THREAD_IN_PROC(p, td) {
 453                         if (td->td_kstack <= saddr && saddr < td->td_kstack +
 454                             PAGE_SIZE * td->td_kstack_pages) {
 455                                 db_printf("Thread %p\n", td);
 456                                 return;
 457                         }
 458                 }
 459         }
 460
 461         for (ks_ce = kstack_cache; ks_ce != NULL;
 462              ks_ce = ks_ce->next_ks_entry) {
 463                 if ((vm_offset_t)ks_ce <= saddr && saddr < (vm_offset_t)ks_ce +
 464                     PAGE_SIZE * KSTACK_PAGES) {
 465                         db_printf("Cached stack %p\n", ks_ce);
 466                         return;
 467                 }
 468         }
 469 }