Debugging helper functions

@[never_extract, extern lean_dbg_trace]

def dbgTrace {α : Type u} (s : String) (f : Unit → α) : α

Equations

• dbgTrace s f = f ()

def dbgTraceVal {α : Type u} [ToString α] (a : α) : α

Equations

• dbgTraceVal a = dbgTrace (toString a) fun (x : Unit) => a

@[never_extract, extern lean_dbg_trace_if_shared]

def dbgTraceIfShared {α : Type u} (s : String) (a : α) : α

Display the given message if a is shared, that is, RC(a) > 1

Equations

• dbgTraceIfShared s a = a

@[never_extract, extern lean_dbg_stack_trace]

def dbgStackTrace {α : Type u} (f : Unit → α) : α

Print stack trace to stderr before evaluating given closure. Currently supported on Linux only.

Equations

• dbgStackTrace f = f ()

@[never_extract]

def dbgStackTraceIf {α : Type u} (cond : Bool) (f : Unit → α) : α

Print stack trace to stderr before evaluating given closure if cond is true. Currently supported on Linux only.

Equations

• dbgStackTraceIf cond f = if cond = true then dbgStackTrace f else f ()

@[extern lean_dbg_sleep]

def dbgSleep {α : Type u} (ms : UInt32) (f : Unit → α) : α

Equations

• dbgSleep ms f = f ()

@[noinline]

def mkPanicMessage (modName : String) (line col : Nat) (msg : String) : String

Equations

• One or more equations did not get rendered due to their size.

@[never_extract, inline]

def panicWithPos {α : Sort u} [Inhabited α] (modName : String) (line col : Nat) (msg : String) : α

Equations

• panicWithPos modName line col msg = panic (mkPanicMessage modName line col msg)

@[noinline]

def mkPanicMessageWithDecl (modName declName : String) (line col : Nat) (msg : String) : String

Equations

• One or more equations did not get rendered due to their size.

@[never_extract, inline]

def panicWithPosWithDecl {α : Sort u} [Inhabited α] (modName declName : String) (line col : Nat) (msg : String) : α

Equations

• panicWithPosWithDecl modName declName line col msg = panic (mkPanicMessageWithDecl modName declName line col msg)

@[extern lean_ptr_addr]

unsafe opaque ptrAddrUnsafe {α : Type u} (a : α) : USize

Returns the address at which an object is allocated.

This function is unsafe because it can distinguish between definitionally equal values.

@[extern lean_is_exclusive_obj]

unsafe opaque isExclusiveUnsafe {α : Type u} (a : α) : Bool

Returns true if a is an exclusive object.

An object is exclusive if it is single-threaded and its reference counter is 1. This function is unsafe because it can distinguish between definitionally equal values.

@[inline]

unsafe def withPtrAddrUnsafe {α : Type u} {β : Type v} (a : α) (k : USize → β) (h : ∀ (u₁ u₂ : USize), k u₁ = k u₂) : β

Equations

• withPtrAddrUnsafe a k h = k (ptrAddrUnsafe a)

@[inline]

unsafe def ptrEq {α : Type u_1} (a b : α) : Bool

Compares two objects for pointer equality.

Two objects are pointer-equal if, at runtime, they are allocated at exactly the same address. This function is unsafe because it can distinguish between definitionally equal values.

Equations

• ptrEq a b = (ptrAddrUnsafe a == ptrAddrUnsafe b)

unsafe def ptrEqList {α : Type u_1} (as bs : List α) : Bool

Compares two lists of objects for element-wise pointer equality. Returns true if both lists are the same length and the objects at the corresponding indices of each list are pointer-equal.

Two objects are pointer-equal if, at runtime, they are allocated at exactly the same address. This function is unsafe because it can distinguish between definitionally equal values.

Equations

• ptrEqList [] [] = true
• ptrEqList (a :: as) (b :: bs) = if ptrEq a b = true then ptrEqList as bs else false
• ptrEqList x✝¹ x✝ = false

@[inline]

unsafe def withPtrEqUnsafe {α : Type u} (a b : α) (k : Unit → Bool) (h : a = b → k () = true) : Bool

Equations

• withPtrEqUnsafe a b k h = if ptrEq a b = true then true else k ()

@[implemented_by withPtrEqUnsafe]

def withPtrEq {α : Type u} (a b : α) (k : Unit → Bool) (h : a = b → k () = true) : Bool

Equations

• withPtrEq a b k h = k ()

@[inline]

def withPtrEqDecEq {α : Type u} (a b : α) (k : Unit → Decidable (a = b)) : Decidable (a = b)

withPtrEq for DecidableEq

Equations

• withPtrEqDecEq a b k = match h : withPtrEq a b (fun (x : Unit) => toBoolUsing (k ())) ⋯ with | true => isTrue ⋯ | false => isFalse ⋯

@[implemented_by withPtrAddrUnsafe]

def withPtrAddr {α : Type u} {β : Type v} (a : α) (k : USize → β) (h : ∀ (u₁ u₂ : USize), k u₁ = k u₂) : β

Equations

• withPtrAddr a k h = k 0