1 .\" Copyright (c) 1992, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" This code is derived from software developed by the Computer Systems
5 .\" Engineering group at Lawrence Berkeley Laboratory under DARPA contract
6 .\" BG 91-66 and contributed to Berkeley.
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.
16 .\" 3. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" @(#)kvm_open.3 8.3 (Berkeley) 4/19/94
43 .Nd initialize kernel virtual memory access
50 .Fn kvm_open "const char *execfile" "const char *corefile" "const char *swapfile" "int flags" "const char *errstr"
53 .Fa "const char *execfile"
54 .Fa "const char *corefile"
57 .Fa "int (*resolver)(const char *name, kvaddr_t *addr)"
60 .Fn kvm_openfiles "const char *execfile" "const char *corefile" "const char *swapfile" "int flags" "char *errbuf"
62 .Fn kvm_close "kvm_t *kd"
69 return a descriptor used to access kernel virtual memory
73 Both active kernels and crash dumps are accessible
74 through this interface.
78 argument is the executable image of the kernel being examined.
79 This file must contain a symbol table.
82 the currently running system is assumed,
88 argument is the kernel memory device file.
91 or a crash dump core generated by
97 the default indicated by
102 It can also be set to a special value
106 that do not directly access kernel memory.
110 argument is currently unused.
114 argument indicates read/write access as in
116 and applies only to the core file.
126 library provides two different error reporting mechanisms.
127 One provides backward compatibility with the SunOS kvm library, while the
128 other provides an improved error reporting framework.
129 The mechanism used by a descriptor is determined by the function used to
134 function is the Sun kvm compatible open call.
137 argument indicates how errors should be handled.
140 no errors are reported and the application cannot know the
141 specific nature of the failed kvm call.
144 errors are printed to
148 prepended to the message, as in
150 Normally, the name of the program is used here.
151 The string is assumed to persist at least until the corresponding
161 style error reporting.
162 Here, error messages are not printed out by the library.
163 Instead, the application obtains the error message
164 corresponding to the most recent kvm library call using
168 The results are undefined if the most recent kvm call did not produce
172 requires a kvm descriptor, but the open routines return
176 cannot be used to get the error message if open fails.
181 will place any error message in the
184 This buffer should be _POSIX2_LINE_MAX characters large (from
189 argument points to a function used by the
191 library to map symbol names to kernel virtual addresses.
196 specifies the requested symbol name.
197 If the function is able to resolve the name to an address,
198 the address should be set in
200 and the function should return zero.
201 If the function is not able to resolve the name to an address,
202 it should return a non-zero value.
203 When opening a native kernel image,
207 to use an internal function to resolve symbol names.
208 Non-native kernel images
209 .Pq such as when cross-debugging a crash dump
218 functions return a descriptor to be used
219 in all subsequent kvm library calls.
220 The library is fully re-entrant.
223 is returned, in which case
227 write the error message into
234 function may fail and set the global variable
236 for any of the errors specified for
241 function may also fail and set
266 There should not be three open calls.
267 The ill-defined error semantics
268 of the Sun library and the desire to have a backward-compatible library