1 // Copyright (C) 2007-2014 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, or (at your option) any later version.
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 #include "SALOME_Launcher.hxx"
24 #include "BatchTest.hxx"
26 #include "SALOME_ContainerManager.hxx"
27 #include "SALOME_NamingService.hxx"
28 #include "SALOME_ResourcesManager.hxx"
29 #include "Utils_CorbaException.hxx"
32 #include "Launcher_Job_Command.hxx"
33 #include "Launcher_Job_YACSFile.hxx"
34 #include "Launcher_Job_PythonSALOME.hxx"
36 #include "utilities.h"
43 #include <sys/types.h>
52 const char *SALOME_Launcher::_LauncherNameInNS = "/SalomeLauncher";
54 //=============================================================================
59 //=============================================================================
60 SALOME_Launcher::SALOME_Launcher(CORBA::ORB_ptr orb, PortableServer::POA_var poa) : _l()
62 MESSAGE("SALOME_Launcher constructor");
63 _NS = new SALOME_NamingService(orb);
64 _ResManager = new SALOME_ResourcesManager(orb,poa,_NS);
65 _l.SetResourcesManager(_ResManager->GetImpl());
66 _ContManager = new SALOME_ContainerManager(orb,poa,_NS);
67 _ResManager->_remove_ref();
68 _ContManager->_remove_ref();
70 _orb = CORBA::ORB::_duplicate(orb) ;
71 _poa = PortableServer::POA::_duplicate(poa) ;
72 PortableServer::ObjectId_var id = _poa->activate_object(this);
73 CORBA::Object_var obj = _poa->id_to_reference(id);
74 Engines::SalomeLauncher_var refContMan = Engines::SalomeLauncher::_narrow(obj);
76 _NS->Register(refContMan,_LauncherNameInNS);
77 MESSAGE("SALOME_Launcher constructor end");
80 //=============================================================================
84 //=============================================================================
85 SALOME_Launcher::~SALOME_Launcher()
87 MESSAGE("SALOME_Launcher destructor");
89 MESSAGE("SALOME_Launcher destructor end");
94 SALOME_Launcher::createJob(const Engines::JobParameters & job_parameters)
96 std::string job_type = job_parameters.job_type.in();
98 if (job_type != "command" && job_type != "yacs_file" && job_type != "python_salome")
100 std::string message("SALOME_Launcher::createJob: bad job type: ");
102 THROW_SALOME_CORBA_EXCEPTION(message.c_str(), SALOME::INTERNAL_ERROR);
105 Launcher::Job * new_job; // It is Launcher_cpp that is going to destroy it
107 if (job_type == "command")
108 new_job = new Launcher::Job_Command();
109 else if (job_type == "yacs_file")
110 new_job = new Launcher::Job_YACSFile();
111 else if (job_type == "python_salome")
112 new_job = new Launcher::Job_PythonSALOME();
115 new_job->setJobName(job_parameters.job_name.in());
118 std::string work_directory = job_parameters.work_directory.in();
119 std::string local_directory = job_parameters.local_directory.in();
120 std::string result_directory = job_parameters.result_directory.in();
121 new_job->setWorkDirectory(work_directory);
122 new_job->setLocalDirectory(local_directory);
123 new_job->setResultDirectory(result_directory);
125 // Parameters for COORM
126 std::string launcher_file = job_parameters.launcher_file.in();
127 std::string launcher_args = job_parameters.launcher_args.in();
128 new_job->setLauncherFile(launcher_file);
129 new_job->setLauncherArgs(launcher_args);
132 std::string job_file = job_parameters.job_file.in();
135 new_job->setJobFile(job_file);
137 catch(const LauncherException &ex)
139 INFOS(ex.msg.c_str());
140 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::INTERNAL_ERROR);
144 std::string env_file = job_parameters.env_file.in();
145 new_job->setEnvFile(env_file);
146 for (CORBA::ULong i = 0; i < job_parameters.in_files.length(); i++)
147 new_job->add_in_file(job_parameters.in_files[i].in());
148 for (CORBA::ULong i = 0; i < job_parameters.out_files.length(); i++)
149 new_job->add_out_file(job_parameters.out_files[i].in());
151 // Expected During Time
154 std::string maximum_duration = job_parameters.maximum_duration.in();
155 new_job->setMaximumDuration(maximum_duration);
157 catch(const LauncherException &ex){
158 INFOS(ex.msg.c_str());
159 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::INTERNAL_ERROR);
163 std::string queue = job_parameters.queue.in();
164 new_job->setQueue(queue);
167 new_job->setExclusive(job_parameters.exclusive);
169 // Memory required per CPU
170 new_job->setMemPerCpu(job_parameters.mem_per_cpu);
173 std::string wckey = job_parameters.wckey.in();
174 new_job->setWCKey(wckey);
177 std::string extra_params = job_parameters.extra_params.in();
178 new_job->setExtraParams(extra_params);
180 // Resources requirements
184 p.name = job_parameters.resource_required.name;
185 p.hostname = job_parameters.resource_required.hostname;
186 p.OS = job_parameters.resource_required.OS;
187 p.nb_proc = job_parameters.resource_required.nb_proc;
188 p.nb_node = job_parameters.resource_required.nb_node;
189 p.nb_proc_per_node = job_parameters.resource_required.nb_proc_per_node;
190 p.cpu_clock = job_parameters.resource_required.cpu_clock;
191 p.mem_mb = job_parameters.resource_required.mem_mb;
192 new_job->setResourceRequiredParams(p);
194 catch(const LauncherException &ex){
195 INFOS(ex.msg.c_str());
196 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::INTERNAL_ERROR);
199 // Adding specific parameters to the job
200 for (CORBA::ULong i = 0; i < job_parameters.specific_parameters.length(); i++)
201 new_job->addSpecificParameter(job_parameters.specific_parameters[i].name.in(),
202 job_parameters.specific_parameters[i].value.in());
205 new_job->checkSpecificParameters();
207 catch(const LauncherException &ex)
209 INFOS(ex.msg.c_str());
210 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::INTERNAL_ERROR);
215 _l.createJob(new_job);
216 std::ostringstream job_id;
217 job_id << new_job->getNumber();
218 notifyObservers("NEW_JOB", job_id.str());
220 catch(const LauncherException &ex)
222 INFOS(ex.msg.c_str());
223 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
225 return new_job->getNumber();
229 SALOME_Launcher::launchJob(CORBA::Long job_id)
233 _l.launchJob(job_id);
235 catch(const LauncherException &ex)
237 INFOS(ex.msg.c_str());
238 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
243 SALOME_Launcher::getJobState(CORBA::Long job_id)
248 result = _l.getJobState(job_id);
250 catch(const LauncherException &ex)
252 INFOS(ex.msg.c_str());
253 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
255 return CORBA::string_dup(result.c_str());
258 // Get names or ids of hosts assigned to the job
260 SALOME_Launcher::getAssignedHostnames(CORBA::Long job_id)
265 result = _l.getAssignedHostnames(job_id);
267 catch(const LauncherException &ex)
269 INFOS(ex.msg.c_str());
270 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
272 return CORBA::string_dup(result.c_str());
276 SALOME_Launcher::getJobResults(CORBA::Long job_id, const char * directory)
280 _l.getJobResults(job_id, directory);
282 catch(const LauncherException &ex)
284 INFOS(ex.msg.c_str());
285 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
290 SALOME_Launcher::getJobDumpState(CORBA::Long job_id, const char * directory)
292 CORBA::Boolean rtn = false;
295 rtn = _l.getJobDumpState(job_id, directory);
297 catch(const LauncherException &ex)
299 INFOS(ex.msg.c_str());
300 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
306 SALOME_Launcher::removeJob(CORBA::Long job_id)
310 _l.removeJob(job_id);
311 std::ostringstream job_id_str;
312 job_id_str << job_id;
313 notifyObservers("REMOVE_JOB", job_id_str.str());
315 catch(const LauncherException &ex)
317 INFOS(ex.msg.c_str());
318 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
323 SALOME_Launcher::stopJob(CORBA::Long job_id)
328 std::ostringstream job_id_str;
329 job_id_str << job_id;
330 notifyObservers("UPDATE_JOB_STATE", job_id_str.str());
332 catch(const LauncherException &ex)
334 INFOS(ex.msg.c_str());
335 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
339 //=============================================================================
341 * Create a job in the launcher with a file
342 * \param xmlExecuteFile : .xml to parse that contains job description
343 * \param clusterName : machine choosed
345 //=============================================================================
347 SALOME_Launcher::createJobWithFile(const char * xmlExecuteFile,
348 const char * clusterName)
352 jobId = _l.createJobWithFile(xmlExecuteFile, clusterName);
354 catch(const LauncherException &ex){
355 INFOS(ex.msg.c_str());
356 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::INTERNAL_ERROR);
362 //=============================================================================
364 * the test batch configuration
365 * \param params : The batch cluster
367 //=============================================================================
369 SALOME_Launcher::testBatch(const Engines::ResourceParameters& params)
371 MESSAGE("BEGIN OF SALOME_Launcher::testBatch");
372 CORBA::Boolean rtn = false;
375 // Consider only resources that can run batch jobs
376 Engines::ResourceParameters new_params(params);
377 new_params.can_launch_batch_jobs = true;
379 // find a resource matching the required parameters
380 Engines::ResourceList *aMachineList = _ResManager->GetFittingResources(new_params);
381 if (aMachineList->length() == 0)
382 throw SALOME_Exception("No resources have been found with your parameters");
384 const Engines::ResourceDefinition* p = _ResManager->GetResourceDefinition((*aMachineList)[0]);
385 std::string resource_name(p->name);
386 INFOS("Choose resource for test: " << resource_name);
394 catch(const LauncherException &ex){
395 INFOS(ex.msg.c_str());
396 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::INTERNAL_ERROR);
401 //=============================================================================
403 * shutdown all the containers, then the ContainerManager servant
405 //=============================================================================
406 void SALOME_Launcher::Shutdown()
409 _NS->Destroy_Name(_LauncherNameInNS);
410 _ContManager->Shutdown();
411 _ResManager->Shutdown();
412 PortableServer::ObjectId_var oid = _poa->servant_to_id(this);
413 _poa->deactivate_object(oid);
414 if(!CORBA::is_nil(_orb))
418 //=============================================================================
420 * Returns the PID of the process
422 //=============================================================================
423 CORBA::Long SALOME_Launcher::getPID()
427 (CORBA::Long)getpid();
429 (CORBA::Long)_getpid();
433 //=============================================================================
435 * Returns current launcher jobs list
437 //=============================================================================
439 SALOME_Launcher::getJobsList()
441 Engines::JobsList_var jobs_list = new Engines::JobsList();
442 std::map<int, Launcher::Job *> cpp_jobs = _l.getJobs();
443 std::map<int, Launcher::Job *>::const_iterator it_job;
445 for(it_job = cpp_jobs.begin(); it_job != cpp_jobs.end(); it_job++)
447 int number = it_job->first;
450 // Prepare CORBA job description
451 Engines::JobDescription_var job_descr = new Engines::JobDescription();
452 Engines::JobParameters_var job_parameters = getJobParameters(number);
453 job_descr->job_id = number;
454 job_descr->job_parameters = job_parameters;
456 // Add job description to the sequence
457 jobs_list->length(list_id + 1);
458 jobs_list[list_id] = job_descr;
463 return jobs_list._retn();
466 //=============================================================================
468 * Returns the job description
470 //=============================================================================
471 Engines::JobParameters *
472 SALOME_Launcher::getJobParameters(CORBA::Long job_id)
474 std::map<int, Launcher::Job *> cpp_jobs = _l.getJobs();
475 std::map<int, Launcher::Job *>::const_iterator it_job = cpp_jobs.find(job_id);
476 if (it_job == cpp_jobs.end())
478 INFOS("Cannot find the job, is it created ? job number: " << job_id);
479 THROW_SALOME_CORBA_EXCEPTION("Job does not exist", SALOME::INTERNAL_ERROR);
482 Launcher::Job * job = it_job->second;
483 Engines::JobParameters_var job_parameters = new Engines::JobParameters;
484 job_parameters->job_name = CORBA::string_dup(job->getJobName().c_str());
485 job_parameters->job_type = CORBA::string_dup(job->getJobType().c_str());
486 job_parameters->job_file = CORBA::string_dup(job->getJobFile().c_str());
487 job_parameters->env_file = CORBA::string_dup(job->getEnvFile().c_str());
488 job_parameters->work_directory = CORBA::string_dup(job->getWorkDirectory().c_str());
489 job_parameters->local_directory = CORBA::string_dup(job->getLocalDirectory().c_str());
490 job_parameters->result_directory = CORBA::string_dup(job->getResultDirectory().c_str());
492 // Parameters for COORM
493 job_parameters->launcher_file = CORBA::string_dup(job->getLauncherFile().c_str());
494 job_parameters->launcher_args = CORBA::string_dup(job->getLauncherArgs().c_str());
498 std::list<std::string> in_files = job->get_in_files();
499 std::list<std::string> out_files = job->get_out_files();
500 job_parameters->in_files.length(in_files.size());
501 for(std::list<std::string>::iterator it = in_files.begin(); it != in_files.end(); it++)
503 job_parameters->in_files[i] = CORBA::string_dup((*it).c_str());
506 job_parameters->out_files.length(out_files.size());
507 for(std::list<std::string>::iterator it = out_files.begin(); it != out_files.end(); it++)
509 job_parameters->out_files[j] = CORBA::string_dup((*it).c_str());
513 job_parameters->maximum_duration = CORBA::string_dup(job->getMaximumDuration().c_str());
514 job_parameters->queue = CORBA::string_dup(job->getQueue().c_str());
515 job_parameters->exclusive = job->getExclusive();
516 job_parameters->mem_per_cpu = job->getMemPerCpu();
517 job_parameters->wckey = CORBA::string_dup(job->getWCKey().c_str());
518 job_parameters->extra_params = CORBA::string_dup(job->getExtraParams().c_str());
520 resourceParams resource_params = job->getResourceRequiredParams();
521 job_parameters->resource_required.name = CORBA::string_dup(resource_params.name.c_str());
522 job_parameters->resource_required.hostname = CORBA::string_dup(resource_params.hostname.c_str());
523 job_parameters->resource_required.OS = CORBA::string_dup(resource_params.OS.c_str());
524 job_parameters->resource_required.nb_proc = resource_params.nb_proc;
525 job_parameters->resource_required.nb_node = resource_params.nb_node;
526 job_parameters->resource_required.nb_proc_per_node = resource_params.nb_proc_per_node;
527 job_parameters->resource_required.cpu_clock = resource_params.cpu_clock;
528 job_parameters->resource_required.mem_mb = resource_params.mem_mb;
530 std::map<std::string, std::string> specific_parameters = job->getSpecificParameters();
531 if (!specific_parameters.empty())
533 job_parameters->specific_parameters.length(specific_parameters.size());
534 std::map<std::string, std::string>::const_iterator it_specific;
536 for (it_specific = specific_parameters.begin() ; it_specific != specific_parameters.end(); it_specific++)
538 Engines::Parameter_var new_param = new Engines::Parameter;
539 new_param->name = CORBA::string_dup((it_specific->first).c_str());
540 new_param->value = CORBA::string_dup((it_specific->second).c_str());
541 job_parameters->specific_parameters[i] = new_param;
546 return job_parameters._retn();
549 //=============================================================================
551 * Loads jobs saved in jobs_file
553 //=============================================================================
555 SALOME_Launcher::loadJobs(const char* jobs_file)
557 list<int> new_jobs_id_list;
560 // Load the jobs in Launcher
561 new_jobs_id_list = _l.loadJobs(jobs_file);
563 catch (const LauncherException & ex)
565 INFOS(ex.msg.c_str());
566 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(), SALOME::INTERNAL_ERROR);
569 // Notify observers of the new jobs
570 list<int>::const_iterator it_jobs_id;
571 for (it_jobs_id = new_jobs_id_list.begin(); it_jobs_id != new_jobs_id_list.end(); it_jobs_id++)
573 ostringstream job_id_sstr;
574 job_id_sstr << *it_jobs_id;
575 notifyObservers("NEW_JOB", job_id_sstr.str());
577 notifyObservers("LOAD_JOBS", jobs_file);
580 //=============================================================================
582 * Save jobs of Launcher (in any steps) in file jobs_file
584 //=============================================================================
586 SALOME_Launcher::saveJobs(const char* jobs_file)
588 _l.saveJobs(jobs_file);
589 notifyObservers("SAVE_JOBS", jobs_file);
592 //=============================================================================
594 * Add a new observer to the launcher
596 //=============================================================================
598 SALOME_Launcher::addObserver(Engines::SalomeLauncherObserver_ptr observer)
600 bool new_observer = true;
601 std::list<Engines::SalomeLauncherObserver_var>::iterator iter = _observers.begin();
602 while(iter != _observers.end())
604 if (std::string(_orb->object_to_string(*iter)) ==
605 std::string(_orb->object_to_string(observer)))
607 new_observer = false;
613 _observers.push_back(Engines::SalomeLauncherObserver::_duplicate(observer));
615 // We notify the new observer with all jobs that are currently in the Launcher
616 std::map<int, Launcher::Job *> cpp_jobs = _l.getJobs();
617 std::map<int, Launcher::Job *>::const_iterator it_job;
618 for(it_job = cpp_jobs.begin(); it_job != cpp_jobs.end(); it_job++)
620 int number = it_job->first;
621 std::ostringstream job_id;
625 observer->notify("NEW_JOB", job_id.str().c_str());
629 MESSAGE("Notify Observer, exception catch");
635 //=============================================================================
637 * Add a new observer to the launcher
639 //=============================================================================
641 SALOME_Launcher::removeObserver(Engines::SalomeLauncherObserver_ptr observer)
643 std::list<Engines::SalomeLauncherObserver_var>::iterator iter = _observers.begin();
644 while(iter != _observers.end())
646 if (std::string(_orb->object_to_string(*iter)) ==
647 std::string(_orb->object_to_string(observer)))
650 iter =_observers.erase(iter++);
659 //=============================================================================
661 * Notify observers on a new event
663 //=============================================================================
665 SALOME_Launcher::notifyObservers(const std::string & event_name,
666 const std::string & event_data)
668 std::list<Engines::SalomeLauncherObserver_var>::iterator iter = _observers.begin();
669 while(iter != _observers.end())
673 (*iter)->notify(CORBA::string_dup(event_name.c_str()),
674 CORBA::string_dup(event_data.c_str()));
678 MESSAGE("Notify Observer, exception catch");