File: cache_wasm_extension_browsertest.cc

package info (click to toggle)
chromium 138.0.7204.157-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,864 kB
  • sloc: cpp: 34,936,859; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,967; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (195 lines) | stat: -rw-r--r-- 7,448 bytes parent folder | download | duplicates (4)
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
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include <array>
#include <string_view>

#include "base/base_paths.h"
#include "base/files/file_util.h"
#include "base/path_service.h"
#include "base/threading/platform_thread.h"
#include "chrome/browser/extensions/chrome_test_extension_loader.h"
#include "chrome/browser/extensions/extension_browsertest.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/browser/ui/browser_commands.h"
#include "components/metrics/content/subprocess_metrics_provider.h"
#include "content/public/test/browser_test.h"
#include "content/public/test/browser_test_utils.h"
#include "third_party/blink/public/common/switches.h"

class WasmExtensionCachingBrowserTest
    : public extensions::ExtensionBrowserTest {
 public:
  WasmExtensionCachingBrowserTest() = default;
  ~WasmExtensionCachingBrowserTest() override = default;

  static constexpr std::string_view kHistogram = "V8.WasmCodeCaching";

  // The enum values need to match "WasmCodeCaching" in
  // tools/metrics/histograms/metadata/v8/enums.xml.
  enum WasmCodeCaching {
    kMiss = 0,
    kHit = 1,
    kInvalidCacheEntry = 2,
    kNoCacheHandler = 3,

    kMaxValue = kNoCacheHandler
  };

  static constexpr std::array kWasmCodeCachingBucketNames = {
      "kMiss", "kHit", "kInvalidCacheEntry", "kNoCacheHandler"};

  const base::FilePath& GetExtensionDir() {
    if (!tmp_dir_.IsValid()) {
      CHECK(tmp_dir_.CreateUniqueTempDir());
    }
    return tmp_dir_.GetPath();
  }

  int GetBucketCount(WasmCodeCaching bucket) const {
    return histogram_tester_.GetBucketCount(kHistogram, bucket);
  }

  int FetchAndAccumulateHistogram() {
    content::FetchHistogramsFromChildProcesses();
    metrics::SubprocessMetricsProvider::MergeHistogramDeltasForTesting();

    // Log and sum up the samples. The logging will help diagnose failures or
    // flakes.
    auto buckets = histogram_tester_.GetAllSamples(kHistogram);
    int total_samples = 0;
    LOG(INFO) << "Histogram '" << kHistogram << "': ";
    for (auto& bucket : buckets) {
      LOG(INFO) << kWasmCodeCachingBucketNames[bucket.min] << ": "
                << bucket.count << "\t";
      total_samples += bucket.count;
    }
    return total_samples;
  }

  // Fetch the `bucket` from the `histogram` in every renderer process until
  // reaching, but not exceeding, `expected_samples`.
  void WaitForHistogramSamples(std::string_view histogram,
                               int expected_samples) {
    // We sleep for an increasing amount of time for the background task to
    // finish.
    int millis_sleep = 100;
    while (true) {
      LOG(INFO) << "Fetching histograms, waiting for " << expected_samples
                << " samples...";

      int total_samples = FetchAndAccumulateHistogram();
      if (total_samples == expected_samples) {
        return;
      }
      CHECK_LT(total_samples, expected_samples);

      base::PlatformThread::Sleep(base::Milliseconds(millis_sleep));
      // Increase sleep time, but never sleep more than 5 seconds.
      millis_sleep = std::min(5000, millis_sleep * 2);
    }
  }

 private:
  // JS flags:
  // --allow-natives-syntax:          Enables the use of (internal) runtime
  //                                  functions like `%IsLiftoffFunction`.
  // --wasm-caching-threshold=1:      Trigger caching as soon as any TurboFan
  //                                  code is available.
  // --wasm-caching-hard-threshold=1: Trigger caching immediately, not after a
  //                                  delay.
  // --wasm-tiering-budget=1:         Trigger tier-up earlier.
  void SetUpCommandLine(base::CommandLine* command_line) override {
    command_line->AppendSwitchASCII(blink::switches::kJavaScriptFlags,
                                    "--allow-natives-syntax"
                                    " --wasm-caching-threshold=1"
                                    " --wasm-caching-hard-threshold=1"
                                    " --wasm-tiering-budget=1");
    ExtensionBrowserTest::SetUpCommandLine(command_line);
  }

  base::ScopedTempDir tmp_dir_;
  base::HistogramTester histogram_tester_;
};

// The `large.wasm` file is very large: 2.5MB. To avoid increasing the git
// repository, we prefer borrowing it from web_tests.
base::FilePath LargeWasmPath() {
  base::FilePath root_path;
  CHECK(base::PathService::Get(base::DIR_SRC_TEST_DATA_ROOT, &root_path));
  return root_path.Append(FILE_PATH_LITERAL(
      "third_party/blink/web_tests/http/tests/wasm/resources/large.wasm"));
}

// Test that we cache streaming compiled/instantiated Wasm modules in
// extensions. We have to wait until caching of the module happens and the
// histogram is populated.
IN_PROC_BROWSER_TEST_F(WasmExtensionCachingBrowserTest, CacheWasmExtensions) {
  base::ScopedAllowBlockingForTesting allow_blocking;
  CHECK(base::CopyFile(LargeWasmPath(),
                       GetExtensionDir().AppendASCII("large.wasm")));

  base::WriteFile(GetExtensionDir().AppendASCII("service_worker_background.js"),
                  R"(
      function execute_wasm(instance) {
        let has_unoptimized = false;
        for (export_name in instance.exports) {
          const func = instance.exports[export_name];
          func(1, 2, 4);
          has_unoptimized ||= %IsLiftoffFunction(func);
        }
        if (has_unoptimized) {
          setTimeout(() => execute_wasm(instance), 1);
        }
      }
      chrome.tabs.onCreated.addListener(() => {
        // Run all functions until there are no unoptimized functions left.
        WebAssembly.instantiateStreaming(fetch("large.wasm")).then(
          ({instance}) => execute_wasm(instance));
      });
    )");

  base::WriteFile(GetExtensionDir().AppendASCII("manifest.json"), R"({
    "name": "foo",
    "description": "foo",
    "version": "0.1",
    "manifest_version": 2,
    "content_security_policy": "script-src 'self' 'unsafe-eval'; object-src 'self'",
    "background": {
      "service_worker": "service_worker_background.js"
    }
  })");

  // After loading the extension, no WebAssembly has been executed.
  extensions::ChromeTestExtensionLoader loader(browser()->profile());
  LOG(INFO) << "Loading extension, expecting zero misses / hits";
  loader.LoadExtension(GetExtensionDir());
  WaitForHistogramSamples(kHistogram, 0);
  CHECK_EQ(0, GetBucketCount(kMiss));
  CHECK_EQ(0, GetBucketCount(kHit));

  // Open up to 10 tabs, with some waiting in between. We should eventually see
  // a cache hit.
  // Typically (on a reasonably fast machine) the first tab creates the cache
  // entry and the second tab consumes it. Very slow machines might require a
  // few more loads.
  for (int num_tabs = 1; num_tabs <= 10; ++num_tabs) {
    LOG(INFO) << "Opening new tab #" << num_tabs;
    chrome::NewTab(browser());
    // Wait until we got a total of `num_tabs` many samples.
    WaitForHistogramSamples(kHistogram, num_tabs);
    // If there was a hit, we are happy (and done).
    if (GetBucketCount(kHit)) {
      return;
    }
    CHECK_EQ(num_tabs, GetBucketCount(kMiss));

    // Before opening the next tab, wait for some (increasing) time.
    // The total maximum waiting time is 1 + 2 + ... + 10 = 55 seconds.
    base::PlatformThread::Sleep(base::Seconds(num_tabs));
  }

  FAIL() << "Failure: No cache hits";
}