redraiment / brainfuck Goto Github PK

View Code? Open in Web Editor NEW

7.0 7.0 0.0 373 KB

Brainfuck Compiler and Interpreter with LLVM in C

License: GNU General Public License v3.0

C 73.81% Lex 1.43% Yacc 3.12% Dockerfile 1.85% C++ 6.75% CMake 11.61% Brainfuck 1.42%

brainfuck c compiler interpreter jit llvm llvm-frontend

brainfuck's Introduction

Hi 👋, I'm Zhang, Zepeng (redraiment)

👨‍💻 Bio

{:name {:first "Zepeng"
        :last "Zhang"}
 :email "[email protected]"
 :bio "A Full Stack Engineer Passionate about Cutting-Edge Technologies."
 :favorites [:AI :Compiler :Database :DataAnalysis :WebApplication
             :Clojure :Kotlin :Python :C :JavaScript
             :Linux :FreeBSD :PostgreSQL :Emacs]}

🔭 Looking forward to connecting with you and creating something amazing together!

📋 My Funny Projects

Quote by Richard P. Feynman: "What I cannot create, I do not understand."

Hence, I reinvented many wheels.

🧬 Play with Interpreters & Compilers

brainfuck: A learning project focused on practicing compiler and interpreter construction using LLVM C API, flex, bison, and more.
basic: A BASIC Programming Language Interpreter implemented in ANSI C.
SmallC: my undergraduate graduation project, featuring a programming language with built-in concurrency support.
Linsp: A minimal Lisp interpreter in Lisp, inspired by The Roots of Lisp.
clop: A programming language currently under design.
jssp: A templating system embedding JVM scripting language into text documents, similar to JSP, PHP, ASP, and other server-side scripting languages.

🖼️ Frameworks

FrontEnd Framework on React

pure-frame: A data-driven, functional, and reactive JavaScript framework for modern web apps, utilizing React and inspired by re-frame.

BackEnd Framework on Clojure

zeta: An open-source software development toolkit in Clojure.

BackEnd Framework on Java

Java on Rails: A Java MVC framework inspired by Ruby on Rails (RoR), featuring:
- jactiverecord: ORM module implementing the ActiveRecord pattern in Java.
- jactiverecord-el: JSP expression language (EL) for jActiveRecord, providing Record & Table field accessors.
- jactioncontroller: Controller module.
- jactionview: View module.

BackEnd Framework on PHP 5

PinkRaiment: A PHP MVC framework inspired by RoR.
phpActiveRecord: ActiveRecord implementation in PHP, similar to jActiveRecord.

🐂 Play with Emacs Lisp

edbc: Emacs-Lisp-based data access technology inspired by JDBC.
emacs-cgi: Using Emacs Lisp for CGI scripting.
eml: Emacs-lisp Markup Language - converting S-expressions to XML.
wechat.el: A framework for developing WeChat games in Emacs Lisp.

💽 Play with Databases

SciKit Learn for PolarDB: A PostgreSQL extension wrapping SciKit-Learn.
pgaut: A PostgreSQL extension implementing MySQL's on update current_timestamp.
pgsql-proxy-middleware: A one-liner Node.js proxy middleware for PostgreSQL.
sqlet: A framework for developing web services in pure SQL.

🐬 Play with Docker

My workstations: Development environments based on Docker containers.

docker-workstations: A collection of Docker images for development, including:
- archlinux: A Archlinux Docker based image with useful utilities.
- clojure: A Clojure development environment based on archlinux with Leiningen.
- python: a Python development environment based on archlinux with IPython and Jupyter.

💡 Play with Knowledges

calendiary: A diary app featuring a calendar view, inspired by Flava 1.0.
iKnowledge: A personal knowledge management system based on Jekyll.
redraiment.github.io: My blog built on iKnowledge.

🧰 Play with Utilities

jco: An API for parsing command-line options in Java programs.
jfn: An example of functional-style programming in pure Java (1.5+).
listfile: An enhanced ls capable of matching file paths with regular expressions.

brainfuck's People

Contributors

Stargazers

Watchers

brainfuck's Issues

Use CMake to build

Reduce the serial same commands

Merge the serial same commands to reduce instructions and enhance performances.

Reduce the serial + and - commands to one update instruction.
Reduce the serial > and < commands to one move instruction.

Build a Brainfuck compile with LLVM C API

Almost of LLVM tutorials are using C++, however, I'd like to use C language to build the lightweight compiler.
Fortunately, the LLVM provides the C interface as well!

Use alpine to instead ubuntu to reduce image size

Support JIT mode in Clojure version as well

Support shebang mode

Function Requirement

Support shebang mode like below:

#!/usr/bin/env brainfuck

++++++++++
[>+++++++>++++++++++>+++>+<<<<-]
>++.>+.+++++++..+++.>++.<<+++++++++++++++.
>.+++.------.--------.>+.>.

Tech Requirement

Add new command # for single line comment.

Release deb package for Debian/Ubuntu

Auto install musl-dev for runtime.

Lexical analysis with flex

Deploy Clojure version with docker

Add an option for enable single comment command

Disable extra command default, and let user to enable it.

Build an interpreter with pure Clojure

Cannot compile when the source file not in current directory.

Building project with GNU Make

Lexical and Syntax analysis with instaparse

Generating Makefile with GNU Autoconf

Stack smashing detected on Ubuntu

It would be cashed when link to executable file.

Support preprocess mode

Emit LLVM representation (.ll)

Build an interpreter in ANSI C

Build a simple Brainfuck interpreter in pure ANSI C, without any third-party dependencies.

Provide command line options to switch between compile mode and scripting mode

Function Description

Usage: brainfuck [Options] <source-file>

Options:

-c/--compile: Enable compile mode. Emit native object (.o).
-p/--preprocess: Enable preprocess mode. Emit LLVM representation (.ll).
-s/--script: [DEFAULT] Enable scripting mode. Parse and execute in memory.
-o/--output <output-file>: Write output to file.
-h/--help: Show this help and exit.

Tech requirement

Parsing command line options with GNU getopt library.

Search linker and c runtime libraries at runtime, rather than compiling time

Embed the CRT into the compiler

Strip dependencies on external files at runtime.

Deploying with docker

Learn brainfuck specification

Resources

Brainfuck Wikipedia

Key Information

Memory size: 30,000 bytes, and initialized to zero.
Data pointer initialized to point to the leftmost byte of the array.
Two streams of bytes for input and output.
Eight commands:

Character	Meaning
`>`	Increment the data pointer (to point to the next cell to the right).
`<`	Decrement the data pointer (to point to the next cell to the left).
`+`	Increment (increase by one) the byte at the data pointer.
`-`	Decrement (decrease by one) the byte at the data pointer.
`.`	Output the byte at the data pointer.
`,`	Accept one byte of input, storing its value in the byte at the data pointer.
`[`	If the byte at the data pointer is zero, then instead of moving the instruction pointer forward to the next command, jump it forward to the command after the matching `]` command.
`]`	If the byte at the data pointer is nonzero, then instead of moving the instruction pointer forward to the next command, jump it back to the command after the matching `[` command.

Syntax analysis with bison

Build AST.

When using static linking with LLVM, execution throws an address boundary error exception.

Embed Brainfuck as DSL in Clojure with macro

Macro in Lisp is an amazing feature! It can be used for defining language syntax extensions, which is known as Domain Specific Languages (DSLs).

Try create a Clojure macro to embedded Brainfuck into Clojure.

Build help and version info with config.h

Static link rather than dynamic link

Add Usage section to README

make error

Hello author:
when I use make command,it will be error.

user@user-Latitude-5430:~/brainfuck$ make
clang -c -I/usr/local/include  -D_GNU_SOURCE -D__STDC_CONSTANT_MACROS -D__STDC_FORMAT_MACROS -D__STDC_LIMIT_MACROS -o options.o options.c
clang -c -I/usr/local/include  -D_GNU_SOURCE -D__STDC_CONSTANT_MACROS -D__STDC_FORMAT_MACROS -D__STDC_LIMIT_MACROS -o engine.o engine.c
clang -c -I/usr/local/include  -D_GNU_SOURCE -D__STDC_CONSTANT_MACROS -D__STDC_FORMAT_MACROS -D__STDC_LIMIT_MACROS -o ast.o ast.c
/usr/bin/bison -d -o parser.c parser.y
/usr/bin/flex --header-file=scanner.h -o scanner.c scanner.l
clang -c -I/usr/local/include  -D_GNU_SOURCE -D__STDC_CONSTANT_MACROS -D__STDC_FORMAT_MACROS -D__STDC_LIMIT_MACROS -o parser.o parser.c
In file included from parser.y:3:
parser.y:12:3: error: unknown type name 'yytoken_kind_t'
  yytoken_kind_t token;
  ^
1 error generated.
make: *** [Makefile:35: parser.o] Error 1

Execute bitcode with LLVM MCJIT

Enhance the C version compiler to support JIT interpreter mode.

Wrap LLVM with JNA

Execution engine throws an address boundary error exception.

It because the execution engine (JIT compiler) cannot find putchar and getchar.

redraiment / brainfuck Goto Github PK

brainfuck's Introduction

Hi 👋, I'm Zhang, Zepeng (redraiment)

👨‍💻 Bio

📋 My Funny Projects

🧬 Play with Interpreters & Compilers

🖼️ Frameworks

FrontEnd Framework on React

BackEnd Framework on Clojure

BackEnd Framework on Java

BackEnd Framework on PHP 5

🐂 Play with Emacs Lisp

💽 Play with Databases

🐬 Play with Docker

💡 Play with Knowledges

🧰 Play with Utilities

brainfuck's People

Contributors

Stargazers

Watchers

brainfuck's Issues

Function Requirement

Tech Requirement

Function Description

Tech requirement

Resources

Key Information

Function Requirement

Tech Requirement

Recommend Projects

Recommend Topics

Recommend Org