| <!-- HTML header for doxygen 1.8.15--> |
| <!-- Remember to use version doxygen 1.8.15 +--> |
| <!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.15"/> |
| <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines --> |
| <title>Compute Library: CLTuner 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="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(initResizable); |
| /* @license-end */</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> |
| <script type="text/x-mathjax-config"> |
| MathJax.Hub.Config({ |
| extensions: ["tex2jax.js"], |
| jax: ["input/TeX","output/HTML-CSS"], |
| }); |
| </script><script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <link href="stylesheet.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;"> |
| <img alt="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname"> |
|  <span id="projectnumber">19.08</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.15 --> |
| <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> |
| </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"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('classarm__compute_1_1_c_l_tuner.xhtml','');}); |
| /* @license-end */ |
| </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)"> |
| </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> | |
| <a href="#pub-attribs">Data Fields</a> </div> |
| <div class="headertitle"> |
| <div class="title">CLTuner Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Basic implementation of the OpenCL tuner interface. |
| <a href="classarm__compute_1_1_c_l_tuner.xhtml#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="_c_l_tuner_8h_source.xhtml">CLTuner.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for CLTuner:</div> |
| <div class="dyncontent"> |
| <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_tuner__coll__graph.svg" width="84" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe> |
| </div> |
| <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></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:ad551ac5b533cac7908910085117f5ca8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#ad551ac5b533cac7908910085117f5ca8">CLTuner</a> (bool <a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#a362184f6651ae4acde05d5ce85cfd16f">tune_new_kernels</a>=true)</td></tr> |
| <tr class="memdesc:ad551ac5b533cac7908910085117f5ca8"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#ad551ac5b533cac7908910085117f5ca8">More...</a><br /></td></tr> |
| <tr class="separator:ad551ac5b533cac7908910085117f5ca8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a577ac5b9d244bdf031905faaf08b968c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#a577ac5b9d244bdf031905faaf08b968c">~CLTuner</a> ()=default</td></tr> |
| <tr class="memdesc:a577ac5b9d244bdf031905faaf08b968c"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a577ac5b9d244bdf031905faaf08b968c">More...</a><br /></td></tr> |
| <tr class="separator:a577ac5b9d244bdf031905faaf08b968c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aba10acdb2d58e3e0a96364c487a71d40"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#aba10acdb2d58e3e0a96364c487a71d40">set_tune_new_kernels</a> (bool <a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#a362184f6651ae4acde05d5ce85cfd16f">tune_new_kernels</a>)</td></tr> |
| <tr class="memdesc:aba10acdb2d58e3e0a96364c487a71d40"><td class="mdescLeft"> </td><td class="mdescRight">Setter for tune_new_kernels option. <a href="#aba10acdb2d58e3e0a96364c487a71d40">More...</a><br /></td></tr> |
| <tr class="separator:aba10acdb2d58e3e0a96364c487a71d40"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a362184f6651ae4acde05d5ce85cfd16f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#a362184f6651ae4acde05d5ce85cfd16f">tune_new_kernels</a> () const</td></tr> |
| <tr class="memdesc:a362184f6651ae4acde05d5ce85cfd16f"><td class="mdescLeft"> </td><td class="mdescRight">Tune kernels that are not in the LWS table. <a href="#a362184f6651ae4acde05d5ce85cfd16f">More...</a><br /></td></tr> |
| <tr class="separator:a362184f6651ae4acde05d5ce85cfd16f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aae485b24df65d39cb646e48317f49639"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#aae485b24df65d39cb646e48317f49639">set_tuner_mode</a> (<a class="el" href="namespacearm__compute.xhtml#ae76ef5bd3ad69f7380ebb3ac6033ec5c">CLTunerMode</a> mode)</td></tr> |
| <tr class="memdesc:aae485b24df65d39cb646e48317f49639"><td class="mdescLeft"> </td><td class="mdescRight">Set OpenCL tuner mode. <a href="#aae485b24df65d39cb646e48317f49639">More...</a><br /></td></tr> |
| <tr class="separator:aae485b24df65d39cb646e48317f49639"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7476f2d243a36f5719a29bc8c758c62a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearm__compute.xhtml#ae76ef5bd3ad69f7380ebb3ac6033ec5c">CLTunerMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#a7476f2d243a36f5719a29bc8c758c62a">get_tuner_mode</a> () const</td></tr> |
| <tr class="memdesc:a7476f2d243a36f5719a29bc8c758c62a"><td class="mdescLeft"> </td><td class="mdescRight">Get the current OpenCL tuner mode. <a href="#a7476f2d243a36f5719a29bc8c758c62a">More...</a><br /></td></tr> |
| <tr class="separator:a7476f2d243a36f5719a29bc8c758c62a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7de8b49d3ae94affb80ba48945368a8a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#a7de8b49d3ae94affb80ba48945368a8a">add_lws_to_table</a> (const std::string &kernel_id, cl::NDRange optimal_lws)</td></tr> |
| <tr class="memdesc:a7de8b49d3ae94affb80ba48945368a8a"><td class="mdescLeft"> </td><td class="mdescRight">Manually add a LWS for a kernel. <a href="#a7de8b49d3ae94affb80ba48945368a8a">More...</a><br /></td></tr> |
| <tr class="separator:a7de8b49d3ae94affb80ba48945368a8a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaf692ee51358d05ca65755a92591f815"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#aaf692ee51358d05ca65755a92591f815">import_lws_table</a> (const std::unordered_map< std::string, cl::NDRange > &<a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#ab34f765d2b59b8f75dceafc6eb3bcb00">lws_table</a>)</td></tr> |
| <tr class="memdesc:aaf692ee51358d05ca65755a92591f815"><td class="mdescLeft"> </td><td class="mdescRight">Import LWS table. <a href="#aaf692ee51358d05ca65755a92591f815">More...</a><br /></td></tr> |
| <tr class="separator:aaf692ee51358d05ca65755a92591f815"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab34f765d2b59b8f75dceafc6eb3bcb00"><td class="memItemLeft" align="right" valign="top">const std::unordered_map< std::string, cl::NDRange > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#ab34f765d2b59b8f75dceafc6eb3bcb00">lws_table</a> () const</td></tr> |
| <tr class="memdesc:ab34f765d2b59b8f75dceafc6eb3bcb00"><td class="mdescLeft"> </td><td class="mdescRight">Give read access to the LWS table. <a href="#ab34f765d2b59b8f75dceafc6eb3bcb00">More...</a><br /></td></tr> |
| <tr class="separator:ab34f765d2b59b8f75dceafc6eb3bcb00"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7937dca7876064401bb14b4443bf5d8d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#a7937dca7876064401bb14b4443bf5d8d">set_cl_kernel_event</a> (cl_event kernel_event)</td></tr> |
| <tr class="memdesc:a7937dca7876064401bb14b4443bf5d8d"><td class="mdescLeft"> </td><td class="mdescRight">Set the OpenCL kernel event. <a href="#a7937dca7876064401bb14b4443bf5d8d">More...</a><br /></td></tr> |
| <tr class="separator:a7937dca7876064401bb14b4443bf5d8d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5ddfa449f78e4c4d8345e37f1719cc57"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#a5ddfa449f78e4c4d8345e37f1719cc57">load_from_file</a> (const std::string &filename)</td></tr> |
| <tr class="memdesc:a5ddfa449f78e4c4d8345e37f1719cc57"><td class="mdescLeft"> </td><td class="mdescRight">Load the LWS table from file. <a href="#a5ddfa449f78e4c4d8345e37f1719cc57">More...</a><br /></td></tr> |
| <tr class="separator:a5ddfa449f78e4c4d8345e37f1719cc57"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6bc110abab391dca6a6b0e977892020c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#a6bc110abab391dca6a6b0e977892020c">save_to_file</a> (const std::string &filename) const</td></tr> |
| <tr class="memdesc:a6bc110abab391dca6a6b0e977892020c"><td class="mdescLeft"> </td><td class="mdescRight">Save the content of the LWS table to file. <a href="#a6bc110abab391dca6a6b0e977892020c">More...</a><br /></td></tr> |
| <tr class="separator:a6bc110abab391dca6a6b0e977892020c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a52f755d664bbdcb9346cdf5cc4a7e958"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#a52f755d664bbdcb9346cdf5cc4a7e958">tune_kernel_static</a> (<a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a> &kernel) override</td></tr> |
| <tr class="memdesc:a52f755d664bbdcb9346cdf5cc4a7e958"><td class="mdescLeft"> </td><td class="mdescRight">Tune OpenCL kernel statically. <a href="#a52f755d664bbdcb9346cdf5cc4a7e958">More...</a><br /></td></tr> |
| <tr class="separator:a52f755d664bbdcb9346cdf5cc4a7e958"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af073b532560e2105dd22d381f5888ce7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#af073b532560e2105dd22d381f5888ce7">tune_kernel_dynamic</a> (<a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a> &kernel) override</td></tr> |
| <tr class="memdesc:af073b532560e2105dd22d381f5888ce7"><td class="mdescLeft"> </td><td class="mdescRight">Tune OpenCL kernel dynamically. <a href="#af073b532560e2105dd22d381f5888ce7">More...</a><br /></td></tr> |
| <tr class="separator:af073b532560e2105dd22d381f5888ce7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac6fe363cafdd1fcfb6179a7cceac7dad"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#ac6fe363cafdd1fcfb6179a7cceac7dad">kernel_event_is_set</a> () const</td></tr> |
| <tr class="memdesc:ac6fe363cafdd1fcfb6179a7cceac7dad"><td class="mdescLeft"> </td><td class="mdescRight">Is the kernel_event set ? <a href="#ac6fe363cafdd1fcfb6179a7cceac7dad">More...</a><br /></td></tr> |
| <tr class="separator:ac6fe363cafdd1fcfb6179a7cceac7dad"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classarm__compute_1_1_i_c_l_tuner"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_c_l_tuner')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_l_tuner.xhtml">ICLTuner</a></td></tr> |
| <tr class="memitem:a7103799fdecd6abca8fc84efebb3653f inherit pub_methods_classarm__compute_1_1_i_c_l_tuner"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_tuner.xhtml#a7103799fdecd6abca8fc84efebb3653f">~ICLTuner</a> ()=default</td></tr> |
| <tr class="memdesc:a7103799fdecd6abca8fc84efebb3653f inherit pub_methods_classarm__compute_1_1_i_c_l_tuner"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <a href="classarm__compute_1_1_i_c_l_tuner.xhtml#a7103799fdecd6abca8fc84efebb3653f">More...</a><br /></td></tr> |
| <tr class="separator:a7103799fdecd6abca8fc84efebb3653f inherit pub_methods_classarm__compute_1_1_i_c_l_tuner"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> |
| Data Fields</h2></td></tr> |
| <tr class="memitem:a5baba955626e8da33ed5dd829a538974"><td class="memItemLeft" align="right" valign="top">std::function< decltype(<a class="el" href="_open_c_l_8cpp.xhtml#a0152f4b089c26f22f032162d0b7a0d21">clEnqueueNDRangeKernel</a>)> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#a5baba955626e8da33ed5dd829a538974">real_clEnqueueNDRangeKernel</a></td></tr> |
| <tr class="memdesc:a5baba955626e8da33ed5dd829a538974"><td class="mdescLeft"> </td><td class="mdescRight">clEnqueueNDRangeKernel symbol <a href="#a5baba955626e8da33ed5dd829a538974">More...</a><br /></td></tr> |
| <tr class="separator:a5baba955626e8da33ed5dd829a538974"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Basic implementation of the OpenCL tuner interface. </p> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_tuner_8h_source.xhtml#l00038">38</a> of file <a class="el" href="_c_l_tuner_8h_source.xhtml">CLTuner.h</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="ad551ac5b533cac7908910085117f5ca8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad551ac5b533cac7908910085117f5ca8">◆ </a></span>CLTuner()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml">CLTuner</a> </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>tune_new_kernels</em> = <code>true</code></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructor. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">tune_new_kernels</td><td>Find the optimal local workgroup size for kernels which are not present in the table ? </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_tuner_8cpp_source.xhtml#l00040">40</a> of file <a class="el" href="_c_l_tuner_8cpp_source.xhtml">CLTuner.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  : <a class="code" href="classarm__compute_1_1_c_l_tuner.xhtml#a5baba955626e8da33ed5dd829a538974">real_clEnqueueNDRangeKernel</a>(<span class="keyword">nullptr</span>), _lws_table(), _kernel_event(), _tune_new_kernels(<a class="code" href="classarm__compute_1_1_c_l_tuner.xhtml#a362184f6651ae4acde05d5ce85cfd16f">tune_new_kernels</a>), _tuner_mode(<a class="code" href="namespacearm__compute.xhtml#a4c9101ca1a1f72f48efff28b4b9a6495a1e23852820b9154316c7c06e2b7ba051">CLTunerMode::NORMAL</a>)</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> }</div><div class="ttc" id="classarm__compute_1_1_c_l_tuner_xhtml_a5baba955626e8da33ed5dd829a538974"><div class="ttname"><a href="classarm__compute_1_1_c_l_tuner.xhtml#a5baba955626e8da33ed5dd829a538974">arm_compute::CLTuner::real_clEnqueueNDRangeKernel</a></div><div class="ttdeci">std::function< decltype(clEnqueueNDRangeKernel)> real_clEnqueueNDRangeKernel</div><div class="ttdoc">clEnqueueNDRangeKernel symbol</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_tuner_8h_source.xhtml#l00102">CLTuner.h:102</a></div></div> |
| <div class="ttc" id="namespacearm__compute_xhtml_a4c9101ca1a1f72f48efff28b4b9a6495a1e23852820b9154316c7c06e2b7ba051"><div class="ttname"><a href="namespacearm__compute.xhtml#a4c9101ca1a1f72f48efff28b4b9a6495a1e23852820b9154316c7c06e2b7ba051">arm_compute::MemoryPolicy::NORMAL</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_tuner_xhtml_a362184f6651ae4acde05d5ce85cfd16f"><div class="ttname"><a href="classarm__compute_1_1_c_l_tuner.xhtml#a362184f6651ae4acde05d5ce85cfd16f">arm_compute::CLTuner::tune_new_kernels</a></div><div class="ttdeci">bool tune_new_kernels() const</div><div class="ttdoc">Tune kernels that are not in the LWS table.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_tuner_8cpp_source.xhtml#l00058">CLTuner.cpp:58</a></div></div> |
| </div><!-- fragment --> |
| <p class="reference">References <a class="el" href="namespacearm__compute.xhtml#a4c9101ca1a1f72f48efff28b4b9a6495a1e23852820b9154316c7c06e2b7ba051">arm_compute::NORMAL</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a577ac5b9d244bdf031905faaf08b968c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a577ac5b9d244bdf031905faaf08b968c">◆ </a></span>~CLTuner()</h2> |
| |
| <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="classarm__compute_1_1_c_l_tuner.xhtml">CLTuner</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">default</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Destructor. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a7de8b49d3ae94affb80ba48945368a8a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7de8b49d3ae94affb80ba48945368a8a">◆ </a></span>add_lws_to_table()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void add_lws_to_table </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>kernel_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">cl::NDRange </td> |
| <td class="paramname"><em>optimal_lws</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Manually add a LWS for a kernel. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">kernel_id</td><td>Unique identifiant of the kernel </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">optimal_lws</td><td>Optimal local workgroup size to use for the given kernel </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_tuner_8cpp_source.xhtml#l00109">109</a> of file <a class="el" href="_c_l_tuner_8cpp_source.xhtml">CLTuner.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> {</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  _lws_table.emplace(kernel_id, optimal_lws);</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> }</div></div><!-- fragment --> |
| <p class="reference">Referenced by <a class="el" href="_c_l_tuner_8cpp_source.xhtml#l00077">CLTuner::tune_kernel_dynamic()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a7476f2d243a36f5719a29bc8c758c62a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7476f2d243a36f5719a29bc8c758c62a">◆ </a></span>get_tuner_mode()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="namespacearm__compute.xhtml#ae76ef5bd3ad69f7380ebb3ac6033ec5c">CLTunerMode</a> get_tuner_mode </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the current OpenCL tuner mode. </p> |
| <dl class="section return"><dt>Returns</dt><dd>tuner_mode Indicates how exhaustive the search for the optimal LWS should be while tuning </dd></dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_tuner_8cpp_source.xhtml#l00067">67</a> of file <a class="el" href="_c_l_tuner_8cpp_source.xhtml">CLTuner.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> {</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordflow">return</span> _tuner_mode;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> }</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a id="aaf692ee51358d05ca65755a92591f815"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aaf692ee51358d05ca65755a92591f815">◆ </a></span>import_lws_table()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void import_lws_table </td> |
| <td>(</td> |
| <td class="paramtype">const std::unordered_map< std::string, cl::NDRange > & </td> |
| <td class="paramname"><em>lws_table</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Import LWS table. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">lws_table</td><td>The unordered_map container to import </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_tuner_8cpp_source.xhtml#l00222">222</a> of file <a class="el" href="_c_l_tuner_8cpp_source.xhtml">CLTuner.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> {</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  _lws_table.clear();</div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  _lws_table = <a class="code" href="classarm__compute_1_1_c_l_tuner.xhtml#ab34f765d2b59b8f75dceafc6eb3bcb00">lws_table</a>;</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> }</div><div class="ttc" id="classarm__compute_1_1_c_l_tuner_xhtml_ab34f765d2b59b8f75dceafc6eb3bcb00"><div class="ttname"><a href="classarm__compute_1_1_c_l_tuner.xhtml#ab34f765d2b59b8f75dceafc6eb3bcb00">arm_compute::CLTuner::lws_table</a></div><div class="ttdeci">const std::unordered_map< std::string, cl::NDRange > & lws_table() const</div><div class="ttdoc">Give read access to the LWS table.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_tuner_8cpp_source.xhtml#l00228">CLTuner.cpp:228</a></div></div> |
| </div><!-- fragment --> |
| <p class="reference">References <a class="el" href="_c_l_tuner_8cpp_source.xhtml#l00228">CLTuner::lws_table()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ac6fe363cafdd1fcfb6179a7cceac7dad"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac6fe363cafdd1fcfb6179a7cceac7dad">◆ </a></span>kernel_event_is_set()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool kernel_event_is_set </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Is the kernel_event set ? </p> |
| <dl class="section return"><dt>Returns</dt><dd>true if the kernel_event is set. </dd></dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_tuner_8cpp_source.xhtml#l00045">45</a> of file <a class="el" href="_c_l_tuner_8cpp_source.xhtml">CLTuner.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">return</span> _kernel_event() != <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> }</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a id="a5ddfa449f78e4c4d8345e37f1719cc57"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5ddfa449f78e4c4d8345e37f1719cc57">◆ </a></span>load_from_file()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void load_from_file </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>filename</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Load the LWS table from file. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>Load the LWS table from this file.(Must exist) </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_tuner_8cpp_source.xhtml#l00233">233</a> of file <a class="el" href="_c_l_tuner_8cpp_source.xhtml">CLTuner.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> {</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  std::ifstream fs;</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  fs.exceptions(std::ifstream::badbit);</div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  fs.open(filename, std::ios::in);</div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  <span class="keywordflow">if</span>(!fs.is_open())</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  {</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  <a class="code" href="_error_8h.xhtml#a05b19c75afe9c24200a62b9724734bbd">ARM_COMPUTE_ERROR</a>(<span class="stringliteral">"Failed to open '%s' (%s [%d])"</span>, filename.c_str(), strerror(errno), errno);</div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  }</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  std::string line;</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  <span class="keywordflow">while</span>(!std::getline(fs, line).fail())</div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  {</div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  std::istringstream ss(line);</div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  std::string token;</div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  <span class="keywordflow">if</span>(std::getline(ss, token, <span class="charliteral">';'</span>).fail())</div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  {</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  <a class="code" href="_error_8h.xhtml#a05b19c75afe9c24200a62b9724734bbd">ARM_COMPUTE_ERROR</a>(<span class="stringliteral">"Malformed row '%s' in %s (Should be of the form 'kernel_id;lws[0];lws[1];lws[2]')"</span>, ss.str().c_str(), filename.c_str());</div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  }</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  std::string kernel_id = token;</div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  cl::NDRange lws(1, 1, 1);</div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  <span class="keywordflow">for</span>(<span class="keywordtype">int</span> i = 0; i < 3; i++)</div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  {</div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  <span class="keywordflow">if</span>(std::getline(ss, token, <span class="charliteral">';'</span>).fail())</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  {</div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  <a class="code" href="_error_8h.xhtml#a05b19c75afe9c24200a62b9724734bbd">ARM_COMPUTE_ERROR</a>(<span class="stringliteral">"Malformed row '%s' in %s (Should be of the form 'kernel_id;lws[0];lws[1];lws[2]')"</span>, ss.str().c_str(), filename.c_str());</div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  }</div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  lws.get()[i] = <a class="code" href="namespacearm__compute_1_1support_1_1cpp11.xhtml#abdba606a789b8d664774f17d18f45cfe">support::cpp11::stoi</a>(token);</div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  }</div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span> </div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  <span class="comment">// If all dimensions are 0: reset to NullRange (i.e nullptr)</span></div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  <span class="keywordflow">if</span>(lws[0] == 0 && lws[1] == 0 && lws[2] == 0)</div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  {</div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  lws = cl::NullRange;</div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  }</div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  <a class="code" href="classarm__compute_1_1_c_l_tuner.xhtml#a7de8b49d3ae94affb80ba48945368a8a">add_lws_to_table</a>(kernel_id, lws);</div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  }</div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  fs.close();</div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span> }</div><div class="ttc" id="_error_8h_xhtml_a05b19c75afe9c24200a62b9724734bbd"><div class="ttname"><a href="_error_8h.xhtml#a05b19c75afe9c24200a62b9724734bbd">ARM_COMPUTE_ERROR</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR(...)</div><div class="ttdoc">Print the given message then throw an std::runtime_error.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00261">Error.h:261</a></div></div> |
| <div class="ttc" id="namespacearm__compute_1_1support_1_1cpp11_xhtml_abdba606a789b8d664774f17d18f45cfe"><div class="ttname"><a href="namespacearm__compute_1_1support_1_1cpp11.xhtml#abdba606a789b8d664774f17d18f45cfe">arm_compute::support::cpp11::stoi</a></div><div class="ttdeci">int stoi(const std::string &str, std::size_t *pos=0, NumericBase base=NumericBase::BASE_10)</div><div class="ttdoc">Convert string values to integer.</div><div class="ttdef"><b>Definition:</b> <a href="_toolchain_support_8h_source.xhtml#l00063">ToolchainSupport.h:63</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_tuner_xhtml_a7de8b49d3ae94affb80ba48945368a8a"><div class="ttname"><a href="classarm__compute_1_1_c_l_tuner.xhtml#a7de8b49d3ae94affb80ba48945368a8a">arm_compute::CLTuner::add_lws_to_table</a></div><div class="ttdeci">void add_lws_to_table(const std::string &kernel_id, cl::NDRange optimal_lws)</div><div class="ttdoc">Manually add a LWS for a kernel.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_tuner_8cpp_source.xhtml#l00109">CLTuner.cpp:109</a></div></div> |
| </div><!-- fragment --> |
| <p class="reference">References <a class="el" href="_error_8h_source.xhtml#l00261">ARM_COMPUTE_ERROR</a>, and <a class="el" href="_toolchain_support_8h_source.xhtml#l00063">arm_compute::support::cpp11::stoi()</a>.</p> |
| |
| <p class="reference">Referenced by <a class="el" href="main_8cpp_source.xhtml#l00090">main()</a>, and <a class="el" href="_c_l_device_backend_8cpp_source.xhtml#l00108">CLDeviceBackend::setup_backend_context()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ab34f765d2b59b8f75dceafc6eb3bcb00"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab34f765d2b59b8f75dceafc6eb3bcb00">◆ </a></span>lws_table()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::unordered_map< std::string, cl::NDRange > & lws_table </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Give read access to the LWS table. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The lws table as unordered_map container </dd></dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_tuner_8cpp_source.xhtml#l00228">228</a> of file <a class="el" href="_c_l_tuner_8cpp_source.xhtml">CLTuner.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> {</div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  <span class="keywordflow">return</span> _lws_table;</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> }</div></div><!-- fragment --> |
| <p class="reference">Referenced by <a class="el" href="_c_l_tuner_8cpp_source.xhtml#l00222">CLTuner::import_lws_table()</a>, and <a class="el" href="_c_l_device_backend_8cpp_source.xhtml#l00070">CLDeviceBackend::~CLDeviceBackend()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a6bc110abab391dca6a6b0e977892020c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6bc110abab391dca6a6b0e977892020c">◆ </a></span>save_to_file()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void save_to_file </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>filename</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Save the content of the LWS table to file. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>Save the LWS table to this file. (Content will be overwritten) </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_tuner_8cpp_source.xhtml#l00272">272</a> of file <a class="el" href="_c_l_tuner_8cpp_source.xhtml">CLTuner.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00273"></a><span class="lineno"> 273</span> {</div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  std::ofstream fs;</div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  fs.exceptions(std::ifstream::failbit | std::ifstream::badbit);</div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  fs.open(filename, std::ios::out);</div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  <span class="keywordflow">for</span>(<span class="keyword">auto</span> <span class="keyword">const</span> &kernel_data : _lws_table)</div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  {</div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  fs << kernel_data.first << <span class="stringliteral">";"</span> << kernel_data.second[0] << <span class="stringliteral">";"</span> << kernel_data.second[1] << <span class="stringliteral">";"</span> << kernel_data.second[2] << std::endl;</div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  }</div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  fs.close();</div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span> }</div></div><!-- fragment --> |
| <p class="reference">Referenced by <a class="el" href="main_8cpp_source.xhtml#l00090">main()</a>, and <a class="el" href="_c_l_device_backend_8cpp_source.xhtml#l00070">CLDeviceBackend::~CLDeviceBackend()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a7937dca7876064401bb14b4443bf5d8d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7937dca7876064401bb14b4443bf5d8d">◆ </a></span>set_cl_kernel_event()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void set_cl_kernel_event </td> |
| <td>(</td> |
| <td class="paramtype">cl_event </td> |
| <td class="paramname"><em>kernel_event</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the OpenCL kernel event. </p> |
| <dl class="section note"><dt>Note</dt><dd>The interceptor can use this function to store the event associated to the OpenCL kernel</dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">kernel_event</td><td>The OpenCL kernel event </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_tuner_8cpp_source.xhtml#l00049">49</a> of file <a class="el" href="_c_l_tuner_8cpp_source.xhtml">CLTuner.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  _kernel_event = kernel_event;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> }</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a id="aba10acdb2d58e3e0a96364c487a71d40"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aba10acdb2d58e3e0a96364c487a71d40">◆ </a></span>set_tune_new_kernels()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void set_tune_new_kernels </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>tune_new_kernels</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Setter for tune_new_kernels option. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">tune_new_kernels</td><td>Find the optimal local workgroup size for kernels which are not present in the table ? </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_tuner_8cpp_source.xhtml#l00054">54</a> of file <a class="el" href="_c_l_tuner_8cpp_source.xhtml">CLTuner.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  _tune_new_kernels = <a class="code" href="classarm__compute_1_1_c_l_tuner.xhtml#a362184f6651ae4acde05d5ce85cfd16f">tune_new_kernels</a>;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> }</div><div class="ttc" id="classarm__compute_1_1_c_l_tuner_xhtml_a362184f6651ae4acde05d5ce85cfd16f"><div class="ttname"><a href="classarm__compute_1_1_c_l_tuner.xhtml#a362184f6651ae4acde05d5ce85cfd16f">arm_compute::CLTuner::tune_new_kernels</a></div><div class="ttdeci">bool tune_new_kernels() const</div><div class="ttdoc">Tune kernels that are not in the LWS table.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_tuner_8cpp_source.xhtml#l00058">CLTuner.cpp:58</a></div></div> |
| </div><!-- fragment --> |
| <p class="reference">References <a class="el" href="_c_l_tuner_8cpp_source.xhtml#l00058">CLTuner::tune_new_kernels()</a>.</p> |
| |
| <p class="reference">Referenced by <a class="el" href="main_8cpp_source.xhtml#l00090">main()</a>, and <a class="el" href="_c_l_device_backend_8cpp_source.xhtml#l00079">CLDeviceBackend::set_kernel_tuning()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aae485b24df65d39cb646e48317f49639"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aae485b24df65d39cb646e48317f49639">◆ </a></span>set_tuner_mode()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void set_tuner_mode </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#ae76ef5bd3ad69f7380ebb3ac6033ec5c">CLTunerMode</a> </td> |
| <td class="paramname"><em>mode</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set OpenCL tuner mode. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>Indicates how exhaustive the search for the optimal LWS should be while tuning. Default is Exhaustive mode </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_tuner_8cpp_source.xhtml#l00063">63</a> of file <a class="el" href="_c_l_tuner_8cpp_source.xhtml">CLTuner.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> {</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  _tuner_mode = mode;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> }</div></div><!-- fragment --> |
| <p class="reference">Referenced by <a class="el" href="main_8cpp_source.xhtml#l00090">main()</a>, and <a class="el" href="_c_l_device_backend_8cpp_source.xhtml#l00084">CLDeviceBackend::set_kernel_tuning_mode()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="af073b532560e2105dd22d381f5888ce7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af073b532560e2105dd22d381f5888ce7">◆ </a></span>tune_kernel_dynamic()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void tune_kernel_dynamic </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a> & </td> |
| <td class="paramname"><em>kernel</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Tune OpenCL kernel dynamically. </p> |
| <dl class="section note"><dt>Note</dt><dd>Tuning requires memory to be available on all kernel tensors and objects in order to be performed</dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">kernel</td><td><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class.">Kernel</a> to tune </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="classarm__compute_1_1_i_c_l_tuner.xhtml#ae12d76ff3471c1f73c62b7c65addc1ec">ICLTuner</a>.</p> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_tuner_8cpp_source.xhtml#l00077">77</a> of file <a class="el" href="_c_l_tuner_8cpp_source.xhtml">CLTuner.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> {</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="comment">// Get the configuration ID from the kernel and append GPU target name and number of available compute units</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">const</span> std::string config_id = kernel.config_id() + <span class="stringliteral">"_"</span> + <a class="code" href="namespacearm__compute.xhtml#af7795707992825c309fe846740dc8cf8">string_from_target</a>(kernel.get_target()) + <span class="stringliteral">"_MP"</span> + <a class="code" href="namespacearm__compute_1_1support_1_1cpp11.xhtml#acc5dddee1cbe93a4eaf0a9f74ee96bb7">support::cpp11::to_string</a>(<a class="code" href="classarm__compute_1_1_c_l_kernel_library.xhtml#acba005f5ce2c62cbf3f94d074d9007aa">CLKernelLibrary::get</a>().<a class="code" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a70696e3d56dcbcdc1f493dec744bc581">get_num_compute_units</a>());</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="comment">// Check if we need to find the Optimal LWS. If the kernel's config_id is equal to default_config_id, the kernel does not require to be tuned</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">if</span>(kernel.config_id() != arm_compute::default_config_id)</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  {</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">auto</span> p = _lws_table.find(config_id);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordflow">if</span>(p == _lws_table.end())</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  {</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">if</span>(_tune_new_kernels)</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  {</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="comment">// Find the optimal LWS for the kernel</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  cl::NDRange opt_lws = find_optimal_lws(kernel);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="comment">// Insert the optimal LWS in the table</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <a class="code" href="classarm__compute_1_1_c_l_tuner.xhtml#a7de8b49d3ae94affb80ba48945368a8a">add_lws_to_table</a>(config_id, opt_lws);</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="comment">// Set Local-Workgroup-Size</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  kernel.set_lws_hint(opt_lws);</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>  }</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  {</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="comment">// Set Local-Workgroup-Size</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  kernel.set_lws_hint(p->second);</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  }</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  }</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> }</div><div class="ttc" id="namespacearm__compute_1_1support_1_1cpp11_xhtml_acc5dddee1cbe93a4eaf0a9f74ee96bb7"><div class="ttname"><a href="namespacearm__compute_1_1support_1_1cpp11.xhtml#acc5dddee1cbe93a4eaf0a9f74ee96bb7">arm_compute::support::cpp11::to_string</a></div><div class="ttdeci">std::string to_string(T &&value)</div><div class="ttdoc">Convert integer and float values to string.</div><div class="ttdef"><b>Definition:</b> <a href="_toolchain_support_8h_source.xhtml#l00242">ToolchainSupport.h:242</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_kernel_library_xhtml_acba005f5ce2c62cbf3f94d074d9007aa"><div class="ttname"><a href="classarm__compute_1_1_c_l_kernel_library.xhtml#acba005f5ce2c62cbf3f94d074d9007aa">arm_compute::CLKernelLibrary::get</a></div><div class="ttdeci">static CLKernelLibrary & get()</div><div class="ttdoc">Access the KernelLibrary singleton.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_kernel_library_8cpp_source.xhtml#l01037">CLKernelLibrary.cpp:1037</a></div></div> |
| <div class="ttc" id="namespacearm__compute_xhtml_af7795707992825c309fe846740dc8cf8"><div class="ttname"><a href="namespacearm__compute.xhtml#af7795707992825c309fe846740dc8cf8">arm_compute::string_from_target</a></div><div class="ttdeci">const std::string & string_from_target(GPUTarget target)</div><div class="ttdoc">Translates a given gpu device target to string.</div><div class="ttdef"><b>Definition:</b> <a href="src_2core_2_g_p_u_target_8cpp_source.xhtml#l00115">GPUTarget.cpp:115</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_kernel_library_xhtml_a70696e3d56dcbcdc1f493dec744bc581"><div class="ttname"><a href="classarm__compute_1_1_c_l_kernel_library.xhtml#a70696e3d56dcbcdc1f493dec744bc581">arm_compute::CLKernelLibrary::get_num_compute_units</a></div><div class="ttdeci">cl_uint get_num_compute_units()</div><div class="ttdoc">Return the maximum number of compute units in the device.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_kernel_library_8cpp_source.xhtml#l01246">CLKernelLibrary.cpp:1246</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_tuner_xhtml_a7de8b49d3ae94affb80ba48945368a8a"><div class="ttname"><a href="classarm__compute_1_1_c_l_tuner.xhtml#a7de8b49d3ae94affb80ba48945368a8a">arm_compute::CLTuner::add_lws_to_table</a></div><div class="ttdeci">void add_lws_to_table(const std::string &kernel_id, cl::NDRange optimal_lws)</div><div class="ttdoc">Manually add a LWS for a kernel.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_tuner_8cpp_source.xhtml#l00109">CLTuner.cpp:109</a></div></div> |
| </div><!-- fragment --> |
| <p class="reference">References <a class="el" href="_c_l_tuner_8cpp_source.xhtml#l00109">CLTuner::add_lws_to_table()</a>, <a class="el" href="_i_c_l_kernel_8h_source.xhtml#l00262">ICLKernel::config_id()</a>, <a class="el" href="_c_l_kernel_library_8cpp_source.xhtml#l01037">CLKernelLibrary::get()</a>, <a class="el" href="_c_l_kernel_library_8cpp_source.xhtml#l01246">CLKernelLibrary::get_num_compute_units()</a>, <a class="el" href="_i_c_l_kernel_8h_source.xhtml#l00286">ICLKernel::get_target()</a>, <a class="el" href="_i_c_l_kernel_8h_source.xhtml#l00237">ICLKernel::set_lws_hint()</a>, <a class="el" href="src_2core_2_g_p_u_target_8cpp_source.xhtml#l00115">arm_compute::string_from_target()</a>, and <a class="el" href="_toolchain_support_8h_source.xhtml#l00242">arm_compute::support::cpp11::to_string()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a52f755d664bbdcb9346cdf5cc4a7e958"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a52f755d664bbdcb9346cdf5cc4a7e958">◆ </a></span>tune_kernel_static()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void tune_kernel_static </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a> & </td> |
| <td class="paramname"><em>kernel</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Tune OpenCL kernel statically. </p> |
| <dl class="section note"><dt>Note</dt><dd>Tuning is performed using only kernel and tensor metadata, thus can be performed when memory is not available</dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">kernel</td><td><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class.">Kernel</a> to tune </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="classarm__compute_1_1_i_c_l_tuner.xhtml#a384fdc1bc38a4fc6e79af675cc4aa8e3">ICLTuner</a>.</p> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_tuner_8cpp_source.xhtml#l00072">72</a> of file <a class="el" href="_c_l_tuner_8cpp_source.xhtml">CLTuner.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> {</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="_error_8h.xhtml#a6dc630a6ae9cc063b3924bcea8dee9d6">ARM_COMPUTE_UNUSED</a>(kernel);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> }</div><div class="ttc" id="_error_8h_xhtml_a6dc630a6ae9cc063b3924bcea8dee9d6"><div class="ttname"><a href="_error_8h.xhtml#a6dc630a6ae9cc063b3924bcea8dee9d6">ARM_COMPUTE_UNUSED</a></div><div class="ttdeci">#define ARM_COMPUTE_UNUSED(...)</div><div class="ttdoc">To avoid unused variables warnings.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00160">Error.h:160</a></div></div> |
| </div><!-- fragment --> |
| <p class="reference">References <a class="el" href="_error_8h_source.xhtml#l00160">ARM_COMPUTE_UNUSED</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a362184f6651ae4acde05d5ce85cfd16f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a362184f6651ae4acde05d5ce85cfd16f">◆ </a></span>tune_new_kernels()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool tune_new_kernels </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Tune kernels that are not in the LWS table. </p> |
| <dl class="section return"><dt>Returns</dt><dd>True if tuning of new kernels is enabled. </dd></dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_tuner_8cpp_source.xhtml#l00058">58</a> of file <a class="el" href="_c_l_tuner_8cpp_source.xhtml">CLTuner.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> {</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordflow">return</span> _tune_new_kernels;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> }</div></div><!-- fragment --> |
| <p class="reference">Referenced by <a class="el" href="_c_l_tuner_8cpp_source.xhtml#l00054">CLTuner::set_tune_new_kernels()</a>, and <a class="el" href="_c_l_device_backend_8cpp_source.xhtml#l00070">CLDeviceBackend::~CLDeviceBackend()</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Field Documentation</h2> |
| <a id="a5baba955626e8da33ed5dd829a538974"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5baba955626e8da33ed5dd829a538974">◆ </a></span>real_clEnqueueNDRangeKernel</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::function<decltype(<a class="el" href="_open_c_l_8cpp.xhtml#a0152f4b089c26f22f032162d0b7a0d21">clEnqueueNDRangeKernel</a>)> real_clEnqueueNDRangeKernel</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>clEnqueueNDRangeKernel symbol </p> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_tuner_8h_source.xhtml#l00102">102</a> of file <a class="el" href="_c_l_tuner_8h_source.xhtml">CLTuner.h</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>arm_compute/runtime/CL/<a class="el" href="_c_l_tuner_8h_source.xhtml">CLTuner.h</a></li> |
| <li>src/runtime/CL/<a class="el" href="_c_l_tuner_8cpp_source.xhtml">CLTuner.cpp</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="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml">CLTuner</a></li> |
| <li class="footer">Generated on Mon Sep 2 2019 11:47:34 for Compute Library by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
