tree: 1e7d873380238fe38636790b66cc789c55b2af13 [path history] [tgz]
  1. OWNERS
  2. README.md
  3. _toc.yaml
  4. fidl-tests-and-gn.md
docs/contribute/contributing-to-fidl/README.md

Contributing to FIDL

Overview

The FIDL toolchain is composed of roughly three parts:

  1. Front-end, a.k.a. fidlc
    • Parses and validates .fidl files
    • Calculates size, alignment, and offset of various structures
    • Produces a JSON IR (Intermediate Representation)
  2. Back-end
    • Works off the IR (except the C back-end)
    • Produces target language specific code, which ties into the libraries for that language
  3. Runtime Libraries
    • Implement encoding/decoding/validation of messages
    • Method dispatching mechanics

Code Location

The front-end lives at //zircon/tools/fidl/, with tests in //zircon/system/utest/fidl-compiler/.

The back-end and runtime library locations are based on the target:

TargetBack-endRuntime Libraries
C//zircon/tools/fidl/lib/c_generator.cc//zircon/system/ulib/fidl/
C++//tools/fidl/fidlgen_hlcpp///zircon/system/ulib/fidl/ & //sdk/lib/fidl/cpp/
Go//tools/fidl/fidlgen_go///third_party/go/src/syscall/zx/fidl/
Rust//tools/fidl/fidlgen_rust///src/lib/fidl/rust/fidl/
Dart//topaz/bin/fidlgen_dart///topaz//public/dart/fidl/
//topaz/bin/fidl_bindings_test/

Other FIDL Tools

A number of FIDL tools are located in the fidl-misc repo. To clone this repo, run

git clone https://fuchsia.googlesource.com/fidl-misc

It is then recommended to export the path to this directory, to make setting aliases easier:

export FIDLMISC_DIR=...

TBD: linter, formatter, gidl, difl, regen scripts, etc.

Common Development Tools

This is a crowdsourced section from the FIDL team on useful tools that they use for working on the FIDL codebase.

IDEs

Most of the FIDL team uses VSCode for development. Some useful plugins and workflows:

  • The remote ssh feature works really well for doing remote work from your laptop.

    • Setting up tmux or screen is also helpful for remote work, to preserve history and manage multiple sessions in the shell.
  • The Fuchsia documentation has instructions for setting up language servers:

  • The rewrap extension is useful for automatically reflowing lines to a certain length (e.g. when editing markdown files).

  • To get automatic syntax highlighting for the bindings golden files, update the file.associations setting:

    "files.associations": {
          "*.test.json.golden": "json",
          "*.test.json.rs.golden": "rust",
          "*.test.json.cc.golden": "cpp",
          "*.test.json.h.golden": "cpp",
          "*.test.json.llcpp.cc.golden": "cpp",
          "*.test.json.llcpp.h.golden": "cpp",
          "*.test.json.go.golden": "go",
          "*.test.json_async.dart.golden": "dart",
          "*.test.json_test.dart.golden": "dart"
    },
    

C++ Style Guide

We follow the Fuchsia C++ Style Guide, with additional rules to further remove ambiguity around the application or interpretation of guidelines.

Constructors

Always place the initializer list on a line below the constructor.

// Don't do this.
SomeClass::SomeClass() : field_(1), another_field_(2) {}

// Correct.
SomeClass::SomeClass()
    : field_(1), another_field_(2) {}

Comments

Comments must respect 80 columns line size limit, unlike code which can extend to 100 lines size limit.

Lambda captures
  • If a lambda escapes the current scope, capture all variables explicitly.
  • If the lambda is local (does not escape the current scope), prefer using a default capture by reference (“[&]”).

Seeing [&] is a strong signal that the lambda exists within the current scope only, and can be used to distinguish local from non-local lambdas.

// Correct.
std::set<const flat::Library*, LibraryComparator> dependencies;
auto add_dependency = [&](const flat::Library* dep_library) {
  if (!dep_library->HasAttribute("Internal")) {
    dependencies.insert(dep_library);
  }
};

General Setup

Fuchsia Setup

Read the Fuchsia Getting Started guide first.

fx set

If you are working on the FIDL toolchain, use:

fx set core.x64 --with //bundles/fidl:tests --with //topaz/bundles/fidl:tests

If you are working on an LSC:

fx set terminal.x64 --with //bundles:kitchen_sink \
                    --with //topaz/packages/tests:all \
                    --with //sdk:modular_testing

symbolizer

To symbolize backtraces, you'll need a symbolizer in scope:

HOST_PLATFORM=linux-x64  # or mac-x64
export ASAN_SYMBOLIZER_PATH="$FUCHSIA_DIR/prebuilt/third_party/clang/$HOST_PLATFORM/bin/llvm-symbolizer"

Compiling, and Running Tests

We provide mostly one-liners to run tests for the various parts. When in doubt, refer to the “Test:” comment in the git commit message; we do our best to describe the commands used to validate our work there.

Tests are run using the fidldev tool. Examples assume that the fidldev script is somewhere on your PATH, e.g. by adding an alias:

alias fidldev=$FIDLMISC_DIR/fidldev/fidldev.py

fidlc

# optional; builds fidlc for the host with ASan <https://github.com/google/sanitizers/wiki/AddressSanitizer>
fx set core.x64 --variant=host_asan

# build fidlc
fx build zircon/tools

If you're doing extensive edit-compile-test cycles on fidlc, building with fewer optimizations can make a significant difference in the build speed. To do this, change the optimization setting in zircon/public/gn/config/levels.gni from default to debug or none.

Warning: The kernel is not regularly tested with debug, and only supports none for building. Running with none can cause kernel panics from stack overflows in the kernel.

To avoid accidentally committing this change, run:

git update-index --skip-worktree zircon/public/gn/config/levels.gni

If you want to allow the changes to be committed again, run:

git update-index --no-skip-worktree zircon/public/gn/config/levels.gni

fidlc tests

fidlc tests are at:

To build and run fidlc tests:

fidldev test fidlc

To run a specific test case, use the --case flag with the fidlc test binary. The binary can be located by running fidldev test --dry-run --no-regen fidlc.

$FUCHSIA_DIR/out/default/host_x64/fidl-compiler -- --case attributes_tests

To regenerate the fidlc JSON goldens:

fidldev regen fidlc

These “golden” files are examples of what kind of JSON IR fidlc produces and are used to track changes. It is required to regenerate the golden files each time the JSON IR is changed in any way, otherwise the json_generator_tests fails.

fidlgen (LLCPP, HLCPP, Rust, Go)

Build:

fx build tools/fidl

Run:

$FUCHSIA_DIR/out/default/host_x64/fidlgen_{llcpp, hlcpp, rust, go}

Some example tests you can run:

fx run-host-tests fidlgen_hlcpp_test
fx run-host-tests fidlgen_golang_ir_test
fidldev test --no-regen fidlgen

To regenerate the goldens:

fidldev regen fidlgen

fidlgen_dart

Build:

fx ninja -C out/default host_x64/fidlgen_dart

Run:

$FUCHSIA_DIR/out/default/host_x64/fidlgen_dart

Some example tests you can run:

fidldev test --no-regen fidlgen_dart

To regenerate the goldens:

fidldev regen fidlgen_dart

Bindings

fidldev supports tests for each of the bindings. Some of the bindings tests run on device and require having Fuchsia running in an emulator. Here are the steps:

Tab 1> fx build && fx serve-updates

Tab 2> fx qemu -kN

The -k flag enables KVM. It is not required, but the emulator is much slower without it. The -N flag enables networking.

The bindings tests can then be run with fidldev:

fidldev test --no-regen hlcpp
fidldev test --no-regen llcpp
fidldev test --no-regen c
fidldev test --no-regen go
fidldev test --no-regen rust
fidldev test --no-regen dart

Alternatively, run fidldev with no arguments to test files that have changed:

fidldev test

To run a specific test or to pass flags to a specific test, run fidldev with the --dry-run, --no-build, --no-regen flags to obtain the desired test commands.

Compatibility Test

Details about how the compatibility tests work and where the code is located can be found in the README at //src/tests/fidl/compatibility.

To run the compatibility tests, you first need to have Fuchsia running in an emulator:

Tab 1> fx build && fx serve

Tab 2> fx qemu -kN

To run the compatibility tests:

Tab 3> fx set core.x64 --with-base //garnet/packages/tests:zircon --with //garnet/packages/tests:all
Tab 3> fx test fidl-compatibility-test

GIDL

To rebuild GIDL:

fx build host-tools/gidl

Measure Tape

fx set core.x64 --with //tools/fidl/measure-tape:host
fx build

All Tests

NameTest CommandCoverage
gidl parserfx test gidl_parser_test//tools/fidl/gidl/parser
fidlgen type definitionsfx test fidlgen_types_test//garnet/go/src/fidl/compiler/backend/types
fidlgen hlcppfx test fidlgen_hlcpp_test//tools/fidl/fidlgen_hlcpp
fidlgen llcppfx test fidlgen_llcpp_test//tools/fidl/fidlgen_llcpp
fidlgen golangfx test fidlgen_go_test//tools/fidl/fidlgen_golang
fidlgen rustfx test fidlgen_rust_test//tools/fidl/fidlgen_rust
fidlgen syzkallerfx test fidlgen_syzkaller_test//tools/fidl/fidlgen_syzkaller
fidlgen dartfx test fidlgen_dart_backend_test//topaz/bin/fidlgen_dart
fidl c runtime testfx test //src/lib/fidl/c//zircon/system/ulib/fidl
c++ host unittestsfx test fidl_cpp_host_unittests//sdk/lib/fidl
c++ bindings testsfx test fidl_tests//sdk/lib/fidl
llcpp bindings testsfx test fidl_llcpp_types_test//tools/fidl/fidlgen_llcpp //zircon/system/ulib/fidl
go bindings testsfx test go_fidl_tests//third_party/go/syscall/zx/fidl third_party/go/syscall/zx/fidl/fidl_test
dart bindings testsfx test fidl_bindings_test//topaz/public/dart/fidl
rust bindings testsfx test fidl-rust-tests//src/lib/fidl/rust/fidl
measure tape testfx test measure-tape-tests//tools/fidl/measure-tape

All Benchmarks

Benchmarks can either be run directly or through one of two test runners: fuchsia_benchmarks (old), SL4F (new).

Benchmarks on chromeperf are currently generated through the fuchsia_benchmarks runner but are transitioning to SL4F. During this transition, benchmarks should be integrated in both systems.

Directly running benchmarks

Ensure that the benchmarks are included in your build:

fx set core.x64 --with //src/tests/benchmarks

You will need to fx build and restart qemu for the packages to be available.

Available benchmarks:

NameBenchmark CommandNotes
Go Benchmarksfx shell /bin/go_fidl_microbenchmarks
Rust Benchmarksfx shell /bin/rust_fidl_microbenchmarks /tmp/myresultsfileResults can be viewed with fx shell cat /tmp/myresultsfile/
LLCPP benchmarksfx shell /bin/llcpp_fidl_microbenchmarks
lib/fidl Benchmarksfx shell /bin/lib_fidl_microbenchmarks
Roundtrip Benchmarksfx shell /bin/roundtrip_fidl_benchmarks

Running all benchmarks with SL4F benchmark runner

This runs benchmarks the same way they are run on CQ. SL4F requires the terminal.x64 product. Use fx set to switch products:

fx set terminal.x64

To run all FIDL tests, use:

fx test --e2e fidl_microbenchmarks_test

All Regen Commands

NameRegen CommandsInputOutput
fidlc goldensfx exec $FUCHSIA_DIR/zircon/tools/fidl/testdata/regen.shzircon/tools/fidl/testdatazircon/tools/fidl/goldens
fidlgen goldensfx exec $FUCHSIA_DIR/garnet/go/src/fidl/compiler/backend/typestest/regen.shzircon/tools/fidl/goldensgarnet/go/src/fidl/compiler/backend/goldens
dart fidlgen goldensfx exec $FUCHSIA_DIR/topaz/bin/fidlgen_dart/regen.shzircon/tools/fidl/goldenstopaz/bin/fidlgen_dart/goldens
dangerous identifiersfx exec src/tests/fidl/dangerous_identifiers/generate.pysrc/tests/fidl/dangerous_identifiers/dangerous_identifiers.txtsrc/tests/fidl/dangerous_identifiers/{cpp, fidl}
regen third party gofx exec $FUCHSIA_DIR/third_party/go/regen-fidl
fidldoc goldensREGENERATE_GOLDENS_FOLDER=$FUCHSIA_DIR/tools/fidl/fidldoc/src/templates/markdown/testdata fx test host_x64/fidldoc_bin_test -- golden_testzircon/tools/fidl/goldenstools/fidl/fidldoc/src/templates/markdown/testdata

Compiling with ninja

In some cases, GN can build many unneeded targets. You can build a specific target with ninja instead of GN. In most cases, you can grep for the binary name to determine the ninja invocation.

For example, you can grep for fidlgen_dart:

fx ninja -C out/default -t targets all | grep -e 'fidlgen_dart:'

This example outputs a list of ninja targets which includes host_x64/fidlgen_dart. Therefore, to build fidlgen_dart run the following ninja command:

fx ninja -C out/default host_x64/fidlgen_dart

Debugging (host)

There are several ways of debugging issues in host binaries. This section gives instructions for the example case where fidlc --files test.fidl is crashing:

Note: Even with all optimizations turned off, the binaries in out/default/host_x64 are stripped. For debugging, you should use the binaries with the .debug suffix, such as out/default.zircon/host-x64-linux-clang/obj/tools/fidl/fidlc.debug.

GDB

Start GDB:

gdb --args out/default.zircon/host-x64-linux-clang/obj/tools/fidl/fidlc.debug --files test.fidl

Then, enter “r” to start the program.

ASan

Ensure you are compiling with ASan enabled:

fx set core.x64 --variant=host_asan
fx build host_x64/fidlc

Then run out/default/host_x64/fidlc --files test.fidl. That binary should be the same as out/default.zircon/host-x64-linux-asan/obj/tools/fidl/fidlc.

Valgrind

On Google Linux machines, you may need to install a standard version of Valgrind instead of using the pre-installed binary:

sudo apt-get install valgrind

Then:

valgrind -v -- out/default.zircon/host-x64-linux-clang/obj/tools/fidl/fidlc.debug --files test.fidl

Workflows

Language evolutions

One common task is to evolve the language, or introduce stricter checks in fidlc. These changes typically follow a three phase approach:

  1. Write the new compiler code in fidlc;
  2. Use this updated fidlc to compile all layers, including vendor/google, make changes as needed;
  3. When all is said and done, the fidlc changes can finally be merged.

All of this assumes that (a) code which wouldn't pass the new checks, or (b) code that has new features, is not introduced concurrently between step 2 and step 3. That typically is the case, however, it is ok to deal with breaking rollers once in a while.

Go fuchsia.io and fuchsia.net

To update all the saved fidlgen files, run the following command, which automatically searches for and generates the necessary go files:

fx exec third_party/go/regen-fidl

FAQs

Why is the C back-end different than all other back-ends?

TBD

Why is fidlc in the zircon repo?

TBD

Why aren't all back-ends in one tool?

We'd actually like all back-ends to be in separate tools!

Down the road, we plan to have a script over all the various tools (fidlc, fidlfmt, the various back-ends) to make all things accessible easily, and manage the chaining of these things. For instance, it should be possible to generate Go bindings in one command such as:

fidl gen --library my_library.fidl --binding go --out-dir go/src/my/library

Or format a library in place with:

fidl fmt --library my_library.fidl -i