sbip-sg / tsll Goto Github PK

View Code? Open in Web Editor NEW

5.0 3.0 2.0 1.15 MB

Tsll is a Typescript-to-LLVM-IR compiler frontend authored by Singapore Blockchain Innovation Programme (SBIP).

Home Page: https://www.comp.nus.edu.sg/~dbsystem/discover

License: Other

JavaScript 0.73% TypeScript 99.27%

typescript-compiler llvm-ir compiler-frontend typescript llvm compiler

tsll's Introduction

What is tsll?

Tsll is a Typescript compiler frontend for LLVM IR generation. Our goal of this work is to verify blockchain smart contracts through the generated IR. Before we transpile Node.js code in Typescript into Javascript artifacts, tsll combined with other backend analysis tools could provide a powerful framework to search for vulnerabilities and security issues as smart contract developers would not realize while writing such smart contracts.

Design idea

Tsll extracts information on Abstract Syntax Tree (AST) generated with Typescript Compiler API by visiting each node, and create instructions accordingly with LLVM Typescript bindings to achieve the final IR generation.

For more detail, go to wiki pages

Prerequisite

Follow the steps to build the source code in LLVM project. I highly recommend using the build tool Ninja as it is fast and simple. Below are a few steps you could start from.

Clone the LLVM project repository and enter the project directory via git clone https://github.com/llvm/llvm-project.git and cd llvm-project
Choose a tag from the list and check out into a branch by running git tag -l and git checkout tags/<tag> (Replace <tag> for with your tag choice)
Generate Ninja build files with cmake -S llvm -B build -G Ninja
cmake --build build to start building your LLVM from the Ninja build files (This may take a while)

Note that we use LLVM 13.0.0 to convert Typescript to LLVM Intermediate Representation in this project so you might want to build this LLVM version for compatibility purposes.

Install

npm install tsll

Usage

tsll can be run as a command as you normally would. Just type the following command to see more options on your favorite terminal.

tsll -h

Development

For those who would like to develop this project together, please check out below.

git clone this repo, and make sure you have already installed LLVM before npm i.

Code Style

This project is developed generally with Typescript style guide to attain better maintainability and readability.

Project Structure

All of the code is located in the src directory. Under src/core are the core components Visitor, Builder, and Debugger included. These three pillars are combined with the common utilites under src/common for Tsll to work as a compiler frontend. src/cli.ts and src/converter.ts are basically the entry point to the compiler.

References

A list of resources regarding LLVM and Typescript Compiler API documentation is provided below so that you can get started with this project to contribute if you will.

Disclaimer

By using this project, you agree that we as SBIP developers of tsll have no legal obligations in any form to your usage.

tsll's People

Contributors

Stargazers

Watchers

Forkers

qtcodes igorjs

tsll's Issues

Translation of IntersectionType from Typescript into LLVM IR

Translation of TypeAliasDeclaration from Typescript into LLVM IR

Translation of Typescript anyType to LLVM IR

Motivation

Similar to Javascript, Typescript also supports type any that allows a variable of that type to be assigned values of any other types. This also means that the type checking is disabled whenever any is used in Typescript. Now we are trying to find how any constructs with any could be possibly translated into LLVM IR. Below is an example of one variable and two functions that are defined with any in Typescript.

Example

let obj: any = { content: 'heymycontent' };
obj = 23;

function isView(arg: any): boolean {
    // Do something here
}

// the output of this function may be of any
function calculate(argA: string, argB: number): any {
    return argA + argB;
}

Translation of Typescript generic types to LLVM IR

It is shown in the following that testing with non-nested generic type declarations against our implementation is currently possible. Please leave a comment if you have doubt over the test result.

Input in Typescript

class AnotherClass<T> {
    private testPrivateMember: T;

    constructor(intro: T) {
        this.testPrivateMember = intro;
    }

    public testPrivateInPublic(): T {
        return this.testPrivateMember;
    }
}

let typicalGeneric = new AnotherClass<number>(100);

Output in LLVM IR

; ModuleID = 'genericType.ts'
source_filename = "genericType.ts"

%AnotherClass = type { double }

define void @main(...) {
  %typicalGeneric = alloca %AnotherClass, align 8
  call void (%AnotherClass*, double, ...) @AnotherClass_Constructor(%AnotherClass* %typicalGeneric, double 1.000000e+02)
  ret void
}

define void @AnotherClass_Constructor(%AnotherClass* %this, double %intro, ...) {
  %1 = alloca double, align 8
  store double %intro, double* %1, align 8
  %2 = getelementptr inbounds %AnotherClass, %AnotherClass* %this, i32 0, i32 0
  %3 = load double, double* %1, align 8
  store double %3, double* %2, align 8
  ret void
}

define double @AnotherClass_testPrivateInPublic(%AnotherClass* %this, ...) {
  %1 = getelementptr inbounds %AnotherClass, %AnotherClass* %this, i32 0, i32 0
  %2 = load double, double* %1, align 8
  ret double %2
}

Translation of enum into LLVM IR

Translation of extends/implements into LLVM IR

Failed to install typescriptllvm globally

Typescriptllvm fails to find LLVM 13 during the global installation:

LLVM environment:

$ npm config set cmake_LLVM_DIR $(/home/trungtq/llvm/llvm-sbip/bin/llvm-config --cmakedir)
$ /home/trungtq/llvm/llvm-sbip/bin/llvm-config --version
13.0.1

Error during compilation of Typescriptllvm: LLVM 8 is detected, but not LLVM 13

sudo npm install -g @lungchen/typescriptllvm
[sudo] password for trungtq:
npm ERR! code 1
npm ERR! path /usr/local/lib/node_modules/@lungchen/typescriptllvm/node_modules/@lungchen/llvm-node
npm ERR! command failed
npm ERR! command sh -c cmake-js compile
npm ERR! [
npm ERR!   '/usr/bin/node',
npm ERR!   '/usr/local/lib/node_modules/@lungchen/typescriptllvm/node_modules/.bin/cmake-js',
npm ERR!   'compile'
npm ERR! ]
npm ERR! Not searching for unused variables given on the command line.
npm ERR! -- The C compiler identification is GNU 9.3.0
npm ERR! -- The CXX compiler identification is GNU 9.3.0
npm ERR! -- Check for working C compiler: /usr/bin/cc
npm ERR! -- Check for working C compiler: /usr/bin/cc -- works
npm ERR! -- Detecting C compiler ABI info
npm ERR! -- Detecting C compiler ABI info - done
npm ERR! -- Detecting C compile features
npm ERR! -- Detecting C compile features - done
npm ERR! -- Check for working CXX compiler: /usr/bin/c++
npm ERR! -- Check for working CXX compiler: /usr/bin/c++ -- works
npm ERR! -- Detecting CXX compiler ABI info
npm ERR! -- Detecting CXX compiler ABI info - done
npm ERR! -- Detecting CXX compile features
npm ERR! -- Detecting CXX compile features - done
npm ERR! -- Found LLVM 8.0.1
npm ERR! -- Using LLVMConfig.cmake in: /usr/lib/llvm-8/cmake
npm ERR! -- Configuring done
npm ERR! -- Generating done
npm ERR! -- Build files have been written to: /usr/local/lib/node_modules/@lungchen/typescriptllvm/node_modules/@lungchen/llvm-node/build

Attach debugging information to instructions in LLVM IR

Motivation

This new feature is to provide metadata information about mapping source code to LLVM IR for debuggers and analyzers to consume. They use the information to detect necessary bugs and improve the code quality if any.

References

https://llvm.org/docs/SourceLevelDebugging.html#id4

Translation of IndexedAccessType from Typescript into LLVM IR

Node installation issue

Hi @lung21,

I encountered this error when trying to run npm install

npm ERR! code E404
npm ERR! 404 Not Found - GET https://registry.npmjs.org/@lungchen%2fllvm-node - Not found
npm ERR! 404
npm ERR! 404  '@lungchen/llvm-node@^0.0.4' is not in this registry.
npm ERR! 404 You should bug the author to publish it (or use the name yourself!)
npm ERR! 404
npm ERR! 404 Note that you can also install from a
npm ERR! 404 tarball, folder, http url, or git url.

Can you help to check?

Compilation of library imports into LLVM IR/Bitcode

Motivation

It is not enough to run a program in LLVM IR or Bitcode by itself, because the program may have been written with other library functions, classes, etc. In order for us to run it with lli, an LLVM interpreter, we need a way to compile and link these libraries used in that program.

Example

If we have the following program where console.log is from another library, we should compile its definition into LLVM IR, or link the compiled library with lli.

let str = 'string';
let a = 3;
let b = 4 + 1;
let c = a + 1;
function testCase1(a: number): void {
    return;
}

a = b;

console.log('print something meaningful');

Expected output

Then, we should receive the message as follows if we run the program above.

print something meaningful

sbip-sg / tsll Goto Github PK

tsll's Introduction

What is tsll?

Design idea

Prerequisite

Install

Usage

Development

Code Style

Project Structure

References

Disclaimer

tsll's People

Contributors

Stargazers

Watchers

Forkers

tsll's Issues

Motivation

Example

Input in Typescript

Output in LLVM IR

Motivation

References

Motivation

Example

Expected output

Recommend Projects

Recommend Topics

Recommend Org