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.

115 lines
3.4 KiB

(*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*)
open! IStd
module F = Format
type std_vector_function =
| Assign
| Clear
| Emplace
| EmplaceBack
| Insert
| PushBack
| Reserve
| ShrinkToFit
[@@deriving compare, equal]
let pp_std_vector_function f = function
| Assign ->
F.fprintf f "std::vector::assign"
| Clear ->
F.fprintf f "std::vector::clear"
| Emplace ->
F.fprintf f "std::vector::emplace"
| EmplaceBack ->
F.fprintf f "std::vector::emplace_back"
| Insert ->
F.fprintf f "std::vector::insert"
| PushBack ->
F.fprintf f "std::vector::push_back"
| Reserve ->
F.fprintf f "std::vector::reserve"
| ShrinkToFit ->
F.fprintf f "std::vector::shrink_to_fit"
type java_iterator_function = Remove [@@deriving compare, equal]
let pp_java_iterator_function f = function Remove -> F.pp_print_string f "Iterator.remove"
type t =
| CFree
| ConstantDereference of IntLit.t
| CppDelete
| EndIterator
| GoneOutOfScope of Pvar.t * Typ.t
| OptionalEmpty
| StdVector of std_vector_function
| JavaIterator of java_iterator_function
[@@deriving compare, equal]
let issue_type_of_cause = function
| CFree ->
IssueType.use_after_free
| ConstantDereference i when IntLit.iszero i ->
IssueType.nullptr_dereference
| ConstantDereference _ ->
IssueType.constant_address_dereference
| CppDelete ->
IssueType.use_after_delete
| EndIterator ->
IssueType.vector_invalidation
| GoneOutOfScope _ ->
IssueType.use_after_lifetime
| OptionalEmpty ->
IssueType.optional_empty_access
| JavaIterator _ | StdVector _ ->
IssueType.vector_invalidation
let describe f cause =
match cause with
| CFree ->
F.pp_print_string f "was invalidated by call to `free()`"
| ConstantDereference i when IntLit.iszero i ->
F.pp_print_string f "is the null pointer"
| ConstantDereference i ->
F.fprintf f "is the constant %a" IntLit.pp i
| CppDelete ->
F.pp_print_string f "was invalidated by `delete`"
| EndIterator ->
F.pp_print_string f "is pointed to by the `end()` iterator"
| GoneOutOfScope (pvar, typ) ->
let pp_var f pvar =
if Pvar.is_cpp_temporary pvar then
F.fprintf f "is the address of a C++ temporary of type `%a`" (Typ.pp_full Pp.text) typ
else F.fprintf f "is the address of a stack variable `%a`" Pvar.pp_value pvar
in
F.fprintf f "%a whose lifetime has ended" pp_var pvar
| OptionalEmpty ->
F.pp_print_string f "is folly::None"
| StdVector std_vector_f ->
F.fprintf f "was potentially invalidated by `%a()`" pp_std_vector_function std_vector_f
| JavaIterator java_iterator_f ->
F.fprintf f "was potentially invalidated by `%a()`" pp_java_iterator_function java_iterator_f
let pp f invalidation =
match invalidation with
| CFree ->
F.fprintf f "CFree(%a)" describe invalidation
| ConstantDereference _ ->
F.fprintf f "ConstantDereference(%a)" describe invalidation
| CppDelete ->
F.fprintf f "CppDelete(%a)" describe invalidation
| EndIterator | GoneOutOfScope _ | OptionalEmpty ->
describe f invalidation
| StdVector _ ->
F.fprintf f "StdVector(%a)" describe invalidation
| JavaIterator _ ->
F.fprintf f "JavaIterator(%a)" describe invalidation