src/Local/Batch_BatchManager_Local.hxx

   1 //  Copyright (C) 2007-2008  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.
  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 "Batch_Defines.hxx"
  40 #include "Batch_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 "Batch_Job.hxx"
  51 #include "Batch_JobId.hxx"
  52 #include "Batch_JobInfo.hxx"
  53 #include "Batch_JobInfo_Local.hxx"
  54 #include "Batch_Job_Local.hxx"
  55 #include "Batch_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
  81     protected:
  82       BatchManager_Local & _bm;
  83       const Job_Local _job;
  84       Id _id;
  85
  86     private:
  87       void pere(Process child);
  88 #ifndef WIN32
  89       void fils();
  90 #else
  91       Process launchWin32ChildProcess();
  92 #endif
  93
  94     };
  95
  96     enum Commande {
  97       NOP = 0,
  98       HOLD,
  99       RELEASE,
 100       TERM,
 101       KILL,
 102       ALTER
 103     };
 104
 105     enum Status {
 106       UNKNOWN = 0,
 107       RUNNING,
 108       STOPPED,
 109       DONE,
 110       DEAD
 111     };
 112
 113     struct Child {
 114       pthread_t thread_id;
 115       std::queue<Commande, std::deque<Commande> > command_queue;
 116       pid_t pid;
 117       int exit_code;
 118       Status status;
 119       Parametre param;
 120       Environnement env;
 121     };
 122
 123
 124
 125   public:
 126     // Constructeur et destructeur
 127     BatchManager_Local(const FactBatchManager * parent,
 128                        const char * host="localhost",
 129                        CommunicationProtocolType protocolType = SSH); // connexion a la machine host
 130     virtual ~BatchManager_Local();
 131
 132     // Recupere le nom du serveur par defaut
 133     // static string BatchManager_Local::getDefaultServer();
 134
 135     // Get the underlying communication protocol
 136     const CommunicationProtocol & getProtocol() const;
 137
 138     // Methodes pour le controle des jobs
 139     virtual const JobId submitJob(const Job & job); // soumet un job au gestionnaire
 140     virtual void deleteJob(const JobId & jobid); // retire un job du gestionnaire
 141     virtual void holdJob(const JobId & jobid); // suspend un job en file d'attente
 142     virtual void releaseJob(const JobId & jobid); // relache un job suspendu
 143     virtual void alterJob(const JobId & jobid, const Parametre & param, const Environnement & env); // modifie un job en file d'attente
 144     virtual void alterJob(const JobId & jobid, const Parametre & param); // modifie un job en file d'attente
 145     virtual void alterJob(const JobId & jobid, const Environnement & env); // modifie un job en file d'attente
 146     virtual JobInfo queryJob(const JobId & jobid); // renvoie l'etat du job
 147     virtual bool isRunning(const JobId & jobid); // teste si un job est present en machine
 148
 149     virtual void setParametre(const JobId & jobid, const Parametre & param) { return alterJob(jobid, param); } // modifie un job en file d'attente
 150     virtual void setEnvironnement(const JobId & jobid, const Environnement & env) { return alterJob(jobid, env); } // modifie un job en file d'attente
 151
 152
 153   protected:
 154     int _connect; // Local connect id
 155     pthread_mutex_t _threads_mutex;
 156     std::map<Id, Child > _threads;
 157
 158     const CommunicationProtocol & _protocol;
 159
 160     // Methode qui renvoie la commande a executer
 161     std::vector<std::string> exec_command(const Parametre & param) const;
 162
 163   private:
 164     virtual void cancel(pthread_t thread_id);
 165     static  void kill_child_on_exit(void * p_pid);
 166     static  void delete_on_exit(void * arg);
 167     pthread_cond_t _threadLaunchCondition;
 168     Id _idCounter;
 169
 170 #ifdef SWIG
 171   public:
 172     // Recupere le l'identifiant d'un job deja soumis au BatchManager
 173     //virtual const JobId getJobIdByReference(const string & ref) { return BatchManager::getJobIdByReference(ref); }
 174     virtual const JobId getJobIdByReference(const char * ref) { return BatchManager::getJobIdByReference(ref); }
 175 #endif
 176
 177   };
 178
 179 }
 180
 181 #endif