Export the firmware type as a cpp variable so we can #ifdef.

Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>

The other cleaning targets might still have issues...

Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>

We can exercise the memory subsystem through unit tests with a little
bit of coaxing. We need to create a number of fake data objects in order
to get it to build. This is less than ideal, but once we've got good
test coverage and confidence in our tests we can begin refactoring.

Had this unit test already been in place, commit 33c4ab1b ("mem: fix
regression in recent memscan changes") would have never been required
because buggy commit a1331f8d ("memscan: pass enum syslinux_memmap_types
around") would have broke the unit test. Ordinarily, this unit test
would have been part of the bugfix commit 33c4ab1b, but the bugfix needs
to be backported to 5.xx on its own.

test_mem_init_reserved() tests whether SMT_RESERVED regions are
incorrectly added to the memory subsystems's freelist.

Signed-off-by: Matt Fleming <matt.fleming@intel.com>

Improve our faith in the validity of the Syslinux code by writing unit
tests where possible. These should be used in addition to the regression
tests - unit tests are a means of doing very fine-grained testing of
code, whereas the regression tests are end-to-end tests that exercise
abstract functionality.

Unit tests run on your development machine and above all else, their
execution time should be kept to a minimum to encourage repeated runs of
the unit testsuite.

The Syslinux header hierarchy has been reconstructed under
tests/unittest/include. This allows us to reuse header files where
appropriate by simply creating a file with the same name and including
the original, e.g.

tests/unittest/include/com32.h:

  #include <../../../com32/include/com32.h>

Places where we need to override definitions (so that the tests build in
a dev environment) obviously won't include the original header file, but
such scenarios should be kept to a minimum, since you're not really
testing any Syslinux code that way.

To execute the collection of unit tests type,

  make unittest

Sample output might look like,

  Executing unit tests
      Running library unit tests...
        [+] zonelist passed
        [+] movebits passed
        [+] memscan passed

Signed-off-by: Matt Fleming <matt.fleming@intel.com>

A number of Syslinux releases have contained regressions when compared
with previous versions. Now that the size of the derivative grid has
exploded (PXELINUX, SYSLINUX,.... bios, efi32, efi64) we need to have
some means of ensuring we don't introduce regressions so easily.

Start building a suite of regression tests. Regression tests should test
end-to-end functionality, e.g. loading a Linux kernel. If a test fails,
that failure represents a regression in some behaviour, e.g. Syslinux
behaves differently than it previously did.

The idea is that when bugs are reported in Syslinux, we can create new
tests that reproduce the buggy behaviour. Once a fix has been committed
the new test should pass. From that point forward, the test provides a
means of ensuring we never reintroduce that bug.

The collection of tests illustrates the agreed upon behaviour of
Syslinux.

To execute the regression testsuite type,

  make regression

Sample output might look like,

  Executing regression tests for SYSLINUX
      Running Linux kernel regression tests...
        [+] empty passed
        [+] kernelhello passed
      Running COM32 module regression tests...
        [+] chaindisk passed
  Executing regression tests for PXELINUX
      Running Linux kernel regression tests...
        [!] empty failed
        [+] kernelhello passed
        [+] pxetest passed

Qemu is used to execute the regression tests in a virtual environment.
Because it takes time to load Qemu, we can forgive the regression
testsuite for not executing instantaneously. However, developers should
keep in mind the idea of "failing fast" in their regression tests to
minimize execution time - that is, if a test is going to fail, make it
fail as quickly as possible to reduce the testrun time.

It's possible to have derivative-specific tests, where the test only
runs for a specific Syslinux boot loader. For an example see pxetest in
tests/linux/Makefile.

Currently the regression testsuite requires root privileges to execute
and makes several calls to sudo(8). In future it would be nice to get
rid of this requirement.

Signed-off-by: Matt Fleming <matt.fleming@intel.com>

Signed-off-by: Matt Fleming <matt.fleming@intel.com>

Avoid warnings about not being able to find any *.c32 files in
{efi32,efi64}/com32/elflink/ldlinux/ by explicitly referencing
$(LDLINUX).

Signed-off-by: Matt Fleming <matt.fleming@intel.com>

Paralleling sometimes fails depending on pxelinux.0

Signed-off-by: Gene Cumm <gene.cumm@gmail.com>

Users are reporting hitting the following error when typing 'make
installer',

  make[3]: *** No rule to make target `efi32/core/codepage.o', needed by `syslinux.so'.  Stop.

But there's no actual need to build any installers for EFI (none exist),
especially not since the stuff in utils/ is already built for BIOS and
doesn't need building again.

Signed-off-by: Matt Fleming <matt.fleming@intel.com>

We need to install the corresonding ldlinux.* file for each of the
firmware.

Signed-off-by: Matt Fleming <matt.fleming@intel.com>