From e6a58aa8a70c7fd17d9930e7df8d158a7e3c8c8e Mon Sep 17 00:00:00 2001 From: Simon Marchi Date: Thu, 8 Mar 2018 18:04:46 -0500 Subject: [PATCH 1/1] Add xml_escape_text_append and use it [This patch should go on top of "linux_qxfer_libraries_svr4: Use std::string", I should have sent them together as a series.] I noticed that linux_qxfer_libraries_svr4 used xml_escape_text, which returns an std::string. That string is then copied into a larger buffer. It would be more efficient if we had a version of xml_escape_text which appended to an existing string instead of returning a new one. This is what this patch does. I manually verified that the output of linux_qxfer_libraries_svr4 didn't change before/after the patch. gdb/ChangeLog: * common/xml-utils.c (xml_escape_text): Move code to... (xml_escape_text_append): ... this new function. * common/xml-utils.h (xml_escape_text_append): New declaration. * unittests/xml-utils-selftests.c (test_xml_escape_text_append): New function. (_initialize_xml_utils): register test_xml_escape_text_append as a selftest. gdb/gdbserver/ChangeLog: * linux-low.c (linux_qxfer_libraries_svr4): Use xml_escape_text_append. --- gdb/ChangeLog | 10 ++++++++++ gdb/common/xml-utils.c | 27 +++++++++++++++++---------- gdb/common/xml-utils.h | 9 +++++++-- gdb/gdbserver/ChangeLog | 5 +++++ gdb/gdbserver/linux-low.c | 10 +++++----- gdb/unittests/xml-utils-selftests.c | 14 ++++++++++++++ 6 files changed, 58 insertions(+), 17 deletions(-) diff --git a/gdb/ChangeLog b/gdb/ChangeLog index f10476b4ca..0ee5178028 100644 --- a/gdb/ChangeLog +++ b/gdb/ChangeLog @@ -1,3 +1,13 @@ +2018-03-08 Simon Marchi + + * common/xml-utils.c (xml_escape_text): Move code to... + (xml_escape_text_append): ... this new function. + * common/xml-utils.h (xml_escape_text_append): New declaration. + * unittests/xml-utils-selftests.c (test_xml_escape_text_append): + New function. + (_initialize_xml_utils): register test_xml_escape_text_append as + a selftest. + 2018-03-07 Alan Hayward * defs.h: Remove MAX_REGISTER_SIZE. diff --git a/gdb/common/xml-utils.c b/gdb/common/xml-utils.c index aba1722cc0..3e1c2bfa7d 100644 --- a/gdb/common/xml-utils.c +++ b/gdb/common/xml-utils.c @@ -20,37 +20,44 @@ #include "common-defs.h" #include "xml-utils.h" -/* Return a string with special characters from TEXT replaced by entity - references. */ +/* See xml-utils.h. */ std::string xml_escape_text (const char *text) { std::string result; + xml_escape_text_append (&result, text); + + return result; +} + +/* See xml-utils.h. */ + +void +xml_escape_text_append (std::string *result, const char *text) +{ /* Expand the result. */ for (int i = 0; text[i] != '\0'; i++) switch (text[i]) { case '\'': - result += "'"; + *result += "'"; break; case '\"': - result += """; + *result += """; break; case '&': - result += "&"; + *result += "&"; break; case '<': - result += "<"; + *result += "<"; break; case '>': - result += ">"; + *result += ">"; break; default: - result += text[i]; + *result += text[i]; break; } - - return result; } diff --git a/gdb/common/xml-utils.h b/gdb/common/xml-utils.h index b874016334..3427ab246d 100644 --- a/gdb/common/xml-utils.h +++ b/gdb/common/xml-utils.h @@ -20,9 +20,14 @@ #ifndef XML_UTILS_H #define XML_UTILS_H -/* Return a malloc allocated string with special characters from TEXT - replaced by entity references. */ +/* Return a string with special characters from TEXT replaced by entity + references. */ extern std::string xml_escape_text (const char *text); +/* Append TEXT to RESULT, with special characters replaced by entity + references. */ + +extern void xml_escape_text_append (std::string *result, const char *text); + #endif diff --git a/gdb/gdbserver/ChangeLog b/gdb/gdbserver/ChangeLog index 33c0484de6..053cf17ee5 100644 --- a/gdb/gdbserver/ChangeLog +++ b/gdb/gdbserver/ChangeLog @@ -1,3 +1,8 @@ +2018-03-08 Simon Marchi + + * linux-low.c (linux_qxfer_libraries_svr4): Use + xml_escape_text_append. + 2018-03-08 Simon Marchi * linux-low.c (linux_qxfer_libraries_svr4): Use std::string. diff --git a/gdb/gdbserver/linux-low.c b/gdb/gdbserver/linux-low.c index c8bb1f5785..e64949504d 100644 --- a/gdb/gdbserver/linux-low.c +++ b/gdb/gdbserver/linux-low.c @@ -7136,12 +7136,12 @@ linux_qxfer_libraries_svr4 (const char *annex, unsigned char *readbuf, header_done = 1; } - std::string name = xml_escape_text ((char *) libname); - string_appendf (document, - "", - name.c_str (), (unsigned long) lm_addr, - (unsigned long) l_addr, (unsigned long) l_ld); + (unsigned long) lm_addr, (unsigned long) l_addr, + (unsigned long) l_ld); } } diff --git a/gdb/unittests/xml-utils-selftests.c b/gdb/unittests/xml-utils-selftests.c index 2457494d8c..1412773e18 100644 --- a/gdb/unittests/xml-utils-selftests.c +++ b/gdb/unittests/xml-utils-selftests.c @@ -33,6 +33,18 @@ static void test_xml_escape_text () SELF_CHECK (actual_output == expected_output); } +static void test_xml_escape_text_append () +{ + /* Make sure that we do indeed append. */ + std::string actual_output = "foo"; + const char *input = " &"; + const char *expected_output + = "foo<this isn't="xml"> &"; + xml_escape_text_append (&actual_output, input); + + SELF_CHECK (actual_output == expected_output); +} + } } @@ -41,4 +53,6 @@ _initialize_xml_utils () { selftests::register_test ("xml_escape_text", selftests::xml_utils::test_xml_escape_text); + selftests::register_test ("xml_escape_text_append", + selftests::xml_utils::test_xml_escape_text_append); } -- 2.34.1