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.129.124]) by sourceware.org (Postfix) with ESMTPS id A2ED43870854 for ; Wed, 20 Dec 2023 14:57:55 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org A2ED43870854 Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=redhat.com ARC-Filter: OpenARC Filter v1.0.0 sourceware.org A2ED43870854 Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=170.10.129.124 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1703084278; cv=none; b=Gj+bmXaR5KHCa+jQYNUXkhoOvJEJrNzn/u6ZpD4i/x/btYHl+AEeaMCdi9yDALj98PbRYmOOCLHJf7omZZKoDjNEJDmRxsxZ7z1Q3xonPKCrc/BAwBBvq7cNTqCsAmdkX/0ct6U/e+GcvIilE8wa2M1VEEATzd0DuvTNpo+g4eA= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1703084278; c=relaxed/simple; bh=KTnle19KBsfi4u4+HYcbo1T0a1Kxw9aZY9t87pZ7M/A=; h=DKIM-Signature:MIME-Version:From:Date:Message-ID:Subject:To; b=uSJugqfafxwa7DpO0BiU6k6Y4bllRLw7nwtYxwLVjliaLE4tHaXutTMo8xk+ZzKDyGMcH9ClVdhmxL4OEwRpExqDNluaiXR0ueJNdhZGm3PI6Gzpw7UhOvT1OCaWs95IomLk7/T1rbgGb1DlaSVmcvB6nO7Bbxe8ltHUBT4wlzQ= ARC-Authentication-Results: i=1; server2.sourceware.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1703084275; 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=g6vciZAZhQI+eC4rde4b+2Ha9PQOg++RNrsRlIqpHuE=; b=UO1Pp+9M8ogcA2c15SPru9tsU3uUZrT/RNWKP8Tt1WmTTPzv01PTnP3x7Ta2RPcA82OYdT ktYLsHq/byYtkId1QYD4SOyqqt47zgAM6ay+7VF+KZ4O7rUICuUpmQd8ADTH1+JQTNEFOH e+gFiEh2c/3bFmls+3hvrzKreAqJEgg= Received: from mail-pg1-f198.google.com (mail-pg1-f198.google.com [209.85.215.198]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-77-hfIwi8fQMjWFnHGtXT0Vug-1; Wed, 20 Dec 2023 09:57:53 -0500 X-MC-Unique: hfIwi8fQMjWFnHGtXT0Vug-1 Received: by mail-pg1-f198.google.com with SMTP id 41be03b00d2f7-5cdba9861b1so871841a12.1 for ; Wed, 20 Dec 2023 06:57:53 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1703084272; x=1703689072; 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=g6vciZAZhQI+eC4rde4b+2Ha9PQOg++RNrsRlIqpHuE=; b=mwUmyPMaY3ivqu16quIJ6qAvUNFL8523hLjCDNfpMAxxfM4KA3mSiGgzIpKvL/ptpV TM/HrlSZSeoj8wAv8EE7etDFQsGnqcmnHh9LMl6ifYMnshMoIWcfBx6O514dpVz9zi76 sG8P9orcQMYmj9Qhq31J0PGUvszWmTL8Q/bcG/j6zmkkJM8ZeiVbCvfVtIS5LZjyqMz0 Vk8kWfnOtMkOacwVhnwd7JNZ1X8I+d8bc943qNCQH+qTqG0tuPkmOXnps4hMrlBbTZsU iUMfY7fNzqEDz4FgZdOAPTriXC5HFnGXvY0TNXWkA9kb24Vb4MJ/0SxEMgn+qMupPEdi DLwQ== X-Gm-Message-State: AOJu0Yy/5WwurmkPCRG6IW3xVBEtTHTJ9Ur9tD8DgmgDvv3e+6MbXMxE 6KRCQaGRMRfhO7730j8k+PEtK4sIadBUWbQr03igQQ5QnnPR9VzpR3Bkhnkg4koCaYVYvhb6JCq JoVjoY179LHrNQqgn/X6a+kqdufXHQGepEkCLiqK97Zzz X-Received: by 2002:a17:90a:cc17:b0:28b:d6ea:91bd with SMTP id b23-20020a17090acc1700b0028bd6ea91bdmr464922pju.55.1703084272418; Wed, 20 Dec 2023 06:57:52 -0800 (PST) X-Google-Smtp-Source: AGHT+IGoygfXhcWoHirMMzHtU6gsiuVeEw6XZTjOi4CiEhrkcdfYyw4rCyx6YbgfIL9TJEbgd9KHkA5ZHAAa1zSpNb8= X-Received: by 2002:a17:90a:cc17:b0:28b:d6ea:91bd with SMTP id b23-20020a17090acc1700b0028bd6ea91bdmr464914pju.55.1703084272064; Wed, 20 Dec 2023 06:57:52 -0800 (PST) MIME-Version: 1.0 References: <20231028002008.1105723-1-amerey@redhat.com> <20231028002008.1105723-3-amerey@redhat.com> In-Reply-To: From: Aaron Merey Date: Wed, 20 Dec 2023 09:57:40 -0500 Message-ID: Subject: [PING*5][PATCH 2/4 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.5 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_H4,RCVD_IN_MSPIKE_WL,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 List-Id: Ping Thanks, Aaron On Tue, Dec 12, 2023 at 10:01=E2=80=AFAM Aaron Merey wr= ote: > > Ping > > Thanks, > Aaron > > On Thu, Nov 30, 2023 at 11:30=E2=80=AFAM Aaron Merey = wrote: > > > > Ping > > > > Thanks, > > Aaron > > > > On Mon, Nov 20, 2023 at 1:39=E2=80=AFPM Aaron Merey = wrote: > > > > > > Ping > > > > > > Thanks, > > > Aaron > > > > > > On Sun, Nov 12, 2023 at 3:20=E2=80=AFPM Aaron Merey wrote: > > > > > > > > Ping > > > > > > > > Thanks, > > > > Aaron > > > > > > > > On Fri, Oct 27, 2023 at 8:20=E2=80=AFPM 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 separ= ate > > > > > debug objfiles are placed into the list after the parent objfile, > > > > > instead of before. Additionally qf_require_partial_symbols now r= eturns > > > > > 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 loo= ping > > > > > 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 a= llows > > > > > objfiles to be removed from the objfiles_list in a loop without i= terator > > > > > invalidation. > > > > > > > > > > If a forward safe iterator were to be used, the deletion of an > > > > > objfile could invalidate the safe iterator's reference to the nex= t > > > > > objfile in the objfiles_list. This can happen when the deletion > > > > > of an objfile causes the deletion of a separate debug objfile tha= t > > > > > happens to the be next element in the objfiles_list. > > > > > > > > > > The standard reverse iterator is not suitable for safe objfile de= letion. > > > > > 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 9e8325ab803..a39fdc5a96d 100644 > > > > > --- a/gdb/jit.c > > > > > +++ b/gdb/jit.c > > > > > @@ -1240,11 +1240,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->add= r !=3D 0) > > > > > - objf->unlink (); > > > > > - } > > > > > + return (objf->jited_data !=3D nullptr) && (objf->jited_dat= a->addr !=3D 0); > > > > > + }); > > > > > } > > > > > > > > > > void > > > > > diff --git a/gdb/objfiles.c b/gdb/objfiles.c > > > > > index 8f085b1bb7c..9822c179962 100644 > > > > > --- a/gdb/objfiles.c > > > > > +++ b/gdb/objfiles.c > > > > > @@ -793,14 +793,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 alread= y, or will > > > > > be soon. */ > > > > > - > > > > > - if (!(objf->flags & OBJF_USERLOADED) && (objf->flags & OBJ= F_SHARED)) > > > > > - objf->unlink (); > > > > > - } > > > > > + return !(objf->flags & OBJF_USERLOADED) && (objf->flags & = OBJF_SHARED); > > > > > + }); > > > > > } > > > > > > > > > > > > > > > diff --git a/gdb/objfiles.h b/gdb/objfiles.h > > > > > index 4b8aa9bfcec..c20b63ceadf 100644 > > > > > --- a/gdb/objfiles.h > > > > > +++ b/gdb/objfiles.h > > > > > @@ -698,13 +698,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 839707e9d71..c0fca1dace7 100644 > > > > > --- a/gdb/progspace.c > > > > > +++ b/gdb/progspace.c > > > > > @@ -143,19 +143,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 (), objfil= es_list.end (), > > > > > [=3D] (const std::unique_ptr<::ob= jfile> &objf) > > > > > { > > > > > - return objf.get () =3D=3D befor= e; > > > > > + 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)); > > > > > } > > > > > } > > > > > > > > > > @@ -184,6 +184,17 @@ program_space::remove_objfile (struct objfil= e *objfile) > > > > > > > > > > /* 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 a22e427400e..17bb1710ccf 100644 > > > > > --- a/gdb/progspace.h > > > > > +++ b/gdb/progspace.h > > > > > @@ -214,28 +214,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 obj= files. > > > > > The basic use is in a foreach, like: > > > > > > > > > > for (objfile *objf : pspace->objfiles_safe ()) { ... } > > > > > > > > > > - This variant uses a basic_safe_iterator so that objfiles ca= n be > > > > > - deleted during iteration. */ > > > > > - objfiles_safe_range objfiles_safe () > > > > > + This variant uses a basic_safe_reverse_iterator so that obj= files > > > > > + can be deleted during iteration. > > > > > + > > > > > + The use of a reverse iterator helps ensure that separate de= bug > > > > > + objfiles are deleted before their parent objfile. This pre= vents > > > > > + iterator invalidation due to the deletion of a parent objfi= le. */ > > > > > + 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_lis= t.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); > > > > > @@ -250,6 +254,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 ad= dress > > > > > 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/testsu= ite/gdb.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(\= "${binfile}\")" \ > > > > > "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-iterato= r.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 i= ntended 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 ite= rator > > > > > + 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_I= T to point > > > > > + 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 iterator= s. */ > > > > > + > > > > > +template > > > > > +class basic_safe_reverse_range > > > > > +{ > > > > > +public: > > > > > + > > > > > + typedef basic_safe_reverse_iterator = iterator; > > > > > + > > > > > + 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 > > > > >