feedc0de/boost_unordered
1
0
Fork 0
forked from boostorg/unordered
Code Pull Requests Activity

Implement natvis for fancy pointers (#262)

Browse Source 
* Add file for manual natvis testing

* Equip natvis file to allow fancy pointers

* Update docs

* [skip ci] add links to natvis docs
This commit is contained in:
Braden Ganetsky
2024-07-15 12:42:28 -05:00
committed by GitHub
parent 3ad8ac4c34
commit 7ddd562532
6 changed files with 382 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/unordered/changes.adoc
View File

@ -6,6 +6,10 @@
:github-pr-url: https://github.com/boostorg/unordered/pull :github-pr-url: https://github.com/boostorg/unordered/pull
:cpp: C++ :cpp: C++
== Release 1.87.0
* In Visual Studio Natvis, supported any container with an allocator that uses fancy pointers. This applies to any fancy pointer type, as long as the proper Natvis customization point "Intrinsic" functions are written for the fancy pointer type.
== Release 1.86.0 == Release 1.86.0
* Added container `pmr` aliases when header `<memory_resource>` is available. The alias `boost::unordered::pmr::[container]` refers to `boost::unordered::[container]` with a `std::pmr::polymorphic_allocator` allocator type. * Added container `pmr` aliases when header `<memory_resource>` is available. The alias `boost::unordered::pmr::[container]` refers to `boost::unordered::[container]` with a `std::pmr::polymorphic_allocator` allocator type.

14
doc/unordered/debuggability.adoc
View File

@ -5,7 +5,13 @@
== Visual Studio Natvis == Visual Studio Natvis
All containers and iterators have custom visualizations in the Natvis framework, as long as their allocator uses regular raw pointers. Any container or iterator with an allocator using fancy pointers does not have a custom visualization right now. All containers and iterators have custom visualizations in the Natvis framework.
=== Using in your project
To visualize Boost.Unordered containers in the Natvis framework in your project, simply add the file link:https://github.com/boostorg/unordered/blob/develop/extra/boost_unordered.natvis[/extra/boost_unordered.natvis] to your Visual Studio project as an "Existing Item".
=== Visualization structure
The visualizations mirror those for the standard unordered containers. A container has a maximum of 100 elements displayed at once. Each set element has its item name listed as `[i]`, where `i` is the index in the display, starting at `0`. Each map element has its item name listed as `[\{key-display}]` by default. For example, if the first element is the pair `("abc", 1)`, the item name will be `["abc"]`. This behaviour can be overridden by using the view "ShowElementsByIndex", which switches the map display behaviour to name the elements by index. This same view name is used in the standard unordered containers. The visualizations mirror those for the standard unordered containers. A container has a maximum of 100 elements displayed at once. Each set element has its item name listed as `[i]`, where `i` is the index in the display, starting at `0`. Each map element has its item name listed as `[\{key-display}]` by default. For example, if the first element is the pair `("abc", 1)`, the item name will be `["abc"]`. This behaviour can be overridden by using the view "ShowElementsByIndex", which switches the map display behaviour to name the elements by index. This same view name is used in the standard unordered containers.
@ -13,4 +19,8 @@ By default, the closed-addressing containers will show the `[hash_function]` and
By default, the open-addressing containers will show the `[hash_function]`, `[key_eq]`, `[allocator]`, and the elements. Using the view "simple" shows only the elements, with no other items present. Both the SIMD and the non-SIMD implementations are viewable through the Natvis framework. By default, the open-addressing containers will show the `[hash_function]`, `[key_eq]`, `[allocator]`, and the elements. Using the view "simple" shows only the elements, with no other items present. Both the SIMD and the non-SIMD implementations are viewable through the Natvis framework.
Iterators are displayed similarly to their standard counterparts. An iterator is displayed as though it were the element that it points to. An end iterator is simply displayed as `\{ end iterator }`. Iterators are displayed similarly to their standard counterparts. An iterator is displayed as though it were the element that it points to. An end iterator is simply displayed as `{ end iterator }`.
=== Fancy pointers
The container visualizations also work if you are using fancy pointers in your allocator, such as `boost::interprocess::offset_ptr`. While this is rare, Boost.Unordered has natvis customization points to support any type of fancy pointer. `boost::interprocess::offset_ptr` has support already defined in the Boost.Interprocess library, and you can add support to your own type by following the instructions contained in a comment near the end of the file link:https://github.com/boostorg/unordered/blob/develop/extra/boost_unordered.natvis[/extra/boost_unordered.natvis].

218
extra/boost_unordered.natvis
View File

@ -30,18 +30,50 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
</Type> </Type>
<Type Name="boost::unordered::detail::grouped_bucket_array&lt;*&gt;" Inheritable="false"> <Type Name="boost::unordered::detail::grouped_bucket_array&lt;*&gt;" Inheritable="false">
<!--
The expression `&**p` is used so the Intrinsic fails to parse for a fancy pointer type.
Only one of the definitions can exist at any given time, so the other must always fail to parse, similar to SFINAE in C++.
For a raw pointer, this expression is exactly equivalent to `*p`.
For a fancy pointer, this expression will try to call a user-defined `operator*()`, which is not allowed in Natvis, and it will fail.
-->
<Intrinsic Name="to_address" Optional="true" Expression="&amp;**p">
<Parameter Name="p" Type="bucket_pointer*" />
</Intrinsic>
<Intrinsic Name="to_address" Optional="true" Expression="&amp;**p">
<Parameter Name="p" Type="node_pointer*" />
</Intrinsic>
<Intrinsic Name="to_address" Optional="true" Expression="p-&gt;boost_to_address()">
<Parameter Name="p" Type="bucket_pointer*" />
</Intrinsic>
<Intrinsic Name="to_address" Optional="true" Expression="p-&gt;boost_to_address()">
<Parameter Name="p" Type="node_pointer*" />
</Intrinsic>
<!--
The casting expression `(xyz_pointer)p` is used so the Intrinsic fails to parse for a fancy pointer type.
Only one of the definitions can exist at any given time, so the other must always fail to parse, similar to SFINAE in C++.
In this case, `(xyz_pointer)p` is either a no-op for a raw pointer type, or it's an invalid expression.
-->
<Intrinsic Name="next" Optional="true" Expression="((bucket_pointer)p) + n">
<Parameter Name="p" Type="bucket_type*" />
<Parameter Name="n" Type="ptrdiff_t" />
</Intrinsic>
<Intrinsic Name="next" Optional="true" Expression="((bucket_pointer*)nullptr)->boost_next(p, n)">
<Parameter Name="p" Type="bucket_type*" />
<Parameter Name="n" Type="ptrdiff_t" />
</Intrinsic>
<Expand> <Expand>
<CustomListItems MaxItemsPerView="100"> <CustomListItems MaxItemsPerView="100">
<Variable Name="size" InitialValue="size_" /> <Variable Name="size" InitialValue="size_" />
<Variable Name="bucket_index" InitialValue="0" /> <Variable Name="bucket_index" InitialValue="0" />
<Variable Name="current_bucket" InitialValue="&amp;buckets[bucket_index]" /> <Variable Name="current_bucket" InitialValue="to_address(&amp;buckets)" />
<Variable Name="node" InitialValue="current_bucket->next" /> <Variable Name="node" InitialValue="to_address(&amp;current_bucket-&gt;next)" />
<Loop Condition="bucket_index != size"> <Loop Condition="bucket_index != size">
<Exec>current_bucket = &amp;buckets[bucket_index]</Exec> <Exec>current_bucket = next(to_address(&amp;buckets), bucket_index)</Exec>
<Exec>node = current_bucket-&gt;next</Exec> <Exec>node = to_address(&amp;current_bucket-&gt;next)</Exec>
<Loop Condition="node != nullptr"> <Loop Condition="node != nullptr">
<Item>node-&gt;buf.t_</Item> <Item>node-&gt;buf.t_</Item>
<Exec>node = node-&gt;next</Exec> <Exec>node = to_address(&amp;node-&gt;next)</Exec>
</Loop> </Loop>
<Exec>++bucket_index</Exec> <Exec>++bucket_index</Exec>
</Loop> </Loop>
@ -54,14 +86,14 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
<CustomListItems MaxItemsPerView="100"> <CustomListItems MaxItemsPerView="100">
<Variable Name="size" InitialValue="size_" /> <Variable Name="size" InitialValue="size_" />
<Variable Name="bucket_index" InitialValue="0" /> <Variable Name="bucket_index" InitialValue="0" />
<Variable Name="current_bucket" InitialValue="&amp;buckets[bucket_index]" /> <Variable Name="current_bucket" InitialValue="to_address(&amp;buckets)" />
<Variable Name="node" InitialValue="current_bucket->next" /> <Variable Name="node" InitialValue="to_address(&amp;current_bucket-&gt;next)" />
<Loop Condition="bucket_index != size"> <Loop Condition="bucket_index != size">
<Exec>current_bucket = &amp;buckets[bucket_index]</Exec> <Exec>current_bucket = next(to_address(&amp;buckets), bucket_index)</Exec>
<Exec>node = current_bucket-&gt;next</Exec> <Exec>node = to_address(&amp;current_bucket-&gt;next)</Exec>
<Loop Condition="node != nullptr"> <Loop Condition="node != nullptr">
<Item Name="[{node-&gt;buf.t_.first}]">node-&gt;buf.t_</Item> <Item Name="[{node-&gt;buf.t_.first}]">node-&gt;buf.t_</Item>
<Exec>node = node-&gt;next</Exec> <Exec>node = to_address(&amp;node-&gt;next)</Exec>
</Loop> </Loop>
<Exec>++bucket_index</Exec> <Exec>++bucket_index</Exec>
</Loop> </Loop>
@ -99,29 +131,46 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
<Type Name="boost::unordered::detail::iterator_detail::iterator&lt;*&gt;" Inheritable="false"> <Type Name="boost::unordered::detail::iterator_detail::iterator&lt;*&gt;" Inheritable="false">
<AlternativeType Name="boost::unordered::detail::iterator_detail::c_iterator&lt;*&gt;" /> <AlternativeType Name="boost::unordered::detail::iterator_detail::c_iterator&lt;*&gt;" />
<Intrinsic Name="valid" Expression="p != nullptr &amp;&amp; itb.p != nullptr &amp;&amp; itb.pbg != nullptr" /> <Intrinsic Name="to_address" Optional="true" Expression="&amp;**p">
<DisplayString Condition="valid()">{p-&gt;buf.t_}</DisplayString> <Parameter Name="p" Type="node_pointer*" />
</Intrinsic>
<Intrinsic Name="to_address" Optional="true" Expression="&amp;**p">
<Parameter Name="p" Type="bucket_iterator::bucket_pointer*" />
</Intrinsic>
<Intrinsic Name="to_address" Optional="true" Expression="&amp;**p">
<Parameter Name="p" Type="bucket_iterator::bucket_group_pointer*" />
</Intrinsic>
<Intrinsic Name="to_address" Optional="true" Expression="p-&gt;boost_to_address()">
<Parameter Name="p" Type="node_pointer*" />
</Intrinsic>
<Intrinsic Name="to_address" Optional="true" Expression="p-&gt;boost_to_address()">
<Parameter Name="p" Type="bucket_iterator::bucket_pointer*" />
</Intrinsic>
<Intrinsic Name="to_address" Optional="true" Expression="p-&gt;boost_to_address()">
<Parameter Name="p" Type="bucket_iterator::bucket_group_pointer*" />
</Intrinsic>
<Intrinsic Name="valid" Expression="to_address(&amp;p) &amp;&amp; to_address(&amp;itb.p) &amp;&amp; to_address(&amp;itb.pbg)" />
<DisplayString Condition="valid()">{to_address(&amp;p)-&gt;buf.t_}</DisplayString>
<DisplayString Condition="!valid()">{{ end iterator }}</DisplayString> <DisplayString Condition="!valid()">{{ end iterator }}</DisplayString>
<Expand> <Expand>
<ExpandedItem Condition="valid()">p-&gt;buf.t_</ExpandedItem> <ExpandedItem Condition="valid()">to_address(&amp;p)-&gt;buf.t_</ExpandedItem>
</Expand> </Expand>
</Type> </Type>
<!-- FOA and CFOA helpers --> <!-- FOA and CFOA helpers -->
<Type Name="boost::unordered::detail::foa::element_type&lt;*&gt;" Priority="Medium" Inheritable="false"> <Type Name="boost::unordered::detail::foa::element_type&lt;*&gt;" Priority="Medium" Inheritable="false">
<DisplayString>{*p}</DisplayString> <Intrinsic Name="to_address" Optional="true" Expression="&amp;**p">
<Parameter Name="p" Type="pointer*" />
</Intrinsic>
<Intrinsic Name="to_address" Optional="true" Expression="p-&gt;boost_to_address()">
<Parameter Name="p" Type="pointer*" />
</Intrinsic>
<Intrinsic Name="get" Expression="to_address(&amp;p)" />
<DisplayString>{*get()}</DisplayString>
<Expand> <Expand>
<ExpandedItem>*p</ExpandedItem> <ExpandedItem>*get()</ExpandedItem>
</Expand>
</Type>
<Type Name="boost::unordered::detail::foa::element_type&lt;std::pair&lt;*&gt;,*&gt;" Priority="MediumHigh" Inheritable="false">
<!-- Manually expand when holding a `std::pair`, otherwise the debugger complains about recursion-->
<DisplayString>({p-&gt;first}, {p-&gt;second})</DisplayString>
<Expand>
<Item Name="first">p-&gt;first</Item>
<Item Name="second">p-&gt;second</Item>
</Expand> </Expand>
</Type> </Type>
@ -227,10 +276,39 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
<Type Name="boost::unordered::detail::foa::table&lt;*&gt;" Inheritable="false"> <Type Name="boost::unordered::detail::foa::table&lt;*&gt;" Inheritable="false">
<AlternativeType Name="boost::unordered::detail::foa::concurrent_table&lt;*&gt;" /> <AlternativeType Name="boost::unordered::detail::foa::concurrent_table&lt;*&gt;" />
<Intrinsic Name="to_address" Optional="true" Expression="&amp;**p">
<Parameter Name="p" Type="arrays_type::value_type_pointer*" />
</Intrinsic>
<Intrinsic Name="to_address" Optional="true" Expression="&amp;**p">
<Parameter Name="p" Type="arrays_type::group_type_pointer*" />
</Intrinsic>
<Intrinsic Name="to_address" Optional="true" Expression="p-&gt;boost_to_address()">
<Parameter Name="p" Type="arrays_type::value_type_pointer*" />
</Intrinsic>
<Intrinsic Name="to_address" Optional="true" Expression="p-&gt;boost_to_address()">
<Parameter Name="p" Type="arrays_type::group_type_pointer*" />
</Intrinsic>
<Intrinsic Name="next" Optional="true" Expression="((arrays_type::value_type_pointer)p) + n">
<Parameter Name="p" Type="arrays_type::value_type*" />
<Parameter Name="n" Type="ptrdiff_t" />
</Intrinsic>
<Intrinsic Name="next" Optional="true" Expression="((arrays_type::char_pointer)p) + n">
<Parameter Name="p" Type="unsigned char*" />
<Parameter Name="n" Type="ptrdiff_t" />
</Intrinsic>
<Intrinsic Name="next" Optional="true" Expression="((arrays_type::value_type_pointer*)nullptr)->boost_next(p, n)">
<Parameter Name="p" Type="arrays_type::value_type*" />
<Parameter Name="n" Type="ptrdiff_t" />
</Intrinsic>
<Intrinsic Name="next" Optional="true" Expression="((arrays_type::char_pointer*)nullptr)->boost_next(p, n)">
<Parameter Name="p" Type="unsigned char*" />
<Parameter Name="n" Type="ptrdiff_t" />
</Intrinsic>
<Intrinsic Optional="true" Name="get_value" ReturnType="value_type*" Expression="e"> <Intrinsic Optional="true" Name="get_value" ReturnType="value_type*" Expression="e">
<Parameter Name="e" Type="value_type*" /> <Parameter Name="e" Type="value_type*" />
</Intrinsic> </Intrinsic>
<Intrinsic Optional="true" Name="get_value" ReturnType="value_type*" Expression="e-&gt;p"> <Intrinsic Optional="true" Name="get_value" ReturnType="value_type*" Expression="e-&gt;get()">
<Parameter Name="e" Type="element_type*" /> <Parameter Name="e" Type="element_type*" />
</Intrinsic> </Intrinsic>
@ -254,8 +332,8 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
<Expand> <Expand>
<Item Name="[stats]" Optional="true">cstats</Item> <Item Name="[stats]" Optional="true">cstats</Item>
<CustomListItems MaxItemsPerView="100"> <CustomListItems MaxItemsPerView="100">
<Variable Name="pc_" InitialValue="reinterpret_cast&lt;unsigned char*&gt;(arrays.groups_)" /> <Variable Name="pc_" InitialValue="reinterpret_cast&lt;unsigned char*&gt;(to_address(&amp;arrays.groups_))" />
<Variable Name="p_" InitialValue="arrays.elements_" /> <Variable Name="p_" InitialValue="to_address(&amp;arrays.elements_)" />
<Variable Name="first_time" InitialValue="true" /> <Variable Name="first_time" InitialValue="true" />
<Variable Name="mask" InitialValue="(int)0" /> <Variable Name="mask" InitialValue="(int)0" />
<Variable Name="n0" InitialValue="(size_t)0" /> <Variable Name="n0" InitialValue="(size_t)0" />
@ -264,18 +342,18 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
<Loop Condition="p_ != nullptr"> <Loop Condition="p_ != nullptr">
<!-- This if block mirrors the condition in the begin() call --> <!-- This if block mirrors the condition in the begin() call -->
<If Condition="!first_time || !(arrays.elements_ &amp;&amp; !(arrays.groups_[0].match_occupied() &amp; 0x1))"> <If Condition="!first_time || !(p_ &amp;&amp; !(to_address(&amp;arrays.groups_)[0].match_occupied() &amp; 0x1))">
<Item>*p_</Item> <Item>*p_</Item>
</If> </If>
<Exec>first_time = false</Exec> <Exec>first_time = false</Exec>
<Exec>n0 = reinterpret_cast&lt;uintptr_t&gt;(pc_) % sizeof(group_type)</Exec> <Exec>n0 = reinterpret_cast&lt;uintptr_t&gt;(pc_) % sizeof(group_type)</Exec>
<Exec>pc_ -= (ptrdiff_t)n0</Exec> <Exec>pc_ = next(pc_, -(ptrdiff_t)n0)</Exec>
<Exec>mask = (reinterpret_cast&lt;group_type*&gt;(pc_)-&gt;match_occupied() &gt;&gt; (n0+1)) &lt;&lt; (n0+1)</Exec> <Exec>mask = (reinterpret_cast&lt;group_type*&gt;(pc_)-&gt;match_occupied() &gt;&gt; (n0+1)) &lt;&lt; (n0+1)</Exec>
<Loop Condition="mask == 0"> <Loop Condition="mask == 0">
<Exec>pc_ += sizeof(group_type)</Exec> <Exec>pc_ = next(pc_, sizeof(group_type))</Exec>
<Exec>p_ += group_type::N</Exec> <Exec>p_ = next(p_, group_type::N)</Exec>
<Exec>mask = reinterpret_cast&lt;group_type*&gt;(pc_)-&gt;match_occupied()</Exec> <Exec>mask = reinterpret_cast&lt;group_type*&gt;(pc_)-&gt;match_occupied()</Exec>
</Loop> </Loop>
@ -284,9 +362,8 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
<Exec>p_ = nullptr</Exec> <Exec>p_ = nullptr</Exec>
</If> </If>
<Else> <Else>
<Exec>pc_ += (ptrdiff_t)n</Exec> <Exec>pc_ = next(pc_, (ptrdiff_t)n)</Exec>
<Exec>p_ -= (ptrdiff_t)n0</Exec> <Exec>p_ = next(p_, (ptrdiff_t)n - (ptrdiff_t)n0)</Exec>
<Exec>p_ += (ptrdiff_t)n</Exec>
</Else> </Else>
</Loop> </Loop>
@ -299,8 +376,8 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
<Expand> <Expand>
<Item Name="[stats]" Optional="true">cstats</Item> <Item Name="[stats]" Optional="true">cstats</Item>
<CustomListItems MaxItemsPerView="100"> <CustomListItems MaxItemsPerView="100">
<Variable Name="pc_" InitialValue="reinterpret_cast&lt;unsigned char*&gt;(arrays.groups_)" /> <Variable Name="pc_" InitialValue="reinterpret_cast&lt;unsigned char*&gt;(to_address(&amp;arrays.groups_))" />
<Variable Name="p_" InitialValue="arrays.elements_" /> <Variable Name="p_" InitialValue="to_address(&amp;arrays.elements_)" />
<Variable Name="first_time" InitialValue="true" /> <Variable Name="first_time" InitialValue="true" />
<Variable Name="mask" InitialValue="(int)0" /> <Variable Name="mask" InitialValue="(int)0" />
<Variable Name="n0" InitialValue="(size_t)0" /> <Variable Name="n0" InitialValue="(size_t)0" />
@ -309,18 +386,18 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
<Loop Condition="p_ != nullptr"> <Loop Condition="p_ != nullptr">
<!-- This if block mirrors the condition in the begin() call --> <!-- This if block mirrors the condition in the begin() call -->
<If Condition="!first_time || !(arrays.elements_ &amp;&amp; !(arrays.groups_[0].match_occupied() &amp; 0x1))"> <If Condition="!first_time || !(p_ &amp;&amp; !(to_address(&amp;arrays.groups_)[0].match_occupied() &amp; 0x1))">
<Item Name="[{get_value(p_)-&gt;first}]">*p_</Item> <Item Name="[{get_value(p_)-&gt;first}]">*p_</Item>
</If> </If>
<Exec>first_time = false</Exec> <Exec>first_time = false</Exec>
<Exec>n0 = reinterpret_cast&lt;uintptr_t&gt;(pc_) % sizeof(group_type)</Exec> <Exec>n0 = reinterpret_cast&lt;uintptr_t&gt;(pc_) % sizeof(group_type)</Exec>
<Exec>pc_ -= (ptrdiff_t)n0</Exec> <Exec>pc_ = next(pc_, -(ptrdiff_t)n0)</Exec>
<Exec>mask = (reinterpret_cast&lt;group_type*&gt;(pc_)-&gt;match_occupied() &gt;&gt; (n0+1)) &lt;&lt; (n0+1)</Exec> <Exec>mask = (reinterpret_cast&lt;group_type*&gt;(pc_)-&gt;match_occupied() &gt;&gt; (n0+1)) &lt;&lt; (n0+1)</Exec>
<Loop Condition="mask == 0"> <Loop Condition="mask == 0">
<Exec>pc_ += sizeof(group_type)</Exec> <Exec>pc_ = next(pc_, sizeof(group_type))</Exec>
<Exec>p_ += group_type::N</Exec> <Exec>p_ = next(p_, group_type::N)</Exec>
<Exec>mask = reinterpret_cast&lt;group_type*&gt;(pc_)-&gt;match_occupied()</Exec> <Exec>mask = reinterpret_cast&lt;group_type*&gt;(pc_)-&gt;match_occupied()</Exec>
</Loop> </Loop>
@ -329,9 +406,8 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
<Exec>p_ = nullptr</Exec> <Exec>p_ = nullptr</Exec>
</If> </If>
<Else> <Else>
<Exec>pc_ += (ptrdiff_t)n</Exec> <Exec>pc_ = next(pc_, (ptrdiff_t)n)</Exec>
<Exec>p_ -= (ptrdiff_t)n0</Exec> <Exec>p_ = next(p_, (ptrdiff_t)n - (ptrdiff_t)n0)</Exec>
<Exec>p_ += (ptrdiff_t)n</Exec>
</Else> </Else>
</Loop> </Loop>
@ -369,12 +445,62 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
<!-- FOA iterators --> <!-- FOA iterators -->
<Type Name="boost::unordered::detail::foa::table_iterator&lt;*&gt;" Inheritable="false"> <Type Name="boost::unordered::detail::foa::table_iterator&lt;*&gt;" Inheritable="false">
<Intrinsic Name="valid" Expression="p_ != nullptr &amp;&amp; pc_ != nullptr" /> <Intrinsic Name="to_address" Optional="true" Expression="&amp;**p">
<DisplayString Condition="valid()">{*p_}</DisplayString> <Parameter Name="p" Type="table_element_pointer*" />
</Intrinsic>
<Intrinsic Name="to_address" Optional="true" Expression="p-&gt;boost_to_address()">
<Parameter Name="p" Type="table_element_pointer*" />
</Intrinsic>
<Intrinsic Name="to_address" Optional="true" Expression="&amp;**p">
<Parameter Name="p" Type="char_pointer*" />
</Intrinsic>
<Intrinsic Name="to_address" Optional="true" Expression="p-&gt;boost_to_address()">
<Parameter Name="p" Type="char_pointer*" />
</Intrinsic>
<Intrinsic Name="valid" Expression="to_address(&amp;p_) != nullptr &amp;&amp; to_address(&amp;pc_) != nullptr" />
<DisplayString Condition="valid()">{*to_address(&amp;p_)}</DisplayString>
<DisplayString Condition="!valid()">{{ end iterator }}</DisplayString> <DisplayString Condition="!valid()">{{ end iterator }}</DisplayString>
<Expand> <Expand>
<ExpandedItem Condition="valid()">*p_</ExpandedItem> <ExpandedItem Condition="valid()">*to_address(&amp;p_)</ExpandedItem>
</Expand> </Expand>
</Type> </Type>
<!-- Fancy pointer support -->
<!--
To allow your own fancy pointer type to interact with Boost.Unordered Natvis,
add the following intrinsics to your type, with the following conditions.
(Note, this is assuming the presence of a type alias `pointer` for the underlying
raw pointer type, and a type alias `difference_type` for your fancy pointer
difference type. Substitute whichever names are applicable in your case.)
`boost_to_address`
* Takes no parameters
* Returns the raw pointer equivalent to your fancy pointer
`boost_next`
* Parameter 1, an underlying raw pointer of type `pointer`
* Parameter 2, an offset of type `difference_type`
* Returns the raw pointer equivalent to your fancy pointer, as if you did the following operations
1. Convert the incoming raw pointer to your fancy pointer
2. Use operator+= to add the offset to the fancy pointer
3. Convert back to the raw pointer
* Note, you will not actually do these operations as stated. You will do equivalent lower-level operations that emulate having done the above.
Example
```
<Type Name="my_fancy_ptr&lt;*&gt;">
...
<Intrinsic Name="boost_to_address" ReturnType="pointer" Expression="..." />
<Intrinsic Name="boost_next" ReturnType="pointer" Expression="...">
<Parameter Name="ptr" Type="pointer" />
<Parameter Name="offset" Type="difference_type" />
</Intrinsic>
...
</Type>
```
-->
</AutoVisualizer> </AutoVisualizer>

5
include/boost/unordered/detail/foa/core.hpp
View File

@ -1017,6 +1017,11 @@ struct table_arrays
rebind<group_type>; rebind<group_type>;
using group_type_pointer_traits=boost::pointer_traits<group_type_pointer>; using group_type_pointer_traits=boost::pointer_traits<group_type_pointer>;
// For natvis purposes
using char_pointer=
typename boost::pointer_traits<value_type_pointer>::template
rebind<unsigned char>;
table_arrays( table_arrays(
std::size_t gsi,std::size_t gsm, std::size_t gsi,std::size_t gsm,
group_type_pointer pg,value_type_pointer pe): group_type_pointer pg,value_type_pointer pe):

2
test/Jamfile.v2
View File

@ -42,6 +42,8 @@ path-constant BOOST_UNORDERED_TEST_DIR : . ;
run quick.cpp ; run quick.cpp ;
compile natvis_tests.cpp ;
compile unordered/self_include_tests_obj.cpp compile unordered/self_include_tests_obj.cpp
: <define>BOOST_UNORDERED_HEADER="boost/unordered_map.hpp" : <define>BOOST_UNORDERED_HEADER="boost/unordered_map.hpp"
: tl_unordered_map_hpp ; : tl_unordered_map_hpp ;

187
test/natvis_tests.cpp Normal file
View File

@ -0,0 +1,187 @@
// Copyright 2024 Braden Ganetsky
// Distributed under the Boost Software License, Version 1.0.
// https://www.boost.org/LICENSE_1_0.txt
// This test applies to MSVC only. This is a file for manual testing.
// Run this test and break manually at the variable called `break_here`.
// Inspect the variables using the Visual Studio debugger to test correctness.
#if !defined(BOOST_MSVC)
#include <boost/config/pragma_message.hpp>
BOOST_PRAGMA_MESSAGE("These tests are for Visual Studio only.")
int main() {}
#else
#if 0 // Change to `#if 1` to test turning off SIMD optimizations
#define BOOST_UNORDERED_DISABLE_SSE2
#define BOOST_UNORDERED_DISABLE_NEON
#endif
#define BOOST_UNORDERED_ENABLE_STATS
#include <boost/core/lightweight_test.hpp>
#include <boost/interprocess/allocators/allocator.hpp>
#include <boost/interprocess/managed_shared_memory.hpp>
#include <boost/unordered/concurrent_flat_map.hpp>
#include <boost/unordered/concurrent_flat_set.hpp>
#include <boost/unordered/unordered_flat_map.hpp>
#include <boost/unordered/unordered_flat_set.hpp>
#include <boost/unordered/unordered_map.hpp>
#include <boost/unordered/unordered_node_map.hpp>
#include <boost/unordered/unordered_node_set.hpp>
#include <boost/unordered/unordered_set.hpp>
#include <boost/uuid/random_generator.hpp>
#include <boost/uuid/uuid_io.hpp>
#include <string>
#include <typeinfo>
// Prevent any "unused" errors
template <class... Args> void use(Args&&...) {}
using map_value_type = std::pair<const std::string, int>;
using set_value_type = std::string;
template <class Tester> void natvis_test(Tester& tester)
{
// clang-format off
auto fca_map = tester.template construct_map<boost::unordered_map>();
auto fca_multimap = tester.template construct_map<boost::unordered_multimap>();
auto fca_set = tester.template construct_set<boost::unordered_set>();
auto fca_multiset = tester.template construct_set<boost::unordered_multiset>();
auto foa_flat_map = tester.template construct_map<boost::unordered_flat_map>();
auto foa_flat_set = tester.template construct_set<boost::unordered_flat_set>();
auto foa_node_map = tester.template construct_map<boost::unordered_node_map>();
auto foa_node_set = tester.template construct_set<boost::unordered_node_set>();
auto cfoa_flat_map = tester.template construct_map<boost::concurrent_flat_map>();
auto cfoa_flat_set = tester.template construct_set<boost::concurrent_flat_set>();
// clang-format on
for (int i = 0; i < 5; ++i) {
const auto str = std::to_string(i * 2);
const auto num = i * 11;
fca_map->emplace(str, num);
fca_multimap->emplace(str, num);
fca_multimap->emplace(str, num + 1);
foa_flat_map->emplace(str, num);
foa_node_map->emplace(str, num);
cfoa_flat_map->emplace(str, num);
fca_set->emplace(str);
fca_multiset->emplace(str);
fca_multiset->emplace(str);
foa_flat_set->emplace(str);
foa_node_set->emplace(str);
cfoa_flat_set->emplace(str);
}
auto fca_map_begin = fca_map->begin();
auto fca_map_end = fca_map->end();
auto fca_multimap_begin = fca_multimap->begin();
auto fca_multimap_end = fca_multimap->end();
auto fca_set_begin = fca_set->begin();
auto fca_set_end = fca_set->end();
auto fca_multiset_begin = fca_multiset->begin();
auto fca_multiset_end = fca_multiset->end();
auto foa_flat_map_begin = foa_flat_map->begin();
auto foa_flat_map_end = foa_flat_map->end();
auto foa_flat_set_begin = foa_flat_set->begin();
auto foa_flat_set_end = foa_flat_set->end();
auto foa_node_map_begin = foa_node_map->begin();
auto foa_node_map_end = foa_node_map->end();
auto foa_node_set_begin = foa_node_set->begin();
auto foa_node_set_end = foa_node_set->end();
use(cfoa_flat_map, cfoa_flat_set);
use(fca_map_begin, fca_map_end, fca_multimap_begin, fca_multimap_end,
fca_set_begin, fca_set_end, fca_multiset_begin, fca_multiset_end);
use(foa_flat_map_begin, foa_flat_map_end, foa_flat_set_begin,
foa_flat_set_end, foa_node_map_begin, foa_node_map_end, foa_node_set_begin,
foa_node_set_end);
int break_here = 0;
use(break_here);
}
class offset_ptr_tester_
{
static constexpr std::size_t SEGMENT_SIZE = 64 * 1024;
std::string segment_name = to_string(boost::uuids::random_generator()());
boost::interprocess::managed_shared_memory segment{
boost::interprocess::create_only, segment_name.c_str(), SEGMENT_SIZE};
using map_allocator = boost::interprocess::allocator<map_value_type,
boost::interprocess::managed_shared_memory::segment_manager>;
using set_allocator = boost::interprocess::allocator<set_value_type,
boost::interprocess::managed_shared_memory::segment_manager>;
template <template <class...> class MapTemplate>
using map_type = MapTemplate<std::string, int, boost::hash<std::string>,
std::equal_to<std::string>, map_allocator>;
template <template <class...> class SetTemplate>
using set_type = SetTemplate<std::string, boost::hash<std::string>,
std::equal_to<std::string>, set_allocator>;
public:
offset_ptr_tester_()
{
boost::interprocess::shared_memory_object::remove(segment_name.c_str());
}
~offset_ptr_tester_()
{
boost::interprocess::shared_memory_object::remove(segment_name.c_str());
}
template <template <class...> class MapTemplate>
map_type<MapTemplate>* construct_map()
{
return &*segment.construct<map_type<MapTemplate> >(
typeid(map_type<MapTemplate>).name())(
map_allocator(segment.get_segment_manager()));
}
template <template <class...> class SetTemplate>
set_type<SetTemplate>* construct_set()
{
return &*segment.construct<set_type<SetTemplate> >(
typeid(set_type<SetTemplate>).name())(
set_allocator(segment.get_segment_manager()));
}
} offset_ptr_tester;
class default_tester_
{
template <template <class...> class MapTemplate>
using map_type = MapTemplate<std::string, int, boost::hash<std::string>,
std::equal_to<std::string>, std::allocator<map_value_type> >;
template <template <class...> class SetTemplate>
using set_type = SetTemplate<std::string, boost::hash<std::string>,
std::equal_to<std::string>, std::allocator<set_value_type> >;
public:
template <template <class...> class MapTemplate>
std::unique_ptr<map_type<MapTemplate> > construct_map()
{
return std::make_unique<map_type<MapTemplate> >();
}
template <template <class...> class SetTemplate>
std::unique_ptr<set_type<SetTemplate> > construct_set()
{
return std::make_unique<set_type<SetTemplate> >();
}
} default_tester;
int main()
{
natvis_test(default_tester);
natvis_test(offset_ptr_tester);
return boost::report_errors();
}
#endif // !defined(BOOST_MSVC)