From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from simark.ca by simark.ca with LMTP id sAK7BVXLEWBZTwAAWB0awg (envelope-from ) for ; Wed, 27 Jan 2021 15:21:41 -0500 Received: by simark.ca (Postfix, from userid 112) id 009271EF86; Wed, 27 Jan 2021 15:21:40 -0500 (EST) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on simark.ca X-Spam-Level: X-Spam-Status: No, score=-1.1 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,MAILING_LIST_MULTI,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.2 Received: from sourceware.org (server2.sourceware.org [8.43.85.97]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by simark.ca (Postfix) with ESMTPS id 5AAA91EF80 for ; Wed, 27 Jan 2021 15:21:34 -0500 (EST) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id C6791398B835; Wed, 27 Jan 2021 20:21:33 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org C6791398B835 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1611778893; bh=M9jmB3HTKw7+WcEL44u9d40PkAQEMz4020xJmuQ3Jz8=; h=To:Subject:Date:In-Reply-To:References:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To: From; b=KBUhjJuL5aQyAWeEHQnpbYZxxmaP5JinRDWt9St/4QfNFq+0XNoYekT+OMZAFcFZh YbiiEWrVHHMHF8czns686Wf7kpSG9g86YuSlbGQEnX1i+gPjQlZHr2GbnD0f3BAWOo d5bF9LefNkc9IBmESdlqJpU8WZ56uxgUbBGtODQ4= Received: from mail-qv1-xf2e.google.com (mail-qv1-xf2e.google.com [IPv6:2607:f8b0:4864:20::f2e]) by sourceware.org (Postfix) with ESMTPS id 4CE2D398B813 for ; Wed, 27 Jan 2021 20:21:31 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org 4CE2D398B813 Received: by mail-qv1-xf2e.google.com with SMTP id l14so1738135qvp.2 for ; Wed, 27 Jan 2021 12:21:31 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=M9jmB3HTKw7+WcEL44u9d40PkAQEMz4020xJmuQ3Jz8=; b=ACzsxE0sw2Uc4DT4+h8hCkO7U4VpGJmkJMdHczKIfWucrEt3ULYDor78fxH6r46ufl DQZsRawFbhoSJjT4OYhuT7jYyEGsx0xKKrTKk30sqeK6K+wEH7N1DbCoor4Z5VfRuGGM CuA0NhATY8czPMMmgFgLuvTFEcq6K05+pQlWrTYQF/smPUyp0T99/LWAObISjPRwipeA EKUrD5fCMbLO2h3FTIT6N5VP3th4RrquihXwWdfnbI07IvRbXUfv0rd/pJY8s8Vy94T4 kJPZqmKshouG4ruWQPMiU/epAxKDcGo4AjQU+YjpvFCRYeyQLZLSFplovB2PNH/5DpGi xyFQ== X-Gm-Message-State: AOAM533aBUhMaTUBNTqsoGK2vNv7AsqsQIVmFOpfNE4luKZKvDa8F8zo 4015ncLJlqLqzAldud/dOvWf5aVzQH3u1w== X-Google-Smtp-Source: ABdhPJwHhXlvcYCnp+4dAY3sxGnls9LSHTeE+4a8ZJbcmpz2QOTml3UOT91TBIYZP+X4aGUqmdt3OQ== X-Received: by 2002:a0c:e5d1:: with SMTP id u17mr11969447qvm.34.1611778890794; Wed, 27 Jan 2021 12:21:30 -0800 (PST) Received: from localhost.localdomain ([2804:7f0:8284:874d:b82c:87fc:4324:adab]) by smtp.gmail.com with ESMTPSA id b194sm1854531qkc.102.2021.01.27.12.21.29 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 27 Jan 2021 12:21:30 -0800 (PST) To: gdb-patches@sourceware.org Subject: [PATCH v5 07/25] Documentation for memory tagging remote packets Date: Wed, 27 Jan 2021 17:20:54 -0300 Message-Id: <20210127202112.2485702-8-luis.machado@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20210127202112.2485702-1-luis.machado@linaro.org> References: <20210127202112.2485702-1-luis.machado@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , From: Luis Machado via Gdb-patches Reply-To: Luis Machado Errors-To: gdb-patches-bounces@sourceware.org Sender: "Gdb-patches" Updates on v4: - Add documentation for ARM-specific memory tag types. Updates on v3: - Made packet description more clear. - Fixed Misc formatting/references issues. Updates on v2: - Update documentation to mention the packet's type field. -- Document the remote packet changes to support memory tagging. gdb/doc/ChangeLog: YYYY-MM-DD Luis Machado * gdb.texinfo (General Query Packets): Document qMemTags and QMemTags. Document the "memory-tagging" feature. (ARM-Specific Protocol Details): Document memory tag types. --- gdb/doc/gdb.texinfo | 114 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 114 insertions(+) diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index 84243a72ea..a10a74d0c3 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -40965,6 +40965,87 @@ is a sequence of thread IDs, @var{threadid} (eight hex digits), from the target. See @code{remote.c:parse_threadlist_response()}. @end table +@item qMemTags:@var{start address},@var{length}:@var{type} +@anchor{qMemTags} +@cindex fetch memory tags +@cindex @samp{qMemTags} packet +Fetch memory tags of type @var{type} from the address range +@w{@r{[}@var{start address}, @var{start address} + @var{length}@r{)}}. The +target is responsible for calculating how many tags will be returned, as this +is architecture-specific. + +@var{start address} is the starting address of the memory range. + +@var{length} is the length, in bytes, of the memory range. + +@var{type} is the type of tag the request wants to fetch. The type is a signed +integer. + +Reply: +@table @samp +@item @var{mxx}@dots{} +Hex encoded sequence of uninterpreted bytes, @var{xx}@dots{}, representing the +tags found in the requested memory range. + +@item E @var{nn} +An error occured. This means that fetching of memory tags failed for some +reason. + +@item @w{} +An empty reply indicates that @samp{qMemTags} is not supported by the stub, +although this should not happen given @value{GDBN} will only send this packet +if the stub has advertised support for memory tagging via @samp{qSupported}. +@end table + +@item QMemTags:@var{start address},@var{length}:@var{type}:@var{tag bytes} +@anchor{QMemTags} +@cindex store memory tags +@cindex @samp{QMemTags} packet +Store memory tags of type @var{type} to the address range +@w{@r{[}@var{start address}, @var{start address} + @var{length}@r{)}}. The +target is responsible for interpreting the type, the tag bytes and modifying +the memory tag granules accordingly, given this is architecture-specific. + +The interpretation of how many tags (@var{nt}) should be written to how many +memory tag granules (@var{ng}) is also architecture-specific. The behavior is +implementation-specific, but the following is suggested. + +If the number of memory tags, @var{nt}, is greater than or equal to the +number of memory tag granules, @var{ng}, only @var{ng} tags will be +stored. + +If @var{nt} is less than @var{ng}, the behavior is that of a fill operation, +and the tag bytes will be used as a pattern that will get repeated until +@var{ng} tags are stored. + +@var{start address} is the starting address of the memory range. The address +does not have any restriction on alignment or size. + +@var{length} is the length, in bytes, of the memory range. + +@var{type} is the type of tag the request wants to fetch. The typeis a signed +integer. + +@var{tag bytes} is a sequence of hex encoded uninterpreted bytes which will be +interpreted by the target. Each pair of hex digits is interpreted as a +single byte. + +Reply: +@table @samp +@item OK +The request was successful and the memory tag granules were modified +accordingly. + +@item E @var{nn} +An error occured. This means that modifying the memory tag granules failed +for some reason. + +@item @w{} +An empty reply indicates that @samp{QMemTags} is not supported by the stub, +although this should not happen given @value{GDBN} will only send this packet +if the stub has advertised support for memory tagging via @samp{qSupported}. +@end table + @item qOffsets @cindex section offsets, remote request @cindex @samp{qOffsets} packet @@ -41632,6 +41713,11 @@ These are the currently defined stub features and their properties: @tab @samp{-} @tab No +@item @samp{memory-tagging} +@tab No +@tab @samp{-} +@tab No + @end multitable These are the currently defined stub features, in more detail: @@ -41846,6 +41932,16 @@ The remote stub understands the @samp{QThreadEvents} packet. @item no-resumed The remote stub reports the @samp{N} stop reply. + +@item memory-tagging +The remote stub supports and implements the required memory tagging +functionality and understands the @samp{qMemTags} (@pxref{qMemTags}) and +@samp{QMemTags} (@pxref{QMemTags}) packets. + +For AArch64 GNU/Linux systems, this feature also requires access to the +@file{/proc/@var{pid}/smaps} file so memory mapping page flags can be inspected. +This is done via the @samp{vFile} requests. + @end table @item qSymbol:: @@ -42327,6 +42423,7 @@ details of XML target descriptions for each architecture. @menu * ARM Breakpoint Kinds:: +* ARM Memory Tag Types:: @end menu @node ARM Breakpoint Kinds @@ -42348,6 +42445,23 @@ These breakpoint kinds are defined for the @samp{Z0} and @samp{Z1} packets. @end table +@node ARM Memory Tag Types +@subsubsection @acronym{ARM} Memory Tag Types +@cindex memory tag types, @acronym{ARM} + +These memory tag types are defined for the @samp{qMemTag} and @samp{QMemTag} +packets. + +@table @r + +@item 0 +MTE logical tag + +@item 1 +MTE allocation tag + +@end table + @node MIPS-Specific Protocol Details @subsection @acronym{MIPS}-specific Protocol Details -- 2.25.1