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.

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

update implementing libfuncs doc #856

Merged
merged 2 commits into from
Oct 17, 2024
Merged

update implementing libfuncs doc #856

merged 2 commits into from
Oct 17, 2024

Conversation

edg-l
Copy link
Member

@edg-l edg-l commented Oct 17, 2024

Checklist

  • Linked to Github Issue
  • Unit tests added
  • Integration tests added.
  • This change requires new documentation.
    • Documentation has been added/updated.

Copy link

github-actions bot commented Oct 17, 2024

Benchmarking results

Benchmark for program factorial_2M

Open benchmarks
Command Mean [s] Min [s] Max [s] Relative
Cairo-vm (Rust, Cairo 1) 10.964 ± 0.260 10.662 11.395 23.31 ± 0.55
cairo-native (embedded AOT) 3.249 ± 0.011 3.221 3.262 6.91 ± 0.03
cairo-native (embedded JIT using LLVM's ORC Engine) 3.268 ± 0.035 3.232 3.353 6.95 ± 0.08
cairo-native (standalone AOT) 0.680 ± 0.004 0.678 0.690 1.45 ± 0.01
cairo-native (standalone AOT with -march=native) 0.470 ± 0.001 0.469 0.471 1.00

Benchmark for program fib_2M

Open benchmarks
Command Mean [s] Min [s] Max [s] Relative
Cairo-vm (Rust, Cairo 1) 11.189 ± 0.310 10.721 11.603 1378.81 ± 39.94
cairo-native (embedded AOT) 2.793 ± 0.037 2.735 2.867 344.22 ± 5.35
cairo-native (embedded JIT using LLVM's ORC Engine) 2.808 ± 0.024 2.776 2.846 345.99 ± 4.10
cairo-native (standalone AOT) 0.009 ± 0.000 0.009 0.010 1.07 ± 0.01
cairo-native (standalone AOT with -march=native) 0.008 ± 0.000 0.008 0.009 1.00

Benchmark for program logistic_map

Open benchmarks
Command Mean [s] Min [s] Max [s] Relative
Cairo-vm (Rust, Cairo 1) 4.486 ± 0.058 4.424 4.623 61.77 ± 0.82
cairo-native (embedded AOT) 2.937 ± 0.020 2.898 2.963 40.44 ± 0.30
cairo-native (embedded JIT using LLVM's ORC Engine) 3.106 ± 0.016 3.077 3.124 42.76 ± 0.25
cairo-native (standalone AOT) 0.112 ± 0.000 0.112 0.113 1.55 ± 0.00
cairo-native (standalone AOT with -march=native) 0.073 ± 0.000 0.072 0.074 1.00

Copy link

github-actions bot commented Oct 17, 2024

Benchmark results Main vs HEAD.

Command Mean [s] Min [s] Max [s] Relative
head factorial_2M.cairo (JIT) 3.182 ± 0.034 3.138 3.235 1.01 ± 0.02
base factorial_2M.cairo (JIT) 3.175 ± 0.015 3.155 3.205 1.01 ± 0.01
head factorial_2M.cairo (AOT) 3.145 ± 0.035 3.106 3.223 1.00
base factorial_2M.cairo (AOT) 3.147 ± 0.024 3.123 3.202 1.00 ± 0.01
Command Mean [s] Min [s] Max [s] Relative
head fib_2M.cairo (JIT) 2.695 ± 0.024 2.653 2.726 1.02 ± 0.01
base fib_2M.cairo (JIT) 2.705 ± 0.018 2.681 2.731 1.02 ± 0.01
head fib_2M.cairo (AOT) 2.652 ± 0.016 2.628 2.681 1.00
base fib_2M.cairo (AOT) 2.668 ± 0.018 2.645 2.693 1.01 ± 0.01
Command Mean [s] Min [s] Max [s] Relative
head logistic_map.cairo (JIT) 2.983 ± 0.038 2.944 3.063 1.06 ± 0.01
base logistic_map.cairo (JIT) 2.975 ± 0.017 2.942 3.002 1.05 ± 0.01
head logistic_map.cairo (AOT) 2.822 ± 0.016 2.804 2.847 1.00
base logistic_map.cairo (AOT) 2.865 ± 0.040 2.818 2.932 1.02 ± 0.02

@edg-l edg-l linked an issue Oct 17, 2024 that may be closed by this pull request
@edg-l edg-l enabled auto-merge October 17, 2024 15:14
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.73%. Comparing base (9db1175) to head (266dc73).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #856   +/-   ##
=======================================
  Coverage   82.73%   82.73%           
=======================================
  Files         120      120           
  Lines       34937    34937           
=======================================
  Hits        28905    28905           
  Misses       6032     6032           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@edg-l edg-l added this pull request to the merge queue Oct 17, 2024
Merged via the queue into main with commit 0e251c5 Oct 17, 2024
15 checks passed
@edg-l edg-l deleted the upd_impl_libfuncs branch October 17, 2024 15:51
edg-l added a commit that referenced this pull request Oct 21, 2024
* Add logs

* Implement Felt252Dict trace dump

* Implement nullabel for trace dump

* Print type id

* Remove print

* add convertion for Sints

* fix mispelled types

* forgot to add feature

* change Sints value to correspond to sierra-emu

* Readd feature

* Add is_infinity field to secp256 point struct (#828)

* add is_infinity to secp point

* clean

* fix

* use same deps as blockifier

* fix

* fix layout

* fix test

* remove some brittle asserts due to random initial data when adding and muling points at infinity

* fix

* remove unused dep

* fixes, missed the value entry/output

* Reset src

* Fix warnings

* Make library public

* Use debug runtime for trace dump

* fix storage's values truncations (#839)

* fix storage's values truncations

* change implementation for i8 i16 i32 i64 too

* format

* Add ptr check to felt dict entry

* Add malloc tracing and fix more memory leaks. (#833)

* Add memory tracing.

* Partial memory fixes.

* Fix arrays.

* Simplify dictionaries. Fix false positive memory leak in dictionary drops.

* Fix zero-sized allocation. Fix warnings. More mem tracing checks.

* Fix mem tracing.

* Fix memory leak in `print` libfunc.

* Fix array slice libfunc.

* Fix starknet memory leaks.

* Fix keccak syscall.

* Fix dict get double free bug.

* Lots of memory fixes.

* More fixes.

* Fix CI.

* Remove old TODOs.

* Fix CI (again).

* Remove TODOs.

* Fix test.

* Maybe fix

* Maybe fix

* Maybe fix

* Dont panic when building circuit partial outputs

* trace dump for Sha256StateHandler

* Builtin costs rework (#837)

* Update to 2.8.4, release docs, alpha

This PR updates cairo to 2.8.4, adds some release docs and updates the
version to alpha.3 to prepare for another release.

* try fix

* cleanup ci, remove panic in link

* rename from jit to from ptr, etc

* crates.io badge

* progress

* progress

* fmt2

* progress

* progress

* fix

* fix bench

* use struct

* Fix felt252 and enum deserialization bugs. (#844)

* Fix felt252 and enum deserialization bugs.

* Fix formatting.

* Also fix the runtime.

* Fix errors.

* try to fix ci

* remove unused deps

---------

Co-authored-by: Edgar Luque <[email protected]>

* Fix trace dump type conv

* fix aot contract executor not passing builtinstats (#849)

* Fix felt252 and enum deserialization bugs.

* Fix formatting.

* Also fix the runtime.

* Fix errors.

* try to fix ci

* remove unused deps

* fix aot contract executor not passing builtinstats

---------

Co-authored-by: Esteve Soler Arderiu <[email protected]>
Co-authored-by: Esteve Soler Arderiu <[email protected]>

* Fix bug (#851)

* Also fix felt bits in starknet syscall wrappers (#853)

* Also fix felt bits in starknet syscall wrappers

* style

* missed

* fix aot contract executor not passing builtinstats (#849)

* Fix felt252 and enum deserialization bugs.

* Fix formatting.

* Also fix the runtime.

* Fix errors.

* try to fix ci

* remove unused deps

* fix aot contract executor not passing builtinstats

---------

Co-authored-by: Esteve Soler Arderiu <[email protected]>
Co-authored-by: Esteve Soler Arderiu <[email protected]>

* Fix bug (#851)

* Also fix felt bits in starknet syscall wrappers (#853)

* Also fix felt bits in starknet syscall wrappers

* style

* missed

* update version to alpha 4 (#854)

* bytes31

* Better function attributes and re-enable >O1 opt (#843)

* Fix felt252 and enum deserialization bugs.

* Fix formatting.

* Also fix the runtime.

* Fix errors.

* try to fix ci

* remove unused deps

* proper function attributes

* add proper function attrs to optimize better, add some passes, run tests with atleast some opts

* dont use remi

* oops

* maybe with opt level 3 now it works

* test

* works

* readd deleted bench

* remove dbg

* Update bench-hyperfine.sh

* fixci

* comment

* Update src/ffi.rs

Co-authored-by: MrAzteca <[email protected]>

---------

Co-authored-by: Esteve Soler Arderiu <[email protected]>
Co-authored-by: Esteve Soler Arderiu <[email protected]>
Co-authored-by: MrAzteca <[email protected]>

* Resolve `CAIRO_NATIVE_RUNTIME_LIBRARY` relative path (#841)

* feat(ffi): resolve runtime relative path using current dir

* chore: remove mentions to old runtime variable

* fix: typo

---------

Co-authored-by: Bohdan Ohorodnii <[email protected]>

* Implement secp

* Fix bytes31

* try to fix ci (#858)

* update implementing libfuncs doc (#856)

* Fix bytes31 bug

* Remove unused dep

---------

Co-authored-by: FrancoGiachetta <[email protected]>
Co-authored-by: Edgar <[email protected]>
Co-authored-by: MrAzteca <[email protected]>
Co-authored-by: Esteve Soler Arderiu <[email protected]>
Co-authored-by: Esteve Soler Arderiu <[email protected]>
Co-authored-by: Rodrigo <[email protected]>
Co-authored-by: Bohdan Ohorodnii <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve libfunc implementation docs
4 participants