mirrors/foot
1
0
Fork 0
mirror of https://codeberg.org/dnkl/foot.git synced 2026-04-08 08:20:59 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

install: update PGO instructions

Browse source
This commit is contained in:
Daniel Eklöf 2020-11-14 14:31:16 +01:00
parent 5a1273eb5b
commit 27f3ca1255
No known key found for this signature in database
GPG key ID: 5BBD4992C116573F
1 changed files with 43 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

47
INSTALL.md
View file

@ -134,8 +134,7 @@ Both `-O3` and `-Db_lto=true` are **highly** recommended.
For performance reasons, I strongly recommend doing a For performance reasons, I strongly recommend doing a
[PGO](#profile-guided-optimization) (Profile Guided Optimization) [PGO](#profile-guided-optimization) (Profile Guided Optimization)
build. This requires a running Wayland session since we will be build.
executing an intermediate build of foot.
If you do not want this, just build: If you do not want this, just build:
@ -180,8 +179,42 @@ ninja
Next, we need to execute the intermediate build of foot, and run a Next, we need to execute the intermediate build of foot, and run a
payload inside it that will exercise the performance critical code payload inside it that will exercise the performance critical code
paths. To do this, we will use the script paths.
`scripts/generate-alt-random-writes.py`:
There are two ways to do this: a [partial PGO build using a PGO
helper](#partial-pgo) binary, or a [full PGO build](#full-pgo) by
running an intermediate foot binary. The latter has slightly better
results (i.e. results in a faster binary), but must be run in a
Wayland session.
##### Partial PGO
This method uses a PGO helper binary that links against the VT parser
only. It is similar to a mock test; it instantiates a dummy terminal
instance and then directly calls the VT parser with stimuli.
It explicitly does **not** include the Wayland backend and as such, it
does not require a running Wayland session. The downside is that not
all code paths in foot is exercised. In particular, the **rendering**
code is not. As a result, the final binary built using this method is
slightly slower than when doing a [full PGO](#full-pgo) build.
We will use the `pgo` binary along with stimuli found in `<src>/pgo`:
```sh
./pgo ../../pgo/stimuli-*.raw
```
You are now ready to [use the generated PGO
data](#use-the-generated-pgo-data).
##### Full PGO
This method requires a running Wayland session.
We will use the script `scripts/generate-alt-random-writes.py`:
```sh ```sh
foot_tmp_file=$(mktemp) foot_tmp_file=$(mktemp)
@ -192,6 +225,12 @@ rm ${foot_tmp_file}
You should see a foot window open up, with random colored text. The You should see a foot window open up, with random colored text. The
window should close after ~1-2s. window should close after ~1-2s.
##### Use the generated PGO data
Now that we have _generated_ PGO data, we need to rebuild foot. This
time telling meson (and ultimately gcc/clang) to _use_ the PGO data.
If using Clang, now do (this requires _llvm_ to have been installed): If using Clang, now do (this requires _llvm_ to have been installed):
```sh ```sh