X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/745934a3a7f8924055f3ecdb3491884dd60d194a..c90aba67a7dd5458a2d7b2e31b54735f5311f787:/include/simgrid/plugins/file_system.h?ds=sidebyside diff --git a/include/simgrid/plugins/file_system.h b/include/simgrid/plugins/file_system.h index 4d7390dec4..fcc4f99408 100644 --- a/include/simgrid/plugins/file_system.h +++ b/include/simgrid/plugins/file_system.h @@ -1,5 +1,4 @@ -/* Copyright (c) 2017. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2017-2020. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -9,51 +8,66 @@ #include #include +#include -SG_BEGIN_DECL() - -XBT_PUBLIC(void) sg_storage_file_system_init(); -XBT_PUBLIC(sg_file_t) sg_file_open(const char* fullpath, void* data); -XBT_PUBLIC(sg_size_t) sg_file_read(sg_file_t fd, sg_size_t size); -XBT_PUBLIC(sg_size_t) sg_file_write(sg_file_t fd, sg_size_t size); -XBT_PUBLIC(void) sg_file_close(sg_file_t fd); - -XBT_PUBLIC(const char*) sg_file_get_name(sg_file_t fd); -XBT_PUBLIC(sg_size_t) sg_file_get_size(sg_file_t fd); -XBT_PUBLIC(void) sg_file_dump(sg_file_t fd); -XBT_PUBLIC(void*) sg_file_get_data(sg_file_t fd); -XBT_PUBLIC(void) sg_file_set_data(sg_file_t fd, void* data); -XBT_PUBLIC(void) sg_file_seek(sg_file_t fd, sg_offset_t offset, int origin); -XBT_PUBLIC(sg_size_t) sg_file_tell(sg_file_t fd); -XBT_PUBLIC(void) sg_file_move(sg_file_t fd, const char* fullpath); -XBT_PUBLIC(void) sg_file_unlink(sg_file_t fd); -XBT_PUBLIC(int) sg_file_rcopy(sg_file_t file, sg_host_t host, const char* fullpath); -XBT_PUBLIC(int) sg_file_rmove(sg_file_t file, sg_host_t host, const char* fullpath); - -XBT_PUBLIC(void*) sg_storage_get_data(sg_storage_t storage); -XBT_PUBLIC(void) sg_storage_set_data(sg_storage_t storage, void* data); -XBT_PUBLIC(sg_size_t) sg_storage_get_size_free(sg_storage_t st); -XBT_PUBLIC(sg_size_t) sg_storage_get_size_used(sg_storage_t st); -XBT_PUBLIC(sg_size_t) sg_storage_get_size(sg_storage_t st); -XBT_PUBLIC(xbt_dict_t) sg_storage_get_content(sg_storage_t storage); - -XBT_PUBLIC(xbt_dict_t) sg_host_get_storage_content(sg_host_t host); - -#define MSG_file_open(fullpath, data) sg_file_open(fullpath, data) -#define MSG_file_read(fd, size) sg_file_read(fd, size) -#define MSG_file_write(fd, size) sg_file_write(fd, size) +#ifdef __cplusplus +#include + +#include +#include +#include +#endif /* C++ */ + +// C interface +//////////////// +typedef sg_file_t msg_file_t; // MSG backwards compatibility + +SG_BEGIN_DECL +XBT_PUBLIC void sg_storage_file_system_init(); +XBT_PUBLIC sg_file_t sg_file_open(const char* fullpath, void* data); +XBT_PUBLIC sg_size_t sg_file_read(sg_file_t fd, sg_size_t size); +XBT_PUBLIC sg_size_t sg_file_write(sg_file_t fd, sg_size_t size); +XBT_PUBLIC void sg_file_close(const_sg_file_t fd); + +XBT_PUBLIC const char* sg_file_get_name(sg_file_t fd); +XBT_PUBLIC sg_size_t sg_file_get_size(sg_file_t fd); +XBT_PUBLIC void sg_file_dump(sg_file_t fd); +XBT_PUBLIC void* sg_file_get_data(const_sg_file_t fd); +XBT_PUBLIC void sg_file_set_data(sg_file_t fd, void* data); +XBT_PUBLIC void sg_file_seek(sg_file_t fd, sg_offset_t offset, int origin); +XBT_PUBLIC sg_size_t sg_file_tell(sg_file_t fd); +XBT_PUBLIC void sg_file_move(sg_file_t fd, const char* fullpath); +XBT_PUBLIC void sg_file_unlink(sg_file_t fd); +XBT_PUBLIC int sg_file_rcopy(sg_file_t file, sg_host_t host, const char* fullpath); +XBT_PUBLIC int sg_file_rmove(sg_file_t file, sg_host_t host, const char* fullpath); + +XBT_PUBLIC sg_size_t sg_disk_get_size_free(const_sg_disk_t d); +XBT_PUBLIC sg_size_t sg_disk_get_size_used(const_sg_disk_t d); +XBT_PUBLIC sg_size_t sg_disk_get_size(const_sg_disk_t d); +XBT_PUBLIC const char* sg_disk_get_mount_point(const_sg_disk_t d); + +XBT_PUBLIC sg_size_t sg_storage_get_size_free(const_sg_storage_t st); +XBT_PUBLIC sg_size_t sg_storage_get_size_used(const_sg_storage_t st); +XBT_PUBLIC sg_size_t sg_storage_get_size(const_sg_storage_t st); +XBT_PUBLIC xbt_dict_t sg_storage_get_content(const_sg_storage_t storage); + +XBT_PUBLIC xbt_dict_t sg_host_get_storage_content(sg_host_t host); + +#define MSG_file_open(fullpath, data) sg_file_open((fullpath), (data)) +#define MSG_file_read(fd, size) sg_file_read((fd), (size)) +#define MSG_file_write(fd, size) sg_file_write((fd), (size)) #define MSG_file_close(fd) sg_file_close(fd) #define MSG_file_get_name(fd) sg_file_get_name(fd) #define MSG_file_get_size(fd) sg_file_get_size(fd) #define MSG_file_dump(fd) sg_file_dump(fd) #define MSG_file_get_data(fd) sg_file_get_data(fd) -#define MSG_file_set_data(fd, data) sg_file_set_data(fd, data) -#define MSG_file_seek(fd, offset, origin) sg_file_seek(fd, offset, origin) +#define MSG_file_set_data(fd, data) sg_file_set_data((fd), (data)) +#define MSG_file_seek(fd, offset, origin) sg_file_seek((fd), (offset), (origin)) #define MSG_file_tell(fd) sg_file_tell(fd) -#define MSG_file_move(fd, fullpath) sg_file_get_size(fd, fullpath) +#define MSG_file_move(fd, fullpath) sg_file_get_size((fd), (fullpath)) #define MSG_file_unlink(fd) sg_file_unlink(fd) -#define MSG_file_rcopy(file, host, fullpath) sg_file_rcopy(file, host, fullpath) -#define MSG_file_rmove(file, host, fullpath) sg_file_rmove(file, host, fullpath) +#define MSG_file_rcopy(file, host, fullpath) sg_file_rcopy((file), (host), (fullpath)) +#define MSG_file_rmove(file, host, fullpath) sg_file_rmove((file), (host), (fullpath)) #define MSG_storage_file_system_init() sg_storage_file_system_init() #define MSG_storage_get_free_size(st) sg_storage_get_size_free(st) @@ -63,6 +77,131 @@ XBT_PUBLIC(xbt_dict_t) sg_host_get_storage_content(sg_host_t host); #define MSG_host_get_storage_content(st) sg_host_get_storage_content(st) -SG_END_DECL() +SG_END_DECL + +// C++ interface +////////////////// + +#ifdef __cplusplus + +namespace simgrid { + +extern template class XBT_PUBLIC xbt::Extendable; + +namespace s4u { + +/** @brief A simulated file + * @addtogroup Plugin_filesystem + * + * Used to simulate the time it takes to access to a file, but does not really store any information. + * + * They are located on @ref simgrid::s4u::Storage that are accessed from a given @ref simgrid::s4u::Host through + * mountpoints. + * For now, you cannot change the mountpoints programmatically, and must declare them from your platform file. + */ +class XBT_PUBLIC File : public xbt::Extendable { + sg_size_t size_; + std::string path_; + std::string fullpath_; + sg_size_t current_position_ = SEEK_SET; + int desc_id = 0; + Disk* local_disk_ = nullptr; + Storage* local_storage_ = nullptr; + std::string mount_point_; + Storage* find_local_storage_on(Host* host); + Disk* find_local_disk_on(const Host* host); + sg_size_t write_on_storage(sg_size_t size, bool write_inside); + sg_size_t write_on_disk(sg_size_t size, bool write_inside); + +public: + File(const std::string& fullpath, void* userdata); + File(const std::string& fullpath, sg_host_t host, void* userdata); + File(const File&) = delete; + File& operator=(const File&) = delete; + ~File(); + + /** Retrieves the path to the file */ + const char* get_path() const { return fullpath_.c_str(); } + + /** Simulates a local read action. Returns the size of data actually read */ + sg_size_t read(sg_size_t size); + + /** Simulates a write action. Returns the size of data actually written. */ + sg_size_t write(sg_size_t size, bool write_inside = false); + + /** Allows to store user data on that host */ + XBT_ATTRIB_DEPRECATED_v329("Please use set_data()") void set_userdata(void* data) { set_data(data); } + /** Retrieves the previously stored data */ + XBT_ATTRIB_DEPRECATED_v329("Please use get_data()") void* get_userdata() { return get_data(); } + + sg_size_t size() const; + void seek(sg_offset_t pos); /** Sets the file head to the given position. */ + void seek(sg_offset_t pos, int origin); /** Sets the file head to the given position from a given origin. */ + sg_size_t tell() const; /** Retrieves the current file position */ + + /** Rename a file. WARNING: It is forbidden to move the file to another mount point */ + void move(const std::string& fullpath) const; + int remote_copy(sg_host_t host, const char* fullpath); + int remote_move(sg_host_t host, const char* fullpath); + + int unlink() const; /** Remove a file from the contents of a disk */ + void dump(); +}; + +class XBT_PUBLIC FileSystemDiskExt { + std::unique_ptr> content_; + std::map remote_mount_points_; + std::string mount_point_; + sg_size_t used_size_ = 0; + sg_size_t size_ = static_cast(500 * 1024) * 1024 * 1024; + +public: + static simgrid::xbt::Extension EXTENSION_ID; + explicit FileSystemDiskExt(const Disk* ptr); + FileSystemDiskExt(const FileSystemDiskExt&) = delete; + FileSystemDiskExt& operator=(const FileSystemDiskExt&) = delete; + std::map* parse_content(const std::string& filename); + std::map* get_content() const { return content_.get(); } + const char* get_mount_point() const { return mount_point_.c_str(); } + const char* get_mount_point(s4u::Host* remote_host) { return remote_mount_points_[remote_host].c_str(); } + void add_remote_mount(Host* host, const std::string& mount_point) + { + remote_mount_points_.insert({host, mount_point}); + } + sg_size_t get_size() const { return size_; } + sg_size_t get_used_size() const { return used_size_; } + void decr_used_size(sg_size_t size); + void incr_used_size(sg_size_t size); +}; + +class XBT_PUBLIC FileSystemStorageExt { + std::unique_ptr> content_; + sg_size_t used_size_ = 0; + sg_size_t size_ = 0; + +public: + static simgrid::xbt::Extension EXTENSION_ID; + explicit FileSystemStorageExt(const Storage* ptr); + FileSystemStorageExt(const FileSystemStorageExt&) = delete; + FileSystemStorageExt& operator=(const FileSystemStorageExt&) = delete; + std::map* parse_content(const std::string& filename); + std::map* get_content() { return content_.get(); } + sg_size_t get_size() const { return size_; } + sg_size_t get_used_size() const { return used_size_; } + void decr_used_size(sg_size_t size); + void incr_used_size(sg_size_t size); +}; + +class XBT_PUBLIC FileDescriptorHostExt { +public: + static simgrid::xbt::Extension EXTENSION_ID; + FileDescriptorHostExt() = default; + FileDescriptorHostExt(const FileDescriptorHostExt&) = delete; + FileDescriptorHostExt& operator=(const FileDescriptorHostExt&) = delete; + std::unique_ptr> file_descriptor_table = nullptr; // Created lazily on need +}; +} // namespace s4u +} // namespace simgrid +#endif #endif