2 * Copyright (c) 1989, 1992, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software developed by the Computer Systems
6 * Engineering group at Lawrence Berkeley Laboratory under DARPA contract
7 * BG 91-66 and contributed to Berkeley.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. All advertising materials mentioning features or use of this software
18 * must display the following acknowledgement:
19 * This product includes software developed by the University of
20 * California, Berkeley and its contributors.
21 * 4. Neither the name of the University nor the names of its contributors
22 * may be used to endorse or promote products derived from this software
23 * without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * $FreeBSD: src/lib/libkvm/kvm_proc.c,v 1.25.2.3 2002/08/24 07:27:46 kris Exp $
39 * @(#)kvm_proc.c 8.3 (Berkeley) 9/23/93
43 * Proc traversal interface for kvm. ps and w are (probably) the exclusive
44 * users of this code, so we've factored it out into a separate module.
45 * Thus, we keep this grunge out of the other kvm applications (i.e.,
46 * most other applications are interested only in open/close/read/nlist).
49 #include <sys/user.h> /* MUST BE FIRST */
51 #include <sys/param.h>
55 #include <sys/globaldata.h>
56 #include <sys/ioctl.h>
67 #include <vm/vm_param.h>
68 #include <vm/swap_pager.h>
70 #include <sys/sysctl.h>
76 #include "kvm_private.h"
80 kvm_readswap(kvm_t *kd, const struct proc *p, u_long va, u_long *cnt)
82 #if defined(__FreeBSD__) || defined(__DragonFly__)
83 /* XXX Stubbed out, our vm system is differnet */
84 _kvm_err(kd, kd->program, "kvm_readswap not implemented");
90 #define KREAD(kd, addr, obj) \
91 (kvm_read(kd, addr, (char *)(obj), sizeof(*obj)) != sizeof(*obj))
92 #define KREADSTR(kd, addr) \
93 kvm_readstr(kd, (u_long)addr, NULL, NULL)
95 static struct kinfo_proc *
96 kinfo_resize_proc(kvm_t *kd, struct kinfo_proc *bp)
101 size_t pos = bp - kd->procend;
102 size_t size = kd->procend - kd->procbase;
108 kd->procbase = _kvm_realloc(kd, kd->procbase, sizeof(*bp) * size);
109 if (kd->procbase == NULL)
111 kd->procend = kd->procbase + size;
112 bp = kd->procbase + pos;
117 * note: this function is also used by /usr/src/sys/kern/kern_kinfo.c as
118 * compiled by userland.
125 if ((dev->si_umajor & 0xffffff00) ||
126 (dev->si_uminor & 0x0000ff00)) {
129 return((dev->si_umajor << 8) | dev->si_uminor);
133 * Helper routine which traverses the left hand side of a red-black sub-tree.
136 kvm_lwptraverse(kvm_t *kd, struct lwp *lwp, uintptr_t lwppos)
139 if (KREAD(kd, lwppos, lwp)) {
140 _kvm_err(kd, kd->program, "can't read lwp at %p",
142 return ((uintptr_t)-1);
144 if (lwp->u.lwp_rbnode.rbe_left == NULL)
146 lwppos = (uintptr_t)lwp->u.lwp_rbnode.rbe_left;
152 * Iterate LWPs in a process.
154 * The first lwp in a red-black tree is a left-side traversal of the tree.
157 kvm_firstlwp(kvm_t *kd, struct lwp *lwp, struct proc *proc)
159 return(kvm_lwptraverse(kd, lwp, (uintptr_t)proc->p_lwp_tree.rbh_root));
163 * If the current element is the left side of the parent the next element
164 * will be a left side traversal of the parent's right side. If the parent
165 * has no right side the next element will be the parent.
167 * If the current element is the right side of the parent the next element
170 * If the parent is NULL we are done.
173 kvm_nextlwp(kvm_t *kd, uintptr_t lwppos, struct lwp *lwp, struct proc *proc)
177 nextpos = (uintptr_t)lwp->u.lwp_rbnode.rbe_parent;
179 if (KREAD(kd, nextpos, lwp)) {
180 _kvm_err(kd, kd->program, "can't read lwp at %p",
182 return ((uintptr_t)-1);
184 if (lwppos == (uintptr_t)lwp->u.lwp_rbnode.rbe_left) {
186 * If we had gone down the left side the next element
187 * is a left hand traversal of the parent's right
188 * side, or the parent itself if there is no right
191 lwppos = (uintptr_t)lwp->u.lwp_rbnode.rbe_right;
193 nextpos = kvm_lwptraverse(kd, lwp, lwppos);
196 * If we had gone down the right side the next
197 * element is the parent.
199 /* nextpos = nextpos */
206 * Read proc's from memory file into buffer bp, which has space to hold
207 * at most maxcnt procs.
210 kvm_proclist(kvm_t *kd, int what, int arg, struct proc *p,
211 struct kinfo_proc *bp)
215 struct globaldata gdata;
217 struct session tsess;
221 struct thread thread;
224 struct vmspace vmspace;
225 struct prison prison;
226 struct sigacts sigacts;
234 for (; p != NULL; p = proc.p_list.le_next) {
235 if (KREAD(kd, (u_long)p, &proc)) {
236 _kvm_err(kd, kd->program, "can't read proc at %p", p);
239 if (KREAD(kd, (u_long)proc.p_ucred, &ucred)) {
240 _kvm_err(kd, kd->program, "can't read ucred at %p",
244 proc.p_ucred = &ucred;
246 switch(what & ~KERN_PROC_FLAGMASK) {
249 if (proc.p_pid != (pid_t)arg)
254 if (ucred.cr_uid != (uid_t)arg)
259 if (ucred.cr_ruid != (uid_t)arg)
264 if (KREAD(kd, (u_long)proc.p_pgrp, &pgrp)) {
265 _kvm_err(kd, kd->program, "can't read pgrp at %p",
271 if (KREAD(kd, (u_long)proc.p_pptr, &pproc)) {
272 _kvm_err(kd, kd->program, "can't read pproc at %p",
276 proc.p_pptr = &pproc;
279 if (proc.p_sigacts) {
280 if (KREAD(kd, (u_long)proc.p_sigacts, &sigacts)) {
281 _kvm_err(kd, kd->program,
282 "can't read sigacts at %p",
286 proc.p_sigacts = &sigacts;
289 if (KREAD(kd, (u_long)pgrp.pg_session, &sess)) {
290 _kvm_err(kd, kd->program, "can't read session at %p",
294 pgrp.pg_session = &sess;
296 if ((proc.p_flags & P_CONTROLT) && sess.s_ttyp != NULL) {
297 if (KREAD(kd, (u_long)sess.s_ttyp, &tty)) {
298 _kvm_err(kd, kd->program,
299 "can't read tty at %p", sess.s_ttyp);
303 if (tty.t_dev && tty.t_dev != NULL) {
304 if (KREAD(kd, (u_long)tty.t_dev, &cdev))
309 if (tty.t_pgrp != NULL) {
310 if (KREAD(kd, (u_long)tty.t_pgrp, &tpgrp)) {
311 _kvm_err(kd, kd->program,
312 "can't read tpgrp at %p",
318 if (tty.t_session != NULL) {
319 if (KREAD(kd, (u_long)tty.t_session, &tsess)) {
320 _kvm_err(kd, kd->program,
321 "can't read tsess at %p",
325 tty.t_session = &tsess;
329 if (KREAD(kd, (u_long)proc.p_vmspace, &vmspace)) {
330 _kvm_err(kd, kd->program, "can't read vmspace at %p",
334 proc.p_vmspace = &vmspace;
336 if (ucred.cr_prison != NULL) {
337 if (KREAD(kd, (u_long)ucred.cr_prison, &prison)) {
338 _kvm_err(kd, kd->program, "can't read prison at %p",
342 ucred.cr_prison = &prison;
345 switch (what & ~KERN_PROC_FLAGMASK) {
348 if (proc.p_pgrp->pg_id != (pid_t)arg)
353 if ((proc.p_flags & P_CONTROLT) == 0 ||
354 dev2udev(proc.p_pgrp->pg_session->s_ttyp->t_dev)
360 if ((bp = kinfo_resize_proc(kd, bp)) == NULL)
362 fill_kinfo_proc(&proc, bp);
363 bp->kp_paddr = (uintptr_t)p;
365 lwppos = kvm_firstlwp(kd, &lwp, &proc);
367 bp++; /* Just export the proc then */
370 while (lwppos && lwppos != (uintptr_t)-1) {
371 if (p != lwp.lwp_proc) {
372 _kvm_err(kd, kd->program, "lwp has wrong parent");
375 lwp.lwp_proc = &proc;
376 if (KREAD(kd, (u_long)lwp.lwp_thread, &thread)) {
377 _kvm_err(kd, kd->program, "can't read thread at %p",
381 lwp.lwp_thread = &thread;
384 if (KREAD(kd, (u_long)thread.td_gd, &gdata)) {
385 _kvm_err(kd, kd->program, "can't read"
390 thread.td_gd = &gdata;
392 if (thread.td_wmesg) {
393 wmesg = (void *)KREADSTR(kd, thread.td_wmesg);
395 _kvm_err(kd, kd->program, "can't read"
400 thread.td_wmesg = wmesg;
405 if ((bp = kinfo_resize_proc(kd, bp)) == NULL)
407 fill_kinfo_proc(&proc, bp);
408 fill_kinfo_lwp(&lwp, &bp->kp_lwp);
409 bp->kp_paddr = (uintptr_t)p;
414 if ((what & KERN_PROC_FLAG_LWP) == 0)
416 lwppos = kvm_nextlwp(kd, lwppos, &lwp, &proc);
418 if (lwppos == (uintptr_t)-1)
425 * Build proc info array by reading in proc list from a crash dump.
426 * We reallocate kd->procbase as necessary.
429 kvm_deadprocs(kvm_t *kd, int what, int arg, u_long a_allproc,
432 struct kinfo_proc *bp = kd->procbase;
436 if (KREAD(kd, a_allproc, &p)) {
437 _kvm_err(kd, kd->program, "cannot read allproc");
440 acnt = kvm_proclist(kd, what, arg, p, bp);
444 if (KREAD(kd, a_zombproc, &p)) {
445 _kvm_err(kd, kd->program, "cannot read zombproc");
448 zcnt = kvm_proclist(kd, what, arg, p, bp + acnt);
452 return (acnt + zcnt);
456 kvm_getprocs(kvm_t *kd, int op, int arg, int *cnt)
458 int mib[4], st, nprocs;
459 int miblen = ((op & ~KERN_PROC_FLAGMASK) == KERN_PROC_ALL) ? 3 : 4;
462 if (kd->procbase != 0) {
463 free((void *)kd->procbase);
465 * Clear this pointer in case this call fails. Otherwise,
466 * kvm_close() will free it again.
470 if (kvm_ishost(kd)) {
476 st = sysctl(mib, miblen, NULL, &size, NULL, 0);
478 _kvm_syserr(kd, kd->program, "kvm_getprocs");
483 kd->procbase = (struct kinfo_proc *)
484 _kvm_realloc(kd, kd->procbase, size);
485 if (kd->procbase == 0)
487 st = sysctl(mib, miblen, kd->procbase, &size, NULL, 0);
488 } while (st == -1 && errno == ENOMEM);
490 _kvm_syserr(kd, kd->program, "kvm_getprocs");
493 if (size % sizeof(struct kinfo_proc) != 0) {
494 _kvm_err(kd, kd->program,
495 "proc size mismatch (%zd total, %zd chunks)",
496 size, sizeof(struct kinfo_proc));
499 nprocs = size / sizeof(struct kinfo_proc);
501 struct nlist nl[4], *p;
503 nl[0].n_name = "_nprocs";
504 nl[1].n_name = "_allproc";
505 nl[2].n_name = "_zombproc";
508 if (kvm_nlist(kd, nl) != 0) {
509 for (p = nl; p->n_type != 0; ++p)
511 _kvm_err(kd, kd->program,
512 "%s: no such symbol", p->n_name);
515 if (KREAD(kd, nl[0].n_value, &nprocs)) {
516 _kvm_err(kd, kd->program, "can't read nprocs");
519 nprocs = kvm_deadprocs(kd, op, arg, nl[1].n_value,
522 size = nprocs * sizeof(struct kinfo_proc);
523 (void)realloc(kd->procbase, size);
527 return (kd->procbase);
531 _kvm_freeprocs(kvm_t *kd)
540 _kvm_realloc(kvm_t *kd, void *p, size_t n)
542 void *np = (void *)realloc(p, n);
546 _kvm_err(kd, kd->program, "out of memory");
552 #define MAX(a, b) ((a) > (b) ? (a) : (b))
556 * Read in an argument vector from the user address space of process pid.
557 * addr if the user-space base address of narg null-terminated contiguous
558 * strings. This is used to read in both the command arguments and
559 * environment strings. Read at most maxcnt characters of strings.
562 kvm_argv(kvm_t *kd, pid_t pid, u_long addr, int narg, int maxcnt)
564 char *np, *cp, *ep, *ap;
570 * Check that there aren't an unreasonable number of agruments,
571 * and that the address is in user space.
574 addr < VM_MIN_USER_ADDRESS || addr >= VM_MAX_USER_ADDRESS) {
579 * kd->argv : work space for fetching the strings from the target
580 * process's space, and is converted for returning to caller
584 * Try to avoid reallocs.
586 kd->argc = MAX(narg + 1, 32);
587 kd->argv = (char **)_kvm_malloc(kd, kd->argc *
591 } else if (narg + 1 > kd->argc) {
592 kd->argc = MAX(2 * kd->argc, narg + 1);
593 kd->argv = (char **)_kvm_realloc(kd, kd->argv, kd->argc *
599 * kd->argspc : returned to user, this is where the kd->argv
600 * arrays are left pointing to the collected strings.
602 if (kd->argspc == 0) {
603 kd->argspc = (char *)_kvm_malloc(kd, PAGE_SIZE);
606 kd->arglen = PAGE_SIZE;
609 * kd->argbuf : used to pull in pages from the target process.
610 * the strings are copied out of here.
612 if (kd->argbuf == 0) {
613 kd->argbuf = (char *)_kvm_malloc(kd, PAGE_SIZE);
618 /* Pull in the target process'es argv vector */
619 cc = sizeof(char *) * narg;
620 if (kvm_uread(kd, pid, addr, (char *)kd->argv, cc) != cc)
623 * ap : saved start address of string we're working on in kd->argspc
624 * np : pointer to next place to write in kd->argspc
625 * len: length of data in kd->argspc
626 * argv: pointer to the argv vector that we are hunting around the
627 * target process space for, and converting to addresses in
628 * our address space (kd->argspc).
630 ap = np = kd->argspc;
634 * Loop over pages, filling in the argument vector.
635 * Note that the argv strings could be pointing *anywhere* in
636 * the user address space and are no longer contiguous.
637 * Note that *argv is modified when we are going to fetch a string
638 * that crosses a page boundary. We copy the next part of the string
639 * into to "np" and eventually convert the pointer.
641 while (argv < kd->argv + narg && *argv != NULL) {
643 /* get the address that the current argv string is on */
644 addr = (u_long)*argv & ~(PAGE_SIZE - 1);
646 /* is it the same page as the last one? */
648 if (kvm_uread(kd, pid, addr, kd->argbuf, PAGE_SIZE) !=
654 /* offset within the page... kd->argbuf */
655 addr = (u_long)*argv & (PAGE_SIZE - 1);
657 /* cp = start of string, cc = count of chars in this chunk */
658 cp = kd->argbuf + addr;
659 cc = PAGE_SIZE - addr;
661 /* dont get more than asked for by user process */
662 if (maxcnt > 0 && cc > maxcnt - len)
665 /* pointer to end of string if we found it in this page */
666 ep = memchr(cp, '\0', cc);
670 * at this point, cc is the count of the chars that we are
671 * going to retrieve this time. we may or may not have found
672 * the end of it. (ep points to the null if the end is known)
675 /* will we exceed the malloc/realloced buffer? */
676 if (len + cc > kd->arglen) {
679 char *op = kd->argspc;
682 kd->argspc = (char *)_kvm_realloc(kd, kd->argspc,
687 * Adjust argv pointers in case realloc moved
690 off = kd->argspc - op;
691 for (pp = kd->argv; pp < argv; pp++)
696 /* np = where to put the next part of the string in kd->argspc*/
697 /* np is kinda redundant.. could use "kd->argspc + len" */
699 np += cc; /* inc counters */
703 * if end of string found, set the *argv pointer to the
704 * saved beginning of string, and advance. argv points to
705 * somewhere in kd->argv.. This is initially relative
706 * to the target process, but when we close it off, we set
707 * it to point in our address space.
713 /* update the address relative to the target process */
717 if (maxcnt > 0 && len >= maxcnt) {
719 * We're stopping prematurely. Terminate the
729 /* Make sure argv is terminated. */
735 ps_str_a(struct ps_strings *p, u_long *addr, int *n)
737 *addr = (u_long)p->ps_argvstr;
742 ps_str_e(struct ps_strings *p, u_long *addr, int *n)
744 *addr = (u_long)p->ps_envstr;
749 * Determine if the proc indicated by p is still active.
750 * This test is not 100% foolproof in theory, but chances of
751 * being wrong are very low.
754 proc_verify(kvm_t *kd, const struct kinfo_proc *p)
756 struct kinfo_proc kp;
763 mib[2] = KERN_PROC_PID;
767 error = sysctl(mib, 4, &kp, &len, NULL, 0);
771 error = (p->kp_pid == kp.kp_pid &&
772 (kp.kp_stat != SZOMB || p->kp_stat == SZOMB));
777 kvm_doargv(kvm_t *kd, const struct kinfo_proc *kp, int nchr,
778 void (*info)(struct ps_strings *, u_long *, int *))
783 static struct ps_strings arginfo;
784 static u_long ps_strings;
787 if (ps_strings == 0) {
788 len = sizeof(ps_strings);
789 if (sysctlbyname("kern.ps_strings", &ps_strings, &len, NULL,
791 ps_strings = PS_STRINGS;
795 * Pointers are stored at the top of the user stack.
797 if (kp->kp_stat == SZOMB ||
798 kvm_uread(kd, kp->kp_pid, ps_strings, (char *)&arginfo,
799 sizeof(arginfo)) != sizeof(arginfo))
802 (*info)(&arginfo, &addr, &cnt);
805 ap = kvm_argv(kd, kp->kp_pid, addr, cnt, nchr);
807 * For live kernels, make sure this process didn't go away.
809 if (ap != NULL && (kvm_ishost(kd) || kvm_isvkernel(kd)) &&
810 !proc_verify(kd, kp))
816 * Get the command args. This code is now machine independent.
819 kvm_getargv(kvm_t *kd, const struct kinfo_proc *kp, int nchr)
824 static unsigned long buflen;
825 static char *buf, *p;
829 if (!kvm_ishost(kd)) { /* XXX: vkernels */
830 _kvm_err(kd, kd->program,
831 "cannot read user space from dead kernel");
836 bufsz = sizeof(buflen);
837 i = sysctlbyname("kern.ps_arg_cache_limit",
838 &buflen, &bufsz, NULL, 0);
842 buf = malloc(buflen);
846 bufp = malloc(sizeof(char *) * argc);
852 oid[2] = KERN_PROC_ARGS;
855 i = sysctl(oid, 4, buf, &bufsz, 0, 0);
856 if (i == 0 && bufsz > 0) {
865 sizeof(char *) * argc);
867 } while (p < buf + bufsz);
872 if (kp->kp_flags & P_SYSTEM)
874 return (kvm_doargv(kd, kp, nchr, ps_str_a));
878 kvm_getenvv(kvm_t *kd, const struct kinfo_proc *kp, int nchr)
880 return (kvm_doargv(kd, kp, nchr, ps_str_e));
884 * Read from user space. The user context is given by pid.
887 kvm_uread(kvm_t *kd, pid_t pid, u_long uva, char *buf, size_t len)
890 char procfile[MAXPATHLEN];
894 if (!kvm_ishost(kd)) { /* XXX: vkernels */
895 _kvm_err(kd, kd->program,
896 "cannot read user space from dead kernel");
900 sprintf(procfile, "/proc/%d/mem", pid);
901 fd = open(procfile, O_RDONLY, 0);
903 _kvm_err(kd, kd->program, "cannot open %s", procfile);
911 if (lseek(fd, (off_t)uva, 0) == -1 && errno != 0) {
912 _kvm_err(kd, kd->program, "invalid address (%lx) in %s",
916 amount = read(fd, cp, len);
918 _kvm_syserr(kd, kd->program, "error reading %s",
923 _kvm_err(kd, kd->program, "EOF reading %s", procfile);
932 return ((ssize_t)(cp - buf));