| lists.openwall.net | lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC | |
|
Open Source and information security mailing list archives
| ||
|
Message-ID: <CAP-5=fVgJu8BJWFVUkCy1Zsi3piTPdV-GXL1bTpWZeO=nm=jrg@mail.gmail.com>
Date: Thu, 31 Oct 2024 13:51:36 -0700
From: Ian Rogers <irogers@...gle.com>
To: Arnaldo Carvalho de Melo <acme@...nel.org>
Cc: Peter Zijlstra <peterz@...radead.org>, Ingo Molnar <mingo@...hat.com>,
Namhyung Kim <namhyung@...nel.org>, Mark Rutland <mark.rutland@....com>,
Alexander Shishkin <alexander.shishkin@...ux.intel.com>, Jiri Olsa <jolsa@...nel.org>,
Adrian Hunter <adrian.hunter@...el.com>, Kan Liang <kan.liang@...ux.intel.com>,
James Clark <james.clark@...aro.org>, Howard Chu <howardchu95@...il.com>,
Athira Jajeev <atrajeev@...ux.vnet.ibm.com>, Michael Petlan <mpetlan@...hat.com>,
Veronika Molnarova <vmolnaro@...hat.com>, Dapeng Mi <dapeng1.mi@...ux.intel.com>,
Thomas Richter <tmricht@...ux.ibm.com>, Ilya Leoshkevich <iii@...ux.ibm.com>,
Colin Ian King <colin.i.king@...il.com>, Weilin Wang <weilin.wang@...el.com>,
Andi Kleen <ak@...ux.intel.com>, Josh Poimboeuf <jpoimboe@...hat.com>, linux-kernel@...r.kernel.org,
linux-perf-users@...r.kernel.org
Subject: Re: [PATCH v5 06/21] perf script: Move find_scripts to browser/scripts.c
On Thu, Oct 31, 2024 at 12:18 PM Arnaldo Carvalho de Melo
<acme@...nel.org> wrote:
>
> On Wed, Oct 30, 2024 at 06:42:37PM -0700, Ian Rogers wrote:
> > The only use of find_scripts is in browser/scripts.c but the
> > definition in builtin causes linking problems requiring a stub in
> > python.c. Move the function to allow the stub to be removed.
> >
> > Rewrite the directory iteration to use openat so that large character
> > arrays aren't needed. The arrays are warned about potential buffer
> > overflows by GCC now that all the code exists in a single C file.
>
> Introducing is_directory_at() should be done as a prep patch, as the
> rest of the patch below could end up being reverted after some other
> patch used it, making the process more difficult.
>
> I mentioned cases like this in the past, so doing it again just for the
> record.
This is highlighted in the commit message:
```
Rewrite the directory iteration to use openat so that large character
arrays aren't needed. The arrays are warned about potential buffer
overflows by GCC now that all the code exists in a single C file.
```
so without the change the code wouldn't build. The new is_directory_at
function is effectively 2 statements fstatat and S_ISDIR on the
result, it is put next to is_directory for consistency but could have
been a static function in the only C file to use it.
For the record, patches introducing 2 line long functions can be
excessively noisy, especially in a 21 patch series. There is always
the declared but not used build error to worry about - here things
couldn't just be simply moved due to triggering a different build
error. Given the simplicity of the function here I made a decision not
to split up the work - the commit message would likely be longer than
the function. The work never intended to introduce is_directory_at but
was forced into it through a desire not to disable compiler warnings.
Thanks,
Ian
>
> - Arnaldo
>
> > Signed-off-by: Ian Rogers <irogers@...gle.com>
> > ---
> > tools/perf/builtin-script.c | 138 ------------------------
> > tools/perf/builtin.h | 6 --
> > tools/perf/ui/browsers/scripts.c | 177 ++++++++++++++++++++++++++++++-
> > tools/perf/util/path.c | 10 ++
> > tools/perf/util/path.h | 1 +
> > tools/perf/util/python.c | 6 --
> > 6 files changed, 186 insertions(+), 152 deletions(-)
> >
> > diff --git a/tools/perf/builtin-script.c b/tools/perf/builtin-script.c
> > index 5d5a1a06d8c6..e9ec74056f71 100644
> > --- a/tools/perf/builtin-script.c
> > +++ b/tools/perf/builtin-script.c
> > @@ -3521,144 +3521,6 @@ static void free_dlarg(void)
> > free(dlargv);
> > }
> >
> > -/*
> > - * Some scripts specify the required events in their "xxx-record" file,
> > - * this function will check if the events in perf.data match those
> > - * mentioned in the "xxx-record".
> > - *
> > - * Fixme: All existing "xxx-record" are all in good formats "-e event ",
> > - * which is covered well now. And new parsing code should be added to
> > - * cover the future complex formats like event groups etc.
> > - */
> > -static int check_ev_match(char *dir_name, char *scriptname,
> > - struct perf_session *session)
> > -{
> > - char filename[MAXPATHLEN], evname[128];
> > - char line[BUFSIZ], *p;
> > - struct evsel *pos;
> > - int match, len;
> > - FILE *fp;
> > -
> > - scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
> > -
> > - fp = fopen(filename, "r");
> > - if (!fp)
> > - return -1;
> > -
> > - while (fgets(line, sizeof(line), fp)) {
> > - p = skip_spaces(line);
> > - if (*p == '#')
> > - continue;
> > -
> > - while (strlen(p)) {
> > - p = strstr(p, "-e");
> > - if (!p)
> > - break;
> > -
> > - p += 2;
> > - p = skip_spaces(p);
> > - len = strcspn(p, " \t");
> > - if (!len)
> > - break;
> > -
> > - snprintf(evname, len + 1, "%s", p);
> > -
> > - match = 0;
> > - evlist__for_each_entry(session->evlist, pos) {
> > - if (evsel__name_is(pos, evname)) {
> > - match = 1;
> > - break;
> > - }
> > - }
> > -
> > - if (!match) {
> > - fclose(fp);
> > - return -1;
> > - }
> > - }
> > - }
> > -
> > - fclose(fp);
> > - return 0;
> > -}
> > -
> > -/*
> > - * Return -1 if none is found, otherwise the actual scripts number.
> > - *
> > - * Currently the only user of this function is the script browser, which
> > - * will list all statically runnable scripts, select one, execute it and
> > - * show the output in a perf browser.
> > - */
> > -int find_scripts(char **scripts_array, char **scripts_path_array, int num,
> > - int pathlen)
> > -{
> > - struct dirent *script_dirent, *lang_dirent;
> > - char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
> > - DIR *scripts_dir, *lang_dir;
> > - struct perf_session *session;
> > - struct perf_data data = {
> > - .path = input_name,
> > - .mode = PERF_DATA_MODE_READ,
> > - };
> > - char *temp;
> > - int i = 0;
> > -
> > - session = perf_session__new(&data, NULL);
> > - if (IS_ERR(session))
> > - return PTR_ERR(session);
> > -
> > - snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
> > -
> > - scripts_dir = opendir(scripts_path);
> > - if (!scripts_dir) {
> > - perf_session__delete(session);
> > - return -1;
> > - }
> > -
> > - for_each_lang(scripts_path, scripts_dir, lang_dirent) {
> > - scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
> > - lang_dirent->d_name);
> > -#ifndef HAVE_LIBPERL_SUPPORT
> > - if (strstr(lang_path, "perl"))
> > - continue;
> > -#endif
> > -#ifndef HAVE_LIBPYTHON_SUPPORT
> > - if (strstr(lang_path, "python"))
> > - continue;
> > -#endif
> > -
> > - lang_dir = opendir(lang_path);
> > - if (!lang_dir)
> > - continue;
> > -
> > - for_each_script(lang_path, lang_dir, script_dirent) {
> > - /* Skip those real time scripts: xxxtop.p[yl] */
> > - if (strstr(script_dirent->d_name, "top."))
> > - continue;
> > - if (i >= num)
> > - break;
> > - snprintf(scripts_path_array[i], pathlen, "%s/%s",
> > - lang_path,
> > - script_dirent->d_name);
> > - temp = strchr(script_dirent->d_name, '.');
> > - snprintf(scripts_array[i],
> > - (temp - script_dirent->d_name) + 1,
> > - "%s", script_dirent->d_name);
> > -
> > - if (check_ev_match(lang_path,
> > - scripts_array[i], session))
> > - continue;
> > -
> > - i++;
> > - }
> > - closedir(lang_dir);
> > - }
> > -
> > - closedir(scripts_dir);
> > - perf_session__delete(session);
> > - return i;
> > -}
> > -
> > static char *get_script_path(const char *script_root, const char *suffix)
> > {
> > struct dirent *script_dirent, *lang_dirent;
> > diff --git a/tools/perf/builtin.h b/tools/perf/builtin.h
> > index 94f4b3769bf7..a07e93c53848 100644
> > --- a/tools/perf/builtin.h
> > +++ b/tools/perf/builtin.h
> > @@ -2,10 +2,6 @@
> > #ifndef BUILTIN_H
> > #define BUILTIN_H
> >
> > -#include <stddef.h>
> > -#include <linux/compiler.h>
> > -#include <tools/config.h>
> > -
> > struct feature_status {
> > const char *name;
> > const char *macro;
> > @@ -56,6 +52,4 @@ int cmd_ftrace(int argc, const char **argv);
> > int cmd_daemon(int argc, const char **argv);
> > int cmd_kwork(int argc, const char **argv);
> >
> > -int find_scripts(char **scripts_array, char **scripts_path_array, int num,
> > - int pathlen);
> > #endif
> > diff --git a/tools/perf/ui/browsers/scripts.c b/tools/perf/ui/browsers/scripts.c
> > index e437d7889de6..2d04ece833aa 100644
> > --- a/tools/perf/ui/browsers/scripts.c
> > +++ b/tools/perf/ui/browsers/scripts.c
> > @@ -1,16 +1,18 @@
> > // SPDX-License-Identifier: GPL-2.0
> > -#include "../../builtin.h"
> > -#include "../../perf.h"
> > #include "../../util/util.h" // perf_exe()
> > #include "../util.h"
> > +#include "../../util/evlist.h"
> > #include "../../util/hist.h"
> > #include "../../util/debug.h"
> > +#include "../../util/session.h"
> > #include "../../util/symbol.h"
> > #include "../browser.h"
> > #include "../libslang.h"
> > #include "config.h"
> > +#include <linux/err.h>
> > #include <linux/string.h>
> > #include <linux/zalloc.h>
> > +#include <subcmd/exec-cmd.h>
> > #include <stdlib.h>
> >
> > #define SCRIPT_NAMELEN 128
> > @@ -77,6 +79,177 @@ static int scripts_config(const char *var, const char *value, void *data)
> > return 0;
> > }
> >
> > +/*
> > + * Some scripts specify the required events in their "xxx-record" file,
> > + * this function will check if the events in perf.data match those
> > + * mentioned in the "xxx-record".
> > + *
> > + * Fixme: All existing "xxx-record" are all in good formats "-e event ",
> > + * which is covered well now. And new parsing code should be added to
> > + * cover the future complex formats like event groups etc.
> > + */
> > +static int check_ev_match(int dir_fd, const char *scriptname, struct perf_session *session)
> > +{
> > + char line[BUFSIZ];
> > + FILE *fp;
> > +
> > + {
> > + char filename[FILENAME_MAX + 5];
> > + int fd;
> > +
> > + scnprintf(filename, sizeof(filename), "bin/%s-record", scriptname);
> > + fd = openat(dir_fd, filename, O_RDONLY);
> > + if (fd == -1)
> > + return -1;
> > + fp = fdopen(fd, "r");
> > + if (!fp)
> > + return -1;
> > + }
> > +
> > + while (fgets(line, sizeof(line), fp)) {
> > + char *p = skip_spaces(line);
> > +
> > + if (*p == '#')
> > + continue;
> > +
> > + while (strlen(p)) {
> > + int match, len;
> > + struct evsel *pos;
> > + char evname[128];
> > +
> > + p = strstr(p, "-e");
> > + if (!p)
> > + break;
> > +
> > + p += 2;
> > + p = skip_spaces(p);
> > + len = strcspn(p, " \t");
> > + if (!len)
> > + break;
> > +
> > + snprintf(evname, len + 1, "%s", p);
> > +
> > + match = 0;
> > + evlist__for_each_entry(session->evlist, pos) {
> > + if (evsel__name_is(pos, evname)) {
> > + match = 1;
> > + break;
> > + }
> > + }
> > +
> > + if (!match) {
> > + fclose(fp);
> > + return -1;
> > + }
> > + }
> > + }
> > +
> > + fclose(fp);
> > + return 0;
> > +}
> > +
> > +/*
> > + * Return -1 if none is found, otherwise the actual scripts number.
> > + *
> > + * Currently the only user of this function is the script browser, which
> > + * will list all statically runnable scripts, select one, execute it and
> > + * show the output in a perf browser.
> > + */
> > +static int find_scripts(char **scripts_array, char **scripts_path_array, int num,
> > + int pathlen)
> > +{
> > + struct dirent *script_dirent, *lang_dirent;
> > + int scripts_dir_fd, lang_dir_fd;
> > + DIR *scripts_dir, *lang_dir;
> > + struct perf_session *session;
> > + struct perf_data data = {
> > + .path = input_name,
> > + .mode = PERF_DATA_MODE_READ,
> > + };
> > + char *temp;
> > + int i = 0;
> > + const char *exec_path = get_argv_exec_path();
> > +
> > + session = perf_session__new(&data, NULL);
> > + if (IS_ERR(session))
> > + return PTR_ERR(session);
> > +
> > + {
> > + char scripts_path[PATH_MAX];
> > +
> > + snprintf(scripts_path, sizeof(scripts_path), "%s/scripts", exec_path);
> > + scripts_dir_fd = open(scripts_path, O_DIRECTORY);
> > + pr_err("Failed to open directory '%s'", scripts_path);
> > + if (scripts_dir_fd == -1) {
> > + perf_session__delete(session);
> > + return -1;
> > + }
> > + }
> > + scripts_dir = fdopendir(scripts_dir_fd);
> > + if (!scripts_dir) {
> > + close(scripts_dir_fd);
> > + perf_session__delete(session);
> > + return -1;
> > + }
> > +
> > + while ((lang_dirent = readdir(scripts_dir)) != NULL) {
> > + if (lang_dirent->d_type != DT_DIR &&
> > + (lang_dirent->d_type == DT_UNKNOWN &&
> > + !is_directory_at(scripts_dir_fd, lang_dirent->d_name)))
> > + continue;
> > + if (!strcmp(lang_dirent->d_name, ".") || !strcmp(lang_dirent->d_name, ".."))
> > + continue;
> > +
> > +#ifndef HAVE_LIBPERL_SUPPORT
> > + if (strstr(lang_dirent->d_name, "perl"))
> > + continue;
> > +#endif
> > +#ifndef HAVE_LIBPYTHON_SUPPORT
> > + if (strstr(lang_dirent->d_name, "python"))
> > + continue;
> > +#endif
> > +
> > + lang_dir_fd = openat(scripts_dir_fd, lang_dirent->d_name, O_DIRECTORY);
> > + if (lang_dir_fd == -1)
> > + continue;
> > + lang_dir = fdopendir(lang_dir_fd);
> > + if (!lang_dir) {
> > + close(lang_dir_fd);
> > + continue;
> > + }
> > + while ((script_dirent = readdir(lang_dir)) != NULL) {
> > + if (script_dirent->d_type == DT_DIR)
> > + continue;
> > + if (script_dirent->d_type == DT_UNKNOWN &&
> > + is_directory_at(lang_dir_fd, script_dirent->d_name))
> > + continue;
> > + /* Skip those real time scripts: xxxtop.p[yl] */
> > + if (strstr(script_dirent->d_name, "top."))
> > + continue;
> > + if (i >= num)
> > + break;
> > + scnprintf(scripts_path_array[i], pathlen, "%s/scripts/%s/%s",
> > + exec_path,
> > + lang_dirent->d_name,
> > + script_dirent->d_name);
> > + temp = strchr(script_dirent->d_name, '.');
> > + snprintf(scripts_array[i],
> > + (temp - script_dirent->d_name) + 1,
> > + "%s", script_dirent->d_name);
> > +
> > + if (check_ev_match(lang_dir_fd, scripts_array[i], session))
> > + continue;
> > +
> > + i++;
> > + }
> > + closedir(lang_dir);
> > + }
> > +
> > + closedir(scripts_dir);
> > + perf_session__delete(session);
> > + return i;
> > +}
> > +
> > /*
> > * When success, will copy the full path of the selected script
> > * into the buffer pointed by script_name, and return 0.
> > diff --git a/tools/perf/util/path.c b/tools/perf/util/path.c
> > index 00adf872bf00..9712466c51e2 100644
> > --- a/tools/perf/util/path.c
> > +++ b/tools/perf/util/path.c
> > @@ -68,6 +68,16 @@ bool is_directory(const char *base_path, const struct dirent *dent)
> > return S_ISDIR(st.st_mode);
> > }
> >
> > +bool is_directory_at(int dir_fd, const char *path)
> > +{
> > + struct stat st;
> > +
> > + if (fstatat(dir_fd, path, &st, /*flags=*/0))
> > + return false;
> > +
> > + return S_ISDIR(st.st_mode);
> > +}
> > +
> > bool is_executable_file(const char *base_path, const struct dirent *dent)
> > {
> > char path[PATH_MAX];
> > diff --git a/tools/perf/util/path.h b/tools/perf/util/path.h
> > index d94902c22222..fbafbe7015dd 100644
> > --- a/tools/perf/util/path.h
> > +++ b/tools/perf/util/path.h
> > @@ -12,6 +12,7 @@ int path__join3(char *bf, size_t size, const char *path1, const char *path2, con
> >
> > bool is_regular_file(const char *file);
> > bool is_directory(const char *base_path, const struct dirent *dent);
> > +bool is_directory_at(int dir_fd, const char *path);
> > bool is_executable_file(const char *base_path, const struct dirent *dent);
> >
> > #endif /* _PERF_PATH_H */
> > diff --git a/tools/perf/util/python.c b/tools/perf/util/python.c
> > index ab67abf3b607..5f11ae88943d 100644
> > --- a/tools/perf/util/python.c
> > +++ b/tools/perf/util/python.c
> > @@ -1306,12 +1306,6 @@ PyMODINIT_FUNC PyInit_perf(void)
> > /* The following are stubs to avoid dragging in builtin-* objects. */
> > /* TODO: move the code out of the builtin-* file into util. */
> >
> > -int find_scripts(char **scripts_array __maybe_unused, char **scripts_path_array __maybe_unused,
> > - int num __maybe_unused, int pathlen __maybe_unused)
> > -{
> > - return -1;
> > -}
> > -
> > void perf_stat__set_no_csv_summary(int set __maybe_unused)
> > {
> > }
> > --
> > 2.47.0.163.g1226f6d8fa-goog
> >
Powered by blists - more mailing lists