LTTng control library C API
Loading...
Searching...
No Matches
stream-info.h
1/*
2 * SPDX-FileCopyrightText: 2025 Jérémie Galarneau <jeremie.galarneau@efficios.com>
3 *
4 * SPDX-License-Identifier: LGPL-2.1-only
5 *
6 */
7
8#ifndef LTTNG_STREAM_INFO_H
9#define LTTNG_STREAM_INFO_H
10
11#include <lttng/domain.h>
12#include <lttng/lttng-error.h>
13#include <lttng/lttng-export.h>
14
15#ifdef __cplusplus
16extern "C" {
17#endif
18
31
43
63
93extern LTTNG_EXPORT enum lttng_data_stream_info_status
95 unsigned int *cpu_id);
96
117extern LTTNG_EXPORT enum lttng_data_stream_info_status
119 uint64_t *value);
120
121extern LTTNG_EXPORT enum lttng_data_stream_info_status
122lttng_data_stream_info_get_max_memory_usage(const struct lttng_data_stream_info *stream_info,
123 uint64_t *value);
124
132
156extern LTTNG_EXPORT enum lttng_data_stream_info_status
158 unsigned int *count);
159
190extern LTTNG_EXPORT enum lttng_data_stream_info_status
192 unsigned int index,
193 const struct lttng_data_stream_info **stream_info);
194
223extern LTTNG_EXPORT enum lttng_data_stream_info_status
225
246extern LTTNG_EXPORT enum lttng_data_stream_info_status
248 enum lttng_app_bitness *bitness);
249
277extern LTTNG_EXPORT enum lttng_data_stream_info_status
279
287
312extern LTTNG_EXPORT enum lttng_data_stream_info_status
314 unsigned int *count);
315
347extern LTTNG_EXPORT enum lttng_data_stream_info_status
349 unsigned int index,
350 const struct lttng_data_stream_info_set **set);
351
363extern LTTNG_EXPORT void
365
367
387
433 const char *channel_name,
434 enum lttng_domain_type domain,
435 const struct lttng_data_stream_info_sets **sets);
436
437#ifdef __cplusplus
438}
439#endif
440
441#endif /* LTTNG_STREAM_INFO_H */
void lttng_data_stream_info_sets_destroy(const struct lttng_data_stream_info_sets *sets)
Destroys the set of data stream info sets sets.
lttng_app_bitness
Bitness of an instrumented application.
Definition stream-info.h:36
enum lttng_data_stream_info_status lttng_data_stream_info_set_get_at_index(const struct lttng_data_stream_info_set *set, unsigned int index, const struct lttng_data_stream_info **stream_info)
Sets *stream_info to the data stream info at the index index in the data stream info set set.
enum lttng_data_stream_info_status lttng_data_stream_info_sets_get_count(const struct lttng_data_stream_info_sets *sets, unsigned int *count)
Sets *count to the number of data stream info sets in the set of data stream info sets sets.
enum lttng_data_stream_info_status lttng_data_stream_info_sets_get_at_index(const struct lttng_data_stream_info_sets *sets, unsigned int index, const struct lttng_data_stream_info_set **set)
Sets *set to the data stream info set at the index index in the set of data stream info sets sets.
enum lttng_data_stream_info_status lttng_data_stream_info_get_memory_usage(const struct lttng_data_stream_info *stream_info, uint64_t *value)
Sets *value to the current memory usage (bytes) of the data stream info stream_info.
enum lttng_data_stream_info_status lttng_data_stream_info_get_cpu_id(const struct lttng_data_stream_info *stream_info, unsigned int *cpu_id)
Sets *cpu_id to the CPU ID of the data stream info stream_info.
enum lttng_data_stream_info_status lttng_data_stream_info_set_get_uid(const struct lttng_data_stream_info_set *set, uid_t *uid)
Sets *uid to the Unix user ID of the owner of the data streams of the data stream info set set.
enum lttng_data_stream_info_status lttng_data_stream_info_set_get_app_bitness(const struct lttng_data_stream_info_set *set, enum lttng_app_bitness *bitness)
Sets *bitness to the application bitness of the data streams of the data stream set set.
enum lttng_data_stream_info_status lttng_data_stream_info_set_get_count(const struct lttng_data_stream_info_set *set, unsigned int *count)
Sets *count to the number of data stream infos in the data stream info set set.
enum lttng_data_stream_info_status lttng_data_stream_info_set_get_pid(const struct lttng_data_stream_info_set *set, pid_t *pid)
Sets *pid to the process ID of the owner of the data streams of the data stream info set set.
lttng_data_stream_info_status
Return type for data stream info functions.
Definition stream-info.h:50
@ LTTNG_APP_BITNESS_32
32-bit.
Definition stream-info.h:38
@ LTTNG_APP_BITNESS_64
64-bit.
Definition stream-info.h:41
@ LTTNG_DATA_STREAM_INFO_STATUS_ERROR
Other error.
Definition stream-info.h:58
@ LTTNG_DATA_STREAM_INFO_STATUS_OK
Success.
Definition stream-info.h:52
@ LTTNG_DATA_STREAM_INFO_STATUS_INVALID_PARAMETER
Unsatisfied precondition.
Definition stream-info.h:61
@ LTTNG_DATA_STREAM_INFO_STATUS_NONE
Information not available.
Definition stream-info.h:55
lttng_domain_type
Tracing domain type (tracer type).
Definition domain.h:27
enum lttng_channel_get_data_stream_info_sets_status lttng_channel_get_data_stream_info_sets(const char *session_name, const char *channel_name, enum lttng_domain_type domain, const struct lttng_data_stream_info_sets **sets)
Retrieves data stream info sets for the event record channel named channel_name in the recording sess...
lttng_channel_get_data_stream_info_sets_status
Return type of lttng_channel_get_data_stream_info_sets().
Definition stream-info.h:376
@ LTTNG_CHANNEL_GET_DATA_STREAM_INFO_SETS_STATUS_ERROR
Other error.
Definition stream-info.h:381
@ LTTNG_CHANNEL_GET_DATA_STREAM_INFO_SETS_STATUS_INVALID_PARAMETER
Unsatisfied precondition.
Definition stream-info.h:384
@ LTTNG_CHANNEL_GET_DATA_STREAM_INFO_SETS_STATUS_OK
Success.
Definition stream-info.h:378
Data stream info set (opaque type).
Set of data stream info sets (opaque type).
Data stream info (opaque type).