From 253d17b642369be8e775e89b22e66237b0ea1d3c Mon Sep 17 00:00:00 2001 From: jkoshy Date: Tue, 16 Sep 2008 16:29:41 +0000 Subject: Move TSC specific PMC information to its own manual page. --- lib/libpmc/pmc.tsc.3 | 79 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 lib/libpmc/pmc.tsc.3 diff --git a/lib/libpmc/pmc.tsc.3 b/lib/libpmc/pmc.tsc.3 new file mode 100644 index 0000000..a234365 --- /dev/null +++ b/lib/libpmc/pmc.tsc.3 @@ -0,0 +1,79 @@ +.\" Copyright (c) 2003-2008 Joseph Koshy. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" This software is provided by Joseph Koshy ``as is'' and +.\" any express or implied warranties, including, but not limited to, the +.\" implied warranties of merchantability and fitness for a particular purpose +.\" are disclaimed. in no event shall Joseph Koshy be liable +.\" for any direct, indirect, incidental, special, exemplary, or consequential +.\" damages (including, but not limited to, procurement of substitute goods +.\" or services; loss of use, data, or profits; or business interruption) +.\" however caused and on any theory of liability, whether in contract, strict +.\" liability, or tort (including negligence or otherwise) arising in any way +.\" out of the use of this software, even if advised of the possibility of +.\" such damage. +.\" +.\" $FreeBSD$ +.\" +.Dd September 15, 2008 +.Os +.Dt PMC.TSC 3 +.Sh NAME +.Nm pmc.tsc +.Nd measurements using the i386 timestamp counter +.Sh LIBRARY +.Lb libpmc +.Sh SYNOPSIS +.In pmc.h +.Sh DESCRIPTION +In the i386 architecture, the timestamp counter is a monotonically +non-decreasing counter that counts processor cycles. +.Pp +This counter may be selected specifying an event specifier +.Dq Li tsc +to +.Xr pmc_allocate 3 . +The TSC is a read-only counter that may only be allocated in +system-wide counting mode. +The +.Dq Li tsc +event does not support further event qualifiers. +.Pp +Multiple processes are allowed to allocate the TSC. +Once allocated, the TSC may be read using the +.Fn pmc_read +function, or by using the +.Li RDTSC +instruction. +.Ss Event Name Aliases +The alias +.Dq Li cycles +maps to the TSC. +.Sh SEE ALSO +.Xr pmc 3 , +.Xr pmc.k7 3 , +.Xr pmc.k8 3 , +.Xr pmc.p4 3 , +.Xr pmc.p5 3 , +.Xr pmc.p6 3 , +.Xr pmclog 3 , +.Xr hwpmc 4 +.Sh HISTORY +The +.Nm pmc +library first appeared in +.Fx 6.0 . +.Sh AUTHORS +The +.Lb libpmc +library was written by +.An "Joseph Koshy" +.Aq jkoshy@FreeBSD.org . -- cgit v1.1