Module Env.RunTimeSource

Internal representation for subprograms.

Parameters

module C : RunTimeConf

Signature

Sourcetype v = C.v

Stored elements of the environment.

Sourcemodule Scope = C.Scope

Scopes for interpretation: make local storage identifiers unique accross function calls, if needed.

Types and constructors.

Sourcetype global = {
  1. static : StaticEnv.global;
    (*

    References the static environment.

    *)
  2. storage : v Storage.t;
    (*

    Binds global variables to their names.

    *)
  3. stack_size : Z.t ASTUtils.IMap.t;
    (*

    Current number of recursive calls open for each subprogram.

    *)
}

The global part of an environment.

Sourcetype local

The local part of an environment.

Sourcetype env = {
  1. global : global;
  2. local : local;
}

The environment type.

Sourceval to_static : env -> StaticEnv.env

Builds a static environment, with an empty local part.

Sourceval local_empty_scoped : ?storage:v Storage.t -> Scope.t -> local

empty_scoped scope is an empty local environment in the scope scope.

Sourceval global_from_static : ?storage:v Storage.t -> StaticEnv.global -> global

global_from_static static_env is an empty global environment with the static environment static_env.

Accessors

Sourcetype 'a env_result =
  1. | Local of 'a
  2. | Global of 'a
  3. | NotFound
    (*

    Indicates if the value returned was bound in the global or local namespace.

    *)

Fetches an identifier from the environment.

Sourceval mem : AST.identifier -> env -> bool

mem x env is true iff x is bound in env.

Sourceval declare_local : AST.identifier -> v -> env -> env

declare_local x v env is env where x is now bound to v. This binding will be discarded by the call to pop_scope corresponding to the last call to push_scope before this declaration.

Sourceval assign_local : AST.identifier -> v -> env -> env

assign_local x v env is env where x is now bound to v. It is assumed to be already bound in env.

Sourceval declare_global : AST.identifier -> v -> env -> env

declare_global x v env is env where x is now bound to v. It is supposed that x is not bound in env.

Sourceval assign_global : AST.identifier -> v -> env -> env

assign_global x v env is env where x is now bound to v. It is assumed to be already bound in env.

Sourceval remove_local : AST.identifier -> env -> env

remove_local x env is env where x is not bound.

Sourceval assign : AST.identifier -> v -> env -> env env_result

assign x v env assigns x to v in env, and returns if x was declared as a local or global identifier.

Loop unrolling

Sourceval tick_push : env -> env

Push a new unrolling counter on the stack. The associated loop will be unrolled C.unroll times.

Sourceval tick_push_bis : env -> env

Push a new unrolling counter on the stack. The associated loop will be unrolled C.unroll - 1 times.

Sourceval tick_pop : env -> env

Discards the last unrolling counter of the stack.

Sourceval tick_decr : env -> bool * env

tick_decr env is (stop, env') where

  • if the last counter is lower or equal to 1, stop is true and the last counter is discarded.
  • if the last counter is bigger or equal to 2, stop is false and the counter is decremented of 1.

Scope handling

Sourceval get_scope : env -> Scope.t

Returns the local scope of that environment.

Sourceval push_scope : env -> env

Push a new scope on the declaration stack. Variables declared here will be stored until the corresponding pop_scope.

Sourceval pop_scope : env -> env -> env

pop_scope old new restores the variable bindings of old, with the updated values of new.

Sourceval get_stack_size : AST.identifier -> env -> Z.t

get_stack_size name env returns the stack_size for name.

Sourceval incr_stack_size : AST.identifier -> global -> global

incr_stack_size name env increases the stack size for name.

Sourceval decr_stack_size : AST.identifier -> global -> global

decr_stack_size name env decreases the stack size for name.