summaryrefslogtreecommitdiff
path: root/src/glibext/delayed.c
blob: 64f18cf6eab9fc398845a217ad062506daed63a7 (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
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353

/* Chrysalide - Outil d'analyse de fichiers binaires
 * delayed.c - gestion des travaux différés
 *
 * Copyright (C) 2009-2018 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 "delayed.h"


#include <assert.h>
#include <inttypes.h>
#include <malloc.h>
#include <stdio.h>
#include <string.h>


#include "delayed-int.h"
#include "../core/nproc.h"
#ifdef INCLUDE_GTK_SUPPORT
#   include "../gui/core/global.h"
#endif



/* -------------------------- TACHE DIFFEREE DANS LE TEMPS -------------------------- */


/* Initialise la classe des travaux différés. */
static void g_delayed_work_class_init(GDelayedWorkClass *);

/* Initialise une instance de travail différé. */
static void g_delayed_work_init(GDelayedWork *);

/* Supprime toutes les références externes. */
static void g_delayed_work_dispose(GDelayedWork *);

/* Procède à la libération totale de la mémoire. */
static void g_delayed_work_finalize(GDelayedWork *);

/* Mène l'opération programmée. */
static void g_delayed_work_process(GDelayedWork *, GtkStatusStack *);



/* -------------------------- THREAD DE TRAITEMENTS DEDIES -------------------------- */


#define G_TYPE_WORK_GROUP               g_work_group_get_type()
#define G_WORK_GROUP(obj)               (G_TYPE_CHECK_INSTANCE_CAST((obj), g_work_group_get_type(), GWorkGroup))
#define G_IS_WORK_GROUP(obj)            (G_TYPE_CHECK_INSTANCE_TYPE((obj), g_work_group_get_type()))
#define G_WORK_GROUP_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST((klass), G_TYPE_WORK_GROUP, GWorkGroupClass))
#define G_IS_WORK_GROUP_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE((klass), G_TYPE_WORK_GROUP))
#define G_WORK_GROUP_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS((obj), G_TYPE_WORK_GROUP, GWorkGroupClass))


/* File de traitement pour un type donné (instance) */
typedef struct _GWorkGroup
{
    GObject parent;                         /* A laisser en premier        */

    wgroup_id_t id;                         /* Identifiant de travaux menés*/

    GDelayedWork *works;                    /* Tâches à mener à bien       */
    GMutex mutex;                           /* Verrou pour l'accès         */
    GCond cond;                             /* Réveil pour un traitement   */
    GCond wait_cond;                        /* Réveil d'attente de fin     */
    gint pending;                           /* Tâches en cours d'exécution */

    GThread **threads;                      /* Procédure de traitement     */
    guint threads_count;                    /* Nombre de procédures        */
    bool force_exit;                        /* Procédure d'arrêt           */

    wait_for_incoming_works_cb callback;    /* Encadre les attentes de fin */
    void *data;                             /* Données à associer          */

} GWorkGroup;

/* File de traitement pour un type donné (classe) */
typedef struct _GWorkGroupClass
{
    GObjectClass parent;                    /* A laisser en premier        */

} GWorkGroupClass;


/* Indique le type défini pour les groupes de travail. */
static GType g_work_group_get_type(void);

/* Initialise la classe des groupes de travail. */
static void g_work_group_class_init(GWorkGroupClass *);

/* Initialise une instance de groupe de travail. */
static void g_work_group_init(GWorkGroup *);

/* Supprime toutes les références externes. */
static void g_work_group_dispose(GWorkGroup *);

/* Procède à la libération totale de la mémoire. */
static void g_work_group_finalize(GWorkGroup *);

/* Crée un nouveau thread dédié à un type de travaux donné. */
static GWorkGroup *g_work_group_new(wgroup_id_t, const guint *);

/* Fournit l'identifiant associé à un groupe de travail. */
static wgroup_id_t g_work_group_get_id(const GWorkGroup *);

/* Place une nouvelle tâche en attente dans une file dédiée. */
static void g_work_group_schedule(GWorkGroup *, GDelayedWork *);

/* Assure le traitement en différé. */
static void *g_work_group_process(GWorkGroup *);

/* Détermine si le groupe est vide de toute programmation. */
static bool g_work_group_is_empty(GWorkGroup *);

/* Attend que toutes les tâches d'un groupe soient traitées. */
static void g_work_group_wait_for_completion(GWorkGroup *, GWorkQueue *);

/* Modifie les conditions d'attente des fins d'exécutions. */
static void g_work_group_set_extra_wait_callback(GWorkGroup *, wait_for_incoming_works_cb, void *);

/* Force un réveil d'une attente en cours pour la confirmer. */
static void g_work_group_wake_up_waiters(GWorkGroup *);



/* ------------------------- TRAITEMENT DE TACHES DIFFEREES ------------------------- */


/* Gestionnaire des travaux différés (instance) */
struct _GWorkQueue
{
    GObject parent;                         /* A laisser en premier        */

    wgroup_id_t generator;                  /* Générateur d'identifiants   */

    GWorkGroup **groups;                    /* Files de traitement         */
    size_t groups_count;                    /* Nombre de files internes    */
    GMutex mutex;                           /* Verrou pour l'accès         */
    GCond wait_all;                         /* Réveil d'attente globale    */

};

/* Gestionnaire des travaux différés (classe) */
struct _GWorkQueueClass
{
    GObjectClass parent;                    /* A laisser en premier        */

};


/* Initialise la classe des travaux différés. */
static void g_work_queue_class_init(GWorkQueueClass *);

/* Initialise une instance de gestionnaire de travaux différés. */
static void g_work_queue_init(GWorkQueue *);

/* Supprime toutes les références externes. */
static void g_work_queue_dispose(GWorkQueue *);

/* Procède à la libération totale de la mémoire. */
static void g_work_queue_finalize(GWorkQueue *);

/* Donne l'assurance de l'existence d'un groupe de travail. */
static bool g_work_queue_ensure_group_exists(GWorkQueue *, wgroup_id_t, const guint *);

/* Fournit le groupe de travail correspondant à un identifiant. */
static GWorkGroup *g_work_queue_find_group_for_id(GWorkQueue *, wgroup_id_t);



/* ---------------------------------------------------------------------------------- */
/*                            TACHE DIFFEREE DANS LE TEMPS                            */
/* ---------------------------------------------------------------------------------- */


/* Indique le type défini pour les travaux différés. */
G_DEFINE_TYPE(GDelayedWork, g_delayed_work, G_TYPE_OBJECT);


/******************************************************************************
*                                                                             *
*  Paramètres  : klass = classe à initialiser.                                *
*                                                                             *
*  Description : Initialise la classe des travaux différés.                   *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_delayed_work_class_init(GDelayedWorkClass *klass)
{
    GObjectClass *object;                   /* Autre version de la classe  */

    object = G_OBJECT_CLASS(klass);

    object->dispose = (GObjectFinalizeFunc/* ! */)g_delayed_work_dispose;
    object->finalize = (GObjectFinalizeFunc)g_delayed_work_finalize;

    g_signal_new("work-completed",
                 G_TYPE_DELAYED_WORK,
                 G_SIGNAL_RUN_LAST,
                 G_STRUCT_OFFSET(GDelayedWorkClass, work_completed),
                 NULL, NULL,
                 g_cclosure_marshal_VOID__VOID,
                 G_TYPE_NONE, 0);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : work = instance à initialiser.                               *
*                                                                             *
*  Description : Initialise une instance de travail différé.                  *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_delayed_work_init(GDelayedWork *work)
{
    work->completed = false;
    g_mutex_init(&work->mutex);
    g_cond_init(&work->cond);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : work = instance d'objet GLib à traiter.                      *
*                                                                             *
*  Description : Supprime toutes les références externes.                     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_delayed_work_dispose(GDelayedWork *work)
{
    g_mutex_clear(&work->mutex);
    g_cond_clear(&work->cond);

    G_OBJECT_CLASS(g_delayed_work_parent_class)->dispose(G_OBJECT(work));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : work = instance d'objet GLib à traiter.                      *
*                                                                             *
*  Description : Procède à la libération totale de la mémoire.                *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_delayed_work_finalize(GDelayedWork *work)
{
    G_OBJECT_CLASS(g_delayed_work_parent_class)->finalize(G_OBJECT(work));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : work   = travail à effectuer.                                *
*                status = barre de statut à tenir informée.                   *
*                                                                             *
*  Description : Mène l'opération programmée.                                 *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_delayed_work_process(GDelayedWork *work, GtkStatusStack *status)
{
    G_DELAYED_WORK_GET_CLASS(work)->run(work, status);

    g_mutex_lock(&work->mutex);

    work->completed = true;

    g_cond_signal(&work->cond);
    g_mutex_unlock(&work->mutex);

    g_signal_emit_by_name(work, "work-completed");

}


/******************************************************************************
*                                                                             *
*  Paramètres  : work = travail à surveiller.                                 *
*                                                                             *
*  Description : Attend la fin de l'exécution d'une tâche donnée.             *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_delayed_work_wait_for_completion(GDelayedWork *work)
{
    g_mutex_lock(&work->mutex);

    while (!work->completed)
        g_cond_wait(&work->cond, &work->mutex);

    g_mutex_unlock(&work->mutex);

}



/* ---------------------------------------------------------------------------------- */
/*                           THREADS DES TRAITEMENTS DEDIES                           */
/* ---------------------------------------------------------------------------------- */


/* Indique le type défini pour les groupes de travail. */
G_DEFINE_TYPE(GWorkGroup, g_work_group, G_TYPE_OBJECT);


/******************************************************************************
*                                                                             *
*  Paramètres  : klass = classe à initialiser.                                *
*                                                                             *
*  Description : Initialise la classe des groupes de travail.                 *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_work_group_class_init(GWorkGroupClass *klass)
{
    GObjectClass *object;                   /* Autre version de la classe  */

    object = G_OBJECT_CLASS(klass);

    object->dispose = (GObjectFinalizeFunc/* ! */)g_work_group_dispose;
    object->finalize = (GObjectFinalizeFunc)g_work_group_finalize;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : group = instance à initialiser.                              *
*                                                                             *
*  Description : Initialise une instance de groupe de travail.                *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_work_group_init(GWorkGroup *group)
{
    group->works = NULL;

    g_mutex_init(&group->mutex);
    g_cond_init(&group->cond);
    g_cond_init(&group->wait_cond);

    g_atomic_int_set(&group->pending, 0);

    group->threads = NULL;
    group->threads_count = 0;
    group->force_exit = false;

    group->callback = NULL;
    group->data = NULL;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : queue = instance d'objet GLib à traiter.                     *
*                                                                             *
*  Description : Supprime toutes les références externes.                     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_work_group_dispose(GWorkGroup *group)
{
    guint i;                                /* Boucle de parcours          */
    GDelayedWork *work;                     /* Travail à oublier           */

    group->force_exit = true;

    /**
     * Concernant la pose du verrou, se référer aux commentaires de la
     * fonction g_work_group_process().
     */

    g_mutex_lock(&group->mutex);

    g_cond_broadcast(&group->cond);

    g_mutex_unlock(&group->mutex);

    for (i = 0; i < group->threads_count; i++)
        g_thread_join(group->threads[i]);

    while (!dl_list_empty(group->works))
    {
        work = group->works;
        delayed_work_list_del(work, &group->works);

        g_object_unref(G_OBJECT(work));

    }

    g_mutex_clear(&group->mutex);
    g_cond_clear(&group->cond);
    g_cond_clear(&group->wait_cond);

    G_OBJECT_CLASS(g_work_group_parent_class)->dispose(G_OBJECT(group));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : group = instance d'objet GLib à traiter.                     *
*                                                                             *
*  Description : Procède à la libération totale de la mémoire.                *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_work_group_finalize(GWorkGroup *group)
{
    if (group->threads != NULL)
        free(group->threads);

    G_OBJECT_CLASS(g_work_group_parent_class)->finalize(G_OBJECT(group));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : id    = identifiant accordé au nouveau groupe.               *
*                count = quantité de threads à allouer.                       *
*                                                                             *
*  Description : Crée un nouveau thread dédié à un type de travaux donné.     *
*                                                                             *
*  Retour      : Structure associée au thread mise en place.                  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static GWorkGroup *g_work_group_new(wgroup_id_t id, const guint *count)
{
    GWorkGroup *result;                    /* Traiteur à retourner        */
    guint i;                                /* Boucle de parcours          */
    char name[16];                          /* Désignation humaine         */

    result = g_object_new(G_TYPE_WORK_GROUP, NULL);

    result->id = id;

    result->threads_count = get_max_online_threads();

    if (count != NULL && *count < result->threads_count)
        result->threads_count = *count;

    result->threads = (GThread **)calloc(result->threads_count, sizeof(GThread *));

    for (i = 0; i < result->threads_count; i++)
    {
        snprintf(name, sizeof(name), "wgrp_%" PRIu64 "-%u", id, i);

        result->threads[i] = g_thread_new(name, (GThreadFunc)g_work_group_process, result);
        if (!result->threads[i])
            goto start_error;

    }

 start_error:

    result->threads_count = i;

    assert(i > 0);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : group = gestionnaire des actions à mener.                    *
*                                                                             *
*  Description : Fournit l'identifiant associé à un groupe de travail.        *
*                                                                             *
*  Retour      : Identifiant unique attribué au groupe de travail.            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static wgroup_id_t g_work_group_get_id(const GWorkGroup *group)
{
    return group->id;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : group = gestionnaire des actions à mener.                    *
*                work  = nouvelle tâche à programmer, puis effectuer.         *
*                                                                             *
*  Description : Place une nouvelle tâche en attente dans une file dédiée.    *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_work_group_schedule(GWorkGroup *group, GDelayedWork *work)
{
    g_mutex_lock(&group->mutex);

    g_atomic_int_inc(&group->pending);

    delayed_work_list_add_tail(work, &group->works);

    g_cond_signal(&group->cond);

    g_mutex_unlock(&group->mutex);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : group = gestionnaire des actions à mener.                    *
*                                                                             *
*  Description : Assure le traitement en différé.                             *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void *g_work_group_process(GWorkGroup *group)
{
    GDelayedWork *work;                     /* Traitement à mener          */
    GtkStatusStack *status;                 /* Zone d'info éventuelle      */

    while (1)
    {
        g_mutex_lock(&group->mutex);

        while (dl_list_empty(group->works) && !group->force_exit)
            g_cond_wait(&group->cond, &group->mutex);

        if (group->force_exit)
        {
            g_mutex_unlock(&group->mutex);
            break;
        }

        work = group->works;
        delayed_work_list_del(work, &group->works);

        g_mutex_unlock(&group->mutex);

#ifdef INCLUDE_GTK_SUPPORT
        status = get_global_status();
#else
        status = NULL;
#endif
        g_delayed_work_process(work, status);

        g_object_unref(G_OBJECT(work));

        /**
         * Verrou ou pas verrou ?
         *
         * La documentation de la GLib indique que ce n'est pas nécessaire :
         *
         *    '''
         *    It is good practice to lock the same mutex as the waiting threads
         *    while calling this function, though not required.
         *    '''
         *
         * Ce conseil se trouve verbatim à l'adresse :
         *
         *    https://developer.gnome.org/glib/stable/glib-Threads.html#g-cond-broadcast
         *
         * Dans la pratique, il peut arriver que l'attente de la fonction
         * g_work_group_wait_for_completion() ne soit jamais interrompue.
         *
         * La documentation POSIX est un peu plus orientée :
         *
         *    '''
         *    The pthread_cond_broadcast() functions may be called by a thread
         *    whether or not it currently owns the mutex that threads calling
         *    pthread_cond_wait() have associated with the condition variable
         *    during their waits; however, if predictable scheduling behavior is
         *    required, then that mutex shall be locked by the thread calling
         *    pthread_cond_broadcast().
         *    '''
         *
         * Ce passage complet est consultable à l'adresse :
         *
         *    http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_cond_broadcast.html
         *
         * La page de manuel pthread_cond_broadcast(3) est quant à elle plus
         * directrice : aucun complément d'information sur le sujet n'est fourni
         * et les exemples associés utilisent implicement un verrou pendant
         * sont appel.
         */

        g_mutex_lock(&group->mutex);

        if (g_atomic_int_dec_and_test(&group->pending))
            g_cond_broadcast(&group->wait_cond);

        g_mutex_unlock(&group->mutex);

    }

    return NULL;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : group = gestionnaire des actions à consulter.                *
*                                                                             *
*  Description : Détermine si le groupe est vide de toute programmation.      *
*                                                                             *
*  Retour      : Etat du groupe de travail.                                   *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool g_work_group_is_empty(GWorkGroup *group)
{
    bool result;                            /* Etat à retourner            */

    /**
     * Pour que le résultat soit exploitable, il ne doit pas varier
     * en dehors de la zone couverte par le verrou du groupe avant
     * son utilisation par l'appelant.
     *
     * Il doit donc logiquement y avoir un autre verrou en amont et,
     * comme à priori on ne devrait pas bloquer les groupes principaux
     * pour un traitement particulier, cette procédure ne devrait concerner
     * que des groupes dynamiques.
     */

    g_mutex_lock(&group->mutex);

    result = dl_list_empty(group->works);

    g_mutex_unlock(&group->mutex);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : group = groupe dont les conclusions sont attendues.          *
*                queue = queue d'appartenance pour les appels externes.       *
*                                                                             *
*  Description : Attend que toutes les tâches d'un groupe soient traitées.    *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_work_group_wait_for_completion(GWorkGroup *group, GWorkQueue *queue)
{
    wait_for_incoming_works_cb callback;    /* Procédure complémentaire    */

    bool no_extra_check(GWorkQueue *_q, wgroup_id_t _id, void *_data)
    {
        return false;
    }

    callback = group->callback != NULL ? group->callback : no_extra_check;

    g_mutex_lock(&group->mutex);

    /**
     * On attend que :
     *  - la liste des tâches programmées soit vide.
     *  - il n'existe plus de tâche en cours.
     *  - rien n'indique que de nouvelles tâches supplémentaires vont arriver.
     */

    while ((g_atomic_int_get(&group->pending) > 0 || callback(queue, group->id, group->data))
           && !group->force_exit)
    {
        g_cond_wait(&group->wait_cond, &group->mutex);
    }

    g_mutex_unlock(&group->mutex);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : group    = groupe dont les paramètres sont à modifier.       *
*                callback = éventuelle fonction à appeler ou NULL.            *
*                data     = données devant accompagner l'appel.               *
*                                                                             *
*  Description : Modifie les conditions d'attente des fins d'exécutions.      *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_work_group_set_extra_wait_callback(GWorkGroup *group, wait_for_incoming_works_cb callback, void *data)
{
    group->callback = callback;
    group->data = data;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : queue    = gestionnaire de l'ensemble des groupes de travail.*
*                id       = identifiant d'un groupe de travail.               *
*                                                                             *
*  Description : Force un réveil d'une attente en cours pour la confirmer.    *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_work_group_wake_up_waiters(GWorkGroup *group)
{
    /**
     * Concernant la pose du verrou, se référer aux commentaires de la
     * fonction g_work_group_process().
     */

    g_mutex_lock(&group->mutex);

    g_cond_broadcast(&group->wait_cond);

    g_mutex_unlock(&group->mutex);

}



/* ---------------------------------------------------------------------------------- */
/*                           TRAITEMENT DE TACHES DIFFEREES                           */
/* ---------------------------------------------------------------------------------- */


/* Indique le type défini pour le gestionnaire des travaux différés. */
G_DEFINE_TYPE(GWorkQueue, g_work_queue, G_TYPE_OBJECT);


/******************************************************************************
*                                                                             *
*  Paramètres  : klass = classe à initialiser.                                *
*                                                                             *
*  Description : Initialise la classe des travaux différés.                   *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_work_queue_class_init(GWorkQueueClass *klass)
{
    GObjectClass *object;                   /* Autre version de la classe  */

    object = G_OBJECT_CLASS(klass);

    object->dispose = (GObjectFinalizeFunc/* ! */)g_work_queue_dispose;
    object->finalize = (GObjectFinalizeFunc)g_work_queue_finalize;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : queue = instance à initialiser.                              *
*                                                                             *
*  Description : Initialise une instance de gestionnaire de travaux différés. *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_work_queue_init(GWorkQueue *queue)
{
    queue->generator = 0;

    queue->groups = NULL;
    queue->groups_count = 0;
    g_mutex_init(&queue->mutex);
    g_cond_init(&queue->wait_all);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : queue = instance d'objet GLib à traiter.                     *
*                                                                             *
*  Description : Supprime toutes les références externes.                     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_work_queue_dispose(GWorkQueue *queue)
{
    size_t i;                               /* Boucle de parcours          */

    g_mutex_lock(&queue->mutex);

    for (i = 0; i < queue->groups_count; i++)
        g_object_unref(G_OBJECT(queue->groups[i]));

    g_mutex_unlock(&queue->mutex);

    g_mutex_clear(&queue->mutex);
    g_cond_clear(&queue->wait_all);

    G_OBJECT_CLASS(g_work_queue_parent_class)->dispose(G_OBJECT(queue));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : queue = instance d'objet GLib à traiter.                     *
*                                                                             *
*  Description : Procède à la libération totale de la mémoire.                *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_work_queue_finalize(GWorkQueue *queue)
{
    if (queue->groups != NULL)
        free(queue->groups);

    G_OBJECT_CLASS(g_work_queue_parent_class)->finalize(G_OBJECT(queue));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Créé un nouveau gestionnaire de tâches parallèles.           *
*                                                                             *
*  Retour      : Gestionnaire de traitements mis en place.                    *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GWorkQueue *g_work_queue_new(void)
{
    GWorkQueue *result;                     /* Instance à retourner        */

    result = g_object_new(G_TYPE_WORK_QUEUE, NULL);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : queue = gestionnaire de l'ensemble des groupes de travail.   *
*                id    = identifiant d'un groupe de travail.                  *
*                count = quantité de threads à allouer.                       *
*                                                                             *
*  Description : Donne l'assurance de l'existence d'un groupe de travail.     *
*                                                                             *
*  Retour      : true si un nouveau groupe a été constitué, false sinon.      *
*                                                                             *
*  Remarques   : Le verrou d'accès doit être posé par l'appelant.             *
*                                                                             *
******************************************************************************/

static bool g_work_queue_ensure_group_exists(GWorkQueue *queue, wgroup_id_t id, const guint *count)
{
    bool found;                             /* Bilan des recherches        */
    size_t i;                               /* Boucle de parcours          */
    GWorkGroup *group;                      /* Groupe à consulter          */

    assert(!g_mutex_trylock(&queue->mutex));

    found = false;

    for (i = 0; i < queue->groups_count && !found; i++)
    {
        group = queue->groups[i];
        found = (g_work_group_get_id(group) == id);
    }

    if (!found)
    {
        queue->groups_count++;
        queue->groups = (GWorkGroup **)realloc(queue->groups,
                                               queue->groups_count * sizeof(GWorkGroup *));

        group = g_work_group_new(id, count);
        queue->groups[queue->groups_count - 1] = group;

    }

    return !found;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : queue = gestionnaire de l'ensemble des groupes de travail.   *
*                                                                             *
*  Description : Constitue un nouveau groupe de travail.                      *
*                                                                             *
*  Retour      : Nouvel identifiant unique d'un nouveau groupe de travail.    *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

wgroup_id_t g_work_queue_define_work_group(GWorkQueue *queue)
{
    wgroup_id_t result;                     /* Valeur à retourner          */
    bool created;                           /* Bilan d'une tentative       */

    g_mutex_lock(&queue->mutex);

    do
    {
        result = queue->generator++;
        created = g_work_queue_ensure_group_exists(queue, result, NULL);
    }
    while (!created);

    g_mutex_unlock(&queue->mutex);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : queue = gestionnaire de l'ensemble des groupes de travail.   *
*                count = quantité de threads à allouer.                       *
*                                                                             *
*  Description : Constitue un nouveau petit groupe de travail.                *
*                                                                             *
*  Retour      : Nouvel identifiant unique d'un nouveau groupe de travail.    *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

wgroup_id_t g_work_queue_define_tiny_work_group(GWorkQueue *queue, guint count)
{
    wgroup_id_t result;                     /* Valeur à retourner          */
    bool created;                           /* Bilan d'une tentative       */

    g_mutex_lock(&queue->mutex);

    do
    {
        result = queue->generator++;
        created = g_work_queue_ensure_group_exists(queue, result, &count);
    }
    while (!created);

    g_mutex_unlock(&queue->mutex);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : queue = gestionnaire de l'ensemble des groupes de travail.   *
*                id    = identifiant d'un groupe de travail.                  *
*                                                                             *
*  Description : Dissout un groupe de travail existant.                       *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_work_queue_delete_work_group(GWorkQueue *queue, wgroup_id_t id)
{
    size_t i;                               /* Boucle de parcours          */
    GWorkGroup *group;                      /* Groupe de travail manipulé  */
#ifndef NDEBUG
    bool found;                             /* Repérage du groupe visé     */
#endif

#ifndef NDEBUG
    found = false;
#endif

    g_mutex_lock(&queue->mutex);

    for (i = 0; i < queue->groups_count; i++)
    {
        group = queue->groups[i];

        if (g_work_group_get_id(group) == id)
        {
            g_object_unref(G_OBJECT(group));

            memmove(&queue->groups[i], &queue->groups[i + 1],
                    (queue->groups_count - i - 1) * sizeof(GWorkGroup *));

            queue->groups_count--;
            queue->groups = (GWorkGroup **)realloc(queue->groups,
                                                   queue->groups_count * sizeof(GWorkGroup *));

#ifndef NDEBUG
            found = true;
#endif

            break;

        }

    }

    assert(found);

    g_cond_broadcast(&queue->wait_all);

    g_mutex_unlock(&queue->mutex);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : queue = gestionnaire des actions à mener.                    *
*                work  = nouvelle tâche à programmer, puis effectuer.         *
*                id    = identifiant du groupe de travail d'affectation.      *
*                                                                             *
*  Description : Place une nouvelle tâche en attente.                         *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_work_queue_schedule_work(GWorkQueue *queue, GDelayedWork *work, wgroup_id_t id)
{
    GWorkGroup *group;                      /* Groupe de travail à attendre*/

    group = g_work_queue_find_group_for_id(queue, id);
    assert(group != NULL);

    g_work_group_schedule(group, work);

    g_object_unref(G_OBJECT(group));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : queue = gestionnaire de l'ensemble des groupes de travail.   *
*                id    = identifiant d'un groupe de travail.                  *
*                                                                             *
*  Description : Fournit le groupe de travail correspondant à un identifiant. *
*                                                                             *
*  Retour      : Eventuel groupe existant trouvé ou NULL si aucun.            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static GWorkGroup *g_work_queue_find_group_for_id(GWorkQueue *queue, wgroup_id_t id)
{
    GWorkGroup *result;                     /* Trouvaille à retourner      */
    size_t i;                               /* Boucle de parcours          */

    result = NULL;

    g_mutex_lock(&queue->mutex);

    for (i = 0; i < queue->groups_count; i++)
        if (g_work_group_get_id(queue->groups[i]) == id)
        {
            result = queue->groups[i];
            g_object_ref(G_OBJECT(result));
            break;
        }

    g_mutex_unlock(&queue->mutex);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : queue = gestionnaire de l'ensemble des groupes de travail.   *
*                id    = identifiant d'un groupe de travail.                  *
*                                                                             *
*  Description : Détermine si un groupe est vide de toute programmation.      *
*                                                                             *
*  Retour      : Etat du groupe de travail.                                   *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_work_queue_is_empty(GWorkQueue *queue, wgroup_id_t id)
{
    bool result;                            /* Etat à retourner            */
    GWorkGroup *group;                      /* Groupe de travail à attendre*/

    group = g_work_queue_find_group_for_id(queue, id);

    if (group != NULL)
    {
        result = g_work_group_is_empty(group);
        g_object_unref(G_OBJECT(group));
    }

    else
        result = true;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : queue = gestionnaire de l'ensemble des groupes de travail.   *
*                id    = identifiant d'un groupe de travail.                  *
*                                                                             *
*  Description : Attend que toutes les tâches d'un groupe soient traitées.    *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_work_queue_wait_for_completion(GWorkQueue *queue, wgroup_id_t id)
{
    GWorkGroup *group;                      /* Groupe de travail à attendre*/

    group = g_work_queue_find_group_for_id(queue, id);

    if (group != NULL)
    {
        g_work_group_wait_for_completion(group, queue);
        g_object_unref(G_OBJECT(group));
    }

}


/******************************************************************************
*                                                                             *
*  Paramètres  : queue    = gestionnaire de l'ensemble des groupes de travail.*
*                gb_ids   = identifiants de groupes globaux.                  *
*                gb_count = nombre de ces groupes globaux.                    *
*                                                                             *
*  Description : Attend que toutes les tâches de tout groupe soient traitées. *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_work_queue_wait_for_all_completions(GWorkQueue *queue, const wgroup_id_t *gb_ids, size_t gb_count)
{
    size_t i;                               /* Boucle de parcours          */

    g_mutex_lock(&queue->mutex);

 wait_again:

    /**
     * Attente d'éventuels groupes isolés.
     */

    while (queue->groups_count > gb_count)
        g_cond_wait(&queue->wait_all, &queue->mutex);

    g_mutex_unlock(&queue->mutex);

    /**
     * Attente des groupes principaux.
     */

    for (i = 0; i < gb_count; i++)
        g_work_queue_wait_for_completion(queue, gb_ids[i]);

    /**
     * Si le groupe par défaut a généré de nouveaux groupes, on recommence !
     */

    g_mutex_lock(&queue->mutex);

    if (queue->groups_count > gb_count)
        goto wait_again;

    g_mutex_unlock(&queue->mutex);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : queue    = gestionnaire de l'ensemble des groupes de travail.*
*                id       = identifiant d'un groupe de travail.               *
*                callback = éventuelle fonction à appeler ou NULL.            *
*                data     = données devant accompagner l'appel.               *
*                                                                             *
*  Description : Modifie les conditions d'attente des fins d'exécutions.      *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_work_queue_set_extra_wait_callback(GWorkQueue *queue, wgroup_id_t id, wait_for_incoming_works_cb callback, void *data)
{
    GWorkGroup *group;                      /* Groupe de travail à traiter */

    group = g_work_queue_find_group_for_id(queue, id);

    if (group != NULL)
    {
        g_work_group_set_extra_wait_callback(group, callback, data);
        g_object_unref(G_OBJECT(group));
    }

}


/******************************************************************************
*                                                                             *
*  Paramètres  : queue    = gestionnaire de l'ensemble des groupes de travail.*
*                id       = identifiant d'un groupe de travail.               *
*                                                                             *
*  Description : Force un réveil d'une attente en cours pour la confirmer.    *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_work_queue_wake_up_waiters(GWorkQueue *queue, wgroup_id_t id)
{
    GWorkGroup *group;                      /* Groupe de travail à traiter */

    group = g_work_queue_find_group_for_id(queue, id);

    if (group != NULL)
    {
        g_work_group_wake_up_waiters(group);
        g_object_unref(G_OBJECT(group));
    }

}