From nobody Mon Sep 16 19:31:07 2024 Received: from mail-yb1-f201.google.com (mail-yb1-f201.google.com [209.85.219.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id B379645C14 for ; Mon, 12 Feb 2024 18:59:21 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.219.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1707764363; cv=none; b=O8LveCVco4WECY+Gn0/f/GDQBHB6Y7lH4l6qmn7ZBoUV5uDNB/lY66e16lat7/gi8C1ZxHC8xF4I4A96iy56wxf6PgWP2pLyr7fJPiDAkMq8yIWK4mOc4dBHv/QsGxSKxKQMtHLbVW08R+BoVZayxul55Yxe9J/qUZJgFAz2edM= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1707764363; c=relaxed/simple; bh=pokSEbOrag3uWdO1RhTKTOPvPSFp8ZMJI6bQo7DbnNA=; h=Date:In-Reply-To:Message-Id:Mime-Version:References:Subject:From: To:Content-Type; b=uMHXqw0eEuHizsqctw5M8nudd3E4BNoUhVR8n6eGdFfxYepdHWB/b4yEQndgNRhERZTlwqpT9T2g9/1TvEoMpVL/B8QbsrYa29TCfsaigTxvvHRQ2k5z0W261y3yXN8+k9JoHDZrIfjfUS966BvsdkFj5JGl9CCWe3KVrJ3fwmY= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--irogers.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=VJyBcTrZ; arc=none smtp.client-ip=209.85.219.201 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--irogers.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="VJyBcTrZ" Received: by mail-yb1-f201.google.com with SMTP id 3f1490d57ef6-dc6b269b172so5768206276.1 for ; Mon, 12 Feb 2024 10:59:21 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1707764361; x=1708369161; darn=vger.kernel.org; h=to:from:subject:references:mime-version:message-id:in-reply-to:date :from:to:cc:subject:date:message-id:reply-to; bh=mEeFv0uon5WQC9cFYvgD6Kwx90gDUxQUuXbCDfN9dJU=; b=VJyBcTrZUBi5oZMBg6/NziPWTE5l63C+eegMy4hvn2u1fzJdXhxZXJynWerDIdnnsm hGqsnsBA+/P5Tvs5P4HBWph2ELiMM6DwNz3tz7JeYbwylImdmlvmKWzNC9El0oVUQwKP kFyWDi3mF0ZQpk9AtKrwePZQ6+fFRH7v50t7KX6eQzIpWqRJpwfMs+uN7bHcKcSd6B3F d5qowv4SL1d2wE3qnsaUY0EzzmrnDklS7nXsRiVaLNOpL11MzDOYJcXODklmGWQPq6OA jeZLHMkINn6/iMHZC+t1zNSs0zWP3f0IKOpyZ0NPQRwBZH4oN6kYZMIuve336JSLb0ui eNWQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1707764361; x=1708369161; h=to:from:subject:references:mime-version:message-id:in-reply-to:date :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=mEeFv0uon5WQC9cFYvgD6Kwx90gDUxQUuXbCDfN9dJU=; b=qY57+J+spqBP/V9f51rwVDwbXKZYF9ggOq/PZMmf99WKgSYz3hRXTArCO0WU64h2HJ mIn43h5U3MlWK1Oqv4TZxkQyQCGEus8dKIJ7ffp5zf8OVpyD1h8u4xcFVnlpFNA7Zibn lz85f+tG/9L5shrVkI5idZLCIhTlFgC7aF769tEDAt9t1o7NsGNoW9KsxkNEGtMQWlr7 jjpB/k7BKPQE5hbKOAIAVKOoah1UQwdrPGNwifm/JI3MPcO0odJicyuOOm69mX25GU4T FoV23MEIXAEhRuruPPj8ReZqItIEP2anbOq59FhvMA/1RkTL1RCRmciruQsXBdKCtIh+ /XMg== X-Forwarded-Encrypted: i=1; AJvYcCVvsFibKk7WDCbXDLGJS8AwqL1B+nlQh6e0g2AzExLVp1KYwKN1KZtbuuIlfuQd9PVD9/YKRcVX0h6B/xdW33S3L8P4DawaMsSqT9Pc X-Gm-Message-State: AOJu0Yzh6NQIpYxBpBlqUEWb94qdKFJw20Pm+nB+4nFrUQSb+7SxVudg IaEPaC0KmhtjAQ1na+kDYbey4Mx3PnIOBkNUU1fO7KH1RbFH7JCsPFtzr6x/GvAPdWUVRzA+q6w eX4JlBw== X-Google-Smtp-Source: AGHT+IEO1PiMz3c0RZTIoYJezmJDkE3dGRBEbQ9aT7WtE501MYAM1moyGkhzIzhdVkLI5mUBKa4Uy1qhvLLj X-Received: from irogers.svl.corp.google.com ([2620:15c:2a3:200:125c:bcda:4fe2:b6e6]) (user=irogers job=sendgmr) by 2002:a05:6902:1209:b0:dc7:7655:46ce with SMTP id s9-20020a056902120900b00dc7765546cemr64080ybu.2.1707764360768; Mon, 12 Feb 2024 10:59:20 -0800 (PST) Date: Mon, 12 Feb 2024 10:58:56 -0800 In-Reply-To: <20240212185858.68189-1-irogers@google.com> Message-Id: <20240212185858.68189-7-irogers@google.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20240212185858.68189-1-irogers@google.com> X-Mailer: git-send-email 2.43.0.687.g38aa6559b0-goog Subject: [PATCH v3 6/8] perf tests: Use scandirat for shell script finding From: Ian Rogers To: Peter Zijlstra , Ingo Molnar , Arnaldo Carvalho de Melo , Namhyung Kim , Mark Rutland , Alexander Shishkin , Jiri Olsa , Ian Rogers , Adrian Hunter , Nathan Chancellor , Nick Desaulniers , Bill Wendling , Justin Stitt , James Clark , Athira Jajeev , Kan Liang , Yang Jihong , linux-kernel@vger.kernel.org, linux-perf-users@vger.kernel.org, llvm@lists.linux.dev Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Avoid filename appending buffers by using openat, faccessat and scandirat more widely. Turn the script's path back to a file name using readlink from /proc//fd/. Read the script's description using api/io.h to avoid fdopen conversions. Whilst reading perform additional sanity checks on the script's contents. Signed-off-by: Ian Rogers --- tools/perf/tests/builtin-test.c | 21 ++--- tools/perf/tests/tests-scripts.c | 144 ++++++++++++++++++------------- tools/perf/tests/tests-scripts.h | 1 - 3 files changed, 95 insertions(+), 71 deletions(-) diff --git a/tools/perf/tests/builtin-test.c b/tools/perf/tests/builtin-tes= t.c index eff3c62e9b47..6d5001daaf63 100644 --- a/tools/perf/tests/builtin-test.c +++ b/tools/perf/tests/builtin-test.c @@ -300,22 +300,20 @@ static int test_and_print(struct test_suite *t, int s= ubtest) } =20 struct shell_test { - const char *dir; const char *file; }; =20 static int shell_test__run(struct test_suite *test, int subdir __maybe_unu= sed) { int err; - char script[PATH_MAX]; struct shell_test *st =3D test->priv; + char *cmd; =20 - path__join(script, sizeof(script) - 3, st->dir, st->file); - - if (verbose > 0) - strncat(script, " -v", sizeof(script) - strlen(script) - 1); - - err =3D system(script); + asprintf(&cmd, "%s%s", st->file, verbose ? " -v" : ""); + if (!cmd) + return TEST_FAIL; + err =3D system(cmd); + free(cmd); if (!err) return TEST_OK; =20 @@ -331,7 +329,7 @@ static int run_shell_tests(int argc, const char *argv[]= , int i, int width, files =3D list_script_files(); if (!files) return 0; - for (file =3D files; file->dir; file++) { + for (file =3D files; file->file; file++) { int curr =3D i++; struct test_case test_cases[] =3D { { @@ -345,13 +343,12 @@ static int run_shell_tests(int argc, const char *argv= [], int i, int width, .test_cases =3D test_cases, .priv =3D &st, }; - st.dir =3D file->dir; + st.file =3D file->file; =20 if (test_suite.desc =3D=3D NULL || !perf_test__matches(test_suite.desc, curr, argc, argv)) continue; =20 - st.file =3D file->file; pr_info("%3d: %-*s:", i, width, test_suite.desc); =20 if (intlist__find(skiplist, i)) { @@ -455,7 +452,7 @@ static int perf_test__list_shell(int argc, const char *= *argv, int i) files =3D list_script_files(); if (!files) return 0; - for (file =3D files; file->dir; file++) { + for (file =3D files; file->file; file++) { int curr =3D i++; struct test_suite t =3D { .desc =3D file->desc diff --git a/tools/perf/tests/tests-scripts.c b/tools/perf/tests/tests-scri= pts.c index 4ebd841da05b..9b3b66dd5508 100644 --- a/tools/perf/tests/tests-scripts.c +++ b/tools/perf/tests/tests-scripts.c @@ -14,6 +14,7 @@ #include #include #include +#include #include "builtin.h" #include "tests-scripts.h" #include "color.h" @@ -35,55 +36,69 @@ static size_t files_num =3D 0; static struct script_file *files =3D NULL; static int files_max_width =3D 0; =20 -static const char *shell_tests__dir(char *path, size_t size) +static int shell_tests__dir_fd(void) { - const char *devel_dirs[] =3D { "./tools/perf/tests", "./tests", }; - char *exec_path; - unsigned int i; + char path[PATH_MAX], *exec_path; + static const char * const devel_dirs[] =3D { "./tools/perf/tests/shell", = "./tests/shell", }; =20 - for (i =3D 0; i < ARRAY_SIZE(devel_dirs); ++i) { - struct stat st; + for (size_t i =3D 0; i < ARRAY_SIZE(devel_dirs); ++i) { + int fd =3D open(devel_dirs[i], O_PATH); =20 - if (!lstat(devel_dirs[i], &st)) { - scnprintf(path, size, "%s/shell", devel_dirs[i]); - if (!lstat(devel_dirs[i], &st)) - return path; - } + if (fd >=3D 0) + return fd; } =20 /* Then installed path. */ exec_path =3D get_argv_exec_path(); - scnprintf(path, size, "%s/tests/shell", exec_path); + scnprintf(path, sizeof(path), "%s/tests/shell", exec_path); free(exec_path); - return path; + return open(path, O_PATH); } =20 -static const char *shell_test__description(char *description, size_t size, - const char *path, const char *n= ame) +static char *shell_test__description(int dir_fd, const char *name) { - FILE *fp; - char filename[PATH_MAX]; - int ch; + struct io io; + char buf[128], desc[256]; + int ch, pos =3D 0; =20 - path__join(filename, sizeof(filename), path, name); - fp =3D fopen(filename, "r"); - if (!fp) + io__init(&io, openat(dir_fd, name, O_RDONLY), buf, sizeof(buf)); + if (io.fd < 0) return NULL; =20 /* Skip first line - should be #!/bin/sh Shebang */ + if (io__get_char(&io) !=3D '#') + goto err_out; + if (io__get_char(&io) !=3D '!') + goto err_out; do { - ch =3D fgetc(fp); - } while (ch !=3D EOF && ch !=3D '\n'); - - description =3D fgets(description, size, fp); - fclose(fp); + ch =3D io__get_char(&io); + if (ch < 0) + goto err_out; + } while (ch !=3D '\n'); =20 - /* Assume first char on line is omment everything after that desc */ - return description ? strim(description + 1) : NULL; + do { + ch =3D io__get_char(&io); + if (ch < 0) + goto err_out; + } while (ch =3D=3D '#' || isspace(ch)); + while (ch > 0 && ch !=3D '\n') { + desc[pos++] =3D ch; + if (pos >=3D (int)sizeof(desc) - 1) + break; + ch =3D io__get_char(&io); + } + while (pos > 0 && isspace(desc[--pos])) + ; + desc[++pos] =3D '\0'; + close(io.fd); + return strdup(desc); +err_out: + close(io.fd); + return NULL; } =20 /* Is this full file path a shell script */ -static bool is_shell_script(const char *path) +static bool is_shell_script(int dir_fd, const char *path) { const char *ext; =20 @@ -91,20 +106,16 @@ static bool is_shell_script(const char *path) if (!ext) return false; if (!strcmp(ext, ".sh")) { /* Has .sh extension */ - if (access(path, R_OK | X_OK) =3D=3D 0) /* Is executable */ + if (faccessat(dir_fd, path, R_OK | X_OK, 0) =3D=3D 0) /* Is executable */ return true; } return false; } =20 /* Is this file in this dir a shell script (for test purposes) */ -static bool is_test_script(const char *path, const char *name) +static bool is_test_script(int dir_fd, const char *name) { - char filename[PATH_MAX]; - - path__join(filename, sizeof(filename), path, name); - if (!is_shell_script(filename)) return false; - return true; + return is_shell_script(dir_fd, name); } =20 /* Duplicate a string and fall over and die if we run out of memory */ @@ -120,12 +131,21 @@ static char *strdup_check(const char *str) return newstr; } =20 -static void append_script(const char *dir, const char *file, const char *d= esc) +static void append_script(int dir_fd, const char *name, char *desc) { + char filename[PATH_MAX], link[128]; struct script_file *files_tmp; - size_t files_num_tmp; + size_t files_num_tmp, len; int width; =20 + snprintf(link, sizeof(link), "/proc/%d/fd/%d", getpid(), dir_fd); + len =3D readlink(link, filename, sizeof(filename)); + if (len < 0) { + pr_err("Failed to readlink %s", link); + return; + } + filename[len++] =3D '/'; + strcpy(&filename[len], name); files_num_tmp =3D files_num + 1; if (files_num_tmp >=3D SIZE_MAX) { pr_err("Too many script files\n"); @@ -142,10 +162,8 @@ static void append_script(const char *dir, const char = *file, const char *desc) /* Add file to end and NULL terminate the struct array */ files =3D files_tmp; files_num =3D files_num_tmp; - files[files_num - 1].dir =3D strdup_check(dir); - files[files_num - 1].file =3D strdup_check(file); - files[files_num - 1].desc =3D strdup_check(desc); - files[files_num].dir =3D NULL; + files[files_num - 1].file =3D strdup_check(filename); + files[files_num - 1].desc =3D desc; files[files_num].file =3D NULL; files[files_num].desc =3D NULL; =20 @@ -154,32 +172,39 @@ static void append_script(const char *dir, const char= *file, const char *desc) files_max_width =3D width; } =20 -static void append_scripts_in_dir(const char *path) +static void append_scripts_in_dir(int dir_fd) { struct dirent **entlist; struct dirent *ent; int n_dirs, i; - char filename[PATH_MAX]; =20 /* List files, sorted by alpha */ - n_dirs =3D scandir(path, &entlist, NULL, alphasort); + n_dirs =3D scandirat(dir_fd, ".", &entlist, NULL, alphasort); if (n_dirs =3D=3D -1) return; for (i =3D 0; i < n_dirs && (ent =3D entlist[i]); i++) { + int fd; + if (ent->d_name[0] =3D=3D '.') continue; /* Skip hidden files */ - if (is_test_script(path, ent->d_name)) { /* It's a test */ - char bf[256]; - const char *desc =3D shell_test__description - (bf, sizeof(bf), path, ent->d_name); + if (is_test_script(dir_fd, ent->d_name)) { /* It's a test */ + char *desc =3D shell_test__description(dir_fd, ent->d_name); =20 if (desc) /* It has a desc line - valid script */ - append_script(path, ent->d_name, desc); - } else if (is_directory(path, ent)) { /* Scan the subdir */ - path__join(filename, sizeof(filename), - path, ent->d_name); - append_scripts_in_dir(filename); + append_script(dir_fd, ent->d_name, desc); + continue; + } + if (ent->d_type !=3D DT_DIR) { + struct stat st; + + if (ent->d_type !=3D DT_UNKNOWN) + continue; + fstatat(dir_fd, ent->d_name, &st, 0); + if (!S_ISDIR(st.st_mode)) + continue; } + fd =3D openat(dir_fd, ent->d_name, O_PATH); + append_scripts_in_dir(fd); } for (i =3D 0; i < n_dirs; i++) /* Clean up */ zfree(&entlist[i]); @@ -188,14 +213,17 @@ static void append_scripts_in_dir(const char *path) =20 const struct script_file *list_script_files(void) { - char path_dir[PATH_MAX]; - const char *path; + int dir_fd; =20 if (files) return files; /* Singleton - we already know our list */ =20 - path =3D shell_tests__dir(path_dir, sizeof(path_dir)); /* Walk dir */ - append_scripts_in_dir(path); + dir_fd =3D shell_tests__dir_fd(); /* Walk dir */ + if (dir_fd < 0) + return NULL; + + append_scripts_in_dir(dir_fd); + close(dir_fd); =20 return files; } diff --git a/tools/perf/tests/tests-scripts.h b/tools/perf/tests/tests-scri= pts.h index 3a3ec6191848..3508a293aaf9 100644 --- a/tools/perf/tests/tests-scripts.h +++ b/tools/perf/tests/tests-scripts.h @@ -3,7 +3,6 @@ #define TESTS_SCRIPTS_H =20 struct script_file { - char *dir; char *file; char *desc; }; --=20 2.43.0.687.g38aa6559b0-goog