1.\" Copyright (c) 1992, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 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. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 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. All advertising materials mentioning features or use of this software 17.\" must display the following acknowledgement: 18.\" This product includes software developed by the University of 19.\" California, Berkeley and its contributors. 20.\" 4. Neither the name of the University nor the names of its contributors 21.\" may be used to endorse or promote products derived from this software 22.\" without specific prior written permission. 23.\" 24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34.\" SUCH DAMAGE. 35.\" 36.\" @(#)kvm_open.3 8.3 (Berkeley) 4/19/94 37.\" $FreeBSD: src/lib/libkvm/kvm_open.3,v 1.5.2.6 2001/12/17 10:08:30 ru Exp $ 38.\" $DragonFly: src/lib/libkvm/kvm_open.3,v 1.3 2006/02/17 19:35:07 swildner Exp $ 39.\" 40.Dd April 19, 1994 41.Dt KVM_OPEN 3 42.Os 43.Sh NAME 44.Nm kvm_open , 45.Nm kvm_openfiles , 46.Nm kvm_close 47.Nd initialize kernel virtual memory access 48.Sh LIBRARY 49.Lb libkvm 50.Sh SYNOPSIS 51.In fcntl.h 52.In kvm.h 53.Ft kvm_t * 54.Fn kvm_open "const char *execfile" "const char *corefile" "const char *swapfile" "int flags" "const char *errstr" 55.Ft kvm_t * 56.Fn kvm_openfiles "const char *execfile" "const char *corefile" "const char *swapfile" "int flags" "char *errbuf" 57.Ft int 58.Fn kvm_close "kvm_t *kd" 59.Sh DESCRIPTION 60The functions 61.Fn kvm_open 62and 63.Fn kvm_openfiles 64return a descriptor used to access kernel virtual memory 65via the 66.Xr kvm 3 67library routines. Both active kernels and crash dumps are accessible 68through this interface. 69.Pp 70.Fa execfile 71is the executable image of the kernel being examined. 72This file must contain a symbol table. 73If this argument is 74.Dv NULL , 75the currently running system is assumed, 76as determined from 77.Xr getbootfile 3 . 78.Pp 79.Fa corefile 80is the kernel memory device file. It can be either /dev/mem 81or a crash dump core generated by 82.Xr savecore 8 . 83If 84.Fa corefile 85is 86.Dv NULL , 87the default indicated by 88.Dv _PATH_MEM 89from <paths.h> is used. 90.Pp 91.Fa swapfile 92should indicate the swap device. If 93.Dv NULL , 94.Dv _PATH_DRUM 95from <paths.h> is used. 96.Pp 97The 98.Fa flags 99argument indicates read/write access as in 100.Xr open 2 101and applies only to the core file. 102Only 103.Dv O_RDONLY , 104.Dv O_WRONLY , 105and 106.Dv O_RDWR 107are permitted. 108.Pp 109There are two open routines which differ only with respect to 110the error mechanism. 111One provides backward compatibility with the SunOS kvm library, while the 112other provides an improved error reporting framework. 113.Pp 114The 115.Fn kvm_open 116function is the Sun kvm compatible open call. Here, the 117.Fa errstr 118argument indicates how errors should be handled. If it is 119.Dv NULL , 120no errors are reported and the application cannot know the 121specific nature of the failed kvm call. 122If it is not 123.Dv NULL , 124errors are printed to stderr with 125.Fa errstr 126prepended to the message, as in 127.Xr perror 3 . 128Normally, the name of the program is used here. 129The string is assumed to persist at least until the corresponding 130.Fn kvm_close 131call. 132.Pp 133The 134.Fn kvm_openfiles 135function provides 136.Bx 137style error reporting. 138Here, error messages are not printed out by the library. 139Instead, the application obtains the error message 140corresponding to the most recent kvm library call using 141.Fn kvm_geterr 142(see 143.Xr kvm_geterr 3 ) . 144The results are undefined if the most recent kvm call did not produce 145an error. 146Since 147.Fn kvm_geterr 148requires a kvm descriptor, but the open routines return 149.Dv NULL 150on failure, 151.Fn kvm_geterr 152cannot be used to get the error message if open fails. 153Thus, 154.Fn kvm_openfiles 155will place any error message in the 156.Fa errbuf 157argument. This buffer should be _POSIX2_LINE_MAX characters large (from 158<limits.h>). 159.Sh RETURN VALUES 160The 161.Fn kvm_open 162and 163.Fn kvm_openfiles 164functions both return a descriptor to be used 165in all subsequent kvm library calls. 166The library is fully re-entrant. 167On failure, 168.Dv NULL 169is returned, in which case 170.Fn kvm_openfiles 171writes the error message into 172.Fa errbuf . 173.Pp 174The 175.Fn kvm_close 176function returns 0 on success and -1 on failure. 177.Sh SEE ALSO 178.Xr open 2 , 179.Xr kvm 3 , 180.Xr kvm_getargv 3 , 181.Xr kvm_getenvv 3 , 182.Xr kvm_geterr 3 , 183.Xr kvm_getprocs 3 , 184.Xr kvm_nlist 3 , 185.Xr kvm_read 3 , 186.Xr kvm_write 3 187.Sh BUGS 188There should not be two open calls. The ill-defined error semantics 189of the Sun library and the desire to have a backward-compatible library 190for 191.Bx 192left little choice. 193