| <!-- 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: arm_compute/runtime/CL/CLScheduler.h Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="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">20.02.1</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('_c_l_scheduler_8h_source.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="headertitle"> |
| <div class="title">CLScheduler.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="_c_l_scheduler_8h.xhtml">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2016-2019 ARM Limited.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * SPDX-License-Identifier: MIT</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * of this software and associated documentation files (the "Software"), to</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * deal in the Software without restriction, including without limitation the</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * sell copies of the Software, and to permit persons to whom the Software is</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * The above copyright notice and this permission notice shall be included in all</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * copies or substantial portions of the Software.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * SOFTWARE.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifndef ARM_COMPUTE_CLSCHEDULER_H</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define ARM_COMPUTE_CLSCHEDULER_H</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="core_2_c_l_2_c_l_helpers_8h.xhtml">arm_compute/core/CL/CLHelpers.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="_c_l_types_8h.xhtml">arm_compute/core/CL/CLTypes.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="_open_c_l_8h.xhtml">arm_compute/core/CL/OpenCL.h</a>"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "<a class="code" href="_error_8h.xhtml">arm_compute/core/Error.h</a>"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "<a class="code" href="arm__compute_2core_2_types_8h.xhtml">arm_compute/core/Types.h</a>"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "<a class="code" href="_i_c_l_tuner_8h.xhtml">arm_compute/runtime/CL/ICLTuner.h</a>"</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">namespace </span><a class="code" href="namespacearm__compute.xhtml">arm_compute</a></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">class </span>ICLKernel;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">class </span>ICLTuner;<span class="comment"></span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">/** Provides global access to a CL context and command queue. */</span></div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_c_l_scheduler.xhtml"> 39</a></span> <span class="keyword">class </span><a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml">CLScheduler</a> final</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> /** Constructor */</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a98c15ddf61f1cf0c8d90429f41db09fb">CLScheduler</a>();<span class="comment"></span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> /** Prevent instances of this class from being copied (As this class contains pointers) */</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a98c15ddf61f1cf0c8d90429f41db09fb">CLScheduler</a>(<span class="keyword">const</span> <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml">CLScheduler</a> &) = <span class="keyword">delete</span>;<span class="comment"></span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> /** Prevent instances of this class from being copied (As this class contains pointers) */</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml">CLScheduler</a> &<a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#afae103416db3e94a7ba0dc7ed642a7fc">operator=</a>(<span class="keyword">const</span> <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml">CLScheduler</a> &) = <span class="keyword">delete</span>;<span class="comment"></span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> /** Default destructor */</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a8f1b713830e21a03ef018f2ae7c7bd17">~CLScheduler</a>() = <span class="keywordflow">default</span>;<span class="comment"></span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> /** Access the scheduler singleton.</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * This method has been deprecated and will be removed in future releases</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * @return The scheduler</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> */</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">static</span> <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml">CLScheduler</a> &<a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a9b58d0eb9a2af8e6d7908695e1557d6c">get</a>();<span class="comment"></span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> /** Initialises the context and command queue used by the scheduler to default values</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * and sets a default device and kernel path for the @ref CLKernelLibrary.</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> *</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * @param[in] cl_tuner (Optional) Pointer to ICLTuner (default=nullptr)</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> */</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a46ecf9ef0fe80ba2ed35acfc29856b7d">default_init</a>(<a class="code" href="classarm__compute_1_1_i_c_l_tuner.xhtml">ICLTuner</a> *cl_tuner = <span class="keyword">nullptr</span>);<span class="comment"></span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> /** Initialises the scheduler with context and device provided by the user</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> *</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * @param[in] device OpenCL device to be used</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * @param[in] ctx OpenCL ctx to be used</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * @param[in] cl_tuner (Optional) Pointer to ICLTuner (default=nullptr)</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> */</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#aa1ab77c1da6b5a6da2e1957352985c8c">default_init_with_context</a>(cl::Device &device, cl::Context &ctx, <a class="code" href="classarm__compute_1_1_i_c_l_tuner.xhtml">ICLTuner</a> *cl_tuner = <span class="keyword">nullptr</span>);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"></span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> /** Schedule the execution of the passed kernel if possible.</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> *</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * @param[in] kernel Kernel to execute.</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * @param[in] flush (Optional) Specifies if the command queue will be flushed after running the kernel.</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> */</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#ae1a643e517f50bf0392fb6516dd7cf67">enqueue</a>(<a class="code" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a> &kernel, <span class="keywordtype">bool</span> flush = <span class="keyword">true</span>);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"></span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> /** Initialises the context and command queue to be used by the scheduler.</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> *</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * @param[in] context A CL context.</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * @param[in] queue A CL command queue.</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * @param[in] device A CL device.</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * @param[in] cl_tuner (Optional) Pointer to OpenCL tuner (default=nullptr)</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * Note: It is caller's responsibility to release the allocated memory for CLTuner</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> */</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a89be78d1ed13202968d25524b2d69393">init</a>(cl::Context <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a86409f541991c3ac377c2a6b7d1f832d">context</a>, cl::CommandQueue <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a398a2582c746d28fc125487a44c9ed74">queue</a>, <span class="keyword">const</span> cl::Device &device, <a class="code" href="classarm__compute_1_1_i_c_l_tuner.xhtml">ICLTuner</a> *cl_tuner = <span class="keyword">nullptr</span>);</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"></span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> /** Accessor for the associated CL context.</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> *</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * @return A CL context.</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> */</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  cl::Context &<a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a86409f541991c3ac377c2a6b7d1f832d">context</a>();</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"></span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> /** Accessor for the associated CL command queue.</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> *</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * @return A CL command queue.</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> */</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  cl::CommandQueue &<a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a398a2582c746d28fc125487a44c9ed74">queue</a>();</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"></span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> /** Get the target GPU.</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> *</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * @return The target GPU.</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> */</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <a class="code" href="namespacearm__compute.xhtml#a735ac6c2a02e320969625308810444f3">GPUTarget</a> <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a27561688e2fc60176608ef725a4ecb30">target</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"></span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> /** Accessor to set the CL context to be used by the scheduler.</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> *</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * @param[in] context A CL context.</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> */</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a293edc1bbcbddffb7228ac97917ed107">set_context</a>(cl::Context <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a86409f541991c3ac377c2a6b7d1f832d">context</a>);</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"></span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> /** Accessor to set the CL command queue to be used by the scheduler.</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> *</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * @param[in] queue A CL command queue.</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> */</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a9608e5af9f3a199f69ca6aa41b94359a">set_queue</a>(cl::CommandQueue <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a398a2582c746d28fc125487a44c9ed74">queue</a>);</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"></span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> /** Accessor to set target GPU to be used by the scheduler.</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> *</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * @param[in] target The target GPU.</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> */</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#ad5ba9d34a3a855bf1dd2e36316ff550a">set_target</a>(<a class="code" href="namespacearm__compute.xhtml#a735ac6c2a02e320969625308810444f3">GPUTarget</a> <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a27561688e2fc60176608ef725a4ecb30">target</a>);</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"></span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> /** Accessor to set the CL tuner to be used by the scheduler.</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> *</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * @param[in] tuner A CL tuner</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> */</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#ad4e05822793fb639fd65ac30428a7878">set_tuner</a>(<a class="code" href="classarm__compute_1_1_i_c_l_tuner.xhtml">ICLTuner</a> *tuner);</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"></span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> /** Blocks until all commands in the associated command queue have finished. */</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#ad55f80ed3cd8b6c4f247763b747016af">sync</a>();</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"></span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> /** Enqueues a marker into the associated command queue and return the event.</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> *</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * @return An event that can be waited on to block the executing thread.</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> */</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  cl::Event <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a6096d26e8e29e1a7f01b0f083fb7e33f">enqueue_sync_event</a>();</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"></span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> /** Tunes OpenCL kernel</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> *</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * @param[in] kernel Kernel to tune</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> */</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a6c2059df991a75abef4eb643510c9544">tune_kernel_static</a>(<a class="code" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a> &kernel);</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordtype">bool</span> <a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#acd81d12c19e4080b463244a58118e503">is_initialised</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="keyword">private</span>:<span class="comment"></span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> /** Flag to ensure symbols initialisation is happening before Scheduler creation */</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keyword">static</span> std::once_flag _initialize_symbols;</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  cl::Context _context;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  cl::CommandQueue _queue;</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <a class="code" href="namespacearm__compute.xhtml#a735ac6c2a02e320969625308810444f3">GPUTarget</a> _target;</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keywordtype">bool</span> _is_initialised;</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <a class="code" href="classarm__compute_1_1_i_c_l_tuner.xhtml">ICLTuner</a> *_cl_tuner;</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  std::unique_ptr<ICLTuner> _cl_default_static_tuner;</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> };</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> } <span class="comment">// namespace arm_compute</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="preprocessor">#endif </span><span class="comment">/* ARM_COMPUTE_CLSCHEDULER_H */</span><span class="preprocessor"></span></div><div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_ad5ba9d34a3a855bf1dd2e36316ff550a"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#ad5ba9d34a3a855bf1dd2e36316ff550a">arm_compute::CLScheduler::set_target</a></div><div class="ttdeci">void set_target(GPUTarget target)</div><div class="ttdoc">Accessor to set target GPU to be used by the scheduler.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8cpp_source.xhtml#l00057">CLScheduler.cpp:57</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_a9b58d0eb9a2af8e6d7908695e1557d6c"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#a9b58d0eb9a2af8e6d7908695e1557d6c">arm_compute::CLScheduler::get</a></div><div class="ttdeci">static CLScheduler & get()</div><div class="ttdoc">Access the scheduler singleton.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8cpp_source.xhtml#l00099">CLScheduler.cpp:99</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_a27561688e2fc60176608ef725a4ecb30"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#a27561688e2fc60176608ef725a4ecb30">arm_compute::CLScheduler::target</a></div><div class="ttdeci">GPUTarget target() const</div><div class="ttdoc">Get the target GPU.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8cpp_source.xhtml#l00047">CLScheduler.cpp:47</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_a293edc1bbcbddffb7228ac97917ed107"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#a293edc1bbcbddffb7228ac97917ed107">arm_compute::CLScheduler::set_context</a></div><div class="ttdeci">void set_context(cl::Context context)</div><div class="ttdoc">Accessor to set the CL context to be used by the scheduler.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8cpp_source.xhtml#l00139">CLScheduler.cpp:139</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_afae103416db3e94a7ba0dc7ed642a7fc"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#afae103416db3e94a7ba0dc7ed642a7fc">arm_compute::CLScheduler::operator=</a></div><div class="ttdeci">CLScheduler & operator=(const CLScheduler &)=delete</div><div class="ttdoc">Prevent instances of this class from being copied (As this class contains pointers)</div></div> |
| <div class="ttc" id="_c_l_types_8h_xhtml"><div class="ttname"><a href="_c_l_types_8h.xhtml">CLTypes.h</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_a8f1b713830e21a03ef018f2ae7c7bd17"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#a8f1b713830e21a03ef018f2ae7c7bd17">arm_compute::CLScheduler::~CLScheduler</a></div><div class="ttdeci">~CLScheduler()=default</div><div class="ttdoc">Default destructor.</div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_acd81d12c19e4080b463244a58118e503"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#acd81d12c19e4080b463244a58118e503">arm_compute::CLScheduler::is_initialised</a></div><div class="ttdeci">bool is_initialised() const</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8cpp_source.xhtml#l00087">CLScheduler.cpp:87</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_a89be78d1ed13202968d25524b2d69393"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#a89be78d1ed13202968d25524b2d69393">arm_compute::CLScheduler::init</a></div><div class="ttdeci">void init(cl::Context context, cl::CommandQueue queue, const cl::Device &device, ICLTuner *cl_tuner=nullptr)</div><div class="ttdoc">Initialises the context and command queue to be used by the scheduler.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8cpp_source.xhtml#l00145">CLScheduler.cpp:145</a></div></div> |
| <div class="ttc" id="core_2_c_l_2_c_l_helpers_8h_xhtml"><div class="ttname"><a href="core_2_c_l_2_c_l_helpers_8h.xhtml">CLHelpers.h</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_i_c_l_kernel_xhtml"><div class="ttname"><a href="classarm__compute_1_1_i_c_l_kernel.xhtml">arm_compute::ICLKernel</a></div><div class="ttdoc">Common interface for all the OpenCL kernels.</div><div class="ttdef"><b>Definition:</b> <a href="_i_c_l_kernel_8h_source.xhtml#l00043">ICLKernel.h:43</a></div></div> |
| <div class="ttc" id="namespacearm__compute_xhtml"><div class="ttname"><a href="namespacearm__compute.xhtml">arm_compute</a></div><div class="ttdoc">Copyright (c) 2017-2020 ARM Limited.</div><div class="ttdef"><b>Definition:</b> <a href="00__introduction_8dox_source.xhtml#l00024">00_introduction.dox:24</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_a86409f541991c3ac377c2a6b7d1f832d"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#a86409f541991c3ac377c2a6b7d1f832d">arm_compute::CLScheduler::context</a></div><div class="ttdeci">cl::Context & context()</div><div class="ttdoc">Accessor for the associated CL context.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8cpp_source.xhtml#l00034">CLScheduler.cpp:34</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_a6096d26e8e29e1a7f01b0f083fb7e33f"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#a6096d26e8e29e1a7f01b0f083fb7e33f">arm_compute::CLScheduler::enqueue_sync_event</a></div><div class="ttdeci">cl::Event enqueue_sync_event()</div><div class="ttdoc">Enqueues a marker into the associated command queue and return the event.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8cpp_source.xhtml#l00072">CLScheduler.cpp:72</a></div></div> |
| <div class="ttc" id="_i_c_l_tuner_8h_xhtml"><div class="ttname"><a href="_i_c_l_tuner_8h.xhtml">ICLTuner.h</a></div></div> |
| <div class="ttc" id="_error_8h_xhtml"><div class="ttname"><a href="_error_8h.xhtml">Error.h</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_ad4e05822793fb639fd65ac30428a7878"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#ad4e05822793fb639fd65ac30428a7878">arm_compute::CLScheduler::set_tuner</a></div><div class="ttdeci">void set_tuner(ICLTuner *tuner)</div><div class="ttdoc">Accessor to set the CL tuner to be used by the scheduler.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8cpp_source.xhtml#l00062">CLScheduler.cpp:62</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_a398a2582c746d28fc125487a44c9ed74"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#a398a2582c746d28fc125487a44c9ed74">arm_compute::CLScheduler::queue</a></div><div class="ttdeci">cl::CommandQueue & queue()</div><div class="ttdoc">Accessor for the associated CL command queue.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8cpp_source.xhtml#l00041">CLScheduler.cpp:41</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_ae1a643e517f50bf0392fb6516dd7cf67"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#ae1a643e517f50bf0392fb6516dd7cf67">arm_compute::CLScheduler::enqueue</a></div><div class="ttdeci">void enqueue(ICLKernel &kernel, bool flush=true)</div><div class="ttdoc">Schedule the execution of the passed kernel if possible.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8cpp_source.xhtml#l00154">CLScheduler.cpp:154</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_a9608e5af9f3a199f69ca6aa41b94359a"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#a9608e5af9f3a199f69ca6aa41b94359a">arm_compute::CLScheduler::set_queue</a></div><div class="ttdeci">void set_queue(cl::CommandQueue queue)</div><div class="ttdoc">Accessor to set the CL command queue to be used by the scheduler.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8cpp_source.xhtml#l00052">CLScheduler.cpp:52</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_a98c15ddf61f1cf0c8d90429f41db09fb"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#a98c15ddf61f1cf0c8d90429f41db09fb">arm_compute::CLScheduler::CLScheduler</a></div><div class="ttdeci">CLScheduler()</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8cpp_source.xhtml#l00094">CLScheduler.cpp:94</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_ad55f80ed3cd8b6c4f247763b747016af"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#ad55f80ed3cd8b6c4f247763b747016af">arm_compute::CLScheduler::sync</a></div><div class="ttdeci">void sync()</div><div class="ttdoc">Blocks until all commands in the associated command queue have finished.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8cpp_source.xhtml#l00067">CLScheduler.cpp:67</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_aa1ab77c1da6b5a6da2e1957352985c8c"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#aa1ab77c1da6b5a6da2e1957352985c8c">arm_compute::CLScheduler::default_init_with_context</a></div><div class="ttdeci">void default_init_with_context(cl::Device &device, cl::Context &ctx, ICLTuner *cl_tuner=nullptr)</div><div class="ttdoc">Initialises the scheduler with context and device provided by the user.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8cpp_source.xhtml#l00106">CLScheduler.cpp:106</a></div></div> |
| <div class="ttc" id="namespacearm__compute_xhtml_a735ac6c2a02e320969625308810444f3"><div class="ttname"><a href="namespacearm__compute.xhtml#a735ac6c2a02e320969625308810444f3">arm_compute::GPUTarget</a></div><div class="ttdeci">GPUTarget</div><div class="ttdoc">Available GPU Targets.</div><div class="ttdef"><b>Definition:</b> <a href="_g_p_u_target_8h_source.xhtml#l00034">GPUTarget.h:34</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml">arm_compute::CLScheduler</a></div><div class="ttdoc">Provides global access to a CL context and command queue.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8h_source.xhtml#l00039">CLScheduler.h:39</a></div></div> |
| <div class="ttc" id="_open_c_l_8h_xhtml"><div class="ttname"><a href="_open_c_l_8h.xhtml">OpenCL.h</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_i_c_l_tuner_xhtml"><div class="ttname"><a href="classarm__compute_1_1_i_c_l_tuner.xhtml">arm_compute::ICLTuner</a></div><div class="ttdoc">Basic interface for tuning the OpenCL kernels.</div><div class="ttdef"><b>Definition:</b> <a href="_i_c_l_tuner_8h_source.xhtml#l00032">ICLTuner.h:32</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_a6c2059df991a75abef4eb643510c9544"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#a6c2059df991a75abef4eb643510c9544">arm_compute::CLScheduler::tune_kernel_static</a></div><div class="ttdeci">void tune_kernel_static(ICLKernel &kernel)</div><div class="ttdoc">Tunes OpenCL kernel.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8cpp_source.xhtml#l00079">CLScheduler.cpp:79</a></div></div> |
| <div class="ttc" id="arm__compute_2core_2_types_8h_xhtml"><div class="ttname"><a href="arm__compute_2core_2_types_8h.xhtml">Types.h</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_a46ecf9ef0fe80ba2ed35acfc29856b7d"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#a46ecf9ef0fe80ba2ed35acfc29856b7d">arm_compute::CLScheduler::default_init</a></div><div class="ttdeci">void default_init(ICLTuner *cl_tuner=nullptr)</div><div class="ttdoc">Initialises the context and command queue used by the scheduler to default values and sets a default ...</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8cpp_source.xhtml#l00119">CLScheduler.cpp:119</a></div></div> |
| </div><!-- fragment --></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="dir_214608ef36d61442cb2b0c1c4e9a7def.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="dir_8bc26130589aa16388b5a02f17abf2c2.xhtml">runtime</a></li><li class="navelem"><a class="el" href="dir_b986aa98f9b6490bb4fc7918500346fb.xhtml">CL</a></li><li class="navelem"><a class="el" href="_c_l_scheduler_8h.xhtml">CLScheduler.h</a></li> |
| <li class="footer">Generated on Thu Mar 5 2020 16:06:56 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> |
