X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=include%2Fbabeltrace%2Fcontext.h;h=32282cf4cc7acb7f91e275da6bbb7f852257751a;hp=55fe2313034db84476a1976fd7b2a3acbd084b12;hb=20d24215ef299a387abac4850f82359de8a86f4d;hpb=b469d2dd9c6770cbdce9304dbb0e2c7ed8304b2a diff --git a/include/babeltrace/context.h b/include/babeltrace/context.h index 55fe2313..32282cf4 100644 --- a/include/babeltrace/context.h +++ b/include/babeltrace/context.h @@ -11,66 +11,61 @@ * Author: Mathieu Desnoyers * Julien Desfossez * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. */ -struct trace_collection; +/* struct bt_context is opaque to the user */ +struct bt_context; /* - * 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. + * bt_context_create : create a Babeltrace context + * + * Allocate a new context. The creation of the context sets the refcount + * to 1. * - * It has to be created with the bt_context_create() function and destroyed by - * bt_context_destroy() + * Returns an allocated context on success and NULL on error */ -struct bt_context { - struct trace_collection *tc; - int refcount; -}; +struct bt_context *bt_context_create(void); /* - * bt_context_create : create a Babeltrace context + * bt_context_add_trace : Add a trace by path to the context * - * Allocate a new context and assign the trace_collection passed in - * parameter as the context trace_collection. The trace_collection - * must contain an array of valid trace_descriptors. The creation of - * the context sets the refcount to 1. + * Open a trace * - * Returns an allocated context on success and NULL on error + * Return: 0 on success, nonzero on failure. */ -struct bt_context *bt_context_create(struct trace_collection *tc); +int bt_context_add_trace(struct bt_context *ctx, const char *path, + const char *format); /* - * bt_context_destroy : destroy a context + * bt_context_remove_trace: Remove a trace from the context. * - * If the context is still in use (by an iterator or a callback), the - * destroy fails and returns -1, on success : return 0. + * Effectively closing the trace. */ -int bt_context_destroy(struct bt_context *ctx); +void bt_context_remove_trace(struct bt_context *ctx, int trace_id); /* - * bt_context_get and bt_context_put : increments and decrement the refcount of - * the context + * bt_context_get and bt_context_put : increments and decrement the + * refcount of the context * - * These functions ensures that the context won't be destroyed when it is in - * use. The same number of get and put has to be done to be able to destroy a - * context. + * These functions ensures that the context won't be destroyed when it + * is in use. The same number of get and put (plus one extra put to + * release the initial reference done at creation) has to be done to + * destroy a context. * - * Return 0 on success, -1 if the context pointer is invalid. When the context - * refcount is decremented to 0 by a bt_context_put, it calls - * bt_context_destroy to free the context. In this case the return code of - * bt_context_destroy is returned. + * When the context refcount is decremented to 0 by a bt_context_put, + * the context is freed. */ -int bt_context_get(struct bt_context *ctx); -int bt_context_put(struct bt_context *ctx); +void bt_context_get(struct bt_context *ctx); +void bt_context_put(struct bt_context *ctx); #endif /* _BABELTRACE_CONTEXT_H */