annotate gcc/analyzer/sm-malloc.dot @ 145:1830386684a0

gcc-9.2.0
author anatofuz
date Thu, 13 Feb 2020 11:34:05 +0900
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
145
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
1 /* An overview of the state machine from sm-malloc.cc.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
2 Copyright (C) 2019-2020 Free Software Foundation, Inc.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
3 Contributed by David Malcolm <dmalcolm@redhat.com>.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
4
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
5 This file is part of GCC.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
6
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
7 GCC is free software; you can redistribute it and/or modify it
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
8 under the terms of the GNU General Public License as published by
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
9 the Free Software Foundation; either version 3, or (at your option)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
10 any later version.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
11
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
12 GCC is distributed in the hope that it will be useful, but
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
13 WITHOUT ANY WARRANTY; without even the implied warranty of
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
15 General Public License for more details.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
16
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
18 along with GCC; see the file COPYING3. If not see
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
19 <http://www.gnu.org/licenses/>. */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
20
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
21 /* Keep this in-sync with sm-malloc.cc */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
22
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
23 digraph "malloc" {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
24
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
25 /* STATES. */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
26
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
27 /* Start state. */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
28 start;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
29
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
30 /* State for a pointer returned from malloc that hasn't been checked for
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
31 NULL.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
32 It could be a pointer to heap-allocated memory, or could be NULL. */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
33 unchecked;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
34
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
35 /* State for a pointer that's known to be NULL. */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
36 null;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
37
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
38 /* State for a pointer to heap-allocated memory, known to be non-NULL. */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
39 nonnull;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
40
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
41 /* State for a pointer to freed memory. */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
42 freed;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
43
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
44 /* State for a pointer that's known to not be on the heap (e.g. to a local
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
45 or global). */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
46 non_heap;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
47
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
48 /* Stop state, for pointers we don't want to track any more. */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
49 stop;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
50
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
51 /* TRANSITIONS. */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
52
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
53 start -> unchecked [label="on 'X=malloc(...);'"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
54 start -> unchecked [label="on 'X=calloc(...);'"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
55
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
56 start -> non_heap [label="on 'X=alloca(...);'"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
57 start -> non_heap [label="on 'X=__builtin_alloca(...);'"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
58
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
59 /* On "free". */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
60 start -> freed [label="on 'free(X);'"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
61 unchecked -> freed [label="on 'free(X);'"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
62 nonnull -> freed [label="on 'free(X);'"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
63 freed -> stop [label="on 'free(X);':\n Warn('double-free')"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
64 non_heap -> stop [label="on 'free(X);':\n Warn('free of non-heap')"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
65
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
66 /* Handle "__attribute__((nonnull))". */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
67 unchecked -> nonnull [label="on 'FN(X)' with __attribute__((nonnull)):\nWarn('possible NULL arg')"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
68 null -> stop [label="on 'FN(X)' with __attribute__((nonnull)):\nWarn('NULL arg')"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
69
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
70 /* is_zero_assignment. */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
71 start -> null [label="on 'X = 0;'"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
72 unchecked -> null [label="on 'X = 0;'"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
73 nonnull -> null [label="on 'X = 0;'"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
74 freed -> null [label="on 'X = 0;'"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
75
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
76 start -> non_heap [label="on 'X = &EXPR;'"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
77
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
78 /* Handle dereferences. */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
79 unchecked -> nonnull [label="on '*X':\nWarn('possible NULL deref')"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
80 null -> stop [label="on '*X':\nWarn('NULL deref')"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
81 freed -> stop [label="on '*X':\nWarn('use after free')"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
82
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
83 /* on_condition. */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
84 unchecked -> nonnull [label="on 'X != 0'"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
85 unchecked -> null [label="on 'X == 0'"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
86
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
87 unchecked -> stop [label="on leak:\nWarn('leak')"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
88 nonnull -> stop [label="on leak:\nWarn('leak')"];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
89 }