[feature] #2434: FFI bindgen library #2314

mversic · 2022-06-03T08:56:32Z

Signed-off-by: Marin Veršić marin.versic101@gmail.com

Description of the Change

I've found that often times I need to traverse the type and produce conversions from source to FFI compliant type and vice versa.
There have been a lot of code duplication and convoluted logic which this PR aims to resolve

Traits which enable this happen: ReprC, AsReprC, TryFromReprC IntoFfi. A Rust structure is converted into an intermediary FFI struct via IntoFfi which implements the AsReprC and can be converted into a type that can cross FFI boundary. This goes the other way as well - FFI ReprC type is converted into a struct via TryFromReprC

1st rule of this lib - there is no ownership transfer except for opaque pointer types
Added catch_unwind to prevent UB when panicking over FFI

Issue

Closes #2327

Benefits

Possible Drawbacks

Usage Examples or Tests [optional]

Alternate Designs [optional]

ffi/derive/src/arg.rs

codecov · 2022-06-03T15:12:54Z

Codecov Report

Merging #2314 (586d59a) into iroha2-dev (a16d9c3) will decrease coverage by 0.83%.
The diff coverage is 60.38%.

@@              Coverage Diff               @@
##           iroha2-dev    #2314      +/-   ##
==============================================
- Coverage       67.61%   66.77%   -0.84%     
==============================================
  Files             140      145       +5     
  Lines           26173    27150     +977     
==============================================
+ Hits            17696    18130     +434     
- Misses           8477     9020     +543

Impacted Files	Coverage Δ
actor/src/broker.rs	`88.05% <ø> (ø)`
client/src/client.rs	`45.33% <0.00%> (-0.99%)`	⬇️
core/src/smartcontracts/isi/asset.rs	`54.82% <ø> (ø)`
core/src/smartcontracts/isi/mod.rs	`56.77% <ø> (+3.90%)`	⬆️
core/src/smartcontracts/isi/triggers.rs	`0.00% <0.00%> (ø)`
core/src/wsv.rs	`83.17% <ø> (+0.92%)`	⬆️
data_model/src/events/execute_trigger.rs	`7.40% <ø> (ø)`
data_model/src/metadata.rs	`90.08% <0.00%> (ø)`
data_model/src/predicate.rs	`99.79% <ø> (-0.01%)`	⬇️
data_model/src/role.rs	`6.57% <0.00%> (-0.37%)`	⬇️
... and 62 more

Help us with your feedback. Take ten seconds to tell us how you rate us.

ffi/derive/src/bindgen.rs

ffi/derive/src/derive.rs

ffi/derive/src/arg.rs

ffi/derive/src/bindgen.rs

ffi/derive/tests/ui_fail/derive_skip_field.rs

ffi/derive/tests/ui_fail/mutable_input_arg.rs

ffi/derive/src/arg.rs

Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

…oha#2314) Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

github-actions bot added the iroha2-dev The re-implementation of a BFT hyperledger in RUST label Jun 3, 2022

mversic commented Jun 3, 2022

View reviewed changes

ffi/derive/src/arg.rs Outdated Show resolved Hide resolved

mversic force-pushed the ffi_common_arg_convert branch 2 times, most recently from 1a880b2 to 4b02d18 Compare June 3, 2022 15:03

mversic force-pushed the ffi_common_arg_convert branch from 4b02d18 to e008574 Compare June 3, 2022 15:20

mversic marked this pull request as ready for review June 3, 2022 16:05

mversic requested review from s8sato, appetrosyan, Arjentix, SamHSmith, QuentinI, outoftardis and ilchu as code owners June 3, 2022 16:05

mversic force-pushed the ffi_common_arg_convert branch from e008574 to aa5d343 Compare June 3, 2022 16:43

mversic commented Jun 3, 2022

View reviewed changes

ffi/derive/src/bindgen.rs Outdated Show resolved Hide resolved

mversic commented Jun 3, 2022

View reviewed changes

ffi/derive/src/derive.rs Show resolved Hide resolved

mversic force-pushed the ffi_common_arg_convert branch 3 times, most recently from 96ed308 to 65840fc Compare June 3, 2022 17:30

Arjentix reviewed Jun 4, 2022

View reviewed changes

mversic force-pushed the ffi_common_arg_convert branch from 65840fc to 55158fa Compare June 6, 2022 09:25

mversic mentioned this pull request Jun 6, 2022

FFI transfer ownership instead of cloning #2325

Closed

mversic force-pushed the ffi_common_arg_convert branch 2 times, most recently from 2c64900 to 5c9ef15 Compare June 6, 2022 20:10

appetrosyan changed the title ~~[refactor] #0000: extract FFI conversion logic to separate module~~ [refactor] #2327: extract FFI conversion logic to separate module Jun 7, 2022

mversic force-pushed the ffi_common_arg_convert branch 2 times, most recently from 6be3eb2 to 9406231 Compare June 7, 2022 07:55

outoftardis reviewed Jun 7, 2022

View reviewed changes

ffi/derive/src/arg.rs Outdated Show resolved Hide resolved

mversic force-pushed the ffi_common_arg_convert branch from 9406231 to d35ecfc Compare June 7, 2022 08:40

mversic added 8 commits July 22, 2022 14:20

remove arg.rs, adjust implementation of FFI fns from getset derives

18e3b53

Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

fix slice FFI implementations

0dde7f6

Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

add context to into_ffi and try_from_ffi

413ff96

Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

remove opaque_pointer lib, make OutType trait

5ef5139

Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

introduce reference conversion traits

876485c

Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

remove store, use ownership and traits

17c980e

Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

simplify conversion API

a2f330e

Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

attach lifetime information to ffi slices

07d227a

Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

mversic force-pushed the ffi_common_arg_convert branch 3 times, most recently from f06bbbe to 8270fc1 Compare July 22, 2022 12:55

fix review comments

586d59a

Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

mversic force-pushed the ffi_common_arg_convert branch from 8270fc1 to 586d59a Compare July 22, 2022 14:29

s8sato approved these changes Jul 22, 2022

View reviewed changes

Erigara approved these changes Jul 22, 2022

View reviewed changes

mversic changed the title ~~[refactor] #2434: extract FFI conversion logic to separate module~~ [feature] #2434: FFI bindgen library Jul 22, 2022

mversic merged commit 985f41f into hyperledger-iroha:iroha2-dev Jul 22, 2022

mversic deleted the ffi_common_arg_convert branch July 22, 2022 16:20

mversic added a commit to mversic/iroha that referenced this pull request Jul 22, 2022

[feature] hyperledger-iroha#2434: FFI bindgen library (hyperledger-ir…

519ed28

…oha#2314) Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

This was referenced Jul 25, 2022

Document the FFI bindgen behaviour hyperledger-iroha/iroha-2-docs#83

Closed

Update WASM guide hyperledger-iroha/iroha-2-docs#39

Closed

mversic mentioned this pull request Jul 31, 2022

[feature] #2536: Introduce ffi_import for FFI clients #2557

Merged

mversic added a commit to mversic/iroha that referenced this pull request Sep 6, 2022

[feature] hyperledger-iroha#2434: FFI bindgen library (hyperledger-ir…

6542dfd

…oha#2314) Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

mversic added a commit to mversic/iroha that referenced this pull request Sep 6, 2022

[feature] hyperledger-iroha#2434: FFI bindgen library (hyperledger-ir…

7911abf

…oha#2314) Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

mversic added a commit to mversic/iroha that referenced this pull request Sep 6, 2022

[feature] hyperledger-iroha#2434: FFI bindgen library (hyperledger-ir…

d10cad8

…oha#2314) Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

mversic added a commit to mversic/iroha that referenced this pull request Sep 7, 2022

[feature] hyperledger-iroha#2434: FFI bindgen library (hyperledger-ir…

6639b01

…oha#2314) Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

mversic added a commit to mversic/iroha that referenced this pull request Sep 8, 2022

[feature] hyperledger-iroha#2434: FFI bindgen library (hyperledger-ir…

c63e2f8

…oha#2314) Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

mversic added a commit to mversic/iroha that referenced this pull request Sep 9, 2022

[feature] hyperledger-iroha#2434: FFI bindgen library (hyperledger-ir…

82fa83f

…oha#2314) Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

mversic added a commit to mversic/iroha that referenced this pull request Sep 9, 2022

[feature] hyperledger-iroha#2434: FFI bindgen library (hyperledger-ir…

afbe13c

…oha#2314) Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

mversic added a commit to mversic/iroha that referenced this pull request Sep 9, 2022

[feature] hyperledger-iroha#2434: FFI bindgen library (hyperledger-ir…

480954f

…oha#2314) Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[feature] #2434: FFI bindgen library #2314

[feature] #2434: FFI bindgen library #2314

mversic commented Jun 3, 2022 •

edited

Loading

codecov bot commented Jun 3, 2022 •

edited

Loading

[feature] #2434: FFI bindgen library #2314

[feature] #2434: FFI bindgen library #2314

Conversation

mversic commented Jun 3, 2022 • edited Loading

Description of the Change

Issue

Benefits

Possible Drawbacks

Usage Examples or Tests [optional]

Alternate Designs [optional]

codecov bot commented Jun 3, 2022 • edited Loading

Codecov Report

mversic commented Jun 3, 2022 •

edited

Loading

codecov bot commented Jun 3, 2022 •

edited

Loading