combuff.h

Go to the documentation of this file.

/*
 *
 *                 #####    #####   ######  ######  ###   ###
 *               ##   ##  ##   ##  ##      ##      ## ### ##
 *              ##   ##  ##   ##  ####    ####    ##  #  ##
 *             ##   ##  ##   ##  ##      ##      ##     ##
 *            ##   ##  ##   ##  ##      ##      ##     ##
 *            #####    #####   ##      ######  ##     ##
 *
 *
 *             OOFEM : Object Oriented Finite Element Code
 *
 *               Copyright (C) 1993 - 2013   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 "oofemcfg.h"
#include "datastream.h"
#include "parallel.h"

namespace oofem {

 #define __CommunicationBuffer_ALLOC_CHUNK 1024

typedef char ComBuff_BYTE_TYPE;

class OOFEM_EXPORT MPIBuffer
{
protected:
    int size, curr_pos;
    bool isDynamic;
    ComBuff_BYTE_TYPE *buff;
    MPI_Request request;

public:
    MPIBuffer(int size, bool dynamic = 0);
    MPIBuffer(bool dynamic = 0);
    virtual ~MPIBuffer();

    int resize(int newSize);
    virtual void init();

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

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


    int givePackSize(MPI_Comm communicator, MPI_Datatype type, int size);

    virtual int iSend(MPI_Comm communicator, int dest, int tag);
    virtual int iRecv(MPI_Comm communicator, int source, int tag, int count = 0);
    int testCompletion();
    int testCompletion(int &source, int &tag);
    virtual int waitCompletion();
    int bcast(MPI_Comm communicator, int root);

    void dump();

private:
    int givePosition() { return curr_pos; }
};


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

    virtual int resize(int newSize) = 0;
    virtual void init() = 0;

    virtual void initForPacking() = 0;
    virtual void initForUnpacking() = 0;

    using DataStream::read;
    virtual int read(bool &data);

    using DataStream::write;
    virtual int write(bool data);
   
    virtual int givePackSizeOfInt(int count);
    virtual int givePackSizeOfDouble(int count);
    virtual int givePackSizeOfChar(int count);
    virtual int givePackSizeOfBool(int count);
    virtual int givePackSizeOfLong(int count);

    virtual int iSend(int dest, int tag) = 0;
    virtual int iRecv(int source, int tag, int 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() { }

    virtual int resize(int newSize) { return MPIBuffer :: resize(newSize); }

    virtual void init() { return MPIBuffer :: init(); }
    virtual void initForPacking() { this->init(); }
    virtual void initForUnpacking() { this->init(); }

    using CommunicationBuffer::write;
    virtual int write(const int *src, int n)
    { return MPIBuffer :: packArray(this->communicator, src, n, MPI_INT); }
    virtual int write(const long *src, int n)
    { return MPIBuffer :: packArray(this->communicator, src, n, MPI_LONG); }
    virtual int write(const unsigned long *src, int n)
    { return MPIBuffer :: packArray(this->communicator, src, n, MPI_UNSIGNED_LONG); }
    virtual int write(const double *src, int n)
    { return MPIBuffer :: packArray(this->communicator, src, n, MPI_DOUBLE); }
    virtual int write(const char *src, int n)
    { return MPIBuffer :: packArray(this->communicator, src, n, MPI_CHAR); }

    using CommunicationBuffer::read;
    virtual int read(int *dest, int n)
    { return MPIBuffer :: unpackArray(this->communicator, dest, n, MPI_INT); }
    virtual int read(long *dest, int n)
    { return MPIBuffer :: unpackArray(this->communicator, dest, n, MPI_LONG); }
    virtual int read(unsigned long *dest, int n)
    { return MPIBuffer :: unpackArray(this->communicator, dest, n, MPI_UNSIGNED_LONG); }
    virtual int read(double *dest, int n)
    { return MPIBuffer :: unpackArray(this->communicator, dest, n, MPI_DOUBLE); }
    virtual int read(char *dest, int n)
    { return MPIBuffer :: unpackArray(this->communicator, dest, n, MPI_CHAR); }

    virtual int iSend(int dest, int tag) { return MPIBuffer :: iSend(this->communicator, dest, tag); }

    virtual int iRecv(int source, int tag, int count = 0)  { return MPIBuffer :: iRecv(this->communicator, source, tag, count); }

    virtual int testCompletion() { return MPIBuffer :: testCompletion(); }

    int testCompletion(int &source, int &tag) { return MPIBuffer :: testCompletion(source, tag); }

    virtual int waitCompletion() { return MPIBuffer :: waitCompletion(); }

    virtual int bcast(int root) { return MPIBuffer :: bcast(this->communicator, root); }
};
} // end namespace oofem

#endif // combuff_h