1 // Copyright (C) 2009-2020 CEA/DEN, EDF R&D, OPEN CASCADE
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 // Author: André RIBES - EDF R&D
22 #include "Launcher_Job_SALOME.hxx"
23 #include "Basics_DirUtils.hxx"
26 #include <libbatch/Constants.hxx>
38 Launcher::Job_SALOME::Job_SALOME() {}
40 Launcher::Job_SALOME::~Job_SALOME() {}
43 Launcher::Job_SALOME::setResourceDefinition(const ParserResourcesType & resource_definition)
45 // Check resource_definition
46 if (resource_definition.AppliPath == "")
48 std::string mess = "Resource definition must define an application path !, resource name is: " + resource_definition.Name;
49 throw LauncherException(mess);
51 Launcher::Job::setResourceDefinition(resource_definition);
55 Launcher::Job_SALOME::update_job()
58 Batch::Parametre params = common_job_params();
59 params[Batch::EXECUTABLE] = buildSalomeScript(params);
60 _batch_job->setParametre(params);
66 Launcher::Job_SALOME::buildSalomeScript(Batch::Parametre params)
69 std::string work_directory = params[Batch::WORKDIR].str();
70 std::ostringstream str_pid;
74 str_pid << ::getpid();
77 // true if APPLI holds a salome file launcher (in state of an application directory)
78 bool is_launcher_file=stat(getenv("APPLI"), &statbuf) ==0 && S_ISREG(statbuf.st_mode);
79 std::string launch_tmp_dir = Kernel_Utils::GetTmpDir();
80 std::string launch_script = launch_tmp_dir + "runSalome_" + _job_file_name + "_" + _launch_date + "-" + str_pid.str() + ".sh";
81 std::ofstream launch_script_stream;
82 launch_script_stream.open(launch_script.c_str(),
85 | std::ofstream::binary //rnv: to avoid CL+RF end of line on windows
90 launch_script_stream << "#!/bin/sh -f" << std::endl;
91 launch_script_stream << "cd " << work_directory << std::endl;
92 // remove the exit code from any previous execution
93 launch_script_stream << "rm -f logs/exit_code.log" << std::endl;
95 launch_script_stream << "export PYTHONPATH=" << work_directory << ":$PYTHONPATH" << std::endl;
96 launch_script_stream << "export PATH=" << work_directory << ":$PATH" << std::endl;
99 std::string::size_type last = _env_file.find_last_of("/");
100 launch_script_stream << ". " << _env_file.substr(last+1) << std::endl;
102 launch_script_stream << "export SALOME_TMP_DIR=" << work_directory << "/logs" << std::endl;
104 // -- Generates Catalog Resources
105 // do not build a new catalog if the job is launched on localhost
106 if(_resource_required_params.name != "localhost")
108 std::string resource_protocol = _resource_definition.getClusterInternalProtocolStr();
109 launch_script_stream << "if [ \"x$LIBBATCH_NODEFILE\" != \"x\" ]; then " << std::endl;
110 launch_script_stream << "CATALOG_FILE=" << "CatalogResources_" << _launch_date << ".xml" << std::endl;
111 launch_script_stream << "export USER_CATALOG_RESOURCES_FILE=" << "$CATALOG_FILE" << std::endl;
112 launch_script_stream << "{" << std::endl;
113 launch_script_stream << "echo '<!DOCTYPE ResourcesCatalog>'" << std::endl;
114 launch_script_stream << "echo '<resources>'" << std::endl;
115 launch_script_stream << "sort \"$LIBBATCH_NODEFILE\" | uniq -c | while read nbproc host" << std::endl;
116 launch_script_stream << "do" << std::endl;
117 // Full name doesn't work. eg: sagittaire-7 instead of sagittaire-7.lyon.grid5000.fr
118 launch_script_stream << "host_basename=$(echo \"$host\" | cut -f1 -d.)" << std::endl;
119 launch_script_stream << "echo '<machine name='\\\"\"$host_basename\"\\\"" << std::endl;
120 launch_script_stream << "echo ' hostname='\\\"\"$host_basename\"\\\"" << std::endl;
121 launch_script_stream << "echo ' type=\"single_machine\"'" << std::endl;
122 launch_script_stream << "echo ' protocol=\"" << resource_protocol << "\"'" << std::endl;
123 launch_script_stream << "echo ' userName=\"" << _resource_definition.UserName << "\"'" << std::endl;
124 launch_script_stream << "echo ' appliPath=\"" << _resource_definition.AppliPath << "\"'" << std::endl;
125 launch_script_stream << "echo ' mpi=\"" << _resource_definition.getMpiImplTypeStr() << "\"'" << std::endl;
126 launch_script_stream << "echo ' nbOfNodes='\\\"\"$nbproc\"\\\"" << std::endl;
127 launch_script_stream << "echo ' nbOfProcPerNode=\"1\"'" << std::endl;
128 launch_script_stream << "echo ' canRunContainers=\"true\"'" << std::endl;
129 launch_script_stream << "echo '/>'" << std::endl;
130 launch_script_stream << "done" << std::endl;
131 launch_script_stream << "echo '</resources>'" << std::endl;
132 launch_script_stream << "} > $CATALOG_FILE" << std::endl;
133 launch_script_stream << "fi" << std::endl;
135 // Create file for ns-port-log
136 if (is_launcher_file)
137 // for a salome application file, we write NS_PORT_FILE_PATH in working directory
138 launch_script_stream << "NS_PORT_FILE_PATH=$(mktemp " << work_directory << "/nsport_" << _launch_date << "_XXXXXX) &&\n";
140 launch_script_stream << "NS_PORT_FILE_PATH=$(mktemp " << _resource_definition.AppliPath << "/USERS/nsport_XXXXXX) &&\n";
142 // Launch SALOME with an appli
143 if (is_launcher_file)
144 launch_script_stream << _resource_definition.AppliPath << " start --terminal --ns-port-log=\"$NS_PORT_FILE_PATH\" --server-launch-mode=fork ";
146 launch_script_stream << _resource_definition.AppliPath << "/salome start --terminal --ns-port-log=\"$NS_PORT_FILE_PATH\" --server-launch-mode=fork ";
147 launch_script_stream << "> logs/salome_" << _launch_date << ".log 2>&1 &&" << std::endl;
148 launch_script_stream << "current=0 &&\n"
150 << "while ! test -s \"$NS_PORT_FILE_PATH\"\n"
153 << " current=$((current+1))\n"
154 << " if [ \"$current\" -eq \"$stop\" ] ; then\n"
155 << " echo Error Naming Service failed ! >&2\n"
159 << "appli_port=$(cat \"$NS_PORT_FILE_PATH\") &&\n"
160 << "rm \"$NS_PORT_FILE_PATH\" &&\n";
162 // Call real job type
163 addJobTypeSpecificScript(launch_script_stream);
165 launch_script_stream << "echo $? > logs/exit_code.log" << std::endl;
168 if (is_launcher_file)
169 launch_script_stream << _resource_definition.AppliPath << " kill \"$appli_port\"" << std::endl;
171 launch_script_stream << _resource_definition.AppliPath << "/salome kill \"$appli_port\"" << std::endl;
174 launch_script_stream.flush();
175 launch_script_stream.close();
176 chmod(launch_script.c_str(), 0x1ED);
177 return launch_script;