aboutsummaryrefslogtreecommitdiff
path: root/clang/test/Analysis/stream-note.c
blob: 2b5d1edb2814f08322fc6a44a9323a7275a5f1cb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
// RUN: %clang_analyze_cc1 -analyzer-checker=core,unix.Stream -analyzer-output text \
// RUN:   -analyzer-config unix.Stream:Pedantic=true \
// RUN:   -verify %s
// RUN: %clang_analyze_cc1 -analyzer-checker=core,unix.Stream,unix.StdCLibraryFunctions -analyzer-output text \
// RUN:   -analyzer-config unix.Stream:Pedantic=true \
// RUN:   -analyzer-config unix.StdCLibraryFunctions:ModelPOSIX=true -verify=expected,stdargs %s

#include "Inputs/system-header-simulator.h"

void check_note_at_correct_open(void) {
  FILE *F1 = tmpfile(); // expected-note {{Stream opened here}}
  // stdargs-note@-1 {{'tmpfile' is successful}}
  if (!F1)
    // expected-note@-1 {{'F1' is non-null}}
    // expected-note@-2 {{Taking false branch}}
    return;
  FILE *F2 = tmpfile();
  if (!F2) {
    // expected-note@-1 {{'F2' is non-null}}
    // expected-note@-2 {{Taking false branch}}
    fclose(F1);
    return;
  }
  rewind(F2);
  fclose(F2);
  rewind(F1);
}
// expected-warning@-1 {{Opened stream never closed. Potential resource leak}}
// expected-note@-2 {{Opened stream never closed. Potential resource leak}}

void check_note_fopen(void) {
  FILE *F = fopen("file", "r"); // expected-note {{Stream opened here}}
  // stdargs-note@-1 {{'fopen' is successful}}
  if (!F)
    // expected-note@-1 {{'F' is non-null}}
    // expected-note@-2 {{Taking false branch}}
    return;
}
// expected-warning@-1 {{Opened stream never closed. Potential resource leak}}
// expected-note@-2 {{Opened stream never closed. Potential resource leak}}

void check_note_freopen(void) {
  FILE *F = fopen("file", "r"); // expected-note {{Stream opened here}}
  // stdargs-note@-1 {{'fopen' is successful}}
  if (!F)
    // expected-note@-1 {{'F' is non-null}}
    // expected-note@-2 {{Taking false branch}}
    return;
  F = freopen(0, "w", F); // expected-note {{Stream reopened here}}
  // stdargs-note@-1 {{'freopen' is successful}}
  if (!F)
    // expected-note@-1 {{'F' is non-null}}
    // expected-note@-2 {{Taking false branch}}
    return;
}
// expected-warning@-1 {{Opened stream never closed. Potential resource leak}}
// expected-note@-2 {{Opened stream never closed. Potential resource leak}}

void check_note_fdopen(int fd) {
  FILE *F = fdopen(fd, "r"); // expected-note {{Stream opened here}}
  // stdargs-note@-1 {{'fdopen' is successful}}
  if (!F)
    // expected-note@-1 {{'F' is non-null}}
    // expected-note@-2 {{Taking false branch}}
    return;
}
// expected-warning@-1 {{Opened stream never closed. Potential resource leak}}
// expected-note@-2 {{Opened stream never closed. Potential resource leak}}

void check_note_leak_2(int c) {
  FILE *F1 = fopen("foo1.c", "r"); // expected-note {{Stream opened here}}
  // stdargs-note@-1 {{'fopen' is successful}}
  if (!F1)
    // expected-note@-1 {{'F1' is non-null}}
    // expected-note@-2 {{Taking false branch}}
    // expected-note@-3 {{'F1' is non-null}}
    // expected-note@-4 {{Taking false branch}}
    return;
  FILE *F2 = fopen("foo2.c", "r"); // expected-note {{Stream opened here}}
  // stdargs-note@-1 {{'fopen' is successful}}
  if (!F2) {
    // expected-note@-1 {{'F2' is non-null}}
    // expected-note@-2 {{Taking false branch}}
    // expected-note@-3 {{'F2' is non-null}}
    // expected-note@-4 {{Taking false branch}}
    fclose(F1);
    return;
  }
  if (c)
    // expected-note@-1 {{Assuming 'c' is not equal to 0}}
    // expected-note@-2 {{Taking true branch}}
    // expected-note@-3 {{Assuming 'c' is not equal to 0}}
    // expected-note@-4 {{Taking true branch}}
    return;
  // expected-warning@-1 {{Opened stream never closed. Potential resource leak}}
  // expected-note@-2 {{Opened stream never closed. Potential resource leak}}
  // expected-warning@-3 {{Opened stream never closed. Potential resource leak}}
  // expected-note@-4 {{Opened stream never closed. Potential resource leak}}
  fclose(F1);
  fclose(F2);
}

void check_track_null(void) {
  FILE *F;
  F = fopen("foo1.c", "r"); // expected-note {{Value assigned to 'F'}} expected-note {{Assuming pointer value is null}}
  // stdargs-note@-1 {{'fopen' fails}}
  if (F != NULL) {          // expected-note {{Taking false branch}} expected-note {{'F' is equal to NULL}}
    fclose(F);
    return;
  }
  fclose(F); // expected-warning {{Stream pointer might be NULL}}
             // expected-note@-1 {{Stream pointer might be NULL}}
}

void check_eof_notes_feof_after_feof(void) {
  FILE *F;
  char Buf[10];
  F = fopen("foo1.c", "r");
  if (F == NULL) { // expected-note {{Taking false branch}} expected-note {{'F' is not equal to NULL}}
    return;
  }
  fread(Buf, 1, 1, F);
  if (feof(F)) { // expected-note {{Taking true branch}}
    clearerr(F);
    fread(Buf, 1, 1, F);   // expected-note {{Assuming stream reaches end-of-file here}}
    if (feof(F)) {         // expected-note {{Taking true branch}}
      fread(Buf, 1, 1, F); // expected-warning {{Read function called when stream is in EOF state. Function has no effect}}
      // expected-note@-1 {{Read function called when stream is in EOF state. Function has no effect}}
    }
  }
  fclose(F);
}

void check_eof_notes_feof_after_no_feof(void) {
  FILE *F;
  char Buf[10];
  F = fopen("foo1.c", "r");
  if (F == NULL) { // expected-note {{Taking false branch}} expected-note {{'F' is not equal to NULL}}
    return;
  }
  fread(Buf, 1, 1, F);
  if (feof(F)) { // expected-note {{Taking false branch}}
    fclose(F);
    return;
  } else if (ferror(F)) { // expected-note {{Taking false branch}}
    fclose(F);
    return;
  }
  fread(Buf, 1, 1, F);   // expected-note {{Assuming stream reaches end-of-file here}}
  if (feof(F)) {         // expected-note {{Taking true branch}}
    fread(Buf, 1, 1, F); // expected-warning {{Read function called when stream is in EOF state. Function has no effect}}
    // expected-note@-1 {{Read function called when stream is in EOF state. Function has no effect}}
  }
  fclose(F);
}

void check_eof_notes_feof_or_no_error(void) {
  FILE *F;
  char Buf[10];
  F = fopen("foo1.c", "r");
  if (F == NULL) // expected-note {{Taking false branch}} expected-note {{'F' is not equal to NULL}}
    return;
  int RRet = fread(Buf, 1, 1, F); // expected-note {{Assuming stream reaches end-of-file here}}
  if (ferror(F)) {                // expected-note {{Taking false branch}}
  } else {
    fread(Buf, 1, 1, F); // expected-warning {{Read function called when stream is in EOF state. Function has no effect}}
    // expected-note@-1 {{Read function called when stream is in EOF state. Function has no effect}}
  }
  fclose(F);
}

void check_indeterminate_notes(void) {
  FILE *F;
  F = fopen("foo1.c", "r");
  if (F == NULL)     // expected-note {{Taking false branch}} \
                     // expected-note {{'F' is not equal to NULL}}
    return;
  int R = fgetc(F);  // no note
  if (R >= 0) {      // expected-note {{Taking true branch}} \
                     // expected-note {{'R' is >= 0}}
    fgetc(F);        // expected-note {{Assuming this stream operation fails}}
    if (ferror(F))   // expected-note {{Taking true branch}}
      fgetc(F);      // expected-warning {{File position of the stream might be 'indeterminate' after a failed operation. Can cause undefined behavior}} \
                     // expected-note {{File position of the stream might be 'indeterminate' after a failed operation. Can cause undefined behavior}}
  }
  fclose(F);
}

void check_indeterminate_after_clearerr(void) {
  FILE *F;
  char Buf[10];
  F = fopen("foo1.c", "r");
  if (F == NULL)          // expected-note {{Taking false branch}} \
                          // expected-note {{'F' is not equal to NULL}}
    return;
  fread(Buf, 1, 1, F);    // expected-note {{Assuming this stream operation fails}}
  if (ferror(F)) {        // expected-note {{Taking true branch}}
    clearerr(F);
    fread(Buf, 1, 1, F);  // expected-warning {{might be 'indeterminate' after a failed operation}} \
                          // expected-note {{might be 'indeterminate' after a failed operation}}
  }
  fclose(F);
}

void check_indeterminate_eof(void) {
  FILE *F;
  char Buf[2];
  F = fopen("foo1.c", "r");
  if (F == NULL)               // expected-note {{Taking false branch}} \
                               // expected-note {{'F' is not equal to NULL}} \
                               // expected-note {{Taking false branch}} \
                               // expected-note {{'F' is not equal to NULL}}
    return;
  fgets(Buf, sizeof(Buf), F);  // expected-note {{Assuming this stream operation fails}} \
                               // expected-note {{Assuming stream reaches end-of-file here}}

  fgets(Buf, sizeof(Buf), F);  // expected-warning {{might be 'indeterminate'}} \
                               // expected-note {{might be 'indeterminate'}} \
                               // expected-warning {{stream is in EOF state}} \
                               // expected-note {{stream is in EOF state}}
  fclose(F);
}

void check_indeterminate_fseek(void) {
  FILE *F = fopen("file", "r");
  if (!F)                           // expected-note {{Taking false branch}} \
                                    // expected-note {{'F' is non-null}}
    return;
  int Ret = fseek(F, 1, SEEK_SET);  // expected-note {{Assuming this stream operation fails}}
  if (Ret) {                        // expected-note {{Taking true branch}} \
                                    // expected-note {{'Ret' is -1}}
    char Buf[2];
    fwrite(Buf, 1, 2, F);           // expected-warning {{might be 'indeterminate'}} \
                                    // expected-note {{might be 'indeterminate'}}
  }
  fclose(F);
}

void error_fseek_ftell(void) {
  FILE *F = fopen("file", "r");
  if (!F)                 // expected-note {{Taking false branch}} \
                          // expected-note {{'F' is non-null}}
    return;
  fseek(F, 0, SEEK_END);  // expected-note {{Assuming this stream operation fails}}
  long size = ftell(F);   // expected-warning {{might be 'indeterminate'}} \
                          // expected-note {{might be 'indeterminate'}}
  if (size == -1) {
    fclose(F);
    return;
  }
  if (size == 1)
    fprintf(F, "abcd");
  fclose(F);
}

void error_fseek_read_eof(void) {
  FILE *F = fopen("file", "r");
  if (!F)
    return;
  if (fseek(F, 22, SEEK_SET) == -1) {
    fclose(F);
    return;
  }
  fgetc(F); // no warning
  fclose(F);
}

void check_note_at_use_after_close(void) {
  FILE *F = tmpfile();
  if (!F) // expected-note {{'F' is non-null}} expected-note {{Taking false branch}}
    return;
  fclose(F); // expected-note {{Stream is closed here}}
  rewind(F); // expected-warning {{Use of a stream that might be already closed}}
  // expected-note@-1 {{Use of a stream that might be already closed}}
}