#869 promote ArgConfig to a component

- use Component as a base class for ArgConfig - use forward declarations to avoid circular dependency - adjust #includes
DARMA-tasking · Jul 3, 2020 · b82d4e0 · b82d4e0
1 parent 5b7217f
commit b82d4e0
Show file tree

Hide file tree

Showing 11 changed files with 56 additions and 13 deletions.
diff --git a/src/vt/configs/arguments/args.cc b/src/vt/configs/arguments/args.cc
@@ -45,6 +45,7 @@
 #include "vt/config.h"
 #include "vt/configs/arguments/argparse.h"
 #include "vt/configs/arguments/args.h"
+//#include "vt/objgroup/manager.h"
 
 #include <string>
 #include <vector>
@@ -55,6 +56,13 @@
 
 namespace vt { namespace arguments {
 
+/*static*/ std::unique_ptr<ArgConfig> ArgConfig::construct() {
+  auto ptr = std::make_unique<ArgConfig>();
+//  auto proxy = theObjGroup()->makeCollective<ArgConfig>(ptr.get());
+//  proxy.get()->setProxy(proxy);
+  return ptr;
+}
+
 void addColorArgs(CLI::App& app) {
   auto quiet  = "Quiet the output from vt (only errors, warnings)";
   auto always = "Colorize output (default)";

diff --git a/src/vt/configs/arguments/args.h b/src/vt/configs/arguments/args.h
@@ -45,16 +45,22 @@
 #if !defined INCLUDED_VT_CONFIGS_ARGUMENTS_ARGS_H
 #define INCLUDED_VT_CONFIGS_ARGUMENTS_ARGS_H
 
-// Do not pull in any VT dependencies here
+// Do not pull in any other VT dependencies here
+namespace vt { namespace arguments {
+struct ArgConfig;
+}}
+
+#include "vt/runtime/component/component.h"
 
 #include <functional>
+#include <memory>
 #include <string>
 #include <vector>
 #include <tuple>
 
 namespace vt { namespace arguments {
 
-struct ArgConfig {
+struct ArgConfig : runtime::component::Component<ArgConfig> {
 
   /// Parse the arguments into ArgConfig.
   /// Re-assigns argc/argv to remove consumed arguments.
@@ -63,6 +69,10 @@ struct ArgConfig {
   /// with an appropriate display message.
   std::tuple<int, std::string> parse(int& argc, char**& argv);
 
+  std::string name() override { return "ArgConfig"; }
+
+  static std::unique_ptr<ArgConfig> construct();
+
 public:
   inline bool user1() { return vt_user_1; }
   inline bool user2() { return vt_user_2; }
@@ -230,7 +240,7 @@ struct ArgConfig {
 
 namespace vt {
 
-arguments::ArgConfig* theArgConfig();
+extern arguments::ArgConfig* theArgConfig();
 
 } /* end namespace vt */
 

diff --git a/src/vt/configs/debug/debug_colorize.h b/src/vt/configs/debug/debug_colorize.h
@@ -52,7 +52,7 @@
 namespace vt { namespace debug {
 
 inline bool colorizeOutput() {
-  return theArgConfig()->colorize_output;
+  return vt::theArgConfig()->colorize_output;
 }
 
 inline std::string green()    { return colorizeOutput() ? "\033[32m"   : ""; }
@@ -93,5 +93,4 @@ inline std::string proc(vt::NodeType const& node)  {
 
 }} /* end namespace vt::debug */
 
-
 #endif /*INCLUDED_VT_CONFIGS_DEBUG_DEBUG_COLORIZE_H*/
diff --git a/src/vt/configs/debug/debug_print.h b/src/vt/configs/debug/debug_print.h
@@ -45,6 +45,7 @@
 #if !defined INCLUDED_VT_CONFIGS_DEBUG_DEBUG_PRINT_H
 #define INCLUDED_VT_CONFIGS_DEBUG_DEBUG_PRINT_H
 
+#include "vt/configs/arguments/args.h"
 #include "vt/configs/types/types_headers.h"
 #include "vt/configs/debug/debug_config.h"
 #include "vt/configs/debug/debug_colorize.h"

diff --git a/src/vt/configs/error/error.impl.h b/src/vt/configs/error/error.impl.h
@@ -57,6 +57,16 @@
 
 #include "fmt/format.h"
 
+namespace vt { namespace debug {
+
+std::string stringizeMessage(
+  std::string const& msg, std::string const& reason, std::string const& cond,
+  std::string const& file, int const line, std::string const& func,
+  ErrorCodeType error
+);
+
+}} /* end namespace vt::debug */
+
 namespace vt { namespace error {
 
 template <typename... Args>

diff --git a/src/vt/runtime/component/component.h b/src/vt/runtime/component/component.h
@@ -45,7 +45,6 @@
 #if !defined INCLUDED_VT_RUNTIME_COMPONENT_COMPONENT_H
 #define INCLUDED_VT_RUNTIME_COMPONENT_COMPONENT_H
 
-#include "vt/configs/error/hard_error.h"
 #include "vt/runtime/component/component_registry.h"
 #include "vt/runtime/component/component_dep.h"
 #include "vt/runtime/component/component_traits.h"
@@ -186,13 +185,20 @@ struct PollableComponent : Component<T> {
    *
    * \return number of units processed---zero
    */
-  virtual int progress() override {
-    vtAbort("PollableComponent should override the empty progress function");
-    return 0;
-  }
+  virtual int progress() override;
 
 };
 
 }}} /* end namespace vt::runtime::component */
 
+#include "vt/configs/error/hard_error.h"
+
+namespace vt { namespace runtime { namespace component {
+  template <typename T>
+  int PollableComponent<T>::progress() {
+    vtAbort("PollableComponent should override the empty progress function");
+    return 0;
+  }
+}}}
+
 #endif /*INCLUDED_VT_RUNTIME_COMPONENT_COMPONENT_H*/
diff --git a/src/vt/runtime/runtime.cc b/src/vt/runtime/runtime.cc
@@ -563,8 +563,12 @@ void Runtime::initializeComponents() {
 
   p_ = std::make_unique<ComponentPack>();
 
+  p_->registerComponent<arguments::ArgConfig>(&theArgConfig, Deps<
+    ctx::Context
+  >{});
+
   p_->registerComponent<ctx::Context>(
-    &theContext, Deps<>{},
+    &theContext, Deps<arguments::ArgConfig>{},
     user_argc_, &user_argv_[0], is_interop_, &communicator_
   );
 
@@ -757,6 +761,7 @@ void Runtime::initializeComponents() {
     >{}
   );
 
+  p_->add<arguments::ArgConfig>();
   p_->add<ctx::Context>();
   p_->add<util::memory::MemoryUsage>();
   p_->add<registry::Registry>();

diff --git a/src/vt/runtime/runtime.h b/src/vt/runtime/runtime.h
@@ -368,6 +368,7 @@ struct Runtime {
   static void termHandler();
 
 public:
+  ComponentPtrType<arguments::ArgConfig> theArgConfig;
   ComponentPtrType<registry::Registry> theRegistry;
   ComponentPtrType<messaging::ActiveMessenger> theMsg;
   ComponentPtrType<ctx::Context> theContext;
@@ -391,7 +392,6 @@ struct Runtime {
   ComponentPtrType<vrt::collection::balance::ProcStats> theProcStats;
   ComponentPtrType<vrt::collection::balance::StatsRestartReader> theStatsReader;
   ComponentPtrType<vrt::collection::balance::LBManager> theLBManager;
-  vt::arguments::ArgConfig theArgConfig;
 
   // Node-level worker-based components for vt (these are optional)
   ComponentPtrType<worker::WorkerGroupType> theWorkerGrp;

diff --git a/src/vt/runtime/runtime_component_fwd.h b/src/vt/runtime/runtime_component_fwd.h
@@ -51,6 +51,9 @@
 
 namespace vt {
 
+namespace arguments {
+struct ArgConfig;
+}
 namespace registry {
 struct Registry;
 }

diff --git a/src/vt/runtime/runtime_get.cc b/src/vt/runtime/runtime_get.cc
@@ -130,7 +130,7 @@ util::memory::MemoryUsage*  theMemUsage()           { return CUR_RT->theMemUsage
 vrt::collection::balance::ProcStats* theProcStats() { return CUR_RT->theProcStats;      }
 vrt::collection::balance::StatsRestartReader* theStatsReader() { return CUR_RT->theStatsReader;      }
 vrt::collection::balance::LBManager* theLBManager() { return CUR_RT->theLBManager;      }
-vt::arguments::ArgConfig*  theArgConfig()           { return &(CUR_RT->theArgConfig);   }
+vt::arguments::ArgConfig*   theArgConfig()          { return CUR_RT->theArgConfig;      }
 
 
 #if backend_check_enabled(trace_enabled)

diff --git a/src/vt/utils/memory/memory_usage.cc b/src/vt/utils/memory/memory_usage.cc
@@ -43,6 +43,7 @@
 */
 
 #include "vt/config.h"
+#include "vt/configs/arguments/args.h"
 #include "vt/utils/memory/memory_usage.h"
 
 #include <vector>