MPIHelper.h

Go to the documentation of this file.

//
// Global functions MPIHelper
//
// Copyright (c) 2010 - 2013, Yves Ineichen, ETH Zürich
// All rights reserved
//
// Implemented as part of the PhD thesis
// "Toward massively parallel multi-objective optimization with application to
// particle accelerators" (https://doi.org/10.3929/ethz-a-009792359)
//
// This file is part of OPAL.
//
// OPAL is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// You should have received a copy of the GNU General Public License
// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
//
#ifndef __MPIHELPER_H__
#define __MPIHELPER_H__
 
#include <cstddef>
#include <cstring>
#include <sstream>
 
#include <mpi.h>
 
#include "Util/Types.h"
 
#define MPI_WORKER_STATUSUPDATE_TAG    0x11
#define MPI_WORKER_FINISHED_TAG        0x12
#define MPI_WORKER_FINISHED_ACK_TAG    0x13
 
#define MPI_COWORKER_NEW_JOB_TAG       0x14
 
 
#define MPI_OPT_NEW_JOB_TAG            0x21
#define MPI_OPT_JOB_FINISHED_TAG       0x22
#define MPI_OPT_CONVERGED_TAG          0x23
 
 
#define MPI_WORK_JOBID_TAG             0x41
#define MPI_WORK_SIZE_TAG              0x42
#define MPI_WORK_SIZE_PARAMS           0x43
 
#define MPI_EXCHANGE_SOL_STATE_TAG          0x51
#define MPI_EXCHANGE_SOL_STATE_DATA_TAG     0x52
#define MPI_EXCHANGE_SOL_STATE_RES_SIZE_TAG 0x53
#define MPI_EXCHANGE_SOL_STATE_RES_TAG      0x54
 
#define MPI_STOP_TAG                   0x91
 
#define MPI_EXCHANGE_SERIALIZED_DATA_TAG        0x99
 
 
//FIXME: double information (use static vars or enums)
enum MPITag_t {
      WORKER_FINISHED_TAG = MPI_WORKER_FINISHED_TAG
    , OPT_NEW_JOB_TAG = MPI_OPT_NEW_JOB_TAG
    , OPT_CONVERGED_TAG = MPI_OPT_CONVERGED_TAG
    , WORKER_STATUSUPDATE_TAG = MPI_WORKER_STATUSUPDATE_TAG
    , REQUEST_FINISHED = MPI_OPT_JOB_FINISHED_TAG
    , EXCHANGE_SOL_STATE_TAG = MPI_EXCHANGE_SOL_STATE_TAG
    , EXCHANGE_SOL_STATE_RES_SIZE_TAG = MPI_EXCHANGE_SOL_STATE_RES_SIZE_TAG
};
 
enum State_t {IDLE = 0, RUNNING = 1};
 
void serialize(Param_t           params, std::ostringstream &os);
void serialize(reqVarContainer_t params, std::ostringstream &os);
 
void deserialize(const char *buffer, std::size_t buf_size, Param_t           &params);
void deserialize(const char *buffer, std::size_t buf_size, reqVarContainer_t &params);
 
void MPI_Bcast_params(Param_t &params, std::size_t root, MPI_Comm comm);
 
void MPI_Bcast_reqvars(reqVarContainer_t reqvars, std::size_t root, MPI_Comm comm);
 
 
//FIXME: test
template<class Data_t>
void MPI_Send_serialized(Data_t data, std::size_t pid, MPI_Comm comm) {
 
    std::ostringstream os;
    serialize(data, os);
    std::size_t buf_size = os.str().length();
 
    MPI_Send(&buf_size, 1, MPI_LONG, pid,
             MPI_EXCHANGE_SERIALIZED_DATA_TAG, comm);
 
    char *buffer = new char[buf_size];
    std::memcpy(buffer, os.str().c_str(), buf_size);
 
    MPI_Send(buffer, buf_size, MPI_CHAR, pid,
             MPI_EXCHANGE_SERIALIZED_DATA_TAG, comm);
 
    delete[] buffer;
}
 
template<class Data_t>
void MPI_Recv_serialized(Data_t &data, std::size_t pid, MPI_Comm comm) {
 
    MPI_Status status;
    std::size_t buf_size = 0;
    MPI_Recv(&buf_size, 1, MPI_LONG, pid,
             MPI_EXCHANGE_SERIALIZED_DATA_TAG, comm, &status);
 
    char *buffer = new char[buf_size];
    MPI_Recv(buffer, buf_size, MPI_CHAR, pid,
             MPI_EXCHANGE_SERIALIZED_DATA_TAG, comm, &status);
 
    deserialize(buffer, buf_size, data);
    delete[] buffer;
}
 
 
void MPI_Send_params(Param_t params, std::size_t pid, MPI_Comm comm);
 
std::pair<std::size_t*, char*> MPI_ISend_params(Param_t params, std::size_t pid,
                                           MPI_Comm comm, MPI_Request *req);
 
void MPI_Recv_params(Param_t &params, std::size_t pid, MPI_Comm comm);
 
void MPI_Send_reqvars(reqVarContainer_t reqvars, std::size_t pid, MPI_Comm comm);
 
void MPI_Recv_reqvars(reqVarContainer_t &reqvars, std::size_t pid, MPI_Comm comm);
 
#endif