add Doxygen documentation
[o-du/phy.git] / docs / API / common_8cpp_source.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>o-du/phy: common.cpp Source File</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
13 <script type="text/javascript" src="search/searchdata.js"></script>
14 <script type="text/javascript" src="search/search.js"></script>
15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
16 </head>
17 <body>
18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19 <div id="titlearea">
20 <table cellspacing="0" cellpadding="0">
21  <tbody>
22  <tr style="height: 56px;">
23   <td id="projectalign" style="padding-left: 0.5em;">
24    <div id="projectname">o-du/phy
25    </div>
26    <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</div>
27   </td>
28  </tr>
29  </tbody>
30 </table>
31 </div>
32 <!-- end header part -->
33 <!-- Generated by Doxygen 1.8.13 -->
34 <script type="text/javascript">
35 var searchBox = new SearchBox("searchBox", "search",false,'Search');
36 </script>
37 <script type="text/javascript" src="menudata.js"></script>
38 <script type="text/javascript" src="menu.js"></script>
39 <script type="text/javascript">
40 $(function() {
41   initMenu('',true,false,'search.php','Search');
42   $(document).ready(function() { init_search(); });
43 });
44 </script>
45 <div id="main-nav"></div>
46 <!-- window showing the filter options -->
47 <div id="MSearchSelectWindow"
48      onmouseover="return searchBox.OnSearchSelectShow()"
49      onmouseout="return searchBox.OnSearchSelectHide()"
50      onkeydown="return searchBox.OnSearchSelectKey(event)">
51 </div>
52
53 <!-- iframe showing the search results (closed by default) -->
54 <div id="MSearchResultsWindow">
55 <iframe src="javascript:void(0)" frameborder="0" 
56         name="MSearchResults" id="MSearchResults">
57 </iframe>
58 </div>
59
60 <div id="nav-path" class="navpath">
61   <ul>
62 <li class="navelem"><a class="el" href="dir_a4c74d6baed87eba72f3b201b7b4b8f2.html">fhi_lib</a></li><li class="navelem"><a class="el" href="dir_babe8eacf738372576863f88f66866a5.html">test</a></li><li class="navelem"><a class="el" href="dir_1bd9561fc3fad99ea06f3a94905f6e7f.html">common</a></li>  </ul>
63 </div>
64 </div><!-- top -->
65 <div class="header">
66   <div class="headertitle">
67 <div class="title">common.cpp</div>  </div>
68 </div><!--header-->
69 <div class="contents">
70 <a href="common_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/******************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">*   Copyright (c) 2019 Intel.</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">*   Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">*   you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">*   You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">*       http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">*   Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">*   distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">*   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">*   See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">*   limitations under the License.</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment">*******************************************************************************/</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &lt;cmath&gt;</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &lt;fstream&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &lt;numeric&gt;</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#ifndef _WIN64</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#include &lt;unistd.h&gt;</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#include &lt;sys/syscall.h&gt;</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#include &lt;Windows.h&gt;</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="common_8hpp.html">common.hpp</a>&quot;</span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor">#ifndef CPU_ID</span></div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="common_8cpp.html#a80c653d62783a4e7ea960794bd287b49">   34</a></span>&#160;<span class="preprocessor">#define CPU_ID 4</span></div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment">/* Required to avoid linker errors */</span></div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<a class="code" href="classnlohmann_1_1basic__json.html">json</a> <a class="code" href="class_kernel_tests.html#abd42f3e51ae547ec1631e9ac60df29d6">KernelTests::conf</a>;</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;std::string <a class="code" href="class_kernel_tests.html#a4e9607ae94d1958d38388cead2e4e3bf">KernelTests::test_type</a>;</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> KernelTests::tsc;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="keywordtype">long</span> <a class="code" href="struct_benchmark_parameters.html#a7f1e5652bb40ab5c264473c82ac23beb">BenchmarkParameters::repetition</a> = 40;</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="keywordtype">long</span> <a class="code" href="struct_benchmark_parameters.html#aac742be3d619ef9ed50afc0c063c6727">BenchmarkParameters::loop</a> = 30;</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="keywordtype">unsigned</span> <a class="code" href="struct_benchmark_parameters.html#a12661f1773e3ba71d5b29d7ffa042b1a">BenchmarkParameters::cpu_id</a> = <a class="code" href="common_8cpp.html#a80c653d62783a4e7ea960794bd287b49">CPU_ID</a>;</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="common_8hpp.html#ae39390f41ba978a1f0d79691436c074a">   47</a></span>&#160;<span class="keywordtype">int</span> <a class="code" href="common_8cpp.html#ae39390f41ba978a1f0d79691436c074a">bind_to_cpu</a>(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> cpu)</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;{</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="preprocessor">#ifndef _WIN64</span></div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    <span class="keyword">const</span> <span class="keyword">auto</span> pid = syscall(SYS_gettid);</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    cpu_set_t mask {};</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    CPU_ZERO(&amp;mask);</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    CPU_SET(cpu, &amp;mask);</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    <span class="keywordflow">return</span> sched_setaffinity(__pid_t(pid), <span class="keyword">sizeof</span>(mask), &amp;mask);</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    <span class="keywordflow">return</span> -1;</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;}</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="common_8hpp.html#a8265b710246f9019ff14556adf5eb35a">   60</a></span>&#160;std::pair&lt;double, double&gt; <a class="code" href="common_8cpp.html#a8265b710246f9019ff14556adf5eb35a">calculate_statistics</a>(<span class="keyword">const</span> std::vector&lt;long&gt; values)</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;{</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <span class="keyword">const</span> <span class="keyword">auto</span> sum = std::accumulate(values.begin(), values.end(), 0L);</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <span class="keyword">const</span> <span class="keyword">auto</span> number_of_iterations = <a class="code" href="struct_benchmark_parameters.html#a7f1e5652bb40ab5c264473c82ac23beb">BenchmarkParameters::repetition</a> *</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;            <a class="code" href="struct_benchmark_parameters.html#aac742be3d619ef9ed50afc0c063c6727">BenchmarkParameters::loop</a>;</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    <span class="keyword">const</span> <span class="keyword">auto</span> mean = sum / (double) number_of_iterations;</div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    <span class="keyword">auto</span> stddev_accumulator = 0.0;</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    <span class="keywordflow">for</span> (<span class="keyword">auto</span> v : values)</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;        stddev_accumulator = pow((v / BenchmarkParameters::loop) - mean, 2);</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    <span class="keyword">const</span> <span class="keyword">auto</span> stddev = sqrt(stddev_accumulator / <a class="code" href="struct_benchmark_parameters.html#a7f1e5652bb40ab5c264473c82ac23beb">BenchmarkParameters::repetition</a>);</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    <span class="keywordflow">return</span> {mean, stddev};</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;}</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;</div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="common_8hpp.html#a39bf4f7770751080f5b72046abfd01a5">   78</a></span>&#160;std::vector&lt;unsigned&gt; <a class="code" href="common_8cpp.html#a39bf4f7770751080f5b72046abfd01a5">get_sequence</a>(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> number)</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;{</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    std::vector&lt;unsigned&gt; sequence(number);</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    std::iota(sequence.begin(), sequence.end(), 0);</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    <span class="keywordflow">return</span> sequence;</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;}</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="common_8hpp.html#a876ed07783b27d38779f7cef4db673e6">   86</a></span>&#160;<span class="keywordtype">char</span>* <a class="code" href="common_8cpp.html#a876ed07783b27d38779f7cef4db673e6">read_data_to_aligned_array</a>(<span class="keyword">const</span> std::string &amp;filename)</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;{</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;    std::ifstream input_stream(filename, std::ios::binary);</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    std::vector&lt;char&gt; buffer((std::istreambuf_iterator&lt;char&gt;(input_stream)),</div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;                              std::istreambuf_iterator&lt;char&gt;());</div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;</div><div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;    <span class="keywordflow">if</span>(buffer.size() == 0)</div><div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;        <span class="keywordflow">throw</span> <a class="code" href="structreading__input__file__exception.html">reading_input_file_exception</a>();</div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;</div><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;    <span class="keyword">auto</span> aligned_buffer = aligned_malloc&lt;char&gt;((int) buffer.size(), 64);</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;    <span class="keywordflow">if</span>(aligned_buffer == <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;        <span class="keywordflow">throw</span> std::runtime_error(<span class="stringliteral">&quot;Failed to allocate memory for the test vector!&quot;</span>);</div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;    std::copy(buffer.begin(), buffer.end(), aligned_buffer);</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;</div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;    <span class="keywordflow">return</span> aligned_buffer;</div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;}</div><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;</div><div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="common_8hpp.html#ad8c062e9b24e4b3a8408b23a0d8ab428">  106</a></span>&#160;<a class="code" href="classnlohmann_1_1basic__json.html">json</a> <a class="code" href="common_8cpp.html#ad8c062e9b24e4b3a8408b23a0d8ab428">read_json_from_file</a>(<span class="keyword">const</span> std::string &amp;filename)</div><div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;{</div><div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;    <a class="code" href="classnlohmann_1_1basic__json.html">json</a> result;</div><div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;</div><div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;    std::ifstream json_stream(filename);</div><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;    <span class="keywordflow">if</span>(!json_stream.is_open())</div><div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;        <span class="keywordflow">throw</span> <a class="code" href="structmissing__config__file__exception.html">missing_config_file_exception</a>();</div><div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;</div><div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;    json_stream &gt;&gt; result;</div><div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;</div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;    <span class="keywordflow">return</span> result;</div><div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;}</div><div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;</div><div class="line"><a name="l00119"></a><span class="lineno"><a class="line" href="common_8hpp.html#a56c41cbb9de4bce25da45ecd74b46a81">  119</a></span>&#160;<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="common_8cpp.html#a56c41cbb9de4bce25da45ecd74b46a81">tsc_recovery</a>()</div><div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;{</div><div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<span class="preprocessor">#ifndef _WIN64</span></div><div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;    constexpr <span class="keyword">auto</span> ns_per_sec = 1E9;</div><div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;</div><div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;    <span class="keyword">struct </span>timespec sleeptime = {.tv_nsec = __syscall_slong_t(5E8) };</div><div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;</div><div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;    <span class="keyword">struct </span>timespec t_start, t_end;</div><div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;</div><div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;    <span class="keywordflow">if</span> (clock_gettime(CLOCK_MONOTONIC_RAW, &amp;t_start) == 0)</div><div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;    {</div><div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;        <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> start = <a class="code" href="common_8cpp.html#a0ab5719a5f67d4d52057b2c4550fe930">tsc_tick</a>();</div><div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;</div><div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;        nanosleep(&amp;sleeptime,NULL);</div><div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;        clock_gettime(CLOCK_MONOTONIC_RAW, &amp;t_end);</div><div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;</div><div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;        <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> end = <a class="code" href="common_8cpp.html#a0ab5719a5f67d4d52057b2c4550fe930">tsc_tick</a>();</div><div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;</div><div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;        <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> ns = (<span class="keywordtype">unsigned</span> long)((t_end.tv_sec - t_start.tv_sec) * ns_per_sec + t_end.tv_nsec - t_start.tv_nsec);</div><div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;</div><div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;        <span class="keywordtype">double</span> secs = (double) ns / ns_per_sec;</div><div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;</div><div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;        <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> resolution_timer = (<span class="keywordtype">unsigned</span> long)((end - start)/secs);</div><div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;        <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="sample-app_8c.html#acbab6f0999957daa6d05b0f286c21666">tick_per_usec</a> = (resolution_timer / 1000000);</div><div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;</div><div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;        std::cout &lt;&lt; <span class="stringliteral">&quot;[----------] System clock (rdtsc) resolution &quot;</span> &lt;&lt; resolution_timer &lt;&lt; <span class="stringliteral">&quot; [Hz]&quot;</span> &lt;&lt; std::endl;</div><div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;        std::cout &lt;&lt; <span class="stringliteral">&quot;[----------] Ticks per us &quot;</span> &lt;&lt; tick_per_usec &lt;&lt; std::endl;</div><div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;</div><div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;        <span class="keywordflow">return</span> <a class="code" href="sample-app_8c.html#acbab6f0999957daa6d05b0f286c21666">tick_per_usec</a>;</div><div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;    }</div><div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;</div><div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;    LARGE_INTEGER tick_per_sec;</div><div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;    QueryPerformanceFrequency(&amp;tick_per_sec);</div><div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;</div><div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;    std::cout &lt;&lt; <span class="stringliteral">&quot;[----------] System clock (rdtsc) resolution unknown&quot;</span> &lt;&lt; std::endl;</div><div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;    std::cout &lt;&lt; <span class="stringliteral">&quot;[----------] Ticks per us &quot;</span> &lt;&lt; (tick_per_sec.QuadPart / 1000000) &lt;&lt; std::endl;</div><div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;    <span class="keywordflow">return</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span>) tick_per_sec.QuadPart;</div><div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;</div><div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;    <span class="keywordflow">return</span> 0;</div><div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;}</div><div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;</div><div class="line"><a name="l00162"></a><span class="lineno"><a class="line" href="common_8hpp.html#a0ab5719a5f67d4d52057b2c4550fe930">  162</a></span>&#160;<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="common_8cpp.html#a0ab5719a5f67d4d52057b2c4550fe930">tsc_tick</a>()</div><div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;{</div><div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;<span class="preprocessor">#ifndef _WIN64</span></div><div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;    <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> hi, lo;</div><div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;</div><div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;    __asm <span class="keyword">volatile</span> (<span class="stringliteral">&quot;rdtsc&quot;</span> : <span class="stringliteral">&quot;=a&quot;</span>(lo), <span class="stringliteral">&quot;=d&quot;</span>(hi));</div><div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;</div><div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;    <span class="keywordflow">return</span> lo | (hi &lt;&lt; 32);</div><div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;    <span class="keywordflow">return</span> 0;</div><div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;}</div><div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;</div><div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;<span class="keywordtype">void</span> KernelTests::print_and_store_results(<span class="keyword">const</span> std::string &amp;isa, <span class="keyword">const</span> std::string &amp;parameters,</div><div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;                                          <span class="keyword">const</span> std::string &amp;<a class="code" href="c__plane__tests_8cc.html#a69b4bff6061152ff85770d725cced3cc">module_name</a>, <span class="keyword">const</span> std::string &amp;test_name,</div><div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;                                          <span class="keyword">const</span> std::string &amp;unit, <span class="keyword">const</span> <span class="keywordtype">int</span> para_factor,</div><div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;                                          <span class="keyword">const</span> <span class="keywordtype">double</span> mean, <span class="keyword">const</span> <span class="keywordtype">double</span> stddev)</div><div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;{</div><div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;    std::cout &lt;&lt; <span class="stringliteral">&quot;[----------] &quot;</span> &lt;&lt; <span class="stringliteral">&quot;Mean&quot;</span> &lt;&lt; <span class="stringliteral">&quot; = &quot;</span> &lt;&lt; std::fixed &lt;&lt; mean &lt;&lt; <span class="stringliteral">&quot; us&quot;</span> &lt;&lt; std::endl;</div><div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;    std::cout &lt;&lt; <span class="stringliteral">&quot;[----------] &quot;</span> &lt;&lt; <span class="stringliteral">&quot;Stddev&quot;</span> &lt;&lt; <span class="stringliteral">&quot; = &quot;</span> &lt;&lt; stddev &lt;&lt; <span class="stringliteral">&quot; us&quot;</span> &lt;&lt; std::endl;</div><div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;</div><div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;<span class="preprocessor">#ifndef _WIN64</span></div><div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;    <span class="comment">/* Two properties below should uniquely identify a test case */</span></div><div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;    RecordProperty(<span class="stringliteral">&quot;kernelname&quot;</span>, <a class="code" href="c__plane__tests_8cc.html#a69b4bff6061152ff85770d725cced3cc">module_name</a>);</div><div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;    RecordProperty(<span class="stringliteral">&quot;parameters&quot;</span>, parameters);</div><div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;</div><div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;    RecordProperty(<span class="stringliteral">&quot;isa&quot;</span>, isa);</div><div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;    RecordProperty(<span class="stringliteral">&quot;unit&quot;</span>, unit);</div><div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;    RecordProperty(<span class="stringliteral">&quot;parallelization_factor&quot;</span>, para_factor);</div><div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;</div><div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;    RecordProperty(<span class="stringliteral">&quot;mean&quot;</span>, std::to_string(mean));</div><div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;    RecordProperty(<span class="stringliteral">&quot;stddev&quot;</span>, std::to_string(stddev));</div><div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;}</div><div class="ttc" id="common_8cpp_html_ad8c062e9b24e4b3a8408b23a0d8ab428"><div class="ttname"><a href="common_8cpp.html#ad8c062e9b24e4b3a8408b23a0d8ab428">read_json_from_file</a></div><div class="ttdeci">json read_json_from_file(const std::string &amp;filename)</div><div class="ttdoc">Read JSON from the given file. </div><div class="ttdef"><b>Definition:</b> <a href="common_8cpp_source.html#l00106">common.cpp:106</a></div></div>
71 <div class="ttc" id="classnlohmann_1_1basic__json_html"><div class="ttname"><a href="classnlohmann_1_1basic__json.html">nlohmann::basic_json</a></div><div class="ttdoc">a class to store JSON values </div><div class="ttdef"><b>Definition:</b> <a href="json_8hpp_source.html#l01016">json.hpp:1016</a></div></div>
72 <div class="ttc" id="struct_benchmark_parameters_html_a12661f1773e3ba71d5b29d7ffa042b1a"><div class="ttname"><a href="struct_benchmark_parameters.html#a12661f1773e3ba71d5b29d7ffa042b1a">BenchmarkParameters::cpu_id</a></div><div class="ttdeci">static unsigned cpu_id</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00068">common.hpp:68</a></div></div>
73 <div class="ttc" id="class_kernel_tests_html_abd42f3e51ae547ec1631e9ac60df29d6"><div class="ttname"><a href="class_kernel_tests.html#abd42f3e51ae547ec1631e9ac60df29d6">KernelTests::conf</a></div><div class="ttdeci">static json conf</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00159">common.hpp:159</a></div></div>
74 <div class="ttc" id="structmissing__config__file__exception_html"><div class="ttname"><a href="structmissing__config__file__exception.html">missing_config_file_exception</a></div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00071">common.hpp:71</a></div></div>
75 <div class="ttc" id="class_kernel_tests_html_a4e9607ae94d1958d38388cead2e4e3bf"><div class="ttname"><a href="class_kernel_tests.html#a4e9607ae94d1958d38388cead2e4e3bf">KernelTests::test_type</a></div><div class="ttdeci">static std::string test_type</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00160">common.hpp:160</a></div></div>
76 <div class="ttc" id="common_8cpp_html_a876ed07783b27d38779f7cef4db673e6"><div class="ttname"><a href="common_8cpp.html#a876ed07783b27d38779f7cef4db673e6">read_data_to_aligned_array</a></div><div class="ttdeci">char * read_data_to_aligned_array(const std::string &amp;filename)</div><div class="ttdoc">Read binary data from the file. </div><div class="ttdef"><b>Definition:</b> <a href="common_8cpp_source.html#l00086">common.cpp:86</a></div></div>
77 <div class="ttc" id="common_8hpp_html"><div class="ttname"><a href="common_8hpp.html">common.hpp</a></div></div>
78 <div class="ttc" id="struct_benchmark_parameters_html_a7f1e5652bb40ab5c264473c82ac23beb"><div class="ttname"><a href="struct_benchmark_parameters.html#a7f1e5652bb40ab5c264473c82ac23beb">BenchmarkParameters::repetition</a></div><div class="ttdeci">static long repetition</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00066">common.hpp:66</a></div></div>
79 <div class="ttc" id="common_8cpp_html_a8265b710246f9019ff14556adf5eb35a"><div class="ttname"><a href="common_8cpp.html#a8265b710246f9019ff14556adf5eb35a">calculate_statistics</a></div><div class="ttdeci">std::pair&lt; double, double &gt; calculate_statistics(const std::vector&lt; long &gt; values)</div><div class="ttdoc">Calculate the mean and variance from the result of the run_benchmark. </div><div class="ttdef"><b>Definition:</b> <a href="common_8cpp_source.html#l00060">common.cpp:60</a></div></div>
80 <div class="ttc" id="common_8cpp_html_a56c41cbb9de4bce25da45ecd74b46a81"><div class="ttname"><a href="common_8cpp.html#a56c41cbb9de4bce25da45ecd74b46a81">tsc_recovery</a></div><div class="ttdeci">unsigned long tsc_recovery()</div><div class="ttdoc">Measure the TSC on the machine. </div><div class="ttdef"><b>Definition:</b> <a href="common_8cpp_source.html#l00119">common.cpp:119</a></div></div>
81 <div class="ttc" id="c__plane__tests_8cc_html_a69b4bff6061152ff85770d725cced3cc"><div class="ttname"><a href="c__plane__tests_8cc.html#a69b4bff6061152ff85770d725cced3cc">module_name</a></div><div class="ttdeci">const std::string module_name</div><div class="ttdef"><b>Definition:</b> <a href="c__plane__tests_8cc_source.html#l00032">c_plane_tests.cc:32</a></div></div>
82 <div class="ttc" id="structreading__input__file__exception_html"><div class="ttname"><a href="structreading__input__file__exception.html">reading_input_file_exception</a></div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00078">common.hpp:78</a></div></div>
83 <div class="ttc" id="struct_benchmark_parameters_html_aac742be3d619ef9ed50afc0c063c6727"><div class="ttname"><a href="struct_benchmark_parameters.html#aac742be3d619ef9ed50afc0c063c6727">BenchmarkParameters::loop</a></div><div class="ttdeci">static long loop</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00067">common.hpp:67</a></div></div>
84 <div class="ttc" id="common_8cpp_html_ae39390f41ba978a1f0d79691436c074a"><div class="ttname"><a href="common_8cpp.html#ae39390f41ba978a1f0d79691436c074a">bind_to_cpu</a></div><div class="ttdeci">int bind_to_cpu(const unsigned cpu)</div><div class="ttdoc">Attach current process to the selected core. </div><div class="ttdef"><b>Definition:</b> <a href="common_8cpp_source.html#l00047">common.cpp:47</a></div></div>
85 <div class="ttc" id="common_8cpp_html_a0ab5719a5f67d4d52057b2c4550fe930"><div class="ttname"><a href="common_8cpp.html#a0ab5719a5f67d4d52057b2c4550fe930">tsc_tick</a></div><div class="ttdeci">unsigned long tsc_tick()</div><div class="ttdoc">Return the current value of the TSC. </div><div class="ttdef"><b>Definition:</b> <a href="common_8cpp_source.html#l00162">common.cpp:162</a></div></div>
86 <div class="ttc" id="sample-app_8c_html_acbab6f0999957daa6d05b0f286c21666"><div class="ttname"><a href="sample-app_8c.html#acbab6f0999957daa6d05b0f286c21666">tick_per_usec</a></div><div class="ttdeci">uint64_t tick_per_usec</div><div class="ttdef"><b>Definition:</b> <a href="sample-app_8c_source.html#l00064">sample-app.c:64</a></div></div>
87 <div class="ttc" id="common_8cpp_html_a80c653d62783a4e7ea960794bd287b49"><div class="ttname"><a href="common_8cpp.html#a80c653d62783a4e7ea960794bd287b49">CPU_ID</a></div><div class="ttdeci">#define CPU_ID</div><div class="ttdef"><b>Definition:</b> <a href="common_8cpp_source.html#l00034">common.cpp:34</a></div></div>
88 <div class="ttc" id="common_8cpp_html_a39bf4f7770751080f5b72046abfd01a5"><div class="ttname"><a href="common_8cpp.html#a39bf4f7770751080f5b72046abfd01a5">get_sequence</a></div><div class="ttdeci">std::vector&lt; unsigned &gt; get_sequence(const unsigned number)</div><div class="ttdoc">For a given number return sequence of number from 0 to number - 1. </div><div class="ttdef"><b>Definition:</b> <a href="common_8cpp_source.html#l00078">common.cpp:78</a></div></div>
89 </div><!-- fragment --></div><!-- contents -->
90 <!-- start footer part -->
91 <hr class="footer"/><address class="footer"><small>
92 Generated by &#160;<a href="http://www.doxygen.org/index.html">
93 <img class="footer" src="doxygen.png" alt="doxygen"/>
94 </a> 1.8.13
95 </small></address>
96 </body>
97 </html>