drmaa2.idl

Ir para a documentação deste ficheiro.

#ifndef _DRMAA2_IDL
#define _DRMAA2_IDL

module tecgraf {
module openbus {
module DRMAA {
module v2_0 {

typedef sequence <string > OrderedStringList;


typedef sequence <string > StringList;

typedef sequence < sequence <string ,2> > Dictionary;

typedef string AbsoluteTime;

typedef long long TimeAmount;

struct Version {
  string major;
  string minor;
};

enum DrmaaCapability {

  ADVANCE_RESERVATION,

  RESERVE_SLOTS,

  CALLBACK,

  BULK_JOBS_MAXPARALLEL,

  JT_EMAIL,

  JT_STAGING,

  JT_DEADLINE,

  JT_MAXSLOTS,

  JT_ACCOUNTINGID,

  RT_STARTNOW,

  RT_DURATION,

  RT_MACHINEOS,

  RT_MACHINEARCH
};


enum JobState {

  UNDETERMINED,

  QUEUED,

  QUEUED_HELD,

  RUNNING,

  SUSPENDED,

  REQUEUED,

  REQUEUED_HELD,

  DONE,

  FAILED
};

enum OperatingSystem {

  AIX,

   BSD,

   LINUX,

   HPUX,

   IRIX,

   MACOS,

   SUNOS,

   TRU64,

   UNIXWARE,

   WIN,

   WINNT,

   OTHER_OS
};

enum CpuArchitecture {

   ALPHA,

   ARM,

   ARM64,

   CELL,

   PARISC,

   PARISC64,

   X86,

   X64,

   IA64,

   MIPS,

   MIPS64,

   PPC,

   PPC64,

   PPC64LE,

   SPARC,

   SPARC64,

   OTHER_CPU
};

struct SlotInfo {
  string machineName;

  long slots;
};

typedef sequence <SlotInfo> OrderedSlotInfoList;

valuetype JobInfo {

  public string jobId;

  public string jobName;

  public long exitStatus;

  public string terminatingSignal;

  public string annotation;

  public JobState jobState;

  // public any jobSubState;

  public OrderedSlotInfoList allocatedMachines;

  public string submissionMachine;

  public string jobOwner;

  public long slots;

  public string queueName;

  public TimeAmount wallclockTime;

  public long cpuTime;

  public AbsoluteTime submissionTime;

  public AbsoluteTime dispatchTime;

  public AbsoluteTime finishTime;
};


//DRMAA Exceptions

exception DeniedByDrmsException {string message;};

exception DrmCommunicationException {string message;};

exception TryLaterException {string message;};

exception TimeoutException {string message;};

exception InternalException {string message;};
exception InvalidArgumentException {string message;};

exception InvalidSessionException {string message;};

exception InvalidStateException {string message;};

exception OutOfResourceException {string message;};

exception UnsupportedAttributeException {string message;};

exception UnsupportedOperationException {string message;};

exception ImplementationSpecificException {string message; long code;};

valuetype JobTemplate {

  const string HOME_DIRECTORY = "_drmaa_hd_ph_";

  const string WORKING_DIRECTORY = "_drmaa_wd_ph_"
  ;
  const string PARAMETRIC_INDEX = "$DRMAA2_INDEX$";

    const string PARAMETRIC_NUMBER_OF_JOBS =  "$DRMAA2_N_JOBS$";

  public string remoteCommand;

  public OrderedStringList args;
  
  public boolean submitAsHold;

  public boolean rerunnable;

  public Dictionary jobEnvironment;

  public string workingDirectory;

  public string jobCategory;

  public StringList email;

  public boolean emailOnStarted;

  public boolean emailOnTerminated;

  public string jobName;

  public string inputPath;

  public string outputPath;

  public string errorPath;

  public boolean joinFiles;

  public string reservationId;

  public string queueName;

  public long minSlots;

  public long maxSlots;

  public long priority;

  public OrderedStringList candidateMachines;

  public long minPhysMemory;

  public OperatingSystem machineOS;

  public CpuArchitecture machineArch;

  public AbsoluteTime startTime;

  public AbsoluteTime deadlineTime;

  public Dictionary stageInFiles;

  public Dictionary stageOutFiles;

  public Dictionary resourceLimits;

  public string accountingId;
};

interface Job {

  readonly attribute string jobId;

  readonly attribute string sessionName;

  readonly attribute JobTemplate jobTemplate;

  void suspend ()
    raises (UnsupportedOperationException);

  void resume ()
    raises (UnsupportedOperationException);

  void hold ()
    raises (UnsupportedOperationException);

  void release ()
    raises (UnsupportedOperationException);

  void terminate ()
    raises (DrmCommunicationException,
        DeniedByDrmsException,
        InternalException);

  void reap ()
    raises (UnsupportedOperationException);

  JobState getState(out any jobSubState);

  JobInfo getInfo ();

  void waitStarted(in TimeAmount timeout)
    raises (UnsupportedOperationException);

  void waitTerminated(in TimeAmount timeout)
    raises (TimeoutException,
        DeniedByDrmsException,
        InternalException);
};

typedef sequence<Job> JobList;

interface JobArray {

  readonly attribute string jobArrayId;

  readonly attribute JobList jobs;

  readonly attribute string sessionName;

  readonly attribute JobTemplate jobTemplate;

  void suspend ()
  raises (UnsupportedOperationException);

  void resume ()
  raises (UnsupportedOperationException);

  void hold ()
  raises (UnsupportedOperationException);

  void release ()
  raises (UnsupportedOperationException);

  void terminate ()
    raises (DrmCommunicationException,
        DeniedByDrmsException,
        InternalException);

  void reap ()
    raises (UnsupportedOperationException);
};
interface JobSession {

  readonly attribute string contact;
  
  readonly attribute string sessionName;

  readonly attribute StringList jobCategories;
  
  JobList getJobs(in JobInfo filter);
  
  JobArray getJobArray(in string jobArrayId)
  raises (InvalidArgumentException,
    InternalException);

  Job runJob(in JobTemplate jobTemplate)
  raises (DeniedByDrmsException, 
    InvalidArgumentException, 
    InternalException);

  JobArray runBulkJobs(in JobTemplate jobTemplate, in long beginIndex, 
    in long endIndex, in long step, in long maxParallel)
  raises (DeniedByDrmsException,  
    InvalidArgumentException, 
    InternalException);

  Job waitAnyStarted(in JobList jobs, in TimeAmount timeout)
  raises (UnsupportedOperationException);

  Job waitAnyTerminated(in JobList jobs, in TimeAmount timeout)
  raises (TimeoutException,
    DeniedByDrmsException, 
    InternalException);
};

// * \brief Enumeração que define tipos de evento para notificações
// */
//enum DrmaaEvent {
//
//  /**
//   * \brief O job trocou de estado, como é descrito no atributo jobState.
//   */
//  NEW_STATE,
//
//  /**
//   * \brief O job foi migrado para outro host de execução, e está agora no estado descrito pelo atributo jobState.
//   */
//  MIGRATED,
//
//  /**
//   * \brief Um atributo monitorado recebeu um novo valor.
//   */
//  ATTRIBUTE_CHANGE
//};
//
//struct DrmaaNotification {
//
//
//  DrmaaEvent event;
//
//  /**
//   * \brief
//   */
//  string jobId;
//
//  /**
//   * \brief
//   */
//  string sessionName;
//
//  /**
//   * \brief
//   */
//  JobState jobState;
//};
//
//   * \brief A interface DrmaaCallback permite que o sistema informe aplicações
//   *      sobre eventos relevantes de maneira assíncrona
//   */
//interface DrmaaCallback {
//
//  /**
//   * \brief Método de callback definido pela aplicação que deseja monitorar algum evento.
//   *
//   * \param [in] notification notificação enviada pelo sistema sobre algum dos eventos
//   *                      mapeados em tecgraf::openbus::DRMAA::v2_0::DrmaaEvent
//   */
//  void notify(in DrmaaNotification notification);
//};


interface SessionManager{

  readonly attribute string drmsName;

  readonly attribute Version drmsVersion;

  readonly attribute string drmaaName;

  readonly attribute Version drmaaVersion;

  boolean _supports(in DrmaaCapability capability);

  JobSession createJobSession(in string sessionName , in string contact )
  raises (DeniedByDrmsException, 
    InternalException,
    InvalidArgumentException);

  JobSession openJobSession(in string sessionName)
  raises (DeniedByDrmsException, 
    InternalException,
    InvalidArgumentException);


  void closeJobSession(in JobSession s);


  void destroyJobSession(in string sessionName);

  StringList getJobSessionNames ();

  void registerEventNotification(in DrmaaCallback callback)
  raises (UnsupportedOperationException);
};

}; // version

}; // DRMAA

}; // openbus

}; // tecgraf
#endif