Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Content-Type: multipart/mixed; boundary="------------jP6YgWTrDDApUlrGwhMuU180"
Message-ID: <14573e7e-f2ad-ff34-dfbd-3efdebee51ed@nvidia.com>
Date:   Tue, 6 Jun 2023 13:10:23 -0700
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.11.2
Subject: Re: [PATCH v3 11/11] selftests: error out if kernel header files are
 not yet built
Content-Language: en-US
To:     Muhammad Usama Anjum <usama.anjum@collabora.com>,
        Andrew Morton <akpm@linux-foundation.org>
Cc:     David Hildenbrand <david@redhat.com>, Peter Xu <peterx@redhat.com>,
        Shuah Khan <shuah@kernel.org>,
        Nathan Chancellor <nathan@kernel.org>, linux-mm@kvack.org,
        linux-kselftest@vger.kernel.org,
        LKML <linux-kernel@vger.kernel.org>,
        Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org
References: <20230606071637.267103-1-jhubbard@nvidia.com>
 <20230606071637.267103-12-jhubbard@nvidia.com>
 <8e208e0f-699c-2c34-d66e-bf6d488a7a1e@collabora.com>
From:   John Hubbard <jhubbard@nvidia.com>
In-Reply-To: <8e208e0f-699c-2c34-d66e-bf6d488a7a1e@collabora.com>
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?UUZuUWN3Smo3dWFFSk5JSjhoZmhVKytJWFRSSkt6Y1dmNGFnQkZYTk9BV3Ev?=
 =?utf-8?B?TFFvVkk1a1BXdVJDTkdxOHBUODd5YU5OUmhqNENwK21SV3ZQcGd2QkhKV3py?=
 =?utf-8?B?VHl6eHRHWmJPODV2QzVyU0l4bkdFWHFUT0dmLzVqeW0xb0ZUbTJGZXozMWV5?=
 =?utf-8?B?TUk4OFJvT1drZzNkeFZNVHhTTDZsRmpvTXBjcEJva25CaG5oWlhIL1FKbWNI?=
 =?utf-8?B?a0hsMGtDZG0wbjA0TG9CamhkZFA0R2FFa1NmNjVzNHNkVmVkQ0hsM1Y5aFF2?=
 =?utf-8?B?Qi9RdC9kcW43a2Y1OXZwTDNLU2N0amhRQ0NjVXV5NXR0S0U5VjIrdzVWNW1Y?=
 =?utf-8?B?K21GVjJ3MzlLUmlvMzhGVnQ5L0JDQTdCeDFqTnorMnlOSGR3aW9NWXdpRVpJ?=
 =?utf-8?B?WTBpTTQraUo4bStVbWFnK1Iva2wrdHU0UXRMcC9TN3I5YzlTMFBVbnk1NW1Y?=
 =?utf-8?B?SWcreTBmU1lJL2tuMFRxTENLVzRFS0RITVJUOWFvMnUzYWx0ZUxVcUYyY2dK?=
 =?utf-8?B?VmFUUFJ0T1M4TnBTenovNnZzczVBT2U3cVhxdnJMYktFRHYzL1R4bk9sNERY?=
 =?utf-8?B?c2Y2TG9KREg5UHlJSmhOaGVzY3Rmei9Ha3NCR3dPZTRYYkdTRHNmeEVGSU10?=
 =?utf-8?B?ZGhCb3VWVWdFOTVCaCt1WkxaM3d5QkRPVCs4bXdZMTEza0xOU0hRcFV2c1g3?=
 =?utf-8?B?NElCODB3ZG9OTllUTGdkeUtEYjQxaDI1ZzA2eVlGNG13a3QxeHdyeFZwcnNq?=
 =?utf-8?B?M0VvSFRJcTFqY1hwZmxLNHpqbHMrS3E0Rk5JZDRxaTlmWFNrWlRSMGc2ejJT?=
 =?utf-8?B?SUUwTHRIYTM2cHRtVzJUd010ZGhpYVEyYTlUaXNBZG1nWml4WWdYby9XWmtn?=
 =?utf-8?B?ZjN5cHRJV2VSdXQ0dEZCUUJzRUlsbXBVSjYxWDZCMHpoNGpTMnFSNS9DbnJn?=
 =?utf-8?B?akhlMlJsMDhKbDVLYWdvK1J6Z1VGSEpZallFUTdzcWhVQ3dnSE45clhWU1Ay?=
 =?utf-8?B?Q3J0ZWNOb0d5Znh3QWxVV2gxZXFFVkZNb1dRSEdoQ2M0aTJVQzdaWWF4TXZ1?=
 =?utf-8?B?WDMweUhhRG15Yi9VMEFXODV1UlVpWjlmd0VlSkdwU0JzWXFGdGViYW5Mb1hu?=
 =?utf-8?B?enpseXUwaEtpakFScFJaUXl3SXBrd1ZyekZtL0M2Nm9mdzFneUtuYy9vUkxE?=
 =?utf-8?B?ampqaEtObEFiYmsyVTNEWFFJdFpXUU1nd2hadkJ4ZnFzRi9Vb2FCU2grcWZq?=
 =?utf-8?B?WUpubWE1VkFMZnhHU2ZrVVg5a3lObVoyQW1BY0JlTUliaXRuWmtKOU9wa0t4?=
 =?utf-8?B?VmovMFRzQkhVbERvSFBuODZpck0yNWdreHFGbzZTZXcvSGxNZmNjZUg4eEdW?=
 =?utf-8?B?SFhSZVpWWTNLTk5jTnNEeWF3RnIxZTBEb0wvWmpyK3FPdS95ZHlYUEhoSlZu?=
 =?utf-8?B?WUFyL0h2ZjdtSnVMc2dCZkNIVmNTOEw1U1RxK0ttdGxYTEJPTUY1U1JCdDh4?=
 =?utf-8?B?UmhrZEp2ZHZmanhzTXp0OWhXc3RoZTJ2MWIwa2xSSWdTTkdTbTcyNjJWNHVy?=
 =?utf-8?B?Zml1TTJXek13MXpsdk9VQTdWNThXZVg1VEY0RTRjamIrbzAyOTMreUZaVHY3?=
 =?utf-8?B?Yk1HNnNBK2lGbDJCZ1I4OFNVNmVXSlNOa3dPYkdSc1ljK2x0WlhmczJ0d2U4?=
 =?utf-8?B?L0hNeGw3c29Mdi90ODhacHJYMmF3dGU5bUI4Nk9MT1ppdXVvSmRSUTFGNG5L?=
 =?utf-8?B?b1MyV1NwaG9tNlg2VUJCTDYxaE05VDFaSURkY2xxOTdZb1hxdldOazhvaER3?=
 =?utf-8?B?YTZleXBIeElza2xZUDRqY09heDJlcE9tWVF4OVc5eFVRM05xbXdQUDYzZE92?=
 =?utf-8?B?UzVzUGYxT1g1Vy9maEZQZlFuVk5qQUVkR3dHeW53KzZpMFRGeTdpcGUyYzJh?=
 =?utf-8?B?UFVlVDcwNG1YZXVQcWxPU3RXY3NUbWJkMldLeTN4MFhIaEtsT3ZRSE1Na1pD?=
 =?utf-8?B?TERTdlFWNzBxQmQ1L2hMemJPbGp4UHlyODhJRHV2cGsvQ1plR2duSXZ6RzhN?=
 =?utf-8?B?d1kxaXRrcTgvV3lxOU1PcE9TLzhuSjRTOVBNSDdZZWNmRHhMSHJ1a2tOWkJI?=
 =?utf-8?Q?IluZx3axUdRZsk1A0fM325ii0?=
X-OriginatorOrg: Nvidia.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 73cc9787-2aa0-46a2-4345-08db66ca13aa
X-MS-Exchange-CrossTenant-AuthSource: BY5PR12MB4130.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 06 Jun 2023 20:10:30.3500
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: bSG/oRbU+b6FQpQviXXa/Kfr1dd35gvW0Kbi3hN+fIcqK5gALPztYUAa8ZE4pvLBB/NGiVEBy+mAuPqbJfyo+w==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY5PR12MB6574
X-Spam-Status: No, score=-1.2 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
        DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FORGED_SPF_HELO,
        NICE_REPLY_A,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,
        SPF_NONE,T_SCC_BODY_TEXT_LINE,URIBL_BLOCKED autolearn=no
        autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

--------------jP6YgWTrDDApUlrGwhMuU180
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit

On 6/6/23 00:38, Muhammad Usama Anjum wrote:
...
>> +kernel_header_files:
>> +	@ls $(KHDR_DIR)/linux/*.h >/dev/null 2>/dev/null;                      \
>> +	if [ $$? -ne 0 ]; then                                                 \
>> +            RED='\033[1;31m';                                                  \
>> +            NOCOLOR='\033[0m';                                                 \
>> +            echo;                                                              \
>> +            echo -e "$${RED}error$${NOCOLOR}: missing kernel header files.";   \
>> +            echo "Please run this and try again:";                             \
>> +            echo;                                                              \
>> +            echo "    cd $(top_srcdir)";                                       \
>> +            echo "    make headers";                                           \
>> +            echo;                                                              \
>> +	    exit 1; \
>> +	fi
> Thank you for adding this. This is outputting error for every selftest
> directory. We should try to make it even better by just aborting the
> Make-ing process the first time headers aren't detected. We can do this now
> or later, fine by me.
> 
OK, I see. Yes, this can be improved by adding the same mechanism to the 
selftests/Makefile, that is in selftests/mm/Makefile.

I'd like to keep both, because as I mentioned earlier, mm folks like to
run just that one Makefile, sometimes, and selftests/mm/Makefile is not
invoking the top level Makefile. Rather, it includes lib.mk--which the
top level Makefile does *not* include.

Arguably, using includes instead of recursive Make, would improve this
framework: reduce duplication such as the above. But that's a larger
project and just food for thought at this point.

Anyway, this works nicely on my system, and I'll attach it as a patch
also in case you want to try it out. What do you think of this:

diff --git a/tools/testing/selftests/Makefile b/tools/testing/selftests/Makefile
index 90a62cf75008..bdca160063d8 100644
--- a/tools/testing/selftests/Makefile
+++ b/tools/testing/selftests/Makefile
@@ -144,10 +144,12 @@ ifneq ($(KBUILD_OUTPUT),)
   abs_objtree := $(realpath $(abs_objtree))
   BUILD := $(abs_objtree)/kselftest
   KHDR_INCLUDES := -isystem ${abs_objtree}/usr/include
+  KHDR_DIR := ${abs_objtree}/usr/include
 else
   BUILD := $(CURDIR)
   abs_srctree := $(shell cd $(top_srcdir) && pwd)
   KHDR_INCLUDES := -isystem ${abs_srctree}/usr/include
+  KHDR_DIR := ${abs_srctree}/usr/include
   DEFAULT_INSTALL_HDR_PATH := 1
 endif
 
@@ -161,7 +163,7 @@ export KHDR_INCLUDES
 # all isn't the first target in the file.
 .DEFAULT_GOAL := all
 
-all:
+all: kernel_header_files
 	@ret=1;							\
 	for TARGET in $(TARGETS); do				\
 		BUILD_TARGET=$$BUILD/$$TARGET;			\
@@ -172,6 +174,23 @@ all:
 		ret=$$((ret * $$?));				\
 	done; exit $$ret;
 
+kernel_header_files:
+	@ls $(KHDR_DIR)/linux/*.h >/dev/null 2>/dev/null;                          \
+	if [ $$? -ne 0 ]; then                                                     \
+            RED='\033[1;31m';                                                  \
+            NOCOLOR='\033[0m';                                                 \
+            echo;                                                              \
+            echo -e "$${RED}error$${NOCOLOR}: missing kernel header files.";   \
+            echo "Please run this and try again:";                             \
+            echo;                                                              \
+            echo "    cd $(top_srcdir)";                                       \
+            echo "    make headers";                                           \
+            echo;                                                              \
+	    exit 1;                                                                \
+	fi
+
+.PHONY: kernel_header_files
+
 run_tests: all
 	@for TARGET in $(TARGETS); do \
 		BUILD_TARGET=$$BUILD/$$TARGET;	\


thanks,
-- 
John Hubbard
NVIDIA

--------------jP6YgWTrDDApUlrGwhMuU180
Content-Type: text/x-patch; charset=UTF-8; name="selftests-makefile.patch"
Content-Disposition: attachment; filename="selftests-makefile.patch"
Content-Transfer-Encoding: base64

ZGlmZiAtLWdpdCBhL3Rvb2xzL3Rlc3Rpbmcvc2VsZnRlc3RzL01ha2VmaWxlIGIvdG9vbHMvdGVz
dGluZy9zZWxmdGVzdHMvTWFrZWZpbGUKaW5kZXggOTBhNjJjZjc1MDA4Li5iZGNhMTYwMDYzZDgg
MTAwNjQ0Ci0tLSBhL3Rvb2xzL3Rlc3Rpbmcvc2VsZnRlc3RzL01ha2VmaWxlCisrKyBiL3Rvb2xz
L3Rlc3Rpbmcvc2VsZnRlc3RzL01ha2VmaWxlCkBAIC0xNDQsMTAgKzE0NCwxMiBAQCBpZm5lcSAo
JChLQlVJTERfT1VUUFVUKSwpCiAgIGFic19vYmp0cmVlIDo9ICQocmVhbHBhdGggJChhYnNfb2Jq
dHJlZSkpCiAgIEJVSUxEIDo9ICQoYWJzX29ianRyZWUpL2tzZWxmdGVzdAogICBLSERSX0lOQ0xV
REVTIDo9IC1pc3lzdGVtICR7YWJzX29ianRyZWV9L3Vzci9pbmNsdWRlCisgIEtIRFJfRElSIDo9
ICR7YWJzX29ianRyZWV9L3Vzci9pbmNsdWRlCiBlbHNlCiAgIEJVSUxEIDo9ICQoQ1VSRElSKQog
ICBhYnNfc3JjdHJlZSA6PSAkKHNoZWxsIGNkICQodG9wX3NyY2RpcikgJiYgcHdkKQogICBLSERS
X0lOQ0xVREVTIDo9IC1pc3lzdGVtICR7YWJzX3NyY3RyZWV9L3Vzci9pbmNsdWRlCisgIEtIRFJf
RElSIDo9ICR7YWJzX3NyY3RyZWV9L3Vzci9pbmNsdWRlCiAgIERFRkFVTFRfSU5TVEFMTF9IRFJf
UEFUSCA6PSAxCiBlbmRpZgogCkBAIC0xNjEsNyArMTYzLDcgQEAgZXhwb3J0IEtIRFJfSU5DTFVE
RVMKICMgYWxsIGlzbid0IHRoZSBmaXJzdCB0YXJnZXQgaW4gdGhlIGZpbGUuCiAuREVGQVVMVF9H
T0FMIDo9IGFsbAogCi1hbGw6CithbGw6IGtlcm5lbF9oZWFkZXJfZmlsZXMKIAlAcmV0PTE7CQkJ
CQkJCVwKIAlmb3IgVEFSR0VUIGluICQoVEFSR0VUUyk7IGRvCQkJCVwKIAkJQlVJTERfVEFSR0VU
PSQkQlVJTEQvJCRUQVJHRVQ7CQkJXApAQCAtMTcyLDYgKzE3NCwyMyBAQCBhbGw6CiAJCXJldD0k
JCgocmV0ICogJCQ/KSk7CQkJCVwKIAlkb25lOyBleGl0ICQkcmV0OwogCitrZXJuZWxfaGVhZGVy
X2ZpbGVzOgorCUBscyAkKEtIRFJfRElSKS9saW51eC8qLmggPi9kZXYvbnVsbCAyPi9kZXYvbnVs
bDsgICAgICAgICAgICAgICAgICAgICAgICAgIFwKKwlpZiBbICQkPyAtbmUgMCBdOyB0aGVuICAg
ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICBcCisgICAg
ICAgICAgICBSRUQ9J1wwMzNbMTszMW0nOyAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAg
ICAgICAgICAgICAgICAgICAgXAorICAgICAgICAgICAgTk9DT0xPUj0nXDAzM1swbSc7ICAgICAg
ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIFwKKyAgICAgICAgICAg
IGVjaG87ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAg
ICAgICAgICAgICBcCisgICAgICAgICAgICBlY2hvIC1lICIkJHtSRUR9ZXJyb3IkJHtOT0NPTE9S
fTogbWlzc2luZyBrZXJuZWwgaGVhZGVyIGZpbGVzLiI7ICAgXAorICAgICAgICAgICAgZWNobyAi
UGxlYXNlIHJ1biB0aGlzIGFuZCB0cnkgYWdhaW46IjsgICAgICAgICAgICAgICAgICAgICAgICAg
ICAgIFwKKyAgICAgICAgICAgIGVjaG87ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAg
ICAgICAgICAgICAgICAgICAgICAgICAgICAgICBcCisgICAgICAgICAgICBlY2hvICIgICAgY2Qg
JCh0b3Bfc3JjZGlyKSI7ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgXAor
ICAgICAgICAgICAgZWNobyAiICAgIG1ha2UgaGVhZGVycyI7ICAgICAgICAgICAgICAgICAgICAg
ICAgICAgICAgICAgICAgICAgICAgIFwKKyAgICAgICAgICAgIGVjaG87ICAgICAgICAgICAgICAg
ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICBcCisJICAgIGV4
aXQgMTsgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAg
ICAgICAgICAgICAgXAorCWZpCisKKy5QSE9OWToga2VybmVsX2hlYWRlcl9maWxlcworCiBydW5f
dGVzdHM6IGFsbAogCUBmb3IgVEFSR0VUIGluICQoVEFSR0VUUyk7IGRvIFwKIAkJQlVJTERfVEFS
R0VUPSQkQlVJTEQvJCRUQVJHRVQ7CVwK

--------------jP6YgWTrDDApUlrGwhMuU180--