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

Enable Miri to pass pointers through FFI #129684

Merged
merged 1 commit into from
Aug 31, 2024
Merged

Enable Miri to pass pointers through FFI #129684

merged 1 commit into from
Aug 31, 2024

Conversation

Strophox
Copy link
Contributor

Following #126787, the purpose of this PR is to now enable Miri to execute native calls that make use of pointers.

Simple example 
extern "C" {
    fn ptr_printer(ptr: *mut i32);
}

fn main() {
    let ptr = &mut 42 as *mut i32;
    unsafe {
        ptr_printer(ptr);
    }
}
void ptr_printer(int *ptr) {
  printf("printing pointer dereference from C: %d\n", *ptr);
}

should now show printing pointer dereference from C: 42.

Note that this PR does not yet implement any logic involved in updating Miri's "analysis" state (byte initialization, provenance) upon such a native call.

r? @RalfJung

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Aug 28, 2024
@rustbot
Copy link
Collaborator

rustbot commented Aug 28, 2024

Some changes occurred to the CTFE / Miri engine

cc @rust-lang/miri

Some changes occurred to the CTFE / Miri engine

cc @rust-lang/miri

The Miri subtree was changed

cc @rust-lang/miri

@Strophox
Copy link
Contributor Author

Oh. Well that didn't work yet.

RalfJung
RalfJung reviewed Aug 29, 2024
View reviewed changes
src/tools/miri/src/alloc_addresses/mod.rs Outdated Show resolved Hide resolved
src/tools/miri/src/alloc_addresses/mod.rs Show resolved Hide resolved
src/tools/miri/src/alloc_addresses/mod.rs Outdated Show resolved Hide resolved
src/tools/miri/src/machine.rs Outdated Show resolved Hide resolved
src/tools/miri/src/machine.rs Outdated Show resolved Hide resolved
src/tools/miri/src/machine.rs Outdated Show resolved Hide resolved
src/tools/miri/src/machine.rs Outdated Show resolved Hide resolved
src/tools/miri/src/shims/native_lib.rs Outdated Show resolved Hide resolved
src/tools/miri/tests/native-lib/pass/call_extern_c_fn.stdout Outdated
@@ -1 +1,2 @@
printing from C
printing pointer dereference from C: 42
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉

@rust-log-analyzer

This comment has been minimized.

Sign in to view
@Strophox
Copy link
Contributor Author

(I might quickly try to enhance+refactor the C pointer FFI tests in Miri now.)

RalfJung
RalfJung reviewed Aug 29, 2024
View reviewed changes
src/tools/miri/src/alloc_addresses/mod.rs Outdated Show resolved Hide resolved
src/tools/miri/src/alloc_addresses/mod.rs Show resolved Hide resolved
src/tools/miri/src/machine.rs Outdated Show resolved Hide resolved
RalfJung
RalfJung reviewed Aug 30, 2024
View reviewed changes
Copy link
Member

@RalfJung RalfJung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall, thanks! Just got some nits regarding the tests.

src/tools/miri/tests/native-lib/native-lib.map Outdated Show resolved Hide resolved
src/tools/miri/tests/native-lib/pass/ptr_read_access.rs Outdated Show resolved Hide resolved
src/tools/miri/tests/native-lib/pass/ptr_read_access.rs Outdated Show resolved Hide resolved
src/tools/miri/tests/native-lib/pass/scalar_arguments.rs Outdated Show resolved Hide resolved
src/tools/miri/tests/native-lib/ptr_read_access.c Outdated Show resolved Hide resolved
src/tools/miri/tests/native-lib/scalar_arguments.c Outdated Show resolved Hide resolved
src/tools/miri/tests/ui.rs Outdated Show resolved Hide resolved
src/tools/miri/tests/ui.rs Outdated Show resolved Hide resolved
@RalfJung
Copy link
Member

Please squash the commits, then we can land this. :-)

@Strophox @RalfJung
enable Miri to pass const pointers through FFI
7fde02e 
Co-authored-by: Ralf Jung <post@ralfj.de>
@RalfJung
Copy link
Member

Great, congrats on getting this finished!

@bors r+

@bors
Copy link
Contributor

bors commented Aug 31, 2024

📌 Commit 7fde02e has been approved by RalfJung

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Aug 31, 2024
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Aug 31, 2024
@matthiaskrgr
Rollup merge of rust-lang#129684 - Strophox:miri-pass-pointer-to-ffi,…
f995a63 
… r=RalfJung

Enable Miri to pass pointers through FFI

Following rust-lang#126787, the purpose of this PR is to now enable Miri to execute native calls that make use of pointers.

> <details>
>
> <summary> Simple example </summary>
>
> ```rust
> extern "C" {
>     fn ptr_printer(ptr: *mut i32);
> }
>
> fn main() {
>     let ptr = &mut 42 as *mut i32;
>     unsafe {
>         ptr_printer(ptr);
>     }
> }
> ```
> ```c
> void ptr_printer(int *ptr) {
>   printf("printing pointer dereference from C: %d\n", *ptr);
> }
> ```
> should now show `printing pointer dereference from C: 42`.
>
> </details>

Note that this PR does not yet implement any logic involved in updating Miri's "analysis" state (byte initialization, provenance) upon such a native call.

r? `@RalfJung`
This was referenced Aug 31, 2024
Closed
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Aug 31, 2024
@bors
Auto merge of rust-lang#129831 - matthiaskrgr:rollup-befq6zx, r=matth…
d37b074 
…iaskrgr

Rollup of 11 pull requests

Successful merges:

 - rust-lang#128523 (Add release notes for 1.81.0)
 - rust-lang#129605 (Add missing `needs-llvm-components` directives for run-make tests that need target-specific codegen)
 - rust-lang#129650 (Clean up `library/profiler_builtins/build.rs`)
 - rust-lang#129651 (skip stage 0 target check if `BOOTSTRAP_SKIP_TARGET_SANITY` is set)
 - rust-lang#129684 (Enable Miri to pass pointers through FFI)
 - rust-lang#129762 (Update the `wasm-component-ld` binary dependency)
 - rust-lang#129782 (couple more crash tests)
 - rust-lang#129816 (tidy: say which feature gate has a stability issue mismatch)
 - rust-lang#129818 (make the const-unstable-in-stable error more clear)
 - rust-lang#129824 (Fix code examples buttons not appearing on click on mobile)
 - rust-lang#129826 (library: Fix typo in `core::mem`)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit to rust-lang-ci/rust that referenced this pull request Aug 31, 2024
@bors
Auto merge of rust-lang#129831 - matthiaskrgr:rollup-befq6zx, r=matth…
a7399ba 
…iaskrgr

Rollup of 11 pull requests

Successful merges:

 - rust-lang#128523 (Add release notes for 1.81.0)
 - rust-lang#129605 (Add missing `needs-llvm-components` directives for run-make tests that need target-specific codegen)
 - rust-lang#129650 (Clean up `library/profiler_builtins/build.rs`)
 - rust-lang#129651 (skip stage 0 target check if `BOOTSTRAP_SKIP_TARGET_SANITY` is set)
 - rust-lang#129684 (Enable Miri to pass pointers through FFI)
 - rust-lang#129762 (Update the `wasm-component-ld` binary dependency)
 - rust-lang#129782 (couple more crash tests)
 - rust-lang#129816 (tidy: say which feature gate has a stability issue mismatch)
 - rust-lang#129818 (make the const-unstable-in-stable error more clear)
 - rust-lang#129824 (Fix code examples buttons not appearing on click on mobile)
 - rust-lang#129826 (library: Fix typo in `core::mem`)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit a5fb8b9 into rust-lang:master Aug 31, 2024
6 checks passed
@rustbot rustbot added this to the 1.82.0 milestone Aug 31, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Aug 31, 2024
@rust-timer
Unrolled build for rust-lang#129684
5632491 
Rollup merge of rust-lang#129684 - Strophox:miri-pass-pointer-to-ffi, r=RalfJung

Enable Miri to pass pointers through FFI

Following rust-lang#126787, the purpose of this PR is to now enable Miri to execute native calls that make use of pointers.

> <details>
>
> <summary> Simple example </summary>
>
> ```rust
> extern "C" {
>     fn ptr_printer(ptr: *mut i32);
> }
>
> fn main() {
>     let ptr = &mut 42 as *mut i32;
>     unsafe {
>         ptr_printer(ptr);
>     }
> }
> ```
> ```c
> void ptr_printer(int *ptr) {
>   printf("printing pointer dereference from C: %d\n", *ptr);
> }
> ```
> should now show `printing pointer dereference from C: 42`.
>
> </details>

Note that this PR does not yet implement any logic involved in updating Miri's "analysis" state (byte initialization, provenance) upon such a native call.

r? ``@RalfJung``
@RalfJung RalfJung mentioned this pull request Sep 13, 2024
Open
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RalfJung RalfJung RalfJung left review comments

Assignees

@RalfJung RalfJung

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.82.0
Development

Successfully merging this pull request may close these issues.
5 participants
@Strophox @rustbot @rust-log-analyzer @RalfJung @bors