Make the data unit size configurable
[libsigrokdecode.git] / instance.c
1 /*
2  * This file is part of the libsigrokdecode project.
3  *
4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
22 #include "libsigrokdecode-internal.h"
23 #include "config.h"
24 #include <glib.h>
25 #include <inttypes.h>
26 #include <stdlib.h>
27 #include <stdint.h>
28
29 /** @cond PRIVATE */
30
31 extern GSList *sessions;
32
33 /* type_logic.c */
34 extern SRD_PRIV PyTypeObject srd_logic_type;
35
36 /** @endcond */
37
38 /**
39  * @file
40  *
41  * Decoder instance handling.
42  */
43
44 /**
45  * @defgroup grp_instances Decoder instances
46  *
47  * Decoder instance handling.
48  *
49  * @{
50  */
51
52 /**
53  * Set one or more options in a decoder instance.
54  *
55  * Handled options are removed from the hash.
56  *
57  * @param di Decoder instance.
58  * @param options A GHashTable of options to set.
59  *
60  * @return SRD_OK upon success, a (negative) error code otherwise.
61  *
62  * @since 0.1.0
63  */
64 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
65                 GHashTable *options)
66 {
67         PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
68         PyObject *py_optlist, *py_classval;
69         Py_UNICODE *py_ustr;
70         GVariant *value;
71         unsigned long long int val_ull;
72         gint64 val_int;
73         int num_optkeys, ret, size, i;
74         const char *val_str;
75         char *dbg, *key;
76
77         if (!di) {
78                 srd_err("Invalid decoder instance.");
79                 return SRD_ERR_ARG;
80         }
81
82         if (!options) {
83                 srd_err("Invalid options GHashTable.");
84                 return SRD_ERR_ARG;
85         }
86
87         if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
88                 /* Decoder has no options. */
89                 if (g_hash_table_size(options) == 0) {
90                         /* No options provided. */
91                         return SRD_OK;
92                 } else {
93                         srd_err("Protocol decoder has no options.");
94                         return SRD_ERR_ARG;
95                 }
96                 return SRD_OK;
97         }
98
99         ret = SRD_ERR_PYTHON;
100         key = NULL;
101         py_dec_options = py_dec_optkeys = py_di_options = py_optval = NULL;
102         py_optlist = py_classval = NULL;
103         py_dec_options = PyObject_GetAttrString(di->decoder->py_dec, "options");
104
105         /* All of these are synthesized objects, so they're good. */
106         py_dec_optkeys = PyDict_Keys(py_dec_options);
107         num_optkeys = PyList_Size(py_dec_optkeys);
108
109         /*
110          * The 'options' dictionary is a class variable, but we need to
111          * change it. Changing it directly will affect the entire class,
112          * so we need to create a new object for it, and populate that
113          * instead.
114          */
115         if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options")))
116                 goto err_out;
117         Py_DECREF(py_di_options);
118         py_di_options = PyDict_New();
119         PyObject_SetAttrString(di->py_inst, "options", py_di_options);
120         for (i = 0; i < num_optkeys; i++) {
121                 /* Get the default class value for this option. */
122                 py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key);
123                 if (!(py_optlist = PyDict_GetItemString(py_dec_options, key)))
124                         goto err_out;
125                 if (!(py_classval = PyList_GetItem(py_optlist, 1)))
126                         goto err_out;
127                 if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) {
128                         srd_err("Options of type %s are not yet supported.",
129                                 Py_TYPE(py_classval)->tp_name);
130                         goto err_out;
131                 }
132
133                 if ((value = g_hash_table_lookup(options, key))) {
134                         dbg = g_variant_print(value, TRUE);
135                         srd_dbg("got option '%s' = %s", key, dbg);
136                         g_free(dbg);
137                         /* An override for this option was provided. */
138                         if (PyUnicode_Check(py_classval)) {
139                                 if (!g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) {
140                                         srd_err("Option '%s' requires a string value.", key);
141                                         goto err_out;
142                                 }
143                                 val_str = g_variant_get_string(value, NULL);
144                                 if (!(py_optval = PyUnicode_FromString(val_str))) {
145                                         /* Some UTF-8 encoding error. */
146                                         PyErr_Clear();
147                                         srd_err("Option '%s' requires a UTF-8 string value.", key);
148                                         goto err_out;
149                                 }
150                         } else if (PyLong_Check(py_classval)) {
151                                 if (!g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) {
152                                         srd_err("Option '%s' requires an integer value.", key);
153                                         goto err_out;
154                                 }
155                                 val_int = g_variant_get_int64(value);
156                                 if (!(py_optval = PyLong_FromLong(val_int))) {
157                                         /* ValueError Exception */
158                                         PyErr_Clear();
159                                         srd_err("Option '%s' has invalid integer value.", key);
160                                         goto err_out;
161                                 }
162                         }
163                         g_hash_table_remove(options, key);
164                 } else {
165                         /* Use the class default for this option. */
166                         if (PyUnicode_Check(py_classval)) {
167                                 /* Make a brand new copy of the string. */
168                                 py_ustr = PyUnicode_AS_UNICODE(py_classval);
169                                 size = PyUnicode_GET_SIZE(py_classval);
170                                 py_optval = PyUnicode_FromUnicode(py_ustr, size);
171                         } else if (PyLong_Check(py_classval)) {
172                                 /* Make a brand new copy of the integer. */
173                                 val_ull = PyLong_AsUnsignedLongLong(py_classval);
174                                 if (val_ull == (unsigned long long)-1) {
175                                         /* OverFlowError exception */
176                                         PyErr_Clear();
177                                         srd_err("Invalid integer value for %s: "
178                                                 "expected integer.", key);
179                                         goto err_out;
180                                 }
181                                 if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull)))
182                                         goto err_out;
183                         }
184                 }
185
186                 /*
187                  * If we got here, py_optval holds a known good new reference
188                  * to the instance option to set.
189                  */
190                 if (PyDict_SetItemString(py_di_options, key, py_optval) == -1)
191                         goto err_out;
192                 g_free(key);
193                 key = NULL;
194         }
195
196         ret = SRD_OK;
197
198 err_out:
199         Py_XDECREF(py_di_options);
200         Py_XDECREF(py_dec_optkeys);
201         Py_XDECREF(py_dec_options);
202         g_free(key);
203         if (PyErr_Occurred()) {
204                 srd_exception_catch("Stray exception in srd_inst_option_set().");
205                 ret = SRD_ERR_PYTHON;
206         }
207
208         return ret;
209 }
210
211 /* Helper GComparefunc for g_slist_find_custom() in srd_inst_probe_set_all() */
212 static gint compare_probe_id(const struct srd_probe *a, const char *probe_id)
213 {
214         return strcmp(a->id, probe_id);
215 }
216
217 /**
218  * Set all probes in a decoder instance.
219  *
220  * This function sets _all_ probes for the specified decoder instance, i.e.,
221  * it overwrites any probes that were already defined (if any).
222  *
223  * @param di Decoder instance.
224  * @param new_probes A GHashTable of probes to set. Key is probe name, value is
225  *                   the probe number. Samples passed to this instance will be
226  *                   arranged in this order.
227  * @param unit_size Number of bytes per sample in the data stream to be passed
228  *                  to the decoder. The highest probe index specified in the
229  *                  probe map must lie within a sample unit.
230  *
231  * @return SRD_OK upon success, a (negative) error code otherwise.
232  *
233  * @since 0.1.0
234  */
235 SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
236                 GHashTable *new_probes, int unit_size)
237 {
238         GVariant *probe_val;
239         GList *l;
240         GSList *sl;
241         struct srd_probe *p;
242         int *new_probemap, new_probenum, num_required_probes, i;
243         char *probe_id;
244
245         srd_dbg("set probes called for instance %s with list of %d probes",
246                 di->inst_id, g_hash_table_size(new_probes));
247
248         if (g_hash_table_size(new_probes) == 0)
249                 /* No probes provided. */
250                 return SRD_OK;
251
252         if (di->dec_num_probes == 0) {
253                 /* Decoder has no probes. */
254                 srd_err("Protocol decoder %s has no probes to define.",
255                         di->decoder->name);
256                 return SRD_ERR_ARG;
257         }
258
259         new_probemap = NULL;
260
261         if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
262                 srd_err("Failed to g_malloc() new probe map.");
263                 return SRD_ERR_MALLOC;
264         }
265
266         /*
267          * For now, map all indexes to probe -1 (can be overridden later).
268          * This -1 is interpreted as an unspecified probe later.
269          */
270         for (i = 0; i < di->dec_num_probes; i++)
271                 new_probemap[i] = -1;
272
273         for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
274                 probe_id = l->data;
275                 probe_val = g_hash_table_lookup(new_probes, probe_id);
276                 if (!g_variant_is_of_type(probe_val, G_VARIANT_TYPE_INT32)) {
277                         /* Probe name was specified without a value. */
278                         srd_err("No probe number was specified for %s.",
279                                         probe_id);
280                         g_free(new_probemap);
281                         return SRD_ERR_ARG;
282                 }
283                 new_probenum = g_variant_get_int32(probe_val);
284                 if (new_probenum >= 8 * unit_size) {
285                         srd_err("Probe index %d not within data unit (%d bit).",
286                                 new_probenum, 8 * unit_size);
287                         g_free(new_probemap);
288                         return SRD_ERR_ARG;
289                 }
290                 if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id,
291                                 (GCompareFunc)compare_probe_id))) {
292                         /* Fall back on optional probes. */
293                         if (!(sl = g_slist_find_custom(di->decoder->opt_probes,
294                              probe_id, (GCompareFunc) compare_probe_id))) {
295                                 srd_err("Protocol decoder %s has no probe "
296                                                 "'%s'.", di->decoder->name, probe_id);
297                                 g_free(new_probemap);
298                                 return SRD_ERR_ARG;
299                         }
300                 }
301                 p = sl->data;
302                 new_probemap[p->order] = new_probenum;
303                 srd_dbg("Setting probe mapping: %s (index %d) = probe %d.",
304                         p->id, p->order, new_probenum);
305         }
306         di->data_unitsize = unit_size;
307
308         srd_dbg("Final probe map:");
309         num_required_probes = g_slist_length(di->decoder->probes);
310         for (i = 0; i < di->dec_num_probes; i++) {
311                 srd_dbg(" - index %d = probe %d (%s)", i, new_probemap[i],
312                         (i < num_required_probes) ? "required" : "optional");
313         }
314
315         /* Report an error if not all required probes were specified. */
316         for (i = 0; i < num_required_probes; i++) {
317                 if (new_probemap[i] != -1)
318                         continue;
319                 p = g_slist_nth(di->decoder->probes, i)->data;
320                 srd_err("Required probe '%s' (index %d) was not specified.",
321                         p->id, i);
322                 return SRD_ERR;
323         }
324
325         g_free(di->dec_probemap);
326         di->dec_probemap = new_probemap;
327
328         return SRD_OK;
329 }
330
331 /**
332  * Create a new protocol decoder instance.
333  *
334  * @param sess The session holding the protocol decoder instance.
335  * @param decoder_id Decoder 'id' field.
336  * @param options GHashtable of options which override the defaults set in
337  *                the decoder class. May be NULL.
338  *
339  * @return Pointer to a newly allocated struct srd_decoder_inst, or
340  *         NULL in case of failure.
341  *
342  * @since 0.3.0
343  */
344 SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
345                 const char *decoder_id, GHashTable *options)
346 {
347         int i;
348         struct srd_decoder *dec;
349         struct srd_decoder_inst *di;
350         char *inst_id;
351
352         srd_dbg("Creating new %s instance.", decoder_id);
353
354         if (session_is_valid(sess) != SRD_OK) {
355                 srd_err("Invalid session.");
356                 return NULL;
357         }
358
359         if (!(dec = srd_decoder_get_by_id(decoder_id))) {
360                 srd_err("Protocol decoder %s not found.", decoder_id);
361                 return NULL;
362         }
363
364         if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) {
365                 srd_err("Failed to g_malloc() instance.");
366                 return NULL;
367         }
368
369         di->decoder = dec;
370         di->sess = sess;
371         if (options) {
372                 inst_id = g_hash_table_lookup(options, "id");
373                 di->inst_id = g_strdup(inst_id ? inst_id : decoder_id);
374                 g_hash_table_remove(options, "id");
375         } else
376                 di->inst_id = g_strdup(decoder_id);
377
378         /*
379          * Prepare a default probe map, where samples come in the
380          * order in which the decoder class defined them.
381          */
382         di->dec_num_probes = g_slist_length(di->decoder->probes) +
383                         g_slist_length(di->decoder->opt_probes);
384         if (di->dec_num_probes) {
385                 if (!(di->dec_probemap =
386                                 g_try_malloc(sizeof(int) * di->dec_num_probes))) {
387                         srd_err("Failed to g_malloc() probe map.");
388                         g_free(di);
389                         return NULL;
390                 }
391                 for (i = 0; i < di->dec_num_probes; i++)
392                         di->dec_probemap[i] = i;
393                 di->data_unitsize = (di->dec_num_probes + 7) / 8;
394                 /*
395                  * Will be used to prepare a sample at every iteration
396                  * of the instance's decode() method.
397                  */
398                 if (!(di->probe_samples = g_try_malloc(di->dec_num_probes))) {
399                         srd_err("Failed to g_malloc() sample buffer.");
400                         g_free(di->dec_probemap);
401                         g_free(di);
402                         return NULL;
403                 }
404         }
405
406         /* Create a new instance of this decoder class. */
407         if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
408                 if (PyErr_Occurred())
409                         srd_exception_catch("failed to create %s instance: ",
410                                         decoder_id);
411                 g_free(di->dec_probemap);
412                 g_free(di);
413                 return NULL;
414         }
415
416         if (options && srd_inst_option_set(di, options) != SRD_OK) {
417                 g_free(di->dec_probemap);
418                 g_free(di);
419                 return NULL;
420         }
421
422         /* Instance takes input from a frontend by default. */
423         sess->di_list = g_slist_append(sess->di_list, di);
424
425         return di;
426 }
427
428 /**
429  * Stack a decoder instance on top of another.
430  *
431  * @param sess The session holding the protocol decoder instances.
432  * @param di_bottom The instance on top of which di_top will be stacked.
433  * @param di_top The instance to go on top.
434  *
435  * @return SRD_OK upon success, a (negative) error code otherwise.
436  *
437  * @since 0.3.0
438  */
439 SRD_API int srd_inst_stack(struct srd_session *sess,
440                 struct srd_decoder_inst *di_bottom,
441                 struct srd_decoder_inst *di_top)
442 {
443
444         if (session_is_valid(sess) != SRD_OK) {
445                 srd_err("Invalid session.");
446                 return SRD_ERR_ARG;
447         }
448
449         if (!di_bottom || !di_top) {
450                 srd_err("Invalid from/to instance pair.");
451                 return SRD_ERR_ARG;
452         }
453
454         if (g_slist_find(sess->di_list, di_top)) {
455                 /* Remove from the unstacked list. */
456                 sess->di_list = g_slist_remove(sess->di_list, di_top);
457         }
458
459         /* Stack on top of source di. */
460         di_bottom->next_di = g_slist_append(di_bottom->next_di, di_top);
461
462         srd_dbg("Stacked %s on top of %s.", di_top->inst_id, di_bottom->inst_id);
463
464         return SRD_OK;
465 }
466
467 /**
468  * Find a decoder instance by its instance ID.
469  *
470  * Only the bottom level of instances are searched -- instances already stacked
471  * on top of another one will not be found.
472  *
473  * @param sess The session holding the protocol decoder instance.
474  * @param inst_id The instance ID to be found.
475  *
476  * @return Pointer to struct srd_decoder_inst, or NULL if not found.
477  *
478  * @since 0.3.0
479  */
480 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
481                 const char *inst_id)
482 {
483         GSList *l;
484         struct srd_decoder_inst *tmp, *di;
485
486         if (session_is_valid(sess) != SRD_OK) {
487                 srd_err("Invalid session.");
488                 return NULL;
489         }
490
491         di = NULL;
492         for (l = sess->di_list; l; l = l->next) {
493                 tmp = l->data;
494                 if (!strcmp(tmp->inst_id, inst_id)) {
495                         di = tmp;
496                         break;
497                 }
498         }
499
500         return di;
501 }
502
503 static struct srd_decoder_inst *srd_sess_inst_find_by_obj(
504                 struct srd_session *sess, const GSList *stack,
505                 const PyObject *obj)
506 {
507         const GSList *l;
508         struct srd_decoder_inst *tmp, *di;
509
510         if (session_is_valid(sess) != SRD_OK) {
511                 srd_err("Invalid session.");
512                 return NULL;
513         }
514
515         di = NULL;
516         for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
517                 tmp = l->data;
518                 if (tmp->py_inst == obj)
519                         di = tmp;
520                 else if (tmp->next_di)
521                         di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj);
522         }
523
524         return di;
525 }
526
527 /**
528  * Find a decoder instance by its Python object.
529  *
530  * I.e. find that instance's instantiation of the sigrokdecode.Decoder class.
531  * This will recurse to find the instance anywhere in the stack tree of all
532  * sessions.
533  *
534  * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the
535  *              stack to search. To start searching at the bottom level of
536  *              decoder instances, pass NULL.
537  * @param obj The Python class instantiation.
538  *
539  * @return Pointer to struct srd_decoder_inst, or NULL if not found.
540  *
541  * @private
542  *
543  * @since 0.1.0
544  */
545 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack,
546                 const PyObject *obj)
547 {
548         struct srd_decoder_inst *di;
549         struct srd_session *sess;
550         GSList *l;
551
552         di = NULL;
553         for (l = sessions; di == NULL && l != NULL; l = l->next) {
554                 sess = l->data;
555                 di = srd_sess_inst_find_by_obj(sess, stack, obj);
556         }
557
558         return di;
559 }
560
561 /** @private */
562 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di)
563 {
564         PyObject *py_res;
565         GSList *l;
566         struct srd_decoder_inst *next_di;
567         int ret;
568
569         srd_dbg("Calling start() method on protocol decoder instance %s.",
570                         di->inst_id);
571
572         if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) {
573                 srd_exception_catch("Protocol decoder instance %s: ",
574                                 di->inst_id);
575                 return SRD_ERR_PYTHON;
576         }
577         Py_DecRef(py_res);
578
579         /* Start all the PDs stacked on top of this one. */
580         for (l = di->next_di; l; l = l->next) {
581                 next_di = l->data;
582                 if ((ret = srd_inst_start(next_di)) != SRD_OK)
583                         return ret;
584         }
585
586         return SRD_OK;
587 }
588
589 /**
590  * Run the specified decoder function.
591  *
592  * @param di The decoder instance to call. Must not be NULL.
593  * @param start_samplenum The starting sample number for the buffer's sample
594  *                        set, relative to the start of capture.
595  * @param end_samplenum The ending sample number for the buffer's sample
596  *                        set, relative to the start of capture.
597  * @param inbuf The buffer to decode. Must not be NULL.
598  * @param inbuflen Length of the buffer. Must be > 0.
599  *
600  * @return SRD_OK upon success, a (negative) error code otherwise.
601  *
602  * @private
603  *
604  * @since 0.1.0
605  */
606 SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di,
607                 uint64_t start_samplenum, uint64_t end_samplenum,
608                 const uint8_t *inbuf, uint64_t inbuflen)
609 {
610         PyObject *py_res;
611         srd_logic *logic;
612
613         srd_dbg("Calling decode() on instance %s with %" PRIu64 " bytes "
614                 "starting at sample %" PRIu64 ".", di->inst_id, inbuflen,
615                 start_samplenum);
616
617         /* Return an error upon unusable input. */
618         if (!di) {
619                 srd_dbg("empty decoder instance");
620                 return SRD_ERR_ARG;
621         }
622         if (!inbuf) {
623                 srd_dbg("NULL buffer pointer");
624                 return SRD_ERR_ARG;
625         }
626         if (inbuflen == 0) {
627                 srd_dbg("empty buffer");
628                 return SRD_ERR_ARG;
629         }
630
631         /*
632          * Create new srd_logic object. Each iteration around the PD's loop
633          * will fill one sample into this object.
634          */
635         logic = PyObject_New(srd_logic, &srd_logic_type);
636         Py_INCREF(logic);
637         logic->di = (struct srd_decoder_inst *)di;
638         logic->start_samplenum = start_samplenum;
639         logic->itercnt = 0;
640         logic->inbuf = (uint8_t *)inbuf;
641         logic->inbuflen = inbuflen;
642         logic->sample = PyList_New(2);
643         Py_INCREF(logic->sample);
644
645         Py_IncRef(di->py_inst);
646         if (!(py_res = PyObject_CallMethod(di->py_inst, "decode",
647                         "KKO", start_samplenum, end_samplenum, logic))) {
648                 srd_exception_catch("Protocol decoder instance %s: ", di->inst_id);
649                 return SRD_ERR_PYTHON;
650         }
651         Py_DecRef(py_res);
652
653         return SRD_OK;
654 }
655
656 /** @private */
657 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
658 {
659         GSList *l;
660         struct srd_pd_output *pdo;
661
662         srd_dbg("Freeing instance %s", di->inst_id);
663
664         Py_DecRef(di->py_inst);
665         g_free(di->inst_id);
666         g_free(di->dec_probemap);
667         g_slist_free(di->next_di);
668         for (l = di->pd_output; l; l = l->next) {
669                 pdo = l->data;
670                 g_free(pdo->proto_id);
671                 g_free(pdo);
672         }
673         g_slist_free(di->pd_output);
674         g_free(di);
675 }
676
677 /** @private */
678 SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack)
679 {
680         GSList *l;
681         struct srd_decoder_inst *di;
682
683         if (session_is_valid(sess) != SRD_OK) {
684                 srd_err("Invalid session.");
685                 return;
686         }
687
688         di = NULL;
689         for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
690                 di = l->data;
691                 if (di->next_di)
692                         srd_inst_free_all(sess, di->next_di);
693                 srd_inst_free(di);
694         }
695         if (!stack) {
696                 g_slist_free(sess->di_list);
697                 sess->di_list = NULL;
698         }
699 }
700
701 /** @} */
702