combuff.h

Go to the documentation of this file.

/*
 *
 *                 #####    #####   ######  ######  ###   ###
 *               ##   ##  ##   ##  ##      ##      ## ### ##
 *              ##   ##  ##   ##  ####    ####    ##  #  ##
 *             ##   ##  ##   ##  ##      ##      ##     ##
 *            ##   ##  ##   ##  ##      ##      ##     ##
 *            #####    #####   ##      ######  ##     ##
 *
 *
 *             OOFEM : Object Oriented Finite Element Code
 *
 *               Copyright (C) 1993 - 2025   Borek Patzak
 *
 *
 *
 *       Czech Technical University, Faculty of Civil Engineering,
 *   Department of Structural Mechanics, 166 29 Prague, Czech Republic
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This program 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
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef combuff_h
#define combuff_h
 
#include "oofemenv.h"
#include "datastream.h"
#include "parallel.h"
 
namespace oofem {
 
#include <stdint.h>
#include <limits.h>
 
#if SIZE_MAX == UCHAR_MAX
   #define my_MPI_SIZE_T MPI_UNSIGNED_CHAR
#elif SIZE_MAX == USHRT_MAX
   #define my_MPI_SIZE_T MPI_UNSIGNED_SHORT
#elif SIZE_MAX == UINT_MAX
   #define my_MPI_SIZE_T MPI_UNSIGNED
#elif SIZE_MAX == ULONG_MAX
   #define my_MPI_SIZE_T MPI_UNSIGNED_LONG
#elif SIZE_MAX == ULLONG_MAX
   #define my_MPI_SIZE_T MPI_UNSIGNED_LONG_LONG
#else
   #error "what is happening here?"
#endif
 
 
 
 #define __CommunicationBuffer_ALLOC_CHUNK 1024
typedef char ComBuff_BYTE_TYPE;
 
class OOFEM_EXPORT MPIBuffer
{
protected:
    std::size_t size, curr_pos;
    bool isDynamic;
    ComBuff_BYTE_TYPE *buff;
    MPI_Request request;
 
public:
    MPIBuffer(std::size_t size, bool dynamic = 0);
    MPIBuffer(bool dynamic = 0);
    virtual ~MPIBuffer();

    int resize(std::size_t newSize);
    virtual void init();

    std::size_t giveSize() { return size; }
    std::size_t giveAvailableSpace() { return ( size - curr_pos ); }
    MPI_Request giveRequest() { return this->request; }

    int packArray(MPI_Comm communicator, const void *src, std::size_t n, MPI_Datatype type);
    int unpackArray(MPI_Comm communicator, void *dest, std::size_t n, MPI_Datatype type);
 


    int givePackSize(MPI_Comm communicator, MPI_Datatype type, std::size_t size);


    virtual int iSend(MPI_Comm communicator, int dest, int tag);
    virtual int iRecv(MPI_Comm communicator, int source, int tag, std::size_t count = 0);
    int testCompletion();
    int testCompletion(int &source, int &tag);
    virtual int waitCompletion();
    int bcast(MPI_Comm communicator, int root);
 
    void dump();
 
private:
    std::size_t givePosition() { return curr_pos; }
};
 

class OOFEM_EXPORT CommunicationBuffer: public DataStream
{
protected:
    MPI_Comm communicator;
public:
    CommunicationBuffer(MPI_Comm comm, std::size_t size, bool dynamic = 0) : communicator(comm) { }
    CommunicationBuffer(MPI_Comm comm, bool dynamic = 0) : communicator(comm) { }
    virtual ~CommunicationBuffer() { }

    virtual int resize(std::size_t newSize) = 0;
    virtual void init() = 0;

    virtual void initForPacking() = 0;
    virtual void initForUnpacking() = 0;
 
    using DataStream::read;
    int read(bool &data) override;
 
    using DataStream::write;
    int write(bool data) override;
 
    int givePackSizeOfInt(std::size_t count) override;
    int givePackSizeOfDouble(std::size_t count) override;
    int givePackSizeOfChar(std::size_t count) override;
    int givePackSizeOfBool(std::size_t count) override;
    int givePackSizeOfLong(std::size_t count) override;
    int givePackSizeOfSizet(std::size_t count) override;
 


    virtual int iSend(int dest, int tag) = 0;
    virtual int iRecv(int source, int tag, std::size_t count = 0) = 0;
    virtual int testCompletion() = 0;
    virtual int waitCompletion() = 0;
    virtual int bcast(int root) = 0;
};
 
 
class OOFEM_EXPORT StaticCommunicationBuffer : public CommunicationBuffer, public MPIBuffer
{
public:
    StaticCommunicationBuffer(MPI_Comm comm, int size, bool dynamic = 0) : CommunicationBuffer(comm, size, dynamic),
        MPIBuffer(size, dynamic) { }

    StaticCommunicationBuffer(MPI_Comm comm, bool dynamic = 0) : CommunicationBuffer(comm, dynamic), MPIBuffer(dynamic) { }
    virtual ~StaticCommunicationBuffer() { }
 
    int resize(std::size_t newSize) override { return MPIBuffer :: resize(newSize); }
 
    void init() override { return MPIBuffer :: init(); }
    void initForPacking() override { this->init(); }
    void initForUnpacking() override { this->init(); }
 
    using CommunicationBuffer::write;
    int write(const int *src, std::size_t n) override
    { return MPIBuffer :: packArray(this->communicator, src, n, MPI_INT); }
    int write(const long *src, std::size_t n) override
    { return MPIBuffer :: packArray(this->communicator, src, n, MPI_LONG); }
    int write(const unsigned long *src, std::size_t n) override
    { return MPIBuffer :: packArray(this->communicator, src, n, MPI_UNSIGNED_LONG); }
    int write(const double *src, std::size_t n) override
    { return MPIBuffer :: packArray(this->communicator, src, n, MPI_DOUBLE); }
    int write(const char *src, std::size_t n) override
    { return MPIBuffer :: packArray(this->communicator, src, n, MPI_CHAR); }
 
    using CommunicationBuffer::read;
    int read(int *dest, std::size_t n) override
    { return MPIBuffer :: unpackArray(this->communicator, dest, n, MPI_INT); }
    int read(long *dest, std::size_t n) override
    { return MPIBuffer :: unpackArray(this->communicator, dest, n, MPI_LONG); }
    int read(unsigned long *dest, std::size_t n) override
    { return MPIBuffer :: unpackArray(this->communicator, dest, n, MPI_UNSIGNED_LONG); }
    int read(double *dest, std::size_t n) override
    { return MPIBuffer :: unpackArray(this->communicator, dest, n, MPI_DOUBLE); }
    int read(char *dest, std::size_t n) override
    { return MPIBuffer :: unpackArray(this->communicator, dest, n, MPI_CHAR); }
 
    #ifdef _MSC_VER
    int read(std::size_t* data, std::size_t count) override { return MPIBuffer :: unpackArray(this->communicator, data, count, my_MPI_SIZE_T); }
    int write(const std::size_t* data, std::size_t count) override { return MPIBuffer :: packArray(this->communicator, data, count, my_MPI_SIZE_T); }
    #endif
 
    int iSend(int dest, int tag) override { return MPIBuffer :: iSend(this->communicator, dest, tag); }
 
    int iRecv(int source, int tag, std::size_t count = 0) override { return MPIBuffer :: iRecv(this->communicator, source, tag, count); }
 
    int testCompletion() override { return MPIBuffer :: testCompletion(); }
 
    int testCompletion(int &source, int &tag) { return MPIBuffer :: testCompletion(source, tag); }
 
    int waitCompletion() override { return MPIBuffer :: waitCompletion(); }
 
    int bcast(int root) override { return MPIBuffer :: bcast(this->communicator, root); }
};
} // end namespace oofem
 
#endif // combuff_h