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 $
38 * $DragonFly: src/lib/libkvm/kvm_proc.c,v 1.18 2008/06/05 18:06:30 swildner Exp $
40 * @(#)kvm_proc.c 8.3 (Berkeley) 9/23/93
44 * Proc traversal interface for kvm. ps and w are (probably) the exclusive
45 * users of this code, so we've factored it out into a separate module.
46 * Thus, we keep this grunge out of the other kvm applications (i.e.,
47 * most other applications are interested only in open/close/read/nlist).
50 #include <sys/user.h> /* MUST BE FIRST */
52 #include <sys/param.h>
56 #include <sys/globaldata.h>
57 #include <sys/ioctl.h>
68 #include <vm/vm_param.h>
69 #include <vm/swap_pager.h>
71 #include <sys/sysctl.h>
77 #include "kvm_private.h"
81 kvm_readswap(kvm_t *kd, const struct proc *p, u_long va, u_long *cnt)
83 #if defined(__FreeBSD__) || defined(__DragonFly__)
84 /* XXX Stubbed out, our vm system is differnet */
85 _kvm_err(kd, kd->program, "kvm_readswap not implemented");
91 #define KREAD(kd, addr, obj) \
92 (kvm_read(kd, addr, (char *)(obj), sizeof(*obj)) != sizeof(*obj))
93 #define KREADSTR(kd, addr) \
94 kvm_readstr(kd, (u_long)addr, NULL, NULL)
96 static struct kinfo_proc *
97 kinfo_resize_proc(kvm_t *kd, struct kinfo_proc *bp)
102 size_t pos = bp - kd->procend;
103 size_t size = kd->procend - kd->procbase;
109 kd->procbase = _kvm_realloc(kd, kd->procbase, sizeof(*bp) * size);
110 if (kd->procbase == NULL)
112 kd->procend = kd->procbase + size;
113 bp = kd->procbase + pos;
118 * note: this function is also used by /usr/src/sys/kern/kern_kinfo.c as
119 * compiled by userland.
126 if ((dev->si_umajor & 0xffffff00) ||
127 (dev->si_uminor & 0x0000ff00)) {
130 return((dev->si_umajor << 8) | dev->si_uminor);
134 * Helper routine which traverses the left hand side of a red-black sub-tree.
137 kvm_lwptraverse(kvm_t *kd, struct lwp *lwp, uintptr_t lwppos)
140 if (KREAD(kd, lwppos, lwp)) {
141 _kvm_err(kd, kd->program, "can't read lwp at %p",
143 return ((uintptr_t)-1);
145 if (lwp->u.lwp_rbnode.rbe_left == NULL)
147 lwppos = (uintptr_t)lwp->u.lwp_rbnode.rbe_left;
153 * Iterate LWPs in a process.
155 * The first lwp in a red-black tree is a left-side traversal of the tree.
158 kvm_firstlwp(kvm_t *kd, struct lwp *lwp, struct proc *proc)
160 return(kvm_lwptraverse(kd, lwp, (uintptr_t)proc->p_lwp_tree.rbh_root));
164 * If the current element is the left side of the parent the next element
165 * will be a left side traversal of the parent's right side. If the parent
166 * has no right side the next element will be the parent.
168 * If the current element is the right side of the parent the next element
171 * If the parent is NULL we are done.
174 kvm_nextlwp(kvm_t *kd, uintptr_t lwppos, struct lwp *lwp, struct proc *proc)
178 nextpos = (uintptr_t)lwp->u.lwp_rbnode.rbe_parent;
180 if (KREAD(kd, nextpos, lwp)) {
181 _kvm_err(kd, kd->program, "can't read lwp at %p",
183 return ((uintptr_t)-1);
185 if (lwppos == (uintptr_t)lwp->u.lwp_rbnode.rbe_left) {
187 * If we had gone down the left side the next element
188 * is a left hand traversal of the parent's right
189 * side, or the parent itself if there is no right
192 lwppos = (uintptr_t)lwp->u.lwp_rbnode.rbe_right;
194 nextpos = kvm_lwptraverse(kd, lwp, lwppos);
197 * If we had gone down the right side the next
198 * element is the parent.
200 /* nextpos = nextpos */
207 * Read proc's from memory file into buffer bp, which has space to hold
208 * at most maxcnt procs.
211 kvm_proclist(kvm_t *kd, int what, int arg, struct proc *p,
212 struct kinfo_proc *bp)
216 struct globaldata gdata;
218 struct session tsess;
222 struct thread thread;
225 struct vmspace vmspace;
226 struct prison prison;
227 struct sigacts sigacts;
235 for (; p != NULL; p = proc.p_list.le_next) {
236 if (KREAD(kd, (u_long)p, &proc)) {
237 _kvm_err(kd, kd->program, "can't read proc at %p", p);
240 if (KREAD(kd, (u_long)proc.p_ucred, &ucred)) {
241 _kvm_err(kd, kd->program, "can't read ucred at %p",
245 proc.p_ucred = &ucred;
247 switch(what & ~KERN_PROC_FLAGMASK) {
250 if (proc.p_pid != (pid_t)arg)
255 if (ucred.cr_uid != (uid_t)arg)
260 if (ucred.cr_ruid != (uid_t)arg)
265 if (KREAD(kd, (u_long)proc.p_pgrp, &pgrp)) {
266 _kvm_err(kd, kd->program, "can't read pgrp at %p",
272 if (KREAD(kd, (u_long)proc.p_pptr, &pproc)) {
273 _kvm_err(kd, kd->program, "can't read pproc at %p",
277 proc.p_pptr = &pproc;
280 if (proc.p_sigacts) {
281 if (KREAD(kd, (u_long)proc.p_sigacts, &sigacts)) {
282 _kvm_err(kd, kd->program,
283 "can't read sigacts at %p",
287 proc.p_sigacts = &sigacts;
290 if (KREAD(kd, (u_long)pgrp.pg_session, &sess)) {
291 _kvm_err(kd, kd->program, "can't read session at %p",
295 pgrp.pg_session = &sess;
297 if ((proc.p_flags & P_CONTROLT) && sess.s_ttyp != NULL) {
298 if (KREAD(kd, (u_long)sess.s_ttyp, &tty)) {
299 _kvm_err(kd, kd->program,
300 "can't read tty at %p", sess.s_ttyp);
304 if (tty.t_dev && tty.t_dev != NULL) {
305 if (KREAD(kd, (u_long)tty.t_dev, &cdev))
310 if (tty.t_pgrp != NULL) {
311 if (KREAD(kd, (u_long)tty.t_pgrp, &tpgrp)) {
312 _kvm_err(kd, kd->program,
313 "can't read tpgrp at %p",
319 if (tty.t_session != NULL) {
320 if (KREAD(kd, (u_long)tty.t_session, &tsess)) {
321 _kvm_err(kd, kd->program,
322 "can't read tsess at %p",
326 tty.t_session = &tsess;
330 if (KREAD(kd, (u_long)proc.p_vmspace, &vmspace)) {
331 _kvm_err(kd, kd->program, "can't read vmspace at %p",
335 proc.p_vmspace = &vmspace;
337 if (ucred.cr_prison != NULL) {
338 if (KREAD(kd, (u_long)ucred.cr_prison, &prison)) {
339 _kvm_err(kd, kd->program, "can't read prison at %p",
343 ucred.cr_prison = &prison;
346 switch (what & ~KERN_PROC_FLAGMASK) {
349 if (proc.p_pgrp->pg_id != (pid_t)arg)
354 if ((proc.p_flags & P_CONTROLT) == 0 ||
355 dev2udev(proc.p_pgrp->pg_session->s_ttyp->t_dev)
361 if ((bp = kinfo_resize_proc(kd, bp)) == NULL)
363 fill_kinfo_proc(&proc, bp);
364 bp->kp_paddr = (uintptr_t)p;
366 lwppos = kvm_firstlwp(kd, &lwp, &proc);
368 bp++; /* Just export the proc then */
371 while (lwppos && lwppos != (uintptr_t)-1) {
372 if (p != lwp.lwp_proc) {
373 _kvm_err(kd, kd->program, "lwp has wrong parent");
376 lwp.lwp_proc = &proc;
377 if (KREAD(kd, (u_long)lwp.lwp_thread, &thread)) {
378 _kvm_err(kd, kd->program, "can't read thread at %p",
382 lwp.lwp_thread = &thread;
385 if (KREAD(kd, (u_long)thread.td_gd, &gdata)) {
386 _kvm_err(kd, kd->program, "can't read"
391 thread.td_gd = &gdata;
393 if (thread.td_wmesg) {
394 wmesg = (void *)KREADSTR(kd, thread.td_wmesg);
396 _kvm_err(kd, kd->program, "can't read"
401 thread.td_wmesg = wmesg;
406 if ((bp = kinfo_resize_proc(kd, bp)) == NULL)
408 fill_kinfo_proc(&proc, bp);
409 fill_kinfo_lwp(&lwp, &bp->kp_lwp);
410 bp->kp_paddr = (uintptr_t)p;
415 if ((what & KERN_PROC_FLAG_LWP) == 0)
417 lwppos = kvm_nextlwp(kd, lwppos, &lwp, &proc);
419 if (lwppos == (uintptr_t)-1)
426 * Build proc info array by reading in proc list from a crash dump.
427 * We reallocate kd->procbase as necessary.
430 kvm_deadprocs(kvm_t *kd, int what, int arg, u_long a_allproc,
433 struct kinfo_proc *bp = kd->procbase;
437 if (KREAD(kd, a_allproc, &p)) {
438 _kvm_err(kd, kd->program, "cannot read allproc");
441 acnt = kvm_proclist(kd, what, arg, p, bp);
445 if (KREAD(kd, a_zombproc, &p)) {
446 _kvm_err(kd, kd->program, "cannot read zombproc");
449 zcnt = kvm_proclist(kd, what, arg, p, bp + acnt);
453 return (acnt + zcnt);
457 kvm_getprocs(kvm_t *kd, int op, int arg, int *cnt)
459 int mib[4], st, nprocs;
460 int miblen = ((op & ~KERN_PROC_FLAGMASK) == KERN_PROC_ALL) ? 3 : 4;
463 if (kd->procbase != 0) {
464 free((void *)kd->procbase);
466 * Clear this pointer in case this call fails. Otherwise,
467 * kvm_close() will free it again.
471 if (kvm_ishost(kd)) {
477 st = sysctl(mib, miblen, NULL, &size, NULL, 0);
479 _kvm_syserr(kd, kd->program, "kvm_getprocs");
484 kd->procbase = (struct kinfo_proc *)
485 _kvm_realloc(kd, kd->procbase, size);
486 if (kd->procbase == 0)
488 st = sysctl(mib, miblen, kd->procbase, &size, NULL, 0);
489 } while (st == -1 && errno == ENOMEM);
491 _kvm_syserr(kd, kd->program, "kvm_getprocs");
494 if (size % sizeof(struct kinfo_proc) != 0) {
495 _kvm_err(kd, kd->program,
496 "proc size mismatch (%zd total, %zd chunks)",
497 size, sizeof(struct kinfo_proc));
500 nprocs = size / sizeof(struct kinfo_proc);
502 struct nlist nl[4], *p;
504 nl[0].n_name = "_nprocs";
505 nl[1].n_name = "_allproc";
506 nl[2].n_name = "_zombproc";
509 if (kvm_nlist(kd, nl) != 0) {
510 for (p = nl; p->n_type != 0; ++p)
512 _kvm_err(kd, kd->program,
513 "%s: no such symbol", p->n_name);
516 if (KREAD(kd, nl[0].n_value, &nprocs)) {
517 _kvm_err(kd, kd->program, "can't read nprocs");
520 nprocs = kvm_deadprocs(kd, op, arg, nl[1].n_value,
523 size = nprocs * sizeof(struct kinfo_proc);
524 (void)realloc(kd->procbase, size);
528 return (kd->procbase);
532 _kvm_freeprocs(kvm_t *kd)
541 _kvm_realloc(kvm_t *kd, void *p, size_t n)
543 void *np = (void *)realloc(p, n);
547 _kvm_err(kd, kd->program, "out of memory");
553 #define MAX(a, b) ((a) > (b) ? (a) : (b))
557 * Read in an argument vector from the user address space of process pid.
558 * addr if the user-space base address of narg null-terminated contiguous
559 * strings. This is used to read in both the command arguments and
560 * environment strings. Read at most maxcnt characters of strings.
563 kvm_argv(kvm_t *kd, pid_t pid, u_long addr, int narg, int maxcnt)
565 char *np, *cp, *ep, *ap;
571 * Check that there aren't an unreasonable number of agruments,
572 * and that the address is in user space.
575 addr < VM_MIN_USER_ADDRESS || addr >= VM_MAX_USER_ADDRESS) {
580 * kd->argv : work space for fetching the strings from the target
581 * process's space, and is converted for returning to caller
585 * Try to avoid reallocs.
587 kd->argc = MAX(narg + 1, 32);
588 kd->argv = (char **)_kvm_malloc(kd, kd->argc *
592 } else if (narg + 1 > kd->argc) {
593 kd->argc = MAX(2 * kd->argc, narg + 1);
594 kd->argv = (char **)_kvm_realloc(kd, kd->argv, kd->argc *
600 * kd->argspc : returned to user, this is where the kd->argv
601 * arrays are left pointing to the collected strings.
603 if (kd->argspc == 0) {
604 kd->argspc = (char *)_kvm_malloc(kd, PAGE_SIZE);
607 kd->arglen = PAGE_SIZE;
610 * kd->argbuf : used to pull in pages from the target process.
611 * the strings are copied out of here.
613 if (kd->argbuf == 0) {
614 kd->argbuf = (char *)_kvm_malloc(kd, PAGE_SIZE);
619 /* Pull in the target process'es argv vector */
620 cc = sizeof(char *) * narg;
621 if (kvm_uread(kd, pid, addr, (char *)kd->argv, cc) != cc)
624 * ap : saved start address of string we're working on in kd->argspc
625 * np : pointer to next place to write in kd->argspc
626 * len: length of data in kd->argspc
627 * argv: pointer to the argv vector that we are hunting around the
628 * target process space for, and converting to addresses in
629 * our address space (kd->argspc).
631 ap = np = kd->argspc;
635 * Loop over pages, filling in the argument vector.
636 * Note that the argv strings could be pointing *anywhere* in
637 * the user address space and are no longer contiguous.
638 * Note that *argv is modified when we are going to fetch a string
639 * that crosses a page boundary. We copy the next part of the string
640 * into to "np" and eventually convert the pointer.
642 while (argv < kd->argv + narg && *argv != 0) {
644 /* get the address that the current argv string is on */
645 addr = (u_long)*argv & ~(PAGE_SIZE - 1);
647 /* is it the same page as the last one? */
649 if (kvm_uread(kd, pid, addr, kd->argbuf, PAGE_SIZE) !=
655 /* offset within the page... kd->argbuf */
656 addr = (u_long)*argv & (PAGE_SIZE - 1);
658 /* cp = start of string, cc = count of chars in this chunk */
659 cp = kd->argbuf + addr;
660 cc = PAGE_SIZE - addr;
662 /* dont get more than asked for by user process */
663 if (maxcnt > 0 && cc > maxcnt - len)
666 /* pointer to end of string if we found it in this page */
667 ep = memchr(cp, '\0', cc);
671 * at this point, cc is the count of the chars that we are
672 * going to retrieve this time. we may or may not have found
673 * the end of it. (ep points to the null if the end is known)
676 /* will we exceed the malloc/realloced buffer? */
677 if (len + cc > kd->arglen) {
680 char *op = kd->argspc;
683 kd->argspc = (char *)_kvm_realloc(kd, kd->argspc,
688 * Adjust argv pointers in case realloc moved
691 off = kd->argspc - op;
692 for (pp = kd->argv; pp < argv; pp++)
697 /* np = where to put the next part of the string in kd->argspc*/
698 /* np is kinda redundant.. could use "kd->argspc + len" */
700 np += cc; /* inc counters */
704 * if end of string found, set the *argv pointer to the
705 * saved beginning of string, and advance. argv points to
706 * somewhere in kd->argv.. This is initially relative
707 * to the target process, but when we close it off, we set
708 * it to point in our address space.
714 /* update the address relative to the target process */
718 if (maxcnt > 0 && len >= maxcnt) {
720 * We're stopping prematurely. Terminate the
730 /* Make sure argv is terminated. */
736 ps_str_a(struct ps_strings *p, u_long *addr, int *n)
738 *addr = (u_long)p->ps_argvstr;
743 ps_str_e(struct ps_strings *p, u_long *addr, int *n)
745 *addr = (u_long)p->ps_envstr;
750 * Determine if the proc indicated by p is still active.
751 * This test is not 100% foolproof in theory, but chances of
752 * being wrong are very low.
755 proc_verify(kvm_t *kd, const struct kinfo_proc *p)
757 struct kinfo_proc kp;
764 mib[2] = KERN_PROC_PID;
768 error = sysctl(mib, 4, &kp, &len, NULL, 0);
772 error = (p->kp_pid == kp.kp_pid &&
773 (kp.kp_stat != SZOMB || p->kp_stat == SZOMB));
778 kvm_doargv(kvm_t *kd, const struct kinfo_proc *kp, int nchr,
779 void (*info)(struct ps_strings *, u_long *, int *))
784 static struct ps_strings arginfo;
785 static u_long ps_strings;
788 if (ps_strings == 0) {
789 len = sizeof(ps_strings);
790 if (sysctlbyname("kern.ps_strings", &ps_strings, &len, NULL,
792 ps_strings = PS_STRINGS;
796 * Pointers are stored at the top of the user stack.
798 if (kp->kp_stat == SZOMB ||
799 kvm_uread(kd, kp->kp_pid, ps_strings, (char *)&arginfo,
800 sizeof(arginfo)) != sizeof(arginfo))
803 (*info)(&arginfo, &addr, &cnt);
806 ap = kvm_argv(kd, kp->kp_pid, addr, cnt, nchr);
808 * For live kernels, make sure this process didn't go away.
810 if (ap != 0 && (kvm_ishost(kd) || kvm_isvkernel(kd)) &&
811 !proc_verify(kd, kp))
817 * Get the command args. This code is now machine independent.
820 kvm_getargv(kvm_t *kd, const struct kinfo_proc *kp, int nchr)
825 static unsigned long buflen;
826 static char *buf, *p;
830 if (!kvm_ishost(kd)) { /* XXX: vkernels */
831 _kvm_err(kd, kd->program,
832 "cannot read user space from dead kernel");
837 bufsz = sizeof(buflen);
838 i = sysctlbyname("kern.ps_arg_cache_limit",
839 &buflen, &bufsz, NULL, 0);
843 buf = malloc(buflen);
847 bufp = malloc(sizeof(char *) * argc);
853 oid[2] = KERN_PROC_ARGS;
856 i = sysctl(oid, 4, buf, &bufsz, 0, 0);
857 if (i == 0 && bufsz > 0) {
866 sizeof(char *) * argc);
868 } while (p < buf + bufsz);
873 if (kp->kp_flags & P_SYSTEM)
875 return (kvm_doargv(kd, kp, nchr, ps_str_a));
879 kvm_getenvv(kvm_t *kd, const struct kinfo_proc *kp, int nchr)
881 return (kvm_doargv(kd, kp, nchr, ps_str_e));
885 * Read from user space. The user context is given by pid.
888 kvm_uread(kvm_t *kd, pid_t pid, u_long uva, char *buf, size_t len)
891 char procfile[MAXPATHLEN];
895 if (!kvm_ishost(kd)) { /* XXX: vkernels */
896 _kvm_err(kd, kd->program,
897 "cannot read user space from dead kernel");
901 sprintf(procfile, "/proc/%d/mem", pid);
902 fd = open(procfile, O_RDONLY, 0);
904 _kvm_err(kd, kd->program, "cannot open %s", procfile);
912 if (lseek(fd, (off_t)uva, 0) == -1 && errno != 0) {
913 _kvm_err(kd, kd->program, "invalid address (%lx) in %s",
917 amount = read(fd, cp, len);
919 _kvm_syserr(kd, kd->program, "error reading %s",
924 _kvm_err(kd, kd->program, "EOF reading %s", procfile);
933 return ((ssize_t)(cp - buf));