1 // Copyright (C) 2007-2016 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);
142 new_job->setPreCommand(job_parameters.pre_command.in());
145 std::string env_file = job_parameters.env_file.in();
146 new_job->setEnvFile(env_file);
147 for (CORBA::ULong i = 0; i < job_parameters.in_files.length(); i++)
148 new_job->add_in_file(job_parameters.in_files[i].in());
149 for (CORBA::ULong i = 0; i < job_parameters.out_files.length(); i++)
150 new_job->add_out_file(job_parameters.out_files[i].in());
152 // Expected During Time
155 std::string maximum_duration = job_parameters.maximum_duration.in();
156 new_job->setMaximumDuration(maximum_duration);
158 catch(const LauncherException &ex){
159 INFOS(ex.msg.c_str());
160 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::INTERNAL_ERROR);
164 std::string queue = job_parameters.queue.in();
165 new_job->setQueue(queue);
168 new_job->setExclusive(job_parameters.exclusive);
170 // Memory required per CPU
171 new_job->setMemPerCpu(job_parameters.mem_per_cpu);
174 std::string wckey = job_parameters.wckey.in();
175 new_job->setWCKey(wckey);
178 std::string extra_params = job_parameters.extra_params.in();
179 new_job->setExtraParams(extra_params);
181 // Resources requirements
185 p.name = job_parameters.resource_required.name;
186 p.hostname = job_parameters.resource_required.hostname;
187 p.OS = job_parameters.resource_required.OS;
188 p.nb_proc = job_parameters.resource_required.nb_proc;
189 p.nb_node = job_parameters.resource_required.nb_node;
190 p.nb_proc_per_node = job_parameters.resource_required.nb_proc_per_node;
191 p.cpu_clock = job_parameters.resource_required.cpu_clock;
192 p.mem_mb = job_parameters.resource_required.mem_mb;
193 new_job->setResourceRequiredParams(p);
195 catch(const LauncherException &ex){
196 INFOS(ex.msg.c_str());
197 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::INTERNAL_ERROR);
200 // Adding specific parameters to the job
201 for (CORBA::ULong i = 0; i < job_parameters.specific_parameters.length(); i++)
202 new_job->addSpecificParameter(job_parameters.specific_parameters[i].name.in(),
203 job_parameters.specific_parameters[i].value.in());
206 new_job->checkSpecificParameters();
208 catch(const LauncherException &ex)
210 INFOS(ex.msg.c_str());
211 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::INTERNAL_ERROR);
216 _l.createJob(new_job);
217 std::ostringstream job_id;
218 job_id << new_job->getNumber();
219 notifyObservers("NEW_JOB", job_id.str());
221 catch(const LauncherException &ex)
223 INFOS(ex.msg.c_str());
224 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
226 return new_job->getNumber();
230 SALOME_Launcher::launchJob(CORBA::Long job_id)
234 _l.launchJob(job_id);
236 catch(const LauncherException &ex)
238 INFOS(ex.msg.c_str());
239 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
244 SALOME_Launcher::getJobState(CORBA::Long job_id)
249 result = _l.getJobState(job_id);
251 catch(const LauncherException &ex)
253 INFOS(ex.msg.c_str());
254 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
256 return CORBA::string_dup(result.c_str());
259 // Get names or ids of hosts assigned to the job
261 SALOME_Launcher::getAssignedHostnames(CORBA::Long job_id)
266 result = _l.getAssignedHostnames(job_id);
268 catch(const LauncherException &ex)
270 INFOS(ex.msg.c_str());
271 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
273 return CORBA::string_dup(result.c_str());
277 SALOME_Launcher::getJobResults(CORBA::Long job_id, const char * directory)
281 _l.getJobResults(job_id, directory);
283 catch(const LauncherException &ex)
285 INFOS(ex.msg.c_str());
286 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
291 SALOME_Launcher::clearJobWorkingDir(CORBA::Long job_id)
295 _l.clearJobWorkingDir(job_id);
297 catch(const LauncherException &ex)
299 INFOS(ex.msg.c_str());
300 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
305 SALOME_Launcher::getJobDumpState(CORBA::Long job_id, const char * directory)
307 CORBA::Boolean rtn = false;
310 rtn = _l.getJobDumpState(job_id, directory);
312 catch(const LauncherException &ex)
314 INFOS(ex.msg.c_str());
315 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
321 SALOME_Launcher::getJobWorkFile(CORBA::Long job_id, const char * work_file, const char * directory)
323 CORBA::Boolean rtn = false;
326 rtn = _l.getJobWorkFile(job_id, work_file, directory);
328 catch(const LauncherException &ex)
330 INFOS(ex.msg.c_str());
331 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
337 SALOME_Launcher::removeJob(CORBA::Long job_id)
341 _l.removeJob(job_id);
342 std::ostringstream job_id_str;
343 job_id_str << job_id;
344 notifyObservers("REMOVE_JOB", job_id_str.str());
346 catch(const LauncherException &ex)
348 INFOS(ex.msg.c_str());
349 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
354 SALOME_Launcher::stopJob(CORBA::Long job_id)
359 std::ostringstream job_id_str;
360 job_id_str << job_id;
361 notifyObservers("UPDATE_JOB_STATE", job_id_str.str());
363 catch(const LauncherException &ex)
365 INFOS(ex.msg.c_str());
366 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::BAD_PARAM);
370 //=============================================================================
372 * Create a job in the launcher with a file
373 * \param xmlExecuteFile : .xml to parse that contains job description
374 * \param clusterName : machine choosed
376 //=============================================================================
378 SALOME_Launcher::createJobWithFile(const char * xmlExecuteFile,
379 const char * clusterName)
383 jobId = _l.createJobWithFile(xmlExecuteFile, clusterName);
385 catch(const LauncherException &ex){
386 INFOS(ex.msg.c_str());
387 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::INTERNAL_ERROR);
393 //=============================================================================
395 * the test batch configuration
396 * \param params : The batch cluster
398 //=============================================================================
400 SALOME_Launcher::testBatch(const Engines::ResourceParameters& params)
402 MESSAGE("BEGIN OF SALOME_Launcher::testBatch");
403 CORBA::Boolean rtn = false;
406 // Consider only resources that can run batch jobs
407 Engines::ResourceParameters new_params(params);
408 new_params.can_launch_batch_jobs = true;
410 // find a resource matching the required parameters
411 Engines::ResourceList *aMachineList = _ResManager->GetFittingResources(new_params);
412 if (aMachineList->length() == 0)
413 throw SALOME_Exception("No resources have been found with your parameters");
415 const Engines::ResourceDefinition* p = _ResManager->GetResourceDefinition((*aMachineList)[0]);
416 std::string resource_name(p->name);
417 INFOS("Choose resource for test: " << resource_name);
425 catch(const LauncherException &ex){
426 INFOS(ex.msg.c_str());
427 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(),SALOME::INTERNAL_ERROR);
432 //=============================================================================
434 * shutdown all the containers, then the ContainerManager servant
436 //=============================================================================
437 void SALOME_Launcher::Shutdown()
440 _NS->Destroy_Name(_LauncherNameInNS);
441 _ContManager->Shutdown();
442 _ResManager->Shutdown();
443 PortableServer::ObjectId_var oid = _poa->servant_to_id(this);
444 _poa->deactivate_object(oid);
445 if(!CORBA::is_nil(_orb))
449 //=============================================================================
451 * Returns the PID of the process
453 //=============================================================================
454 CORBA::Long SALOME_Launcher::getPID()
458 (CORBA::Long)getpid();
460 (CORBA::Long)_getpid();
464 //=============================================================================
466 * Returns current launcher jobs list
468 //=============================================================================
470 SALOME_Launcher::getJobsList()
472 Engines::JobsList_var jobs_list = new Engines::JobsList();
473 std::map<int, Launcher::Job *> cpp_jobs = _l.getJobs();
474 std::map<int, Launcher::Job *>::const_iterator it_job;
476 for(it_job = cpp_jobs.begin(); it_job != cpp_jobs.end(); it_job++)
478 int number = it_job->first;
481 // Prepare CORBA job description
482 Engines::JobDescription_var job_descr = new Engines::JobDescription();
483 Engines::JobParameters_var job_parameters = getJobParameters(number);
484 job_descr->job_id = number;
485 job_descr->job_parameters = job_parameters;
487 // Add job description to the sequence
488 jobs_list->length(list_id + 1);
489 jobs_list[list_id] = job_descr;
494 return jobs_list._retn();
497 //=============================================================================
499 * Returns the job description
501 //=============================================================================
502 Engines::JobParameters *
503 SALOME_Launcher::getJobParameters(CORBA::Long job_id)
505 std::map<int, Launcher::Job *> cpp_jobs = _l.getJobs();
506 std::map<int, Launcher::Job *>::const_iterator it_job = cpp_jobs.find(job_id);
507 if (it_job == cpp_jobs.end())
509 INFOS("Cannot find the job, is it created ? job number: " << job_id);
510 THROW_SALOME_CORBA_EXCEPTION("Job does not exist", SALOME::INTERNAL_ERROR);
513 Launcher::Job * job = it_job->second;
514 Engines::JobParameters_var job_parameters = new Engines::JobParameters;
515 job_parameters->job_name = CORBA::string_dup(job->getJobName().c_str());
516 job_parameters->job_type = CORBA::string_dup(job->getJobType().c_str());
517 job_parameters->job_file = CORBA::string_dup(job->getJobFile().c_str());
518 job_parameters->env_file = CORBA::string_dup(job->getEnvFile().c_str());
519 job_parameters->work_directory = CORBA::string_dup(job->getWorkDirectory().c_str());
520 job_parameters->local_directory = CORBA::string_dup(job->getLocalDirectory().c_str());
521 job_parameters->result_directory = CORBA::string_dup(job->getResultDirectory().c_str());
522 job_parameters->pre_command = CORBA::string_dup(job->getPreCommand().c_str());
524 // Parameters for COORM
525 job_parameters->launcher_file = CORBA::string_dup(job->getLauncherFile().c_str());
526 job_parameters->launcher_args = CORBA::string_dup(job->getLauncherArgs().c_str());
530 std::list<std::string> in_files = job->get_in_files();
531 std::list<std::string> out_files = job->get_out_files();
532 job_parameters->in_files.length(in_files.size());
533 for(std::list<std::string>::iterator it = in_files.begin(); it != in_files.end(); it++)
535 job_parameters->in_files[i] = CORBA::string_dup((*it).c_str());
538 job_parameters->out_files.length(out_files.size());
539 for(std::list<std::string>::iterator it = out_files.begin(); it != out_files.end(); it++)
541 job_parameters->out_files[j] = CORBA::string_dup((*it).c_str());
545 job_parameters->maximum_duration = CORBA::string_dup(job->getMaximumDuration().c_str());
546 job_parameters->queue = CORBA::string_dup(job->getQueue().c_str());
547 job_parameters->exclusive = job->getExclusive();
548 job_parameters->mem_per_cpu = job->getMemPerCpu();
549 job_parameters->wckey = CORBA::string_dup(job->getWCKey().c_str());
550 job_parameters->extra_params = CORBA::string_dup(job->getExtraParams().c_str());
552 resourceParams resource_params = job->getResourceRequiredParams();
553 job_parameters->resource_required.name = CORBA::string_dup(resource_params.name.c_str());
554 job_parameters->resource_required.hostname = CORBA::string_dup(resource_params.hostname.c_str());
555 job_parameters->resource_required.OS = CORBA::string_dup(resource_params.OS.c_str());
556 job_parameters->resource_required.nb_proc = resource_params.nb_proc;
557 job_parameters->resource_required.nb_node = resource_params.nb_node;
558 job_parameters->resource_required.nb_proc_per_node = resource_params.nb_proc_per_node;
559 job_parameters->resource_required.cpu_clock = resource_params.cpu_clock;
560 job_parameters->resource_required.mem_mb = resource_params.mem_mb;
562 std::map<std::string, std::string> specific_parameters = job->getSpecificParameters();
563 if (!specific_parameters.empty())
565 job_parameters->specific_parameters.length(specific_parameters.size());
566 std::map<std::string, std::string>::const_iterator it_specific;
568 for (it_specific = specific_parameters.begin() ; it_specific != specific_parameters.end(); it_specific++)
570 Engines::Parameter_var new_param = new Engines::Parameter;
571 new_param->name = CORBA::string_dup((it_specific->first).c_str());
572 new_param->value = CORBA::string_dup((it_specific->second).c_str());
573 job_parameters->specific_parameters[i] = new_param;
578 return job_parameters._retn();
581 //=============================================================================
583 * Loads jobs saved in jobs_file
585 //=============================================================================
587 SALOME_Launcher::loadJobs(const char* jobs_file)
589 list<int> new_jobs_id_list;
592 // Load the jobs in Launcher
593 new_jobs_id_list = _l.loadJobs(jobs_file);
595 catch (const LauncherException & ex)
597 INFOS(ex.msg.c_str());
598 THROW_SALOME_CORBA_EXCEPTION(ex.msg.c_str(), SALOME::INTERNAL_ERROR);
601 // Notify observers of the new jobs
602 list<int>::const_iterator it_jobs_id;
603 for (it_jobs_id = new_jobs_id_list.begin(); it_jobs_id != new_jobs_id_list.end(); it_jobs_id++)
605 ostringstream job_id_sstr;
606 job_id_sstr << *it_jobs_id;
607 notifyObservers("NEW_JOB", job_id_sstr.str());
609 notifyObservers("LOAD_JOBS", jobs_file);
612 //=============================================================================
614 * Save jobs of Launcher (in any steps) in file jobs_file
616 //=============================================================================
618 SALOME_Launcher::saveJobs(const char* jobs_file)
620 _l.saveJobs(jobs_file);
621 notifyObservers("SAVE_JOBS", jobs_file);
624 //=============================================================================
626 * Add a new observer to the launcher
628 //=============================================================================
630 SALOME_Launcher::addObserver(Engines::SalomeLauncherObserver_ptr observer)
632 bool new_observer = true;
633 std::list<Engines::SalomeLauncherObserver_var>::iterator iter = _observers.begin();
634 while(iter != _observers.end())
636 if (std::string(_orb->object_to_string(*iter)) ==
637 std::string(_orb->object_to_string(observer)))
639 new_observer = false;
645 _observers.push_back(Engines::SalomeLauncherObserver::_duplicate(observer));
647 // We notify the new observer with all jobs that are currently in the Launcher
648 std::map<int, Launcher::Job *> cpp_jobs = _l.getJobs();
649 std::map<int, Launcher::Job *>::const_iterator it_job;
650 for(it_job = cpp_jobs.begin(); it_job != cpp_jobs.end(); it_job++)
652 int number = it_job->first;
653 std::ostringstream job_id;
657 observer->notify("NEW_JOB", job_id.str().c_str());
661 MESSAGE("Notify Observer, exception catch");
667 //=============================================================================
669 * Add a new observer to the launcher
671 //=============================================================================
673 SALOME_Launcher::removeObserver(Engines::SalomeLauncherObserver_ptr observer)
675 std::list<Engines::SalomeLauncherObserver_var>::iterator iter = _observers.begin();
676 while(iter != _observers.end())
678 if (std::string(_orb->object_to_string(*iter)) ==
679 std::string(_orb->object_to_string(observer)))
682 iter =_observers.erase(iter++);
691 //=============================================================================
693 * Notify observers on a new event
695 //=============================================================================
697 SALOME_Launcher::notifyObservers(const std::string & event_name,
698 const std::string & event_data)
700 std::list<Engines::SalomeLauncherObserver_var>::iterator iter = _observers.begin();
701 while(iter != _observers.end())
705 (*iter)->notify(CORBA::string_dup(event_name.c_str()),
706 CORBA::string_dup(event_data.c_str()));
710 MESSAGE("Notify Observer, exception catch");