Implementation of SouffleProgram interface for an interpreter instance. More...

#include <ProgInterface.h>

Inheritance diagram for souffle::interpreter::ProgInterface:

Collaboration diagram for souffle::interpreter::ProgInterface:

Public Member Functions
void	dumpInputs () override
	Dump inputs: not implemented. More...

void	dumpOutputs () override
	Dump outputs: not implemented. More...

void	executeSubroutine (std::string name, const std::vector< RamDomain > &args, std::vector< RamDomain > &ret) override
	Run subroutine. More...

RecordTable &	getRecordTable () override
	Get the record table of the program. More...

SymbolTable &	getSymbolTable () override
	Get symbol table. More...

void	loadAll (std::string) override
	Load input data: not implemented. More...

void	printAll (std::string) override
	Print output data: not implemented. More...

	ProgInterface (Engine &interp)

void	run () override
	Run program instance: not implemented. More...

void	runAll (std::string, std::string) override
	Load data, run program instance, store data: not implemented. More...

	~ProgInterface () override

Public Member Functions inherited from souffle::SouffleProgram
template<typename... Args>
bool	contains (const std::tuple< Args... > &t, Relation *relation)
	Contains function with std::tuple as input (wrapper) More...

std::vector< Relation * >	getAllRelations () const
	Getter of allRelations, which this vector structure contains all relations. More...

std::vector< Relation * >	getInputRelations () const
	Getter of inputRelations, which this vector structure contains all input relations. More...

std::vector< Relation * >	getInternalRelations () const
	Getter of internalRelations, which this vector structure contains all relations that are neither an input relation or an output relation. More...

std::size_t	getNumThreads ()
	Get the number of threads to be used. More...

std::vector< Relation * >	getOutputRelations () const
	Getter of outputRelations, which this vector structure contains all output relations. More...

Relation *	getRelation (const std::string &name) const
	Get Relation by its name from relationMap, if relation not found, return a nullptr. More...

std::string	getRelationName (const std::string &name) const
	Return the name of the target relation from relationMap. More...

std::size_t	getRelationSize (const std::string &name) const
	Return the size of the target relation from relationMap. More...

template<typename... Args>
void	insert (const std::tuple< Args... > &t, Relation *relation)
	Insert function with std::tuple as input (wrapper) More...

void	purgeInputRelations ()
	Remove all the tuples from the inputRelations, calling the purge method of each. More...

void	purgeInternalRelations ()
	Remove all the tuples from the internalRelations, calling the purge method of each. More...

void	purgeOutputRelations ()
	Remove all the tuples from the outputRelations, calling the purge method of each. More...

void	setNumThreads (std::size_t numThreadsValue)
	Set the number of threads to be used. More...

virtual	~SouffleProgram ()=default
	Destructor. More...

Private Attributes
Engine &	exec

std::vector< RelInterface * >	interfaces

const ram::Program &	prog

RecordTable &	recordTable

SymbolTable &	symTable

Additional Inherited Members
Protected Member Functions inherited from souffle::SouffleProgram
void	addRelation (const std::string &name, Relation &rel, bool isInput, bool isOutput)
	Add the relation to relationMap (with its name) and allRelations, depends on the properties of the relation, if the relation is an input relation, it will be added to inputRelations, else if the relation is an output relation, it will be added to outputRelations, otherwise will add to internalRelations. More...

void	addRelation (const std::string &name, Relation *rel, bool isInput, bool isOutput)

Detailed Description

Implementation of SouffleProgram interface for an interpreter instance.

Definition at line 214 of file ProgInterface.h.

Constructor & Destructor Documentation

◆ ProgInterface()

souffle::interpreter::ProgInterface::ProgInterface ( Engine & interp )

inlineexplicit

Definition at line 216 of file ProgInterface.h.

                                                           { map[rel.getName()] = &rel; });
  
         // Build wrapper relations for Souffle's interface
         for (auto& relHandler : exec.getRelationMap()) {
             if (relHandler == nullptr) {
                 // Skip droped relation.
                 continue;
             }
             auto& interpreterRel = **relHandler;
             auto& name = interpreterRel.getName();
             assert(map[name]);
             const ram::Relation& rel = *map[name];
  
             // construct types and names vectors
             std::vector<std::string> types = rel.getAttributeTypes();
             std::vector<std::string> attrNames = rel.getAttributeNames();
  
             auto* interface = new RelInterface(interpreterRel, symTable, rel.getName(), types, attrNames, id);
             interfaces.push_back(interface);
             bool input = false;
             bool output = false;
             visitDepthFirst(prog, [&](const ram::IO& io) {
                 if (map[io.getRelation()] == &rel) {
                     const std::string& op = io.get("operation");
                     if (op == "input") {
                         input = true;
                     } else if (op == "output" || op == "printsize") {
                         output = true;
                     } else {
                         assert("wrong i/o operation");
                     }
                 }
             });
             addRelation(rel.getName(), *interface, input, output);
             id++;
         }
     }
     ~ProgInterface() override {
         for (auto* interface : interfaces) {
             delete interface;
         }
     }
  

References souffle::map(), and rel().

Here is the call graph for this function:

◆ ~ProgInterface()

souffle::interpreter::ProgInterface::~ProgInterface ( )

inlineoverride

Definition at line 260 of file ProgInterface.h.

                         {}
  
     /** Load data, run program instance, store data: not implemented */
     void runAll(std::string, std::string) override {}

Member Function Documentation

◆ dumpInputs()

void souffle::interpreter::ProgInterface::dumpInputs ( )

inlineoverridevirtual

Dump inputs: not implemented.

Implements souffle::SouffleProgram.

Definition at line 279 of file ProgInterface.h.

◆ dumpOutputs()

void souffle::interpreter::ProgInterface::dumpOutputs ( )

inlineoverridevirtual

Dump outputs: not implemented.

Implements souffle::SouffleProgram.

Definition at line 282 of file ProgInterface.h.

285 {

◆ executeSubroutine()

void souffle::interpreter::ProgInterface::executeSubroutine	(	std::string	name,
		const std::vector< RamDomain > &	args,
		std::vector< RamDomain > &	ret
	)

inlineoverridevirtual

Run subroutine.

Reimplemented from souffle::SouffleProgram.

Definition at line 285 of file ProgInterface.h.

                                            {
         return symTable;
     }
  

◆ getRecordTable()

RecordTable& souffle::interpreter::ProgInterface::getRecordTable ( )

inlineoverridevirtual

Get the record table of the program.

Implements souffle::SouffleProgram.

Definition at line 295 of file ProgInterface.h.

◆ getSymbolTable()

SymbolTable& souffle::interpreter::ProgInterface::getSymbolTable ( )

inlineoverridevirtual

Get symbol table.

Implements souffle::SouffleProgram.

Definition at line 291 of file ProgInterface.h.

293 :

294 const ram::Program& prog;

◆ loadAll()

void souffle::interpreter::ProgInterface::loadAll ( std::string )

inlineoverridevirtual

Load input data: not implemented.

Implements souffle::SouffleProgram.

Definition at line 273 of file ProgInterface.h.

273 {}

◆ printAll()

void souffle::interpreter::ProgInterface::printAll ( std::string )

inlineoverridevirtual

Print output data: not implemented.

Implements souffle::SouffleProgram.

Definition at line 276 of file ProgInterface.h.

276 {}

◆ run()

void souffle::interpreter::ProgInterface::run ( )

inlineoverridevirtual

Run program instance: not implemented.

Reimplemented from souffle::SouffleProgram.

Definition at line 267 of file ProgInterface.h.

267 {}

◆ runAll()

void souffle::interpreter::ProgInterface::runAll	(	std::string	,
		std::string
	)

inlineoverridevirtual

Load data, run program instance, store data: not implemented.

Implements souffle::SouffleProgram.

Definition at line 270 of file ProgInterface.h.

270 {}

Field Documentation

◆ exec

Engine& souffle::interpreter::ProgInterface::exec

private

Definition at line 301 of file ProgInterface.h.

◆ interfaces

std::vector<RelInterface*> souffle::interpreter::ProgInterface::interfaces

private

Definition at line 304 of file ProgInterface.h.

◆ prog

const ram::Program& souffle::interpreter::ProgInterface::prog

private

Definition at line 300 of file ProgInterface.h.

◆ recordTable

RecordTable& souffle::interpreter::ProgInterface::recordTable

private

Definition at line 303 of file ProgInterface.h.

◆ symTable

SymbolTable& souffle::interpreter::ProgInterface::symTable

private

Definition at line 302 of file ProgInterface.h.

The documentation for this class was generated from the following file:

interpreter/ProgInterface.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ProgInterface()

◆ ~ProgInterface()

Member Function Documentation

◆ dumpInputs()

◆ dumpOutputs()

◆ executeSubroutine()

◆ getRecordTable()

◆ getSymbolTable()

◆ loadAll()

◆ printAll()

◆ run()

◆ runAll()

Field Documentation

◆ exec

◆ interfaces

◆ prog

◆ recordTable

◆ symTable