1 // Copyright (C) 2007-2008 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.
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
22 #ifndef _SALOME_CONTAINERMANAGER_IDL_
23 #define _SALOME_CONTAINERMANAGER_IDL_
25 #include "SALOME_Exception.idl"
26 #include "SALOME_Component.idl"
28 /*! \file SALOME_ContainerManager.idl \brief interfaces for %SALOME launcher and container manager
34 //! Type to transmit list of resources.
35 typedef sequence<string> ResourceList;
37 typedef sequence<string> CompoList;
39 typedef sequence<string> FilesList;
41 typedef sequence<string> ModulesList;
43 //! A generic parameter
49 //! Generic parameter list
50 typedef sequence<Engines::Parameter> ParameterList;
52 //! Type to describe required properties of a resource
53 struct ResourceParameters
55 //! resource name - manual selection
59 //! if given required operating system
61 //! if given list of components that could be loaded on a container
62 //! Optional if no resource are found with this constraint
63 CompoList componentList;
65 // Permits to order resources
66 //! required number of proc
68 //! required memory size
70 //! required frequency
72 //! required number of node
74 //! required number of proc per node
75 long nb_proc_per_node;
77 // Permits to configure SALOME resource management
78 //! resource management policy : first, cycl, altcycl or best (can be extended)
80 //! restricted list of resources to search in
84 //! Type to describe required properties of a container
85 struct ContainerParameters
87 //! container name if given else automatic
88 string container_name;
90 //! creation mode for GiveContainer if given else automatic
91 /*!start creates a new container
92 * get try to find an existing container
93 * getorstart use an existing container if it exists or creates a new one
97 //! container working directory if given else automatic
101 //! Number of proc of a parallel container
103 //! if true start a MPI container
105 //! PaCO specific informations
108 //! Parameters to choose a resource
109 ResourceParameters resource_params;
112 //! Type to describe a resource
113 struct ResourceDefinition
119 //! protocol to connect to the resource
120 //! protocol used to start a remote container (ssh or rsh)
122 //! login name to use to start a remote container
124 //! salome application to use to start a remote container
126 //! list of available components
127 CompoList componentList;
128 //! Type of resource: interactive or batch
133 //! memory size per node
139 //! number of proc per node
140 long nb_proc_per_node;
143 //! MPI implementation
145 //! if the resource is a cluster:
146 //! internal protocol to use to start a remote container (ssh or rsh) on the cluster
150 //! exception thrown if a computer is not found in the catalog
151 exception NotFound {};
155 //! Job Type - Could be equal to "command" or "yacs_file" or "python_salome"
163 string work_directory;
164 string local_directory;
165 string result_directory;
167 /*! Time for the batch (has to be like this : hh:mm) - Could be empty, in
168 this case, default value of the selected resource will be used.
170 string maximum_duration;
172 // Memory is expressed in megabytes -> mem_mb
173 // Number of Processors -> nb_proc
174 ResourceParameters resource_required;
177 Name of the batch queue choosed - optional
182 Specific parameters for each type of job - optional
184 Engines::ParameterList specific_parameters;
187 /*! \brief Interface of the %salomelauncher
188 This interface is used for interaction with the unique instance
191 interface SalomeLauncher
194 long createJob (in Engines::JobParameters job_parameters) raises (SALOME::SALOME_Exception);
195 void launchJob (in long job_id) raises (SALOME::SALOME_Exception);
196 string getJobState (in long job_id) raises (SALOME::SALOME_Exception);
197 void getJobResults(in long job_id, in string directory) raises (SALOME::SALOME_Exception);
198 void removeJob (in long job_id) raises (SALOME::SALOME_Exception);
201 long createJobWithFile(in string xmlJobFile, in string clusterName) raises (SALOME::SALOME_Exception);
202 boolean testBatch (in ResourceParameters params) raises (SALOME::SALOME_Exception);
204 // SALOME kernel service methods
209 /*! \brief Interface of the %containerManager
210 This interface is used for interaction with the unique instance
213 interface ContainerManager
215 //! GiveContainer - use mode parameter of ContainerParameters to configure
216 //! how this method works
217 //! Currently: get, start, getorstart, findorstart, find
218 Container GiveContainer(in ContainerParameters params);
220 //! Shutdown all containers that have been launched by the container manager
221 void ShutdownContainers();
224 /*! \brief Interface of the %resourcesManager
225 This interface is used for interaction with the unique instance
228 interface ResourcesManager
230 //! Find first available resource in a resources list
231 string FindFirst(in ResourceList possibleResources);
233 //! Find best available computer according to policy in a computers list
234 string Find(in string policy, in ResourceList possibleResources);
236 //! Get a list of resources that are best suited to launch a container given constraints
238 The constraints are resource constraints (params) and components constraints (componentList)
240 ResourceList GetFittingResources(in ResourceParameters params) raises (SALOME::SALOME_Exception);
242 //! Get definition of a resource
243 ResourceDefinition GetResourceDefinition(in string name);
245 //! Add a new resource to the resource_manager
247 write -> true, resource manager will add it into a xml_file
248 xml_file -> could be empty, in this case if write is true, resource manager will write
249 the resource in its first ResourceCatalog file
251 void AddResource(in ResourceDefinition new_resource, in boolean write, in string xml_file)
252 raises (SALOME::SALOME_Exception);
254 //! Remove a new resource to the resource_manager
256 write -> true, resource manager will write a new xml_file
257 xml_file -> could be empty, in this case if write is true, resource manager will write
258 the resource in its first ResourceCatalog file
260 void RemoveResource(in string resource_name, in boolean write, in string xml_file)
261 raises (SALOME::SALOME_Exception);
265 // For compatibility - will be erased on SALOME 6
266 typedef sequence<string> MachineList;
267 //! Type to describe required properties of a container.
268 struct MachineParameters
270 //! container name if given else automatic
271 string container_name;
272 //! host name if given else automatic
274 //! if given list of components that could be loaded on the container
275 CompoList componentList;
276 //! if given restricted list of machines to search in
277 MachineList computerList;
278 //! required operating system
280 //! required memory size
282 //! required frequency
284 //! required number of proc per node
285 long nb_proc_per_node;
286 //! required number of node
288 //! if true start a MPI container
290 //! container working directory
292 //! creation mode for GiveContainer.
293 /*!start creates a new container
294 * get try to find an existing container
295 * getorstart use an existing container if it exists or creates a new one
298 //! resource management policy : first, cycl, altcycl or best (can be extended)
301 //! PaCO specific informations
303 long nb_component_nodes;