From: Kevin Buettner <kevinb@redhat.com>
To: Tom de Vries <tdevries@suse.de>
Cc: gdb-patches@sourceware.org
Subject: Re: [PATCH] Throw error when creating an overly large gdb-index file
Date: Thu, 14 Sep 2023 17:22:24 -0700 [thread overview]
Message-ID: <20230914172224.68a2d70c@f37-zws-nv> (raw)
In-Reply-To: <e4b62fde-2bbe-2e9a-6f85-8dfce011e189@suse.de>
On Sat, 9 Sep 2023 10:20:19 +0200
Tom de Vries <tdevries@suse.de> wrote:
> On 9/9/23 04:55, Kevin Buettner via Gdb-patches wrote:
> > I wish I could provide a test case, but due to the sizes of both the
> > input and output files, I think that testing resources would be strained
> > or exceeded in many environments.
>
> How about this unit test approach? This fails on master, and could be
> updated to catch the error thrown by the patch.
I like it. I made several tweaks resulting in the version below.
Does it look okay to you?
From 1999dc14bf8c498c3f0db83eeb8f7e6d7376e8ff Mon Sep 17 00:00:00 2001
From: Tom de Vries <tdevries@suse.de>
Date: Sat, 9 Sep 2023 10:15:01 +0200
Subject: [PATCH] Add unit test for overly large gdb-index file
This commit adds a test which checks that write_gdb_index_1 will throw
an error when the size of the file would exceed the maximum value
capable of being represented by 'offset_type'.
Co-Authored-By: Kevin Buettner <kevinb@redhat.com>
diff --git a/gdb/dwarf2/index-write.c b/gdb/dwarf2/index-write.c
index 3827a810130..fd9605700c8 100644
--- a/gdb/dwarf2/index-write.c
+++ b/gdb/dwarf2/index-write.c
@@ -137,7 +137,7 @@ class data_buf
}
/* Return the size of the buffer. */
- size_t size () const
+ virtual size_t size () const
{
return m_vec.size ();
}
@@ -1117,6 +1117,9 @@ write_gdbindex_1 (FILE *out_file,
if (total_len > max_size)
error (_("gdb-index maximum file size of %zu exceeded"), max_size);
+ if (out_file == nullptr)
+ return;
+
contents.file_write (out_file);
cu_list.file_write (out_file);
types_cu_list.file_write (out_file);
@@ -1537,10 +1540,70 @@ save_gdb_index_command (const char *arg, int from_tty)
}
}
+#if GDB_SELF_TEST
+#include "gdbsupport/selftest.h"
+
+namespace selftests {
+
+class pretend_data_buf : public data_buf
+{
+public:
+ /* Set the pretend size. */
+ void set_pretend_size (size_t s) {
+ m_pretend_size = s;
+ }
+
+ /* Override size method of data_buf, returning the pretend size instead. */
+ size_t size () const override {
+ return m_pretend_size;
+ }
+
+private:
+ size_t m_pretend_size;
+};
+
+static void
+gdb_index ()
+{
+ pretend_data_buf cu_list;
+ pretend_data_buf types_cu_list;
+ pretend_data_buf addr_vec;
+ pretend_data_buf symtab_vec;
+ pretend_data_buf constant_pool;
+
+ /* Test that an overly large index will throw an error. */
+ symtab_vec.set_pretend_size (~(offset_type)0);
+ constant_pool.set_pretend_size (1);
+
+ bool saw_exception = false;
+ try
+ {
+ write_gdbindex_1 (nullptr, cu_list, types_cu_list, addr_vec,
+ symtab_vec, constant_pool);
+ }
+ catch (const gdb_exception_error &e)
+ {
+ SELF_CHECK (e.reason == RETURN_ERROR);
+ SELF_CHECK (e.error == GENERIC_ERROR);
+ SELF_CHECK (e.message->find (_("gdb-index maximum file size of"))
+ != std::string::npos);
+ SELF_CHECK (e.message->find (_("exceeded")) != std::string::npos);
+ saw_exception = true;
+ }
+ SELF_CHECK (saw_exception);
+}
+
+} /* selftests namespace. */
+#endif
+
void _initialize_dwarf_index_write ();
void
_initialize_dwarf_index_write ()
{
+#if GDB_SELF_TEST
+ selftests::register_test ("gdb_index", selftests::gdb_index);
+#endif
+
cmd_list_element *c = add_cmd ("gdb-index", class_files,
save_gdb_index_command, _("\
Save a gdb-index file.\n\
next prev parent reply other threads:[~2023-09-15 0:22 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-09-09 2:55 Kevin Buettner
2023-09-09 5:19 ` Kevin Buettner
2023-09-09 8:20 ` Tom de Vries
2023-09-15 0:22 ` Kevin Buettner [this message]
2023-09-15 9:09 ` Tom de Vries
2023-09-12 16:07 ` Tom Tromey
2023-09-13 2:43 ` Kevin Buettner
2023-09-13 14:24 ` Tom Tromey
2023-09-15 0:10 ` Kevin Buettner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230914172224.68a2d70c@f37-zws-nv \
--to=kevinb@redhat.com \
--cc=gdb-patches@sourceware.org \
--cc=tdevries@suse.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).