beam.com 0.1.0-rc.1

package/runtime/licenses/wamr.txt

@@ -0,0 +1,219 @@
+                                 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.
+
+
+--- LLVM Exceptions to the Apache 2.0 License ----
+
+As an exception, if, as a result of your compiling your source code, portions
+of this Software are embedded into an Object form of such source code, you
+may redistribute such embedded portions in such Object form without complying
+with the conditions of Sections 4(a), 4(b) and 4(d) of the License.
+
+In addition, if you combine or link compiled forms of this Software with
+software that is licensed under the GPLv2 ("Combined Software") and if a
+court of competent jurisdiction determines that the patent provision (Section
+3), the indemnity provision (Section 9) or other Section of the License
+conflicts with the conditions of the GPLv2, you may retroactively and
+prospectively choose to deem waived or otherwise exclude such Section(s) of
+the License, but only in their entirety and only with respect to the Combined
+Software.
+

package/runtime/nifs.js

@@ -0,0 +1,2 @@
+// No NIF libraries of an app: the host compiles them at run time.
+export default null;

package/runtime/package.json

@@ -0,0 +1 @@
+{ "type": "module" }

package/runtime/page/404.html

@@ -0,0 +1,49 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<title>Page not found</title>
+<!-- GitHub Pages gives this page for a path with no file. A path of the app
+     (SITE/app/PATH, for example a link to a page of the app before the first
+     visit) goes to the page of the site, with the path in the fragment
+     (SITE#/PATH). This page does not know the base path of the site, and a
+     repository can have the name "app" (/app/app/users). So it tries each
+     prefix of the path before a segment "app/", the longest first, and uses
+     the prefix where sw.js exists. -->
+<style>
+  :root { --bg: #f6f4f1; --text: #1f1a17; --muted: #756c65; }
+  @media (prefers-color-scheme: dark) {
+    :root:not([data-theme="light"]) { --bg: #171412; --text: #efe9e4; --muted: #a2978f; }
+  }
+  :root[data-theme="dark"] { --bg: #171412; --text: #efe9e4; --muted: #a2978f; }
+  body { background: var(--bg); color: var(--text); font: 15px/1.5 system-ui, -apple-system, "Segoe UI", sans-serif; margin: 0; }
+  main { max-width: 40rem; margin: 0 auto; padding: 15vh 16px 0; }
+  p { color: var(--muted); }
+</style>
+</head>
+<body>
+<main id="missing" hidden>
+  <h1>404</h1>
+  <p>This page does not exist.</p>
+</main>
+<script>
+  (async () => {
+    const path = location.pathname;
+    const bases = [];
+    for (let i = path.indexOf('/app/'); i !== -1; i = path.indexOf('/app/', i + 1)) bases.push(path.slice(0, i + 1));
+    for (const base of bases.reverse()) {
+      try {
+        const r = await fetch(`${base}sw.js`, { method: 'HEAD', cache: 'no-store' });
+        if (r.ok) {
+          const rest = path.slice(base.length + 'app'.length) + location.search + location.hash;
+          location.replace(rest === '/' ? base : `${base}#${rest}`);
+          return;
+        }
+      } catch {}
+    }
+    document.getElementById('missing').hidden = false;
+  })();
+</script>
+</body>
+</html>

package/runtime/page/app-com.js

@@ -0,0 +1,203 @@
+// The release of a native app.com for the WebAssembly runtime: the same
+// file that runs natively runs in the VM of worker.js (Workers, Deno, a
+// web page). "beam.com INPUT -o app.com" writes the edge part of the file
+// into its zip, under .wasm/ (beam_com_wasm:overlay/4): .release.json
+// (the boot of the VM, and the runtime of the build), the application
+// wasm_host, the boot script with wasm_host, and the modules in the place
+// of NIFs.
+//
+// appRelease(read, size, { runtime }) gives the release as release.bin
+// gives it (an ArrayBuffer, see unpack in worker.js): the files of lib/
+// and releases/ of the zip, with the files of .wasm/ in their place, and
+// .release.json first.
+// - read(at, n): n bytes (a Uint8Array) at the offset at of app.com: a
+//   file, a range of a URL, or bytes in memory (bytesReader).
+// - size: the size of app.com in bytes.
+// - runtime: the identity of this runtime (the text of runtime-id.js of
+//   DIR, beam_com_wasm:runtime_id/1). With it, a file for another runtime
+//   is an error.
+// It reads three parts: the end of the file, the central directory, and
+// the span of the release (the edge part is at the end of it).
+//
+// appFiles(read, size, { runtime }) gives the same files with no copy:
+// {meta, files, byteLength, buffers, statics}, which worker.js takes in
+// the place of release.bin.
+// - files: [path, bytes] for each file of the release. A stored entry is a
+//   view of the bytes that read gives (with bytesReader, of app.com).
+// - buffers: the ArrayBuffers of these bytes. A file of the VM in another
+//   buffer is a file that the boot wrote (the snapshot keeps it).
+// - statics: the static files of a Phoenix app (lib/NAME-VSN/priv/static,
+//   NAME the name of the release), a Map of path to {data, size, crc, deflated}, which
+//   the host serves before the VM (worker.js). They are not in files,
+//   except cache_manifest.json, which Phoenix reads at its start.
+//
+// The zip of beam.com stores each .beam file as a gzip file (the loader of
+// ERTS reads it so, beam_com_zip), so it is a view too. A deflated .beam
+// entry (an older app.com) becomes a gzip file with the same data, with
+// no inflate. Each other entry is checked with its CRC-32.
+
+const text = new TextDecoder();
+const u16 = (b, i) => b[i] | (b[i + 1] << 8);
+const u32 = (b, i) => (b[i] | (b[i + 1] << 8) | (b[i + 2] << 16) | (b[i + 3] << 24)) >>> 0;
+const fail = (message) => { throw new Error(`app.com: ${message}`); };
+
+const LOCAL = 0x04034b50, CENTRAL = 0x02014b50, END = 0x06054b50;
+const STORED = 0, DEFLATED = 8;
+// The end record (22 bytes) and a comment of at most 65535 bytes.
+const TAIL = 22 + 0xffff;
+
+const CRC = new Uint32Array(256).map((_, n) => {
+  let c = n;
+  for (let k = 0; k < 8; k++) c = c & 1 ? 0xedb88320 ^ (c >>> 1) : c >>> 1;
+  return c >>> 0;
+});
+
+export function crc32(b) {
+  let c = 0xffffffff;
+  for (let i = 0; i < b.length; i++) c = CRC[(c ^ b[i]) & 0xff] ^ (c >>> 8);
+  return (c ^ 0xffffffff) >>> 0;
+}
+
+// A reader of bytes in memory (an ArrayBuffer or a typed array).
+export function bytesReader(bytes) {
+  const b = bytes instanceof Uint8Array ? bytes : new Uint8Array(bytes.buffer ?? bytes, bytes.byteOffset ?? 0, bytes.byteLength);
+  return { size: b.length, read: async (at, n) => b.subarray(at, at + n) };
+}
+
+// The central directory: {entries, cdAt}, where each entry is {name,
+// method, crc, csize, size, offset}.
+export async function zipEntries(read, size) {
+  const n = Math.min(size, TAIL);
+  const tail = await read(size - n, n);
+  if (tail.length !== n) fail('a short read at the end of the file');
+  // The last end record whose comment ends the file.
+  let e = -1;
+  for (let i = n - 22; i >= 0; i--) {
+    if (u32(tail, i) === END && i + 22 + u16(tail, i + 20) === n) { e = i; break; }
+  }
+  if (e < 0) fail('not a zip file (no end of central directory)');
+  const count = u16(tail, e + 10), cdSize = u32(tail, e + 12), cdAt = u32(tail, e + 16);
+  if (count === 0xffff || cdAt === 0xffffffff || cdSize === 0xffffffff) fail('a zip64 file is not supported');
+  if (cdAt + cdSize > size) fail('the central directory is outside the file');
+  const cd = await read(cdAt, cdSize);
+  const entries = [];
+  for (let i = 0, k = 0; k < count; k++) {
+    if (i + 46 > cd.length || u32(cd, i) !== CENTRAL) fail('a bad central directory');
+    const nlen = u16(cd, i + 28), xlen = u16(cd, i + 30), clen = u16(cd, i + 32);
+    entries.push({
+      name: text.decode(cd.subarray(i + 46, i + 46 + nlen)), method: u16(cd, i + 10),
+      crc: u32(cd, i + 16), csize: u32(cd, i + 20), size: u32(cd, i + 24), offset: u32(cd, i + 42),
+    });
+    i += 46 + nlen + xlen + clen;
+  }
+  return { entries, cdAt };
+}
+
+async function inflate(raw) {
+  const s = new Blob([raw]).stream().pipeThrough(new DecompressionStream('deflate-raw'));
+  return new Uint8Array(await new Response(s).arrayBuffer());
+}
+
+// The same deflate data in a gzip file: a header of 10 bytes, the data,
+// the CRC-32 and the size.
+function gzipOf(raw, e) {
+  const out = new Uint8Array(10 + raw.length + 8);
+  out.set([0x1f, 0x8b, 8, 0, 0, 0, 0, 0, 0, 255]);
+  out.set(raw, 10);
+  const v = new DataView(out.buffer);
+  v.setUint32(10 + raw.length, e.crc, true);
+  v.setUint32(14 + raw.length, e.size, true);
+  return out;
+}
+
+// The data of the entry e, in span (the bytes of the file from offset base).
+async function entryData(span, base, e) {
+  const h = e.offset - base;
+  if (h < 0 || h + 30 > span.length || u32(span, h) !== LOCAL) fail(`${e.name}: no local header`);
+  const start = h + 30 + u16(span, h + 26) + u16(span, h + 28);
+  if (start + e.csize > span.length) fail(`${e.name}: the data is outside the file`);
+  const raw = span.subarray(start, start + e.csize);
+  if (e.method === DEFLATED && e.name.endsWith('.beam')) return gzipOf(raw, e);
+  let d;
+  if (e.method === STORED) d = raw;
+  else if (e.method === DEFLATED) d = await inflate(raw);
+  else fail(`${e.name}: the compression method ${e.method} is not supported`);
+  if (d.length !== e.size || crc32(d) !== e.crc) fail(`${e.name}: the CRC-32 does not match`);
+  return d;
+}
+
+const EDGE = '.wasm/';
+const inRelease = (name) => name.startsWith('lib/') || name.startsWith('releases/') || name.startsWith(EDGE);
+
+export async function appRelease(read, size, options = {}) {
+  const { meta, files } = await appFiles(read, size, { ...options, statics: false });
+  return pack(meta, files);
+}
+
+export async function appFiles(read, size, { runtime, statics: split = true } = {}) {
+  const { entries, cdAt } = await zipEntries(read, size);
+  const want = entries.filter((e) => inRelease(e.name) && !e.name.endsWith('/'));
+  const json = want.find((e) => e.name === `${EDGE}.release.json`);
+  if (!json) fail('no edge part (.wasm/.release.json): build it with a beam.com that has the WebAssembly runtime, and without --no-edge');
+  // One read: the entries of the release, up to the central directory.
+  const lo = Math.min(...want.map((e) => e.offset));
+  const span = await read(lo, cdAt - lo);
+  if (span.length !== cdAt - lo) fail('a short read of the release');
+  const meta = await entryData(span, lo, json);
+  const release = JSON.parse(text.decode(meta));
+  if (runtime && release.runtime !== runtime) {
+    fail(`it was built for the runtime ${String(release.runtime).slice(0, 12)}, and this runtime is ${runtime.slice(0, 12)}: `
+         + 'use the runtime of the beam.com that built it');
+  }
+  // The static files of a Phoenix app (PHX_SERVER in the environment of
+  // the release): lib/NAME-VSN/priv/static/, for the application with the
+  // name of the release. Plug.Static serves them at the root of the site.
+  const app = split && release.env?.PHX_SERVER === 'true' && typeof release.name === 'string'
+    && `lib/${release.name}-`;
+  const prefix = app && want.map((e) => /^lib\/[^/]+\/priv\/static\//.exec(e.name)?.[0])
+    .find((p) => p?.startsWith(app) && /^[0-9]/.test(p.slice(app.length)));
+  const statics = new Map();
+  const files = new Map();
+  for (const e of want) {
+    if (e.name.startsWith(EDGE)) continue;
+    if (prefix && e.name.startsWith(prefix) && e.name !== `${prefix}cache_manifest.json`) {
+      statics.set(e.name.slice(prefix.length - 1), staticEntry(span, lo, e));
+      continue;
+    }
+    files.set(e.name, await entryData(span, lo, e));
+  }
+  for (const e of want) if (e.name.startsWith(EDGE) && e !== json) files.set(e.name.slice(EDGE.length), await entryData(span, lo, e));
+  const list = [...files];
+  return {
+    meta, files: list, statics,
+    byteLength: list.reduce((n, [, d]) => n + d.length, meta.length),
+    buffers: new Set([meta.buffer, ...list.map(([, d]) => d.buffer)]),
+  };
+}
+
+// A static file: its bytes in the zip (stored or deflated), not checked
+// here (the host checks the CRC-32 when it inflates them).
+function staticEntry(span, base, e) {
+  const h = e.offset - base;
+  if (h < 0 || h + 30 > span.length || u32(span, h) !== LOCAL) fail(`${e.name}: no local header`);
+  const start = h + 30 + u16(span, h + 26) + u16(span, h + 28);
+  if (start + e.csize > span.length) fail(`${e.name}: the data is outside the file`);
+  if (e.method !== STORED && e.method !== DEFLATED) fail(`${e.name}: the compression method ${e.method} is not supported`);
+  return { data: span.subarray(start, start + e.csize), size: e.size, crc: e.crc, deflated: e.method === DEFLATED };
+}
+
+// release.bin: "BEAMFS1\n", then (length, path, length, data) for each
+// file, with .release.json first.
+function pack(meta, files) {
+  const enc = new TextEncoder();
+  const parts = [['.release.json', meta], ...files].map(([p, d]) => [enc.encode(p), d]);
+  const out = new Uint8Array(8 + parts.reduce((s, [p, d]) => s + 8 + p.length + d.length, 0));
+  const v = new DataView(out.buffer);
+  out.set(enc.encode('BEAMFS1\n'));
+  let i = 8;
+  for (const [p, d] of parts) {
+    v.setUint32(i, p.length); out.set(p, i + 4); i += 4 + p.length;
+    v.setUint32(i, d.length); out.set(d, i + 4); i += 4 + d.length;
+  }
+  return out.buffer;
+}