MPIHelpers.h

Go to the documentation of this file.

//===-- MPIHelpers.h -- MPI helper classes for cache implementations --===//
//
// Part of the Proteus Project, under the Apache License v2.0 with LLVM
// Exceptions. See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// Shared MPI helper classes used by MPI-based cache implementations.
//
//===----------------------------------------------------------------------===//
 
#ifndef PROTEUS_MPIHELPERS_H
#define PROTEUS_MPIHELPERS_H
 
#include "proteus/impl/Caching/ObjectCache.h"
#include "proteus/impl/Hashing.h"
 
#include <mpi.h>
 
#include <memory>
#include <thread>
#include <vector>
 
namespace proteus {
 
enum class MPITag : int {
  Store = 1,
  LookupRequest = 2,
  LookupResponse = 3,
};
 
void validateMPIConfig();
 
class CommThreadHandle {
public:
  CommThreadHandle() = default;
  ~CommThreadHandle();
 
  CommThreadHandle(const CommThreadHandle &) = delete;
  CommThreadHandle &operator=(const CommThreadHandle &) = delete;
 
  template <typename Callable> void start(Callable &&ThreadFunc) {
    if (isRunning())
      return;
 
    Thread = std::make_unique<std::thread>(std::forward<Callable>(ThreadFunc));
    Running = true;
  }
 
  void join();
 
  bool isRunning() const;
 
private:
  std::unique_ptr<std::thread> Thread;
  bool Running = false;
};
 
class MPICommHandle {
public:
  MPICommHandle();
  ~MPICommHandle();
 
  MPICommHandle(const MPICommHandle &) = delete;
  MPICommHandle &operator=(const MPICommHandle &) = delete;
 
  MPI_Comm get() const;
  int getRank() const;
  int getSize() const;
 
  void finalize();
 
private:
  MPI_Comm Comm = MPI_COMM_NULL;
  int Rank = -1;
  int Size = -1;
};
 
struct StoreMessage {
  HashT Hash;
  std::vector<char> Data;
  bool IsDynLib;
};
 
std::vector<char> packStoreMessage(MPI_Comm Comm, const HashT &HashValue,
                                   const CacheEntry &Entry);
StoreMessage unpackStoreMessage(MPI_Comm Comm, const std::vector<char> &Buffer);
 
} // namespace proteus
 
#endif