From patchwork Thu Sep 24 08:57:26 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Tzvetomir Stoyanov (VMware)" X-Patchwork-Id: 11796633 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 60C2A59D for ; Thu, 24 Sep 2020 08:57:31 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 451762376F for ; Thu, 24 Sep 2020 08:57:31 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="A6M/kkMK" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727256AbgIXI5b (ORCPT ); Thu, 24 Sep 2020 04:57:31 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:34710 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726064AbgIXI5a (ORCPT ); Thu, 24 Sep 2020 04:57:30 -0400 Received: from mail-wr1-x443.google.com (mail-wr1-x443.google.com [IPv6:2a00:1450:4864:20::443]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 899B2C0613CE for ; Thu, 24 Sep 2020 01:57:30 -0700 (PDT) Received: by mail-wr1-x443.google.com with SMTP id j2so2887892wrx.7 for ; Thu, 24 Sep 2020 01:57:30 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=DD7DzH+1uZHiL1ja2Xj2Qul/zGwrkIhGowK81J16h9k=; b=A6M/kkMK5jiLdxBQ2+W0869GsrB593CCTXIV3sDsAN53BVboKesAet+xwc/F5gtUwd 8BwNQth+JeexT69lEbmjbeT1IbXohgpM/sKvyD1uq7t70gbGJHjP3MR41MzovgYEAye4 Fh+6jWeIQe+RR1poqqSQSJ+LUFmev+0ah1w90a+jdds1wEPKmEYRdkvBbxatWQ5ve3lt i1Im10pj0+rmSb9Mr6dsWwnfWORVPIBMtQI4VuuuifQ6S8zUyQftyr3mx/8EW02zCAzz 32DlEcPBbk6+Y3N1QNKpRa9aA+mUlKjkIUrv6zhk47prNpPGVEZA2QxJtSKMU+3RTj5d nzdg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=DD7DzH+1uZHiL1ja2Xj2Qul/zGwrkIhGowK81J16h9k=; b=lF33V+bzQ07ME5ADJdMtjHVjGZqQI1cDjLRr2+kRIlvUWSKPy4S5HQzg775h2yyowU 8CUnPG4neMpoJcDuQ4j8LbrCx5u+3iJMJI4QpudtO6mxrN1XLNQ2Ao4ZyPlir2cvQyfg lbYN8czEovpTiI5e/1ErEVUCZmD/gEe7x3vHOcSDAEXfXFl2vU5qiUjAfXvQBY23So/9 67UjNTliKqr6IMYAlz8m2Egd11ISzFyHeYDZnyJci0fLz1pcgtaZZmViUixd8bl6Qzgl DacRvOlTnQVLK572HWLf91APsFrMxiJe5Pislz/QXVIEQ0yrli28JfPRGiaD0ie0cGSO g0Cw== X-Gm-Message-State: AOAM532uYeKPRcKewdelllBYT5m4Cy1wwpKCByqR3hE/Nk2jiTNhIR1v 9O1paAeUMsZPgzuqpUN7AD7k0rTsMZBKoA== X-Google-Smtp-Source: ABdhPJzurGZaRM4TM1nUFImYf2308pZT9DFC6Y2mdaGDJNi2WuhXGuCEVo71+kVf3zStCF7D8YGiAg== X-Received: by 2002:a5d:470e:: with SMTP id y14mr3916219wrq.354.1600937849228; Thu, 24 Sep 2020 01:57:29 -0700 (PDT) Received: from oberon.zico.biz ([83.222.187.186]) by smtp.gmail.com with ESMTPSA id u17sm3062385wri.45.2020.09.24.01.57.27 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 24 Sep 2020 01:57:28 -0700 (PDT) From: "Tzvetomir Stoyanov (VMware)" To: rostedt@goodmis.org Cc: linux-trace-devel@vger.kernel.org Subject: [PATCH 1/2] tools lib traceevent: Man page for tep_add_plugin_path() API Date: Thu, 24 Sep 2020 11:57:26 +0300 Message-Id: <20200924085726.112758-1-tz.stoyanov@gmail.com> X-Mailer: git-send-email 2.26.2 MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-trace-devel@vger.kernel.org Add documentation of tep_add_plugin_path() API in the libtraceevent plugin man page. Signed-off-by: Tzvetomir Stoyanov (VMware) --- .../Documentation/libtraceevent-plugins.txt | 22 +++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/tools/lib/traceevent/Documentation/libtraceevent-plugins.txt b/tools/lib/traceevent/Documentation/libtraceevent-plugins.txt index 4d6394397d92..e584b8c777ad 100644 --- a/tools/lib/traceevent/Documentation/libtraceevent-plugins.txt +++ b/tools/lib/traceevent/Documentation/libtraceevent-plugins.txt @@ -3,7 +3,7 @@ libtraceevent(3) NAME ---- -tep_load_plugins, tep_unload_plugins, tep_load_plugins_hook - Load / unload traceevent plugins. +tep_load_plugins, tep_unload_plugins, tep_load_plugins_hook, tep_add_plugin_path - Load / unload traceevent plugins. SYNOPSIS -------- @@ -19,6 +19,8 @@ void *tep_load_plugins_hook*(struct tep_handle pass:[*]_tep_, const char pass:[* const char pass:[*]name, void pass:[*]data), void pass:[*]_data_); +int *tep_add_plugin_path*(struct tep_handle pass:[*]tep, char pass:[*]path, + enum tep_plugin_load_priority prio); -- DESCRIPTION @@ -52,16 +54,30 @@ _tep_load_plugins()_. The _tep_ argument is trace event parser context. The _plugin_list_ is the list of loaded plugins, returned by the _tep_load_plugins()_ function. -The _tep_load_plugins_hook_ function walks through all directories with plugins +The _tep_load_plugins_hook()_ function walks through all directories with plugins and calls user specified _load_plugin()_ hook for each plugin file. Only files with given _suffix_ are considered to be plugins. The _data_ is a user specified context, passed to _load_plugin()_. Directories and the walk order are the same as in _tep_load_plugins()_ API. +The _tep_add_plugin_path()_ functions adds additional directories with plugins in +the _tep_->plugins_dir list. It must be called before _tep_load_plugins()_ in order +the plugins from the new directories to be loaded. The _tep_ argument is trace event +parser context. The _path_ is the full path to the new plugin directory. The _prio_ +argument specifies the loading priority of plugins from the new directory. The loading +priority is important in case of different versions of the same plugin located in +multiple plugin directories.The last loaded plugin wins. The priority can be: +[verse] +-- + _TEP_PLUGIN_FIRST_ - Load plugins from this directory first + _TEP_PLUGIN_LAST_ - Load plugins from this directory last +-- + RETURN VALUE ------------ The _tep_load_plugins()_ function returns a list of successfully loaded plugins, or NULL in case no plugins are loaded. +The _tep_add_plugin_path()_ function returns -1 in case of an error, 0 otherwise. EXAMPLE ------- @@ -71,6 +87,8 @@ EXAMPLE ... struct tep_handle *tep = tep_alloc(); ... +tep_add_plugin_path(tep, "~/dev_plugins", TEP_PLUGIN_LAST); +... struct tep_plugin_list *plugins = tep_load_plugins(tep); if (plugins == NULL) { /* no plugins are loaded */ From patchwork Thu Sep 24 08:57:35 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Tzvetomir Stoyanov (VMware)" X-Patchwork-Id: 11796635 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 7D1516CA for ; Thu, 24 Sep 2020 08:57:39 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 6353523772 for ; Thu, 24 Sep 2020 08:57:39 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="vRiU3Ixv" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727268AbgIXI5j (ORCPT ); Thu, 24 Sep 2020 04:57:39 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:34732 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726064AbgIXI5j (ORCPT ); Thu, 24 Sep 2020 04:57:39 -0400 Received: from mail-wm1-x342.google.com (mail-wm1-x342.google.com [IPv6:2a00:1450:4864:20::342]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B907BC0613CE for ; Thu, 24 Sep 2020 01:57:38 -0700 (PDT) Received: by mail-wm1-x342.google.com with SMTP id k18so2729684wmj.5 for ; Thu, 24 Sep 2020 01:57:38 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=w90kD4riP0Fuf2IH9074v4Qu8q9n8nKw3Ed4EsETaIs=; b=vRiU3IxvOYPVGh3eAEc8CkT8i3+FX96uMAO6Qp5cKQo9O1JhEk1lU2uwa3Qb29ft9B j6XGY8rPwBhJ8TcHOCmigIqIP4crkBGpwNC+hGJGwejqMnLmxTOFUb0/GmPURe4EpnwS Fssanq5wcEVS07q+KFmC0KGOjfsFOweK8pu3LBLj5nVTJbpg5uu4bZMPPrhsRTx+WoaY +qopfORnRbGR1bh472ALQl+Mbvf6BPwlIwYrryumGMrJzF61S15P1d/Wx65DcuGG5lcK RSXM5zOKtw0ri8lmrzqD4ODQwijjKSNe4x4quFhPZy68Jpvcj25s/9NrjykFOwf9yMUO T7LQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=w90kD4riP0Fuf2IH9074v4Qu8q9n8nKw3Ed4EsETaIs=; b=q2CpK7NfHrORvfzNe7SEmeYk1DjhiTQ2AUCOL226t1eLCP+i9bJ1OoSTDyMpVMxXYd ipMMwdiN/kP0JkeX5z18sdV/pEZsyaQ6AUE3m9EQS4xplvBx0EHPZS9+Q/xaBnrZpC2Y eo0h0AN+cAoq9Ao7FSCJzSrbauoxYZhsghvKCE7FsJmB3xNteE9u6emtClPjtxSr6iS9 7RGL52BpRCF3JlcaeQ345QttbKTs1DmiI7WJD4vWC4hnnSW7QSHZ/lLyACjTB6ip2hEj iIbM0CuEuNenNNM1wkCPhBxzcMk34Li3WmIAe4YfXjv26A2QEuQ30e7AzwZJWjBGvpuj juMg== X-Gm-Message-State: AOAM531rbccU26xOpJja7xDiNly5euhzDrsZzyDM6hCrynSGDSlfCA70 Gq8RYYbcZn3u3WGKulwWL0d8sPsA553dWw== X-Google-Smtp-Source: ABdhPJy132A+psIOBImOiVVR8BgtNNGxqsdSK3t+s6xO6fSkFKHuVjk6dnPzcj6coaThf6VEbeS/cg== X-Received: by 2002:a1c:3d06:: with SMTP id k6mr3578744wma.27.1600937857382; Thu, 24 Sep 2020 01:57:37 -0700 (PDT) Received: from oberon.zico.biz ([83.222.187.186]) by smtp.gmail.com with ESMTPSA id y5sm2762030wrh.6.2020.09.24.01.57.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 24 Sep 2020 01:57:36 -0700 (PDT) From: "Tzvetomir Stoyanov (VMware)" To: rostedt@goodmis.org Cc: linux-trace-devel@vger.kernel.org Subject: [PATCH 2/2] tools lib traceevent: Man page libtraceevent debug APIs Date: Thu, 24 Sep 2020 11:57:35 +0300 Message-Id: <20200924085735.112822-1-tz.stoyanov@gmail.com> X-Mailer: git-send-email 2.26.2 MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-trace-devel@vger.kernel.org Add a new libtraceevent man page with documentation of these debug APIs: tep_print_printk tep_print_funcs tep_set_test_filters tep_plugin_print_options Signed-off-by: Tzvetomir Stoyanov (VMware) --- .../Documentation/libtraceevent-debug.txt | 95 +++++++++++++++++++ 1 file changed, 95 insertions(+) create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-debug.txt diff --git a/tools/lib/traceevent/Documentation/libtraceevent-debug.txt b/tools/lib/traceevent/Documentation/libtraceevent-debug.txt new file mode 100644 index 000000000000..9a2d1ffa2d72 --- /dev/null +++ b/tools/lib/traceevent/Documentation/libtraceevent-debug.txt @@ -0,0 +1,95 @@ +libtraceevent(3) +================ + +NAME +---- +tep_print_printk, tep_print_funcs, tep_set_test_filters, tep_plugin_print_options - +Print libtraceevent internal information. + +SYNOPSIS +-------- +[verse] +-- +*#include * +*#include * + +void *tep_print_printk*(struct tep_handle pass:[*]tep); +void *tep_print_funcs*(struct tep_handle pass:[*]tep); +void *tep_set_test_filters*(struct tep_handle pass:[*]tep, int test_filters); +void *tep_plugin_print_options*(struct trace_seq pass:[*]s); +-- + +DESCRIPTION +----------- +The _tep_print_printk()_ function prints the printk string formats that were +stored for this tracing session. The _tep_ argument is trace event parser context. + +The _tep_print_funcs()_ function prints the stored function name to address mapping +for this tracing session. The _tep_ argument is trace event parser context. + +The _tep_set_test_filters()_ function sets a flag to test a filter string. If this +flag is set, when _tep_filter_add_filter_str()_ API as called, it will print the filter +string instead of adding it. The _tep_ argument is trace event parser context. +The _test_filters_ argument is the test flag that will be set. + +The _tep_plugin_print_options()_ function writes a list of the registered plugin options +into _s_. + +EXAMPLE +------- +[source,c] +-- +#include +#include +... +struct tep_handle *tep = tep_alloc(); +... + tep_print_printk(tep); +... + tep_print_funcs(tep); +... +struct tep_event_filter *filter = tep_filter_alloc(tep); + tep_set_test_filters(tep, 1); + tep_filter_add_filter_str(filter, "sche d/sched_wakeup:target_cpu==1"); + tep_set_test_filters(tep, 0); + tep_filter_free(filter); +... +struct trace_seq seq; +trace_seq_init(&seq); + + tep_plugin_print_options(&s); +... +-- + +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