ft_endpoint.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_H
#define END_POINT_H
 
#include "ft_utility.h"
#include "ft_type.h"
#include <string>
#include <iostream>
#include <vector>
#include <math.h>
 
using namespace std;
 
//Todo:
//This might be general command
#define OP_CREATE_VIS_SCRIPT 4
#define OP_LIST_TAG 5
 
class Endpoint
{
protected:
    AuEndpointType endpoint_type;
    std::string endpoint_info;
    std::vector<unsigned long long> endpoint_size;
 
    int endpoint_ranks;
    AuEndpointDataType data_element_type;
    std::string data_endpoint_orig;
 
    bool set_endpoint_dim_size_flag = false;
    bool open_flag = false;
    bool create_flag = false;
    unsigned read_write_flag;
 
public:
    Endpoint(){};
    virtual ~Endpoint(){};
 
    std::vector<unsigned long long> GetDimensions();
 
    void SetDimensions(std::vector<unsigned long long> endpoint_dim_size_p);
 
    void SetDataElementType(AuEndpointDataType data_element_type_p);
 
    AuEndpointDataType GetDataElementType();
 
    int GetDataElementTypeSize();
 
    void SetEndpointType(AuEndpointType endpoint_type_p);
 
    AuEndpointType GetEndpointType();
 
    bool GetOpenFlag();
 
    void SetOpenFlag(bool open_flag_p);
 
    bool GetCreateFlag();
 
    void SetCreateFlag(bool open_flag_p);
 
    void SetRwFlag(unsigned read_write_flag_p);
 
    unsigned GetRwFlag();
 
    std::vector<AuEndpointDataTypeUnion> Void2Union(void *vp, size_t n_elements);
 
    void *Union2Void(std::vector<AuEndpointDataTypeUnion> &data_vector_in_union_type);
 
    void SetEndpointInfo(std::string endpoint_info_p);
 
    std::string GetEndpointInfo();
 
    virtual int ParseEndpointInfo() = 0;
 
    virtual int ExtractMeta() = 0;
    virtual int PrintInfo() = 0;
 
    virtual int Create() = 0;
 
    virtual int Open() = 0;
 
    virtual int Read(std::vector<unsigned long long> start, std::vector<unsigned long long> end, void *data) = 0;
 
    virtual int Write(std::vector<unsigned long long> start, std::vector<unsigned long long> end, void *data) = 0;
 
    virtual int WriteAttribute(const std::string &name, const void *data, FTDataType data_type_p, const size_t &data_length_p = 0);
 
    virtual int ReadAttribute(const std::string &name, void *data, FTDataType data_type_p, const size_t &data_length_p = 0);
 
    virtual int GetAttributeSize(const std::string &name, FTDataType data_type_p);
 
    virtual int Close() = 0;
 
    //virtual int Finalize() = 0;
 
    virtual void Map2MyType() = 0;
 
    virtual void EnableCollectiveIO();
 
    virtual void DisableCollectiveIO();
 
    virtual std::vector<std::string> GetDirFileVector();
 
    virtual void SetDirFileVector(std::vector<std::string> &file_list);
 
    virtual std::vector<int> GetDirChunkSize();
 
    virtual void SetDirChunkSize(std::vector<int> &dir_chunk_size_p);
 
    //virtual int SpecialOperator(int opt_code, std::string parameter);
 
    //virtual int SpecialOperator(int opt_code, std::vector<std::string> parameter_v);
    virtual int Control(int opt_code, std::vector<std::string> &parameter_v);
    virtual int MapOpStr2Int(std::string op_cmd_str);
 
    virtual std::string MapOpInt2Str(int op_int);
};
 
#endif