Salome HOME
Merged from BR_AR
[tools/libbatch.git] / src / SGE / Batch_BatchManager_eSGE.cxx
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_eSGE.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 #include <sys/stat.h>
39
40 #include <stdlib.h>
41 #include <string.h>
42
43 #ifdef WIN32
44 #include <io.h>
45 #else
46 #include <libgen.h>
47 #endif
48
49 #include "Batch_BatchManager_eSGE.hxx"
50 #include "Batch_JobInfo_eSGE.hxx"
51
52 using namespace std;
53
54 namespace Batch {
55
56   BatchManager_eSGE::BatchManager_eSGE(const FactBatchManager * parent, const char * host,
57                                        CommunicationProtocolType protocolType, const char * mpiImpl)
58   : BatchManager_eClient(parent, host, protocolType, mpiImpl),
59     BatchManager(parent, host)
60   {
61     // Nothing to do
62   }
63
64   // Destructeur
65   BatchManager_eSGE::~BatchManager_eSGE()
66   {
67     // Nothing to do
68   }
69
70   // Methode pour le controle des jobs : soumet un job au gestionnaire
71   const JobId BatchManager_eSGE::submitJob(const Job & job)
72   {
73     int status;
74     Parametre params = job.getParametre();
75     const std::string workDir = params[WORKDIR];
76     const string fileToExecute = params[EXECUTABLE];
77     string::size_type p1 = fileToExecute.find_last_of("/");
78     string::size_type p2 = fileToExecute.find_last_of(".");
79     std::string fileNameToExecute = fileToExecute.substr(p1+1,p2-p1-1);
80
81     // export input files on cluster
82     exportInputFiles(job);
83
84     // build batch script for job
85     buildBatchScript(job);
86
87     // define name of log file (local)
88     string logFile = generateTemporaryFileName("SGE-submitlog");
89
90     // define command to submit batch
91     string subCommand = string("cd ") + workDir + "; qsub " + fileNameToExecute + "_Batch.sh";
92     string command = _protocol.getExecCommand(subCommand, _hostname, _username);
93     command += " > ";
94     command += logFile;
95     command += " 2>&1";
96     cerr << command.c_str() << endl;
97     status = system(command.c_str());
98     if(status)
99     {
100       ifstream error_message(logFile.c_str());
101       std::string mess;
102       std::string temp;
103       while(std::getline(error_message, temp))
104         mess += temp;
105       error_message.close();
106       throw EmulationException("Error of connection on remote host, error was: " + mess);
107     }
108
109     // read id of submitted job in log file
110     char line[128];
111     FILE *fp = fopen(logFile.c_str(),"r");
112     fgets( line, 128, fp);
113     fclose(fp);
114
115     string strjob;
116     istringstream iss(line);
117     iss >> strjob >> strjob >> strjob;
118
119     JobId id(this, strjob);
120     return id;
121   }
122
123   // Methode pour le controle des jobs : retire un job du gestionnaire
124   void BatchManager_eSGE::deleteJob(const JobId & jobid)
125   {
126     int status;
127     int ref;
128     istringstream iss(jobid.getReference());
129     iss >> ref;
130
131     // define command to delete batch
132     string subCommand = string("qdel ") + iss.str();
133     string command = _protocol.getExecCommand(subCommand, _hostname, _username);
134     cerr << command.c_str() << endl;
135     status = system(command.c_str());
136     if(status)
137       throw EmulationException("Error of connection on remote host");
138
139     cerr << "jobId = " << ref << "killed" << endl;
140   }
141
142   // Methode pour le controle des jobs : suspend un job en file d'attente
143   void BatchManager_eSGE::holdJob(const JobId & jobid)
144   {
145     throw EmulationException("Not yet implemented");
146   }
147
148   // Methode pour le controle des jobs : relache un job suspendu
149   void BatchManager_eSGE::releaseJob(const JobId & jobid)
150   {
151     throw EmulationException("Not yet implemented");
152   }
153
154
155   // Methode pour le controle des jobs : modifie un job en file d'attente
156   void BatchManager_eSGE::alterJob(const JobId & jobid, const Parametre & param, const Environnement & env)
157   {
158     throw EmulationException("Not yet implemented");
159   }
160
161   // Methode pour le controle des jobs : modifie un job en file d'attente
162   void BatchManager_eSGE::alterJob(const JobId & jobid, const Parametre & param)
163   {
164     alterJob(jobid, param, Environnement());
165   }
166
167   // Methode pour le controle des jobs : modifie un job en file d'attente
168   void BatchManager_eSGE::alterJob(const JobId & jobid, const Environnement & env)
169   {
170     alterJob(jobid, Parametre(), env);
171   }
172
173   // Methode pour le controle des jobs : renvoie l'etat du job
174   JobInfo BatchManager_eSGE::queryJob(const JobId & jobid)
175   {
176     int id;
177     istringstream iss(jobid.getReference());
178     iss >> id;
179
180     // define name of log file (local)
181     string logFile = generateTemporaryFileName(string("SGE-querylog-id") + jobid.getReference());
182
183     // define command to query batch
184     string subCommand = string("qstat | grep ") + iss.str();
185     string command = _protocol.getExecCommand(subCommand, _hostname, _username);
186     command += " > ";
187     command += logFile;
188     cerr << command.c_str() << endl;
189     int status = system(command.c_str());
190     if (status && status != 256)
191       throw EmulationException("Error of connection on remote host");
192
193     JobInfo_eSGE ji = JobInfo_eSGE(id,logFile);
194     return ji;
195   }
196
197   // Methode pour le controle des jobs : teste si un job est present en machine
198   bool BatchManager_eSGE::isRunning(const JobId & jobid)
199   {
200     throw EmulationException("Not yet implemented");
201   }
202
203   void BatchManager_eSGE::buildBatchScript(const Job & job)
204   {
205 #ifndef WIN32
206     //TODO porting on Win32 platform
207     std::cerr << "BuildBatchScript" << std::endl;
208     Parametre params = job.getParametre();
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("SGE-script", tempOutputFile);
246
247     tempOutputFile << "#! /bin/sh -f" << endl;
248     if (queue != "")
249       tempOutputFile << "#$ -q " << queue << endl;
250     tempOutputFile << "#$ -pe mpich " << nbproc << endl;
251     if( edt > 0 )
252       tempOutputFile << "#$ -l h_rt=" << getWallTime(edt) << endl ;
253     if( mem > 0 )
254       tempOutputFile << "#$ -l h_vmem=" << mem << "M" << endl ;
255     tempOutputFile << "#$ -o " << workDir << "/logs/output.log." << rootNameToExecute << endl ;
256     tempOutputFile << "#$ -e " << workDir << "/logs/error.log." << rootNameToExecute << endl ;
257
258     // Abstraction of PBS_NODEFILE - TODO
259     tempOutputFile << "export LIBBATCH_NODEFILE=$TMPDIR/machines" << endl;
260
261     // Launch the executable
262     tempOutputFile << "cd " << workDir << endl ;
263     tempOutputFile << "./" + fileNameToExecute << endl;
264     tempOutputFile.flush();
265     tempOutputFile.close();
266
267     BATCH_CHMOD(TmpFileName.c_str(), 0x1ED);
268     cerr << "Batch script file generated is: " << TmpFileName.c_str() << endl;
269
270     int status = _protocol.copyFile(TmpFileName, "", "",
271                                     workDir + "/" + rootNameToExecute + "_Batch.sh",
272                                     _hostname, _username);
273     if (status)
274       throw EmulationException("Error of connection on remote host");
275
276 #endif //WIN32
277   }
278
279   std::string BatchManager_eSGE::getWallTime(const long edt)
280   {
281     long h, m;
282     h = edt / 60;
283     m = edt - h*60;
284     ostringstream oss;
285     if( m >= 10 )
286       oss << h << ":" << m;
287     else
288       oss << h << ":0" << m;
289     return oss.str();
290   }
291
292 }