mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
79 lines
21 KiB
HTML
79 lines
21 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/shmem/Common.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><li class="navelem"><a class="el" href="dir_6475741fe3587c0a949798307da6131d.html">shmem</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Common.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/********************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * This software is distributed under the terms of the *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * GNU Lesser General Public Licence (LGPL) version 3, *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * copied verbatim in the file "LICENSE" *</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> ********************************************************************************/</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#ifndef FAIR_MQ_SHMEM_COMMON_H_</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#define FAIR_MQ_SHMEM_COMMON_H_</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <atomic></span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <unordered_map></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">#include <boost/interprocess/managed_shared_memory.hpp></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <boost/interprocess/allocators/allocator.hpp></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <boost/interprocess/containers/map.hpp></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <boost/interprocess/containers/string.hpp></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <boost/interprocess/containers/vector.hpp></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <boost/functional/hash.hpp></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <unistd.h></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <sys/types.h></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">namespace </span><a class="code" href="namespacefair.html">fair</a></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="keyword">namespace </span>mq</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span>shmem</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> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">using</span> SegmentManager = boost::interprocess::managed_shared_memory::segment_manager;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">using</span> VoidAlloc = boost::interprocess::allocator<void, SegmentManager>;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">using</span> CharAlloc = boost::interprocess::allocator<char, SegmentManager>;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">using</span> Str = boost::interprocess::basic_string<char, std::char_traits<char>, CharAlloc>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">using</span> StrAlloc = boost::interprocess::allocator<Str, SegmentManager>;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">using</span> StrVector = boost::interprocess::vector<Str, StrAlloc>;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="structfair_1_1mq_1_1shmem_1_1RegionInfo.html"> 39</a></span> <span class="keyword">struct </span><a class="code" href="structfair_1_1mq_1_1shmem_1_1RegionInfo.html">RegionInfo</a></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="structfair_1_1mq_1_1shmem_1_1RegionInfo.html">RegionInfo</a>(<span class="keyword">const</span> VoidAlloc& alloc)</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  : fPath(<span class="stringliteral">""</span>, alloc)</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  , fFlags(0)</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  , fUserFlags(0)</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  , fDestroyed(<span class="keyword">false</span>)</div><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> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="structfair_1_1mq_1_1shmem_1_1RegionInfo.html">RegionInfo</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* path, <span class="keyword">const</span> <span class="keywordtype">int</span> flags, <span class="keyword">const</span> uint64_t userFlags, <span class="keyword">const</span> VoidAlloc& alloc)</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  : fPath(path, alloc)</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  , fFlags(flags)</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  , fUserFlags(userFlags)</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  , fDestroyed(<span class="keyword">false</span>)</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  {}</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  Str fPath;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">int</span> fFlags;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  uint64_t fUserFlags;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">bool</span> fDestroyed;</div><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> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">using</span> Uint64RegionInfoPairAlloc = boost::interprocess::allocator<std::pair<const uint64_t, RegionInfo>, SegmentManager>;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">using</span> Uint64RegionInfoMap = boost::interprocess::map<uint64_t, RegionInfo, std::less<uint64_t>, Uint64RegionInfoPairAlloc>;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="structfair_1_1mq_1_1shmem_1_1DeviceCounter.html"> 64</a></span> <span class="keyword">struct </span><a class="code" href="structfair_1_1mq_1_1shmem_1_1DeviceCounter.html">DeviceCounter</a></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> {</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="structfair_1_1mq_1_1shmem_1_1DeviceCounter.html">DeviceCounter</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> c)</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  : fCount(c)</div><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> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  std::atomic<unsigned int> fCount;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> };</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="structfair_1_1mq_1_1shmem_1_1RegionCounter.html"> 73</a></span> <span class="keyword">struct </span><a class="code" href="structfair_1_1mq_1_1shmem_1_1RegionCounter.html">RegionCounter</a></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> {</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="structfair_1_1mq_1_1shmem_1_1RegionCounter.html">RegionCounter</a>(uint64_t c)</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  : fCount(c)</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  {}</div><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>  std::atomic<uint64_t> fCount;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> };</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="structfair_1_1mq_1_1shmem_1_1MetaHeader.html"> 82</a></span> <span class="keyword">struct </span><a class="code" href="structfair_1_1mq_1_1shmem_1_1MetaHeader.html">MetaHeader</a></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>  <span class="keywordtype">size_t</span> fSize;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">size_t</span> fRegionId;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">size_t</span> fHint;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  boost::interprocess::managed_shared_memory::handle_t fHandle;</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> </div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="structfair_1_1mq_1_1shmem_1_1RegionBlock.html"> 90</a></span> <span class="keyword">struct </span><a class="code" href="structfair_1_1mq_1_1shmem_1_1RegionBlock.html">RegionBlock</a></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="structfair_1_1mq_1_1shmem_1_1RegionBlock.html">RegionBlock</a>()</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  : fHandle()</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  , fSize(0)</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  , fHint(0)</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> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <a class="code" href="structfair_1_1mq_1_1shmem_1_1RegionBlock.html">RegionBlock</a>(boost::interprocess::managed_shared_memory::handle_t handle, <span class="keywordtype">size_t</span> size, <span class="keywordtype">size_t</span> hint)</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  : fHandle(handle)</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  , fSize(size)</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  , fHint(hint)</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> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  boost::interprocess::managed_shared_memory::handle_t fHandle;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordtype">size_t</span> fSize;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordtype">size_t</span> fHint;</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">// find id for unique shmem name:</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment">// a hash of user id + session id, truncated to 8 characters (to accommodate for name size limit on some systems (MacOS)).</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="keyword">inline</span> std::string buildShmIdFromSessionIdAndUserId(<span class="keyword">const</span> std::string& sessionId)</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> {</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  boost::hash<std::string> stringHash;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  std::string shmId(std::to_string(stringHash(std::string((std::to_string(geteuid()) + sessionId)))));</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  shmId.resize(8, <span class="charliteral">'_'</span>);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordflow">return</span> shmId;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> }</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> } <span class="comment">// namespace shmem</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> } <span class="comment">// namespace mq</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> } <span class="comment">// namespace fair</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="preprocessor">#endif </span><span class="comment">/* FAIR_MQ_SHMEM_COMMON_H_ */</span><span class="preprocessor"></span></div><div class="ttc" id="structfair_1_1mq_1_1shmem_1_1RegionCounter_html"><div class="ttname"><a href="structfair_1_1mq_1_1shmem_1_1RegionCounter.html">fair::mq::shmem::RegionCounter</a></div><div class="ttdef"><b>Definition:</b> Common.h:73</div></div>
|
|
<div class="ttc" id="structfair_1_1mq_1_1shmem_1_1RegionBlock_html"><div class="ttname"><a href="structfair_1_1mq_1_1shmem_1_1RegionBlock.html">fair::mq::shmem::RegionBlock</a></div><div class="ttdef"><b>Definition:</b> Common.h:90</div></div>
|
|
<div class="ttc" id="structfair_1_1mq_1_1shmem_1_1RegionInfo_html"><div class="ttname"><a href="structfair_1_1mq_1_1shmem_1_1RegionInfo.html">fair::mq::shmem::RegionInfo</a></div><div class="ttdef"><b>Definition:</b> Common.h:39</div></div>
|
|
<div class="ttc" id="structfair_1_1mq_1_1shmem_1_1DeviceCounter_html"><div class="ttname"><a href="structfair_1_1mq_1_1shmem_1_1DeviceCounter.html">fair::mq::shmem::DeviceCounter</a></div><div class="ttdef"><b>Definition:</b> Common.h:64</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 class="ttc" id="structfair_1_1mq_1_1shmem_1_1MetaHeader_html"><div class="ttname"><a href="structfair_1_1mq_1_1shmem_1_1MetaHeader.html">fair::mq::shmem::MetaHeader</a></div><div class="ttdef"><b>Definition:</b> Common.h:82</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>
|