ChunkInfo.hpp

/* Copyright 2020-2021 Franz Poeschel
 *
 * This file is part of openPMD-api.
 *
 * openPMD-api is free software: you can redistribute it and/or modify
 * it under the terms of of either the GNU General Public License or
 * the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * openPMD-api is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License and the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * and the GNU Lesser General Public License along with openPMD-api.
 * If not, see <http://www.gnu.org/licenses/>.
 */
#pragma once
 
#include "openPMD/config.hpp"
 
#include "openPMD/Dataset.hpp" // Offset, Extent
 
#if openPMD_HAVE_MPI
#include <mpi.h>
#endif
 
#include <map>
#include <string>
#include <vector>
 
namespace openPMD
{
struct ChunkInfo
{
    Offset offset; 
    Extent extent; 
 
    /*
     * If rank is smaller than zero, will be converted to zero.
     */
    explicit ChunkInfo() = default;
    ChunkInfo(Offset, Extent);
 
    bool operator==(ChunkInfo const &other) const;
};
 
struct WrittenChunkInfo : ChunkInfo
{
    unsigned int sourceID = 0; 
 
    explicit WrittenChunkInfo() = default;
    /*
     * If rank is smaller than zero, will be converted to zero.
     */
    WrittenChunkInfo(Offset, Extent, int sourceID);
    WrittenChunkInfo(Offset, Extent);
 
    bool operator==(WrittenChunkInfo const &other) const;
};
 
using ChunkTable = std::vector<WrittenChunkInfo>;
 
namespace chunk_assignment
{
    using RankMeta = std::map<unsigned int, std::string>;
} // namespace chunk_assignment
 
namespace host_info
{
    enum class Method
    {
        POSIX_HOSTNAME,
        MPI_PROCESSOR_NAME
    };
 
    bool methodAvailable(Method);
 
    std::string byMethod(Method);
 
#if openPMD_HAVE_MPI
    chunk_assignment::RankMeta byMethodCollective(MPI_Comm, Method);
#endif
} // namespace host_info
} // namespace openPMD
 
#undef openPMD_POSIX_AVAILABLE