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;
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
Message-Id: <1682696089-27937-7-git-send-email-alan.maguire@oracle.com>
In-Reply-To: <1682696089-27937-1-git-send-email-alan.maguire@oracle.com>
References: <1682696089-27937-1-git-send-email-alan.maguire@oracle.com>
Precedence: bulk

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