ft_endpoint_hdf5.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_HDF5_H
#define END_POINT_HDF5_H
 
#include "ft_type.h"
#include "ft_endpoint.h"
#include "ft_xdmf.h"
 
#include <string>
#include <iostream>
#include <vector>
#include <math.h>
 
#include "hdf5.h" //right now, we only have code for HDF5
 
#define HDF5_ENABLE_MPI_IO 0
#define HDF5_DISABLE_MPI_IO 1
#define HDF5_ENABLE_COLLECTIVE_IO 2
#define HDF5_DISABLE_COLLECTIVE_IO 3
 
//For some old code
#define OP_ENABLE_MPI_IO HDF5_ENABLE_MPI_IO
#define OP_DISABLE_MPI_IO HDF5_DISABLE_MPI_IO
#define OP_ENABLE_COLLECTIVE_IO HDF5_ENABLE_COLLECTIVE_IO
#define OP_DISABLE_COLLECTIVE_IO HDF5_DISABLE_COLLECTIVE_IO
 
//
//I/O layer
class EndpointHDF5 : public Endpoint
{
private:
    hid_t fid = -1, gid = -1, did = -1;
    hid_t dataspace_id = -1;
    std::string fn_str, gn_str, dn_str;
    hid_t plist_id = H5P_DEFAULT, plist_cio_id = H5P_DEFAULT;
    hid_t mem_type, disk_type;
    bool is_mpi_enabled = false;
 
public:
    EndpointHDF5(std::string endpoint_info_p)
    {
        endpoint_info = endpoint_info_p;
        ParseEndpointInfo();
        SetOpenFlag(false);
        SetRwFlag(H5F_ACC_RDONLY);
        SetEndpointType(EP_HDF5);
        EnableMPIIO();
        EnableCollectiveIO();
        is_mpi_enabled = true;
    }
    EndpointHDF5()
    {
        SetOpenFlag(false);
        SetRwFlag(H5F_ACC_RDONLY);
        SetEndpointType(EP_HDF5);
        EnableMPIIO();
        EnableCollectiveIO();
        is_mpi_enabled = true;
    }
 
    EndpointHDF5(int no_mpi)
    {
        //endpoint_info = endpoint_info_p;
        //ParseEndpointInfo();
        SetOpenFlag(false);
        SetRwFlag(H5F_ACC_RDONLY);
        SetEndpointType(EP_HDF5);
        //EnableMPIIO();
        //EnableCollectiveIO();
    }
 
    ~EndpointHDF5()
    {
        Close();
        if (is_mpi_enabled)
        {
            DisableMPIIO();
            DisableCollectiveIO();
        }
    }
    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 Map2MyTypeParameters(FTDataType ft_type, hid_t &mem_type, hid_t &disk_type);
 
    void EnableCollectiveIO() override;
 
    void DisableCollectiveIO() override;
 
    void EnableMPIIO();
 
    void DisableMPIIO();
 
    int ParseEndpointInfo() override;
 
    //int SpecialOperator(int opt_code, std::string parameter) override;
 
    int Control(int opt_code, std::vector<std::string> &parameter_v) override;
 
    int WriteAttribute(const std::string &name, const void *data, FTDataType data_type_p, const size_t &data_length_p = 0) override;
 
    int ReadAllAttributeName(std::vector<std::string> &attr_name);
 
    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 CreateXDMF();
};
#endif