Skip to content

Support outputting wasm as inline base64 #1880

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Support outputting wasm as inline base64 #1880

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a2586a
OutputMode::Bundler.inline
samdenty Nov 26, 2019
b493392
fix
samdenty Nov 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
148 changes: 96 additions & 52 deletions crates/cli-support/src/js/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ use crate::webidl::{AuxValue, Binding};
use crate::webidl::{JsImport, JsImportName, NonstandardWebidlSection, WasmBindgenAux};
use crate::{Bindgen, EncodeInto, OutputMode};
use anyhow::{bail, Context as _, Error};
use base64::encode;
use std::collections::{BTreeMap, BTreeSet, HashMap, HashSet};
use std::fs;
use std::path::{Path, PathBuf};
Expand Down Expand Up @@ -64,6 +65,7 @@ pub struct ExportedClass {
const INITIAL_HEAP_VALUES: &[&str] = &["undefined", "null", "true", "false"];
// Must be kept in sync with `src/lib.rs` of the `wasm-bindgen` crate
const INITIAL_HEAP_OFFSET: usize = 32;
const MODULE_NAME: &str = "wbg";

impl<'a> Context<'a> {
pub fn new(module: &'a mut Module, config: &'a Bindgen) -> Result<Context<'a>, Error> {
Expand Down Expand Up @@ -282,10 +284,16 @@ impl<'a> Context<'a> {
| OutputMode::Node {
experimental_modules: true,
} => {
imports.push_str(&format!(
"import * as wasm from './{}_bg.wasm';\n",
module_name
));
if let OutputMode::Bundler { inline: true, .. } = &self.config.mode {
let wasm = self.gen_base64(Some(&mut imports))?;
js.push_str(&wasm);
} else {
imports.push_str(&format!(
"import * as wasm from './{}_bg.wasm';\n",
module_name
));
}

for (id, js) in sorted_iter(&self.wasm_import_definitions) {
let import = self.module.imports.get_mut(*id);
import.module = format!("./{}.js", module_name);
Expand Down Expand Up @@ -432,63 +440,20 @@ impl<'a> Context<'a> {
)
}

fn gen_init(
&mut self,
needs_manual_start: bool,
mut imports: Option<&mut String>,
) -> Result<(String, String), Error> {
let module_name = "wbg";
let mem = self.module.memories.get(self.memory);
let (init_memory1, init_memory2) = if let Some(id) = mem.import {
self.module.imports.get_mut(id).module = module_name.to_string();
let mut memory = String::from("new WebAssembly.Memory({");
memory.push_str(&format!("initial:{}", mem.initial));
if let Some(max) = mem.maximum {
memory.push_str(&format!(",maximum:{}", max));
}
if mem.shared {
memory.push_str(",shared:true");
}
memory.push_str("})");
self.imports_post.push_str("let memory;\n");
(
format!("memory = imports.{}.memory = maybe_memory;", module_name),
format!("memory = imports.{}.memory = {};", module_name, memory),
)
} else {
(String::new(), String::new())
};
let init_memory_arg = if mem.import.is_some() {
", maybe_memory"
} else {
""
};

let default_module_path = match self.config.mode {
OutputMode::Web => {
"\
if (typeof module === 'undefined') {
module = import.meta.url.replace(/\\.js$/, '_bg.wasm');
}"
}
_ => "",
};

let ts = Self::ts_for_init_fn(mem.import.is_some(), !default_module_path.is_empty());

fn gen_imports_init(&mut self, mut imports: Option<&mut String>) -> Result<String, Error> {
// Initialize the `imports` object for all import definitions that we're
// directed to wire up.
let mut imports_init = String::new();
if self.wasm_import_definitions.len() > 0 {
imports_init.push_str("imports.");
imports_init.push_str(module_name);
imports_init.push_str(MODULE_NAME);
imports_init.push_str(" = {};\n");
}
for (id, js) in sorted_iter(&self.wasm_import_definitions) {
let import = self.module.imports.get_mut(*id);
import.module = module_name.to_string();
import.module = MODULE_NAME.to_string();
imports_init.push_str("imports.");
imports_init.push_str(module_name);
imports_init.push_str(MODULE_NAME);
imports_init.push_str(".");
imports_init.push_str(&import.name);
imports_init.push_str(" = ");
Expand Down Expand Up @@ -523,12 +488,91 @@ impl<'a> Context<'a> {
imports_init.push_str(&format!("imports['{}'] = __wbg_star{};\n", extra, i));
}

let js = format!("const imports = {{}};\n{}", imports_init);

Ok(js)
}

fn gen_base64(&mut self, imports: Option<&mut String>) -> Result<String, Error> {
let imports_init = self.gen_imports_init(imports)?;

let wasm_bytes = self.module.emit_wasm();
let wasm_base64 = encode(&wasm_bytes);

let js = format!(
"\
const wasm = (() => {{
{imports_init}

const raw = atob('{wasm_base64}');
const rawLength = raw.length;
const buf = new Uint8Array(new ArrayBuffer(rawLength));
for(let i = 0; i < rawLength; i++) {{
buf[i] = raw.charCodeAt(i);
}}

const mod = new WebAssembly.Module(buf);
const instance = new WebAssembly.Instance(mod, imports)
return instance.exports
}})()
",
wasm_base64 = wasm_base64,
imports_init = imports_init
);

Ok(js)
}

fn gen_init(
&mut self,
needs_manual_start: bool,
imports: Option<&mut String>,
) -> Result<(String, String), Error> {
let mem = self.module.memories.get(self.memory);
let (init_memory1, init_memory2) = if let Some(id) = mem.import {
self.module.imports.get_mut(id).module = MODULE_NAME.to_string();
let mut memory = String::from("new WebAssembly.Memory({");
memory.push_str(&format!("initial:{}", mem.initial));
if let Some(max) = mem.maximum {
memory.push_str(&format!(",maximum:{}", max));
}
if mem.shared {
memory.push_str(",shared:true");
}
memory.push_str("})");
self.imports_post.push_str("let memory;\n");
(
format!("memory = imports.{}.memory = maybe_memory;", MODULE_NAME),
format!("memory = imports.{}.memory = {};", MODULE_NAME, memory),
)
} else {
(String::new(), String::new())
};
let init_memory_arg = if mem.import.is_some() {
", maybe_memory"
} else {
""
};

let default_module_path = match self.config.mode {
OutputMode::Web => {
"\
if (typeof module === 'undefined') {
module = import.meta.url.replace(/\\.js$/, '_bg.wasm');
}"
}
_ => "",
};

let ts = Self::ts_for_init_fn(mem.import.is_some(), !default_module_path.is_empty());

let imports_init = self.gen_imports_init(imports)?;

let js = format!(
"\
function init(module{init_memory_arg}) {{
{default_module_path}
let result;
const imports = {{}};
{imports_init}
if ((typeof URL === 'function' && module instanceof URL) || typeof module === 'string' || (typeof Request === 'function' && module instanceof Request)) {{
{init_memory2}
Expand Down
18 changes: 15 additions & 3 deletions crates/cli-support/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ pub struct Output {

#[derive(Clone)]
enum OutputMode {
Bundler { browser_only: bool },
Bundler { browser_only: bool, inline: bool },
Web,
NoModules { global: String },
Node { experimental_modules: bool },
Expand Down Expand Up @@ -85,6 +85,7 @@ impl Bindgen {
out_name: None,
mode: OutputMode::Bundler {
browser_only: false,
inline: false,
},
debug: false,
typescript: false,
Expand Down Expand Up @@ -154,10 +155,21 @@ impl Bindgen {
Ok(self)
}

pub fn inline(&mut self, inline: bool) -> Result<&mut Bindgen, Error> {
if inline {
match &mut self.mode {
OutputMode::Bundler { inline, .. } => *inline = true,
_ => bail!("cannot specify `--inline` with other output types"),
}
}
Ok(self)
}

pub fn bundler(&mut self, bundler: bool) -> Result<&mut Bindgen, Error> {
if bundler {
self.switch_mode(
OutputMode::Bundler {
inline: false,
browser_only: false,
},
"--target bundler",
Expand Down Expand Up @@ -188,7 +200,7 @@ impl Bindgen {
pub fn browser(&mut self, browser: bool) -> Result<&mut Bindgen, Error> {
if browser {
match &mut self.mode {
OutputMode::Bundler { browser_only } => *browser_only = true,
OutputMode::Bundler { browser_only, .. } => *browser_only = true,
_ => bail!("cannot specify `--browser` with other output types"),
}
}
Expand Down Expand Up @@ -517,7 +529,7 @@ impl OutputMode {
match self {
OutputMode::Web => true,
OutputMode::NoModules { .. } => true,
OutputMode::Bundler { browser_only } => *browser_only,
OutputMode::Bundler { browser_only, .. } => *browser_only,
_ => false,
}
}
Expand Down