mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
169 lines
16 KiB
HTML
169 lines
16 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.18"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>FairMQ: fairmq/plugins/PMIx/PMIxPlugin.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.33</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.18 -->
|
|
<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>
|
|
<!-- 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_c2fe5dddc7ffa165dbdae926a051158e.html">plugins</a></li><li class="navelem"><a class="el" href="dir_066f3fccd7659c68e6e82b743d15481d.html">PMIx</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">PMIxPlugin.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) 2019 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>  </div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#ifndef FAIR_MQ_PLUGINS_PMIX</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define FAIR_MQ_PLUGINS_PMIX</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "PMIx.hpp"</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "PMIxCommands.h"</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 <fairmq/Plugin.h></span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <fairmq/Version.h></span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <FairMQLogger.h></span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <sstream></span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <stdexcept></span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <string></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> <span class="preprocessor">#include <unistd.h></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <vector></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="keyword">namespace </span>fair::mq::plugins</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>  </div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">class </span>PMIxPlugin : <span class="keyword">public</span> Plugin</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">public</span>:</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  PMIxPlugin(<span class="keyword">const</span> std::string& name,</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">const</span> Plugin::Version version,</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">const</span> std::string& maintainer,</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1plugins_1_1PMIxPlugin.html"> 36</a></span>  <span class="keyword">const</span> std::string& homepage,</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="classfair_1_1mq_1_1PluginServices.html">PluginServices</a>* pluginServices);</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  ~<a class="code" href="classfair_1_1mq_1_1plugins_1_1PMIxPlugin.html">PMIxPlugin</a>();</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">auto</span> PMIxClient() const -> std::<span class="keywordtype">string</span> { <span class="keywordflow">return</span> fPMIxClient; };</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="structpmix_1_1proc.html">pmix::proc</a> fProcess;</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  pid_t fPid;</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  std::string fPMIxClient;</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  std::string fDeviceId;</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="classpmix_1_1Commands.html">pmix::Commands</a> fCommands;</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  std::set<uint32_t> fStateChangeSubscribers;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  uint32_t fLastExternalController;</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">bool</span> fExitingAckedByLastExternalController;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  std::condition_variable fExitingAcked;</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  std::mutex fStateChangeSubscriberMutex;</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>  DeviceState fCurrentState;</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  DeviceState fLastState;</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">auto</span> Init() -> <a class="code" href="structpmix_1_1proc.html">pmix::proc</a>;</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">auto</span> Publish() -> void;</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">auto</span> Fence() -> void;</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">auto</span> Fence(<span class="keyword">const</span> std::string& label) -> void;</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">auto</span> Lookup() -> void;</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">auto</span> SubscribeForCommands() -> void;</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">auto</span> WaitForExitingAck() -> void;</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</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> Plugin::ProgOptions PMIxProgramOptions()</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>  boost::program_options::options_description options(<span class="stringliteral">"PMIx Plugin"</span>);</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  options.add_options()</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  (<span class="stringliteral">"pmix-dummy"</span>, boost::program_options::value<int>()->default_value(0), <span class="stringliteral">"Dummy."</span>);</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">return</span> options;</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>  </div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> REGISTER_FAIRMQ_PLUGIN(</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  PMIxPlugin, <span class="comment">// Class name</span></div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  pmix, <span class="comment">// Plugin name (string, lower case chars only)</span></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  (Plugin::Version{FAIRMQ_VERSION_MAJOR,</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  FAIRMQ_VERSION_MINOR,</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  FAIRMQ_VERSION_PATCH}), <span class="comment">// Version</span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="stringliteral">"FairRootGroup <fairroot@gsi.de>"</span>, <span class="comment">// Maintainer</span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="stringliteral">"https://github.com/FairRootGroup/FairMQ"</span>, <span class="comment">// Homepage</span></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  PMIxProgramOptions <span class="comment">// custom program options for the plugin</span></div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> )</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="comment">// namespace fair::mq::plugins</span></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="preprocessor">#endif </span><span class="comment">/* FAIR_MQ_PLUGINS_PMIX */</span><span class="preprocessor"></span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1PluginServices_html"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html">fair::mq::PluginServices</a></div><div class="ttdoc">Facilitates communication between devices and plugins.</div><div class="ttdef"><b>Definition:</b> PluginServices.h:46</div></div>
|
|
<div class="ttc" id="astructpmix_1_1proc_html"><div class="ttname"><a href="structpmix_1_1proc.html">pmix::proc</a></div><div class="ttdef"><b>Definition:</b> PMIx.hpp:68</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1plugins_1_1PMIxPlugin_html"><div class="ttname"><a href="classfair_1_1mq_1_1plugins_1_1PMIxPlugin.html">fair::mq::plugins::PMIxPlugin</a></div><div class="ttdef"><b>Definition:</b> PMIxPlugin.h:37</div></div>
|
|
<div class="ttc" id="aclasspmix_1_1Commands_html"><div class="ttname"><a href="classpmix_1_1Commands.html">pmix::Commands</a></div><div class="ttdef"><b>Definition:</b> PMIxCommands.h:89</div></div>
|
|
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
|