Message-ID: <CAP-5=fV2S1iyjVnwM9ivGjyfCxkb+YUY-4y__=OLNHZnMs=9Wg@mail.gmail.com>
Date:   Mon, 5 Jun 2023 13:19:52 -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>,
        Mark Rutland <mark.rutland@....com>,
        Alexander Shishkin <alexander.shishkin@...ux.intel.com>,
        Jiri Olsa <jolsa@...nel.org>,
        Namhyung Kim <namhyung@...nel.org>,
        Adrian Hunter <adrian.hunter@...el.com>,
        linux-perf-users@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] tools headers: Make the difference output easier to read

On Mon, Jun 5, 2023 at 12:37 PM Arnaldo Carvalho de Melo
<acme@...nel.org> wrote:
>
> Em Mon, Jun 05, 2023 at 12:13:46PM -0700, Ian Rogers escreveu:
> > Add failures to an array and display it before exiting.
> >
> > Before:
> > ```
> > Warning: Kernel ABI header at 'tools/include/uapi/linux/perf_event.h' differs from latest version at 'include/uapi/linux/perf_event.h'
> > diff -u tools/include/uapi/linux/perf_event.h include/uapi/linux/perf_event.h
> > Warning: Kernel ABI header at 'tools/arch/arm64/include/uapi/asm/perf_regs.h' differs from latest version at 'arch/arm64/include/uapi/asm/perf_regs.h'
> > diff -u tools/arch/arm64/include/uapi/asm/perf_regs.h arch/arm64/include/uapi/asm/perf_regs.h
> > Warning: Kernel ABI header at 'tools/arch/arm64/include/asm/cputype.h' differs from latest version at 'arch/arm64/include/asm/cputype.h'
> > diff -u tools/arch/arm64/include/asm/cputype.h arch/arm64/include/asm/cputype.h
> > ...
> > ```
> >
> > After:
> > ```
> > Warning: Kernel ABI header differences:
> >   diff -u tools/include/uapi/linux/perf_event.h include/uapi/linux/perf_event.h
> >   diff -u tools/arch/arm64/include/uapi/asm/perf_regs.h arch/arm64/include/uapi/asm/perf_regs.h
> >   diff -u tools/arch/arm64/include/asm/cputype.h arch/arm64/include/asm/cputype.h
> > ...
> > ```
>
> Here I'm seeing it twice, I was expecting what is in the cset log
> message, that looks perfect: shows what is different while keeping a
> line to cut'n'paste and indents the diff lines so that the warnings
> stand out in the output, can you please take a look?

Yep, sorry I left in a debug echo.

Ian

> ⬢[acme@...lbox perf-tools-next]$ alias m
> alias m='perf stat -e cycles:u,instructions:u make -k BUILD_BPF_SKEL=1 CORESIGHT=1 PYTHON=python3 O=/tmp/build/perf-tools-next -C tools/perf install-bin && git status && perf test python'
> ⬢[acme@...lbox perf-tools-next]$ m
> make: Entering directory '/var/home/acme/git/perf-tools-next/tools/perf'
>   BUILD:   Doing 'make -j32' parallel build
> tools/include/uapi/linux/perf_event.h include/uapi/linux/perf_event.h
> tools/arch/arm64/include/uapi/asm/perf_regs.h arch/arm64/include/uapi/asm/perf_regs.h
> tools/arch/arm64/include/asm/cputype.h arch/arm64/include/asm/cputype.h
> Warning: Kernel ABI header differences:
>   diff -u tools/include/uapi/linux/perf_event.h include/uapi/linux/perf_event.h
>   diff -u tools/arch/arm64/include/uapi/asm/perf_regs.h arch/arm64/include/uapi/asm/perf_regs.h
>   diff -u tools/arch/arm64/include/asm/cputype.h arch/arm64/include/asm/cputype.h
>
>   INSTALL libsubcmd_headers
>
>
> > The aim is to make the warnings easier to read and distinguish from
> > other Makefile warnings messages.
> >
> > Signed-off-by: Ian Rogers <irogers@...gle.com>
> >
> > v2. Is a rebase, avoids the warning message if there are no diffs,
> >     adds diff to the output for easier copy and paste.
> > ---
> >  tools/perf/check-headers.sh | 233 ++++++++++++++++++++----------------
> >  1 file changed, 129 insertions(+), 104 deletions(-)
> >
> > diff --git a/tools/perf/check-headers.sh b/tools/perf/check-headers.sh
> > index 6f831ee2f60f..bcad6a7d8e5d 100755
> > --- a/tools/perf/check-headers.sh
> > +++ b/tools/perf/check-headers.sh
> > @@ -1,113 +1,122 @@
> > -#!/bin/sh
> > +#!/bin/bash
> >  # SPDX-License-Identifier: GPL-2.0
> >
> > -FILES='
> > -include/uapi/linux/const.h
> > -include/uapi/drm/drm.h
> > -include/uapi/drm/i915_drm.h
> > -include/uapi/linux/fadvise.h
> > -include/uapi/linux/fcntl.h
> > -include/uapi/linux/fs.h
> > -include/uapi/linux/fscrypt.h
> > -include/uapi/linux/kcmp.h
> > -include/uapi/linux/kvm.h
> > -include/uapi/linux/in.h
> > -include/uapi/linux/mount.h
> > -include/uapi/linux/openat2.h
> > -include/uapi/linux/perf_event.h
> > -include/uapi/linux/prctl.h
> > -include/uapi/linux/sched.h
> > -include/uapi/linux/stat.h
> > -include/uapi/linux/usbdevice_fs.h
> > -include/uapi/linux/vhost.h
> > -include/uapi/sound/asound.h
> > -include/linux/bits.h
> > -include/vdso/bits.h
> > -include/linux/const.h
> > -include/vdso/const.h
> > -include/linux/hash.h
> > -include/linux/list-sort.h
> > -include/uapi/linux/hw_breakpoint.h
> > -arch/x86/include/asm/disabled-features.h
> > -arch/x86/include/asm/required-features.h
> > -arch/x86/include/asm/cpufeatures.h
> > -arch/x86/include/asm/inat_types.h
> > -arch/x86/include/asm/emulate_prefix.h
> > -arch/x86/include/asm/irq_vectors.h
> > -arch/x86/include/asm/msr-index.h
> > -arch/x86/include/uapi/asm/prctl.h
> > -arch/x86/lib/x86-opcode-map.txt
> > -arch/x86/tools/gen-insn-attr-x86.awk
> > -arch/arm/include/uapi/asm/perf_regs.h
> > -arch/arm64/include/uapi/asm/perf_regs.h
> > -arch/loongarch/include/uapi/asm/perf_regs.h
> > -arch/mips/include/uapi/asm/perf_regs.h
> > -arch/powerpc/include/uapi/asm/perf_regs.h
> > -arch/s390/include/uapi/asm/perf_regs.h
> > -arch/x86/include/uapi/asm/perf_regs.h
> > -arch/x86/include/uapi/asm/kvm.h
> > -arch/x86/include/uapi/asm/kvm_perf.h
> > -arch/x86/include/uapi/asm/svm.h
> > -arch/x86/include/uapi/asm/unistd.h
> > -arch/x86/include/uapi/asm/vmx.h
> > -arch/powerpc/include/uapi/asm/kvm.h
> > -arch/s390/include/uapi/asm/kvm.h
> > -arch/s390/include/uapi/asm/kvm_perf.h
> > -arch/s390/include/uapi/asm/sie.h
> > -arch/arm/include/uapi/asm/kvm.h
> > -arch/arm64/include/uapi/asm/kvm.h
> > -arch/arm64/include/uapi/asm/unistd.h
> > -arch/alpha/include/uapi/asm/errno.h
> > -arch/mips/include/asm/errno.h
> > -arch/mips/include/uapi/asm/errno.h
> > -arch/parisc/include/uapi/asm/errno.h
> > -arch/powerpc/include/uapi/asm/errno.h
> > -arch/sparc/include/uapi/asm/errno.h
> > -arch/x86/include/uapi/asm/errno.h
> > -include/asm-generic/bitops/arch_hweight.h
> > -include/asm-generic/bitops/const_hweight.h
> > -include/asm-generic/bitops/__fls.h
> > -include/asm-generic/bitops/fls.h
> > -include/asm-generic/bitops/fls64.h
> > -include/linux/coresight-pmu.h
> > -include/uapi/asm-generic/errno.h
> > -include/uapi/asm-generic/errno-base.h
> > -include/uapi/asm-generic/ioctls.h
> > -include/uapi/asm-generic/mman-common.h
> > -include/uapi/asm-generic/unistd.h
> > -'
> > -
> > -SYNC_CHECK_FILES='
> > -arch/x86/include/asm/inat.h
> > -arch/x86/include/asm/insn.h
> > -arch/x86/lib/inat.c
> > -arch/x86/lib/insn.c
> > -'
> > +YELLOW='\033[0;33m'
> > +NC='\033[0m' # No Color
> > +
> > +declare -a FILES
> > +FILES=(
> > +  "include/uapi/linux/const.h"
> > +  "include/uapi/drm/drm.h"
> > +  "include/uapi/drm/i915_drm.h"
> > +  "include/uapi/linux/fadvise.h"
> > +  "include/uapi/linux/fcntl.h"
> > +  "include/uapi/linux/fs.h"
> > +  "include/uapi/linux/fscrypt.h"
> > +  "include/uapi/linux/kcmp.h"
> > +  "include/uapi/linux/kvm.h"
> > +  "include/uapi/linux/in.h"
> > +  "include/uapi/linux/mount.h"
> > +  "include/uapi/linux/openat2.h"
> > +  "include/uapi/linux/perf_event.h"
> > +  "include/uapi/linux/prctl.h"
> > +  "include/uapi/linux/sched.h"
> > +  "include/uapi/linux/stat.h"
> > +  "include/uapi/linux/usbdevice_fs.h"
> > +  "include/uapi/linux/vhost.h"
> > +  "include/uapi/sound/asound.h"
> > +  "include/linux/bits.h"
> > +  "include/vdso/bits.h"
> > +  "include/linux/const.h"
> > +  "include/vdso/const.h"
> > +  "include/linux/hash.h"
> > +  "include/linux/list-sort.h"
> > +  "include/uapi/linux/hw_breakpoint.h"
> > +  "arch/x86/include/asm/disabled-features.h"
> > +  "arch/x86/include/asm/required-features.h"
> > +  "arch/x86/include/asm/cpufeatures.h"
> > +  "arch/x86/include/asm/inat_types.h"
> > +  "arch/x86/include/asm/emulate_prefix.h"
> > +  "arch/x86/include/asm/irq_vectors.h"
> > +  "arch/x86/include/asm/msr-index.h"
> > +  "arch/x86/include/uapi/asm/prctl.h"
> > +  "arch/x86/lib/x86-opcode-map.txt"
> > +  "arch/x86/tools/gen-insn-attr-x86.awk"
> > +  "arch/arm/include/uapi/asm/perf_regs.h"
> > +  "arch/arm64/include/uapi/asm/perf_regs.h"
> > +  "arch/loongarch/include/uapi/asm/perf_regs.h"
> > +  "arch/mips/include/uapi/asm/perf_regs.h"
> > +  "arch/powerpc/include/uapi/asm/perf_regs.h"
> > +  "arch/s390/include/uapi/asm/perf_regs.h"
> > +  "arch/x86/include/uapi/asm/perf_regs.h"
> > +  "arch/x86/include/uapi/asm/kvm.h"
> > +  "arch/x86/include/uapi/asm/kvm_perf.h"
> > +  "arch/x86/include/uapi/asm/svm.h"
> > +  "arch/x86/include/uapi/asm/unistd.h"
> > +  "arch/x86/include/uapi/asm/vmx.h"
> > +  "arch/powerpc/include/uapi/asm/kvm.h"
> > +  "arch/s390/include/uapi/asm/kvm.h"
> > +  "arch/s390/include/uapi/asm/kvm_perf.h"
> > +  "arch/s390/include/uapi/asm/sie.h"
> > +  "arch/arm/include/uapi/asm/kvm.h"
> > +  "arch/arm64/include/uapi/asm/kvm.h"
> > +  "arch/arm64/include/uapi/asm/unistd.h"
> > +  "arch/alpha/include/uapi/asm/errno.h"
> > +  "arch/mips/include/asm/errno.h"
> > +  "arch/mips/include/uapi/asm/errno.h"
> > +  "arch/parisc/include/uapi/asm/errno.h"
> > +  "arch/powerpc/include/uapi/asm/errno.h"
> > +  "arch/sparc/include/uapi/asm/errno.h"
> > +  "arch/x86/include/uapi/asm/errno.h"
> > +  "include/asm-generic/bitops/arch_hweight.h"
> > +  "include/asm-generic/bitops/const_hweight.h"
> > +  "include/asm-generic/bitops/__fls.h"
> > +  "include/asm-generic/bitops/fls.h"
> > +  "include/asm-generic/bitops/fls64.h"
> > +  "include/linux/coresight-pmu.h"
> > +  "include/uapi/asm-generic/errno.h"
> > +  "include/uapi/asm-generic/errno-base.h"
> > +  "include/uapi/asm-generic/ioctls.h"
> > +  "include/uapi/asm-generic/mman-common.h"
> > +  "include/uapi/asm-generic/unistd.h"
> > +)
> > +
> > +declare -a SYNC_CHECK_FILES
> > +SYNC_CHECK_FILES=(
> > +  "arch/x86/include/asm/inat.h"
> > +  "arch/x86/include/asm/insn.h"
> > +  "arch/x86/lib/inat.c"
> > +  "arch/x86/lib/insn.c"
> > +)
> >
> >  # These copies are under tools/perf/trace/beauty/ as they are not used to in
> >  # building object files only by scripts in tools/perf/trace/beauty/ to generate
> >  # tables that then gets included in .c files for things like id->string syscall
> >  # tables (and the reverse lookup as well: string -> id)
> >
> > -BEAUTY_FILES='
> > -include/linux/socket.h
> > -'
> > +declare -a BEAUTY_FILES
> > +BEAUTY_FILES=(
> > +  "include/linux/socket.h"
> > +)
> > +
> > +declare -a FAILURES
> >
> >  check_2 () {
> > -  file1=$1
> > -  file2=$2
> > +  tools_file=$1
> > +  orig_file=$2
> >
> >    shift
> >    shift
> >
> > -  cmd="diff $* $file1 $file2 > /dev/null"
> > +  cmd="diff $* $tools_file $orig_file > /dev/null"
> >
> > -  test -f $file2 && {
> > -    eval $cmd || {
> > -      echo "Warning: Kernel ABI header at '$file1' differs from latest version at '$file2'" >&2
> > -      echo diff -u $file1 $file2
> > -    }
> > -  }
> > +  if [ -f "$orig_file" ] && ! eval "$cmd"
> > +  then
> > +    echo "$tools_file $orig_file"
> > +    FAILURES+=(
> > +      "$tools_file $orig_file"
> > +    )
> > +  fi
> >  }
> >
> >  check () {
> > @@ -115,7 +124,7 @@ check () {
> >
> >    shift
> >
> > -  check_2 tools/$file $file $*
> > +  check_2 "tools/$file" "$file" $*
> >  }
> >
> >  beauty_check () {
> > @@ -123,23 +132,29 @@ beauty_check () {
> >
> >    shift
> >
> > -  check_2 tools/perf/trace/beauty/$file $file $*
> > +  check_2 "tools/perf/trace/beauty/$file" "$file" $*
> >  }
> >
> >  # Check if we have the kernel headers (tools/perf/../../include), else
> >  # we're probably on a detached tarball, so no point in trying to check
> >  # differences.
> > -test -d ../../include || exit 0
> > +if ! [ -d ../../include ]
> > +then
> > +  echo -e "${YELLOW}Warning${NC}: Skipped check-headers due to missing ../../include"
> > +  exit 0
> > +fi
> >
> >  cd ../..
> >
> >  # simple diff check
> > -for i in $FILES; do
> > -  check $i -B
> > +for i in "${FILES[@]}"
> > +do
> > +  check "$i" -B
> >  done
> >
> > -for i in $SYNC_CHECK_FILES; do
> > -  check $i '-I "^.*\/\*.*__ignore_sync_check__.*\*\/.*$"'
> > +for i in "${SYNC_CHECK_FILES[@]}"
> > +do
> > +  check "$i" '-I "^.*\/\*.*__ignore_sync_check__.*\*\/.*$"'
> >  done
> >
> >  # diff with extra ignore lines
> > @@ -160,8 +175,9 @@ check_2 tools/perf/arch/powerpc/entry/syscalls/syscall.tbl arch/powerpc/kernel/s
> >  check_2 tools/perf/arch/s390/entry/syscalls/syscall.tbl arch/s390/kernel/syscalls/syscall.tbl
> >  check_2 tools/perf/arch/mips/entry/syscalls/syscall_n64.tbl arch/mips/kernel/syscalls/syscall_n64.tbl
> >
> > -for i in $BEAUTY_FILES; do
> > -  beauty_check $i -B
> > +for i in "${BEAUTY_FILES[@]}"
> > +do
> > +  beauty_check "$i" -B
> >  done
> >
> >  # check duplicated library files
> > @@ -169,3 +185,12 @@ check_2 tools/perf/util/hashmap.h tools/lib/bpf/hashmap.h
> >  check_2 tools/perf/util/hashmap.c tools/lib/bpf/hashmap.c
> >
> >  cd tools/perf
> > +
> > +if [ ${#FAILURES[@]} -gt 0 ]
> > +then
> > +  echo -e "${YELLOW}Warning${NC}: Kernel ABI header differences:"
> > +  for i in "${FAILURES[@]}"
> > +  do
> > +    echo "  diff -u $i"
> > +  done
> > +fi
> > --
> > 2.41.0.rc0.172.g3f132b7071-goog
> >
>
> --
>
> - Arnaldo

Powered by blists - more mailing lists