mpi_manager.hpp

Go to the documentation of this file.

//============================================================================
// vSMC/include/vsmc/mpi/mpi_manager.hpp
//----------------------------------------------------------------------------
//                         vSMC: Scalable Monte Carlo
//----------------------------------------------------------------------------
// Copyright (c) 2013,2014, Yan Zhou
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//   Redistributions of source code must retain the above copyright notice,
//   this list of conditions and the following disclaimer.
//
//   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.
//
// 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 HOLDER 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.
//============================================================================

#ifndef VSMC_MPI_MPI_MANAGER_HPP
#define VSMC_MPI_MPI_MANAGER_HPP

#include <vsmc/internal/common.hpp>
#include <vsmc/rng/seed.hpp>
#include <boost/mpi.hpp>

namespace vsmc {

namespace internal {

template <typename ResultType, typename IntType1, typename IntType2>
inline void mpi_init_seed (ResultType &, IntType1 D, IntType2 R)
{
    Seed::instance().modulo(
            static_cast<Seed::skip_type>(D), static_cast<Seed::skip_type>(R));
}

template <typename T, std::size_t K, typename IntType1, typename IntType2>
inline void mpi_init_seed (vsmc::Array<T, K> &s, IntType1, IntType2 R)
{s.back() = static_cast<Seed::skip_type>(R);}

} // namespace vsmc::internal

class MPIEnvironment
{
    public :

#ifdef BOOST_MPI_HAS_NOARG_INITIALIZATION
    explicit MPIEnvironment (bool abort_on_exception = true) :
        env_(abort_on_exception) {init_seed();}
#endif

    MPIEnvironment(int &argc, char **&argv, bool abort_on_exception = true) :
        env_(argc, argv, abort_on_exception) {init_seed();}

    private :

    ::boost::mpi::environment env_;

    void init_seed () const
    {
        ::boost::mpi::communicator world;
        Seed::result_type s(Seed::instance().get());
        internal::mpi_init_seed(s, world.size(), world.rank());
        Seed::instance().set(s);
        world.barrier();
    }
}; // class MPIEnvironment

template <typename ID>
class MPICommunicator
{
    public :

    static MPICommunicator<ID> &instance ()
    {
        static MPICommunicator<ID> comm;

        return comm;
    }

    const MPI_Comm &get () const {return comm_;}

    void set (const MPI_Comm &comm) {comm_ = comm;}

    private :

    MPI_Comm comm_;

    MPICommunicator () : comm_(MPI_COMM_WORLD) {}
    MPICommunicator (const MPICommunicator<ID> &);
    MPICommunicator<ID> &operator= (const MPICommunicator<ID> &);
}; // class MPICommunicator

} // namespace vsmc

#endif // VSMC_MPI_MPI_MANAGER_HPP