src/Local/BatchManager_Local.hxx

   1 // Copyright (C) 2007-2021  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  * BatchManager_Local.hxx :
  24  *
  25  * Auteur : Ivan DUTKA-MALEN - EDF R&D
  26  * Mail   : mailto:ivan.dutka-malen@der.edf.fr
  27  * Date   : Thu Nov  6 10:17:22 2003
  28  * Projet : Salome 2
  29  *
  30  * Refactored by Renaud Barate (EDF R&D) in September 2009 to use
  31  * CommunicationProtocol classes and merge Local_SH, Local_RSH and Local_SSH batch
  32  * managers.
  33  *
  34  */
  35
  36 #ifndef _BATCHMANAGER_LOCAL_H_
  37 #define _BATCHMANAGER_LOCAL_H_
  38
  39 #include "Defines.hxx"
  40 #include "CommunicationProtocol.hxx"
  41
  42 #ifdef WIN32
  43 #include <Windows.h>
  44 #endif
  45
  46 #include <list>
  47 #include <map>
  48 #include <queue>
  49 #include <pthread.h>
  50 #include "Job.hxx"
  51 #include "JobId.hxx"
  52 #include "JobInfo.hxx"
  53 #include "JobInfo_Local.hxx"
  54 #include "Job_Local.hxx"
  55 #include "BatchManager.hxx"
  56
  57 namespace Batch {
  58
  59   class FactBatchManager;
  60
  61   /*!
  62    *  This class defines a local pseudo batch manager that can launch jobs locally or on a remote
  63    *  machine with SSH or RSH. This class is NOT thread-safe.
  64    */
  65   class BATCH_EXPORT BatchManager_Local : virtual public BatchManager
  66   {
  67   private:
  68     typedef int Id;
  69 #ifdef WIN32
  70     typedef HANDLE Process;
  71 #else
  72     typedef pid_t Process;
  73 #endif
  74     friend class ThreadAdapter;
  75     class ThreadAdapter{
  76     public:
  77       ThreadAdapter(BatchManager_Local & bm, const Job_Local & job, Id id);
  78       static void * run(void * arg);
  79       BatchManager_Local & getBatchManager() const { return _bm; };
  80       Id getId() const { return _id; };
  81
  82     protected:
  83       BatchManager_Local & _bm;
  84       const Job_Local _job;
  85       Id _id;
  86
  87     private:
  88       void pere(Process child);
  89 #ifndef WIN32
  90       void fils();
  91 #else
  92       Process launchWin32ChildProcess();
  93 #endif
  94
  95       /**
  96        * Create script to launch the remote command and copy it on the server.
  97        * Return the path of the remote script.
  98        */
  99       std::string buildCommandFile(const Job_Local & job);
 100
 101     };
 102
 103     enum Commande {
 104       NOP = 0,
 105       HOLD,
 106       RELEASE,
 107       TERM,
 108       KILL,
 109       ALTER
 110     };
 111
 112     struct Child {
 113       pthread_t thread_id;
 114       std::queue<Commande, std::deque<Commande> > command_queue;
 115       pid_t pid;
 116       int exit_code;
 117       bool hasFailed;
 118       Parametre param;
 119       Environnement env;
 120     };
 121
 122
 123
 124   public:
 125
 126     BatchManager_Local(const Batch::FactBatchManager * parent, const char * host = "localhost",
 127                        const char * username = "",
 128                        CommunicationProtocolType protocolType = SSH, const char * mpiImpl = "nompi");
 129     virtual ~BatchManager_Local();
 130
 131     // Recupere le nom du serveur par defaut
 132     // static string BatchManager_Local::getDefaultServer();
 133
 134     // Methodes pour le controle des jobs
 135     virtual const JobId runJob(const Job & job); // soumet un job au gestionnaire
 136     virtual void deleteJob(const JobId & jobid); // retire un job du gestionnaire
 137     virtual void holdJob(const JobId & jobid); // suspend un job en file d'attente
 138     virtual void releaseJob(const JobId & jobid); // relache un job suspendu
 139     virtual JobInfo queryJob(const JobId & jobid); // renvoie l'etat du job
 140     virtual bool isRunning(const JobId & jobid); // teste si un job est present en machine
 141
 142     virtual void setParametre(const JobId & jobid, const Parametre & param) { return alterJob(jobid, param); } // modifie un job en file d'attente
 143     virtual void setEnvironnement(const JobId & jobid, const Environnement & env) { return alterJob(jobid, env); } // modifie un job en file d'attente
 144
 145     virtual const Batch::JobId addJob(const Batch::Job & job, const std::string & reference); // ajoute un nouveau job sans le soumettre
 146
 147   protected:
 148     int _connect; // Local connect id
 149     pthread_mutex_t _threads_mutex;
 150     std::map<Id, Child > _threads;
 151
 152   private:
 153     static  void kill_child_on_exit(void * p_pid);
 154     static  void delete_on_exit(void * arg);
 155     static void setFailedOnCancel(void * arg);
 156     pthread_cond_t _threadSyncCondition;
 157     Id _idCounter;
 158
 159 #ifdef SWIG
 160   public:
 161     // Recupere le l'identifiant d'un job deja soumis au BatchManager
 162     //virtual const JobId getJobIdByReference(const string & ref) { return BatchManager::getJobIdByReference(ref); }
 163     virtual const JobId getJobIdByReference(const char * ref) { return BatchManager::getJobIdByReference(ref); }
 164 #endif
 165
 166   };
 167
 168 }
 169
 170 #endif