From patchwork Fri Apr 28 23:35:38 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrew Burgess X-Patchwork-Id: 68525 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 383EC3858416 for ; Fri, 28 Apr 2023 23:39:50 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 383EC3858416 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1682725191; bh=7mXCC3Xa50QRXUeMWe8VXmpgKCR856vR16t7sPSvNWI=; h=To:Cc:Subject:Date:In-Reply-To:References:List-Id: List-Unsubscribe:List-Archive:List-Post:List-Help:List-Subscribe: From:Reply-To:From; b=NJ6c8t8Ryq+GBAL7A44sw5gR9UeTzg7lk52ZMePQ3g0RMHWDRp/hiD7eM20hDWiRY ECJ2dCaKmmcuvYqcvGyXfXdaWrJYPQ4yrsCv8f09VFFV0pPB2kkcvb0gupUgrAHHZ+ UJTKmquZQICn8gDSU8nrTzgu0ZsKuBs9eSVawfcQ= X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by sourceware.org (Postfix) with ESMTPS id 382033858002 for ; Fri, 28 Apr 2023 23:35:54 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 382033858002 Received: from mail-wm1-f72.google.com (mail-wm1-f72.google.com [209.85.128.72]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-252--cckFiihNnqXhs0RbZ-OEQ-1; Fri, 28 Apr 2023 19:35:52 -0400 X-MC-Unique: -cckFiihNnqXhs0RbZ-OEQ-1 Received: by mail-wm1-f72.google.com with SMTP id 5b1f17b1804b1-3f191fc08b7so801395e9.0 for ; Fri, 28 Apr 2023 16:35:52 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1682724951; x=1685316951; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=7mXCC3Xa50QRXUeMWe8VXmpgKCR856vR16t7sPSvNWI=; b=kUmK04DCnCJsb20X5ZTnoreBc3F3p+xZFU4LKAV9TOLrpTV4CToXcW1546Fmve7DDx 0mBra0J9uuxrK12FmU1uZrtCBlPR/3jh/eMRJfVH1OFocuHaDCdisDy7zXnWZy7mfLhK MRO4atCWayQKf1L8uREX1astig0TE1B2LCuMhH+MYRcJ8mP98I1iLbNhSk7An32AgoVM gWLOeSYOYYTe4ki2XKEyZyuq6w/5VJk1f4Dm5QzH3wJOebK+jFs9NyonksChJB8Y2ELN OI9Rmk/wdjFc3OXrEbEbRtyXuJ7M8gR1VOiGu2DMY2n9UsRHdG8WPhaG1plWEFa+nsDP dQvg== X-Gm-Message-State: AC+VfDxqdfFMZSjhn8H+j7Y/DSow4DlISHehllvBwZStkA8EPXNZDJ36 qsChjuwKSjG09jNDUY7JQBheyD6x2+i8KNeFRwA5UgghiPjE2IbN8/THE+QAOpz9jUSH3dkYW6L sNiv4NgNLeJX/uhBkGHs6+ybPUaL5ReWEIloaKZ6ZvCF4iLhSMVZW0+GCX6O6ehOJINE8F10GFs q0iTvXbg== X-Received: by 2002:a05:600c:cb:b0:3f1:7144:5e32 with SMTP id u11-20020a05600c00cb00b003f171445e32mr5165327wmm.35.1682724950963; Fri, 28 Apr 2023 16:35:50 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ6PS7ZTUEfztGejesy84qfiBuUWWxHVqCrN3NthPYtSSBrDdCZVcclp4vIJ1Z+ludraFVC60g== X-Received: by 2002:a05:600c:cb:b0:3f1:7144:5e32 with SMTP id u11-20020a05600c00cb00b003f171445e32mr5165317wmm.35.1682724950465; Fri, 28 Apr 2023 16:35:50 -0700 (PDT) Received: from localhost (11.72.115.87.dyn.plus.net. [87.115.72.11]) by smtp.gmail.com with ESMTPSA id x24-20020a1c7c18000000b003f183127434sm25653045wmc.30.2023.04.28.16.35.49 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 28 Apr 2023 16:35:50 -0700 (PDT) To: gdb-patches@sourceware.org Cc: Andrew Burgess Subject: [PATCH 2/9] gdb: create_breakpoint: asserts relating to extra_string/parse_extra Date: Sat, 29 Apr 2023 00:35:38 +0100 Message-Id: <1930bf8655de11ae7499e0a04d3255150146fbe5.1682724005.git.aburgess@redhat.com> X-Mailer: git-send-email 2.25.4 In-Reply-To: References: MIME-Version: 1.0 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-Spam-Status: No, score=-11.6 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H2, SPF_HELO_NONE, SPF_NONE, 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-Patchwork-Original-From: Andrew Burgess via Gdb-patches From: Andrew Burgess Reply-To: Andrew Burgess Errors-To: gdb-patches-bounces+patchwork=sourceware.org@sourceware.org Sender: "Gdb-patches" The goal of this commit is to better define the API for create_breakpoint especially around the use of extra_string and parse_extra. This will be useful in the next commit when I plan to make some changes to create_breakpoint. This commit makes one possibly breaking change: until this commit it was possible to create thread-specific dprintf breakpoint like this: (gdb) dprintf call_me, thread 1 "%s", "hello" Dprintf 2 at 0x401152: file /tmp/hello.c, line 8. (gdb) info breakpoints Num Type Disp Enb Address What 2 dprintf keep y 0x0000000000401152 in call_me at /tmp/hello.c:8 thread 1 stop only in thread 1 printf "%s", "hello" (gdb) this feature of dprintf was not documented, was not tested, and is slightly different in syntax to how we create thread specific breakpoints and/or watchpoints -- the thread condition appears after the first ','. I believe that this worked at all was simply by luck. We happen to pass the parse_extra flag as true from dprintf_command to create_breakpoint. So in this commit I made the choice change this. We now pass parse_extra as false from dprintf_command to create_breakpoint. With this done it is assumed that the only thing in the extra_string is the dprintf format and arguments. Beyond this change I've updated the comment on create_breakpoint in breakpoint.h, and I've then added some asserts into create_breakpoint as well as moving around some of the error handling. - We now assert on the incoming argument values, - I've moved an error check to sit after the call to find_condition_and_thread_for_sals, this ensures the extra_string was parsed correctly, In dprintf_command: - We now throw an error if there is no format string after the dprintf location. This error was already being thrown, but was being caught later in the process. With this change we catch the missing string earlier, - And, as mentioned earlier, we pass parse_extra as false when calling create_breakpoint, In create_tracepoint_from_upload: - We now throw an error if the parsed location doesn't completely consume the addr_str variable. This error has now effectively moved out of create_breakpoint. --- gdb/breakpoint.c | 42 +++++++++++++++++++++++++++++------------- gdb/breakpoint.h | 38 ++++++++++++++++++++++++-------------- 2 files changed, 53 insertions(+), 27 deletions(-) diff --git a/gdb/breakpoint.c b/gdb/breakpoint.c index e6940bc9671..350fa495319 100644 --- a/gdb/breakpoint.c +++ b/gdb/breakpoint.c @@ -9034,6 +9034,17 @@ create_breakpoint (struct gdbarch *gdbarch, if (extra_string != NULL && *extra_string == '\0') extra_string = NULL; + /* A bp_dprintf must always have an accompanying EXTRA_STRING containing + the dprintf format and arguments -- PARSE_EXTRA should always be false + in this case. + + For all other breakpoint types, EXTRA_STRING should be nullptr unless + PARSE_EXTRA is true. */ + gdb_assert ((type_wanted == bp_dprintf + && extra_string != nullptr && !parse_extra) + || (type_wanted != bp_dprintf + && (extra_string == nullptr || parse_extra))); + try { ops->create_sals_from_location_spec (locspec, &canonical); @@ -9097,6 +9108,8 @@ create_breakpoint (struct gdbarch *gdbarch, if (parse_extra) { + gdb_assert (type_wanted != bp_dprintf); + gdb::unique_xmalloc_ptr rest; gdb::unique_xmalloc_ptr cond; @@ -9104,15 +9117,15 @@ create_breakpoint (struct gdbarch *gdbarch, find_condition_and_thread_for_sals (lsal.sals, extra_string, &cond, &thread, &task, &rest); + + if (rest.get () != nullptr && *(rest.get ()) != '\0') + error (_("Garbage '%s' at end of command"), rest.get ()); + cond_string_copy = std::move (cond); extra_string_copy = std::move (rest); } else { - if (type_wanted != bp_dprintf - && extra_string != NULL && *extra_string != '\0') - error (_("Garbage '%s' at end of location"), extra_string); - /* Check the validity of the condition. We should error out if the condition is invalid at all of the locations and if it is not forced. In the PARSE_EXTRA case above, this @@ -9321,20 +9334,17 @@ dprintf_command (const char *arg, int from_tty) /* If non-NULL, ARG should have been advanced past the location; the next character must be ','. */ - if (arg != NULL) + if (arg == nullptr || arg[0] != ',' || arg[1] == '\0') + error (_("Format string required")); + else { - if (arg[0] != ',' || arg[1] == '\0') - error (_("Format string required")); - else - { - /* Skip the comma. */ - ++arg; - } + /* Skip the comma. */ + ++arg; } create_breakpoint (get_current_arch (), locspec.get (), - NULL, 0, arg, false, 1 /* parse arg */, + NULL, -1, arg, false, 0 /* parse arg */, 0, bp_dprintf, 0 /* Ignore count */, pending_break_support, @@ -13909,6 +13919,12 @@ create_tracepoint_from_upload (struct uploaded_tp *utp) location_spec_up locspec = string_to_location_spec (&addr_str, current_language); + + + gdb_assert (addr_str != nullptr); + if (*addr_str != '\0') + error (_("Garbage '%s' at end of location"), addr_str); + if (!create_breakpoint (get_current_arch (), locspec.get (), utp->cond_string.get (), -1, addr_str, diff --git a/gdb/breakpoint.h b/gdb/breakpoint.h index e57dc2523fb..2adcc9fa338 100644 --- a/gdb/breakpoint.h +++ b/gdb/breakpoint.h @@ -1515,26 +1515,36 @@ enum breakpoint_create_flags functions for setting a breakpoint at LOCSPEC. This function has two major modes of operations, selected by the - PARSE_EXTRA parameter. + PARSE_EXTRA and WANTED_TYPE parameters. - If PARSE_EXTRA is zero, LOCSPEC is just the breakpoint's location - spec, with condition, thread, and extra string specified by the - COND_STRING, THREAD, and EXTRA_STRING parameters. + When WANTED_TYPE is not bp_dprintf the following rules apply: - If PARSE_EXTRA is non-zero, this function will attempt to extract - the condition, thread, and extra string from EXTRA_STRING, ignoring - the similarly named parameters. + If PARSE_EXTRA is zero, LOCSPEC is just the breakpoint's location + spec, with condition, thread, and extra string specified by the + COND_STRING, THREAD, and EXTRA_STRING parameters. - If FORCE_CONDITION is true, the condition is accepted even when it is - invalid at all of the locations. However, if PARSE_EXTRA is non-zero, - the FORCE_CONDITION parameter is ignored and the corresponding argument - is parsed from EXTRA_STRING. + If PARSE_EXTRA is non-zero, this function will attempt to extract the + condition, thread, and extra string from EXTRA_STRING, ignoring the + similarly named parameters. + + When WANTED_TYPE is bp_dprintf the following rules apply: + + PARSE_EXTRA must always be zero, LOCSPEC is just the breakpoint's + location spec, with condition, thread, and extra string (which + contains the dprintf format and arguments) specified by the + COND_STRING, THREAD, and EXTRA_STRING parameters. + + If FORCE_CONDITION is true, the condition (in COND_STRING) is accepted + even when it is invalid at all of the locations. However, if + PARSE_EXTRA is non-zero and WANTED_TYPE is not bp_dprintf, the + FORCE_CONDITION parameter is ignored and the corresponding argument is + parsed from EXTRA_STRING. The THREAD should be a global thread number, the created breakpoint will only apply for that thread. If the breakpoint should apply for all - threads then pass -1. However, if PARSE_EXTRA is non-zero then the - THREAD parameter is ignored and an optional thread number will be parsed - from EXTRA_STRING. + threads then pass -1. However, if PARSE_EXTRA is non-zero and + WANTED_TYPE is not bp_dprintf, then the THREAD parameter is ignored and + an optional thread number will be parsed from EXTRA_STRING. If INTERNAL is non-zero, the breakpoint number will be allocated from the internal breakpoint count.