1 // Copyright (C) 2007-2008 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 * BatchManager_eLSF.cxx : emulation of LSF client
25 * Auteur : Bernard SECHER - CEA DEN
26 * Mail : mailto:bernard.secher@cea.fr
27 * Date : Thu Apr 24 10:17:22 2008
32 #include "Batch_BatchManager_eClient.hxx"
33 #include "Batch_RunTimeException.hxx"
45 #include "Batch_config.h"
48 #define EXISTS(path) _access_s(path, 0) == 0
50 #define EXISTS(path) access(path, F_OK) == 0
58 BatchManager_eClient::BatchManager_eClient(const Batch::FactBatchManager * parent, const char* host,
59 const char* protocol, const char* mpiImpl)
60 : BatchManager(parent, host), _protocol(protocol), _username("")
62 // instanciation of mpi implementation needed to launch executable in batch script
63 _mpiImpl = FactoryMpiImpl(mpiImpl);
67 BatchManager_eClient::~BatchManager_eClient()
73 void BatchManager_eClient::exportInputFiles(const Job& job)
76 Parametre params = job.getParametre();
77 Versatile V = params[INFILE];
78 Versatile::iterator Vit;
79 _username = string(params[USER]);
81 string command = "\"";
82 string copy_command = "\"";
85 if( _protocol == "rsh" ) {
88 } else if( _protocol == "ssh" ) {
92 throw EmulationException("Unknown protocol : only rsh and ssh are known !");
95 copy_command += "\" ";
97 // First step : creating batch tmp files directory
99 command += _username + "@";
101 command += _hostname;
102 command += " mkdir -p ";
103 command += string(params[TMPDIR]);
104 cerr << command.c_str() << endl;
105 status = system(command.c_str());
107 std::ostringstream oss;
109 std::string ex_mess("Error of connection on remote host ! status = ");
110 ex_mess += oss.str();
111 throw EmulationException(ex_mess.c_str());
114 // Second step : copy fileToExecute into
115 // batch tmp files directory
116 string executeFile = params[EXECUTABLE];
117 if( executeFile.size() > 0 ){
118 command = copy_command;
119 command += string(params[EXECUTABLE]);
122 command += _username;
125 command += _hostname;
127 command += string(params[TMPDIR]);
128 cerr << command.c_str() << endl;
129 status = system(command.c_str());
131 std::ostringstream oss;
133 std::string ex_mess("Error of connection on remote host ! status = ");
134 ex_mess += oss.str();
135 throw EmulationException(ex_mess.c_str());
139 // On Windows, we make the remote file executable afterward because pscp does not preserve
140 // access permissions on files
142 if( _protocol == "rsh" ) {
144 } else if( _protocol == "ssh" ) {
147 throw EmulationException("Unknown protocol : only rsh and ssh are known !");
151 command += _username + "@";
153 command += _hostname;
154 command += " chmod u+x ";
155 command += string(params[TMPDIR]) + "/" + string(params[EXECUTABLE]);
156 cerr << command.c_str() << endl;
157 status = system(command.c_str());
159 std::ostringstream oss;
161 std::string ex_mess("Error of connection on remote host ! status = ");
162 ex_mess += oss.str();
163 throw EmulationException(ex_mess.c_str());
168 // Third step : copy filesToExportList into
169 // batch tmp files directory
170 for(Vit=V.begin(); Vit!=V.end(); Vit++) {
171 CoupleType cpt = *static_cast< CoupleType * >(*Vit);
172 Couple inputFile = cpt;
173 command = copy_command;
174 command += inputFile.getLocal();
177 command += _username;
180 command += _hostname;
182 command += inputFile.getRemote();
183 cerr << command.c_str() << endl;
184 status = system(command.c_str());
186 std::ostringstream oss;
188 std::string ex_mess("Error of connection on remote host ! status = ");
189 ex_mess += oss.str();
190 throw EmulationException(ex_mess.c_str());
196 void BatchManager_eClient::importOutputFiles( const Job & job, const string directory ) throw(EmulationException)
200 Parametre params = job.getParametre();
201 Versatile V = params[OUTFILE];
202 Versatile::iterator Vit;
204 for(Vit=V.begin(); Vit!=V.end(); Vit++) {
205 CoupleType cpt = *static_cast< CoupleType * >(*Vit);
206 Couple outputFile = cpt;
208 string command = "\"";
211 if( _protocol == "rsh" ) {
213 } else if( _protocol == "ssh" ) {
216 throw EmulationException("Unknown protocol : only rsh and ssh are known !");
220 if (_username != ""){
221 command += _username;
224 command += _hostname;
226 command += outputFile.getRemote();
228 command += directory;
229 cerr << command.c_str() << endl;
230 status = system(command.c_str());
233 // Try to get what we can (logs files)
234 // throw BatchException("Error of connection on remote host");
235 std::string mess("Copy command failed ! status is :");
236 ostringstream status_str;
237 status_str << status;
238 mess += status_str.str();
239 cerr << mess << endl;
245 MpiImpl *BatchManager_eClient::FactoryMpiImpl(string mpiImpl) throw(EmulationException)
248 return new MpiImpl_LAM();
249 else if(mpiImpl == "mpich1")
250 return new MpiImpl_MPICH1();
251 else if(mpiImpl == "mpich2")
252 return new MpiImpl_MPICH2();
253 else if(mpiImpl == "openmpi")
254 return new MpiImpl_OPENMPI();
255 else if(mpiImpl == "slurm")
256 return new MpiImpl_SLURM();
257 else if(mpiImpl == "prun")
258 return new MpiImpl_PRUN();
259 else if(mpiImpl == "nompi")
260 throw EmulationException("you must specify an mpi implementation for batch manager");
263 oss << mpiImpl << " : not yet implemented";
264 throw EmulationException(oss.str().c_str());
269 * This method generates a temporary file name with the pattern "<tmpdir>/<prefix>-XXXXXX" where
270 * <tmpdir> is the directory for temporary files (see BatchManager_eClient::getTmpDir()) and the
271 * X's are replaced by random characters. Note that this method is less secure than
272 * BatchManager_eClient::createAndOpenTemporaryFile, so use the latter whenever possible.
273 * \param prefix the prefix to use for the temporary file.
274 * \return a name usable for a temporary file.
276 string BatchManager_eClient::generateTemporaryFileName(const string & prefix)
278 string fileName = getTmpDir() + "/" + prefix + "-XXXXXX";
282 sprintf(randstr, "%06d", rand() % 1000000);
283 fileName.replace(fileName.size()-6, 6, randstr);
284 } while (EXISTS(fileName.c_str()));
290 * This method creates a temporary file and opens an output stream to write into this file.
291 * The file is created with the pattern "<tmpdir>/<prefix>-XXXXXX" where <tmpdir> is the directory
292 * for temporary files (see BatchManager_eClient::getTmpDir()) and the X's are replaced by random
293 * characters. The caller is responsible for closing and deleting the file when it is no more used.
294 * \param prefix the prefix to use for the temporary file.
295 * \param outputStream an output stream that will be opened for writing in the temporary file. If
296 * the stream is already open, it will be closed first.
297 * \return the name of the created file.
299 string BatchManager_eClient::createAndOpenTemporaryFile(const string & prefix, ofstream & outputStream)
301 if (outputStream.is_open())
302 outputStream.close();
306 string fileName = generateTemporaryFileName(prefix);
307 outputStream.open(fileName.c_str());
311 string fileName = getTmpDir() + "/" + prefix + "-XXXXXX";
312 char buf[fileName.size()+1];
313 fileName.copy(buf, fileName.size());
314 buf[fileName.size()] = '\0';
316 int fd = mkstemp(buf);
318 throw RunTimeException(string("Can't create temporary file ") + fileName);
321 outputStream.open(fileName.c_str());
322 close(fd); // Close the file descriptor so that the file is not opened twice
326 if (outputStream.fail())
327 throw RunTimeException(string("Can't open temporary file ") + fileName);
333 * This method finds the name of the directory to use for temporary files in libBatch. This name
334 * is <tempdir>/libBatch-<username>-XXXXXX. <tempdir> is found by looking for environment
335 * variables TEMP, TMP, TEMPDIR, TMPDIR, and defaults to "/tmp" if none of them is defined.
336 * <username> is found by looking for environment variables USER and USERNAME, and defaults to
337 * "unknown". XXXXXX represents random characters. The directory name is generated only once for
338 * each BatchManager_eClient instance, and the directory is created at this moment. Subsequent
339 * calls will always return the same path and the existence of the directory will not be
341 * \return the name of the directory to use for temporary files.
343 const std::string & BatchManager_eClient::getTmpDir()
345 if (tmpDirName.empty()) {
346 char * baseDir = getenv("TEMP");
347 if (baseDir == NULL) baseDir = getenv("TMP");
348 if (baseDir == NULL) baseDir = getenv("TEMPDIR");
349 if (baseDir == NULL) baseDir = getenv("TMPDIR");
350 if (baseDir == NULL) baseDir = "/tmp";
352 char * userName = getenv("USER");
353 if (userName == NULL) userName = getenv("USERNAME");
354 if (userName == NULL) userName = "unknown";
356 string baseName = string(baseDir) + "/libBatch-" + userName + "-XXXXXX";
363 sprintf(randstr, "%06d", rand() % 1000000);
364 baseName.replace(baseName.size()-6, 6, randstr);
365 } while (EXISTS(baseName.c_str()));
366 if (_mkdir(baseName.c_str()) != 0)
367 throw RunTimeException(string("Can't create temporary directory ") + baseName);
368 tmpDirName = baseName;
372 char buf[baseName.size()+1];
373 baseName.copy(buf, baseName.size());
374 buf[baseName.size()] = '\0';
375 if (mkdtemp(buf) == NULL)
376 throw RunTimeException(string("Can't create temporary directory ") + baseName);