on-restart-benchmarks/gecode/driver/script.hpp

/* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
/*
 *  Main authors:
 *     Christian Schulte <schulte@gecode.org>
 *
 *  Copyright:
 *     Christian Schulte, 2004
 *
 *  This file is part of Gecode, the generic constraint
 *  development environment:
 *     http://www.gecode.org
 *
 *
 *  Permission is hereby granted, free of charge, to any person obtaining
 *  a copy of this software and associated documentation files (the
 *  "Software"), to deal in the Software without restriction, including
 *  without limitation the rights to use, copy, modify, merge, publish,
 *  distribute, sublicense, and/or sell copies of the Software, and to
 *  permit persons to whom the Software is furnished to do so, subject to
 *  the following conditions:
 *
 *  The above copyright notice and this permission notice shall be
 *  included in all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */

#include <iostream>
#include <iomanip>
#include <fstream>
#include <cstring>

#ifndef GECODE_THREADS_WINDOWS
#include <csignal>
#endif

namespace Gecode { namespace Driver {

  /**
   * \brief Stop object based on nodes, failures, and time
   *
   */
  class CombinedStop : public Search::Stop {
  private:
    Search::NodeStop* ns; ///< Used node stop object
    Search::FailStop* fs; ///< Used fail stop object
    Search::TimeStop* ts; ///< Used time stop object
    Search::RestartStop* rs; ///< Used restart stop object
    GECODE_DRIVER_EXPORT
    static bool sigint;   ///< Whether search was interrupted using Ctrl-C
    /// Initialize stop object
    CombinedStop(unsigned long long int node,
                 unsigned long long int fail,
                 double time,
                 unsigned long long int restart)
      : ns((node > 0ULL) ? new Search::NodeStop(node) : nullptr),
        fs((fail > 0ULL) ? new Search::FailStop(fail) : nullptr),
        ts((time > 0.0)  ? new Search::TimeStop(time) : nullptr),
        rs((restart > 0.0) ? new Search::RestartStop(restart) : nullptr) {
      sigint = false;
    }
  public:
    /// Reason why search has been stopped
    enum {
      SR_NODE = 1 << 0, ///< Node limit reached
      SR_FAIL = 1 << 1, ///< Fail limit reached
      SR_TIME = 1 << 2, ///< Time limit reached
      SR_RESTART = 1 << 3, ///< Time limit reached
      SR_INT  = 1 << 4  ///< Interrupted by user
    };
    /// Test whether search must be stopped
    virtual bool stop(const Search::Statistics& s, const Search::Options& o) {
      return
        sigint ||
        ((ns != nullptr) && ns->stop(s,o)) ||
        ((fs != nullptr) && fs->stop(s,o)) ||
        ((ts != nullptr) && ts->stop(s,o)) ||
        ((rs != nullptr) && rs->stop(s,o));
    }
    /// Report reason why search has been stopped
    int reason(const Search::Statistics& s, const Search::Options& o) {
      return
        (((ns != nullptr) && ns->stop(s,o)) ? SR_NODE : 0) |
        (((fs != nullptr) && fs->stop(s,o)) ? SR_FAIL : 0) |
        (((ts != nullptr) && ts->stop(s,o)) ? SR_TIME : 0) |
        (((rs != nullptr) && rs->stop(s,o)) ? SR_RESTART : 0) |
        (sigint                          ? SR_INT  : 0);
    }
    /// Create appropriate stop-object
    static Search::Stop*
    create(unsigned long long int node,
           unsigned long long int fail,
           double time,
					 unsigned long long int restart,
           bool intr) {
      if (!intr && (node == 0ULL) && (fail == 0ULL) && (time == 0.0) && (restart == 0ULL))
        return nullptr;
      else
        return new CombinedStop(node,fail,time,restart);
    }
#ifdef GECODE_THREADS_WINDOWS
    /// Handler for catching Ctrl-C
    static BOOL interrupt(DWORD t) noexcept {
      if (t == CTRL_C_EVENT) {
        sigint = true;
        installCtrlHandler(false,true);
        return true;
      }
      return false;
    }
#else
    /// Handler for catching Ctrl-C
    static void
    interrupt(int) {
      sigint = true;
      installCtrlHandler(false,true);
    }
#endif
    /// Install handler for catching Ctrl-C
    static void installCtrlHandler(bool install, bool force=false) {
      if (force || !sigint) {
#ifdef GECODE_THREADS_WINDOWS
        SetConsoleCtrlHandler( (PHANDLER_ROUTINE) interrupt, install);
#else
        std::signal(SIGINT, install ? interrupt : SIG_DFL);
#endif
      }
    }
    /// Destructor
    ~CombinedStop(void) {
      delete ns; delete fs; delete ts; delete rs;
    }
  };

  /**
   * \brief Get time since start of timer and print user friendly time
   * information.
   */
  GECODE_DRIVER_EXPORT void
  stop(Support::Timer& t, std::ostream& os);

  /**
   * \brief Compute arithmetic mean of \a n elements in \a t
   */
  GECODE_DRIVER_EXPORT double
  am(double t[], unsigned int n);

  /**
   * \brief Compute deviation of \a n elements in \a t
   */
  GECODE_DRIVER_EXPORT double
  dev(double t[], unsigned int n);

  /// Create cutoff object from options
  template<class Options>
  inline Search::Cutoff*
  createCutoff(const Options& o) {
    switch (o.restart()) {
    case RM_NONE:
      return nullptr;
    case RM_CONSTANT:
      return Search::Cutoff::constant(o.restart_scale());
    case RM_LINEAR:
      return Search::Cutoff::linear(o.restart_scale());
    case RM_LUBY:
      return Search::Cutoff::luby(o.restart_scale());
    case RM_GEOMETRIC:
      return Search::Cutoff::geometric(o.restart_scale(),o.restart_base());
    default: GECODE_NEVER;
    }
    return nullptr;
  }


#ifdef GECODE_HAS_GIST

  /**
   * \brief Traits class for search engines
   */
  template<class Engine>
  class GistEngine {
  public:
    static void explore(Space* root, const Gist::Options& opt) {
      (void) Gist::dfs(root, opt);
    }
  };

  /// Specialization for DFS
  template<typename S>
  class GistEngine<DFS<S> > {
  public:
    static void explore(S* root, const Gist::Options& opt) {
      (void) Gist::dfs(root, opt);
    }
  };

  /// Specialization for LDS
  template<typename S>
  class GistEngine<LDS<S> > {
  public:
    static void explore(S* root, const Gist::Options& opt) {
      (void) Gist::dfs(root, opt);
    }
  };

  /// Specialization for BAB
  template<typename S>
  class GistEngine<BAB<S> > {
  public:
    static void explore(S* root, const Gist::Options& opt) {
      (void) Gist::bab(root, opt);
    }
  };

#endif

#ifdef GECODE_HAS_CPPROFILER

  /// Class to send solution information to CPProfiler for a script
  template<class BaseSpace>
  class ScriptGetInfo : public CPProfilerSearchTracer::GetInfo {
  public:
    /// Initialize
    ScriptGetInfo(void);
    /// Return info for a space (which must be a script)
    virtual std::string getInfo(const Space& home) const;
  };

#endif

  template<class BaseSpace>
  forceinline
  ScriptBase<BaseSpace>::ScriptBase(const Options& opt)
    : BaseSpace(opt) {}

  template<class BaseSpace>
  forceinline
  ScriptBase<BaseSpace>::ScriptBase(ScriptBase& e)
    : BaseSpace(e) {}

  template<class BaseSpace>
  void
  ScriptBase<BaseSpace>::print(std::ostream&) const {}

  template<class BaseSpace>
  void
  ScriptBase<BaseSpace>::compare(const Space&, std::ostream&) const {}

  template<class BaseSpace>
  std::ostream&
  ScriptBase<BaseSpace>::select_ostream(const char* sn, std::ofstream& ofs) {
    if (strcmp(sn, "stdout") == 0) {
      return std::cout;
    } else if (strcmp(sn, "stdlog") == 0) {
      return std::clog;
    } else if (strcmp(sn, "stderr") == 0) {
      return std::cerr;
    } else {
      ofs.open(sn);
      return ofs;
    }
  }

#ifdef GECODE_HAS_CPPROFILER

  template<class BaseSpace>
  ScriptGetInfo<BaseSpace>::ScriptGetInfo(void) {}

  template<class BaseSpace>
  std::string
  ScriptGetInfo<BaseSpace>::getInfo(const Space& home) const {
    std::stringstream ss;
    if (const ScriptBase<BaseSpace>* sb
        = dynamic_cast<const ScriptBase<BaseSpace>*>(&home))
      sb->print(ss);
    return ss.str();
  }

#endif


  /**
   * \brief Wrapper class to add engine template argument
   */
  template<class T, template<class> class E>
  class EngineToMeta : public E<T> {
  public:
    EngineToMeta(T* s, const Search::Options& o) : E<T>(s,o) {}
  };

  template<class BaseSpace>
  template<class Script, template<class> class Engine, class Options>
  void
  ScriptBase<BaseSpace>::run(const Options& o, Script* s) {
    if ((o.restart() != RM_NONE) && (o.assets() > 0)) {
      std::cerr << "Cannot use restarts and portfolio..." << std::endl;
      exit(EXIT_FAILURE);
    }
    if (o.restart() != RM_NONE) {
      runMeta<Script,Engine,Options,RBS>(o,s);
    } else if (o.assets() > 0) {
      runMeta<Script,Engine,Options,PBS>(o,s);
    } else {
      runMeta<Script,Engine,Options,EngineToMeta>(o,s);
    }
  }

  template<class BaseSpace>
  template<class Script, template<class> class Engine, class Options,
           template<class, template<class> class> class Meta>
  void
  ScriptBase<BaseSpace>::runMeta(const Options& o, Script* s) {
    using namespace std;

    ofstream sol_file, log_file;

    ostream& s_out = select_ostream(o.out_file(), sol_file);
    ostream& l_out = select_ostream(o.log_file(), log_file);

    Search::Options so;

    try {
      switch (o.mode()) {
      case SM_GIST:
#ifdef GECODE_HAS_GIST
        {
          Gist::Print<Script> pi(o.name());
          Gist::VarComparator<Script> vc(o.name());
          Gist::Options opt;
          opt.inspect.click(&pi);
          opt.inspect.compare(&vc);
          opt.clone = false;
          opt.c_d   = o.c_d();
          opt.a_d   = o.a_d();
          for (unsigned int i=0; o.inspect.click(i) != nullptr; i++)
            opt.inspect.click(o.inspect.click(i));
          for (unsigned int i=0; o.inspect.solution(i) != nullptr; i++)
            opt.inspect.solution(o.inspect.solution(i));
          for (unsigned int i=0; o.inspect.move(i) != nullptr; i++)
            opt.inspect.move(o.inspect.move(i));
          for (unsigned int i=0; o.inspect.compare(i) != nullptr; i++)
            opt.inspect.compare(o.inspect.compare(i));
          if (s == nullptr)
            s = new Script(o);
          (void) GistEngine<Engine<Script> >::explore(s, opt);
        }
        break;
        // If Gist is not available, goto solution
#else
        goto solution;
#endif
      case SM_SOLUTION:
#ifndef GECODE_HAS_GIST
      solution:
#endif
        {
#ifdef GECODE_HAS_CPPROFILER
          if (o.profiler_port()) {
            CPProfilerSearchTracer::GetInfo* getInfo = nullptr;
            getInfo = new ScriptGetInfo<BaseSpace>;
            so.tracer = new CPProfilerSearchTracer
              (o.profiler_id(), o.name(), o.profiler_port(), getInfo);
          }
#endif
          l_out << o.name() << endl;
          Support::Timer t;
          unsigned long long int s_l =
            (o.solutions() == 0) ? ULLONG_MAX : o.solutions();
          unsigned long long int s_n = 0;
          t.start();
          if (s == nullptr)
            s = new Script(o);
          unsigned int n_p = PropagatorGroup::all.size(*s);
          unsigned int n_b = BrancherGroup::all.size(*s);
          so.threads = o.threads();
          so.c_d     = o.c_d();
          so.a_d     = o.a_d();
          so.d_l     = o.d_l();
          so.assets  = o.assets();
          so.slice   = o.slice();
          so.stop    = CombinedStop::create(o.node(),o.fail(), o.time(), o.restart_limit(),
                                            o.interrupt());
          so.cutoff  = createCutoff(o);
          so.clone   = false;
          so.nogoods_limit = o.nogoods() ? o.nogoods_limit() : 0U;
          if (o.interrupt())
            CombinedStop::installCtrlHandler(true);
          {
            Meta<Script,Engine> e(s,so);
            if (o.print_last()) {
              Script* px = nullptr;
              do {
                Script* ex = e.next();
                if (ex == nullptr) {
                  if (px != nullptr) {
                    px->print(s_out);
                    delete px;
                  }
                  break;
                } else {
                  s_n++;
                  delete px;
                  px = ex;
                }
              } while (s_n < s_l);
            } else {
              do {
                Script* ex = e.next();
                if (ex == nullptr)
                  break;
                ex->print(s_out);
                delete ex;
                s_n++;
              } while (s_n < s_l);
            }
            if (o.interrupt())
              CombinedStop::installCtrlHandler(false);
            Search::Statistics stat = e.statistics();
            s_out << endl;
            if (e.stopped()) {
              l_out << "Search engine stopped..." << endl
                    << "\treason: ";
              int r = static_cast<CombinedStop*>(so.stop)->reason(stat,so);
              if (r & CombinedStop::SR_INT)
                l_out << "user interrupt " << endl;
              else {
                if (r & CombinedStop::SR_NODE)
                  l_out << "node ";
                if (r & CombinedStop::SR_FAIL)
                  l_out << "fail ";
                if (r & CombinedStop::SR_TIME)
                  l_out << "time ";
                if (r & CombinedStop::SR_RESTART)
                  l_out << "restart ";
                l_out << "limit reached" << endl << endl;
              }
            }
            l_out << "Initial" << endl
                  << "\tpropagators: " << n_p << endl
                  << "\tbranchers:   " << n_b << endl
                  << endl
                  << "Summary" << endl
                  << "\truntime:      ";
            stop(t, l_out);
            l_out << endl
                  << "\tsolutions:    " << s_n << endl
                  << "\tpropagations: " << stat.propagate << endl
                  << "\tnodes:        " << stat.node << endl
                  << "\tfailures:     " << stat.fail << endl
                  << "\trestarts:     " << stat.restart << endl
                  << "\tno-goods:     " << stat.nogood << endl
                  << "\tpeak depth:   " << stat.depth << endl
#ifdef GECODE_PEAKHEAP
                  << "\tpeak memory:  "
                  << static_cast<int>((heap.peak()+1023) / 1024) << " KB"
                  << endl
#endif
                  << endl;
          }
          delete so.stop;
          delete so.tracer;
        }
        break;
      case SM_STAT:
        {
          l_out << o.name() << endl;
          Support::Timer t;
          unsigned long long int s_l =
            (o.solutions() == 0) ? ULLONG_MAX : o.solutions();
          unsigned long long int s_n = 0;
          t.start();
          if (s == nullptr)
            s = new Script(o);
          unsigned int n_p = PropagatorGroup::all.size(*s);
          unsigned int n_b = BrancherGroup::all.size(*s);

          so.clone   = false;
          so.threads = o.threads();
          so.assets  = o.assets();
          so.slice   = o.slice();
          so.c_d     = o.c_d();
          so.a_d     = o.a_d();
          so.d_l     = o.d_l();
          so.stop    = CombinedStop::create(o.node(),o.fail(), o.time(), o.restart_limit(),
                                            o.interrupt());
          so.cutoff  = createCutoff(o);
          so.nogoods_limit = o.nogoods() ? o.nogoods_limit() : 0U;
          if (o.interrupt())
            CombinedStop::installCtrlHandler(true);
          {
            Meta<Script,Engine> e(s,so);
            do {
              Script* ex = e.next();
              if (ex == nullptr)
                break;
              delete ex;
              s_n++;
            } while (s_n < s_l);
            if (o.interrupt())
              CombinedStop::installCtrlHandler(false);
            Search::Statistics stat = e.statistics();
            l_out << endl
                  << "\tpropagators:  " << n_p << endl
                  << "\tbranchers:    " << n_b << endl
                  << "\truntime:      ";
            stop(t, l_out);
            l_out << endl
                  << "\tsolutions:    " << s_n << endl
                  << "\tpropagations: " << stat.propagate << endl
                  << "\tnodes:        " << stat.node << endl
                  << "\tfailures:     " << stat.fail << endl
                  << "\trestarts:     " << stat.restart << endl
                  << "\tno-goods:     " << stat.nogood << endl
                  << "\tpeak depth:   " << stat.depth << endl
#ifdef GECODE_PEAKHEAP
                  << "\tpeak memory:  "
                  << static_cast<int>((heap.peak()+1023) / 1024) << " KB"
                  << endl
#endif
                  << endl;
          }
          delete so.stop;
        }
        break;
      case SM_TIME:
        {
          l_out << o.name() << endl;
          Support::Timer t;
          double* ts = new double[o.samples()];
          bool stopped = false;
          for (unsigned int ns = o.samples(); !stopped && ns--; ) {
            unsigned long long int s_l =
              (o.solutions() == 0) ? ULLONG_MAX : o.solutions();
            t.start();
            for (unsigned int k = o.iterations(); !stopped && k--; ) {
              unsigned long long int s_n = 0;
              Script* s1 = new Script(o);
              Search::Options sok;
              sok.clone   = false;
              sok.threads = o.threads();
              sok.assets  = o.assets();
              sok.slice   = o.slice();
              sok.c_d     = o.c_d();
              sok.a_d     = o.a_d();
              sok.d_l     = o.d_l();
              sok.stop    = CombinedStop::create(o.node(),o.fail(), o.time(), o.restart_limit(),
                                                 false);
              sok.cutoff  = createCutoff(o);
              sok.nogoods_limit = o.nogoods() ? o.nogoods_limit() : 0U;
              {
                Meta<Script,Engine> e(s1,sok);
                do {
                  Script* ex = e.next();
                  if (ex == nullptr)
                    break;
                  delete ex;
                  s_n++;
                } while (s_n < s_l);
                if (e.stopped())
                  stopped = true;
              }
              delete sok.stop;
            }
            ts[ns] = t.stop() / o.iterations();
          }
          if (stopped) {
            l_out << "\tSTOPPED" << endl;
          } else {
            double m = am(ts,o.samples());
            double d = dev(ts,o.samples()) * 100.0;
            l_out << "\truntime: "
                 << setw(20) << right
                 << showpoint << fixed
                 << setprecision(6) << m << "ms"
                 << setprecision(2) << " (" << d << "% deviation)"
                 << endl;
          }
          delete [] ts;
        }
        break;
      }
    } catch (Exception& e) {
      cerr << "Exception: " << e.what() << "." << endl
           << "Stopping..." << endl;
      if (sol_file.is_open())
        sol_file.close();
      if (log_file.is_open())
        log_file.close();
      exit(EXIT_FAILURE);
    }
    if (sol_file.is_open())
      sol_file.close();
    if (log_file.is_open())
      log_file.close();
  }

}}

// STATISTICS: driver-any