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