control.hh

Go to the documentation of this file.

/*
    @@@@@@@@  @@           @@@@@@   @@@@@@@@ @@
   /@@/////  /@@          @@////@@ @@////// /@@
   /@@       /@@  @@@@@  @@    // /@@       /@@
   /@@@@@@@  /@@ @@///@@/@@       /@@@@@@@@@/@@
   /@@////   /@@/@@@@@@@/@@       ////////@@/@@
   /@@       /@@/@@//// //@@    @@       /@@/@@
   /@@       @@@//@@@@@@ //@@@@@@  @@@@@@@@ /@@
   //       ///  //////   //////  ////////  //

   Copyright (c) 2016, Triad National Security, LLC
   All rights reserved.
                                                                              */
#pragma once

#include <flecsi-config.h>

#include "flecsi/ctrl/point_walker.hh"
#include "flecsi/execution.hh"
#include "flecsi/flog.hh"
#include "flecsi/util/constant.hh"
#include "flecsi/util/dag.hh"
#include "flecsi/util/demangle.hh"

#include <functional>
#include <map>
#include <vector>

namespace flecsi {

inline log::devel_tag control_tag("control");

#if defined(FLECSI_ENABLE_GRAPHVIZ)
inline program_option<bool> control_model_option("FleCSI Options",
  "control-model",
  "Output a dot file of the control model. This can be processed into a pdf "
  "using the dot command, like:\n\033[0;36m$ dot -Tpdf input.dot > "
  "output.pdf\033[0m",
  {{flecsi::option_implicit, true}, {flecsi::option_zero}});

inline program_option<bool> control_model_sorted_option("FleCSI Options",
  "control-model-sorted",
  "Output a dot file of the sorted control model actions.",
  {{flecsi::option_implicit, true}, {flecsi::option_zero}});
#endif

template<auto CP>
using control_point = util::constant<CP>;

template<bool (*Predicate)(), typename... ControlPoints>
using cycle = ctrl_impl::cycle<Predicate, ControlPoints...>;

template<typename ControlPolicy>
struct control : ControlPolicy {

  using target_type = int (*)();

private:
  friend ControlPolicy;

  using control_points = typename ControlPolicy::control_points;
  using control_points_enum = typename ControlPolicy::control_points_enum;
  using node_policy = typename ControlPolicy::node_policy;

  using point_walker = ctrl_impl::point_walker<control<ControlPolicy>>;
  friend point_walker;

  using init_walker = ctrl_impl::init_walker<control<ControlPolicy>>;
  friend init_walker;

#if defined(FLECSI_ENABLE_GRAPHVIZ)
  using point_writer = ctrl_impl::point_writer<control<ControlPolicy>>;
  friend point_writer;
#endif

  /*
    Control node type. This just adds an executable target.
   */

  struct control_node : node_policy {

    template<typename... Args>
    control_node(target_type target, Args &&... args)
      : node_policy(std::forward<Args>(args)...), target_(target) {}

    int execute() const {
      return target_();
    }

  private:
    target_type target_;
  }; // struct control_node

  /*
    Use the ndoe type that is defined by the specialized DAG.
   */

  using node_type = typename util::dag<control_node>::node_type;

  /*
    Initialize the control point dags. This is necessary in order to
    assign labels in the case that no actions are registered at one
    or more control points.
   */

  control() {
    init_walker(registry_).template walk_types<control_points>();
  }

  /*
    The singleton instance is private, and should only be accessed by internal
    types.
   */

  static control & instance() {
    static control c;
    return c;
  }

  /*
    Return the dag at the given control point.
   */

  util::dag<control_node> & control_point_dag(control_points_enum cp) {
    registry_.try_emplace(cp, *cp);
    return registry_[cp];
  }

  /*
    Return a map of the sorted dags under each control point.
   */

  std::map<control_points_enum, std::vector<node_type const *>> sort() {
    std::map<control_points_enum, std::vector<node_type const *>> sorted;
    for(auto & d : registry_) {
      sorted.try_emplace(d.first, d.second.sort());
    }
    return sorted;
  }

  /*
    Run the control model.
   */

  int run() {
    int status{flecsi::run::status::success};
    point_walker(sort(), status).template walk_types<control_points>();
    return status;
  } // run

  /*
    Output a graph of the control model.
   */

#if defined(FLECSI_ENABLE_GRAPHVIZ)
  int write() {
    flecsi::util::graphviz gv;
    point_writer(registry_, gv).template walk_types<control_points>();
    std::string file = program() + "-control-model.dot";
    gv.write(file);
    return flecsi::run::status::control;
  } // write

  int write_sorted() {
    flecsi::util::graphviz gv;
    point_writer::write_sorted(sort(), gv);
    std::string file = program() + "-control-model-sorted.dot";
    gv.write(file);
    return flecsi::run::status::control;
  } // write_sorted
#endif

  std::map<control_points_enum, util::dag<control_node>> registry_;

public:
  template<target_type Target, control_points_enum ControlPoint>
  struct action {

    template<target_type U, control_points_enum V>
    friend struct action;

    template<typename... Args>
    action(Args &&... args)
      : node_(util::symbol<*Target>(), Target, std::forward<Args>(args)...) {
      instance().control_point_dag(ControlPoint).push_back(&node_);
    }

    /*
      Dummy type used to force namespace scope execution.
     */

    struct dependency {};

    template<target_type U, control_points_enum V>
    dependency add(action<U, V> const & from) {
      static_assert(ControlPoint == V,
        "you cannot add dependencies between actions under different control "
        "points");
      node_.push_back(&from.node_);
      return {};
    }

    template<target_type F>
    void push_back(action<F, ControlPoint> const & from) {
      node_.push_back(&from.node_);
    }

  private:
    node_type node_;
  }; // struct action

  static int execute() {
    return instance().run();
  } // execute

  static int check_options() {
    int retval{flecsi::run::status::success};
#if defined(FLECSI_ENABLE_GRAPHVIZ)
    if(control_model_option.has_value()) {
      retval |= instance().write();
    } // if
    if(control_model_sorted_option.has_value()) {
      retval |= instance().write_sorted();
    } // if
#endif
    return retval;
  } // write

}; // struct control

} // namespace flecsi