lib/libkvm/kvm.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1989, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)kvm.h       8.1 (Berkeley) 6/2/93
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef _KVM_H_
  36 #define _KVM_H_
  37
  38 #include <sys/cdefs.h>
  39 #include <sys/types.h>
  40 #include <nlist.h>
  41
  42 /*
  43  * Including vm/vm.h causes namespace pollution issues.  For the
  44  * most part, only things using kvm_walk_pages() need to #include it.
  45  */
  46 #ifndef VM_H
  47 typedef u_char vm_prot_t;
  48 #endif
  49
  50 /* Default version symbol. */
  51 #define VRS_SYM         "_version"
  52 #define VRS_KEY         "VERSION"
  53
  54 #ifndef _SIZE_T_DECLARED
  55 typedef __size_t        size_t;
  56 #define _SIZE_T_DECLARED
  57 #endif
  58
  59 #ifndef _SSIZE_T_DECLARED
  60 typedef __ssize_t       ssize_t;
  61 #define _SSIZE_T_DECLARED
  62 #endif
  63
  64 typedef uint64_t kvaddr_t;              /* An address in a target image. */
  65
  66 struct kvm_nlist {
  67         const char *n_name;
  68         unsigned char n_type;
  69         kvaddr_t n_value;
  70 };
  71
  72 typedef struct __kvm kvm_t;
  73
  74 struct kinfo_proc;
  75 struct proc;
  76
  77 struct kvm_swap {
  78         char    ksw_devname[32];
  79         u_int   ksw_used;
  80         u_int   ksw_total;
  81         int     ksw_flags;
  82         u_int   ksw_reserved1;
  83         u_int   ksw_reserved2;
  84 };
  85
  86 struct kvm_page {
  87         unsigned int version;
  88         u_long paddr;
  89         u_long kmap_vaddr;
  90         u_long dmap_vaddr;
  91         vm_prot_t prot;
  92         u_long offset;
  93         size_t len;
  94         /* end of version 1 */
  95 };
  96
  97 #define SWIF_DEV_PREFIX 0x0002
  98 #define LIBKVM_WALK_PAGES_VERSION       1
  99
 100 __BEGIN_DECLS
 101 int       kvm_close(kvm_t *);
 102 int       kvm_dpcpu_setcpu(kvm_t *, unsigned int);
 103 char    **kvm_getargv(kvm_t *, const struct kinfo_proc *, int);
 104 int       kvm_getcptime(kvm_t *, long *);
 105 char    **kvm_getenvv(kvm_t *, const struct kinfo_proc *, int);
 106 char     *kvm_geterr(kvm_t *);
 107 int       kvm_getloadavg(kvm_t *, double [], int);
 108 int       kvm_getmaxcpu(kvm_t *);
 109 int       kvm_getncpus(kvm_t *);
 110 void     *kvm_getpcpu(kvm_t *, int);
 111 uint64_t  kvm_counter_u64_fetch(kvm_t *, u_long);
 112 struct kinfo_proc *
 113           kvm_getprocs(kvm_t *, int, int, int *);
 114 int       kvm_getswapinfo(kvm_t *, struct kvm_swap *, int, int);
 115 int       kvm_native(kvm_t *);
 116 int       kvm_nlist(kvm_t *, struct nlist *);
 117 int       kvm_nlist2(kvm_t *, struct kvm_nlist *);
 118 kvm_t    *kvm_open
 119             (const char *, const char *, const char *, int, const char *);
 120 kvm_t    *kvm_openfiles
 121             (const char *, const char *, const char *, int, char *);
 122 kvm_t    *kvm_open2
 123             (const char *, const char *, int, char *,
 124             int (*)(const char *, kvaddr_t *));
 125 ssize_t   kvm_read(kvm_t *, unsigned long, void *, size_t);
 126 ssize_t   kvm_read_zpcpu(kvm_t *, unsigned long, void *, size_t, int);
 127 ssize_t   kvm_read2(kvm_t *, kvaddr_t, void *, size_t);
 128 ssize_t   kvm_write(kvm_t *, unsigned long, const void *, size_t);
 129
 130 typedef int kvm_walk_pages_cb_t(struct kvm_page *, void *);
 131 int kvm_walk_pages(kvm_t *, kvm_walk_pages_cb_t *, void *);
 132 __END_DECLS
 133
 134 #endif /* !_KVM_H_ */