[libcxx] Remove VLA from libcxx locale header

[DanielMcIntosh-IBM]

Summary

The buffer size (__nbuf) in num_put::do_put is currently not an
integral/core constant expression. As a result, __nar is a Variable Length
Array (VLA). VLAs are a GNU extension and not part of the base C++ standard, so
unless there is good reason to do so they probably shouldn't be used in any of
the standard library headers. The call to __iob.flags() is the only thing
keeping __nbuf from being a compile time constant, so the solution here is to
simply err on the side of caution and always allocate a buffer large enough to
fit the base prefix.

Note that, while the base prefix for hex (0x) is slightly longer than the
base prefix for octal (0), this isn't a concern. The difference in the space
needed for the value portion of the string is enough to make up for this.
(Unless we're working with small, oddly sized types such as a hypothetical
uint9_t, the space needed for the value portion in octal is at least 1 more
than the space needed for the value portion in hex).

This PR also adds constexpr to __nbuf to enforce compile time const-ness
going forward.

[Mordante]

Note that, while the base prefix for hex (0x) is slightly longer than the
base prefix for octal (0), this isn't a concern. The difference in the space
needed for the value portion of the string is enough to make up for this.

I'm also not concerned since that's the same behaviour as before.

Thanks for the cleanup, LGTM.
I see a lot of build failure on Runtime build node, I assume it's already fixed by D103533. Can you rebase to verify your patch to verify that indeed solve all issues with this patch on that node?

[• Quuxplusone]

libcxx/include/locale

1463

I wonder if this should be _LIBCPP_CONSTEXPR const (which seems redundant) or merely static const (for C++03 compatibility) or merely const. But I guess as long as it compiles it's fine any way.

[DanielMcIntosh-IBM]

rebase

[DanielMcIntosh-IBM]

libcxx/include/locale

1463

const and static const by themselves wont force __nbuf to be a compile-time constant. If __nbuf is not constant-initialized, then the __nbuf expression used to set the size of __nar will silently stop being an integral constant expression (it will stop satisfying exception a to rule 9 of what isn't a core constant expression). This is why we were able to use __iob.flags() in the initializer without generating any errors.

constexpr by itself would be enough, but can't be used prior to C++11, so we need to use _LIBCPP_CONSTEXPR. However, we still can't remove the const because pre-c++11, that would leave __nbuf with neither const nor constexpr, which would again stop __nbuf from satisfying exception a to rule 9.

While the _LIBCPP_CONSTEXPR isn't strictly necessary, it prevents future issues like this one by generating an error if __nbuf isn't a compile-time constant.

[Mordante]

Just FYI when we approve with the condition the CI is green after a rebase, you're free to land the patch after the CI passes.
So feel free to land the patch, or do you need somebody to commit it on your behalf?
If so please provide your name and e-mail address so we commit it on your behalf.

libcxx/include/locale

num_put<_CharT, _OutputIterator>::do_put(iter_type __s, ios_base& __iob,
                                          char_type __fl, long __v) const
 {
     // Stage 1 - Get number in narrow char
     char __fmt[6] = {'%', 0};
     const char* __len = "l";
     this->__format_int(__fmt+1, __len, true, __iob.flags());
     // Worst case is octal, with showbase enabled. Note that octal is always
     // printed as an unsigned value.
-    const unsigned __nbuf = (numeric_limits<unsigned long>::digits / 3)          // 1 char per 3 bits
-                            + ((numeric_limits<unsigned long>::digits % 3) != 0) // round up
-                            + ((__iob.flags() & ios_base::showbase) != 0)        // base prefix
-                            + 1;                                                 // terminating null character
+    _LIBCPP_CONSTEXPR const unsigned __nbuf
+        = (numeric_limits<unsigned long>::digits / 3)        // 1 char per 3 bits
+        + 2; // base prefix + terminating null character
     char __nar[__nbuf];
     int __nc = __libcpp_snprintf_l(__nar, sizeof(__nar), _LIBCPP_GET_C_LOCALE, __fmt, __v);
     char* __ne = __nar + __nc;
     char* __np = this->__identify_padding(__nar, __ne, __iob);
     // Stage 2 - Widen __nar while adding thousands separators
     char_type __o[2*(__nbuf-1) - 1];
     char_type* __op;  // pad here
     char_type* __oe;  // end of output
num_put<_CharT, _OutputIterator>::do_put(iter_type __s, ios_base& __iob,
                                          char_type __fl, long long __v) const
 {
     // Stage 1 - Get number in narrow char
     char __fmt[8] = {'%', 0};
     const char* __len = "ll";
     this->__format_int(__fmt+1, __len, true, __iob.flags());
     // Worst case is octal, with showbase enabled. Note that octal is always
     // printed as an unsigned value.
-    const unsigned __nbuf = (numeric_limits<unsigned long long>::digits / 3)          // 1 char per 3 bits
-                            + ((numeric_limits<unsigned long long>::digits % 3) != 0) // round up
-                            + ((__iob.flags() & ios_base::showbase) != 0)             // base prefix
-                            + 1;                                                      // terminating null character
+    _LIBCPP_CONSTEXPR const unsigned __nbuf
+        = (numeric_limits<unsigned long long>::digits / 3)        // 1 char per 3 bits
+        + 2; // base prefix + terminating null character
     char __nar[__nbuf];
     int __nc = __libcpp_snprintf_l(__nar, sizeof(__nar), _LIBCPP_GET_C_LOCALE, __fmt, __v);
     char* __ne = __nar + __nc;
     char* __np = this->__identify_padding(__nar, __ne, __iob);
     // Stage 2 - Widen __nar while adding thousands separators
     char_type __o[2*(__nbuf-1) - 1];
     char_type* __op;  // pad here
     char_type* __oe;  // end of output
     this->__widen_and_group_int(__nar, __np, __ne, __o, __op, __oe, __iob.getloc());
     // [__o, __oe) contains thousands_sep'd wide number
     // Stage 3 & 4
     return __pad_and_output(__s, __o, __op, __oe, __iob, __fl);
 }
 
 template <class _CharT, class _OutputIterator>
 _OutputIterator
 num_put<_CharT, _OutputIterator>::do_put(iter_type __s, ios_base& __iob,
                                          char_type __fl, unsigned long __v) const
 {
     // Stage 1 - Get number in narrow char
     char __fmt[6] = {'%', 0};
     const char* __len = "l";
     this->__format_int(__fmt+1, __len, false, __iob.flags());
     // Worst case is octal, with showbase enabled.
-    const unsigned __nbuf = (numeric_limits<unsigned long>::digits / 3)          // 1 char per 3 bits
-                            + ((numeric_limits<unsigned long>::digits % 3) != 0) // round up
-                            + ((__iob.flags() & ios_base::showbase) != 0)        // base prefix
-                            + 1;                                                 // terminating null character
+    _LIBCPP_CONSTEXPR const unsigned __nbuf
+        = (numeric_limits<unsigned long>::digits / 3)        // 1 char per 3 bits
+        + 2; // base prefix + terminating null character
     char __nar[__nbuf];
     int __nc = __libcpp_snprintf_l(__nar, sizeof(__nar), _LIBCPP_GET_C_LOCALE, __fmt, __v);
     char* __ne = __nar + __nc;
     char* __np = this->__identify_padding(__nar, __ne, __iob);
     // Stage 2 - Widen __nar while adding thousands separators
     char_type __o[2*(__nbuf-1) - 1];
     char_type* __op;  // pad here
     char_type* __oe;  // end of output
     this->__widen_and_group_int(__nar, __np, __ne, __o, __op, __oe, __iob.getloc());
     // [__o, __oe) contains thousands_sep'd wide number
     // Stage 3 & 4
     return __pad_and_output(__s, __o, __op, __oe, __iob, __fl);
 }
 
 template <class _CharT, class _OutputIterator>
 _OutputIterator
 num_put<_CharT, _OutputIterator>::do_put(iter_type __s, ios_base& __iob,
                                          char_type __fl, unsigned long long __v) const
 {
     // Stage 1 - Get number in narrow char
     char __fmt[8] = {'%', 0};
     const char* __len = "ll";
     this->__format_int(__fmt+1, __len, false, __iob.flags());
     // Worst case is octal, with showbase enabled.
-    const unsigned __nbuf = (numeric_limits<unsigned long long>::digits / 3)          // 1 char per 3 bits
-                            + ((numeric_limits<unsigned long long>::digits % 3) != 0) // round up
-                            + ((__iob.flags() & ios_base::showbase) != 0)             // base prefix
-                            + 1;                                                      // terminating null character
+    _LIBCPP_CONSTEXPR const unsigned __nbuf
+        = (numeric_limits<unsigned long long>::digits / 3)        // 1 char per 3 bits
+        + 2; // base prefix + terminating null character
     char __nar[__nbuf];
     int __nc = __libcpp_snprintf_l(__nar, sizeof(__nar), _LIBCPP_GET_C_LOCALE, __fmt, __v);
     char* __ne = __nar + __nc;
     char* __np = this->__identify_padding(__nar, __ne, __iob);
     // Stage 2 - Widen __nar while adding thousands separators
     char_type __o[2*(__nbuf-1) - 1];
     char_type* __op;  // pad here
     char_type* __oe;  // end of output