Version: 9.12.0
Launcher_Job.hxx
Go to the documentation of this file.
1 // Copyright (C) 2009-2023 CEA, EDF, OPEN CASCADE
2 //
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.
7 //
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.
12 //
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
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19 
20 // Author: AndrĂ© RIBES - EDF R&D
21 //
22 #ifndef _LAUNCHER_JOB_HXX_
23 #define _LAUNCHER_JOB_HXX_
24 
25 #include "Launcher_Utils.hxx"
26 #include "ResourcesManager.hxx"
27 
28 #include <stdlib.h>
29 #include <time.h>
30 #include <sys/stat.h>
31 
32 #include <string>
33 #include <list>
34 #include <map>
35 #include <iostream>
36 #include <sstream>
37 #include <algorithm>
38 #include <exception>
39 
40 #ifdef WITH_LIBBATCH
41 #include <libbatch/Job.hxx>
42 #include <libbatch/JobId.hxx>
43 #include <libbatch/GenericException.hxx>
44 #endif
45 
46 namespace Launcher
47 {
49  {
50  public:
51  Job();
52  virtual ~Job();
53 
54  // Launcher managing parameters
55  // State of a Job: CREATED, IN_PROCESS, QUEUED, RUNNING, PAUSED, FINISHED, ERROR
56  void setState(const std::string & state);
57  std::string getState() const;
58  // Get names or ids of hosts assigned to the job
59  std::string getAssignedHostnames();
60 
61  void setNumber(const int & number);
62  int getNumber();
63 
64  virtual void setResourceDefinition(const ParserResourcesType & resource_definition);
65  ParserResourcesType getResourceDefinition() const;
66 
67  // Common parameters
68  void setJobName(const std::string & job_name);
69  virtual void setJobFile(const std::string & job_file);
70  void setPreCommand(const std::string & preCommand);
71  void setWorkDirectory(const std::string & work_directory);
72  void setLocalDirectory(const std::string & local_directory);
73  void setResultDirectory(const std::string & result_directory);
74  void add_in_file(const std::string & file);
75  void add_out_file(const std::string & file);
76  void setMaximumDuration(const std::string & maximum_duration);
77  void setResourceRequiredParams(const resourceParams & resource_required_params);
78  void setQueue(const std::string & queue);
79  void setPartition(const std::string & partition);
80  void setEnvFile(const std::string & env_file);
81  void setExclusive(bool exclusive);
82  void setExclusiveStr(const std::string & exclusiveStr);
83  void setMemPerCpu(unsigned long mem_per_cpu);
84  void setWCKey(const std::string & wckey);
85  void setExtraParams(const std::string & extra_params);
86  void setReference(const std::string & reference);
87  // For COORM
88  void setLauncherFile(const std::string & launcher_file);
89  void setLauncherArgs(const std::string & launcher_args);
90 
91  std::string getJobName() const;
92  std::string getJobFile() const;
93  std::string getPreCommand() const;
94  std::string getWorkDirectory() const;
95  std::string getLocalDirectory() const;
96  std::string getResultDirectory() const;
97  const std::list<std::string> & get_in_files() const;
98  const std::list<std::string> & get_out_files() const;
99  std::string getMaximumDuration() const;
100  resourceParams getResourceRequiredParams() const;
101  std::string getQueue() const;
102  std::string getPartition() const;
103  std::string getEnvFile() const;
104  std::string getJobType() const;
105  bool getExclusive() const;
106  std::string getExclusiveStr() const;
107  unsigned long getMemPerCpu() const;
108  std::string getWCKey() const;
109  std::string getExtraParams() const;
110  std::string getReference() const;
111 
112  // For COORM
113  std::string getLauncherFile() const;
114  std::string getLauncherArgs() const;
115 
116  std::string updateJobState();
117 
118  void addSpecificParameter(const std::string & name,
119  const std::string & value);
120  const std::map<std::string, std::string> & getSpecificParameters() const;
121  virtual void checkSpecificParameters();
122 
123  // Checks
124  void checkMaximumDuration(const std::string & maximum_duration);
125  void checkResourceRequiredParams(const resourceParams & resource_required_params);
126 
127  // Helps
128  long convertMaximumDuration(const std::string & maximum_duration);
129  std::string getLaunchDate() const;
130 
131  void stopJob();
132  void removeJob();
133 
134  // Abstract class
135  virtual void update_job() = 0;
136 
137  protected:
138  int _number;
139 
140  std::string _job_type;
141 
142  std::string _state;
143  std::string _assigned_hostnames; // Assigned hostnames
144  std::string _launch_date;
145  std::string _env_file;
146 
148 
149  std::string _job_name;
150  std::string _job_file;
151  std::string _job_file_name;
153  std::string _pre_command;
154 
155  std::string _work_directory;
156  std::string _local_directory;
157  std::string _result_directory;
158  std::list<std::string> _in_files;
159  std::list<std::string> _out_files;
160  std::map<std::string, std::string> _specific_parameters;
161  std::string _maximum_duration;
164  std::string _queue;
165  std::string _partition;
167  unsigned long _mem_per_cpu;
168  std::string _wckey;
169  std::string _extra_params;
170  std::string _reference;
171 
172  // Parameters for COORM
173  std::string _launcher_file;
174  std::string _launcher_args;
175 
176 #ifdef WITH_LIBBATCH
177  // Connection with LIBBATCH
178  public:
179  Batch::Job * getBatchJob();
180  Batch::Parametre common_job_params();
181  void setBatchManagerJobId(Batch::JobId batch_manager_job_id);
182  Batch::JobId getBatchManagerJobId() const;
183 
184  protected:
185  Batch::Job * _batch_job;
186  Batch::JobId _batch_job_id;
187 #endif
188  protected:
189  mutable int _cnt = 1;
190  };
191 }
192 
193 #endif
#define LAUNCHER_EXPORT
Definition: Launcher_Utils.hxx:39
Definition: Launcher_Job.hxx:49
std::string _launcher_args
Definition: Launcher_Job.hxx:174
std::string _job_name
Definition: Launcher_Job.hxx:149
std::string _result_directory
Definition: Launcher_Job.hxx:157
std::string _launcher_file
Reference of the job for the batch manager.
Definition: Launcher_Job.hxx:173
std::string _work_directory
Definition: Launcher_Job.hxx:155
virtual void update_job()=0
std::string _reference
Definition: Launcher_Job.hxx:170
std::string _partition
Definition: Launcher_Job.hxx:165
std::string _extra_params
Definition: Launcher_Job.hxx:169
resourceParams _resource_required_params
Definition: Launcher_Job.hxx:163
std::string _job_type
Definition: Launcher_Job.hxx:140
std::list< std::string > _out_files
Definition: Launcher_Job.hxx:159
long _maximum_duration_in_second
Definition: Launcher_Job.hxx:162
std::string _env_file
Definition: Launcher_Job.hxx:145
unsigned long _mem_per_cpu
Definition: Launcher_Job.hxx:167
std::string _job_file
Definition: Launcher_Job.hxx:150
std::list< std::string > _in_files
Definition: Launcher_Job.hxx:158
std::string _local_directory
Definition: Launcher_Job.hxx:156
int _number
Definition: Launcher_Job.hxx:138
std::string _job_file_name_complete
Definition: Launcher_Job.hxx:152
std::string _launch_date
Definition: Launcher_Job.hxx:144
ParserResourcesType _resource_definition
Definition: Launcher_Job.hxx:147
bool _exclusive
Definition: Launcher_Job.hxx:166
std::string _pre_command
Definition: Launcher_Job.hxx:153
std::map< std::string, std::string > _specific_parameters
Definition: Launcher_Job.hxx:160
std::string _maximum_duration
Definition: Launcher_Job.hxx:161
std::string _queue
Definition: Launcher_Job.hxx:164
std::string _state
Definition: Launcher_Job.hxx:142
std::string _wckey
Definition: Launcher_Job.hxx:168
std::string _assigned_hostnames
Definition: Launcher_Job.hxx:143
std::string _job_file_name
Definition: Launcher_Job.hxx:151
Definition: SALOME_ResourcesCatalog_Parser.hxx:90
Definition: Launcher_Job.hxx:47
job_name
Definition: launcher_use_case.py:48
wckey
Definition: launcher_use_case.py:47
job_file
Definition: launcher_use_case.py:43
result_directory
Definition: launcher_use_case.py:45
work_directory
Definition: launcher_use_case.py:44
local_directory
Definition: launcher_use_case.py:42
string name
Definition: pythfilter.py:56
Definition: ResourcesManager.hxx:52