Marge Bot pushed to branch master at Glasgow Haskell Compiler / GHC

Commits:

1 changed file:

Changes:

  • utils/jsffi/dyld.mjs
    ... ... @@ -670,7 +670,25 @@ class DyLD {
    670 670
     
    
    671 671
       // Wasm memory & table
    
    672 672
       #memory = new WebAssembly.Memory({ initial: 1 });
    
    673
    +
    
    673 674
       #table = new WebAssembly.Table({ element: "anyfunc", initial: 1 });
    
    675
    +  // First free slot, might be invalid when it advances to #table.length
    
    676
    +  #tableFree = 1;
    
    677
    +  // See Note [The evil wasm table grower]
    
    678
    +  #tableGrowInstance = new WebAssembly.Instance(
    
    679
    +    new WebAssembly.Module(
    
    680
    +      new Uint8Array([
    
    681
    +        0, 97, 115, 109, 1, 0, 0, 0, 1, 6, 1, 96, 1, 127, 1, 127, 2, 35, 1, 3,
    
    682
    +        101, 110, 118, 25, 95, 95, 105, 110, 100, 105, 114, 101, 99, 116, 95,
    
    683
    +        102, 117, 110, 99, 116, 105, 111, 110, 95, 116, 97, 98, 108, 101, 1,
    
    684
    +        112, 0, 0, 3, 2, 1, 0, 7, 31, 1, 27, 95, 95, 103, 104, 99, 95, 119, 97,
    
    685
    +        115, 109, 95, 106, 115, 102, 102, 105, 95, 116, 97, 98, 108, 101, 95,
    
    686
    +        103, 114, 111, 119, 0, 0, 10, 11, 1, 9, 0, 208, 112, 32, 0, 252, 15, 0,
    
    687
    +        11,
    
    688
    +      ])
    
    689
    +    ),
    
    690
    +    { env: { __indirect_function_table: this.#table } }
    
    691
    +  );
    
    674 692
     
    
    675 693
       // __stack_pointer
    
    676 694
       #sp = new WebAssembly.Global(
    
    ... ... @@ -715,6 +733,82 @@ class DyLD {
    715 733
       // Global STG registers
    
    716 734
       #regs = {};
    
    717 735
     
    
    736
    +  // Note [The evil wasm table grower]
    
    737
    +  // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    
    738
    +  // We need to grow the wasm table as we load shared libraries in
    
    739
    +  // wasm dyld. We used to directly call the table.grow() JS API,
    
    740
    +  // which works as expected in Firefox/Chrome, but unfortunately,
    
    741
    +  // WebKit's implementation of the table.grow() JS API is broken:
    
    742
    +  // https://bugs.webkit.org/show_bug.cgi?id=290681, which means that
    
    743
    +  // the wasm dyld simply does not work in WebKit-based browsers like
    
    744
    +  // Safari.
    
    745
    +  //
    
    746
    +  // Now, one simple workaround would be to avoid growing the table at
    
    747
    +  // all: just allocate a huge table upfront (current limitation
    
    748
    +  // agreed by all vendors is 10000000). To avoid unnecessary space
    
    749
    +  // waste on non-WebKit platforms, we could additionally check
    
    750
    +  // navigator.userAgent against some regexes and only allocate
    
    751
    +  // fixed-length table when there's no blink/gecko mention. But this
    
    752
    +  // is fragile and gross, and it's better to stick to a uniform code
    
    753
    +  // path for all browsers.
    
    754
    +  //
    
    755
    +  // Fortunately, it turns out the table.grow wasm instruction work as
    
    756
    +  // expected in WebKit! So we can invoke a wasm function that grows
    
    757
    +  // the table for us. But don't open a champagne yet, where would
    
    758
    +  // that wasm function come from? It can't be put into RTS, or even
    
    759
    +  // libc.so, because loading those libraries would require growing
    
    760
    +  // the table in the first place! Or perhaps, reserve a table upfront
    
    761
    +  // that's just large enough to load RTS and then we can access that
    
    762
    +  // function for subsequent table grows? But then we need to
    
    763
    +  // experiment for a reasonable initial size, and add a magic number
    
    764
    +  // here, which is also fragile and gross and not future-proof!
    
    765
    +  //
    
    766
    +  // So this special wasm function needs to live in a single wasm
    
    767
    +  // module, which is loaded before we load anything else. The full
    
    768
    +  // source code for this module is:
    
    769
    +  //
    
    770
    +  // (module
    
    771
    +  //   (type (func (param i32) (result i32)))
    
    772
    +  //   (import "env" "__indirect_function_table" (table 0 funcref))
    
    773
    +  //   (export "__ghc_wasm_jsffi_table_grow" (func 0))
    
    774
    +  //   (func (type 0) (param i32) (result i32)
    
    775
    +  //     ref.null func
    
    776
    +  //     local.get 0
    
    777
    +  //     table.grow 0
    
    778
    +  //   )
    
    779
    +  // )
    
    780
    +  //
    
    781
    +  // This module is 103 bytes so that we can inline its blob in dyld,
    
    782
    +  // and use the usually discouraged synchronous
    
    783
    +  // WebAssembly.Instance/WebAssembly.Module constructors to load it.
    
    784
    +  // On non-WebKit platforms, growing tables this way would introduce
    
    785
    +  // a bit of extra JS/Wasm interop overhead, which can be amplified
    
    786
    +  // as we used to call table.grow(1, foo) for every GOT.func item.
    
    787
    +  // Therefore, unless we're about to exceed the hard limit of table
    
    788
    +  // size, we now grow the table exponentially, and use bump
    
    789
    +  // allocation to calculate the table index to be returned.
    
    790
    +  // Exponential growth is only implemented to minimize the JS/Wasm
    
    791
    +  // interop overhead when calling __ghc_wasm_jsffi_table_grow;
    
    792
    +  // V8/SpiderMonkey/WebKit already do their own exponential growth of
    
    793
    +  // the table's backing buffer in their table growth logic.
    
    794
    +  //
    
    795
    +  // Invariants: n >= 0; when v is non-null, n === 1
    
    796
    +  #tableGrow(n, v) {
    
    797
    +    const prev_free = this.#tableFree;
    
    798
    +    if (prev_free + n > this.#table.length) {
    
    799
    +      const min_delta = prev_free + n - this.#table.length;
    
    800
    +      const delta = Math.max(min_delta, this.#table.length);
    
    801
    +      this.#tableGrowInstance.exports.__ghc_wasm_jsffi_table_grow(
    
    802
    +        this.#table.length + delta <= 10000000 ? delta : min_delta
    
    803
    +      );
    
    804
    +    }
    
    805
    +    if (v) {
    
    806
    +      this.#table.set(prev_free, v);
    
    807
    +    }
    
    808
    +    this.#tableFree += n;
    
    809
    +    return prev_free;
    
    810
    +  }
    
    811
    +
    
    718 812
       constructor({ args, rpc }) {
    
    719 813
         this.#rpc = rpc;
    
    720 814
     
    
    ... ... @@ -878,7 +972,7 @@ class DyLD {
    878 972
     
    
    879 973
           // __memory_base & __table_base, different for each .so
    
    880 974
           let memory_base;
    
    881
    -      let table_base = this.#table.grow(tableSize);
    
    975
    +      let table_base = this.#tableGrow(tableSize);
    
    882 976
           console.assert(tableP2Align === 0);
    
    883 977
     
    
    884 978
           // libc.so is always the first one to be ever loaded and has VIP
    
    ... ... @@ -982,7 +1076,7 @@ class DyLD {
    982 1076
               if (this.exportFuncs[name]) {
    
    983 1077
                 this.#gotFunc[name] = new WebAssembly.Global(
    
    984 1078
                   { value: "i32", mutable: true },
    
    985
    -              this.#table.grow(1, this.exportFuncs[name])
    
    1079
    +              this.#tableGrow(1, this.exportFuncs[name])
    
    986 1080
                 );
    
    987 1081
                 continue;
    
    988 1082
               }
    
    ... ... @@ -1033,7 +1127,7 @@ class DyLD {
    1033 1127
               if (this.#gotFunc[k]) {
    
    1034 1128
                 const got = this.#gotFunc[k];
    
    1035 1129
                 if (got.value === DyLD.#poison) {
    
    1036
    -              const idx = this.#table.grow(1, v);
    
    1130
    +              const idx = this.#tableGrow(1, v);
    
    1037 1131
                   got.value = idx;
    
    1038 1132
                 } else {
    
    1039 1133
                   this.#table.set(got.value, v);
    
    ... ... @@ -1103,7 +1197,7 @@ class DyLD {
    1103 1197
         // Not in GOT.func yet, create the entry on demand
    
    1104 1198
         if (this.exportFuncs[sym]) {
    
    1105 1199
           console.assert(!this.#gotFunc[sym]);
    
    1106
    -      const addr = this.#table.grow(1, this.exportFuncs[sym]);
    
    1200
    +      const addr = this.#tableGrow(1, this.exportFuncs[sym]);
    
    1107 1201
           this.#gotFunc[sym] = new WebAssembly.Global(
    
    1108 1202
             { value: "i32", mutable: true },
    
    1109 1203
             addr