Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

PoC: Build Bytecode Quickly (BBQ) #2088

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

PoC: Build Bytecode Quickly (BBQ) #2088

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
547 changes: 547 additions & 0 deletions runtime/bbq/compiler/compiler.go
View file
Open in desktop

Large diffs are not rendered by default.

331 changes: 331 additions & 0 deletions runtime/bbq/compiler/compiler_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,331 @@
/*
* Cadence - The resource-oriented smart contract programming language
*
* Copyright 2019-2022 Dapper Labs, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package compiler

import (
"testing"

"github.com/stretchr/testify/require"

"github.com/onflow/cadence/runtime/bbq"
"github.com/onflow/cadence/runtime/bbq/constantkind"
"github.com/onflow/cadence/runtime/bbq/opcode"
. "github.com/onflow/cadence/runtime/tests/checker"
)

func TestCompileRecursionFib(t *testing.T) {

t.Parallel()

checker, err := ParseAndCheck(t, `
fun fib(_ n: Int): Int {
if n < 2 {
return n
}
return fib(n - 1) + fib(n - 2)
}
`)
require.NoError(t, err)

compiler := NewCompiler(checker.Program, checker.Elaboration)
program := compiler.Compile()

require.Len(t, program.Functions, 1)
require.Equal(t,
[]byte{
// if n < 2
byte(opcode.GetLocal), 0, 0,
byte(opcode.GetConstant), 0, 0,
byte(opcode.IntLess),
byte(opcode.JumpIfFalse), 0, 14,
// then return n
byte(opcode.GetLocal), 0, 0,
byte(opcode.ReturnValue),
// fib(n - 1)
byte(opcode.GetLocal), 0, 0,
byte(opcode.GetConstant), 0, 1,
byte(opcode.IntSubtract),
byte(opcode.GetGlobal), 0, 0,
byte(opcode.Call),
// fib(n - 2)
byte(opcode.GetLocal), 0, 0,
byte(opcode.GetConstant), 0, 2,
byte(opcode.IntSubtract),
byte(opcode.GetGlobal), 0, 0,
byte(opcode.Call),
// return sum
byte(opcode.IntAdd),
byte(opcode.ReturnValue),
},
compiler.functions[0].code,
)

require.Equal(t,
[]*bbq.Constant{
{
Data: []byte{0x2},
Kind: constantkind.Int,
},
{
Data: []byte{0x1},
Kind: constantkind.Int,
},
{
Data: []byte{0x2},
Kind: constantkind.Int,
},
},
program.Constants,
)
}

func TestCompileImperativeFib(t *testing.T) {

t.Parallel()

checker, err := ParseAndCheck(t, `
fun fib(_ n: Int): Int {
var fib1 = 1
var fib2 = 1
var fibonacci = fib1
var i = 2
while i < n {
fibonacci = fib1 + fib2
fib1 = fib2
fib2 = fibonacci
i = i + 1
}
return fibonacci
}
`)
require.NoError(t, err)

compiler := NewCompiler(checker.Program, checker.Elaboration)
program := compiler.Compile()

require.Len(t, program.Functions, 1)
require.Equal(t,
[]byte{
// var fib1 = 1
byte(opcode.GetConstant), 0, 0,
byte(opcode.SetLocal), 0, 1,
// var fib2 = 1
byte(opcode.GetConstant), 0, 1,
byte(opcode.SetLocal), 0, 2,
// var fibonacci = fib1
byte(opcode.GetLocal), 0, 1,
byte(opcode.SetLocal), 0, 3,
// var i = 2
byte(opcode.GetConstant), 0, 2,
byte(opcode.SetLocal), 0, 4,
// while i < n
byte(opcode.GetLocal), 0, 4,
byte(opcode.GetLocal), 0, 0,
byte(opcode.IntLess),
byte(opcode.JumpIfFalse), 0, 69,
// fibonacci = fib1 + fib2
byte(opcode.GetLocal), 0, 1,
byte(opcode.GetLocal), 0, 2,
byte(opcode.IntAdd),
byte(opcode.SetLocal), 0, 3,
// fib1 = fib2
byte(opcode.GetLocal), 0, 2,
byte(opcode.SetLocal), 0, 1,
// fib2 = fibonacci
byte(opcode.GetLocal), 0, 3,
byte(opcode.SetLocal), 0, 2,
// i = i + 1
byte(opcode.GetLocal), 0, 4,
byte(opcode.GetConstant), 0, 3,
byte(opcode.IntAdd),
byte(opcode.SetLocal), 0, 4,
// continue loop
byte(opcode.Jump), 0, 24,
// return fibonacci
byte(opcode.GetLocal), 0, 3,
byte(opcode.ReturnValue),
},
compiler.functions[0].code,
)

require.Equal(t,
[]*bbq.Constant{
{
Data: []byte{0x1},
Kind: constantkind.Int,
},
{
Data: []byte{0x1},
Kind: constantkind.Int,
},
{
Data: []byte{0x2},
Kind: constantkind.Int,
},
{
Data: []byte{0x1},
Kind: constantkind.Int,
},
},
program.Constants,
)
}

func TestCompileBreak(t *testing.T) {

t.Parallel()

checker, err := ParseAndCheck(t, `
fun test(): Int {
var i = 0
while true {
if i > 3 {
break
}
i = i + 1
}
return i
}
`)
require.NoError(t, err)

compiler := NewCompiler(checker.Program, checker.Elaboration)
program := compiler.Compile()

require.Len(t, program.Functions, 1)
require.Equal(t,
[]byte{
// var i = 0
byte(opcode.GetConstant), 0, 0,
byte(opcode.SetLocal), 0, 0,
// while true
byte(opcode.True),
byte(opcode.JumpIfFalse), 0, 36,
// if i > 3
byte(opcode.GetLocal), 0, 0,
byte(opcode.GetConstant), 0, 1,
byte(opcode.IntGreater),
byte(opcode.JumpIfFalse), 0, 23,
// break
byte(opcode.Jump), 0, 36,
// i = i + 1
byte(opcode.GetLocal), 0, 0,
byte(opcode.GetConstant), 0, 2,
byte(opcode.IntAdd),
byte(opcode.SetLocal), 0, 0,
// repeat
byte(opcode.Jump), 0, 6,
// return i
byte(opcode.GetLocal), 0, 0,
byte(opcode.ReturnValue),
},
compiler.functions[0].code,
)

require.Equal(t,
[]*bbq.Constant{
{
Data: []byte{0x0},
Kind: constantkind.Int,
},
{
Data: []byte{0x3},
Kind: constantkind.Int,
},
{
Data: []byte{0x1},
Kind: constantkind.Int,
},
},
program.Constants,
)
}

func TestCompileContinue(t *testing.T) {

t.Parallel()

checker, err := ParseAndCheck(t, `
fun test(): Int {
var i = 0
while true {
i = i + 1
if i < 3 {
continue
}
break
}
return i
}
`)
require.NoError(t, err)

compiler := NewCompiler(checker.Program, checker.Elaboration)
program := compiler.Compile()

require.Len(t, program.Functions, 1)
require.Equal(t,
[]byte{
// var i = 0
byte(opcode.GetConstant), 0, 0,
byte(opcode.SetLocal), 0, 0,
// while true
byte(opcode.True),
byte(opcode.JumpIfFalse), 0, 39,
// i = i + 1
byte(opcode.GetLocal), 0, 0,
byte(opcode.GetConstant), 0, 1,
byte(opcode.IntAdd),
byte(opcode.SetLocal), 0, 0,
// if i < 3
byte(opcode.GetLocal), 0, 0,
byte(opcode.GetConstant), 0, 2,
byte(opcode.IntLess),
byte(opcode.JumpIfFalse), 0, 33,
// continue
byte(opcode.Jump), 0, 6,
// break
byte(opcode.Jump), 0, 39,
// repeat
byte(opcode.Jump), 0, 6,
// return i
byte(opcode.GetLocal), 0, 0,
byte(opcode.ReturnValue),
},
compiler.functions[0].code,
)

require.Equal(t,
[]*bbq.Constant{
{
Data: []byte{0x0},
Kind: constantkind.Int,
},
{
Data: []byte{0x1},
Kind: constantkind.Int,
},
{
Data: []byte{0x3},
Kind: constantkind.Int,
},
},
program.Constants,
)
}
27 changes: 27 additions & 0 deletions runtime/bbq/compiler/constant.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
/*
* Cadence - The resource-oriented smart contract programming language
*
* Copyright 2019-2022 Dapper Labs, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package compiler

import "github.com/onflow/cadence/runtime/bbq/constantkind"

type constant struct {
index uint16
data []byte
kind constantkind.Constant
}
Loading