Salome HOME
Merge branch 'omu/multijob'
[modules/kernel.git] / src / Launcher / Launcher.hxx
index 228355c301cc58f137e8eb86a6b6c17913e5be63..d7e9f1d22c1a04a9a405e38728a59525a73cb0d6 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2020  CEA/DEN, EDF R&D, OPEN CASCADE
 //
 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
@@ -6,7 +6,7 @@
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
 // License as published by the Free Software Foundation; either
-// version 2.1 of the License.
+// version 2.1 of the License, or (at your option) any later version.
 //
 // This library is distributed in the hope that it will be useful,
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -33,8 +33,8 @@
 
 #include <string>
 #include <vector>
-
-#include <pthread.h>
+#include <list>
+#include <memory>
 
 class MpiImpl;
 
@@ -43,59 +43,89 @@ namespace Batch{
   class Job;
 }
 
-struct batchParams{
-  std::string batch_directory;
-  std::string expected_during_time;
-  std::string mem;
-  unsigned long nb_proc;
-
-  // Parameters for COORM
+struct LAUNCHER_EXPORT JobParameters_cpp
+{
+  std::string job_name;
+  std::string job_type;
+  std::string job_file;
+  std::string pre_command;
+  std::string env_file;
+  std::list<std::string> in_files;
+  std::list<std::string> out_files;
+  std::string work_directory;
+  std::string local_directory;
+  std::string result_directory;
+  std::string maximum_duration;
+  resourceParams resource_required;
+  std::string queue;
+  std::string partition;
+  bool exclusive;
+  unsigned int mem_per_cpu;
+  std::string wckey;
+  std::string extra_params;
+  std::map<std::string, std::string> specific_parameters;
   std::string launcher_file;
   std::string launcher_args;
 };
 
 class LAUNCHER_EXPORT Launcher_cpp
 {
-
 public:
   Launcher_cpp();
   virtual ~Launcher_cpp();
 
   // Main interface
   void         createJob(Launcher::Job * new_job);
+  int          createJob(const JobParameters_cpp& job_parameters);
   void         launchJob(int job_id);
-  const char * getJobState(int job_id);
-  const char * getAssignedHostnames(int job_id); // Get names or ids of hosts assigned to the job
+  std::string  getJobState(int job_id);
+  std::string  getAssignedHostnames(int job_id); // Get names or ids of hosts assigned to the job
+  void         exportInputFiles(int job_id);
   void         getJobResults(int job_id, std::string directory);
+  void         clearJobWorkingDir(int job_id);
   bool         getJobDumpState(int job_id, std::string directory);
+  bool         getJobWorkFile(int job_id, std::string work_file, std::string directory);
   void         stopJob(int job_id);
   void         removeJob(int job_id);
+  std::string  dumpJob(int job_id);
+  int restoreJob(const std::string& dumpedJob);
+  JobParameters_cpp getJobParameters(int job_id);
+
+  /*! Load the jobs from the file "jobs_file" and add them to the Launcher.
+   *  Return a list with the IDs of the jobs that were successfully loaded.
+   */
+  std::list<int> loadJobs(const char* jobs_file);
+
+  //! Save the jobs of the Launcher to the file "jobs_file".
+  void saveJobs(const char* jobs_file);
 
   // Useful methods
   long createJobWithFile(std::string xmlExecuteFile, std::string clusterName);
   std::map<int, Launcher::Job *> getJobs();
-  void createBatchManagerForJob(Launcher::Job * job);
-  void addJobDirectlyToMap(Launcher::Job * new_job, const std::string job_reference);
+  void addJobDirectlyToMap(Launcher::Job * new_job);
+  Launcher::Job * findJob(int job_id);
 
   // Lib methods
-  void SetResourcesManager( ResourcesManager_cpp* rm ) {_ResManager = rm;}
+  void SetResourcesManager( std::shared_ptr<ResourcesManager_cpp>& rm ) {_ResManager = rm;}
 
-  // Used by SALOME_Launcher
-  ResourcesManager_cpp *_ResManager;
 protected:
 
+  // Used by SALOME_Launcher
+  std::shared_ptr<ResourcesManager_cpp> _ResManager;
+
   virtual void notifyObservers(const std::string & event_name, const std::string & event_data) {}
+  int addJob(Launcher::Job * new_job);
 
   // Methods used by user interface methods
 #ifdef WITH_LIBBATCH
   Batch::BatchManager *FactoryBatchManager(ParserResourcesType& params);
   std::map <int, Batch::BatchManager*> _batchmap;
+  Batch::BatchManager* getBatchManager(Launcher::Job * job);
 #endif
   ParserLauncherType ParseXmlFile(std::string xmlExecuteFile);
 
   std::map <int, Launcher::Job *> _launcher_job_map;  
   int _job_cpt; // job number counter
-  pthread_mutex_t * _job_cpt_mutex; // mutex for job counter
 };
 
 #endif