NetworkIO.h

Go to the documentation of this file.

/*
 * This file belongs to the Galois project, a C++ library for exploiting
 * parallelism. The code is being released under the terms of the 3-Clause BSD
 * License (a copy is located in LICENSE.txt at the top-level directory).
 *
 * Copyright (C) 2018, The University of Texas at Austin. All rights reserved.
 * UNIVERSITY EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES CONCERNING THIS
 * SOFTWARE AND DOCUMENTATION, INCLUDING ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR ANY PARTICULAR PURPOSE, NON-INFRINGEMENT AND WARRANTIES OF
 * PERFORMANCE, AND ANY WARRANTY THAT MIGHT OTHERWISE ARISE FROM COURSE OF
 * DEALING OR USAGE OF TRADE.  NO WARRANTY IS EITHER EXPRESS OR IMPLIED WITH
 * RESPECT TO THE USE OF THE SOFTWARE OR DOCUMENTATION. Under no circumstances
 * shall University be liable for incidental, special, indirect, direct or
 * consequential damages or loss of profits, interruption of business, or
 * related expenses which may arise from use of Software or Documentation,
 * including but not limited to those resulting from defects in Software and/or
 * Documentation, or loss or inaccuracy of data of any kind.
 */

#ifndef GALOIS_RUNTIME_NETWORKTHREAD_H
#define GALOIS_RUNTIME_NETWORKTHREAD_H

#include <cstdint>
#include <vector>
#include <tuple>
#include <memory>
#include <cassert>
#include <cstring>
#include <deque>
#include <string>
#include <fstream>
#include <unistd.h>
#include <mpi.h>
#include "galois/runtime/MemUsage.h"
#include "galois/PODResizeableArray.h"

namespace galois {
namespace runtime {

class NetworkIO {
protected:
  static void handleError(int rc) {
    if (rc != MPI_SUCCESS) {
      MPI_Abort(MPI_COMM_WORLD, rc);
    }
  }

  MemUsageTracker& memUsageTracker;

  std::atomic<size_t>& inflightSends;
  std::atomic<size_t>& inflightRecvs;

  // using vTy = std::vector<uint8_t>;
  using vTy = galois::PODResizeableArray<uint8_t>;

public:
  struct message {
    uint32_t host; 
    uint32_t tag;  
    vTy data;      

    message() : host(~0), tag(~0) {}
    message(uint32_t h, uint32_t t, vTy&& d)
        : host(h), tag(t), data(std::move(d)) {}

    bool valid() const { return !data.empty(); }
  };

  NetworkIO(MemUsageTracker& tracker, std::atomic<size_t>& sends,
            std::atomic<size_t>& recvs)
      : memUsageTracker(tracker), inflightSends(sends), inflightRecvs(recvs) {}

  virtual ~NetworkIO();
  virtual void enqueue(message m) = 0;
  virtual message dequeue() = 0;
  virtual void progress() = 0;
};

std::tuple<std::unique_ptr<NetworkIO>, uint32_t, uint32_t>
makeNetworkIOMPI(galois::runtime::MemUsageTracker& tracker,
                 std::atomic<size_t>& sends, std::atomic<size_t>& recvs);
// #ifdef GALOIS_USE_LCI
// /**
//  * Creates/returns a network IO layer that uses LWCI to do communication.
//  *
//  * @returns tuple with pointer to the LWCI IO layer, this host's ID, and the
//  * total number of hosts in the system
//  */
// std::tuple<std::unique_ptr<NetworkIO>, uint32_t, uint32_t>
// makeNetworkIOLWCI(galois::runtime::MemUsageTracker& tracker,
//                   std::atomic<size_t>& sends, std::atomic<size_t>& recvs);
// #endif

} // namespace runtime
} // namespace galois

#endif