This PR implements zero cost `BaseIO` by erasing the `IO.RealWorld` parameter from argument lists and structures. This is a **major breaking change for FFI**. Concretely: - `BaseIO` is defined in terms of `ST IO.RealWorld` - `EIO` (and thus `IO`) is defined in terms of `EST IO.RealWorld` - The opaque `Void` type is introduced and the trivial structure optimization updated to account for it. Furthermore, arguments of type `Void s` are removed from the argument lists of the C functions. - `ST` is redefined as `Void s -> ST.Out s a` where `ST.Out` is a pair of `Void s` and `a` This together has the following major effects on our generated code: - Functions that return `BaseIO`/`ST`/`EIO`/`IO`/`EST` now do not take the dummy world parameter anymore. To account for this FFI code needs to delete the dummy world parameter from the argument lists. - Functions that return `BaseIO`/`ST` now return their wrapped value directly. In particular `BaseIO UInt32` now returns a `uint32_t` instead of a `lean_object*`. To account for this FFI code might have to change the return type and does not need to call `lean_io_result_mk_ok` anymore but can instead just `return` values right away (same with extracting values from `BaseIO` computations. - Functions that return `EIO`/`IO`/`EST` now only return the equivalent of an `Except` node which reduces the allocation size. The `lean_io_result_mk_ok`/`lean_io_result_mk_error` functions were updated to account for this already so no change is required. Besides improving performance by dropping allocation (sizes) we can now also do fun new things such as: ```lean @[extern "malloc"] opaque malloc (size : USize) : BaseIO USize ```
71 lines
2.4 KiB
Text
71 lines
2.4 KiB
Text
/-
|
|
Copyright (c) 2025 Lean FRO, LLC. All rights reserved.
|
|
Released under Apache 2.0 license as described in the file LICENSE.
|
|
Authors: Henrik Böving
|
|
-/
|
|
module
|
|
|
|
prelude
|
|
public import Lean.Compiler.LCNF.CompilerM
|
|
import Lean.Compiler.LCNF.BaseTypes
|
|
import Lean.Compiler.LCNF.Util
|
|
|
|
namespace Lean.Compiler.LCNF
|
|
|
|
/--
|
|
Given a constructor, return a bitmask `m` s.t. `m[i]` is true if field `i` is
|
|
computationally relevant.
|
|
-/
|
|
def getRelevantCtorFields (ctorName : Name) (trivialType : Expr → MetaM Bool) :
|
|
CoreM (Array Bool) := do
|
|
let .ctorInfo info ← getConstInfo ctorName | unreachable!
|
|
Meta.MetaM.run' do
|
|
Meta.forallTelescopeReducing info.type fun xs _ => do
|
|
let mut result := #[]
|
|
for x in xs[info.numParams...*] do
|
|
let type ← Meta.inferType x
|
|
result := result.push !(← trivialType type)
|
|
return result
|
|
|
|
/--
|
|
We say a structure has a trivial structure if it has not builtin support in the runtime,
|
|
it has only one constructor, and this constructor has only one relevant field.
|
|
-/
|
|
public structure TrivialStructureInfo where
|
|
ctorName : Name
|
|
numParams : Nat
|
|
fieldIdx : Nat
|
|
deriving Inhabited, Repr
|
|
|
|
/--
|
|
Return `some fieldIdx` if `declName` is the name of an inductive datatype s.t.
|
|
- It does not have builtin support in the runtime.
|
|
- It has only one constructor.
|
|
- This constructor has only one computationally relevant field.
|
|
-/
|
|
public def Irrelevant.hasTrivialStructure?
|
|
(cacheExt : CacheExtension Name (Option TrivialStructureInfo))
|
|
(trivialType : Expr → MetaM Bool) (declName : Name) : CoreM (Option TrivialStructureInfo) := do
|
|
match (← cacheExt.find? declName) with
|
|
| some info? => return info?
|
|
| none =>
|
|
let info? ← fillCache
|
|
cacheExt.insert declName info?
|
|
return info?
|
|
where fillCache : CoreM (Option TrivialStructureInfo) := do
|
|
if isRuntimeBuiltinType declName then return none
|
|
let .inductInfo info ← getConstInfo declName | return none
|
|
if info.isUnsafe || info.isRec then return none
|
|
let [ctorName] := info.ctors | return none
|
|
let ctorType ← getOtherDeclBaseType ctorName []
|
|
if ctorType.isErased then return none
|
|
let mask ← getRelevantCtorFields ctorName trivialType
|
|
let mut result := none
|
|
for h : i in *...mask.size do
|
|
if mask[i] then
|
|
if result.isSome then return none
|
|
result := some { ctorName, fieldIdx := i, numParams := info.numParams }
|
|
return result
|
|
|
|
|
|
end Lean.Compiler.LCNF
|