job_launcher.h

Go to the documentation of this file.

#ifndef JOB_LAUNCHER_H
#define JOB_LAUNCHER_H

#include <sprockit/factories/factory.h>
#include <sprockit/unordered.h>
#include <sstmac/common/event_handler.h>
#include <sstmac/hardware/interconnect/interconnect_fwd.h>
#include <sstmac/software/launch/node_set.h>
#include <sstmac/software/process/task_id.h>
#include <sstmac/software/process/app_id.h>
#include <sstmac/software/launch/app_launch_fwd.h>

namespace sstmac {
namespace sw {

/**
 * @brief The job_launcher class performs the combined operations a queue scheduler like PBS or MOAB
 * and a job launcher like SLURM (srun) or ALPS (aprun).
 * The job launcher allocates nodes to each requested MPI job (or other application).
 * Once nodes are allocated, the job_launcher has to assign MPI ranks to each node (mapping or indexing).
 * Each application can request its a specific allocation or indexing.
 * However, it is ultimately the responsibility of the job launcher to decide on the final
 * allocation/indexing. In most cases, the job_launcher will honor exactly each applications's request
 * unless there is a conflict - in which case the job_launcher must arbitrate conflicting requests.
 */
class job_launcher :
  public sprockit::factory_type,
  public event_handler
{
 public:
  void handle(event *ev);

  void
  set_interconnect(hw::interconnect* ic);

  node_id
  node_for_task(app_id aid, task_id tid) const;

  app_launch*
  task_mapper(app_id aid) const;

  virtual void
  init_factory_params(sprockit::sim_parameters *params);

  /**
   * @brief handle_new_launch_request As if a new job had been submitted with qsub or salloc.
   * The job_launcher receives a new request to launch an application, at which point
   * it can choose to launch the application immediately if node allocation succeeds.
   * @param appnum  A unique integer identifying the application launched
   * @param appman  An object specifying all the details (indexing, allocation, application type)
   *                of the application being launched
   */
  virtual void
  handle_new_launch_request(app_launch* appman) = 0;

 protected:
  void
  satisfy_launch_request(app_launch* appman);

 protected:
  hw::interconnect* interconnect_;
  ordered_node_set allocated_;
  ordered_node_set available_;

  std::map<app_id, app_launch*> apps_launched_;

};

DeclareFactory(job_launcher);

class default_job_launcher :
  public job_launcher
{
 public:
  std::string
  to_string() const {
    return "default job launcher";
  }

 protected:
  void handle_new_launch_request(app_launch* appman);

};

}
}



#endif // JOB_LAUNCHER_H