parallel_tool.h

Go to the documentation of this file.

// Author(s): Jan Friso Groote
// Copyright: see the accompanying file COPYING or copy at
// https://github.com/mCRL2org/mCRL2/blob/master/COPYING
//
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
//
 
#ifndef MCRL2_UTILITIES_PARALLEL_TOOL_H
#define MCRL2_UTILITIES_PARALLEL_TOOL_H
 
#include "mcrl2/utilities/configuration.h"
#include "mcrl2/utilities/command_line_interface.h"
 
namespace mcrl2
{
 
namespace utilities
{
 
namespace tools
{
 
template <typename Tool>
class parallel_tool: public Tool
{
  protected:
    std::size_t m_number_of_threads=1;
 
    void add_options(utilities::interface_description& desc)
    {
      Tool::add_options(desc);
      if constexpr (mcrl2::utilities::detail::GlobalThreadSafe)
      {
        desc.add_option("threads", utilities::make_mandatory_argument("NUM"), "run with NUM threads (default=1). With multiple threads the stack size on a Mac is limited which can lead to bus errors. ");
      }
      else
      {
        desc.add_option("threads", utilities::make_mandatory_argument("NUM"), "run with NUM threads (default=1). This option is not available as this tool is compiled as a sequential tool.");
      }
    }
 
 
    void parse_options(const utilities::command_line_parser& parser)
    {
      Tool::parse_options(parser);
 
      if (parser.has_option("threads"))
      {
        m_number_of_threads = parser.option_argument_as<std::size_t>("threads");
        if (m_number_of_threads<1)
        {
          throw mcrl2::runtime_error("The number of threads should at least be 1.");
        }
        if (!mcrl2::utilities::detail::GlobalThreadSafe && number_of_threads()!=1)
        {
          throw mcrl2::runtime_error("This tool is compiled for sequential use. The number of threads (now: " + 
                                     std::to_string(number_of_threads()) +
                                     ") can only be 1.");
        }
      }
    }
 
  public:
 
    parallel_tool(const std::string& name,
                  const std::string& author,
                  const std::string& what_is,
                  const std::string& tool_description,
                  std::string known_issues = ""
                 )
      : Tool(name, author, what_is, tool_description, known_issues)
    {}
 
    std::size_t number_of_threads() const
    {
      return m_number_of_threads;
    }
};
 
} // namespace tools
 
} // namespace utilities
 
} // namespace mcrl2
 
#endif // MCRL2_UTILITIES_PARALLEL_TOOL_H