hofstee/coreir

##Tested Compatable compilers:
gcc 4.9
Apple LLVM version 8.0.0 (clang-800.0.42.1)

How to Install CoreIR

###If you are using a Linux environment:
To Install:

make install

To verify coreir build

make test

###If you are using an OSX environment To Install:

make osx

To verify coreir build

make test

How to use coreIR in your C++ project

//(in main.cpp)

//include all coreir functions
#include "coreir.h"

//Optionally include stdlib
#include "coreir-libs/stdlib.hpp"

//Optionally include compiler passes
#include "coreir-passes/passes.h"



int main(...) {
...
}

#Makefile example
COREIR = <Path_to_coreir>
INCS = $COREIR/include
LPATH = $COREIR/lib
LIBS =  -Wl,-rpath,$COREIR/lib -lcoreir-passes -lcoreir
executable: main.o 
	$(CXX) $(CXXFLAGS) $(INCS) -o executable main.o $(LPATH) $(LIBS) 

Libraries

A coreir library NAME defines a C++ function CoreIRLoadLibrary_NAME that instantiates and populates a Namespace object. Here is an example defining a library named stdlib.

1. We begin with a header file that declares both the C++ and C interfaces. CoreIR provides macros (defined in coreir-macros.h) for convenience. NOTE: The use of the ifdef guard for C++ is required.

   // coreir-stdlib.h
   #ifndef COREIR_STDLIB_H_
   #define COREIR_STDLIB_H_
   
   #include "coreir-macros.h"
   #include "coreir-c/ctypes.h"
   
   #ifdef __cplusplus
   #include "coreir.h"
   COREIR_GEN_CPP_API_DECLARATION_FOR_LIBRARY(stdlib);
   #endif
   
   COREIR_GEN_C_API_DECLARATION_FOR_LIBRARY(stdlib);
   
   
   #endif //COREIR_STDLIB_HPP_

2. Next we define CoreIRLoadLibrary_stdlib with the interface Namespace* CoreIRLoadLibrary_{{NAME}}(Context* c)

   // coreir-stdlib.cpp
   #include <coreir-stdlib.h>
   Namespace* CoreIRLoadLibrary_stdlib(Context* c) {
     Namespace* stdlib = c->newNamespace("stdlib");
     stdlib->newNamedType("clk","clkIn",c->Bit());
     return stdlib;
   }

3. Finally, the library must wrap this function with a C compatible version using the macro COREIR_GEN_C_API_DEFINITION_FOR_LIBRARY.

   COREIR_GEN_C_API_DEFINITION_FOR_LIBRARY(stdlib);

To find a full working example see lib/libs/stdlib.cpp and include/coreir-lib/stdlib.h.