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.
Glossary
A static representation of a single piece of storage in a running
program.
A structural representation of a project's source text.
For more information, see API: AST.
An argument associated with a function call.
API
An acronym for "application programming interface",
which provides programmatic access to the deep-structure
representation of a project.
For information about the CodeSonar API, see section API.
build
Building a project is the CodeSonar analog of compiling an
executable.
For more information, see section Building.
[Visualization feature] In a call graph, there is only one node
per function f(). There are
edges to this node from every node representing a
function that calls f(), and from this node to every
node representing a function called by f(). If f() recursively calls itself, there will
be an edge looping from the node back to itself. Call graphs
are always finite.
call site
The program point at which a function is invoked.
The top-level file and collection of included files associated
with a given separate compilation.
compiler model
A CodeSonar subsystem that mimics the command-line processing of
an object-code compiler.
For more information, see section Compiler
Models.
In a
metric
report, the set of constraints used to specify which code
components will have their metric values displayed. This is one
of two sets of constraints for the report: the other is
included metrics.
control-flow edge
A relation between two program points reflecting how control
flows from point to point in the program, and labeled with a
value encoding the condition under which control may flow.
The collection of program points associated with a function, and
the control-flow edges connecting them.
For warnings associated with execution paths, we refer to the
path fragment covered by the warning's
Listing as the
core path. This is the sequence of calls and program
statements whose execution will trigger the warning. Users can
examine the possible call sequences leading into the core path
with the
Explore Callers
(Warning) and
Search
Callers functionality.
The
decl-uses set of a given program point is the set of
variables that
occur at that point.
A variable def is a program point where the variable is
necessarily assigned a value.
A metric class whose values are computed by mathematically
manipulating values of already existing metrics.
[CodeSonar for Binaries only] In a mixed build, we refer to
displayed binaries where necessary to contrast with
offstage binaries. A displayed
binary is one that
either
- was an input to a linker invocation during the CodeSonar
build/analysis and its name matches a BINARIES_TO_ANALYZE_AND_SHOW
rule,
or
- was directly specified for analysis with cs-bin-scan.
Displayed binaries are included
in the project, analyzed, and included in results.
A problem that exists in the analyzed project but for which
CodeSonar does not issue a warning.
A warning issued by CodeSonar that does not correspond to a
problem in the analyzed project.
FAQ
Frequently asked questions.
There is a CodeSonar FAQ.
file static variable
A variable that is local to a file, but not local to a function.
In discussions of the CodeSonar web GUI, the analysis whose
information is currently being viewed. For example, a warning
report's focal analysis is the analysis that issued that
warning instance.
The focal analysis of a Project page is the most recent
analysis of that project.
formal parameter
A parameter associated with the definition of a function.
global variable
A variable that is neither local to a file nor local to a
function.
include tree
A tree showing the inclusion relationships among the source-file
instances of a compilation unit.
For more information, see section API: Source
Files.
included file
A source file included directly or indirectly into a compilation
unit.
For more information, see API: Source
Files.
In a
metric
report, the set of constraints used to specify which metrics
will be reported. This is one of two sets of constraints for the
report: the other is
component
search.
installation instructions
kind (functions)
A categorization of functions.
For more information, see section API: PDG.
local variable
An automatic variable or a formal parameter.
macro
An identifier that is replaced by a sequence of tokens when it
occurs in source text.
memory allocator
A function such as
malloc used
for dynamic memory allocation. For more information, see section
C/C++ Allocators.
For a specific hub, describes a set of analyses: the most recent
analysis of each project on the hub.
non-local variable
An variable not declared in a function is non-local to that
function.
A program point where a variable's name occurs literally.
[CodeSonar for Binaries only] In a mixed build, an
offstage
binary is one that meets all of the following conditions.
- It was an input to a linker invocation during the CodeSonar
build/analysis
- Its name matches a BINARIES_TO_ANALYZE rule.
- Its name does not match a BINARIES_TO_ANALYZE_AND_SHOW
rule.
- It was not directly specified for analysis with
cs-bin-scan.
Warnings whose paths incorporate both offstage and
non-offstage components (source code, displayed binaries) of the project are
reported with each offstage segment of the path projected onto
the closest call site in analyzed source code or displayed
binary.
The converse of an offstage binary is a displayed binary.
A variable that may contain the address of another variable, or
the address of a function.
A
hub that has its own hub
database, located in its hub directory. (The alternative is a
satellite hub.)
procedure
A synonym for function.
The representation of a source-code location in CodeSonar's
deep-structure program representation.
A mechanism for grouping all the CodeSonar analyses of a single
software project.
For more information, see the Project section.
regular expression
A search pattern used to specify a set of named entities.
release notes
Information specific to a release.
See the CodeSonar Release
Notes.
A hub that does not have its own hub database, but instead uses
the hub database belonging to the associated
primary hub. For more information, see section
Satellite Hubs.
An instance of a source file in a compilation unit of a
project.
For more information, see:
string variable
A string constant, or a variable that represents a collection of
string constants.
structure field
A named part of a structure variable.
syntax coloring
Display of source text according to its syntax.
In a
metric report
containing multiple tables, the
table limit specifies an
upper bound on the size of each table in the report.
Tables in other GUI pages (and in metric reports containing
exactly one table) provide standard pagination
controls, allowing table size to be adjusted dynamically.
A warning issued by CodeSonar that corresponds to a real problem
in the analyzed project.
undefined function
A function that is referenced but not defined in the project.
union field
A named part of a union variable.
A program point where the value of a variable is taken, either
directly or indirectly (via pointer dereference).
variable
A location that can contain a value.