RestrictedTraceTests.md

Show log
Commit

Hash : 080d711b
Author :
Date : 2020-01-08T13:04:44

Tests: Add a perf test using traces

This test will load traces and cycle through a set of frames.

The new tests are:

    TracePerfTest.Run/gl_trex_200_210
    TracePerfTest.Run/gl_trex_800_810
    TracePerfTest.Run/gl_trex_900_910
    TracePerfTest.Run/gl_trex_1300_1310

To download the traces, you must be granted access and authenticate
with the cloud.  See the steps in RestrictedTraces.md for this.

Then add the following to the end of your .gclient file:

    "custom_vars": {
      "checkout_angle_internal":"True"
    },

And run `glcient runhooks`.

To enable building the test, add the following GN arg:

    build_angle_trace_perf_tests = true

See the new markdown document for ways to execute the tests.

Bug: angleproject:3630
Change-Id: Ic25cd94fb36b35fcf187e88d3bf9548c65f59755
Reviewed-on: https://chromium-review.googlesource.com/c/angle/angle/+/1949605
Commit-Queue: Cody Northrop <cnorthrop@google.com>
Reviewed-by: Jamie Madill <jmadill@chromium.org>

Download

ANGLE Restricted Traces

The files in this directory are traces of real applications. We host them internally because they may contain third party IP which we don’t want to share publicly.

Setup

In order to compile and run with these, you must be granted access by Google, then authenticate with the cloud with your @google account:

gcloud auth login

download_from_google_storage --config
<enter 0 for the project ID>

Add the following to ANGLE’s .gclient file:

    "custom_vars": {
      "checkout_angle_internal":"True"
    },

Then use gclient to pull down binary files from a cloud storage bucket.

gclient runhooks

To build the tests, add the following GN argument:

build_angle_trace_perf_tests = true

Build the angle_perftests:

autoninja -C out/Release angle_perftests

On desktop, run them like so:

out/Release/angle_perftests --gtest_filter=TracePerfTest*

On Android, run them like so:

out/Release/bin/run_angle_perftests --gtest_filter=TracePerfTest*

Updating traces

The current TRex traces were captured on Windows with an Nvidia driver.

Update START and END for each range.

Windows

cd gfxbench\out\install\vs2017-x64\lib
python ..\..\..\..\scripts\refresh_angle_libs.py --verbose
set TFW_PACKAGE_DIR=../../../build/vs2017-x64/testfw/tfw-dev
set ANGLE_DEFAULT_PLATFORM=vulkan

set START=200
set END=210
set LABEL=trex
mkdir ..\..\..\..\..\angle\src\tests\perf_tests\restricted_traces\%LABEL%_%START%_%END%
set ANGLE_CAPTURE_LABEL=%LABEL%_%START%_%END%
set ANGLE_CAPTURE_FRAME_START=%START%
set ANGLE_CAPTURE_FRAME_END=%END%
set ANGLE_CAPTURE_OUT_DIR=..\..\..\..\..\angle\src\tests\perf_tests\restricted_traces\%LABEL%_%START%_%END%
..\bin\testfw_app.exe -b ../../../build/vs2017-x64/testfw/tfw-dev --gfx egl -w 1920 -h 1080 -t gl_trex --ei -frame_step_time=40

Linux

cd gfxbench/out/install/linux/lib
python ../../../../scripts/refresh_angle_libs.py --verbose
export PLATFORM=linux
export TFW_PACKAGE_DIR=../../../build/linux/testfw_Release/tfw-dev
export ANGLE_DEFAULT_PLATFORM=vulkan
export LD_LIBRARY_PATH=.

export START=200
export END=210
export LABEL=trex
mkdir -p ../../../../../angle/src/tests/perf_tests/restricted_traces/${LABEL}_${START}_${END}
export ANGLE_CAPTURE_LABEL=${LABEL}_${START}_${END}
export ANGLE_CAPTURE_FRAME_START=$START
export ANGLE_CAPTURE_FRAME_END=$END
export ANGLE_CAPTURE_OUT_DIR=../../../../../angle/src/tests/perf_tests/restricted_traces/${LABEL}_${START}_${END}
../bin/testfw_app -b $TFW_PACKAGE_DIR --gfx egl -w 512 -h 512 -t gl_trex --ei -frame_step_time=40

Upload to the cloud

cd ~/chromium/src/third_party/angle/src/tests/perf_tests/restricted_traces
upload_to_google_storage.py --bucket chrome-angle-capture-binaries --archive trex_200_210
upload_to_google_storage.py --bucket chrome-angle-capture-binaries --archive trex_800_810
upload_to_google_storage.py --bucket chrome-angle-capture-binaries --archive trex_900_910
upload_to_google_storage.py --bucket chrome-angle-capture-binaries --archive trex_1300_1310

Adding new tests

Once you are able to capture a set of frames from an application using the steps above, you’ll need to:

Add the tests to restricted_traces/angle_trace_perf_tests.gni
Update TracePerfTest.cpp to include the headers from the test, add it to the list of TracePerfTestID, and support it throughout the file using the namespace created in the trace.
Upload the traces to the cloud using the steps above.
Add the sha1 files created by the upload and submit them with your changes.

Source

src/tests/perf_tests/restricted_traces/RestrictedTraceTests.md

# ANGLE Restricted Traces

The files in this directory are traces of real applications.  We host them
internally because they may contain third party IP which we don't want
to share publicly.

## Setup

In order to compile and run with these, you must be granted access by Google,
then authenticate with the cloud with your @google account:
```
gcloud auth login
```
```
download_from_google_storage --config
<enter 0 for the project ID>
```
Add the following to ANGLE's .gclient file:
```
    "custom_vars": {
      "checkout_angle_internal":"True"
    },
```
Then use gclient to pull down binary files from a cloud storage bucket.
```
gclient runhooks
```
To build the tests, add the following GN argument:
```
build_angle_trace_perf_tests = true
```
Build the angle_perftests:
```
autoninja -C out/Release angle_perftests
```
On desktop, run them like so:
```
out/Release/angle_perftests --gtest_filter=TracePerfTest*
```
On Android, run them like so:
```
out/Release/bin/run_angle_perftests --gtest_filter=TracePerfTest*
```

## Updating traces

The current TRex traces were captured on Windows with an Nvidia driver.

Update START and END for each range.

### Windows

```
cd gfxbench\out\install\vs2017-x64\lib
python ..\..\..\..\scripts\refresh_angle_libs.py --verbose
set TFW_PACKAGE_DIR=../../../build/vs2017-x64/testfw/tfw-dev
set ANGLE_DEFAULT_PLATFORM=vulkan

set START=200
set END=210
set LABEL=trex
mkdir ..\..\..\..\..\angle\src\tests\perf_tests\restricted_traces\%LABEL%_%START%_%END%
set ANGLE_CAPTURE_LABEL=%LABEL%_%START%_%END%
set ANGLE_CAPTURE_FRAME_START=%START%
set ANGLE_CAPTURE_FRAME_END=%END%
set ANGLE_CAPTURE_OUT_DIR=..\..\..\..\..\angle\src\tests\perf_tests\restricted_traces\%LABEL%_%START%_%END%
..\bin\testfw_app.exe -b ../../../build/vs2017-x64/testfw/tfw-dev --gfx egl -w 1920 -h 1080 -t gl_trex --ei -frame_step_time=40
```

### Linux

```
cd gfxbench/out/install/linux/lib
python ../../../../scripts/refresh_angle_libs.py --verbose
export PLATFORM=linux
export TFW_PACKAGE_DIR=../../../build/linux/testfw_Release/tfw-dev
export ANGLE_DEFAULT_PLATFORM=vulkan
export LD_LIBRARY_PATH=.

export START=200
export END=210
export LABEL=trex
mkdir -p ../../../../../angle/src/tests/perf_tests/restricted_traces/${LABEL}_${START}_${END}
export ANGLE_CAPTURE_LABEL=${LABEL}_${START}_${END}
export ANGLE_CAPTURE_FRAME_START=$START
export ANGLE_CAPTURE_FRAME_END=$END
export ANGLE_CAPTURE_OUT_DIR=../../../../../angle/src/tests/perf_tests/restricted_traces/${LABEL}_${START}_${END}
../bin/testfw_app -b $TFW_PACKAGE_DIR --gfx egl -w 512 -h 512 -t gl_trex --ei -frame_step_time=40
```

## Upload to the cloud

```
cd ~/chromium/src/third_party/angle/src/tests/perf_tests/restricted_traces
upload_to_google_storage.py --bucket chrome-angle-capture-binaries --archive trex_200_210
upload_to_google_storage.py --bucket chrome-angle-capture-binaries --archive trex_800_810
upload_to_google_storage.py --bucket chrome-angle-capture-binaries --archive trex_900_910
upload_to_google_storage.py --bucket chrome-angle-capture-binaries --archive trex_1300_1310
```

## Adding new tests
Once you are able to capture a set of frames from an application using the steps above, you'll need to:

* Add the tests to restricted_traces/angle_trace_perf_tests.gni
* Update TracePerfTest.cpp to include the headers from the test, add it to the list of TracePerfTestID, and support it throughout the file using the namespace created in the trace.
* Upload the traces to the cloud using the steps above.
* Add the sha1 files created by the upload and submit them with your changes.

Download