Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
From:   "Bird, Tim" <Tim.Bird@sony.com>
To:     Shuah Khan <shuahkh@osg.samsung.com>,
        "open list:KERNEL SELFTEST FRAMEWORK" 
        <linux-kselftest@vger.kernel.org>
CC:     "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>
Subject: cross-compiling vm, confusion over output directory
Thread-Topic: cross-compiling vm, confusion over output directory
Thread-Index: AdX5gBczKI3kpl+jT9616UrKn+d3vg==
Date:   Fri, 13 Mar 2020 22:14:05 +0000
Message-ID: <MWHPR13MB0895E9C11DB4E72158445944FDFA0@MWHPR13MB0895.namprd13.prod.outlook.com>
Accept-Language: en-US
Content-Language: en-US
received-spf: None (protection.outlook.com: sony.com does not designate
 permitted sender hosts)
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-MS-Exchange-CrossTenant-Network-Message-Id: dcff9d1d-049e-470e-fb9f-08d7c79bd878
X-MS-Exchange-CrossTenant-originalarrivaltime: 13 Mar 2020 22:14:05.5353
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 66c65d8a-9158-4521-a2d8-664963db48e4
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: HBkABwmbpNnq6RY0l44LLXyES78El8J9iZs7WBDjiDexnAtkt+PMfaOS7/FHxjF6zjtO9enI7pQ2YxQEDYaX6Q==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MWHPR13MB1294
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

I was working on fixing the cross-compilation for the selftests/vm tests.
Currently, there are two issues in my testing:

1) problem: required library missing from some cross-compile environments:
tools/testing/selftests/vm/mlock-random-test.c requires libcap
be installed.  The target line for mlock-random-test in
tools/testing/selftests/vm/Makefile looks like this:

$(OUTPUT)/mlock-random-test: LDLIBS +=3D -lcap

and mlock-random-test.c has this include line:
#include <sys/capability.h>

this is confusing, since this is different from the header file
linux/capability.h.  It is associated with the capability library (libcap)
and not the kernel.  In any event, on some distros and in some
cross-compile SDKs the package containing these files is not installed
by default.

Once this library is installed, things progress farther.  Using an Ubuntu
system, you can install the cross version of this library (for arm64) by do=
ing:
$ sudo apt install libcap-dev:arm64

1) solution:
I would like to add some meta-data about this build dependency, by putting
something in the settings file as a hint to CI build systems.  Specifically=
, I'd like to
create the file 'tools/testing/selftests/vm/settings', with the content:
NEED_LIB=3Dcap

We already use settings for other meta-data about a test (right now, just a
non-default timeout value), but I don't want to create a new file or syntax
for this build dependency data.

Let me know what you think.

I may follow up with some script in the kernel source tree to check these
dependencies, independent of any CI system.  I have such a script in Fuego
that I could submit, but it would need some work to fit into the kernel bui=
ld
flow for kselftest.  The goal would be to provide a nicely formatted warnin=
g,
with a recommendation for a package install.  But that's more work than
I think is needed right now just to let developers know there's a build dep=
endency
here.

2) problem: reference to source-relative header file
the Makefile for vm uses a relative path for include directories.
Specifically, it has the line:
CFLAGS =3D -Wall -I ../../../../../usr/include $(EXTRA_CFLAGS)

I believe this needs to reference kernel include files from the
output directory, not the source directory.

With the relative include directory path, the program userfaultfd.c
gets compilation error like this:

userfaultfd.c:267:21: error: 'UFFD_API_RANGE_IOCTLS_BASIC' undeclared here =
(not in a function)
  .expected_ioctls =3D UFFD_API_RANGE_IOCTLS_BASIC,
                     ^
userfaultfd.c: In function 'uffd_poll_thread':
userfaultfd.c:529:8: error: 'UFFD_EVENT_FORK' undeclared (first use in this=
 function)
   case UFFD_EVENT_FORK:
        ^
userfaultfd.c:529:8: note: each undeclared identifier is reported only once=
 for each function it appears in
userfaultfd.c:531:18: error: 'union <anonymous>' has no member named 'fork'
    uffd =3D msg.arg.fork.ufd;
                  ^

2) incomplete solution:
I originally changed this line to read:
CFLAGS =3D -Wall -I $(KBUILD_OUTPUT)/usr/include $(EXTRA_CFLAGS)

This works when the output directory is specified using KBUILD_OUTPUT,
but not when the output directory is specified using O=3D
I'm not sure what happens when the output directory is specified
with a non-source-tree current working directory.

In any event, while researching a proper solution to this, I found
the following in tools/testing/selftests/Makefile:

If compiling with ifneq ($(O),)
    BUILD :=3D $(O)
else
    ifneq ($(KBUILD_OUTPUT),)
        BUILD :=3D $(KBUILD_OUTPUT)/kselftest
    else
        BUILD :=3D $(shell pwd)
        DEFAULT_INSTALL_HDR_PATH :=3D 1
    endif
endif

This doesn't seem right.  It looks like the selftests Makefile treats a dir=
ectory
passed in using O=3D different from one specified using KBUILD_OUTPUT
or the current working directory.
In the KBUILD_OUTPUT case, you get an extra 'kselftest' directory layer
that you don't get for the other two.

In contrast, the kernel top-level Makefile has this:
ifeq ("$(origin O)", "command line")
  KBUILD_OUTPUT :=3D $(O)
endif
(and from then on, the top-level Makefile appears to only use KBUILD_OUTPUT=
)

This makes it look like the rest of the kernel build system treats O=3D and=
 KBUILD_OUTPUT
identically.

Am I missing something, or is there a flaw in the O=3D/KBUILD_OUTPUT handli=
ng in
kselftest?  Please let me know and I'll try to work out an appropriate fix =
for
cross-compiling the vm tests.
 -- Tim