All of lore.kernel.org
 help / color / mirror / Atom feed
From: Alan Maguire <alan.maguire@oracle.com>
To: rostedt@goodmis.org, mhiramat@kernel.org
Cc: corbet@lwn.net, shuah@kernel.org,
	linux-trace-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kselftest@vger.kernel.org, linux-kernel@vger.kernel.org,
	Alan Maguire <alan.maguire@oracle.com>
Subject: [PATCH v2 tracing 6/6] tracing: document IPv4, IPv6, MAC address and > 8 byte numeric filtering support
Date: Fri, 28 Apr 2023 16:34:49 +0100	[thread overview]
Message-ID: <1682696089-27937-7-git-send-email-alan.maguire@oracle.com> (raw)
In-Reply-To: <1682696089-27937-1-git-send-email-alan.maguire@oracle.com>

Document that only == and != predicates are supported for
IPv4, IPv6 and MAC addresses.

For values > 8 bytes in size, only == and != filter predicates are
supported; document this also.

Signed-off-by: Alan Maguire <alan.maguire@oracle.com>
---
 Documentation/trace/events.rst | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/Documentation/trace/events.rst b/Documentation/trace/events.rst
index f5fcb8e1218f..6a75e4e256c9 100644
--- a/Documentation/trace/events.rst
+++ b/Documentation/trace/events.rst
@@ -182,10 +182,31 @@ The field-names available for use in filters can be found in the
 
 The relational-operators depend on the type of the field being tested:
 
+For IPv4, IPv6 and MAC addresses, the available operators are:
+
+==, !=
+
+For example
+
+"dst == 127.0.0.1"
+
+"src != ::1"
+
+"mac_addr == ab:cd:ef:12:34:56"
+
 The operators available for numeric fields are:
 
 ==, !=, <, <=, >, >=, &
 
+For numeric fields larger than 8 bytes, only
+
+==, !=
+
+...are allowed, and values for comparison must match field size exactly.
+For example, to match the "::1" IPv6 address:
+
+"dst == 0x00000000000000000000000000000001"
+
 And for string fields they are:
 
 ==, !=, ~
-- 
2.31.1


      parent reply	other threads:[~2023-04-28 15:35 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-04-28 15:34 [PATCH v2 tracing 0/6] tracing: additional filter predicates Alan Maguire
2023-04-28 15:34 ` [PATCH v2 tracing 1/6] tracing: support > 8 byte array " Alan Maguire
2023-04-28 15:34 ` [PATCH v2 tracing 2/6] tracing: support IPv4 address filter predicate Alan Maguire
2023-04-28 15:34 ` [PATCH v2 tracing 3/6] tracing: support IPv6 filter predicates Alan Maguire
2023-06-09 21:12   ` Steven Rostedt
2023-06-09 21:15     ` Steven Rostedt
2023-04-28 15:34 ` [PATCH v2 tracing 4/6] tracing: support MAC address " Alan Maguire
2023-04-28 15:34 ` [PATCH v2 tracing 5/6] selftests/ftrace: add test coverage for " Alan Maguire
2023-04-28 15:34 ` Alan Maguire [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1682696089-27937-7-git-send-email-alan.maguire@oracle.com \
    --to=alan.maguire@oracle.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-kselftest@vger.kernel.org \
    --cc=linux-trace-kernel@vger.kernel.org \
    --cc=mhiramat@kernel.org \
    --cc=rostedt@goodmis.org \
    --cc=shuah@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.