2018-10-09 18:30:41 +00:00
# Architecture
2019-01-08 23:47:12 +00:00
This document describes the high-level architecture of rust-analyzer.
2018-10-09 18:30:41 +00:00
If you want to familiarize yourself with the code base, you are just
in the right place!
2019-01-21 08:26:15 +00:00
See also the [guide ](./guide.md ), which walks through a particular snapshot of
rust-analyzer code base.
2019-03-20 13:05:49 +00:00
Yet another resource is this playlist with videos about various parts of the
analyzer:
https://www.youtube.com/playlist?list=PL85XCvVPmGQho7MZkdW-wtPtuJcFpzycE
2019-02-28 19:08:17 +00:00
2020-01-29 14:08:31 +00:00
Note that the guide and videos are pretty dated, this document should be in
generally fresher.
2018-12-17 21:13:50 +00:00
## The Big Picture
On the highest level, rust-analyzer is a thing which accepts input source code
from the client and produces a structured semantic model of the code.
More specifically, input data consists of a set of test files (`(PathBuf,
2020-01-29 14:08:31 +00:00
String)` pairs) and information about project structure, captured in the so
called `CrateGraph` . The crate graph specifies which files are crate roots,
which cfg flags are specified for each crate and what dependencies exist between
the crates. The analyzer keeps all this input data in memory and never does any
IO. Because the input data are source code, which typically measures in tens of
megabytes at most, keeping everything in memory is OK.
2018-12-17 21:13:50 +00:00
2018-12-20 13:34:16 +00:00
A "structured semantic model" is basically an object-oriented representation of
2018-12-17 21:13:50 +00:00
modules, functions and types which appear in the source code. This representation
is fully "resolved": all expressions have types, all references are bound to
declarations, etc.
The client can submit a small delta of input data (typically, a change to a
single file) and get a fresh code model which accounts for changes.
2019-01-08 23:47:12 +00:00
The underlying engine makes sure that model is computed lazily (on-demand) and
can be quickly updated for small modifications.
2018-12-17 21:13:50 +00:00
2018-10-09 18:30:41 +00:00
## Code generation
Some of the components of this repository are generated through automatic
2020-01-29 14:08:31 +00:00
processes. `cargo xtask codegen` runs all generation tasks. Generated code is
2020-05-01 13:43:08 +00:00
committed to the git repository.
2020-01-29 14:08:31 +00:00
In particular, `cargo xtask codegen` generates:
1. [`syntax_kind/generated` ](https://github.com/rust-analyzer/rust-analyzer/blob/a0be39296d2925972cacd9fbf8b5fb258fad6947/crates/ra_parser/src/syntax_kind/generated.rs )
-- the set of terminals and non-terminals of rust grammar.
2018-10-09 18:30:41 +00:00
2020-01-29 14:08:31 +00:00
2. [`ast/generated` ](https://github.com/rust-analyzer/rust-analyzer/blob/a0be39296d2925972cacd9fbf8b5fb258fad6947/crates/ra_syntax/src/ast/generated.rs )
-- AST data structure.
2018-10-09 18:30:41 +00:00
2020-04-28 14:18:12 +00:00
3. [`doc_tests/generated` ](https://github.com/rust-analyzer/rust-analyzer/blob/a0be39296d2925972cacd9fbf8b5fb258fad6947/crates/ra_assists/src/doc_tests/generated.rs ),
2020-01-29 14:08:31 +00:00
[`test_data/parser/inline` ](https://github.com/rust-analyzer/rust-analyzer/tree/a0be39296d2925972cacd9fbf8b5fb258fad6947/crates/ra_syntax/test_data/parser/inline )
-- tests for assists and the parser.
The source for 1 and 2 is in [`ast_src.rs` ](https://github.com/rust-analyzer/rust-analyzer/blob/a0be39296d2925972cacd9fbf8b5fb258fad6947/xtask/src/ast_src.rs ).
2018-10-09 18:30:41 +00:00
## Code Walk-Through
2019-03-20 13:05:49 +00:00
### `crates/ra_syntax`, `crates/ra_parser`
2018-10-09 18:30:41 +00:00
Rust syntax tree structure and parser. See
2020-01-29 14:08:31 +00:00
[RFC ](https://github.com/rust-lang/rfcs/pull/2256 ) and [./syntax.md ](./syntax.md ) for some design notes.
2018-10-09 18:30:41 +00:00
- [rowan ](https://github.com/rust-analyzer/rowan ) library is used for constructing syntax trees.
2019-01-08 23:47:12 +00:00
- `grammar` module is the actual parser. It is a hand-written recursive descent parser, which
2019-08-07 17:18:47 +00:00
produces a sequence of events like "start node X", "finish node Y". It works similarly to [kotlin's parser ](https://github.com/JetBrains/kotlin/blob/4d951de616b20feca92f3e9cc9679b2de9e65195/compiler/frontend/src/org/jetbrains/kotlin/parsing/KotlinParsing.java ),
2019-01-08 23:47:12 +00:00
which is a good source of inspiration for dealing with syntax errors and incomplete input. Original [libsyntax parser ](https://github.com/rust-lang/rust/blob/6b99adeb11313197f409b4f7c4083c2ceca8a4fe/src/libsyntax/parse/parser.rs )
2018-10-09 18:30:41 +00:00
is what we use for the definition of the Rust language.
2020-01-29 14:08:31 +00:00
- `TreeSink` and `TokenSource` traits bridge the tree-agnostic parser from `grammar` with `rowan` trees.
2019-01-08 23:47:12 +00:00
- `ast` provides a type safe API on top of the raw `rowan` tree.
2020-01-29 14:08:31 +00:00
- `ast_src` description of the grammar, which is used to generate `syntax_kinds`
and `ast` modules, using `cargo xtask codegen` command.
2018-10-09 18:30:41 +00:00
2019-08-07 17:23:10 +00:00
Tests for ra_syntax are mostly data-driven: `test_data/parser` contains subdirectories with a bunch of `.rs`
2018-10-09 18:30:41 +00:00
(test vectors) and `.txt` files with corresponding syntax trees. During testing, we check
`.rs` against `.txt` . If the `.txt` file is missing, it is created (this is how you update
2019-10-23 15:17:24 +00:00
tests). Additionally, running `cargo xtask codegen` will walk the grammar module and collect
2019-08-07 17:23:10 +00:00
all `// test test_name` comments into files inside `test_data/parser/inline` directory.
2018-10-09 18:30:41 +00:00
2020-01-29 14:08:31 +00:00
Note
[`api_walkthrough` ](https://github.com/rust-analyzer/rust-analyzer/blob/2fb6af89eb794f775de60b82afe56b6f986c2a40/crates/ra_syntax/src/lib.rs#L190-L348 )
in particular: it shows off various methods of working with syntax tree.
2018-10-09 18:30:41 +00:00
See [#93 ](https://github.com/rust-analyzer/rust-analyzer/pull/93 ) for an example PR which
fixes a bug in the grammar.
2018-12-17 20:23:39 +00:00
### `crates/ra_db`
2018-12-10 14:07:07 +00:00
2019-01-05 11:32:51 +00:00
We use the [salsa ](https://github.com/salsa-rs/salsa ) crate for incremental and
2018-12-17 20:23:39 +00:00
on-demand computation. Roughly, you can think of salsa as a key-value store, but
it also can compute derived values using specified functions. The `ra_db` crate
2019-01-08 23:47:12 +00:00
provides basic infrastructure for interacting with salsa. Crucially, it
2018-12-20 10:47:32 +00:00
defines most of the "input" queries: facts supplied by the client of the
analyzer. Reading the docs of the `ra_db::input` module should be useful:
2018-12-20 13:34:16 +00:00
everything else is strictly derived from those inputs.
2018-10-09 18:30:41 +00:00
2020-01-29 14:08:31 +00:00
### `crates/ra_hir*` crates
2018-10-09 18:30:41 +00:00
2018-12-20 13:34:16 +00:00
HIR provides high-level "object oriented" access to Rust code.
2018-10-09 18:30:41 +00:00
2018-12-17 20:23:39 +00:00
The principal difference between HIR and syntax trees is that HIR is bound to a
2020-01-29 14:08:31 +00:00
particular crate instance. That is, it has cfg flags and features applied. So,
the relation between syntax and HIR is many-to-one. The `source_binder` module
is responsible for guessing a HIR for a particular source position.
2018-10-09 18:30:41 +00:00
2018-12-20 13:34:16 +00:00
Underneath, HIR works on top of salsa, using a `HirDatabase` trait.
2018-10-09 18:30:41 +00:00
2020-01-29 14:08:31 +00:00
`ra_hir_xxx` crates have a strong ECS flavor, in that they work with raw ids and
2020-05-01 13:43:08 +00:00
directly query the database.
2020-01-29 14:08:31 +00:00
The top-level `ra_hir` façade crate wraps ids into a more OO-flavored API.
2019-11-27 18:32:33 +00:00
### `crates/ra_ide`
2018-10-09 18:30:41 +00:00
2019-01-08 19:45:52 +00:00
A stateful library for analyzing many Rust files as they change. `AnalysisHost`
is a mutable entity (clojure's atom) which holds the current state, incorporates
2019-01-08 23:47:12 +00:00
changes and hands out `Analysis` --- an immutable and consistent snapshot of
the world state at a point in time, which actually powers analysis.
2018-10-09 18:30:41 +00:00
2019-01-08 19:45:52 +00:00
One interesting aspect of analysis is its support for cancellation. When a
change is applied to `AnalysisHost` , first all currently active snapshots are
2019-01-08 23:47:12 +00:00
canceled. Only after all snapshots are dropped the change actually affects the
2018-12-17 20:34:07 +00:00
database.
2019-01-08 19:45:52 +00:00
APIs in this crate are IDE centric: they take text offsets as input and produce
offsets and strings as output. This works on top of rich code model powered by
`hir` .
2018-10-09 18:30:41 +00:00
2020-02-18 11:33:16 +00:00
### `crates/rust-analyzer`
2019-01-08 19:45:52 +00:00
2019-11-27 18:32:33 +00:00
An LSP implementation which wraps `ra_ide` into a language server protocol.
2019-01-08 19:45:52 +00:00
2019-03-20 13:05:49 +00:00
### `ra_vfs`
2019-01-08 19:45:52 +00:00
2019-11-27 18:32:33 +00:00
Although `hir` and `ra_ide` don't do any IO, we need to be able to read
2019-01-08 19:45:52 +00:00
files from disk at the end of the day. This is what `ra_vfs` does. It also
manages overlays: "dirty" files in the editor, whose "true" contents is
2019-03-20 13:05:49 +00:00
different from data on disk. This is more or less the single really
platform-dependent component, so it lives in a separate repository and has an
extensive cross-platform CI testing.
2019-01-08 19:45:52 +00:00
2019-03-20 13:05:49 +00:00
## Testing Infrastructure
2019-01-22 21:39:21 +00:00
2019-03-20 14:22:22 +00:00
Rust Analyzer has three interesting [systems
boundaries](https://www.tedinski.com/2018/04/10/making-tests-a-positive-influence-on-design.html)
to concentrate tests on.
2020-02-18 11:33:16 +00:00
The outermost boundary is the `rust-analyzer` crate, which defines an LSP
2019-03-20 14:22:22 +00:00
interface in terms of stdio. We do integration testing of this component, by
feeding it with a stream of LSP requests and checking responses. These tests are
known as "heavy", because they interact with Cargo and read real files from
disk. For this reason, we try to avoid writing too many tests on this boundary:
in a statically typed language, it's hard to make an error in the protocol
itself if messages are themselves typed.
2019-11-27 18:32:33 +00:00
The middle, and most important, boundary is `ra_ide` . Unlike
2020-02-18 11:33:16 +00:00
`rust-analyzer` , which exposes API, `ide` uses Rust API and is intended to
2019-03-20 14:22:22 +00:00
use by various tools. Typical test creates an `AnalysisHost` , calls some
`Analysis` functions and compares the results against expectation.
The innermost and most elaborate boundary is `hir` . It has a much richer
2019-11-27 18:32:33 +00:00
vocabulary of types than `ide` , but the basic testing setup is the same: we
2019-03-20 14:22:22 +00:00
create a database, run some queries, assert result.
For comparisons, we use [insta ](https://github.com/mitsuhiko/insta/ ) library for
snapshot testing.
To test various analysis corner cases and avoid forgetting about old tests, we
use so-called marks. See the `marks` module in the `test_utils` crate for more.
