/usr/include/babeltrace/ctf-ir/stream-class.h is in libbabeltrace-dev 1.5.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 | #ifndef BABELTRACE_CTF_IR_STREAM_CLASS_H
#define BABELTRACE_CTF_IR_STREAM_CLASS_H
/*
* BabelTrace - CTF IR: Stream Class
*
* Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
*
* Author: Jérémie Galarneau <jeremie.galarneau@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
* 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 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.
*
* The Common Trace Format (CTF) Specification is available at
* http://www.efficios.com/ctf
*/
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
struct bt_ctf_event_class;
struct bt_ctf_stream_class;
struct bt_ctf_clock;
/*
* bt_ctf_stream_class_create: create a stream class.
*
* Allocate a new stream class of the given name. The creation of an event class
* sets its reference count to 1.
*
* A stream class' packet context is a structure initialized with the following
* fields:
* - uint64_t timestamp_begin
* - uint64_t timestamp_end
* - uint64_t content_size
* - uint64_t packet_size
* - uint64_t events_discarded
*
* A stream class's event header is a structure initialized the following
* fields:
* - uint32_t id
* - uint64_t timestamp
*
* @param name Stream name, NULL to create an unnamed stream class.
*
* Returns an allocated stream class on success, NULL on error.
*/
extern struct bt_ctf_stream_class *bt_ctf_stream_class_create(const char *name);
/*
* bt_ctf_stream_class_set_clock: assign a clock to a stream class.
*
* Add an event class to a stream class. New events can be added even after a
* stream has beem instanciated and events have been appended. However, a stream
* will not accept events of a class that has not been registered beforehand.
* The stream class will share the ownership of "event_class" by incrementing
* its reference count.
*
* Note that an event class may only be added to one stream class. It
* also becomes immutable.
*
* @param stream_class Stream class.
* @param event_class Event class to add to the provided stream class.
*
* Returns 0 on success, a negative value on error.
*/
extern int bt_ctf_stream_class_add_event_class(
struct bt_ctf_stream_class *stream_class,
struct bt_ctf_event_class *event_class);
/*
* bt_ctf_stream_class_get_packet_context_type: get the stream class' packet
* context type.
*
* @param stream_class Stream class.
*
* Returns the packet context's type (a structure), NULL on error.
*/
extern struct bt_ctf_field_type *bt_ctf_stream_class_get_packet_context_type(
struct bt_ctf_stream_class *stream_class);
#ifdef __cplusplus
}
#endif
#endif /* BABELTRACE_CTF_IR_STREAM_CLASS_H */
|