pygi-marshal-cleanup.c 18.1 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
/* -*- Mode: C; c-basic-offset: 4 -*-
 * vim: tabstop=4 shiftwidth=4 expandtab
 *
 * Copyright (C) 2011 John (J5) Palmieri <johnp@redhat.com>, Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
 * USA
 */
 
 #include "pygi-marshal-cleanup.h"
 #include <glib.h>
24
25
static inline void
_cleanup_caller_allocates (PyGIInvokeState    *state,
26
                           PyGIArgCache       *cache,
27
28
                           gpointer            data)
{
29
30
31
    PyGIInterfaceCache *iface_cache = (PyGIInterfaceCache *)cache;

    if (iface_cache->g_type == G_TYPE_BOXED) {
32
        gsize size;
33
        size = g_struct_info_get_size (iface_cache->interface_info);
34
        g_slice_free1 (size, data);
35
36
    } else if (iface_cache->g_type == G_TYPE_VALUE) {
        g_slice_free (GValue, data);
37
38
    } else if (iface_cache->is_foreign) {
        pygi_struct_foreign_release ((GIBaseInfo *)iface_cache->interface_info,
39
40
41
42
43
                                     data);
    } else {
        g_free (data);
    }
}
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
/**
 * Cleanup during invoke can happen in multiple
 * stages, each of which can be the result of a
 * successful compleation of that stage or an error
 * occured which requires partial cleanup.
 *
 * For the most part, either the C interface being
 * invoked or the python object which wraps the
 * parameters, handle their lifecycles but in some
 * cases, where we have intermediate objects,
 * or when we fail processing a parameter, we need
 * to handle the clean up manually.
 *
 * There are two argument processing stages.
 * They are the in stage, where we process python
 * parameters into their C counterparts, and the out
 * stage, where we process out C parameters back
 * into python objects. The in stage also sets up
 * temporary out structures for caller allocated
 * parameters which need to be cleaned up either on
 * in stage failure or at the completion of the out
 * stage (either success or failure)
 *
 * The in stage must call one of these cleanup functions:
 *    - pygi_marshal_cleanup_args_in_marshal_success
 *       (continue to out stage)
 *    - pygi_marshal_cleanup_args_in_parameter_fail
 *       (final, exit from invoke)
 *
 * The out stage must call one of these cleanup functions which are all final:
 *    - pygi_marshal_cleanup_args_out_marshal_success
 *    - pygi_marshal_cleanup_args_return_fail
 *    - pygi_marshal_cleanup_args_out_parameter_fail
 *
 **/
void
pygi_marshal_cleanup_args_in_marshal_success (PyGIInvokeState   *state,
                                              PyGICallableCache *cache)
{
84
    gsize i;
85

86
87
88
89
90
    /* For in success, call cleanup for all GI_DIRECTION_IN values only. */
    for (i = 0; i < cache->n_args; i++) {
        PyGIArgCache *arg_cache = cache->args_cache[i];
        PyGIMarshalCleanupFunc cleanup_func = arg_cache->in_cleanup;

91
92
93
        if (cleanup_func &&
                arg_cache->direction == GI_DIRECTION_IN &&
                    state->args[i]->v_pointer != NULL)
94
95
            cleanup_func (state, arg_cache, state->args[i]->v_pointer, TRUE);
    }
96
97
98
}

void
99
100
pygi_marshal_cleanup_args_out_marshal_success (PyGIInvokeState   *state,
                                               PyGICallableCache *cache)
101
{
102
103
104
    /* clean up the return if available */
    if (cache->return_cache != NULL) {
        PyGIMarshalCleanupFunc cleanup_func = cache->return_cache->out_cleanup;
105
        if (cleanup_func && state->return_arg.v_pointer != NULL)
106
107
108
109
110
            cleanup_func (state,
                          cache->return_cache,
                          state->return_arg.v_pointer,
                          TRUE);
    }
111

112
113
114
115
116
    /* Now clean up args */
    GSList *cache_item = cache->out_args;
    while (cache_item) {
        PyGIArgCache *arg_cache = (PyGIArgCache *) cache_item->data;
        PyGIMarshalCleanupFunc cleanup_func = arg_cache->out_cleanup;
117
118
119
        gpointer data = state->args[arg_cache->c_arg_index]->v_pointer;

        if (cleanup_func != NULL && data != NULL)
120
121
            cleanup_func (state,
                          arg_cache,
122
                          data,
123
124
125
126
                          TRUE);

        cache_item = cache_item->next;
    }
127
128
129
130
131
132
133
}

void
pygi_marshal_cleanup_args_in_parameter_fail (PyGIInvokeState   *state,
                                             PyGICallableCache *cache,
                                             gssize failed_arg_index)
{
134
135
    gsize i;

136
    state->failed = TRUE;
137

138
    for (i = 0; i < cache->n_args  && i <= failed_arg_index; i++) {
139
140
        PyGIArgCache *arg_cache = cache->args_cache[i];
        PyGIMarshalCleanupFunc cleanup_func = arg_cache->in_cleanup;
141
        gpointer data = state->args[i]->v_pointer;
142

143
144
145
        if (cleanup_func &&
                arg_cache->direction == GI_DIRECTION_IN &&
                    data != NULL) {
146
147
            cleanup_func (state,
                          arg_cache,
148
                          data,
149
                          i < failed_arg_index);
150
151

        } else if (arg_cache->is_caller_allocates && data != NULL) {
152
153
            _cleanup_caller_allocates (state,
                                       arg_cache,
154
                                       data);
155
156
        }
    }
157
158
159
160
161
162
}

void
pygi_marshal_cleanup_args_return_fail (PyGIInvokeState   *state,
                                       PyGICallableCache *cache)
{
163
    state->failed = TRUE;
164
165
166
167
168
169
170
}

void
pygi_marshal_cleanup_args_out_parameter_fail (PyGIInvokeState   *state,
                                              PyGICallableCache *cache,
                                              gssize failed_out_arg_index)
{
171
172
    state->failed = TRUE;
}
173

174
175
176
177
178
179
180
void 
_pygi_marshal_cleanup_closure_unref (PyGIInvokeState *state,
                                     PyGIArgCache    *arg_cache,
                                     gpointer         data,
                                     gboolean         was_processed)
{
    g_closure_unref ( (GClosure *)data);
181
182
}

183
void
184
185
186
187
_pygi_marshal_cleanup_in_utf8 (PyGIInvokeState *state,
                               PyGIArgCache    *arg_cache,
                               gpointer         data,
                               gboolean         was_processed)
188
{
189
190
191
192
    /* We strdup strings so always free if we have processed this
       parameter for input */
    if (was_processed)
        g_free (data);
193
194
}

195
196
197
198
199
void
_pygi_marshal_cleanup_out_utf8 (PyGIInvokeState *state,
                                PyGIArgCache    *arg_cache,
                                gpointer         data,
                                gboolean         was_processed)
200
{
201
202
203
204
205
    /* Python copies the string so we need to free it
       if the interface is transfering ownership, 
       whether or not it has been processed yet */
    if (arg_cache->transfer == GI_TRANSFER_EVERYTHING)
        g_free (data);
206
207
}

208
void
209
210
211
212
_pygi_marshal_cleanup_in_interface_object (PyGIInvokeState *state,
                                           PyGIArgCache    *arg_cache,
                                           gpointer         data,
                                           gboolean         was_processed)
213
{
214
215
216
217
218
    /* If we processed the parameter but fail before invoking the method,
       we need to remove the ref we added */
    if (was_processed && state->failed && data != NULL &&
            arg_cache->transfer == GI_TRANSFER_EVERYTHING)
        g_object_unref (G_OBJECT(data));
219
}
220
221

void
222
223
224
225
_pygi_marshal_cleanup_out_interface_object (PyGIInvokeState *state,
                                            PyGIArgCache    *arg_cache,
                                            gpointer         data,
                                            gboolean         was_processed)
226
{
227
228
229
230
    /* If we error out and the object is not marshalled into a PyGObject
       we must take care of removing the ref */
    if (!was_processed && arg_cache->transfer == GI_TRANSFER_EVERYTHING)
        g_object_unref (G_OBJECT(data));
231
232
233
}

void 
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
_pygi_marshal_cleanup_in_interface_struct_gvalue (PyGIInvokeState *state,
                                                  PyGIArgCache    *arg_cache,
                                                  gpointer         data,
                                                  gboolean         was_processed)
{
    if (was_processed) {
        PyObject *py_arg = PyTuple_GET_ITEM (state->py_in_args,
                                             arg_cache->py_arg_index);
        GType py_object_type =
            pyg_type_from_object_strict ( (PyObject *) py_arg->ob_type, FALSE);

        if (py_object_type != G_TYPE_VALUE) {
            g_value_unset ((GValue *) data);
            g_slice_free (GValue, data);
        }
    }
}

void
_pygi_marshal_cleanup_in_interface_struct_foreign (PyGIInvokeState *state,
                                                   PyGIArgCache    *arg_cache,
                                                   gpointer         data,
                                                   gboolean         was_processed)
{
    if (state->failed && was_processed)
        pygi_struct_foreign_release (
            ( (PyGIInterfaceCache *)arg_cache)->interface_info,
            data);
}

void
_pygi_marshal_cleanup_out_interface_struct_foreign (PyGIInvokeState *state,
                                                    PyGIArgCache    *arg_cache,
                                                    gpointer         data,
                                                    gboolean         was_processed)
269
{
270
271
272
273
    if (!was_processed && arg_cache->transfer == GI_TRANSFER_EVERYTHING)
        pygi_struct_foreign_release ( 
            ( (PyGIInterfaceCache *)arg_cache)->interface_info,
            data);
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

void
_pygi_marshal_cleanup_in_array (PyGIInvokeState *state,
                                PyGIArgCache    *arg_cache,
                                gpointer         data,
                                gboolean         was_processed)
{
    if (was_processed) {
        GArray *array_;
        PyGISequenceCache *sequence_cache = (PyGISequenceCache *)arg_cache;

        /* If this isn't a garray create one to help process variable sized
           array elements */
        if (sequence_cache->array_type == GI_ARRAY_TYPE_C) {
            gsize len;
            if (sequence_cache->fixed_size >= 0) {
                len = sequence_cache->fixed_size;
            } else if (sequence_cache->is_zero_terminated) {
                len = g_strv_length ((gchar **)data);
            } else {
                GIArgument *len_arg = state->args[sequence_cache->len_arg_index];
                len = len_arg->v_long;
            }

            array_ = g_array_new (FALSE,
                                  FALSE,
                                  sequence_cache->item_size);

            if (array_ == NULL)
                return;

            array_->data = data;
            array_->len = len;

        } else {
            array_ = (GArray *) data;
        }

        /* clean up items first */
        if (sequence_cache->item_cache->in_cleanup != NULL) {
            gsize i;
            PyGIMarshalCleanupFunc cleanup_func =
                sequence_cache->item_cache->in_cleanup;

            for(i = 0; i < array_->len; i++) {
                cleanup_func (state,
                              sequence_cache->item_cache,
                              g_array_index (array_, gpointer, i),
                              TRUE);
            }
        }

        if (state->failed ||
            arg_cache->transfer == GI_TRANSFER_NOTHING ||
            arg_cache->transfer == GI_TRANSFER_CONTAINER) {
            g_array_free (array_, TRUE);
        } else if (sequence_cache->array_type == GI_ARRAY_TYPE_C) {
            g_array_free (array_, FALSE);
        }
    }
}

void
_pygi_marshal_cleanup_out_array (PyGIInvokeState *state,
                                 PyGIArgCache    *arg_cache,
                                 gpointer         data,
                                 gboolean         was_processed)
{
343
    PyGISequenceCache *sequence_cache = (PyGISequenceCache *)arg_cache;
344

345
346
    if (arg_cache->transfer == GI_TRANSFER_EVERYTHING ||
            arg_cache->transfer == GI_TRANSFER_CONTAINER) {
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
        GArray *array_ = (GArray *) data;

        if (sequence_cache->array_type == GI_ARRAY_TYPE_C) {
            g_free (data);
            return;
        }

        if (sequence_cache->item_cache->out_cleanup != NULL) {
            int i;

            PyGIMarshalCleanupFunc cleanup_func = sequence_cache->item_cache->out_cleanup;
            for (i = 0; i < array_->len; i++) {
                cleanup_func (state,
                              sequence_cache->item_cache,
                              g_array_index (array_, gpointer, i),
                              was_processed);
            }
        }

        if (arg_cache->transfer == GI_TRANSFER_EVERYTHING)
            g_array_free (array_, TRUE);
    }
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

void
_pygi_marshal_cleanup_in_glist  (PyGIInvokeState *state,
                                 PyGIArgCache    *arg_cache,
                                 gpointer         data,
                                 gboolean         was_processed)
{
    if (was_processed) {
        GSList *list_;
        PyGISequenceCache *sequence_cache = (PyGISequenceCache *)arg_cache;

        list_ = (GSList *)data;

        /* clean up items first */
        if (sequence_cache->item_cache->in_cleanup != NULL) {
            PyGIMarshalCleanupFunc cleanup_func =
                sequence_cache->item_cache->in_cleanup;
            GSList *node = list_;
            while (node != NULL) {
                cleanup_func (state,
                              sequence_cache->item_cache,
                              node->data,
                              TRUE);
                node = node->next;
            }
        }

        if (state->failed ||
               arg_cache->transfer == GI_TRANSFER_NOTHING ||
                  arg_cache->transfer == GI_TRANSFER_CONTAINER) {
            switch (arg_cache->type_tag) {
                case GI_TYPE_TAG_GLIST:
                    g_list_free ( (GList *)list_);
                    break;
                case GI_TYPE_TAG_GSLIST:
                    g_slist_free (list_);
                    break;
                default:
                    g_assert_not_reached();
            }
        }
    }
}

void
_pygi_marshal_cleanup_out_glist (PyGIInvokeState *state,
                                 PyGIArgCache    *arg_cache,
                                 gpointer         data,
                                 gboolean         was_processed)
{
    PyGISequenceCache *sequence_cache = (PyGISequenceCache *)arg_cache;

    if (arg_cache->transfer == GI_TRANSFER_EVERYTHING ||
            arg_cache->transfer == GI_TRANSFER_CONTAINER) {
        GSList *list_ = (GSList *)data;

        if (sequence_cache->item_cache->out_cleanup != NULL) {
            PyGIMarshalCleanupFunc cleanup_func =
                sequence_cache->item_cache->out_cleanup;
            GSList *node = list_;

            while (node != NULL) {
                cleanup_func (state,
                              sequence_cache->item_cache,
                              node->data,
                              was_processed);
                node = node->next;
            }
        }

        if (arg_cache->transfer == GI_TRANSFER_EVERYTHING) {
            switch (arg_cache->type_tag) {
                case GI_TYPE_TAG_GLIST:
                    g_list_free ( (GList *)list_);
                    break;
                case GI_TYPE_TAG_GSLIST:
                    g_slist_free (list_);
                    break;
                default:
                    g_assert_not_reached();
            }
        }
    }
}
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

void
_pygi_marshal_cleanup_in_ghash  (PyGIInvokeState *state,
                                 PyGIArgCache    *arg_cache,
                                 gpointer         data,
                                 gboolean         was_processed)
{
    if (data == NULL)
        return;

    if (was_processed) {
        GHashTable *hash_;
        PyGIHashCache *hash_cache = (PyGIHashCache *)arg_cache;

        hash_ = (GHashTable *)data;

        /* clean up keys and values first */
        if (hash_cache->key_cache->in_cleanup != NULL ||
                hash_cache->value_cache->in_cleanup != NULL) {
            GHashTableIter hiter;
            gpointer key;
            gpointer value;

            PyGIMarshalCleanupFunc key_cleanup_func =
                hash_cache->key_cache->in_cleanup;
            PyGIMarshalCleanupFunc value_cleanup_func =
                hash_cache->value_cache->in_cleanup;

            g_hash_table_iter_init (&hiter, hash_);
            while (g_hash_table_iter_next (&hiter, &key, &value)) {
                if (key != NULL && key_cleanup_func != NULL)
                    key_cleanup_func (state,
                                      hash_cache->key_cache,
                                      key,
                                      TRUE);
                if (value != NULL && value_cleanup_func != NULL)
                    value_cleanup_func (state,
                                        hash_cache->value_cache,
                                        value,
                                        TRUE);
            }
        }

        if (state->failed ||
               arg_cache->transfer == GI_TRANSFER_NOTHING ||
                  arg_cache->transfer == GI_TRANSFER_CONTAINER)
            g_hash_table_destroy (hash_);

    }
}

void
_pygi_marshal_cleanup_out_ghash (PyGIInvokeState *state,
                                 PyGIArgCache    *arg_cache,
                                 gpointer         data,
                                 gboolean         was_processed)
{
    if (data == NULL)
        return;

    /* assume hashtable has boxed key and value */
    if (arg_cache->transfer == GI_TRANSFER_EVERYTHING)
        g_hash_table_destroy ( (GHashTable *)data);
}