src/SGE/BatchManager_SGE.cxx

   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_SGE.cxx : emulation of SGE client
  24  *
  25  * Auteur : Bernard SECHER - CEA DEN
  26  * Mail   : mailto:bernard.secher@cea.fr
  27  * Date   : Thu Apr 24 10:17:22 2008
  28  * Projet : PAL Salome
  29  *
  30  */
  31
  32 #include <stdlib.h>
  33 #include <string.h>
  34
  35 #include <iostream>
  36 #include <fstream>
  37 #include <sstream>
  38
  39 #include <stdlib.h>
  40 #include <string.h>
  41
  42 #ifdef WIN32
  43 #include <io.h>
  44 #else
  45 #include <libgen.h>
  46 #endif
  47
  48 #include <Constants.hxx>
  49 #include <Utils.hxx>
  50 #include <NotYetImplementedException.hxx>
  51
  52 #include "BatchManager_SGE.hxx"
  53 #include "JobInfo_SGE.hxx"
  54 #include "Log.hxx"
  55
  56 using namespace std;
  57
  58 namespace Batch {
  59
  60   BatchManager_SGE::BatchManager_SGE(const FactBatchManager * parent, const char * host,
  61                                        const char * username,
  62                                        CommunicationProtocolType protocolType, const char * mpiImpl)
  63   : BatchManager(parent, host, username, protocolType, mpiImpl)
  64   {
  65     // Nothing to do
  66   }
  67
  68   // Destructeur
  69   BatchManager_SGE::~BatchManager_SGE()
  70   {
  71     // Nothing to do
  72   }
  73
  74   // Methode pour le controle des jobs : soumet un job au gestionnaire
  75   const JobId BatchManager_SGE::runJob(const Job & job)
  76   {
  77     Parametre params = job.getParametre();
  78     const std::string workDir = params[WORKDIR];
  79     const string fileToExecute = params[EXECUTABLE];
  80     string::size_type p1 = fileToExecute.find_last_of("/");
  81     string::size_type p2 = fileToExecute.find_last_of(".");
  82     std::string fileNameToExecute = fileToExecute.substr(p1+1,p2-p1-1);
  83
  84     // build batch script for job
  85     buildBatchScript(job);
  86
  87     // define command to submit batch
  88     string subCommand = string("bash -l -c \\\"cd ") + workDir + "; qsub " + fileNameToExecute + "_Batch.sh\\\"";
  89     string command = _protocol.getExecCommand(subCommand, _hostname, _username);
  90     command += " 2>&1";
  91     LOG(command);
  92
  93     // submit job
  94     string output;
  95     int status = Utils::getCommandOutput(command, output);
  96     LOG(output);
  97     if (status != 0) throw RunTimeException("Can't submit job, error was: " + output);
  98
  99     // find id of submitted job in output
 100     string strjob;
 101     istringstream iss(output);
 102     iss >> strjob >> strjob >> strjob;
 103
 104     JobId id(this, strjob);
 105     return id;
 106   }
 107
 108
 109   // Methode pour le controle des jobs : retire un job du gestionnaire
 110   void BatchManager_SGE::deleteJob(const JobId & jobid)
 111   {
 112     int status;
 113     int ref;
 114     istringstream iss(jobid.getReference());
 115     iss >> ref;
 116
 117     // define command to delete batch
 118     string subCommand = string("bash -l -c \\\"qdel ") + iss.str() + string("\\\"");
 119     string command = _protocol.getExecCommand(subCommand, _hostname, _username);
 120     LOG(command);
 121     status = system(command.c_str());
 122     if(status)
 123       throw RunTimeException("Error of connection on remote host");
 124
 125     LOG("jobId = " << ref << "killed");
 126   }
 127
 128   // Methode pour le controle des jobs : renvoie l'etat du job
 129   JobInfo BatchManager_SGE::queryJob(const JobId & jobid)
 130   {
 131     int id;
 132     istringstream iss(jobid.getReference());
 133     iss >> id;
 134
 135     // define command to query batch
 136     string subCommand = string("bash -l -c \\\"qstat | grep ") + iss.str() + string("\\\"");
 137     string command = _protocol.getExecCommand(subCommand, _hostname, _username);
 138     LOG(command);
 139
 140     string output;
 141     int status = Utils::getCommandOutput(command, output);
 142     if (status && status != 256)
 143       throw RunTimeException("Error of connection on remote host");
 144
 145     JobInfo_SGE ji = JobInfo_SGE(id, output);
 146     return ji;
 147   }
 148
 149   // Methode pour le controle des jobs : teste si un job est present en machine
 150   bool BatchManager_SGE::isRunning(const JobId & /*jobid*/)
 151   {
 152     throw NotYetImplementedException("BatchManager_SGE::isRunning");
 153   }
 154
 155   void BatchManager_SGE::buildBatchScript(const Job & job)
 156   {
 157 #ifndef WIN32
 158     //TODO porting on Win32 platform
 159     LOG("BuildBatchScript");
 160     Parametre params = job.getParametre();
 161
 162     // Job Parameters
 163     string workDir       = "";
 164     string fileToExecute = "";
 165     int nbproc           = 0;
 166     int edt              = 0;
 167     int mem              = 0;
 168     string queue         = "";
 169
 170     // Mandatory parameters
 171     if (params.find(WORKDIR) != params.end())
 172       workDir = params[WORKDIR].str();
 173     else
 174       throw RunTimeException("params[WORKDIR] is not defined ! Please defined it, cannot submit this job");
 175     if (params.find(EXECUTABLE) != params.end())
 176       fileToExecute = params[EXECUTABLE].str();
 177     else
 178       throw RunTimeException("params[EXECUTABLE] is not defined ! Please defined it, cannot submit this job");
 179
 180     // Optional parameters
 181     if (params.find(NBPROC) != params.end())
 182       nbproc = params[NBPROC];
 183     if (params.find(MAXWALLTIME) != params.end())
 184       edt = params[MAXWALLTIME];
 185     if (params.find(MAXRAMSIZE) != params.end())
 186       mem = params[MAXRAMSIZE];
 187     if (params.find(QUEUE) != params.end())
 188       queue = params[QUEUE].str();
 189
 190     string::size_type p1 = fileToExecute.find_last_of("/");
 191     string::size_type p2 = fileToExecute.find_last_of(".");
 192     string rootNameToExecute = fileToExecute.substr(p1+1,p2-p1-1);
 193     string fileNameToExecute = fileToExecute.substr(p1+1);
 194
 195     // Create batch submit file
 196     ofstream tempOutputFile;
 197     std::string TmpFileName = Utils::createAndOpenTemporaryFile("SGE-script", tempOutputFile);
 198
 199     tempOutputFile << "#! /bin/sh -f" << endl;
 200     if (queue != "")
 201       tempOutputFile << "#$ -q " << queue << endl;
 202     tempOutputFile << "#$ -pe " << _mpiImpl->name() << " " << nbproc << endl;
 203     if( edt > 0 )
 204       tempOutputFile << "#$ -l h_rt=" << getWallTime(edt) << endl ;
 205     if( mem > 0 )
 206       tempOutputFile << "#$ -l h_vmem=" << mem << "M" << endl ;
 207     tempOutputFile << "#$ -o " << workDir << "/logs/output.log." << rootNameToExecute << endl ;
 208     tempOutputFile << "#$ -e " << workDir << "/logs/error.log." << rootNameToExecute << endl ;
 209
 210     // Abstraction of PBS_NODEFILE - TODO
 211     tempOutputFile << "export LIBBATCH_NODEFILE=$TMPDIR/machines" << endl;
 212
 213     // Launch the executable
 214     tempOutputFile << "cd " << workDir << endl ;
 215     tempOutputFile << "./" + fileNameToExecute << endl;
 216     tempOutputFile.flush();
 217     tempOutputFile.close();
 218
 219     Utils::chmod(TmpFileName.c_str(), 0x1ED);
 220     LOG("Batch script file generated is: " << TmpFileName.c_str());
 221
 222     int status = _protocol.copyFile(TmpFileName, "", "",
 223                                     workDir + "/" + rootNameToExecute + "_Batch.sh",
 224                                     _hostname, _username);
 225     if (status)
 226       throw RunTimeException("Error of connection on remote host");
 227
 228 #endif //WIN32
 229   }
 230
 231   std::string BatchManager_SGE::getWallTime(const long edt)
 232   {
 233     long h, m;
 234     h = edt / 60;
 235     m = edt - h*60;
 236     ostringstream oss;
 237     if( m >= 10 )
 238       oss << h << ":" << m;
 239     else
 240       oss << h << ":0" << m;
 241     oss << ":00"; // the seconds
 242
 243     return oss.str();
 244   }
 245
 246 }