1088845 - Annotate mozilla::pkix code so that compilers report missing return value checks

Status: NEW

(NSS :: Libraries, enhancement, P5)

Description

[Brian Smith (:briansmith, :bsmith, use NEEDINFO?)]

+++ This bug was initially created as a clone of Bug #1083539 +++

See bug 1083539. During routine refactoring I accidentally a return value check. Although it is probably impossible to write perfect code, such bugs should be allowed to exist in code that gets checked in. MSVC supports functions being annotated with _Check_return_ (when SAL is enabled), GCC has __attribute__((warn_unused_result)), the Linux kernel has the __must_check macro, MFBT has MOZ_WARN_UNUSED_RESULT (which doesn't support MSVC), etc.

We should also look into other SAL and static analysis attributes for mozilla::pkix, in follow-up bugs.

The current MOZILLA_PKIX_ prefix on macros defined by mozilla::pkix is a little unwieldy to use for annotations on every function and/or argument declaration. We should find a shorter prefix.

Comment 1

[Dana Keeler (she/her) (use needinfo) [:keeler]]

mozilla::pkix is part of NSS now