ft_endpoint_dir.h

Go to the documentation of this file.

/*
****************************
 
FasTensor (FT) Copyright (c) 2021, The Regents of the University of
California, through Lawrence Berkeley National Laboratory (subject to
receipt of any required approvals from the U.S. Dept. of Energy). 
All rights reserved.
 
If you have questions about your rights to use or distribute this software,
please contact Berkeley Lab's Intellectual Property Office at
[email protected].
 
NOTICE.  This Software was developed under funding from the U.S. Department
of Energy and the U.S. Government consequently retains certain rights.  As
such, the U.S. Government has been granted for itself and others acting on
its behalf a paid-up, nonexclusive, irrevocable, worldwide license in the
Software to reproduce, distribute copies to the public, prepare derivative 
works, and perform publicly and display publicly, and to permit others to do so.
 
 
****************************
 
 
*** License Agreement ***
 
FasTensor (FT) Copyright (c) 2021, The Regents of the University of
California, through Lawrence Berkeley National Laboratory (subject to
receipt of any required approvals from the U.S. Dept. of Energy). 
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
(1) Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
 
(2) Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
 
(3) Neither the name of the University of California, Lawrence Berkeley
National Laboratory, U.S. Dept. of Energy nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
 
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
 
You are under no obligation whatsoever to provide any bug fixes, patches,
or upgrades to the features, functionality or performance of the source
code ("Enhancements") to anyone; however, if you choose to make your
Enhancements available either publicly, or directly to Lawrence Berkeley
National Laboratory, without imposing a separate written license agreement
for such Enhancements, then you hereby grant the following license: a
non-exclusive, royalty-free perpetual license to install, use, modify,
prepare derivative works, incorporate into other computer software,
distribute, and sublicense such enhancements or derivative works thereof,
in binary and source code form.
*/
 
#ifndef END_POINT_DIR_H
#define END_POINT_DIR_H
 
#define DIR_MERGE_INDEX 0
#define DIR_SUB_CMD_ARG 1
#define DIR_INPUT_SEARCH_RGX 2
#define DIR_OUPUT_REPLACE_RGX 3
#define DIR_OUPUT_REPLACE_RGX_ARG 4
#define DIR_FILE_SORT_INDEXES 15
#define DIR_N_FILES 6
#define DIR_GET_FILE_SIZE 7
#define DIR_SET_CHUNK_SIZE 8
#define DIR_GET_ALL_CHUNK_TAGS 9
#define DIR_SET_ALL_CHUNK_TAGS 10
 
//Todo
#define DIR_INPUT_ELASTIC_SIZE 11
#define DIR_OUTPUT_ELASTIC_SIZE 12
#define DIR_SET_OUTPUT_FILE_NAMES 13
 
#include "ft_utility.h"
#include "ft_type.h"
#include "ft_endpoint.h"
#include "ft_endpoint_hdf5.h"
#include "ft_endpoint_tdms.h"
#include <string>
#include <iostream>
#include <vector>
#include <math.h>
#include <regex>
 
//
//I/O layer
class EndpointDIR : public Endpoint
{
private:
    std::string endpoint_info;
    AuEndpointType sub_endpoint_type;
    std::string sub_endpoint_info; //Directory of files
    Endpoint *sub_endpoint = nullptr;
 
    std::string dir_str;
    std::vector<std::string> dir_file_list;
    int dir_file_list_current_index = 0; //index of the current one in read/write
 
    std::string append_sub_endpoint_info;              //dir_file_list[i] + append_sub_endpoint_info is the finale sub_endpoint_info
    std::vector<int> dir_chunk_size, dir_overlap_size; //set chunk size to be each sub_endpoint
 
    int dir_data_merge_index = 0;
 
    //http://www.cplusplus.com/reference/regex/ECMAScript/
    bool input_replace_regex_flag = false;
    std::regex *input_filter_regex; //The regex to "search" on list of file as input
 
    bool output_replace_regex_flag = false;
    std::regex *output_replace_regex; //The regex to "replace" on list of file as output (input)
    std::string output_replace_regex_aug;
    std::string output_replace_regex_match_str;
 
    bool has_ordering_on_file_list = false; //User may apply ordering on list, based on sorted ordring
    std::vector<size_t> order_on_file_list;
 
public:
    EndpointDIR(std::string endpoint_info_p)
    {
        endpoint_info = endpoint_info_p;
        ParseEndpointInfo();
        if (sub_endpoint_type == EP_HDF5)
        {
            sub_endpoint = new EndpointHDF5();
            std::vector<std::string> cmd_argv;
            sub_endpoint->Control(OP_DISABLE_MPI_IO, cmd_argv);
            sub_endpoint->Control(OP_DISABLE_COLLECTIVE_IO, cmd_argv);
        }
        else if (sub_endpoint_type == EP_TDMS)
        {
            sub_endpoint = new EndpointTDMS();
        }
        SetEndpointType(EP_DIR);
        sub_endpoint->SetDataElementType(data_element_type);
    }
 
    EndpointDIR()
    {
    }
 
    ~EndpointDIR()
    {
        if (sub_endpoint != nullptr)
            delete sub_endpoint;
    }
    int ExtractMeta() override;
    int PrintInfo() override;
 
    int Create() override;
 
    int Open() override;
 
    int Read(std::vector<unsigned long long> start, std::vector<unsigned long long> end, void *data) override;
 
    int Write(std::vector<unsigned long long> start, std::vector<unsigned long long> end, void *data) override;
 
    int Close() override;
 
    void Map2MyType() override;
 
    void EnableCollectiveIO() override;
 
    void DisableCollectiveIO() override;
 
    int ParseEndpointInfo() override;
 
    std::vector<int> GetDirChunkSize() override;
 
    void SetDirChunkSize(std::vector<int> &dir_chunk_size_p) override;
 
    std::vector<std::string> GetDirFileVector() override;
 
    void SetDirFileVector(std::vector<std::string> &file_list) override;
 
    int Control(int opt_code, std::vector<std::string> &parameter_v) override;
 
    void SetMergeIndex(int index_p);
 
    int GetMergeIndex();
 
    int WriteAttribute(const std::string &name, const void *data, FTDataType data_type_p, const size_t &data_length_p = 0) override;
 
    int ReadAttribute(const std::string &name, void *data, FTDataType data_type_p, const size_t &data_length_p = 0) override;
 
    int GetAttributeSize(const std::string &name, FTDataType data_type_p) override;
 
    int ReadAllAttributeName(std::vector<std::string> &attr_name);
};
#endif