From: "François Dumont" <frs.dumont@gmail.com>
To: "libstdc++@gcc.gnu.org" <libstdc++@gcc.gnu.org>
Cc: gcc-patches <gcc-patches@gcc.gnu.org>
Subject: Re: [PATCH][_GLIBCXX_DEBUG] Add basic_string::starts_with/ends_with checks
Date: Mon, 15 Aug 2022 22:26:50 +0200 [thread overview]
Message-ID: <0ec115b4-917a-403e-88fe-6a9360659bd8@gmail.com> (raw)
In-Reply-To: <f41daeb7-45dc-4e5c-ce18-17306171a837@gmail.com>
[-- Attachment #1: Type: text/plain, Size: 2273 bytes --]
With the patch !
On 14/08/22 17:32, François Dumont wrote:
> I think we can add those checks.
>
> Note that I wonder if it was needed as in basic_string_view I see
> usages of __attribute__((__nonnull__)). But running the test I saw no
> impact even after I try to apply this attribute to the
> starts_with/ends_with methods themselves.
>
> Also note that several checks like the ones I am adding here are
> XFAILS when using 'make check' because of the segfault rather than on
> a proper debug checks. Would you prefer to add dg-require-debug-mode
> to those ?
>
> libstdc++: [_GLIBCXX_DEBUG] Add
> basic_string::starts_with/ends_with checks
>
> Add simple checks on C string parameters which should not be null.
>
> Review null string checks to show:
> _String != nullptr
>
> rather than:
> _String != 0
>
> libstdc++-v3/ChangeLog:
>
> * include/bits/basic_string.h (starts_with, ends_with):
> Add __glibcxx_check_string.
> * include/bits/cow_string.h (starts_with, ends_with):
> Likewise.
> * include/debug/debug.h: Use nullptr rather than '0' in
> checks in C++11.
> * include/debug/string: Likewise.
> *
> testsuite/21_strings/basic_string/operations/ends_with/char.cc: Use
> __gnu_test::string.
> *
> testsuite/21_strings/basic_string/operations/ends_with/wchar_t.cc: Use
> __gnu_test::wstring.
> *
> testsuite/21_strings/basic_string/operations/starts_with/wchar_t.cc:
> Use __gnu_test::wstring.
> *
> testsuite/21_strings/basic_string/operations/starts_with/char.cc: Use
> __gnu_test::string.
> *
> testsuite/21_strings/basic_string/operations/ends_with/char_neg.cc:
> New test.
> *
> testsuite/21_strings/basic_string/operations/ends_with/wchar_t_neg.cc:
> New test.
> *
> testsuite/21_strings/basic_string/operations/starts_with/char_neg.cc:
> New test.
> *
> testsuite/21_strings/basic_string/operations/starts_with/wchar_t_neg.cc:
> New test.
>
> Tested under linux normal and debug modes.
>
> François
>
>
[-- Attachment #2: debug_string_starts_ends_with.patch --]
[-- Type: text/x-patch, Size: 14820 bytes --]
diff --git a/libstdc++-v3/include/bits/basic_string.h b/libstdc++-v3/include/bits/basic_string.h
index b04fba95678..d06330e6c48 100644
--- a/libstdc++-v3/include/bits/basic_string.h
+++ b/libstdc++-v3/include/bits/basic_string.h
@@ -3402,7 +3402,10 @@ _GLIBCXX_BEGIN_NAMESPACE_CXX11
constexpr bool
starts_with(const _CharT* __x) const noexcept
- { return __sv_type(this->data(), this->size()).starts_with(__x); }
+ {
+ __glibcxx_requires_string(__x);
+ return __sv_type(this->data(), this->size()).starts_with(__x);
+ }
constexpr bool
ends_with(basic_string_view<_CharT, _Traits> __x) const noexcept
@@ -3414,7 +3417,10 @@ _GLIBCXX_BEGIN_NAMESPACE_CXX11
constexpr bool
ends_with(const _CharT* __x) const noexcept
- { return __sv_type(this->data(), this->size()).ends_with(__x); }
+ {
+ __glibcxx_requires_string(__x);
+ return __sv_type(this->data(), this->size()).ends_with(__x);
+ }
#endif // C++20
#if __cplusplus > 202002L
diff --git a/libstdc++-v3/include/bits/cow_string.h b/libstdc++-v3/include/bits/cow_string.h
index f16e33ac1ef..59b36a1006a 100644
--- a/libstdc++-v3/include/bits/cow_string.h
+++ b/libstdc++-v3/include/bits/cow_string.h
@@ -3014,7 +3014,10 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
bool
starts_with(const _CharT* __x) const noexcept
- { return __sv_type(this->data(), this->size()).starts_with(__x); }
+ {
+ __glibcxx_requires_string(__x);
+ return __sv_type(this->data(), this->size()).starts_with(__x);
+ }
bool
ends_with(basic_string_view<_CharT, _Traits> __x) const noexcept
@@ -3026,7 +3029,10 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
bool
ends_with(const _CharT* __x) const noexcept
- { return __sv_type(this->data(), this->size()).ends_with(__x); }
+ {
+ __glibcxx_requires_string(__x);
+ return __sv_type(this->data(), this->size()).ends_with(__x);
+ }
#endif // C++20
#if __cplusplus > 202011L
diff --git a/libstdc++-v3/include/debug/debug.h b/libstdc++-v3/include/debug/debug.h
index 28e250f0c50..f4233760426 100644
--- a/libstdc++-v3/include/debug/debug.h
+++ b/libstdc++-v3/include/debug/debug.h
@@ -118,10 +118,17 @@ namespace __gnu_debug
__glibcxx_check_heap(_First,_Last)
# define __glibcxx_requires_heap_pred(_First,_Last,_Pred) \
__glibcxx_check_heap_pred(_First,_Last,_Pred)
-# define __glibcxx_requires_string(_String) \
+# if __cplusplus < 201103L
+# define __glibcxx_requires_string(_String) \
_GLIBCXX_DEBUG_PEDASSERT(_String != 0)
-# define __glibcxx_requires_string_len(_String,_Len) \
+# define __glibcxx_requires_string_len(_String,_Len) \
_GLIBCXX_DEBUG_PEDASSERT(_String != 0 || _Len == 0)
+# else
+# define __glibcxx_requires_string(_String) \
+ _GLIBCXX_DEBUG_PEDASSERT(_String != nullptr)
+# define __glibcxx_requires_string_len(_String,_Len) \
+ _GLIBCXX_DEBUG_PEDASSERT(_String != nullptr || _Len == 0)
+# endif
# define __glibcxx_requires_irreflexive(_First,_Last) \
__glibcxx_check_irreflexive(_First,_Last)
# define __glibcxx_requires_irreflexive2(_First,_Last) \
diff --git a/libstdc++-v3/include/debug/string b/libstdc++-v3/include/debug/string
index c32eb41eacd..f02c74431ed 100644
--- a/libstdc++-v3/include/debug/string
+++ b/libstdc++-v3/include/debug/string
@@ -50,14 +50,25 @@
#endif
#ifdef _GLIBCXX_DEBUG_PEDANTIC
-# define __glibcxx_check_string(_String) \
+# if __cplusplus < 201103L
+# define __glibcxx_check_string(_String) \
_GLIBCXX_DEBUG_VERIFY_STR_COND_AT(_String != 0, \
__FILE__, __LINE__, \
__PRETTY_FUNCTION__);
-# define __glibcxx_check_string_len(_String,_Len) \
+# define __glibcxx_check_string_len(_String,_Len) \
_GLIBCXX_DEBUG_VERIFY_STR_COND_AT(_String != 0 || _Len == 0, \
__FILE__, __LINE__, \
__PRETTY_FUNCTION__);
+# else
+# define __glibcxx_check_string(_String) \
+ _GLIBCXX_DEBUG_VERIFY_STR_COND_AT(_String != nullptr, \
+ __FILE__, __LINE__, \
+ __PRETTY_FUNCTION__);
+# define __glibcxx_check_string_len(_String,_Len) \
+ _GLIBCXX_DEBUG_VERIFY_STR_COND_AT(_String != nullptr || _Len == 0, \
+ __FILE__, __LINE__, \
+ __PRETTY_FUNCTION__);
+# endif
#else
# define __glibcxx_check_string(_String)
# define __glibcxx_check_string_len(_String,_Len)
@@ -75,8 +86,13 @@ namespace __gnu_debug
const char* __function __attribute__((__unused__)))
{
#ifdef _GLIBCXX_DEBUG_PEDANTIC
+# if __cplusplus < 201103L
_GLIBCXX_DEBUG_VERIFY_STR_COND_AT(__s != 0 || __n == 0,
__file, __line, __function);
+# else
+ _GLIBCXX_DEBUG_VERIFY_STR_COND_AT(__s != nullptr || __n == 0,
+ __file, __line, __function);
+# endif
#endif
return __s;
}
@@ -90,8 +106,13 @@ namespace __gnu_debug
const char* __function __attribute__((__unused__)))
{
#ifdef _GLIBCXX_DEBUG_PEDANTIC
+# if __cplusplus < 201103L
_GLIBCXX_DEBUG_VERIFY_STR_COND_AT(__s != 0,
__file, __line, __function);
+# else
+ _GLIBCXX_DEBUG_VERIFY_STR_COND_AT(__s != nullptr,
+ __file, __line, __function);
+# endif
#endif
return __s;
}
@@ -1033,6 +1054,26 @@ namespace __gnu_debug
return _Base::compare(__pos1, __n1, __s, __n2);
}
+#if __cplusplus >= 202002L
+ using _Base::starts_with;
+
+ __attribute__((__nonnull__)) constexpr bool
+ starts_with(const _CharT* __x) const noexcept
+ {
+ __glibcxx_check_string(__x);
+ return _Base::starts_with(__x);
+ }
+
+ using _Base::ends_with;
+
+ constexpr bool
+ ends_with(const _CharT* __x) const noexcept
+ {
+ __glibcxx_check_string(__x);
+ return _Base::ends_with(__x);
+ }
+#endif
+
_Base&
_M_base() _GLIBCXX_NOEXCEPT { return *this; }
diff --git a/libstdc++-v3/testsuite/21_strings/basic_string/operations/ends_with/char.cc b/libstdc++-v3/testsuite/21_strings/basic_string/operations/ends_with/char.cc
index cfe18e0186c..3cf85121e36 100644
--- a/libstdc++-v3/testsuite/21_strings/basic_string/operations/ends_with/char.cc
+++ b/libstdc++-v3/testsuite/21_strings/basic_string/operations/ends_with/char.cc
@@ -20,7 +20,7 @@
// basic_string ends_with
-#include <string>
+#include <testsuite_string.h>
#include <testsuite_hooks.h>
void
@@ -31,7 +31,7 @@ test01()
const char cstr_suf2[] = ".rgb";
const std::string_view sv_suf2(".rgb");
- const std::string s_test("slugs/slimy.jpg");
+ const __gnu_test::string s_test("slugs/slimy.jpg");
const auto cstr_in_slugs = s_test.ends_with(cstr_suf);
VERIFY( cstr_in_slugs );
diff --git a/libstdc++-v3/testsuite/21_strings/basic_string/operations/ends_with/char_neg.cc b/libstdc++-v3/testsuite/21_strings/basic_string/operations/ends_with/char_neg.cc
new file mode 100644
index 00000000000..7a7b8dd077d
--- /dev/null
+++ b/libstdc++-v3/testsuite/21_strings/basic_string/operations/ends_with/char_neg.cc
@@ -0,0 +1,37 @@
+// Copyright (C) 2022 Free Software Foundation, Inc.
+//
+// This file is part of the GNU ISO C++ Library. This library is free
+// software; you can redistribute it and/or modify it under the
+// terms of the GNU General Public License as published by the
+// Free Software Foundation; either version 3, or (at your option)
+// any later version.
+
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License along
+// with this library; see the file COPYING3. If not see
+// <http://www.gnu.org/licenses/>.
+//
+// { dg-options "-std=gnu++2a -O0" }
+// { dg-do run { target c++2a xfail *-*-* } }
+
+#define _GLIBCXX_DEBUG_PEDANTIC
+
+#include <testsuite_string.h>
+
+void
+test01()
+{
+ const __gnu_test::string s_test("slugs/slimy.jpg");
+ s_test.ends_with(nullptr);
+}
+
+int
+main()
+{
+ test01();
+ return 0;
+}
diff --git a/libstdc++-v3/testsuite/21_strings/basic_string/operations/ends_with/wchar_t.cc b/libstdc++-v3/testsuite/21_strings/basic_string/operations/ends_with/wchar_t.cc
index d27e8246fb8..70b522ff69e 100644
--- a/libstdc++-v3/testsuite/21_strings/basic_string/operations/ends_with/wchar_t.cc
+++ b/libstdc++-v3/testsuite/21_strings/basic_string/operations/ends_with/wchar_t.cc
@@ -20,7 +20,7 @@
// basic_string ends_with
-#include <string>
+#include <testsuite_string.h>
#include <testsuite_hooks.h>
void
@@ -31,7 +31,7 @@ test01()
const wchar_t cstr_suf2[] = L".rgb";
const std::wstring_view sv_suf2(L".rgb");
- const std::wstring s_test(L"slugs/slimy.jpg");
+ const __gnu_test::wstring s_test(L"slugs/slimy.jpg");
const auto cstr_in_slugs = s_test.ends_with(cstr_suf);
VERIFY( cstr_in_slugs );
diff --git a/libstdc++-v3/testsuite/21_strings/basic_string/operations/ends_with/wchar_t_neg.cc b/libstdc++-v3/testsuite/21_strings/basic_string/operations/ends_with/wchar_t_neg.cc
new file mode 100644
index 00000000000..a6881bf406b
--- /dev/null
+++ b/libstdc++-v3/testsuite/21_strings/basic_string/operations/ends_with/wchar_t_neg.cc
@@ -0,0 +1,37 @@
+// Copyright (C) 2022 Free Software Foundation, Inc.
+//
+// This file is part of the GNU ISO C++ Library. This library is free
+// software; you can redistribute it and/or modify it under the
+// terms of the GNU General Public License as published by the
+// Free Software Foundation; either version 3, or (at your option)
+// any later version.
+
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License along
+// with this library; see the file COPYING3. If not see
+// <http://www.gnu.org/licenses/>.
+//
+// { dg-options "-std=gnu++2a -O0" }
+// { dg-do run { target c++2a xfail *-*-* } }
+
+#define _GLIBCXX_DEBUG_PEDANTIC
+
+#include <testsuite_string.h>
+
+void
+test01()
+{
+ const __gnu_test::wstring s_test(L"slugs/slimy.jpg");
+ s_test.ends_with(nullptr);
+}
+
+int
+main()
+{
+ test01();
+ return 0;
+}
diff --git a/libstdc++-v3/testsuite/21_strings/basic_string/operations/starts_with/char.cc b/libstdc++-v3/testsuite/21_strings/basic_string/operations/starts_with/char.cc
index 5c0b3afc0b6..dddf51cee16 100644
--- a/libstdc++-v3/testsuite/21_strings/basic_string/operations/starts_with/char.cc
+++ b/libstdc++-v3/testsuite/21_strings/basic_string/operations/starts_with/char.cc
@@ -20,7 +20,7 @@
// basic_string begins_with
-#include <string>
+#include <testsuite_string.h>
#include <testsuite_hooks.h>
void
@@ -31,7 +31,7 @@ test01()
const char cstr_dir2[] = "worms/";
const std::string_view sv_dir2("worms/");
- const std::string s_test("slugs/slimy.jpg");
+ const __gnu_test::string s_test("slugs/slimy.jpg");
const auto cstr_in_slugs = s_test.starts_with(cstr_dir);
VERIFY( cstr_in_slugs );
diff --git a/libstdc++-v3/testsuite/21_strings/basic_string/operations/starts_with/char_neg.cc b/libstdc++-v3/testsuite/21_strings/basic_string/operations/starts_with/char_neg.cc
new file mode 100644
index 00000000000..f357aef2289
--- /dev/null
+++ b/libstdc++-v3/testsuite/21_strings/basic_string/operations/starts_with/char_neg.cc
@@ -0,0 +1,37 @@
+// Copyright (C) 2022 Free Software Foundation, Inc.
+//
+// This file is part of the GNU ISO C++ Library. This library is free
+// software; you can redistribute it and/or modify it under the
+// terms of the GNU General Public License as published by the
+// Free Software Foundation; either version 3, or (at your option)
+// any later version.
+
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License along
+// with this library; see the file COPYING3. If not see
+// <http://www.gnu.org/licenses/>.
+//
+// { dg-options "-std=gnu++2a -O0" }
+// { dg-do run { target c++2a xfail *-*-* } }
+
+#define _GLIBCXX_DEBUG_PEDANTIC
+
+#include <testsuite_string.h>
+
+void
+test01()
+{
+ const __gnu_test::string s_test("slugs/slimy.jpg");
+ s_test.starts_with(nullptr);
+}
+
+int
+main()
+{
+ test01();
+ return 0;
+}
diff --git a/libstdc++-v3/testsuite/21_strings/basic_string/operations/starts_with/wchar_t.cc b/libstdc++-v3/testsuite/21_strings/basic_string/operations/starts_with/wchar_t.cc
index eda73212ea0..747b23ae5c2 100644
--- a/libstdc++-v3/testsuite/21_strings/basic_string/operations/starts_with/wchar_t.cc
+++ b/libstdc++-v3/testsuite/21_strings/basic_string/operations/starts_with/wchar_t.cc
@@ -20,7 +20,7 @@
// basic_string begins_with
-#include <string>
+#include <testsuite_string.h>
#include <testsuite_hooks.h>
void
@@ -31,7 +31,7 @@ test01()
const wchar_t cstr_dir2[] = L"worms/";
const std::wstring_view sv_dir2(L"worms/");
- const std::wstring s_test(L"slugs/slimy.jpg");
+ const __gnu_test::wstring s_test(L"slugs/slimy.jpg");
const auto cstr_in_slugs = s_test.starts_with(cstr_dir);
VERIFY( cstr_in_slugs );
diff --git a/libstdc++-v3/testsuite/21_strings/basic_string/operations/starts_with/wchar_t_neg.cc b/libstdc++-v3/testsuite/21_strings/basic_string/operations/starts_with/wchar_t_neg.cc
new file mode 100644
index 00000000000..90065a459b6
--- /dev/null
+++ b/libstdc++-v3/testsuite/21_strings/basic_string/operations/starts_with/wchar_t_neg.cc
@@ -0,0 +1,37 @@
+// Copyright (C) 2022 Free Software Foundation, Inc.
+//
+// This file is part of the GNU ISO C++ Library. This library is free
+// software; you can redistribute it and/or modify it under the
+// terms of the GNU General Public License as published by the
+// Free Software Foundation; either version 3, or (at your option)
+// any later version.
+
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License along
+// with this library; see the file COPYING3. If not see
+// <http://www.gnu.org/licenses/>.
+//
+// { dg-options "-std=gnu++2a -O0" }
+// { dg-do run { target c++2a xfail *-*-* } }
+
+#define _GLIBCXX_DEBUG_PEDANTIC
+
+#include <testsuite_string.h>
+
+void
+test01()
+{
+ const __gnu_test::wstring s_test(L"slugs/slimy.jpg");
+ s_test.starts_with(nullptr);
+}
+
+int
+main()
+{
+ test01();
+ return 0;
+}
next prev parent reply other threads:[~2022-08-15 20:26 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-14 15:32 François Dumont
2022-08-15 20:26 ` François Dumont [this message]
2022-08-25 16:11 ` François Dumont
2022-08-26 9:33 ` Jonathan Wakely
2022-08-26 9:31 ` Jonathan Wakely
2022-08-31 4:38 ` [PATCH][_GLIBCXX_DEBUG] Review null string assertions (was: Add basic_string::starts_with/ends_with checks) François Dumont
2022-08-31 9:25 ` Jonathan Wakely
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=0ec115b4-917a-403e-88fe-6a9360659bd8@gmail.com \
--to=frs.dumont@gmail.com \
--cc=gcc-patches@gcc.gnu.org \
--cc=libstdc++@gcc.gnu.org \
/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).