CAPIO-CL 2.0.1
CAPIO-CL: Cross Application Programmable I/O - Coordination Language
Loading...
Searching...
No Matches
engine.h
1#ifndef CAPIO_CL_ENGINE_H
2#define CAPIO_CL_ENGINE_H
3#include <jsoncons/basic_json.hpp>
4#include <shared_mutex>
5#include <vector>
6
7#include "capiocl.hpp"
8#include "capiocl/api.h"
9#include "capiocl/monitor.h"
10#include "capiocl/serializer.h"
11
13namespace capiocl::engine {
14
17struct CapioCLEntry final {
18 // LCOV_EXCL_START
20 std::vector<std::string> producers;
22 std::vector<std::string> consumers;
24 std::vector<std::filesystem::path> file_dependencies;
36 bool store_in_memory = false;
38 bool permanent = false;
40 bool excluded = false;
42 bool is_file = true;
43 // LCOV_EXCL_STOP
44
50 static CapioCLEntry fromJson(const std::string &in);
51
53 [[nodiscard]] std::string toJson() const;
54
57
60
62 bool operator==(const CapioCLEntry &other);
63
65 bool operator!=(const CapioCLEntry &other);
66};
67
83class Engine final {
84 friend class serializer::Serializer;
85
87 mutable std::shared_mutex _shared_mutex;
88
90 bool store_all_in_memory = false;
91
94
96 void configureMonitorBackends();
97
99 monitor::Monitor monitor;
100
102 std::string node_name;
103
105 std::string workflow_name;
106
108 std::unique_ptr<api::CapioClApiServer> webapi_server;
109
111 mutable std::unordered_map<std::string, CapioCLEntry> _capio_cl_entries;
112
123 static std::string truncateLastN(const std::string &str, const std::size_t n) {
124 if (str.length() > n) {
125 return "[..] " + str.substr(str.length() - n);
126 }
127 return str;
128 }
129
134 void _newFile(const std::filesystem::path &path) const;
135
148 void compute_directory_entry_count(const std::filesystem::path &path) const;
149
150 public:
152 explicit Engine(bool use_default_settings = true);
153
155 explicit Engine(const configuration::CapioClConfiguration &config);
156
158 void print() const;
159
167 bool contains(const std::filesystem::path &file) const;
168
170 size_t size() const;
171
184 void add(std::filesystem::path &path, std::vector<std::string> &producers,
185 std::vector<std::string> &consumers, const std::string &commit_rule,
186 const std::string &fire_rule, bool permanent, bool exclude,
187 std::vector<std::filesystem::path> &dependencies);
188
194 void add(const std::filesystem::path &path, const CapioCLEntry &entry) const;
195
202 void addProducer(const std::filesystem::path &path, std::string &producer);
203
210 void addConsumer(const std::filesystem::path &path, std::string &consumer);
211
219 void addFileDependency(const std::filesystem::path &path,
220 std::filesystem::path &file_dependency);
221
228 void newFile(const std::filesystem::path &path) const;
229
234 void remove(const std::filesystem::path &path) const;
235
242 void setCommitRule(const std::filesystem::path &path, const std::string &commit_rule);
243
250 void setFireRule(const std::filesystem::path &path, const std::string &fire_rule);
251
257 void setPermanent(const std::filesystem::path &path, bool value);
258
264 void setExclude(const std::filesystem::path &path, bool value);
265
270 void setDirectory(const std::filesystem::path &path);
271
276 void setFile(const std::filesystem::path &path);
277
284 void setCommitedCloseNumber(const std::filesystem::path &path, long num);
285
298
299 void setDirectoryFileCount(const std::filesystem::path &path, long num);
300
307 void setFileDeps(const std::filesystem::path &path,
308 const std::vector<std::filesystem::path> &dependencies);
309
314 void setStoreFileInMemory(const std::filesystem::path &path);
315
319 void setAllStoreInMemory();
320
325 void setStoreFileInFileSystem(const std::filesystem::path &path);
326
331 void setWorkflowName(const std::string &name);
332
338 long getDirectoryFileCount(const std::filesystem::path &path) const;
339
341 std::string getCommitRule(const std::filesystem::path &path) const;
342
344 std::string getFireRule(const std::filesystem::path &path) const;
345
347 std::vector<std::string> getProducers(const std::filesystem::path &path) const;
348
350 std::vector<std::string> getConsumers(const std::filesystem::path &path) const;
351
353 long getCommitCloseCount(const std::filesystem::path &path) const;
354
356 std::vector<std::filesystem::path>
357 getCommitOnFileDependencies(const std::filesystem::path &path) const;
358
360 std::vector<std::string> getFileToStoreInMemory() const;
361
363 std::set<std::string> getHomeNode(const std::filesystem::path &path) const;
364
366 void setHomeNode(const std::filesystem::path &path) const;
367
369 const std::string &getWorkflowName() const;
370
377 bool isProducer(const std::filesystem::path &path, const std::string &app_name) const;
378
385 bool isConsumer(const std::filesystem::path &path, const std::string &app_name) const;
386
392 bool isFirable(const std::filesystem::path &path) const;
393
399 bool isFile(const std::filesystem::path &path) const;
400
406 bool isExcluded(const std::filesystem::path &path) const;
407
413 bool isDirectory(const std::filesystem::path &path) const;
414
420 bool isStoredInMemory(const std::filesystem::path &path) const;
421
427 bool isPermanent(const std::filesystem::path &path) const;
428
434 bool isCommitted(const std::filesystem::path &path) const;
435
443 bool increaseCloseCount(const std::filesystem::path &path) const;
444
449 void setCommitted(const std::filesystem::path &path) const;
450
455 std::vector<std::string> getPaths() const;
456
462 bool operator==(const Engine &other) const;
463
468 void loadConfiguration(const std::string &path);
469
474
479 void startApiServer();
480};
481
482} // namespace capiocl::engine
483
484#endif // CAPIO_CL_ENGINE_H
Load configuration and store it from a CAPIO-CL TOML configuration file.
Definition configuration.h:41
bool isDirectory(const std::filesystem::path &path) const
Check if a path is a directory.
Definition Engine.cpp:747
void setStoreFileInFileSystem(const std::filesystem::path &path)
Store the file on the file system.
Definition Engine.cpp:1017
void setDirectory(const std::filesystem::path &path)
Mark a path as a directory.
Definition Engine.cpp:687
std::set< std::string > getHomeNode(const std::filesystem::path &path) const
Get the home node of a file.
Definition Engine.cpp:1072
bool isStoredInMemory(const std::filesystem::path &path) const
Check if a file is stored in memory.
Definition Engine.cpp:1036
void setCommitted(const std::filesystem::path &path) const
Definition Engine.cpp:650
const std::string & getWorkflowName() const
Get current workflow name loaded from memory.
Definition Engine.cpp:1011
bool increaseCloseCount(const std::filesystem::path &path) const
Record one qualified logical close for an ON_CLOSE path. Filesystem-backed counts greater than one re...
Definition Engine.cpp:621
bool contains(const std::filesystem::path &file) const
Check whether a file is contained in the configuration. The lookup is performed by exact match or by ...
Definition Engine.cpp:264
bool isProducer(const std::filesystem::path &path, const std::string &app_name) const
Check if a process is a producer for a file.
Definition Engine.cpp:879
void loadConfiguration(const std::string &path)
Definition Engine.cpp:1121
void setCommitedCloseNumber(const std::filesystem::path &path, long num)
Set the commit-on-close counter. The file will be committed after num close operations.
Definition Engine.cpp:755
std::vector< std::filesystem::path > getCommitOnFileDependencies(const std::filesystem::path &path) const
Get file dependencies.
Definition Engine.cpp:957
bool isPermanent(const std::filesystem::path &path) const
Check if file should remain on file system after workflow terminates.
Definition Engine.cpp:554
std::vector< std::string > getPaths() const
Definition Engine.cpp:656
void addFileDependency(const std::filesystem::path &path, std::filesystem::path &file_dependency)
Add a new file dependency, when rule is commit_on_file As a side effect, the file identified by path,...
Definition Engine.cpp:396
bool isCommitted(const std::filesystem::path &path) const
Definition Engine.cpp:574
std::vector< std::string > getConsumers(const std::filesystem::path &path) const
Get the consumers of a file.
Definition Engine.cpp:818
void addProducer(const std::filesystem::path &path, std::string &producer)
Add a new producer to a file entry.
Definition Engine.cpp:342
std::string getCommitRule(const std::filesystem::path &path) const
Get the commit rule of a file.
Definition Engine.cpp:446
void setStoreFileInMemory(const std::filesystem::path &path)
Store the file in memory only.
Definition Engine.cpp:967
size_t size() const
return the number of entries in the current configuration
Definition Engine.cpp:272
void setFireRule(const std::filesystem::path &path, const std::string &fire_rule)
Set the fire rule of a file.
Definition Engine.cpp:488
std::vector< std::string > getProducers(const std::filesystem::path &path) const
Get the producers of a file.
Definition Engine.cpp:858
void newFile(const std::filesystem::path &path) const
Create a new CAPIO file entry. Commit and fire rules are automatically computed using the longest pre...
Definition Engine.cpp:321
std::vector< std::string > getFileToStoreInMemory() const
Get the list of files stored in memory.
Definition Engine.cpp:1056
bool isFile(const std::filesystem::path &path) const
Check if a path refers to a file.
Definition Engine.cpp:727
std::string getFireRule(const std::filesystem::path &path) const
Get the fire rule of a file.
Definition Engine.cpp:467
long getDirectoryFileCount(const std::filesystem::path &path) const
Get the expected number of files in a directory.
Definition Engine.cpp:327
void setDirectoryFileCount(const std::filesystem::path &path, long num)
Sets the expected number of files in a directory.
Definition Engine.cpp:780
void setFile(const std::filesystem::path &path)
Mark a path as a file.
Definition Engine.cpp:707
void remove(const std::filesystem::path &path) const
Remove a file from the configuration.
Definition Engine.cpp:806
void useDefaultConfiguration()
Definition Engine.cpp:1163
void setWorkflowName(const std::string &name)
Definition Engine.cpp:1002
void startApiServer()
Definition Engine.cpp:1173
bool isConsumer(const std::filesystem::path &path, const std::string &app_name) const
Check if a process is a consumer for a file.
Definition Engine.cpp:828
void setPermanent(const std::filesystem::path &path, bool value)
Mark a file as permanent or not.
Definition Engine.cpp:533
bool isExcluded(const std::filesystem::path &path) const
Check if a path is excluded.
Definition Engine.cpp:1083
bool operator==(const Engine &other) const
Check for equality between two instances of Engine.
Definition Engine.cpp:1102
bool isFirable(const std::filesystem::path &path) const
Check if a file is firable, that is fire rule is no_update.
Definition Engine.cpp:513
void addConsumer(const std::filesystem::path &path, std::string &consumer)
Add a new consumer to a file entry.
Definition Engine.cpp:371
long getCommitCloseCount(const std::filesystem::path &path) const
Get the commit-on-close counter for a file.
Definition Engine.cpp:936
void add(std::filesystem::path &path, std::vector< std::string > &producers, std::vector< std::string > &consumers, const std::string &commit_rule, const std::string &fire_rule, bool permanent, bool exclude, std::vector< std::filesystem::path > &dependencies)
Add a new CAPIO-CL configuration entry.
Definition Engine.cpp:278
void print() const
Print the current CAPIO-CL configuration.
Definition Engine.cpp:43
void setAllStoreInMemory()
set all files to be stored in memory. Once this method is called, all new files will be stored in mem...
Definition Engine.cpp:988
void setCommitRule(const std::filesystem::path &path, const std::string &commit_rule)
Set the commit rule of a file.
Definition Engine.cpp:420
Engine(bool use_default_settings=true)
Class constructor.
Definition Engine.cpp:165
void setFileDeps(const std::filesystem::path &path, const std::vector< std::filesystem::path > &dependencies)
Set the dependencies of a file. This method as a side effect sets the commit rule to Commit on Files.
Definition Engine.cpp:907
void setHomeNode(const std::filesystem::path &path) const
Set the home node for a given path.
Definition Engine.cpp:1077
void setExclude(const std::filesystem::path &path, bool value)
Mark a file as excluded or not.
Definition Engine.cpp:667
Class to monitor runtime dependent information on CAPIO-CL related paths, such as commitment status a...
Definition monitor.h:326
Dump the current loaded CAPIO-CL configuration from class Engine to a CAPIO-CL configuration file.
Definition serializer.h:34
constexpr char ON_TERMINATION[]
CoT Streaming Rule.
Definition capiocl.hpp:45
Namespace containing the CAPIO-CL Engine.
Definition engine.h:13
constexpr char UPDATE[]
FoC Streaming Rule.
Definition capiocl.hpp:18
Internal CAPIO-CL Engine storage entity. Each CapioCLEntry is an entry for a given file handled by CA...
Definition engine.h:17
bool excluded
whether to ignore this entry
Definition engine.h:40
bool is_file
whether this entry is a file or a directory
Definition engine.h:42
bool operator!=(const CapioCLEntry &other)
check for inequality
Definition Engine.cpp:1326
long commit_on_close_count
Expected close count.
Definition engine.h:32
bool enable_directory_count_update
whether to update or not directory item count
Definition engine.h:34
std::vector< std::filesystem::path > file_dependencies
Dependencies for Commit.
Definition engine.h:24
std::string fire_rule
Fire rule.
Definition engine.h:28
CapioCLEntry operator+(const CapioCLEntry &rhs)
add a new CapioClEntry to this one
Definition Engine.cpp:1269
bool permanent
whether the file should persiste after workflow termination
Definition engine.h:38
std::string toJson() const
Serialize this entry to a JSON object returned as string to be sent over network.
Definition Engine.cpp:1217
CapioCLEntry & operator+=(const CapioCLEntry &rhs)
add a new CapioClEntry to this one
Definition Engine.cpp:1242
bool operator==(const CapioCLEntry &other)
check for equality of rules
Definition Engine.cpp:1276
std::string commit_rule
Commit rule.
Definition engine.h:26
static CapioCLEntry fromJson(const std::string &in)
Definition Engine.cpp:1179
long directory_children_count
Expected number of files in directory.
Definition engine.h:30
bool store_in_memory
Store in memory or on the file system.
Definition engine.h:36
std::vector< std::string > consumers
consumers of file
Definition engine.h:22
std::vector< std::string > producers
Producers of file.
Definition engine.h:20