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. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * $FreeBSD: src/lib/libkvm/kvm_proc.c,v 1.25.2.3 2002/08/24 07:27:46 kris Exp $
35 * @(#)kvm_proc.c 8.3 (Berkeley) 9/23/93
39 * Proc traversal interface for kvm. ps and w are (probably) the exclusive
40 * users of this code, so we've factored it out into a separate module.
41 * Thus, we keep this grunge out of the other kvm applications (i.e.,
42 * most other applications are interested only in open/close/read/nlist).
45 #include <sys/user.h> /* MUST BE FIRST */
47 #include <sys/param.h>
51 #include <sys/globaldata.h>
52 #include <sys/ioctl.h>
63 #include <vm/vm_param.h>
64 #include <vm/swap_pager.h>
66 #include <sys/sysctl.h>
72 #include "kvm_private.h"
76 kvm_readswap(kvm_t *kd, const struct proc *p, u_long va, u_long *cnt)
78 #if defined(__FreeBSD__) || defined(__DragonFly__)
79 /* XXX Stubbed out, our vm system is differnet */
80 _kvm_err(kd, kd->program, "kvm_readswap not implemented");
86 #define KREAD(kd, addr, obj) \
87 (kvm_read(kd, addr, (char *)(obj), sizeof(*obj)) != sizeof(*obj))
88 #define KREADSTR(kd, addr) \
89 kvm_readstr(kd, (u_long)addr, NULL, NULL)
91 static struct kinfo_proc *
92 kinfo_resize_proc(kvm_t *kd, struct kinfo_proc *bp)
97 size_t pos = bp - kd->procend;
98 size_t size = kd->procend - kd->procbase;
104 kd->procbase = _kvm_realloc(kd, kd->procbase, sizeof(*bp) * size);
105 if (kd->procbase == NULL)
107 kd->procend = kd->procbase + size;
108 bp = kd->procbase + pos;
113 * note: this function is also used by /usr/src/sys/kern/kern_kinfo.c as
114 * compiled by userland.
121 if ((dev->si_umajor & 0xffffff00) ||
122 (dev->si_uminor & 0x0000ff00)) {
125 return((dev->si_umajor << 8) | dev->si_uminor);
129 * Helper routine which traverses the left hand side of a red-black sub-tree.
132 kvm_lwptraverse(kvm_t *kd, struct lwp *lwp, uintptr_t lwppos)
135 if (KREAD(kd, lwppos, lwp)) {
136 _kvm_err(kd, kd->program, "can't read lwp at %p",
138 return ((uintptr_t)-1);
140 if (lwp->u.lwp_rbnode.rbe_left == NULL)
142 lwppos = (uintptr_t)lwp->u.lwp_rbnode.rbe_left;
148 * Iterate LWPs in a process.
150 * The first lwp in a red-black tree is a left-side traversal of the tree.
153 kvm_firstlwp(kvm_t *kd, struct lwp *lwp, struct proc *proc)
155 return(kvm_lwptraverse(kd, lwp, (uintptr_t)proc->p_lwp_tree.rbh_root));
159 * If the current element is the left side of the parent the next element
160 * will be a left side traversal of the parent's right side. If the parent
161 * has no right side the next element will be the parent.
163 * If the current element is the right side of the parent the next element
166 * If the parent is NULL we are done.
169 kvm_nextlwp(kvm_t *kd, uintptr_t lwppos, struct lwp *lwp, struct proc *proc)
173 nextpos = (uintptr_t)lwp->u.lwp_rbnode.rbe_parent;
175 if (KREAD(kd, nextpos, lwp)) {
176 _kvm_err(kd, kd->program, "can't read lwp at %p",
178 return ((uintptr_t)-1);
180 if (lwppos == (uintptr_t)lwp->u.lwp_rbnode.rbe_left) {
182 * If we had gone down the left side the next element
183 * is a left hand traversal of the parent's right
184 * side, or the parent itself if there is no right
187 lwppos = (uintptr_t)lwp->u.lwp_rbnode.rbe_right;
189 nextpos = kvm_lwptraverse(kd, lwp, lwppos);
192 * If we had gone down the right side the next
193 * element is the parent.
195 /* nextpos = nextpos */
202 * Read proc's from memory file into buffer bp, which has space to hold
203 * at most maxcnt procs.
206 kvm_proclist(kvm_t *kd, int what, int arg, struct proc *p,
207 struct kinfo_proc *bp)
211 struct globaldata gdata;
213 struct session tsess;
217 struct thread thread;
220 struct vmspace vmspace;
221 struct prison prison;
222 struct sigacts sigacts;
230 for (; p != NULL; p = proc.p_list.le_next) {
231 if (KREAD(kd, (u_long)p, &proc)) {
232 _kvm_err(kd, kd->program, "can't read proc at %p", p);
235 if (KREAD(kd, (u_long)proc.p_ucred, &ucred)) {
236 _kvm_err(kd, kd->program, "can't read ucred at %p",
240 proc.p_ucred = &ucred;
242 switch(what & ~KERN_PROC_FLAGMASK) {
245 if (proc.p_pid != (pid_t)arg)
250 if (ucred.cr_uid != (uid_t)arg)
255 if (ucred.cr_ruid != (uid_t)arg)
260 if (KREAD(kd, (u_long)proc.p_pgrp, &pgrp)) {
261 _kvm_err(kd, kd->program, "can't read pgrp at %p",
267 if (KREAD(kd, (u_long)proc.p_pptr, &pproc)) {
268 _kvm_err(kd, kd->program, "can't read pproc at %p",
272 proc.p_pptr = &pproc;
275 if (proc.p_sigacts) {
276 if (KREAD(kd, (u_long)proc.p_sigacts, &sigacts)) {
277 _kvm_err(kd, kd->program,
278 "can't read sigacts at %p",
282 proc.p_sigacts = &sigacts;
285 if (KREAD(kd, (u_long)pgrp.pg_session, &sess)) {
286 _kvm_err(kd, kd->program, "can't read session at %p",
290 pgrp.pg_session = &sess;
292 if ((proc.p_flags & P_CONTROLT) && sess.s_ttyp != NULL) {
293 if (KREAD(kd, (u_long)sess.s_ttyp, &tty)) {
294 _kvm_err(kd, kd->program,
295 "can't read tty at %p", sess.s_ttyp);
299 if (tty.t_dev != NULL) {
300 if (KREAD(kd, (u_long)tty.t_dev, &cdev))
305 if (tty.t_pgrp != NULL) {
306 if (KREAD(kd, (u_long)tty.t_pgrp, &tpgrp)) {
307 _kvm_err(kd, kd->program,
308 "can't read tpgrp at %p",
314 if (tty.t_session != NULL) {
315 if (KREAD(kd, (u_long)tty.t_session, &tsess)) {
316 _kvm_err(kd, kd->program,
317 "can't read tsess at %p",
321 tty.t_session = &tsess;
325 if (KREAD(kd, (u_long)proc.p_vmspace, &vmspace)) {
326 _kvm_err(kd, kd->program, "can't read vmspace at %p",
330 proc.p_vmspace = &vmspace;
332 if (ucred.cr_prison != NULL) {
333 if (KREAD(kd, (u_long)ucred.cr_prison, &prison)) {
334 _kvm_err(kd, kd->program, "can't read prison at %p",
338 ucred.cr_prison = &prison;
341 switch (what & ~KERN_PROC_FLAGMASK) {
344 if (proc.p_pgrp->pg_id != (pid_t)arg)
349 if ((proc.p_flags & P_CONTROLT) == 0 ||
350 dev2udev(proc.p_pgrp->pg_session->s_ttyp->t_dev)
356 if ((bp = kinfo_resize_proc(kd, bp)) == NULL)
358 fill_kinfo_proc(&proc, bp);
359 bp->kp_paddr = (uintptr_t)p;
361 lwppos = kvm_firstlwp(kd, &lwp, &proc);
363 bp++; /* Just export the proc then */
366 while (lwppos && lwppos != (uintptr_t)-1) {
367 if (p != lwp.lwp_proc) {
368 _kvm_err(kd, kd->program, "lwp has wrong parent");
371 lwp.lwp_proc = &proc;
372 if (KREAD(kd, (u_long)lwp.lwp_thread, &thread)) {
373 _kvm_err(kd, kd->program, "can't read thread at %p",
377 lwp.lwp_thread = &thread;
380 if (KREAD(kd, (u_long)thread.td_gd, &gdata)) {
381 _kvm_err(kd, kd->program, "can't read"
386 thread.td_gd = &gdata;
388 if (thread.td_wmesg) {
389 wmesg = (void *)KREADSTR(kd, thread.td_wmesg);
391 _kvm_err(kd, kd->program, "can't read"
396 thread.td_wmesg = wmesg;
401 if ((bp = kinfo_resize_proc(kd, bp)) == NULL)
403 fill_kinfo_proc(&proc, bp);
404 fill_kinfo_lwp(&lwp, &bp->kp_lwp);
405 bp->kp_paddr = (uintptr_t)p;
410 if ((what & KERN_PROC_FLAG_LWP) == 0)
412 lwppos = kvm_nextlwp(kd, lwppos, &lwp, &proc);
414 if (lwppos == (uintptr_t)-1)
421 * Build proc info array by reading in proc list from a crash dump.
422 * We reallocate kd->procbase as necessary.
425 kvm_deadprocs(kvm_t *kd, int what, int arg, u_long a_allproc,
428 struct kinfo_proc *bp = kd->procbase;
432 if (KREAD(kd, a_allproc, &p)) {
433 _kvm_err(kd, kd->program, "cannot read allproc");
436 acnt = kvm_proclist(kd, what, arg, p, bp);
440 if (KREAD(kd, a_zombproc, &p)) {
441 _kvm_err(kd, kd->program, "cannot read zombproc");
444 zcnt = kvm_proclist(kd, what, arg, p, bp + acnt);
448 return (acnt + zcnt);
452 kvm_getprocs(kvm_t *kd, int op, int arg, int *cnt)
454 int mib[4], st, nprocs;
455 int miblen = ((op & ~KERN_PROC_FLAGMASK) == KERN_PROC_ALL) ? 3 : 4;
458 if (kd->procbase != 0) {
459 free((void *)kd->procbase);
461 * Clear this pointer in case this call fails. Otherwise,
462 * kvm_close() will free it again.
466 if (kvm_ishost(kd)) {
472 st = sysctl(mib, miblen, NULL, &size, NULL, 0);
474 _kvm_syserr(kd, kd->program, "kvm_getprocs");
479 kd->procbase = (struct kinfo_proc *)
480 _kvm_realloc(kd, kd->procbase, size);
481 if (kd->procbase == 0)
483 st = sysctl(mib, miblen, kd->procbase, &size, NULL, 0);
484 } while (st == -1 && errno == ENOMEM);
486 _kvm_syserr(kd, kd->program, "kvm_getprocs");
489 if (size % sizeof(struct kinfo_proc) != 0) {
490 _kvm_err(kd, kd->program,
491 "proc size mismatch (%zd total, %zd chunks)",
492 size, sizeof(struct kinfo_proc));
495 nprocs = size / sizeof(struct kinfo_proc);
497 struct nlist nl[4], *p;
499 nl[0].n_name = "_nprocs";
500 nl[1].n_name = "_allproc";
501 nl[2].n_name = "_zombproc";
504 if (kvm_nlist(kd, nl) != 0) {
505 for (p = nl; p->n_type != 0; ++p)
507 _kvm_err(kd, kd->program,
508 "%s: no such symbol", p->n_name);
511 if (KREAD(kd, nl[0].n_value, &nprocs)) {
512 _kvm_err(kd, kd->program, "can't read nprocs");
515 nprocs = kvm_deadprocs(kd, op, arg, nl[1].n_value,
518 size = nprocs * sizeof(struct kinfo_proc);
519 (void)realloc(kd->procbase, size);
523 return (kd->procbase);
527 _kvm_freeprocs(kvm_t *kd)
536 _kvm_realloc(kvm_t *kd, void *p, size_t n)
538 void *np = (void *)realloc(p, n);
542 _kvm_err(kd, kd->program, "out of memory");
548 #define MAX(a, b) ((a) > (b) ? (a) : (b))
552 * Read in an argument vector from the user address space of process pid.
553 * addr if the user-space base address of narg null-terminated contiguous
554 * strings. This is used to read in both the command arguments and
555 * environment strings. Read at most maxcnt characters of strings.
558 kvm_argv(kvm_t *kd, pid_t pid, u_long addr, int narg, int maxcnt)
560 char *np, *cp, *ep, *ap;
566 * Check that there aren't an unreasonable number of agruments,
567 * and that the address is in user space.
570 addr < VM_MIN_USER_ADDRESS || addr >= VM_MAX_USER_ADDRESS) {
575 * kd->argv : work space for fetching the strings from the target
576 * process's space, and is converted for returning to caller
580 * Try to avoid reallocs.
582 kd->argc = MAX(narg + 1, 32);
583 kd->argv = (char **)_kvm_malloc(kd, kd->argc *
587 } else if (narg + 1 > kd->argc) {
588 kd->argc = MAX(2 * kd->argc, narg + 1);
589 kd->argv = (char **)_kvm_realloc(kd, kd->argv, kd->argc *
595 * kd->argspc : returned to user, this is where the kd->argv
596 * arrays are left pointing to the collected strings.
598 if (kd->argspc == 0) {
599 kd->argspc = (char *)_kvm_malloc(kd, PAGE_SIZE);
602 kd->arglen = PAGE_SIZE;
605 * kd->argbuf : used to pull in pages from the target process.
606 * the strings are copied out of here.
608 if (kd->argbuf == 0) {
609 kd->argbuf = (char *)_kvm_malloc(kd, PAGE_SIZE);
614 /* Pull in the target process'es argv vector */
615 cc = sizeof(char *) * narg;
616 if (kvm_uread(kd, pid, addr, (char *)kd->argv, cc) != cc)
619 * ap : saved start address of string we're working on in kd->argspc
620 * np : pointer to next place to write in kd->argspc
621 * len: length of data in kd->argspc
622 * argv: pointer to the argv vector that we are hunting around the
623 * target process space for, and converting to addresses in
624 * our address space (kd->argspc).
626 ap = np = kd->argspc;
630 * Loop over pages, filling in the argument vector.
631 * Note that the argv strings could be pointing *anywhere* in
632 * the user address space and are no longer contiguous.
633 * Note that *argv is modified when we are going to fetch a string
634 * that crosses a page boundary. We copy the next part of the string
635 * into to "np" and eventually convert the pointer.
637 while (argv < kd->argv + narg && *argv != NULL) {
639 /* get the address that the current argv string is on */
640 addr = (u_long)*argv & ~(PAGE_SIZE - 1);
642 /* is it the same page as the last one? */
644 if (kvm_uread(kd, pid, addr, kd->argbuf, PAGE_SIZE) !=
650 /* offset within the page... kd->argbuf */
651 addr = (u_long)*argv & (PAGE_SIZE - 1);
653 /* cp = start of string, cc = count of chars in this chunk */
654 cp = kd->argbuf + addr;
655 cc = PAGE_SIZE - addr;
657 /* dont get more than asked for by user process */
658 if (maxcnt > 0 && cc > maxcnt - len)
661 /* pointer to end of string if we found it in this page */
662 ep = memchr(cp, '\0', cc);
666 * at this point, cc is the count of the chars that we are
667 * going to retrieve this time. we may or may not have found
668 * the end of it. (ep points to the null if the end is known)
671 /* will we exceed the malloc/realloced buffer? */
672 if (len + cc > kd->arglen) {
675 char *op = kd->argspc;
678 kd->argspc = (char *)_kvm_realloc(kd, kd->argspc,
683 * Adjust argv pointers in case realloc moved
686 off = kd->argspc - op;
687 for (pp = kd->argv; pp < argv; pp++)
692 /* np = where to put the next part of the string in kd->argspc*/
693 /* np is kinda redundant.. could use "kd->argspc + len" */
695 np += cc; /* inc counters */
699 * if end of string found, set the *argv pointer to the
700 * saved beginning of string, and advance. argv points to
701 * somewhere in kd->argv.. This is initially relative
702 * to the target process, but when we close it off, we set
703 * it to point in our address space.
709 /* update the address relative to the target process */
713 if (maxcnt > 0 && len >= maxcnt) {
715 * We're stopping prematurely. Terminate the
725 /* Make sure argv is terminated. */
731 ps_str_a(struct ps_strings *p, u_long *addr, int *n)
733 *addr = (u_long)p->ps_argvstr;
738 ps_str_e(struct ps_strings *p, u_long *addr, int *n)
740 *addr = (u_long)p->ps_envstr;
745 * Determine if the proc indicated by p is still active.
746 * This test is not 100% foolproof in theory, but chances of
747 * being wrong are very low.
750 proc_verify(kvm_t *kd, const struct kinfo_proc *p)
752 struct kinfo_proc kp;
759 mib[2] = KERN_PROC_PID;
763 error = sysctl(mib, 4, &kp, &len, NULL, 0);
767 error = (p->kp_pid == kp.kp_pid &&
768 (kp.kp_stat != SZOMB || p->kp_stat == SZOMB));
773 kvm_doargv(kvm_t *kd, const struct kinfo_proc *kp, int nchr,
774 void (*info)(struct ps_strings *, u_long *, int *))
779 static struct ps_strings arginfo;
780 static u_long ps_strings;
783 if (ps_strings == 0) {
784 len = sizeof(ps_strings);
785 if (sysctlbyname("kern.ps_strings", &ps_strings, &len, NULL,
787 ps_strings = PS_STRINGS;
791 * Pointers are stored at the top of the user stack.
793 if (kp->kp_stat == SZOMB ||
794 kvm_uread(kd, kp->kp_pid, ps_strings, (char *)&arginfo,
795 sizeof(arginfo)) != sizeof(arginfo))
798 (*info)(&arginfo, &addr, &cnt);
801 ap = kvm_argv(kd, kp->kp_pid, addr, cnt, nchr);
803 * For live kernels, make sure this process didn't go away.
805 if (ap != NULL && (kvm_ishost(kd) || kvm_isvkernel(kd)) &&
806 !proc_verify(kd, kp))
812 * Get the command args. This code is now machine independent.
815 kvm_getargv(kvm_t *kd, const struct kinfo_proc *kp, int nchr)
820 static unsigned long buflen;
821 static char *buf, *p;
825 if (!kvm_ishost(kd)) { /* XXX: vkernels */
826 _kvm_err(kd, kd->program,
827 "cannot read user space from dead kernel");
832 bufsz = sizeof(buflen);
833 i = sysctlbyname("kern.ps_arg_cache_limit",
834 &buflen, &bufsz, NULL, 0);
838 buf = malloc(buflen);
842 bufp = malloc(sizeof(char *) * argc);
848 oid[2] = KERN_PROC_ARGS;
851 i = sysctl(oid, 4, buf, &bufsz, 0, 0);
852 if (i == 0 && bufsz > 0) {
861 sizeof(char *) * argc);
863 } while (p < buf + bufsz);
868 if (kp->kp_flags & P_SYSTEM)
870 return (kvm_doargv(kd, kp, nchr, ps_str_a));
874 kvm_getenvv(kvm_t *kd, const struct kinfo_proc *kp, int nchr)
876 return (kvm_doargv(kd, kp, nchr, ps_str_e));
880 * Read from user space. The user context is given by pid.
883 kvm_uread(kvm_t *kd, pid_t pid, u_long uva, char *buf, size_t len)
886 char procfile[MAXPATHLEN];
890 if (!kvm_ishost(kd)) { /* XXX: vkernels */
891 _kvm_err(kd, kd->program,
892 "cannot read user space from dead kernel");
896 sprintf(procfile, "/proc/%d/mem", pid);
897 fd = open(procfile, O_RDONLY, 0);
899 _kvm_err(kd, kd->program, "cannot open %s", procfile);
907 if (lseek(fd, (off_t)uva, 0) == -1 && errno != 0) {
908 _kvm_err(kd, kd->program, "invalid address (%lx) in %s",
912 amount = read(fd, cp, len);
914 _kvm_syserr(kd, kd->program, "error reading %s",
919 _kvm_err(kd, kd->program, "EOF reading %s", procfile);
928 return ((ssize_t)(cp - buf));