Skip to content

manual: example of releasing the runtime system leaks memory#920

Merged
gasche merged 1 commit intoocaml:trunkfrom
v-gb:leak-in-c-binding-example
Nov 27, 2016
Merged

manual: example of releasing the runtime system leaks memory#920
gasche merged 1 commit intoocaml:trunkfrom
v-gb:leak-in-c-binding-example

Conversation

@v-gb
Copy link
Contributor

@v-gb v-gb commented Nov 16, 2016

While I'm making changes to this example, let's encourage people to use caml_stat_alloc, rather than stat_alloc.

/* Resolve the name */
h = gethostbyname(name);
/* Free the copy of the string, which we might as well do before
acquiring the runtime system to benefit from parallelism. */
Copy link
Member

Choose a reason for hiding this comment

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

I don't understand the comment. You say that you are "freeing now to benefit from parallelism", but isn't freeing now just the natural thing to do anyway? Is this really parallelism-related?

(As a functional programming I would be tempted to put a block scope between the release .. acquire calls and define char * name in there, but that is not idiomatic C style so let's not.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I meant "freeing before acquiring the runtime system" as opposed to freeing after acquiring the runtime system, which is probably slightly more natural to write as it's more symmetric:

alloc(); release_runtime(); blocking_stuff(); acquire_runtime(); free()
vs
alloc(); release_runtime(); blocking_stuff(); free(); acquire_runtime()

But the more symmetric version doesn't allow ocaml code to run while free() is running.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks, I was misunderstanding.

@gasche
Copy link
Member

gasche commented Nov 16, 2016

The forgotten char * name declaration means that this code never compiled. Is there a way we could structure this part of the manual to have the somewhat self-contained .c files by themselves for which we could test the build, and include them in the .etex file? (cc @Octachron the manual overlord.)

@gasche
Copy link
Member

gasche commented Nov 16, 2016

The proposed code relies on the fact that caml_stat_free does not require to own the runtime system, while caml_stat_alloc does. Is this actually a reasonable invariant to rely on?

In fact I googled around and there is a discussion of this precise question there, which seems related to the work around #71, and it seems there is a consensus that those are reasonable assumptions.

@Octachron
Copy link
Member

@gasche It would be possible use the verbatim package (supported by hevea) to include exterior files with \verbatiminput{cfilename.c} files. However it might decrease local readability of the source file. A better option may be to output the content of the verbatim environment to separate c files from the latex side.

@gasche
Copy link
Member

gasche commented Nov 16, 2016

I'm not so worried about local readability for large-ish example (I know how to open other files from my editor), but one think I would worry about is that the examples are not "actually compiling C" right now, they are full of [...] and stuff, and that turning them into possibly-compiling C files could decrease their readability.

@gasche gasche merged commit dade0b5 into ocaml:trunk Nov 27, 2016
@v-gb v-gb deleted the leak-in-c-binding-example branch December 5, 2016 02:16
camlspotter pushed a commit to camlspotter/ocaml that referenced this pull request Oct 17, 2017
manual: example of releasing the runtime system leaks memory
sadiqj pushed a commit to sadiqj/ocaml that referenced this pull request Feb 21, 2023
stedolan pushed a commit to stedolan/ocaml that referenced this pull request Mar 21, 2023
stedolan pushed a commit to stedolan/ocaml that referenced this pull request Mar 21, 2023
b11eea1 flambda-backend: Introduce Import_info (ocaml#1036)
bc5b135 flambda-backend: Fix `ocamlobjinfo` on flambda2 .cmx files (ocaml#1029)
c8babbd flambda-backend: Compilation_unit optimisations (ocaml#1035)
e8d3e22 flambda-backend: Use 4.14.0 opam switch for building (includes upgrading ocamlformat to 0.24.1) (ocaml#1030)
eb14a86 flambda-backend: Port PR81 from ocaml-jst (ocaml#1024)
131bc12 flambda-backend: Merge ocaml-jst 2022-12-13 (ocaml#1022)
06c189a flambda-backend: Make stack allocation the default (ocaml#1013)
98debd5 flambda-backend: Initial support for value slots not of value kind (ocaml#946)
deb1714 flambda-backend: Add is_last flag to closinfo words (ocaml#938)
d07fce1 flambda-backend: Disable poll insertion in Configure (ocaml#967)
0f1ce0e flambda-backend: Regenerate ocaml/configure autoconf 2.69 (instead of 2.71) (ocaml#1012)
27132d8 flambda-backend: Fix for spurious typing error related to expanding through functor arguments (ocaml#997)
724fb68 flambda-backend: Use `Compilation_unit.t` instead of `Ident.t` for globals (ocaml#871)
396d5b8 flambda-backend: Add a test for frametable setup in natdynlinked libraries (ocaml#983)
b73ab12 flambda-backend: Fix invocation of `caml_shared_startup` in native dynlink (ocaml#980)
7c7d75a flambda-backend: Fix split_default_wrapper which did not trigger anymore with flambda2 (ocaml#970)
8fb75bd flambda-backend: Port ocaml#11727 and ocaml#11732 (ocaml#965)
fdb7987 flambda-backend: Fix include functor issue after 4.14 merge. (ocaml#948)
9745cdb flambda-backend: Print -dprofile/-dtimings output to stdout like 4.12 (ocaml#943)
5f51f21 flambda-backend: Merge pull request ocaml#932 from mshinwell/4.14-upgrade
841687d flambda-backend: Run make alldepend in ocaml/ (ocaml#936)
72a7658 flambda-backend: Remove reformatting changes only in dynlink/dune (preserving PR889 and adjusting to minimise diff)
6d758cd flambda-backend: Revert whitespace changes in dune files, to match upstream
c86bf6e flambda-backend: Remove duplicate tests for polling
971dbeb flambda-backend: Testsuite fixes
32f8356 flambda-backend: Topeval fix for symbols patch
befea01 flambda-backend: Compilation fixes / rectify merge faults
a84543f flambda-backend: Merge ocaml-jst
8e65056 flambda-backend: Merge ocaml-jst
4d70045 flambda-backend: Remove filename from system frametable (amd64) (ocaml#920)
5e57b7d flambda-backend: Bugfix for runtime frame_descr logic for C frames (ocaml#918)
6423d5e flambda-backend: Merge pull request ocaml#914 from mshinwell/merge-ocaml-jst-2022-10-24
ead605c flambda-backend: Add a missing Extract_exception (ocaml#916)
c8f1481 flambda-backend: Resolve conflicts and add specialise/specialised attributes to Builtin_attributes
cf4d0d3 flambda-backend: Merge fixes (ocaml#21)
c2f742f flambda-backend: Re-enable some tests for Flambda2 (ocaml#881)
3d38d13 flambda-backend: Long frames in frametable (ocaml#797)
85aec7b flambda-backend: Add loop attribute to Builtin_attributes
c0f16e3 flambda-backend: Compilation fixes
90dea23 flambda-backend: Merge flambda-backend/main
5acc6ea flambda-backend: Fixes after merge
e501946 flambda-backend: Merge ocaml-jst
115083b flambda-backend: Merge ocaml-jst
9943b2e flambda-backend: Revert "Revert "Transform tail-recursive functions into recursive continuations (ocaml#893)"" (ocaml#909)
ce339f1 flambda-backend: Fix alloc modes and call kinds for overapplications (ocaml#902)
e6a317c flambda-backend: Revert "Transform tail-recursive functions into recursive continuations (ocaml#893)"
853c488 flambda-backend: Transform tail-recursive functions into recursive continuations (ocaml#893)
5a977e4 flambda-backend: Fix missing End_region primitives on switch arms (ocaml#898)
7fa7f9d flambda-backend: Add missing dependencies to Dune files (ocaml#889)
3cd36f0 flambda-backend: Have Lambda `Pgetglobal` and `Psetglobal` take `Compilation_unit.t` (ocaml#896)
7565915 flambda-backend: [@poll error] attribute (ocaml#745)
9eb9448 flambda-backend: Backport the main safepoints PRs (ocaml#740)
689bdda flambda-backend: Add strict mode for ocamldep (ocaml#892)

git-subtree-dir: ocaml
git-subtree-split: b11eea1
EmileTrotignon pushed a commit to EmileTrotignon/ocaml that referenced this pull request Jan 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants