From patchwork Sat Dec 10 13:58:15 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Steven Rostedt X-Patchwork-Id: 32041 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:f944:0:0:0:0:0 with SMTP id q4csp1347183wrr; Sat, 10 Dec 2022 06:50:36 -0800 (PST) X-Google-Smtp-Source: AA0mqf4Y8ZOZwUdk7yjri1vFTIhIFAxTaDTZj6ARxQPwww4SOY2LSLKkHJurphiCnZMorIXPBKG/ X-Received: by 2002:a05:6e02:80b:b0:303:7f2:7c75 with SMTP id u11-20020a056e02080b00b0030307f27c75mr5546142ilm.12.1670681443410; Sat, 10 Dec 2022 06:10:43 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1670681443; cv=none; d=google.com; s=arc-20160816; b=XzNvxbXvJH4zgKj1U7dg4loyAWriBByI0jU3M+jKwfFhtuosMqwzBpEqnTa4joOXhX 6I/jETvdXV/mIgU6H95OZwfwi7YENDKdY6SgCJ8NA/4Dm6IjLPvTVww//KpPeTFiU2iP T7bI0LvBO6oX4BBjWF6xFGeKR9E655WWbSBXjZy8yMHSp3hT4M2l5kmV2WpIrogZOv3e ogNHBaHhZYZ/wmfYkxSX1xWT10xhKPSU+0dfqXeN0H2ANbPaMnkbQlRLxMdcgvaWCrji OUeR9wlolUxV1pFP0Q+hNVIL5cj/KqmUVIIkGmCEZz1Ox/EboZ5MnYhG64b0bZ70EDuP lNNQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:mime-version:references:subject:cc:to:from:date :user-agent:message-id; bh=64RXBqRhwZ7v3S1vi64KcDy6Ha+Nb+A9HbVWJ1mZv5w=; b=s6JPfVdiNiLVdxdYTK1EQv6HT8P8Z4p63RjKXci5d8mTwY2prYx7aRyjD1xn20Vze1 rKbBl7YfJZY+bnENLx+Tw1HJ8yGnQ9VYn9rYcfFYE5Rx9QPWglxM5rA0ooPTu18Py8tI i24FSgGDK5XHtHC8ycfnJ5YSFOpQm+dU90tP+Igv2YJORqQNMcu7kxYQJovAtZ3Vy3cJ 7wgsih+bYzbaNhWIQQ/aePoYQi8XXZpQENm1frp+OSbxzIZLzY/AVy5THKAuVJJogHeL CB1mN/Q2hzACiYLuNCjZach3w4vdasYl1cAi4MvYHuppDAPjVvOREfh4ipSp/kui/wJh 9xaA== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id 21-20020a631355000000b0044c3ec9ea71si4378685pgt.630.2022.12.10.06.10.29; Sat, 10 Dec 2022 06:10:43 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230149AbiLJN75 (ORCPT + 99 others); Sat, 10 Dec 2022 08:59:57 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:34972 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229865AbiLJN6a (ORCPT ); Sat, 10 Dec 2022 08:58:30 -0500 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 6201518E0F for ; Sat, 10 Dec 2022 05:58:28 -0800 (PST) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id 435E360C3B for ; Sat, 10 Dec 2022 13:58:28 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 1DAD1C43396; Sat, 10 Dec 2022 13:58:28 +0000 (UTC) Received: from rostedt by gandalf.local.home with local (Exim 4.96) (envelope-from ) id 1p40N1-000kwr-0j; Sat, 10 Dec 2022 08:58:27 -0500 Message-ID: <20221210135827.094878105@goodmis.org> User-Agent: quilt/0.66 Date: Sat, 10 Dec 2022 08:58:15 -0500 From: Steven Rostedt To: linux-kernel@vger.kernel.org Cc: Masami Hiramatsu , Andrew Morton , Daniel Bristot de Oliveira , Juri Lelli , Clark Williams , Jonathan Corbet , Bagas Sanjaya Subject: [for-next][PATCH 25/25] Documentation/osnoise: Add osnoise/options documentation References: <20221210135750.425719934@goodmis.org> MIME-Version: 1.0 X-Spam-Status: No, score=-6.7 required=5.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,RCVD_IN_DNSWL_HI,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1751836465597528269?= X-GMAIL-MSGID: =?utf-8?q?1751836465597528269?= From: Daniel Bristot de Oliveira Add the documentation about the osnoise/options file, the options, and some additional explanation about the OSNOISE_WORKLOAD option. Link: https://lkml.kernel.org/r/fde5567a4bae364f67fd1e9a644d1d62862618a6.1670623111.git.bristot@kernel.org Cc: Daniel Bristot de Oliveira Cc: Juri Lelli Cc: Clark Williams Cc: Masami Hiramatsu Cc: Jonathan Corbet Cc: Bagas Sanjaya Signed-off-by: Daniel Bristot de Oliveira Reviewed-by: Bagas Sanjaya Signed-off-by: Steven Rostedt (Google) --- Documentation/trace/osnoise-tracer.rst | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/Documentation/trace/osnoise-tracer.rst b/Documentation/trace/osnoise-tracer.rst index fdd562d7c22d..140ef2533d26 100644 --- a/Documentation/trace/osnoise-tracer.rst +++ b/Documentation/trace/osnoise-tracer.rst @@ -92,8 +92,8 @@ Note that the example above shows a high number of HW noise samples. The reason being is that this sample was taken on a virtual machine, and the host interference is detected as a hardware interference. -Tracer options ---------------------- +Tracer Configuration +-------------------- The tracer has a set of options inside the osnoise directory, they are: @@ -115,6 +115,22 @@ The tracer has a set of options inside the osnoise directory, they are: NO_OSNOISE_WORKLOAD disables the OSNOISE_WORKLOAD option. The special DEAFAULTS option resets all options to the default value. +Tracer Options +-------------- + +The osnoise/options file exposes a set of on/off configuration options for +the osnoise tracer. These options are: + + - DEFAULTS: reset the options to the default value. + - OSNOISE_WORKLOAD: do not dispatch osnoise workload (see dedicated + section below). + - PANIC_ON_STOP: call panic() if the tracer stops. This option serves to + capture a vmcore. + - OSNOISE_PREEMPT_DISABLE: disable preemption while running the osnoise + workload, allowing only IRQ and hardware-related noise. + - OSNOISE_IRQ_DISABLE: disable IRQs while running the osnoise workload, + allowing only NMIs and hardware-related noise, like hwlat tracer. + Additional Tracing ------------------