lib/libkvm/kvm_getswapinfo.3

   1 .\" Copyright (c) 1999, Matthew Dillon.  All rights reserved.
   2 .\"
   3 .\" Redistribution and use in source and binary forms, with or without
   4 .\" modification, are permitted provided under the terms of the BSD
   5 .\" Copyright as found in /usr/src/COPYRIGHT in the FreeBSD source tree.
   6 .\"
   7 .\" $FreeBSD$
   8 .\"
   9 .Dd January 22, 1999
  10 .Dt KVM_SWAPINFO 3
  11 .Os
  12 .Sh NAME
  13 .Nm kvm_getswapinfo
  14 .Nd return swap summary statistics for the system
  15 .Sh SYNOPSIS
  16 .Fd #include <kvm.h>
  17 .Ft int
  18 .Fn kvm_getswapinfo "kvm_t *kd" "struct kvm_swap *" "int maxswap" "int flags"
  19 .Sh DESCRIPTION
  20 The
  21 .Fn kvm_getswapinfo
  22 function fills an array of kvm_swap structures with swap summary
  23 information for each swap device, for up to maxswap - 1 devices.
  24 The number of devices, up to maxswap - 1, is returned.  A grand
  25 total of all swap devices ( including any devices that go beyond
  26 maxswap - 1 ) is returned in one additional array entry.  This
  27 entry is not counted in the return value.  Thus, if you specify
  28 a maxswap value of 1, the function will typically return the
  29 value 0 and the single kvm_swap structure will be filled with
  30 the grand total over all swap devices.  The grand total is calculated
  31 from all available swap devices whether or not you made room
  32 for them all in the array.
  33 the grant total is returned.
  34 .Pp
  35 The flags argument is currently unused and must be passed as 0.
  36 .Pp
  37 If an error occurs, -1 is returned.
  38 .Pp
  39 Each swap partition and the grand total is summarized in the kvm_swap
  40 structure.  This structure contains the following fields:
  41 .Bl -inset -width indent
  42 .It char ksw_devname[];
  43 .It int ksw_total;
  44 .It int ksw_used;
  45 .It int ksw_flags;
  46 .El
  47 .Pp
  48 Values are in PAGE_SIZE'd chunks ( see getpagesize() ).  ksw_flags contains
  49 a copy of the swap device flags.
  50 .PP
  51 .Sh CACHING
  52 This function caches the nlist values for various kernel variables which
  53 it reuses in successive calls.  You may call the function with kd == NULL
  54 to clear the cache.
  55 .Sh DIAGNOSTICS
  56 If the load average was unobtainable, \-1 is returned; otherwise,
  57 the number of swap devices actually retrieved is returned.
  58 .Pp
  59 If the name of the swap device does not fit in the static char buffer
  60 in the structure, it is truncated.  The buffer is always zero terminated.
  61 .Sh SEE ALSO
  62 .Xr kvm 3