summaryrefslogtreecommitdiff
path: root/src/gleak.c
blob: 4423cbbd56d039e985c187c034247296c9ad5509 (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * gleak.c - aide à la détection de fuites d'instances de GTypes
 *
 * Copyright (C) 2019 Cyrille Bagard
 *
 *  This file is part of Chrysalide.
 *
 *  Chrysalide is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  Chrysalide is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with Chrysalide.  If not, see <http://www.gnu.org/licenses/>.
 */


#include "gleak.h"


#include <assert.h>
#include <glib-object.h>
#include <malloc.h>
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>


#include "common/environment.h"



#define DUMP_OPEN_MSG  "\n---------- GType instance leak dump ----------\n\n"
#define DUMP_CLOSE_MSG "\n----------------------------------------------\n\n"


/* Description de type utilisé */
typedef struct _tracked_gtype_t
{
    GType type;                             /* Type GLib représenté        */
    char *name;                             /* Désignation humaine         */

} tracked_gtype_t;

/* Conservation des types même sans les greffons associés */
static tracked_gtype_t *__tracking = NULL;
static size_t __count = 0;


/* Effectue une comparaison entre deux mémorisations de GTypes. */
static int compare_gtypes_for_leaks(const tracked_gtype_t *, const tracked_gtype_t *);

/* Constitue une base de données de nom de tous les GTypes. */
static void _remember_gtypes_for_leaks(GType);

/*  Parcourt l'arborescence des types à la recherche de fuites. */
static void track_gtype_for_leak(GType, bool *);




/******************************************************************************
*                                                                             *
*  Paramètres  : a = première description à comparer.                         *
*                b = seconde description à comparer.                          *
*                                                                             *
*  Description : Effectue une comparaison entre deux mémorisations de GTypes. *
*                                                                             *
*  Retour      : Bilan de l'opération (-1, 0 ou 1).                           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static int compare_gtypes_for_leaks(const tracked_gtype_t *a, const tracked_gtype_t *b)
{
    int result;                             /* Bilan à retourner           */

    if (a->type < b->type)
        result = -1;

    else if (a->type > b->type)
        result = 1;

    else
        result = 0;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : root  = racine des types d'instance à parcourir.             *
*                                                                             *
*  Description : Constitue une base de données de nom de tous les GTypes.     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void _remember_gtypes_for_leaks(GType root)
{
    GType *children;                        /* Liste de tous les sous-types*/
    guint count;                            /* Taille de cette liste       */
    tracked_gtype_t *new;                   /* Nouvelle feuille à mémoriser*/
    GType *iter;                            /* Boucle de parcours          */

    children = g_type_children(root, &count);

    if (count == 0)
    {
        __tracking = realloc(__tracking, ++__count * sizeof(tracked_gtype_t));

        new = &__tracking[__count - 1];

        new->type = root;
        new->name = strdup(g_type_name(root));

    }

    else
        for (iter = children; *iter != 0; iter++)
            _remember_gtypes_for_leaks(*iter);

    g_free(children);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : root  = racine des types d'instance à parcourir.             *
*                                                                             *
*  Description : Constitue une base de données de nom de tous les GTypes.     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void remember_gtypes_for_leaks(void)
{
    _remember_gtypes_for_leaks(G_TYPE_OBJECT);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : root  = racine des types d'instance à retrouver.             *
*                first = suivi des premières impressions. [OUT]               *
*                                                                             *
*  Description : Parcourt l'arborescence des types à la recherche de fuites.  *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void track_gtype_for_leak(GType root, bool *first)
{
    GType *children;                        /* Liste de tous les sous-types*/
    guint count;                            /* Taille de cette liste       */
    int remaining;                          /* Nombre d'instances restantes*/
    const tracked_gtype_t *tracked;         /* Infos de type mémorisées    */
    GType *iter;                            /* Boucle de parcours          */

    children = g_type_children(root, &count);

    if (count == 0)
    {
        remaining = g_type_get_instance_count(root);

        if (remaining > 0)
        {
            if (*first)
            {
                fprintf(stderr, DUMP_OPEN_MSG);
                *first = false;
            }

            tracked = bsearch((tracked_gtype_t []) { { .type = root } }, __tracking,
                              __count, sizeof(tracked_gtype_t), (__compar_fn_t)compare_gtypes_for_leaks);

            assert(tracked != NULL);

            fprintf(stderr, "%s: %d\n", tracked->name, remaining);

        }

    }

    else
        for (iter = children; *iter != 0; iter++)
            track_gtype_for_leak(*iter, first);

    g_free(children);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Affiche la liste des instances courantes restantes par type. *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void dump_remaining_gtypes(void)
{
    char *debug;                            /* Conditions d'environnement  */
    bool first;                             /* Première fois ?             */
    size_t i;                               /* Boucle de parcours          */

    debug = get_env_var("GOBJECT_DEBUG");

    if (strstr(debug, "instance-count") == NULL)
    {
        fprintf(stderr, DUMP_OPEN_MSG);
        fprintf(stderr, "The GOBJECT_DEBUG variable does not include instance-count.\n");
        fprintf(stderr, "Exiting the dumping process...\n");
        fprintf(stderr, DUMP_CLOSE_MSG);
    }

    else
    {
        first = true;

        qsort(__tracking, __count, sizeof(tracked_gtype_t), (__compar_fn_t)compare_gtypes_for_leaks);

        track_gtype_for_leak(G_TYPE_OBJECT, &first);

        if (!first)
            fprintf(stderr, DUMP_CLOSE_MSG);

    }

    free(debug);

    for (i = 0; i < __count; i++)
        free(__tracking[i].name);

    if (__tracking != NULL)
    {
        free(__tracking);

        __tracking = NULL;
        __count = 0;

    }

}