2 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
3 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to deal
7 * in the Software without restriction, including without limitation the rights
8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 * copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 #define BT_LOG_TAG "PLUGIN-TEXT-DMESG-SRC"
31 #include <babeltrace/assert-internal.h>
32 #include <babeltrace/common-internal.h>
33 #include <babeltrace/babeltrace.h>
34 #include <babeltrace/value-internal.h>
35 #include <babeltrace/compat/utc-internal.h>
36 #include <babeltrace/compat/stdio-internal.h>
39 #define NSEC_PER_USEC 1000UL
40 #define NSEC_PER_MSEC 1000000UL
41 #define NSEC_PER_SEC 1000000000ULL
42 #define USEC_PER_SEC 1000000UL
44 struct dmesg_component
;
46 struct dmesg_msg_iter
{
47 struct dmesg_component
*dmesg_comp
;
48 bt_self_message_iterator
*pc_msg_iter
; /* Weak */
52 bt_message
*tmp_event_msg
;
53 uint64_t last_clock_value
;
56 STATE_EMIT_STREAM_BEGINNING
,
57 STATE_EMIT_STREAM_ACTIVITY_BEGINNING
,
58 STATE_EMIT_PACKET_BEGINNING
,
60 STATE_EMIT_PACKET_END
,
61 STATE_EMIT_STREAM_ACTIVITY_END
,
62 STATE_EMIT_STREAM_END
,
67 struct dmesg_component
{
70 bt_bool read_from_stdin
;
74 bt_self_component_source
*self_comp
;
75 bt_trace_class
*trace_class
;
76 bt_stream_class
*stream_class
;
77 bt_event_class
*event_class
;
81 bt_clock_class
*clock_class
;
85 bt_field_class
*create_event_payload_fc(bt_trace_class
*trace_class
)
87 bt_field_class
*root_fc
= NULL
;
88 bt_field_class
*fc
= NULL
;
91 root_fc
= bt_field_class_structure_create(trace_class
);
93 BT_LOGE_STR("Cannot create an empty structure field class object.");
97 fc
= bt_field_class_string_create(trace_class
);
99 BT_LOGE_STR("Cannot create a string field class object.");
103 ret
= bt_field_class_structure_append_member(root_fc
,
106 BT_LOGE("Cannot add `str` member to structure field class: "
114 BT_FIELD_CLASS_PUT_REF_AND_RESET(root_fc
);
117 bt_field_class_put_ref(fc
);
122 int create_meta(struct dmesg_component
*dmesg_comp
, bool has_ts
)
124 bt_field_class
*fc
= NULL
;
127 dmesg_comp
->trace_class
= bt_trace_class_create(
128 bt_self_component_source_as_self_component(
129 dmesg_comp
->self_comp
));
130 if (!dmesg_comp
->trace_class
) {
131 BT_LOGE_STR("Cannot create an empty trace class object.");
135 dmesg_comp
->stream_class
= bt_stream_class_create(
136 dmesg_comp
->trace_class
);
137 if (!dmesg_comp
->stream_class
) {
138 BT_LOGE_STR("Cannot create a stream class object.");
143 dmesg_comp
->clock_class
= bt_clock_class_create(
144 dmesg_comp
->trace_class
);
145 if (!dmesg_comp
->clock_class
) {
146 BT_LOGE_STR("Cannot create clock class.");
151 * The `dmesg` timestamp is not absolute, it's relative
154 bt_clock_class_set_is_absolute(dmesg_comp
->clock_class
,
157 ret
= bt_stream_class_set_default_clock_class(
158 dmesg_comp
->stream_class
, dmesg_comp
->clock_class
);
160 BT_LOGE_STR("Cannot set stream class's default clock class.");
165 dmesg_comp
->event_class
= bt_event_class_create(
166 dmesg_comp
->stream_class
);
167 if (!dmesg_comp
->event_class
) {
168 BT_LOGE_STR("Cannot create an event class object.");
172 ret
= bt_event_class_set_name(dmesg_comp
->event_class
, "string");
174 BT_LOGE_STR("Cannot set event class's name.");
178 fc
= create_event_payload_fc(dmesg_comp
->trace_class
);
180 BT_LOGE_STR("Cannot create event payload field class.");
184 ret
= bt_event_class_set_payload_field_class(dmesg_comp
->event_class
, fc
);
186 BT_LOGE_STR("Cannot set event class's event payload field class.");
196 bt_field_class_put_ref(fc
);
201 int handle_params(struct dmesg_component
*dmesg_comp
,
202 const bt_value
*params
)
204 const bt_value
*no_timestamp
= NULL
;
205 const bt_value
*path
= NULL
;
206 const char *path_str
;
209 no_timestamp
= bt_value_map_borrow_entry_value_const(params
,
210 "no-extract-timestamp");
212 if (!bt_value_is_bool(no_timestamp
)) {
213 BT_LOGE("Expecting a boolean value for the `no-extract-timestamp` parameter: "
215 bt_common_value_type_string(
216 bt_value_get_type(no_timestamp
)));
220 dmesg_comp
->params
.no_timestamp
=
221 bt_value_bool_get(no_timestamp
);
224 path
= bt_value_map_borrow_entry_value_const(params
, "path");
226 if (dmesg_comp
->params
.read_from_stdin
) {
227 BT_LOGE_STR("Cannot specify both `read-from-stdin` and `path` parameters.");
231 if (!bt_value_is_string(path
)) {
232 BT_LOGE("Expecting a string value for the `path` parameter: "
234 bt_common_value_type_string(
235 bt_value_get_type(path
)));
239 path_str
= bt_value_string_get(path
);
240 g_string_assign(dmesg_comp
->params
.path
, path_str
);
242 dmesg_comp
->params
.read_from_stdin
= true;
255 int create_packet_and_stream_and_trace(struct dmesg_component
*dmesg_comp
)
258 const char *trace_name
= NULL
;
259 gchar
*basename
= NULL
;
261 dmesg_comp
->trace
= bt_trace_create(dmesg_comp
->trace_class
);
262 if (!dmesg_comp
->trace
) {
263 BT_LOGE_STR("Cannot create trace object.");
267 if (dmesg_comp
->params
.read_from_stdin
) {
268 trace_name
= "STDIN";
270 basename
= g_path_get_basename(dmesg_comp
->params
.path
->str
);
273 if (strcmp(basename
, G_DIR_SEPARATOR_S
) != 0 &&
274 strcmp(basename
, ".") != 0) {
275 trace_name
= basename
;
280 ret
= bt_trace_set_name(dmesg_comp
->trace
, trace_name
);
282 BT_LOGE("Cannot set trace's name: name=\"%s\"",
288 dmesg_comp
->stream
= bt_stream_create(dmesg_comp
->stream_class
,
290 if (!dmesg_comp
->stream
) {
291 BT_LOGE_STR("Cannot create stream object.");
295 dmesg_comp
->packet
= bt_packet_create(dmesg_comp
->stream
);
296 if (!dmesg_comp
->packet
) {
297 BT_LOGE_STR("Cannot create packet object.");
301 ret
= bt_trace_make_static(dmesg_comp
->trace
);
303 BT_LOGE_STR("Cannot make trace static.");
321 int try_create_meta_stream_packet(struct dmesg_component
*dmesg_comp
,
326 if (dmesg_comp
->trace
) {
327 /* Already created */
331 ret
= create_meta(dmesg_comp
, has_ts
);
333 BT_LOGE("Cannot create metadata objects: dmesg-comp-addr=%p",
338 ret
= create_packet_and_stream_and_trace(dmesg_comp
);
340 BT_LOGE("Cannot create packet and stream objects: "
341 "dmesg-comp-addr=%p", dmesg_comp
);
355 void destroy_dmesg_component(struct dmesg_component
*dmesg_comp
)
361 if (dmesg_comp
->params
.path
) {
362 g_string_free(dmesg_comp
->params
.path
, TRUE
);
365 bt_packet_put_ref(dmesg_comp
->packet
);
366 bt_trace_put_ref(dmesg_comp
->trace
);
367 bt_stream_class_put_ref(dmesg_comp
->stream_class
);
368 bt_event_class_put_ref(dmesg_comp
->event_class
);
369 bt_stream_put_ref(dmesg_comp
->stream
);
370 bt_clock_class_put_ref(dmesg_comp
->clock_class
);
371 bt_trace_class_put_ref(dmesg_comp
->trace_class
);
376 bt_self_component_status
create_port(
377 bt_self_component_source
*self_comp
)
379 return bt_self_component_source_add_output_port(self_comp
,
384 bt_self_component_status
dmesg_init(
385 bt_self_component_source
*self_comp
,
386 bt_value
*params
, void *init_method_data
)
389 struct dmesg_component
*dmesg_comp
= g_new0(struct dmesg_component
, 1);
390 bt_self_component_status status
= BT_SELF_COMPONENT_STATUS_OK
;
393 BT_LOGE_STR("Failed to allocate one dmesg component structure.");
397 dmesg_comp
->self_comp
= self_comp
;
398 dmesg_comp
->params
.path
= g_string_new(NULL
);
399 if (!dmesg_comp
->params
.path
) {
400 BT_LOGE_STR("Failed to allocate a GString.");
404 ret
= handle_params(dmesg_comp
, params
);
406 BT_LOGE("Invalid parameters: comp-addr=%p", self_comp
);
410 if (!dmesg_comp
->params
.read_from_stdin
&&
411 !g_file_test(dmesg_comp
->params
.path
->str
,
412 G_FILE_TEST_IS_REGULAR
)) {
413 BT_LOGE("Input path is not a regular file: "
414 "comp-addr=%p, path=\"%s\"", self_comp
,
415 dmesg_comp
->params
.path
->str
);
419 status
= create_port(self_comp
);
420 if (status
!= BT_SELF_COMPONENT_STATUS_OK
) {
424 bt_self_component_set_data(
425 bt_self_component_source_as_self_component(self_comp
),
430 destroy_dmesg_component(dmesg_comp
);
431 bt_self_component_set_data(
432 bt_self_component_source_as_self_component(self_comp
),
436 status
= BT_SELF_COMPONENT_STATUS_ERROR
;
444 void dmesg_finalize(bt_self_component_source
*self_comp
)
446 destroy_dmesg_component(bt_self_component_get_data(
447 bt_self_component_source_as_self_component(self_comp
)));
451 bt_message
*create_init_event_msg_from_line(
452 struct dmesg_msg_iter
*msg_iter
,
453 const char *line
, const char **new_start
)
456 bt_message
*msg
= NULL
;
457 bool has_timestamp
= false;
458 unsigned long sec
, usec
, msec
;
459 unsigned int year
, mon
, mday
, hour
, min
;
462 struct dmesg_component
*dmesg_comp
= msg_iter
->dmesg_comp
;
466 if (dmesg_comp
->params
.no_timestamp
) {
470 /* Extract time from input line */
471 if (sscanf(line
, "[%lu.%lu] ", &sec
, &usec
) == 2) {
472 ts
= (uint64_t) sec
* USEC_PER_SEC
+ (uint64_t) usec
;
475 * The clock class we use has a 1 GHz frequency: convert
479 has_timestamp
= true;
480 } else if (sscanf(line
, "[%u-%u-%u %u:%u:%lu.%lu] ",
481 &year
, &mon
, &mday
, &hour
, &min
,
486 memset(&ti
, 0, sizeof(ti
));
487 ti
.tm_year
= year
- 1900; /* From 1900 */
488 ti
.tm_mon
= mon
- 1; /* 0 to 11 */
494 ep_sec
= bt_timegm(&ti
);
495 if (ep_sec
!= (time_t) -1) {
496 ts
= (uint64_t) ep_sec
* NSEC_PER_SEC
497 + (uint64_t) msec
* NSEC_PER_MSEC
;
500 has_timestamp
= true;
504 /* Set new start for the message portion of the line */
505 *new_start
= strchr(line
, ']');
506 BT_ASSERT(*new_start
);
509 if ((*new_start
)[0] == ' ') {
516 * At this point, we know if the stream class's event header
517 * field class should have a timestamp or not, so we can lazily
518 * create the metadata, stream, and packet objects.
520 ret
= try_create_meta_stream_packet(dmesg_comp
, has_timestamp
);
522 /* try_create_meta_stream_packet() logs errors */
526 if (dmesg_comp
->clock_class
) {
527 msg
= bt_message_event_create_with_default_clock_snapshot(
528 msg_iter
->pc_msg_iter
,
529 dmesg_comp
->event_class
, dmesg_comp
->packet
, ts
);
530 msg_iter
->last_clock_value
= ts
;
532 msg
= bt_message_event_create(msg_iter
->pc_msg_iter
,
533 dmesg_comp
->event_class
, dmesg_comp
->packet
);
537 BT_LOGE_STR("Cannot create event message.");
541 event
= bt_message_event_borrow_event(msg
);
546 BT_MESSAGE_PUT_REF_AND_RESET(msg
);
553 int fill_event_payload_from_line(const char *line
,
556 bt_field
*ep_field
= NULL
;
557 bt_field
*str_field
= NULL
;
561 ep_field
= bt_event_borrow_payload_field(event
);
563 str_field
= bt_field_structure_borrow_member_field_by_index(
566 BT_LOGE_STR("Cannot borrow `timestamp` field from event payload structure field.");
571 if (line
[len
- 1] == '\n') {
572 /* Do not include the newline character in the payload */
576 ret
= bt_field_string_clear(str_field
);
578 BT_LOGE_STR("Cannot clear string field object.");
582 ret
= bt_field_string_append_with_length(str_field
, line
, len
);
584 BT_LOGE("Cannot append value to string field object: "
599 bt_message
*create_msg_from_line(
600 struct dmesg_msg_iter
*dmesg_msg_iter
, const char *line
)
602 bt_event
*event
= NULL
;
603 bt_message
*msg
= NULL
;
604 const char *new_start
;
607 msg
= create_init_event_msg_from_line(dmesg_msg_iter
,
610 BT_LOGE_STR("Cannot create and initialize event message from line.");
614 event
= bt_message_event_borrow_event(msg
);
616 ret
= fill_event_payload_from_line(new_start
, event
);
618 BT_LOGE("Cannot fill event payload field from line: "
626 BT_MESSAGE_PUT_REF_AND_RESET(msg
);
633 void destroy_dmesg_msg_iter(struct dmesg_msg_iter
*dmesg_msg_iter
)
635 if (!dmesg_msg_iter
) {
639 if (dmesg_msg_iter
->fp
&& dmesg_msg_iter
->fp
!= stdin
) {
640 if (fclose(dmesg_msg_iter
->fp
)) {
641 BT_LOGE_ERRNO("Cannot close input file", ".");
645 bt_message_put_ref(dmesg_msg_iter
->tmp_event_msg
);
646 free(dmesg_msg_iter
->linebuf
);
647 g_free(dmesg_msg_iter
);
651 bt_self_message_iterator_status
dmesg_msg_iter_init(
652 bt_self_message_iterator
*self_msg_iter
,
653 bt_self_component_source
*self_comp
,
654 bt_self_component_port_output
*self_port
)
656 struct dmesg_component
*dmesg_comp
;
657 struct dmesg_msg_iter
*dmesg_msg_iter
=
658 g_new0(struct dmesg_msg_iter
, 1);
659 bt_self_message_iterator_status status
=
660 BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
662 if (!dmesg_msg_iter
) {
663 BT_LOGE_STR("Failed to allocate on dmesg message iterator structure.");
667 dmesg_comp
= bt_self_component_get_data(
668 bt_self_component_source_as_self_component(self_comp
));
669 BT_ASSERT(dmesg_comp
);
670 dmesg_msg_iter
->dmesg_comp
= dmesg_comp
;
671 dmesg_msg_iter
->pc_msg_iter
= self_msg_iter
;
673 if (dmesg_comp
->params
.read_from_stdin
) {
674 dmesg_msg_iter
->fp
= stdin
;
676 dmesg_msg_iter
->fp
= fopen(dmesg_comp
->params
.path
->str
, "r");
677 if (!dmesg_msg_iter
->fp
) {
678 BT_LOGE_ERRNO("Cannot open input file in read mode", ": path=\"%s\"",
679 dmesg_comp
->params
.path
->str
);
684 bt_self_message_iterator_set_data(self_msg_iter
,
689 destroy_dmesg_msg_iter(dmesg_msg_iter
);
690 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
692 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
700 void dmesg_msg_iter_finalize(
701 bt_self_message_iterator
*priv_msg_iter
)
703 destroy_dmesg_msg_iter(bt_self_message_iterator_get_data(
708 bt_self_message_iterator_status
dmesg_msg_iter_next_one(
709 struct dmesg_msg_iter
*dmesg_msg_iter
,
713 struct dmesg_component
*dmesg_comp
;
714 bt_self_message_iterator_status status
=
715 BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
717 BT_ASSERT(dmesg_msg_iter
);
718 dmesg_comp
= dmesg_msg_iter
->dmesg_comp
;
719 BT_ASSERT(dmesg_comp
);
721 if (dmesg_msg_iter
->state
== STATE_DONE
) {
722 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_END
;
726 if (dmesg_msg_iter
->tmp_event_msg
||
727 dmesg_msg_iter
->state
== STATE_EMIT_PACKET_END
||
728 dmesg_msg_iter
->state
== STATE_EMIT_STREAM_ACTIVITY_END
||
729 dmesg_msg_iter
->state
== STATE_EMIT_STREAM_END
) {
735 bool only_spaces
= true;
737 len
= bt_getline(&dmesg_msg_iter
->linebuf
,
738 &dmesg_msg_iter
->linebuf_len
, dmesg_msg_iter
->fp
);
740 if (errno
== EINVAL
) {
741 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
742 } else if (errno
== ENOMEM
) {
744 BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM
;
746 if (dmesg_msg_iter
->state
== STATE_EMIT_STREAM_BEGINNING
) {
747 /* Stream did not even begin */
748 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_END
;
751 /* End current packet now */
752 dmesg_msg_iter
->state
=
753 STATE_EMIT_PACKET_END
;
761 BT_ASSERT(dmesg_msg_iter
->linebuf
);
763 /* Ignore empty lines, once trimmed */
764 for (ch
= dmesg_msg_iter
->linebuf
; *ch
!= '\0'; ch
++) {
776 dmesg_msg_iter
->tmp_event_msg
= create_msg_from_line(
777 dmesg_msg_iter
, dmesg_msg_iter
->linebuf
);
778 if (!dmesg_msg_iter
->tmp_event_msg
) {
779 BT_LOGE("Cannot create event message from line: "
780 "dmesg-comp-addr=%p, line=\"%s\"", dmesg_comp
,
781 dmesg_msg_iter
->linebuf
);
786 BT_ASSERT(dmesg_comp
->trace
);
788 switch (dmesg_msg_iter
->state
) {
789 case STATE_EMIT_STREAM_BEGINNING
:
790 BT_ASSERT(dmesg_msg_iter
->tmp_event_msg
);
791 *msg
= bt_message_stream_beginning_create(
792 dmesg_msg_iter
->pc_msg_iter
, dmesg_comp
->stream
);
793 dmesg_msg_iter
->state
= STATE_EMIT_STREAM_ACTIVITY_BEGINNING
;
795 case STATE_EMIT_STREAM_ACTIVITY_BEGINNING
:
796 BT_ASSERT(dmesg_msg_iter
->tmp_event_msg
);
797 *msg
= bt_message_stream_activity_beginning_create(
798 dmesg_msg_iter
->pc_msg_iter
, dmesg_comp
->stream
);
799 dmesg_msg_iter
->state
= STATE_EMIT_PACKET_BEGINNING
;
801 case STATE_EMIT_PACKET_BEGINNING
:
802 BT_ASSERT(dmesg_msg_iter
->tmp_event_msg
);
804 if (dmesg_comp
->clock_class
) {
805 *msg
= bt_message_packet_beginning_create_with_default_clock_snapshot(
806 dmesg_msg_iter
->pc_msg_iter
, dmesg_comp
->packet
,
807 dmesg_msg_iter
->last_clock_value
);
809 *msg
= bt_message_packet_beginning_create(
810 dmesg_msg_iter
->pc_msg_iter
, dmesg_comp
->packet
);
813 dmesg_msg_iter
->state
= STATE_EMIT_EVENT
;
815 case STATE_EMIT_EVENT
:
816 BT_ASSERT(dmesg_msg_iter
->tmp_event_msg
);
817 *msg
= dmesg_msg_iter
->tmp_event_msg
;
818 dmesg_msg_iter
->tmp_event_msg
= NULL
;
820 case STATE_EMIT_PACKET_END
:
821 if (dmesg_comp
->clock_class
) {
822 *msg
= bt_message_packet_end_create_with_default_clock_snapshot(
823 dmesg_msg_iter
->pc_msg_iter
, dmesg_comp
->packet
,
824 dmesg_msg_iter
->last_clock_value
);
826 *msg
= bt_message_packet_end_create(
827 dmesg_msg_iter
->pc_msg_iter
, dmesg_comp
->packet
);
830 dmesg_msg_iter
->state
= STATE_EMIT_STREAM_ACTIVITY_END
;
832 case STATE_EMIT_STREAM_ACTIVITY_END
:
833 *msg
= bt_message_stream_activity_end_create(
834 dmesg_msg_iter
->pc_msg_iter
, dmesg_comp
->stream
);
835 dmesg_msg_iter
->state
= STATE_EMIT_STREAM_END
;
837 case STATE_EMIT_STREAM_END
:
838 *msg
= bt_message_stream_end_create(
839 dmesg_msg_iter
->pc_msg_iter
, dmesg_comp
->stream
);
840 dmesg_msg_iter
->state
= STATE_DONE
;
847 BT_LOGE("Cannot create message: dmesg-comp-addr=%p",
849 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
857 bt_self_message_iterator_status
dmesg_msg_iter_next(
858 bt_self_message_iterator
*self_msg_iter
,
859 bt_message_array_const msgs
, uint64_t capacity
,
862 struct dmesg_msg_iter
*dmesg_msg_iter
=
863 bt_self_message_iterator_get_data(
865 bt_self_message_iterator_status status
=
866 BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
869 while (i
< capacity
&&
870 status
== BT_SELF_MESSAGE_ITERATOR_STATUS_OK
) {
871 bt_message
*priv_msg
= NULL
;
873 status
= dmesg_msg_iter_next_one(dmesg_msg_iter
,
876 if (status
== BT_SELF_MESSAGE_ITERATOR_STATUS_OK
) {
883 * Even if dmesg_msg_iter_next_one() returned
884 * something else than
885 * BT_SELF_MESSAGE_ITERATOR_STATUS_OK, we
886 * accumulated message objects in the output
887 * message array, so we need to return
888 * BT_SELF_MESSAGE_ITERATOR_STATUS_OK so that they
889 * are transfered to downstream. This other status
890 * occurs again the next time muxer_msg_iter_do_next()
891 * is called, possibly without any accumulated
892 * message, in which case we'll return it.
895 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;