{"id":26726,"date":"2020-10-06T17:56:43","date_gmt":"2020-10-06T17:56:43","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/cppblog\/?p=26726"},"modified":"2020-10-06T17:58:52","modified_gmt":"2020-10-06T17:58:52","slug":"c-core-check-in-visual-studio","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/cppblog\/c-core-check-in-visual-studio\/","title":{"rendered":"C++ Core Check in Visual Studio"},"content":{"rendered":"

C++ Core Check is Microsoft\u2019s static analysis tool that enforces the rules from the C++ Core Guidelines<\/a>, which is maintained by the C++ Foundation. This post is to provide a snapshot of the C++ Core Guidelines coverage that C++ Core Check offers.<\/p>\n

For background, the C++ team introduced C++ Core Check in December 2015 as part of Visual Studio 2015 Update 1<\/a>. At the time of its release, C++ Core Check offered rules from the Bounds profile<\/a> and Type profile<\/a> with the promise of the Lifetimes profile<\/a> to follow.<\/p>\n

The C++ team has been expanding C++ Core Check’s coverage over the last five years. We have added more rules into the existing Type, Bounds, and Lifetimes profiles and have expanded into other areas of the C++ Core Guidelines, which you can see in the tables at the bottom of the post. For a more detailed view into the growth and evolution of C++ Core Check, see the other posts in our blog tagged “CppCoreCheck”<\/a>.<\/span><\/p>\n

The C++ Core Guidelines is an ever-evolving document that currently contains 482 rules, however only 263 of these provide guides that are enforceable by static analysis (Enforceable Set). At the time of writing, C++ Core Check covers 67 rules from the Enforceable Set. We are actively expanding the coverage as well as fixing issues raised on the Developer Community<\/a>\u00a0page.<\/p>\n

1<\/sup>\u00a0This excludes rules that are philosophical, code-style based rules, rules marked as “impossible to enforce”, or those that are meant to be interpreted and enforced by each codebase’s maintainers.<\/p>\n

 <\/p>\n

Mapping of C++ Core Guidelines rules to C++ Core Check warnings<\/h3>\n

Type Profile<\/a><\/h4>\n\n\n\n\n\n\n\n\n\n\n
C++ Core Guidelines Rule<\/strong><\/td>\nC++ Core Check warning(s)<\/strong><\/td>\n<\/tr>\n
Type.1<\/td>\nC26471<\/a>, C26472<\/a>, C26473<\/a>, C26474<\/a>, C26490<\/a><\/td>\n<\/tr>\n
Type.2<\/td>\nC26466<\/a>, C26491<\/a><\/td>\n<\/tr>\n
Type.3<\/td>\nC26465<\/a>, C26492<\/a><\/td>\n<\/tr>\n
Type.4<\/td>\nC26493<\/a><\/td>\n<\/tr>\n
Type.5<\/td>\nC26494<\/a><\/td>\n<\/tr>\n
Type.6<\/td>\nC26495<\/a><\/td>\n<\/tr>\n
Type.7<\/td>\nC26496<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

Bounds Profile<\/a><\/h4>\n\n\n\n\n\n\n\n
C++ Core Guidelines Rule<\/strong><\/td>\nC++ Core Check warning(s)<\/strong><\/td>\n<\/tr>\n
Bounds.1<\/td>\nC26481<\/a><\/td>\n<\/tr>\n
Bounds.2<\/td>\nC26482<\/a>, C26483<\/a><\/td>\n<\/tr>\n
Bounds.3<\/td>\nC26485<\/a><\/td>\n<\/tr>\n
Bounds.4<\/td>\nC26446<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

Lifetimes Profile<\/a><\/h4>\n\n\n\n\n\n\n\n\n
C++ Core Guidelines Rule<\/strong><\/td>\nC++ Core Check warning(s)<\/strong><\/td>\n<\/tr>\n
Lifetime.1<\/td>\nC26488<\/a>, C26489<\/a>, C26800<\/a>, C26810<\/a>, C26811<\/a><\/td>\n<\/tr>\n
Lifetime.3<\/td>\nC26486<\/a><\/td>\n<\/tr>\n
Lifetime.4<\/td>\nC26487<\/a><\/td>\n<\/tr>\n
Lifetime.ptrtotemp<\/td>\nC26815<\/a><\/td>\n<\/tr>\n
Lifetime.ptrtostack<\/td>\nC26816<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

C: Classes and class hierarchy<\/a><\/h4>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
C++ Core Guidelines Rule<\/strong><\/td>\nC++ Core Check warning(s)<\/strong><\/td>\n<\/tr>\n
C.21<\/td>\nC26432<\/a><\/td>\n<\/tr>\n
C.35<\/td>\nC26436<\/a><\/td>\n<\/tr>\n
C.41<\/td>\nC26495<\/a><\/td>\n<\/tr>\n
C.52<\/td>\nC26495<\/a><\/td>\n<\/tr>\n
C.66<\/td>\nC26493<\/a><\/td>\n<\/tr>\n
C.84<\/td>\nC26493<\/a><\/td>\n<\/tr>\n
C.85<\/td>\nC26493<\/a><\/td>\n<\/tr>\n
C.127<\/td>\nC26436<\/a><\/td>\n<\/tr>\n
C.128<\/td>\nC26433<\/a>, C26434<\/a>, C26435<\/a>, C26443<\/a>, C26456<\/a><\/td>\n<\/tr>\n
C.146<\/td>\nC26466<\/a><\/td>\n<\/tr>\n
C.149<\/td>\nC26409<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

Con: Constants and immutability<\/a><\/h4>\n\n\n\n\n\n\n\n
C++ Core Guidelines Rule<\/strong><\/td>\nC++ Core Check warning(s)<\/strong><\/td>\n<\/tr>\n
Con.1<\/td>\nC26496<\/a><\/td>\n<\/tr>\n
Con.3<\/td>\nC26460<\/a>, C26461<\/a><\/td>\n<\/tr>\n
Con.4<\/td>\nC26462<\/a>, C26463<\/a>, C26464<\/a>, C26496<\/a><\/td>\n<\/tr>\n
Con.5<\/td>\nC26498<\/a>, C26814<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

CP.con: Concurrency<\/a><\/h4>\n\n\n\n\n
C++ Core Guidelines Rule<\/strong><\/td>\nC++ Core Check warning<\/strong><\/td>\n<\/tr>\n
CP.44<\/td>\nC26441<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

E: Error handling<\/a><\/h4>\n\n\n\n\n
C++ Core Guidelines Rule<\/strong><\/td>\nC++ Core Check warning<\/strong><\/td>\n<\/tr>\n
E.16<\/td>\nC26495<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

Enum: Enumerations<\/a><\/h4>\n\n\n\n\n
C++ Core Guidelines Rule<\/strong><\/td>\nC++ Core Check warning<\/strong><\/td>\n<\/tr>\n
Enum.3<\/td>\nC26812<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

ES: Expressions and statements<\/a><\/h4>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
C++ Core Guidelines Rule<\/strong><\/td>\nC++ Core Check warning<\/strong><\/td>\n<\/tr>\n
ES.24<\/td>\nC26409<\/a><\/td>\n<\/tr>\n
ES.25<\/td>\nC26462<\/a><\/td>\n<\/tr>\n
ES.46<\/td>\nCompiler warning: C4244<\/td>\n<\/tr>\n
ES.47<\/td>\nC26477<\/a><\/td>\n<\/tr>\n
ES.49<\/td>\nC26475<\/a><\/td>\n<\/tr>\n
ES.50<\/td>\nC26492<\/a><\/td>\n<\/tr>\n
ES.56<\/td>\nC26478<\/a><\/td>\n<\/tr>\n
ES.60<\/td>\nC26409<\/a><\/td>\n<\/tr>\n
ES.61<\/td>\nC26409<\/a><\/td>\n<\/tr>\n
ES.63<\/td>\nC26437<\/a><\/td>\n<\/tr>\n
ES.65<\/td>\nSee Lifetimes.1<\/td>\n<\/tr>\n
ES.71<\/td>\nC26817<\/a><\/td>\n<\/tr>\n
ES.76<\/td>\nC26438<\/a><\/td>\n<\/tr>\n
ES.78<\/td>\nC26819<\/a><\/td>\n<\/tr>\n
ES.79<\/td>\nC26818<\/a><\/td>\n<\/tr>\n
ES.84<\/td>\nC26444<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

F: Functions<\/a><\/h4>\n\n\n\n\n\n\n
C++ Core Guidelines Rule<\/strong><\/td>\nC++ Core Check warning(s)<\/strong><\/td>\n<\/tr>\n
F.4<\/td>\nC26497<\/a><\/td>\n<\/tr>\n
F.6<\/td>\nC26439<\/a>, C26440<\/a>, C26447<\/a><\/td>\n<\/tr>\n
F.23<\/td>\nC26429<\/a>, C26430<\/a>, C26431<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

I: Interfaces<\/a><\/h4>\n\n\n\n\n\n
C++ Core Guidelines Rule<\/strong><\/td>\nC++ Core Check warning(s)<\/strong><\/td>\n<\/tr>\n
I.11<\/td>\nC26400<\/a>, C26401<\/a><\/td>\n<\/tr>\n
I.22<\/td>\nC26426<\/a>, C26427<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

P: Philosophy<\/a><\/h4>\n\n\n\n\n
C++ Core Guidelines Rule<\/strong><\/td>\nC++ Core Check warning<\/strong><\/td>\n<\/tr>\n
P.9<\/td>\nC26820<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

R: Resource management<\/a><\/h4>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
C++ Core Guidelines Rule<\/strong><\/td>\nC++ Core Check warning<\/strong><\/td>\n<\/tr>\n
R.3<\/td>\nC26402<\/a>, C26403<\/a>, C26404<\/a>, C26406<\/a><\/td>\n<\/tr>\n
R.5<\/td>\nC26407<\/a>, C26414<\/a><\/td>\n<\/tr>\n
R.10<\/td>\nC26408<\/a><\/td>\n<\/tr>\n
R.11<\/td>\nC26409<\/a><\/td>\n<\/tr>\n
R.20<\/td>\nC26409<\/a><\/td>\n<\/tr>\n
R.23<\/td>\nC26409<\/a><\/td>\n<\/tr>\n
R.30<\/td>\nC26415<\/a><\/td>\n<\/tr>\n
R.32<\/td>\nC26410<\/a><\/td>\n<\/tr>\n
R.33<\/td>\nC26411<\/a><\/td>\n<\/tr>\n
R.34<\/td>\nC26416<\/a><\/td>\n<\/tr>\n
R.35<\/td>\nC26417<\/a><\/td>\n<\/tr>\n
R.36<\/td>\nC26418<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

Additionally, C++ Core Check also publishes a few rules that do not directly map to the C++ Core Guidelines.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
C++ Core Guidelines Inspired Rule<\/strong><\/td>\nC++ Core Check warning<\/strong><\/td>\n<\/tr>\n
GSL.view<\/td>\nC26445<\/a>, C26449<\/a><\/td>\n<\/tr>\n
GSL.util<\/td>\nC26448<\/a><\/td>\n<\/tr>\n
Io.1<\/td>\nC26450<\/a><\/td>\n<\/tr>\n
Io.2<\/td>\nC26451<\/a><\/td>\n<\/tr>\n
Io.3<\/td>\nC26452<\/a><\/td>\n<\/tr>\n
Io.4<\/td>\nC26453<\/a><\/td>\n<\/tr>\n
Io.5<\/td>\nC26454<\/a><\/td>\n<\/tr>\n
STL.1<\/td>\nC26459<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

All of these rules are available in Visual Studio. The checkers from the “Microsoft Native Recommended Rules” ruleset already appear in-editor in the form of green squiggles: see in-editor code analysis<\/a>.<\/p>\n

\"Visual<\/p>\n

To run the C++ Core Check rules, navigate to the project properties dialog and select the “C++ Core Check rules” in the Code analysis pane.<\/span><\/p>\n

\"Image<\/p>\n

For more information about the various rulesets and configuring them please visit <\/span>Quickstart: Code analysis for C\/C++<\/a>.<\/span><\/p>\n

Next steps:<\/h3>\n

If there are any rules you’d like to see added, please visit the Suggest a Feature<\/a> page and tag your rule C++ Core Check. See the Microsoft Docs<\/a> page for in-depth examples and explanations for each of the warnings that C++ Core Check offers. We can be reached via the comments below or @VisualC on Twitter.<\/p>\n

 <\/p>\n","protected":false},"excerpt":{"rendered":"

C++ Core Check is Microsoft\u2019s static analysis tool that enforces the rules from the C++ Core Guidelines, which is maintained by the C++ Foundation. This post is to provide a snapshot of the C++ Core Guidelines coverage that C++ Core Check offers. For background, the C++ team introduced C++ Core Check in December 2015 as […]<\/p>\n","protected":false},"author":6068,"featured_media":26823,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[119,245,163],"class_list":["post-26726","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-cplusplus","tag-code-analysis","tag-cppcorecheck","tag-static-analysis"],"acf":[],"blog_post_summary":"

C++ Core Check is Microsoft\u2019s static analysis tool that enforces the rules from the C++ Core Guidelines, which is maintained by the C++ Foundation. This post is to provide a snapshot of the C++ Core Guidelines coverage that C++ Core Check offers. For background, the C++ team introduced C++ Core Check in December 2015 as […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/posts\/26726","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/users\/6068"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/comments?post=26726"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/posts\/26726\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/media\/26823"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/media?parent=26726"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/categories?post=26726"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/tags?post=26726"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}