Version: 8.3.0
Launcher_Job.hxx
Go to the documentation of this file.
1 // Copyright (C) 2009-2016 CEA/DEN, EDF R&D, 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 {
48  class LAUNCHER_EXPORT Job
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 setWorkDirectory(const std::string & work_directory);
71  void setLocalDirectory(const std::string & local_directory);
72  void setResultDirectory(const std::string & result_directory);
73  void add_in_file(const std::string & file);
74  void add_out_file(const std::string & file);
75  void setMaximumDuration(const std::string & maximum_duration);
76  void setResourceRequiredParams(const resourceParams & resource_required_params);
77  void setQueue(const std::string & queue);
78  void setEnvFile(const std::string & env_file);
79  void setExclusive(bool exclusive);
80  void setExclusiveStr(const std::string & exclusiveStr);
81  void setMemPerCpu(unsigned long mem_per_cpu);
82  void setWCKey(const std::string & wckey);
83  void setExtraParams(const std::string & extra_params);
84  void setReference(const std::string & reference);
85  // For COORM
86  void setLauncherFile(const std::string & launcher_file);
87  void setLauncherArgs(const std::string & launcher_args);
88 
89  std::string getJobName() const;
90  std::string getJobFile() const;
91  std::string getWorkDirectory() const;
92  std::string getLocalDirectory() const;
93  std::string getResultDirectory() const;
94  const std::list<std::string> & get_in_files() const;
95  const std::list<std::string> & get_out_files() const;
96  std::string getMaximumDuration() const;
97  resourceParams getResourceRequiredParams() const;
98  std::string getQueue() const;
99  std::string getEnvFile() const;
100  std::string getJobType() const;
101  bool getExclusive() const;
102  std::string getExclusiveStr() const;
103  unsigned long getMemPerCpu() const;
104  std::string getWCKey() const;
105  std::string getExtraParams() const;
106  std::string getReference() const;
107 
108  // For COORM
109  std::string getLauncherFile() const;
110  std::string getLauncherArgs() const;
111 
112  std::string updateJobState();
113 
114  void addSpecificParameter(const std::string & name,
115  const std::string & value);
116  const std::map<std::string, std::string> & getSpecificParameters() const;
117  virtual void checkSpecificParameters();
118 
119  // Checks
120  void checkMaximumDuration(const std::string & maximum_duration);
121  void checkResourceRequiredParams(const resourceParams & resource_required_params);
122 
123  // Helps
124  long convertMaximumDuration(const std::string & maximum_duration);
125  std::string getLaunchDate() const;
126 
127  void stopJob();
128  void removeJob();
129 
130  // Abstract class
131  virtual void update_job() = 0;
132 
133  protected:
134  int _number;
135 
136  std::string _job_type;
137 
138  std::string _state;
139  std::string _assigned_hostnames; // Assigned hostnames
140  std::string _launch_date;
141  std::string _env_file;
142 
143  ParserResourcesType _resource_definition;
144 
145  std::string _job_name;
146  std::string _job_file;
147  std::string _job_file_name;
148  std::string _job_file_name_complete;
149 
150  std::string _work_directory;
151  std::string _local_directory;
152  std::string _result_directory;
153  std::list<std::string> _in_files;
154  std::list<std::string> _out_files;
155  std::map<std::string, std::string> _specific_parameters;
156  std::string _maximum_duration;
157  long _maximum_duration_in_second;
158  resourceParams _resource_required_params;
159  std::string _queue;
160  bool _exclusive;
161  unsigned long _mem_per_cpu;
162  std::string _wckey;
163  std::string _extra_params;
164  std::string _reference;
165 
166  // Parameters for COORM
167  std::string _launcher_file;
168  std::string _launcher_args;
169 
170 #ifdef WITH_LIBBATCH
171  // Connection with LIBBATCH
172  public:
173  Batch::Job * getBatchJob();
174  Batch::Parametre common_job_params();
175  void setBatchManagerJobId(Batch::JobId batch_manager_job_id);
176  Batch::JobId getBatchManagerJobId() const;
177 
178  protected:
179  Batch::Job * _batch_job;
180  Batch::JobId _batch_job_id;
181 #endif
182  };
183 }
184 
185 #endif