2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2009 Robert N. M. Watson
5 * Copyright (c) 2009 Bjoern A. Zeeb <bz@FreeBSD.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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
30 #include <sys/cdefs.h>
31 #include <sys/param.h>
37 #include <sys/_lock.h>
38 #include <sys/_mutex.h>
39 #include <sys/_task.h>
42 #include <sys/types.h>
52 #include "kvm_private.h"
55 * Set up libkvm to handle virtual network stack symbols by selecting a
59 _kvm_vnet_selectpid(kvm_t *kd, pid_t pid)
65 struct kvm_nlist nl[] = {
67 * Note: kvm_nlist strips the first '_' so add an extra one
68 * here to __{start,stop}_set_vnet.
70 #define NLIST_START_VNET 0
71 { .n_name = "___start_" VNET_SETNAME },
72 #define NLIST_STOP_VNET 1
73 { .n_name = "___stop_" VNET_SETNAME },
74 #define NLIST_VNET_HEAD 2
75 { .n_name = "vnet_head" },
76 #define NLIST_ALLPROC 3
77 { .n_name = "allproc" },
78 #define NLIST_DUMPTID 4
79 { .n_name = "dumptid" },
81 { .n_name = "proc0" },
84 uintptr_t procp, credp;
85 #define VMCORE_VNET_OF_PROC0
86 #ifndef VMCORE_VNET_OF_PROC0
93 * XXX: This only works for native kernels for now.
99 * Locate and cache locations of important symbols
100 * using the internal version of _kvm_nlist, turning
101 * off initialization to avoid recursion in case of
102 * unresolveable symbols.
104 if (_kvm_nlist(kd, nl, 0) != 0) {
106 * XXX-BZ: ___start_/___stop_VNET_SETNAME may fail.
107 * For now do not report an error here as we are called
108 * internally and in `void context' until we merge the
109 * functionality to optionally activate this into programs.
110 * By that time we can properly fail and let the callers
113 /* _kvm_err(kd, kd->program, "%s: no namelist", __func__); */
118 * Auto-detect if this is a crashdump by reading dumptid.
121 if (nl[NLIST_DUMPTID].n_value) {
122 if (kvm_read(kd, nl[NLIST_DUMPTID].n_value, &dumptid,
123 sizeof(dumptid)) != sizeof(dumptid)) {
124 _kvm_err(kd, kd->program, "%s: dumptid", __func__);
130 * First, find the process for this pid. If we are working on a
131 * dump, either locate the thread dumptid is referring to or proc0.
132 * Based on either, take the address of the ucred.
136 procp = nl[NLIST_ALLPROC].n_value;
137 #ifdef VMCORE_VNET_OF_PROC0
139 procp = nl[NLIST_PROC0].n_value;
144 if (kvm_read(kd, procp, &proc, sizeof(proc)) != sizeof(proc)) {
145 _kvm_err(kd, kd->program, "%s: proc", __func__);
148 #ifndef VMCORE_VNET_OF_PROC0
150 tdp = (uintptr_t)TAILQ_FIRST(&proc.p_threads);
152 if (kvm_read(kd, tdp, &td, sizeof(td)) !=
154 _kvm_err(kd, kd->program, "%s: thread",
158 if (td.td_tid == dumptid) {
159 credp = (uintptr_t)td.td_ucred;
162 tdp = (uintptr_t)TAILQ_NEXT(&td, td_plist);
166 if (proc.p_pid == pid)
167 credp = (uintptr_t)proc.p_ucred;
170 procp = (uintptr_t)LIST_NEXT(&proc, p_list);
173 _kvm_err(kd, kd->program, "%s: pid/tid not found", __func__);
176 if (kvm_read(kd, (uintptr_t)credp, &cred, sizeof(cred)) !=
178 _kvm_err(kd, kd->program, "%s: cred", __func__);
181 if (cred.cr_prison == NULL) {
182 _kvm_err(kd, kd->program, "%s: no jail", __func__);
185 if (kvm_read(kd, (uintptr_t)cred.cr_prison, &prison, sizeof(prison)) !=
187 _kvm_err(kd, kd->program, "%s: prison", __func__);
190 if (prison.pr_vnet == NULL) {
191 _kvm_err(kd, kd->program, "%s: no vnet", __func__);
194 if (kvm_read(kd, (uintptr_t)prison.pr_vnet, &vnet, sizeof(vnet)) !=
196 _kvm_err(kd, kd->program, "%s: vnet", __func__);
199 if (vnet.vnet_magic_n != VNET_MAGIC_N) {
200 _kvm_err(kd, kd->program, "%s: invalid vnet magic#", __func__);
203 kd->vnet_initialized = 1;
204 kd->vnet_start = nl[NLIST_START_VNET].n_value;
205 kd->vnet_stop = nl[NLIST_STOP_VNET].n_value;
206 kd->vnet_current = (uintptr_t)prison.pr_vnet;
207 kd->vnet_base = vnet.vnet_data_base;
212 * Check whether the vnet module has been initialized successfully
213 * or not, initialize it if permitted.
216 _kvm_vnet_initialized(kvm_t *kd, int intialize)
219 if (kd->vnet_initialized || !intialize)
220 return (kd->vnet_initialized);
222 (void) _kvm_vnet_selectpid(kd, getpid());
224 return (kd->vnet_initialized);
228 * Check whether the value is within the vnet symbol range and
229 * only if so adjust the offset relative to the current base.
232 _kvm_vnet_validaddr(kvm_t *kd, kvaddr_t value)
238 if (!kd->vnet_initialized)
241 if (value < kd->vnet_start || value >= kd->vnet_stop)
244 return (kd->vnet_base + value);