Bug 160565 – Undefined behavior in StdLibExtras.h, bitCount

• Component: Web Template Framework
• Status: RESOLVED INVALID

[Jonathan Bedard]

In StdLibExtras.h bitCount, there is undefined behavior on return.  The line:
    return (((bits + (bits >> 4)) & 0xF0F0F0F) * 0x1010101) >> 24
almost always has undefined behavior.  In this case, the overflow is expected.  However, compiler optimization (given that this function is an inline) with constants may preform unexpected operations

[Jonathan Bedard]

Created attachment 285364 [details]
Patch

[Jonathan Bedard]

Here is the error message clang's undefined behavior sanitizer emits for this particular error:

/Volumes/Data/Code/UndefinedBehavior/OpenSource/WebKitBuild/Debug/usr/local/include/wtf/StdLibExtras.h:163:48: runtime error: unsigned integer overflow: 1025 * 16843009 cannot be represented in type 'unsigned int'

Further investigation on this has revealed that clang is combining some 'suspicious' behaviors with 'undefined' behaviors, and this is a case of 'suspicious' behavior, but, as per C++ 2014 standard 3.9.1, 4, unsigned types overflow with modulo 2^n, which is our desired behavior in this case.  In short, the behavior corrected here is both defined and desired.

Undefined behavior sanitizer information: http://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html

C++ standard:
http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4296.pdf

No fix is needed.  Marking as resolved.