summaryrefslogtreecommitdiff
path: root/src/common/array.c
blob: e4e7bb140263cd4b9252da1ff6e2376e05920ad9 (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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495

/* Chrysalide - Outil d'analyse de fichiers binaires
 * array.c - manipulation optimisée de tableaux au niveau de l'empreinte mémoire
 *
 * Copyright (C) 2017 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 Foobar.  If not, see <http://www.gnu.org/licenses/>.
 */


#include "array.h"


#include <assert.h>
#include <endian.h>
#include <glib.h>
#include <malloc.h>
#ifndef NDEBUG
#   include <stdbool.h>
#endif
#include <string.h>


#include "sort.h"



/**
 * L'expression du besoin d'une gestion optimisée des tableaux se base sur la
 * structure usuelle et naïve suivante :
 *
 *    {
 *        void **array;
 *        size_t count;
 *    }
 *
 * Déjà, size_t mesure la taille d'un long sur 64 bits. Ensuite, si le tableau
 * renvoie effectivement vers des pointeurs, un tableau à un seul élément va
 * allouer 8 octets (sur 64 bits) pour stocker ce seul élément. Cela fait donc
 * 16 octets inutiles.
 *
 * Le jeu des alignements fait que la structure définie ici devrait être alignée
 * sur 8 octets.
 *
 * Cela laisse donc 3 bits toujours nuls à disposition pour conserver quelques
 * informations utiles.
 *
 * Cf. http://www.catb.org/esr/structure-packing/
 *
 * Pour les notions de verrouillage, la consommation mémoire peut vite augmenter :
 * GRWLock pèse par exemple 16 octets pour offrir la distinction entre consultation
 * et modification.
 *
 * Dans le même temps, des solutions plus légères existent : la GLib propose
 * incidemment les fonctions portables g_bit_lock() / g_bit_unlock().
 *
 * Cependant, elles ne fonctionnent que sur des gint. Donc il faut s'adapter pour
 * les architectures en grand boutisme. Comment il est peu vraisemblable que le
 * bit de poids fort habituellement associé à l'espace noyau se retrouve dans des
 * adresses utilisateurs manipulées ici, on l'utilise pour le verrou au besoin.
 */

#if __BYTE_ORDER == __LITTLE_ENDIAN

#   define FLAT_ARRAY_LOCK_BIT 0
#   define FLAT_ARRAY_LOCK_MASK (1 << 0)

#elif __BYTE_ORDER == __BIG_ENDIAN

#   define FLAT_ARRAY_LOCK_BIT 31
#   define FLAT_ARRAY_LOCK_MASK (1 << (__WORDSIZE - 1))

#else

#   error "Unknown byte order"

#endif

#define FLAT_ARRAY_INDEX_MASK (1 << 1)

#define FLAT_ARRAY_USED_MASK (FLAT_ARRAY_INDEX_MASK | FLAT_ARRAY_LOCK_MASK)


/* Tableau compressé à 2 éléments ou plus */
typedef struct _ext_flat_array_t
{
    void *items;                            /* Tableau d'éléments          */
    size_t count;                           /* Quantité d'éléments         */

} ext_flat_array_t;


#define FLAT_ARRAY_IS_LOCKED(a) (((unsigned long)a) & FLAT_ARRAY_LOCK_MASK)

#define FLAT_ARRAY_IS_EMPTY(a) ((((unsigned long)a) & ~FLAT_ARRAY_USED_MASK) == 0)

#define FLAT_ARRAY_HAS_NO_INDEX(a) ((((unsigned long)a) & FLAT_ARRAY_INDEX_MASK) == 0)

#define FLAT_ARRAY_SET_INDEX(a) *((unsigned long *)&a) |= FLAT_ARRAY_INDEX_MASK

#define GET_LONELY_ITEM(a) (void *)(((unsigned long)a) & ~FLAT_ARRAY_USED_MASK)

#define EXTENDED_ARRAY(a) (ext_flat_array_t *)(((unsigned long)a) & ~FLAT_ARRAY_USED_MASK)



/******************************************************************************
*                                                                             *
*  Paramètres  : array = tableau compressé à modifier. [OUT]                  *
*                                                                             *
*  Description : Verrouille l'accès à un tableau compressé.                   *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void lock_flat_array(flat_array_t **array)
{
    g_bit_lock((gint *)array, FLAT_ARRAY_LOCK_BIT);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : array = tableau compressé à modifier. [OUT]                  *
*                                                                             *
*  Description : Déverrouille l'accès à un tableau compressé.                 *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void unlock_flat_array(flat_array_t **array)
{
    g_bit_unlock((gint *)array, FLAT_ARRAY_LOCK_BIT);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : array = tableau compressé à consulter.                       *
*                                                                             *
*  Description : Indique la quantité d'éléments présents dans le tableau.     *
*                                                                             *
*  Retour      : Nombre d'éléments attachés.                                  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

size_t count_flat_array_items(const flat_array_t *array)
{
    size_t result;                          /* Quantité à retourner        */
    ext_flat_array_t *extended;             /* Version de tableau étendue  */

    assert(FLAT_ARRAY_IS_LOCKED(array));

    if (FLAT_ARRAY_IS_EMPTY(array))
        result = 0;

    else
    {
        if (FLAT_ARRAY_HAS_NO_INDEX(array))
            result = 1;

        else
        {
            extended = EXTENDED_ARRAY(array);
            result = extended->count;
        }

    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : array = tableau compressé à mettre à jour. [OUT]             *
*                item  = adresse de l'élément à rajouter.                     *
*                size  = taille de ce nouvel élément.                         *
*                                                                             *
*  Description : Ajoute un élément supplémentaire à un tableau.               *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void add_item_to_flat_array(flat_array_t **array, const void *item, size_t size)
{
    ext_flat_array_t *extended;             /* Version de tableau étendue  */

    assert(FLAT_ARRAY_IS_LOCKED(*array));

    if (FLAT_ARRAY_IS_EMPTY(*array))
    {
        *array = malloc(size);
        memcpy(*array, item, size);

        lock_flat_array(array);

    }

    else
    {
        if (FLAT_ARRAY_HAS_NO_INDEX(*array))
        {
            extended = (ext_flat_array_t *)malloc(sizeof(ext_flat_array_t));

            extended->items = malloc(2 * size);
            extended->count = 2;

            memcpy(extended->items, GET_LONELY_ITEM(*array), size);
            memcpy(((char *)extended->items) + size, item, size);

            FLAT_ARRAY_SET_INDEX(extended);

            *array = (flat_array_t *)extended;

            lock_flat_array(array);

        }

        else
        {
            extended = EXTENDED_ARRAY(*array);

            extended->count++;
            extended->items = realloc(extended->items, extended->count * size);

            memcpy(((char *)extended->items) + (extended->count - 1) * size, item, size);

        }

    }

}


/******************************************************************************
*                                                                             *
*  Paramètres  : array  = tableau compressé à mettre à jour. [OUT]            *
*                item   = adresse de l'élément à rajouter.                    *
*                size   = taille de ce nouvel élément.                        *
*                compar = méthode de comparaison entre éléments.              *
*                                                                             *
*  Description : Ajoute un élément supplémentaire à un tableau trié.          *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void insert_item_into_flat_array(flat_array_t **array, void *item, size_t size, __compar_fn_t compar)
{
    ext_flat_array_t *extended;             /* Version de tableau étendue  */

    assert(FLAT_ARRAY_IS_LOCKED(*array));

    if (FLAT_ARRAY_IS_EMPTY(*array))
    {
        *array = malloc(size);
        memcpy(*array, item, size);

        lock_flat_array(array);

    }

    else
    {
        if (FLAT_ARRAY_HAS_NO_INDEX(*array))
        {
            extended = (ext_flat_array_t *)malloc(sizeof(ext_flat_array_t));

            extended->items = malloc(size);
            extended->count = 1;

            memcpy(extended->items, GET_LONELY_ITEM(*array), size);

            FLAT_ARRAY_SET_INDEX(extended);

            *array = (flat_array_t *)extended;

            lock_flat_array(array);

        }

        extended = EXTENDED_ARRAY(*array);

        extended->items = qinsert(extended->items, &extended->count, size, compar, item);

    }

}


/******************************************************************************
*                                                                             *
*  Paramètres  : array = tableau compressé à mettre à jour.                   *
*                index = indice de l'élément à remplacer.                     *
*                new   = adresse de l'élément à rajouter.                     *
*                size  = taille de ce nouvel élément.                         *
*                                                                             *
*  Description : Remplace un élément d'un tableau compressé par un autre.     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void rpl_item_in_flat_array(flat_array_t *array, size_t index, void *new, size_t size)
{
    ext_flat_array_t *extended;             /* Version de tableau étendue  */

    assert(FLAT_ARRAY_IS_LOCKED(array));

    assert(!FLAT_ARRAY_IS_EMPTY(array));

    if (FLAT_ARRAY_HAS_NO_INDEX(array))
    {
        assert(index == 0);

        memcpy(GET_LONELY_ITEM(array), new, size);

    }

    else
    {
        extended = EXTENDED_ARRAY(array);

        assert(index < extended->count);

        memcpy(((char *)extended->items) + index * size, new, size);

    }

}


/******************************************************************************
*                                                                             *
*  Paramètres  : array = tableau compressé à mettre à jour. [OUT]             *
*                index = indice de l'élément à retirer.                       *
*                size  = taille de ce nouvel élément.                         *
*                                                                             *
*  Description : Retire un élément existant d'un tableau.                     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void rem_item_from_flat_array(flat_array_t **array, size_t index, size_t size)
{
    size_t count;                           /* Nombre d'éléments présents  */
    ext_flat_array_t *extended;             /* Version de tableau étendue  */
    void *new;                              /* Nouveau tableau à jour      */

    assert(FLAT_ARRAY_IS_LOCKED(*array));

    count = count_flat_array_items(*array);

    switch (count)
    {
        case 0:
            assert(false);
            break;

        case 1:

            assert(FLAT_ARRAY_HAS_NO_INDEX(*array));
            assert(index == 0);

            free(GET_LONELY_ITEM(*array));

            *array = NULL;

            lock_flat_array(array);

            break;

        case 2:

            assert(!FLAT_ARRAY_HAS_NO_INDEX(*array));
            assert(index == 0 || index == 1);

            extended = EXTENDED_ARRAY(*array);

            new = malloc(size);

            if (index == 1)
                memcpy(new, extended->items, size);
            else
                memcpy(new, ((char *)extended->items) + size, size);

            free(extended);

            *array = new;

            lock_flat_array(array);

            break;

        default:

            assert(!FLAT_ARRAY_HAS_NO_INDEX(*array));
            assert(index < count);

            extended = EXTENDED_ARRAY(*array);

            if ((count - index - 1) > 0)
                memmove(((char *)extended->items) + index * size,
                        ((char *)extended->items) + (index + 1) * size,
                        (count - index - 1) * size);

            extended->count--;
            extended->items = realloc(extended->items, extended->count * size);

            break;

    }

}


/******************************************************************************
*                                                                             *
*  Paramètres  : array = tableau compressé à consulter.                       *
*                index = indice de l'élément à retrouver                      *
*                size  = taille de ce nouvel élément.                         *
*                                                                             *
*  Description : Fournit un élément présent dans un tableau compressé.        *
*                                                                             *
*  Retour      : Elément du tableau visé par la procédure.                    *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void *get_flat_array_item(flat_array_t *array, size_t index, size_t size)
{
    void *result;                           /* Trouvaille à retourner      */
    ext_flat_array_t *extended;             /* Version de tableau étendue  */

    assert(FLAT_ARRAY_IS_LOCKED(array));

    assert(!FLAT_ARRAY_IS_EMPTY(array));

    if (FLAT_ARRAY_HAS_NO_INDEX(array))
    {
        assert(index == 0);

        result = GET_LONELY_ITEM(array);

    }

    else
    {
        extended = EXTENDED_ARRAY(array);

        assert(index < extended->count);

        result = (void *)(((char *)extended->items) + index * size);

    }

    return result;

}