src/doc/rustc-dev-guide/src/borrow_check/region_inference.md

   1 # Region inference (NLL)
   2
   3 <!-- toc -->
   4
   5 The MIR-based region checking code is located in [the `rustc_mir::borrow_check`
   6 module][nll].
   7
   8 [nll]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_borrowck/index.html
   9
  10 The MIR-based region analysis consists of two major functions:
  11
  12 - [`replace_regions_in_mir`], invoked first, has two jobs:
  13   - First, it finds the set of regions that appear within the
  14     signature of the function (e.g., `'a` in `fn foo<'a>(&'a u32) {
  15     ... }`). These are called the "universal" or "free" regions – in
  16     particular, they are the regions that [appear free][fvb] in the
  17     function body.
  18   - Second, it replaces all the regions from the function body with
  19     fresh inference variables. This is because (presently) those
  20     regions are the results of lexical region inference and hence are
  21     not of much interest. The intention is that – eventually – they
  22     will be "erased regions" (i.e., no information at all), since we
  23     won't be doing lexical region inference at all.
  24 - [`compute_regions`], invoked second: this is given as argument the
  25   results of move analysis. It has the job of computing values for all
  26   the inference variables that `replace_regions_in_mir` introduced.
  27   - To do that, it first runs the [MIR type checker]. This is
  28     basically a normal type-checker but specialized to MIR, which is
  29     much simpler than full Rust, of course. Running the MIR type
  30     checker will however create various [constraints][cp] between region
  31     variables, indicating their potential values and relationships to
  32     one another.
  33   - After this, we perform [constraint propagation][cp] by creating a
  34     [`RegionInferenceContext`] and invoking its [`solve`]
  35     method.
  36   - The [NLL RFC] also includes fairly thorough (and hopefully readable)
  37     coverage.
  38
  39 [cp]: ./region_inference/constraint_propagation.md
  40 [fvb]: ../appendix/background.md#free-vs-bound
  41 [`replace_regions_in_mir`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_borrowck/nll/fn.replace_regions_in_mir.html
  42 [`compute_regions`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_borrowck/nll/fn.compute_regions.html
  43 [`RegionInferenceContext`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_borrowck/region_infer/struct.RegionInferenceContext.html
  44 [`solve`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_borrowck/region_infer/struct.RegionInferenceContext.html#method.solve
  45 [NLL RFC]: https://rust-lang.github.io/rfcs/2094-nll.html
  46 [MIR type checker]: ./type_check.md
  47
  48 ## Universal regions
  49
  50 The [`UniversalRegions`] type represents a collection of _universal_ regions
  51 corresponding to some MIR `DefId`. It is constructed in
  52 [`replace_regions_in_mir`] when we replace all regions with fresh inference
  53 variables. [`UniversalRegions`] contains indices for all the free regions in
  54 the given MIR along with any relationships that are _known_ to hold between
  55 them (e.g. implied bounds, where clauses, etc.).
  56
  57 For example, given the MIR for the following function:
  58
  59 ```rust
  60 fn foo<'a>(x: &'a u32) {
  61     // ...
  62 }
  63 ```
  64
  65 we would create a universal region for `'a` and one for `'static`. There may
  66 also be some complications for handling closures, but we will ignore those for
  67 the moment.
  68
  69 TODO: write about _how_ these regions are computed.
  70
  71 [`UniversalRegions`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_borrowck/universal_regions/struct.UniversalRegions.html
  72
  73 <a name="region-variables"></a>
  74
  75 ## Region variables
  76
  77 The value of a region can be thought of as a **set**. This set contains all
  78 points in the MIR where the region is valid along with any regions that are
  79 outlived by this region (e.g. if `'a: 'b`, then `end('b)` is in the set for
  80 `'a`); we call the domain of this set a `RegionElement`. In the code, the value
  81 for all regions is maintained in [the `rustc_borrowck::region_infer` module][ri].
  82 For each region we maintain a set storing what elements are present in its value (to make this
  83 efficient, we give each kind of element an index, the `RegionElementIndex`, and
  84 use sparse bitsets).
  85
  86 [ri]: https://github.com/rust-lang/rust/tree/master/compiler/rustc_borrowck/src/region_infer
  87
  88 The kinds of region elements are as follows:
  89
  90 - Each **[`location`]** in the MIR control-flow graph: a location is just
  91   the pair of a basic block and an index. This identifies the point
  92   **on entry** to the statement with that index (or the terminator, if
  93   the index is equal to `statements.len()`).
  94 - There is an element `end('a)` for each universal region `'a`,
  95   corresponding to some portion of the caller's (or caller's caller,
  96   etc) control-flow graph.
  97 - Similarly, there is an element denoted `end('static)` corresponding
  98   to the remainder of program execution after this function returns.
  99 - There is an element `!1` for each placeholder region `!1`. This
 100   corresponds (intuitively) to some unknown set of other elements –
 101   for details on placeholders, see the section
 102   [placeholders and universes](region_inference/placeholders_and_universes.md).
 103
 104 ## Constraints
 105
 106 Before we can infer the value of regions, we need to collect
 107 constraints on the regions. The full set of constraints is described
 108 in [the section on constraint propagation][cp], but the two most
 109 common sorts of constraints are:
 110
 111 1. Outlives constraints. These are constraints that one region outlives another
 112    (e.g. `'a: 'b`). Outlives constraints are generated by the [MIR type
 113    checker].
 114 2. Liveness constraints. Each region needs to be live at points where it can be
 115    used. These constraints are collected by [`generate_constraints`].
 116
 117 [`generate_constraints`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_borrowck/constraint_generation/fn.generate_constraints.html
 118
 119 ## Inference Overview
 120
 121 So how do we compute the contents of a region? This process is called _region
 122 inference_. The high-level idea is pretty simple, but there are some details we
 123 need to take care of.
 124
 125 Here is the high-level idea: we start off each region with the MIR locations we
 126 know must be in it from the liveness constraints. From there, we use all of the
 127 outlives constraints computed from the type checker to _propagate_ the
 128 constraints: for each region `'a`, if `'a: 'b`, then we add all elements of
 129 `'b` to `'a`, including `end('b)`. This all happens in
 130 [`propagate_constraints`].
 131
 132 Then, we will check for errors. We first check that type tests are satisfied by
 133 calling [`check_type_tests`]. This checks constraints like `T: 'a`. Second, we
 134 check that universal regions are not "too big". This is done by calling
 135 [`check_universal_regions`]. This checks that for each region `'a` if `'a`
 136 contains the element `end('b)`, then we must already know that `'a: 'b` holds
 137 (e.g. from a where clause). If we don't already know this, that is an error...
 138 well, almost. There is some special handling for closures that we will discuss
 139 later.
 140
 141 ### Example
 142
 143 Consider the following example:
 144
 145 ```rust,ignore
 146 fn foo<'a, 'b>(x: &'a usize) -> &'b usize {
 147     x
 148 }
 149 ```
 150
 151 Clearly, this should not compile because we don't know if `'a` outlives `'b`
 152 (if it doesn't then the return value could be a dangling reference).
 153
 154 Let's back up a bit. We need to introduce some free inference variables (as is
 155 done in [`replace_regions_in_mir`]). This example doesn't use the exact regions
 156 produced, but it (hopefully) is enough to get the idea across.
 157
 158 ```rust,ignore
 159 fn foo<'a, 'b>(x: &'a /* '#1 */ usize) -> &'b /* '#3 */ usize {
 160     x // '#2, location L1
 161 }
 162 ```
 163
 164 Some notation: `'#1`, `'#3`, and `'#2` represent the universal regions for the
 165 argument, return value, and the expression `x`, respectively. Additionally, I
 166 will call the location of the expression `x` `L1`.
 167
 168 So now we can use the liveness constraints to get the following starting points:
 169
 170 Region  | Contents
 171 --------|----------
 172 '#1     |
 173 '#2     | `L1`
 174 '#3     | `L1`
 175
 176 Now we use the outlives constraints to expand each region. Specifically, we
 177 know that `'#2: '#3` ...
 178
 179 Region  | Contents
 180 --------|----------
 181 '#1     | `L1`
 182 '#2     | `L1, end('#3) // add contents of '#3 and end('#3)`
 183 '#3     | `L1`
 184
 185 ... and `'#1: '#2`, so ...
 186
 187 Region  | Contents
 188 --------|----------
 189 '#1     | `L1, end('#2), end('#3) // add contents of '#2 and end('#2)`
 190 '#2     | `L1, end('#3)`
 191 '#3     | `L1`
 192
 193 Now, we need to check that no regions were too big (we don't have any type
 194 tests to check in this case). Notice that `'#1` now contains `end('#3)`, but
 195 we have no `where` clause or implied bound to say that `'a: 'b`... that's an
 196 error!
 197
 198 ### Some details
 199
 200 The [`RegionInferenceContext`] type contains all of the information needed to
 201 do inference, including the universal regions from [`replace_regions_in_mir`] and
 202 the constraints computed for each region. It is constructed just after we
 203 compute the liveness constraints.
 204
 205 Here are some of the fields of the struct:
 206
 207 - [`constraints`]: contains all the outlives constraints.
 208 - [`liveness_constraints`]: contains all the liveness constraints.
 209 - [`universal_regions`]: contains the `UniversalRegions` returned by
 210   [`replace_regions_in_mir`].
 211 - [`universal_region_relations`]: contains relations known to be true about
 212   universal regions. For example, if we have a where clause that `'a: 'b`, that
 213   relation is assumed to be true while borrow checking the implementation (it
 214   is checked at the caller), so `universal_region_relations` would contain `'a:
 215   'b`.
 216 - [`type_tests`]: contains some constraints on types that we must check after
 217   inference (e.g. `T: 'a`).
 218 - [`closure_bounds_mapping`]: used for propagating region constraints from
 219   closures back out to the creator of the closure.
 220
 221 [`constraints`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_borrowck/region_infer/struct.RegionInferenceContext.html#structfield.constraints
 222 [`liveness_constraints`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_borrowck/region_infer/struct.RegionInferenceContext.html#structfield.liveness_constraints
 223 [`location`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/mir/struct.Location.html
 224 [`universal_regions`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_borrowck/region_infer/struct.RegionInferenceContext.html#structfield.universal_regions
 225 [`universal_region_relations`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_borrowck/region_infer/struct.RegionInferenceContext.html#structfield.universal_region_relations
 226 [`type_tests`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_borrowck/region_infer/struct.RegionInferenceContext.html#structfield.type_tests
 227 [`closure_bounds_mapping`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_borrowck/region_infer/struct.RegionInferenceContext.html#structfield.closure_bounds_mapping
 228
 229 TODO: should we discuss any of the others fields? What about the SCCs?
 230
 231 Ok, now that we have constructed a `RegionInferenceContext`, we can do
 232 inference. This is done by calling the [`solve`] method on the context. This
 233 is where we call [`propagate_constraints`] and then check the resulting type
 234 tests and universal regions, as discussed above.
 235
 236 [`propagate_constraints`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_borrowck/region_infer/struct.RegionInferenceContext.html#method.propagate_constraints
 237 [`check_type_tests`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_borrowck/region_infer/struct.RegionInferenceContext.html#method.check_type_tests
 238 [`check_universal_regions`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_borrowck/region_infer/struct.RegionInferenceContext.html#method.check_universal_regions