{"id":110619,"date":"2024-12-09T07:00:00","date_gmt":"2024-12-09T15:00:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/oldnewthing\/?p=110619"},"modified":"2024-12-09T10:46:23","modified_gmt":"2024-12-09T18:46:23","slug":"20241209-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20241209-00\/?p=110619","title":{"rendered":"Learning to read C++ compiler errors: Failing to create a shared_ptr<\/CODE>"},"content":{"rendered":"

Consider the following erroneous code:<\/p>\n

#include <memory>\r\n#include <string>\r\n\r\nstruct WidgetOptions\r\n{\r\n    \/\/ imagine there is interesting stuff here\r\n};\r\n\r\nstruct Widget\r\n{\r\n    Widget(WidgetOptions const* options);\r\n\r\n    \/\/ imagine there is other interesting stuff here\r\n};\r\n\r\nvoid oops()\r\n{\r\n    WidgetOptions options;\r\n\r\n    \/\/ The next line fails to compile\r\n    std::shared_ptr<Widget> widget =\r\n        std::make_shared<Widget>(options);\r\n}\r\n<\/pre>\n
Here comes the error explosion.<\/p>\n
\/\/ gcc\r\nIn file included from bits\/stl_tempbuf.h:61,\r\n                 from memory:66,\r\n                 from sample.cpp:1:\r\nbits\/stl_construct.h: In instantiation of 'void std::_Construct(_Tp*, _Args&& ...) [with _Tp = Widget; _Args = {WidgetOptions&}]':\r\nbits\/alloc_traits.h:657:19:   required from 'static void std::allocator_traits<std::allocator<void> >::construct(allocator_type&, _Up*, _Args&& ...) [with _Up = Widget; _Args = {WidgetOptions&}; allocator_type = std::allocator<void>]'\r\n  657 |         { std::_Construct(__p, std::forward<_Args>(__args)...); }\r\n      |           ~~~~~~~~~~~~~~~^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r\nbits\/shared_ptr_base.h:607:39:   required from 'std::_Sp_counted_ptr_inplace<_Tp, _Alloc, _Lp>::_Sp_counted_ptr_inplace(_Alloc, _Args&& ...) [with _Args = {WidgetOptions&}; _Tp = Widget; _Alloc = std::allocator<void>; __gnu_cxx::_Lock_policy _Lp = __gnu_cxx::_S_atomic]'\r\n  607 |           allocator_traits<_Alloc>::construct(__a, _M_ptr(),\r\n      |           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^~~~~~~~~~~~~~~\r\n  608 |               std::forward<_Args>(__args)...); \/\/ might throw\r\n      |               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ \r\nbits\/shared_ptr_base.h:969:16:   required from 'std::__shared_count<_Lp>::__shared_count(_Tp*&, std::_Sp_alloc_shared_tag<_Alloc>, _Args&& ...) [with _Tp = Widget; _Alloc = std::allocator<void>; _Args = {WidgetOptions&}; __gnu_cxx::_Lock_policy _Lp = __gnu_cxx::_S_atomic]'\r\n  969 |           auto __pi = ::new (__mem)\r\n      |                       ^~~~~~~~~~~~~\r\n  970 |             _Sp_cp_type(__a._M_a, std::forward<_Args>(__args)...);\r\n      |             ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r\nbits\/shared_ptr_base.h:1713:14:   required from 'std::__shared_ptr<_Tp, _Lp>::__shared_ptr(std::_Sp_alloc_shared_tag<_Tp>, _Args&& ...) [with _Alloc = std::allocator<void>; _Args = {WidgetOptions&}; _Tp = Widget; __gnu_cxx::_Lock_policy _Lp = __gnu_cxx::_S_atomic]'\r\n 1713 |         : _M_ptr(), _M_refcount(_M_ptr, __tag, std::forward<_Args>(__args)...)\r\n      |                     ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r\nbits\/shared_ptr.h:463:59:   required from 'std::shared_ptr<_Tp>::shared_ptr(std::_Sp_alloc_shared_tag<_Tp>, _Args&& ...) [with _Alloc = std::allocator<void>; _Args = {WidgetOptions&}; _Tp = Widget]'\r\n  463 |         : __shared_ptr<_Tp>(__tag, std::forward<_Args>(__args)...)\r\n      |                                                                  ^\r\nbits\/shared_ptr.h:1007:14:   required from 'std::shared_ptr<typename std::enable_if<(! std::is_array<_Tp>::value), _Tp>::type> std::make_shared(_Args&& ...) [with _Tp = Widget; _Args = {WidgetOptions&}; typename enable_if<(! is_array<_Tp>::value), _Tp>::type = Widget]'\r\n 1007 |       return shared_ptr<_Tp>(_Sp_alloc_shared_tag<_Alloc>{__a},\r\n      |              ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r\n 1008 |                              std::forward<_Args>(__args)...);\r\n      |                              ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r\nsample.cpp:22:33:   required from here\r\n   22 |         std::make_shared<Widget>(options);\r\n      |         ~~~~~~~~~~~~~~~~~~~~~~~~^~~~~~~~~\r\nbits\/stl_construct.h:119:7: error: no matching function for call to 'Widget::Widget(WidgetOptions&)'\r\n  119 |       ::new((void*)__p) _Tp(std::forward<_Args>(__args)...);\r\n      |       ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r\nsample.cpp:11:5: note: candidate: 'Widget::Widget(const WidgetOptions*)'\r\n   11 |     Widget(WidgetOptions const* options);\r\n      |     ^~~~~~\r\nsample.cpp:11:33: note:   no known conversion for argument 1 from 'WidgetOptions' to 'const WidgetOptions*'\r\n   11 |     Widget(WidgetOptions const* options);\r\n      |            ~~~~~~~~~~~~~~~~~~~~~^~~~~~~\r\nsample.cpp:9:8: note: candidate: 'constexpr Widget::Widget(const Widget&)'\r\n    9 | struct Widget\r\n      |        ^~~~~~\r\nsample.cpp:9:8: note:   no known conversion for argument 1 from 'WidgetOptions' to 'const Widget&'\r\nsample.cpp:9:8: note: candidate: 'constexpr Widget::Widget(Widget&&)'\r\nsample.cpp:9:8: note:   no known conversion for argument 1 from 'WidgetOptions' to 'Widget&&'\r\nCompiler returned: 1\r\n<\/pre>\n
And for clang:<\/p>\n
In file included from sample.cpp:1:\r\nIn file included from memory:66:\r\nIn file included from bits\/stl_tempbuf.h:61:\r\nbits\/stl_construct.h:119:25: error: no matching constructor for initialization of 'Widget'\r\n  119 |       ::new((void*)__p) _Tp(std::forward<_Args>(__args)...);\r\n      |                         ^   ~~~~~~~~~~~~~~~~~~~~~~~~~~~\r\nbits\/alloc_traits.h:657:9: note: in instantiation of function template specialization 'std::_Construct<Widget, WidgetOptions &>' requested here\r\n  657 |         { std::_Construct(__p, std::forward<_Args>(__args)...); }\r\n      |                ^\r\nbits\/shared_ptr_base.h:607:30: note: in instantiation of function template specialization 'std::allocator_traits<std::allocator<void>>::construct<Widget, WidgetOptions &>' requested here\r\n  607 |           allocator_traits<_Alloc>::construct(__a, _M_ptr(),\r\n      |                                     ^\r\nbits\/shared_ptr_base.h:970:6: note: in instantiation of function template specialization 'std::_Sp_counted_ptr_inplace<Widget, std::allocator<void>, __gnu_cxx::_S_atomic>::_Sp_counted_ptr_inplace<WidgetOptions &>' requested here\r\n  970 |             _Sp_cp_type(__a._M_a, std::forward<_Args>(__args)...);\r\n      |             ^\r\nbits\/shared_ptr_base.h:1713:14: note: in instantiation of function template specialization 'std::__shared_count<>::__shared_count<Widget, std::allocator<void>, WidgetOptions &>' requested here\r\n 1713 |         : _M_ptr(), _M_refcount(_M_ptr, __tag, std::forward<_Args>(__args)...)\r\n      |                     ^\r\nbits\/shared_ptr.h:463:4: note: in instantiation of function template specialization 'std::__shared_ptr<Widget>::__shared_ptr<std::allocator<void>, WidgetOptions &>' requested here\r\n  463 |         : __shared_ptr<_Tp>(__tag, std::forward<_Args>(__args)...)\r\n      |           ^\r\nbits\/shared_ptr.h:1007:14: note: in instantiation of function template specialization 'std::shared_ptr<Widget>::shared_ptr<std::allocator<void>, WidgetOptions &>' requested here\r\n 1007 |       return shared_ptr<_Tp>(_Sp_alloc_shared_tag<_Alloc>{__a},\r\n      |              ^\r\nsample.cpp:22:14: note: in instantiation of function template specialization 'std::make_shared<Widget, WidgetOptions &>' requested here\r\n   22 |         std::make_shared<Widget>(options);\r\n      |              ^\r\nsample.cpp:11:5: note: candidate constructor not viable: no known conversion from 'WidgetOptions' to 'const WidgetOptions *' for 1st argument; take the address of the argument with &\r\n   11 |     Widget(WidgetOptions const* options);\r\n      |     ^      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r\nsample.cpp:9:8: note: candidate constructor (the implicit copy constructor) not viable: no known conversion from 'WidgetOptions' to 'const Widget' for 1st argument\r\n    9 | struct Widget\r\n      |        ^~~~~~\r\nsample.cpp:9:8: note: candidate constructor (the implicit move constructor) not viable: no known conversion from 'WidgetOptions' to 'Widget' for 1st argument\r\n    9 | struct Widget\r\n      |        ^~~~~~\r\n1 error generated.\r\nCompiler returned: 1\r\n<\/pre>\n
And for msvc:<\/p>\n
xutility(408): error C2665: 'Widget::Widget': no overloaded function could convert all the argument types\r\nsample.cpp(14): note: could be 'Widget::Widget(Widget &&)'\r\nxutility(408): note: 'Widget::Widget(Widget &&)': cannot convert argument 1 from 'WidgetOptions' to 'Widget &&'\r\nxutility(408): note: Reason: cannot convert from 'WidgetOptions' to 'Widget'\r\nxutility(408): note: No user-defined-conversion operator available that can perform this conversion, or the operator cannot be called\r\nsample.cpp(14): note: or       'Widget::Widget(const Widget &)'\r\nxutility(408): note: 'Widget::Widget(const Widget &)': cannot convert argument 1 from 'WidgetOptions' to 'const Widget &'\r\nxutility(408): note: Reason: cannot convert from 'WidgetOptions' to 'const Widget'\r\nxutility(408): note: No user-defined-conversion operator available that can perform this conversion, or the operator cannot be called\r\nsample.cpp(11): note: or       'Widget::Widget(const WidgetOptions *)'\r\nxutility(408): note: 'Widget::Widget(const WidgetOptions *)': cannot convert argument 1 from 'WidgetOptions' to 'const WidgetOptions *'\r\nxutility(408): note: No user-defined-conversion operator available that can perform this conversion, or the operator cannot be called\r\nxutility(408): note: while trying to match the argument list '(WidgetOptions)'\r\nxutility(408): note: the template instantiation context (the oldest one first) is\r\nsample.cpp(22): note: see reference to function template instantiation 'std::shared_ptr<Widget> std::make_shared<Widget,WidgetOptions&>(WidgetOptions &)' being compiled\r\nmemory(2896): note: see reference to function template instantiation 'std::_Ref_count_obj2<_Ty>::_Ref_count_obj2<WidgetOptions&>(WidgetOptions &)' being compiled\r\n        with\r\n        [\r\n            _Ty=Widget\r\n        ]\r\nmemory(2083): note: see reference to function template instantiation 'void std::_Construct_in_place<_Ty,WidgetOptions&>(_Ty &,WidgetOptions &) noexcept(false)' being compiled\r\n        with\r\n        [\r\n            _Ty=Widget\r\n        ]\r\nCompiler returned: 2\r\n<\/pre>\n
The trick to understanding C++ compiler error messages is to focus on two things. First, look at the beginning of the error message, which tells you what went wrong at a very low level. Then skip over the intermediate errors that follow the chain of calls until you end up at the line of code that you<\/i> wrote. That original line of code is the one that is leading the compiler to a bad place. After that, you sometimes get supplemental information that helps you understand the low-level error better.<\/p>\n
For the gcc error, it starts with trying to call void std::_Construct(_Tp*, _Args&& ...)<\/code>, and if you substitute the template parameters, it expands to void std::_Construct(Widget*, WidgetOptions&)<\/code>. From the function name, it sounds like it’s trying to construct something, and my guess is that it’s trying to construct the type _Tp<\/code> (which is Widget<\/code>) from the arguments (which are WidgetOptions&<\/code>). Then follows a chain of “required from”s that ultimately lead to std::make_shared<Widget>(options)<\/code>, which is the line of code that we wrote that created the problem in the first place.<\/p>\n
After that comes a little more explanation: “No matching function for call to Widget::Widget(Widget\u00adOptions&)<\/code>.” So it’s trying to call the Widget<\/code> constructor with a Widget\u00adOptions&<\/code> but can’t, and the rest of the error message is listing the various constructor candidates and why each one doesn’t work.<\/p>\n
For the clang error, it starts with the “No matching constructor” portion, though for some reason it doesn’t tell you what _Tp<\/code> and _Args<\/code> are. Then comes a chain of “in instantiation of” messages until it reaches std::make_shared<Widget(options)<\/code>, which is the line of code we wrote.<\/p>\n
After the chain of instantiations, clang provides details on why it couldn’t find a matching constructor.<\/p>\n
Finally, we have msvc, which does things in a different order. It starts by telling you that it couldn’t construct a Widget<\/code> from the provided arguments. Unfortunately, it doesn’t come right out and tell you what the arguments are, though from the third part of the message “cannot convert argument 1 from ‘Widget\u00adOptions<\/code>‘ to ‘Widget&&<\/code>‘” you can infer that the first argument is a Widget\u00adOptions<\/code>. After explaining why each constructor candidate was unsuitable, it gives you the function instantiation chain, starting with the std::make_shared<Widget, Widget\u00adOptions&>(Widget\u00adOptions&)<\/code>.<\/p>\n
So all of them are telling you that the std::make_shared<Widget(options)<\/code> is the line of code that created the problem, and the reason is that it couldn’t find a suitable Widget<\/code> constructor.<\/p>\n
Study the part of the message that explains why each candidate was unsuitable, and look at the part where the compiler rejects the constructor you thought you were using. In our case, we wanted to use the Widget(WidgetOptions const* options)<\/code> constructor.<\/p>\n
\/\/ clang\r\nno known conversion for argument 1 from 'WidgetOptions' to 'const WidgetOptions*'\r\n\r\n\/\/ gcc\r\nno known conversion from 'WidgetOptions' to 'const WidgetOptions *' for 1st argument; take the address of the argument with &\r\n\r\n\/\/ msvc\r\ncannot convert argument 1 from 'WidgetOptions' to 'const WidgetOptions *'\r\n<\/pre>\n
The problem is that we passed a Widget\u00adOptions<\/code> object, but the constructor wanted a const Widget\u00adOptions*<\/code> pointer. We should have passed a pointer to the options rather than the options itself. The gcc compiler even guessed that that was what you intended.<\/p>\n
So that’s the trick: Read the start of the error message to find out what went wrong, and then skip over all the intermediate steps to find the line of code you wrote that caused the error. Use your understanding of what your code was trying to do to understand why the compiler couldn’t do it. In our case, we were trying to construct a shared Widget<\/code>, and our attention was drawn to the inability to call the constructor correctly.<\/p>\n
Bonus chatter<\/b>: The library authors could do us a solid here and add a special diagnostic to identify the problem sooner. They could put something at the start of make_shared<\/code> like this:<\/p>\n
static_assert(std::is_constructible_v<_Tp, _Args&&>,\r\n    \"Cannot construct the object from the provided parameters. \"\r\n    \"See subsequent error messages for details.\");\r\n<\/pre>\n
This adds a message to the error spew that helps guide the developer to the part of the subsequent error message that they should focus on.<\/p>\n","protected":false},"excerpt":{"rendered":"
Understanding what you asked the compiler to do, and why it couldn’t comply.<\/p>\n","protected":false},"author":1069,"featured_media":111744,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[25],"class_list":["post-110619","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-code"],"acf":[],"blog_post_summary":"
Understanding what you asked the compiler to do, and why it couldn’t comply.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/110619","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/users\/1069"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/comments?post=110619"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/110619\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media\/111744"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media?parent=110619"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=110619"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=110619"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}