From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.8 required=3.0 tests=DKIM_ADSP_CUSTOM_MED, DKIM_INVALID,DKIM_SIGNED,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 12A46C433DF for ; Fri, 26 Jun 2020 14:20:05 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id C33F3208C9 for ; Fri, 26 Jun 2020 14:20:04 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="ma+hnIeL" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org C33F3208C9 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:37466 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jopD2-0004q1-2e for qemu-devel@archiver.kernel.org; Fri, 26 Jun 2020 10:20:04 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:47832) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jopCK-0004L7-0N for qemu-devel@nongnu.org; Fri, 26 Jun 2020 10:19:20 -0400 Received: from mail-lj1-x242.google.com ([2a00:1450:4864:20::242]:34206) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1jopCH-0006QA-FT for qemu-devel@nongnu.org; Fri, 26 Jun 2020 10:19:19 -0400 Received: by mail-lj1-x242.google.com with SMTP id x18so10553017lji.1 for ; Fri, 26 Jun 2020 07:19:16 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc:content-transfer-encoding; bh=uw8v9cgjcz1o9NYQ3JDUINFfCN2ao/eHHaaJCDt/2So=; b=ma+hnIeLm+lPoYA5kNCd8jmxQ5kgTuS8DS96lj26kpXCWmEnrH4gZQhtLsiowxO/Rq TIXLlfBeJSBnXpxbo80yYV84slRq/iqWO3c1aIAIrkP2/xNKmAQXKKgXtIO6GJDWSdRH X2zz3YXTNo84IZNokCbiALASAqnGCZZejU7ZkxDZTeZEB595+gW+mSM4VommY6gwUUp5 EmnIY0KViKCBngpugg77pletvDSaw+giUzK/bYfa/5ytOf3B8TGjQ80a0Z2lHXFD+aW7 PZsZHsQ6Rlk0N5WvJjtx68aY6x5LOkMyhHdUpuBLIfe3HRp35GSZRfsvlgBHLhjEFOcH zGYQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc:content-transfer-encoding; bh=uw8v9cgjcz1o9NYQ3JDUINFfCN2ao/eHHaaJCDt/2So=; b=ojjOsb9fZIfNTNZDxc2N14pE4kkzEnIoNgvRhDkMM/ryF1Bi+NaG7DQzYyJ66rF27h tEEEBy5UFaV1nJLRfHexfiArADwZm7VYbl/tK99GCkFlGjth1MFD2BAj1HGom3Bx42ok vFlQK87wXYOM4NTv6PR1/ecABo3kWnEsKCWABjHV0B5baUb7wvb34hiLGaBzFt0vm68i pa9dGE8lj+Qx7jst4UMZpfn3+8Ag+u5nRupEhrfPoeJwa6l9kCtffCdmSeclpgkqQKx7 u6lRt3p/occuacx2VjwLScHUXIYvYvoBxZECJVfMa73f4kTy4rdiRhTKTGAo5W6HamJs td5Q== X-Gm-Message-State: AOAM532Btr6SupDFvrfMjr0GhzTSu5dL+jka8s6fYMBTbin/Waucdstz xrI0aX6PEMNFIf3YxCAmDLiFwt/IYRXmIADEEqg= X-Google-Smtp-Source: ABdhPJxiQaIO36FXMK/3tLXiscDvnZHLIHqIh3U469n58ezHMzH3Gxi0mTpYXL6rr/3zGt/XHRg8pTAQLlv7gqRp93o= X-Received: by 2002:a2e:850b:: with SMTP id j11mr1153422lji.30.1593181151074; Fri, 26 Jun 2020 07:19:11 -0700 (PDT) MIME-Version: 1.0 References: <20200624153142.13247-1-ahmedkhaledkaraman@gmail.com> <20200624153142.13247-2-ahmedkhaledkaraman@gmail.com> In-Reply-To: From: Ahmed Karaman Date: Fri, 26 Jun 2020 16:18:35 +0200 Message-ID: Subject: Re: [PATCH v3 1/3] scripts/performance: Add topN_perf.py script To: Aleksandar Markovic Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Received-SPF: pass client-ip=2a00:1450:4864:20::242; envelope-from=ahmedkhaledkaraman@gmail.com; helo=mail-lj1-x242.google.com X-detected-operating-system: by eggs.gnu.org: No matching host in p0f cache. That's all we know. X-Spam_score_int: -10 X-Spam_score: -1.1 X-Spam_bar: - X-Spam_report: (-1.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, PDS_OTHER_BAD_TLD=1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001 autolearn=_AUTOLEARN X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?B?THVrw6HFoSBEb2t0b3I=?= , Eduardo Habkost , =?UTF-8?B?QWxleCBCZW5uw6ll?= , QEMU Developers , Cleber Rosa , Richard Henderson Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" On Thu, Jun 25, 2020 at 11:45 AM Aleksandar Markovic wrote: > > =D1=81=D1=80=D0=B5, 24. =D1=98=D1=83=D0=BD 2020. =D1=83 17:32 Ahmed Karam= an > =D1=98=D0=B5 =D0=BD=D0=B0=D0=BF=D0=B8=D1= =81=D0=B0=D0=BE/=D0=BB=D0=B0: > > > > Syntax: > > topN_perf.py [-h] [-n] -- \ > > [] \ > > [] > > > > [-h] - Print the script arguments help message. > > [-n] - Specify the number of top functions to print. > > - If this flag is not specified, the tool defaults to 25. > > > > Example of usage: > > topN_perf.py -n 20 -- qemu-arm coulomb_double-arm > > > > Example Output: > > No. Percentage Name Caller > > ---- ---------- ------------------------- ------------------------- > > 1 16.25% float64_mul qemu-x86_64 > > 2 12.01% float64_sub qemu-x86_64 > > 3 11.99% float64_add qemu-x86_64 > > 4 5.69% helper_mulsd qemu-x86_64 > > 5 4.68% helper_addsd qemu-x86_64 > > 6 4.43% helper_lookup_tb_ptr qemu-x86_64 > > 7 4.28% helper_subsd qemu-x86_64 > > 8 2.71% f64_compare qemu-x86_64 > > 9 2.71% helper_ucomisd qemu-x86_64 > > 10 1.04% helper_pand_xmm qemu-x86_64 > > 11 0.71% float64_div qemu-x86_64 > > 12 0.63% helper_pxor_xmm qemu-x86_64 > > 13 0.50% 0x00007f7b7004ef95 [JIT] tid 491 > > 14 0.50% 0x00007f7b70044e83 [JIT] tid 491 > > 15 0.36% helper_por_xmm qemu-x86_64 > > 16 0.32% helper_cc_compute_all qemu-x86_64 > > 17 0.30% 0x00007f7b700433f0 [JIT] tid 491 > > 18 0.30% float64_compare_quiet qemu-x86_64 > > 19 0.27% soft_f64_addsub qemu-x86_64 > > 20 0.26% round_to_int qemu-x86_64 > > > > Signed-off-by: Ahmed Karaman > > --- > > scripts/performance/topN_perf.py | 142 +++++++++++++++++++++++++++++++ > > 1 file changed, 142 insertions(+) > > create mode 100755 scripts/performance/topN_perf.py > > > > diff --git a/scripts/performance/topN_perf.py b/scripts/performance/top= N_perf.py > > new file mode 100755 > > index 0000000000..d2b939c375 > > --- /dev/null > > +++ b/scripts/performance/topN_perf.py > > @@ -0,0 +1,142 @@ > > +#!/usr/bin/env python3 > > + > > +# Print the top N most executed functions in QEMU using perf. > > +# Syntax: > > +# topN_perf.py [-h] [-n] -- \ > > +# [] \ > > +# [] > > +# > > +# [-h] - Print the script arguments help message. > > +# [-n] - Specify the number of top functions to print. > > +# - If this flag is not specified, the tool defaults to 25. > > +# > > +# Example of usage: > > +# topN_perf.py -n 20 -- qemu-arm coulomb_double-arm > > +# > > +# This file is a part of the project "TCG Continuous Benchmarking". > > +# > > +# Copyright (C) 2020 Ahmed Karaman > > +# Copyright (C) 2020 Aleksandar Markovic > > +# > > +# This program is free software: you can redistribute it and/or modif= y > > +# it under the terms of the GNU General Public License as published b= y > > +# the Free Software Foundation, either version 2 of the License, or > > +# (at your option) any later version. > > +# > > +# This program is distributed in the hope that it will be useful, > > +# but WITHOUT ANY WARRANTY; without even the implied warranty of > > +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the > > +# GNU General Public License for more details. > > +# > > +# You should have received a copy of the GNU General Public License > > +# along with this program. If not, see . > > + > > +import argparse > > +import os > > +import subprocess > > +import sys > > + > > + > > +# Parse the command line arguments > > +parser =3D argparse.ArgumentParser( > > + usage=3D'topN_perf.py [-h] [-n] -- ' > > + ' [] ' > > + ' []') > > + > > +parser.add_argument('-n', dest=3D'top', type=3Dint, default=3D25, > > + help=3D'Specify the number of top functions to pri= nt.') > > + > > +parser.add_argument('command', type=3Dstr, nargs=3D'+', help=3Dargpars= e.SUPPRESS) > > + > > +args =3D parser.parse_args() > > + > > +# Extract the needed variables from the args > > +command =3D args.command > > +top =3D args.top > > + > > +# Insure that perf is installed > > +check_perf =3D subprocess.run(["which", "perf"], stdout=3Dsubprocess.D= EVNULL) > > +if check_perf.returncode: > > + sys.exit("Please install perf before running the script!") > > I would rename "chech_perf" to "check_perf_presence". It is more > specific, clearer. > > > + > > +# Insure user has previllage to run perf > > +check_perf_executability =3D subprocess.run(["perf", "stat", "ls", "/"= ], > > + stdout=3Dsubprocess.DEVNULL, stderr=3Dsubpr= ocess.DEVNULL) > > +if check_perf_executability.returncode: > > + sys.exit( > > +""" > > +Error: > > +You may not have permission to collect stats. > > + > > +Consider tweaking /proc/sys/kernel/perf_event_paranoid, > > +which controls use of the performance events system by > > +unprivileged users (without CAP_SYS_ADMIN). > > + > > + -1: Allow use of (almost) all events by all users > > + Ignore mlock limit after perf_event_mlock_kb without CAP_IPC_LOC= K > > + 0: Disallow ftrace function tracepoint by users without CAP_SYS_ADM= IN > > + Disallow raw tracepoint access by users without CAP_SYS_ADMIN > > + 1: Disallow CPU event access by users without CAP_SYS_ADMIN > > + 2: Disallow kernel profiling by users without CAP_SYS_ADMIN > > + > > +To make this setting permanent, edit /etc/sysctl.conf too, e.g.: > > + kernel.perf_event_paranoid =3D -1 > > +""" > > +) > > Very good. > > > + > > +# Run perf record > > +perf_record =3D subprocess.run((["perf", "record"] + command), > > + stdout=3Dsubprocess.DEVNULL, stderr=3Dsub= process.PIPE) > > +if perf_record.returncode: > > + os.unlink('perf.data') > > + sys.exit(perf_record.stderr.decode("utf-8")) > > Here, the file "perf.data" will be created in the current working > directory. If one existed prior to script execution, it will be > overwritten. > > I think such "corruption" of current working directory is not optimal. > It would be better that the script doesn't touch current working > directory at all (perhaps user wants to keep perf.data he obtained > from some experiment in the past. > > Therefore, I think it would be better if you specify output of "perf > report" to be "/tmp/perf.data", not "perf.data", which is the default. > There is an option of "perf record" to specify the output file: > > -o, --output=3D > Output file name. > > > + > > +# Save perf report output to perf_report.out > > +with open("perf_report.out", "w") as output: > > + perf_report =3D subprocess.run( > > + ["perf", "report", "--stdio"], stdout=3Doutput, stderr=3Dsubpr= ocess.PIPE) > > + if perf_report.returncode: > > + os.unlink('perf.data') > > + output.close() > > + os.unlink('perf_report.out') > > + sys.exit(perf_report.stderr.decode("utf-8")) > > For similar reasons described above, input file should be > "/tmp/perf.data". Option of "perf report" for input file: > > -i, --input=3D > Input file name. > > Output file should be "/tmp/perf_report.out", not "perf_report.out". > > > + > > +# Read the reported data to functions[] > > +functions =3D [] > > +with open("perf_report.out", "r") as data: > > "/tmp/perf_report.out" > > > + # Only read lines that are not comments (comments start with #) > > + # Only read lines that are not empty > > + functions =3D [line for line in data.readlines() if line and line[= 0] > > + !=3D '#' and line[0] !=3D "\n"] > > + > > +# Limit the number of top functions to "top" > > +number_of_top_functions =3D top if len(functions) > top else len(funct= ions) > > + > > +# Store the data of the top functions in top_functions[] > > +top_functions =3D functions[:number_of_top_functions] > > + > > +# Print table header > > +print('{:>4} {:>10} {:<30} {}\n{} {} {} {}'.format('No.', > > + 'Percentage', > > + 'Name', > > 'Function Name' would be more ergonomic here. > > > + 'Caller', > > Please replace 'Caller' with 'Invoked by'. 'Caller' implies a function > that directly calls the function in question. 'Invoked by' avoids such > confusion, and it just feels more appropriate here. > > > + '-' * 4, > > + '-' * 10, > > + '-' * 30, > > + '-' * 25)) > > + > > + > > +# Print top N functions > > +for (index, function) in enumerate(top_functions, start=3D1): > > + function_data =3D function.split() > > + function_percentage =3D function_data[0] > > + function_name =3D function_data[-1] > > + function_caller =3D ' '.join(function_data[2:-2]) > > function_invoker > > > + print('{:>4} {:>10} {:<30} {}'.format(index, > > + function_percentage, > > + function_name, > > + function_caller)) > > function_invoker > > > + > > +# Remove intermediate files > > +os.unlink('perf.data') > > +os.unlink('perf_report.out') > > os.unlink('/tmp/perf.data') > os.unlink('/tmp/perf_report.out') > > > > -- > > 2.17.1 > > Thanks Mr. Aleksandar. These are really valid points. I'll add these updates in v4 of this series. Best regards, Ahmed Karaman