summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/core/queue.c
blob: d0fbed8ac84b0ea71e543f54d9e8a9399682e8ba (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * queue.c - équivalent Python du fichier "core/queue.c"
 *
 * Copyright (C) 2018-2020 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 this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */


#include "queue.h"


#include <pygobject.h>


#include <core/queue.h>


#include "../access.h"
#include "../helpers.h"



/* Constitue un nouveau groupe de travail global. */
static PyObject *py_queue_setup_global_work_group(PyObject *, PyObject *);

/* Constitue un nouveau petit groupe de travail global. */
static PyObject *py_queue_setup_tiny_global_work_group(PyObject *, PyObject *);

/* Attend que toutes les tâches de tout groupe soient traitées. */
static PyObject *py_queue_wait_for_all_global_works(PyObject *, PyObject *);



/******************************************************************************
*                                                                             *
*  Paramètres  : self = objet Python concerné par l'appel.                    *
*                args = non utilisé ici.                                      *
*                                                                             *
*  Description : Constitue un nouveau groupe de travail global.               *
*                                                                             *
*  Retour      : Nouvel identifiant unique d'un nouveau groupe de travail.    *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_queue_setup_global_work_group(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Valeur à retourner          */
    PyThreadState *_save;                   /* Sauvegarde de contexte      */
    wgroup_id_t wid;                        /* Identifiant de groupe       */

#define QUEUE_SETUP_GLOBAL_WORK_GROUP_METHOD PYTHON_METHOD_DEF  \
(                                                               \
    setup_global_work_group, "",                                \
    METH_NOARGS, py_queue,                                      \
    "Create a new work group for parallel processed jobs.\n"    \
    "\n"                                                        \
    "The quantity of threads allocated for processing future"   \
    " data depends of available CPU cores.\n"                   \
    "\n"                                                        \
    "The returned value is an integer value referring to the"   \
    " unique identifier of a work group."                       \
)

    Py_UNBLOCK_THREADS;

    wid = setup_global_work_group();

    result = PyLong_FromUnsignedLongLong(wid);

    Py_BLOCK_THREADS;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = objet Python concerné par l'appel.                    *
*                args = paramètre à récupérer pour le traitement.             *
*                                                                             *
*  Description : Constitue un nouveau petit groupe de travail global.         *
*                                                                             *
*  Retour      : Nouvel identifiant unique d'un nouveau groupe de travail.    *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_queue_setup_tiny_global_work_group(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Valeur à retourner          */
    unsigned int count;                     /* Nombre de thread parallèle  */
    PyThreadState *_save;                   /* Sauvegarde de contexte      */

    int ret;                                /* Bilan de lecture des args.  */
    wgroup_id_t wid;                        /* Identifiant de groupe       */

#define QUEUE_SETUP_TINY_GLOBAL_WORK_GROUP_METHOD PYTHON_METHOD_DEF \
(                                                                   \
    setup_tiny_global_work_group, "/, count = 1",                   \
    METH_VARARGS, py_queue,                                         \
    "Create a new tiny work group for parallel processed jobs.\n"   \
    "\n"                                                            \
    "The *count* argument defines the quantity of threads allocated"\
    " for processing future data.\n"                                \
    "\n"                                                            \
    "The returned value is an integer value referring to the"       \
    " unique identifier of a work group."                           \
)

    result = NULL;

    count = 1;

    Py_UNBLOCK_THREADS;

    ret = PyArg_ParseTuple(args, "|I", &count);
    if (!ret) goto exit;

    if (count < 1)
    {
        PyErr_SetString(PyExc_ValueError, "the provided quantity has to be strictly positive");
        goto exit;
    }

    wid = setup_tiny_global_work_group(count);

    result = PyLong_FromUnsignedLongLong(wid);

 exit:

    Py_BLOCK_THREADS;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = objet Python concerné par l'appel.                    *
*                args = non utilisé ici.                                      *
*                                                                             *
*  Description : Attend que toutes les tâches de tout groupe soient traitées. *
*                                                                             *
*  Retour      : None.                                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_queue_wait_for_all_global_works(PyObject *self, PyObject *args)
{
    PyThreadState *_save;                   /* Sauvegarde de contexte      */

#define QUEUE_WAIT_FOR_ALL_GLOBAL_WORKS_METHOD PYTHON_METHOD_DEF    \
(                                                                   \
    wait_for_all_global_works, "",                                  \
    METH_NOARGS, py_queue,                                          \
    "Wait for all global tasks being processed."                    \
)

    Py_UNBLOCK_THREADS;

    wait_for_all_global_works();

    Py_BLOCK_THREADS;

    Py_RETURN_NONE;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Définit une extension du module 'core' à compléter.          *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool populate_core_module_with_queue(void)
{
    bool result;                            /* Bilan à retourner           */
    PyObject *module;                       /* Module à recompléter        */

    static PyMethodDef py_queue_methods[] = {
        QUEUE_SETUP_GLOBAL_WORK_GROUP_METHOD,
        QUEUE_SETUP_TINY_GLOBAL_WORK_GROUP_METHOD,
        QUEUE_WAIT_FOR_ALL_GLOBAL_WORKS_METHOD,
        { NULL }
    };

    module = get_access_to_python_module("pychrysalide.core");

    result = register_python_module_methods(module, py_queue_methods);

    return result;

}