1 .\" Copyright (c) 1999, Matthew Dillon. All rights reserved.
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.
7 .\" $FreeBSD: src/lib/libkvm/kvm_getswapinfo.3,v 1.5.2.6 2001/12/17 10:08:30 ru Exp $
14 .Nd return swap summary statistics for the system
20 .Fn kvm_getswapinfo "kvm_t *kd" "struct kvm_swap *" "int maxswap" "int flags"
24 function fills an array of
26 structures with swap summary
27 information for each swap device, for up to
30 The number of devices, up to
32 \- 1, is returned. A grand
33 total of all swap devices (including any devices that go beyond
35 \- 1) is returned in one additional array entry. This
36 entry is not counted in the return value.
37 Thus, if you specify a
39 value of 1, the function will typically return the
40 value 0 and the single
42 structure will be filled with
43 the grand total over all swap devices. The grand total is calculated
44 from all available swap devices whether or not you made room
45 for them all in the array.
46 The grand total is returned.
48 The flags argument is currently unused and must be passed as 0.
50 If an error occurs, -1 is returned.
52 Each swap partition and the grand total is summarized in the
54 structure. This structure contains the following fields:
56 .Bl -item -offset indent -compact
58 .Va char ksw_devname[] ;
73 a copy of the swap device flags.
75 This function caches the nlist values for various kernel variables which
76 it reuses in successive calls.
77 You may call the function with
83 If the load average was unobtainable, \-1 is returned; otherwise,
84 the number of swap devices actually retrieved is returned.
86 If the name of the swap device does not fit in the static char buffer
87 in the structure, it is truncated. The buffer is always zero terminated.