Received-SPF: softfail (google.com: domain of transitioning linux-kernel-owner@vger.kernel.org does not designate 23.128.96.19 as permitted sender) client-ip=23.128.96.19;
From:   Sidhartha Kumar <sidhartha.kumar@oracle.com>
To:     shuah@kernel.org, akpm@linux-foundation.org
Cc:     Sidhartha Kumar <sidhartha.kumar@oracle.com>, linux-mm@kvack.org,
        linux-kselftest@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH v2] selftest/vm clarify error statement in gup_test
Date:   Tue,  5 Apr 2022 21:48:09 +0000
Message-Id: <20220405214809.3351223-1-sidhartha.kumar@oracle.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?SVXTjnOxDwnhmGWCAMlFas5lVbuFJmAj0YoLIWMpb82CkGNmMXH9/HSTqmEj?=
 =?us-ascii?Q?sOlKMtt0VDtSPQDG7IBfuvBHaBvwfZPK7+/byVZ45xXm/TqFsrC2KTNhWLrZ?=
 =?us-ascii?Q?NmE3sa00Dabw2rjt+ZQv+3Dgm+jWYDLUJ+C5p5SW0QAj/xXH4SSdbJgRdM7G?=
 =?us-ascii?Q?C11BY3U36ob9ztlfNZRw60VPopwKLO9mCKiwfYywJOG/a69jZnZceQAuMGSz?=
 =?us-ascii?Q?tNOtspy4MWIgFZjZSaw2ZT3f1Q7mjDmevrHvKHWnSsWdATHvnQvM+r3dhZ6+?=
 =?us-ascii?Q?gXuTutfNF+90hUAyMvYyy7Er9QkwuEswHDhYtteViIw74LYoBdOJmVlJG41+?=
 =?us-ascii?Q?GILCZ2qgm5KOIUqxUMYEZ7XbcciW4szy1NZWqr7J9MRRf9lnBbH2ynm6qLhE?=
 =?us-ascii?Q?BdrJ9yGckn+RCSsBaFhETKJckx9b+vePi2vYUtAJJy8GBT6Pj3O+tEdOslbb?=
 =?us-ascii?Q?sjr86XTi3AZ6FcwvaboLYnjTS+sSIyg0DAwdGFHFaOc2J6GhJAEAVwtMmzCc?=
 =?us-ascii?Q?gu5oThL9Rca4PZ4pWCc6Yts3DZnmosdpD3XuqfDaTVlpN0yOTUpf3ETk7E+I?=
 =?us-ascii?Q?A1a5Uk7Zj+aRbfGusGJxkIu+4sL/uCzATFia6J5li7QV1KBoKZXdKLZ1k5l2?=
 =?us-ascii?Q?k5pwRIrLIzurL4SBCfJib2/TDWLUXn4uDnoIqYnLg1TIi4Vztbinihb6bQsy?=
 =?us-ascii?Q?bObpk/j7sH/j6MP5q/GlhdlT4elEeZ9Pr0j0MTda7PRG+UWlqKmf9paDn0Jj?=
 =?us-ascii?Q?vRSneLpTJKOg51Deth8PiB1YN/1b/dlreb9xAvkiN/uI5gyWPyGecPA4dQ16?=
 =?us-ascii?Q?OpjkUQJRkOcRfKhb6CLJWTmGOyebYndPOM94NefIek/TUVC8ggD2TIRl+8U5?=
 =?us-ascii?Q?fBxnDgWTp3HDKyag9r+HG9x4eNG6grN7TP2dM1t826ZpSJ1d1A5YnzB5KUoi?=
 =?us-ascii?Q?o0RM7nYmTeXBr8dsAuE039uuhCbz2ew+97hQWfBUUYN7CX65nKLwcuuAzjyr?=
 =?us-ascii?Q?n2syHPaW7jtOMLBYTaW/VmKH0XUc5Ujz5WYj3dx7wtFBSgd8oQMseiv7Diys?=
 =?us-ascii?Q?y95eJuOp3uieUeCIIreT9D4d2AGwQAjJ8l6fZANxYLnw5n/u1BS0iENlWG1l?=
 =?us-ascii?Q?ZZAoK3RO45mlCFc9GYNuWP3UNG+66p3MrBM6DrMH6PeK5lwX+NghkEm20fu0?=
 =?us-ascii?Q?hIKeaQrW6aJ9jHg9VEjNcC1rnd9OsFr4hl4zzJJGo4uA+NMHdOR/d3M5r0Lw?=
 =?us-ascii?Q?Y4PEVMqqPaIRX3frOmr2JQRSppXMla24lKvob0ozeComwBwqHaWVDXUG7uCM?=
 =?us-ascii?Q?QgixJCd8Ui8I0/Lf5AlGVJQkqzFEpXjRiO1QqeuA1sVqK+jgIjDC7lJfF2QW?=
 =?us-ascii?Q?rMW35vM2I0wO2GmwHHRdpDd1BONPIhlu0clR2blFYzE4dxyrHyXngCJVzlky?=
 =?us-ascii?Q?lp9TVwRHg+Q5MzQRyNQ+P6zVqLj2Gy90glttefK91lWZZWrsbKX1BoVs53sx?=
 =?us-ascii?Q?8OiuxTgCrC6snMiNpdF8R5+lf8Bh2nZZSP+XlzYhBA2BppsOwufDd97vVUBs?=
 =?us-ascii?Q?ER9rhdP2GHs5yDZl9c01BYnXnn/yTTJoBPS6dq3gi4FZQ3sZ/G6e3HGz5jCQ?=
 =?us-ascii?Q?e26I7N+cftEzExvKJX69C//P+0hARxROGo0jrIWufuW430/G4CBrLzeFyZBf?=
 =?us-ascii?Q?dvXyMsMSAg5U3jfe6oW3235ofQ5vubchn4zpY902YKs5g3KqziOxWkmX7SHa?=
 =?us-ascii?Q?EaULvbYVwP9ccQTy3mWSliEzH0DZJso=3D?=
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: c316e2c1-7cfe-4a07-6585-08da174e03e4
X-MS-Exchange-CrossTenant-AuthSource: CH0PR10MB5113.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Apr 2022 21:48:26.8096
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: AMJxerPEze1mpkIpUXRwAvZDFk46QLQeAto4NrYjfd1afUyj/mfjj5YvCrJh2rjbrahWWEqgJxVojm/GTRz8eR6m7m3TzG1B/SDEEkIOIxw=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH0PR10MB4613
X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.425,18.0.850
 definitions=2022-04-05_07:2022-04-04,2022-04-05 signatures=0
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 malwarescore=0 adultscore=0 mlxscore=0
 bulkscore=0 suspectscore=0 spamscore=0 mlxlogscore=999 phishscore=0
 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2202240000
 definitions=main-2204050119
X-Proofpoint-ORIG-GUID: Azhrdroc8bGtH9ksK2J1lXtuv0meceOB
X-Proofpoint-GUID: Azhrdroc8bGtH9ksK2J1lXtuv0meceOB
X-Spam-Status: No, score=-2.0 required=5.0 tests=BAYES_00,DKIM_SIGNED,
	DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,
	MAILING_LIST_MULTI,RDNS_NONE,SPF_HELO_NONE,T_SCC_BODY_TEXT_LINE
	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

Print three possible reasons /sys/kernel/debug/gup_test
cannot be opened to help users of this test diagnose
failures.

Signed-off-by: Sidhartha Kumar <sidhartha.kumar@oracle.com>
---
v2:
- Add support for skipping the test due to unmet dependencies.
- Use errno to print a more specific message.
- Add check for root privileges.
- dropped CC to stable.
 tools/testing/selftests/vm/gup_test.c     | 22 +++++++++++++--
 tools/testing/selftests/vm/run_vmtests.sh | 33 ++++++++++++++++-------
 2 files changed, 44 insertions(+), 11 deletions(-)

diff --git a/tools/testing/selftests/vm/gup_test.c b/tools/testing/selftests/vm/gup_test.c
index fe043f67798b0..bdedaa6c58e18 100644
--- a/tools/testing/selftests/vm/gup_test.c
+++ b/tools/testing/selftests/vm/gup_test.c
@@ -1,7 +1,9 @@
 #include <fcntl.h>
+#include <errno.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <unistd.h>
+#include <dirent.h>
 #include <sys/ioctl.h>
 #include <sys/mman.h>
 #include <sys/stat.h>
@@ -9,6 +11,7 @@
 #include <pthread.h>
 #include <assert.h>
 #include "../../../../mm/gup_test.h"
+#include "../kselftest.h"
 
 #define MB (1UL << 20)
 #define PAGE_SIZE sysconf(_SC_PAGESIZE)
@@ -205,8 +208,23 @@ int main(int argc, char **argv)
 
 	gup_fd = open("/sys/kernel/debug/gup_test", O_RDWR);
 	if (gup_fd == -1) {
-		perror("open");
-		exit(1);
+		switch (errno) {
+		case EACCES:
+			if (getuid())
+				printf("Please run this test as root\n");
+			break;
+		case ENOENT:
+			if (opendir("/sys/kernel/debug") == NULL) {
+				printf("mount debugfs at /sys/kernel/debug\n");
+				break;
+			}
+			printf("check if CONFIG_GUP_TEST is enabled in kernel config\n");
+			break;
+		default:
+			perror("failed to open /sys/kernel/debug/gup_test");
+			break;
+		}
+		exit(KSFT_SKIP);
 	}
 
 	p = mmap(NULL, size, PROT_READ | PROT_WRITE, flags, filed, 0);
diff --git a/tools/testing/selftests/vm/run_vmtests.sh b/tools/testing/selftests/vm/run_vmtests.sh
index 45e803af7c775..88e15fbb50278 100755
--- a/tools/testing/selftests/vm/run_vmtests.sh
+++ b/tools/testing/selftests/vm/run_vmtests.sh
@@ -127,22 +127,32 @@ echo "------------------------------------------------------"
 echo "running: gup_test -u # get_user_pages_fast() benchmark"
 echo "------------------------------------------------------"
 ./gup_test -u
-if [ $? -ne 0 ]; then
+ret_val=$?
+
+if [ $ret_val -eq 0 ]; then
+	echo "[PASS]"
+elif [ $ret_val -eq $ksft_skip ]; then
+	 echo "[SKIP]"
+	 exitcode=$ksft_skip
+else
 	echo "[FAIL]"
 	exitcode=1
-else
-	echo "[PASS]"
 fi
 
 echo "------------------------------------------------------"
 echo "running: gup_test -a # pin_user_pages_fast() benchmark"
 echo "------------------------------------------------------"
 ./gup_test -a
-if [ $? -ne 0 ]; then
+ret_val=$?
+
+if [ $ret_val -eq 0 ]; then
+	echo "[PASS]"
+elif [ $ret_val -eq $ksft_skip ]; then
+	 echo "[SKIP]"
+	 exitcode=$ksft_skip
+else
 	echo "[FAIL]"
 	exitcode=1
-else
-	echo "[PASS]"
 fi
 
 echo "------------------------------------------------------------"
@@ -150,11 +160,16 @@ echo "# Dump pages 0, 19, and 4096, using pin_user_pages:"
 echo "running: gup_test -ct -F 0x1 0 19 0x1000 # dump_page() test"
 echo "------------------------------------------------------------"
 ./gup_test -ct -F 0x1 0 19 0x1000
-if [ $? -ne 0 ]; then
+ret_val=$?
+
+if [ $ret_val -eq 0 ]; then
+	echo "[PASS]"
+elif [ $ret_val -eq $ksft_skip ]; then
+	 echo "[SKIP]"
+	 exitcode=$ksft_skip
+else
 	echo "[FAIL]"
 	exitcode=1
-else
-	echo "[PASS]"
 fi
 
 echo "-------------------"
-- 
2.27.0