tree: 3011a783a8eb160f1c0320b07b5d51efe4dc594f [path history] [tgz]
  1. proto/
  2. action_diff.py
  3. action_diff_test.py
  4. bb_fetch_rbe_cas.py
  5. bb_fetch_rbe_cas_test.py
  6. bbtool.py
  7. bbtool_test.py
  8. BUILD.gn
  9. cl_utils.py
  10. cl_utils_test.py
  11. common-setup.sh
  12. cxx.py
  13. cxx_link_remote_wrapper.py
  14. cxx_link_remote_wrapper_test.py
  15. cxx_remote_wrapper.py
  16. cxx_remote_wrapper_test.py
  17. cxx_test.py
  18. depfile.py
  19. depfile_test.py
  20. detail-diff.sh
  21. dlwrap.py
  22. dlwrap_test.py
  23. fuchsia-reproxy-wrap.sh
  24. fuchsia-reproxy.cfg
  25. fuchsia-rewrapper.cfg
  26. fuchsia.py
  27. fuchsia_test.py
  28. linker.py
  29. linker_test.py
  30. log-it.sh
  31. output_leak_scanner.py
  32. output_leak_scanner_test.py
  33. pb_message_util.py
  34. pb_message_util_test.py
  35. prebuilt_tool_remote_wrapper.py
  36. prebuilt_tool_remote_wrapper_test.py
  37. python_with_pb_test.sh
  38. README.md
  39. reclient_cxx.sh
  40. relativize_args.py
  41. relativize_args_test.py
  42. remote_action.py
  43. remote_action_test.py
  44. remotetool.py
  45. remotetool.sh
  46. remotetool_test.py
  47. reproxy_logs.py
  48. reproxy_logs_test.py
  49. rpl_tool.py
  50. rpl_tool_test.py
  51. rustc.py
  52. rustc_remote_wrapper.py
  53. rustc_remote_wrapper_test.py
  54. rustc_test.py
  55. test_all.sh
  56. textpb.py
  57. textpb_test.py
  58. upload_reproxy_logs.py
  59. upload_reproxy_logs_test.py
build/rbe/README.md

This directory contains support for building the Fuchsia tree with build actions running on RBE (remote build execution).

Remote execution wrappers

The top-level remote execution wrappers are used as command prefixes:

  • cxx_remote_wrapper.py: prefix wrapper for remote compiling C++
  • rustc_remote_wrapper.py: prefix wrapper for remote compiling Rust
    • Detects and gathers all inputs and tools needed for remote compiling.
    • Detects extra outputs to download produced by remote compiling.
  • remote_action.py: prefix wrapper for generic remote actions
    • Exists as standalone wrapper and library.
    • Includes detailed diagnostics for certain error conditions.
    • Includes limited fault-tolerance and retries.
    • The C++ and Rust wrappers inherit all of the features of this generic script.
  • fuchsia-reproxy-wrap.sh: automatically start/shutdown reproxy (needed by rewrapper) around any command. Used by fx build.

More details can be found by running with --help.

Support scripts

  • cl_utils.py: generic command-line operation library
  • cxx.py: for understanding structure of C/C++ compile commands
  • fuchsia.py: Fuchsia-tree specific directory layouts and conventions. Parties interested in re-using wrapper scripts found here should expect to replace this file.
  • output_leak_scanner.py: Check that commands and outputs do not leak the name of the build output directory, for better caching outcomes.
  • relativize_args.py: Attempt to transform commands with absolute paths into equivalent commands with relative paths. This can be useful for build systems that insist on absolute paths, like cmake.
  • rustc.py: for understanding structure of rustc compile commands

Configurations

  • fuchsia-rewrapper.cfg: rewrapper configuration
  • fuchsia-reproxy.cfg: reproxy configuration

Troubleshooting tools

  • action_diff.sh: recursively queries through two reproxy logs to root-cause differences between output and intermediate artifacts. This is useful for examining unexpected digest differences and cache misses.
  • bbtool.py: buildbucket related tools
    • fetch_reproxy_log: retrieve .rrpl log, possibly from subbuild.
  • bb_fetch_rbe_cas.sh: retrieve a remote-built artifact from the RBE CAS using a buildbucket id and the path under the build output directory.
  • detail-diff.sh: attempts to compare human-readable representations of files, including some binary files, by using tools like objdump.
  • remotetool.sh: can lookup actions and artifacts in the RBE CAS. From: https://github.com/bazelbuild/remote-apis-sdks
  • reproxy_logs.sh: subcommand utility
    • diff: report meaningful difference between two reproxy logs
    • output_file_digest: lookup the digest of a remote built artifact
    • bandwidth: report total download and upload bytes from reproxy log
    • plot_download: plot download demand over the course of a build
  • rpl_tool.sh: tools that involve reproxy logs and remotetool together
    • expand_to_rpl: populate .rrpl with command and inputs -> .rpl

All tools have more detailed usage with --help.

GN files

  • build/toolchain/rbe.gni: global args.gn variables for RBE

  • build/toolchain/clang_toolchain.gni: uses RBE wrappers depending on configuration

  • build/rust/rustc_*.gni: uses RBE wrappers depending on configuration

Metrics and logs

  • upload_reproxy_logs.py: pushes RBE metrics and detailed logs to BigQuery.

    • This can be enabled by fx build-metrics.
  • pb_message_util.py: library for translating protobufs to JSON