FairMQ  1.4.33
C++ Message Queuing Library and Framework
PMIxPlugin.h
1 /********************************************************************************
2  * Copyright (C) 2019 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH *
3  * *
4  * This software is distributed under the terms of the *
5  * GNU Lesser General Public Licence (LGPL) version 3, *
6  * copied verbatim in the file "LICENSE" *
7  ********************************************************************************/
8 
9 #ifndef FAIR_MQ_PLUGINS_PMIX
10 #define FAIR_MQ_PLUGINS_PMIX
11 
12 #include "PMIx.hpp"
13 #include "PMIxCommands.h"
14 
15 #include <fairmq/Plugin.h>
16 #include <fairmq/Version.h>
17 #include <FairMQLogger.h>
18 
19 #include <string>
20 #include <sstream>
21 #include <stdexcept>
22 #include <string>
23 #include <sys/types.h>
24 #include <unistd.h>
25 #include <vector>
26 
27 namespace fair::mq::plugins
28 {
29 
30 class PMIxPlugin : public Plugin
31 {
32  public:
33  PMIxPlugin(const std::string& name,
34  const Plugin::Version version,
35  const std::string& maintainer,
36  const std::string& homepage,
37  PluginServices* pluginServices);
38  ~PMIxPlugin();
39 
40  auto PMIxClient() const -> std::string { return fPMIxClient; };
41 
42  private:
43  pmix::proc fProcess;
44  pid_t fPid;
45  std::string fPMIxClient;
46  std::string fDeviceId;
47  pmix::Commands fCommands;
48 
49  std::set<uint32_t> fStateChangeSubscribers;
50  uint32_t fLastExternalController;
51  bool fExitingAckedByLastExternalController;
52  std::condition_variable fExitingAcked;
53  std::mutex fStateChangeSubscriberMutex;
54 
55  DeviceState fCurrentState;
56  DeviceState fLastState;
57 
58  auto Init() -> pmix::proc;
59  auto Publish() -> void;
60  auto Fence() -> void;
61  auto Fence(const std::string& label) -> void;
62  auto Lookup() -> void;
63 
64  auto SubscribeForCommands() -> void;
65  auto WaitForExitingAck() -> void;
66 };
67 
68 Plugin::ProgOptions PMIxProgramOptions()
69 {
70  boost::program_options::options_description options("PMIx Plugin");
71  options.add_options()
72  ("pmix-dummy", boost::program_options::value<int>()->default_value(0), "Dummy.");
73  return options;
74 }
75 
76 REGISTER_FAIRMQ_PLUGIN(
77  PMIxPlugin, // Class name
78  pmix, // Plugin name (string, lower case chars only)
79  (Plugin::Version{FAIRMQ_VERSION_MAJOR,
80  FAIRMQ_VERSION_MINOR,
81  FAIRMQ_VERSION_PATCH}), // Version
82  "FairRootGroup <fairroot@gsi.de>", // Maintainer
83  "https://github.com/FairRootGroup/FairMQ", // Homepage
84  PMIxProgramOptions // custom program options for the plugin
85 )
86 
87 } // namespace fair::mq::plugins
88 
89 #endif /* FAIR_MQ_PLUGINS_PMIX */
fair::mq::PluginServices
Facilitates communication between devices and plugins.
Definition: PluginServices.h:46
pmix::proc
Definition: PMIx.hpp:68
fair::mq::plugins::PMIxPlugin
Definition: PMIxPlugin.h:37
pmix::Commands
Definition: PMIxCommands.h:89

privacy