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 .\" 4. 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
42 .Nd initialize kernel virtual memory access
49 .Fn kvm_open "const char *execfile" "const char *corefile" "const char *swapfile" "int flags" "const char *errstr"
51 .Fn kvm_openfiles "const char *execfile" "const char *corefile" "const char *swapfile" "int flags" "char *errbuf"
53 .Fn kvm_close "kvm_t *kd"
59 return a descriptor used to access kernel virtual memory
63 Both active kernels and crash dumps are accessible
64 through this interface.
68 argument is the executable image of the kernel being examined.
69 This file must contain a symbol table.
72 the currently running system is assumed,
78 argument is the kernel memory device file.
81 or a crash dump core generated by
87 the default indicated by
92 It can also be set to a special value
96 that do not directly access kernel memory.
100 argument is currently unused.
104 argument indicates read/write access as in
106 and applies only to the core file.
114 There are two open routines which differ only with respect to
116 One provides backward compatibility with the SunOS kvm library, while the
117 other provides an improved error reporting framework.
121 function is the Sun kvm compatible open call.
124 argument indicates how errors should be handled.
127 no errors are reported and the application cannot know the
128 specific nature of the failed kvm call.
131 errors are printed to
135 prepended to the message, as in
137 Normally, the name of the program is used here.
138 The string is assumed to persist at least until the corresponding
146 style error reporting.
147 Here, error messages are not printed out by the library.
148 Instead, the application obtains the error message
149 corresponding to the most recent kvm library call using
153 The results are undefined if the most recent kvm call did not produce
157 requires a kvm descriptor, but the open routines return
161 cannot be used to get the error message if open fails.
164 will place any error message in the
167 This buffer should be _POSIX2_LINE_MAX characters large (from
174 functions both return a descriptor to be used
175 in all subsequent kvm library calls.
176 The library is fully re-entrant.
179 is returned, in which case
181 writes the error message into
188 function may fail and set the global variable
190 for any of the errors specified for
195 function may also fail and set
219 There should not be two open calls.
220 The ill-defined error semantics
221 of the Sun library and the desire to have a backward-compatible library