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.12 2007/02/18 16:15:23 corecode 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).
52 #include <sys/param.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))
94 static struct kinfo_proc *
95 kinfo_resize_proc(kvm_t *kd, struct kinfo_proc *bp)
100 size_t pos = bp - kd->procend;
101 size_t size = kd->procend - kd->procbase;
107 kd->procbase = _kvm_realloc(kd, kd->procbase, sizeof(*bp) * size);
108 if (kd->procbase == NULL)
110 kd->procend = kd->procbase + size;
111 bp = kd->procbase + pos;
116 * Read proc's from memory file into buffer bp, which has space to hold
117 * at most maxcnt procs.
120 kvm_proclist(kvm_t *kd, int what, int arg, struct proc *p,
121 struct kinfo_proc *bp)
129 struct thread thread;
132 struct vmspace vmspace;
133 struct prison prison;
137 for (; p != NULL; p = proc.p_list.le_next) {
138 if (KREAD(kd, (u_long)p, &proc)) {
139 _kvm_err(kd, kd->program, "can't read proc at %x", p);
142 if (KREAD(kd, (u_long)proc.p_ucred, &ucred)) {
143 _kvm_err(kd, kd->program, "can't read ucred at %p",
147 proc.p_ucred = &ucred;
149 switch(what & ~KERN_PROC_FLAGMASK) {
152 if (proc.p_pid != (pid_t)arg)
157 if (ucred.cr_uid != (uid_t)arg)
162 if (ucred.cr_ruid != (uid_t)arg)
167 if (KREAD(kd, (u_long)proc.p_pgrp, &pgrp)) {
168 _kvm_err(kd, kd->program, "can't read pgrp at %x",
174 if (KREAD(kd, (u_long)proc.p_pptr, &pproc)) {
175 _kvm_err(kd, kd->program, "can't read pproc at %x",
179 proc.p_pptr = &pproc;
181 if (KREAD(kd, (u_long)pgrp.pg_session, &sess)) {
182 _kvm_err(kd, kd->program, "can't read session at %x",
186 pgrp.pg_session = &sess;
188 if ((proc.p_flag & P_CONTROLT) && sess.s_ttyp != NULL) {
189 if (KREAD(kd, (u_long)sess.s_ttyp, &tty)) {
190 _kvm_err(kd, kd->program,
191 "can't read tty at %x", sess.s_ttyp);
195 if (tty.t_dev && tty.t_dev != NOCDEV) {
196 if (KREAD(kd, (u_long)tty.t_dev, &cdev))
201 if (tty.t_pgrp != NULL) {
202 if (KREAD(kd, (u_long)tty.t_pgrp, &tpgrp)) {
203 _kvm_err(kd, kd->program,
204 "can't read tpgrp at %x",
212 if (KREAD(kd, (u_long)proc.p_vmspace, &vmspace)) {
213 _kvm_err(kd, kd->program, "can't read vmspace at %p",
217 proc.p_vmspace = &vmspace;
219 if (ucred.cr_prison != NULL) {
220 if (KREAD(kd, (u_long)ucred.cr_prison, &prison)) {
221 _kvm_err(kd, kd->program, "can't read prison at %p",
225 ucred.cr_prison = &prison;
228 switch (what & ~KERN_PROC_FLAGMASK) {
231 if (proc.p_pgrp->pg_id != (pid_t)arg)
236 if ((proc.p_flag & P_CONTROLT) == 0 ||
237 proc.p_pgrp->pg_session->s_ttyp->t_dev->si_udev
243 if ((bp = kinfo_resize_proc(kd, bp)) == NULL)
245 fill_kinfo_proc(&proc, bp);
246 bp->kp_paddr = (uintptr_t)p;
248 lwppos = (uintptr_t)proc.p_lwps.lh_first;
250 bp++; /* Just export the proc then */
251 while (lwppos != 0) {
252 if (KREAD(kd, lwppos, &lwp)) {
253 _kvm_err(kd, kd->program, "can't read lwp at %p",
257 if (p != lwp.lwp_proc) {
258 _kvm_err(kd, kd->program, "lwp has wrong parent");
261 lwp.lwp_proc = &proc;
262 if (KREAD(kd, (u_long)lwp.lwp_thread, &thread)) {
263 _kvm_err(kd, kd->program, "can't read thread at %x",
267 lwp.lwp_thread = &thread;
269 if ((bp = kinfo_resize_proc(kd, bp)) == NULL)
271 fill_kinfo_proc(&proc, bp);
272 fill_kinfo_lwp(&lwp, &bp->kp_lwp);
273 bp->kp_paddr = (uintptr_t)p;
275 if ((what & KERN_PROC_FLAG_LWP) == 0)
278 lwppos = (uintptr_t)lwp.lwp_list.le_next;
285 * Build proc info array by reading in proc list from a crash dump.
286 * We reallocate kd->procbase as necessary.
289 kvm_deadprocs(kvm_t *kd, int what, int arg, u_long a_allproc,
292 struct kinfo_proc *bp = kd->procbase;
296 if (KREAD(kd, a_allproc, &p)) {
297 _kvm_err(kd, kd->program, "cannot read allproc");
300 acnt = kvm_proclist(kd, what, arg, p, bp);
304 if (KREAD(kd, a_zombproc, &p)) {
305 _kvm_err(kd, kd->program, "cannot read zombproc");
308 zcnt = kvm_proclist(kd, what, arg, p, bp + acnt);
312 return (acnt + zcnt);
316 kvm_getprocs(kvm_t *kd, int op, int arg, int *cnt)
318 int mib[4], st, nprocs;
321 if (kd->procbase != 0) {
322 free((void *)kd->procbase);
324 * Clear this pointer in case this call fails. Otherwise,
325 * kvm_close() will free it again.
335 st = sysctl(mib, op == KERN_PROC_ALL ? 3 : 4, NULL, &size, NULL, 0);
337 _kvm_syserr(kd, kd->program, "kvm_getprocs");
342 kd->procbase = (struct kinfo_proc *)
343 _kvm_realloc(kd, kd->procbase, size);
344 if (kd->procbase == 0)
346 st = sysctl(mib, op == KERN_PROC_ALL ? 3 : 4,
347 kd->procbase, &size, NULL, 0);
348 } while (st == -1 && errno == ENOMEM);
350 _kvm_syserr(kd, kd->program, "kvm_getprocs");
353 if (size % sizeof(struct kinfo_proc) != 0) {
354 _kvm_err(kd, kd->program,
355 "proc size mismatch (%d total, %d chunks)",
356 size, sizeof(struct kinfo_proc));
359 nprocs = size / sizeof(struct kinfo_proc);
361 struct nlist nl[4], *p;
363 nl[0].n_name = "_nprocs";
364 nl[1].n_name = "_allproc";
365 nl[2].n_name = "_zombproc";
368 if (kvm_nlist(kd, nl) != 0) {
369 for (p = nl; p->n_type != 0; ++p)
371 _kvm_err(kd, kd->program,
372 "%s: no such symbol", p->n_name);
375 if (KREAD(kd, nl[0].n_value, &nprocs)) {
376 _kvm_err(kd, kd->program, "can't read nprocs");
379 nprocs = kvm_deadprocs(kd, op, arg, nl[1].n_value,
382 size = nprocs * sizeof(struct kinfo_proc);
383 (void)realloc(kd->procbase, size);
387 return (kd->procbase);
391 _kvm_freeprocs(kvm_t *kd)
400 _kvm_realloc(kvm_t *kd, void *p, size_t n)
402 void *np = (void *)realloc(p, n);
406 _kvm_err(kd, kd->program, "out of memory");
412 #define MAX(a, b) ((a) > (b) ? (a) : (b))
416 * Read in an argument vector from the user address space of process pid.
417 * addr if the user-space base address of narg null-terminated contiguous
418 * strings. This is used to read in both the command arguments and
419 * environment strings. Read at most maxcnt characters of strings.
422 kvm_argv(kvm_t *kd, pid_t pid, u_long addr, int narg, int maxcnt)
424 char *np, *cp, *ep, *ap;
430 * Check that there aren't an unreasonable number of agruments,
431 * and that the address is in user space.
434 addr < VM_MIN_USER_ADDRESS || addr >= VM_MAX_USER_ADDRESS) {
439 * kd->argv : work space for fetching the strings from the target
440 * process's space, and is converted for returning to caller
444 * Try to avoid reallocs.
446 kd->argc = MAX(narg + 1, 32);
447 kd->argv = (char **)_kvm_malloc(kd, kd->argc *
451 } else if (narg + 1 > kd->argc) {
452 kd->argc = MAX(2 * kd->argc, narg + 1);
453 kd->argv = (char **)_kvm_realloc(kd, kd->argv, kd->argc *
459 * kd->argspc : returned to user, this is where the kd->argv
460 * arrays are left pointing to the collected strings.
462 if (kd->argspc == 0) {
463 kd->argspc = (char *)_kvm_malloc(kd, PAGE_SIZE);
466 kd->arglen = PAGE_SIZE;
469 * kd->argbuf : used to pull in pages from the target process.
470 * the strings are copied out of here.
472 if (kd->argbuf == 0) {
473 kd->argbuf = (char *)_kvm_malloc(kd, PAGE_SIZE);
478 /* Pull in the target process'es argv vector */
479 cc = sizeof(char *) * narg;
480 if (kvm_uread(kd, pid, addr, (char *)kd->argv, cc) != cc)
483 * ap : saved start address of string we're working on in kd->argspc
484 * np : pointer to next place to write in kd->argspc
485 * len: length of data in kd->argspc
486 * argv: pointer to the argv vector that we are hunting around the
487 * target process space for, and converting to addresses in
488 * our address space (kd->argspc).
490 ap = np = kd->argspc;
494 * Loop over pages, filling in the argument vector.
495 * Note that the argv strings could be pointing *anywhere* in
496 * the user address space and are no longer contiguous.
497 * Note that *argv is modified when we are going to fetch a string
498 * that crosses a page boundary. We copy the next part of the string
499 * into to "np" and eventually convert the pointer.
501 while (argv < kd->argv + narg && *argv != 0) {
503 /* get the address that the current argv string is on */
504 addr = (u_long)*argv & ~(PAGE_SIZE - 1);
506 /* is it the same page as the last one? */
508 if (kvm_uread(kd, pid, addr, kd->argbuf, PAGE_SIZE) !=
514 /* offset within the page... kd->argbuf */
515 addr = (u_long)*argv & (PAGE_SIZE - 1);
517 /* cp = start of string, cc = count of chars in this chunk */
518 cp = kd->argbuf + addr;
519 cc = PAGE_SIZE - addr;
521 /* dont get more than asked for by user process */
522 if (maxcnt > 0 && cc > maxcnt - len)
525 /* pointer to end of string if we found it in this page */
526 ep = memchr(cp, '\0', cc);
530 * at this point, cc is the count of the chars that we are
531 * going to retrieve this time. we may or may not have found
532 * the end of it. (ep points to the null if the end is known)
535 /* will we exceed the malloc/realloced buffer? */
536 if (len + cc > kd->arglen) {
539 char *op = kd->argspc;
542 kd->argspc = (char *)_kvm_realloc(kd, kd->argspc,
547 * Adjust argv pointers in case realloc moved
550 off = kd->argspc - op;
551 for (pp = kd->argv; pp < argv; pp++)
556 /* np = where to put the next part of the string in kd->argspc*/
557 /* np is kinda redundant.. could use "kd->argspc + len" */
559 np += cc; /* inc counters */
563 * if end of string found, set the *argv pointer to the
564 * saved beginning of string, and advance. argv points to
565 * somewhere in kd->argv.. This is initially relative
566 * to the target process, but when we close it off, we set
567 * it to point in our address space.
573 /* update the address relative to the target process */
577 if (maxcnt > 0 && len >= maxcnt) {
579 * We're stopping prematurely. Terminate the
589 /* Make sure argv is terminated. */
595 ps_str_a(struct ps_strings *p, u_long *addr, int *n)
597 *addr = (u_long)p->ps_argvstr;
602 ps_str_e(struct ps_strings *p, u_long *addr, int *n)
604 *addr = (u_long)p->ps_envstr;
609 * Determine if the proc indicated by p is still active.
610 * This test is not 100% foolproof in theory, but chances of
611 * being wrong are very low.
614 proc_verify(kvm_t *kd, const struct kinfo_proc *p)
616 struct kinfo_proc kp;
623 mib[2] = KERN_PROC_PID;
627 error = sysctl(mib, 4, &kp, &len, NULL, 0);
631 error = (p->kp_pid == kp.kp_pid &&
632 (kp.kp_stat != SZOMB || p->kp_stat == SZOMB));
637 kvm_doargv(kvm_t *kd, const struct kinfo_proc *kp, int nchr,
638 void (*info)(struct ps_strings *, u_long *, int *))
643 static struct ps_strings arginfo;
644 static u_long ps_strings;
647 if (ps_strings == NULL) {
648 len = sizeof(ps_strings);
649 if (sysctlbyname("kern.ps_strings", &ps_strings, &len, NULL,
651 ps_strings = PS_STRINGS;
655 * Pointers are stored at the top of the user stack.
657 if (kp->kp_stat == SZOMB ||
658 kvm_uread(kd, kp->kp_pid, ps_strings, (char *)&arginfo,
659 sizeof(arginfo)) != sizeof(arginfo))
662 (*info)(&arginfo, &addr, &cnt);
665 ap = kvm_argv(kd, kp->kp_pid, addr, cnt, nchr);
667 * For live kernels, make sure this process didn't go away.
669 if (ap != 0 && ISALIVE(kd) &&
670 !proc_verify(kd, kp))
676 * Get the command args. This code is now machine independent.
679 kvm_getargv(kvm_t *kd, const struct kinfo_proc *kp, int nchr)
684 static unsigned long buflen;
685 static char *buf, *p;
690 _kvm_err(kd, kd->program,
691 "cannot read user space from dead kernel");
696 bufsz = sizeof(buflen);
697 i = sysctlbyname("kern.ps_arg_cache_limit",
698 &buflen, &bufsz, NULL, 0);
702 buf = malloc(buflen);
706 bufp = malloc(sizeof(char *) * argc);
712 oid[2] = KERN_PROC_ARGS;
715 i = sysctl(oid, 4, buf, &bufsz, 0, 0);
716 if (i == 0 && bufsz > 0) {
725 sizeof(char *) * argc);
727 } while (p < buf + bufsz);
732 if (kp->kp_flags & P_SYSTEM)
734 return (kvm_doargv(kd, kp, nchr, ps_str_a));
738 kvm_getenvv(kvm_t *kd, const struct kinfo_proc *kp, int nchr)
740 return (kvm_doargv(kd, kp, nchr, ps_str_e));
744 * Read from user space. The user context is given by pid.
747 kvm_uread(kvm_t *kd, pid_t pid, u_long uva, char *buf, size_t len)
750 char procfile[MAXPATHLEN];
755 _kvm_err(kd, kd->program,
756 "cannot read user space from dead kernel");
760 sprintf(procfile, "/proc/%d/mem", pid);
761 fd = open(procfile, O_RDONLY, 0);
763 _kvm_err(kd, kd->program, "cannot open %s", procfile);
771 if (lseek(fd, (off_t)uva, 0) == -1 && errno != 0) {
772 _kvm_err(kd, kd->program, "invalid address (%x) in %s",
776 amount = read(fd, cp, len);
778 _kvm_syserr(kd, kd->program, "error reading %s",
783 _kvm_err(kd, kd->program, "EOF reading %s", procfile);
792 return ((ssize_t)(cp - buf));