From: Julien Desfossez Date: Tue, 31 Jan 2012 16:59:22 +0000 (-0500) Subject: API : iterator namespace cleanup X-Git-Tag: v0.9~9 X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=commitdiff_plain;h=e8c92a62cb474a1bb64bcbfff47c17291751b959 API : iterator namespace cleanup For coherence, rename babeltrace_iter to bt_iter, and trace_collection_pos to bt_iter_pos. Signed-off-by: Julien Desfossez Signed-off-by: Mathieu Desnoyers --- diff --git a/converter/babeltrace.c b/converter/babeltrace.c index f872e6dc..eb2bb146 100644 --- a/converter/babeltrace.c +++ b/converter/babeltrace.c @@ -482,36 +482,36 @@ error: int convert_trace(struct trace_descriptor *td_write, struct bt_context *ctx) { - struct babeltrace_iter *iter; + struct bt_iter *iter; struct ctf_stream *stream; struct ctf_stream_event *event; struct ctf_text_stream_pos *sout; - struct trace_collection_pos begin_pos; + struct bt_iter_pos begin_pos; int ret; sout = container_of(td_write, struct ctf_text_stream_pos, trace_descriptor); begin_pos.type = BT_SEEK_BEGIN; - iter = babeltrace_iter_create(ctx, &begin_pos, NULL); + iter = bt_iter_create(ctx, &begin_pos, NULL); if (!iter) { ret = -1; goto error_iter; } - while (babeltrace_iter_read_event(iter, &stream, &event) == 0) { + while (bt_iter_read_event(iter, &stream, &event) == 0) { ret = sout->parent.event_cb(&sout->parent, stream); if (ret) { fprintf(stderr, "[error] Writing event failed.\n"); goto end; } - ret = babeltrace_iter_next(iter); + ret = bt_iter_next(iter); if (ret < 0) goto end; } ret = 0; end: - babeltrace_iter_destroy(iter); + bt_iter_destroy(iter); error_iter: return ret; } diff --git a/include/babeltrace/babeltrace.h b/include/babeltrace/babeltrace.h index c37e846b..aacedaeb 100644 --- a/include/babeltrace/babeltrace.h +++ b/include/babeltrace/babeltrace.h @@ -23,7 +23,7 @@ typedef GQuark bt_event_name; /* Forward declarations */ -struct babeltrace_iter; +struct bt_iter; struct ctf_stream_event; struct ctf_stream; struct bt_dependencies; @@ -47,12 +47,12 @@ struct bt_dependencies *babeltrace_dependencies_create(const char *first, ...); /* * struct bt_dependencies must be destroyed explicitly if not passed as - * parameter to a babeltrace_iter_add_callback(). + * parameter to a bt_iter_add_callback(). */ void babeltrace_dependencies_destroy(struct bt_dependencies *dep); /* - * babeltrace_iter_add_callback: Add a callback to iterator. + * bt_iter_add_callback: Add a callback to iterator. * * @iter: trace collection iterator (input) * @event: event to target. 0 for all events. @@ -76,17 +76,17 @@ void babeltrace_dependencies_destroy(struct bt_dependencies *dep); * destroyed, but they belong to the babeltrace library. * * (note to implementor: we need to keep a gptrarray of struct - * bt_dependencies to "garbage collect" in struct babeltrace_iter, and + * bt_dependencies to "garbage collect" in struct bt_iter, and * dependencies need to have a refcount to handle the case where they * would be passed to more than one iterator. Upon iterator detroy, we * iterate on all the gc ptrarray and decrement the refcounts, freeing * if we reach 0.) * (note to implementor: we calculate the dependency graph when - * babeltrace_iter_read_event() is executed after a - * babeltrace_iter_add_callback(). Beware that it is valid to create/add + * bt_iter_read_event() is executed after a + * bt_iter_add_callback(). Beware that it is valid to create/add * callbacks/read/add more callbacks/read some more.) */ -int babeltrace_iter_add_callback(struct babeltrace_iter *iter, +int bt_iter_add_callback(struct bt_iter *iter, bt_event_name event, void *private_data, int flags, enum bt_cb_ret (*callback)(struct bt_ctf_data *ctf_data, void *caller_data), diff --git a/include/babeltrace/callbacks-internal.h b/include/babeltrace/callbacks-internal.h index 0f0e5378..65f62adb 100644 --- a/include/babeltrace/callbacks-internal.h +++ b/include/babeltrace/callbacks-internal.h @@ -49,7 +49,7 @@ struct bt_dependencies { int refcount; /* free when decremented to 0 */ }; -void process_callbacks(struct babeltrace_iter *iter, +void process_callbacks(struct bt_iter *iter, struct ctf_stream *stream); #endif /* _BABELTRACE_CALLBACKS_INTERNAL_H */ diff --git a/include/babeltrace/iterator-internal.h b/include/babeltrace/iterator-internal.h index 3410f926..9cbc79cf 100644 --- a/include/babeltrace/iterator-internal.h +++ b/include/babeltrace/iterator-internal.h @@ -22,20 +22,20 @@ */ /* - * struct babeltrace_iter: data structure representing an iterator on a trace + * struct bt_iter: data structure representing an iterator on a trace * collection. */ -struct babeltrace_iter { +struct bt_iter { struct ptr_heap *stream_heap; struct bt_context *ctx; - struct trace_collection_pos *end_pos; + struct bt_iter_pos *end_pos; GArray *callbacks; /* Array of struct bt_stream_callbacks */ struct bt_callback_chain main_callbacks; /* For all events */ /* * Flag indicating if dependency graph needs to be recalculated. - * Set by babeltrace_iter_add_callback(), and checked (and - * cleared) by upon entry into babeltrace_iter_read_event(). - * babeltrace_iter_read_event() is responsible for calling dep + * Set by bt_iter_add_callback(), and checked (and + * cleared) by upon entry into bt_iter_read_event(). + * bt_iter_read_event() is responsible for calling dep * graph calculation if it sees this flag set. */ int recalculate_dep_graph; @@ -43,7 +43,7 @@ struct babeltrace_iter { * Array of pointers to struct bt_dependencies, for garbage * collection. We're not using a linked list here because each * struct bt_dependencies can belong to more than one - * babeltrace_iter. + * bt_iter. */ GPtrArray *dep_gc; }; diff --git a/include/babeltrace/iterator.h b/include/babeltrace/iterator.h index df890f8d..1de2809b 100644 --- a/include/babeltrace/iterator.h +++ b/include/babeltrace/iterator.h @@ -21,12 +21,12 @@ #include /* Forward declarations */ -struct babeltrace_iter; +struct bt_iter; struct ctf_stream_event; struct ctf_stream; -struct babeltrace_saved_pos; +struct bt_saved_pos; -struct trace_collection_pos { +struct bt_iter_pos { enum { BT_SEEK_TIME, /* uses u.seek_time */ BT_SEEK_RESTORE, /* uses u.restore */ @@ -36,12 +36,12 @@ struct trace_collection_pos { } type; union { uint64_t seek_time; - struct babeltrace_saved_pos *restore; + struct bt_saved_pos *restore; } u; }; /* - * babeltrace_iter_create - Allocate a trace collection iterator. + * bt_iter_create - Allocate a trace collection iterator. * * begin_pos and end_pos are optional parameters to specify the position * at which the trace collection should be seeked upon iterator @@ -52,55 +52,55 @@ struct trace_collection_pos { * creation. By default, if end_pos is NULL, a BT_SEEK_END (end of * trace) is the EOF criterion. */ -struct babeltrace_iter *babeltrace_iter_create(struct bt_context *ctx, - struct trace_collection_pos *begin_pos, - struct trace_collection_pos *end_pos); +struct bt_iter *bt_iter_create(struct bt_context *ctx, + struct bt_iter_pos *begin_pos, + struct bt_iter_pos *end_pos); /* - * babeltrace_iter_destroy - Free a trace collection iterator. + * bt_iter_destroy - Free a trace collection iterator. */ -void babeltrace_iter_destroy(struct babeltrace_iter *iter); +void bt_iter_destroy(struct bt_iter *iter); /* - * babeltrace_iter_next: Move trace collection position to the next event. + * bt_iter_next: Move trace collection position to the next event. * * Returns 0 on success, a negative value on error */ -int babeltrace_iter_next(struct babeltrace_iter *iter); +int bt_iter_next(struct bt_iter *iter); /* - * babeltrace_iter_save_pos - Save the current trace collection position. + * bt_iter_save_pos - Save the current trace collection position. * * The position returned by this function needs to be freed by - * babeltrace_iter_free_pos after use. + * bt_iter_free_pos after use. */ -struct trace_collection_pos * - babeltrace_iter_save_pos(struct babeltrace_iter *iter); +struct bt_iter_pos * + bt_iter_save_pos(struct bt_iter *iter); /* - * babeltrace_iter_free_pos - Free the position. + * bt_iter_free_pos - Free the position. */ -void babeltrace_iter_free_pos(struct trace_collection_pos *pos); +void bt_iter_free_pos(struct bt_iter_pos *pos); /* - * babeltrace_iter_seek: seek iterator to given position. + * bt_iter_seek: seek iterator to given position. * * Return EOF if position is after the last event of the trace collection. * Return other negative value for other errors. * Return 0 for success. */ -int babeltrace_iter_seek(struct babeltrace_iter *iter, - const struct trace_collection_pos *pos); +int bt_iter_seek(struct bt_iter *iter, + const struct bt_iter_pos *pos); /* - * babeltrace_iter_read_event: Read the iterator's current event data. + * bt_iter_read_event: Read the iterator's current event data. * * @iter: trace collection iterator (input) * @stream: stream containing event at current position (output) * @event: current event (output) * Return 0 on success, negative error value on error. */ -int babeltrace_iter_read_event(struct babeltrace_iter *iter, +int bt_iter_read_event(struct bt_iter *iter, struct ctf_stream **stream, struct ctf_stream_event **event); diff --git a/lib/callbacks.c b/lib/callbacks.c index b3856ceb..aae8196f 100644 --- a/lib/callbacks.c +++ b/lib/callbacks.c @@ -57,9 +57,9 @@ struct bt_dependencies *babeltrace_dependencies_create(const char *first, ...) } /* - * babeltrace_iter_add_callback: Add a callback to iterator. + * bt_iter_add_callback: Add a callback to iterator. */ -int babeltrace_iter_add_callback(struct babeltrace_iter *iter, +int bt_iter_add_callback(struct bt_iter *iter, bt_event_name event, void *private_data, int flags, enum bt_cb_ret (*callback)(struct bt_ctf_data *ctf_data, void *private_data), @@ -168,7 +168,7 @@ struct ctf_stream_event *extract_ctf_stream_event(struct ctf_stream *stream) return event; } -void process_callbacks(struct babeltrace_iter *iter, +void process_callbacks(struct bt_iter *iter, struct ctf_stream *stream) { struct bt_stream_callbacks *bt_stream_cb; diff --git a/lib/iterator.c b/lib/iterator.c index 4b5b453f..4d201dc4 100644 --- a/lib/iterator.c +++ b/lib/iterator.c @@ -37,7 +37,7 @@ struct stream_saved_pos { ssize_t offset; /* offset from base, in bits. EOF for end of file. */ }; -struct babeltrace_saved_pos { +struct bt_saved_pos { struct trace_collection *tc; GArray *stream_saved_pos; /* Contains struct stream_saved_pos */ }; @@ -75,7 +75,7 @@ int stream_compare(void *a, void *b) * The stream_id parameter is only useful for BT_SEEK_RESTORE. */ static int babeltrace_filestream_seek(struct ctf_file_stream *file_stream, - const struct trace_collection_pos *begin_pos, + const struct bt_iter_pos *begin_pos, unsigned long stream_id) { int ret = 0; @@ -102,10 +102,10 @@ static int babeltrace_filestream_seek(struct ctf_file_stream *file_stream, } /* - * babeltrace_iter_seek: seek iterator to given position. + * bt_iter_seek: seek iterator to given position. */ -int babeltrace_iter_seek(struct babeltrace_iter *iter, - const struct trace_collection_pos *begin_pos) +int bt_iter_seek(struct bt_iter *iter, + const struct bt_iter_pos *begin_pos) { int i, stream_id; int ret = 0; @@ -142,15 +142,15 @@ end: return ret; } -struct babeltrace_iter *babeltrace_iter_create(struct bt_context *ctx, - struct trace_collection_pos *begin_pos, - struct trace_collection_pos *end_pos) +struct bt_iter *bt_iter_create(struct bt_context *ctx, + struct bt_iter_pos *begin_pos, + struct bt_iter_pos *end_pos) { int i, stream_id; int ret = 0; - struct babeltrace_iter *iter; + struct bt_iter *iter; - iter = malloc(sizeof(struct babeltrace_iter)); + iter = malloc(sizeof(struct bt_iter)); if (!iter) goto error_malloc; iter->stream_heap = g_new(struct ptr_heap, 1); @@ -220,7 +220,7 @@ error_malloc: return NULL; } -void babeltrace_iter_destroy(struct babeltrace_iter *iter) +void bt_iter_destroy(struct bt_iter *iter) { struct bt_stream_callbacks *bt_stream_cb; struct bt_callback_chain *bt_chain; @@ -254,7 +254,7 @@ void babeltrace_iter_destroy(struct babeltrace_iter *iter) free(iter); } -int babeltrace_iter_next(struct babeltrace_iter *iter) +int bt_iter_next(struct bt_iter *iter) { struct ctf_file_stream *file_stream, *removed; int ret; @@ -283,7 +283,7 @@ end: return ret; } -int babeltrace_iter_read_event(struct babeltrace_iter *iter, +int bt_iter_read_event(struct bt_iter *iter, struct ctf_stream **stream, struct ctf_stream_event **event) {