tree: fae33408dafdc0c8c6e1178f0f6a2a30a67b046d [path history] [tgz]
  1. formal_methods/
  2. inference/
  3. test/
  4. ast_helpers.h
  5. bluze.textproto
  6. BUILD
  7. macro_arg_capture.h
  8. pointer_nullability.cc
  9. pointer_nullability.h
  10. pointer_nullability_analysis.cc
  11. pointer_nullability_analysis.h
  12. pointer_nullability_analysis_benchmark.cc
  13. pointer_nullability_analysis_test.cc
  14. pointer_nullability_diagnosis.cc
  15. pointer_nullability_diagnosis.h
  16. pointer_nullability_lattice.cc
  17. pointer_nullability_lattice.h
  18. pointer_nullability_lattice_test.cc
  19. pointer_nullability_matchers.cc
  20. pointer_nullability_matchers.h
  21. pointer_nullability_matchers_test.cc
  22. pointer_nullability_test.cc
  23. pragma.cc
  24. pragma.h
  25. pragma_test.cc
  26. proto_matchers.cc
  27. proto_matchers.h
  28. README.md
  29. type_and_maybe_loc_visitor.h
  30. type_nullability.cc
  31. type_nullability.h
  32. type_nullability_test.cc
nullability/README.md

C++ nullability analysis

Annotating C++ API boundaries with nullability information can improve their Rust bindings (e.g. binding non-null pointers as T& rather than Option<T&>).

This directory has tools for C++ codebases that use such annotations:

  • Nullability inference suggests annotations to add to APIs, by analyzing the code that implements and uses them.

  • Nullability verification verifies that annotated APIs are used and implemented safely, e.g. checking nullable pointers before dereferencing them. This is a local analysis suitable for use in a clang-tidy check.

They use Clang, its dataflow framework, and its nullability annotations.

Style

This directory mostly uses LLVM-style C++, rather than Google-style C++ used in the rest of crubit/. The goal is to make it easy to upstream into clang-tidy once mature.

Specifically:

  • We follow the LLVM coding standards, with the exceptions listed here.
  • We use absl CHECK() rather than assert(). (This finds bugs more reliably, and is trivial to migrate later.)
  • We otherwise avoid relying on absl, using llvm's Support libraries instead.
  • We write // TODO instead of // FIXME.

This list isn‘t set in stone: we can choose to diverge further from LLVM style, if it’s worth more cost of upstreaming later.