CWE Rule 457
Description
Rule Description
The code uses a variable that has not been initialized, leading to unpredictable or unintended results.
Polyspace Implementation
The rule checker checks for these issues:
Member not initialized in constructor
Non-initialized pointer
Non-initialized variable
Examples
Member not initialized in constructor
This issue occurs when a class constructor has at least one execution path on which it does not initialize some data members of the class.
The defect does not appear in the following cases:
Empty constructors.
The non-initialized member is not used in the code.
The members that the constructor does not initialize can have unintended values when you read them later.
Initializing all members in the constructor makes it easier to use your class. If you call a separate method to initialize your members and then read them, you can avoid uninitialized values. However, someone else using your class can read a class member before calling your initialization method. Because a constructor is called when you create an object of the class, if you initialize all members in the constructor, they cannot have uninitialized values later on.
The best practice is to initialize all members in your constructor, preferably in an initialization list.
class MyClass { public: explicit MyClass(int); private: int _i; char _c; }; MyClass::MyClass(int flag) { if(flag == 0) { _i = 0; _c = 'a'; } else { _i = 1; } } //Noncompliant
In this example, if flag
is not 0, the member _c
is
not initialized.
The defect appears on the closing brace of the constructor. Following are some tips for navigating in the source code:
On the Result Details pane, see which members are not initialized.
To navigate to the class definition, right-click a member that is initialized in the constructor. Select Go To Definition. In the class definition, you can see all the members, including those members that are not initialized in the constructor.
One possible correction is to initialize all
members of the class MyClass
for all
values of flag
.
class MyClass { public: explicit MyClass(int); private: int _i; char _c; }; MyClass::MyClass(int flag) { if(flag == 0) { _i = 0; _c = 'a'; } else { _i = 1; _c = 'b'; } }
Non-initialized pointer
This issue occurs when a pointer is not assigned an address before dereference.
Unless a pointer is explicitly assigned an address, it points to an unpredictable location.
The fix depends on the root cause of the defect. For instance, you assigned an address to the pointer but the assignment is unreachable.
Often the result details (or source code tooltips in Polyspace as You Code) show a sequence of events that led to the defect. You can implement the fix on any event in the sequence. If the result details do not show this event history, you can search for previous references of variables relevant to the defect using right-click options in the source code and find related events. See also Interpret Bug Finder Results in Polyspace Desktop User Interface or Interpret Bug Finder Results in Polyspace Access Web Interface (Polyspace Access).
See examples of fixes below. It is a good practice to initialize a pointer to NULL when declaring the pointer.
If you do not want to fix the issue, add comments to your result or code to avoid another review. See:
Address Results in Polyspace User Interface Through Bug Fixes or Justifications if you review results in the Polyspace user interface.
Address Results in Polyspace Access Through Bug Fixes or Justifications (Polyspace Access) if you review results in a web browser.
Annotate Code and Hide Known or Acceptable Results if you review results in an IDE.
If a pointer in your code is non-initialized only for certain system input values, you can see one possible combination of input values causing the defect. See Extend Bug Finder Checkers to Find Defects from Specific System Input Values.
#include <stdlib.h> int* assign_pointer(int* prev) { int j = 42; int* pi; if (prev == NULL) { pi = (int*)malloc(sizeof(int)); if (pi == NULL) return NULL; } *pi = j; //Noncompliant /* Defect: Writing to uninitialized pointer */ return pi; }
If prev
is not NULL
,
the pointer pi
is not assigned an address. However, pi
is
dereferenced on every execution paths, irrespective of whether prev
is NULL
or
not.
One possible correction is to assign an address
to pi
when prev
is not NULL
.
#include <stdlib.h> int* assign_pointer(int* prev) { int j = 42; int* pi; if (prev == NULL) { pi = (int*)malloc(sizeof(int)); if (pi == NULL) return NULL; } /* Fix: Initialize pi in branches of if statement */ else pi = prev; *pi = j; return pi; }
Non-initialized variable
This issue occurs when a variable is not initialized before its value is read.
Unless a variable is explicitly initialized, the variable value is unpredictable. You cannot rely on the variable having a specific value.
The fix depends on the root cause of the defect. For instance, you assigned a value to the variable but the assignment is unreachable or you assigned a value to the variable in one of two branches of a conditional statement. Fix the unreachable code or missing assignment.
Often the result details (or source code tooltips in Polyspace as You Code) show a sequence of events that led to the defect. You can implement the fix on any event in the sequence. If the result details do not show this event history, you can search for previous references of variables relevant to the defect using right-click options in the source code and find related events. See also Interpret Bug Finder Results in Polyspace Desktop User Interface or Interpret Bug Finder Results in Polyspace Access Web Interface (Polyspace Access).
See examples of fixes below. It is a good practice to initialize a variable at declaration.
If you do not want to fix the issue, add comments to your result or code to avoid another review. See:
Address Results in Polyspace User Interface Through Bug Fixes or Justifications if you review results in the Polyspace user interface.
Address Results in Polyspace Access Through Bug Fixes or Justifications (Polyspace Access) if you review results in a web browser.
Annotate Code and Hide Known or Acceptable Results if you review results in an IDE.
You can extend the checker in the following ways:
Polyspace® does not flag passing pointers to noninitialized variables to functions. To detect noninitialized variables that are passed to functions by pointers, extend the checker by using the option
-code-behavior-specification
. See Extend Checkers for Initialization to Check Function Arguments Passed by Pointers.If a variable in your code is non-initialized only for certain system input values, you can see one possible combination of input values causing the defect. See Extend Bug Finder Checkers to Find Defects from Specific System Input Values.
int get_sensor_value(void) { extern int getsensor(void); int command; int val; command = getsensor(); if (command == 2) { val = getsensor(); } return val; //Noncompliant /* Defect: val does not have a value if command is not 2 */ }
If command
is not 2, the
variable val
is unassigned. In this case, the return
value of function get_sensor_value
is undetermined.
One possible correction is to initialize val
during
declaration so that the initialization is not bypassed on some execution paths.
int get_sensor_value(void) { extern int getsensor(void); int command; /* Fix: Initialize val */ int val=0; command = getsensor(); if (command == 2) { val = getsensor(); } return val; }
val
is assigned an initial value of 0. When command
is
not equal to 2, the function get_sensor_value
returns
this value.
Check Information
Category: Others |
Version History
Introduced in R2023a
See Also
External Websites
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)
Asia Pacific
- Australia (English)
- India (English)
- New Zealand (English)
- 中国
- 日本Japanese (日本語)
- 한국Korean (한국어)