Received: by 2002:a05:6a10:5bc5:0:0:0:0 with SMTP id os5csp417189pxb; Mon, 25 Oct 2021 10:46:54 -0700 (PDT) X-Google-Smtp-Source: ABdhPJyOJBnyiY91fk9plTJRqCRP1O6l56BKnS9g2SH2bQN86dxoiTJuk3hG/40IIvLc2oRjh7dI X-Received: by 2002:a17:907:2155:: with SMTP id rk21mr24668246ejb.421.1635184014185; Mon, 25 Oct 2021 10:46:54 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1635184014; cv=none; d=google.com; s=arc-20160816; b=e5JueX+Eut5GZb4eglp/9mMlZBNGKDcvZ2I9AnLx0CV3ETFNk/Wg3vchhqC0GEnMxJ IGKuOWFuoMgJtvo9kKaE07KefE2ICcx0xJVYJE0wh/sWP5xqsk0VjCSn00nI57bRr1en y8qdaWUY2gRC8eB2h4EQeNVHh/2yGxmmlDYnDqerd9NsIkwsDiOmPJKrHWbMjQsrqA1A wJrGTYxtP4QsQjrD8VS6YAnpODmDIKby8IRasYt6lKh63/bAFsiTfMoTFs2+eK/gtnkQ KLGvoGr9U+mQtlDeR8U6ydyNUSbBQOO1LZ1Hh5qn45SmUCE5OXcJpAgdbY06xwLw0qUn aMWg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from; bh=etFlahlItSqWjzrmpLzuVeYEF6YNniL9cEbgr8kI2/Y=; b=fMhQK5jpOhaMkXOYte+imxdHC18YS2sjaRF2AKOTHUArXjVTuNj4iHZyXhUmKNQsdj af9NYc9GmtBNLl7ArCmTVLipYFHfjqZkHZMyO6ufBMyMUy2/fgdNyoZyqTlY8qVLVLOT uMldvf3aBwVWVf1jnzdUFz9/xtx7M9rxMA7pnb8MGT2FNU+YNuvbTpU/dbNLbOejqz0a q+qFV344/bwudGad6gLSQAs00FvtpgDIpCZrVntsYk/DVDvqScKlhUvjzbMfyW5SLgVJ P3SCUFpku+Lol6yBaAPbckoXH0FnEOp3VFaAPNZr1f5whCwXDrOPPS4viIOfaToncoNQ B4+w== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id z9si18245830edd.231.2021.10.25.10.46.19; Mon, 25 Oct 2021 10:46:54 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233990AbhJYRp3 convert rfc822-to-8bit (ORCPT + 99 others); Mon, 25 Oct 2021 13:45:29 -0400 Received: from us-smtp-delivery-44.mimecast.com ([205.139.111.44]:24592 "EHLO us-smtp-delivery-44.mimecast.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234407AbhJYRpH (ORCPT ); Mon, 25 Oct 2021 13:45:07 -0400 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-188-mnvZWIibNkSX8woYsnj3iA-1; Mon, 25 Oct 2021 13:42:41 -0400 X-MC-Unique: mnvZWIibNkSX8woYsnj3iA-1 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 741BE801B01; Mon, 25 Oct 2021 17:42:39 +0000 (UTC) Received: from x1.com (unknown [10.22.9.145]) by smtp.corp.redhat.com (Postfix) with ESMTP id C26355C1A1; Mon, 25 Oct 2021 17:42:35 +0000 (UTC) From: Daniel Bristot de Oliveira To: Steven Rostedt Cc: Daniel Bristot de Oliveira , Ingo Molnar , Tom Zanussi , Masami Hiramatsu , Juri Lelli , Clark Williams , John Kacur , Peter Zijlstra , Thomas Gleixner , Sebastian Andrzej Siewior , linux-rt-users@vger.kernel.org, linux-trace-devel@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH V5 17/20] rtla: Add rtla osnoise hist documentation Date: Mon, 25 Oct 2021 19:40:42 +0200 Message-Id: <4f57282c60ac728d263508be5acd4b3569e4ee8d.1635181938.git.bristot@kernel.org> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=bristot@kernel.org X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: kernel.org Content-Transfer-Encoding: 8BIT Content-Type: text/plain; charset=WINDOWS-1252 Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Man page for rtla osnoise hist mode. Cc: Steven Rostedt Cc: Ingo Molnar Cc: Tom Zanussi Cc: Masami Hiramatsu Cc: Juri Lelli Cc: Clark Williams Cc: John Kacur Cc: Peter Zijlstra Cc: Thomas Gleixner Cc: Sebastian Andrzej Siewior Cc: Daniel Bristot de Oliveira Cc: linux-rt-users@vger.kernel.org Cc: linux-trace-devel@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by: Daniel Bristot de Oliveira --- .../tools/rtla/common_hist_options.rst | 23 +++++++ .../tools/rtla/rtla-osnoise-hist.rst | 66 +++++++++++++++++++ 2 files changed, 89 insertions(+) create mode 100644 Documentation/tools/rtla/common_hist_options.rst create mode 100644 Documentation/tools/rtla/rtla-osnoise-hist.rst diff --git a/Documentation/tools/rtla/common_hist_options.rst b/Documentation/tools/rtla/common_hist_options.rst new file mode 100644 index 000000000000..0266cd08a6c9 --- /dev/null +++ b/Documentation/tools/rtla/common_hist_options.rst @@ -0,0 +1,23 @@ +**-b**, **--bucket-size** *N* + + Set the histogram bucket size (default *1*). + +**-e**, **--entries** *N* + + Set the number of entries of the histogram (default 256). + +**--no-header** + + Do not print header. + +**--no-summary** + + Do not print summary. + +**--no-index** + + Do not print index. + +**--with-zeros** + + Print zero only entries. diff --git a/Documentation/tools/rtla/rtla-osnoise-hist.rst b/Documentation/tools/rtla/rtla-osnoise-hist.rst new file mode 100644 index 000000000000..52298ddd8701 --- /dev/null +++ b/Documentation/tools/rtla/rtla-osnoise-hist.rst @@ -0,0 +1,66 @@ +=================== +rtla-osnoise-hist +=================== +------------------------------------------------------ +Display a histogram of the osnoise tracer samples +------------------------------------------------------ + +:Manual section: 1 + +SYNOPSIS +======== +**rtla osnoise hist** [*OPTIONS*] + +DESCRIPTION +=========== +.. include:: common_osnoise_description.rst + +The **rtla osnoise hist** tool collects all **osnoise:sample_threshold** +occurrence in a histogram, displaying the results in a user-friendly way. +The tool also allows many configurations of the *osnoise* tracer and the +collection of the tracer output. + +OPTIONS +======= +.. include:: common_osnoise_options.rst + +.. include:: common_hist_options.rst + +.. include:: common_options.rst + +EXAMPLE +======= +In the example below, *osnoise* tracer threads are set to run with real-time +priority *FIFO:1*, on CPUs *0-11*, for *900ms* at each period (*1s* by +default). The reason for reducing the runtime is to avoid starving the +**rtla** tool. The tool is also set to run for *one minute*. The output +histogram is set to group outputs in buckets of *10us* and *25* entries:: + + [root@f34 ~/]# rtla osnoise hist -P F:1 -c 0-11 -r 900000 -d 1M -b 10 -e 25 + # RTLA osnoise histogram + # Time unit is microseconds (us) + # Duration: 0 00:01:00 + Index CPU-000 CPU-001 CPU-002 CPU-003 CPU-004 CPU-005 CPU-006 CPU-007 CPU-008 CPU-009 CPU-010 CPU-011 + 0 42982 46287 51779 53740 52024 44817 49898 36500 50408 50128 49523 52377 + 10 12224 8356 2912 878 2667 10155 4573 18894 4214 4836 5708 2413 + 20 8 5 12 2 13 24 20 41 29 53 39 39 + 30 1 1 0 0 10 3 6 19 15 31 30 38 + 40 0 0 0 0 0 4 2 7 2 3 8 11 + 50 0 0 0 0 0 0 0 0 0 1 1 2 + over: 0 0 0 0 0 0 0 0 0 0 0 0 + count: 55215 54649 54703 54620 54714 55003 54499 55461 54668 55052 55309 54880 + min: 0 0 0 0 0 0 0 0 0 0 0 0 + avg: 0 0 0 0 0 0 0 0 0 0 0 0 + max: 30 30 20 20 30 40 40 40 40 50 50 50 + +SEE ALSO +======== +**rtla-osnoise**\(1), **rtla-osnoise-top**\(1) + +*osnoise* tracer documentation: + +AUTHOR +====== +Written by Daniel Bristot de Oliveira + +.. include:: common_appendix.rst -- 2.31.1