mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 16:46:47 +00:00
81 lines
20 KiB
HTML
81 lines
20 KiB
HTML
<!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.14"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>FairMQ: fairmq/tools/RateLimit.h Source File</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="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">FairMQ
|
|
 <span id="projectnumber">1.3.8</span>
|
|
</div>
|
|
<div id="projectbrief">C++ Message Passing Framework</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</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 id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d6b28f7731906a8cbc4171450df4b180.html">fairmq</a></li><li class="navelem"><a class="el" href="dir_b7a9729ec9acb584ba3af78f8b60e470.html">tools</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">RateLimit.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/********************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (C) 2014-2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * This software is distributed under the terms of the *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * GNU Lesser General Public Licence (LGPL) version 3, *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * copied verbatim in the file "LICENSE" *</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> ********************************************************************************/</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#ifndef FAIR_MQ_TOOLS_RATELIMIT_H</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define FAIR_MQ_TOOLS_RATELIMIT_H</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <cassert></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <iostream></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <iomanip></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <thread></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <chrono></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">namespace </span><a class="code" href="namespacefair.html">fair</a></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">namespace </span>mq</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> {</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span>tools</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1tools_1_1RateLimiter.html"> 39</a></span> <span class="keyword">class </span><a class="code" href="classfair_1_1mq_1_1tools_1_1RateLimiter.html">RateLimiter</a></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">using</span> clock = std::chrono::steady_clock;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1tools_1_1RateLimiter.html#a593f79d4621ad7a54dddec55d4435adb"> 51</a></span>  <a class="code" href="classfair_1_1mq_1_1tools_1_1RateLimiter.html#a593f79d4621ad7a54dddec55d4435adb">RateLimiter</a>(<span class="keywordtype">float</span> rate) : tw_req(<a class="code" href="namespacestd.html">std</a>::chrono::seconds(1)), start_time(clock::now())</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  {</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">if</span> (rate <= 0) {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  tw_req = std::chrono::nanoseconds(1);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  tw_req = std::chrono::duration_cast<clock::duration>(tw_req / rate);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  }</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  skip_check_count = std::max(1, <span class="keywordtype">int</span>(std::chrono::milliseconds(5) / tw_req));</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  count = skip_check_count;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">//std::cerr << "skip_check_count: " << skip_check_count << '\n';</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  }</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1tools_1_1RateLimiter.html#a577dffe74db4af027a7e43ff90fea679"> 70</a></span>  <span class="keywordtype">void</span> <a class="code" href="classfair_1_1mq_1_1tools_1_1RateLimiter.html#a577dffe74db4af027a7e43ff90fea679">maybe_sleep</a>()</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">using namespace </span>std::chrono;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">if</span> (--count == 0) {</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">auto</span> now = clock::now();</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">if</span> (tw == clock::duration::zero()) {</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  tw = (now - start_time) / skip_check_count;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  tw = (1 * tw + 3 * (now - start_time) / skip_check_count) / 4;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  }</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">//std::ostringstream s; s << "tw = " << std::setw(10) << duration_cast<nanoseconds>(tw).count() << "ns, req = " << duration_cast<nanoseconds>(tw_req).count() << "ns, ";</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">if</span> (tw > tw_req * 65 / 64) {</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="comment">// the time between maybe_sleep calls is more than 1% too long</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="comment">// fix it by reducing ts towards 0 and if ts = 0 doesn't suffice, increase</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="comment">// skip_check_count</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordflow">if</span> (ts > clock::duration::zero()) {</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  ts = std::max(clock::duration::zero(),</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  ts - (tw - tw_req) * skip_check_count * 1 / 2);</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="comment">//std::cerr << s.str() << "maybe_sleep: going too slow; sleep less: " << duration_cast<microseconds>(ts).count() << "µs\n";</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  skip_check_count =</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  std::min(<span class="keywordtype">int</span>(seconds(1) / tw_req), <span class="comment">// recheck at least every second</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  (skip_check_count * 5 + 3) / 4);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="comment">//std::cerr << s.str() << "maybe_sleep: going too slow; work more: " << skip_check_count << "\n";</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  }</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (tw < tw_req * 63 / 64) {</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="comment">// the time between maybe_sleep calls is more than 1% too short</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="comment">// fix it by reducing skip_check_count towards 1 and if skip_check_count = 1</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="comment">// doesn't suffice, increase ts</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="comment">// The minimum work count is defined such that a typical sleep time is greater</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="comment">// than 1ms.</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="comment">// The user requested 1/tw_req work iterations per second. Divided by 1000, that's</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="comment">// the count per ms.</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">const</span> <span class="keywordtype">int</span> min_skip_count = std::max(1, <span class="keywordtype">int</span>(milliseconds(5) / tw_req));</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordflow">if</span> (skip_check_count > min_skip_count) {</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  assert(ts == clock::duration::zero());</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  skip_check_count = std::max(min_skip_count, skip_check_count * 3 / 4);</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="comment">//std::cerr << s.str() << "maybe_sleep: going too fast; work less: " << skip_check_count << "\n";</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  ts += (tw_req - tw) * (skip_check_count * 7) / 8;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="comment">//std::cerr << s.str() << "maybe_sleep: going too fast; sleep more: " << duration_cast<microseconds>(ts).count() << "µs\n";</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  }</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  }</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  start_time = now;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  count = skip_check_count;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordflow">if</span> (ts > clock::duration::zero()) {</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  std::this_thread::sleep_for(ts);</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  }</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  }</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  }</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  clock::duration tw{}, </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  ts{}, </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  tw_req; </div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  clock::time_point start_time;</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordtype">int</span> count = 1;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordtype">int</span> skip_check_count = 1;</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> };</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> } <span class="comment">/* namespace tools */</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> } <span class="comment">/* namespace mq */</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> } <span class="comment">/* namespace fair */</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="preprocessor">#endif // FAIR_MQ_TOOLS_RATELIMIT_H</span></div><div class="ttc" id="classfair_1_1mq_1_1tools_1_1RateLimiter_html_a577dffe74db4af027a7e43ff90fea679"><div class="ttname"><a href="classfair_1_1mq_1_1tools_1_1RateLimiter.html#a577dffe74db4af027a7e43ff90fea679">fair::mq::tools::RateLimiter::maybe_sleep</a></div><div class="ttdeci">void maybe_sleep()</div><div class="ttdef"><b>Definition:</b> RateLimit.h:70</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1tools_1_1RateLimiter_html_a593f79d4621ad7a54dddec55d4435adb"><div class="ttname"><a href="classfair_1_1mq_1_1tools_1_1RateLimiter.html#a593f79d4621ad7a54dddec55d4435adb">fair::mq::tools::RateLimiter::RateLimiter</a></div><div class="ttdeci">RateLimiter(float rate)</div><div class="ttdef"><b>Definition:</b> RateLimit.h:51</div></div>
|
|
<div class="ttc" id="namespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdef"><b>Definition:</b> FairMQStateMachine.cxx:40</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1tools_1_1RateLimiter_html"><div class="ttname"><a href="classfair_1_1mq_1_1tools_1_1RateLimiter.html">fair::mq::tools::RateLimiter</a></div><div class="ttdef"><b>Definition:</b> RateLimit.h:39</div></div>
|
|
<div class="ttc" id="namespacefair_html"><div class="ttname"><a href="namespacefair.html">fair</a></div><div class="ttdoc">Tools for interfacing containers to the transport via polymorphic allocators. </div><div class="ttdef"><b>Definition:</b> DeviceRunner.h:23</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
|