X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=include%2Fbabeltrace%2Fcontext.h;h=2ef85e2d90bed4d29b0be53c456984ca37b644fa;hp=738a8432c61be0c003742225abbe6ea405884401;hb=c462e188f3e7819c7bc74f671038cdbf36e8c3c0;hpb=181a49809955b9d28ec2e6d6db4e48af0c366326 diff --git a/include/babeltrace/context.h b/include/babeltrace/context.h index 738a8432..2ef85e2d 100644 --- a/include/babeltrace/context.h +++ b/include/babeltrace/context.h @@ -21,26 +21,27 @@ * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. */ -struct trace_collection; -struct GHashTable; +#include +#include -/* - * The context represents the object in which a trace_collection is - * open. As long as this structure is allocated, the trace_collection is - * open and the traces it contains can be read and seeked by the - * iterators and callbacks. - * - * It has to be created with the bt_context_create() function and - * destroyed by calling one more bt_context_put() than bt_context_get() - */ -struct bt_context { - struct trace_collection *tc; - GHashTable *trace_handles; - int refcount; - int last_trace_handle_id; -}; +#ifdef __cplusplus +extern "C" { +#endif + +/* struct bt_context is opaque to the user */ +struct bt_context; +struct stream_pos; +struct bt_ctf_event; /* * bt_context_create : create a Babeltrace context @@ -55,30 +56,44 @@ struct bt_context *bt_context_create(void); /* * bt_context_add_trace : Add a trace by path to the context * - * Open a trace + * Open a trace. * - * Return the trace handle id of the opened trace - */ -int bt_context_add_trace(struct bt_context *ctx, const char *path, - const char *format); - -/* - * bt_context_add_traces: Open a trace recursively + * path is the path to the trace, it is not recursive. If "path" is NULL, + * stream_list is used instead as a list of mmap streams to open for the trace. * - * Find each trace present in the subdirectory starting from the given - * path, and add them to the context. + * format is a string containing the format name in which the trace was + * produced. * - * Return: 0 on success, nonzero on failure. + * packet_seek can be NULL to use the default packet_seek handler provided by + * the trace format. If non-NULL, it is used as an override of the handler for + * seeks across packets. It takes as parameter a stream position, the packet + * index it needs to seek to (for SEEK_SET), and a "whence" parameter (either + * SEEK_CUR: seek to next packet, or SEEK_SET: seek to packet at packet index). + * + * stream_list is a linked list of streams, it is used to open a trace where + * the trace data is located in memory mapped areas instead of trace files, + * this argument should be set to NULL when path is NULL. + * + * The metadata parameter acts as a metadata override when not NULL, otherwise + * the format handles the metadata opening. + * + * Return: the trace handle id (>= 0) on success, a negative + * value on error. */ -int bt_context_add_traces(struct bt_context *ctx, const char *path, - const char *format); +int bt_context_add_trace(struct bt_context *ctx, const char *path, + const char *format, + void (*packet_seek)(struct stream_pos *pos, + size_t index, int whence), + struct mmap_stream_list *stream_list, + FILE *metadata); /* * bt_context_remove_trace: Remove a trace from the context. * - * Effectively closing the trace. + * Effectively closing the trace. Return negative error value if trace + * is not in context. */ -void bt_context_remove_trace(struct bt_context *ctx, int trace_id); +int bt_context_remove_trace(struct bt_context *ctx, int trace_id); /* * bt_context_get and bt_context_put : increments and decrement the @@ -95,4 +110,15 @@ void bt_context_remove_trace(struct bt_context *ctx, int trace_id); void bt_context_get(struct bt_context *ctx); void bt_context_put(struct bt_context *ctx); +/* + * bt_ctf_get_context : get the context associated with an event + * + * Returns NULL on error + */ +struct bt_context *bt_ctf_event_get_context(const struct bt_ctf_event *event); + +#ifdef __cplusplus +} +#endif + #endif /* _BABELTRACE_CONTEXT_H */