From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-12.1 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, MENTIONS_GIT_HOSTING,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id BA3A3C04AAF for ; Sat, 18 May 2019 09:09:56 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 8BFAE2082C for ; Sat, 18 May 2019 09:09:55 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=zytor.com header.i=@zytor.com header.b="VTRu2YmL" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729715AbfERJJy (ORCPT ); Sat, 18 May 2019 05:09:54 -0400 Received: from terminus.zytor.com ([198.137.202.136]:53491 "EHLO terminus.zytor.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725268AbfERJJy (ORCPT ); Sat, 18 May 2019 05:09:54 -0400 Received: from terminus.zytor.com (localhost [127.0.0.1]) by terminus.zytor.com (8.15.2/8.15.2) with ESMTPS id x4I99UiK1736972 (version=TLSv1.3 cipher=TLS_AES_256_GCM_SHA384 bits=256 verify=NO); Sat, 18 May 2019 02:09:30 -0700 DKIM-Filter: OpenDKIM Filter v2.11.0 terminus.zytor.com x4I99UiK1736972 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=zytor.com; s=2019041745; t=1558170570; bh=22iwg4vE2A/cF38F7Fv9unq86DIk7aEhj95Y7TSiS+Y=; h=Date:From:Cc:Reply-To:In-Reply-To:References:To:Subject:From; b=VTRu2YmLuvCB78+IpntuaG/ODp6sBZ3mSN9/6/VOz8sbJ7n+3NmfdKPHX/zErT7Ao PLOPXUlCMvLvvSpONBY+88F2J1NQUrECXGrOQaNeAbsxQ72EWbZDlxbgnaC/oBV3cL 9XKcodc4ZNPiUFmiTtueQJZqPLuvK0BebjHpIJjNE9HK3sRF6zEbIfQFqKOlN1Hryq JXYzb/DnNPWQRWehrmYE5xqbsP3ZWyK7yCZEdULgOVH+l2g9ow1RIGM9ZSU6aMsWg9 VMzFtaOmwsgaHFJb6uNnAIoClSh+490yQH53zWDlxep9rcqEm1Z9XMz8fBOdXXUg3P eN6ESLUT7eYkg== Received: (from tipbot@localhost) by terminus.zytor.com (8.15.2/8.15.2/Submit) id x4I99T2K1736969; Sat, 18 May 2019 02:09:29 -0700 Date: Sat, 18 May 2019 02:09:29 -0700 X-Authentication-Warning: terminus.zytor.com: tipbot set sender to tipbot@zytor.com using -f From: tip-bot for Tzvetomir Stoyanov Message-ID: Cc: tstoyanov@vmware.com, mingo@kernel.org, linux-kernel@vger.kernel.org, akpm@linux-foundation.org, namhyung@kernel.org, rostedt@goodmis.org, hpa@zytor.com, tglx@linutronix.de, jolsa@redhat.com, acme@redhat.com Reply-To: tstoyanov@vmware.com, mingo@kernel.org, akpm@linux-foundation.org, linux-kernel@vger.kernel.org, namhyung@kernel.org, rostedt@goodmis.org, hpa@zytor.com, jolsa@redhat.com, tglx@linutronix.de, acme@redhat.com In-Reply-To: <20190510200108.197407057@goodmis.org> References: <20190510200108.197407057@goodmis.org> To: linux-tip-commits@vger.kernel.org Subject: [tip:perf/core] tools lib traceevent: Man pages for event find APIs Git-Commit-ID: 86e8076e93ff69213931f867878709f2c6139032 X-Mailer: tip-git-log-daemon Robot-ID: Robot-Unsubscribe: Contact to get blacklisted from these emails MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset=UTF-8 Content-Disposition: inline Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Commit-ID: 86e8076e93ff69213931f867878709f2c6139032 Gitweb: https://git.kernel.org/tip/86e8076e93ff69213931f867878709f2c6139032 Author: Tzvetomir Stoyanov AuthorDate: Fri, 10 May 2019 15:56:21 -0400 Committer: Arnaldo Carvalho de Melo CommitDate: Wed, 15 May 2019 16:36:48 -0300 tools lib traceevent: Man pages for event find APIs Create man pages for libtraceevent APIs: tep_find_event() tep_find_event_by_name() tep_find_event_by_record() Signed-off-by: Tzvetomir Stoyanov Cc: Andrew Morton Cc: Jiri Olsa Cc: Namhyung Kim Cc: linux-trace-devel@vger.kernel.org Link: http://lore.kernel.org/linux-trace-devel/20190503091119.23399-15-tstoyanov@vmware.com Link: http://lkml.kernel.org/r/20190510200108.197407057@goodmis.org Signed-off-by: Steven Rostedt (VMware) Signed-off-by: Arnaldo Carvalho de Melo --- .../Documentation/libtraceevent-event_find.txt | 103 +++++++++++++++++++++ 1 file changed, 103 insertions(+) diff --git a/tools/lib/traceevent/Documentation/libtraceevent-event_find.txt b/tools/lib/traceevent/Documentation/libtraceevent-event_find.txt new file mode 100644 index 000000000000..7bc062c9f76f --- /dev/null +++ b/tools/lib/traceevent/Documentation/libtraceevent-event_find.txt @@ -0,0 +1,103 @@ +libtraceevent(3) +================ + +NAME +---- +tep_find_event,tep_find_event_by_name,tep_find_event_by_record - +Find events by given key. + +SYNOPSIS +-------- +[verse] +-- +*#include * + +struct tep_event pass:[*]*tep_find_event*(struct tep_handle pass:[*]_tep_, int _id_); +struct tep_event pass:[*]*tep_find_event_by_name*(struct tep_handle pass:[*]_tep_, const char pass:[*]_sys_, const char pass:[*]_name_); +struct tep_event pass:[*]*tep_find_event_by_record*(struct tep_handle pass:[*]_tep_, struct tep_record pass:[*]_record_); +-- + +DESCRIPTION +----------- +This set of functions can be used to search for an event, based on a given +criteria. All functions require a pointer to a _tep_, trace event parser +context. + +The _tep_find_event()_ function searches for an event by given event _id_. The +event ID is assigned dynamically and can be viewed in event's format file, +"ID" field. + +The tep_find_event_by_name()_ function searches for an event by given +event _name_, under the system _sys_. If the _sys_ is NULL (not specified), +the first event with _name_ is returned. + +The tep_find_event_by_record()_ function searches for an event from a given +_record_. + +RETURN VALUE +------------ +All these functions return a pointer to the found event, or NULL if there is no +such event. + +EXAMPLE +------- +[source,c] +-- +#include +... +struct tep_handle *tep = tep_alloc(); +... +struct tep_event *event; + +event = tep_find_event(tep, 1857); +if (event == NULL) { + /* There is no event with ID 1857 */ +} + +event = tep_find_event_by_name(tep, "kvm", "kvm_exit"); +if (event == NULL) { + /* There is no kvm_exit event, from kvm system */ +} + +void event_from_record(struct tep_record *record) +{ + struct tep_event *event = tep_find_event_by_record(tep, record); + if (event == NULL) { + /* There is no event from given record */ + } +} +... +-- + +FILES +----- +[verse] +-- +*event-parse.h* + Header file to include in order to have access to the library APIs. +*-ltraceevent* + Linker switch to add when building a program that uses the library. +-- + +SEE ALSO +-------- +_libtraceevent(3)_, _trace-cmd(1)_ + +AUTHOR +------ +[verse] +-- +*Steven Rostedt* , author of *libtraceevent*. +*Tzvetomir Stoyanov* , author of this man page. +-- +REPORTING BUGS +-------------- +Report bugs to + +LICENSE +------- +libtraceevent is Free Software licensed under the GNU LGPL 2.1 + +RESOURCES +--------- +https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git