From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id DAE803EF65B for ; Thu, 23 Apr 2026 13:08:23 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=170.10.133.124 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1776949706; cv=none; b=VsghznG3M11njuuRVqDwEemWob/9ttwooRRJ/jqlfRj8CwTfCBaF1vMY5ONKP7vLfsuCobh0hayz/PCziyKu/x5OmvorznEANQhlWg7/49Xn+64nDH7EX7EiEb7+PJ9rSsS88iB3V+tkum6iXwb5RzOAziei0Hm9Te89VeuJdCQ= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1776949706; c=relaxed/simple; bh=zufJnXWDyPeKufM90NOwYfmd/zaRGvkiBD94e46PFjI=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=Jzq28VZeOudHhfSopyzTQKpABbQHDjJ7p3QB3qB9pEJiKs0VdqeO3iG3t67XVaD56lapPkTh02brjW9FlcKiaceBvDRUsjmu3I55ljmtEd/2qsEYNL/4+Wwjjv5Kk5y7FjER3wUMqOuRymrO0r8KKjT09n/46/pt3a2lVWgfTuE= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=redhat.com; spf=pass smtp.mailfrom=redhat.com; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b=YbtEsfXi; arc=none smtp.client-ip=170.10.133.124 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=redhat.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=redhat.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="YbtEsfXi" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1776949702; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=hr/ez8sNqgD6OzbSwn16HTFbZ7x0aqC7wOIkJ0foQXA=; b=YbtEsfXiynii/b+4e/enKNhUK+ryFQDSiJaixfY+bwBKRdKIV2u40yr74xfihDDvVpKVhQ hLobmDD0oJJRPi+YypqL4vtvQ2PWc08PXtFJtkWA4TNhmr+7nECsLew02Due9SqKKjiBBh 5AahsvlNYI/RvZOnL0GQcW5lWYKoVVg= Received: from mx-prod-mc-08.mail-002.prod.us-west-2.aws.redhat.com (ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-634-7LdbA8fwN32bviK7ABynLg-1; Thu, 23 Apr 2026 09:08:14 -0400 X-MC-Unique: 7LdbA8fwN32bviK7ABynLg-1 X-Mimecast-MFC-AGG-ID: 7LdbA8fwN32bviK7ABynLg_1776949693 Received: from mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.4]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id AEE98180059B; Thu, 23 Apr 2026 13:08:13 +0000 (UTC) Received: from fedora.brq.redhat.com (unknown [10.43.17.109]) by mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id A5BA73000709; Thu, 23 Apr 2026 13:08:10 +0000 (UTC) From: Tomas Glozar To: Steven Rostedt , Tomas Glozar Cc: John Kacur , Luis Goncalves , Crystal Wood , Costa Shulyupin , Wander Lairson Costa , LKML , linux-trace-kernel Subject: [PATCH] rtla: Document tests in README Date: Thu, 23 Apr 2026 15:07:59 +0200 Message-ID: <20260423130759.882247-1-tglozar@redhat.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.4 RTLA tests are not documented anywhere. Mention both runtime and unit tests in the README, with instructions on how to run them and a list of dependencies and required system configuration. Signed-off-by: Tomas Glozar --- tools/tracing/rtla/README.txt | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/tools/tracing/rtla/README.txt b/tools/tracing/rtla/README.txt index a9faee4dbb3a..8a782cd2c171 100644 --- a/tools/tracing/rtla/README.txt +++ b/tools/tracing/rtla/README.txt @@ -42,4 +42,34 @@ For development, we suggest the following steps for compiling rtla: $ make $ sudo make install +Running tests + +RTLA has two test suites: a runtime test suite and a unit test suite. + +The runtime test suite is available as "make check" (root required) and has +the following dependencies, in addition to RTLA build dependencies: + +- Perl +- Test::Harness / TAP::Harness +- bash +- coreutils +- ldd +- util-linux +- procps(-ng) +- bpftool (if rtla is built against libbpf) + +as well as the following required system configuration: + +- CONFIG_OSNOISE_TRACER=y +- CONFIG_TIMERLAT_TRACER=y +- tracefs mounted and readable at /sys/kernel/tracing + +The unit test suite is available as "make unit-tests" and has the following +dependencies: + +- libcheck + +Unlike the runtime test suite, root is not required to run unit tests, nor is +a tracefs/osnoise/timerlat-capable kernel required. + For further information, please refer to the rtla man page. -- 2.53.0