LateInitCallback.hpp

// Copyright (c) 2019 Graphcore Ltd. All rights reserved.
 
#ifndef poplar_LateInitCallback_hpp
#define poplar_LateInitCallback_hpp
 
#include <cstdint>
#include <functional>
#include <map>
#include <string>
#include <vector>
 
#include <poplar/GraphElements.hpp>
 
namespace poplar {
 
struct VertexEdgeInfo {
  struct StorageInfo {
    std::uint64_t startOffs; // Start addr in dev memory (offs from 0x40000)
    std::uint32_t len;       // Length in bytes
  };
  // A map from field name => StorageInfo[] for all (edge) fields of the vertex.
  // For a 1D field, the std::vector, value for the map entry, will have a
  // single element, describing that field.
  // For a 2D field, it will have as many entries as there are 'rows' in the
  // field.
  // Note that this will not discriminate between a 1D vector and a 2D with a
  // single row, but this should not matter in any case, because the callback
  // must be aware of the type of the field.
  std::map<std::string, std::vector<StorageInfo>> storage;
};
 
template <typename T>
using LateInitCallback = std::function<T(const VertexEdgeInfo &)>;
 
} // End namespace poplar.
#endif // poplar_LateInitCallback_hpp