Re: Shell startup, aliases vs. functions vs. autoloadable functions, and zcompile benefits

[Roman Perepelitsa <roman.perepelitsa@xxxxxxxxx>]

On Sat, Nov 27, 2021 at 9:11 AM Zach Riggle <zachriggle@xxxxxxxxx> wrote:
>
> Does anybody have information on which approach is faster?
>
> alias foo='foo --flag1 --flag2'
> foo() { command foo --flag1 --flag2 "$@" }
> autoloadable module containing (2)

In theory the first and the last should have the same performance and
the middle should be slower because it has to parse the body. In
practice you won't find any difference: zsh parser is very fast.

There is a difference in usability between these options. When using
an alias, you can expand it (provided that you have a binding for
expanding aliases) to check what it does and then either undo the
expansion (provided you have a binding) or modify it. I do this all
the time. Aliases also allow you to bypass them with `\foo` rather
than `command foo`. Less typing.

> Finally, I'm aware of the zcompile tool to create .zwc bytecode files, but it appears that this causes issues with $functions / $functions_source and sometimes things don't work.

zcompiling has two main gotchas:

1. Aliases get expanded differently.
2. If you move a source file (e.g., to backup) and then move it back
(restore from backup), you might end up with a mismatched zwc with
greater mtime.

See https://github.com/romkatv/zsh-bench#cutting-corners for a more
detailed description.

> Is there a true performance benefit in the general case for pre-compiling ALL of my zsh scripts (i.e. everything inside ~/.zprezto that /usr/bin/file says is a "zsh script text executable")?

The only benefit of zcompiling is performance. For autoloadable
functions that don't get invoked on startup you won't be able to tell
the difference. This means that the only benefit of zcompiling is
faster zsh startup. You can simply try it: zcompile your stuff and see
if you can tell the difference in zsh startup speed using your own
senses. If you cannot, there is no point in zcompiling. If you want a
machine-mediated measurement, you can use
https://github.com/romkatv/zsh-bench and look at first_prompt_lag and
first_command_lag in the output.

Roman.