diff --git a/packages/simd/.npmignore b/packages/simd/.npmignore new file mode 100644 index 0000000000..2f617619f1 --- /dev/null +++ b/packages/simd/.npmignore @@ -0,0 +1,19 @@ +.cache +.meta +.nyc_output +*.gz +*.html +*.svg +*.tgz +*.h +*.o +*.wat +!*.wasm +build +coverage +dev +doc +export +src* +test +tsconfig.json diff --git a/packages/simd/LICENSE b/packages/simd/LICENSE new file mode 100644 index 0000000000..8dada3edaf --- /dev/null +++ b/packages/simd/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/simd/README.md b/packages/simd/README.md new file mode 100644 index 0000000000..3f9552b6c0 --- /dev/null +++ b/packages/simd/README.md @@ -0,0 +1,40 @@ +# @thi.ng/simd + +[![npm (scoped)](https://img.shields.io/npm/v/@thi.ng/simd.svg)](https://www.npmjs.com/package/@thi.ng/simd) +![npm downloads](https://img.shields.io/npm/dm/@thi.ng/simd.svg) +[![Twitter Follow](https://img.shields.io/twitter/follow/thing_umbrella.svg?style=flat-square&label=twitter)](https://twitter.com/thing_umbrella) + +This project is part of the +[@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo. + + + + + +## About + +TODO... + +## Installation + +```bash +yarn add @thi.ng/simd +``` + +## Dependencies + +- TODO... + +## Usage examples + +```ts +import * as s from "@thi.ng/simd"; +``` + +## Authors + +- Karsten Schmidt + +## License + +© 2019 Karsten Schmidt // Apache Software License 2.0 diff --git a/packages/simd/assembly/dot.ts b/packages/simd/assembly/dot.ts new file mode 100644 index 0000000000..7f0f5e78c7 --- /dev/null +++ b/packages/simd/assembly/dot.ts @@ -0,0 +1,38 @@ +/** + * f32x4 dot product. `so` should be 1 for packed result buffer. + * + * @param out + * @param a + * @param b + * @param num + * @param so + * @param sa + * @param sb + */ +export function dot4( + out: usize, + a: usize, + b: usize, + num: usize, + so: usize, + sa: usize, + sb: usize +): usize { + const res = out; + so <<= 2; + sa <<= 2; + sb <<= 2; + // a1*b1 + a2*b2 + a3*b3 + a4*b4 + for (; num-- > 0; ) { + let m = v128.mul(v128.load(a), v128.load(b)); + m = v128.add(m, v128.shuffle(m, m, 2, 3, 0, 1)); + store( + out, + v128.extract_lane(m, 0) + v128.extract_lane(m, 1) + ); + out += so; + a += sa; + b += sb; + } + return res; +} diff --git a/packages/simd/assembly/index.ts b/packages/simd/assembly/index.ts new file mode 100644 index 0000000000..c904f454ce --- /dev/null +++ b/packages/simd/assembly/index.ts @@ -0,0 +1,3 @@ +export * from "./dot"; +export * from "./madd"; +export * from "./maddn"; diff --git a/packages/simd/assembly/madd.ts b/packages/simd/assembly/madd.ts new file mode 100644 index 0000000000..565af7678b --- /dev/null +++ b/packages/simd/assembly/madd.ts @@ -0,0 +1,48 @@ +/** + * f32x4 multiply-add: out = a * b + c. + * + * `num` and all strides must by multiples of 4. + * All pointers must be aligned to multiples of 16. + * Returns `out` pointer. + * + * @param out + * @param a + * @param b + * @param c + * @param num number of 4D vectors + * @param so out element stride + * @param sa + * @param sb + * @param sc + */ +export function madd4( + out: usize, + a: usize, + b: usize, + c: usize, + num: usize, + so: usize, + sa: usize, + sb: usize, + sc: usize +): usize { + const res = out; + so <<= 2; + sa <<= 2; + sb <<= 2; + sc <<= 2; + for (; num-- > 0; ) { + v128.store( + out, + v128.add( + v128.mul(v128.load(a), v128.load(b)), + v128.load(c) + ) + ); + out += so; + a += sa; + b += sb; + c += sc; + } + return res; +} diff --git a/packages/simd/assembly/maddn.ts b/packages/simd/assembly/maddn.ts new file mode 100644 index 0000000000..ae797e0866 --- /dev/null +++ b/packages/simd/assembly/maddn.ts @@ -0,0 +1,26 @@ +export function maddN4( + out: usize, + a: usize, + b: f32, + c: usize, + num: usize, + so: usize, + sa: usize, + sc: usize +): usize { + const res = out; + so <<= 2; + sa <<= 2; + sc <<= 2; + const vb = v128.splat(b); + for (; num-- > 0; ) { + v128.store( + out, + v128.add(v128.mul(v128.load(a), vb), v128.load(c)) + ); + out += so; + a += sa; + c += sc; + } + return res; +} diff --git a/packages/simd/assembly/tsconfig.json b/packages/simd/assembly/tsconfig.json new file mode 100644 index 0000000000..20ee7a2111 --- /dev/null +++ b/packages/simd/assembly/tsconfig.json @@ -0,0 +1,6 @@ +{ + "extends": "../../../node_modules/assemblyscript/std/assembly.json", + "include": [ + "./**/*.ts" + ] +} \ No newline at end of file diff --git a/packages/simd/package.json b/packages/simd/package.json new file mode 100644 index 0000000000..d272e3ef1c --- /dev/null +++ b/packages/simd/package.json @@ -0,0 +1,48 @@ +{ + "name": "@thi.ng/simd", + "version": "0.0.1", + "description": "TODO", + "module": "./index.js", + "main": "./lib/index.js", + "umd:main": "./lib/index.umd.js", + "typings": "./index.d.ts", + "repository": { + "type": "git", + "url": "https://github.com/thi-ng/umbrella.git" + }, + "homepage": "https://github.com/thi-ng/umbrella/tree/master/packages/simd", + "author": "Karsten Schmidt ", + "license": "Apache-2.0", + "scripts": { + "build": "yarn clean && yarn build:wasm && yarn build:es6 && node ../../scripts/bundle-module", + "build:release": "yarn clean && yarn build:wasm && yarn build:es6 && node ../../scripts/bundle-module all", + "build:es6": "tsc --declaration", + "build:test": "rimraf build && tsc -p test/tsconfig.json", + "build:wasm": "asc assembly/index.ts -b simd.wasm -t simd.wat --validate --optimize --enable simd --runtime none --importMemory --memoryBase 1024", + "test": "yarn build:test && mocha build/test/*.js", + "cover": "yarn build:test && nyc mocha build/test/*.js && nyc report --reporter=lcov", + "clean": "rimraf *.js *.d.ts .nyc_output build coverage doc lib", + "doc": "node_modules/.bin/typedoc --mode modules --out doc --ignoreCompilerErrors src", + "pub": "yarn build:release && yarn publish --access public" + }, + "devDependencies": { + "@types/mocha": "^5.2.6", + "@types/node": "^12.6.3", + "assemblyscript": "AssemblyScript/assemblyscript", + "mocha": "^6.1.4", + "nyc": "^14.0.0", + "typedoc": "^0.15.0", + "typescript": "^3.6.4" + }, + "dependencies": { + "@thi.ng/api": "^6.4.0" + }, + "keywords": [ + "ES6", + "typescript" + ], + "publishConfig": { + "access": "public" + }, + "sideEffects": false +} \ No newline at end of file diff --git a/packages/simd/src/index.ts b/packages/simd/src/index.ts new file mode 100644 index 0000000000..731c85b5ae --- /dev/null +++ b/packages/simd/src/index.ts @@ -0,0 +1,37 @@ +import { isString } from "@thi.ng/checks"; + +export interface SIMD { + // prettier-ignore + dot4(out: number, a: number, b: number, num: number, so: number, sa: number, sb: number): number; + // prettier-ignore + madd4(out: number, a: number, b: number, c: number, num: number, so: number, sa: number, sb: number, sc: number): number; + // prettier-ignore + maddN4(out: number, a: number, b: number, c: number, num: number, so: number, sa: number, sc: number): number; +} + +export const init = async ( + src: string | Buffer, + memory: WebAssembly.Memory +): Promise => { + let wasm: WebAssembly.Instance; + const imports: any = { + env: { + memory, + abort(_: any, file: any, line: number, column: number) { + console.error(`abort called in ${file}: ${line}:${column}`); + } + } + }; + if (isString(src)) { + wasm = (await (WebAssembly).instantiateStreaming( + fetch(src), + imports + )).instance; + } else { + wasm = await WebAssembly.instantiate( + new WebAssembly.Module(src), + imports + ); + } + return wasm.exports; +}; diff --git a/packages/simd/test/index.ts b/packages/simd/test/index.ts new file mode 100644 index 0000000000..f8083c7acc --- /dev/null +++ b/packages/simd/test/index.ts @@ -0,0 +1,6 @@ +// import * as assert from "assert"; +// import * as s from "../src/index"; + +describe("simd", () => { + it("tests pending"); +}); diff --git a/packages/simd/test/tsconfig.json b/packages/simd/test/tsconfig.json new file mode 100644 index 0000000000..f6e63560dd --- /dev/null +++ b/packages/simd/test/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../../tsconfig.json", + "compilerOptions": { + "outDir": "../build", + "module": "commonjs" + }, + "include": [ + "./**/*.ts", + "../src/**/*.ts" + ] +} diff --git a/packages/simd/tsconfig.json b/packages/simd/tsconfig.json new file mode 100644 index 0000000000..893b9979c5 --- /dev/null +++ b/packages/simd/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../tsconfig.json", + "compilerOptions": { + "outDir": ".", + "module": "es6", + "target": "es6" + }, + "include": [ + "./src/**/*.ts" + ] +} diff --git a/yarn.lock b/yarn.lock index 6808bbb003..b94f61afd8 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1529,6 +1529,11 @@ "@parcel/utils" "^1.11.0" physical-cpu-count "^2.0.0" +"@protobufjs/utf8@^1.1.0": + version "1.1.0" + resolved "https://registry.yarnpkg.com/@protobufjs/utf8/-/utf8-1.1.0.tgz#a777360b5b39a1a2e5106f8e858f2fd2d060c570" + integrity sha1-p3c2C1s5oaLlEG+OhY8v0tBgxXA= + "@types/estree@*": version "0.0.39" resolved "https://registry.yarnpkg.com/@types/estree/-/estree-0.0.39.tgz#e177e699ee1b8c22d23174caaa7422644389509f" @@ -1997,6 +2002,17 @@ asn1@~0.2.3: dependencies: safer-buffer "~2.1.0" +assemblyscript@AssemblyScript/assemblyscript: + version "0.7.0" + resolved "https://codeload.github.com/AssemblyScript/assemblyscript/tar.gz/c7740fe36590679c411e4de1c0865732f8050c03" + dependencies: + "@protobufjs/utf8" "^1.1.0" + binaryen "89.0.0-nightly.20191012" + glob "^7.1.4" + long "^4.0.0" + opencollective-postinstall "^2.0.0" + source-map-support "^0.5.13" + assert-plus@1.0.0, assert-plus@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/assert-plus/-/assert-plus-1.0.0.tgz#f12e0f3c5d77b0b1cdd9146942e4e96c1e4dd525" @@ -2144,6 +2160,11 @@ binary-extensions@^1.0.0: resolved "https://registry.yarnpkg.com/binary-extensions/-/binary-extensions-1.13.1.tgz#598afe54755b2868a5330d2aff9d4ebb53209b65" integrity sha512-Un7MIEDdUC5gNpcGDV97op1Ywk748MpHcFTHoYs6qnj1Z3j7I53VG3nwZhKzoBZmbdRNnb6WRdFlwl7tSDuZGw== +binaryen@89.0.0-nightly.20191012: + version "89.0.0-nightly.20191012" + resolved "https://registry.yarnpkg.com/binaryen/-/binaryen-89.0.0-nightly.20191012.tgz#4079f4399cd3961f876aa1c913c0c9546f1c23f8" + integrity sha512-ipKFZEyrMnFuEPCzEsXZ80DwZhGzrPldQ+vtcyCfdr8O75PKawfll1gmdWg4sUtzjSnfdvK9NiYfzm021lDNUg== + bindings@~1.2.1: version "1.2.1" resolved "https://registry.yarnpkg.com/bindings/-/bindings-1.2.1.tgz#14ad6113812d2d37d72e67b4cacb4bb726505f11" @@ -5416,6 +5437,11 @@ log-symbols@2.2.0, log-symbols@^2.2.0: dependencies: chalk "^2.0.1" +long@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/long/-/long-4.0.0.tgz#9a7b71cfb7d361a194ea555241c92f7468d5bf28" + integrity sha512-XsP+KhQif4bjX1kbuSiySJFNAehNxgLb6hPRGJ9QsUr8ajHkuXGdrHmFUTUUXhDwVX2R5bY4JNZEwbUiMhV+MA== + loose-envify@^1.0.0: version "1.4.0" resolved "https://registry.yarnpkg.com/loose-envify/-/loose-envify-1.4.0.tgz#71ee51fa7be4caec1a63839f7e682d8132d30caf" @@ -6287,6 +6313,11 @@ onetime@^2.0.0: dependencies: mimic-fn "^1.0.0" +opencollective-postinstall@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/opencollective-postinstall/-/opencollective-postinstall-2.0.2.tgz#5657f1bede69b6e33a45939b061eb53d3c6c3a89" + integrity sha512-pVOEP16TrAO2/fjej1IdOyupJY8KDUM1CvsaScRbw6oddvpQoOfGk4ywha0HKKVAD6RkW4x6Q+tNBwhf3Bgpuw== + opn@^5.1.0: version "5.5.0" resolved "https://registry.yarnpkg.com/opn/-/opn-5.5.0.tgz#fc7164fab56d235904c51c3b27da6758ca3b9bfc" @@ -8013,7 +8044,7 @@ source-map-resolve@^0.5.0: source-map-url "^0.4.0" urix "^0.1.0" -source-map-support@~0.5.10, source-map-support@~0.5.12: +source-map-support@^0.5.13, source-map-support@~0.5.10, source-map-support@~0.5.12: version "0.5.13" resolved "https://registry.yarnpkg.com/source-map-support/-/source-map-support-0.5.13.tgz#31b24a9c2e73c2de85066c0feb7d44767ed52932" integrity sha512-SHSKFHadjVA5oR4PPqhtAVdcBWwRYVd6g6cAXnIbRiIwc2EhPrTuKUBdSLvlEKyIP3GCf89fltvcZiP9MMFA1w==