1.\" Copyright (c) 2008 Yahoo!, Inc. 2.\" All rights reserved. 3.\" Written by: John Baldwin <jhb@FreeBSD.org> 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 author nor the names of any co-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 AUTHOR 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 AUTHOR 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.Dd August 19, 2008 30.Dt KVM_GETCPTIME 3 31.Os 32.Sh NAME 33.Nm kvm_getcptime 34.Nd fetch global CPU time statistics 35.Sh LIBRARY 36.Lb libkvm 37.Sh SYNOPSIS 38.In sys/param.h 39.In sys/resource.h 40.In sys/sysctl.h 41.In kvm.h 42.Ft int 43.Fn kvm_getcptime "kvm_t *kd" "long *cp_time" 44.Sh DESCRIPTION 45The 46.Fn kvm_getcptime 47function stores the global CPU time statistics from the kernel 48.Fa kd 49in the array of counters pointed to by 50.Fa cp_time . 51Note that 52.Fa cp_time 53should point to an array of 54.Dv CPUSTATES 55long integers. 56The format of the counters is identical to that output by the 57.Va kern.cp_time 58sysctl. 59.Sh CACHING 60This function caches the nlist values for various kernel variables which it 61reuses in successive calls. 62You may call the function with 63.Fa kd 64set to 65.Dv NULL 66to clear this cache. 67.Sh RETURN VALUES 68The 69.Nm kvm_getcptime 70function returns 0 on success and -1 on failure. 71If an error occurs, 72then an error message may be retrieved via 73.Xr kvm_geterr 3 . 74.Sh SEE ALSO 75.Xr kvm 3 76