lib/libkvm/kvm.h

   1 /*-
   2  * Copyright (c) 1989, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  *      @(#)kvm.h       8.1 (Berkeley) 6/2/93
  30  * $FreeBSD: src/lib/libkvm/kvm.h,v 1.11 1999/08/27 23:44:50 peter Exp $
  31  */
  32
  33 #ifndef _KVM_H_
  34 #define _KVM_H_
  35
  36 #include <sys/cdefs.h>
  37 #include <machine/stdint.h>
  38 #include <nlist.h>
  39
  40 /* Default version symbol. */
  41 #define VRS_SYM         "_version"
  42 #define VRS_KEY         "VERSION"
  43
  44 typedef struct __kvm kvm_t;
  45
  46 struct kinfo_file;
  47 struct kinfo_proc;
  48 struct nchstats;
  49 struct proc;
  50 struct vm_map;
  51 struct vm_map_entry;
  52
  53 struct kvm_swap {
  54         char    ksw_devname[64];
  55         u_int   ksw_used;
  56         u_int   ksw_total;
  57         int     ksw_flags;
  58         u_int   ksw_reserved1;
  59         u_int   ksw_reserved2;
  60 };
  61
  62 #define SWIF_DUMP_TREE  0x0001
  63 #define SWIF_DEV_PREFIX 0x0002
  64
  65 __BEGIN_DECLS
  66 int       kvm_close (kvm_t *);
  67 char    **kvm_getargv (kvm_t *, const struct kinfo_proc *, int);
  68 char    **kvm_getenvv (kvm_t *, const struct kinfo_proc *, int);
  69 char     *kvm_geterr (kvm_t *);
  70 struct kinfo_file *
  71           kvm_getfiles (kvm_t *, int, int, int *);
  72 int       kvm_getloadavg (kvm_t *, double [], int);
  73 struct kinfo_proc *
  74           kvm_getprocs (kvm_t *, int, int, int *);
  75 int       kvm_getswapinfo (kvm_t *, struct kvm_swap *, int, int);
  76 void      kvm_nch_cpuagg (struct nchstats *, struct nchstats *, int);
  77 int       kvm_nlist (kvm_t *, struct nlist *);
  78 kvm_t    *kvm_open (const char *, const char *, const char *, int,
  79                     const char *);
  80 kvm_t    *kvm_openfiles (const char *, const char *, const char *, int, char *);
  81 __ssize_t kvm_read (kvm_t *, unsigned long, void *, __size_t);
  82 char     *kvm_readstr (kvm_t *, u_long, char *, size_t *);
  83 __ssize_t kvm_uread (kvm_t *, pid_t, unsigned long, char *, __size_t);
  84 __ssize_t kvm_write (kvm_t *, unsigned long, const void *, __size_t);
  85 struct vm_map_entry *
  86           kvm_vm_map_entry_first (kvm_t *, struct vm_map *,
  87                                   struct vm_map_entry *);
  88 struct vm_map_entry *
  89           kvm_vm_map_entry_next (kvm_t *, struct vm_map_entry *,
  90                                  struct vm_map_entry *);
  91 __END_DECLS
  92
  93 #endif /* !_KVM_H_ */