Device.hpp

// Copyright (c) 2016 Graphcore Ltd. All rights reserved.
 
#ifndef poplar_Device_hpp
#define poplar_Device_hpp
#include <map>
#include <memory>
#include <poplar/OptionFlags.hpp>
#include <poplar/Target.hpp>
 
#include <graphcore_target_access/IPUAttributes.h>
 
#include <string>
#include <vector>
 
namespace poplar {
namespace core {
class Device;
}
class Device {
public:
  Device();
  Device(Device &&) noexcept;
  virtual ~Device();
 
  Device &operator=(Device &&) noexcept;
 
  // A Device can not be copied or assigned in order to preserve the
  // attach/detach state of underlying hardware.
  Device(const Device &) = delete;
  Device &operator=(const Device &) = delete;
 
  unsigned getId() const;
 
  const Target &getTarget() const;
 
  bool attach() const;
 
  void detach() const;
 
  void getDriverVersion(unsigned &major, unsigned &minor,
                        unsigned &point) const;
 
  bool supportsRemoteBuffers() const;
 
  bool hasGateway() const;
 
  GC_DEPRECATED std::map<std::string, std::string> getAttributes() const;
 
  std::string getAttribute(IPUAttributes::AttributeId attributeId) const;
 
  std::vector<int> getNumaTopology() const;
 
  std::vector<int> getNumaNodesUsedForIPUs() const;
 
  std::vector<unsigned> getDriverIDs() const;
 
  void reset() const;
 
  Device createVirtualDevice(unsigned tilesPerIPU);
 
  static Device createCPUDevice(unsigned numOfIPUs = 1);
 
  // Internal use only.
  static Device createSimulatorDevice(const Target &target,
                                      const OptionFlags &options = {});
 
  // Implementation
  Device(std::unique_ptr<core::Device>);
  core::Device &getImpl() const { return *impl; }
 
private:
  Target target;
  std::unique_ptr<core::Device> impl;
};
 
} // namespace poplar
 
#endif // poplar_Device_hpp