1e804f892SPaolo Bonzini /* Coverity Scan model
2e804f892SPaolo Bonzini *
3e804f892SPaolo Bonzini * Copyright (C) 2014 Red Hat, Inc.
4e804f892SPaolo Bonzini *
5e804f892SPaolo Bonzini * Authors:
6e804f892SPaolo Bonzini * Markus Armbruster <armbru@redhat.com>
7e804f892SPaolo Bonzini * Paolo Bonzini <pbonzini@redhat.com>
8e804f892SPaolo Bonzini *
9e804f892SPaolo Bonzini * This work is licensed under the terms of the GNU GPL, version 2 or, at your
10e804f892SPaolo Bonzini * option, any later version. See the COPYING file in the top-level directory.
11e804f892SPaolo Bonzini */
12e804f892SPaolo Bonzini
13e804f892SPaolo Bonzini
14e804f892SPaolo Bonzini /*
15e804f892SPaolo Bonzini * This is the source code for our Coverity user model file. The
16e804f892SPaolo Bonzini * purpose of user models is to increase scanning accuracy by explaining
17e804f892SPaolo Bonzini * code Coverity can't see (out of tree libraries) or doesn't
18e804f892SPaolo Bonzini * sufficiently understand. Better accuracy means both fewer false
19e804f892SPaolo Bonzini * positives and more true defects. Memory leaks in particular.
20e804f892SPaolo Bonzini *
21e804f892SPaolo Bonzini * - A model file can't import any header files. Some built-in primitives are
22e804f892SPaolo Bonzini * available but not wchar_t, NULL etc.
23e804f892SPaolo Bonzini * - Modeling doesn't need full structs and typedefs. Rudimentary structs
24e804f892SPaolo Bonzini * and similar types are sufficient.
25e804f892SPaolo Bonzini * - An uninitialized local variable signifies that the variable could be
26e804f892SPaolo Bonzini * any value.
27e804f892SPaolo Bonzini *
28e804f892SPaolo Bonzini * The model file must be uploaded by an admin in the analysis settings of
29e804f892SPaolo Bonzini * http://scan.coverity.com/projects/378
30e804f892SPaolo Bonzini */
31e804f892SPaolo Bonzini
32e804f892SPaolo Bonzini #define NULL ((void *)0)
33e804f892SPaolo Bonzini
34e804f892SPaolo Bonzini typedef unsigned char uint8_t;
35e804f892SPaolo Bonzini typedef char int8_t;
36e804f892SPaolo Bonzini typedef unsigned int uint32_t;
37e804f892SPaolo Bonzini typedef int int32_t;
38e804f892SPaolo Bonzini typedef long ssize_t;
39e804f892SPaolo Bonzini typedef unsigned long long uint64_t;
40e804f892SPaolo Bonzini typedef long long int64_t;
41e804f892SPaolo Bonzini typedef _Bool bool;
42e804f892SPaolo Bonzini
43e804f892SPaolo Bonzini typedef struct va_list_str *va_list;
44e804f892SPaolo Bonzini
45e804f892SPaolo Bonzini /* Tainting */
46e804f892SPaolo Bonzini
47e804f892SPaolo Bonzini typedef struct {} name2keysym_t;
get_keysym(const name2keysym_t * table,const char * name)48e804f892SPaolo Bonzini static int get_keysym(const name2keysym_t *table,
49e804f892SPaolo Bonzini const char *name)
50e804f892SPaolo Bonzini {
51e804f892SPaolo Bonzini int result;
52e804f892SPaolo Bonzini if (result > 0) {
53e804f892SPaolo Bonzini __coverity_tainted_string_sanitize_content__(name);
54e804f892SPaolo Bonzini return result;
55e804f892SPaolo Bonzini } else {
56e804f892SPaolo Bonzini return 0;
57e804f892SPaolo Bonzini }
58e804f892SPaolo Bonzini }
59e804f892SPaolo Bonzini
60e804f892SPaolo Bonzini /* Replay data is considered trusted. */
replay_get_byte(void)61e804f892SPaolo Bonzini uint8_t replay_get_byte(void)
62e804f892SPaolo Bonzini {
63e804f892SPaolo Bonzini uint8_t byte;
64e804f892SPaolo Bonzini return byte;
65e804f892SPaolo Bonzini }
66e804f892SPaolo Bonzini
67e804f892SPaolo Bonzini
68e804f892SPaolo Bonzini /*
69e804f892SPaolo Bonzini * GLib memory allocation functions.
70e804f892SPaolo Bonzini *
71e804f892SPaolo Bonzini * Note that we ignore the fact that g_malloc of 0 bytes returns NULL,
72e804f892SPaolo Bonzini * and g_realloc of 0 bytes frees the pointer.
73e804f892SPaolo Bonzini *
74e804f892SPaolo Bonzini * Modeling this would result in Coverity flagging a lot of memory
75e804f892SPaolo Bonzini * allocations as potentially returning NULL, and asking us to check
76e804f892SPaolo Bonzini * whether the result of the allocation is NULL or not. However, the
77e804f892SPaolo Bonzini * resulting pointer should never be dereferenced anyway, and in fact
78e804f892SPaolo Bonzini * it is not in the vast majority of cases.
79e804f892SPaolo Bonzini *
80e804f892SPaolo Bonzini * If a dereference did happen, this would suppress a defect report
81e804f892SPaolo Bonzini * for an actual null pointer dereference. But it's too unlikely to
82e804f892SPaolo Bonzini * be worth wading through the false positives, and with some luck
83e804f892SPaolo Bonzini * we'll get a buffer overflow reported anyway.
84e804f892SPaolo Bonzini */
85e804f892SPaolo Bonzini
86e804f892SPaolo Bonzini /*
87e804f892SPaolo Bonzini * Allocation primitives, cannot return NULL
88e804f892SPaolo Bonzini * See also Coverity's library/generic/libc/all/all.c
89e804f892SPaolo Bonzini */
90e804f892SPaolo Bonzini
g_malloc_n(size_t nmemb,size_t size)91e804f892SPaolo Bonzini void *g_malloc_n(size_t nmemb, size_t size)
92e804f892SPaolo Bonzini {
93e804f892SPaolo Bonzini void *ptr;
94e804f892SPaolo Bonzini
95e804f892SPaolo Bonzini __coverity_negative_sink__(nmemb);
96e804f892SPaolo Bonzini __coverity_negative_sink__(size);
9705ad6857SPaolo Bonzini ptr = __coverity_alloc__(nmemb * size);
980da41187SPaolo Bonzini if (!ptr) {
990da41187SPaolo Bonzini __coverity_panic__();
1000da41187SPaolo Bonzini }
101e804f892SPaolo Bonzini __coverity_mark_as_uninitialized_buffer__(ptr);
102243a545bSPaolo Bonzini __coverity_mark_as_afm_allocated__(ptr, AFM_free);
103e804f892SPaolo Bonzini return ptr;
104e804f892SPaolo Bonzini }
105e804f892SPaolo Bonzini
g_malloc0_n(size_t nmemb,size_t size)106e804f892SPaolo Bonzini void *g_malloc0_n(size_t nmemb, size_t size)
107e804f892SPaolo Bonzini {
108e804f892SPaolo Bonzini void *ptr;
109e804f892SPaolo Bonzini
110e804f892SPaolo Bonzini __coverity_negative_sink__(nmemb);
111e804f892SPaolo Bonzini __coverity_negative_sink__(size);
11205ad6857SPaolo Bonzini ptr = __coverity_alloc__(nmemb * size);
1130da41187SPaolo Bonzini if (!ptr) {
1140da41187SPaolo Bonzini __coverity_panic__();
1150da41187SPaolo Bonzini }
116e804f892SPaolo Bonzini __coverity_writeall0__(ptr);
117243a545bSPaolo Bonzini __coverity_mark_as_afm_allocated__(ptr, AFM_free);
118e804f892SPaolo Bonzini return ptr;
119e804f892SPaolo Bonzini }
120e804f892SPaolo Bonzini
g_realloc_n(void * ptr,size_t nmemb,size_t size)121e804f892SPaolo Bonzini void *g_realloc_n(void *ptr, size_t nmemb, size_t size)
122e804f892SPaolo Bonzini {
123e804f892SPaolo Bonzini __coverity_negative_sink__(nmemb);
124e804f892SPaolo Bonzini __coverity_negative_sink__(size);
125e804f892SPaolo Bonzini __coverity_escape__(ptr);
12605ad6857SPaolo Bonzini ptr = __coverity_alloc__(nmemb * size);
1270da41187SPaolo Bonzini if (!ptr) {
1280da41187SPaolo Bonzini __coverity_panic__();
1290da41187SPaolo Bonzini }
130e804f892SPaolo Bonzini /*
131e804f892SPaolo Bonzini * Memory beyond the old size isn't actually initialized. Can't
132e804f892SPaolo Bonzini * model that. See Coverity's realloc() model
133e804f892SPaolo Bonzini */
134e804f892SPaolo Bonzini __coverity_writeall__(ptr);
135243a545bSPaolo Bonzini __coverity_mark_as_afm_allocated__(ptr, AFM_free);
136e804f892SPaolo Bonzini return ptr;
137e804f892SPaolo Bonzini }
138e804f892SPaolo Bonzini
g_free(void * ptr)139e804f892SPaolo Bonzini void g_free(void *ptr)
140e804f892SPaolo Bonzini {
141e804f892SPaolo Bonzini __coverity_free__(ptr);
142243a545bSPaolo Bonzini __coverity_mark_as_afm_freed__(ptr, AFM_free);
143e804f892SPaolo Bonzini }
144e804f892SPaolo Bonzini
145e804f892SPaolo Bonzini /*
146e804f892SPaolo Bonzini * Derive the g_try_FOO_n() from the g_FOO_n() by adding indeterminate
147e804f892SPaolo Bonzini * out of memory conditions
148e804f892SPaolo Bonzini */
149e804f892SPaolo Bonzini
g_try_malloc_n(size_t nmemb,size_t size)150e804f892SPaolo Bonzini void *g_try_malloc_n(size_t nmemb, size_t size)
151e804f892SPaolo Bonzini {
152e804f892SPaolo Bonzini int nomem;
153e804f892SPaolo Bonzini
154e804f892SPaolo Bonzini if (nomem) {
155e804f892SPaolo Bonzini return NULL;
156e804f892SPaolo Bonzini }
157e804f892SPaolo Bonzini return g_malloc_n(nmemb, size);
158e804f892SPaolo Bonzini }
159e804f892SPaolo Bonzini
g_try_malloc0_n(size_t nmemb,size_t size)160e804f892SPaolo Bonzini void *g_try_malloc0_n(size_t nmemb, size_t size)
161e804f892SPaolo Bonzini {
162e804f892SPaolo Bonzini int nomem;
163e804f892SPaolo Bonzini
164e804f892SPaolo Bonzini if (nomem) {
165e804f892SPaolo Bonzini return NULL;
166e804f892SPaolo Bonzini }
167e804f892SPaolo Bonzini return g_malloc0_n(nmemb, size);
168e804f892SPaolo Bonzini }
169e804f892SPaolo Bonzini
g_try_realloc_n(void * ptr,size_t nmemb,size_t size)170e804f892SPaolo Bonzini void *g_try_realloc_n(void *ptr, size_t nmemb, size_t size)
171e804f892SPaolo Bonzini {
172e804f892SPaolo Bonzini int nomem;
173e804f892SPaolo Bonzini
174e804f892SPaolo Bonzini if (nomem) {
175e804f892SPaolo Bonzini return NULL;
176e804f892SPaolo Bonzini }
177e804f892SPaolo Bonzini return g_realloc_n(ptr, nmemb, size);
178e804f892SPaolo Bonzini }
179e804f892SPaolo Bonzini
18096915d63SPaolo Bonzini /* Derive the g_FOO() from the g_FOO_n() */
181e804f892SPaolo Bonzini
g_malloc(size_t size)182e804f892SPaolo Bonzini void *g_malloc(size_t size)
183e804f892SPaolo Bonzini {
184e17bdaabSPaolo Bonzini void *ptr;
185e17bdaabSPaolo Bonzini
186e17bdaabSPaolo Bonzini __coverity_negative_sink__(size);
187e17bdaabSPaolo Bonzini ptr = __coverity_alloc__(size);
188e17bdaabSPaolo Bonzini if (!ptr) {
189e17bdaabSPaolo Bonzini __coverity_panic__();
190e17bdaabSPaolo Bonzini }
191e17bdaabSPaolo Bonzini __coverity_mark_as_uninitialized_buffer__(ptr);
192e17bdaabSPaolo Bonzini __coverity_mark_as_afm_allocated__(ptr, AFM_free);
193e17bdaabSPaolo Bonzini return ptr;
194e804f892SPaolo Bonzini }
195e804f892SPaolo Bonzini
g_malloc0(size_t size)196e804f892SPaolo Bonzini void *g_malloc0(size_t size)
197e804f892SPaolo Bonzini {
198e17bdaabSPaolo Bonzini void *ptr;
199e17bdaabSPaolo Bonzini
200e17bdaabSPaolo Bonzini __coverity_negative_sink__(size);
201e17bdaabSPaolo Bonzini ptr = __coverity_alloc__(size);
202e17bdaabSPaolo Bonzini if (!ptr) {
203e17bdaabSPaolo Bonzini __coverity_panic__();
204e17bdaabSPaolo Bonzini }
205e17bdaabSPaolo Bonzini __coverity_writeall0__(ptr);
206e17bdaabSPaolo Bonzini __coverity_mark_as_afm_allocated__(ptr, AFM_free);
207e17bdaabSPaolo Bonzini return ptr;
208e804f892SPaolo Bonzini }
209e804f892SPaolo Bonzini
g_realloc(void * ptr,size_t size)210e804f892SPaolo Bonzini void *g_realloc(void *ptr, size_t size)
211e804f892SPaolo Bonzini {
212e17bdaabSPaolo Bonzini __coverity_negative_sink__(size);
213e17bdaabSPaolo Bonzini __coverity_escape__(ptr);
214e17bdaabSPaolo Bonzini ptr = __coverity_alloc__(size);
215e17bdaabSPaolo Bonzini if (!ptr) {
216e17bdaabSPaolo Bonzini __coverity_panic__();
217e17bdaabSPaolo Bonzini }
218e17bdaabSPaolo Bonzini /*
219e17bdaabSPaolo Bonzini * Memory beyond the old size isn't actually initialized. Can't
220e17bdaabSPaolo Bonzini * model that. See Coverity's realloc() model
221e17bdaabSPaolo Bonzini */
222e17bdaabSPaolo Bonzini __coverity_writeall__(ptr);
223e17bdaabSPaolo Bonzini __coverity_mark_as_afm_allocated__(ptr, AFM_free);
224e17bdaabSPaolo Bonzini return ptr;
225e804f892SPaolo Bonzini }
226e804f892SPaolo Bonzini
g_try_malloc(size_t size)227e804f892SPaolo Bonzini void *g_try_malloc(size_t size)
228e804f892SPaolo Bonzini {
229e17bdaabSPaolo Bonzini int nomem;
230e17bdaabSPaolo Bonzini
231e17bdaabSPaolo Bonzini if (nomem) {
232e17bdaabSPaolo Bonzini return NULL;
233e17bdaabSPaolo Bonzini }
234e17bdaabSPaolo Bonzini return g_malloc(size);
235e804f892SPaolo Bonzini }
236e804f892SPaolo Bonzini
g_try_malloc0(size_t size)237e804f892SPaolo Bonzini void *g_try_malloc0(size_t size)
238e804f892SPaolo Bonzini {
239e17bdaabSPaolo Bonzini int nomem;
240e17bdaabSPaolo Bonzini
241e17bdaabSPaolo Bonzini if (nomem) {
242e17bdaabSPaolo Bonzini return NULL;
243e17bdaabSPaolo Bonzini }
244e17bdaabSPaolo Bonzini return g_malloc0(size);
245e804f892SPaolo Bonzini }
246e804f892SPaolo Bonzini
g_try_realloc(void * ptr,size_t size)247e804f892SPaolo Bonzini void *g_try_realloc(void *ptr, size_t size)
248e804f892SPaolo Bonzini {
249e17bdaabSPaolo Bonzini int nomem;
250e17bdaabSPaolo Bonzini
251e17bdaabSPaolo Bonzini if (nomem) {
252e17bdaabSPaolo Bonzini return NULL;
253e17bdaabSPaolo Bonzini }
254e17bdaabSPaolo Bonzini return g_realloc(ptr, size);
255e804f892SPaolo Bonzini }
256e804f892SPaolo Bonzini
257e804f892SPaolo Bonzini /* Other glib functions */
258e804f892SPaolo Bonzini
259e804f892SPaolo Bonzini typedef struct pollfd GPollFD;
260e804f892SPaolo Bonzini
261e804f892SPaolo Bonzini int poll();
262e804f892SPaolo Bonzini
g_poll(GPollFD * fds,unsigned nfds,int timeout)263e804f892SPaolo Bonzini int g_poll (GPollFD *fds, unsigned nfds, int timeout)
264e804f892SPaolo Bonzini {
265e804f892SPaolo Bonzini return poll(fds, nfds, timeout);
266e804f892SPaolo Bonzini }
267e804f892SPaolo Bonzini
268e804f892SPaolo Bonzini typedef struct _GIOChannel GIOChannel;
g_io_channel_unix_new(int fd)269e804f892SPaolo Bonzini GIOChannel *g_io_channel_unix_new(int fd)
270e804f892SPaolo Bonzini {
271*fae4fad5SPaolo Bonzini /* cannot use incomplete type, the actual struct is roughly this size. */
272*fae4fad5SPaolo Bonzini GIOChannel *c = g_malloc0(20 * sizeof(void *));
273e804f892SPaolo Bonzini __coverity_escape__(fd);
274e804f892SPaolo Bonzini return c;
275e804f892SPaolo Bonzini }
276e804f892SPaolo Bonzini
g_assertion_message_expr(const char * domain,const char * file,int line,const char * func,const char * expr)277e804f892SPaolo Bonzini void g_assertion_message_expr(const char *domain,
278e804f892SPaolo Bonzini const char *file,
279e804f892SPaolo Bonzini int line,
280e804f892SPaolo Bonzini const char *func,
281e804f892SPaolo Bonzini const char *expr)
282e804f892SPaolo Bonzini {
283e804f892SPaolo Bonzini __coverity_panic__();
284e804f892SPaolo Bonzini }
285