Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Multithreading and performance optimization #211

Open
oxalica opened this issue Jun 28, 2024 · 4 comments
Open

Multithreading and performance optimization #211

oxalica opened this issue Jun 28, 2024 · 4 comments

Comments

@oxalica
Copy link

oxalica commented Jun 28, 2024

It seems that we are only using a single thread when formatting tons of files. But this can be trivially parallelized. This should also ease the adoption of format-checking in git commit hook as mentioned in NixOS/nixpkgs#322537 (comment)

Eg: fd -e nix --exec-batch nixfmt (--exec-batch passes as much files to nixfmt as possible in a single exec)
It takes takes 1:49.27 (~110s) on my machine with only a single thread (~99% CPU) being occupied.

@infinisil
Copy link
Member

infinisil commented Jun 28, 2024

We previously decided to deprecate the directory mode of nixfmt and instead encourage treefmt, for which I recently implemented parallel formatting.

So I don't think there's anything to do here, let's keep the complexity of this codebase at a minimum :)

@piegamesde
Copy link
Member

I think that there is quite a bit of code performance which Nixfmt currently leaves on the table. Someone with knowledge of profiling Haskell applications would likely find quite a few low-hanging fruits.

Off the top of my head I can already think of https://github.com/NixOS/nixfmt/blob/master/src/Nixfmt/Predoc.hs#L178-L192 which has overall quadratic complexity, but by delaying computations into a single pass at the end this could be reduced to linear. (I didn't do it when I wrote the code because it requires a minor data types refactoring and I wanted to get stuff to work first.) Of course I can't tell how much this actually affects overall performance, but there are probably quite a few like this which add up.

@toastal
Copy link
Contributor

toastal commented Nov 29, 2024

You can also run it with GNU parallel: parallel "nixfmt {}" ::: *.nix

@infinisil
Copy link
Member

I think we can close this actually, because we now deprecated recursive mode, and are recommending treefmt instead, which does run in parallel.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo
Development

No branches or pull requests

4 participants