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_ResourcesManager.hxx"
28 #include "Utils_CorbaException.hxx"
31 #include "Launcher_Job_Command.hxx"
32 #include "Launcher_Job_YACSFile.hxx"
33 #include "Launcher_Job_PythonSALOME.hxx"
40 #include <sys/types.h>
49 const char *SALOME_Launcher::_LauncherNameInNS = "/SalomeLauncher";
51 //=============================================================================
56 //=============================================================================
57 SALOME_Launcher::SALOME_Launcher(CORBA::ORB_ptr orb, PortableServer::POA_var poa) : _l()
59 MESSAGE("SALOME_Launcher constructor");
60 _NS = new SALOME_NamingService(orb);
61 _ResManager = new SALOME_ResourcesManager(orb,poa,_NS);
62 _l.SetResourcesManager(_ResManager->GetImpl());
63 _ContManager = new SALOME_ContainerManager(orb,poa,_NS);
64 _ResManager->_remove_ref();
65 _ContManager->_remove_ref();
67 _orb = CORBA::ORB::_duplicate(orb) ;
68 _poa = PortableServer::POA::_duplicate(poa) ;
69 PortableServer::ObjectId_var id = _poa->activate_object(this);
70 CORBA::Object_var obj = _poa->id_to_reference(id);
71 Engines::SalomeLauncher_var refContMan = Engines::SalomeLauncher::_narrow(obj);
73 _NS->Register(refContMan,_LauncherNameInNS);
74 MESSAGE("SALOME_Launcher constructor end");
77 //=============================================================================
81 //=============================================================================
82 SALOME_Launcher::~SALOME_Launcher()
84 MESSAGE("SALOME_Launcher destructor");
86 MESSAGE("SALOME_Launcher destructor end");
91 SALOME_Launcher::createJob(const Engines::JobParameters & job_parameters)
93 std::string job_type = job_parameters.job_type.in();
95 if (job_type != "command" && job_type != "yacs_file" && job_type != "python_salome")
97 std::string message("SALOME_Launcher::createJob: bad job type: ");
99 THROW_SALOME_CORBA_EXCEPTION(message.c_str(), SALOME::INTERNAL_ERROR);
102 Launcher::Job * new_job; // It is Launcher_cpp that is going to destroy it
104 if (job_type == "command")
105 new_job = new Launcher::Job_Command();
106 else if (job_type == "yacs_file")
107 new_job = new Launcher::Job_YACSFile();
108 else if (job_type == "python_salome")
109 new_job = new Launcher::Job_PythonSALOME();
112 new_job->setJobName(job_parameters.job_name.in());
115 std::string work_directory = job_parameters.work_directory.in();
116 std::string local_directory = job_parameters.local_directory.in();
117 std::string result_directory = job_parameters.result_directory.in();
118 new_job->setWorkDirectory(work_directory);
119 new_job->setLocalDirectory(local_directory);
120 new_job->setResultDirectory(result_directory);
122 // Parameters for COORM
123 std::string launcher_file = job_parameters.launcher_file.in();
124 std::string launcher_args = job_parameters.launcher_args.in();
125 new_job->setLauncherFile(launcher_file);
126 new_job->setLauncherArgs(launcher_args);
129 std::string job_file = job_parameters.job_file.in();
132 new_job->setJobFile(job_file);
134 catch(const LauncherException &ex)
136 INFOS(ex.msg.c_str());
137 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::INTERNAL_ERROR);
141 std::string env_file = job_parameters.env_file.in();
142 new_job->setEnvFile(env_file);
143 for (CORBA::ULong i = 0; i < job_parameters.in_files.length(); i++)
144 new_job->add_in_file(job_parameters.in_files[i].in());
145 for (CORBA::ULong i = 0; i < job_parameters.out_files.length(); i++)
146 new_job->add_out_file(job_parameters.out_files[i].in());
148 // Expected During Time
151 std::string maximum_duration = job_parameters.maximum_duration.in();
152 new_job->setMaximumDuration(maximum_duration);
154 catch(const LauncherException &ex){
155 INFOS(ex.msg.c_str());
156 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::INTERNAL_ERROR);
160 std::string queue = job_parameters.queue.in();
161 new_job->setQueue(queue);
164 new_job->setExclusive(job_parameters.exclusive);
166 // Memory required per CPU
167 new_job->setMemPerCpu(job_parameters.mem_per_cpu);
170 std::string wckey = job_parameters.wckey.in();
171 new_job->setWCKey(wckey);
174 std::string extra_params = job_parameters.extra_params.in();
175 new_job->setExtraParams(extra_params);
177 // Resources requirements
181 p.name = job_parameters.resource_required.name;
182 p.hostname = job_parameters.resource_required.hostname;
183 p.OS = job_parameters.resource_required.OS;
184 p.nb_proc = job_parameters.resource_required.nb_proc;
185 p.nb_node = job_parameters.resource_required.nb_node;
186 p.nb_proc_per_node = job_parameters.resource_required.nb_proc_per_node;
187 p.cpu_clock = job_parameters.resource_required.cpu_clock;
188 p.mem_mb = job_parameters.resource_required.mem_mb;
189 new_job->setResourceRequiredParams(p);
191 catch(const LauncherException &ex){
192 INFOS(ex.msg.c_str());
193 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::INTERNAL_ERROR);
196 // Adding specific parameters to the job
197 for (CORBA::ULong i = 0; i < job_parameters.specific_parameters.length(); i++)
198 new_job->addSpecificParameter(job_parameters.specific_parameters[i].name.in(),
199 job_parameters.specific_parameters[i].value.in());
202 new_job->checkSpecificParameters();
204 catch(const LauncherException &ex)
206 INFOS(ex.msg.c_str());
207 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::INTERNAL_ERROR);
212 _l.createJob(new_job);
213 std::ostringstream job_id;
214 job_id << new_job->getNumber();
215 notifyObservers("NEW_JOB", job_id.str());
217 catch(const LauncherException &ex)
219 INFOS(ex.msg.c_str());
220 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
222 return new_job->getNumber();
226 SALOME_Launcher::launchJob(CORBA::Long job_id)
230 _l.launchJob(job_id);
232 catch(const LauncherException &ex)
234 INFOS(ex.msg.c_str());
235 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
240 SALOME_Launcher::getJobState(CORBA::Long job_id)
245 result = _l.getJobState(job_id);
247 catch(const LauncherException &ex)
249 INFOS(ex.msg.c_str());
250 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
252 return CORBA::string_dup(result.c_str());
255 // Get names or ids of hosts assigned to the job
257 SALOME_Launcher::getAssignedHostnames(CORBA::Long job_id)
262 result = _l.getAssignedHostnames(job_id);
264 catch(const LauncherException &ex)
266 INFOS(ex.msg.c_str());
267 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
269 return CORBA::string_dup(result.c_str());
273 SALOME_Launcher::getJobResults(CORBA::Long job_id, const char * directory)
277 _l.getJobResults(job_id, directory);
279 catch(const LauncherException &ex)
281 INFOS(ex.msg.c_str());
282 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
287 SALOME_Launcher::getJobDumpState(CORBA::Long job_id, const char * directory)
289 CORBA::Boolean rtn = false;
292 rtn = _l.getJobDumpState(job_id, directory);
294 catch(const LauncherException &ex)
296 INFOS(ex.msg.c_str());
297 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
303 SALOME_Launcher::removeJob(CORBA::Long job_id)
307 _l.removeJob(job_id);
308 std::ostringstream job_id_str;
309 job_id_str << job_id;
310 notifyObservers("REMOVE_JOB", job_id_str.str());
312 catch(const LauncherException &ex)
314 INFOS(ex.msg.c_str());
315 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
320 SALOME_Launcher::stopJob(CORBA::Long job_id)
325 std::ostringstream job_id_str;
326 job_id_str << job_id;
327 notifyObservers("UPDATE_JOB_STATE", job_id_str.str());
329 catch(const LauncherException &ex)
331 INFOS(ex.msg.c_str());
332 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
336 //=============================================================================
338 * Create a job in the launcher with a file
339 * \param xmlExecuteFile : .xml to parse that contains job description
340 * \param clusterName : machine choosed
342 //=============================================================================
344 SALOME_Launcher::createJobWithFile(const char * xmlExecuteFile,
345 const char * clusterName)
349 jobId = _l.createJobWithFile(xmlExecuteFile, clusterName);
351 catch(const LauncherException &ex){
352 INFOS(ex.msg.c_str());
353 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::INTERNAL_ERROR);
359 //=============================================================================
361 * the test batch configuration
362 * \param params : The batch cluster
364 //=============================================================================
366 SALOME_Launcher::testBatch(const Engines::ResourceParameters& params)
368 MESSAGE("BEGIN OF SALOME_Launcher::testBatch");
369 CORBA::Boolean rtn = false;
372 // Consider only resources that can run batch jobs
373 Engines::ResourceParameters new_params(params);
374 new_params.can_launch_batch_jobs = true;
376 // find a resource matching the required parameters
377 Engines::ResourceList *aMachineList = _ResManager->GetFittingResources(new_params);
378 if (aMachineList->length() == 0)
379 throw SALOME_Exception("No resources have been found with your parameters");
381 const Engines::ResourceDefinition* p = _ResManager->GetResourceDefinition((*aMachineList)[0]);
382 std::string resource_name(p->name);
383 INFOS("Choose resource for test: " << resource_name);
391 catch(const LauncherException &ex){
392 INFOS(ex.msg.c_str());
393 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::INTERNAL_ERROR);
398 //=============================================================================
400 * shutdown all the containers, then the ContainerManager servant
402 //=============================================================================
403 void SALOME_Launcher::Shutdown()
406 _NS->Destroy_Name(_LauncherNameInNS);
407 _ContManager->Shutdown();
408 _ResManager->Shutdown();
409 PortableServer::ObjectId_var oid = _poa->servant_to_id(this);
410 _poa->deactivate_object(oid);
411 if(!CORBA::is_nil(_orb))
415 //=============================================================================
417 * Returns the PID of the process
419 //=============================================================================
420 CORBA::Long SALOME_Launcher::getPID()
424 (CORBA::Long)getpid();
426 (CORBA::Long)_getpid();
430 //=============================================================================
432 * Returns current launcher jobs list
434 //=============================================================================
436 SALOME_Launcher::getJobsList()
438 Engines::JobsList_var jobs_list = new Engines::JobsList();
439 std::map<int, Launcher::Job *> cpp_jobs = _l.getJobs();
440 std::map<int, Launcher::Job *>::const_iterator it_job;
442 for(it_job = cpp_jobs.begin(); it_job != cpp_jobs.end(); it_job++)
444 int number = it_job->first;
447 // Prepare CORBA job description
448 Engines::JobDescription_var job_descr = new Engines::JobDescription();
449 Engines::JobParameters_var job_parameters = getJobParameters(number);
450 job_descr->job_id = number;
451 job_descr->job_parameters = job_parameters;
453 // Add job description to the sequence
454 jobs_list->length(list_id + 1);
455 jobs_list[list_id] = job_descr;
460 return jobs_list._retn();
463 //=============================================================================
465 * Returns the job description
467 //=============================================================================
468 Engines::JobParameters *
469 SALOME_Launcher::getJobParameters(CORBA::Long job_id)
471 std::map<int, Launcher::Job *> cpp_jobs = _l.getJobs();
472 std::map<int, Launcher::Job *>::const_iterator it_job = cpp_jobs.find(job_id);
473 if (it_job == cpp_jobs.end())
475 INFOS("Cannot find the job, is it created ? job number: " << job_id);
476 THROW_SALOME_CORBA_EXCEPTION("Job does not exist", SALOME::INTERNAL_ERROR);
479 Launcher::Job * job = it_job->second;
480 Engines::JobParameters_var job_parameters = new Engines::JobParameters;
481 job_parameters->job_name = CORBA::string_dup(job->getJobName().c_str());
482 job_parameters->job_type = CORBA::string_dup(job->getJobType().c_str());
483 job_parameters->job_file = CORBA::string_dup(job->getJobFile().c_str());
484 job_parameters->env_file = CORBA::string_dup(job->getEnvFile().c_str());
485 job_parameters->work_directory = CORBA::string_dup(job->getWorkDirectory().c_str());
486 job_parameters->local_directory = CORBA::string_dup(job->getLocalDirectory().c_str());
487 job_parameters->result_directory = CORBA::string_dup(job->getResultDirectory().c_str());
489 // Parameters for COORM
490 job_parameters->launcher_file = CORBA::string_dup(job->getLauncherFile().c_str());
491 job_parameters->launcher_args = CORBA::string_dup(job->getLauncherArgs().c_str());
495 std::list<std::string> in_files = job->get_in_files();
496 std::list<std::string> out_files = job->get_out_files();
497 job_parameters->in_files.length(in_files.size());
498 for(std::list<std::string>::iterator it = in_files.begin(); it != in_files.end(); it++)
500 job_parameters->in_files[i] = CORBA::string_dup((*it).c_str());
503 job_parameters->out_files.length(out_files.size());
504 for(std::list<std::string>::iterator it = out_files.begin(); it != out_files.end(); it++)
506 job_parameters->out_files[j] = CORBA::string_dup((*it).c_str());
510 job_parameters->maximum_duration = CORBA::string_dup(job->getMaximumDuration().c_str());
511 job_parameters->queue = CORBA::string_dup(job->getQueue().c_str());
512 job_parameters->exclusive = job->getExclusive();
513 job_parameters->mem_per_cpu = job->getMemPerCpu();
514 job_parameters->wckey = CORBA::string_dup(job->getWCKey().c_str());
515 job_parameters->extra_params = CORBA::string_dup(job->getExtraParams().c_str());
517 resourceParams resource_params = job->getResourceRequiredParams();
518 job_parameters->resource_required.name = CORBA::string_dup(resource_params.name.c_str());
519 job_parameters->resource_required.hostname = CORBA::string_dup(resource_params.hostname.c_str());
520 job_parameters->resource_required.OS = CORBA::string_dup(resource_params.OS.c_str());
521 job_parameters->resource_required.nb_proc = resource_params.nb_proc;
522 job_parameters->resource_required.nb_node = resource_params.nb_node;
523 job_parameters->resource_required.nb_proc_per_node = resource_params.nb_proc_per_node;
524 job_parameters->resource_required.cpu_clock = resource_params.cpu_clock;
525 job_parameters->resource_required.mem_mb = resource_params.mem_mb;
527 std::map<std::string, std::string> specific_parameters = job->getSpecificParameters();
528 if (!specific_parameters.empty())
530 job_parameters->specific_parameters.length(specific_parameters.size());
531 std::map<std::string, std::string>::const_iterator it_specific;
533 for (it_specific = specific_parameters.begin() ; it_specific != specific_parameters.end(); it_specific++)
535 Engines::Parameter_var new_param = new Engines::Parameter;
536 new_param->name = CORBA::string_dup((it_specific->first).c_str());
537 new_param->value = CORBA::string_dup((it_specific->second).c_str());
538 job_parameters->specific_parameters[i] = new_param;
543 return job_parameters._retn();
546 //=============================================================================
548 * Loads jobs saved in jobs_file
550 //=============================================================================
552 SALOME_Launcher::loadJobs(const char* jobs_file)
554 list<int> new_jobs_id_list;
557 // Load the jobs in Launcher
558 new_jobs_id_list = _l.loadJobs(jobs_file);
560 catch (const LauncherException & ex)
562 INFOS(ex.msg.c_str());
563 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(), SALOME::INTERNAL_ERROR);
566 // Notify observers of the new jobs
567 list<int>::const_iterator it_jobs_id;
568 for (it_jobs_id = new_jobs_id_list.begin(); it_jobs_id != new_jobs_id_list.end(); it_jobs_id++)
570 ostringstream job_id_sstr;
571 job_id_sstr << *it_jobs_id;
572 notifyObservers("NEW_JOB", job_id_sstr.str());
574 notifyObservers("LOAD_JOBS", jobs_file);
577 //=============================================================================
579 * Save jobs of Launcher (in any steps) in file jobs_file
581 //=============================================================================
583 SALOME_Launcher::saveJobs(const char* jobs_file)
585 _l.saveJobs(jobs_file);
586 notifyObservers("SAVE_JOBS", jobs_file);
589 //=============================================================================
591 * Add a new observer to the launcher
593 //=============================================================================
595 SALOME_Launcher::addObserver(Engines::SalomeLauncherObserver_ptr observer)
597 bool new_observer = true;
598 std::list<Engines::SalomeLauncherObserver_var>::iterator iter = _observers.begin();
599 while(iter != _observers.end())
601 if (std::string(_orb->object_to_string(*iter)) ==
602 std::string(_orb->object_to_string(observer)))
604 new_observer = false;
610 _observers.push_back(Engines::SalomeLauncherObserver::_duplicate(observer));
612 // We notify the new observer with all jobs that are currently in the Launcher
613 std::map<int, Launcher::Job *> cpp_jobs = _l.getJobs();
614 std::map<int, Launcher::Job *>::const_iterator it_job;
615 for(it_job = cpp_jobs.begin(); it_job != cpp_jobs.end(); it_job++)
617 int number = it_job->first;
618 std::ostringstream job_id;
622 observer->notify("NEW_JOB", job_id.str().c_str());
626 MESSAGE("Notify Observer, exception catch");
632 //=============================================================================
634 * Add a new observer to the launcher
636 //=============================================================================
638 SALOME_Launcher::removeObserver(Engines::SalomeLauncherObserver_ptr observer)
640 std::list<Engines::SalomeLauncherObserver_var>::iterator iter = _observers.begin();
641 while(iter != _observers.end())
643 if (std::string(_orb->object_to_string(*iter)) ==
644 std::string(_orb->object_to_string(observer)))
647 iter =_observers.erase(iter++);
656 //=============================================================================
658 * Notify observers on a new event
660 //=============================================================================
662 SALOME_Launcher::notifyObservers(const std::string & event_name,
663 const std::string & event_data)
665 std::list<Engines::SalomeLauncherObserver_var>::iterator iter = _observers.begin();
666 while(iter != _observers.end())
670 (*iter)->notify(CORBA::string_dup(event_name.c_str()),
671 CORBA::string_dup(event_data.c_str()));
675 MESSAGE("Notify Observer, exception catch");