You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2029 lines
87 KiB

NAME
infer - static analysis for Java and C/C++/Objective-C/Objective-C++
SYNOPSIS
infer analyze [options]
infer capture [options]
infer compile [options]
infer help [options]
infer explore [options]
infer report [options]
infer reportdiff [options]
infer run [options]
infer --compilation-database[-escaped] file [options]
infer [options] -- compile command
infer [options]
DESCRIPTION
Infer is a static analyzer. Given a collection of source files written
in Java or in languages of the C family, and a command to build them,
infer produces a list of potential issues.
Infer consists of a collection of tools referenced in the SEE ALSO
section of this manual. See their respective manuals for more
information.
When run without a subcommand, and if a compilation command is
specified via the -- option or one of the
--clang-compilation-database[-escaped] options, then infer behaves as
infer-run(1). Otherwise, infer behaves as infer-analyze(1).
OPTIONS
Every infer command accepts the arguments from all the other infer
commands.
Options are read from the .inferconfig file, then from the INFER_ARGS
environment variable, then from the command line. Options in
INFER_ARGS take precedence over options in .inferconfig, and options
passed on the command line take precedence over options in INFER_ARGS.
See the ENVIRONMENT and FILES sections of this manual for more
information.
Options can be specified inside an argument file file by passing @file
as argument. The format is one option per line, and enclosing single '
and double " quotes are ignored.
Options without a default value (e.g., --linter) and options with
list-like values (e.g., --Xbuck) all have a corresponding
--option-reset flag that resets their values to nothing or the empty
list, respectively. For instance, --Xbuck-reset will cancel any
previous --Xbuck option passed to infer.
See the manuals of individual infer commands for details about their
supported options. The following is a list of all the supported
options (see also --help-full for options reserved for internal use).
--annotation-reachability
Activates: checker annotation-reachability: Given a pair of source
and sink annotation, e.g. `@PerformanceCritical` and `@Expensive`,
this checker will warn whenever some method annotated with
`@PerformanceCritical` calls, directly or indirectly, another
method annotated with `@Expensive` (Conversely:
--no-annotation-reachability) See also infer-analyze(1).
--annotation-reachability-custom-pairs json
Specify custom sources/sink for the annotation reachability
checker Example format: for custom annotations
com.my.annotation.{Source1,Source2,Sink1}
{ "sources" : ["Source1", "Source2"], "sink" : "Sink1" }
See also infer-analyze(1).
--annotation-reachability-cxx json
Specify annotation reachability analyses to be performed on
C/C++/ObjC code. Each entry is a JSON object whose key is the
issue name. "sources" and "sinks" can be specified either by
symbol (including regexps) or path prefix. "sinks" optionally can
specify "overrides" (by symbol or path prefix) that block the
reachability analysis when hit. Example: {
"ISOLATED_REACHING_CONNECT": {
"doc_url":
"http:://example.com/issue/doc/optional_link.html",
"sources": {
"desc": "Code that should not call connect [optional]",
"paths": [ "isolated/" ]
},
"sinks": {
"symbols": [ "connect" ],
"overrides": { "symbol_regexps": [ ".*::Trusted::.*" ] }
}
}
}
This will cause us to create a new ISOLATED_REACHING_CONNECT
issue for every function whose source path starts with "isolated/"
that may reach the function named "connect", ignoring paths that
go through a symbol matching the OCaml regexp ".*::Trusted::.*".
See also infer-analyze(1).
--annotation-reachability-cxx-sources json
Override sources in all cxx annotation reachability specs with the
given sources spec See also infer-analyze(1).
--annotation-reachability-only
Activates: Enable annotation-reachability and disable all other
checkers (Conversely: --no-annotation-reachability-only)
See also infer-analyze(1).
--append-buck-flavors +string
Additional Buck flavors to append to targets discovered by the
--buck-compilation-database option. See also infer-capture(1).
--no-biabduction
Deactivates: checker biabduction: This analysis deals with a range
of issues, many linked to memory safety. (Conversely:
--biabduction) See also infer-analyze(1).
--biabduction-only
Activates: Enable biabduction and disable all other checkers
(Conversely: --no-biabduction-only) See also infer-analyze(1).
--bo-debug int
Debug level for buffer-overrun checker (0-4) See also infer-analyze(1).
--bo-field-depth-limit int
Limit of field depth of abstract location in buffer-overrun
checker See also infer-analyze(1).
--bootclasspath string
Specify the Java bootclasspath See also infer-capture(1).
--buck-blacklist +regex
Skip capture of files matched by the specified regular expression.
Only the clang, non-compilation-database Buck integration is supported, not Java.
See also infer-capture(1) and infer-run(1).
--buck-clang
Activates: Buck integration for clang-based targets
(C/C++/Objective-C/Objective-C++). (Conversely: --no-buck-clang)
See also infer-capture(1).
--buck-combined
Activates: Buck integration for clang-based and Java targets.
(Conversely: --no-buck-combined) See also infer-capture(1).
--buck-compilation-database { no-deps | deps }
Buck integration using the compilation database, with or without
dependencies. Only includes clang targets, as per Buck's
#compilation-database flavor. See also infer-capture(1).
--buck-compilation-database-depth int
Depth of dependencies used by the --buck-compilation-database deps
option. By default, all recursive dependencies are captured.
See also infer-capture(1).
--buck-java
Activates: Buck integration for Java targets. (Conversely:
--no-buck-java) See also infer-capture(1).
--buck-java-flavor
Activates: Buck integration for Java which uses the buck flavor
#infer-java-capture instead of genrules like buck-java.
(Conversely: --no-buck-java-flavor) See also infer-capture(1).
--buck-java-flavor-suppress-config
Activates: Suppress setting buck config values for the infer
binary and its version in the buck-java-flavor integration.
(Conversely: --no-buck-java-flavor-suppress-config)
See also infer-capture(1).
--buck-merge-all-deps
Activates: Find and merge all infer dependencies produced by buck.
Use this flag if infer doesn't find any files to analyze after a
successful capture. Only valid for --buck-clang. (Conversely:
--no-buck-merge-all-deps) See also infer-capture(1).
--buck-targets-blacklist +regex
Skip capture of buck targets matched by the specified regular
expression. Only valid for --buck-compilation-database.
See also infer-capture(1) and infer-run(1).
--bufferoverrun
Activates: checker bufferoverrun: InferBO is a detector for
out-of-bounds array accesses. (Conversely: --no-bufferoverrun)
See also infer-analyze(1).
--bufferoverrun-only
Activates: Enable bufferoverrun and disable all other checkers
(Conversely: --no-bufferoverrun-only) See also infer-analyze(1).
--capture-blacklist regex
Skip capture of files matched by the specified OCaml regular
expression (only supported by the javac integration for now).
See also infer-capture(1) and infer-run(1).
--censor-report +string
Specify a filter for issues to be censored by adding a
'censored_reason' field in the json report. Infer will not report
censored issues on the console output and in report.txt, but tools
that post-process the json report can take them into account. If
multiple filters are specified, they are applied in the order in
which they are specified. Each filter is applied to each issue
detected, and only issues which are accepted by all filters are
reported. Each filter is of the form:
`<issue_type_regex>:<filename_regex>:<reason_string>`. The first
two components are OCaml Str regular expressions, with an optional
`!` character prefix. If a regex has a `!` prefix, the polarity is
inverted, and the filter becomes a "blacklist" instead of a
"whitelist". Each filter is interpreted as an implication: an
issue matches if it does not match the `issue_type_regex` or if it
does match the `filename_regex`. The filenames that are tested by
the regex are relative to the `--project-root` directory. The
`<reason_string>` is a non-empty string used to explain why the
issue was filtered. See also infer-report(1) and infer-run(1).
--changed-files-index file
Specify the file containing the list of source files from which
reactive analysis should start. Source files should be specified
relative to project root or be absolute See also infer-analyze(1).
--clang-biniou-file file
Specify a file containing the AST of the program, in biniou format
See also infer-capture(1).
--clang-blacklisted-flags +string
Clang flags to filter out See also infer-capture(1).
--clang-blacklisted-flags-with-arg +string
Clang flags (taking args) to filter out See also infer-capture(1).
--clang-compound-literal-init-limit int
Limit after which initialization of compound types (structs and
arrays) is not done element by element but using a builtin
function that each analysis has to model. See also infer-analyze(1) and infer-capture(1).
--compilation-database +path
File that contain compilation commands (can be specified multiple
times) See also infer-capture(1).
--compilation-database-escaped +path
File that contain compilation commands where all entries are
escaped for the shell, eg coming from Xcode (can be specified
multiple times) See also infer-capture(1).
--config-checks-between-markers
Activates: checker config-checks-between-markers: [EXPERIMENTAL]
Collects config checks between marker start and end. (Conversely:
--no-config-checks-between-markers) See also infer-analyze(1).
--config-checks-between-markers-only
Activates: Enable config-checks-between-markers and disable all
other checkers (Conversely:
--no-config-checks-between-markers-only) See also infer-analyze(1).
--continue
Activates: Continue the capture for the reactive analysis,
increasing the changed files/procedures. (If a procedure was
changed beforehand, keep the changed marking.) (Conversely:
--no-continue) See also infer-capture(1).
--continue-analysis
Activates: Continue the analysis after more targets are captured
by --continue. The other analysis options should be given the same
before. Not compatible with --reanalyze and
--incremental-analysis. (Conversely: --no-continue-analysis)
See also infer-analyze(1).
--cost
Activates: checker cost: Computes the time complexity of functions
and methods. Can be used to detect changes in runtime complexity
with `infer reportdiff`. (Conversely: --no-cost) See also infer-analyze(1).
--cost-issues-tests file
Write a list of cost issues in a format suitable for cost tests to
file See also infer-report(1).
--cost-only
Activates: Enable cost and disable all other checkers (Conversely:
--no-cost-only) See also infer-analyze(1).
--cost-tests-only-autoreleasepool
Activates: [EXPERIMENTAL] Report only autoreleasepool size results
in cost tests (Conversely: --no-cost-tests-only-autoreleasepool)
See also infer-report(1) and infer-reportdiff(1).
--costs-current path
Costs report of the latest revision See also infer-reportdiff(1).
--costs-previous path
Costs report of the base revision to use for comparison
See also infer-reportdiff(1).
--custom-symbols json
Specify named lists of symbols available to rules See also infer-analyze(1).
--no-cxx
Deactivates: Analyze C++ methods (Conversely: --cxx)
See also infer-capture(1).
--cxx-scope-guards json
Specify scope guard classes that can be read only by destructors
without being reported as dead stores. See also infer-analyze(1).
--debug,-g
Activates: Debug mode (also sets --debug-level 2,
--developer-mode, --print-buckets, --print-types,
--reports-include-ml-loc, --no-only-cheap-debug, --trace-error,
--write-dotty, --write-html) (Conversely: --no-debug | -G)
See also infer-analyze(1), infer-capture(1), infer-compile(1),
infer-report(1), infer-reportdiff(1), and infer-run(1).
--debug-level level
Debug level (sets --bo-debug level, --debug-level-analysis level,
--debug-level-capture level, --debug-level-linters level):
- 0: only basic debugging enabled
- 1: verbose debugging enabled
- 2: very verbose debugging enabled
See also infer-analyze(1), infer-capture(1), infer-compile(1),
infer-report(1), infer-reportdiff(1), and infer-run(1).
--debug-level-analysis int
Debug level for the analysis. See --debug-level for accepted
values. See also infer-analyze(1), infer-capture(1), infer-compile(1),
infer-report(1), infer-reportdiff(1), and infer-run(1).
--debug-level-capture int
Debug level for the capture. See --debug-level for accepted
values. See also infer-analyze(1), infer-capture(1), infer-compile(1),
infer-report(1), infer-reportdiff(1), and infer-run(1).
--debug-level-linters int
Debug level for the linters. See --debug-level for accepted
values. See also infer-analyze(1), infer-capture(1), infer-compile(1),
infer-report(1), infer-reportdiff(1), and infer-run(1).
--no-deduplicate
Deactivates: Apply issue-specific deduplication during analysis
and/or reporting. (Conversely: --deduplicate) See also infer-analyze(1), infer-report(1), and
infer-reportdiff(1).
--no-default-checkers
Deactivates: Default checkers: --biabduction,
--fragment-retains-view, --inefficient-keyset-iterator, --linters,
--liveness, --racerd, --siof, --self-in-block, --starvation,
--uninit (Conversely: --default-checkers) See also infer-analyze(1).
--no-default-linters
Deactivates: Use the default linters for the analysis.
(Conversely: --default-linters) See also infer-capture(1).
--dependencies
Activates: Translate all the dependencies during the capture. The
classes in the given jar file will be translated. No sources
needed. (Conversely: --no-dependencies) See also infer-capture(1).
--differential-filter-files string
Specify the file containing the list of source files for which a
differential report is desired. Source files should be specified
relative to project root or be absolute See also infer-report(1).
--disable-issue-type +issue_type
Do not show reports coming from this type of issue. Each checker
can report a range of issue types. This option provides
fine-grained filtering over which types of issue should be
reported once the checkers have run. In particular, note that
disabling issue types does not make the corresponding checker not
run. Available issue types are as follows:
ARRAY_OUT_OF_BOUNDS_L1 (disabled by default),
ARRAY_OUT_OF_BOUNDS_L2 (disabled by default),
ARRAY_OUT_OF_BOUNDS_L3 (disabled by default),
ASSIGN_POINTER_WARNING (enabled by default),
AUTORELEASEPOOL_SIZE_COMPLEXITY_INCREASE (enabled by default),
AUTORELEASEPOOL_SIZE_COMPLEXITY_INCREASE_UI_THREAD (enabled by
default),
AUTORELEASEPOOL_SIZE_UNREACHABLE_AT_EXIT (disabled by default),
Abduction_case_not_implemented (enabled by default),
Array_of_pointsto (enabled by default),
Assert_failure (enabled by default),
BAD_POINTER_COMPARISON (enabled by default),
BIABDUCTION_ANALYSIS_STOPS (disabled by default),
BIABDUCTION_MEMORY_LEAK (disabled by default),
BUFFER_OVERRUN_L1 (enabled by default),
BUFFER_OVERRUN_L2 (enabled by default),
BUFFER_OVERRUN_L3 (enabled by default),
BUFFER_OVERRUN_L4 (disabled by default),
BUFFER_OVERRUN_L5 (disabled by default),
BUFFER_OVERRUN_S2 (enabled by default),
BUFFER_OVERRUN_U5 (disabled by default),
Bad_footprint (enabled by default),
CAPTURED_STRONG_SELF (enabled by default),
CHECKERS_ALLOCATES_MEMORY (enabled by default),
CHECKERS_ANNOTATION_REACHABILITY_ERROR (enabled by default),
CHECKERS_CALLS_EXPENSIVE_METHOD (enabled by default),
CHECKERS_EXPENSIVE_OVERRIDES_UNANNOTATED (enabled by default),
CHECKERS_FRAGMENT_RETAINS_VIEW (enabled by default),
CHECKERS_IMMUTABLE_CAST (enabled by default),
CHECKERS_PRINTF_ARGS (enabled by default),
CLASS_CAST_EXCEPTION (disabled by default),
COMPONENT_WITH_MULTIPLE_FACTORY_METHODS (enabled by default),
CONDITION_ALWAYS_FALSE (disabled by default),
CONDITION_ALWAYS_TRUE (disabled by default),
CONFIG_CHECKS_BETWEEN_MARKERS (disabled by default),
CONSTANT_ADDRESS_DEREFERENCE (disabled by default),
CREATE_INTENT_FROM_URI (enabled by default),
CROSS_SITE_SCRIPTING (enabled by default),
CXX_REFERENCE_CAPTURED_IN_OBJC_BLOCK (enabled by default),
Cannot_star (enabled by default),
DANGLING_POINTER_DEREFERENCE (disabled by default),
DANGLING_POINTER_DEREFERENCE_MAYBE (disabled by default),
DEADLOCK (enabled by default),
DEAD_STORE (enabled by default),
DIRECT_ATOMIC_PROPERTY_ACCESS (enabled by default),
DISCOURAGED_WEAK_PROPERTY_CUSTOM_SETTER (enabled by default),
DIVIDE_BY_ZERO (disabled by default),
DO_NOT_REPORT (enabled by default),
EMPTY_VECTOR_ACCESS (enabled by default),
ERADICATE_BAD_NESTED_CLASS_ANNOTATION (enabled by default),
ERADICATE_CONDITION_REDUNDANT (enabled by default),
ERADICATE_FIELD_NOT_INITIALIZED (enabled by default),
ERADICATE_FIELD_NOT_NULLABLE (enabled by default),
ERADICATE_FIELD_OVER_ANNOTATED (enabled by default),
ERADICATE_INCONSISTENT_SUBCLASS_PARAMETER_ANNOTATION (enabled
by default),
ERADICATE_INCONSISTENT_SUBCLASS_RETURN_ANNOTATION (enabled by
default),
ERADICATE_META_CLASS_CAN_BE_NULLSAFE (disabled by default),
ERADICATE_META_CLASS_IS_NULLSAFE (disabled by default),
ERADICATE_META_CLASS_NEEDS_IMPROVEMENT (disabled by default),
ERADICATE_NULLABLE_DEREFERENCE (enabled by default),
ERADICATE_PARAMETER_NOT_NULLABLE (enabled by default),
ERADICATE_REDUNDANT_NESTED_CLASS_ANNOTATION (enabled by
default),
ERADICATE_RETURN_NOT_NULLABLE (enabled by default),
ERADICATE_RETURN_OVER_ANNOTATED (enabled by default),
ERADICATE_UNCHECKED_USAGE_IN_NULLSAFE (enabled by default),
ERADICATE_UNVETTED_THIRD_PARTY_IN_NULLSAFE (enabled by
default),
EXECUTION_TIME_COMPLEXITY_INCREASE (enabled by default),
EXECUTION_TIME_COMPLEXITY_INCREASE_UI_THREAD (enabled by
default),
EXECUTION_TIME_UNREACHABLE_AT_EXIT (disabled by default),
EXPENSIVE_LOOP_INVARIANT_CALL (enabled by default),
EXPOSED_INSECURE_INTENT_HANDLING (enabled by default),
Failure_exe (enabled by default),
GLOBAL_VARIABLE_INITIALIZED_WITH_FUNCTION_OR_METHOD_CALL
(disabled by default),
GUARDEDBY_VIOLATION (enabled by default),
IMPURE_FUNCTION (enabled by default),
INEFFICIENT_KEYSET_ITERATOR (enabled by default),
INFERBO_ALLOC_IS_BIG (enabled by default),
INFERBO_ALLOC_IS_NEGATIVE (enabled by default),
INFERBO_ALLOC_IS_ZERO (enabled by default),
INFERBO_ALLOC_MAY_BE_BIG (enabled by default),
INFERBO_ALLOC_MAY_BE_NEGATIVE (enabled by default),
INFINITE_AUTORELEASEPOOL_SIZE (disabled by default),
INFINITE_EXECUTION_TIME (disabled by default),
INHERENTLY_DANGEROUS_FUNCTION (enabled by default),
INSECURE_INTENT_HANDLING (enabled by default),
INTEGER_OVERFLOW_L1 (enabled by default),
INTEGER_OVERFLOW_L2 (enabled by default),
INTEGER_OVERFLOW_L5 (disabled by default),
INTEGER_OVERFLOW_U5 (disabled by default),
INTERFACE_NOT_THREAD_SAFE (enabled by default),
INVARIANT_CALL (disabled by default),
IVAR_NOT_NULL_CHECKED (enabled by default),
Internal_error (enabled by default),
JAVASCRIPT_INJECTION (enabled by default),
LAB_RESOURCE_LEAK (enabled by default),
LOCKLESS_VIOLATION (enabled by default),
LOCK_CONSISTENCY_VIOLATION (enabled by default),
LOGGING_PRIVATE_DATA (enabled by default),
Leak_after_array_abstraction (enabled by default),
Leak_in_footprint (enabled by default),
Leak_unknown_origin (disabled by default),
MEMORY_LEAK (enabled by default),
MISSING_REQUIRED_PROP (enabled by default),
MIXED_SELF_WEAKSELF (enabled by default),
MULTIPLE_WEAKSELF (enabled by default),
MUTABLE_LOCAL_VARIABLE_IN_COMPONENT_FILE (enabled by default),
Missing_fld (enabled by default),
NULLPTR_DEREFERENCE (disabled by default),
NULL_DEREFERENCE (enabled by default),
OPTIONAL_EMPTY_ACCESS (disabled by default),
PARAMETER_NOT_NULL_CHECKED (enabled by default),
POINTER_TO_CONST_OBJC_CLASS (enabled by default),
PRECONDITION_NOT_FOUND (enabled by default),
PRECONDITION_NOT_MET (enabled by default),
PREMATURE_NIL_TERMINATION_ARGUMENT (enabled by default),
PURE_FUNCTION (enabled by default),
QUANDARY_TAINT_ERROR (enabled by default),
RESOURCE_LEAK (enabled by default),
RETAIN_CYCLE (enabled by default),
SHELL_INJECTION (enabled by default),
SHELL_INJECTION_RISK (enabled by default),
SKIP_FUNCTION (disabled by default),
SQL_INJECTION (enabled by default),
SQL_INJECTION_RISK (enabled by default),
STACK_VARIABLE_ADDRESS_ESCAPE (enabled by default),
STARVATION (enabled by default),
STATIC_INITIALIZATION_ORDER_FIASCO (enabled by default),
STRICT_MODE_VIOLATION (enabled by default),
STRONG_DELEGATE_WARNING (enabled by default),
STRONG_SELF_NOT_CHECKED (enabled by default),
Symexec_memory_error (enabled by default),
THREAD_SAFETY_VIOLATION (enabled by default),
TOPL_BIABD_ERROR (enabled by default),
TOPL_PULSE_ERROR (enabled by default),
UNINITIALIZED_VALUE (enabled by default),
UNREACHABLE_CODE (enabled by default),
UNTRUSTED_BUFFER_ACCESS (disabled by default),
UNTRUSTED_DESERIALIZATION (enabled by default),
UNTRUSTED_DESERIALIZATION_RISK (enabled by default),
UNTRUSTED_ENVIRONMENT_CHANGE_RISK (enabled by default),
UNTRUSTED_FILE (enabled by default),
UNTRUSTED_FILE_RISK (enabled by default),
UNTRUSTED_HEAP_ALLOCATION (disabled by default),
UNTRUSTED_INTENT_CREATION (enabled by default),
UNTRUSTED_URL_RISK (enabled by default),
UNTRUSTED_VARIABLE_LENGTH_ARRAY (enabled by default),
USER_CONTROLLED_SQL_RISK (enabled by default),
USE_AFTER_DELETE (enabled by default),
USE_AFTER_FREE (enabled by default),
USE_AFTER_LIFETIME (enabled by default),
VECTOR_INVALIDATION (enabled by default),
WEAK_SELF_IN_NO_ESCAPE_BLOCK (enabled by default),
Wrong_argument_number (enabled by default).
See also infer-report(1).
--dump-duplicate-symbols
Activates: Dump all symbols with the same name that are defined in
more than one file. (Conversely: --no-dump-duplicate-symbols)
See also infer-capture(1).
--enable-issue-type +issue_type
Show reports coming from this type of issue. By default, all issue
types are enabled except the ones listed in --disable-issue-type.
Note that enabling issue types does not make the corresponding
checker run; see individual checker options to turn them on or
off. See also infer-report(1).
--eradicate
Activates: checker eradicate: The eradicate `@Nullable` checker
for Java annotations. (Conversely: --no-eradicate) See also infer-analyze(1).
--eradicate-only
Activates: Enable eradicate and disable all other checkers
(Conversely: --no-eradicate-only) See also infer-analyze(1).
--external-java-packages +prefix
Specify a list of Java package prefixes for external Java
packages. If set, the analysis will not report non-actionable
warnings on those packages. See also infer-analyze(1).
--fail-on-issue
Activates: Exit with error code 2 if Infer found something to
report (Conversely: --no-fail-on-issue) See also infer-run(1).
--file-renamings path
JSON with a list of file renamings to use while computing
differential reports See also infer-reportdiff(1).
--no-filtering,-F
Deactivates: Do not show the experimental and blacklisted issue
types (Conversely: --filtering | -f) See also infer-report(1).
--force-delete-results-dir
Activates: Do not refuse to delete the results directory if it
doesn't look like an infer results directory. (Conversely:
--no-force-delete-results-dir) See also infer-capture(1), infer-compile(1), and infer-run(1).
--force-integration command
Proceed as if the first argument after -- was command. Possible
values: ant, buck, gradle, gradlew, java, javac, cc, clang, gcc,
clang++, c++, g++, make, configure, cmake, waf, mvn, mvnw,
ndk-build, xcodebuild. See also infer-capture(1) and infer-run(1).
--no-fragment-retains-view
Deactivates: checker fragment-retains-view: Detects when Android
fragments are not explicitly nullified before becoming
unreachable. (Conversely: --fragment-retains-view) See also infer-analyze(1).
--fragment-retains-view-only
Activates: Enable fragment-retains-view and disable all other
checkers (Conversely: --no-fragment-retains-view-only)
See also infer-analyze(1).
--from-json-costs-report costs-report.json
Load costs analysis results from a costs-report file.
See also infer-report(1).
--from-json-report report.json
Load analysis results from a report file (default is to load the
results from the specs files generated by the analysis).
See also infer-report(1).
--frontend-tests
Activates: Save filename.ext.test.dot with the cfg in dotty format
for frontend tests (also sets --print-types) (Conversely:
--no-frontend-tests) See also infer-capture(1).
--generated-classes path
Specify where to load the generated class files See also infer-capture(1).
--global-tenv
Activates: Print the global type environment. (Conversely:
--no-global-tenv) See also infer-debug(1).
--headers
Activates: Analyze code in header files (Conversely: --no-headers)
See also infer-capture(1).
--help
Show this manual See also infer-analyze(1), infer-capture(1), infer-compile(1),
infer-debug(1), infer-explore(1), infer-help(1), infer-report(1),
infer-reportdiff(1), and infer-run(1).
--help-checker +checker-id
Show information about a checker, for example biabduction. To see
the list of all checkers, see --list-checkers. See also infer-help(1).
--help-format { auto | groff | pager | plain }
Show this help in the specified format. auto sets the format to
plain if the environment variable TERM is "dumb" or undefined, and
to pager otherwise. See also infer-analyze(1), infer-capture(1), infer-compile(1),
infer-debug(1), infer-explore(1), infer-help(1), infer-report(1),
infer-reportdiff(1), and infer-run(1).
--help-full
Show this manual with all internal options in the INTERNAL OPTIONS
section See also infer-analyze(1), infer-capture(1), infer-compile(1),
infer-debug(1), infer-explore(1), infer-help(1), infer-report(1),
infer-reportdiff(1), and infer-run(1).
--help-issue-type +UNIQUE_ID
Show information about an issue type, for example
NULL_DEREFERENCE. To see the list of all issue types, see
--list-issue-types. See also infer-help(1).
--no-hoisting-report-only-expensive
Deactivates: [Hoisting] Report loop-invariant calls only when the
function is expensive, i.e. at least linear (Conversely:
--hoisting-report-only-expensive) See also infer-report(1).
--html
Activates: Generate html report. (Conversely: --no-html)
See also infer-explore(1).
--immutable-cast
Activates: checker immutable-cast: Detection of object cast from
immutable types to mutable types. For instance, it will detect
casts from `ImmutableList` to `List`, `ImmutableMap` to `Map`, and
`ImmutableSet` to `Set`. (Conversely: --no-immutable-cast)
See also infer-analyze(1).
--immutable-cast-only
Activates: Enable immutable-cast and disable all other checkers
(Conversely: --no-immutable-cast-only) See also infer-analyze(1).
--impurity
Activates: checker impurity: Detects functions with potential
side-effects. Same as "purity", but implemented on top of Pulse.
(Conversely: --no-impurity) See also infer-analyze(1).
--impurity-only
Activates: Enable impurity and disable all other checkers
(Conversely: --no-impurity-only) See also infer-analyze(1).
--no-inefficient-keyset-iterator
Deactivates: checker inefficient-keyset-iterator: Check for
inefficient uses of iterators that iterate on keys then lookup
their values, instead of iterating on key-value pairs directly.
(Conversely: --inefficient-keyset-iterator) See also infer-analyze(1).
--inefficient-keyset-iterator-only
Activates: Enable inefficient-keyset-iterator and disable all
other checkers (Conversely: --no-inefficient-keyset-iterator-only)
See also infer-analyze(1).
--issues-tests file
Write a list of issues in a format suitable for tests to file
See also infer-report(1).
--issues-tests-fields ,-separated sequence of { bug_type | bucket |
qualifier | severity | line | column | procedure |
procedure_start_line | file | bug_trace | key | hash | line_offset |
qualifier_contains_potential_exception_note | nullsafe_extra }
Fields to emit with --issues-tests See also infer-report(1).
--java-jar-compiler path
Specify the Java compiler jar used to generate the bytecode
See also infer-capture(1).
--java-version int
The version of Java being used. Set it to your Java version if mvn
is failing. See also infer-analyze(1) and infer-capture(1).
--jobs,-j int
Run the specified number of analysis jobs simultaneously
See also infer-analyze(1).
--keep-going
Activates: Keep going when the analysis encounters a failure
(Conversely: --no-keep-going) See also infer-analyze(1).
--linter string
From the linters available, only run this one linter. (Useful
together with --linters-developer-mode) See also infer-capture(1).
--no-linters
Deactivates: checker linters: Declarative linting framework over
the Clang AST. (Conversely: --linters) See also infer-analyze(1).
--linters-def-file +file
Specify the file containing linters definition (e.g. 'linters.al')
See also infer-capture(1).
--linters-def-folder +dir
Specify the folder containing linters files with extension .al
See also infer-capture(1).
--linters-developer-mode
Activates: Debug mode for developing new linters. (Sets the
analyzer to linters; also sets --debug, --debug-level-linters 2,
--developer-mode, and unsets --allowed-failures and
--default-linters. (Conversely: --no-linters-developer-mode)
See also infer-capture(1).
--linters-doc-url +string
Specify custom documentation URL for some linter that overrides
the default one. Useful if your project has specific ways of
fixing a lint error that is not true in general or public info.
Format: linter_name:doc_url. See also infer-capture(1).
--linters-ignore-clang-failures
Activates: Continue linting files even if some compilation fails.
(Conversely: --no-linters-ignore-clang-failures) See also infer-capture(1).
--linters-only
Activates: Enable linters and disable all other checkers
(Conversely: --no-linters-only) See also infer-analyze(1).
--linters-validate-syntax-only
Activates: Validate syntax of AL files, then emit possible errors
in JSON format to stdout (Conversely:
--no-linters-validate-syntax-only) See also infer-capture(1).
--list-checkers
Activates: Show the list of all available checkers. (Conversely:
--no-list-checkers) See also infer-help(1).
--list-issue-types
Activates: Show the list of all issue types that infer might
report. (Conversely: --no-list-issue-types) See also infer-help(1).
--litho-required-props
Activates: checker litho-required-props: Checks that all
non-optional `@Prop`s have been specified when constructing Litho
components. (Conversely: --no-litho-required-props)
See also infer-analyze(1).
--litho-required-props-only
Activates: Enable litho-required-props and disable all other
checkers (Conversely: --no-litho-required-props-only)
See also infer-analyze(1).
--no-liveness
Deactivates: checker liveness: Detection of dead stores and unused
variables. (Conversely: --liveness) See also infer-analyze(1).
--liveness-dangerous-classes json
Specify classes where the destructor should be ignored when
computing liveness. In other words, assignement to variables of
these types (or common wrappers around these types such as
unique_ptr<type>) will count as dead stores when the variables are
not read explicitly by the program. See also infer-analyze(1).
--liveness-only
Activates: Enable liveness and disable all other checkers
(Conversely: --no-liveness-only) See also infer-analyze(1).
--load-average,-l float
Do not start new parallel jobs if the load average is greater than
that specified (Buck and make only) See also infer-capture(1).
--loop-hoisting
Activates: checker loop-hoisting: Detect opportunities to hoist
function calls that are invariant outside of loop bodies for
efficiency. (Conversely: --no-loop-hoisting) See also infer-analyze(1).
--loop-hoisting-only
Activates: Enable loop-hoisting and disable all other checkers
(Conversely: --no-loop-hoisting-only) See also infer-analyze(1).
--max-jobs int
Maximum number of analysis jobs running simultaneously
See also infer-analyze(1).
--max-nesting int
Level of nested procedure calls to show. Trace elements beyond the
maximum nesting level are skipped. If omitted, all levels are
shown. See also infer-explore(1).
--merge
Activates: Merge the captured results directories specified in the
dependency file. (Conversely: --no-merge) See also infer-analyze(1).
--ml-buckets ,-separated sequence of { all | cf | arc | narc | cpp |
unknown_origin }
Specify the memory leak buckets to be checked in C++:
- cpp from C++ code
See also infer-analyze(1).
--perf-profiler-data-file file
DEPRECATED: Specify the file containing perf profiler data to read
See also infer-analyze(1).
--pmd-xml
Activates: Output issues in (PMD) XML format in
infer-out/report.xml (Conversely: --no-pmd-xml) See also infer-run(1).
--print-active-checkers
Activates: Print the active checkers before starting the analysis
(Conversely: --no-print-active-checkers) See also infer-analyze(1).
--print-logs
Activates: Also log messages to stdout and stderr (Conversely:
--no-print-logs) See also infer-analyze(1), infer-capture(1), infer-report(1), and
infer-run(1).
--printf-args
Activates: checker printf-args: Detect mismatches between the Java
`printf` format strings and the argument types For example, this
checker will warn about the type error in `printf("Hello %d",
"world")` (Conversely: --no-printf-args) See also infer-analyze(1).
--printf-args-only
Activates: Enable printf-args and disable all other checkers
(Conversely: --no-printf-args-only) See also infer-analyze(1).
--procedures
Activates: Print functions and methods discovered by infer
(Conversely: --no-procedures) See also infer-debug(1).
--procedures-attributes
Activates: Print the attributes of each procedure in the output of
--procedures (Conversely: --no-procedures-attributes)
See also infer-debug(1).
--procedures-cfg
Activates: Output a dotty file in
infer-out/captured/<file_name>/<proc_name>.dot for each procedure
in the output of --procedures (Conversely: --no-procedures-cfg)
See also infer-debug(1).
--no-procedures-definedness
Deactivates: Include procedures definedness in the output of
--procedures, i.e. whether the procedure definition was found, or
only the procedure declaration, or the procedure is an
auto-generated Objective-C accessor (Conversely:
--procedures-definedness) See also infer-debug(1).
--procedures-filter filter
With --procedures, only print functions and methods (procedures)
matching the specified filter. A procedure filter is of the form
path_pattern:procedure_name. Patterns are interpreted as OCaml Str
regular expressions. For instance, to keep only methods named
"foo", one can use the filter ".*:foo", or "foo" for short.
See also infer-debug(1).
--procedures-name
Activates: Include procedures names in the output of --procedures
(Conversely: --no-procedures-name) See also infer-debug(1).
--no-procedures-source-file
Deactivates: Include the source file in which the procedure
definition or declaration was found in the output of --procedures
(Conversely: --procedures-source-file) See also infer-debug(1).
--procedures-summary
Activates: Print the summaries of each procedure in the output of
--procedures (Conversely: --no-procedures-summary) See also infer-debug(1).
--no-progress-bar,-P
Deactivates: Show a progress bar (Conversely: --progress-bar | -p)
See also infer-run(1).
--progress-bar-style { auto | plain | multiline }
Style of the progress bar. auto selects multiline if connected to
a tty, otherwise plain. See also infer-analyze(1) and infer-capture(1).
--project-root,-C dir
Specify the root directory of the project See also infer-analyze(1), infer-capture(1), infer-report(1), and
infer-run(1).
--pulse
Activates: checker pulse: Memory and lifetime analysis.
(Conversely: --no-pulse) See also infer-analyze(1).
--pulse-cut-to-one-path-procedures-pattern string
Regex of methods for which pulse will only explore one path. Can
be used on pathologically large procedures to prevent too-big
states from being produced. See also infer-analyze(1).
--pulse-model-abort +string
Methods that should be modelled as abort in Pulse See also infer-analyze(1).
--pulse-model-alloc-pattern string
Regex of methods that should be modelled as allocs in Pulse
See also infer-analyze(1).
--pulse-model-release-pattern string
Regex of methods that should be modelled as release in Pulse
See also infer-analyze(1).
--pulse-model-return-nonnull +string
Methods that should be modelled as returning non-null in Pulse
See also infer-analyze(1).
--pulse-model-skip-pattern string
Regex of methods that should be modelled as "skip" in Pulse
See also infer-analyze(1).
--pulse-model-transfer-ownership +string
Methods that should be modelled as transfering memory ownership in
Pulse. Accepted formats are method or namespace::method
See also infer-analyze(1).
--pulse-only
Activates: Enable pulse and disable all other checkers
(Conversely: --no-pulse-only) See also infer-analyze(1).
--purity
Activates: checker purity: Detects pure (side-effect-free)
functions. A different implementation of "impurity". (Conversely:
--no-purity) See also infer-analyze(1).
--purity-only
Activates: Enable purity and disable all other checkers
(Conversely: --no-purity-only) See also infer-analyze(1).
--quandary
Activates: checker quandary: The Quandary taint analysis detects
flows of values between sources and sinks, except if the value
went through a "sanitizer". In addition to some defaults, users
can specify their own sources, sinks, and sanitizers functions.
(Conversely: --no-quandary) See also infer-analyze(1).
--quandary-endpoints json
Specify endpoint classes for Quandary See also infer-analyze(1).
--quandary-only
Activates: Enable quandary and disable all other checkers
(Conversely: --no-quandary-only) See also infer-analyze(1).
--quandary-sanitizers json
Specify custom sanitizers for Quandary See also infer-analyze(1).
--quandary-sinks json
Specify custom sinks for Quandary See also infer-analyze(1).
--quandary-sources json
Specify custom sources for Quandary See also infer-analyze(1).
--quiet,-q
Activates: Do not print anything on standard output. (Conversely:
--no-quiet | -Q) See also infer-analyze(1) and infer-report(1).
--no-racerd
Deactivates: checker racerd: Thread safety analysis. (Conversely:
--racerd) See also infer-analyze(1).
--racerd-guardedby
Activates: Check @GuardedBy annotations with RacerD (Conversely:
--no-racerd-guardedby) See also infer-analyze(1).
--racerd-only
Activates: Enable racerd and disable all other checkers
(Conversely: --no-racerd-only) See also infer-analyze(1).
--no-racerd-unknown-returns-owned
Deactivates: DEPRECATED, does nothing. (Conversely:
--racerd-unknown-returns-owned) See also infer-analyze(1).
--reactive,-r
Activates: Reactive mode: the analysis starts from the files
captured since the infer command started (Conversely:
--no-reactive | -R) See also infer-analyze(1).
--no-report
Deactivates: Run the reporting phase once the analysis has
completed (Conversely: --report) See also infer-analyze(1) and infer-run(1).
--report-blacklist-files-containing +string
Do not report any issues on files containing the specified string
See also infer-report(1) and infer-run(1).
--report-blacklist-path-regex +path_regex
Do not report any issues on files whose relative path matches the
specified OCaml regex, even if they match the whitelist specified
by --report-whitelist-path-regex See also infer-report(1) and infer-run(1).
--report-console-limit int
Maximum number of issues to display on standard output. Unset with
--report-console-limit-reset to show all. See also infer-report(1).
--report-current path
report of the latest revision See also infer-reportdiff(1).
--report-force-relative-path
Activates: Force converting an absolute path to a relative path to
the root directory (Conversely: --no-report-force-relative-path)
See also infer-analyze(1) and infer-run(1).
--report-formatter { none | phabricator }
Which formatter to use when emitting the report See also infer-report(1).
--report-previous path
Report of the base revision to use for comparison See also infer-reportdiff(1).
--report-suppress-errors +error_name
do not report a type of errors See also infer-report(1) and infer-run(1).
--report-whitelist-path-regex +path_regex
Report issues only on files whose relative path matches the
specified OCaml regex (and which do not match
--report-blacklist-path-regex) See also infer-report(1) and infer-run(1).
--results-dir,-o dir
Write results and internal files in the specified directory
See also infer-analyze(1), infer-capture(1), infer-explore(1),
infer-report(1), and infer-run(1).
--select N
Select bug number N. If omitted, prompt for input. See also infer-explore(1).
--no-self-in-block
Deactivates: checker self-in-block: An Objective-C-specific
analysis to detect when a block captures `self`. (Conversely:
--self-in-block) See also infer-analyze(1).
--self-in-block-only
Activates: Enable self-in-block and disable all other checkers
(Conversely: --no-self-in-block-only) See also infer-analyze(1).
--no-siof
Deactivates: checker siof: Catches Static Initialization Order
Fiascos in C++, that can lead to subtle,
compiler-version-dependent errors. (Conversely: --siof)
See also infer-analyze(1).
--siof-check-iostreams
Activates: Do not assume that iostreams (cout, cerr, ...) are
always initialized. The default is to assume they are always
initialized to avoid false positives. However, if your program
compiles against a recent libstdc++ then it is safe to turn this
option on. (Conversely: --no-siof-check-iostreams) See also infer-analyze(1).
--siof-only
Activates: Enable siof and disable all other checkers (Conversely:
--no-siof-only) See also infer-analyze(1).
--siof-safe-methods +string
Methods that are SIOF-safe; "foo::bar" will match "foo::bar()",
"foo<int>::bar()", etc. (can be specified multiple times)
See also infer-analyze(1).
--skip-analysis-in-path +path_prefix_OCaml_regex
Ignore files whose path matches the given prefix (can be specified
multiple times) See also infer-capture(1) and infer-run(1).
--skip-analysis-in-path-skips-compilation
Activates: Whether paths in --skip-analysis-in-path should be
compiled or not (Conversely:
--no-skip-analysis-in-path-skips-compilation) See also infer-report(1).
--no-skip-duplicated-types
Deactivates: Skip fixed-then-introduced duplicated types while
computing differential reports (Conversely:
--skip-duplicated-types) See also infer-reportdiff(1).
--skip-translation-headers +path_prefix
Ignore headers whose path matches the given prefix See also infer-capture(1).
--source-files
Activates: Print source files discovered by infer (Conversely:
--no-source-files) See also infer-debug(1).
--source-files-cfg
Activates: Output a dotty file in infer-out/captured for each
source file in the output of --source-files (Conversely:
--no-source-files-cfg) See also infer-debug(1).
--source-files-filter filter
With --source-files, only print source files matching the
specified filter. The filter is a pattern that should match the
file path. Patterns are interpreted as OCaml Str regular
expressions. See also infer-debug(1).
--source-files-freshly-captured
Activates: Print whether the source file has been captured in the
most recent capture phase in the output of --source-files.
(Conversely: --no-source-files-freshly-captured) See also infer-debug(1).
--source-files-procedure-names
Activates: Print the names of procedure of each source file in the
output of --source-files (Conversely:
--no-source-files-procedure-names) See also infer-debug(1).
--source-files-type-environment
Activates: Print the type environment of each source file in the
output of --source-files (Conversely:
--no-source-files-type-environment) See also infer-debug(1).
--no-source-preview
Deactivates: print code excerpts around trace elements
(Conversely: --source-preview) See also infer-explore(1).
--sqlite-cache-size int
SQLite cache size in pages (if positive) or kB (if negative),
follows formal of corresponding SQLite PRAGMA. See also infer-analyze(1), infer-capture(1), and infer-run(1).
--sqlite-lock-timeout int
Timeout for SQLite results database operations, in milliseconds.
See also infer-analyze(1), infer-capture(1), and infer-run(1).
--sqlite-page-size int
SQLite page size in bytes, must be a power of two between 512 and
65536. See also infer-analyze(1), infer-capture(1), and infer-run(1).
--no-starvation
Deactivates: checker starvation: Detect various kinds of
situations when no progress is being made because of concurrency
errors. (Conversely: --starvation) See also infer-analyze(1).
--starvation-only
Activates: Enable starvation and disable all other checkers
(Conversely: --no-starvation-only) See also infer-analyze(1).
--threadsafe-aliases json
Specify custom annotations that should be considered aliases of
@ThreadSafe See also infer-analyze(1).
--topl-biabd
Activates: checker topl-biabd: Detects errors based on
user-provided state machines describing multi-object monitors.
(Conversely: --no-topl-biabd) See also infer-analyze(1).
--topl-biabd-only
Activates: Enable topl-biabd and disable all other checkers
(Conversely: --no-topl-biabd-only) See also infer-analyze(1).
--topl-pulse
Activates: checker topl-pulse: Detects errors based on
user-provided state machines describing multi-object monitors.
(Conversely: --no-topl-pulse) See also infer-analyze(1).
--topl-pulse-only
Activates: Enable topl-pulse and disable all other checkers
(Conversely: --no-topl-pulse-only) See also infer-analyze(1).
--no-uninit
Deactivates: checker uninit: Warns when values are used before
having been initialized. (Conversely: --uninit) See also infer-analyze(1).
--uninit-only
Activates: Enable uninit and disable all other checkers
(Conversely: --no-uninit-only) See also infer-analyze(1).
--unsafe-malloc
Activates: Assume that malloc(3) never returns null. (Conversely:
--no-unsafe-malloc) See also infer-analyze(1).
--version
Print version information and exit See also infer-run(1).
--version-json
Print version information in json format and exit See also infer-run(1).
--write-website path_to_website_dir
Use to write website files documenting issue types and checkers
under path_to_website_dir/. Meant to be used within the Infer
directory to generate its website at fbinfer.com at website/.
See also infer-help(1).
--Xbuck +string
Pass values as command-line arguments to invocations of `buck
build`. Only valid for --buck-clang. See also infer-capture(1).
--Xbuck-no-inline +string
Pass values as command-line arguments to invocations of `buck
build`, don't inline any args starting with '@'. Only valid for
--buck-clang. See also infer-capture(1).
--Xclang +string
Pass values as command-line arguments to invocations of clang
See also infer-capture(1).
--xcode-developer-dir XCODE_DEVELOPER_DIR
Specify the path to Xcode developer directory, to use for Buck
clang targets See also infer-capture(1).
--xcode-isysroot-suffix string
Specify the suffix of Xcode isysroot directory, to avoid absolute
paths in tests See also infer-analyze(1).
--xcpretty
Activates: Infer will use xcpretty together with xcodebuild to
analyze an iOS app. xcpretty just needs to be in the path, infer
command is still just `infer -- <xcodebuild command>`.
(Conversely: --no-xcpretty) See also infer-capture(1).
-- Stop argument processing, use remaining arguments as a build
command See also infer-capture(1) and infer-run(1).
INTERNAL OPTIONS
Use at your own risk.
--abs-struct int
Specify abstraction level for fields of structs: - 0 = no
- 1 = forget some fields during matching (and so lseg
abstraction)
--abs-val int
Specify abstraction level for expressions: - 0 = no abstraction
- 1 = evaluate all expressions abstractly
- 2 = 1 + abstract constant integer values during join
--allow-leak
Activates: Forget leaked memory during abstraction (Conversely:
--no-allow-leak)
--append-buck-flavors-reset
Set --append-buck-flavors to the empty list.
--array-level int
Level of treating the array indexing and pointer arithmetic:
- 0 = treats both features soundly
- 1 = assumes that the size of every array is infinite
- 2 = assumes that all heap dereferences via array indexing and
pointer arithmetic are correct
--backtrack-level int
Maximum level of backtracking to convert an absolute path to path
relative to the common prefix between the project root and the
path. For instance, with bactraking level 1, it will convert
/my/source/File.java with project root /my/root into
../source/File.java
--biabduction-models-mode
Activates: Analysis of the biabduction models (Conversely:
--no-biabduction-models-mode)
--bo-field-depth-limit-reset
Cancel the effect of --bo-field-depth-limit.
--bootclasspath-reset
Cancel the effect of --bootclasspath.
--buck-blacklist-reset
Set --buck-blacklist to the empty list.
--buck-compilation-database-depth-reset
Cancel the effect of --buck-compilation-database-depth.
--buck-compilation-database-reset
Cancel the effect of --buck-compilation-database.
--buck-targets-blacklist-reset
Set --buck-targets-blacklist to the empty list.
--call-graph-schedule
Activates: use call graph for scheduling analysis (Conversely:
--no-call-graph-schedule)
--no-capture
Deactivates: capture and translate source files into infer's
intermediate language for analysis (Conversely: --capture)
--capture-blacklist-reset
Cancel the effect of --capture-blacklist.
--censor-report-reset
Set --censor-report to the empty list.
--changed-files-index-reset
Cancel the effect of --changed-files-index.
--check-version version
Verify that the Infer version is equal to the provided argument
--check-version-reset
Cancel the effect of --check-version.
--clang-biniou-file-reset
Cancel the effect of --clang-biniou-file.
--clang-blacklisted-flags-reset
Set --clang-blacklisted-flags to the empty list.
--clang-blacklisted-flags-with-arg-reset
Set --clang-blacklisted-flags-with-arg to the empty list.
--clang-idirafter-to-override-regex dir_OCaml_regex
Use this option in the uncommon case where the normal compilation
process overrides the location of internal compiler headers. This
option should specify regular expression with the path to those
headers so that infer can use its own clang internal headers
instead. Concretely, this will replace -idirafter <path matching
the regex> with -idirafter
/path/to/infer/facebook-clang-plugins/clang/install/lib/clang/<version>/include.
--clang-idirafter-to-override-regex-reset
Cancel the effect of --clang-idirafter-to-override-regex.
--clang-ignore-regex dir_OCaml_regex
The files in this regex will be ignored in the compilation process
and an empty file will be passed to clang instead. This is to be
used with the buck flavour infer-capture-all to work around
missing generated files.
--clang-ignore-regex-reset
Cancel the effect of --clang-ignore-regex.
--clang-isystem-to-override-regex dir_OCaml_regex
Use this option in the uncommon case where the normal compilation
process overrides the location of internal compiler headers. This
option should specify regular expression with the path to those
headers so that infer can use its own clang internal headers
instead. Concretely, this will replace -isystem <path matching the
regex> with -isystem
/path/to/infer/facebook-clang-plugins/clang/install/lib/clang/<version>/include.
--clang-isystem-to-override-regex-reset
Cancel the effect of --clang-isystem-to-override-regex.
--clang-libcxx-include-to-override-regex dir_OCaml_regex
Use this option in the uncommon case where the normal compilation
process overrides the location of libc++. Concretely, this will
replace -I <path matching the regex> with -I
/path/to/infer/facebook-clang-plugins/clang/install/include/c++/v1.
--clang-libcxx-include-to-override-regex-reset
Cancel the effect of --clang-libcxx-include-to-override-regex.
--classpath string
Specify the Java classpath
--classpath-reset
Cancel the effect of --classpath.
--compilation-database-escaped-reset
Set --compilation-database-escaped to the empty list.
--compilation-database-reset
Set --compilation-database to the empty list.
--cost-issues-tests-reset
Cancel the effect of --cost-issues-tests.
--cost-scuba-logging
Activates: Log unknown functions to scuba in cost/inferbo
checkers; also sets --scuba-logging. (Conversely:
--no-cost-scuba-logging)
--costs-current-reset
Cancel the effect of --costs-current.
--costs-previous-reset
Cancel the effect of --costs-previous.
--coverage
analysis mode to maximize coverage (can take longer)
--debug-exceptions
Activates: Generate lightweight debugging information: just print
the internal exceptions during analysis (also sets
--developer-mode, --no-filtering, --no-deduplicate,
--print-buckets, --reports-include-ml-loc) (Conversely:
--no-debug-exceptions)
--debug-level-reset
Cancel the effect of --debug-level.
--debug-level-test-determinator int
Debug level for the test determinator. See --debug-level for
accepted values.
--developer-mode
Activates: Show internal exceptions (Conversely:
--no-developer-mode)
--differential-filter-files-reset
Cancel the effect of --differential-filter-files.
--differential-filter-set ,-separated sequence of { introduced | fixed
| preexisting }
Specify which set of the differential results is filtered with the
modified files provided through the --differential-modified-files
argument. By default it is applied to all sets (introduced, fixed,
and preexisting)
--disable-issue-type-reset
Set --disable-issue-type to the empty list.
--no-dotty-cfg-libs
Deactivates: Print the cfg of the code coming from the libraries
(Conversely: --dotty-cfg-libs)
--enable-issue-type-reset
Set --enable-issue-type to the empty list.
--eradicate-condition-redundant
Activates: Condition redundant warnings (Conversely:
--no-eradicate-condition-redundant)
--eradicate-field-over-annotated
Activates: Field over-annotated warnings (Conversely:
--no-eradicate-field-over-annotated)
--eradicate-return-over-annotated
Activates: Return over-annotated warning (Conversely:
--no-eradicate-return-over-annotated)
--eradicate-verbose
Activates: Print initial and final typestates (Conversely:
--no-eradicate-verbose)
--exit-node-bias
nodes nearest the exit node are analyzed first
--export-changed-functions
Activates: Make infer output changed functions, similar to
test-determinator. It is used together with the --modified-lines.
(Conversely: --no-export-changed-functions)
--external-java-packages-reset
Set --external-java-packages to the empty list.
--fcp-apple-clang path
Specify the path to Apple Clang
--fcp-apple-clang-reset
Cancel the effect of --fcp-apple-clang.
--fcp-syntax-only
Activates: Skip creation of object files (Conversely:
--no-fcp-syntax-only)
--file-renamings-reset
Cancel the effect of --file-renamings.
--no-filter-paths
Deactivates: Filters specified in .inferconfig (Conversely:
--filter-paths)
--force-integration-reset
Cancel the effect of --force-integration.
--from-json-costs-report-reset
Cancel the effect of --from-json-costs-report.
--from-json-report-reset
Cancel the effect of --from-json-report.
--frontend-stats
Activates: Output statistics about the capture phase to *.o.astlog
(clang only) (Conversely: --no-frontend-stats)
--function-pointer-specialization
Activates: Do function pointer preprocessing (clang only).
(Conversely: --no-function-pointer-specialization)
--generated-classes-reset
Cancel the effect of --generated-classes.
--genrule-mode
Activates: Enable the genrule compatibility mode used for the Buck
integration (Conversely: --no-genrule-mode)
--help-checker-reset
Set --help-checker to the empty list.
--help-issue-type-reset
Set --help-issue-type to the empty list.
--help-scrubbed
Show this manual without specifying default values induced by the
current build configuration
--help-scrubbed-full
Show the scrubbed manual with all internal options
--icfg-dotty-outfile path
If set, specifies path where .dot file should be written, it
overrides the path for all other options that would generate icfg
file otherwise
--icfg-dotty-outfile-reset
Cancel the effect of --icfg-dotty-outfile.
--no-inclusive-cost
Deactivates: Computes the inclusive cost (Conversely:
--inclusive-cost)
--incremental-analysis
Activates: [EXPERIMENTAL] Use incremental analysis for changed
files. Not compatible with --reanalyze and --continue-analysis.
(Conversely: --no-incremental-analysis)
--issues-tests-reset
Cancel the effect of --issues-tests.
--iterations int
Specify the maximum number of operations for each function,
expressed as a multiple of symbolic operations and a multiple of
seconds of elapsed time
--java-debug-source-file-info path
For debugging only: Call the Java declarations source file parser
on the given file and do not run anything else.
--java-debug-source-file-info-reset
Cancel the effect of --java-debug-source-file-info.
--java-jar-compiler-reset
Cancel the effect of --java-jar-compiler.
--java-version-reset
Cancel the effect of --java-version.
--job-id string
Specify the job ID of this Infer run.
--job-id-reset
Cancel the effect of --job-id.
--join-cond int
Set the strength of the final information-loss check used by the
join: - 0 = use the most aggressive join for preconditions
- 1 = use the least aggressive join for preconditions
--linter-reset
Cancel the effect of --linter.
--linters-def-file-reset
Set --linters-def-file to the empty list.
--linters-def-folder-reset
Set --linters-def-folder to the empty list.
--linters-doc-url-reset
Set --linters-doc-url to the empty list.
--load-average-reset
Cancel the effect of --load-average.
--margin int
Set right margin for the pretty printing functions
--max-jobs-reset
Cancel the effect of --max-jobs.
--max-nesting-reset
Cancel the effect of --max-nesting.
--method-decls-info method_decls_info.json
Specifies the file containing the method declarations info (eg.
start line, end line, class, method name, etc.) when Infer is run
Test Determinator mode with --test-determinator.
--method-decls-info-reset
Cancel the effect of --method-decls-info.
--modeled-expensive json
Matcher or list of matchers for methods that should be considered
expensive by the performance critical checker.
--modified-lines path
Specifies the file containing the modified lines when Infer is run
Test Determinator mode with --test-determinator.
--modified-lines-reset
Cancel the effect of --modified-lines.
--monitor-prop-size
Activates: Monitor size of props, and print every time the current
max is exceeded (Conversely: --no-monitor-prop-size)
--nelseg
Activates: Use only nonempty lsegs (Conversely: --no-nelseg)
--never-returning-null json
Matcher or list of matchers for functions that never return null.
--nullable-annotation-name string
Specify custom nullable annotation name
--nullable-annotation-name-reset
Cancel the effect of --nullable-annotation-name.
--nullsafe
Activates: checker nullsafe: [RESERVED] Reserved for nullsafe
typechecker, use `--eradicate` for now. (Conversely:
--no-nullsafe)
--nullsafe-disable-field-not-initialized-in-nonstrict-classes
Activates: Nullsafe: In this mode field not initialized issues
won't be reported unless the class is marked as @NullsafeStrict.
This feature is needed for compatibility reasons. (Conversely:
--no-nullsafe-disable-field-not-initialized-in-nonstrict-classes)
--no-nullsafe-optimistic-third-party-params-in-non-strict
Deactivates: Nullsafe: in this mode we treat non annotated third
party method params as if they were annotated as nullable.
(Conversely:
--nullsafe-optimistic-third-party-params-in-non-strict)
--nullsafe-strict-containers
Activates: Warn when containers are used with nullable keys or
values (Conversely: --no-nullsafe-strict-containers)
--nullsafe-third-party-location-for-messaging-only string
Path to a folder with annotated signatures to include into error
message. If not specified, path will be fetched from
nullsafe-third-party-signatures. This param is only needed for the
case when the real repository is located in the different place,
and nullsafe-third-party-signatures contains only its copy (which
can happen e.g. in case of caching by the build system)
--nullsafe-third-party-location-for-messaging-only-reset
Cancel the effect of
--nullsafe-third-party-location-for-messaging-only.
--nullsafe-third-party-signatures string
Path to a folder with annotated signatures of third-party methods
to be taken into account by nullsafe. Path is either relative to
.inferconfig folder or absolute
--nullsafe-third-party-signatures-reset
Cancel the effect of --nullsafe-third-party-signatures.
--no-only-cheap-debug
Deactivates: Disable expensive debugging output (Conversely:
--only-cheap-debug)
--only-footprint
Activates: Skip the re-execution phase (Conversely:
--no-only-footprint)
--oom-threshold int
Available memory threshold (in MB) below which multi-worker
scheduling throttles back work. Only for use on Linux.
--oom-threshold-reset
Cancel the effect of --oom-threshold.
--passthroughs
Activates: In error traces, show intermediate steps that propagate
data. When false, error traces are shorter and show only direct
flow via souces/sinks (Conversely: --no-passthroughs)
--perf-profiler-data-file-reset
Cancel the effect of --perf-profiler-data-file.
--print-buckets
Activates: Show the internal bucket of Infer reports in their
textual description (Conversely: --no-print-buckets)
--print-builtins
Activates: Print the builtin functions and exit (Conversely:
--no-print-builtins)
--print-jbir
Activates: Print JBir translation of Java bytecode in logs
(Conversely: --no-print-jbir)
--print-types
Activates: Print types in symbolic heaps (Conversely:
--no-print-types)
--no-print-using-diff
Deactivates: Highlight the difference w.r.t. the previous prop
when printing symbolic execution debug info (Conversely:
--print-using-diff)
--procedures-filter-reset
Cancel the effect of --procedures-filter.
--process-clang-ast
Activates: process the ast to emit some info about the file (Not
available for Java) (Conversely: --no-process-clang-ast)
--profiler-samples path
File containing the profiler samples when Infer is run Test
Determinator mode with --test-determinator.
--profiler-samples-reset
Cancel the effect of --profiler-samples.
--pulse-cut-to-one-path-procedures-pattern-reset
Cancel the effect of --pulse-cut-to-one-path-procedures-pattern.
--pulse-intraprocedural-only
Activates: Disable inter-procedural analysis in Pulse. Used for
experimentations only. (Conversely:
--no-pulse-intraprocedural-only)
--pulse-max-disjuncts int
Under-approximate after int disjunctions in the domain
--pulse-model-abort-reset
Set --pulse-model-abort to the empty list.
--pulse-model-alloc-pattern-reset
Cancel the effect of --pulse-model-alloc-pattern.
--pulse-model-release-pattern-reset
Cancel the effect of --pulse-model-release-pattern.
--pulse-model-return-nonnull-reset
Set --pulse-model-return-nonnull to the empty list.
--pulse-model-skip-pattern-reset
Cancel the effect of --pulse-model-skip-pattern.
--pulse-model-transfer-ownership-reset
Set --pulse-model-transfer-ownership to the empty list.
--pulse-recency-limit int
Maximum number of array elements and structure fields to keep
track of for a given array address.
--pulse-widen-threshold int
Under-approximate after int loop iterations
--pure-by-default
Activates: [Purity]Consider unknown functions to be pure by
default (Conversely: --no-pure-by-default)
--reanalyze
Activates: Rerun the analysis. Not compatible with
--incremental-analysis and --continue-analysis. (Conversely:
--no-reanalyze)
--report-blacklist-files-containing-reset
Set --report-blacklist-files-containing to the empty list.
--report-blacklist-path-regex-reset
Set --report-blacklist-path-regex to the empty list.
--report-console-limit-reset
Cancel the effect of --report-console-limit.
--report-current-reset
Cancel the effect of --report-current.
--report-previous-reset
Cancel the effect of --report-previous.
--report-suppress-errors-reset
Set --report-suppress-errors to the empty list.
--report-whitelist-path-regex-reset
Set --report-whitelist-path-regex to the empty list.
--reports-include-ml-loc
Activates: Include the location in the Infer source code from
where reports are generated (Conversely:
--no-reports-include-ml-loc)
--reset-linters-def-folder
Reset the list of folders containing linters definitions to be
empty (see linters-def-folder).
--resource-leak-lab
Activates: checker resource-leak-lab: Toy checker for the
"resource leak" write-your-own-checker exercise. (Conversely:
--no-resource-leak-lab)
--scheduler { file | restart | callgraph }
Specify the scheduler used for the analysis phase
--scuba-logging
Activates: (direct) logging to scuba (Conversely:
--no-scuba-logging)
--scuba-normal +key=value
add an extra string (normal) field to be set for each sample of
scuba, format <name>=<value>
--scuba-tags +key=value
add an extra set of strings (tagset) field to be set for each
sample of scuba, format <name>=(<value>,<value>,<value>|NONE)
--seconds-per-iteration float
Set the number of seconds per iteration (see --iterations)
--seconds-per-iteration-reset
Cancel the effect of --seconds-per-iteration.
--select-reset
Cancel the effect of --select.
--siof-safe-methods-reset
Set --siof-safe-methods to the empty list.
--skip-analysis-in-path-reset
Set --skip-analysis-in-path to the empty list.
--skip-implementation json
Matcher or list of matchers for names of files where we only want
to translate the method declaration, skipping the body of the
methods (Java only).
--skip-translation json
Matcher or list of matchers for names of files that should not be
analyzed at all.
--skip-translation-headers-reset
Set --skip-translation-headers to the empty list.
--source-files-filter-reset
Cancel the effect of --source-files-filter.
--sourcepath string
Specify the sourcepath
--sourcepath-reset
Cancel the effect of --sourcepath.
--sources +string
Specify the list of source files
--sources-reset
Set --sources to the empty list.
--sqlite-vfs string
VFS for SQLite
--sqlite-vfs-reset
Cancel the effect of --sqlite-vfs.
--starvation-skip-analysis json
Specify combinations of class/method list that should be skipped
during starvation analysis
--no-starvation-strict-mode
Deactivates: During starvation analysis, report strict mode
violations (Android only) (Conversely: --starvation-strict-mode)
--starvation-whole-program
Activates: Run whole-program starvation analysis (Conversely:
--no-starvation-whole-program)
--no-subtype-multirange
Deactivates: Use the multirange subtyping domain (Conversely:
--subtype-multirange)
--summaries-caches-max-size int
The maximum amount of elements the summaries LRU caches can hold
--symops-per-iteration int
Set the number of symbolic operations per iteration (see
--iterations)
--symops-per-iteration-reset
Cancel the effect of --symops-per-iteration.
--test-determinator
Activates: Run infer in Test Determinator mode. It is used
together with the --modified-lines and --profiler-samples flags,
which specify the relevant arguments. (Conversely:
--no-test-determinator)
--test-filtering
Activates: List all the files Infer can report on (should be
called from the root of the project) (Conversely:
--no-test-filtering)
--testing-mode
Activates: Mode for testing, where no headers are translated, and
dot files are created (clang only) (Conversely: --no-testing-mode)
--topl-properties +path
[EXPERIMENTAL] Specify a file containing a temporal property
definition (e.g., jdk.topl).
--topl-properties-reset
Set --topl-properties to the empty list.
--trace-error
Activates: Detailed tracing information during error explanation
(Conversely: --no-trace-error)
--trace-events
Activates: Emit Chrome performance trace events in
infer-out/perf_events.json (Conversely: --no-trace-events)
--trace-join
Activates: Detailed tracing information during prop join
operations (Conversely: --no-trace-join)
--trace-rearrange
Activates: Detailed tracing information during prop re-arrangement
operations (Conversely: --no-trace-rearrange)
--trace-topl
Activates: Detailed tracing information during TOPL analysis
(Conversely: --no-trace-topl)
--tv-commit commit
Commit hash to submit to Traceview
--tv-commit-reset
Cancel the effect of --tv-commit.
--tv-limit int
The maximum number of traces to submit to Traceview
--tv-limit-filtered int
The maximum number of traces for issues filtered out by
--report-filter to submit to Traceview
--type-size
Activates: Consider the size of types during analysis, e.g. cannot
use an int pointer to write to a char (Conversely: --no-type-size)
--uninit-interproc
Activates: Run uninit check in the experimental interprocedural
mode (Conversely: --no-uninit-interproc)
--version-vcs
Print version control system commit and exit
--visits-bias
nodes visited fewer times are analyzed first
--write-dotty
Activates: Produce dotty files for specs in the results directory
(Conversely: --no-write-dotty)
--write-html
Activates: Produce html debug output in the results directory
(Conversely: --no-write-html)
--write-html-whitelist-regex +string
Whitelist files that will have their html debug output printed
when --html is true.
--write-html-whitelist-regex-reset
Set --write-html-whitelist-regex to the empty list.
--write-website-reset
Cancel the effect of --write-website.
--Xbuck-no-inline-reset
Set --Xbuck-no-inline to the empty list.
--Xbuck-reset
Set --Xbuck to the empty list.
--Xclang-reset
Set --Xclang to the empty list.
--xcode-developer-dir-reset
Cancel the effect of --xcode-developer-dir.
--xcode-isysroot-suffix-reset
Cancel the effect of --xcode-isysroot-suffix.
ENVIRONMENT
Extra arguments may be passed to all infer commands using the
INFER_ARGS environment variable (see the OPTIONS section). INFER_ARGS
is expected to contain a string of ^-separated options. For instance,
calling `INFER_ARGS=--debug^--print-logs infer` is equivalent to
calling `infer --debug --print-logs`.
INFERCONFIG: Tells infer where to find the .inferconfig file. (See the
FILES section)
If INFER_STRICT_MODE is set to "1", then infer commands will exit with
an error code in some cases when otherwise a simple warning would be
emitted on stderr, for instance if a deprecated form of an option is
used.
FILES
.inferconfig can be used to store infer options. Its format is that of
a JSON record, where fields are infer long-form options, without their
leading "--", and values depend on the type of the option:
- for switches options, the value is a JSON boolean (true or false,
without quotes)
- for integers, the value is a JSON integer (without quotes)
- string options have string values
- path options have string values, and are interpreted relative to the
location of the .inferconfig file
- cumulative options are JSON arrays of the appropriate type
Infer will look for an .inferconfig file in the current directory,
then its parent, etc., stopping at the first .inferconfig file found.
Example:
{
"cxx": false,
"infer-blacklist-files-containing": ["@gen","/* no infer */"]
}
SEE ALSO
infer-analyze(1), infer-capture(1), infer-compile(1), infer-debug(1),
infer-explore(1), infer-help(1), infer-report(1), infer-reportdiff(1),
infer-run(1)