Received: by 2002:a05:6a10:5bc5:0:0:0:0 with SMTP id os5csp3187640pxb; Mon, 18 Oct 2021 09:53:26 -0700 (PDT) X-Google-Smtp-Source: ABdhPJw0UdqavQCz1EOI5Qd7pwhTdZjmUFVrWr1Puz91cQoR7dw4wQMMf3cGPQpCJDOL+zABRWH6 X-Received: by 2002:a63:be01:: with SMTP id l1mr5632817pgf.445.1634576006079; Mon, 18 Oct 2021 09:53:26 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1634576006; cv=none; d=google.com; s=arc-20160816; b=Md9/5XTE5c7ci5gmJbYpUA7zXgNReJRn26rtJAQ0/CVs7BhqEVcU11yOV51fko52xp CDTV10ipT48RM4nXLY1k6ndOng77mb1H8ZDPFmj46pmE0QpOMPT7cIwe2OS7sCxPIaB5 MSAAheWuBdgVtar/rMt1duJCjgowRks9eVmIalgjqedpHB2T8zFAVRQBGTAVzKtiDirh VbhGg+vRil4a7aiPzPfZjOvcQ2nPr63923xOcudgQV7aVVB2s9MSVNcAYW2WiDnIkuW4 gsMEXF23QhucTqOfq1RXgvPmBABT0vfh8eVghv1lBDF+b8iEBn7A5UJDUuXAKrcu8S7E WYJQ== 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=S5v5809ycK2yCf5RvwfaV5XIByNTAtBALbDKGWjNDPE=; b=rzXMEivVFW+scDufjlrpvE38Jiljvyf+aZsKShktZt1dR8LCfsl+V6LLOcj1WSt78c Z+r8otTU3CQ3LwonN/iO4pauW9fS12/OQLCSyap5cQMhT7G1+zFdnfPcpNh8/GrIm8id oK18hoqdlN/hfONcWFWDtmEblflc1RC6VGPrXL/mJUyQdssBCnrcHcDrRWo9qyqAXKN+ 6ZmqwRI3dQHwMzD/8Rsc6wjaEo6j0dlQpKrQCbEpcPwioW6S5tJxRp/eo6tdSf+30wkx rPExmBfq7HnmUEEHxu42MXD4uWPdqN845H5MS8/vcc/tl8C2DNmLqJFjQPO0Xt6RlUCm cjiA== 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 c3si11974791pll.154.2021.10.18.09.53.13; Mon, 18 Oct 2021 09:53:26 -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 S234100AbhJRQwr convert rfc822-to-8bit (ORCPT + 99 others); Mon, 18 Oct 2021 12:52:47 -0400 Received: from us-smtp-delivery-44.mimecast.com ([205.139.111.44]:35609 "EHLO us-smtp-delivery-44.mimecast.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234107AbhJRQwN (ORCPT ); Mon, 18 Oct 2021 12:52:13 -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-504-9vAWlUkWPcyIo1Tbf9UUqA-1; Mon, 18 Oct 2021 12:49:58 -0400 X-MC-Unique: 9vAWlUkWPcyIo1Tbf9UUqA-1 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id D7CD11006AA3; Mon, 18 Oct 2021 16:49:56 +0000 (UTC) Received: from x1.com (unknown [10.22.18.18]) by smtp.corp.redhat.com (Postfix) with ESMTP id CC86C10016F4; Mon, 18 Oct 2021 16:49:51 +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 V3 15/19] rtla: Add rtla osnoise top documentation Date: Mon, 18 Oct 2021 18:48:28 +0200 Message-Id: In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 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 top 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 --- .../rtla/Documentation/rtla-osnoise-top.txt | 98 +++++++++++++++++++ 1 file changed, 98 insertions(+) create mode 100644 tools/tracing/rtla/Documentation/rtla-osnoise-top.txt diff --git a/tools/tracing/rtla/Documentation/rtla-osnoise-top.txt b/tools/tracing/rtla/Documentation/rtla-osnoise-top.txt new file mode 100644 index 000000000000..c7c0e7983c6f --- /dev/null +++ b/tools/tracing/rtla/Documentation/rtla-osnoise-top.txt @@ -0,0 +1,98 @@ +rtla-osnoise-top(1) +=================== + +NAME +---- +rtla-osnoise-top - Display a summary of the operating system noise + +SYNOPSIS +-------- +*rtla osnoise top* ['OPTIONS'] + +DESCRIPTION +----------- +The rtla-osnoise-top(1) 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 osnoise during its execution. The osnoise's +tracer threads take note of the delta between each time read, along with +an interference counter for each source of interference. At the end of +each period, the osnoise tracer displays a summary of the results. + +*rtla osnoise top* collects the periodic summary from the osnoise tracer, +including the counters of the occurrence of the interference source, +displaying the results in a user-friendly format. + +The tool also allows many configurations of the osnoise tracer and the +collection of the tracer output. + +OPTIONS +------- +*-h*, *--help*:: +Print help menu. +*-p*, *--period* 'us':: +Set the osnoise tracer period in microseconds. +*-r*, *--runtime* 'us':: +Set the osnoise tracer runtime in microseconds. +*-s*, *--stop* 'us':: +Stop the trace if a single sample is higher than the argument in microseconds. +If -T is set, it will also save the trace to the output. +*-S*, *--stop-total* 'us':: +Stop the trace if the total sample is higher than the argument in microseconds. +If -T is set, it will also save the trace to the output. +*-c*, *--cpus* 'cpu-list':: +Set the osnoise tracer to run the sample threads in the cpu-list. +*-d*, *--duration* 'time[s|m|h|d]':: +Set the duration of the session. +*-t*, *--trace*['=file']:: +Save the stopped trace to ['file|osnoise_trace.txt']. +*-q*, *--quiet*:: +Print only a summary at the end of the session. +*-P*, *--priority* 'o:prio|r:prio|f:prio|d:runtime:period':: +Set scheduling parameters to the osnoise tracer threads, the format to set the priority are: + - 'o:prio' - use SCHED_OTHER with 'prio'; + - 'r:prio' - use SCHED_RR with 'prio'; + - 'f:prio' - use SCHED_FIFO with 'prio'; + - 'd:runtime[us|ms|s]:period[us|ms|s]' - use SCHED_DEADLINE with 'runtime' and 'period' in nanoseconds. + +EXAMPLE +------- +In the example below, the rtla osnoise top tool is set to run with a +real-time priority 'FIFO:1', on CPUs '0-3', 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' and to display +a summary of the report at the end of the session. + +------------------------------------------------------- +[root@f34 ~]# rtla osnoise top -P F:1 -c 0-3 -r 900000 -d 1M -q + Operating System Noise +duration: 0 00:01:00 | time is in us +CPU Period Runtime Noise % CPU Aval Max Noise Max Single HW NMI IRQ Softirq Thread + 0 #59 53100000 304896 99.42580 6978 56 549 0 53111 1590 13 + 1 #59 53100000 338339 99.36282 8092 24 399 0 53130 1448 31 + 2 #59 53100000 290842 99.45227 6582 39 855 0 53110 1406 12 + 3 #59 53100000 204935 99.61405 6251 33 290 0 53156 1460 12 +------------------------------------------------------- + +SEE ALSO +-------- +_rtla-osnoise(1)_, _rtla-osnoise-hist_(1) + +Osnoise tracer documentation: + +AUTHOR +------ +Written by Daniel Bristot de Oliveira + +REPORTING BUGS +-------------- +Report bugs to + +LICENSE +------- +rtla is Free Software licensed under the GNU GPLv2 + +COPYING +------- +Copyright \(C) 2021 Red Hat, Inc. Free use of this software is granted under +the terms of the GNU Public License (GPL). -- 2.31.1