lib: add internal object pool API and use it; adapt plugins/tests
[babeltrace.git] / include / babeltrace / babeltrace.h
index c37e846b45179b6bd0c34f874d548c8be4705c3a..cd910280777577f8f879f35c0f8f1b6ce6c79124 100644 (file)
@@ -1,10 +1,10 @@
-#ifndef _BABELTRACE_H
-#define _BABELTRACE_H
+#ifndef BABELTRACE_BABELTRACE_H
+#define BABELTRACE_BABELTRACE_H
 
 /*
- * BabelTrace API
+ * Babeltrace API
  *
- * Copyright 2010-2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright 2010-2017 EfficiOS Inc. <http://www.efficios.com/>
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  *
  * 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.
  */
 
-#include <glib.h>
-#include <babeltrace/format.h>
-
-typedef GQuark bt_event_name;
+/* Core API */
+#include <babeltrace/logging.h>
+#include <babeltrace/ref.h>
+#include <babeltrace/types.h>
+#include <babeltrace/values.h>
+#include <babeltrace/version.h>
 
-/* Forward declarations */
-struct babeltrace_iter;
-struct ctf_stream_event;
-struct ctf_stream;
-struct bt_dependencies;
+/* Legacy API (for CTF writer) */
+#include <babeltrace/ctf/events.h>
 
-enum bt_cb_ret {
-       BT_CB_OK                = 0,
-       BT_CB_OK_STOP           = 1,
-       BT_CB_ERROR_STOP        = 2,
-       BT_CB_ERROR_CONTINUE    = 3,
-};
+/* CTF writer API */
+#include <babeltrace/ctf-writer/clock-class.h>
+#include <babeltrace/ctf-writer/clock.h>
+#include <babeltrace/ctf-writer/event-fields.h>
+#include <babeltrace/ctf-writer/event-types.h>
+#include <babeltrace/ctf-writer/event.h>
+#include <babeltrace/ctf-writer/field-types.h>
+#include <babeltrace/ctf-writer/fields.h>
+#include <babeltrace/ctf-writer/stream-class.h>
+#include <babeltrace/ctf-writer/stream.h>
+#include <babeltrace/ctf-writer/trace.h>
+#include <babeltrace/ctf-writer/writer.h>
 
-struct bt_ctf_data {
-       struct ctf_stream_event *event;
-       struct ctf_stream *stream;
-};
-
-/*
- * Receives a variable number of strings as parameter, ended with NULL.
- */
-struct bt_dependencies *babeltrace_dependencies_create(const char *first, ...);
+/* CTF IR API */
+#include <babeltrace/ctf-ir/clock-class.h>
+#include <babeltrace/ctf-ir/clock-value.h>
+#include <babeltrace/ctf-ir/clock.h>
+#include <babeltrace/ctf-ir/event-class.h>
+#include <babeltrace/ctf-ir/event-header-field.h>
+#include <babeltrace/ctf-ir/event.h>
+#include <babeltrace/ctf-ir/field-path.h>
+#include <babeltrace/ctf-ir/field-types.h>
+#include <babeltrace/ctf-ir/fields.h>
+#include <babeltrace/ctf-ir/packet-context-field.h>
+#include <babeltrace/ctf-ir/packet-header-field.h>
+#include <babeltrace/ctf-ir/packet.h>
+#include <babeltrace/ctf-ir/stream-class.h>
+#include <babeltrace/ctf-ir/stream.h>
+#include <babeltrace/ctf-ir/trace.h>
+#include <babeltrace/ctf-ir/utils.h>
+#include <babeltrace/ctf-ir/visitor.h>
 
-/*
- * struct bt_dependencies must be destroyed explicitly if not passed as
- * parameter to a babeltrace_iter_add_callback().
- */
-void babeltrace_dependencies_destroy(struct bt_dependencies *dep);
+/* Plugin and plugin development API */
+#include <babeltrace/plugin/plugin-dev.h>
+#include <babeltrace/plugin/plugin.h>
 
-/*
- * babeltrace_iter_add_callback: Add a callback to iterator.
- *
- * @iter: trace collection iterator (input)
- * @event: event to target. 0 for all events.
- * @private_data: private data pointer to pass to the callback
- * @flags: specific flags controlling the behavior of this callback
- *         (or'd).
- *            
- * @callback: function pointer to call
- * @depends: struct bt_dependency detailing the required computation results.
- *           Ends with 0.
- * @weak_depends: struct bt_dependency detailing the optional computation
- *                results that can be optionally consumed by this
- *                callback.
- * @provides: struct bt_dependency detailing the computation results
- *            provided by this callback.
- *            Ends with 0.
- *
- * "depends", "weak_depends" and "provides" memory is handled by the
- * babeltrace library after this call succeeds or fails. These objects
- * can still be used by the caller until the babeltrace iterator is
- * 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
- * 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
- * callbacks/read/add more callbacks/read some more.)
- */
-int babeltrace_iter_add_callback(struct babeltrace_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),
-               struct bt_dependencies *depends,
-               struct bt_dependencies *weak_depends,
-               struct bt_dependencies *provides);
-
-/*
- * For flags parameter above.
- */
-enum {
-       BT_FLAGS_FREE_PRIVATE_DATA      = (1 << 0),
-};
+/* Graph, component, and notification API */
+#include <babeltrace/graph/clock-class-priority-map.h>
+#include <babeltrace/graph/component-class-filter.h>
+#include <babeltrace/graph/component-class-sink.h>
+#include <babeltrace/graph/component-class-source.h>
+#include <babeltrace/graph/component-class.h>
+#include <babeltrace/graph/component-filter.h>
+#include <babeltrace/graph/component-sink.h>
+#include <babeltrace/graph/component-source.h>
+#include <babeltrace/graph/component-status.h>
+#include <babeltrace/graph/component.h>
+#include <babeltrace/graph/connection.h>
+#include <babeltrace/graph/graph.h>
+#include <babeltrace/graph/notification-discarded-events.h>
+#include <babeltrace/graph/notification-discarded-packets.h>
+#include <babeltrace/graph/notification-event.h>
+#include <babeltrace/graph/notification-heap.h>
+#include <babeltrace/graph/notification-inactivity.h>
+#include <babeltrace/graph/notification-iterator.h>
+#include <babeltrace/graph/notification-packet.h>
+#include <babeltrace/graph/notification-stream.h>
+#include <babeltrace/graph/notification.h>
+#include <babeltrace/graph/output-port-notification-iterator.h>
+#include <babeltrace/graph/port.h>
+#include <babeltrace/graph/private-component-filter.h>
+#include <babeltrace/graph/private-component-sink.h>
+#include <babeltrace/graph/private-component-source.h>
+#include <babeltrace/graph/private-component.h>
+#include <babeltrace/graph/private-connection-notification-iterator.h>
+#include <babeltrace/graph/private-connection-private-notification-iterator.h>
+#include <babeltrace/graph/private-connection.h>
+#include <babeltrace/graph/private-port.h>
+#include <babeltrace/graph/query-executor.h>
 
-#endif /* _BABELTRACE_H */
+#endif /* BABELTRACE_BABELTRACE_H */
This page took 0.025692 seconds and 4 git commands to generate.