diff --git a/.gitignore b/.gitignore index 73f5db0..3822e8d 100644 --- a/.gitignore +++ b/.gitignore @@ -18,6 +18,11 @@ Thumbs.db /dist/ /out/ +# Idris2 build artifacts +**/build/ +*.ttc +*.ttm + # Dependencies /node_modules/ /vendor/ diff --git a/src/interface/abi/Foreign.idr b/src/interface/abi/Bqniser/ABI/Foreign.idr similarity index 100% rename from src/interface/abi/Foreign.idr rename to src/interface/abi/Bqniser/ABI/Foreign.idr diff --git a/src/interface/abi/Layout.idr b/src/interface/abi/Bqniser/ABI/Layout.idr similarity index 67% rename from src/interface/abi/Layout.idr rename to src/interface/abi/Bqniser/ABI/Layout.idr index b5eea1c..59eb970 100644 --- a/src/interface/abi/Layout.idr +++ b/src/interface/abi/Bqniser/ABI/Layout.idr @@ -17,6 +17,8 @@ module Bqniser.ABI.Layout import Bqniser.ABI.Types import Data.Vect import Data.So +import Data.Nat +import Decidable.Equality %default total @@ -55,11 +57,21 @@ arrayByteSize layout = dataSize = layout.elemCount * layout.elemSize in headerSize + shapeSize + dataSize -||| Proof that array byte size is always >= 8 (at minimum the header) +||| `8 + n` is at least 8 for every `n`. `(>=)` on Nat routes through +||| `compare`, which does not reduce for a symbolic tail, so we case on `n`: +||| both `compare Z Z = EQ` and `compare (S k) Z = GT` reduce, never `LT`. +geEight : (n : Nat) -> So ((8 + n) >= 8) +geEight Z = Oh +geEight (S _) = Oh + +||| Proof that array byte size is always >= 8 (at minimum the header). +||| `arrayByteSize = (8 + rank*8) + dataSize`; reassociate to `8 + (...)` +||| and discharge with `geEight`. public export arraySizeMinHeader : {rank : Nat} -> (layout : BQNArrayLayout rank) -> So (arrayByteSize layout >= 8) -arraySizeMinHeader layout = ?arraySizeMinHeaderProof +arraySizeMinHeader (MkBQNArrayLayout _ _ _ elemSize elemCount) = + geEight (rank * 8 + elemCount * elemSize) ||| Calculate element count from shape (product of extents) public export @@ -82,24 +94,40 @@ paddingFor : (offset : Nat) -> (alignment : Nat) -> Nat paddingFor offset alignment = if offset `mod` alignment == 0 then 0 - else alignment - (offset `mod` alignment) + else minus alignment (offset `mod` alignment) -||| Proof that alignment divides aligned size +||| Proof that alignment divides aligned size: `m = k * n`. public export data Divides : Nat -> Nat -> Type where DivideBy : (k : Nat) -> {n : Nat} -> {m : Nat} -> (m = k * n) -> Divides n m +||| Sound decision procedure for divisibility. Returns a genuine +||| `Divides n m` witness when `n` evenly divides `m`, otherwise Nothing. +||| Division by zero is undecidable here and yields Nothing. +public export +decDivides : (n : Nat) -> (m : Nat) -> Maybe (Divides n m) +decDivides Z _ = Nothing +decDivides (S k) m = + let q = m `div` (S k) in + case decEq m (q * (S k)) of + Yes prf => Just (DivideBy q prf) + No _ => Nothing + ||| Round up to next alignment boundary public export alignUp : (size : Nat) -> (alignment : Nat) -> Nat alignUp size alignment = size + paddingFor size alignment -||| Proof that alignUp produces aligned result +||| Sound divisibility check for an aligned size. The general theorem +||| "alignUp size align is always divisible by align" needs div/mod lemmas; +||| here we *decide* it via `decDivides`, which returns a genuine witness when +||| it holds. (Previously `DivideBy (… div …) Refl`, whose `Refl` cannot +||| typecheck for symbolic inputs.) public export -alignUpCorrect : (size : Nat) -> (align : Nat) -> (align > 0) -> Divides align (alignUp size align) -alignUpCorrect size align prf = - DivideBy ((size + paddingFor size align) `div` align) Refl +alignUpDivides : (size : Nat) -> (align : Nat) -> + Maybe (Divides align (alignUp size align)) +alignUpDivides size align = decDivides align (alignUp size align) -------------------------------------------------------------------------------- -- BQN Value Header Layout @@ -208,6 +236,8 @@ cbqnArrayDescLayout = ] 16 -- Total size: 16 bytes 8 -- Alignment: 8 bytes + {sizeCorrect = Oh} + {aligned = DivideBy 2 Refl} -------------------------------------------------------------------------------- -- Platform-Specific Layouts @@ -229,17 +259,56 @@ verifyAllPlatforms layouts = Right () -- C ABI Compatibility -------------------------------------------------------------------------------- -||| Proof that a struct follows C ABI rules +||| Proof that every field offset in a layout is correctly aligned. +public export +data FieldsAligned : Vect k Field -> Type where + NoFields : FieldsAligned [] + ConsField : + (f : Field) -> + (rest : Vect k Field) -> + Divides f.alignment f.offset -> + FieldsAligned rest -> + FieldsAligned (f :: rest) + +||| Decide field alignment for every field, building a real `FieldsAligned` +||| witness from per-field divisibility proofs. +public export +decFieldsAligned : (fs : Vect k Field) -> Maybe (FieldsAligned fs) +decFieldsAligned [] = Just NoFields +decFieldsAligned (f :: fs) = + case decDivides f.alignment f.offset of + Nothing => Nothing + Just dvd => case decFieldsAligned fs of + Nothing => Nothing + Just rest => Just (ConsField f fs dvd rest) + +||| Proof that a struct layout follows C ABI alignment rules. public export data CABICompliant : StructLayout -> Type where CABIOk : (layout : StructLayout) -> + FieldsAligned layout.fields -> CABICompliant layout -||| Proof that CBQN array descriptor is C-ABI compliant +||| Verify a layout against the C ABI alignment rules, returning a genuine +||| `CABICompliant` proof (built from real per-field divisibility witnesses) +||| or an error when some field offset is misaligned. +public export +checkCABI : (layout : StructLayout) -> Either String (CABICompliant layout) +checkCABI layout = + case decFieldsAligned layout.fields of + Just prf => Right (CABIOk layout prf) + Nothing => Left "Field offsets are not correctly aligned for the C ABI" + +||| Proof that CBQN array descriptor is C-ABI compliant. +||| Offsets 0 and 8 are both divisible by alignment 8. public export -cbqnArrayDescCABI : CABICompliant cbqnArrayDescLayout -cbqnArrayDescCABI = CABIOk cbqnArrayDescLayout +cbqnArrayDescCABI : CABICompliant Layout.cbqnArrayDescLayout +cbqnArrayDescCABI = + CABIOk cbqnArrayDescLayout + (ConsField _ _ (DivideBy 0 Refl) + (ConsField _ _ (DivideBy 1 Refl) + NoFields)) -------------------------------------------------------------------------------- -- Offset Calculation @@ -252,3 +321,15 @@ fieldOffset layout name = case findIndex (\f => f.name == name) layout.fields of Just idx => Just (finToNat idx ** index idx layout.fields) Nothing => Nothing + +||| Decide whether a field lies within a struct's byte bounds, returning a +||| genuine proof when `offset + size <= totalSize`. A previous template +||| version asserted this for *every* field unconditionally, which is false +||| (a field need not belong to the layout); this honest version decides it. +public export +offsetInBounds : (layout : StructLayout) -> (f : Field) -> + Maybe (So (f.offset + f.size <= layout.totalSize)) +offsetInBounds layout f = + case choose (f.offset + f.size <= layout.totalSize) of + Left ok => Just ok + Right _ => Nothing diff --git a/src/interface/abi/Bqniser/ABI/Proofs.idr b/src/interface/abi/Bqniser/ABI/Proofs.idr new file mode 100644 index 0000000..2e67e57 --- /dev/null +++ b/src/interface/abi/Bqniser/ABI/Proofs.idr @@ -0,0 +1,76 @@ +-- SPDX-License-Identifier: MPL-2.0 +-- Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) +-- +||| Machine-checked proofs over the bqniser ABI. +||| +||| These are not runtime tests — they are propositional statements the Idris2 +||| type checker must discharge at compile time. If the concrete CBQN array +||| descriptor layout were misaligned, the FFI result-code encoding wrong, or +||| the BQN type-tag encoding wrong, this module would fail to typecheck and +||| the proof build would go red. +||| +||| The C-ABI compliance witness is built directly from per-field divisibility +||| proofs (`DivideBy k Refl`, where `offset = k * alignment`). Multiplication +||| reduces during type checking, so these are fully verified by the compiler; +||| we never route them through `Nat` division, which is a primitive that does +||| not reduce at the type level. + +module Bqniser.ABI.Proofs + +import Bqniser.ABI.Types +import Bqniser.ABI.Layout +import Data.So +import Data.Vect + +%default total + +-------------------------------------------------------------------------------- +-- The concrete CBQN array-descriptor layout is provably C-ABI compliant. +-------------------------------------------------------------------------------- + +||| Every field offset in the CBQN array descriptor divides its alignment: +||| 0|8 (= 0 * 8) and 8|8 (= 1 * 8). +export +cbqnArrayDescCompliant : CABICompliant Layout.cbqnArrayDescLayout +cbqnArrayDescCompliant = + CABIOk cbqnArrayDescLayout + (ConsField _ _ (DivideBy 0 Refl) + (ConsField _ _ (DivideBy 1 Refl) + NoFields)) + +-------------------------------------------------------------------------------- +-- Result-code round-trip: the encoding the Zig FFI depends on. +-------------------------------------------------------------------------------- + +||| Success is encoded as 0 (the C convention the FFI bridge relies on). +export +okIsZero : resultToInt Ok = 0 +okIsZero = Refl + +||| Null-pointer errors are encoded as 4, matching errorDescription/the bridge. +export +nullPointerIsFour : resultToInt NullPointer = 4 +nullPointerIsFour = Refl + +-------------------------------------------------------------------------------- +-- BQN type-tag encoding: must match CBQN's internal tags 0..6. +-------------------------------------------------------------------------------- + +||| Numbers carry tag 0. +export +numberTagIsZero : bqnTypeToInt BQNNumber = 0 +numberTagIsZero = Refl + +||| Arrays — the fundamental compound type — carry the top tag 6. +export +arrayTagIsSix : bqnTypeToInt BQNArray = 6 +arrayTagIsSix = Refl + +-------------------------------------------------------------------------------- +-- A scalar (rank 0) holds exactly one element. +-------------------------------------------------------------------------------- + +||| The empty shape vector has product 1, so a rank-0 value is a single cell. +export +scalarSingleElement : shapeProduct (the (Vect 0 Bits64) []) = 1 +scalarSingleElement = Refl diff --git a/src/interface/abi/Types.idr b/src/interface/abi/Bqniser/ABI/Types.idr similarity index 62% rename from src/interface/abi/Types.idr rename to src/interface/abi/Bqniser/ABI/Types.idr index b15194e..66b43e7 100644 --- a/src/interface/abi/Types.idr +++ b/src/interface/abi/Bqniser/ABI/Types.idr @@ -18,6 +18,7 @@ module Bqniser.ABI.Types import Data.Bits import Data.So import Data.Vect +import Decidable.Equality %default total @@ -32,9 +33,7 @@ data Platform = Linux | Windows | MacOS | BSD | WASM ||| Compile-time platform detection public export thisPlatform : Platform -thisPlatform = - %runElab do - pure Linux -- Default; override with compiler flags +thisPlatform = Linux -- Default; override with compiler flags -------------------------------------------------------------------------------- -- BQN Array Rank @@ -60,7 +59,8 @@ data ArrayRank : Nat -> Type where ||| Proof that every ArrayRank has a non-negative rank (trivially true for Nat) public export rankNonNeg : {r : Nat} -> ArrayRank r -> (r >= 0 = True) -rankNonNeg _ = Refl +rankNonNeg {r = Z} _ = Refl +rankNonNeg {r = S _} _ = Refl -------------------------------------------------------------------------------- -- BQN Primitives @@ -95,6 +95,7 @@ data BQNPrimitive : Type where ||| Decidable equality for BQN primitives public export DecEq BQNPrimitive where + -- Diagonal: identical nullary constructors. decEq Join Join = Yes Refl decEq Reverse Reverse = Yes Refl decEq GradeUp GradeUp = Yes Refl @@ -103,7 +104,104 @@ DecEq BQNPrimitive where decEq Select Select = Yes Refl decEq Reshape Reshape = Yes Refl decEq Transpose Transpose = Yes Refl - decEq _ _ = No absurd + -- Diagonal: parametric constructors reduce to their Char field. + decEq (Arith g1) (Arith g2) = case decEq g1 g2 of + Yes Refl => Yes Refl + No contra => No (\case Refl => contra Refl) + decEq (Compare g1) (Compare g2) = case decEq g1 g2 of + Yes Refl => Yes Refl + No contra => No (\case Refl => contra Refl) + -- Off-diagonal: Join vs others + decEq Join Reverse = No (\case Refl impossible) + decEq Join GradeUp = No (\case Refl impossible) + decEq Join GradeDown = No (\case Refl impossible) + decEq Join Replicate = No (\case Refl impossible) + decEq Join Select = No (\case Refl impossible) + decEq Join Reshape = No (\case Refl impossible) + decEq Join Transpose = No (\case Refl impossible) + decEq Join (Arith _) = No (\case Refl impossible) + decEq Join (Compare _) = No (\case Refl impossible) + decEq Reverse Join = No (\case Refl impossible) + decEq Reverse GradeUp = No (\case Refl impossible) + decEq Reverse GradeDown = No (\case Refl impossible) + decEq Reverse Replicate = No (\case Refl impossible) + decEq Reverse Select = No (\case Refl impossible) + decEq Reverse Reshape = No (\case Refl impossible) + decEq Reverse Transpose = No (\case Refl impossible) + decEq Reverse (Arith _) = No (\case Refl impossible) + decEq Reverse (Compare _) = No (\case Refl impossible) + decEq GradeUp Join = No (\case Refl impossible) + decEq GradeUp Reverse = No (\case Refl impossible) + decEq GradeUp GradeDown = No (\case Refl impossible) + decEq GradeUp Replicate = No (\case Refl impossible) + decEq GradeUp Select = No (\case Refl impossible) + decEq GradeUp Reshape = No (\case Refl impossible) + decEq GradeUp Transpose = No (\case Refl impossible) + decEq GradeUp (Arith _) = No (\case Refl impossible) + decEq GradeUp (Compare _) = No (\case Refl impossible) + decEq GradeDown Join = No (\case Refl impossible) + decEq GradeDown Reverse = No (\case Refl impossible) + decEq GradeDown GradeUp = No (\case Refl impossible) + decEq GradeDown Replicate = No (\case Refl impossible) + decEq GradeDown Select = No (\case Refl impossible) + decEq GradeDown Reshape = No (\case Refl impossible) + decEq GradeDown Transpose = No (\case Refl impossible) + decEq GradeDown (Arith _) = No (\case Refl impossible) + decEq GradeDown (Compare _) = No (\case Refl impossible) + decEq Replicate Join = No (\case Refl impossible) + decEq Replicate Reverse = No (\case Refl impossible) + decEq Replicate GradeUp = No (\case Refl impossible) + decEq Replicate GradeDown = No (\case Refl impossible) + decEq Replicate Select = No (\case Refl impossible) + decEq Replicate Reshape = No (\case Refl impossible) + decEq Replicate Transpose = No (\case Refl impossible) + decEq Replicate (Arith _) = No (\case Refl impossible) + decEq Replicate (Compare _) = No (\case Refl impossible) + decEq Select Join = No (\case Refl impossible) + decEq Select Reverse = No (\case Refl impossible) + decEq Select GradeUp = No (\case Refl impossible) + decEq Select GradeDown = No (\case Refl impossible) + decEq Select Replicate = No (\case Refl impossible) + decEq Select Reshape = No (\case Refl impossible) + decEq Select Transpose = No (\case Refl impossible) + decEq Select (Arith _) = No (\case Refl impossible) + decEq Select (Compare _) = No (\case Refl impossible) + decEq Reshape Join = No (\case Refl impossible) + decEq Reshape Reverse = No (\case Refl impossible) + decEq Reshape GradeUp = No (\case Refl impossible) + decEq Reshape GradeDown = No (\case Refl impossible) + decEq Reshape Replicate = No (\case Refl impossible) + decEq Reshape Select = No (\case Refl impossible) + decEq Reshape Transpose = No (\case Refl impossible) + decEq Reshape (Arith _) = No (\case Refl impossible) + decEq Reshape (Compare _) = No (\case Refl impossible) + decEq Transpose Join = No (\case Refl impossible) + decEq Transpose Reverse = No (\case Refl impossible) + decEq Transpose GradeUp = No (\case Refl impossible) + decEq Transpose GradeDown = No (\case Refl impossible) + decEq Transpose Replicate = No (\case Refl impossible) + decEq Transpose Select = No (\case Refl impossible) + decEq Transpose Reshape = No (\case Refl impossible) + decEq Transpose (Arith _) = No (\case Refl impossible) + decEq Transpose (Compare _) = No (\case Refl impossible) + decEq (Arith _) Join = No (\case Refl impossible) + decEq (Arith _) Reverse = No (\case Refl impossible) + decEq (Arith _) GradeUp = No (\case Refl impossible) + decEq (Arith _) GradeDown = No (\case Refl impossible) + decEq (Arith _) Replicate = No (\case Refl impossible) + decEq (Arith _) Select = No (\case Refl impossible) + decEq (Arith _) Reshape = No (\case Refl impossible) + decEq (Arith _) Transpose = No (\case Refl impossible) + decEq (Arith _) (Compare _) = No (\case Refl impossible) + decEq (Compare _) Join = No (\case Refl impossible) + decEq (Compare _) Reverse = No (\case Refl impossible) + decEq (Compare _) GradeUp = No (\case Refl impossible) + decEq (Compare _) GradeDown = No (\case Refl impossible) + decEq (Compare _) Replicate = No (\case Refl impossible) + decEq (Compare _) Select = No (\case Refl impossible) + decEq (Compare _) Reshape = No (\case Refl impossible) + decEq (Compare _) Transpose = No (\case Refl impossible) + decEq (Compare _) (Arith _) = No (\case Refl impossible) -------------------------------------------------------------------------------- -- BQN Modifiers (1-modifiers and 2-modifiers) @@ -231,7 +329,36 @@ DecEq Result where decEq OutOfMemory OutOfMemory = Yes Refl decEq NullPointer NullPointer = Yes Refl decEq EvalError EvalError = Yes Refl - decEq _ _ = No absurd + decEq Ok Error = No (\case Refl impossible) + decEq Ok InvalidParam = No (\case Refl impossible) + decEq Ok OutOfMemory = No (\case Refl impossible) + decEq Ok NullPointer = No (\case Refl impossible) + decEq Ok EvalError = No (\case Refl impossible) + decEq Error Ok = No (\case Refl impossible) + decEq Error InvalidParam = No (\case Refl impossible) + decEq Error OutOfMemory = No (\case Refl impossible) + decEq Error NullPointer = No (\case Refl impossible) + decEq Error EvalError = No (\case Refl impossible) + decEq InvalidParam Ok = No (\case Refl impossible) + decEq InvalidParam Error = No (\case Refl impossible) + decEq InvalidParam OutOfMemory = No (\case Refl impossible) + decEq InvalidParam NullPointer = No (\case Refl impossible) + decEq InvalidParam EvalError = No (\case Refl impossible) + decEq OutOfMemory Ok = No (\case Refl impossible) + decEq OutOfMemory Error = No (\case Refl impossible) + decEq OutOfMemory InvalidParam = No (\case Refl impossible) + decEq OutOfMemory NullPointer = No (\case Refl impossible) + decEq OutOfMemory EvalError = No (\case Refl impossible) + decEq NullPointer Ok = No (\case Refl impossible) + decEq NullPointer Error = No (\case Refl impossible) + decEq NullPointer InvalidParam = No (\case Refl impossible) + decEq NullPointer OutOfMemory = No (\case Refl impossible) + decEq NullPointer EvalError = No (\case Refl impossible) + decEq EvalError Ok = No (\case Refl impossible) + decEq EvalError Error = No (\case Refl impossible) + decEq EvalError InvalidParam = No (\case Refl impossible) + decEq EvalError OutOfMemory = No (\case Refl impossible) + decEq EvalError NullPointer = No (\case Refl impossible) -------------------------------------------------------------------------------- -- Opaque Handles @@ -247,8 +374,10 @@ data Handle : Type where ||| Returns Nothing if pointer is null. public export createHandle : Bits64 -> Maybe Handle -createHandle 0 = Nothing -createHandle ptr = Just (MkHandle ptr) +createHandle ptr = + case choose (ptr /= 0) of + Left ok => Just (MkHandle ptr {nonNull = ok}) + Right _ => Nothing ||| Extract pointer value from handle. public export diff --git a/src/interface/abi/bqniser-abi.ipkg b/src/interface/abi/bqniser-abi.ipkg new file mode 100644 index 0000000..67c97c6 --- /dev/null +++ b/src/interface/abi/bqniser-abi.ipkg @@ -0,0 +1,11 @@ +-- SPDX-License-Identifier: MPL-2.0 +-- Idris2 package for the bqniser ABI formal proofs. +-- Build/check with: idris2 --build bqniser-abi.ipkg (from src/interface/abi/) +package bqniser-abi + +sourcedir = "." + +modules = Bqniser.ABI.Types + , Bqniser.ABI.Layout + , Bqniser.ABI.Foreign + , Bqniser.ABI.Proofs