summaryrefslogtreecommitdiffstats
path: root/doc/SystemTap_Tapset_Reference/en-US/timestamp.xml
blob: 714f16b10bec54ecdd879ae85daf452cd9f85cf8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
<?xml version='1.0'?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
]>
<!-- This file is extracted from the tapset files 
   Do not modify this file -->
<chapter id="timestamp_stp">
  <title>Timestamp Functions</title>
  <para>
	Each timestamp function returns a value to indicate when
     the function is executed.
     Thus, these returned values can be used to indicate
     when an event occurs, provide an ordering for events, or compute
	the amount of time elapsed between to time stamps.
  </para>
<formalpara id="get_cycles">
  <title>get_cycles:long()</title>
  <indexterm><primary>get_cycles</primary></indexterm>
  <para>
	Return the processor cycle counter value, or 0 if unavailable.
  </para>
</formalpara>
<formalpara id="gettimeofday_ns">
  <title>gettimeofday_ns:long ()</title>
  <indexterm><primary>gettimeofday_ns</primary></indexterm>
  <para>
	Return the number of nanoseconds since the UNIX epoch.
  </para>
</formalpara>
<formalpara id="gettimeofday_us">
  <title>gettimeofday_us:long ()</title>
  <indexterm><primary>gettimeofday_us</primary></indexterm>
  <para>
	Return the number of microseconds since the UNIX epoch.
  </para>
</formalpara>
<formalpara id="gettimeofday_ms">
  <title>gettimeofday_ms:long ()</title>
  <indexterm><primary>gettimeofday_ms</primary></indexterm>
  <para>
	Return the number of milliseconds since the UNIX epoch.
  </para>
</formalpara>
<formalpara id="gettimeofday_s">
  <title>gettimeofday_s:long ()</title>
  <indexterm><primary>gettimeofday_s</primary></indexterm>
  <para>
	Return the number of seconds since the UNIX epoch.
  </para>
</formalpara>
</chapter>