@grain/stdlib 0.5.12 → 0.6.0

package/runtime/malloc.gr

@@ -1,4 +1,5 @@
-/* grainc-flags --compilation-mode=runtime */
+@runtimeMode
+module Malloc
 
 /*
  * This module implements a generic memory allocator.
@@ -6,29 +7,30 @@
  * from pages 185-188 of K&R C (2nd edition).
  */
 
-import WasmI32, {
-  add as (+),
-  sub as (-),
-  mul as (*),
+from "runtime/unsafe/wasmi32" include WasmI32
+use WasmI32.{
+  (+),
+  (-),
+  (*),
   divU as (/),
   gtU as (>),
   geU as (>=),
   ltU as (<),
-  shl as (<<),
-  shrU as (>>),
-  eq as (==),
-  ne as (!=),
-} from "runtime/unsafe/wasmi32"
-import Exception from "runtime/exception"
+  (<<),
+  (>>>),
+  (==),
+  (!=),
+}
+from "runtime/exception" include Exception
 
-primitive memorySize: () -> WasmI32 = "@wasm.memory_size"
-primitive memoryGrow: WasmI32 -> WasmI32 = "@wasm.memory_grow"
+primitive memorySize = "@wasm.memory_size"
+primitive memoryGrow = "@wasm.memory_grow"
 
-primitive (!): Bool -> Bool = "@not"
-primitive (&&): (Bool, Bool) -> Bool = "@and"
-primitive (||): (Bool, Bool) -> Bool = "@or"
+primitive (!) = "@not"
+primitive (&&) = "@and"
+primitive (||) = "@or"
 
-primitive heapBase: WasmI32 = "@heap.base"
+primitive heapStart = "@heap.start"
 
 /* UNDERSTANDING THE STRUCTURE OF THE FREE LIST
  * The original K&R definition for the free list entry type was the following:
@@ -74,13 +76,13 @@ let logMallocHeaderSize = 3n
  */
 let mut heapSize = 0n
 
-export let _RESERVED_RUNTIME_SPACE = 0x4000n
+provide let _RESERVED_RUNTIME_SPACE = 0x800n
 
 /**
  * The base the heap. The block at this address will be size 0 and
  * serve as the root of the free list.
  */
-let _BASE = heapBase + _RESERVED_RUNTIME_SPACE
+let _BASE = heapStart() + _RESERVED_RUNTIME_SPACE
 
 /**
  * The start pointer of the heap.
@@ -129,7 +131,7 @@ let growHeap = (nbytes: WasmI32) => {
       // More bytes requested than the initial heap size,
       // so we need to request more anyway.
       reqSize = nbytes - heapSize
-      reqSize = reqSize >> 16n
+      reqSize = reqSize >>> 16n
       reqSize += 1n
       reqResult = memoryGrow(reqSize)
       if (reqResult == -1n) {
@@ -146,7 +148,7 @@ let growHeap = (nbytes: WasmI32) => {
     let newRegionStart = memorySize() * _PAGE_SIZE
 
     reqSize = nbytes
-    reqSize = reqSize >> 16n
+    reqSize = reqSize >>> 16n
     reqSize += 1n
 
     reqResult = memoryGrow(reqSize)
@@ -164,7 +166,7 @@ let growHeap = (nbytes: WasmI32) => {
  *
  * @param ap: The pointer to free
  */
-export let free = (ap: WasmI32) => {
+provide let free = (ap: WasmI32) => {
   let mut blockPtr = ap - 8n // 8 bytes for malloc header
   let mut p = freePtr
 
@@ -238,8 +240,8 @@ let morecore = (nbytes: WasmI32) => {
  * @param nbytes: The number of bytes to allocate
  * @returns The pointer to the allocated region (8-byte aligned) or -1 if the allocation failed
  */
-export let malloc = (nb: WasmI32) => {
-  let mut nbytes = nb
+provide let malloc = (nbytes: WasmI32) => {
+  let mut nbytes = nbytes
   let mut prevp = freePtr
 
   // Set nbytes to the next multiple of mallocHeaderSize greater
@@ -258,12 +260,10 @@ export let malloc = (nb: WasmI32) => {
   let mut ret = -1n
 
   // Search the freelist for any blocks large enough.
-  for (
-    let mut p = getNext(prevp); ; {
-      prevp = p
-      p = getNext(p)
-    }
-  ) {
+  for (let mut p = getNext(prevp);; {
+    prevp = p
+    p = getNext(p)
+  }) {
     let size = getSize(p)
     if (size >= nbytes) {
       // If this block is big enough, allocate from it.
@@ -305,6 +305,6 @@ export let malloc = (nb: WasmI32) => {
  *
  * @returns The free list pointer
  */
-export let getFreePtr = () => {
+provide let getFreePtr = () => {
   freePtr
 }

package/runtime/malloc.md

@@ -1,3 +1,11 @@
+---
+title: Malloc
+---
+
+## Values
+
+Functions and constants included in the Malloc module.
+
 ### Malloc.**_RESERVED_RUNTIME_SPACE**
 
 ```grain
@@ -7,7 +15,7 @@ _RESERVED_RUNTIME_SPACE : WasmI32
 ### Malloc.**free**
 
 ```grain
-free : WasmI32 -> Void
+free : (ap: WasmI32) => Void
 ```
 
 Frees the given allocated pointer.
@@ -21,7 +29,7 @@ Parameters:
 ### Malloc.**malloc**
 
 ```grain
-malloc : WasmI32 -> WasmI32
+malloc : (nbytes: WasmI32) => WasmI32
 ```
 
 Allocates the requested number of bytes, returning a pointer.
@@ -41,7 +49,7 @@ Returns:
 ### Malloc.**getFreePtr**
 
 ```grain
-getFreePtr : () -> WasmI32
+getFreePtr : () => WasmI32
 ```
 
 Returns the current free list pointer.