coreboot-kgpe-d16/payloads/libpayload
Julius Werner bf697566da libpayload: lz4: Add output overrun check to incompressible case
The LZ4 decompressor currently doesn't check for output overruns before
writing data in the case where a block had been incompressible (and
included verbatim in the compression stream). This is extremely unlikely
with the default 4MB blocks, but still a nice thing to fix. We'll still
output as much data as we can before returning an error to support
partial decompression use cases.

This matches the behavior already in place for normal, LZ4-compressed
blocks where the decompression function is already (supposed to be)
doing complete bounds checking (although it is not guaranteed to output
all valid bytes before aborting on an output overrun, and you should try
to provide a few dozen bytes of extra buffer space beyond the parts
you're interested in on partial decompression).

BRANCH=None
BUG=chrome-os-partner:32184
TEST=None

Change-Id: I5e40c8cec8947ec0ec8f6d8c8fa2574cfb4dc958
Signed-off-by: Patrick Georgi <pgeorgi@chromium.org>
Original-Commit-Id: 636985334c9b3b93a12d4066d2829f1f999c9315
Original-Change-Id: Iecf44650aade60b9fa1b13e57da752fb482a3f3f
Original-Signed-off-by: Julius Werner <jwerner@chromium.org>
Original-Reviewed-on: https://chromium-review.googlesource.com/286240
Original-Reviewed-by: Aaron Durbin <adurbin@chromium.org>
Reviewed-on: http://review.coreboot.org/11016
Tested-by: build bot (Jenkins)
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
2015-07-21 21:27:42 +02:00
..
arch cbfs: define libpayload_init_default_cbfs_media weakly 2015-07-06 09:42:12 +02:00
bin libpayload: arch/mips: Add basic MIPS architecture support 2015-03-21 11:07:50 +01:00
configs libpayload: update defconfigs 2015-07-08 10:25:11 +02:00
crypto libpayload: Make Kconfig bools use IS_ENABLED() 2015-06-30 18:55:15 +02:00
curses libpayload: Make Kconfig bools use IS_ENABLED() 2015-06-30 18:55:15 +02:00
drivers libpayload: usb: Add support for SuperSpeed hubs 2015-07-18 09:40:48 +02:00
gdb Remove address from GPLv2 headers 2015-05-21 20:50:25 +02:00
include libpayload: usb: dwc2: support split transaction 2015-07-16 22:39:59 +02:00
libc libpayload: store boot media information in sysinfo 2015-07-14 22:37:10 +02:00
libcbfs libpayload: assume cbfs file alignment is 64 byte 2015-07-15 16:34:50 +02:00
liblz4 libpayload: lz4: Add output overrun check to incompressible case 2015-07-21 21:27:42 +02:00
liblzma lzma: Return correct amount of decompressed bytes 2015-07-06 09:40:37 +02:00
libpci Remove empty lines at end of file 2015-06-08 00:55:07 +02:00
sample Remove empty lines at end of file 2015-06-08 00:55:07 +02:00
tests Remove empty lines at end of file 2015-06-08 00:55:07 +02:00
Doxyfile
Kconfig libpayload: Add LZ4 decompression algorithm 2015-07-09 00:10:16 +02:00
LICENSES libpayload: Add LZ4 decompression algorithm 2015-07-09 00:10:16 +02:00
LICENSE_GPL libpayload: Introduce new Kconfig to explicitly allow GPL code 2015-01-09 07:06:27 +01:00
Makefile libpayload: Use top level xcompile 2015-07-09 08:47:16 +02:00
Makefile.inc libpayload: Have make install save .xcompile file 2015-07-09 08:47:41 +02:00
README Remove empty lines at end of file 2015-06-08 00:55:07 +02: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 http://coreboot.org for details on coreboot.


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

 $ git clone http://review.coreboot.org/p/coreboot.git

 $ cd coreboot/payloads/libpayload

 $ make menuconfig

 $ make

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

As libpayload is for 32bit x86 systems only, you might have to install the
32bit libgcc version, otherwise your payloads will fail to compile.
On Debian systems you'd do 'apt-get install gcc-multilib' for example.


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 http://www.coreboot.org/Libpayload.

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


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

See LICENSES.