Re: [kvm-unit-tests PATCH 0/3] Add support for external tests and litmus7 documentation

[Andrew Jones <drjones@redhat.com>]

On Tue, Jun 29, 2021 at 07:49:37PM +0300, Nikos Nikoleris wrote:
> 
> 
> On 29/06/2021 19:13, Andrew Jones wrote:
> > On Tue, Jun 29, 2021 at 04:32:36PM +0300, Nikos Nikoleris wrote:
> > > Hi all,
> > > 
> > > On 14/04/2021 11:42, Andrew Jones wrote:
> > > > On Tue, Apr 13, 2021 at 05:52:37PM +0100, Nikos Nikoleris wrote:
> > > > > On 24/03/2021 17:13, Nikos Nikoleris wrote:
> > > > > > This set of patches makes small changes to the build system to allow
> > > > > > easy integration of tests not included in the repository. To this end,
> > > > > > it adds a parameter to the configuration script `--ext-dir=DIR` which
> > > > > > will instruct the build system to include the Makefile in
> > > > > > DIR/Makefile. The external Makefile can then add extra tests,
> > > > > > link object files and modify/extend flags.
> > > > > > 
> > > > > > In addition, to demonstrate how we can use this functionality, a
> > > > > > README file explains how to use litmus7 to generate the C code for
> > > > > > litmus tests and link with kvm-unit-tests to produce flat files.
> > > > > > 
> > > > > > Note that currently, litmus7 produces its own independent Makefile as
> > > > > > an intermediate step. Once this set of changes is committed, litmus7
> > > > > > will be modifed to make use hook to specify external tests and
> > > > > > leverage the build system to build the external tests
> > > > > > (https://github.com/relokin/herdtools7/commit/8f23eb39d25931c2c34f4effa096df58547a3bb4).
> > > > > > 
> > > > > 
> > > > > Just wanted to add that if anyone's interested in trying out this series
> > > > > with litmus7 I am very happy to help. Any feedback on this series or the way
> > > > > we use kvm-unit-tests would be very welcome!
> > > > 
> > > > Hi Nikos,
> > > > 
> > > > It's on my TODO to play with this. I just haven't had a chance yet. I'm
> > > > particularly slow right now because I'm in the process of handling a
> > > > switch of my email server from one type to another, requiring rewrites
> > > > of filters, new mail synchronization methods, and, in general, lots of
> > > > pain... Hopefully by the end of this week all will be done. Then, I can
> > > > start ignoring emails on purpose again, instead of due to the fact that
> > > > I can't find them :-)
> > > > 
> > > > Thanks,
> > > > drew
> > > > 
> > > 
> > > Just wanted to revive the discussion on this. In particular there are two
> > > fairly small changes to the build system that allow us to add external tests
> > > (in our case, generated using litmus7) to the list of tests we build. This
> > > is specific to arm builds but I am happy to look into generalizing it to
> > > include all archs.
> > > 
> > 
> > Hi Nikos,
> > 
> 
> Hi Drew,
> 
> Thanks for having a look!
> 
> > I just spent a few minutes playing around with litmus7. I see the
> > litmus/libdir/kvm-*.cfg files in herdtools7[1] are very kvm-unit-tests
> > specific. They appear to absorb much of the kvm-unit-tests Makefile
> > paths, flags, cross compiler prefixes, etc. Are these .cfg files the
> > only kvm-unit-tests specific files in herdtools7?
> > 
> 
> Indeed these kvm-*.cfg files redefine much of the same variables we have in
> kvm-unit-tests make files. litmus7 uses these cfg files (and
> litmus/libdir/_aarch64/kvm.rules for the rules) to generate a standalone
> Makefile. When we call make, we compile the generated sources and link with
> kvm-unit-tests object files. The generated Makefile redefines much of the
> build system in kvm-unit-tests which is not great. If we make any change to
> the build system in kvm-unit-tests (e.g., add support for efi) we have to
> port this change to the standalone Makefile we generate using litmus7.

Right, that's why I'm suggesting that kvm-unit-tests be brought into the
litmus7 build as a submodule.

> 
> > Here's a half-baked proposal that I'd like your input on:
> > 
> >   1) Generate the kvm-unit-tests specific .cfg files in kvm-unit-tests when
> >      configured with a new --litmus7 configure switch. This will ensure
> >      that the paths, flags, etc. will be up to date in the .cfg file.
> 
> This wouldn't be enough we would also need some sort of minimal Makefile too
> (something like litmus/libdir/_aarch64/kvm.rules).

It also looks derived from kvm-unit-tests:arm/Makefile.common. So why not
just modify that instead? Possibly creating a new make target in order to
accommodate any differences.

> 
> >   2) Add kvm-unit-tests as a git submodule to [1] to get access to the
> >      generated .cfg files and to build the litmus tests for kvm-unit-tests.
> >      A litmus7 command will invoke the kvm-unit-tests build (using
> >      make -C).
> 
> That's possible but it doesn't solve the biggest problem which is figuring
> out what is the command(s) we need to run to link an elf and subsequently
> generate a flat file.

Shouldn't all those commands be in the Makefiles that will be used as part
of the 'make -C <kut-submodule-dir>' call?

> 
> >   3) Create an additional unittests.cfg file (e.g. litmus7-tests.cfg) for
> >      kvm-unit-tests that allows easily running all the litmus7 tests.
> >      (That should also allow 'make standalone' to work for litmus7 tests.)
> 
> This is a good point I can have a look at how we could add this.
> 
> >   4) Like patch 3/3 already does, document the litmus7 stuff in
> >      kvm-unit-tests, so people understand the purpose of the --litmus7
> >      configure switch and also to inform them of the ability to run
> >      additional tests and how (by using [1]).
> > 
> 
> Overall it would be great if we could piggyback on the build system of
> kvm-unit-tests rather than try to re-generate (part of) it. This is what the
> patch 2/3 tries to do. This is not solving the problem in a way that is
> specific to litmus7 and allows for adding more source files to the all-tests
> list.

Patch 2/3 only adds the ability to add a new dir to look at. It leaves
everything else up to litmus7 build code to duplicate what it needs and
also manual commands to populate that new directory. I'd rather we have a
more coherent solution.

We want to build litmus7 tests as kvm-unit-tests. We can look at this two
ways: 1) we want to add litmus7 tests to kvm-unit-tests or 2) we want to
build litmus7 tests for kvm-unit-tests.

This patch series is going for (1), but without actually committing the
tests to kvm-unit-tests. I'm arguing we should do (2), especially since
the litmus7 build code already appears to need to know about
kvm-unit-tests.

I think we should only need to modify the build scripts of litmus7 to
use/build kvm-unit-tests as a submodule and to somehow build litmus7
tests with it. Also, litmus7 test running could be done from the
litmus7 build repo or kvm-unit-tests standalone tests could built for
litmus7 tests and installed elsewhere.

A final note on patch 2/3. Why not just override the TEST_DIR config
variable with a different directory? (If it doesn't work for some
reason, then we could hopefully fix that.)

Thanks,
drew

> 
> If 2/3 was accepted then we would do something like [1]. And the generated
> Makefile for the litmus7 tests turns into something very simple:
> 
> CFLAGS += -march=armv8.1-a
> 
> tests += $(EXT_DIR)/MP.flat
> 
> cflatobjs += $(EXT_DIR)/utils.o
> cflatobjs += $(EXT_DIR)/kvm_timeofday.o
> 
> [1]: https://github.com/relokin/herdtools7/commit/6fa5ec06856c8263a0823ad21e097a39c97cabc1
> 
> Thanks,
> 
> Nikos
> 
> > [1] https://github.com/herd/herdtools7.git
> > 
> > Thanks,
> > drew
> > 
>