JPL Checks

JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.

If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.

If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.

If you access the manual through the hub's Web GUI, the functionality will not be suppressed because the hub is a web server.
Alternatively, your browser may allow you to explicitly disable the security setting that suppresses functionality. See the CodeSonar FAQ for more information.

CodeSonar^® 9.2p0

CONFIDENTIAL

CodeSecure Inc

JPL Checks

The categories list for each CodeSonar warning includes any relevant JPL rule numbers.

A broader set of correspondences is shown in Broad Mapping: JPL.

CSV tables of warning classes by JPL rule are provided in JPL-mapping.csv.

The JPL Rules
Relevant Warning Classes
Enabling JPL Checks

The JPL Rules

The phrase "JPL Rules" is shorthand for JPL Institutional Coding Standard for the C Programming Language [*]. There is some overlap with The Power of Ten Rules.

Relevant Warning Classes

The following table shows the CodeSonar warning classes that are associated with JPL rules.

JPL	C/C++ Warning Classes
JPL:1 Do not stray outside the language definition.	C++ Comment in C GNU Extension GNU Typeof Microsoft Extension
JPL:2 Compile with all warnings enabled; use static source code analyzers.	Not All Warnings Are Enabled Warnings Not Treated As Errors
JPL:3 Use verifiable loop bounds for all loops meant to be terminating.	Potential Unbounded Loop
JPL:4 Do not use direct or indirect recursion.	Recursion
JPL:5 Do not use dynamic memory allocation after task initialization.	Dynamic Allocation After Initialization Use of <stdlib.h> Allocator/Deallocator Use of <stdlib.h> Allocator/Deallocator Macro Use of delete Use of new
JPL:6 Use IPC messages for task communication.	-
JPL:7 Do not use task delays for task synchronization.	Task Delay Function
JPL:8 Explicitly transfer write-permission (ownership) for shared data objects.	-
JPL:9 Place restrictions on the use of semaphores and locks.	Conflicting Lock Order Lock/Unlock Mismatch Locked Twice Missing Lock Acquisition Missing Lock Release Nested Locks Unknown Lock
JPL:10 Use memory protection, safety margins, barrier patterns.	-
JPL:11 Do not use goto, setjmp or longjmp.	Goto Statement Use of <setjmp.h> Use of longjmp Use of setjmp
JPL:12 Do not use selective value assignments to elements of an enum list.	Inconsistent Enumerator Initialization
JPL:13 Declare data objects at smallest possible level of scope.	Non-distinct Identifiers: Nested Scope Scope Could Be File Static Scope Could Be Local Static
JPL:14 Check the return value of non-void functions, or explicitly cast to (void).	Ignored Return Value
JPL:15 Check the validity of values passed to functions.	Unchecked Parameter Dereference
JPL:16 Use static and dynamic assertions as sanity checks.	Not Enough Assertions
JPL:17 Use U32, I16, etc instead of predefined C data types such as int, short, etc.	Basic Numerical Type Used
JPL:18 Make the order of evaluation in compound expressions explicit.	Indeterminate Order of Evaluation Missing Parentheses
JPL:19 Do not use expressions with side effects.	Assignment Result in Expression Condition Contains Side Effects Side Effects in Expression with Decrement Side Effects in Expression with Increment Side Effects in Initializer List Side Effects in Logical Operand Side Effects in sizeof Too Many Side Effects in Assignment Too Many Side Effects in Condition Too Many Side Effects in Function Call Too Many Side Effects in Statement Too Many Side Effects in Switch
JPL:20 Make only very limited use of the C pre-processor.	## Follows # Operator Conditional Compilation Macro Argument is both Mixed and Expanded Macro Does Not End With } or ) Macro Does Not Start With { or ( Macro Name is C Keyword Macro Uses # Operator Macro Uses ## Operator Non-Boolean Preprocessor Expression Preprocessing Directives in Macro Argument Recursive Macro Unbalanced Parenthesis Use of <stdio.h> Input/Output Macro Use of <wchar.h> Input/Output Macro Variadic Macro
JPL:21 Do not define macros within a function or a block.	Macro Defined in Function Body Macro Undefined in Function Body
JPL:22 Do not undefine or redefine macros.	Macro Undefinition of Reserved Name Use of #undef
JPL:23 Place #else, #elif, and #endif in the same file as the matching #if or #ifdef.	No Matching #endif No Matching #if
JPL:24 Place no more than one statement or declaration per line of text.	Multiple Declarations On Line Multiple Statements On Line
JPL:25 Use short functions with a limited number of parameters.	Ellipsis Function Too Long Too Many Parameters
JPL:26 Use no more than two levels of indirection per declaration.	Too Much Indirection in Declaration
JPL:27 Use no more than two levels of dereferencing per object reference.	Too Many Dereferences
JPL:28 Do not hide dereference operations inside macros or typedefs.	Macro Uses -> Operator Macro Uses Unary * Operator Macro Uses [] Operator Pointer Type Inside Typedef
JPL:29 Do not use non-constant function pointers.	-
JPL:30 Do not cast function pointers into other types.	Conversion from Function Pointer Function Pointer Conversion
JPL:31 Do not place code or declarations before an #include directive.	Code Before #include

Enabling JPL Checks

Because the rules are extremely strict, most of the associated checks are disabled by default.

CodeSonar ships with a taxonomy preset for JPL checks:

jpl

Enables warning classes such that a given class C is enabled if all of the following are true.

C is closely mapped to one or more JPL rules (that is, it appears in the table above), and
no other classes enabled by the preset are more closely related to the same rules, and
C is not diagnostic-only (that is, it does not have a DIAG.* mnemonic).

You can apply the jpl preset to the CodeSonar build/analysis as shown in the following table.

Command Line	Specify -preset jpl as part of your build/analysis command. For example: codesonar analyze MyProj -preset jpl localhost:7340 make
Define as a default preset	Copy jpl.conf from $CSONAR/codesonar/presets/ to $CSONAR/codesonar/default_presets/. OR Use the CodeSonar Configuration Tool Modify Analysis Settings option.
Windows Build Wizard	Select jpl from the Preset list on screen 2.
Eclipse Plug-In	Select jpl from the Presets list in the Properties dialog.
Visual Studio Plug-In	Select jpl from the Presets list in the Project Properties dialog.

Enabling checks for specific rules

To enable checks for all the warning classes associated with a specific JPL rule, include the following in the project configuration file:

WARNING_FILTER += allow categories:"JPL:num"
RETAIN_UNNORMALIZED_C_AST = yes

num is the JPL rule number.
To enable checks for several rule numbers, include several WARNING_FILTER lines of this form.
If none of the warning classes require it (check individual warning class pages for requirements), you can omit RETAIN_UNNORMALIZED_C_AST = yes.

Enabling individual warning classes

To enable a single warning class check, follow the instructions in the documentation for the corresponding warning class. Warning class documentation links are provided above.

[*] http://lars-lab.jpl.nasa.gov/JPL_Coding_Standard_ext.pdf

To report problems with this documentation, please visit https://support.codesecure.com/.