Turn on /analyze and fix resulting warnings #1009

BillyONeal · 2020-07-07T09:30:05Z

This is to resolve Microsoft-internal:

(which all boil down to 'getting yelled at for not turning on /analyze')

Functional changes:

Added annotations for consistency to definitions
Added what I hope are 'obvious' _Analysis_assume_s
When a function sometimes filled in a value and sometimes did not, and the parameter was annotated _Out_, I removed the annotation as the annotations to tell PREfast that the parameter is conditionally _Out_ exceed any value they might give us.
Filed multprec.cpp: _MP_Rem has apparently nonsense memory read #1008 for a 'probably a bug but I'm not sure' case in _MP_Rem
Blindly suppressed additional warnings in ConcRT and Boost as there is nothing we can do about them here
Changed __crtInitializeCriticalSectionEx to return the value of InitializeCriticalSectionAndSpinCount rather than always return TRUE; in Vista or later this is no functional change, and on XP it will pass through the result correctly. Most callers are still ignoring the return value (as they probably should, now) but this avoids a warning here.
Changed _Wcsxfrm to use RAII to record when bbuffer is allocated rather than extra null checks.
Changed Xp_setw to hoist constexpr comparisons into an if constexpr block.
Added _PThrow null check before calling RtlPcToFileHeader in excptptr.cpp.

…ant' by making the constant comparison constexpr.

…ock.

StephanTLavavej

The arm/arm64 builds are failing. From the error log:

C:\agent\_work\1\s\stl\src\winapisupp.cpp(493,1): error C2220: the following warning is treated as an error
C:\agent\_work\1\s\stl\src\winapisupp.cpp(490) : warning C28251: Inconsistent annotation for '__crtQueueUserWorkItem': this instance has no annotations. See c:\agent\_work\1\s\stl\src\awint.hpp(232).

BillyONeal · 2020-07-15T03:06:57Z

(In fact I'd rather this land after the atomic wait stuff since that adds new APIs that are likely to make PREfast unhappy)

And follow the style in threadpoollegacyapiset.h.

The functional changes are: * `__crtFlsAlloc`: Change `lpCallback` from `__in` to `_In_opt_` as declared in `fibersapi.h` * `__crtCreateEventExW`: Change `dwFlags` from `__reserved` to `_In_` as declared in `synchapi.h` * `__crtGetFileInformationByHandleEx`: Change `lpFileInformation` from `_Out_` to `_Out_writes_bytes_(dwBufferSize)` as declared in `WinBase.h` * `__crtSetFileInformationByHandle`: Change `lpFileInformation` from `_In_` to `_In_reads_bytes_(dwBufferSize)` as declared in `fileapi.h` * `__crtGetLocaleInfoEx`: Change `lpLCData` from `_Out_opt_` to `_Out_writes_opt_(cchData)` as declared in `WinNls.h`

StephanTLavavej · 2020-07-15T04:28:07Z

Building with /analyze is noticeably slower. Are there other possibilities, like making this off-by-default for developers, but with coverage in the CI, assuming that /analyze build breaks will be relatively rare?

BillyONeal · 2020-07-15T04:29:22Z

Building with /analyze is noticeably slower. Are there other possibilities, like making this off-by-default for developers, but with coverage in the CI, assuming that /analyze build breaks will be relatively rare?

Sure, we can do that; I didn't bother before because I figure our test pass takes ~an hour and our build takes ~30 seconds, and turning this on makes it take ~45 seconds; but the test pass still dominates. Making it a CMake configurable option is probably a good idea.

StephanTLavavej · 2020-07-15T04:36:56Z

Pushed a fix for the build break, which was simple - define __crtQueueUserWorkItem with SAL, like the rest of the definitions. But then I noticed that awint.hpp had different SAL annotations from the WinSDK, some stylistic but some significant. I updated the SAL, changing deprecated __meow to modern _Meow_ (note: not a mechanical in-place conversion; each occurrence was taken from the WinSDK) and fixing the differences. (I'm not sure if they were taken from an older WinSDK, or what. I used the WinSDK that's currently checked into the MSVC-internal repo.)

I ran full clean builds of x86/x64/arm/arm64 and they succeeded.

BillyONeal · 2020-07-15T04:47:26Z

Thanks for running that down Stephan :D

Fixed build break, need to actually review changes now

# Conflicts: # stl/inc/xfilesystem_abi.h # stl/src/filesystem.cpp

StephanTLavavej · 2020-08-03T22:17:18Z

I resolved the merge conflict; the code in parallel_algorithms.cpp was deleted, and I verified that this PR's addition of _Analysis_assume_(_Kernel32); didn't need to be moved anywhere else.

BillyONeal · 2020-08-04T00:02:39Z

Thanks STL

StephanTLavavej

Only change requested is to make the /analyze build off by default, and enabled for PR/CI builds.

stl/src/filesystem.cpp

BillyONeal · 2020-08-24T20:41:56Z

Thanks Curtis!

cbezault · 2020-08-24T20:51:08Z

I'm not sure how to verify that the changes I made make /analyze run in the CI since the output isn't any different...

CaseyCarter · 2020-08-24T20:56:12Z

I'm not sure how to verify that the changes I made make /analyze run in the CI since the output isn't any different...

Temporarily Inject a code pattern that /analyze warns about and see if the CI breaks? (Possibly as a test PR from a different branch so as not to break this one?)

StephanTLavavej · 2020-08-26T01:44:47Z

The build break was that /clr:pure is /std:c++14, so using if constexpr in xxxprec.hpp triggered the Future Technology warning. The simplest way to silence this was to use the STL's header warning suppression machinery, which determines whether that warning needs to be suppressed (in addition to silencing other noise that we never care about). I didn't use the whole public header guard, just the MSVC warning fragment.

StephanTLavavej · 2020-08-26T06:47:19Z

Analyzing change... 🤖 Beep! Thanks for this improvement, human! 🚀

BillyONeal added 11 commits July 7, 2020 02:08

Turn on /analyze.

fdb4607

Add matching set_new_handler annotation.

60fe5d9

Suppress C6326 'Potential comparison of a constant with another const…

a878d5c

…ant' by making the constant comparison constexpr.

Unpack Xp_setw to get the constant comparison into an if constexpr bl…

def3994

…ock.

Teach PREfast about maxsig in the _Stoflt family.

cefc151

Fix annotations on __crtLocale functions in awint.h.

efbb5e8

Fix a bunch of annotations.

626ed31

Rename _Inf to _Infinity due to shadowing.

02c7021

Remove branch and casts for __crtLCMapStringW call.

8413970

Suppress some /analyze warnings.

5d40f06

Fix more /analyze warnings found building x64.

eea4db3

BillyONeal requested a review from a team as a code owner July 7, 2020 09:30

clang-format

4a5e0db

CaseyCarter added the bug Something isn't working label Jul 7, 2020

StephanTLavavej added 2 commits July 8, 2020 21:24

clang-format xfilesystem_abi.h.

4a5c8a6

Merge branch 'master' into analyze

5bcd4b1

StephanTLavavej previously requested changes Jul 9, 2020

View reviewed changes

Merge branch 'master' into analyze

40ec5fa

This comment has been minimized.

Sign in to view

StephanTLavavej added 2 commits July 14, 2020 20:10

Define __crtQueueUserWorkItem with SAL.

0ab6312

And follow the style in threadpoollegacyapiset.h.

StephanTLavavej self-requested a review July 15, 2020 08:32

BillyONeal self-assigned this Jul 16, 2020

Merge remote-tracking branch 'origin/master' into analyze

91a7d7c

# Conflicts: # stl/inc/xfilesystem_abi.h # stl/src/filesystem.cpp

StephanTLavavej unassigned BillyONeal Aug 1, 2020

This comment has been minimized.

Sign in to view

Merge branch 'master' into analyze

6e5f3e2

mnatsuhara approved these changes Aug 19, 2020

View reviewed changes

StephanTLavavej self-assigned this Aug 19, 2020

mnatsuhara assigned cbezault Aug 19, 2020

StephanTLavavej requested changes Aug 20, 2020

View reviewed changes

stl/src/filesystem.cpp Show resolved Hide resolved

stl/src/filesystem.cpp Show resolved Hide resolved

StephanTLavavej removed their assignment Aug 20, 2020

cbezault added the build Related to the build system label Aug 24, 2020

Only /analyze during CI

36c1268

BillyONeal requested a review from StephanTLavavej August 24, 2020 20:41

cbezault requested a review from mnatsuhara August 24, 2020 20:44

StephanTLavavej approved these changes Aug 24, 2020

View reviewed changes

mnatsuhara approved these changes Aug 25, 2020

View reviewed changes

StephanTLavavej unassigned cbezault Aug 25, 2020

Fix /clr:pure build break.

c42d5eb

StephanTLavavej self-assigned this Aug 26, 2020

StephanTLavavej merged commit 5bf2826 into microsoft:master Aug 26, 2020

BillyONeal deleted the analyze branch September 23, 2020 02:43

StephanTLavavej mentioned this pull request Jun 21, 2022

[benchmark] add gbenchmark #2780

Merged

4 tasks

Turn on /analyze and fix resulting warnings #1009

Turn on /analyze and fix resulting warnings #1009

Uh oh!

Conversation

BillyONeal commented Jul 7, 2020 • edited by StephanTLavavej Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

StephanTLavavej left a comment

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

This comment has been minimized.

BillyONeal commented Jul 15, 2020

Uh oh!

StephanTLavavej commented Jul 15, 2020

Uh oh!

BillyONeal commented Jul 15, 2020

Uh oh!

StephanTLavavej commented Jul 15, 2020

Uh oh!

BillyONeal commented Jul 15, 2020

Uh oh!

This comment has been minimized.

StephanTLavavej commented Aug 3, 2020

Uh oh!

BillyONeal commented Aug 4, 2020

Uh oh!

StephanTLavavej left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

BillyONeal commented Aug 24, 2020

Uh oh!

cbezault commented Aug 24, 2020

Uh oh!

CaseyCarter commented Aug 24, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

StephanTLavavej commented Aug 26, 2020

Uh oh!

StephanTLavavej commented Aug 26, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

BillyONeal commented Jul 7, 2020 •

edited by StephanTLavavej

Loading

CaseyCarter commented Aug 24, 2020 •

edited

Loading