SALOME_ResourcesManager.idl

Go to the documentation of this file.

// Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
//
// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//

#ifndef _SALOME_RESOURCESMANAGER_IDL_
#define _SALOME_RESOURCESMANAGER_IDL_

#include "SALOME_Exception.idl"

module Engines
{

typedef sequence<string> ResourceList;
typedef sequence<string> CompoList;
typedef sequence<long> IntegerList;
  
struct ResourceParameters
{

  string name;

  string hostname;
  boolean can_launch_batch_jobs;
  boolean can_run_containers;
  string OS;

  CompoList componentList;

  // Permits to order resources

  long nb_proc;


  long mem_mb;
  long cpu_clock;
  long nb_node;
  long nb_proc_per_node;

  // Permits to configure SALOME resource management
  string policy;
  ResourceList resList;
};

struct ResourceDefinition
{
  string name;
  string hostname;
  string type;
  string protocol;
  string username;
  string applipath;
  CompoList componentList;

  string OS;
  long mem_mb;
  long cpu_clock;
  long nb_node;
  long nb_proc_per_node;
  string batch;
  string mpiImpl;
  string iprotocol;

  boolean can_launch_batch_jobs;
  boolean can_run_containers;

  string working_directory;
};

interface ResourcesManager
{
  string FindFirst(in ResourceList possibleResources);

  string Find(in string policy, in ResourceList possibleResources);


  ResourceList GetFittingResources(in ResourceParameters params) raises (SALOME::SALOME_Exception);

  ResourceDefinition GetResourceDefinition(in string name) raises (SALOME::SALOME_Exception);


  void AddResource(in ResourceDefinition new_resource, in boolean write, in string xml_file) 
    raises (SALOME::SALOME_Exception);


  void RemoveResource(in string resource_name, in boolean write, in string xml_file) 
    raises (SALOME::SALOME_Exception);

  string getMachineFile(in string resource_name, in long nb_procs, in string parallelLib)
    raises (SALOME::SALOME_Exception);

  void ListAllAvailableResources(out ResourceList machines, out IntegerList nbProcsOfMachines) raises (SALOME::SALOME_Exception);
};

};
  
#endif