CAPIO-CL 1.4.0
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 monitor::Monitor monitor;
97
99 std::string node_name;
100
102 std::string workflow_name;
103
105 std::unique_ptr<api::CapioClApiServer> webapi_server;
106
108 mutable std::unordered_map<std::string, CapioCLEntry> _capio_cl_entries;
109
120 static std::string truncateLastN(const std::string &str, const std::size_t n) {
121 if (str.length() > n) {
122 return "[..] " + str.substr(str.length() - n);
123 }
124 return str;
125 }
126
131 void _newFile(const std::filesystem::path &path) const;
132
145 void compute_directory_entry_count(const std::filesystem::path &path) const;
146
147 public:
149 explicit Engine(bool use_default_settings = true);
150
152 void print() const;
153
161 bool contains(const std::filesystem::path &file) const;
162
164 size_t size() const;
165
178 void add(std::filesystem::path &path, std::vector<std::string> &producers,
179 std::vector<std::string> &consumers, const std::string &commit_rule,
180 const std::string &fire_rule, bool permanent, bool exclude,
181 std::vector<std::filesystem::path> &dependencies);
182
188 void add(const std::filesystem::path &path, const CapioCLEntry &entry) const;
189
196 void addProducer(const std::filesystem::path &path, std::string &producer);
197
204 void addConsumer(const std::filesystem::path &path, std::string &consumer);
205
213 void addFileDependency(const std::filesystem::path &path,
214 std::filesystem::path &file_dependency);
215
222 void newFile(const std::filesystem::path &path) const;
223
228 void remove(const std::filesystem::path &path) const;
229
236 void setCommitRule(const std::filesystem::path &path, const std::string &commit_rule);
237
244 void setFireRule(const std::filesystem::path &path, const std::string &fire_rule);
245
251 void setPermanent(const std::filesystem::path &path, bool value);
252
258 void setExclude(const std::filesystem::path &path, bool value);
259
264 void setDirectory(const std::filesystem::path &path);
265
270 void setFile(const std::filesystem::path &path);
271
278 void setCommitedCloseNumber(const std::filesystem::path &path, long num);
279
292
293 void setDirectoryFileCount(const std::filesystem::path &path, long num);
294
301 void setFileDeps(const std::filesystem::path &path,
302 const std::vector<std::filesystem::path> &dependencies);
303
308 void setStoreFileInMemory(const std::filesystem::path &path);
309
313 void setAllStoreInMemory();
314
319 void setStoreFileInFileSystem(const std::filesystem::path &path);
320
325 void setWorkflowName(const std::string &name);
326
332 long getDirectoryFileCount(const std::filesystem::path &path) const;
333
335 std::string getCommitRule(const std::filesystem::path &path) const;
336
338 std::string getFireRule(const std::filesystem::path &path) const;
339
341 std::vector<std::string> getProducers(const std::filesystem::path &path) const;
342
344 std::vector<std::string> getConsumers(const std::filesystem::path &path) const;
345
347 long getCommitCloseCount(const std::filesystem::path &path) const;
348
350 std::vector<std::filesystem::path>
351 getCommitOnFileDependencies(const std::filesystem::path &path) const;
352
354 std::vector<std::string> getFileToStoreInMemory() const;
355
357 std::set<std::string> getHomeNode(const std::filesystem::path &path) const;
358
360 void setHomeNode(const std::filesystem::path &path) const;
361
363 const std::string &getWorkflowName() const;
364
371 bool isProducer(const std::filesystem::path &path, const std::string &app_name) const;
372
379 bool isConsumer(const std::filesystem::path &path, const std::string &app_name) const;
380
386 bool isFirable(const std::filesystem::path &path) const;
387
393 bool isFile(const std::filesystem::path &path) const;
394
400 bool isExcluded(const std::filesystem::path &path) const;
401
407 bool isDirectory(const std::filesystem::path &path) const;
408
414 bool isStoredInMemory(const std::filesystem::path &path) const;
415
421 bool isPermanent(const std::filesystem::path &path) const;
422
428 bool isCommitted(const std::filesystem::path &path) const;
429
434 void setCommitted(const std::filesystem::path &path) const;
435
440 std::vector<std::string> getPaths() const;
441
447 bool operator==(const Engine &other) const;
448
453 void loadConfiguration(const std::string &path);
454
459
464 void startApiServer();
465};
466
467} // namespace capiocl::engine
468
469#endif // CAPIO_CL_ENGINE_H
Load configuration and store it from a CAPIO-CL TOML configuration file.
Definition configuration.h:39
bool isDirectory(const std::filesystem::path &path) const
Check if a path is a directory.
Definition Engine.cpp:576
void setStoreFileInFileSystem(const std::filesystem::path &path)
Store the file on the file system.
Definition Engine.cpp:808
void setDirectory(const std::filesystem::path &path)
Mark a path as a directory.
Definition Engine.cpp:525
std::set< std::string > getHomeNode(const std::filesystem::path &path) const
Get the home node of a file.
Definition Engine.cpp:857
bool isStoredInMemory(const std::filesystem::path &path) const
Check if a file is stored in memory.
Definition Engine.cpp:823
void setCommitted(const std::filesystem::path &path) const
Definition Engine.cpp:496
const std::string & getWorkflowName() const
Get current workflow name loaded from memory.
Definition Engine.cpp:803
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:222
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:689
void loadConfiguration(const std::string &path)
Definition Engine.cpp:901
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:583
std::vector< std::filesystem::path > getCommitOnFileDependencies(const std::filesystem::path &path) const
Get file dependencies.
Definition Engine.cpp:760
bool isPermanent(const std::filesystem::path &path) const
Check if file should remain on file system after workflow terminates.
Definition Engine.cpp:473
std::vector< std::string > getPaths() const
Definition Engine.cpp:500
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:336
bool isCommitted(const std::filesystem::path &path) const
Definition Engine.cpp:492
std::vector< std::string > getConsumers(const std::filesystem::path &path) const
Get the consumers of a file.
Definition Engine.cpp:633
void addProducer(const std::filesystem::path &path, std::string &producer)
Add a new producer to a file entry.
Definition Engine.cpp:287
std::string getCommitRule(const std::filesystem::path &path) const
Get the commit rule of a file.
Definition Engine.cpp:378
void setStoreFileInMemory(const std::filesystem::path &path)
Store the file in memory only.
Definition Engine.cpp:769
size_t size() const
return the number of entries in the current configuration
Definition Engine.cpp:229
void setFireRule(const std::filesystem::path &path, const std::string &fire_rule)
Set the fire rule of a file.
Definition Engine.cpp:418
std::vector< std::string > getProducers(const std::filesystem::path &path) const
Get the producers of a file.
Definition Engine.cpp:669
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:267
std::vector< std::string > getFileToStoreInMemory() const
Get the list of files stored in memory.
Definition Engine.cpp:842
bool isFile(const std::filesystem::path &path) const
Check if a path refers to a file.
Definition Engine.cpp:557
std::string getFireRule(const std::filesystem::path &path) const
Get the fire rule of a file.
Definition Engine.cpp:398
long getDirectoryFileCount(const std::filesystem::path &path) const
Get the expected number of files in a directory.
Definition Engine.cpp:272
void setDirectoryFileCount(const std::filesystem::path &path, long num)
Sets the expected number of files in a directory.
Definition Engine.cpp:600
void setFile(const std::filesystem::path &path)
Mark a path as a file.
Definition Engine.cpp:541
void remove(const std::filesystem::path &path) const
Remove a file from the configuration.
Definition Engine.cpp:623
void useDefaultConfiguration()
Definition Engine.cpp:930
void setWorkflowName(const std::string &name)
Definition Engine.cpp:798
void startApiServer()
Definition Engine.cpp:938
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:642
void setPermanent(const std::filesystem::path &path, bool value)
Mark a file as permanent or not.
Definition Engine.cpp:457
bool isExcluded(const std::filesystem::path &path) const
Check if a path is excluded.
Definition Engine.cpp:865
bool operator==(const Engine &other) const
Check for equality between two instances of Engine.
Definition Engine.cpp:883
bool isFirable(const std::filesystem::path &path) const
Check if a file is firable, that is fire rule is no_update.
Definition Engine.cpp:438
void addConsumer(const std::filesystem::path &path, std::string &consumer)
Add a new consumer to a file entry.
Definition Engine.cpp:314
long getCommitCloseCount(const std::filesystem::path &path) const
Get the commit-on-close counter for a file.
Definition Engine.cpp:740
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:234
void print() const
Print the current CAPIO-CL configuration.
Definition Engine.cpp:28
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:786
void setCommitRule(const std::filesystem::path &path, const std::string &commit_rule)
Set the commit rule of a file.
Definition Engine.cpp:357
Engine(bool use_default_settings=true)
Class constructor.
Definition Engine.cpp:148
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:714
void setHomeNode(const std::filesystem::path &path) const
Set the home node for a given path.
Definition Engine.cpp:861
void setExclude(const std::filesystem::path &path, bool value)
Mark a file as excluded or not.
Definition Engine.cpp:510
Class to monitor runtime dependent information on CAPIO-CL related paths, such as commitment status a...
Definition monitor.h:295
Dump the current loaded CAPIO-CL configuration from class Engine to a CAPIO-CL configuration file.
Definition serializer.h:30
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:1082
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:1026
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:976
CapioCLEntry & operator+=(const CapioCLEntry &rhs)
add a new CapioClEntry to this one
Definition Engine.cpp:1000
bool operator==(const CapioCLEntry &other)
check for equality of rules
Definition Engine.cpp:1032
std::string commit_rule
Commit rule.
Definition engine.h:26
static CapioCLEntry fromJson(const std::string &in)
Definition Engine.cpp:942
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