kernel: event notifier: kernel-ctl interface
[lttng-tools.git] / src / common / kernel-ctl / kernel-ctl.h
1 /*
2 * Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 *
5 * SPDX-License-Identifier: GPL-2.0-only
6 *
7 */
8
9 #ifndef _LTTNG_KERNEL_CTL_H
10 #define _LTTNG_KERNEL_CTL_H
11
12 #include <stdbool.h>
13
14 #include <lttng/lttng.h>
15 #include <common/lttng-kernel.h>
16 #include <common/lttng-kernel-old.h>
17 #include <common/sessiond-comm/sessiond-comm.h> /* for struct lttng_filter_bytecode */
18
19 int kernctl_create_session(int fd);
20 int kernctl_open_metadata(int fd, struct lttng_channel_attr *chops);
21 int kernctl_create_channel(int fd, struct lttng_channel_attr *chops);
22 int kernctl_create_stream(int fd);
23 int kernctl_create_event(int fd, struct lttng_kernel_event *ev);
24 int kernctl_add_context(int fd, struct lttng_kernel_context *ctx);
25
26 int kernctl_enable(int fd);
27 int kernctl_disable(int fd);
28 int kernctl_start_session(int fd);
29 int kernctl_stop_session(int fd);
30
31 int kernctl_create_event_notifier_group(int fd);
32
33 /* Apply on event notifier_group file descriptor. */
34 int kernctl_create_event_notifier_group_notification_fd(int fd);
35 int kernctl_create_event_notifier(int fd,
36 const struct lttng_kernel_event_notifier *event_notifier);
37
38 /* Apply on event file descriptor. */
39 int kernctl_filter(int fd, struct lttng_filter_bytecode *filter);
40 int kernctl_add_callsite(int fd, struct lttng_kernel_event_callsite *callsite);
41
42 int kernctl_tracepoint_list(int fd);
43 int kernctl_syscall_list(int fd);
44 int kernctl_tracer_version(int fd, struct lttng_kernel_tracer_version *v);
45 int kernctl_tracer_abi_version(int fd, struct lttng_kernel_tracer_abi_version *v);
46 int kernctl_wait_quiescent(int fd);
47
48 /*
49 * kernctl_syscall_mask - Get syscall mask associated to a channel file
50 * descriptor.
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 */
60 int kernctl_syscall_mask(int fd, char **syscall_mask,
61 uint32_t *nr_bits);
62
63 /* Process ID tracking can be applied to session file descriptor. */
64 int kernctl_track_pid(int fd, int pid);
65 int kernctl_untrack_pid(int fd, int pid);
66 int kernctl_list_tracker_pids(int fd);
67
68 int kernctl_track_id(int fd, enum lttng_process_attr process_attr, int id);
69 int kernctl_untrack_id(int fd, enum lttng_process_attr process_attr, int id);
70 int kernctl_list_tracker_ids(int fd, enum lttng_process_attr process_attr);
71
72 int kernctl_session_regenerate_metadata(int fd);
73 int kernctl_session_regenerate_statedump(int fd);
74 int kernctl_session_set_name(int fd, const char *name);
75 int kernctl_session_set_creation_time(int fd, time_t time);
76
77 /* Buffer operations */
78
79 /* For mmap mode, readable without "get" operation */
80 int kernctl_get_mmap_len(int fd, unsigned long *len);
81 int 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 */
87 int kernctl_get_mmap_read_offset(int fd, unsigned long *len);
88 int kernctl_get_subbuf_size(int fd, unsigned long *len);
89 int kernctl_get_padded_subbuf_size(int fd, unsigned long *len);
90
91 int kernctl_get_next_subbuf(int fd);
92 int kernctl_put_next_subbuf(int fd);
93
94 /* snapshot */
95 int kernctl_snapshot(int fd);
96 int kernctl_snapshot_sample_positions(int fd);
97 int kernctl_snapshot_get_consumed(int fd, unsigned long *pos);
98 int kernctl_snapshot_get_produced(int fd, unsigned long *pos);
99 int kernctl_get_subbuf(int fd, unsigned long *pos);
100 int kernctl_put_subbuf(int fd);
101
102 int kernctl_buffer_flush(int fd);
103 int kernctl_buffer_flush_empty(int fd);
104 int kernctl_buffer_clear(int fd);
105 int kernctl_get_metadata_version(int fd, uint64_t *version);
106 int kernctl_metadata_cache_dump(int fd);
107 int kernctl_get_next_subbuf_metadata_check(int fd, bool *consistent);
108
109 /* index */
110 int kernctl_get_timestamp_begin(int fd, uint64_t *timestamp_begin);
111 int kernctl_get_timestamp_end(int fd, uint64_t *timestamp_end);
112 int kernctl_get_events_discarded(int fd, uint64_t *events_discarded);
113 int kernctl_get_content_size(int fd, uint64_t *content_size);
114 int kernctl_get_packet_size(int fd, uint64_t *packet_size);
115 int kernctl_get_stream_id(int fd, uint64_t *stream_id);
116 int kernctl_get_current_timestamp(int fd, uint64_t *ts);
117 int kernctl_get_sequence_number(int fd, uint64_t *seq);
118 int kernctl_get_instance_id(int fd, uint64_t *seq);
119
120 #endif /* _LTTNG_KERNEL_CTL_H */
This page took 0.04494 seconds and 4 git commands to generate.