Parsing NUL-terminated strings in a Bash script requires reading the output of
systemd-boot commands directly into an array using process substitution and the
readarray builtin. This approach bypasses standard line-based parsing, ensuring that entries with special characters or spaces are stored correctly as distinct elements without requiring complex delimiter manipulation or external tools like
awk.
The Problem with Standard Parsing
When listing boot entries in systemd-boot, the output often contains spaces, dashes, or other special characters within the entry titles. A common mistake is to use a
while read loop with standard input redirection. This fails because the subshell created by the pipe does not modify variables in the parent shell, leading to empty arrays after the loop completes. Additionally, relying on newline delimiters breaks if any entry title contains a newline, which is rare but possible in malformed configurations. The most robust solution involves treating the output as a stream of NUL-separated values.
Correcting the Array Population Issue
The core issue in many scripts is that
read -d $'\0' inside a piped loop loses its data context. To fix this, you must use
readarray (also known as
mapfile) combined with process substitution. This allows the main shell process to populate the array directly. You first convert the newline-separated output from the bootloader command into NUL-separated values using
tr, then feed that into
readarray.
Here is the correct pattern for populating the array:
boot_entries=()
while IFS= read -r -d '' entry; do
boot_entries+=("$entry")
done < <(systemd-bootctl list | tail -n +2 | tr '\n' '\0')
In this snippet,
tail -n +2 skips the header lines provided by
systemd-bootctl. The
tr '\n' '\0' command replaces newlines with NUL bytes. The
while loop reads these NUL-delimited chunks into the variable
entry, appending each one to the
boot_entries array. This method ensures that every entry, regardless of internal spacing, becomes a single array element. For more details on handling filenames and quoting issues in similar scenarios, see
Troubleshooting Bash Script with Suspected Issues of Spaces, Dashes, Filenames and Quoting.
Iterating Over the Entries Safely
Once the array is populated, you can iterate over it safely using a
for loop. It is critical to quote the array expansion
"${boot_entries[@]}" to preserve whitespace. If you omit the quotes, Bash will perform word splitting on each element, breaking entries that contain spaces into multiple arguments.
for entry in "${boot_entries[@]}"; do
echo "Found entry: [$entry]"
# Perform actions here
done
This loop prints each entry enclosed in brackets to visualize the boundaries. If an entry contains a space, such as "Windows Boot Manager", the quotes ensure it remains a single string. Without them, the loop would treat "Windows" and "Boot" and "Manager" as separate iterations, causing logic errors in subsequent commands.
Filtering Specific Entries
Often, you need to find a specific entry among many. You can use pattern matching within the loop. Bash supports glob-style patterns inside
[[ ]] tests. For example, to find an entry starting with "Linux":
target_entry=""
for entry in "${boot_entries[@]}"; do
if [[ "$entry" == Linux* ]]; then
target_entry="$entry"
break
fi
done
if [[ -z "$target_entry" ]]; then
echo "No Linux entry found."
else
echo "Selected: $target_entry"
fi
This code iterates through the array and assigns the first matching entry to
target_entry. The
break statement exits the loop early once a match is found, improving performance when dealing with large lists. Checking if
target_entry is empty afterward confirms whether the search was successful.
Updating EFI Variables
After identifying the correct entry, you might need to update the default boot entry. Systemd-boot allows setting the default via environment variables or configuration files. However, modifying EFI variables directly can be risky. If you are working in a dual-boot setup, especially with Windows, ensure you understand the implications of changing boot priorities. See
Unable to Update EFI variables in systemd-boot for Windows in Dual-Boot Setup for guidance on managing conflicts between operating systems.
To set the default entry, you typically write the entry title to the
/boot/loader/loader.conf file or use
systemd-bootctl commands if available in your version. Always verify the change by running
systemd-bootctl list again after your script executes.
Debugging Common Errors
If your script still fails to parse correctly, check the following:
- Shell Version: Ensure you are using Bash 4.4 or later for reliable
readarray behavior with NUL terminators.
- Output Format: Verify that
systemd-bootctl list outputs exactly what you expect. Use cat -v to see hidden characters.
- Permissions: Running scripts that modify boot settings usually requires root privileges. Use
sudo appropriately.
By adhering to these practices, you create a resilient script that handles the nuances of systemd-boot output reliably.
Frequently Asked Questions
Why does my array remain empty after the loop?
This happens when you use a pipe (
|) to feed data into a
while read loop, as the loop runs in a subshell. To fix this, use process substitution (
< <(...)) or
readarray to keep the variable scope in the main shell.
Can I use awk instead of tr for parsing?
While
awk is powerful, it operates on line-based records by default. Using
tr to convert newlines to NUL bytes is simpler and more direct for feeding NUL-delimited data into Bash's built-in reading mechanisms.
How do I handle entries with special characters like quotes?
Always quote your variables during iteration (
"$entry"). This prevents word splitting and globbing, ensuring that special characters within the entry title are treated as literal text rather than syntax.
Is it safe to delete old boot entries with a script?
Deleting boot entries permanently removes them from the EFI partition. Always backup your
/boot/loader/ directory before running scripts that modify these files, and verify the entry name matches exactly to avoid accidental deletion.
What if systemd-bootctl outputs different formats?
Different versions of systemd may format the output slightly differently. Use
head or
tail to isolate the relevant section, and consider checking the man page for
systemd-bootctl to confirm the exact column structure in your environment.