From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: 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 A6B2B3858D35 for ; Tue, 10 Oct 2023 21:57:00 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org A6B2B3858D35 Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=redhat.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1696975020; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=BMNrHnFimFZbq/epJSKaSmpI9LhklIaaMhfr+a5TaOM=; b=efJwTEiRKqdtiQHTOdHv297Aqf6itvwAiKCVrGj0KtIYObWXmNk/FKd0XrAyjhR7x5jnxZ zG3WXgKQ0KNmW3wfslSQDMfeMz38apnTb+yF2gwByCGoJ/MJupMdzIAMV7Ftx2PHJrhnGe w7kccbyV7DJvRVtwxpPD795+8UA2jSA= Received: from mail-pj1-f70.google.com (mail-pj1-f70.google.com [209.85.216.70]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-244-aqJYuPoYNoOzvNzopFOyjw-1; Tue, 10 Oct 2023 17:56:59 -0400 X-MC-Unique: aqJYuPoYNoOzvNzopFOyjw-1 Received: by mail-pj1-f70.google.com with SMTP id 98e67ed59e1d1-27cf48e7d37so694398a91.1 for ; Tue, 10 Oct 2023 14:56:58 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1696975018; x=1697579818; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=BMNrHnFimFZbq/epJSKaSmpI9LhklIaaMhfr+a5TaOM=; b=qdvslDiH1UgT6KINBnf3AEf6zOw+bmurqI3gKS0G8sLgqjVRYT+sFdnm1LuXZ9J+6F AoSrvcjB1RufDOPrU+Cpebgpwmp5cgwd5t2t6Kc5Wf6wOl1YmGOtPamda9ZISpQ4AbHN EnJUvMJsnbhgNIFOBJ3FrjLYBQEbQu8ZeEGDcRq3H0mH6XovDtPRfL6QYRBAcFQLw9zI qfgAVD9eYNR8Y1khGGMETmOPN3u80nlsvwEUz0ZgMqn6LHHsdOAfDOxUL+CYRyD4UQTg ez2rtUkPptj/jsR9nhKO1J8ACdzbfu/gtvM2nFtiqFybfIbC3qOa+EdOfMgPxECAE2XP nIZQ== X-Gm-Message-State: AOJu0YziEMCDoZb2LQqUWyGVH9V2bALy8vc2mbCcNNOcsA8d33P6Kp5h nCEjBI7goXm7mdueEq/BQY+lkPxK+MYouUCqixDB4T9gN928BkRweYHGlaVeVTb7pJrzmHpvWHg fwAQ11OSzr1USJXEPfR8nSBH6W/r+vi6QLV4BuwJSoNKC X-Received: by 2002:a17:90b:2343:b0:27c:ede4:511b with SMTP id ms3-20020a17090b234300b0027cede4511bmr2777865pjb.25.1696975017685; Tue, 10 Oct 2023 14:56:57 -0700 (PDT) X-Google-Smtp-Source: AGHT+IEjoIgnQzdurZbI5OrTPUQ+YBwclTp31jnVlx5MDzeKDAh9xR/NZbLbxuwqgiqNleLolsZPWIVqwMwQPRUtGWY= X-Received: by 2002:a17:90b:2343:b0:27c:ede4:511b with SMTP id ms3-20020a17090b234300b0027cede4511bmr2777850pjb.25.1696975017215; Tue, 10 Oct 2023 14:56:57 -0700 (PDT) MIME-Version: 1.0 References: <20230816044259.2675531-1-amerey@redhat.com> <20230816044259.2675531-6-amerey@redhat.com> In-Reply-To: From: Aaron Merey Date: Tue, 10 Oct 2023 17:56:46 -0400 Message-ID: Subject: [PING*2][PATCH 5/7 v2] gdb/progspace: Add reverse safe iterator and template for unwrapping iterator To: gdb-patches@sourceware.org Cc: Andrew Burgess X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable X-Spam-Status: No, score=-11.1 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_H3,RCVD_IN_MSPIKE_WL,SPF_HELO_NONE,SPF_NONE,TXREP autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org List-Id: Ping Thanks, Aaron On Tue, Sep 19, 2023 at 10:35=E2=80=AFAM Aaron Merey wr= ote: > > Ping > > Thanks, > Aaron > > On Wed, Aug 16, 2023 at 12:43=E2=80=AFAM Aaron Merey = wrote: > > > > v1: https://sourceware.org/pipermail/gdb-patches/2023-June/199984.html > > > > v2 removes unwrapping_reverse_objfile_iterator and adds > > basic_safe_reverse_range and basic_safe_reverse_iterator. > > > > Commit message: > > > > This patch changes progspace objfile_list insertion so that separate > > debug objfiles are placed into the list after the parent objfile, > > instead of before. Additionally qf_require_partial_symbols now returns > > a safe_range. > > > > These changes are intended to prepare gdb for on-demand debuginfo > > downloading and the downloading of .gdb_index sections. > > > > With on-demand downloading enabled, gdb might need to delete a > > .gdb_index quick_symbol_functions from a parent objfile while looping > > the objfile's list of quick_symbol_functions becasue the separate > > debug objfile has just been downloaded. The use of a safe_range > > prevents this removal from causing iterator invalidation. > > > > gdb might also download a debuginfo file during symtab expansion. > > In this case an objfile will be added to the current progspace's > > objfiles_list during iteration over the list (for example, in > > iterate_over_symtabs). We want these loops to also iterate over > > newly downloaded objfiles. So objfiles need to be inserted into > > objfiles_list after their parent since it is during the search of > > the parent objfile for some symbol or filename that the separate > > debug objfile might be downloaded. > > > > To facilitate the safe deletion of objfiles, this patch also adds > > basic_safe_reverse_range and basic_safe_reverse_iterator. This allows > > objfiles to be removed from the objfiles_list in a loop without iterato= r > > invalidation. > > > > If a forward safe iterator were to be used, the deletion of an > > objfile could invalidate the safe iterator's reference to the next > > objfile in the objfiles_list. This can happen when the deletion > > of an objfile causes the deletion of a separate debug objfile that > > happens to the be next element in the objfiles_list. > > > > The standard reverse iterator is not suitable for safe objfile deletion= . > > In order to safely delete the first objfile in the objfiles_list, the > > standard reverse iterator's underlying begin iterator would have to be > > decremented, resulting in undefined behavior. > > > > A small change was also made to a testcase in py-objfile.exp to > > account for the new placement of separate debug objfiles in > > objfiles_list. > > --- > > gdb/jit.c | 7 +- > > gdb/objfiles.c | 8 +- > > gdb/objfiles.h | 8 +- > > gdb/progspace.c | 19 ++++- > > gdb/progspace.h | 31 ++++--- > > gdb/testsuite/gdb.python/py-objfile.exp | 2 +- > > gdbsupport/safe-iterator.h | 106 ++++++++++++++++++++++++ > > 7 files changed, 154 insertions(+), 27 deletions(-) > > > > diff --git a/gdb/jit.c b/gdb/jit.c > > index 804c832f47d..091e0b4a771 100644 > > --- a/gdb/jit.c > > +++ b/gdb/jit.c > > @@ -1239,11 +1239,10 @@ jit_breakpoint_re_set (void) > > static void > > jit_inferior_exit_hook (struct inferior *inf) > > { > > - for (objfile *objf : current_program_space->objfiles_safe ()) > > + current_program_space->unlink_objfiles_if ([&] (const objfile *objf) > > { > > - if (objf->jited_data !=3D nullptr && objf->jited_data->addr !=3D= 0) > > - objf->unlink (); > > - } > > + return (objf->jited_data !=3D nullptr) && (objf->jited_data->add= r !=3D 0); > > + }); > > } > > > > void > > diff --git a/gdb/objfiles.c b/gdb/objfiles.c > > index 5ba5f0a616d..f862182458d 100644 > > --- a/gdb/objfiles.c > > +++ b/gdb/objfiles.c > > @@ -794,14 +794,12 @@ have_full_symbols (void) > > void > > objfile_purge_solibs (void) > > { > > - for (objfile *objf : current_program_space->objfiles_safe ()) > > + current_program_space->unlink_objfiles_if ([&] (const objfile *objf) > > { > > /* We assume that the solib package has been purged already, or = will > > be soon. */ > > - > > - if (!(objf->flags & OBJF_USERLOADED) && (objf->flags & OBJF_SHAR= ED)) > > - objf->unlink (); > > - } > > + return !(objf->flags & OBJF_USERLOADED) && (objf->flags & OBJF_S= HARED); > > + }); > > } > > > > > > diff --git a/gdb/objfiles.h b/gdb/objfiles.h > > index 189856f0a51..4a396af17da 100644 > > --- a/gdb/objfiles.h > > +++ b/gdb/objfiles.h > > @@ -699,13 +699,17 @@ struct objfile > > > > private: > > > > + using qf_list =3D std::forward_list; > > + using qf_range =3D iterator_range; > > + using qf_safe_range =3D basic_safe_range; > > + > > /* Ensure that partial symbols have been read and return the "quick"= (aka > > partial) symbol functions for this symbol reader. */ > > - const std::forward_list & > > + qf_safe_range > > qf_require_partial_symbols () > > { > > this->require_partial_symbols (true); > > - return qf; > > + return qf_safe_range (qf_range (qf.begin (), qf.end ())); > > } > > > > public: > > diff --git a/gdb/progspace.c b/gdb/progspace.c > > index 5cf8334ee67..2ab1a799fe7 100644 > > --- a/gdb/progspace.c > > +++ b/gdb/progspace.c > > @@ -139,19 +139,19 @@ program_space::free_all_objfiles () > > > > void > > program_space::add_objfile (std::unique_ptr &&objfile, > > - struct objfile *before) > > + struct objfile *after) > > { > > - if (before =3D=3D nullptr) > > + if (after =3D=3D nullptr) > > objfiles_list.push_back (std::move (objfile)); > > else > > { > > auto iter =3D std::find_if (objfiles_list.begin (), objfiles_lis= t.end (), > > [=3D] (const std::unique_ptr<::objfile>= &objf) > > { > > - return objf.get () =3D=3D before; > > + return objf.get () =3D=3D after; > > }); > > gdb_assert (iter !=3D objfiles_list.end ()); > > - objfiles_list.insert (iter, std::move (objfile)); > > + objfiles_list.insert (++iter, std::move (objfile)); > > } > > } > > > > @@ -180,6 +180,17 @@ program_space::remove_objfile (struct objfile *obj= file) > > > > /* See progspace.h. */ > > > > +void > > +program_space::unlink_objfiles_if > > + (gdb::function_view predicate) > > +{ > > + for (auto &it : objfiles_safe ()) > > + if (predicate (it.get ())) > > + it->unlink (); > > +} > > + > > +/* See progspace.h. */ > > + > > struct objfile * > > program_space::objfile_for_address (CORE_ADDR address) > > { > > diff --git a/gdb/progspace.h b/gdb/progspace.h > > index ee12d89c173..a730c1334eb 100644 > > --- a/gdb/progspace.h > > +++ b/gdb/progspace.h > > @@ -213,28 +213,32 @@ struct program_space > > unwrapping_objfile_iterator (objfiles_list.end ())); > > } > > > > - using objfiles_safe_range =3D basic_safe_range; > > + using objfiles_safe_range =3D iterator_range= ; > > + using objfiles_safe_reverse_range > > + =3D basic_safe_reverse_range; > > > > /* An iterable object that can be used to iterate over all objfiles. > > The basic use is in a foreach, like: > > > > for (objfile *objf : pspace->objfiles_safe ()) { ... } > > > > - This variant uses a basic_safe_iterator so that objfiles can be > > - deleted during iteration. */ > > - objfiles_safe_range objfiles_safe () > > + This variant uses a basic_safe_reverse_iterator so that objfiles > > + can be deleted during iteration. > > + > > + The use of a reverse iterator helps ensure that separate debug > > + objfiles are deleted before their parent objfile. This prevents > > + iterator invalidation due to the deletion of a parent objfile. *= / > > + objfiles_safe_reverse_range objfiles_safe () > > { > > - return objfiles_safe_range > > - (objfiles_range > > - (unwrapping_objfile_iterator (objfiles_list.begin ()), > > - unwrapping_objfile_iterator (objfiles_list.end ()))); > > + return objfiles_safe_reverse_range > > + (objfiles_safe_range (objfiles_list.begin (), objfiles_list.end = ())); > > } > > > > - /* Add OBJFILE to the list of objfiles, putting it just before > > - BEFORE. If BEFORE is nullptr, it will go at the end of the > > + /* Add OBJFILE to the list of objfiles, putting it just after > > + AFTER. If AFTER is nullptr, it will go at the end of the > > list. */ > > void add_objfile (std::unique_ptr &&objfile, > > - struct objfile *before); > > + struct objfile *after); > > > > /* Remove OBJFILE from the list of objfiles. */ > > void remove_objfile (struct objfile *objfile); > > @@ -249,6 +253,11 @@ struct program_space > > /* Free all the objfiles associated with this program space. */ > > void free_all_objfiles (); > > > > + /* Unlink all objfiles associated with this program space for which > > + PREDICATE evaluates to true. */ > > + void unlink_objfiles_if > > + (gdb::function_view predicate); > > + > > /* Return the objfile containing ADDRESS, or nullptr if the address > > is outside all objfiles in this progspace. */ > > struct objfile *objfile_for_address (CORE_ADDR address); > > diff --git a/gdb/testsuite/gdb.python/py-objfile.exp b/gdb/testsuite/gd= b.python/py-objfile.exp > > index 61b9942de79..0bf49976b73 100644 > > --- a/gdb/testsuite/gdb.python/py-objfile.exp > > +++ b/gdb/testsuite/gdb.python/py-objfile.exp > > @@ -135,7 +135,7 @@ gdb_test "p main" "=3D {} $hex
" \ > > gdb_py_test_silent_cmd "python objfile.add_separate_debug_file(\"${bin= file}\")" \ > > "Add separate debug file file" 1 > > > > -gdb_py_test_silent_cmd "python sep_objfile =3D gdb.objfiles()\[0\]" \ > > +gdb_py_test_silent_cmd "python sep_objfile =3D gdb.objfiles()\[1\]" \ > > "Get separate debug info objfile" 1 > > > > gdb_test "python print (sep_objfile.owner.filename)" "${testfile}2" \ > > diff --git a/gdbsupport/safe-iterator.h b/gdbsupport/safe-iterator.h > > index ccd772ca2a5..9f57c1543cf 100644 > > --- a/gdbsupport/safe-iterator.h > > +++ b/gdbsupport/safe-iterator.h > > @@ -136,4 +136,110 @@ class basic_safe_range > > Range m_range; > > }; > > > > +/* A reverse basic_safe_iterator. See basic_safe_iterator for intende= d use. */ > > + > > +template > > +class basic_safe_reverse_iterator > > +{ > > +public: > > + typedef basic_safe_reverse_iterator self_type; > > + typedef typename Iterator::value_type value_type; > > + typedef typename Iterator::reference reference; > > + typedef typename Iterator::pointer pointer; > > + typedef typename Iterator::iterator_category iterator_category; > > + typedef typename Iterator::difference_type difference_type; > > + > > + /* Construct the iterator using ARG, and construct the end iterator > > + using ARG2. */ > > + template > > + explicit basic_safe_reverse_iterator (Arg &&arg, Arg &&arg2) > > + : m_begin (std::forward (arg)), > > + m_end (std::forward (arg2)), > > + m_it (m_end), > > + m_next (m_end) > > + { > > + /* M_IT and M_NEXT are initialized as one-past-end. Set M_IT to p= oint > > + to the last element and set M_NEXT to point to the second last = element, > > + if such elements exist. */ > > + if (m_it !=3D m_begin) > > + { > > + --m_it; > > + > > + if (m_it !=3D m_begin) > > + { > > + --m_next; > > + --m_next; > > + } > > + } > > + } > > + > > + typename gdb::invoke_result::type > > + operator* () const > > + { return *m_it; } > > + > > + self_type &operator++ () > > + { > > + m_it =3D m_next; > > + > > + if (m_it !=3D m_end) > > + { > > + /* Use M_BEGIN only if we sure that it is valid. */ > > + if (m_it =3D=3D m_begin) > > + m_next =3D m_end; > > + else > > + --m_next; > > + } > > + > > + return *this; > > + } > > + > > + bool operator=3D=3D (const self_type &other) const > > + { return m_it =3D=3D other.m_it; } > > + > > + bool operator!=3D (const self_type &other) const > > + { return m_it !=3D other.m_it; } > > + > > +private: > > + /* The first element. */ > > + Iterator m_begin {}; > > + > > + /* A one-past-end iterator. */ > > + Iterator m_end {}; > > + > > + /* The current element. */ > > + Iterator m_it {}; > > + > > + /* The next element. Always one element ahead of M_IT. */ > > + Iterator m_next {}; > > +}; > > + > > +/* A range adapter that wraps a forward range, and then returns > > + safe reverse iterators wrapping the original range's iterators. */ > > + > > +template > > +class basic_safe_reverse_range > > +{ > > +public: > > + > > + typedef basic_safe_reverse_iterator iterat= or; > > + > > + explicit basic_safe_reverse_range (Range range) > > + : m_range (range) > > + { > > + } > > + > > + iterator begin () > > + { > > + return iterator (m_range.begin (), m_range.end ()); > > + } > > + > > + iterator end () > > + { > > + return iterator (m_range.end (), m_range.end ()); > > + } > > + > > +private: > > + > > + Range m_range; > > +}; > > #endif /* COMMON_SAFE_ITERATOR_H */ > > -- > > 2.41.0 > >