Skip to content

Fix UB in analysis/test #683

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

Merged
merged 8 commits into from
Sep 28, 2022
Merged

Fix UB in analysis/test #683

merged 8 commits into from
Sep 28, 2022

Conversation

kkysen
Copy link
Contributor

@kkysen kkysen commented Sep 25, 2022

Fixes #680.

See the commits for the individual fixes. The fixes are:

Now cd analysis/test && cargo miri run reports no UB. However, miri can't run variadic functions like printf, so running this requires the monomorphic printf shim in #686.

@kkysen kkysen requested a review from aneksteind September 25, 2022 03:36
@aneksteind
Copy link
Contributor

Can you remind me whether or not this UB is the fault of the transpiler? This is where much of the code in the test file has come from. It would be great to treat the issue at the source, if so.

@kkysen
Copy link
Contributor Author

kkysen commented Sep 27, 2022

Can you remind me whether or not this UB is the fault of the transpiler? This is where much of the code in the test file has come from. It would be great to treat the issue at the source, if so.

I have no idea at this point. The file has diverged quite a bit from the initial transpiled code. That said, if the C has UB, I think the transpiled Rust would have UB, too.

@kkysen
Copy link
Contributor Author

kkysen commented Sep 27, 2022

Yeah, none of the UB fixes here are in functions that are in pointers.c. it's pretty out-of-date.

@aneksteind
Copy link
Contributor

Ok, that sounds fine then

@kkysen
Copy link
Contributor Author

kkysen commented Sep 27, 2022

There was one transpiled leak in main for arg conversion, but I already opened an issue for that in #649. It was fixed here manually in #653.

@kkysen kkysen force-pushed the kkysen/analysis-test-fix-ub branch from f21764b to d6eb540 Compare September 28, 2022 04:21
@kkysen kkysen merged commit 4d7808e into master Sep 28, 2022
@kkysen kkysen deleted the kkysen/analysis-test-fix-ub branch September 28, 2022 05:41
@kkysen kkysen mentioned this pull request Oct 10, 2022
kkysen added a commit that referenced this pull request Oct 10, 2022
Fixes #685.

This makes `analysis/test` `miri`-compatible when running with `--features miri`.  This is done by using a monomorphic `printf` shim, since `miri` can't handle variadic functions like `printf`.  Since all uses of `printf` in `analysis/test` are monomorphic (they all have the same format string), we can substitute a `fn printf` that is non-`extern "C"`, non-variadic (and thus `miri`-compatible), and that still has the same behavior for its call sites.

Then we add a test in `c2rust-pdg` that runs `miri` on `analysis/test` to ensure it stays UB-free.

However, we don't yet run this test by default (it's `#[ignore]`d for now) as there are issues with running `miri` in CI (it installs `xargo` every time and I'm getting a permission denied error (not sure from quite what exactly), and it'd be better to install `xargo` upfront, not on every run).  Thus, I'm `#[ignore]`ing it for now in 4152d34.  We can get it to run in CI correctly later in another PR, but I want to merge this now and avoid over-complicating it here.  The test can still be manually run with `cargo test -p c2rust-pdg -- --ignored analysis_test_miri`.  See #698 for the tracking issue to re-enable this test by default.

The new test passing is blocked on:
* #683 (f ixes #680)
* #684 (f ixes #681)

It would also be nice to f ix #682, but that's not completely necessary for this (though it would create a much less noisy output).
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.

Fix UB in analysis/test
2 participants