Salome HOME
Merge from mergeto_V5_1_main_19Jan10
[modules/kernel.git] / src / ResourcesManager / ResourcesManager.hxx
1 //  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 //  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
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.
10 //
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.
15 //
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
19 //
20 //  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22 #ifndef __RESOURCESMANAGER_HXX__
23 #define __RESOURCESMANAGER_HXX__
24
25 #include "ResourcesManager_Defs.hxx"
26
27 #include <string>
28 #include <fstream>
29 #include <vector>
30 #include <list>
31 #include "SALOME_ResourcesCatalog_Parser.hxx"
32 #include "SALOME_ResourcesCatalog_Handler.hxx"
33 #include "SALOME_LoadRateManager.hxx"
34 #include <sys/types.h>
35 #include <sys/stat.h>
36 #ifdef WNT
37 #else
38 #include <unistd.h>
39 #endif
40
41 // --- WARNING ---
42 // The call of BuildTempFileToLaunchRemoteContainer and RmTmpFile must be done
43 // in a critical section to be sure to be clean.
44 // Only one thread should use the SALOME_ResourcesManager class in a SALOME
45 // session.
46 struct resourceParams
47 {
48   std::string name;
49   std::string hostname;
50   std::string OS;
51   unsigned int nb_proc;
52   unsigned int nb_node;
53   unsigned int nb_proc_per_node;
54   unsigned int cpu_clock;
55   unsigned int mem_mb;
56   std::vector<std::string> componentList;
57   std::vector<std::string> resourceList;
58 };
59
60 class RESOURCESMANAGER_EXPORT ResourcesException
61 {
62 public:
63   const std::string msg;
64
65   ResourcesException(const std::string m) : msg(m) {}
66 };
67
68 class RESOURCESMANAGER_EXPORT ResourcesManager_cpp
69   {
70
71   public:
72
73     ResourcesManager_cpp(const char *xmlFilePath);
74     ResourcesManager_cpp() throw(ResourcesException);
75
76     ~ResourcesManager_cpp();
77
78     std::vector<std::string> 
79     GetFittingResources(const resourceParams& params) throw(ResourcesException);
80
81     std::string Find(const std::string& policy, 
82                      const std::vector<std::string>& listOfResources);
83
84     int AddResourceInCatalog (const resourceParams& paramsOfNewResources,
85                               const std::vector<std::string>& componentsOnNewResources,
86                               const char *userName,
87                               AccessModeType mode,
88                               AccessProtocolType prot,
89                               AccessProtocolType iprot) throw(ResourcesException);
90
91     void DeleteResourceInCatalog(const char * name);
92
93     void WriteInXmlFile(std::string & xml_file);
94
95     const MapOfParserResourcesType& ParseXmlFiles();
96
97     const MapOfParserResourcesType& GetList() const;
98
99     ParserResourcesType GetResourcesDescr(const std::string & name);
100
101   protected:
102     
103     void SelectOnlyResourcesWithOS(std::vector<std::string>& resources, std::string OS);
104
105     void KeepOnlyResourcesWithComponent(std::vector<std::string>& resources, 
106                                         const std::vector<std::string>& componentList);
107
108     //! will contain the path to the ressources catalog
109     std::list<std::string> _path_resources;
110     std::list<std::string>::iterator _path_resources_it;
111
112     //! will contain the informations on the data type catalog(after parsing)
113     MapOfParserResourcesType _resourcesList;
114
115     //! a map that contains all the available load rate managers (the key is the name)
116     std::map<std::string , LoadRateManager*> _resourceManagerMap;
117
118     //! contain the time where resourcesList was created
119     time_t _lasttime;
120   };
121
122 #endif // __RESOURCESMANAGER_HXX__