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   class BATCH_EXPORT BatchManager_Local : public BatchManager
  62   {
  63   private:
  64 #ifdef WIN32
  65     typedef HANDLE Process;
  66 #else
  67     typedef pid_t Process;
  68 #endif
  69     friend class ThreadAdapter;
  70     class ThreadAdapter{
  71     public:
  72       ThreadAdapter(BatchManager_Local & bm, const Job_Local & job);
  73       static void * run(void * arg);
  74       BatchManager_Local & getBatchManager() const { return _bm; };
  75
  76     protected:
  77       BatchManager_Local & _bm;
  78       const Job_Local _job;
  79
  80     private:
  81       void pere(Process child);
  82 #ifndef WIN32
  83       void fils();
  84 #else
  85       Process launchWin32ChildProcess();
  86 #endif
  87
  88     };
  89
  90     typedef int Id;
  91
  92     enum Commande {
  93       NOP = 0,
  94       HOLD,
  95       RELEASE,
  96       TERM,
  97       KILL,
  98       ALTER
  99     };
 100
 101     enum Status {
 102       UNKNOWN = 0,
 103       RUNNING,
 104       STOPPED,
 105       DONE,
 106       DEAD
 107     };
 108
 109     struct Child {
 110       pthread_t thread_id;
 111       std::queue<Commande, std::deque<Commande> > command_queue;
 112       pid_t pid;
 113       int exit_code;
 114       Status status;
 115       Parametre param;
 116       Environnement env;
 117     };
 118
 119
 120
 121   public:
 122     // Constructeur et destructeur
 123     BatchManager_Local(const FactBatchManager * parent,
 124                        const char * host="localhost",
 125                        CommunicationProtocolType protocolType = SSH); // connexion a la machine host
 126     virtual ~BatchManager_Local();
 127
 128     // Recupere le nom du serveur par defaut
 129     // static string BatchManager_Local::getDefaultServer();
 130
 131     // Get the underlying communication protocol
 132     const CommunicationProtocol & getProtocol() const;
 133
 134     // Methodes pour le controle des jobs
 135     virtual const JobId submitJob(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 void alterJob(const JobId & jobid, const Parametre & param, const Environnement & env); // modifie un job en file d'attente
 140     virtual void alterJob(const JobId & jobid, const Parametre & param); // modifie un job en file d'attente
 141     virtual void alterJob(const JobId & jobid, const Environnement & env); // modifie un job en file d'attente
 142     virtual JobInfo queryJob(const JobId & jobid); // renvoie l'etat du job
 143     virtual bool isRunning(const JobId & jobid); // teste si un job est present en machine
 144
 145     virtual void setParametre(const JobId & jobid, const Parametre & param) { return alterJob(jobid, param); } // modifie un job en file d'attente
 146     virtual void setEnvironnement(const JobId & jobid, const Environnement & env) { return alterJob(jobid, env); } // modifie un job en file d'attente
 147
 148
 149   protected:
 150     int _connect; // Local connect id
 151     pthread_mutex_t _threads_mutex;
 152     std::map<Id, Child > _threads;
 153
 154     const CommunicationProtocol & _protocol;
 155
 156     // Methode qui renvoie la commande a executer
 157     std::vector<std::string> exec_command(const Parametre & param) const;
 158
 159   private:
 160     struct ThreadIdIdAssociation {
 161       pthread_t threadId;
 162       Id id;
 163     };
 164
 165     virtual pthread_t submit(const Job_Local & job);
 166     virtual void cancel(pthread_t thread_id);
 167     static  void kill_child_on_exit(void * p_pid);
 168     static  void delete_on_exit(void * arg);
 169     Id nextId(); // Retourne un identifiant unique pour un thread (clef de la map)
 170     Id getIdByThread_id(pthread_t thread_id);
 171     Id registerThread_id(pthread_t thread_id);
 172     pthread_mutex_t _thread_id_id_association_mutex;
 173     pthread_cond_t  _thread_id_id_association_cond;
 174     std::list<struct ThreadIdIdAssociation> _thread_id_id_association;
 175
 176 #ifdef SWIG
 177   public:
 178     // Recupere le l'identifiant d'un job deja soumis au BatchManager
 179     //virtual const JobId getJobIdByReference(const string & ref) { return BatchManager::getJobIdByReference(ref); }
 180     virtual const JobId getJobIdByReference(const char * ref) { return BatchManager::getJobIdByReference(ref); }
 181 #endif
 182
 183   };
 184
 185 }
 186
 187 #endif