Salome HOME
Build SALOME on win32 platform.
[modules/kernel.git] / src / Launcher / Launcher.cxx
1 // Copyright (C) 2007-2011  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 #ifdef WITH_LIBBATCH
24 #include <Batch/Batch_Date.hxx>
25 #include <Batch/Batch_BatchManagerCatalog.hxx>
26 #include <Batch/Batch_FactBatchManager_eClient.hxx>
27 #include <Batch/Batch_BatchManager_eClient.hxx>
28 #endif
29
30 #include "Basics_Utils.hxx"
31 #include "Basics_DirUtils.hxx"
32 #include "SALOME_Launcher_Handler.hxx"
33 #include "Launcher.hxx"
34 #include "Launcher_Job_Command.hxx"
35 #include <iostream>
36 #include <sstream>
37 #include <sys/stat.h>
38 #include <time.h>
39
40 //=============================================================================
41 /*! 
42  *  Constructor
43  *  \param orb
44  *  Define a CORBA single thread policy for the server, which avoid to deal
45  *  with non thread-safe usage like Change_Directory in SALOME naming service
46  */
47 //=============================================================================
48 Launcher_cpp::Launcher_cpp()
49 {
50   LAUNCHER_MESSAGE("Launcher_cpp constructor");
51   _job_cpt = 0;
52   _job_cpt_mutex = new pthread_mutex_t();
53   pthread_mutex_init(_job_cpt_mutex, NULL);
54 }
55
56 //=============================================================================
57 /*! 
58  * destructor
59  */
60 //=============================================================================
61 Launcher_cpp::~Launcher_cpp()
62 {
63   LAUNCHER_MESSAGE("Launcher_cpp destructor");
64 #ifdef WITH_LIBBATCH
65   std::map<int, Launcher::Job *>::const_iterator it_job;
66   for(it_job = _launcher_job_map.begin(); it_job != _launcher_job_map.end(); it_job++)
67     delete it_job->second;
68   std::map <int, Batch::BatchManager_eClient * >::const_iterator it1;
69   for(it1=_batchmap.begin();it1!=_batchmap.end();it1++)
70     delete it1->second;
71 #endif
72
73   pthread_mutex_destroy(_job_cpt_mutex);
74   delete _job_cpt_mutex;
75 }
76
77 #ifdef WITH_LIBBATCH
78
79 //=============================================================================
80 /*!
81  * Add a job into the launcher - check resource and choose one 
82  */ 
83 //=============================================================================
84 void 
85 Launcher_cpp::createJob(Launcher::Job * new_job)
86 {
87   LAUNCHER_MESSAGE("Creating a new job");
88   // Add job to the jobs map
89   pthread_mutex_lock(_job_cpt_mutex);
90   new_job->setNumber(_job_cpt);
91   _job_cpt++;
92   pthread_mutex_unlock(_job_cpt_mutex);
93   std::map<int, Launcher::Job *>::const_iterator it_job = _launcher_job_map.find(new_job->getNumber());
94   if (it_job == _launcher_job_map.end())
95     _launcher_job_map[new_job->getNumber()] = new_job;
96   else
97   {
98     LAUNCHER_INFOS("A job as already the same id: " << new_job->getNumber());
99     delete new_job;
100     throw LauncherException("A job as already the same id - job is not created !");
101   }
102   LAUNCHER_MESSAGE("New Job created");
103 }
104
105 //=============================================================================
106 /*!
107  * Launch a job 
108  */ 
109 //=============================================================================
110 void 
111 Launcher_cpp::launchJob(int job_id)
112 {
113   LAUNCHER_MESSAGE("Launch a job");
114
115   // Check if job exist
116   std::map<int, Launcher::Job *>::const_iterator it_job = _launcher_job_map.find(job_id);
117   if (it_job == _launcher_job_map.end())
118   {
119     LAUNCHER_INFOS("Cannot find the job, is it created ? job number: " << job_id);
120     throw LauncherException("Cannot find the job, is it created ?");
121   }
122
123   Launcher::Job * job = it_job->second;
124
125   // Check job state (cannot launch a job already launched...)
126   if (job->getState() != "CREATED")
127   {
128     LAUNCHER_INFOS("Bad state of the job: " << job->getState());
129     throw LauncherException("Bad state of the job: " + job->getState());
130   }
131
132   // Third step search batch manager for the job into the map -> instanciate one if does not exist
133 #ifdef WITH_LIBBATCH
134   std::map<int, Batch::BatchManager_eClient *>::const_iterator it = _batchmap.find(job_id);
135   if(it == _batchmap.end())
136   {
137     createBatchManagerForJob(job);
138   }
139 #endif
140
141   try {
142     Batch::JobId batch_manager_job_id = _batchmap[job_id]->submitJob(*(job->getBatchJob()));
143     job->setBatchManagerJobId(batch_manager_job_id);
144     job->setState("QUEUED");
145   }
146   catch(const Batch::EmulationException &ex)
147   {
148     LAUNCHER_INFOS("Job is not launched, exception in submitJob: " << ex.message);
149     throw LauncherException(ex.message.c_str());
150   }
151   LAUNCHER_MESSAGE("Job launched");
152 }
153
154 //=============================================================================
155 /*!
156  * Get job state
157  */ 
158 //=============================================================================
159 const char *
160 Launcher_cpp::getJobState(int job_id)
161 {
162   LAUNCHER_MESSAGE("Get job state");
163
164   // Check if job exist
165   std::map<int, Launcher::Job *>::const_iterator it_job = _launcher_job_map.find(job_id);
166   if (it_job == _launcher_job_map.end())
167   {
168     LAUNCHER_INFOS("Cannot find the job, is it created ? job number: " << job_id);
169     throw LauncherException("Cannot find the job, is it created ?");
170   }
171
172   Launcher::Job * job = it_job->second;
173   std::string state = job->updateJobState();
174
175   return state.c_str();
176 }
177
178 //=============================================================================
179 /*!
180  * Get Job result - the result directory could be changed
181  */ 
182 //=============================================================================
183 void
184 Launcher_cpp::getJobResults(int job_id, std::string directory)
185 {
186   LAUNCHER_MESSAGE("Get Job results");
187
188   // Check if job exist
189   std::map<int, Launcher::Job *>::const_iterator it_job = _launcher_job_map.find(job_id);
190   if (it_job == _launcher_job_map.end())
191   {
192     LAUNCHER_INFOS("Cannot find the job, is it created ? job number: " << job_id);
193     throw LauncherException("Cannot find the job, is it created ?");
194   }
195
196   Launcher::Job * job = it_job->second;
197   std::string resource_name = job->getResourceDefinition().Name;
198   try 
199   {
200     if (directory != "")
201       _batchmap[job_id]->importOutputFiles(*(job->getBatchJob()), directory);
202     else
203       _batchmap[job_id]->importOutputFiles(*(job->getBatchJob()), job->getResultDirectory());
204   }
205   catch(const Batch::EmulationException &ex)
206   {
207     LAUNCHER_INFOS("getJobResult is maybe incomplete, exception: " << ex.message);
208     throw LauncherException(ex.message.c_str());
209   }
210   LAUNCHER_MESSAGE("getJobResult ended");
211 }
212
213 //=============================================================================
214 /*!
215  * Get Job dump state - the result directory could be changed
216  */ 
217 //=============================================================================
218 bool
219 Launcher_cpp::getJobDumpState(int job_id, std::string directory)
220 {
221   bool rtn;
222   LAUNCHER_MESSAGE("Get Job dump state");
223
224   // Check if job exist
225   std::map<int, Launcher::Job *>::const_iterator it_job = _launcher_job_map.find(job_id);
226   if (it_job == _launcher_job_map.end())
227   {
228     LAUNCHER_INFOS("Cannot find the job, is it created ? job number: " << job_id);
229     throw LauncherException("Cannot find the job, is it created ?");
230   }
231
232   Launcher::Job * job = it_job->second;
233   std::string resource_name = job->getResourceDefinition().Name;
234   try 
235   {
236     if (directory != "")
237       rtn = _batchmap[job_id]->importDumpStateFile(*(job->getBatchJob()), directory);
238     else
239       rtn = _batchmap[job_id]->importDumpStateFile(*(job->getBatchJob()), job->getResultDirectory());
240   }
241   catch(const Batch::EmulationException &ex)
242   {
243     LAUNCHER_INFOS("getJobResult is maybe incomplete, exception: " << ex.message);
244     throw LauncherException(ex.message.c_str());
245   }
246   LAUNCHER_MESSAGE("getJobResult ended");
247   return rtn;
248 }
249
250 //=============================================================================
251 /*!
252  * Remove the job - into the Launcher and its batch manager
253  */ 
254 //=============================================================================
255 void
256 Launcher_cpp::removeJob(int job_id)
257 {
258   LAUNCHER_MESSAGE("Remove Job");
259
260   // Check if job exist
261   std::map<int, Launcher::Job *>::iterator it_job = _launcher_job_map.find(job_id);
262   if (it_job == _launcher_job_map.end())
263   {
264     LAUNCHER_INFOS("Cannot find the job, is it created ? job number: " << job_id);
265     throw LauncherException("Cannot find the job, is it created ?");
266   }
267
268   it_job->second->removeJob();
269   delete it_job->second;
270   _launcher_job_map.erase(it_job);
271 }
272
273 //=============================================================================
274 /*!
275  * stop the job
276  */ 
277 //=============================================================================
278 void
279 Launcher_cpp::stopJob(int job_id)
280 {
281   LAUNCHER_MESSAGE("Stop Job");
282
283   // Check if job exist
284   std::map<int, Launcher::Job *>::iterator it_job = _launcher_job_map.find(job_id);
285   if (it_job == _launcher_job_map.end())
286   {
287     LAUNCHER_INFOS("Cannot find the job, is it created ? job number: " << job_id);
288     throw LauncherException("Cannot find the job, is it created ?");
289   }
290
291   it_job->second->stopJob();
292 }
293
294 //=============================================================================
295 /*! 
296  *  create a launcher job based on a file
297  *  \param xmlExecuteFile     : to define the execution on the batch cluster
298  */
299 //=============================================================================
300 long 
301 Launcher_cpp::createJobWithFile(const std::string xmlExecuteFile, 
302                                 const std::string clusterName)
303 {
304   LAUNCHER_MESSAGE("Begin of Launcher_cpp::createJobWithFile");
305
306   // Parsing xml file
307   ParserLauncherType job_params = ParseXmlFile(xmlExecuteFile);
308
309   // Creating a new job
310   Launcher::Job_Command * new_job = new Launcher::Job_Command();
311
312   std::string cmdFile = Kernel_Utils::GetTmpFileName();  
313 #ifndef WIN32
314   cmdFile += ".sh";
315 #else
316   cmdFile += ".bat";
317 #endif
318   std::ofstream os;
319   os.open(cmdFile.c_str(), std::ofstream::out );
320   os << "#! /bin/sh" << std::endl;
321   os << job_params.Command;
322   os.close();
323
324   new_job->setJobFile(cmdFile);
325   new_job->setLocalDirectory(job_params.RefDirectory);
326   new_job->setWorkDirectory(job_params.MachinesList[clusterName].WorkDirectory);
327   new_job->setEnvFile(job_params.MachinesList[clusterName].EnvFile);
328
329   for(int i=0; i < job_params.InputFile.size(); i++)
330     new_job->add_in_file(job_params.InputFile[i]);
331   for(int i=0; i < job_params.OutputFile.size();i++)
332     new_job->add_out_file(job_params.OutputFile[i]);
333
334   resourceParams p;
335   p.hostname = clusterName;
336   p.name = "";
337   p.OS = "";
338   p.nb_proc = job_params.NbOfProcesses;
339   p.nb_node = 0;
340   p.nb_proc_per_node = 0;
341   p.cpu_clock = 0;
342   p.mem_mb = 0;
343   new_job->setResourceRequiredParams(p);
344
345   createJob(new_job);
346   return new_job->getNumber();
347 }
348
349 //=============================================================================
350 /*!
351  *  Factory to instanciate the good batch manager for choosen cluster.
352  */ 
353 //=============================================================================
354 Batch::BatchManager_eClient *
355 Launcher_cpp::FactoryBatchManager(ParserResourcesType& params)
356 {
357   std::string mpi;
358   Batch::CommunicationProtocolType protocol;
359   Batch::FactBatchManager_eClient* fact;
360
361   int nb_proc_per_node = params.DataForSort._nbOfProcPerNode;
362   std::string hostname = params.HostName;
363
364   switch(params.Protocol)
365   {
366     case rsh:
367       protocol = Batch::RSH;
368       break;
369     case ssh:
370       protocol = Batch::SSH;
371       break;
372     default:
373       throw LauncherException("Unknown protocol for this resource");
374       break;
375   }
376
377   switch(params.mpi)
378   {
379     case lam:
380       mpi = "lam";
381       break;
382     case mpich1:
383       mpi = "mpich1";
384       break;
385     case mpich2:
386       mpi = "mpich2";
387       break;
388     case openmpi:
389       mpi = "openmpi";
390       break;
391     case slurmmpi:
392       mpi = "slurmmpi";
393       break;
394     case prun:
395       mpi = "prun";
396       break;
397     default:
398       mpi = "nompi";
399   }
400
401   const char * bmType;
402   switch( params.Batch )
403   {
404     case pbs:
405       bmType = "ePBS";
406       break;
407     case lsf:
408       bmType = "eLSF";
409       break;
410     case sge:
411       bmType = "eSGE";
412       break;
413     case ccc:
414       bmType = "eCCC";
415       break;
416     case slurm:
417       bmType = "eSLURM";
418       break;
419     case ssh_batch:
420       bmType = "eSSH";
421       break;
422     case ll:
423       bmType = "eLL";
424       break;
425     default:
426       LAUNCHER_MESSAGE("Bad batch description of the resource: Batch = " << params.Batch);
427       throw LauncherException("No batchmanager for that cluster - Bad batch description of the resource");
428   }
429   Batch::BatchManagerCatalog & cata = Batch::BatchManagerCatalog::getInstance();
430   fact = dynamic_cast<Batch::FactBatchManager_eClient*>(cata(bmType));
431   if (fact == NULL) {
432     LAUNCHER_MESSAGE("Cannot find batch manager factory for " << bmType << ". Check your version of libBatch.");
433     throw LauncherException("Cannot find batch manager factory");
434   }
435   LAUNCHER_MESSAGE("Instanciation of batch manager of type: " << bmType);
436   Batch::BatchManager_eClient * batch_client = (*fact)(hostname.c_str(), params.UserName.c_str(),
437                                                        protocol, mpi.c_str(), nb_proc_per_node);
438   return batch_client;
439 }
440
441 //----------------------------------------------------------
442 // Without LIBBATCH - Launcher_cpp do nothing...
443 //----------------------------------------------------------
444 #else
445
446 void 
447 Launcher_cpp::createJob(Launcher::Job * new_job)
448 {
449   LAUNCHER_INFOS("Launcher compiled without LIBBATCH - cannot create a job !!!");
450   delete new_job;
451   throw LauncherException("Method Launcher_cpp::createJob is not available "
452                           "(libBatch was not present at compilation time)");
453 }
454
455 void 
456 Launcher_cpp::launchJob(int job_id)
457 {
458   LAUNCHER_INFOS("Launcher compiled without LIBBATCH - cannot launch a job !!!");
459   throw LauncherException("Method Launcher_cpp::launchJob is not available "
460                           "(libBatch was not present at compilation time)");
461 }
462
463 const char *
464 Launcher_cpp::getJobState(int job_id)
465 {
466   LAUNCHER_INFOS("Launcher compiled without LIBBATCH - cannot get job state!!!");
467   throw LauncherException("Method Launcher_cpp::getJobState is not available "
468                           "(libBatch was not present at compilation time)");
469 }
470
471 void
472 Launcher_cpp::getJobResults(int job_id, std::string directory)
473 {
474   LAUNCHER_INFOS("Launcher compiled without LIBBATCH - cannot get job results!!!");
475   throw LauncherException("Method Launcher_cpp::getJobResults is not available "
476                           "(libBatch was not present at compilation time)");
477 }
478
479 bool
480 Launcher_cpp::getJobDumpState(int job_id, std::string directory)
481 {
482   LAUNCHER_INFOS("Launcher compiled without LIBBATCH - cannot get job dump state!!!");
483   throw LauncherException("Method Launcher_cpp::getJobDumpState is not available "
484                           "(libBatch was not present at compilation time)");
485 }
486
487 void
488 Launcher_cpp::removeJob(int job_id)
489 {
490   LAUNCHER_INFOS("Launcher compiled without LIBBATCH - cannot remove job!!!");
491   throw LauncherException("Method Launcher_cpp::removeJob is not available "
492                           "(libBatch was not present at compilation time)");
493 }
494
495 void
496 Launcher_cpp::stopJob(int job_id)
497 {
498   throw LauncherException("Method Launcher_cpp::stopJob is not available "
499                           "(libBatch was not present at compilation time)");
500 }
501
502 long 
503 Launcher_cpp::createJobWithFile( const std::string xmlExecuteFile, std::string clusterName)
504 {
505   throw LauncherException("Method Launcher_cpp::createJobWithFile is not available "
506                           "(libBatch was not present at compilation time)");
507   return 0;
508 }
509
510 #endif
511
512 ParserLauncherType 
513 Launcher_cpp::ParseXmlFile(std::string xmlExecuteFile)
514 {
515   ParserLauncherType job_params;
516   SALOME_Launcher_Handler * handler = new SALOME_Launcher_Handler(job_params);
517
518   const char* aFilePath = xmlExecuteFile.c_str();
519   FILE* aFile = fopen(aFilePath, "r");
520   if (aFile != NULL)
521   {
522     xmlDocPtr aDoc = xmlReadFile(aFilePath, NULL, 0);
523     if (aDoc != NULL)
524       handler->ProcessXmlDocument(aDoc);
525     else
526     {
527       std::string message = "ResourcesManager_cpp: could not parse file: " + xmlExecuteFile;
528       LAUNCHER_MESSAGE(message);
529       delete handler;
530       throw LauncherException(message);
531     }
532     // Free the document
533     xmlFreeDoc(aDoc);
534     fclose(aFile);
535   }
536   else
537   {
538     std::string message = "ResourcesManager_cpp: file is not readable: " + xmlExecuteFile;
539     LAUNCHER_MESSAGE(message);
540     delete handler;
541     throw LauncherException(message);
542   }
543
544   // Return
545   delete handler;
546   return job_params;
547 }
548
549 std::map<int, Launcher::Job *>
550 Launcher_cpp::getJobs()
551 {
552   return _launcher_job_map;
553 }
554
555 void 
556 Launcher_cpp::createBatchManagerForJob(Launcher::Job * job)
557 {
558   int job_id = job->getNumber();
559
560   // Select a ressource for the job
561   std::vector<std::string> ResourceList;
562   resourceParams params = job->getResourceRequiredParams();
563   try
564   {
565     ResourceList = _ResManager->GetFittingResources(params);
566   }
567   catch(const ResourcesException &ex)
568   {
569     throw LauncherException(ex.msg.c_str());
570   }
571   if (ResourceList.size() == 0)
572   {
573     LAUNCHER_INFOS("No adequate resource found for the job, number " << job->getNumber());
574     job->setState("ERROR");
575     throw LauncherException("No resource found the job");
576   }
577
578   // Configure the job with the resource selected - the first of the list
579   ParserResourcesType resource_definition = _ResManager->GetResourcesDescr(ResourceList[0]);
580
581   // Set resource definition to the job
582   // The job will check if the definitions needed
583   try
584   {
585     job->setResourceDefinition(resource_definition);
586   }
587   catch(const LauncherException &ex)
588   {
589     LAUNCHER_INFOS("Error in the definition of the resource, mess: " << ex.msg);
590     job->setState("ERROR");
591     throw ex;
592   }
593
594   // Step 2: We can now add a Factory if the resource is correctly define
595 #ifdef WITH_LIBBATCH
596   std::map<int, Batch::BatchManager_eClient *>::const_iterator it = _batchmap.find(job_id);
597   if(it == _batchmap.end())
598   {
599     try
600     {
601       // Warning cannot write on one line like this, because map object is constructed before
602       // the method is called...
603       //_batchmap[job_id] = FactoryBatchManager(resource_definition);
604       Batch::BatchManager_eClient * batch_client = FactoryBatchManager(resource_definition);
605       _batchmap[job_id] = batch_client;
606     }
607     catch(const LauncherException &ex)
608     {
609       LAUNCHER_INFOS("Error during creation of the batch manager of the job, mess: " << ex.msg);
610       throw ex;
611     }
612     catch(const Batch::EmulationException &ex)
613     {
614       LAUNCHER_INFOS("Error during creation of the batch manager of the job, mess: " << ex.message);
615       throw LauncherException(ex.message);
616     }
617     catch(const Batch::InvalidArgumentException &ex)
618     {
619       LAUNCHER_INFOS("Error during creation of the batch manager of the job, mess: " << ex.message);
620       throw LauncherException(ex.message);
621     }
622   }
623 #endif
624 }
625
626 void 
627 Launcher_cpp::addJobDirectlyToMap(Launcher::Job * new_job, const std::string job_reference)
628 {
629   // Step 0: Calculated job_id
630   pthread_mutex_lock(_job_cpt_mutex);
631   int job_id = _job_cpt;
632   _job_cpt++;
633   new_job->setNumber(job_id);
634   pthread_mutex_unlock(_job_cpt_mutex);
635
636   // Step 1: check if resource is already in the map
637   createBatchManagerForJob(new_job);
638
639   // Step 2: add the job to the batch manager
640 #ifdef WITH_LIBBATCH
641   try
642   {
643     Batch::JobId batch_manager_job_id = _batchmap[job_id]->addJob(*(new_job->getBatchJob()),
644                                                                   job_reference);
645     new_job->setBatchManagerJobId(batch_manager_job_id);
646   }
647   catch(const Batch::EmulationException &ex)
648   {
649     LAUNCHER_INFOS("Job cannot be added, exception in addJob: " << ex.message);
650     throw LauncherException(ex.message.c_str());
651   }
652
653   // Step 3: add job to launcher map
654   std::map<int, Launcher::Job *>::const_iterator it_job = _launcher_job_map.find(new_job->getNumber());
655   if (it_job == _launcher_job_map.end())
656     _launcher_job_map[new_job->getNumber()] = new_job;
657   else
658   {
659     LAUNCHER_INFOS("A job as already the same id: " << new_job->getNumber());
660     delete new_job;
661     throw LauncherException("A job as already the same id - job is not created !");
662   }
663   LAUNCHER_MESSAGE("New job added");
664 #endif
665 }