| 1 | #ifndef BABELTRACE_CTF_WRITER_WRITER_H |
| 2 | #define BABELTRACE_CTF_WRITER_WRITER_H |
| 3 | |
| 4 | /* |
| 5 | * BabelTrace - CTF Writer: Writer |
| 6 | * |
| 7 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 8 | * |
| 9 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 10 | * |
| 11 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 12 | * of this software and associated documentation files (the "Software"), to deal |
| 13 | * in the Software without restriction, including without limitation the rights |
| 14 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 15 | * copies of the Software, and to permit persons to whom the Software is |
| 16 | * furnished to do so, subject to the following conditions: |
| 17 | * |
| 18 | * The above copyright notice and this permission notice shall be included in |
| 19 | * all copies or substantial portions of the Software. |
| 20 | * |
| 21 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 22 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 23 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 24 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 25 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 26 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 27 | * SOFTWARE. |
| 28 | * |
| 29 | * The Common Trace Format (CTF) Specification is available at |
| 30 | * http://www.efficios.com/ctf |
| 31 | */ |
| 32 | |
| 33 | #include <babeltrace/ctf-ir/event-types.h> |
| 34 | #include <babeltrace/ctf-ir/trace.h> |
| 35 | |
| 36 | #ifdef __cplusplus |
| 37 | extern "C" { |
| 38 | #endif |
| 39 | |
| 40 | struct bt_ctf_writer; |
| 41 | struct bt_ctf_stream; |
| 42 | struct bt_ctf_stream_class; |
| 43 | struct bt_ctf_clock; |
| 44 | |
| 45 | /* |
| 46 | * bt_ctf_writer_create: create a writer instance. |
| 47 | * |
| 48 | * Allocate a new writer that will produce a trace in the given path. |
| 49 | * The creation of a writer sets its reference count to 1. |
| 50 | * |
| 51 | * @param path Path to the trace's containing folder (string is copied). |
| 52 | * |
| 53 | * Returns an allocated writer on success, NULL on error. |
| 54 | */ |
| 55 | extern struct bt_ctf_writer *bt_ctf_writer_create(const char *path); |
| 56 | |
| 57 | /* |
| 58 | * bt_ctf_writer_get_trace: Get a writer's associated trace. |
| 59 | * |
| 60 | * @param writer Writer instance. |
| 61 | * |
| 62 | * Return the writer's associated instance, NULL on error. |
| 63 | */ |
| 64 | extern struct bt_ctf_trace *bt_ctf_writer_get_trace( |
| 65 | struct bt_ctf_writer *writer); |
| 66 | |
| 67 | /* |
| 68 | * bt_ctf_writer_create_stream: create a stream instance. |
| 69 | * |
| 70 | * Allocate a new stream instance and register it to the writer. The creation of |
| 71 | * a stream sets its reference count to 1. |
| 72 | * |
| 73 | * @param writer Writer instance. |
| 74 | * @param stream_class Stream class to instantiate. |
| 75 | * |
| 76 | * Returns an allocated stream on success, NULL on error. |
| 77 | */ |
| 78 | extern struct bt_ctf_stream *bt_ctf_writer_create_stream( |
| 79 | struct bt_ctf_writer *writer, |
| 80 | struct bt_ctf_stream_class *stream_class); |
| 81 | |
| 82 | /* |
| 83 | * bt_ctf_writer_add_environment_field: add an environment field to the trace. |
| 84 | * |
| 85 | * Add an environment field to the trace. The name and value parameters are |
| 86 | * copied. |
| 87 | * |
| 88 | * @param writer Writer instance. |
| 89 | * @param name Name of the environment field (will be copied). |
| 90 | * @param value Value of the environment field (will be copied). |
| 91 | * |
| 92 | * Returns 0 on success, a negative value on error. |
| 93 | */ |
| 94 | extern int bt_ctf_writer_add_environment_field(struct bt_ctf_writer *writer, |
| 95 | const char *name, |
| 96 | const char *value); |
| 97 | |
| 98 | /* |
| 99 | * bt_ctf_writer_add_clock: add a clock to the trace. |
| 100 | * |
| 101 | * Add a clock to the trace. Clocks assigned to stream classes must be |
| 102 | * registered to the writer. |
| 103 | * |
| 104 | * @param writer Writer instance. |
| 105 | * @param clock Clock to add to the trace. |
| 106 | * |
| 107 | * Returns 0 on success, a negative value on error. |
| 108 | */ |
| 109 | extern int bt_ctf_writer_add_clock(struct bt_ctf_writer *writer, |
| 110 | struct bt_ctf_clock *clock); |
| 111 | |
| 112 | /* |
| 113 | * bt_ctf_writer_get_metadata_string: get meta-data string. |
| 114 | * |
| 115 | * Get the trace's TSDL meta-data. The caller assumes the ownership of the |
| 116 | * returned string. |
| 117 | * |
| 118 | * @param writer Writer instance. |
| 119 | * |
| 120 | * Returns the metadata string on success, NULL on error. |
| 121 | */ |
| 122 | extern char *bt_ctf_writer_get_metadata_string(struct bt_ctf_writer *writer); |
| 123 | |
| 124 | /* |
| 125 | * bt_ctf_writer_flush_metadata: flush the trace's metadata to disk. |
| 126 | * |
| 127 | * Flush the trace's metadata to the metadata file. Note that the metadata will |
| 128 | * be flushed automatically when the Writer instance is released (last call to |
| 129 | * bt_ctf_writer_put). |
| 130 | * |
| 131 | * @param writer Writer instance. |
| 132 | */ |
| 133 | extern void bt_ctf_writer_flush_metadata(struct bt_ctf_writer *writer); |
| 134 | |
| 135 | /* |
| 136 | * bt_ctf_writer_set_byte_order: set a field type's byte order. |
| 137 | * |
| 138 | * Set the trace's byte order. Defaults to the host machine's endianness. |
| 139 | * |
| 140 | * @param writer Writer instance. |
| 141 | * @param byte_order Trace's byte order. |
| 142 | * |
| 143 | * Returns 0 on success, a negative value on error. |
| 144 | * |
| 145 | * Note: byte_order must not be BT_CTF_BYTE_ORDER_NATIVE since, according |
| 146 | * to the CTF specification, is defined as "the byte order described in the |
| 147 | * trace description". |
| 148 | */ |
| 149 | extern int bt_ctf_writer_set_byte_order(struct bt_ctf_writer *writer, |
| 150 | enum bt_ctf_byte_order byte_order); |
| 151 | |
| 152 | /* |
| 153 | * bt_ctf_writer_get and bt_ctf_writer_put: increment and decrement the |
| 154 | * writer's reference count. |
| 155 | * |
| 156 | * You may also use bt_ctf_get() and bt_ctf_put() with writer objects. |
| 157 | * |
| 158 | * These functions ensure that the writer won't be destroyed while it |
| 159 | * is in use. The same number of get and put (plus one extra put to |
| 160 | * release the initial reference done at creation) have to be done to |
| 161 | * destroy a writer. |
| 162 | * |
| 163 | * When the writer's reference count is decremented to 0 by a |
| 164 | * bt_ctf_writer_put, the writer is freed. |
| 165 | * |
| 166 | * @param writer Writer instance. |
| 167 | */ |
| 168 | extern void bt_ctf_writer_get(struct bt_ctf_writer *writer); |
| 169 | extern void bt_ctf_writer_put(struct bt_ctf_writer *writer); |
| 170 | |
| 171 | #ifdef __cplusplus |
| 172 | } |
| 173 | #endif |
| 174 | |
| 175 | #endif /* BABELTRACE_CTF_WRITER_WRITER_H */ |