src/Vishnu/BatchManager_Vishnu.cxx

   1 //  Copyright (C) 2007-2013  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_Vishnu.cxx :
  24  *
  25  *  Created on: 24 june 2011
  26  *  Author : Renaud BARATE - EDF R&D
  27  */
  28
  29 #ifndef WIN32
  30 #include <unistd.h>
  31 #endif
  32
  33 #include <cstdlib>
  34 #include <iostream>
  35 #include <fstream>
  36 #include <sstream>
  37
  38 #include <Constants.hxx>
  39 #include <Utils.hxx>
  40
  41 #include "BatchManager_Vishnu.hxx"
  42 #include "JobInfo_Vishnu.hxx"
  43 #include "Log.hxx"
  44
  45 using namespace std;
  46
  47 namespace Batch {
  48
  49   BatchManager_Vishnu::BatchManager_Vishnu(const FactBatchManager * parent,
  50                                              const char * host,
  51                                              const char * username,
  52                                              CommunicationProtocolType protocolType,
  53                                              const char * mpiImpl)
  54     : // Force SH protocol for Vishnu
  55       BatchManager(parent, host, username, SH, mpiImpl)
  56   {
  57   }
  58
  59   BatchManager_Vishnu::~BatchManager_Vishnu()
  60   {
  61   }
  62
  63   // Method to submit a job to the batch manager
  64   const JobId BatchManager_Vishnu::submitJob(const Job & job)
  65   {
  66     // export input files on cluster
  67     exportInputFiles(job);
  68
  69     // build command file to submit the job
  70     string cmdFile = buildCommandFile(job);
  71
  72     // define extra parameters (that can not be defined in the command file)
  73     Parametre params = job.getParametre();
  74     ostringstream extraParams;
  75     if (params.find(NBPROC) != params.end())
  76       extraParams << "-P " << params[NBPROC] << " ";
  77     if (params.find(MAXRAMSIZE) != params.end())
  78       extraParams << "-m " << params[MAXRAMSIZE] << " ";
  79
  80     // define command to submit batch
  81     string subCommand = string("export OMNIORB_CONFIG=$VISHNU_CONFIG_FILE; ");
  82     subCommand += "vishnu_connect && ";
  83     subCommand += "vishnu_submit_job " + extraParams.str() + _hostname + " " + cmdFile + " && ";
  84     subCommand += "vishnu_close";
  85     string command = _protocol.getExecCommand(subCommand, _hostname, _username);
  86     command += " 2>&1";
  87     LOG(command);
  88
  89     // submit job
  90     string output;
  91     int status = Utils::getCommandOutput(command, output);
  92     LOG(output);
  93     if (status != 0) throw RunTimeException("Can't submit job, error was: " + output);
  94
  95     // find id of submitted job in output
  96     string search = "Job Id     : ";
  97     string::size_type pos = output.find(search);
  98     if (pos == string::npos)
  99       throw RunTimeException("Error in the submission of the job on the remote host");
 100     pos += search.size();
 101     string::size_type endl_pos = output.find('\n', pos);
 102     string::size_type count = (endl_pos == string::npos)? string::npos : endl_pos - pos;
 103     string jobref = output.substr(pos, count);
 104     if (jobref.size() == 0)
 105       throw RunTimeException("Error in the submission of the job on the remote host");
 106
 107     JobId id(this, jobref);
 108     return id;
 109   }
 110
 111
 112   void BatchManager_Vishnu::exportInputFiles(const Job& job)
 113   {
 114     Parametre params = job.getParametre();
 115     string subCommand = string("export OMNIORB_CONFIG=$VISHNU_CONFIG_FILE; ");
 116     subCommand += "vishnu_connect && ";
 117
 118     // create remote directories
 119     subCommand += "vishnu_create_dir -p " + _hostname + ":" + params[WORKDIR].str() + "/logs && ";
 120
 121     // copy executable
 122     string executeFile = params[EXECUTABLE];
 123     if (executeFile.size() != 0) {
 124       subCommand += "vishnu_copy_file " + executeFile + " " +
 125                     _hostname + ":" + params[WORKDIR].str() + "/ && ";
 126     }
 127
 128     // copy filesToExportList
 129     const Versatile & V = params[INFILE];
 130     Versatile::const_iterator Vit;
 131     for (Vit=V.begin(); Vit!=V.end(); Vit++) {
 132       CoupleType cpt  = *static_cast< CoupleType * >(*Vit);
 133       Couple inputFile = cpt;
 134
 135       // Get absolute paths
 136       char * buf = getcwd(NULL, 0);
 137       string cwd = buf;
 138       free(buf);
 139
 140       string absremote = (Utils::isAbsolutePath(inputFile.getRemote()))?
 141                          inputFile.getRemote() :
 142                          params[WORKDIR].str() + "/" + inputFile.getRemote();
 143       string abslocal = (Utils::isAbsolutePath(inputFile.getLocal()))?
 144                         inputFile.getLocal() :
 145                         cwd + "/" + inputFile.getLocal();
 146
 147       if (Vit != V.begin())
 148         subCommand += " && ";
 149       subCommand += "vishnu_copy_file " + abslocal + " " + _hostname + ":" + absremote;
 150     }
 151     subCommand += " && vishnu_close";
 152
 153     // Execute command
 154     string command = _protocol.getExecCommand(subCommand, _hostname, _username);
 155     command += " 2>&1";
 156     LOG(command);
 157     string output;
 158     int status = Utils::getCommandOutput(command, output);
 159     LOG(output);
 160     if (status != 0)
 161       throw RunTimeException("Can't copy input files, error was: " + output);
 162   }
 163
 164   /**
 165    * Create Vishnu command file and copy it on the server.
 166    * Return the name of the remote file.
 167    */
 168   string BatchManager_Vishnu::buildCommandFile(const Job & job)
 169   {
 170     Parametre params = job.getParametre();
 171
 172     // Job Parameters
 173     string workDir = "";
 174     string fileToExecute = "";
 175     string queue = "";
 176
 177     // Mandatory parameters
 178     if (params.find(WORKDIR) != params.end())
 179       workDir = params[WORKDIR].str();
 180     else
 181       throw RunTimeException("params[WORKDIR] is not defined. Please define it, cannot submit this job.");
 182     if (params.find(EXECUTABLE) != params.end())
 183       fileToExecute = params[EXECUTABLE].str();
 184     else
 185       throw RunTimeException("params[EXECUTABLE] is not defined. Please define it, cannot submit this job.");
 186
 187     string::size_type p1 = fileToExecute.find_last_of("/");
 188     string::size_type p2 = fileToExecute.find_last_of(".");
 189     string rootNameToExecute = fileToExecute.substr(p1+1,p2-p1-1);
 190     string fileNameToExecute = fileToExecute.substr(p1+1);
 191
 192     // Create batch submit file
 193     ofstream tempOutputFile;
 194     string tmpFileName = Utils::createAndOpenTemporaryFile("vishnu-script", tempOutputFile);
 195
 196     tempOutputFile << "#!/bin/sh" << endl;
 197     tempOutputFile << "#% vishnu_output=" << workDir << "/logs/output.log." << rootNameToExecute << endl;
 198     tempOutputFile << "#% vishnu_rror=" << workDir << "/logs/error.log." << rootNameToExecute << endl;
 199
 200     if (params.find(NAME) != params.end())
 201       tempOutputFile << "#% vishnu_job_name=\"" << params[NAME] << "\"" << endl;
 202
 203     // Optional parameters
 204     if (params.find(MAXWALLTIME) != params.end()) {
 205       long totalMinutes = params[MAXWALLTIME];
 206       long h = totalMinutes / 60;
 207       long m = totalMinutes - h * 60;
 208       tempOutputFile << "#% vishnu_wallclocklimit=" << h << ":";
 209       if (m < 10)
 210         tempOutputFile << "0";
 211       tempOutputFile << m << ":00" << endl;
 212     }
 213     if (params.find(QUEUE) != params.end())
 214       tempOutputFile << "#% vishnu_queue=" << params[QUEUE] << endl;
 215
 216     // Define environment for the job
 217     Environnement env = job.getEnvironnement();
 218     for (Environnement::const_iterator iter = env.begin() ; iter != env.end() ; ++iter) {
 219       tempOutputFile << "export " << iter->first << "=" << iter->second << endl;
 220     }
 221
 222     // Node file
 223     tempOutputFile << "export LIBBATCH_NODEFILE=$VISHNU_BATCHJOB_NODEFILE" << endl;
 224
 225     // Launch the executable
 226     tempOutputFile << "cd " << workDir << endl;
 227     tempOutputFile << "./" + fileNameToExecute;
 228     if (params.find(ARGUMENTS) != params.end()) {
 229       Versatile V = params[ARGUMENTS];
 230       for(Versatile::const_iterator it=V.begin(); it!=V.end(); it++) {
 231         StringType argt = * static_cast<StringType *>(*it);
 232         string     arg  = argt;
 233         tempOutputFile << " " << arg;
 234       }
 235     }
 236     tempOutputFile << endl;
 237
 238     tempOutputFile.flush();
 239     tempOutputFile.close();
 240
 241     LOG("Batch script file generated is: " << tmpFileName);
 242     return tmpFileName;
 243   }
 244
 245   void BatchManager_Vishnu::deleteJob(const JobId & jobid)
 246   {
 247     // define command to delete job
 248     string subCommand = string("export OMNIORB_CONFIG=$VISHNU_CONFIG_FILE; ");
 249     subCommand += "vishnu_connect && ";
 250     subCommand += "vishnu_cancel_job " + _hostname + " " + jobid.getReference() + " && ";
 251     subCommand += "vishnu_close";
 252     string command = _protocol.getExecCommand(subCommand, _hostname, _username);
 253     LOG(command);
 254
 255     int status = system(command.c_str());
 256     if (status)
 257       throw RunTimeException("Can't delete job " + jobid.getReference());
 258
 259     LOG("job " << jobid.getReference() << " killed");
 260   }
 261
 262   JobInfo BatchManager_Vishnu::queryJob(const JobId & jobid)
 263   {
 264     // define command to query batch
 265     string subCommand = string("export OMNIORB_CONFIG=$VISHNU_CONFIG_FILE; ");
 266     subCommand += "vishnu_connect && ";
 267     subCommand += "vishnu_get_job_info " + _hostname + " " + jobid.getReference() + " && ";
 268     subCommand += "vishnu_close";
 269     string command = _protocol.getExecCommand(subCommand, _hostname, _username);
 270     LOG(command);
 271
 272     string output;
 273     int status = Utils::getCommandOutput(command, output);
 274     if (status != 0)
 275       throw RunTimeException("Can't query job " + jobid.getReference());
 276     JobInfo_Vishnu jobinfo = JobInfo_Vishnu(jobid.getReference(), output);
 277     return jobinfo;
 278   }
 279
 280   void BatchManager_Vishnu::importOutputFiles(const Job & job, const std::string directory)
 281   {
 282     // Create local result directory
 283     char * buf = getcwd(NULL, 0);
 284     string cwd = buf;
 285     free(buf);
 286     string absdir = (Utils::isAbsolutePath(directory))? directory : cwd + "/" + directory;
 287     int status = CommunicationProtocol::getInstance(SH).makeDirectory(absdir, "", "");
 288     if (status != 0) {
 289       throw RunTimeException("Can't create result directory");
 290     }
 291
 292     string subCommand = string("export OMNIORB_CONFIG=$VISHNU_CONFIG_FILE; ");
 293     subCommand += "vishnu_connect && ";
 294
 295     // Copy output files
 296     Parametre params = job.getParametre();
 297     const Versatile & V = params[OUTFILE];
 298     Versatile::const_iterator Vit;
 299     for (Vit=V.begin(); Vit!=V.end(); Vit++) {
 300       CoupleType cpt  = *static_cast< CoupleType * >(*Vit);
 301       Couple outputFile = cpt;
 302
 303       // Get absolute paths
 304       string absremote = (Utils::isAbsolutePath(outputFile.getRemote()))?
 305                          outputFile.getRemote() :
 306                          params[WORKDIR].str() + "/" + outputFile.getRemote();
 307       string abslocal = (Utils::isAbsolutePath(outputFile.getLocal()))?
 308                         outputFile.getLocal() :
 309                         absdir + "/" + outputFile.getLocal();
 310
 311       subCommand += "vishnu_copy_file " + _hostname + ":" + absremote + " " + abslocal + " && ";
 312     }
 313
 314     // Copy logs
 315     subCommand += "vishnu_copy_file -r " +_hostname + ":" + params[WORKDIR].str() + "/logs" + " " + absdir + " && ";
 316     subCommand += "vishnu_close";
 317
 318     // Execute command
 319     string command = _protocol.getExecCommand(subCommand, _hostname, _username);
 320     command += " 2>&1";
 321     LOG(command);
 322     string output;
 323     status = Utils::getCommandOutput(command, output);
 324     LOG(output);
 325     if (status != 0)
 326       throw RunTimeException("Can't import output files, error was: " + output);
 327   }
 328
 329 }