src/PBS/Batch_BatchManager_ePBS.cxx

   1 //  Copyright (C) 2007-2010  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_ePBS.cxx : emulation of PBS client
  24  *
  25  * Auteur : Bernard SECHER - CEA DEN, André RIBES - EDF R&D
  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 #include <sys/stat.h>
  39
  40 #include <stdlib.h>
  41 #include <string.h>
  42 #include <Batch_config.h>
  43
  44 #ifdef MSVC
  45 #include <io.h>
  46 #else
  47 #include <libgen.h>
  48 #endif
  49
  50 #include "Batch_BatchManager_ePBS.hxx"
  51 #include "Batch_JobInfo_ePBS.hxx"
  52
  53 using namespace std;
  54
  55 namespace Batch {
  56
  57   BatchManager_ePBS::BatchManager_ePBS(const FactBatchManager * parent, const char * host,
  58                                        CommunicationProtocolType protocolType, const char * mpiImpl,
  59                                        int nb_proc_per_node)
  60     : BatchManager_eClient(parent, host, protocolType, mpiImpl),
  61     BatchManager(parent, host)
  62   {
  63     // Nothing to do
  64     _nb_proc_per_node = nb_proc_per_node;
  65   }
  66
  67   // Destructeur
  68   BatchManager_ePBS::~BatchManager_ePBS()
  69   {
  70     // Nothing to do
  71   }
  72
  73   // Methode pour le controle des jobs : soumet un job au gestionnaire
  74   const JobId BatchManager_ePBS::submitJob(const Job & job)
  75   {
  76     int status;
  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     // export input files on cluster
  85     exportInputFiles(job);
  86
  87     // build batch script for job
  88     buildBatchScript(job);
  89
  90     // define name of log file (local)
  91     string logFile = generateTemporaryFileName("PBS-submitlog");
  92
  93     // define command to submit batch
  94     string subCommand = string("cd ") + workDir + "; qsub " + fileNameToExecute + "_Batch.sh";
  95     string command = _protocol.getExecCommand(subCommand, _hostname, _username);
  96     command += " > ";
  97     command += logFile;
  98     command += " 2>&1";
  99     cerr << command.c_str() << endl;
 100     status = system(command.c_str());
 101     if(status)
 102     {
 103       ifstream error_message(logFile.c_str());
 104       std::string mess;
 105       std::string temp;
 106       while(std::getline(error_message, temp))
 107         mess += temp;
 108       error_message.close();
 109       throw EmulationException("Error of connection on remote host, error was: " + mess);
 110     }
 111
 112     // read id of submitted job in log file
 113     ifstream idfile(logFile.c_str());
 114     string sline;
 115     idfile >> sline;
 116     idfile.close();
 117     if (sline.size() == 0)
 118       throw EmulationException("Error in the submission of the job on the remote host");
 119
 120     JobId id(this, sline);
 121     return id;
 122   }
 123
 124   // Methode pour le controle des jobs : retire un job du gestionnaire
 125   void BatchManager_ePBS::deleteJob(const JobId & jobid)
 126   {
 127     int status;
 128     int ref;
 129     istringstream iss(jobid.getReference());
 130     iss >> ref;
 131
 132     // define command to delete batch
 133     string subCommand = string("qdel ") + iss.str();
 134     string command = _protocol.getExecCommand(subCommand, _hostname, _username);
 135     cerr << command.c_str() << endl;
 136     status = system(command.c_str());
 137     if (status)
 138       throw EmulationException("Error of connection on remote host");
 139
 140     cerr << "jobId = " << ref << "killed" << endl;
 141   }
 142
 143   // Methode pour le controle des jobs : suspend un job en file d'attente
 144   void BatchManager_ePBS::holdJob(const JobId & jobid)
 145   {
 146     throw EmulationException("Not yet implemented");
 147   }
 148
 149   // Methode pour le controle des jobs : relache un job suspendu
 150   void BatchManager_ePBS::releaseJob(const JobId & jobid)
 151   {
 152     throw EmulationException("Not yet implemented");
 153   }
 154
 155
 156   // Methode pour le controle des jobs : modifie un job en file d'attente
 157   void BatchManager_ePBS::alterJob(const JobId & jobid, const Parametre & param, const Environnement & env)
 158   {
 159     throw EmulationException("Not yet implemented");
 160   }
 161
 162   // Methode pour le controle des jobs : modifie un job en file d'attente
 163   void BatchManager_ePBS::alterJob(const JobId & jobid, const Parametre & param)
 164   {
 165     alterJob(jobid, param, Environnement());
 166   }
 167
 168   // Methode pour le controle des jobs : modifie un job en file d'attente
 169   void BatchManager_ePBS::alterJob(const JobId & jobid, const Environnement & env)
 170   {
 171     alterJob(jobid, Parametre(), env);
 172   }
 173
 174   // Methode pour le controle des jobs : renvoie l'etat du job
 175   JobInfo BatchManager_ePBS::queryJob(const JobId & jobid)
 176   {
 177     int id;
 178     istringstream iss(jobid.getReference());
 179     iss >> id;
 180
 181     // define name of log file (local)
 182     string logFile = generateTemporaryFileName(string("PBS-querylog-id") + jobid.getReference());
 183
 184     // define command to query batch
 185     string subCommand = string("qstat -f ") + iss.str();
 186     string command = _protocol.getExecCommand(subCommand, _hostname, _username);
 187     command += " > ";
 188     command += logFile;
 189     cerr << command.c_str() << endl;
 190     int status = system(command.c_str());
 191     if(status && status != 153 && status != 256*153)
 192       throw EmulationException("Error of connection on remote host");
 193
 194     JobInfo_ePBS ji = JobInfo_ePBS(id,logFile);
 195     return ji;
 196   }
 197
 198   // Methode pour le controle des jobs : teste si un job est present en machine
 199   bool BatchManager_ePBS::isRunning(const JobId & jobid)
 200   {
 201     throw EmulationException("Not yet implemented");
 202   }
 203
 204   void BatchManager_ePBS::buildBatchScript(const Job & job)
 205   {
 206     std::cerr << "BuildBatchScript" << std::endl;
 207     Parametre params = job.getParametre();
 208     Environnement env = job.getEnvironnement();
 209
 210     // Job Parameters
 211     string workDir       = "";
 212     string fileToExecute = "";
 213     int nbproc           = 0;
 214     int edt              = 0;
 215     int mem              = 0;
 216     string queue         = "";
 217
 218     // Mandatory parameters
 219     if (params.find(WORKDIR) != params.end())
 220       workDir = params[WORKDIR].str();
 221     else
 222       throw EmulationException("params[WORKDIR] is not defined ! Please defined it, cannot submit this job");
 223     if (params.find(EXECUTABLE) != params.end())
 224       fileToExecute = params[EXECUTABLE].str();
 225     else
 226       throw EmulationException("params[EXECUTABLE] is not defined ! Please defined it, cannot submit this job");
 227
 228     // Optional parameters
 229     if (params.find(NBPROC) != params.end())
 230       nbproc = params[NBPROC];
 231     if (params.find(MAXWALLTIME) != params.end())
 232       edt = params[MAXWALLTIME];
 233     if (params.find(MAXRAMSIZE) != params.end())
 234       mem = params[MAXRAMSIZE];
 235     if (params.find(QUEUE) != params.end())
 236       queue = params[QUEUE].str();
 237
 238     string::size_type p1 = fileToExecute.find_last_of("/");
 239     string::size_type p2 = fileToExecute.find_last_of(".");
 240     string rootNameToExecute = fileToExecute.substr(p1+1,p2-p1-1);
 241     string fileNameToExecute = fileToExecute.substr(p1+1);
 242
 243     // Create batch submit file
 244     ofstream tempOutputFile;
 245     std::string TmpFileName = createAndOpenTemporaryFile("PBS-script", tempOutputFile);
 246
 247     tempOutputFile << "#! /bin/sh -f" << endl;
 248     if (nbproc > 0)
 249     {
 250       // Division - arrondi supérieur
 251       int nodes_requested = (nbproc + _nb_proc_per_node -1) / _nb_proc_per_node;
 252       tempOutputFile << "#PBS -l nodes=" << nodes_requested << ":ppn=" << _nb_proc_per_node << endl;
 253     }
 254     if (queue != "")
 255       tempOutputFile << "#PBS -q " << queue << endl;
 256     if( edt > 0 )
 257       tempOutputFile << "#PBS -l walltime=" << edt*60 << endl;
 258     if( mem > 0 )
 259       tempOutputFile << "#PBS -l mem=" << mem << "MB" << endl;
 260     tempOutputFile << "#PBS -o " << workDir << "/logs/output.log." << rootNameToExecute << endl;
 261     tempOutputFile << "#PBS -e " << workDir << "/logs/error.log."  << rootNameToExecute << endl;
 262
 263     // Define environment for the job
 264     if (!env.empty()) {
 265       tempOutputFile << "#PBS -v ";
 266       Environnement::const_iterator iter;
 267       for (iter = env.begin() ; iter != env.end() ; ++iter) {
 268         tempOutputFile << iter->first << "=" << iter->second << ",";
 269       }
 270       tempOutputFile << endl;
 271     }
 272
 273     // Abstraction of PBS_NODEFILE - TODO
 274     tempOutputFile << "export LIBBATCH_NODEFILE=$PBS_NODEFILE" << endl;
 275
 276     // Launch the executable
 277     tempOutputFile << "cd " << workDir << endl;
 278     tempOutputFile << "./" + fileNameToExecute << endl;
 279     tempOutputFile.flush();
 280     tempOutputFile.close();
 281
 282     BATCH_CHMOD(TmpFileName.c_str(), 0x1ED);
 283     cerr << "Batch script file generated is: " << TmpFileName.c_str() << endl;
 284
 285     int status = _protocol.copyFile(TmpFileName, "", "",
 286                                     workDir + "/" + rootNameToExecute + "_Batch.sh",
 287                                     _hostname, _username);
 288     if (status)
 289       throw EmulationException("Error of connection on remote host, cannot copy batch submission file");
 290   }
 291 }