Plugin.h

Go to the documentation of this file.

// Copyright (c) 2018 the Talvos developers. All rights reserved.
//
// This file is distributed under a three-clause BSD license. For full license
// terms please see the LICENSE file distributed with this source code.


#ifndef TALVOS_PLUGIN_H
#define TALVOS_PLUGIN_H

#include <cstdint>

namespace talvos
{

class Command;
class Instruction;
class Invocation;
class Memory;
class Workgroup;

class Plugin
{
public:
  virtual ~Plugin() = default;

  virtual bool isThreadSafe() const { return true; }

  virtual void atomicAccess(const Memory *Mem, uint64_t Address,
                            uint64_t NumBytes, uint32_t Opcode, uint32_t Scope,
                            uint32_t Semantics, const Invocation *Invoc)
  {}

  virtual void commandBegin(const Command *Cmd) {}

  virtual void commandComplete(const Command *Cmd) {}

  virtual void hostMemoryLoad(const Memory *Mem, uint64_t Address,
                              uint64_t NumBytes)
  {}

  virtual void hostMemoryStore(const Memory *Mem, uint64_t Address,
                               uint64_t NumBytes, const uint8_t *Data)
  {}

  virtual void instructionExecuted(const Invocation *Invoc,
                                   const Instruction *Inst)
  {}

  virtual void invocationBegin(const Invocation *Invoc) {}

  virtual void invocationComplete(const Invocation *Invoc) {}

  virtual void memoryLoad(const Memory *Mem, uint64_t Address,
                          uint64_t NumBytes, const Invocation *Invoc)
  {}

  virtual void memoryMap(const Memory *Mem, uint64_t Base, uint64_t Offset,
                         uint64_t NumBytes)
  {}

  virtual void memoryStore(const Memory *Mem, uint64_t Address,
                           uint64_t NumBytes, const uint8_t *Data,
                           const Invocation *Invoc)
  {}

  virtual void memoryUnmap(const Memory *Mem, uint64_t Base) {}

  virtual void workgroupBegin(const Workgroup *Group) {}

  virtual void workgroupBarrier(const Workgroup *Group) {}

  virtual void workgroupComplete(const Workgroup *Group) {}
};

} // namespace talvos

#endif