Documentation

Lean.Compiler.IR.Basic

Implements (extended) λPure and λRc proposed in the article "Counting Immutable Beans", Sebastian Ullrich and Leonardo de Moura.

The Lean to IR transformation produces λPure code, and this part is implemented in C++. The procedures described in the paper above are implemented in Lean.

@[inline]
abbrev Lean.IR.FunId :
Type

Function identifier

Equations
@[inline]
abbrev Lean.IR.Index :
Type
Equations
structure Lean.IR.VarId :
Type

Variable identifier

Instances For
    Equations
    structure Lean.IR.JoinPointId :
    Type

    Join point identifier

    Instances For
      @[inline]
      Equations
      Equations
      Equations
      Equations
      @[inline]
      abbrev Lean.IR.MData :
      Type
      Equations
      @[inline]
      Equations
      inductive Lean.IR.IRType :
      Type

      Low Level IR types. Most are self explanatory.

      • usize represents the C++ size_t Type. We have it here because it is 32-bit in 32-bit machines, and 64-bit in 64-bit machines, and we want the C++ backend for our Compiler to generate platform independent code.

      • irrelevant for Lean types, propositions and proofs.

      • object a pointer to a value in the heap.

      • tobject a pointer to a value in the heap or tagged pointer (i.e., the least significant bit is 1) storing a scalar value.

      • struct and union are used to return small values (e.g., Option, Prod, Except) on the stack.

      Remark: the RC operations for tobject are slightly more expensive because we first need to test whether the tobject is really a pointer or not.

      Remark: the Lean runtime assumes that sizeof(void*) == sizeof(sizeT). Lean cannot be compiled on old platforms where this is not True.

      Since values of type struct and union are only used to return values, We assume they must be used/consumed "linearly". We use the term "linear" here to mean "exactly once" in each execution. That is, given x : S, where S is a struct, then one of the following must hold in each (execution) branch. 1- x occurs only at a single ret x instruction. That is, it is being consumed by being returned. 2- x occurs only at a single ctor. That is, it is being "consumed" by being stored into another struct/union. 3- We extract (aka project) every single field of x exactly once. That is, we are consuming x by consuming each of one of its components. Minor refinement: we don't need to consume scalar fields or struct/union fields that do not contain object fields.

      Instances For
        Equations
        • One or more equations did not get rendered due to their size.
        Equations
        Equations
        Equations
        Equations
        inductive Lean.IR.Arg :
        Type

        Arguments to applications, constructors, etc. We use irrelevant for Lean types, propositions and proofs that have been erased. Recall that for a Function f, we also generate f._rarg which does not take irrelevant arguments. However, f._rarg is only safe to be used in full applications.

        Instances For
          Equations
          • One or more equations did not get rendered due to their size.
          @[export lean_ir_mk_var_arg]
          Equations
          inductive Lean.IR.LitVal :
          Type
          Instances For
            Equations
            • One or more equations did not get rendered due to their size.
            structure Lean.IR.CtorInfo :
            Type

            Constructor information.

            • name is the Name of the Constructor in Lean.
            • cidx is the Constructor index (aka tag).
            • size is the number of arguments of type object/tobject.
            • usize is the number of arguments of type usize.
            • ssize is the number of bytes used to store scalar values.

            Recall that a Constructor object contains a header, then a sequence of pointers to other Lean objects, a sequence of USize (i.e., size_t) scalar values, and a sequence of other scalar values.

            Instances For
              Equations
              • One or more equations did not get rendered due to their size.
              Equations
              inductive Lean.IR.Expr :
              Type
              Instances For
                @[export lean_ir_mk_ctor_expr]
                def Lean.IR.mkCtorExpr (n : Lean.Name) (cidx : Nat) (size : Nat) (usize : Nat) (ssize : Nat) (ys : Array Lean.IR.Arg) :
                Equations
                @[export lean_ir_mk_proj_expr]
                Equations
                @[export lean_ir_mk_uproj_expr]
                Equations
                @[export lean_ir_mk_sproj_expr]
                Equations
                @[export lean_ir_mk_fapp_expr]
                Equations
                @[export lean_ir_mk_papp_expr]
                Equations
                @[export lean_ir_mk_app_expr]
                Equations
                @[export lean_ir_mk_num_expr]
                Equations
                structure Lean.IR.Param :
                Type
                Instances For
                  Equations
                  @[export lean_ir_mk_param]
                  Equations
                  inductive Lean.IR.AltCore (FnBody : Type) :
                  Type
                  Instances For
                    inductive Lean.IR.FnBody :
                    Type
                    Instances For
                      @[export lean_ir_mk_vdecl]
                      Equations
                      @[export lean_ir_mk_jdecl]
                      Equations
                      @[export lean_ir_mk_uset]
                      Equations
                      @[export lean_ir_mk_sset]
                      Equations
                      @[export lean_ir_mk_ret]
                      Equations
                      @[export lean_ir_mk_jmp]
                      Equations
                      @[matchPattern, inline]
                      Equations
                      @[matchPattern, inline]
                      Equations
                      Equations
                      • One or more equations did not get rendered due to their size.
                      Equations
                      • One or more equations did not get rendered due to their size.
                      Equations
                      • One or more equations did not get rendered due to their size.
                      @[inline]

                      If b is a non terminal, then return a pair (c, b') s.t. b == c <;> b', and c.body == FnBody.nil

                      Equations
                      Equations
                      Equations
                      • One or more equations did not get rendered due to their size.
                      @[inline]
                      Equations
                      Equations
                      @[inline]
                      Equations
                      @[inline]
                      def Lean.IR.mmodifyJPs {m : TypeType} [inst : Monad m] (bs : Array Lean.IR.FnBody) (f : Lean.IR.FnBodym Lean.IR.FnBody) :
                      Equations
                      • One or more equations did not get rendered due to their size.
                      @[export lean_ir_mk_alt]
                      def Lean.IR.mkAlt (n : Lean.Name) (cidx : Nat) (size : Nat) (usize : Nat) (ssize : Nat) (b : Lean.IR.FnBody) :
                      Equations
                      structure Lean.IR.DeclInfo :
                      Type
                      • If some , then declaration depends on which uses a sorry axiom.

                        sorryDep? : Option Lean.Name

                      Extra information associated with a declaration.

                      Instances For
                        Equations
                        Equations
                        Equations
                        Equations
                        Equations
                        Equations
                        Equations
                        • One or more equations did not get rendered due to their size.
                        @[export lean_ir_mk_decl]
                        Equations
                        @[export lean_ir_mk_extern_decl]
                        Equations
                        @[export lean_ir_mk_dummy_extern_decl]
                        Equations
                        @[inline]
                        abbrev Lean.IR.IndexSet :
                        Type

                        Set of variable and join point names

                        Equations
                        Equations
                        • One or more equations did not get rendered due to their size.
                        class Lean.IR.AlphaEqv (α : Type) :
                        Type
                        Instances
                          Equations
                          Equations
                          • One or more equations did not get rendered due to their size.
                          Equations
                          Equations
                          • One or more equations did not get rendered due to their size.
                          Equations
                          Equations
                          Equations
                          • One or more equations did not get rendered due to their size.
                          @[inline]
                          abbrev Lean.IR.VarIdSet :
                          Type
                          Equations
                          Equations
                          • One or more equations did not get rendered due to their size.