mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
79 lines
19 KiB
HTML
79 lines
19 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>FairMQ: fairmq/MemoryResources.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">FairMQ
|
|
 <span id="projectnumber">1.4.14</span>
|
|
</div>
|
|
<div id="projectbrief">C++ Message Queuing Library and Framework</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d6b28f7731906a8cbc4171450df4b180.html">fairmq</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">MemoryResources.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/********************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (C) 2018 CERN and copyright holders of ALICE O2 *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright (C) 2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This software is distributed under the terms of the *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * GNU Lesser General Public Licence (LGPL) version 3, *</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * copied verbatim in the file "LICENSE" *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> ********************************************************************************/</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#ifndef FAIR_MQ_MEMORY_RESOURCES_H</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#define FAIR_MQ_MEMORY_RESOURCES_H</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <fairmq/FairMQMessage.h></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">class </span><a class="code" href="classFairMQTransportFactory.html">FairMQTransportFactory</a>;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <boost/container/flat_map.hpp></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <boost/container/pmr/memory_resource.hpp></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <boost/container/pmr/monotonic_buffer_resource.hpp></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <boost/container/pmr/polymorphic_allocator.hpp></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <cstring></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <utility></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span><a class="code" href="namespacefair.html">fair</a> {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span>mq {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">using</span> byte = <span class="keywordtype">unsigned</span> char;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">namespace </span>pmr = boost::container::pmr;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1FairMQMemoryResource.html"> 37</a></span> <span class="keyword">class </span><a class="code" href="classfair_1_1mq_1_1FairMQMemoryResource.html">FairMQMemoryResource</a> : <span class="keyword">public</span> pmr::memory_resource</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">virtual</span> FairMQMessagePtr <a class="code" href="classfair_1_1mq_1_1FairMQMemoryResource.html#ac4af63a6341db214cc350b3270543584">getMessage</a>(<span class="keywordtype">void</span> *p) = 0;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> *setMessage(FairMQMessagePtr) = 0;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">virtual</span> <a class="code" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *getTransportFactory() noexcept = 0;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> getNumberOfMessages() <span class="keyword">const</span> noexcept = 0;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> };</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1ChannelResource.html"> 56</a></span> <span class="keyword">class </span><a class="code" href="classfair_1_1mq_1_1ChannelResource.html">ChannelResource</a> : <span class="keyword">public</span> <a class="code" href="classfair_1_1mq_1_1FairMQMemoryResource.html">FairMQMemoryResource</a></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *factory{<span class="keyword">nullptr</span>};</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">// TODO: for now a map to keep track of allocations, something else would</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// probably be</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="comment">// faster, but for now this does not need to be fast.</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  boost::container::flat_map<void *, FairMQMessagePtr> messageMap;</div><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>  <span class="keyword">public</span>:</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="classfair_1_1mq_1_1ChannelResource.html">ChannelResource</a>() = <span class="keyword">delete</span>;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="classfair_1_1mq_1_1ChannelResource.html">ChannelResource</a>(<a class="code" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *_factory)</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  : <a class="code" href="classfair_1_1mq_1_1FairMQMemoryResource.html">FairMQMemoryResource</a>()</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  , factory(_factory)</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  , messageMap()</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  {</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">if</span> (!_factory) {</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordflow">throw</span> std::runtime_error(<span class="stringliteral">"Tried to construct from a nullptr FairMQTransportFactory"</span>);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  }</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  };</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1ChannelResource.html#a86d96d680d0d8316665c8cd95b68a744"> 78</a></span>  FairMQMessagePtr <a class="code" href="classfair_1_1mq_1_1ChannelResource.html#a86d96d680d0d8316665c8cd95b68a744">getMessage</a>(<span class="keywordtype">void</span> *p)<span class="keyword"> override</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">auto</span> mes = std::move(messageMap[p]);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  messageMap.erase(p);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordflow">return</span> mes;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  }</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="keywordtype">void</span> *setMessage(FairMQMessagePtr message)<span class="keyword"> override</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">void</span> *addr = message->GetData();</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  messageMap[addr] = std::move(message);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">return</span> addr;</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> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <a class="code" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *getTransportFactory() noexcept <span class="keyword">override</span> { <span class="keywordflow">return</span> factory; }</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="keywordtype">size_t</span> getNumberOfMessages() <span class="keyword">const</span> noexcept <span class="keyword">override</span> { <span class="keywordflow">return</span> messageMap.size(); }</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">void</span> *do_allocate(std::size_t bytes, std::size_t alignment) <span class="keyword">override</span>;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordtype">void</span> do_deallocate(<span class="keywordtype">void</span> *p, std::size_t <span class="comment">/*bytes*/</span>, std::size_t <span class="comment">/*alignment*/</span>)<span class="keyword"> override</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  messageMap.erase(p);</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</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="keywordtype">bool</span> do_is_equal(<span class="keyword">const</span> pmr::memory_resource &other) <span class="keyword">const</span> noexcept <span class="keyword">override</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  {</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordflow">return</span> <span class="keyword">this</span> == &other;</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="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> } <span class="comment">/* namespace mq */</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> } <span class="comment">/* namespace fair */</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor">#endif </span><span class="comment">/* FAIR_MQ_MEMORY_RESOURCES_H */</span><span class="preprocessor"></span></div><div class="ttc" id="classfair_1_1mq_1_1FairMQMemoryResource_html_ac4af63a6341db214cc350b3270543584"><div class="ttname"><a href="classfair_1_1mq_1_1FairMQMemoryResource.html#ac4af63a6341db214cc350b3270543584">fair::mq::FairMQMemoryResource::getMessage</a></div><div class="ttdeci">virtual FairMQMessagePtr getMessage(void *p)=0</div></div>
|
|
<div class="ttc" id="classFairMQTransportFactory_html"><div class="ttname"><a href="classFairMQTransportFactory.html">FairMQTransportFactory</a></div><div class="ttdef"><b>Definition:</b> FairMQTransportFactory.h:30</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1FairMQMemoryResource_html"><div class="ttname"><a href="classfair_1_1mq_1_1FairMQMemoryResource.html">fair::mq::FairMQMemoryResource</a></div><div class="ttdef"><b>Definition:</b> MemoryResources.h:37</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1ChannelResource_html_a86d96d680d0d8316665c8cd95b68a744"><div class="ttname"><a href="classfair_1_1mq_1_1ChannelResource.html#a86d96d680d0d8316665c8cd95b68a744">fair::mq::ChannelResource::getMessage</a></div><div class="ttdeci">FairMQMessagePtr getMessage(void *p) override</div><div class="ttdef"><b>Definition:</b> MemoryResources.h:78</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1ChannelResource_html"><div class="ttname"><a href="classfair_1_1mq_1_1ChannelResource.html">fair::mq::ChannelResource</a></div><div class="ttdef"><b>Definition:</b> MemoryResources.h:56</div></div>
|
|
<div class="ttc" id="namespacefair_html"><div class="ttname"><a href="namespacefair.html">fair</a></div><div class="ttdoc">Tools for interfacing containers to the transport via polymorphic allocators. </div><div class="ttdef"><b>Definition:</b> DeviceRunner.h:23</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
|