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
Cc:     corbet@lwn.net, mingo@redhat.com, shuah@kernel.org,
        linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
        linux-kselftest@vger.kernel.org,
        Alan Maguire <alan.maguire@oracle.com>
Subject: [RFC tracing 4/4] tracing: document > 8 byte numeric filtering support
Date:   Sun,  7 Aug 2022 23:21:23 +0100
Message-Id: <1659910883-18223-5-git-send-email-alan.maguire@oracle.com>
In-Reply-To: <1659910883-18223-1-git-send-email-alan.maguire@oracle.com>
References: <1659910883-18223-1-git-send-email-alan.maguire@oracle.com>
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?Y4hyenqr3VlJBK4J+Dni58SpOXtKWdp/AOT5N6boklXlEt9LHAfnOBGIzyAE?=
 =?us-ascii?Q?9U5lzPX+czJCaos8V84WXQ3i0nuI40hiQ3EOdgjXfIF6yK4Itit+W3PbVbkQ?=
 =?us-ascii?Q?VEVky6gCei0eYPk4U5zajxhvPJtPfTj1B77TRNDa5GkeOnFAuJpn3sH11fS6?=
 =?us-ascii?Q?oDYbjhTbGM7P9FMS+p6weZ9vx9UIH4LX/Ijxp0XuNxCGVbPdtIPxqjbVwl+x?=
 =?us-ascii?Q?stgYu1AekG6HfvVF4wCUpqnCaU9wY8c3q0rVi0X4WZbLuoe2THrgGVMLPuT3?=
 =?us-ascii?Q?qVQhDieocGyVxX7INOk4ntQQlzwv6qRXaNcfOXP+ac1gHuzvgrD4jitq9A7e?=
 =?us-ascii?Q?eydBHnBFerZkDf/K+YYyBKd35M2ABgjvdZTVL7xnSxwxoc1UfyVIq8ZGuVGF?=
 =?us-ascii?Q?vc0AwduUyHYvAKUj9zLvSfzd554Zmn4HJfi628jTwR75amEVhxGeyxFwafRd?=
 =?us-ascii?Q?ydlL/8KesUu0ty94loYgTbO393ADq/Bp+Em/pqUXEpydrvBP6U/w8hwIjk0l?=
 =?us-ascii?Q?CnpCvW++JRMl5wX+Sm+/+djyxyOR8GpRPFdNFgUXN26DH+X90fyqbUZ6KIbj?=
 =?us-ascii?Q?STXg8fJ7nhlOmbpsrjZe+3DfPfxRLE4hWTCSt3ZQHn/ZOJ+XkoV1fee8PwE5?=
 =?us-ascii?Q?HZqi4m18jzQdvQpJ7ykRDpn9FfalLuHcvX0vFmAW0dSXrAb53b+EU+XNf/Mb?=
 =?us-ascii?Q?t0mqjtDf1eiULGghL1z6a92PQhkdd4oyPLnN4AQ3xkmMx9efFEcXLy2deasY?=
 =?us-ascii?Q?dXBOOpxHnNRDGv+iaB4ATuRvGlbg9sCPsoabNgSC6i+Fbb2qrESr5SaNdzPJ?=
 =?us-ascii?Q?ZYodS9XrS2N92MsNiwdsF+diZHFaSS9b6gke8uH4nBo3PLsskKsK71dCXm8y?=
 =?us-ascii?Q?pkLt37xiBToA27ZiKh1EvsLLd8mUN4I4rMMKy2YLkx54yuC93Cma6b6lH/kN?=
 =?us-ascii?Q?FFlnffDzF1YmJ1eqt+rY7GKASnO24MTzZpEuG+WF1OKBpfMgtQNgG1HIIFP8?=
 =?us-ascii?Q?492Yib8fJnGVeNfjoCSQbnDQILsh+ELLnmk1Hv9uS9VnGtEGd4dxYZHNP6CW?=
 =?us-ascii?Q?rFm3LTO1VIIsVcEeywPxsc6xl2i9xQNbPKpHHfLolcrezhgDth8TxUx7OIW3?=
 =?us-ascii?Q?aD2Ojc9CQgv+jDcgtljYi//xqjz5Df8tRYLKY2T3mhqaB5X2+QSRe7sFTP29?=
 =?us-ascii?Q?kKOO8cEbkGT5YHGeVbDLYUl5f21kOZfgsTP9p38imsvxjT4VlLZ7RsQLB/lV?=
 =?us-ascii?Q?xDR7i6MjNk+rEJSri8AwZlciQSYc7U0K5VhVNIJjhaf2AVB9JKYukNyZdZA8?=
 =?us-ascii?Q?QU0u6tu4pa6ntNEPZBBMsAUwHv+I35yICKwPi++2vX3v1zrWcktXHLd7A7Bj?=
 =?us-ascii?Q?6Ja+hC121ZRlZK6MiaBWIy9r6HPyv7diopqQslNDgAbhd5GNsWaJkQ1Tp6Fz?=
 =?us-ascii?Q?Vp7LcdtIz3dMSJrCBmaT8p0wyx7v1mlktRdMCbBRjOKEUyR9RKNcURX8x5HA?=
 =?us-ascii?Q?TzC6uA2p7EzW9DqfDhBMWlsOYKc8opg8u60f9g32bZVV4DFgjrYLQ62LjGtk?=
 =?us-ascii?Q?YBhGw5DzHjqNp62A7TbIzAhs+hVBsfKcyr47AfX/Lg+bbRQp79co8IKx8Hwa?=
 =?us-ascii?Q?qg=3D=3D?=
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 8f98d52b-e918-4b49-87c8-08da78c33cc8
X-MS-Exchange-CrossTenant-AuthSource: BLAPR10MB5267.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 07 Aug 2022 22:21:56.4763
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: L2eVXhodokg4Sk0gQcuEafICdQAoU0ZOE/1I/e3+3sfcFz9OVBCHH4/g6LCkOO5cz/gRGhYV5glkTAzTNDgB2A==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MWHPR1001MB2381
X-Proofpoint-Virus-Version: vendor=baseguard
 engine=ICAP:2.0.205,Aquarius:18.0.883,Hydra:6.0.517,FMLib:17.11.122.1
 definitions=2022-08-07_15,2022-08-05_01,2022-06-22_01
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 mlxscore=0 mlxlogscore=999 adultscore=0
 bulkscore=0 phishscore=0 suspectscore=0 spamscore=0 malwarescore=0
 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2206140000
 definitions=main-2208070119
X-Proofpoint-ORIG-GUID: ReqRWd_8AqnxOw73ZmFFIHuWInWL8xeQ
X-Proofpoint-GUID: ReqRWd_8AqnxOw73ZmFFIHuWInWL8xeQ
X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_LOW,
        RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,SPF_NONE,T_SCC_BODY_TEXT_LINE
        autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

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

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

diff --git a/Documentation/trace/events.rst b/Documentation/trace/events.rst
index c47f381d0c00..318dba2fe3ee 100644
--- a/Documentation/trace/events.rst
+++ b/Documentation/trace/events.rst
@@ -186,6 +186,15 @@ 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