Google Git
Sign in
apache / impala / asf-site / . / doc / html / classimpala_1_1StopWatch.html
blob: f5e46a80250f49b36a37a83ddc725e14721565fd [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>Impala: impala::StopWatch Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Impala
</div>
<div id="projectbrief">Impalaistheopensource,nativeanalyticdatabaseforApacheHadoop.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classimpala_1_1StopWatch.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classimpala_1_1StopWatch-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">impala::StopWatch Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="stopwatch_8h_source.html">stopwatch.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for impala::StopWatch:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classimpala_1_1StopWatch__coll__graph.svg" width="183" height="302"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abc507dcfaf20a06af6edc35f38f3ebbd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1StopWatch.html#abc507dcfaf20a06af6edc35f38f3ebbd">StopWatch</a> ()</td></tr>
<tr class="separator:abc507dcfaf20a06af6edc35f38f3ebbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a811ac5c8ae0f5de261c62aba58d911f6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1StopWatch.html#a811ac5c8ae0f5de261c62aba58d911f6">Start</a> ()</td></tr>
<tr class="separator:a811ac5c8ae0f5de261c62aba58d911f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb3886869c34e8e9a3d2d43a41631dac"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1StopWatch.html#abb3886869c34e8e9a3d2d43a41631dac">Stop</a> ()</td></tr>
<tr class="separator:abb3886869c34e8e9a3d2d43a41631dac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b066166745d33cfc6b56bb9cc24e05f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuint64__t.html">uint64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1StopWatch.html#a8b066166745d33cfc6b56bb9cc24e05f">ElapsedTime</a> () const </td></tr>
<tr class="memdesc:a8b066166745d33cfc6b56bb9cc24e05f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns time in cpu ticks. <a href="#a8b066166745d33cfc6b56bb9cc24e05f">More...</a><br/></td></tr>
<tr class="separator:a8b066166745d33cfc6b56bb9cc24e05f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:af933ad3073503f1a5d79583c4d7357a8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classuint64__t.html">uint64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1StopWatch.html#af933ad3073503f1a5d79583c4d7357a8">Rdtsc</a> ()</td></tr>
<tr class="separator:af933ad3073503f1a5d79583c4d7357a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:aae7afa69ef62bfb17c49e1d6424b570a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuint64__t.html">uint64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1StopWatch.html#aae7afa69ef62bfb17c49e1d6424b570a">start_</a></td></tr>
<tr class="separator:aae7afa69ef62bfb17c49e1d6424b570a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1301c97f0017b78104776c319fe61d4c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuint64__t.html">uint64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1StopWatch.html#a1301c97f0017b78104776c319fe61d4c">total_time_</a></td></tr>
<tr class="separator:a1301c97f0017b78104776c319fe61d4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb8273ed99ee1ff8e53aee366d304526"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbool.html">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1StopWatch.html#abb8273ed99ee1ff8e53aee366d304526">running_</a></td></tr>
<tr class="separator:abb8273ed99ee1ff8e53aee366d304526"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Utility class to measure time. This is measured using the cpu tick counter which is very low overhead but can be inaccurate if the thread is switched away. This is useful for measuring cpu time at the row batch level (too much overhead at the row granularity). </p>
<p>Definition at line <a class="el" href="stopwatch_8h_source.html#l00028">28</a> of file <a class="el" href="stopwatch_8h_source.html">stopwatch.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="abc507dcfaf20a06af6edc35f38f3ebbd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">impala::StopWatch::StopWatch </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="stopwatch_8h_source.html#l00030">30</a> of file <a class="el" href="stopwatch_8h_source.html">stopwatch.h</a>.</p>
<p>References <a class="el" href="stopwatch_8h_source.html#l00065">running_</a>, and <a class="el" href="stopwatch_8h_source.html#l00064">total_time_</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a8b066166745d33cfc6b56bb9cc24e05f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classuint64__t.html">uint64_t</a> impala::StopWatch::ElapsedTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns time in cpu ticks. </p>
<p>Definition at line <a class="el" href="stopwatch_8h_source.html#l00050">50</a> of file <a class="el" href="stopwatch_8h_source.html">stopwatch.h</a>.</p>
<p>References <a class="el" href="stopwatch_8h_source.html#l00054">Rdtsc()</a>, <a class="el" href="stopwatch_8h_source.html#l00065">running_</a>, <a class="el" href="stopwatch_8h_source.html#l00064">start_</a>, and <a class="el" href="stopwatch_8h_source.html#l00064">total_time_</a>.</p>
<p>Referenced by <a class="el" href="growing-test_8cc_source.html#l00023">impala::GrowingTest::AggregateTest()</a>, <a class="el" href="name-resolution-benchmark_8cc_source.html#l00134">main()</a>, <a class="el" href="benchmark_8cc_source.html#l00028">impala::Benchmark::Measure()</a>, <a class="el" href="cache-hash-test_8cc_source.html#l00067">Test()</a>, and <a class="el" href="thread-create-benchmark_8cc_source.html#l00102">TimeParallelExecutors()</a>.</p>
</div>
</div>
<a class="anchor" id="af933ad3073503f1a5d79583c4d7357a8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classuint64__t.html">uint64_t</a> impala::StopWatch::Rdtsc </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="stopwatch_8h_source.html#l00054">54</a> of file <a class="el" href="stopwatch_8h_source.html">stopwatch.h</a>.</p>
<p>Referenced by <a class="el" href="stopwatch_8h_source.html#l00050">ElapsedTime()</a>, <a class="el" href="stopwatch_8h_source.html#l00035">Start()</a>, and <a class="el" href="stopwatch_8h_source.html#l00042">Stop()</a>.</p>
</div>
</div>
<a class="anchor" id="a811ac5c8ae0f5de261c62aba58d911f6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void impala::StopWatch::Start </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="stopwatch_8h_source.html#l00035">35</a> of file <a class="el" href="stopwatch_8h_source.html">stopwatch.h</a>.</p>
<p>References <a class="el" href="stopwatch_8h_source.html#l00054">Rdtsc()</a>, <a class="el" href="stopwatch_8h_source.html#l00065">running_</a>, and <a class="el" href="stopwatch_8h_source.html#l00064">start_</a>.</p>
<p>Referenced by <a class="el" href="growing-test_8cc_source.html#l00023">impala::GrowingTest::AggregateTest()</a>, <a class="el" href="name-resolution-benchmark_8cc_source.html#l00134">main()</a>, <a class="el" href="benchmark_8cc_source.html#l00028">impala::Benchmark::Measure()</a>, <a class="el" href="cache-hash-test_8cc_source.html#l00067">Test()</a>, <a class="el" href="partitioning-throughput-test_8cc_source.html#l00110">impala::PartitioningThroughputTest::TestRawThroughput()</a>, <a class="el" href="partitioning-throughput-test_8cc_source.html#l00078">impala::PartitioningThroughputTest::TestThroughput()</a>, and <a class="el" href="thread-create-benchmark_8cc_source.html#l00102">TimeParallelExecutors()</a>.</p>
</div>
</div>
<a class="anchor" id="abb3886869c34e8e9a3d2d43a41631dac"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void impala::StopWatch::Stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="stopwatch_8h_source.html#l00042">42</a> of file <a class="el" href="stopwatch_8h_source.html">stopwatch.h</a>.</p>
<p>References <a class="el" href="stopwatch_8h_source.html#l00054">Rdtsc()</a>, <a class="el" href="stopwatch_8h_source.html#l00065">running_</a>, <a class="el" href="stopwatch_8h_source.html#l00064">start_</a>, and <a class="el" href="stopwatch_8h_source.html#l00064">total_time_</a>.</p>
<p>Referenced by <a class="el" href="growing-test_8cc_source.html#l00023">impala::GrowingTest::AggregateTest()</a>, <a class="el" href="name-resolution-benchmark_8cc_source.html#l00134">main()</a>, <a class="el" href="benchmark_8cc_source.html#l00028">impala::Benchmark::Measure()</a>, <a class="el" href="cache-hash-test_8cc_source.html#l00067">Test()</a>, <a class="el" href="partitioning-throughput-test_8cc_source.html#l00110">impala::PartitioningThroughputTest::TestRawThroughput()</a>, <a class="el" href="partitioning-throughput-test_8cc_source.html#l00078">impala::PartitioningThroughputTest::TestThroughput()</a>, and <a class="el" href="thread-create-benchmark_8cc_source.html#l00102">TimeParallelExecutors()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="abb8273ed99ee1ff8e53aee366d304526"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbool.html">bool</a> impala::StopWatch::running_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="stopwatch_8h_source.html#l00065">65</a> of file <a class="el" href="stopwatch_8h_source.html">stopwatch.h</a>.</p>
<p>Referenced by <a class="el" href="stopwatch_8h_source.html#l00050">ElapsedTime()</a>, <a class="el" href="stopwatch_8h_source.html#l00035">Start()</a>, <a class="el" href="stopwatch_8h_source.html#l00042">Stop()</a>, and <a class="el" href="stopwatch_8h_source.html#l00030">StopWatch()</a>.</p>
</div>
</div>
<a class="anchor" id="aae7afa69ef62bfb17c49e1d6424b570a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classuint64__t.html">uint64_t</a> impala::StopWatch::start_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="stopwatch_8h_source.html#l00064">64</a> of file <a class="el" href="stopwatch_8h_source.html">stopwatch.h</a>.</p>
<p>Referenced by <a class="el" href="stopwatch_8h_source.html#l00050">ElapsedTime()</a>, <a class="el" href="stopwatch_8h_source.html#l00035">Start()</a>, and <a class="el" href="stopwatch_8h_source.html#l00042">Stop()</a>.</p>
</div>
</div>
<a class="anchor" id="a1301c97f0017b78104776c319fe61d4c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classuint64__t.html">uint64_t</a> impala::StopWatch::total_time_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="stopwatch_8h_source.html#l00064">64</a> of file <a class="el" href="stopwatch_8h_source.html">stopwatch.h</a>.</p>
<p>Referenced by <a class="el" href="stopwatch_8h_source.html#l00050">ElapsedTime()</a>, <a class="el" href="stopwatch_8h_source.html#l00042">Stop()</a>, and <a class="el" href="stopwatch_8h_source.html#l00030">StopWatch()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>be/src/util/<a class="el" href="stopwatch_8h_source.html">stopwatch.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceimpala.html">impala</a></li><li class="navelem"><a class="el" href="classimpala_1_1StopWatch.html">StopWatch</a></li>
<li class="footer">Generated on Thu May 7 2015 16:10:50 for Impala by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>
</div>
</body>
</html>