# Module `Incremental__.Incremental_intf`

## Incremental in a nutshell

Incremental is used to define a collection of interdependent values, some of which are "variables" set by user code and others that are defined via functions (in the mathematical and programming senses) of other incremental values. Incremental automatically tracks all the dependencies between incremental values and can, on demand, propagate changed variables and recompute the incremental values that depend on them.

To use incremental, one first creates a new instance via:

`module Inc : Incremental.S = Incremental.Make ()`

The functor application creates data structures that will be shared throughout the lifetime of all incremental values used with this instance. Since `Incremental.Make`

is a generative functor, the type system enforces that different applications of the functor deal with disjoint sets of incrementals.

For the remainder of this comment, we assume a particular `Inc`

is `open`

:

`open Inc`

As an example of a simple computation, suppose we have integer variables `x`

and `y`

and want to keep an incremental value `z`

defined by `z = x + y`

. We could do this with:

```
let x = Var.create 13
let y = Var.create 17
let z = map2 (Var.watch x) (Var.watch y) ~f:(fun x y -> x + y)
```

With this, as `x`

and `y`

change, incremental can recompute `z = x + y`

on demand. Incremental only recomputes values that are being "observed", which one indicates by calling the `observe`

function to get an "observer", e.g.:

`let z_o = observe z`

Incremental doesn't compute `z`

every time `x`

and `y`

change. Rather, one must explicitly tell incremental when one wants `z`

(and all other observed values) to be brought up to date, by calling `stabilize`

:

`stabilize ();`

At this point, the value of `z`

is `30`

, which we can verify by:

`assert (Observer.value_exn z_o = 30);`

If we change the value of `x`

and then tell incremental to recompute observed values, then the value of `z`

will change appropriately:

```
Var.set x 19;
stabilize ();
assert (Observer.value_exn z_o = 36);
```

Another way to observe values is to use `Observer.on_update_exn`

, which attaches an "on-update handler" to an observer -- the handler will be run after each stabilization in which the observer's value changed (or was initialized) during stabilization.

User functions given to incremental should never raise any exceptions: doing so will cause all future calls to `stabilize`

to raise.

## The incremental DAG

One can think of incrementals as forming a directed acyclic graph (DAG), where nodes correspond to incremental values and there is an edge from node `n1`

to node `n2`

if the value of `n2`

depends on the value of `n1`

. For example, the DAG for the above example has an edge from `x`

to `z`

and from `y`

to `z`

. The graph must be acyclic in order for the computation to be well defined. The graph is a DAG rather than a tree because incremental values can be shared. Extending the above example, we might have:

`let w = map2 (Var.watch y) z ~f:(fun y z -> y - z)`

Both the node for `y`

and the node for `z`

are shared.

We will use "node" to mean "incremental value" when we want to emphasize some aspect of the DAG.

Say that a node is "observed" if there is an observer for it (created via `observe`

). Say that a node is "necessary" if there is a path from that node to an observed node. `stabilize`

ensures that all necessary nodes have correct values; it will not compute unnecessary nodes. An unobserved node becomes necessary by a call to `observe`

or by being used to compute an observed node; this will cause the appropriate DAG edges to be added. A necessary node will become unnecessary if its observer (if any) becomes unused and if the node is no longer used to compute any observed nodes. This will cause the appropriate DAG edges to be removed.

Incremental does not know whether user-supplied functions (e.g. functions supplied to `bind`

or `map`

) are side effecting, and will not evaluate them for side effect. If the resulting incrementals are not necessary then the function will not be called.

## Stabilization

`stabilize`

traverses the DAG in topological order starting at variables that changed since the last stabilization and recomputing their dependents. This is done by using a "recompute heap" to visit the nodes in non-decreasing order of "height", which is a over-approximation of the longest path from a variable to that node. To ensure that each node is computed at most once and that its children are stabilized before it is computed, nodes satisfy the property that if there is an edge from n1 to n2, then the height of n1 is less than the height of n2.

`stabilize`

repeats the following steps until the heap becomes empty:

1. remove from the recompute heap a node with the smallest height 2. recompute that node 3. if the node's value changes, then add its parents to the heap.

The definition of "changes" in step (3) is configurable by user code. By default, a node is considered to change if its new value is not `phys_equal`

to the previous value. One can use `set_cutoff`

on a node to change its cutoff function, e.g. for `floats`

one could cutoff propagation if the old value and new value are closer than some threshold.

If `stabilize`

ever raises due to an error, then the incremental system becomes unusable, and all future calls to `stabilize`

will immediately raise.

Stabilization uses a heap implemented with an array whose length is the max height, so for good performance, the height of nodes must be small. There is an upper bound on the height of nodes, `max_height_allowed`

, which defaults to 128. An attempt to create a node with larger height will raise. One can dynamically increase `max_height_allowed`

; however, one should be wary of doing so, for performance reasons.

## Bind

Much of the power of incremental comes from `bind`

, also written `>>=`

. As a reminder, `bind`

has this type:

`val bind : 'a t -> f:('a -> 'b t) -> 'b t`

`bind ta ~f`

returns an incremental `tb`

that behaves like `f a`

, where `a`

is the most recent value of `ta`

. The implementation only calls `f`

when the value of `ta`

changes. Thinking in terms of the DAG, `bind ta ~f`

returns a node `tb`

such that whenever the value of `ta`

changes, the implementation calls `f`

to obtain a node (possibly with an arbitrary DAG below it) that defines the value of `tb`

.

`bind`

can be used to transition existing parts of the graph between necessary and unnecessary. E.g.:

```
val if_ : bool t -> a t -> a t -> a t
let if_ a b c = bind a ~f:(fun a -> if a then b else c)
```

With `let t = if_ a b c`

, when `a`

is `true`

, if `t`

is necessary, then `b`

will be necessary, but `c`

will not. And vice-versa when `a`

is `false`

.

Even more, `bind`

allows one to dynamically create an arbitrary graph based on the value of some other incremental, and to "hide" that dynamism behind an ordinary incremental value. One common way to use this is for dynamic reconfiguration, e.g.:

```
let config_var = Var.create config in
bind (Var.watch config_var) ~f:(fun config -> ... )
```

Then, whenever one wants to reconfigure the system, one does `Var.set config_var`

and then `stabilize`

, which will construct a new DAG according to the new config.

Bind nodes introduce special height constraints, so that stabilization is guaranteed to recompute the left-hand side of a bind before recomputing any node created by the right-hand side `f`

. This avoids recomputing nodes created on the right-hand side that would then become unnecessary when the left-hand side changes. More precisely, in `t >>= f`

, any node created by `f`

is made to have a height larger than `t`

. This rule applies also to bind nodes created by `f`

, so that ultimately the height of every node is greater than the height of all the left-hand sides of the binds that were involved in its creation. The height requirement does not apply to nodes returned by `f`

but not created by `f`

-- such nodes depend on the bind in effect when they were created, but have no dependence on `t`

.

When the left-hand side of a bind node changes, stabilization "invalidates" all the nodes that depend on it (because they may use an old value of the left-hand side).

For example, consider:

```
let t1 = map ... in
bind t2 ~f:(fun _ ->
let t3 = map ... in
map2 t1 t3 ~f:(...))
```

In this example, `t1`

is created outside of `bind t2`

, whereas `t3`

is created by the right-hand side of `bind t2`

. So, `t3`

depends on `t2`

(and has a greater height), whereas `t1`

does not. And, in a stabilization in which `t2`

changes, we are guaranteed to not recompute the old `t3`

, but we have no such guarantee about `t1`

. Furthermore, when `t2`

changes, the old `t3`

will be invalidated, whereas `t1`

will not.

Since `bind`

essentially allows one to add arbitrary edges to the DAG, one can use it to construct a cycle. `stabilize`

will detect such cycles and raise.

## Garbage collection

Incremental maintains three kinds of pointers:

- from nodes to their children (nodes they depend on).
- from necessary nodes to their necessary parents (nodes that depend on them).
- from observers to the nodes they observe.

So, all necessary nodes are kept alive, from the perspective of the garbage collector.

If an observer has no on-update handlers and user code no longer holds on to it, incremental (via a finalizer on the observer), detects this and disallows future use of the observer, making the node it observed unnecessary if it is not necessary for another reason. One can eagerly remove an observer by calling `disallow_future_use`

. Because finalizers may be called much later than when an observer actually becomes unreachable, it is preferable to disable observers using `disallow_future_use`

to avoid useless propagation during stabilizations.

If an observer has on-update handlers, calling `disallow_future_use`

is the only way to have it removed.

## The implementation

The key type in the implementation is `Node.t`

, which represents one node in the incremental DAG. The node type is in fact the same as `Incremental.t`

, although this type equivalence is not exposed. A node is a record with many fields (> 20). In particular a node holds:

- kind -- the kind of node it is (const, var, map, bind, snapshot, etc.).
- value -- the node's current value.
- recompute id -- the stabilization number at which it was last recomputed.
- change id -- the stabilization number at which its value last changed.
- height -- the height of the node in the DAG.
- parents -- the necessary nodes that depend on it.
- children -- the nodes that it depends on.
- created_in -- the scope in which it was created.

Say that a node is "stale" if it has never been computed or if its recompute id is less than the change id of one of its children. A node should be recomputed if it is both necessary and stale.

The `State.t`

type holds all the mutable data used to implement stabilization. In particular, the incremental state contains:

- the current stabilization number
- the set of observers
- a recompute heap -- nodes that need to be recomputed, ordered by height.
- an adjust-heights heap -- nodes whose height needs increasing, ordered by height.

The goals of stabilization are to:

- compute all necessary nodes that need to be recomputed.
- only compute necessary nodes.
- compute each node at most once.
- only compute a node after ensuring its children are up to date.

To do this, incremental maintains the following invariants:

`p`

is in`c`

's parents iff (`c`

is in`p`

's children &&`p`

is necessary)`p`

is in the recompute heap iff`p`

is necessary and stale.- if
`p`

is a parent of`c`

, then`p`

's height is greater than`c`

's height.

The first invariant ensures that when a node's value changes, we can reach from it all necessary nodes (and only the necessary nodes) that depend on it. The second invariant ensures that that stabilization only computes necessary nodes. The third invariant, combined with the fact that stabilization always recomputes a node from the recompute-heap that has minimum height, ensures that we only compute a node after all its children are stable, and that we compute each node at most once.

Finally, at the end of stabilization, the recompute heap is empty, so the invariant implies that there are no necessary nodes that are stale, i.e. stabilization has computed all necessary nodes that need to be recomputed.

## Maintaining the parent invariant

Maintaining the invariant that a node has edges only to necessary parents requires traversing a node's descendants when it transitions between necessary and unnecessary, in order to add or remove parents as appropriate. For example, when an observer is first added to an unnecessary node, the implementation visits all its descendants to add parents. This is essentially a form of ref-counting, in which the counter is the number of parents that a node has. There is no problem with cycles because the DAG requirement on the graph is enforced.

## Maintaining the height invariant and checking for cycles

Maintaining the invariant that a necessary node's height is larger than all of its children requires adjusting heights when an edge is added to the DAG (e.g. when a bind left-hand side changes). This is done using the "adjust-heights" heap. When an edge is added, if the child's height is greater than or equal to the parent's height, then the adjust-heights heap increases the height of the parent and all of the parent's ancestors as necessary in order to restore the height invariant. This is done by visiting ancestors in topological order, in increasing order of pre-adjusted height. If during that traversal, the child of the original edge is visited, then there is a cycle in the graph, and stabilization raises.

In pathological situations, the implementation will raise due to a cyclic graph even though subsequent graph operations would eliminate the cycle. This is because the cyclicity check happens after each edge is added, rather than waiting until a batch of graph changes.

## Bind, scopes, and invalidation

Much of the complexity of the implementation comes from `bind`

. In `t >>= f`

, when `f`

is applied to the value of `t`

, all of the nodes that are created depend on that value. If the value of `t`

changes, then those nodes no longer make sense because they depend on a stale value. It would be both wasteful and wrong to recompute any of those "invalid" nodes. So, the implementation maintains the invariant that the height of a necessary node is greater than the height of the left-hand side of the nearest enclosing bind. That guarantees that stabilization will stabilize the left-hand side before recomputing any nodes created on the right-hand side. Furthermore, if the left-hand side's value changes, stabilization marks all the nodes on the right-hand side as invalid. Such invalid nodes will typically be unnecessary, but there are pathological cases where they remain necessary.

The bind height invariant is accomplished using a special "bind-lhs-change" node, which is a parent of the bind-lhs and a child of the bind result. The incremental state maintains the "current scope", which is the bind whose right-hand side is currently being evaluated, or a special "top" scope if there is no bind in effect. Each node has a `created_in`

field set to the scope in effect when the node is created. The implementation keeps for each scope, a singly-linked list of all nodes created in that scope. Invalidation traverses this list, and recurs on bind nodes in it to traverse their scopes as well.

`if_`

and `join`

are special cases of `bind`

that manipulate the graph; however they do not create new scopes. They use a similar lhs-change node to detect changes and perform graph manipulation.

## Debugging

For performance reasons, `Incremental`

is built with debugging asserts disabled. `Incremental_debug`

is a library that uses the same code as `Incremental`

, but has debugging asserts enabled (via an `IFDEF`

). `Incremental_debug`

is significantly slower than `Incremental`

, but may detect a bug in the Incremental library that would otherwise remain undetected by `Incremental`

.

## Reading guide

Here's a breakdown of the modules in roughly dependency order.

`Import`

-- imports from other libraries, and commonly used functionsBasic types.

`Cutoff`

-- a cutoff function`On_update_handler`

-- a function to run when a node's value changes`Node_id`

-- an integer unique id for nodes`Raised_exn`

-- a wrapper around`exn`

that keeps a backtrace.`Sexp_of`

-- interfaces for types that have`with sexp_of`

.`Stabilization_num`

-- an abstract`int option`

, used to express the stabilization cycle when something happens.

`Types`

-- mutually recursive types. Many of the types used in the implementation are mutually recursive. They are all defined in`Types`

. Each type is then later defined in its own module, along with`with fields, sexp`

.`Kind`

-- the variant with one constructor for each kind of node, plus a special constructor for invalidated nodes. Many of the value-carrying variants also have a module for its argument type:`Array_fold`

`At`

`At_intervals`

`Bind`

`Freeze`

`If_then_else`

`Join`

`Snapshot`

`Step_function_node`

`Unordered_array_fold`

`Var`

`Scope`

-- a packed bind.`Node`

-- the main node type.`Internal_observer`

`Observer`

-- a`ref`

wrapper around`Internal_observer`

, used so a finalizer can detect when user code is done with an observer.`Recompute_heap`

`Adjust_heights_heap`

`Alarm_value`

-- values stored in the timing wheel, for time-based nodes.`State`

-- the record type will all data structures used for stabilization, and the implementation of all the`Incremental`

functions.`Incremental`

, the main functor, mostly a wrapper around`State`

.`Incremental_unit_tests`

.

`module type Map_n_gen = sig ... end`

`module type Map_n = sig ... end`

`module type Bind_n_gen = sig ... end`

`module type Bind_n = sig ... end`

`module type S_gen = sig ... end`

`S_gen`

is the type of the module returned by`Incremental.Make`

. It is a specialization of the interface of`Incremental`

, with:

`module type Incremental = sig ... end`