Init

Author: kateinoigakukun

.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+/.build
+/Packages
+/*.xcodeproj
+xcuserdata/
+Package.resolved

Examples/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+/.build
+/.index-build
+/Packages
+xcuserdata/
+DerivedData/
+.swiftpm/configuration/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc

Examples/Package.swift

@@ -0,0 +1,36 @@
+// swift-tools-version: 6.0
+
+import PackageDescription
+
+let package = Package(
+    name: "Examples",
+    dependencies: [
+        .package(path: "../"),
+    ],
+    targets: [
+        .executableTarget(
+            name: "Examples",
+            dependencies: [
+                .product(name: "dlmalloc", package: "swift-dlmalloc"),
+            ],
+            cSettings: [
+                .unsafeFlags(["-fdeclspec"])
+            ],
+            swiftSettings: [
+                .enableExperimentalFeature("Embedded"),
+                .enableExperimentalFeature("Extern"),
+                .unsafeFlags([
+                    "-wmo", "-disable-cmo",
+                    "-Xfrontend", "-gnone",
+                    "-Xfrontend", "-disable-stack-protector",
+                ]),
+            ],
+            linkerSettings: [
+                .unsafeFlags([
+                    "-Xclang-linker", "-nostdlib",
+                    "-Xlinker", "--no-entry"
+                ])
+            ]
+        ),
+    ]
+)

Examples/README.md

@@ -0,0 +1,13 @@
+# Example of swift-dlmalloc usage
+
+This is a simple example of how to use the `swift-dlmalloc` package.
+
+## Build and run
+
+```console
+$ swift build -c release --triple wasm32-unknown-none-wasm -debug-info-format=none
+$ wasmtime run .build/release/Examples.wasm
+Hello, world!
+malloc(8) = 0x106d0
+*(0x106d0) = 42
+```

Examples/Sources/main.swift

@@ -0,0 +1,35 @@
+import dlmalloc
+
+@_extern(wasm, module: "wasi_snapshot_preview1", name: "fd_write")
+@_extern(c)
+func fd_write(fd: Int32, iovs: UnsafeRawPointer, iovs_len: Int32, nwritten: UnsafeMutablePointer<Int32>) -> Int32
+
+func _print(_ string: String) {
+    var string = string
+    string.withUTF8 { string in
+        withUnsafeTemporaryAllocation(byteCount: 8, alignment: 4) { iov in
+            let iov = iov.baseAddress!
+            iov.advanced(by: 0).storeBytes(of: string.baseAddress!, as: UnsafeRawPointer.self)
+            iov.advanced(by: 4).storeBytes(of: Int32(string.count), as: Int32.self)
+            var nwritten: Int32 = 0
+            _ = fd_write(fd: 1, iovs: iov, iovs_len: 1, nwritten: &nwritten)
+        }
+    }
+}
+
+func hex(_ ptr: UnsafeRawPointer) -> String {
+    return "0x\(String(UInt(bitPattern: ptr), radix: 16))"
+}
+
+@_expose(wasm)
+@_cdecl("_start")
+public func main() {
+    _print("Hello, world!\n")
+
+    let ptr = dlmalloc.malloc(8)!
+    ptr.storeBytes(of: 42, as: Int.self)
+    _print("malloc(8) = \(hex(ptr))\n")
+    _print("*(\(hex(ptr))) = \(ptr.load(as: Int.self))\n")
+
+    dlmalloc.free(ptr)
+}

NOTICE

@@ -0,0 +1,7 @@
+This package includes a modified version of dlmalloc derived from the wasi-libc
+project. The original dlmalloc is licensed under CC0-1.0, and the modifications
+by the wasi-libc project are licensed under the Apache License 2.0 with LLVM
+Exceptions, Apache License 2.0, and MIT License.
+
+The original dlmalloc is available at: ftp://gee.cs.oswego.edu/pub/misc/malloc.c
+The wasi-libc project is available at: https://github.com/WebAssembly/wasi-libc

Package.swift

@@ -0,0 +1,21 @@
+// swift-tools-version: 5.10
+
+import PackageDescription
+
+let package = Package(
+    name: "dlmalloc",
+    products: [
+        .library(
+            name: "dlmalloc",
+            targets: ["dlmalloc"]),
+    ],
+    targets: [
+        .target(
+            name: "dlmalloc",
+            exclude: ["wasm/"],
+            cSettings: [
+                .headerSearchPath("wasm/internal-headers")
+            ]
+        ),
+    ]
+)

Patches/0001-Remove-__wasi__-check-to-allow-building-with-wasm32-.patch

@@ -0,0 +1,28 @@
+From 27226ddab08b358ddbb961dd9564915c89caf6f0 Mon Sep 17 00:00:00 2001
+From: Yuta Saito <[email protected]>
+Date: Tue, 15 Oct 2024 08:28:43 +0900
+Subject: [PATCH] Remove `__wasi__` check to allow building with
+ `wasm32-unknown-unknown` target
+
+---
+ Sources/dlmalloc/wasm/internal-headers/wasi/api.h | 4 ----
+ 1 file changed, 4 deletions(-)
+
+diff --git a/Sources/dlmalloc/wasm/internal-headers/wasi/api.h b/Sources/dlmalloc/wasm/internal-headers/wasi/api.h
+index 45a6506..6ac9b72 100644
+--- a/Sources/dlmalloc/wasm/internal-headers/wasi/api.h
++++ b/Sources/dlmalloc/wasm/internal-headers/wasi/api.h
+@@ -19,10 +19,6 @@
+ #ifndef __wasi_api_h
+ #define __wasi_api_h
+ 
+-#ifndef __wasi__
+-#error <wasi/api.h> is only supported on WASI platforms.
+-#endif
+-
+ #ifndef __wasm32__
+ #error <wasi/api.h> only supports wasm32; doesn't yet support wasm64
+ #endif
+-- 
+2.39.3 (Apple Git-146)
+

Patches/0002-Remove-bits-alltypes.h-include.patch

@@ -0,0 +1,29 @@
+From c09abe907526966f4e679559d229d556e4e71dbe Mon Sep 17 00:00:00 2001
+From: Yuta Saito <[email protected]>
+Date: Tue, 15 Oct 2024 08:38:39 +0900
+Subject: [PATCH] Remove `<bits/alltypes.h>` include
+
+To allow building dlmalloc outside of the wasi-libc source tree, remove
+the include of `<bits/alltypes.h>` and replace it with `<stddef.h>`.
+---
+ Sources/dlmalloc/wasm/internal-headers/malloc.h | 4 +---
+ 1 file changed, 1 insertion(+), 3 deletions(-)
+
+diff --git a/Sources/dlmalloc/wasm/internal-headers/malloc.h b/Sources/dlmalloc/wasm/internal-headers/malloc.h
+index bc17b10..79d3a2e 100644
+--- a/Sources/dlmalloc/wasm/internal-headers/malloc.h
++++ b/Sources/dlmalloc/wasm/internal-headers/malloc.h
+@@ -9,9 +9,7 @@
+ extern "C" {
+ #endif
+ 
+-#define __NEED_size_t
+-
+-#include <bits/alltypes.h>
++#include <stddef.h>
+ 
+ #ifdef __wasilibc_unmodified_upstream /* Use alternate WASI libc headers */
+ void *malloc (size_t);
+-- 
+2.39.3 (Apple Git-146)
+

Patches/0003-Remove-extern-errno-values.patch

@@ -0,0 +1,32 @@
+From a3eec3642bbd31610ad52c35b3725e4e832ede10 Mon Sep 17 00:00:00 2001
+From: Yuta Saito <[email protected]>
+Date: Tue, 15 Oct 2024 08:59:13 +0900
+Subject: [PATCH] Remove extern errno values
+
+They increase the size of the data segment, and are not needed since we
+have errno.h in this build setup.
+---
+ Sources/dlmalloc/wasm/dlmalloc.c | 7 -------
+ 1 file changed, 7 deletions(-)
+
+diff --git a/Sources/dlmalloc/wasm/dlmalloc.c b/Sources/dlmalloc/wasm/dlmalloc.c
+index 331536b..c443d67 100644
+--- a/Sources/dlmalloc/wasm/dlmalloc.c
++++ b/Sources/dlmalloc/wasm/dlmalloc.c
+@@ -30,13 +30,6 @@
+ // Align malloc regions to 16, to avoid unaligned SIMD accesses.
+ #define MALLOC_ALIGNMENT 16
+ 
+-// Declare errno values used by dlmalloc. We define them like this to avoid
+-// putting specific errno values in the ABI.
+-extern const int __ENOMEM;
+-#define ENOMEM __ENOMEM
+-extern const int __EINVAL;
+-#define EINVAL __EINVAL
+-
+ // Define USE_DL_PREFIX so that we leave dlmalloc's names prefixed with 'dl'.
+ // We define them as "static", and we wrap them with public names below. This
+ // serves two purposes:
+-- 
+2.39.3 (Apple Git-146)
+

Patches/0004-Remove-redundant-include-of-string.h-in-memset.c.patch

@@ -0,0 +1,44 @@
+From 8cc8e199ea6f2b9282f45b0c26e64295f5c9ec03 Mon Sep 17 00:00:00 2001
+From: Yuta Saito <[email protected]>
+Date: Tue, 15 Oct 2024 09:45:00 +0900
+Subject: [PATCH] Remove redundant include of string.h in memset.c
+
+string.h is not included in this build setup
+---
+ Sources/dlmalloc/wasm/memcpy.c  | 2 --
+ Sources/dlmalloc/wasm/memmove.c | 1 -
+ Sources/dlmalloc/wasm/memset.c  | 1 -
+ 3 file changed, 4 deletion(-)
+
+diff --git a/Sources/dlmalloc/wasm/memset.c b/Sources/dlmalloc/wasm/memset.c
+index f64c9cf..711717a 100644
+--- a/Sources/dlmalloc/wasm/memset.c
++++ b/Sources/dlmalloc/wasm/memset.c
+@@ -1,4 +1,3 @@
+-#include <string.h>
+ #include <stdint.h>
+ 
+ void *memset(void *dest, int c, size_t n)
+diff --git a/Sources/dlmalloc/wasm/memcpy.c b/Sources/dlmalloc/wasm/memcpy.c
+index 3cc7e28..0422eeb 100644
+--- a/Sources/dlmalloc/wasm/memcpy.c
++++ b/Sources/dlmalloc/wasm/memcpy.c
+@@ -1,6 +1,4 @@
+-#include <string.h>
+ #include <stdint.h>
+-#include <endian.h>
+
+ void *memcpy(void *restrict dest, const void *restrict src, size_t n)
+ {
+diff --git a/Sources/dlmalloc/wasm/memmove.c b/Sources/dlmalloc/wasm/memmove.c
+index 7376a52..74913a4 100644
+--- a/Sources/dlmalloc/wasm/memmove.c
++++ b/Sources/dlmalloc/wasm/memmove.c
+@@ -1,4 +1,3 @@
+-#include <string.h>
+ #include <stdint.h>
+
+ #ifdef __GNUC__
+--
+2.39.3 (Apple Git-146)
+

README.md

@@ -0,0 +1,58 @@
+# swift-dlmalloc
+
+This is a SwiftPM package for [dlmalloc](https://gee.cs.oswego.edu/dl/html/malloc.html) which is a general-purpose memory allocator written by Doug Lea.
+Typically, this package is helpful when you need a memory allocator implementation for Embedded Swift applications.
+
+## Supported Platforms
+
+| Target triplet | Supported |
+|----------------|:---------:|
+| wasm32-unknown-none-wasm | ✅ |
+
+Feel free to create a PR to add support for other platforms.
+
+## Usage
+
+Add the following dependency to your `Package.swift` file:
+
+```swift
+dependencies: [
+    .package(url: "https://github.com/swiftwasm/swift-dlmalloc", from: "0.1.0"),
+]
+```
+
+Then, add `dlmalloc` as a dependency for your target:
+
+```swift
+.executableTarget(
+    name: "Examples",
+    dependencies: [
+        .product(name: "dlmalloc", package: "swift-dlmalloc"),
+    ]
+)
+```
+
+Finally, import `dlmalloc` module in your Swift code:
+
+```swift
+
+import dlmalloc
+
+public func main() {
+    let ptr = dlmalloc.malloc(8)!
+    ptr.storeBytes(of: 42, as: Int.self)
+    print("malloc(8) = \(ptr)\n")
+    print("*(\(ptr)) = \(ptr.load(as: Int.self))\n")
+
+    dlmalloc.free(ptr)
+}
+```
+
+See [Examples](Examples) directory for more working examples.
+
+## License
+
+This package is licensed under the MIT license. See [LICENSE](LICENSE) for more info.
+
+Portions of this software are based on the work of Doug Lea and others. See [NOTICE](NOTICE) for more info.
+

Sources/dlmalloc/dlmalloc.c

@@ -0,0 +1,16 @@
+#if __wasm__
+#  define LACKS_STRING_H
+#  include <stddef.h>
+void *memcpy (void *__restrict, const void *__restrict, size_t);
+void *memset (void *, int, size_t);
+void abort(void);
+_Thread_local int errno = 0;
+#  include "./wasm/dlmalloc.c"
+#  include "./wasm/sbrk.c"
+#  include "./wasm/memcpy.c"
+#  include "./wasm/memset.c"
+#  include "./wasm/memmove.c"
+#  include "./wasm/abort.c"
+#else
+#  error "Unsupported target platform. Contribution for porting to the platform is more than welcome!"
+#endif

Sources/dlmalloc/include/module.modulemap

@@ -0,0 +1,3 @@
+module dlmalloc {
+  header "swift_dlmalloc.h"
+}

Sources/dlmalloc/include/swift_dlmalloc.h

@@ -0,0 +1,11 @@
+#ifndef SWIFT_DLMALLOC_H
+#define SWIFT_DLMALLOC_H
+
+#include <stddef.h>
+
+void *malloc (size_t);
+void *calloc (size_t, size_t);
+void *realloc (void *, size_t);
+void free (void *);
+
+#endif // SWIFT_DLMALLOC_H

Sources/dlmalloc/wasm/abort.c

@@ -0,0 +1,6 @@
+#include <stdlib.h>
+
+void abort(void) {
+    // wasm doesn't support signals, so just trap to halt the program.
+    __builtin_trap();
+}