Various minor fixes for python 3

[saugustine]

Summary

Switch StdTuple printer from python 2-style "next" to python 3.

Nested iteration changed enough to make the original bitset iteration
code a bit trickier than it needs to be, so unnest.

The end node of a map iterator is sometimes hard to detect in isolation,
don't fail in that case.

[ldionne]

LGTM once CI passes. Thanks!

[mgorny]

I haven't tested it on main but on top of 12.0.0-rc1:

+ /usr/lib/ccache/bin/x86_64-pc-linux-gnu-clang -v --target=x86_64-pc-linux-gnu /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/libcxx/gdb/gdb_pretty_printer_test.sh.cpp -o /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx-12.0.0_rc1_build-abi_x86_64.amd64/test/libcxx/gdb/Output/gdb_pretty_printer_test.sh.cpp.dir/t.tmp.exe -include /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx-12.0.0_rc1_build-abi_x86_64.amd64/__config_site -include /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/support/nasty_macros.h -nostdinc++ -I/tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/include -I/tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx-12.0.0_rc1_build-abi_x86_64.amd64/include/c++build -D__STDC_FORMAT_MACROS -D__STDC_LIMIT_MACROS -D__STDC_CONSTANT_MACROS -I/tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/support -D_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER -std=c++2b -Werror -Wall -Wextra -Wshadow -Wno-unused-command-line-argument -Wno-attributes -Wno-pessimizing-move -Wno-c++11-extensions -Wno-user-defined-literals -Wno-noexcept-type -Wno-atomic-alignment -Wsign-compare -Wunused-variable -Wunused-parameter -Wunreachable-code -Wno-unused-local-typedef -D_LIBCPP_DISABLE_AVAILABILITY -fcoroutines-ts -Werror=thread-safety -Wuser-defined-warnings -fmodules-cache-path=/tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx-12.0.0_rc1_build-abi_x86_64.amd64/test/libcxx/gdb/Output/gdb_pretty_printer_test.sh.cpp.dir/t.tmp/ModuleCache -Wno-macro-redefined -D_LIBCPP_HAS_THREAD_API_PTHREAD -Wno-macro-redefined -D_LIBCPP_ABI_VERSION=1 -g -L/tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx-12.0.0_rc1_build-abi_x86_64.amd64/lib64 -Wl,-rpath,/tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx-12.0.0_rc1_build-abi_x86_64.amd64/lib64 -nodefaultlibs -lc++ -lc++abi -lm -lgcc_s -lgcc -lpthread -lc -lgcc_s -lgcc -latomic -lc++experimental
clang version 12.0.0
Target: x86_64-pc-linux-gnu
Thread model: posix
InstalledDir: /usr/lib/llvm/12/bin
Selected GCC installation: /usr/lib/gcc/x86_64-pc-linux-gnu/9.3.0
Candidate multilib: .;@m64
Candidate multilib: 32;@m32
Candidate multilib: x32;@mx32
Selected multilib: .;@m64
 "/usr/lib/llvm/12/bin/clang-12" -cc1 -triple x86_64-pc-linux-gnu -emit-obj -mrelax-all --mrelax-relocations -disable-free -disable-llvm-verifier -discard-value-names -main-file-name gdb_pretty_printer_test.sh.cpp -mrelocation-model static -mframe-pointer=all -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -tune-cpu generic -fno-split-dwarf-inlining -debug-info-kind=limited -dwarf-version=4 -debugger-tuning=gdb -v -nostdinc++ -resource-dir /usr/lib/llvm/12/bin/../../../../lib/clang/12.0.0 -include /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx-12.0.0_rc1_build-abi_x86_64.amd64/__config_site -include /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/support/nasty_macros.h -I /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/include -I /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx-12.0.0_rc1_build-abi_x86_64.amd64/include/c++build -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -D __STDC_CONSTANT_MACROS -I /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/support -D _LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER -D _LIBCPP_DISABLE_AVAILABILITY -D _LIBCPP_HAS_THREAD_API_PTHREAD -D _LIBCPP_ABI_VERSION=1 -internal-isystem /usr/local/include -internal-isystem /usr/lib/llvm/12/bin/../../../../lib/clang/12.0.0/include -internal-externc-isystem /include -internal-externc-isystem /usr/include -Werror -Wall -Wextra -Wshadow -Wno-unused-command-line-argument -Wno-attributes -Wno-pessimizing-move -Wno-c++11-extensions -Wno-user-defined-literals -Wno-noexcept-type -Wno-atomic-alignment -Wsign-compare -Wunused-variable -Wunused-parameter -Wunreachable-code -Wno-unused-local-typedef -Werror=thread-safety -Wuser-defined-warnings -Wno-macro-redefined -Wno-macro-redefined -std=c++2b -fdeprecated-macro -fdebug-compilation-dir /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx-12.0.0_rc1_build-abi_x86_64.amd64/test/libcxx/gdb -ferror-limit 19 -fcoroutines-ts -fgnuc-version=4.2.1 -fcxx-exceptions -fexceptions -o /tmp/portage/sys-libs/libcxx-12.0.0_rc1/temp/gdb_pretty_printer_test-62e7f0.o -x c++ /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/libcxx/gdb/gdb_pretty_printer_test.sh.cpp
clang -cc1 version 12.0.0 based upon LLVM 12.0.0 default target x86_64-pc-linux-gnu
ignoring nonexistent directory "/usr/local/include"
ignoring nonexistent directory "/include"
#include "..." search starts here:
#include <...> search starts here:
 /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/include
 /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx-12.0.0_rc1_build-abi_x86_64.amd64/include/c++build
 /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/support
 /usr/lib/llvm/12/bin/../../../../lib/clang/12.0.0/include
 /usr/include
End of search list.
/tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/libcxx/gdb/gdb_pretty_printer_test.sh.cpp:494:20: error: use of undeclared identifier 'R'
      "not_found", R "(std::__map_iterator ( = {\[0x[a-f0-9]+\] = .*}|<error "
                   ^
1 error generated.

--

********************

[saugustine]

Undo an auto-lint fix that breaks the string.

[saugustine]

In D96167#2545870, @mgorny wrote:

I haven't tested it on main but on top of 12.0.0-rc1:

/tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/libcxx/gdb/gdb_pretty_printer_test.sh.cpp:494:20: error: use of undeclared identifier 'R'

"not_found", R "(std::__map_iterator ( = {\[0x[a-f0-9]+\] = .*}|<error "
             ^

1 error generated.

That's what I get for trusting the linter that automatically runs at arc diff time. Surely a bug there. I've undone its fix, so we should be good to go.

[ldionne]

In D96167#2545895, @saugustine wrote:

In D96167#2545870, @mgorny wrote:

I haven't tested it on main but on top of 12.0.0-rc1:

/tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/libcxx/gdb/gdb_pretty_printer_test.sh.cpp:494:20: error: use of undeclared identifier 'R'

"not_found", R "(std::__map_iterator ( = {\[0x[a-f0-9]+\] = .*}|<error "
             ^

1 error generated.

That's what I get for trusting the linter that automatically runs at arc diff time. Surely a bug there. I've undone its fix, so we should be good to go.

I always use arc diff --nolint. LGTM again once CI is green.

[mgorny]

Ok, now it's a definite improvement.

Still 4 sub-tests fail for me:

FAIL: /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/libcxx/gdb/gdb_pretty_printer_test.sh.cpp:611
GDB printed:
   'Traceback (most recent call last):\n  File "/tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/libcxx/gdb/../../../utils/gdb/libcxx/printers.py", line 315, in to_string\n    usecount = refcount["__shared_owners_"] + 1\ngdb.error: There is no member named __shared_owners_.\n'
Value should match:
   'std::shared_ptr<int> count 2, weak 0 containing = {__ptr_ = 0x[a-f0-9]+}'
FAIL: /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/libcxx/gdb/gdb_pretty_printer_test.sh.cpp:616
GDB printed:
   'Traceback (most recent call last):\n  File "/tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/libcxx/gdb/../../../utils/gdb/libcxx/printers.py", line 315, in to_string\n    usecount = refcount["__shared_owners_"] + 1\ngdb.error: There is no member named __shared_owners_.\n'
Value should match:
   'std::shared_ptr<int> count 3, weak 0 containing = {__ptr_ = 0x[a-f0-9]+}'
FAIL: /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/libcxx/gdb/gdb_pretty_printer_test.sh.cpp:622
GDB printed:
   'Traceback (most recent call last):\n  File "/tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/libcxx/gdb/../../../utils/gdb/libcxx/printers.py", line 315, in to_string\n    usecount = refcount["__shared_owners_"] + 1\ngdb.error: There is no member named __shared_owners_.\n'
Value should match:
   'std::shared_ptr<int> count 3, weak 1 containing = {__ptr_ = 0x[a-f0-9]+}'
FAIL: /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/libcxx/gdb/gdb_pretty_printer_test.sh.cpp:627
GDB printed:
   'Traceback (most recent call last):\n  File "/tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/libcxx/gdb/../../../utils/gdb/libcxx/printers.py", line 315, in to_string\n    usecount = refcount["__shared_owners_"] + 1\ngdb.error: There is no member named __shared_owners_.\n'
Value should match:
   'std::shared_ptr<int> count 3, weak 0 containing = {__ptr_ = 0x[a-f0-9]+}'

[saugustine]

In D96167#2545911, @mgorny wrote:

Ok, now it's a definite improvement.

Still 4 sub-tests fail for me:

FAIL: /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/libcxx/gdb/gdb_pretty_printer_test.sh.cpp:611
GDB printed:
   'Traceback (most recent call last):\n  File "/tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/libcxx/gdb/../../../utils/gdb/libcxx/printers.py", line 315, in to_string\n    usecount = refcount["__shared_owners_"] + 1\ngdb.error: There is no member named __shared_owners_.\n'
Value should match:
   'std::shared_ptr<int> count 2, weak 0 containing = {__ptr_ = 0x[a-f0-9]+}'
FAIL: /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/libcxx/gdb/gdb_pretty_printer_test.sh.cpp:616
GDB printed:
   'Traceback (most recent call last):\n  File "/tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/libcxx/gdb/../../../utils/gdb/libcxx/printers.py", line 315, in to_string\n    usecount = refcount["__shared_owners_"] + 1\ngdb.error: There is no member named __shared_owners_.\n'
Value should match:
   'std::shared_ptr<int> count 3, weak 0 containing = {__ptr_ = 0x[a-f0-9]+}'
FAIL: /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/libcxx/gdb/gdb_pretty_printer_test.sh.cpp:622
GDB printed:
   'Traceback (most recent call last):\n  File "/tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/libcxx/gdb/../../../utils/gdb/libcxx/printers.py", line 315, in to_string\n    usecount = refcount["__shared_owners_"] + 1\ngdb.error: There is no member named __shared_owners_.\n'
Value should match:
   'std::shared_ptr<int> count 3, weak 1 containing = {__ptr_ = 0x[a-f0-9]+}'
FAIL: /tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/libcxx/gdb/gdb_pretty_printer_test.sh.cpp:627
GDB printed:
   'Traceback (most recent call last):\n  File "/tmp/portage/sys-libs/libcxx-12.0.0_rc1/work/libcxx/test/libcxx/gdb/../../../utils/gdb/libcxx/printers.py", line 315, in to_string\n    usecount = refcount["__shared_owners_"] + 1\ngdb.error: There is no member named __shared_owners_.\n'
Value should match:
   'std::shared_ptr<int> count 3, weak 0 containing = {__ptr_ = 0x[a-f0-9]+}'

I don't see these. Will submit this, and dig a bit further.

[mgorny]

Thanks. If you have any idea what I could try to help, please let me know.

libcxx/test/libcxx/gdb/gdb_pretty_printer_test.sh.cpp

 // -*- C++ -*-
 //===----------------------------------------------------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
void map_iterator_test() {
   auto it = one_two_three.begin();
   MarkAsLive(it);
   CompareExpressionPrettyPrintToRegex("it",
       R"(std::__map_iterator  = )"
       R"({\[0x[a-f0-9]+\] = {first = 1, second = "one"}})");
 
   auto not_found = one_two_three.find(7);
   MarkAsLive(not_found);
-  CompareExpressionPrettyPrintToRegex("not_found",
-      R"(std::__map_iterator  = {\[0x[a-f0-9]+\] =  end\(\)})");
+  // Because the end_node is not easily detected, just be sure it doesn't crash.
+  CompareExpressionPrettyPrintToRegex(
+      "not_found", R"(std::__map_iterator ( = {\[0x[a-f0-9]+\] = .*}|<error reading variable:.*>))");
 }
 
 void unordered_set_test() {
   std::unordered_set<int> i_am_empty;
   ComparePrettyPrintToChars(i_am_empty, "std::unordered_set is empty");
 
   std::unordered_set<int> numbers {12345, 67890, 222333, 12345};
   numbers.erase(numbers.find(222333));

libcxx/utils/gdb/libcxx/printers.py

 #===----------------------------------------------------------------------===##
 #
 # Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 # See https://llvm.org/LICENSE.txt for license information.
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 #
 #===----------------------------------------------------------------------===##
 """GDB pretty-printers for libc++.
 
 These should work for objects compiled when _LIBCPP_ABI_UNSTABLE is defined
 and when it is undefined.
 """
 
 from __future__ import print_function
 
+import math
 import re
 import gdb
 
 # One under-documented feature of the gdb pretty-printer API
 # is that clients can call any other member of the API
 # before they call to_string.
 # Therefore all self.FIELDs must be set in the pretty-printer's
 # __init__ function.
class _Children(object):
             self.child_iter = iter(self.val["__base_"].type.fields())
             self.count = 0
 
         def __iter__(self):
             return self
 
         def __next__(self):
             # child_iter raises StopIteration when appropriate.
-            field_name = self.child_iter.next()
+            field_name = next(self.child_iter)
             child = self.val["__base_"][field_name]["__value_"]
             self.count += 1
             return ("[%d]" % self.count, child)
 
         # TODO Delete when we drop Python 2.
         def next(self):
             return self.__next__()
 

 
 class StdBitsetPrinter(object):
     """Print a std::bitset."""
 
     def __init__(self, val):
         self.val = val
         self.n_words = int(self.val["__n_words"])
         self.bits_per_word = int(self.val["__bits_per_word"])
+        self.bit_count = self.val.type.template_argument(0)
         if self.n_words == 1:
             self.values = [int(self.val["__first_"])]
         else:
             self.values = [int(self.val["__first_"][index])
                            for index in range(self.n_words)]
 
     def to_string(self):
         typename = _prettify_typename(self.val.type)
         return "%s" % typename
 
-    def _byte_it(self, value):
-        index = -1
-        while value:
-            index += 1
-            will_yield = value % 2
-            value /= 2
-            if will_yield:
-                yield index
-
     def _list_it(self):
-        for word_index in range(self.n_words):
-            current = self.values[word_index]
-            if current:
-                for n in self._byte_it(current):
-                    yield ("[%d]" % (word_index * self.bits_per_word + n), 1)
+        for bit in range(self.bit_count):
+            word = math.floor(bit / self.bits_per_word)
+            word_bit = bit % self.bits_per_word
+            if self.values[word] & (1 << word_bit):
+                yield ("[%d]" % bit, 1)
 
     def __iter__(self):
         return self._list_it()
 
     def children(self):
         return self