Skip to content

Fix high CPU usage due to inotify watch triggering itself#5905

Merged
laurmaedje merged 7 commits intotypst:mainfrom
aodenis:fix-high-cpu-usage-watch
Feb 25, 2025
Merged

Fix high CPU usage due to inotify watch triggering itself#5905
laurmaedje merged 7 commits intotypst:mainfrom
aodenis:fix-high-cpu-usage-watch

Conversation

@aodenis
Copy link
Contributor

@aodenis aodenis commented Feb 19, 2025

On Linux, inotify is used to monitor filesystem changes. inotify events are then filtered to check whether they are relevant and must trigger a recompilation, but this check opens the file, which trigger an inotify event, creating a busy loop.

This commit swaps the order of the checks done in is_event_relevant in order to filter out the open events caused by is_same_file without triggering new ones.

@aodenis aodenis mentioned this pull request Feb 19, 2025
Closed
1 task
laurmaedje
laurmaedje reviewed Feb 21, 2025
View reviewed changes
@laurmaedje
Copy link
Member

laurmaedje commented Feb 23, 2025

After further thinking, I'm not convinced we need the is_same_file check at all anymore. It's a remnant from times where we watched the whole root directory recursively. Nowadays, the CLI watches every path separately, so saving the PDF shouldn't trigger an event at all.

That is, unless one does read("output.pdf", encoding: none), but then one really asked for it and compiling in a loop doesn't seem like technically wrong behaviour to me then. Notably, the current check is not effective anyway for multipage PNG and SVG output, as output will contain a page number template.

@aodenis
Copy link
Contributor Author

aodenis commented Feb 23, 2025

I removed the check. I did not remove same-file from cargo manifests as cargo remove would change the manifests too much.

@laurmaedje
Copy link
Member

laurmaedje commented Feb 23, 2025

Why not remove it by hand?

@aodenis
Copy link
Contributor Author

aodenis commented Feb 23, 2025

I hadn't seen it was a dependency of walkdir, that's why cargo remove removed too many stuff

@laurmaedje laurmaedje force-pushed the fix-high-cpu-usage-watch branch from a4b6f9a to b3db266 Compare February 25, 2025 12:37
@laurmaedje
Copy link
Member

laurmaedje commented Feb 25, 2025

I discussed with @PgBiel and he considered it too big of a footgun that the CLI could end up in a loop when one reads the output file. So I reverted that part.

The output check does not work properly for multifile image export, but that's not a regression and can be considered separately. Dealing with that properly is a bit complicated.

Thanks for the investigation here!

@laurmaedje laurmaedje added this pull request to the merge queue Feb 25, 2025
Merged via the queue into typst:main with commit acd3a5b Feb 25, 2025
6 checks passed
laurmaedje added a commit that referenced this pull request Feb 25, 2025
@aodenis @laurmaedje
Fix high CPU usage due to inotify watch triggering itself (#5905)
a754be5 
Co-authored-by: Laurenz <laurmaedje@gmail.com>
@wamserma wamserma mentioned this pull request Feb 27, 2025
Merged
13 tasks
wamserma added a commit to wamserma/nixpkgs that referenced this pull request Feb 27, 2025
@wamserma
typst: fix high cpu load when using typst watch
1c27c12 
This adopts a merged PR from upstream to fix the issue until a new
release is provided by upstream.

Upstream PR: typst/typst#5905
@Myriad-Dreamin Myriad-Dreamin mentioned this pull request Mar 20, 2025
Closed
1 task
hongjr03 pushed a commit to hongjr03/typst that referenced this pull request Apr 16, 2025
@aodenis @laurmaedje @hongjr03
Fix high CPU usage due to inotify watch triggering itself (typst#5905)
57eb8d1 
Co-authored-by: Laurenz <laurmaedje@gmail.com>
stelzo pushed a commit to stelzo/typst that referenced this pull request Nov 21, 2025
@tetofonta @stelzo
git modules and vendoring
5aadbf2 
git download method

fixed warinings

documentation

cli updater adaptation and clippy fixes

enhanced documentation

add git downloader default impl

migrating from git2 to gitoxide crate for git downloads

Add support for `c2sc` OpenType feature in `smallcaps` (typst#5655)

Just add MathText SyntaxKind

Basic SymbolElem addition

Use SymbolElem in more places and add `char` cast for content

Add SymbolElem to realization

Update math TextElem layout to separate out SymbolElem

Handle boxes and blocks a bit better in HTML export (typst#5744)

Co-authored-by: Martin Haug <3874949+reknih@users.noreply.github.com>

Tweak HTML pretty printing (typst#5745)

Semantic paragraphs (typst#5746)

Fix space collapsing for explicit paragraphs (typst#5749)

Support first-line-indent for every paragraph (typst#5768)

Fixed typo in the new outline docs (typst#5772)

Resolve bound name of bare import statically (typst#5773)

Fix typo in scripting.md (typst#5783)

Modular, multi-threaded, transitioning plugins (typst#5779)

Include images from raw pixmaps and more (typst#5632)

Co-authored-by: PgBiel <9021226+PgBiel@users.noreply.github.com>
Co-authored-by: Laurenz <laurmaedje@gmail.com>

Change type repr to short name (typst#5788)

Disable cjk_latin_spacing in raw by default (typst#5753)

Change the default math class of U+22A5 ⊥ UP TACK to Normal (typst#5714)

Revert adding `flatten-text` to `image` (typst#5789)

Refactor `Scope` (typst#5797)

Enable HTML feature in docs generator (typst#5800)

Scope deprecations (typst#5798)

Fix typo in page documentation (typst#5804)

Bump openssl from 0.10.66 to 0.10.70 (typst#5802)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bump codex to 0.1.0 (typst#5805)

Bump dependencies (typst#5808)

Fix small copy-paste oversight (typst#5811)

Bump more dependencies (typst#5813)

Export target docs (typst#5812)

Co-authored-by: Martin Haug <3874949+reknih@users.noreply.github.com>

0.13 changelog (typst#5801)

Release Candidate 1

Autocomplete content methods (typst#5822)

Documentation fixes and improvements (typst#5816)

Fix docs outline for nested definitions (typst#5823)

Document removals in changelog (typst#5827)

Fix unnecessary import rename warning (typst#5828)

Don't crash on image with zero DPI (typst#5835)

Add warning for `pdf.embed` elem used with HTML (typst#5829)

Add smart quotes for Bulgarian (typst#5807)

Respect `par` constructor arguments (typst#5842)

Bump `typst-assets`

Fix autocomplete and jumps in math (typst#5849)

Update documentation for `float.{to-bits, from-bits}` (typst#5836)

`Gradient::repeat`: Fix floating-point error in stop calculation (typst#5837)

Lazy parsing of the package index (typst#5851)

Remove Linux Libertine warning (typst#5876)

Bring back type/str compatibility for 0.13, with warnings and hints (typst#5877)

More robust SVG auto-detection (typst#5878)

HTML export: Use `<code>` for inline `RawElem` (typst#5884)

--make-deps fixes (typst#5873)

Update changelog (typst#5894)

Version bump

Fix HTML export of table with gutter (typst#5920)

Fix comparison of `Func` and `NativeFuncData` (typst#5943)

HTML export: fix elem counting on classify_output (typst#5910)

Co-authored-by: Laurenz <laurmaedje@gmail.com>

Fix introspection of HTML root sibling metadata (typst#5953)

Fix high CPU usage due to inotify watch triggering itself (typst#5905)

Co-authored-by: Laurenz <laurmaedje@gmail.com>

Fix false positive for type/str comparison warning (typst#5957)

Fix paper name in page setup guide (typst#5956)

Fix curve with multiple non-closed components. (typst#5963)

Fix docs example with type/string comparison (typst#5987)

Correct typo (typst#5971)

Make `array.chunks` example more readable (typst#5975)

Hotfix for labels on symbols (typst#6015)

Replace `par` function call in tutorial (typst#6023)

Mention that `sym.ohm` was removed in the 0.13.0 changelog (typst#6017)

Co-authored-by: Laurenz <laurmaedje@gmail.com>

Mark breaking symbol changes as breaking in 0.13.0 changelog (typst#6024)

0.13.1 changelog (typst#6025)

Version bump

dep min 1.81

use 1.81 in ci
stelzo pushed a commit to stelzo/typst that referenced this pull request Nov 21, 2025
@tetofonta @stelzo
git modules and vendoring
451581f 
git download method

fixed warinings

documentation

cli updater adaptation and clippy fixes

enhanced documentation

add git downloader default impl

migrating from git2 to gitoxide crate for git downloads

Add support for `c2sc` OpenType feature in `smallcaps` (typst#5655)

Just add MathText SyntaxKind

Basic SymbolElem addition

Use SymbolElem in more places and add `char` cast for content

Add SymbolElem to realization

Update math TextElem layout to separate out SymbolElem

Handle boxes and blocks a bit better in HTML export (typst#5744)

Co-authored-by: Martin Haug <3874949+reknih@users.noreply.github.com>

Tweak HTML pretty printing (typst#5745)

Semantic paragraphs (typst#5746)

Fix space collapsing for explicit paragraphs (typst#5749)

Support first-line-indent for every paragraph (typst#5768)

Fixed typo in the new outline docs (typst#5772)

Resolve bound name of bare import statically (typst#5773)

Fix typo in scripting.md (typst#5783)

Modular, multi-threaded, transitioning plugins (typst#5779)

Include images from raw pixmaps and more (typst#5632)

Co-authored-by: PgBiel <9021226+PgBiel@users.noreply.github.com>
Co-authored-by: Laurenz <laurmaedje@gmail.com>

Change type repr to short name (typst#5788)

Disable cjk_latin_spacing in raw by default (typst#5753)

Change the default math class of U+22A5 ⊥ UP TACK to Normal (typst#5714)

Revert adding `flatten-text` to `image` (typst#5789)

Refactor `Scope` (typst#5797)

Enable HTML feature in docs generator (typst#5800)

Scope deprecations (typst#5798)

Fix typo in page documentation (typst#5804)

Bump openssl from 0.10.66 to 0.10.70 (typst#5802)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bump codex to 0.1.0 (typst#5805)

Bump dependencies (typst#5808)

Fix small copy-paste oversight (typst#5811)

Bump more dependencies (typst#5813)

Export target docs (typst#5812)

Co-authored-by: Martin Haug <3874949+reknih@users.noreply.github.com>

0.13 changelog (typst#5801)

Release Candidate 1

Autocomplete content methods (typst#5822)

Documentation fixes and improvements (typst#5816)

Fix docs outline for nested definitions (typst#5823)

Document removals in changelog (typst#5827)

Fix unnecessary import rename warning (typst#5828)

Don't crash on image with zero DPI (typst#5835)

Add warning for `pdf.embed` elem used with HTML (typst#5829)

Add smart quotes for Bulgarian (typst#5807)

Respect `par` constructor arguments (typst#5842)

Bump `typst-assets`

Fix autocomplete and jumps in math (typst#5849)

Update documentation for `float.{to-bits, from-bits}` (typst#5836)

`Gradient::repeat`: Fix floating-point error in stop calculation (typst#5837)

Lazy parsing of the package index (typst#5851)

Remove Linux Libertine warning (typst#5876)

Bring back type/str compatibility for 0.13, with warnings and hints (typst#5877)

More robust SVG auto-detection (typst#5878)

HTML export: Use `<code>` for inline `RawElem` (typst#5884)

--make-deps fixes (typst#5873)

Update changelog (typst#5894)

Version bump

Fix HTML export of table with gutter (typst#5920)

Fix comparison of `Func` and `NativeFuncData` (typst#5943)

HTML export: fix elem counting on classify_output (typst#5910)

Co-authored-by: Laurenz <laurmaedje@gmail.com>

Fix introspection of HTML root sibling metadata (typst#5953)

Fix high CPU usage due to inotify watch triggering itself (typst#5905)

Co-authored-by: Laurenz <laurmaedje@gmail.com>

Fix false positive for type/str comparison warning (typst#5957)

Fix paper name in page setup guide (typst#5956)

Fix curve with multiple non-closed components. (typst#5963)

Fix docs example with type/string comparison (typst#5987)

Correct typo (typst#5971)

Make `array.chunks` example more readable (typst#5975)

Hotfix for labels on symbols (typst#6015)

Replace `par` function call in tutorial (typst#6023)

Mention that `sym.ohm` was removed in the 0.13.0 changelog (typst#6017)

Co-authored-by: Laurenz <laurmaedje@gmail.com>

Mark breaking symbol changes as breaking in 0.13.0 changelog (typst#6024)

0.13.1 changelog (typst#6025)

Version bump

dep min 1.81

use 1.81 in ci
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@laurmaedje laurmaedje laurmaedje left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@aodenis @laurmaedje