Module.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_MODULE_H
#define TALVOS_MODULE_H

#include <map>
#include <memory>
#include <string>
#include <vector>

#include "talvos/Dim3.h"
#include "talvos/Object.h"

namespace talvos
{

class EntryPoint;
class Function;
class Instruction;
class Type;
class Variable;

typedef std::vector<const Variable *> VariableList;

class Module
{
public:
  Module(uint32_t IdBound);

  // Destroy the module and all its types, functions, blocks, and instructions.
  ~Module();

  // Do not allow Module objects to be copied.
  Module(const Module &) = delete;
  Module &operator=(const Module &) = delete;

  void addEntryPoint(EntryPoint *EP);

  void addFunction(std::unique_ptr<Function> Func);

  void addLocalSize(uint32_t Entry, Dim3 LocalSize);

  void addObject(uint32_t Id, const Object &Obj);

  void addSpecConstant(uint32_t SpecId, uint32_t ResultId);

  void addSpecConstantOp(Instruction *Op);

  void addType(uint32_t Id, std::unique_ptr<Type> Ty);

  void addVariable(Variable *Var) { Variables.push_back(Var); }

  const EntryPoint *getEntryPoint(const std::string &Name,
                                  uint32_t ExecutionModel) const;

  const Function *getFunction(uint32_t Id) const;

  uint32_t getIdBound() const { return IdBound; }

  Dim3 getLocalSize(uint32_t Entry) const;

  const Object &getObject(uint32_t Id) const;

  const std::vector<Object> &getObjects() const;

  uint32_t getSpecConstant(uint32_t SpecId) const;

  const std::vector<Instruction *> &getSpecConstantOps() const;

  const Type *getType(uint32_t Id) const;

  const VariableList &getVariables() const { return Variables; }

  uint32_t getWorkgroupSizeId() const { return WorkgroupSizeId; }

  void setWorkgroupSizeId(uint32_t Id) { WorkgroupSizeId = Id; }

  static std::shared_ptr<Module> load(const uint32_t *Words, size_t NumWords);

  static std::shared_ptr<Module> load(const std::string &FileName);

private:
  typedef std::map<uint32_t, std::unique_ptr<Type>> TypeMap;

  typedef std::map<uint32_t, std::unique_ptr<Function>> FunctionMap;

  uint32_t IdBound;            
  std::vector<Object> Objects; 
  TypeMap Types;               

  FunctionMap Functions;                 
  std::vector<EntryPoint *> EntryPoints; 
  std::map<uint32_t, Dim3> LocalSizes;   

  std::map<uint32_t, uint32_t> SpecConstants;

  std::vector<Instruction *> SpecConstantOps;

  uint32_t WorkgroupSizeId;

  VariableList Variables;
};

} // namespace talvos

#endif