InOutTypes.hpp

// Copyright (c) 2018 Graphcore Ltd. All rights reserved.
 
#ifndef _poplar_InOutTypes_hpp_
#define _poplar_InOutTypes_hpp_
#include <cstdint>
#include <poplar/Iterators.hpp>
#include <poplar/QuarterFloat.hpp>
 
namespace poplar {
 
template <typename T> struct IOBase { void *p; };
 
template <> struct IOBase<quarter> {
  void *p;
  void *meta;
};
 
// This is needed if we ever use the '-finstrument-function'. We don't want
// these functions to be instrumented.
#define NO_INSTRUMENT __attribute__((no_instrument_function))
 
template <typename T> class InputBase : public IOBase<T> {
public:
  using type = const T;
  using baseT = const T;
 
  NO_INSTRUMENT
  operator const T &() const { return *((T *)IOBase<T>::p); }
 
  NO_INSTRUMENT
  const T &operator*() const { return *((T *)IOBase<T>::p); }
 
  NO_INSTRUMENT
  const T *operator->() const { return (T *)IOBase<T>::p; }
};
 
template <typename T> class OutputBase : public IOBase<T> {
public:
  using baseT = T;
 
  NO_INSTRUMENT
  operator T &() const { return *((T *)IOBase<T>::p); }
 
  NO_INSTRUMENT
  T &operator*() const { return *((T *)IOBase<T>::p); }
 
  NO_INSTRUMENT
  T *operator->() const { return (T *)IOBase<T>::p; }
};
 
template <typename T> class InOutBase : public IOBase<T> {
public:
  using baseT = T;
 
  NO_INSTRUMENT
  operator T &() const { return *((T *)IOBase<T>::p); }
 
  NO_INSTRUMENT
  T &operator*() const { return *((T *)IOBase<T>::p); }
 
  NO_INSTRUMENT
  T *operator->() const { return (T *)IOBase<T>::p; }
};
 
template <typename T> class Input : public InputBase<T> {};
 
template <> class Input<quarter> : public InputBase<quarter> {
public:
  NO_INSTRUMENT
  const MetadataType *getMetadata() const { return (const MetadataType *)meta; }
};
 
template <typename T> class Output : public OutputBase<T> {};
 
template <> class Output<quarter> : public OutputBase<quarter> {
public:
  NO_INSTRUMENT
  const MetadataType *getMetadata() const { return (MetadataType *)meta; }
};
 
template <typename T> class InOut : public InOutBase<T> {};
 
template <> class InOut<quarter> : public InOutBase<quarter> {
public:
  NO_INSTRUMENT
  const MetadataType *getMetadata() const { return (MetadataType *)meta; }
};
 
} // namespace poplar
 
#endif // _poplar_InOutTypes_hpp_