Received: by 2002:a05:6a10:5bc5:0:0:0:0 with SMTP id os5csp416592pxb; Mon, 25 Oct 2021 10:46:09 -0700 (PDT) X-Google-Smtp-Source: ABdhPJxYNXNuBh+RvoNoZAlOInWBH6aElznrSndtU9TfZz97x1vu4HuVvbd/EFePCi0x7Zo7eqXU X-Received: by 2002:a17:906:2a0d:: with SMTP id j13mr23012432eje.545.1635183969706; Mon, 25 Oct 2021 10:46:09 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1635183969; cv=none; d=google.com; s=arc-20160816; b=vyu7OR+xNBv+cJu/fuxYFtXaevpyQTs08M1sZxi4X/ZGSyArzfnHNESm/NVSR0uZ1P 6ETblReaqKFJgsBlglUsT4YSFKoRByiKqd00feD48Y5TS02Qt1JDxUsgEMwosWAKh1hT Nti8wkNfm5oDw6ZDXkWVJIIpdTfYSxTIRJ5nDXCfaVSOwcEucdKLEh2usYeW/mLg2l7P dOtipPEy7KXhJ56imoeDwC9VLuSUKGV6/1sQk3DGSb00Pufant9+8hR50jH5DAP6Hpsv sMXfIbn5hHOLFDSwpKSYYuX5+iFX0LrxnjboRPq/l+HWzZ2PYDgsHGFf/JUTFqA9j57R BjxA== 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=P4XBghZcX9LmDAp+zmC6XwHvlt3rlh+zeS9O4eCXBGs=; b=KdO6wv5iopGDPFp5w4riRSkdP9aEpEa6qY7A78hXq4rNuiRS0nB3iYNTDt+QcOR5oZ MD7AVRaKh5GXnvZj9EUOc2gbATModvPyrzUHDJ1haBfLDS7U2VZXsDFNH3Gf2naEYi+x ntojLRL+1T5iTDF5CGK9TSNyWOjnqTz1TmJciq/VgKmlPMIXecVHEFUzcER+McdV//nv bcuNTv9BPMYstItRXBVQpe55gatqnlaeolpXLCpXtCp9MGzGq/TYwIsfINouQS6C5tol YouZOUpGx1r6Va3awvkgWXrY6zdcwZxFmDwc341q/6ori33jgA6bVjEtFqI6gwXiXMX4 x5dg== 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 qk10si27469148ejc.155.2021.10.25.10.45.40; Mon, 25 Oct 2021 10:46:09 -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 S234372AbhJYRpU convert rfc822-to-8bit (ORCPT + 99 others); Mon, 25 Oct 2021 13:45:20 -0400 Received: from us-smtp-delivery-44.mimecast.com ([207.211.30.44]:29575 "EHLO us-smtp-delivery-44.mimecast.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234375AbhJYRo7 (ORCPT ); Mon, 25 Oct 2021 13:44:59 -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-579-LnozHLpEMe2iNo-cVpDLcQ-1; Mon, 25 Oct 2021 13:42:32 -0400 X-MC-Unique: LnozHLpEMe2iNo-cVpDLcQ-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 34D88801B26; Mon, 25 Oct 2021 17:42:31 +0000 (UTC) Received: from x1.com (unknown [10.22.9.145]) by smtp.corp.redhat.com (Postfix) with ESMTP id D52BA5C1A1; Mon, 25 Oct 2021 17:42:22 +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 15/20] rtla: Add rtla osnoise man page Date: Mon, 25 Oct 2021 19:40:40 +0200 Message-Id: <66e75571354250bd6a4910649bf213dc457d6f19.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 command. 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_osnoise_description.rst | 8 +++ Documentation/tools/rtla/rtla-osnoise.rst | 59 +++++++++++++++++++ 2 files changed, 67 insertions(+) create mode 100644 Documentation/tools/rtla/common_osnoise_description.rst create mode 100644 Documentation/tools/rtla/rtla-osnoise.rst diff --git a/Documentation/tools/rtla/common_osnoise_description.rst b/Documentation/tools/rtla/common_osnoise_description.rst new file mode 100644 index 000000000000..8973c5df888f --- /dev/null +++ b/Documentation/tools/rtla/common_osnoise_description.rst @@ -0,0 +1,8 @@ +The **rtla osnoise** tool is an interface for the *osnoise* tracer. The +*osnoise* tracer dispatches a kernel thread per-cpu. These threads read the +time in a loop while with preemption, softirq and IRQs enabled, thus +allowing all the sources of operating systme noise during its execution. +The *osnoise*'s tracer threads take note of the delta between each time +read, along with an interference counter of all sources of interference. +At the end of each period, the *osnoise* tracer displays a summary of +the results. diff --git a/Documentation/tools/rtla/rtla-osnoise.rst b/Documentation/tools/rtla/rtla-osnoise.rst new file mode 100644 index 000000000000..c129b206ce34 --- /dev/null +++ b/Documentation/tools/rtla/rtla-osnoise.rst @@ -0,0 +1,59 @@ +=============== +rtla-osnoise +=============== +------------------------------------------------------------------ +Measure the operating system noise +------------------------------------------------------------------ + +:Manual section: 1 + +SYNOPSIS +======== +**rtla osnoise** [*MODE*] ... + +DESCRIPTION +=========== + +.. include:: common_osnoise_description.rst + +The *osnoise* tracer outputs information in two ways. It periodically prints +a summary of the noise of the operating system, including the counters of +the occurrence of the source of interference. It also provides information +for each noise via the **osnoise:** tracepoints. The **rtla osnoise top** +mode displays information about the periodic summary from the *osnoise* tracer. +The **rtla osnoise hist** mode displays information about the noise using +the **osnoise:** tracepoints. For further details, please refer to the +respective man page. + +MODES +===== +**top** + + Prints the summary from osnoise tracer. + +**hist** + + Prints a histogram of osnoise samples. + +If no MODE is given, the top mode is called, passing the arguments. + +OPTIONS +======= + +**-h**, **--help** + + Display the help text. + +For other options, see the man page for the corresponding mode. + +SEE ALSO +======== +**rtla-osnoise-top**\(1), **rtla-osnoise-hist**\(1) + +Osnoise tracer documentation: + +AUTHOR +====== +Written by Daniel Bristot de Oliveira + +.. include:: common_appendix.rst -- 2.31.1