Skip to content

Cause a C warning when CAMLreturn is missing in C stubs. #376

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 1 commit into from
Feb 16, 2022

Conversation

stedolan
Copy link
Contributor

@stedolan stedolan commented Nov 9, 2021

Not for the first time, a missing CAMLreturn in a C stub recently caused several people to spend a long time debugging. This patch tries to make that situation a bit easier to debug, by triggering an unused variable warning when it occurs. GCC error output looks like this (when I broke something in otherlibs/str):

In file included from strstubs.c:20:
strstubs.c: In function ‘re_replacement_text’:
../../runtime/caml/memory.h:300:7: error: unused variable ‘caml__missing_CAMLreturn’ [-Werror=unused-variable]
  300 |   int caml__missing_CAMLreturn = 0; \
      |       ^~~~~~~~~~~~~~~~~~~~~~~~
../../runtime/caml/memory.h:312:3: note: in expansion of macro ‘CAMLparam0’
  312 |   CAMLparam0 (); \
      |   ^~~~~~~~~~
strstubs.c:483:3: note: in expansion of macro ‘CAMLparam3’
  483 |   CAMLparam3(repl, groups, orig);
      |   ^~~~~~~~~~
cc1: all warnings being treated as errors

That's not great but beats debugging mysterious nontermination with gdb. (cc @mshinwell)

@mshinwell mshinwell self-requested a review November 9, 2021 17:11
@chambart
Copy link
Contributor

chambart commented Nov 9, 2021

I didn't try, but is it missing something similar in CAMLnoreturn ?

@stedolan stedolan force-pushed the warn-on-missing-camlreturn branch from ef69eeb to b9fe5cb Compare November 9, 2021 17:18
@stedolan
Copy link
Contributor Author

stedolan commented Nov 9, 2021

I didn't try, but is it missing something similar in CAMLnoreturn ?

Good point, fixed.

@mshinwell mshinwell merged commit d19e1e2 into ocaml-flambda:main Feb 16, 2022
Gbury pushed a commit to Gbury/flambda-backend that referenced this pull request Feb 17, 2022
stedolan added a commit to stedolan/flambda-backend that referenced this pull request Mar 7, 2022
64235a3 flambda-backend: Change Float.nan from sNaN to qNaN (ocaml-flambda#466)
14a8e27 flambda-backend: Track GC work for all managed bigarray allocations (upstream 11022) (ocaml-flambda#569)
c3cda96 flambda-backend: Add two new methods to targetint for dwarf (ocaml-flambda#560)
e6f1fed flambda-backend: Handle arithmetic overflow in select_addr (ocaml-flambda#570)
dab7209 flambda-backend: Add Target_system to ocaml/utils (ocaml-flambda#542)
82d5044 flambda-backend: Enhance numbers.ml with more primitive types (ocaml-flambda#544)
216be99 flambda-backend: Fix flambda_o3 and flambda_oclassic attributes (ocaml-flambda#536)
4b56e07 flambda-backend: Test naked pointer root handling (ocaml-flambda#550)
40d69ce flambda-backend: Stop local function optimisation from moving code into function bodies; opaque_identity fixes for class compilation (ocaml-flambda#537)
f08ae58 flambda-backend: Implemented inlining history and use it inside inlining reports (ocaml-flambda#365)
ac496bf flambda-backend: Disable the local keyword in typing (ocaml-flambda#540)
7d46712 flambda-backend: Bugfix for Typedtree generation of arrow types (ocaml-flambda#539)
61a7b47 flambda-backend: Insert missing page table check in roots_nat.c (ocaml-flambda#541)
323bd36 flambda-backend: Compiler error when -disable-all-extensions and -extension are used (ocaml-flambda#534)
d8956b0 flambda-backend: Persistent environment and reproducibility (ocaml-flambda#533)
4a0c89f flambda-backend: Revert "Revert bswap PRs (480 and 482)" (ocaml-flambda#506)
7803705 flambda-backend: Cause a C warning when CAMLreturn is missing in C stubs. (ocaml-flambda#376)
6199db5 flambda-backend: Improve unboxing during cmm for Flambda (ocaml-flambda#295)
96b9e1b flambda-backend: Print diagnostics at runtime for Invalid (ocaml-flambda#530)
42ab88e flambda-backend: Disable bytecode compilers in ocamltest (ocaml-flambda#504)
58c72d5 flambda-backend: Backport ocaml/ocaml#10595 from upstream/trunk (ocaml-flambda#471)
1010539 flambda-backend: Use C++ name mangling convention (ocaml-flambda#483)
81881bb flambda-backend: Local allocation test no longer relies on lifting (ocaml-flambda#525)
f5c4719 flambda-backend: Fix an assertion in Closure that breaks probes (ocaml-flambda#505)
c2cf2b2 flambda-backend: Add some missing command line arguments to ocamlnat (ocaml-flambda#499)

git-subtree-dir: ocaml
git-subtree-split: 64235a3
stedolan added a commit that referenced this pull request Mar 7, 2022
64235a3 flambda-backend: Change Float.nan from sNaN to qNaN (#466)
14a8e27 flambda-backend: Track GC work for all managed bigarray allocations (upstream 11022) (#569)
c3cda96 flambda-backend: Add two new methods to targetint for dwarf (#560)
e6f1fed flambda-backend: Handle arithmetic overflow in select_addr (#570)
dab7209 flambda-backend: Add Target_system to ocaml/utils (#542)
82d5044 flambda-backend: Enhance numbers.ml with more primitive types (#544)
216be99 flambda-backend: Fix flambda_o3 and flambda_oclassic attributes (#536)
4b56e07 flambda-backend: Test naked pointer root handling (#550)
40d69ce flambda-backend: Stop local function optimisation from moving code into function bodies; opaque_identity fixes for class compilation (#537)
f08ae58 flambda-backend: Implemented inlining history and use it inside inlining reports (#365)
ac496bf flambda-backend: Disable the local keyword in typing (#540)
7d46712 flambda-backend: Bugfix for Typedtree generation of arrow types (#539)
61a7b47 flambda-backend: Insert missing page table check in roots_nat.c (#541)
323bd36 flambda-backend: Compiler error when -disable-all-extensions and -extension are used (#534)
d8956b0 flambda-backend: Persistent environment and reproducibility (#533)
4a0c89f flambda-backend: Revert "Revert bswap PRs (480 and 482)" (#506)
7803705 flambda-backend: Cause a C warning when CAMLreturn is missing in C stubs. (#376)
6199db5 flambda-backend: Improve unboxing during cmm for Flambda (#295)
96b9e1b flambda-backend: Print diagnostics at runtime for Invalid (#530)
42ab88e flambda-backend: Disable bytecode compilers in ocamltest (#504)
58c72d5 flambda-backend: Backport ocaml/ocaml#10595 from upstream/trunk (#471)
1010539 flambda-backend: Use C++ name mangling convention (#483)
81881bb flambda-backend: Local allocation test no longer relies on lifting (#525)
f5c4719 flambda-backend: Fix an assertion in Closure that breaks probes (#505)
c2cf2b2 flambda-backend: Add some missing command line arguments to ocamlnat (#499)

git-subtree-dir: ocaml
git-subtree-split: 64235a3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants