coreboot/payloads/libpayload
Julius Werner 8097809c8a libpayload: Fix strsep() edge cases
Our strsep() function is slightly incorrect in that it leaves the
`stringp` pointer pointing to the terminating NUL byte after parsing the
last token. The man page for official implementations says:

> In case no delimiter was found, the token is taken to be the entire
> string *stringp, and *stringp is made NULL.

This doesn't affect things in practice much because we also
(incorrectly) return NULL when called with `**stringp == '\0'`, meaning
the usual pattern of calling `strsep()` in a row without checking
results first still works when there are less tokens than expected,
since we terminate early from that case instead. But it does break the
edge cases where the caller wants to check if there were extra bytes
beyond the last token (`stringp == NULL`), and where we call `strsep()`
on a pointer pointing directly to a terminating NUL byte already
(supposed to return an empty string but our implementation actually
returns NULL). It doesn't look like these edge cases occur anywhere in
current libpayload or depthcharge code.

This patch fixes the issue and also adds a unit test to ensure it
remains correct in the future. (Also move the definition of the `errno`
variable from lib.c into string.c, because `perror()` in string.c is the
only function that actually needs that, and the crazy linker error you
get when only linking one but not the other into a test will waste you
half an hour to figure out.)

Change-Id: I610b5117710c110bcba4fac2a0bb6c13f4f8d046
Signed-off-by: Julius Werner <jwerner@chromium.org>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/88729
Reviewed-by: Yu-Ping Wu <yupingso@google.com>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
2025-08-13 17:44:31 +00:00
..
arch libpayload/arch/arm64/mmu: Fix missing CBMEM in used ranges 2025-06-13 15:23:09 +00:00
bin libpayload: Add x86_64 (64-bit) support 2024-05-26 01:26:31 +00:00
configs libpayload: configs: Add new config.featuretest to broaden CI 2024-12-04 22:25:34 +00:00
crypto payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
curses tree: Replace union {0} initializers with {} for C23 compliance 2025-08-11 16:40:34 +00:00
drivers libpayload/drivers/pci_qcom: Fix address during ATU config 2025-07-30 17:54:17 +00:00
gdb libpayload: gdb: Make die_if() format string a literal 2024-03-19 22:50:03 +00:00
include payloads: Propagate SPI flash address mode flag to libpayload 2025-06-28 02:40:48 +00:00
libc libpayload: Fix strsep() edge cases 2025-08-13 17:44:31 +00:00
libcbfs libpayload: Remove legacy CBFS API 2024-02-22 21:18:39 +00:00
liblz4 payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
liblzma payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
libpci payloads: Rename Makefiles from .inc to .mk 2024-01-24 10:15:10 +00:00
sample libpayload: Add mock architecture 2021-10-11 12:59:57 +00:00
tests libpayload: Fix strsep() edge cases 2025-08-13 17:44:31 +00:00
vboot libpayload: Add x86_64 (64-bit) support 2024-05-26 01:26:31 +00:00
.gitignore .gitignore: Split into subdirectory files 2020-10-30 07:05:27 +00:00
Doxyfile
Kconfig libpayload: Use Kconfig instead of weak symbol for arch_ndelay() 2025-05-22 19:27:30 +00:00
LICENSE_GPL
LICENSES
Makefile tree: Replace scan-build by clang-tidy 2025-07-01 01:12:32 +00:00
Makefile.mk payloads/libpayload/Makefile.mk: Replace nm with $(NM) 2025-06-05 13:37:27 +00:00
Makefile.payload libpayload/Makefile.payload: Add lto flags 2024-08-27 09:08:07 +00:00
README

-------------------------------------------------------------------------------
libpayload README
-------------------------------------------------------------------------------

libpayload is a minimal library to support standalone payloads
that can be booted with firmware like coreboot. It handles the setup
code, and provides common C library symbols such as malloc() and printf().

Note: This is _not_ a standard library for use with an operating system,
rather it's only useful for coreboot payload development!
See https://www.coreboot.org for details on coreboot.


Installation
------------

 $ git clone https://review.coreboot.org/coreboot.git

 $ cd coreboot/payloads/libpayload

 $ make menuconfig

 $ make

 $ make install (optional, will install into ./install per default)

On x86 systems, libpayload will always be 32-bit even if your host OS runs
in 64-bit, so you might have to install the 32-bit libgcc version.
On Debian systems you'd do 'apt-get install gcc-multilib' for example.

Run 'make distclean' before switching boards. This command will remove
your current .config file, so you need 'make menuconfig' again or
'make defconfig' in order to set up configuration. Default configuration
is based on 'configs/defconfig'. See the configs/ directory for examples
of configuration.


Usage
-----

Here's an example of a very simple payload (hello.c) and how to build it:

 #include <libpayload.h>

 int main(void)
 {
     printf("Hello, world!\n");
     return 0;
 }

Building the payload using the 'lpgcc' compiler wrapper:

 $ lpgcc -o hello.elf hello.c

Please see the sample/ directory for details.


Website and Mailing List
------------------------

The main website is https://www.coreboot.org/Libpayload.

For additional information, patches, and discussions, please join the
coreboot mailing list at https://www.coreboot.org/Mailinglist, where most
libpayload developers are subscribed.


Copyright and License
---------------------

See LICENSES.