idl/SALOME_Launcher.idl

   1 // Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 #ifndef _SALOME_LAUNCHER_IDL_
  24 #define _SALOME_LAUNCHER_IDL_
  25
  26 #include "SALOME_Exception.idl"
  27 #include "SALOME_ResourcesManager.idl"
  28
  29 /*! \file SALOME_Launcher.idl \brief Interfaces for %SALOME Launcher service
  30 */
  31
  32 module Engines
  33 {
  34
  35 //! files list
  36 typedef sequence<string> FilesList;
  37
  38 //! A generic parameter
  39 struct Parameter
  40 {
  41   string name;
  42   string value;
  43 };
  44 //! Generic parameter list
  45 typedef sequence<Engines::Parameter> ParameterList;
  46
  47 struct JobParameters
  48 {
  49   //! Name of the job.
  50   string job_name;
  51
  52   //! Type of the job.
  53   /*! There are three supported types:
  54         - "command" : execute #job_file script without %SALOME environment
  55         - "python_salome" : execute #job_file python script by %SALOME
  56         - "yacs_file" : execute #job_file by YACS module as a xml YACS schema
  57   */
  58   string job_type;
  59
  60   // Common values
  61   //! Local path to the file to be executed by the job.
  62   /*! The type of the file depends on #job_type.
  63       If #job_type is "command", the #job_file must be a single filename
  64       specifying a self-consistent script to be executed without any argument,
  65       on the remote host.
  66   */
  67   string job_file;
  68
  69   //! Local path to a script to be sourced in the environment of the job.
  70   /*! It may contain modifications of environment variables.
  71   */
  72   string env_file;
  73
  74   //! List of local data files to be copied to #work_directory.
  75   /*! #job_file and #env_file are automaticaly copied, without adding them
  76       to this list. If basenames are specified, then the files are supposed
  77       to be located in #local_directory.
  78   */
  79   FilesList in_files;
  80
  81   //! List of results to get back at the end of the job.
  82   /*! These results can be names of files or directories, produced by the job
  83       in #work_directory. Directories will be copied recursively.
  84       It is also possible to use an absolute path instead of the simple name,
  85       (string beginning with '/') and this absolute path will be used instead
  86       of #result_directory when SalomeLauncher::getJobResults is called.
  87       \see SalomeLauncher::getJobResults
  88   */
  89   FilesList out_files;
  90
  91   //! Remote directory where the job will be executed.
  92   /*! It must be used to specify the remote directory where to put all
  93       the stuff to run the job. Note that the job will be executed from within
  94       this directory. A change directory toward this working directory is done
  95       by the batch system before running the job.
  96       If not specified (empty string), the launcher will use the working
  97       directory of the chosen ressource and if this is also an empty string
  98       the value used will be $HOME/Batch/workdir_"date" where $HOME is the
  99       value of the environment variable on the remote ressource and "date" is
 100       the current date.
 101   */
 102   string work_directory;
 103
 104   //! Prefix to be applied to #in_files.
 105   /*! It can be used to specify where to find the local input files.
 106       It's optionnal if you specify the absolute path name of input files.
 107   */
 108   string local_directory;
 109
 110   //! Local directory where to get result files.
 111   /*! It must be used to specify where to download the output files on the
 112       local file system.
 113       If not specified (empty string), the value of $HOME environment variable
 114       will be used.
 115       \see SalomeLauncher::getJobResults
 116   */
 117   string result_directory;
 118
 119   //! Maximum time for the batch execution (expected format : "hh:mm").
 120   /*! Could be empty, in this case, default value of the selected resource
 121       will be used.
 122   */
 123   string maximum_duration;
 124
 125   //! Specifies the rules to choose the ressource where to execute the job.
 126   /*! The additionnal two following parameters MUST be specified explicitly,
 127       because they are not provided by the resource definition:
 128       - mem_mb -> Memory expressed in megabytes.
 129       - nb_proc -> Number of Processors.
 130   */
 131   ResourceParameters resource_required;
 132
 133   //!  Name of the batch queue chosen - optional
 134   string queue;
 135
 136   //! Specifies if the job must run in exclusive mode (without sharing nodes with other jobs)
 137   boolean exclusive;
 138
 139   //! Specifies the memory limit per cpu (exclusive with resource_required.mem_mb)
 140   unsigned long mem_per_cpu;
 141
 142   //! Workload Characterization Key - mandatory on some clusters
 143   string wckey;
 144
 145   //! String that is added to the job submission file - optional
 146   string extra_params;
 147
 148   //! Specific parameters for each type of job - optional
 149   /*! This is a list of parameters (key - value pairs of strings) useful in
 150       some specific situations.
 151       Known parameters:
 152       - EnableDumpYACS : value of the "dump" option of the "driver" command
 153         when the job type is "yacs_file". It gives the number of seconds
 154         between two updates of the state dump file. There will be no dump file
 155         if this parameter is missing or if its value is less than 1.
 156   */
 157   Engines::ParameterList specific_parameters;
 158
 159   //! %Parameter for COORM
 160   string launcher_file;
 161   //! %Parameter for COORM
 162   string launcher_args;
 163 };
 164
 165 struct JobDescription
 166 {
 167   long job_id;
 168   Engines::JobParameters job_parameters;
 169 };
 170 typedef sequence<Engines::JobDescription> JobsList;
 171
 172 interface SalomeLauncherObserver
 173 {
 174   void notify(in string event_name, in string event_data);
 175 };
 176
 177 //! Interface of the %salome launcher.
 178 /*! This interface is used for interaction with the unique instance
 179     of SalomeLauncher.
 180     The utilisation of this interface is explained in the YACS documentation,
 181     article "Starting a SALOME application in a batch manager".
 182     Other examples of use can be found in the modules JOBMANAGER, PARAMETRIC
 183     and SMESH (PADDER tool).
 184 */
 185 interface SalomeLauncher
 186 {
 187   // Main methods
 188   //! Create a job and set its parameters, without launching it.
 189   /*! Its state becomes "CREATED".
 190       \return job id
 191   */
 192   long   createJob    (in Engines::JobParameters job_parameters) raises (SALOME::SALOME_Exception);
 193
 194   //! Launch an already created job (job's state should be "CREATED").
 195   /*! Launching the job consists of:
 196       - create the working directory on the remote file system
 197       - copy the input files into the working directory
 198       - submit the job to the batch manager
 199   */
 200   void   launchJob    (in long job_id)                           raises (SALOME::SALOME_Exception);
 201
 202   //! Get the execution state of the job.
 203   /*! \return "CREATED", "IN_PROCESS", "QUEUED", "RUNNING", "PAUSED",
 204              "FINISHED" or "FAILED"
 205       \see LIBBATCH/src/core/Constants.hxx
 206   */
 207   string getJobState  (in long job_id)                           raises (SALOME::SALOME_Exception);
 208
 209   //! Get names or ids of hosts assigned to the job
 210   string getAssignedHostnames  (in long job_id)                  raises (SALOME::SALOME_Exception);
 211
 212   //! Copy the result files from the work directory of the job
 213   //! to a local directory.
 214   /*! The list of result files is given by the JobParameters::out_files parameter.
 215      If a result "file" is a directory, the copy is recursive.
 216      The "logs" directory contains the standard and the error outputs of the job.
 217      \param job_id    Job id returned by createJob().
 218      \param directory Local directory where to copy the results.
 219                       If this value is an empty string (""), files will be
 220                       copied to the directory given by
 221                       JobParameters::result_directory.
 222      \see JobParameters
 223      \see createJob
 224   */
 225   void   getJobResults(in long job_id, in string directory)      raises (SALOME::SALOME_Exception);
 226
 227   //! Try to copy the files named "dumpState*.xml" from the working directory.
 228   /*! The file "dumpState_name.xml" can be produced by the execution of a YACS
 229       schema and it contains the execution state of the schema.
 230       You can activate the creation of this file by adding the parameter
 231       "EnableDumpYACS" in JobParameters::specific_parameters when the job
 232       is created.
 233      \param job_id    Job id returned by createJob().
 234      \param directory Local directory where to copy the file.
 235                       If this value is an empty string (""), the file will be
 236                       copied to the directory given by
 237                       JobParameters::result_directory.
 238      \return 1 if the copy succeeds.
 239      \see JobParameters::specific_parameters
 240   */
 241   boolean getJobDumpState(in long job_id, in string directory)   raises (SALOME::SALOME_Exception);
 242
 243   //! Retrieve one sigle file from the working directory.
 244   /*! Use this method if you don't want to copy all the results of the job,
 245       for instance if you want to obtain a file which contains the computing
 246       progress while the job is running.
 247      \param job_id    Job id returned by createJob().
 248      \param work_file Path to the file to be copied, relative to the
 249                       working directory of the job. If it is a directory,
 250                       it will be copied recursively.
 251      \param directory Local directory where to copy the file.
 252                       If this value is an empty string (""), the file will be
 253                       copied to the directory given by
 254                       JobParameters::result_directory.
 255      \return 1 if the copy succeeds.
 256   */
 257   boolean getJobWorkFile(in long job_id, in string work_file, in string directory)   raises (SALOME::SALOME_Exception);
 258
 259   //! Kill the job and set its state to "FAILED"
 260   void   stopJob      (in long job_id)                           raises (SALOME::SALOME_Exception);
 261   //! Kill the job and remove it from the jobs list
 262   void   removeJob    (in long job_id)                           raises (SALOME::SALOME_Exception);
 263
 264   // Useful methods
 265   long    createJobWithFile(in string xmlJobFile, in string clusterName) raises (SALOME::SALOME_Exception);
 266   boolean testBatch        (in ResourceParameters params)                raises (SALOME::SALOME_Exception);
 267
 268   // SALOME kernel service methods
 269   //! Shutdow SalomeLauncher server.
 270   void Shutdown();
 271   //! Get the PID of the current process
 272   long getPID();
 273
 274   // Observer and introspection methods
 275   //! Add an observer to be notified of the jobs list modifications
 276   void addObserver(in Engines::SalomeLauncherObserver observer);
 277   void removeObserver(in Engines::SalomeLauncherObserver observer);
 278   Engines::JobsList getJobsList();
 279   Engines::JobParameters getJobParameters(in long job_id) raises (SALOME::SALOME_Exception);
 280
 281   // Save and load methods
 282   //! Add to the current jobs list the jobs previously saved in an xml file.
 283   void loadJobs(in string jobs_file) raises (SALOME::SALOME_Exception);
 284   //! Save the current list of jobs in an xml file.
 285   void saveJobs(in string jobs_file) raises (SALOME::SALOME_Exception);
 286
 287 };
 288
 289 };
 290
 291 #endif