From patchwork Wed Nov 30 18:35:42 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daniel Bristot de Oliveira X-Patchwork-Id: 27954 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:f944:0:0:0:0:0 with SMTP id q4csp1087659wrr; Wed, 30 Nov 2022 10:36:48 -0800 (PST) X-Google-Smtp-Source: AA0mqf66OFSRfj6HUDecUnmxO3re97Y0qqyF6Bp21Kmw9HHhliNeWuwGXV+5Z8G9e4sNUN0/LUwI X-Received: by 2002:a17:90a:6b03:b0:205:f921:90ff with SMTP id v3-20020a17090a6b0300b00205f92190ffmr72823101pjj.156.1669833408260; Wed, 30 Nov 2022 10:36:48 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1669833408; cv=none; d=google.com; s=arc-20160816; b=aCU+FwjwnxsdPU2hj8G+I4KZ2JKqUGaGOBMdf/xz1zW9y15mXfJnVJZZVg53SRhL8U rrkjnq7UnZ7i75nrcLWRtHbL/GsM/me7feWFZBEluNOPbvgoSTZg3QStwt67RTTwQlZW P4GiHUfah68pliWvjB10TrZjVlbyZFodk9re4RwP5klRT7o2Be8aK1ocOUurP/EvI3M1 f5SXN5PaAgh6pcrcTfKoSowyFUThK7z0urZdo5HaoUle9wZ71h7CJsTMFPc4etSa4HSq yiBaHQnpzjjmx8iq7LehJn/aUrt/G6E+kpP0A1zHuDTArHbQmJAeK0tJ0Lfvhemkg7MM Rohw== 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 :dkim-signature; bh=SuR4XrBDJ03a8zE65CtxOLuh82yJ5bsOg17DGuJZt8E=; b=ckQbnm7BDK0FrNI3phItjIvl65spFKAoM6AJD2kZ8s9MV8oknMgaJId66pZ9MZc4Eo 3q5PsTAWpFDf/WxlRTjnBNhIRTUDHaiKOq7itQfdIPOaA/LSCk5L6gbi35xP8VSih4kW l5Dz3hGECf2u/1/SUjnVoYoCHi3Hv07OBXG51hoIeifHacVzJs09B3ET6UEVsBH9qX3L dWKp04KGUynB2aZiEpTXQr1L52ruCUmXoE3lM3AObpJgXx9VEmym7eaS3yl5mqsZclRa Qbd1eiT8OVWrrR6kXXRBNIDuA5VXaKWqCumCTpFscwruN0kZ5wv89KykDcROLY/9CE9T DcMg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=XHDHym0f; 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; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id s21-20020a632c15000000b00477a3989772si2043929pgs.12.2022.11.30.10.36.35; Wed, 30 Nov 2022 10:36:48 -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; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=XHDHym0f; 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; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230425AbiK3SgV (ORCPT + 99 others); Wed, 30 Nov 2022 13:36:21 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44310 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230389AbiK3SgA (ORCPT ); Wed, 30 Nov 2022 13:36:00 -0500 Received: from ams.source.kernel.org (ams.source.kernel.org [IPv6:2604:1380:4601:e00::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BA84598953; Wed, 30 Nov 2022 10:35:55 -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 ams.source.kernel.org (Postfix) with ESMTPS id 7AA2BB81C9C; Wed, 30 Nov 2022 18:35:54 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 3B5FEC43470; Wed, 30 Nov 2022 18:35:51 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1669833353; bh=IvVRl4+fARp9XLGnHwE9fvcyF8luYUHd16dM9vMV/1A=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=XHDHym0fw/am9a6O1+HkdUZhYjS/i9Ib8fXUEfx3TCvQVtbQnDv5q3TH4i8PNdTwU T3Ll1ycSOBJ5l1LAVtpaYW75hthJoCLP4hLQ4kyh4jmHjKqTKadniT7Qaf1yTVm93y OJnkhsy+zZwk7VUBtd9mueaQhsH+OPdSRgUx6dpeBhW5JLhg46Tj+VsUXRsb/TmbOm CrKISttzd85lp40AMkRx7BpYWArFGCSF7NyD1NZnnOrPzBu6Vq97QNh8RveZjBKRN1 L6LxCstxWJdTiYzuh9LEnu64SZLS7sggxGmn7mf9iglvHvo809ug6/csr6UukY19Gs UOdfbmKFJ44BA== From: Daniel Bristot de Oliveira To: Daniel Bristot de Oliveira , Steven Rostedt Cc: Masami Hiramatsu , Jonathan Corbet , Juri Lelli , Clark Williams , Bagas Sanjaya , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH V4 3/3] Documentation/osnoise: Add osnoise/options documentation Date: Wed, 30 Nov 2022 19:35:42 +0100 Message-Id: <255d17a89bcd9ca8eef6931c0052b1a520e0b580.1669832184.git.bristot@kernel.org> X-Mailer: git-send-email 2.32.0 In-Reply-To: References: MIME-Version: 1.0 X-Spam-Status: No, score=-7.1 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,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?1750947235702589515?= X-GMAIL-MSGID: =?utf-8?q?1750947235702589515?= Add the documentation about the osnoise/options file, the options, and some additional explanation about the OSNOISE_WORKLOAD option. Cc: Daniel Bristot de Oliveira Cc: Steven Rostedt Cc: Masami Hiramatsu Cc: Jonathan Corbet Cc: Bagas Sanjaya Signed-off-by: Daniel Bristot de Oliveira Reviewed-by: Bagas Sanjaya --- 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 3c675ed82b27..f2008e317223 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 ------------------