Skip to content

Backend support for local allocations #478

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 6 commits into from
Jan 26, 2022

Conversation

stedolan
Copy link
Contributor

This PR adds support for local (stack) allocations to the backend, extracted from the branch at https://github.com/ocaml-flambda/ocaml-jst/tree/local-dev. To avoid creating at truly massive PR, this patch contains only the backend changes. (This also means that this PR contains no tests for local allocations. There is an extensive testsuite in the ocaml-jst repo, but the tests require front and middle-end support in order to run).

The original PR series for local allocations is at https://github.com/janestreet/ocaml/pulls?q=is%3Apr.

Concretely, the main changes here are:

  • Annotate allocations with a Lambda.alloc_mode. Alloc_heap allocations are normal GC allocations, while the new Alloc_local allocations allocate instead on a separate stack.

  • At Mach and beyond, add two new primitives Ibeginregion and Iendregion that delimit regions (roughly, stackframes). All local allocations during a region are freed at the end of the region, by resetting the local stack pointer. Ibeginregion returns the current value of this pointer, while Iendregion resets it.

    (Currently, Iendregion does some additional tracking of stats, for development and testing. This will be removed before release)

  • At Cmm level, instead of explicit begin/end primitives we use a block-structured Cregion e. The job of placing Ibeginregion / Iendregion falls to Selectgen.

There is special handling of tail calls: since tail recursive loops must run in constant space, tail calls in tail position of a region end the region before transferring control. This is denoted by an apply_position in Cmm: when it is Apply_tail, the Iendregion will be inserted before the call by Selectgen. Furthermore, there is a new Ctail construct in Cmm to handle the case where an Apply_tail call is inlined, which ends the region before the inlined body is evaluated.

Finally, there is some refactoring of the generation of curry / apply stubs: instead of encoding tupled vs. curried in the sign of the arity, the stub is selected as a pair of a Lambda function kind and an integer. (This refactoring is there mainly to support the middle-end's need for both local and heap versions of the curry stubs)

@stedolan stedolan marked this pull request as draft January 24, 2022 11:23
@stedolan stedolan marked this pull request as ready for review January 24, 2022 13:29
Adds local allocations (Ialloc Alloc_local) to the backend, as well
as new primitives for region boundaries (Ibeginregion/Iendregion).

In Cmm, instead of explicit Ibeginregion/Iendregion, there is a new
block-structured Cregion.

Since tail calls are supposed to end a region before transferring
control, Cmm also has two new constructs that end a region early:
Capply with Apply_tail, and Ctail (for general code blocks, resulting
from tail calls that have been inlined).
@xclerc
Copy link
Contributor

xclerc commented Jan 25, 2022

(Cannot add a comment on the code outside of the diff.)
In "backend/arm64/proc.ml", shouldn't the op_is_pure
function have the following case:

| Ibeginregion | Iendregion -> false

@xclerc
Copy link
Contributor

xclerc commented Jan 25, 2022

I think the current transformations over CFG values are
not affected by these changes (and the CI is green), but
region begins/ends likely impose some restrictions on
what can safely be changed about a CFG value.

@gretay-js This is probably worth adding to your document
about CFG invariants.

(The fact that the CI is green is moot, since the new
features are not currently being tested in this repository.)

@stedolan
Copy link
Contributor Author

I think the current transformations over CFG values are
not affected by these changes (and the CI is green), but
region begins/ends likely impose some restrictions on
what can safely be changed about a CFG value.

My hope was that marking local allocations as coeffectful and Ibeginregion / Iendregion as effectful would be enough to ensure the right semantics - it is invalid to move a load across a possibly-aliasing store anyway.

@xclerc
Copy link
Contributor

xclerc commented Jan 25, 2022

I think the current transformations over CFG values are
not affected by these changes (and the CI is green), but
region begins/ends likely impose some restrictions on
what can safely be changed about a CFG value.

My hope was that marking local allocations as coeffectful and Ibeginregion / Iendregion as effectful would be enough to ensure the right semantics - it is invalid to move a load across a possibly-aliasing store anyway.

I think I am mostly worried about ensuring that no
transformations break the bracketing of begin/end
pairs, but that might be unfounded.

@mshinwell
Copy link
Collaborator

The following is needed in Printmach:

!|  | Ialloc { bytes = n; mode = Alloc_heap } ->
 |    fprintf ppf "alloc %i" n;
+|  | Ialloc { bytes = n; mode = Alloc_local } ->
+|    fprintf ppf "alloc_local %i" n;

@xclerc
Copy link
Contributor

xclerc commented Jan 26, 2022

For grepping purposes, I think the existing line is:

| Ialloc { bytes = n; } ->

@stedolan
Copy link
Contributor Author

Thanks, patch applied.

@stedolan stedolan merged commit c2c83ec into ocaml-flambda:main Jan 26, 2022
stedolan added a commit to ocaml-flambda/ocaml-jst that referenced this pull request Jan 31, 2022
mshinwell pushed a commit that referenced this pull request Feb 1, 2022
Adds local allocations (Ialloc Alloc_local) to the backend, as well
as new primitives for region boundaries (Ibeginregion/Iendregion).

In Cmm, instead of explicit Ibeginregion/Iendregion, there is a new
block-structured Cregion.

Since tail calls are supposed to end a region before transferring
control, Cmm also has two new constructs that end a region early:
Capply with Apply_tail, and Ctail (for general code blocks, resulting
from tail calls that have been inlined).
stedolan added a commit that referenced this pull request Feb 1, 2022
86526aa flambda-backend: Middle-end support for local allocs (#491)
969b937 flambda-backend: Backend support for local allocations (#478)
2d1e6ef flambda-backend: Remove leading space from LINE. (#484)

git-subtree-dir: ocaml
git-subtree-split: 86526aa
stedolan added a commit that referenced this pull request Feb 1, 2022
173842c Merge flambda-backend changes
ed7eba2 Remove leading space from LINE. (#484)
bd61170 Bump magic numbers (#5)
c50c47d Add CI builds with local allocations enabled
1412792 Move local allocations support behind '-extension local'
6d8e42a Better tail call behaviour in caml_applyN
c7dac3d Typemod: toplevel bindings escape even if no variables are bound
82d6c3e Several fixes for partial application and currying
d05c70c Pprintast support for new local syntax
e0e62fc Typecheck x |> f y as (f y x), not ((f y) x)
d7e34ce Remove autogeneration of @ocaml.curry
b9a0593 Port #493
0a872d9 Code review fixes from #491
6c168bb Remove local allocation counting
3c6e7f0 Code review fixes from #478
bb97207 Rename Lambda.apply_position
a7cb650 Quieten Makefile when runtime dep files are not present
c656dc9 Merge flambda-backend changes
11b5424 Avoid printing double spaces in function argument lists
7751faa Restore locations to Typedtree.{pat,let}_bound_idents_full
e450b6c add build_ocaml_compiler.sexp
0403bb3 Revert PR 9895 to continue installing VERSION
b3447db Ensure new local attributes are namespaced properly
7f213fc Allow empty functions again
8f22ad8 Bugfix: ensure local domain state is initialised
80f54dd Bugfix for Selectgen with regions
e8133a1 Fix external-external signature inclusion
9840051 Bootstrap
d879f23 Merge remote-tracking branch 'jane/local-reviewed' into local-merge
94454f5 Use Local_store for the local allocations ref
54a164c Create fewer regions, according to typechecking (#59)
1c2479b Merge flambda-backend changes
ce34678 Fix printing of modes in return types
91f2281 Hook mode variable solving into Btype.snapshot/backtrack
54e4b09 Move Alloc_mode and Value_mode to Btype
ff4611e Merge flambda-backend changes
ce62e45 Ensure allocations are initialised, even dead ones
6b6ec5a Fix the alloc.ml test on 32-bit builds
81e9879 Merge flambda-backend changes
40a7f89 Update repo URL for ocaml-jst, and rename script.
0454ee7 Add some new locally-allocating primitives (#57)
8acdda1 Reset the local stack pointer in exception handlers (#56)
8dafa98 Improve typing for (||) and (&&) (#55)
8c64754 Fix make_check_all_arches (#54)
b50cd45 Allow arguments to primitives to be local even in tail position (#53)
cad125d Fix modes from or-patterns (#50)
4efdb72 Fix tailcalls tests with inlining (#52)
4a795cb Flambda support (#49)
74722cb Add [@ocaml.principal] and [@ocaml.noprincipal] attributes, and use in oo.mli
6d7d3b8 Ensure that functions are evaluated after their arguments (flambda-backend #353)
89bda6b Keep Sys.opaque_identity in Cmm and Mach (port upstream PR 9412)
a39126a Fix tailcalls within regions (#48)
4ac4cfd Fix stdlib manpages build
3a95f5e Merge flambda-backend changes
efe80c9 Add jane/pull-flambda-patches script
fca94c4 Register allocations for Omitted parameter closures (#47)
103b139 Remove various FIXMEs (#46)
62ba2c1 Bootstrap
a0062ad Allow local allocations for various primitives (#43)
7a2165e Allow primitives to be poly-moded (#43)
2af3f55 Fix a flaky test by refactoring TypePairs (ocaml/ocaml#10638)
58dd807 Bootstrap
ee3be10 Fix modes in build_apply for partial applications
fe73656 Tweak for evaluation order of labelled partial applications (#10653)
0527570 Fix caml_modify on local allocations (#40)
e657e99 Relax modes for `as` patterns (#42)
f815bf2 Add special mode handling for tuples in matches and let bindings (#38)
39f1211 Only take the upper bounds of modes associated with allocations (#37)
aec6fde Interpret arrow types in "local positions" differently
c4f3319 Bootstrap
ff6fdad Add some missing regions
40d586d Bootstrap
66d8110 Switch to a system with 3 modes for values
f2c5a85 Bugfix for Comballoc with local allocations. (#41)
83bcd09 Fix bug with root scanning during compaction (#39)
1b5ec83 Track modes in Lambda.lfunction and onwards (#33)
f1e2e97 Port ocaml/ocaml#10728
56703cd Port ocaml/ocaml#10081
eb66785 Support local allocations in i386 and fix amd64 bug (#31)
c936b19 Disallow local recursive non-functions (#30)
c7a193a GC support for local allocations (#29)
8dd7270 Nonlocal fields (#28)
e19a2f0 Bootstrap
694b9ac Add syntax to the parser for local allocations (#26)
f183008 Lower initial stack size
918226f Allow local closure allocations (#27)
2552e7d Introduce mode variables (#25)
bc41c99 Minor fixes for local allocations (#24)
a2a4e60 Runtime and compiler support for more local allocations (#23)
d030554 Typechecking for local allocations (#21)
9ee2332 Bugfix missing from #20
02c4cef Retain block-structured local regions until Mach.
86dbe1c amd64: Move stack realloc calls out-of-line
324d218 More typing modes and locking of environments
a4080b8 Initial version of local allocation (unsafe)

git-subtree-dir: ocaml
git-subtree-split: 173842c
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.

7 participants