kernel: event notifier: kernel-ctl interface
[lttng-tools.git] / src / common / kernel-ctl / kernel-ctl.h
CommitLineData
ee0326c0 1/*
ab5be9fa
MJ
2 * Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
ee0326c0 4 *
ab5be9fa 5 * SPDX-License-Identifier: GPL-2.0-only
ee0326c0 6 *
ee0326c0
DG
7 */
8
3bd1e081
MD
9#ifndef _LTTNG_KERNEL_CTL_H
10#define _LTTNG_KERNEL_CTL_H
ee0326c0 11
41dc93d9
JG
12#include <stdbool.h>
13
f3ed775e 14#include <lttng/lttng.h>
10a8a223 15#include <common/lttng-kernel.h>
4dbc372b 16#include <common/lttng-kernel-old.h>
00a62084 17#include <common/sessiond-comm/sessiond-comm.h> /* for struct lttng_filter_bytecode */
16421f6e 18
964ccb60
MD
19int kernctl_create_session(int fd);
20int kernctl_open_metadata(int fd, struct lttng_channel_attr *chops);
f3ed775e 21int kernctl_create_channel(int fd, struct lttng_channel_attr *chops);
964ccb60 22int kernctl_create_stream(int fd);
9cb98350 23int kernctl_create_event(int fd, struct lttng_kernel_event *ev);
964ccb60
MD
24int kernctl_add_context(int fd, struct lttng_kernel_context *ctx);
25
f3ed775e
DG
26int kernctl_enable(int fd);
27int kernctl_disable(int fd);
50dc1fa6
DG
28int kernctl_start_session(int fd);
29int kernctl_stop_session(int fd);
964ccb60 30
cfb1c9bc
JR
31int kernctl_create_event_notifier_group(int fd);
32
33/* Apply on event notifier_group file descriptor. */
34int kernctl_create_event_notifier_group_notification_fd(int fd);
35int kernctl_create_event_notifier(int fd,
36 const struct lttng_kernel_event_notifier *event_notifier);
37
38/* Apply on event file descriptor. */
00a62084 39int kernctl_filter(int fd, struct lttng_filter_bytecode *filter);
1ab8c2ad 40int kernctl_add_callsite(int fd, struct lttng_kernel_event_callsite *callsite);
00a62084 41
8d609afd 42int kernctl_tracepoint_list(int fd);
d02666a9 43int kernctl_syscall_list(int fd);
8d609afd 44int kernctl_tracer_version(int fd, struct lttng_kernel_tracer_version *v);
c052142c 45int kernctl_tracer_abi_version(int fd, struct lttng_kernel_tracer_abi_version *v);
f3ed775e 46int kernctl_wait_quiescent(int fd);
16421f6e 47
46820c8b 48/*
cfb1c9bc
JR
49 * kernctl_syscall_mask - Get syscall mask associated to a channel file
50 * descriptor.
46820c8b
MD
51 *
52 * The parameter @syscall_mask should initially be either NULL or point
53 * to memory allocated with malloc(3) or realloc(3). When the function
54 * returns, it will point to a memory area of the size required for the
55 * bitmask (using realloc(3) to resize the memory).
56 *
57 * It returns 0 if OK, -1 on error. In all cases (error and OK),
58 * @syscall_mask should be freed by the caller with free(3).
59 */
60int kernctl_syscall_mask(int fd, char **syscall_mask,
61 uint32_t *nr_bits);
62
cfb1c9bc 63/* Process ID tracking can be applied to session file descriptor. */
ccf10263
MD
64int kernctl_track_pid(int fd, int pid);
65int kernctl_untrack_pid(int fd, int pid);
a5dfbb9d 66int kernctl_list_tracker_pids(int fd);
ccf10263 67
159b042f
JG
68int kernctl_track_id(int fd, enum lttng_process_attr process_attr, int id);
69int kernctl_untrack_id(int fd, enum lttng_process_attr process_attr, int id);
70int kernctl_list_tracker_ids(int fd, enum lttng_process_attr process_attr);
d01c0e56 71
eded6438 72int kernctl_session_regenerate_metadata(int fd);
c2561365 73int kernctl_session_regenerate_statedump(int fd);
8ff4109e 74int kernctl_session_set_name(int fd, const char *name);
e04b2181 75int kernctl_session_set_creation_time(int fd, time_t time);
93ec662e 76
964ccb60
MD
77/* Buffer operations */
78
79/* For mmap mode, readable without "get" operation */
80int kernctl_get_mmap_len(int fd, unsigned long *len);
81int kernctl_get_max_subbuf_size(int fd, unsigned long *len);
82
83/*
84 * For mmap mode, operate on the current packet (between get/put or
85 * get_next/put_next).
86 */
87int kernctl_get_mmap_read_offset(int fd, unsigned long *len);
88int kernctl_get_subbuf_size(int fd, unsigned long *len);
89int kernctl_get_padded_subbuf_size(int fd, unsigned long *len);
90
91int kernctl_get_next_subbuf(int fd);
92int kernctl_put_next_subbuf(int fd);
93
94/* snapshot */
95int kernctl_snapshot(int fd);
b007ec59 96int kernctl_snapshot_sample_positions(int fd);
964ccb60
MD
97int kernctl_snapshot_get_consumed(int fd, unsigned long *pos);
98int kernctl_snapshot_get_produced(int fd, unsigned long *pos);
99int kernctl_get_subbuf(int fd, unsigned long *pos);
100int kernctl_put_subbuf(int fd);
101
102int kernctl_buffer_flush(int fd);
f22dd891 103int kernctl_buffer_flush_empty(int fd);
99930a9d 104int kernctl_buffer_clear(int fd);
93ec662e 105int kernctl_get_metadata_version(int fd, uint64_t *version);
8024cc8c 106int kernctl_metadata_cache_dump(int fd);
41dc93d9 107int kernctl_get_next_subbuf_metadata_check(int fd, bool *consistent);
964ccb60 108
309167d2
JD
109/* index */
110int kernctl_get_timestamp_begin(int fd, uint64_t *timestamp_begin);
111int kernctl_get_timestamp_end(int fd, uint64_t *timestamp_end);
112int kernctl_get_events_discarded(int fd, uint64_t *events_discarded);
113int kernctl_get_content_size(int fd, uint64_t *content_size);
114int kernctl_get_packet_size(int fd, uint64_t *packet_size);
115int kernctl_get_stream_id(int fd, uint64_t *stream_id);
d3e2ba59 116int kernctl_get_current_timestamp(int fd, uint64_t *ts);
fb83fe64 117int kernctl_get_sequence_number(int fd, uint64_t *seq);
000fa86f 118int kernctl_get_instance_id(int fd, uint64_t *seq);
309167d2 119
3bd1e081 120#endif /* _LTTNG_KERNEL_CTL_H */
This page took 0.105529 seconds and 4 git commands to generate.