wasm-opt 0.116.1

wasm-opt bindings
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
use strum::IntoEnumIterator;
use wasm_opt::base::*;

use std::fs::{self, File};
use std::io::BufWriter;
use std::io::Write;
use tempfile::Builder;

static WAT_FILE: &[u8] = include_bytes!("hello_world.wat");
static WASM_FILE: &[u8] = include_bytes!("hello_world.wasm");
static GARBAGE_FILE: &[u8] = include_bytes!("garbage_file.wat");
static MULTISIG_WASM: &[u8] = include_bytes!("ink_example_multisig.wasm");

#[test]
#[ignore]
fn read_write_from_unicode_works() -> anyhow::Result<()> {
    let temp_dir = Builder::new().prefix("unicode-α℗$∞ℳ-").tempdir()?;
    let path = temp_dir.path().join("hello_world.wasm");

    let temp_file = File::create(&path)?;
    let mut buf_writer = BufWriter::new(&temp_file);
    buf_writer.write_all(WASM_FILE)?;

    let mut m = Module::new();
    let mut reader = ModuleReader::new();
    reader.read_binary(&path, &mut m, None)?;

    let mut writer = ModuleWriter::new();
    let new_file = temp_dir.path().join("hello_world_by_module_writer.wasm");
    writer.write_binary(&mut m, &new_file)?;

    let mut another_m = Module::new();
    let mut another_reader = ModuleReader::new();
    another_reader.read_binary(&new_file, &mut another_m, None)?;

    let mut another_writer = ModuleWriter::new();
    let another_new_file = temp_dir
        .path()
        .join("hello_world_by_another_module_writer.wasm");
    another_writer.write_binary(&mut another_m, &another_new_file)?;

    let new_file_reader = fs::read(&new_file)?;
    let another_new_file_reader = fs::read(&another_new_file)?;

    assert_eq!(new_file_reader, another_new_file_reader);

    Ok(())
}

#[test]
fn read_write_text_works() -> anyhow::Result<()> {
    let temp_dir = Builder::new().prefix("wasm_opt_tests").tempdir()?;
    let path = temp_dir.path().join("hello_world.wat");

    let temp_file = File::create(&path)?;
    let mut buf_writer = BufWriter::new(&temp_file);
    buf_writer.write_all(WAT_FILE)?;

    let mut m = Module::new();
    let mut reader = ModuleReader::new();
    reader.read_text(&path, &mut m)?;

    let mut writer = ModuleWriter::new();
    let new_file = temp_dir.path().join("hello_world_by_module_writer.wat");
    writer.write_text(&mut m, &new_file)?;

    let mut another_m = Module::new();
    let mut another_reader = ModuleReader::new();
    another_reader.read_text(&new_file, &mut another_m)?;

    let mut another_writer = ModuleWriter::new();
    let another_new_file = temp_dir
        .path()
        .join("hello_world_by_another_module_writer.wat");
    another_writer.write_text(&mut another_m, &another_new_file)?;

    let new_file_reader = fs::read(&new_file)?;
    let another_new_file_reader = fs::read(&another_new_file)?;

    assert_eq!(new_file_reader, another_new_file_reader);

    Ok(())
}

#[test]
fn read_write_binary_works() -> anyhow::Result<()> {
    let temp_dir = Builder::new().prefix("wasm_opt_tests").tempdir()?;
    let path = temp_dir.path().join("hello_world.wasm");

    let temp_file = File::create(&path)?;
    let mut buf_writer = BufWriter::new(&temp_file);
    buf_writer.write_all(WASM_FILE)?;

    let mut m = Module::new();
    let mut reader = ModuleReader::new();
    reader.read_binary(&path, &mut m, None)?;

    let mut writer = ModuleWriter::new();
    let new_file = temp_dir.path().join("hello_world_by_module_writer.wasm");
    writer.write_binary(&mut m, &new_file)?;

    let mut another_m = Module::new();
    let mut another_reader = ModuleReader::new();
    another_reader.read_binary(&new_file, &mut another_m, None)?;

    let mut another_writer = ModuleWriter::new();
    let another_new_file = temp_dir
        .path()
        .join("hello_world_by_another_module_writer.wasm");
    another_writer.write_binary(&mut another_m, &another_new_file)?;

    let new_file_reader = fs::read(&new_file)?;
    let another_new_file_reader = fs::read(&another_new_file)?;

    assert_eq!(new_file_reader, another_new_file_reader);

    Ok(())
}

#[test]
fn module_read_garbage_error_works() -> anyhow::Result<()> {
    let temp_dir = Builder::new().prefix("wasm_opt_tests").tempdir()?;
    let path = temp_dir.path().join("hello_world_bad.wat");

    let temp_file = File::create(&path)?;
    let mut buf_writer = BufWriter::new(&temp_file);
    buf_writer.write_all(GARBAGE_FILE)?;

    let mut m = Module::new();
    let mut reader = ModuleReader::new();
    let res = reader.read_text(&path, &mut m);
    match res {
        Ok(()) => {}
        Err(_) => println!("Module read_text failed"),
    }

    let mut m = Module::new();
    let mut reader = ModuleReader::new();
    let res = reader.read_binary(&path, &mut m, None);
    match res {
        Ok(()) => {}
        Err(_) => println!("Module read_binary failed"),
    }

    let mut m = Module::new();
    let mut reader = ModuleReader::new();
    let res = reader.read(&path, &mut m, None);
    match res {
        Ok(()) => {}
        Err(_) => println!("Module read failed"),
    }

    Ok(())
}

#[test]
fn map_parse_exception_works() -> anyhow::Result<()> {
    let temp_dir = Builder::new().prefix("wasm_opt_tests").tempdir()?;
    let path = temp_dir.path().join("hello_world.wasm");

    let temp_file = File::create(&path)?;
    let mut buf_writer = BufWriter::new(&temp_file);
    buf_writer.write_all(WASM_FILE)?;

    let mut m = Module::new();
    let mut reader = ModuleReader::new();

    let source_map_path = temp_dir.path().join("bad_source_map_path");
    let res = reader.read_binary(&path, &mut m, Some(&source_map_path));
    match res {
        Ok(()) => panic!(),
        Err(e) => println!("Module read_binary failed: {}", e),
    }

    let res = reader.read(&path, &mut m, Some(&source_map_path));
    match res {
        Ok(()) => panic!(),
        Err(e) => println!("Module read failed: {}", e),
    }

    Ok(())
}

#[test]
fn pass_runner_works() -> anyhow::Result<()> {
    let temp_dir = Builder::new().prefix("wasm_opt_tests").tempdir()?;
    let path = temp_dir.path().join("hello_world.wasm");

    let temp_file = File::create(&path)?;
    let mut buf_writer = BufWriter::new(&temp_file);
    buf_writer.write_all(WASM_FILE)?;

    // Module without optimization
    let mut m = Module::new();
    let mut reader = ModuleReader::new();
    reader.read_binary(&path, &mut m, None)?;

    let mut writer = ModuleWriter::new();
    let new_file = temp_dir.path().join("hello_world_by_module_writer.wasm");
    writer.write_binary(&mut m, &new_file)?;

    // Module with optimization
    let mut another_m = Module::new();
    let mut another_reader = ModuleReader::new();
    another_reader.read_binary(&new_file, &mut another_m, None)?;

    let mut pass_runner = PassRunner::new(&mut another_m);
    pass_runner.add_default_optimization_passes();
    pass_runner.run();
    drop(pass_runner);

    let mut another_writer = ModuleWriter::new();
    let another_new_file = temp_dir
        .path()
        .join("hello_world_by_another_module_writer.wasm");
    another_writer.write_binary(&mut another_m, &another_new_file)?;

    let new_file_reader = fs::read(&new_file)?;
    let another_new_file_reader = fs::read(&another_new_file)?;

    assert!(new_file_reader.len() > another_new_file_reader.len());

    Ok(())
}

#[test]
fn pass_options_works() -> anyhow::Result<()> {
    let temp_dir = Builder::new().prefix("wasm_opt_tests").tempdir()?;
    let path = temp_dir.path().join("hello_world.wasm");

    let temp_file = File::create(&path)?;
    let mut buf_writer = BufWriter::new(&temp_file);
    buf_writer.write_all(WASM_FILE)?;

    // Module without optimization
    let mut m = Module::new();
    let mut reader = ModuleReader::new();
    reader.read_binary(&path, &mut m, None)?;

    let mut writer = ModuleWriter::new();
    let new_file = temp_dir.path().join("hello_world_by_module_writer.wasm");
    writer.write_binary(&mut m, &new_file)?;

    // Module with optimization: default
    let mut m_0 = Module::new();
    let mut reader_0 = ModuleReader::new();
    reader_0.read_binary(&new_file, &mut m_0, None)?;

    let mut pass_options = PassOptions::new();
    pass_options.set_optimize_level(2);
    pass_options.set_shrink_level(1);

    let mut pass_runner = PassRunner::new_with_options(&mut m_0, pass_options);
    pass_runner.add_default_optimization_passes();
    pass_runner.run();
    drop(pass_runner);

    let mut writer_0 = ModuleWriter::new();
    let file_0 = temp_dir.path().join("hello_world_by_module_writer_0.wasm");
    writer_0.write_binary(&mut m_0, &file_0)?;

    let new_file_reader = fs::read(&new_file)?;
    let file_reader_0 = fs::read(&file_0)?;

    println!("new_file: {}", new_file_reader.len());
    println!("file_0: {}", file_reader_0.len());

    assert!(new_file_reader.len() > file_reader_0.len());

    // Module with optimization: more optimized settings
    let mut m_1 = Module::new();
    let mut reader_1 = ModuleReader::new();
    reader_1.read_binary(&new_file, &mut m_1, None)?;

    let mut pass_options = PassOptions::new();
    pass_options.set_optimize_level(5);
    pass_options.set_shrink_level(5);

    let mut pass_runner = PassRunner::new_with_options(&mut m_1, pass_options);
    pass_runner.add_default_optimization_passes();
    pass_runner.run();
    drop(pass_runner);

    let mut writer_1 = ModuleWriter::new();
    let file_1 = temp_dir.path().join("hello_world_by_module_writer_1.wasm");
    writer_1.write_binary(&mut m_1, &file_1)?;

    let file_reader_1 = fs::read(&file_1)?;
    println!("file_1: {}", file_reader_1.len());

    assert!(file_reader_0.len() > file_reader_1.len());

    // Module with optimization: ridiculous settings
    let mut m_2 = Module::new();
    let mut reader_2 = ModuleReader::new();
    reader_2.read_binary(&new_file, &mut m_2, None)?;

    let mut pass_options = PassOptions::new();

    pass_options.set_optimize_level(2_000_000_000);
    pass_options.set_shrink_level(2_000_000_000);

    let mut pass_runner = PassRunner::new_with_options(&mut m_2, pass_options);
    pass_runner.add_default_optimization_passes();
    pass_runner.run();
    drop(pass_runner);

    let mut writer_2 = ModuleWriter::new();
    let file_2 = temp_dir.path().join("hello_world_by_module_writer_2.wasm");
    writer_2.write_binary(&mut m_2, &file_2)?;

    let file_reader_2 = fs::read(&file_2)?;
    println!("file_2: {}", file_reader_2.len());

    assert!(file_reader_1.len() >= file_reader_2.len());

    Ok(())
}

#[test]
fn pass_runner_add_works() -> anyhow::Result<()> {
    let temp_dir = Builder::new().prefix("wasm_opt_tests").tempdir()?;
    let path = temp_dir.path().join("ink_example_multisig.wasm");

    let temp_file = File::create(&path)?;
    let mut buf_writer = BufWriter::new(&temp_file);
    buf_writer.write_all(MULTISIG_WASM)?;

    // Module without optimization
    let mut m = Module::new();
    let mut reader = ModuleReader::new();
    reader.read_binary(&path, &mut m, None)?;

    let mut writer = ModuleWriter::new();
    let new_file = temp_dir
        .path()
        .join("ink_example_multisig_by_module_writer.wasm");
    writer.write_binary(&mut m, &new_file)?;

    // Module with optimization
    let mut another_m = Module::new();
    let mut another_reader = ModuleReader::new();
    another_reader.read_binary(&new_file, &mut another_m, None)?;

    let mut pass_runner = PassRunner::new(&mut another_m);
    pass_runner.add("duplicate-function-elimination");
    pass_runner.run();
    drop(pass_runner);

    let mut another_writer = ModuleWriter::new();
    let another_new_file = temp_dir
        .path()
        .join("ink_example_multisig_by_another_module_writer.wasm");
    another_writer.write_binary(&mut another_m, &another_new_file)?;

    let new_file_reader = fs::read(&new_file)?;
    let another_new_file_reader = fs::read(&another_new_file)?;

    println!("file_1: {}", new_file_reader.len());
    println!("file_2: {}", another_new_file_reader.len());
    assert!(new_file_reader.len() > another_new_file_reader.len());

    Ok(())
}

#[test]
fn get_pass_description_valid_name_works() -> anyhow::Result<()> {
    let pass_description = pass_registry::get_pass_description("limit-segments");

    assert_eq!(
        pass_description,
        "attempt to merge segments to fit within web limits"
    );

    Ok(())
}

#[test]
fn is_pass_hidden_works() -> anyhow::Result<()> {
    let is_pass_hidden = pass_registry::is_pass_hidden("limit-segments");

    assert_eq!(is_pass_hidden, false);

    Ok(())
}

#[test]
fn read_file_not_exists() -> anyhow::Result<()> {
    let temp_dir = Builder::new().prefix("wasm-opt").tempdir()?;
    let path = temp_dir.path().join("not-a-file.wasm");

    let mut m = Module::new();
    let mut reader = ModuleReader::new();
    let r = reader.read_binary(&path, &mut m, None);

    assert!(r.is_err());

    Ok(())
}

#[test]
fn write_file_path_not_exists() -> anyhow::Result<()> {
    let temp_dir = Builder::new().prefix("wasm-opt").tempdir()?;
    let path = temp_dir.path().join("hello_world.wat");

    let temp_file = File::create(&path)?;
    let mut buf_writer = BufWriter::new(&temp_file);
    buf_writer.write_all(WAT_FILE)?;

    let mut m = Module::new();
    let mut reader = ModuleReader::new();
    reader.read_text(&path, &mut m)?;

    let mut writer = ModuleWriter::new();
    let new_file = temp_dir
        .path()
        .join("badpath")
        .join("hello_world_by_module_writer.wat");
    let r = writer.write_text(&mut m, &new_file);

    assert!(r.is_err());

    Ok(())
}

#[test]
fn all_features_correct() -> anyhow::Result<()> {
    let features_via_shims = get_feature_array();
    let mut features_via_base = Vec::<u32>::new();

    Feature::iter().for_each(|f| {
        features_via_base.push(f as u32);
    });

    assert_eq!(features_via_shims, features_via_base);
    Ok(())
}