From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wr1-f49.google.com (mail-wr1-f49.google.com [209.85.221.49]) by sourceware.org (Postfix) with ESMTPS id CA3F438EC7B9 for ; Wed, 13 Jul 2022 22:25:35 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org CA3F438EC7B9 Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=palves.net Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=gmail.com Received: by mail-wr1-f49.google.com with SMTP id bk26so1870wrb.11 for ; Wed, 13 Jul 2022 15:25:35 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=uAaW7Yh9eKvLlq9EIwR4e67u6KbG4H60b4t3mjGG1ro=; b=kvYmW79jd4oz9JabGUkKa9OrQdpycA3Oiibg7g8s1l1Lee8S8YulBK+sBwvd5NNppB 8YdwRYeIUklNxRScGH9HtmHAzGuiA9o/P04ROM0Usxy0VZr2nzSXKKOL61ncppIsyjwO kZvsszJyLON0ywQ66aDt+yUK/qIQ5dmnMIcTlL6nZw/tbTYosyaTMAAzYtOYnJllE2H/ 7Ohs+yvSb3m2S4VEKGITw/ueUGQvztzgkruZtrAiBsnhh6K/37qu+Mprv47ZUOK7jDOB EykzgXiarD8HlAYSo2BpzZ1Rrnt1iT6eHOVsGU2kfrceUAuCb/2zADWzaP5pRy4f955H tvWQ== X-Gm-Message-State: AJIora/X/H5DpY+8Dje51kSXXLkCfNLxoJeFi7frPSN/vTxV+18JAgBn f6JJo4QBRCPcS2nK39FvUv6F1GAXnj0= X-Google-Smtp-Source: AGRyM1svWFLutFQQWjZ1gHEXEt0JnR15S6LVgvxNGLhC6iiKQgj5sLx+RiNChGvZ8EURF7iYDJYnEg== X-Received: by 2002:a5d:5903:0:b0:21d:6dd5:d9c3 with SMTP id v3-20020a5d5903000000b0021d6dd5d9c3mr5134924wrd.85.1657751133995; Wed, 13 Jul 2022 15:25:33 -0700 (PDT) Received: from localhost ([2001:8a0:f924:2600:209d:85e2:409e:8726]) by smtp.gmail.com with ESMTPSA id p12-20020a5d48cc000000b0021d9d13bf6csm10658098wrs.97.2022.07.13.15.25.32 for (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Wed, 13 Jul 2022 15:25:32 -0700 (PDT) From: Pedro Alves To: gdb-patches@sourceware.org Subject: [PATCH v2 26/29] Document remote clone events, and QThreadOptions packet Date: Wed, 13 Jul 2022 23:24:30 +0100 Message-Id: <20220713222433.374898-27-pedro@palves.net> X-Mailer: git-send-email 2.36.0 In-Reply-To: <20220713222433.374898-1-pedro@palves.net> References: <20220713222433.374898-1-pedro@palves.net> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-9.9 required=5.0 tests=BAYES_00, FREEMAIL_FORGED_FROMDOMAIN, FREEMAIL_FROM, GIT_PATCH_0, HEADER_FROM_DIFFERENT_DOMAINS, KAM_DMARC_STATUS, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H2, SPF_HELO_NONE, SPF_PASS, TXREP, 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 server2.sourceware.org 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: , X-List-Received-Date: Wed, 13 Jul 2022 22:25:38 -0000 This commit documents in both manual and NEWS: - the new remote clone event stop reply, - the new QThreadOptions packet and its current defined options, - the associated "set/show remote thread-events-packet" command, - and the associated QThreadOptions qSupported feature. Change-Id: Ic1c8de1fefba95729bbd242969284265de42427e --- gdb/NEWS | 19 +++++++ gdb/doc/gdb.texinfo | 126 ++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 142 insertions(+), 3 deletions(-) diff --git a/gdb/NEWS b/gdb/NEWS index f0f6990dc59..41d3f4d3f5c 100644 --- a/gdb/NEWS +++ b/gdb/NEWS @@ -88,6 +88,10 @@ show style disassembler symbol The 'disassembler address' and 'disassembler symbol' styles are aliases for the 'address' and 'function' styles respectively. +set remote thread-options-packet +show remote thread-options-packet + Set/show the use of the thread options packet. + * Changed commands maintenance info line-table @@ -160,6 +164,21 @@ GNU/Linux/LoongArch (gdbserver) loongarch*-*-linux* ** GDBserver is now supported on LoongArch GNU/Linux. +* New remote packets + +New stop reason: clone + Indicates that a clone system call was executed. + +QThreadOptions + Enable/disable optional event reporting, on a per-thread basis. + Currently supported options are GDB_TO_CLONE, to enable clone event + reporting, and GDB_TO_EXIT to enable thread exit event reporting. + +QThreadOptions in qSupported + The qSupported packet allows GDB to inform the stub it supports the + QThreadOptions packet, and the qSupported response can contain the + set of thread options the remote stub supports. + *** Changes in GDB 12 * DBX mode is deprecated, and will be removed in GDB 13 diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index a15ef0ed0db..ed86632830e 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -23940,6 +23940,10 @@ are: @tab @code{QThreadEvents} @tab Tracking thread lifetime. +@item @code{thread-options} +@tab @code{QThreadOptions} +@tab Set thread event reporting options. + @item @code{no-resumed-stop-reply} @tab @code{no resumed thread left stop reply} @tab Tracking thread lifetime. @@ -41815,6 +41819,17 @@ appropriate @samp{qSupported} feature (@pxref{qSupported}). The remote stub must also supply the appropriate @samp{qSupported} feature indicating support. +@cindex thread clone events, remote reply +@anchor{thread clone event} +@item clone +The packet indicates that @code{clone} was called, and @var{r} is the +thread ID of the new child thread, as specified in @ref{thread-id +syntax}. This packet is only applicable to targets that support clone +events. + +This packet should not be sent by default; @value{GDBN} requests it +with the @ref{QThreadOptions} packet. + @cindex thread create event, remote reply @anchor{thread create event} @item create @@ -41853,9 +41868,10 @@ hex strings. @item w @var{AA} ; @var{tid} The thread exited, and @var{AA} is the exit status. This response -should not be sent by default; @value{GDBN} requests it with the -@ref{QThreadEvents} packet. See also @ref{thread create event} above. -@var{AA} is formatted as a big-endian hex string. +should not be sent by default; @value{GDBN} requests it with either +the @ref{QThreadEvents} or @ref{QThreadOptions} packets. See also +@ref{thread create event} above. @var{AA} is formatted as a +big-endian hex string. @item N There are no resumed threads left in the target. In other words, even @@ -42580,6 +42596,11 @@ same thread. @value{GDBN} does not enable this feature unless the stub reports that it supports it by including @samp{QThreadEvents+} in its @samp{qSupported} reply. +This packet always enables/disables event reporting for all threads of +all processes under control of the remote stub. For per-thread +control of optional event reporting, see the @ref{QThreadOptions} +packet. + Reply: @table @samp @item OK @@ -42596,6 +42617,93 @@ the stub. Use of this packet is controlled by the @code{set remote thread-events} command (@pxref{Remote Configuration, set remote thread-events}). +@anchor{QThreadOptions} +@item QThreadOptions@r{[};@var{options}@r{[}:@var{thread-id}@r{]]}@dots{} +@cindex thread options, remote request +@cindex @samp{QThreadOptions} packet + +For each inferior thread, the last @var{options} in the list with a +matching @var{thread-id} are applied. Any options previously set on a +thread are discarded and replaced by the new options specified. +Threads that do not match any @var{thread-id} retain their +previously-set options. Thread IDs are specified using the syntax +described in @ref{thread-id syntax}. If multiprocess extensions +(@pxref{multiprocess extensions}) are supported, options can be +specified to apply to all threads of a process by using the +@samp{p@var{pid}.-1} form of @var{thread-id}. Options with no +@var{thread-id} apply to all threads. Specifying no options is an +error. + +@var{options} is the bitwise @code{OR} of the following values. All +values are given in hexadecimal representation. + +@table @code +@item GDB_TO_CLONE (0x1) +Report thread clone events (@pxref{thread clone event}). This is only +meaningful for targets that support clone events (e.g., GNU/Linux +systems). + +@item GDB_TO_EXIT (0x2) +Report thread exit events (@pxref{thread exit event}). +@end table + +@noindent + +For example, @value{GDBN} enables the @code{GDB_TO_EXIT} and +@code{GDB_TO_CLONE} options when single-stepping a thread past a +breakpoint, for the following reasons: + +@itemize @bullet +@item +If the single-stepped thread exits (e.g., it executes a thread exit +system call), enabling @code{GDB_TO_EXIT} prevents @value{GDBN} from +waiting forever, not knowing that it should no longer expect a stop for +that same thread, and blocking other threads from progressing. + +@item +If the single-stepped thread spawns a new clone child (i.e., it +executes a clone system call), enabling @code{GDB_TO_CLONE} halts the +cloned thread before it executes any instructions, and thus prevents +the following problematic situations: + +@itemize @minus +@item +If the breakpoint is stepped-over in-line, the spawned thread would +incorrectly run free while the breakpoint being stepped over is not +inserted, and thus the cloned thread may potentially run past the +breakpoint without stopping for it; + +@item +If displaced (out-of-line) stepping is used, the cloned thread starts +running at the out-of-line PC, leading to undefined behavior, usually +crashing or corrupting data. +@end itemize + +@end itemize + +New threads start with thread options cleared. + +@value{GDBN} does not enable this feature unless the stub reports that +it supports it by including +@samp{QThreadOptions=@var{supported_options}} in its @samp{qSupported} +reply. + +Reply: +@table @samp +@item OK +The request succeeded. + +@item E @var{nn} +An error occurred. The error number @var{nn} is given as hex digits. + +@item @w{} +An empty reply indicates that @samp{QThreadOptions} is not supported by +the stub. +@end table + +Use of this packet is controlled by the @code{set remote thread-options} +command (@pxref{Remote Configuration, set remote thread-options}). + @item qRcmd,@var{command} @cindex execute remote command, remote request @cindex @samp{qRcmd} packet @@ -43041,6 +43149,11 @@ These are the currently defined stub features and their properties: @tab @samp{-} @tab No +@item @samp{QThreadOptions} +@tab Yes +@tab @samp{-} +@tab No + @item @samp{no-resumed} @tab No @tab @samp{-} @@ -43262,6 +43375,13 @@ The remote stub reports the supported actions in the reply to @item QThreadEvents The remote stub understands the @samp{QThreadEvents} packet. +@item QThreadOptions=@var{supported_options} +The remote stub understands the @samp{QThreadOptions} packet. +@var{supported_options} indicates the set of thread options the remote +stub supports. @var{supported_options} has the same format as the +@var{options} parameter of the @code{QThreadOptions} packet, described +at @ref{QThreadOptions}. + @item no-resumed The remote stub reports the @samp{N} stop reply. -- 2.36.0