Introduce compiler-rt and add bitwise `and`, `or`, `xor` polyfills #89

wzmuda · 2024-11-14T23:23:08Z

Summary

Introduce compiler runtime module. Add relevant CI changes and update the PR template to reflect that we should also format the Cairo code.

Start implementing ALU. Add the top-level module and submodules for and, or and xor operations. Add relevant readmes.

Implemented polyfills:

`and`

Implements bitwise and operation.

API

__llvm_and_bool_bool(lhs: u128, rhs: u128) -> u128
__llvm_and_i8_i8(lhs: u128, rhs: u128) -> u128
__llvm_and_i16_i16(lhs: u128, rhs: u128) -> u128
__llvm_and_i32_i32(lhs: u128, rhs: u128) -> u128
__llvm_and_i64_i64(lhs: u128, rhs: u128) -> u128
__llvm_and_i128_i128(lhs: u128, rhs: u128) -> u128

`or`

Implements bitwise or operation.

API

__llvm_or_bool_bool(lhs: u128, rhs: u128) -> u128
__llvm_or_i8_i8(lhs: u128, rhs: u128) -> u128
__llvm_or_i16_i16(lhs: u128, rhs: u128) -> u128
__llvm_or_i32_i32(lhs: u128, rhs: u128) -> u128
__llvm_or_i64_i64(lhs: u128, rhs: u128) -> u128
__llvm_or_i128_i128(lhs: u128, rhs: u128) -> u128

`xor`

Implements bitwise xor operation.

API

__llvm_xor_bool_bool(lhs: u128, rhs: u128) -> u128
__llvm_xor_i8_i8(lhs: u128, rhs: u128) -> u128
__llvm_xor_i16_i16(lhs: u128, rhs: u128) -> u128
__llvm_xor_i32_i32(lhs: u128, rhs: u128) -> u128
__llvm_xor_i64_i64(lhs: u128, rhs: u128) -> u128
__llvm_xor_i128_i128(lhs: u128, rhs: u128) -> u128

Other PRs for issue #38 will follow.

Details

Are we sure about using u128 instead of felts?
Does my testing approach make sense? I generated all these cases with Python.
Apart from code please rate the overall code organization.

Checklist

Code is formatted by Rustfmt or scarb fmt.
Documentation has been updated if necessary.

iamrecursion

A good start, but definitely needs some changes in my view. One thing I want to see is documentation of the structure and why this structure is chosen.

compiler_rt/src/alu.cairo

compiler_rt/src/alu/test_cases.cairo

compiler_rt/src/alu/and_bool.cairo

compiler_rt/src/alu/and_i128.cairo

wzmuda · 2024-11-15T23:53:52Z

One thing I want to see is documentation of the structure and why this structure is chosen.

Sure, where would be a good place for this? Dedicated README.md in the compiler_rt directory perhaps? That would be a central point for everybody who starts reading/modifying the runtime and would display nicely on github.

compiler_rt/src/alu/and/and_bool.cairo

iamrecursion

Good stuff, but still more to do! Please apply comments I have made on one polyfill (or set of polyfills) to all relevant polyfills; I didn't want to repeat myself too much.

.github/workflows/scarb.yml

compiler_rt/README.md

compiler_rt/src/alu/and/and_bool.cairo

compiler_rt/src/alu/and/and_i128.cairo

compiler_rt/src/alu/and/and_i16.cairo

package.json

iamrecursion

Good stuff, but there is yet more to do!

compiler_rt/README.md

compiler_rt/src/alu/and/and_bool.cairo

.github/workflows/scarb.yml

compiler_rt/src/alu/and/and_i1.cairo

Run `npm audit fix`. This was motivated by the following error: [error] Cannot find package 'prettier-plugin-toml' imported from /Users/wz/reilabs/starknet/hieratika/noop.js Signed-off-by: Wojciech Zmuda <[email protected]>

Signed-off-by: Wojciech Zmuda <[email protected]>

iamrecursion

LGTM! One last question; can we have the directory called compiler-rt even if the project is compiler_rt? It would be cleaner.

iamrecursion · 2024-11-19T15:03:49Z

compiler_rt/README.md

+one of the polyfills.
+
+This project's name deliberately resembles [LLVM's `compiler-rt`](https://compiler-rt.llvm.org/),
+because it served the same purpose of providing implementations of the low-level operations written


Suggested change

because it served the same purpose of providing implementations of the low-level operations written

because it serves the same purpose of providing implementations of the low-level operations written

Add skeleton for the compiler_rt project, which is a scarb project containing Cairo code implementing Hieratika polyfills. The first added operations are: - `__llvm_and_i1_i1` - `__llvm_and_i8_i8` - `__llvm_and_i16_i16` - `__llvm_and_i32_i32` - `__llvm_and_i64_i64` - `__llvm_and_i128_i128` Signed-off-by: Wojciech Zmuda <[email protected]>

This workflow tests and formats Cairo code. It is triggered only on changes done to the compiler-rt directory. Signed-off-by: Wojciech Zmuda <[email protected]>

Add `__llvm_or_iN_iN` family of polyfills to ALU. Signed-off-by: Wojciech Zmuda <[email protected]>

Add `__llvm_xor_iN_iN` family of polyfills to ALU. Signed-off-by: Wojciech Zmuda <[email protected]>

iamrecursion requested changes Nov 15, 2024

View reviewed changes

compiler_rt/src/alu.cairo Outdated Show resolved Hide resolved

compiler_rt/src/alu/test_cases.cairo Outdated Show resolved Hide resolved

compiler_rt/src/alu/and_bool.cairo Outdated Show resolved Hide resolved

compiler_rt/src/alu/and_i128.cairo Outdated Show resolved Hide resolved

wzmuda force-pushed the wz/alu-bit-ops branch 2 times, most recently from eac1dc7 to 06124cc Compare November 15, 2024 23:52

wzmuda force-pushed the wz/alu-bit-ops branch 5 times, most recently from cca754f to 106000a Compare November 17, 2024 22:04

wzmuda commented Nov 17, 2024

View reviewed changes

compiler_rt/src/alu/and/and_bool.cairo Outdated Show resolved Hide resolved

wzmuda force-pushed the wz/alu-bit-ops branch 2 times, most recently from 366eb21 to bb94e00 Compare November 17, 2024 23:41

wzmuda marked this pull request as ready for review November 17, 2024 23:41

wzmuda requested a review from a team as a code owner November 17, 2024 23:41

wzmuda changed the title ~~Introduce compiler_rt and add bitwise and polyfills~~ Introduce compiler_rt and add bitwise and, or, xor polyfills Nov 18, 2024

iamrecursion requested changes Nov 18, 2024

View reviewed changes

wzmuda force-pushed the wz/alu-bit-ops branch 2 times, most recently from 793118a to 3e0facf Compare November 18, 2024 17:46

iamrecursion requested changes Nov 18, 2024

View reviewed changes

compiler_rt/README.md Outdated Show resolved Hide resolved

compiler_rt/src/alu/and/and_bool.cairo Outdated Show resolved Hide resolved

.github/workflows/scarb.yml Outdated Show resolved Hide resolved

compiler_rt/src/alu/and/and_i1.cairo Outdated Show resolved Hide resolved

wzmuda force-pushed the wz/alu-bit-ops branch from 3e0facf to 5717707 Compare November 18, 2024 23:06

wzmuda added 2 commits November 19, 2024 00:06

Fix broken npm prettier

931deca

Run `npm audit fix`. This was motivated by the following error: [error] Cannot find package 'prettier-plugin-toml' imported from /Users/wz/reilabs/starknet/hieratika/noop.js Signed-off-by: Wojciech Zmuda <[email protected]>

flake: add Cairo toolchain

916f706

Signed-off-by: Wojciech Zmuda <[email protected]>

wzmuda force-pushed the wz/alu-bit-ops branch 2 times, most recently from 85051eb to ad25010 Compare November 18, 2024 23:35

iamrecursion approved these changes Nov 19, 2024

View reviewed changes

wzmuda added 4 commits November 19, 2024 20:46

github: add Cairo CI workflow

a80eb03

This workflow tests and formats Cairo code. It is triggered only on changes done to the compiler-rt directory. Signed-off-by: Wojciech Zmuda <[email protected]>

compiler-rt: alu: add bitwise or polyfills

965205c

Add `__llvm_or_iN_iN` family of polyfills to ALU. Signed-off-by: Wojciech Zmuda <[email protected]>

compiler-rt: alu: add bitwise xor polyfills

1e90256

Add `__llvm_xor_iN_iN` family of polyfills to ALU. Signed-off-by: Wojciech Zmuda <[email protected]>

wzmuda force-pushed the wz/alu-bit-ops branch from ad25010 to 1e90256 Compare November 19, 2024 19:46

wzmuda changed the title ~~Introduce compiler_rt and add bitwise and, or, xor polyfills~~ Introduce compiler-rt and add bitwise and, or, xor polyfills Nov 19, 2024

wzmuda merged commit 7b7da08 into main Nov 19, 2024
10 checks passed

wzmuda deleted the wz/alu-bit-ops branch November 19, 2024 19:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce compiler-rt and add bitwise `and`, `or`, `xor` polyfills #89

Introduce compiler-rt and add bitwise `and`, `or`, `xor` polyfills #89

wzmuda commented Nov 14, 2024 •

edited

Loading

iamrecursion left a comment

wzmuda commented Nov 15, 2024

iamrecursion left a comment

iamrecursion left a comment

iamrecursion left a comment

iamrecursion Nov 19, 2024

wzmuda Nov 19, 2024

	because it served the same purpose of providing implementations of the low-level operations written
	because it serves the same purpose of providing implementations of the low-level operations written

Introduce compiler-rt and add bitwise and, or, xor polyfills #89

Introduce compiler-rt and add bitwise and, or, xor polyfills #89

Conversation

wzmuda commented Nov 14, 2024 • edited Loading

Summary

Implemented polyfills:

and

API

or

API

xor

API

Details

Checklist

iamrecursion left a comment

Choose a reason for hiding this comment

wzmuda commented Nov 15, 2024

iamrecursion left a comment

Choose a reason for hiding this comment

iamrecursion left a comment

Choose a reason for hiding this comment

iamrecursion left a comment

Choose a reason for hiding this comment

iamrecursion Nov 19, 2024

Choose a reason for hiding this comment

wzmuda Nov 19, 2024

Choose a reason for hiding this comment

Introduce compiler-rt and add bitwise `and`, `or`, `xor` polyfills #89

Introduce compiler-rt and add bitwise `and`, `or`, `xor` polyfills #89

wzmuda commented Nov 14, 2024 •

edited

Loading

`and`

`or`

`xor`