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. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  *      @(#)kvm.h       8.1 (Berkeley) 6/2/93
  34  * $FreeBSD: src/lib/libkvm/kvm.h,v 1.11 1999/08/27 23:44:50 peter Exp $
  35  * $DragonFly: src/lib/libkvm/kvm.h,v 1.4 2003/11/12 20:21:30 eirikn Exp $
  36  */
  37
  38 #ifndef _KVM_H_
  39 #define _KVM_H_
  40
  41 #include <sys/cdefs.h>
  42 #include <machine/stdint.h>
  43 #include <nlist.h>
  44
  45 /* Default version symbol. */
  46 #define VRS_SYM         "_version"
  47 #define VRS_KEY         "VERSION"
  48
  49 typedef struct __kvm kvm_t;
  50
  51 struct kinfo_proc;
  52 struct proc;
  53
  54 struct kvm_swap {
  55         char    ksw_devname[32];
  56         int     ksw_used;
  57         int     ksw_total;
  58         int     ksw_flags;
  59         int     ksw_reserved1;
  60         int     ksw_reserved2;
  61 };
  62
  63 #define SWIF_DUMP_TREE  0x0001
  64 #define SWIF_DEV_PREFIX 0x0002
  65
  66 __BEGIN_DECLS
  67 int       kvm_close (kvm_t *);
  68 char    **kvm_getargv (kvm_t *, const struct kinfo_proc *, int);
  69 char    **kvm_getenvv (kvm_t *, const struct kinfo_proc *, int);
  70 char     *kvm_geterr (kvm_t *);
  71 char     *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 int       kvm_nlist (kvm_t *, struct nlist *);
  77 kvm_t    *kvm_open
  78             (const char *, const char *, const char *, int, const char *);
  79 kvm_t    *kvm_openfiles
  80             (const char *, const char *, const char *, int, char *);
  81 __ssize_t         kvm_read (kvm_t *, unsigned long, void *, __size_t);
  82 __ssize_t         kvm_uread
  83             (kvm_t *, const struct proc *, unsigned long, char *, __size_t);
  84 __ssize_t         kvm_write (kvm_t *, unsigned long, const void *, __size_t);
  85 __END_DECLS
  86
  87 #endif /* !_KVM_H_ */