GPU Pixel Wrangling is the process of keeping various GPU bots green. On the GPU bots, tests run on physical hardware with real GPUs, not in VMs like the majority of the bots on the Chromium waterfall.
WaterfallsThe waterfalls work much like any other; see the Tour of the Chromium Buildbot Waterfall for a more detailed explanation of how this is laid out. We have more subtle configurations because the GPU matters, not just the OS and release v. debug. Hence we have Windows Nvidia Release bots, Mac Intel Debug bots, and so on.The waterfalls we’re interested in are:
The bots run several test suites. The majority of them have been migrated to the Telemetry harness, and are run within the full browser, in order to better test the code that is actually shipped. As of this writing, the tests included:
Additionally, the Release bots run:
- Tests using the Telemetry harness:
- The WebGL conformance tests: src/content/test/gpu/gpu_tests/webgl_conformance.py
- A Google Maps test: src/content/test/gpu/gpu_tests/maps.py
- Context loss tests: src/content/test/gpu/gpu_tests/context_lost.py
- GPU process launch tests: src/content/test/gpu/gpu_tests/gpu_process.py
- Hardware acceleration validation tests: src/content/test/gpu/gpu_tests/hardware_accelerated_feature.py
- GPU memory consumption tests: src/content/test/gpu/gpu_tests/memory.py
- Pixel tests validating the end-to-end rendering pipeline: src/content/test/gpu/gpu_tests/pixel.py
- content_gl_tests: see src/content/content_tests.gypi
- gles2_conform_test (requires internal sources): see src/gpu/gles2_conform_support/gles2_conform_test.gyp
- gl_tests: see src/gpu/gpu.gyp
- angle_unittests: see src/gpu/gpu.gyp
- tab_capture_performance_tests: see performance_browser_tests in src/chrome/chrome_tests.gypi and src/browser/extensions/api/tab_capture/tab_capture_performancetest.cc
- Ideally a wrangler should be both WebKit and Chromium committer. There's a wrangling schedule. If you're in rotation, there will be an email notifying you of the upcoming stint.
- Apply for access to the bots.
How to Keep the Bots Green
- Watch for redness on the tree.
- The bots are expected to be green all the time. Flakiness on these bots is neither expected nor acceptable.
- If a bot goes consistently red, it's necessary to figure out whether a recent CL caused it, or whether it's a problem with the bot or infrastructure.
- If it looks like a problem with the bot (deep problems like failing to check out the sources, the isolate server failing, etc.) notify the Chromium troopers. See the general tree sheriffing page for more details.
- Otherwise, examine the builds just before and after the redness was introduced. Look at the revisions in the builds before and after the failure was introduced. Depending on whether you're looking at the Chromium or Blink trees, use either the Chromium or Blink revisions. Unfortunately, you'll need to construct your regression URL manually:
- For regressions on the Chromium tree: use this URL and replace "[rev1]" and "[rev2]" in the "range=[rev1]:[rev2]" URL query parameter
- For regressions on the Blink tree: use this URL and replace "[rev1]" and "[rev2]" in the "range=[rev1]:[rev2]" URL query parameter
- File a bug capturing the regression range and excerpts of any associated logs. Regressions should be marked P1. CC engineers who you think may be able to help triage the issue. Keep in mind that the logs on the bots expire after a few days, so make sure to add copies of relevant logs to the bug report.
- Study the regression range carefully. Changes outside the Chromium tree (i.e., in /trunk/tools/ rather than /trunk/src/) may break the GPU bots, because the GPU recipe which drives these bots is in the tools repository.
- Use drover to revert any CLs which break the GPU bots. In the revert message, provide a clear description of what broke, links to failing builds, and excerpts of the failure logs, because the build logs expire after a few days.
- Make sure the bots are running jobs.
- Keep an eye on the console views of the various bots.
- Make sure the bots are all actively processing jobs. If they go offline for a long period of time, the "summary bubble" at the top may still be green, but the column in the console view will be gray.
- Email the Chromium troopers if you find a bot that's not processing jobs.
- Check if any pixel test failures are actual failures or need to be rebaselined.
- For a given build failing the pixel tests, click the "stdio" link of the "pixel" step.
- The output will contain a link of the form http://chromium-browser-gpu-tests.commondatastorage.googleapis.com/view_test_results.html?242523_Linux_Release_Intel__telemetry
- Visit the link to see whether the generated or reference images look incorrect.
- All of the reference images for all of the bots are stored in cloud storage under the link https://cloud.google.com/console#/storage/chromium-gpu-archive/reference-images/ . They are indexed by version number, OS, GPU vendor, GPU device, and whether or not antialiasing is enabled in that configuration. You can download the reference images individually to examine them in detail.
- Rebaseline pixel test reference images if necessary.
- Increment the revision number of the particular test in src/content/test/gpu/page_sets/pixel_tests.json .
- When this is committed, all of the bots will generate new reference images for the new version of the test.
- Alternatively, if absolutely necessary, you can use the Chrome Internal GPU Pixel Wrangling Instructions to delete just the broken reference images for a particular configuration.
- Update WebGL Conformance Test expectations if necessary: src/content/test/gpu/gpu_tests/webgl_conformance_expectations.py.
- See the header of the file a list of modifiers to specify a bot configuration. We can specify OS (down to a specific version, say, Windows 7 or Mountain Lion), GPU vendor (NVIDIA/AMD/Intel), and a specific GPU device.
- The key is to maintain the highest coverage: if you have to disable a test, disable it only on the specific configurations it's failing. Note that it is not possible to discern between Debug and Release configurations.
- All other tests, do the regular DISABLE_ / FLAKY_ / etc thing.
- (Rarely) Update the version of the WebGL conformance tests. See below.
When Bots Misbehave (SSHing into a bot):
Updating the WebGL Conformance Tests
Occasionally a bug in the WebGL conformance tests will be exposed by a WebKit roll, and the best solution is to roll forward to a new version of the WebGL conformance suite in which the bug has been fixed. In order to do this, follow the steps below.
- Visit https://chromium.googlesource.com/external/khronosgroup/webgl.git with your browser.
- Find the full git hash of the revision you want to roll to.
- Modify the entry for src/third_party/webgl/src in src/DEPS with the new hash.
- Send the CL to the GPU try servers (win_gpu, linux_gpu, mac_gpu).
- If the CL looks good, commit it.
- Watch the GPU bots on the various waterfalls. There are more OS and GPU combinations than the GPU servers can reasonably try. An update to the WebGL conformance suite is likely to fail on one or more bots.
- Update the WebGL conformance suite expectations to suppress failures if necessary. File bugs about the need for these suppressions so they can be removed in the future.
Performance Test Graphs
Nearly all of the GPU performance tests have been migrated off the GPU bots on to the Perf waterfall. The sole exception is tab_capture_performance_tests, which continues to run on Release bots. At this point, this test mainly measures correctness. Changes which break the execution of this test should be reverted.
Extending the GPU Pixel Wrangling Rotation