d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
d3e1307bf5
freebsd-skq/lib/libkvm/kvm.h

135 lines
4.1 KiB
C
Raw Normal View History

BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
/*-
General further adoption of SPDX licensing ID tags. Mainly focus on files that use BSD 3-Clause license. The Software Package Data Exchange (SPDX) group provides a specification to make it easier for automated tools to detect and summarize well known opensource licenses. We are gradually adopting the specification, noting that the tags are considered only advisory and do not, in any way, superceed or replace the license texts. Special thanks to Wind River for providing access to "The Duke of Highlander" tool: an older (2014) run over FreeBSD tree was useful as a starting point.
2017-11-20 19:49:47 +00:00
* SPDX-License-Identifier: BSD-3-Clause
*
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
* Copyright (c) 1989, 1993
* The Regents of the University of California. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96
2017-02-28 23:42:47 +00:00
* 3. Neither the name of the University nor the names of its contributors
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* @(#)kvm.h 8.1 (Berkeley) 6/2/93
$Id$ -> $FreeBSD$
1999-08-27 23:45:13 +00:00
* $FreeBSD$
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
*/
#ifndef _KVM_H_
#define _KVM_H_
Declare mkstemps().
1999-04-09 15:06:56 +00:00
#include <sys/cdefs.h>
Include types.h for C99 uintXX_t types.
2013-04-11 07:30:49 +00:00
#include <sys/types.h>
Declare mkstemps().
1999-04-09 15:06:56 +00:00
#include <nlist.h>
libkvm: fix build failures
2017-11-12 01:36:48 +00:00
/*
* Including vm/vm.h causes namespace pollution issues. For the
* most part, only things using kvm_walk_pages() need to #include it.
*/
#ifndef VM_H
typedef u_char vm_prot_t;
#endif
Declare mkstemps().
1999-04-09 15:06:56 +00:00
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
/* Default version symbol. */
#define VRS_SYM "_version"
#define VRS_KEY "VERSION"
o Merge <machine/ansi.h> and <machine/types.h> into a new header called <machine/_types.h>. o <machine/ansi.h> will continue to live so it can define MD clock macros, which are only MD because of gratuitous differences between architectures. o Change all headers to make use of this. This mainly involves changing: #ifdef _BSD_FOO_T_ typedef _BSD_FOO_T_ foo_t; #undef _BSD_FOO_T_ #endif to: #ifndef _FOO_T_DECLARED typedef __foo_t foo_t; #define _FOO_T_DECLARED #endif Concept by: bde Reviewed by: jake, obrien
2002-08-21 16:20:02 +00:00
#ifndef _SIZE_T_DECLARED
typedef __size_t size_t;
#define _SIZE_T_DECLARED
Declare size_t and ssize_t if they are not already declared, so that <kvm.h> is self-sufficient again. Moved typedefs and forward struct declarations out of __BEGIN_DECLS/ __END_DECLS. Don't comment out the prototype for kvm_uread(). This was a 4 year old kludge for previous breakage of self-sufficiency. The prototypwe was broken instead. Fixed bitrot (const poisoning) in the type of kvm_uread(). Fixed order of the declaration of kvm_uread().
1998-12-16 18:59:47 +00:00
#endif
o Merge <machine/ansi.h> and <machine/types.h> into a new header called <machine/_types.h>. o <machine/ansi.h> will continue to live so it can define MD clock macros, which are only MD because of gratuitous differences between architectures. o Change all headers to make use of this. This mainly involves changing: #ifdef _BSD_FOO_T_ typedef _BSD_FOO_T_ foo_t; #undef _BSD_FOO_T_ #endif to: #ifndef _FOO_T_DECLARED typedef __foo_t foo_t; #define _FOO_T_DECLARED #endif Concept by: bde Reviewed by: jake, obrien
2002-08-21 16:20:02 +00:00
#ifndef _SSIZE_T_DECLARED
typedef __ssize_t ssize_t;
#define _SSIZE_T_DECLARED
Declare size_t and ssize_t if they are not already declared, so that <kvm.h> is self-sufficient again. Moved typedefs and forward struct declarations out of __BEGIN_DECLS/ __END_DECLS. Don't comment out the prototype for kvm_uread(). This was a 4 year old kludge for previous breakage of self-sufficiency. The prototypwe was broken instead. Fixed bitrot (const poisoning) in the type of kvm_uread(). Fixed order of the declaration of kvm_uread().
1998-12-16 18:59:47 +00:00
#endif
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
Add support to libkvm for reading vmcores from other architectures. - Add a kvaddr_type to represent kernel virtual addresses instead of unsigned long. - Add a struct kvm_nlist which is a stripped down version of struct nlist that uses kvaddr_t for n_value. - Add a kvm_native() routine that returns true if an open kvm descriptor is for a native kernel and memory image. - Add a kvm_open2() function similar to kvm_openfiles(). It drops the unused 'swapfile' argument and adds a new function pointer argument for a symbol resolving function. Native kernels still use _fdnlist() from libc to resolve symbols if a resolver function is not supplied, but cross kernels require a resolver. - Add a kvm_nlist2() function similar to kvm_nlist() except that it uses struct kvm_nlist instead of struct nlist. - Add a kvm_read2() function similar to kvm_read() except that it uses kvaddr_t instead of unsigned long for the kernel virtual address. - Add a new kvm_arch switch of routines needed by a vmcore backend. Each backend is responsible for implementing kvm_read2() for a given vmcore format. - Use libelf to read headers from ELF kernels and cores (except for powerpc cores). - Add internal helper routines for the common page offset hash table used by the minidump backends. - Port all of the existing kvm backends to implement a kvm_arch switch and to be cross-friendly by using private constants instead of ones that vary by platform (e.g. PAGE_SIZE). Static assertions are present when a given backend is compiled natively to ensure the private constants match the real ones. - Enable all of the existing vmcore backends on all platforms. This means that libkvm on any platform should be able to perform KVA translation and read data from a vmcore of any platform. Tested on: amd64, i386, sparc64 (marius) Differential Revision: https://reviews.freebsd.org/D3341
2015-11-27 18:58:26 +00:00
typedef uint64_t kvaddr_t; /* An address in a target image. */
struct kvm_nlist {
const char *n_name;
unsigned char n_type;
kvaddr_t n_value;
};
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
typedef struct __kvm kvm_t;
struct kinfo_proc;
Declare size_t and ssize_t if they are not already declared, so that <kvm.h> is self-sufficient again. Moved typedefs and forward struct declarations out of __BEGIN_DECLS/ __END_DECLS. Don't comment out the prototype for kvm_uread(). This was a 4 year old kludge for previous breakage of self-sufficiency. The prototypwe was broken instead. Fixed bitrot (const poisoning) in the type of kvm_uread(). Fixed order of the declaration of kvm_uread().
1998-12-16 18:59:47 +00:00
struct proc;
Removed evil typedef kvm_swap_t and all uses of it (not many). Hoped for by: wollman
1999-01-27 11:29:15 +00:00
struct kvm_swap {
Oops, forgot this. Needed by libkvm.
1999-01-23 04:58:35 +00:00
char ksw_devname[32];
libkvm - extend a bit the swap statistics field. Change ksw_used and ksw_total to unsigned, which increases the maximum total swap that can be displayed properly from ~8TB to ~16TB. Obtained from: DragonflyBSD (ecc2e461) MFC after: 2 weeks
2017-01-02 15:12:11 +00:00
u_int ksw_used;
u_int ksw_total;
Oops, forgot this. Needed by libkvm.
1999-01-23 04:58:35 +00:00
int ksw_flags;
libkvm - extend a bit the swap statistics field. Change ksw_used and ksw_total to unsigned, which increases the maximum total swap that can be displayed properly from ~8TB to ~16TB. Obtained from: DragonflyBSD (ecc2e461) MFC after: 2 weeks
2017-01-02 15:12:11 +00:00
u_int ksw_reserved1;
u_int ksw_reserved2;
Removed evil typedef kvm_swap_t and all uses of it (not many). Hoped for by: wollman
1999-01-27 11:29:15 +00:00
};
Oops, forgot this. Needed by libkvm.
1999-01-23 04:58:35 +00:00
libkvm: add kvm_walk_pages API. This API allows callers to enumerate all known pages, including any direct map & kernel map virtual addresses, physical addresses, size, offset into the core, & protection configured. For architectures that support direct map addresses, also generate pages for any direct map only addresses that are not associated with kernel map addresses. Fix page size portability issue left behind from previous kvm page table lookup interface. Reviewed by: jhb Sponsored by: Backtrace I/O Differential Revision: https://reviews.freebsd.org/D12279
2017-11-11 23:30:58 +00:00
struct kvm_page {
unsigned int version;
u_long paddr;
u_long kmap_vaddr;
u_long dmap_vaddr;
vm_prot_t prot;
u_long offset;
size_t len;
/* end of version 1 */
};
Oops, forgot this. Needed by libkvm.
1999-01-23 04:58:35 +00:00
#define SWIF_DEV_PREFIX 0x0002
libkvm: add kvm_walk_pages API. This API allows callers to enumerate all known pages, including any direct map & kernel map virtual addresses, physical addresses, size, offset into the core, & protection configured. For architectures that support direct map addresses, also generate pages for any direct map only addresses that are not associated with kernel map addresses. Fix page size portability issue left behind from previous kvm page table lookup interface. Reviewed by: jhb Sponsored by: Backtrace I/O Differential Revision: https://reviews.freebsd.org/D12279
2017-11-11 23:30:58 +00:00
#define LIBKVM_WALK_PAGES_VERSION 1
Oops, forgot this. Needed by libkvm.
1999-01-23 04:58:35 +00:00
Declare size_t and ssize_t if they are not already declared, so that <kvm.h> is self-sufficient again. Moved typedefs and forward struct declarations out of __BEGIN_DECLS/ __END_DECLS. Don't comment out the prototype for kvm_uread(). This was a 4 year old kludge for previous breakage of self-sufficiency. The prototypwe was broken instead. Fixed bitrot (const poisoning) in the type of kvm_uread(). Fixed order of the declaration of kvm_uread().
1998-12-16 18:59:47 +00:00
__BEGIN_DECLS
Remove __P() usage.
2002-03-21 23:54:04 +00:00
int kvm_close(kvm_t *);
Not all programs including kvm.h include the necessary headers to use u_int, so prefer unsigned int. MFC after: 6 days Pointed out by: bz, kib, Mr Tinderbox
2010-03-01 09:46:27 +00:00
int kvm_dpcpu_setcpu(kvm_t *, unsigned int);
Remove __P() usage.
2002-03-21 23:54:04 +00:00
char **kvm_getargv(kvm_t *, const struct kinfo_proc *, int);
Add a new routine kvm_getcptime(3) for fetching the equivalent of 'kern.cp_time'. For a live kernel it uses the sysctl. For a crashdump, it first checks to see if the kernel has a 'cp_time' global symbol. If it does, it uses that. If that doesn't work, when it uses the recently added kvm_getmaxcpu(3) and kvm_getpcpu(3) routines to walk all the CPUs and sum up their counters. MFC after: 1 week
2008-08-19 21:30:36 +00:00
int kvm_getcptime(kvm_t *, long *);
Remove __P() usage.
2002-03-21 23:54:04 +00:00
char **kvm_getenvv(kvm_t *, const struct kinfo_proc *, int);
char *kvm_geterr(kvm_t *);
int kvm_getloadavg(kvm_t *, double [], int);
Add two new routines to libkvm for working with per-CPU data: kvm_getmaxcpu() and kvm_getpcpu(). MFC after: 1 week
2008-08-19 19:55:33 +00:00
int kvm_getmaxcpu(kvm_t *);
Add kvm_getncpus() to obtain mp_ncpus. Sponsored by: Nginx, Inc.
2014-02-12 19:22:48 +00:00
int kvm_getncpus(kvm_t *);
Add two new routines to libkvm for working with per-CPU data: kvm_getmaxcpu() and kvm_getpcpu(). MFC after: 1 week
2008-08-19 19:55:33 +00:00
void *kvm_getpcpu(kvm_t *, int);
o Provide function kvm_read_zpcpu() to access UMA_ZONE_PCPU allocations. o Provide function kvm_counter_u64_fetch() to fetch valut of a counter(9). Sponsored by: Nginx, Inc.
2013-04-10 20:26:53 +00:00
uint64_t kvm_counter_u64_fetch(kvm_t *, u_long);
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
struct kinfo_proc *
Remove __P() usage.
2002-03-21 23:54:04 +00:00
kvm_getprocs(kvm_t *, int, int, int *);
int kvm_getswapinfo(kvm_t *, struct kvm_swap *, int, int);
Add support to libkvm for reading vmcores from other architectures. - Add a kvaddr_type to represent kernel virtual addresses instead of unsigned long. - Add a struct kvm_nlist which is a stripped down version of struct nlist that uses kvaddr_t for n_value. - Add a kvm_native() routine that returns true if an open kvm descriptor is for a native kernel and memory image. - Add a kvm_open2() function similar to kvm_openfiles(). It drops the unused 'swapfile' argument and adds a new function pointer argument for a symbol resolving function. Native kernels still use _fdnlist() from libc to resolve symbols if a resolver function is not supplied, but cross kernels require a resolver. - Add a kvm_nlist2() function similar to kvm_nlist() except that it uses struct kvm_nlist instead of struct nlist. - Add a kvm_read2() function similar to kvm_read() except that it uses kvaddr_t instead of unsigned long for the kernel virtual address. - Add a new kvm_arch switch of routines needed by a vmcore backend. Each backend is responsible for implementing kvm_read2() for a given vmcore format. - Use libelf to read headers from ELF kernels and cores (except for powerpc cores). - Add internal helper routines for the common page offset hash table used by the minidump backends. - Port all of the existing kvm backends to implement a kvm_arch switch and to be cross-friendly by using private constants instead of ones that vary by platform (e.g. PAGE_SIZE). Static assertions are present when a given backend is compiled natively to ensure the private constants match the real ones. - Enable all of the existing vmcore backends on all platforms. This means that libkvm on any platform should be able to perform KVA translation and read data from a vmcore of any platform. Tested on: amd64, i386, sparc64 (marius) Differential Revision: https://reviews.freebsd.org/D3341
2015-11-27 18:58:26 +00:00
int kvm_native(kvm_t *);
Remove __P() usage.
2002-03-21 23:54:04 +00:00
int kvm_nlist(kvm_t *, struct nlist *);
Add support to libkvm for reading vmcores from other architectures. - Add a kvaddr_type to represent kernel virtual addresses instead of unsigned long. - Add a struct kvm_nlist which is a stripped down version of struct nlist that uses kvaddr_t for n_value. - Add a kvm_native() routine that returns true if an open kvm descriptor is for a native kernel and memory image. - Add a kvm_open2() function similar to kvm_openfiles(). It drops the unused 'swapfile' argument and adds a new function pointer argument for a symbol resolving function. Native kernels still use _fdnlist() from libc to resolve symbols if a resolver function is not supplied, but cross kernels require a resolver. - Add a kvm_nlist2() function similar to kvm_nlist() except that it uses struct kvm_nlist instead of struct nlist. - Add a kvm_read2() function similar to kvm_read() except that it uses kvaddr_t instead of unsigned long for the kernel virtual address. - Add a new kvm_arch switch of routines needed by a vmcore backend. Each backend is responsible for implementing kvm_read2() for a given vmcore format. - Use libelf to read headers from ELF kernels and cores (except for powerpc cores). - Add internal helper routines for the common page offset hash table used by the minidump backends. - Port all of the existing kvm backends to implement a kvm_arch switch and to be cross-friendly by using private constants instead of ones that vary by platform (e.g. PAGE_SIZE). Static assertions are present when a given backend is compiled natively to ensure the private constants match the real ones. - Enable all of the existing vmcore backends on all platforms. This means that libkvm on any platform should be able to perform KVA translation and read data from a vmcore of any platform. Tested on: amd64, i386, sparc64 (marius) Differential Revision: https://reviews.freebsd.org/D3341
2015-11-27 18:58:26 +00:00
int kvm_nlist2(kvm_t *, struct kvm_nlist *);
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
kvm_t *kvm_open
Fixed some style bugs in the removal of __P(()). Blind removal of spaces before __P(()) outdented continuation lines to column 0.
2003-10-13 04:44:55 +00:00
(const char *, const char *, const char *, int, const char *);
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
kvm_t *kvm_openfiles
Fixed some style bugs in the removal of __P(()). Blind removal of spaces before __P(()) outdented continuation lines to column 0.
2003-10-13 04:44:55 +00:00
(const char *, const char *, const char *, int, char *);
Add support to libkvm for reading vmcores from other architectures. - Add a kvaddr_type to represent kernel virtual addresses instead of unsigned long. - Add a struct kvm_nlist which is a stripped down version of struct nlist that uses kvaddr_t for n_value. - Add a kvm_native() routine that returns true if an open kvm descriptor is for a native kernel and memory image. - Add a kvm_open2() function similar to kvm_openfiles(). It drops the unused 'swapfile' argument and adds a new function pointer argument for a symbol resolving function. Native kernels still use _fdnlist() from libc to resolve symbols if a resolver function is not supplied, but cross kernels require a resolver. - Add a kvm_nlist2() function similar to kvm_nlist() except that it uses struct kvm_nlist instead of struct nlist. - Add a kvm_read2() function similar to kvm_read() except that it uses kvaddr_t instead of unsigned long for the kernel virtual address. - Add a new kvm_arch switch of routines needed by a vmcore backend. Each backend is responsible for implementing kvm_read2() for a given vmcore format. - Use libelf to read headers from ELF kernels and cores (except for powerpc cores). - Add internal helper routines for the common page offset hash table used by the minidump backends. - Port all of the existing kvm backends to implement a kvm_arch switch and to be cross-friendly by using private constants instead of ones that vary by platform (e.g. PAGE_SIZE). Static assertions are present when a given backend is compiled natively to ensure the private constants match the real ones. - Enable all of the existing vmcore backends on all platforms. This means that libkvm on any platform should be able to perform KVA translation and read data from a vmcore of any platform. Tested on: amd64, i386, sparc64 (marius) Differential Revision: https://reviews.freebsd.org/D3341
2015-11-27 18:58:26 +00:00
kvm_t *kvm_open2
(const char *, const char *, int, char *,
int (*)(const char *, kvaddr_t *));
Remove __P() usage.
2002-03-21 23:54:04 +00:00
ssize_t kvm_read(kvm_t *, unsigned long, void *, size_t);
While it isn't too late and kvm_read_zpcpu() function isn't yet used outside libkvm(3), change its order of arguments, so that it is the same as in kvm_read(). Sponsored by: Nginx, Inc.
2014-02-12 09:41:17 +00:00
ssize_t kvm_read_zpcpu(kvm_t *, unsigned long, void *, size_t, int);
Add support to libkvm for reading vmcores from other architectures. - Add a kvaddr_type to represent kernel virtual addresses instead of unsigned long. - Add a struct kvm_nlist which is a stripped down version of struct nlist that uses kvaddr_t for n_value. - Add a kvm_native() routine that returns true if an open kvm descriptor is for a native kernel and memory image. - Add a kvm_open2() function similar to kvm_openfiles(). It drops the unused 'swapfile' argument and adds a new function pointer argument for a symbol resolving function. Native kernels still use _fdnlist() from libc to resolve symbols if a resolver function is not supplied, but cross kernels require a resolver. - Add a kvm_nlist2() function similar to kvm_nlist() except that it uses struct kvm_nlist instead of struct nlist. - Add a kvm_read2() function similar to kvm_read() except that it uses kvaddr_t instead of unsigned long for the kernel virtual address. - Add a new kvm_arch switch of routines needed by a vmcore backend. Each backend is responsible for implementing kvm_read2() for a given vmcore format. - Use libelf to read headers from ELF kernels and cores (except for powerpc cores). - Add internal helper routines for the common page offset hash table used by the minidump backends. - Port all of the existing kvm backends to implement a kvm_arch switch and to be cross-friendly by using private constants instead of ones that vary by platform (e.g. PAGE_SIZE). Static assertions are present when a given backend is compiled natively to ensure the private constants match the real ones. - Enable all of the existing vmcore backends on all platforms. This means that libkvm on any platform should be able to perform KVA translation and read data from a vmcore of any platform. Tested on: amd64, i386, sparc64 (marius) Differential Revision: https://reviews.freebsd.org/D3341
2015-11-27 18:58:26 +00:00
ssize_t kvm_read2(kvm_t *, kvaddr_t, void *, size_t);
Remove __P() usage.
2002-03-21 23:54:04 +00:00
ssize_t kvm_write(kvm_t *, unsigned long, const void *, size_t);
libkvm: add kvm_walk_pages API. This API allows callers to enumerate all known pages, including any direct map & kernel map virtual addresses, physical addresses, size, offset into the core, & protection configured. For architectures that support direct map addresses, also generate pages for any direct map only addresses that are not associated with kernel map addresses. Fix page size portability issue left behind from previous kvm page table lookup interface. Reviewed by: jhb Sponsored by: Backtrace I/O Differential Revision: https://reviews.freebsd.org/D12279
2017-11-11 23:30:58 +00:00
typedef int kvm_walk_pages_cb_t(struct kvm_page *, void *);
int kvm_walk_pages(kvm_t *, kvm_walk_pages_cb_t *, void *);
BSD 4.4 Lite Include Sources
1994-05-24 09:57:34 +00:00
__END_DECLS
#endif /* !_KVM_H_ */
Reference in New Issue Copy Permalink