SoW-2020-0003: Trace Hit Counters
[lttng-tools.git] / src / common / kernel-ctl / kernel-ctl.c
1 /*
2 * Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 *
6 * SPDX-License-Identifier: GPL-2.0-only
7 *
8 */
9
10 #include "lttng/tracker.h"
11 #define _LGPL_SOURCE
12 #define __USE_LINUX_IOCTL_DEFS
13 #include <sys/ioctl.h>
14 #include <string.h>
15 #include <common/align.h>
16 #include <common/macros.h>
17 #include <common/compat/errno.h>
18 #include <stdarg.h>
19 #include <assert.h>
20 #include <common/time.h>
21
22 #include "kernel-ctl.h"
23 #include "kernel-ioctl.h"
24
25 #define LTTNG_IOCTL_CHECK(fildes, request, ...) ({ \
26 int ret = ioctl(fildes, request, ##__VA_ARGS__);\
27 assert(ret <= 0); \
28 !ret ? 0 : -errno; \
29 })
30
31 #define LTTNG_IOCTL_NO_CHECK(fildes, request, ...) ({ \
32 int ret = ioctl(fildes, request, ##__VA_ARGS__);\
33 ret >= 0 ? ret : -errno; \
34 })
35
36 /*
37 * This flag indicates which version of the kernel ABI to use. The old
38 * ABI (namespace _old) does not support a 32-bit user-space when the
39 * kernel is 64-bit. The old ABI is kept here for compatibility but is
40 * deprecated and will be removed eventually.
41 */
42 static int lttng_kernel_use_old_abi = -1;
43
44 /*
45 * Execute the new or old ioctl depending on the ABI version.
46 * If the ABI version is not determined yet (lttng_kernel_use_old_abi = -1),
47 * this function tests if the new ABI is available and otherwise fallbacks
48 * on the old one.
49 * This function takes the fd on which the ioctl must be executed and the old
50 * and new request codes.
51 * It returns the return value of the ioctl executed.
52 */
53 static inline int compat_ioctl_no_arg(int fd, unsigned long oldname,
54 unsigned long newname)
55 {
56 int ret;
57
58 if (lttng_kernel_use_old_abi == -1) {
59 ret = LTTNG_IOCTL_NO_CHECK(fd, newname);
60 if (!ret) {
61 lttng_kernel_use_old_abi = 0;
62 goto end;
63 }
64 lttng_kernel_use_old_abi = 1;
65 }
66 if (lttng_kernel_use_old_abi) {
67 ret = LTTNG_IOCTL_NO_CHECK(fd, oldname);
68 } else {
69 ret = LTTNG_IOCTL_NO_CHECK(fd, newname);
70 }
71
72 end:
73 return ret;
74 }
75
76 int kernctl_create_session(int fd)
77 {
78 return compat_ioctl_no_arg(fd, LTTNG_KERNEL_OLD_SESSION,
79 LTTNG_KERNEL_SESSION);
80 }
81
82 /* open the metadata global channel */
83 int kernctl_open_metadata(int fd, struct lttng_channel_attr *chops)
84 {
85 struct lttng_kernel_channel channel;
86
87 if (lttng_kernel_use_old_abi) {
88 struct lttng_kernel_old_channel old_channel;
89
90 memset(&old_channel, 0, sizeof(old_channel));
91 old_channel.overwrite = chops->overwrite;
92 old_channel.subbuf_size = chops->subbuf_size;
93 old_channel.num_subbuf = chops->num_subbuf;
94 old_channel.switch_timer_interval = chops->switch_timer_interval;
95 old_channel.read_timer_interval = chops->read_timer_interval;
96 old_channel.output = chops->output;
97
98 memset(old_channel.padding, 0, sizeof(old_channel.padding));
99 /*
100 * The new channel padding is smaller than the old ABI so we use the
101 * new ABI padding size for the memcpy.
102 */
103 memcpy(old_channel.padding, chops->padding, sizeof(chops->padding));
104
105 return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_OLD_METADATA,
106 &old_channel);
107 }
108
109 memset(&channel, 0, sizeof(channel));
110 channel.overwrite = chops->overwrite;
111 channel.subbuf_size = chops->subbuf_size;
112 channel.num_subbuf = chops->num_subbuf;
113 channel.switch_timer_interval = chops->switch_timer_interval;
114 channel.read_timer_interval = chops->read_timer_interval;
115 channel.output = chops->output;
116 memcpy(channel.padding, chops->padding, sizeof(chops->padding));
117
118 return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_METADATA, &channel);
119 }
120
121 int kernctl_create_channel(int fd, struct lttng_channel_attr *chops)
122 {
123 struct lttng_kernel_channel channel;
124
125 memset(&channel, 0, sizeof(channel));
126 if (lttng_kernel_use_old_abi) {
127 struct lttng_kernel_old_channel old_channel;
128
129 old_channel.overwrite = chops->overwrite;
130 old_channel.subbuf_size = chops->subbuf_size;
131 old_channel.num_subbuf = chops->num_subbuf;
132 old_channel.switch_timer_interval = chops->switch_timer_interval;
133 old_channel.read_timer_interval = chops->read_timer_interval;
134 old_channel.output = chops->output;
135
136 memset(old_channel.padding, 0, sizeof(old_channel.padding));
137 /*
138 * The new channel padding is smaller than the old ABI so we use the
139 * new ABI padding size for the memcpy.
140 */
141 memcpy(old_channel.padding, chops->padding, sizeof(chops->padding));
142
143 return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_OLD_CHANNEL,
144 &old_channel);
145 }
146
147 channel.overwrite = chops->overwrite;
148 channel.subbuf_size = chops->subbuf_size;
149 channel.num_subbuf = chops->num_subbuf;
150 channel.switch_timer_interval = chops->switch_timer_interval;
151 channel.read_timer_interval = chops->read_timer_interval;
152 channel.output = chops->output;
153 memcpy(channel.padding, chops->padding, sizeof(chops->padding));
154
155 return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_CHANNEL, &channel);
156 }
157
158 int kernctl_create_session_counter(int session_fd, struct lttng_kernel_counter_conf *counter_conf)
159 {
160 return LTTNG_IOCTL_NO_CHECK(session_fd, LTTNG_KERNEL_COUNTER, counter_conf);
161 }
162
163
164 int kernctl_syscall_mask(int fd, char **syscall_mask, uint32_t *nr_bits)
165 {
166 struct lttng_kernel_syscall_mask kmask_len, *kmask = NULL;
167 size_t array_alloc_len;
168 char *new_mask;
169 int ret = 0;
170
171 if (!syscall_mask) {
172 ret = -1;
173 goto end;
174 }
175
176 if (!nr_bits) {
177 ret = -1;
178 goto end;
179 }
180
181 kmask_len.len = 0;
182 ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_SYSCALL_MASK, &kmask_len);
183 if (ret) {
184 goto end;
185 }
186
187 array_alloc_len = ALIGN(kmask_len.len, 8) >> 3;
188
189 kmask = zmalloc(sizeof(*kmask) + array_alloc_len);
190 if (!kmask) {
191 ret = -1;
192 goto end;
193 }
194
195 kmask->len = kmask_len.len;
196 ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_SYSCALL_MASK, kmask);
197 if (ret) {
198 goto end;
199 }
200
201 new_mask = realloc(*syscall_mask, array_alloc_len);
202 if (!new_mask) {
203 ret = -1;
204 goto end;
205 }
206 memcpy(new_mask, kmask->mask, array_alloc_len);
207 *syscall_mask = new_mask;
208 *nr_bits = kmask->len;
209
210 end:
211 free(kmask);
212 return ret;
213 }
214
215 int kernctl_track_pid(int fd, int pid)
216 {
217 return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_SESSION_TRACK_PID, pid);
218 }
219
220 int kernctl_untrack_pid(int fd, int pid)
221 {
222 return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_SESSION_UNTRACK_PID, pid);
223 }
224
225 int kernctl_list_tracker_pids(int fd)
226 {
227 return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS);
228 }
229
230 static enum lttng_kernel_tracker_type get_kernel_tracker_type(
231 enum lttng_process_attr process_attr)
232 {
233 switch (process_attr) {
234 case LTTNG_PROCESS_ATTR_PROCESS_ID:
235 return LTTNG_KERNEL_TRACKER_PID;
236 case LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID:
237 return LTTNG_KERNEL_TRACKER_VPID;
238 case LTTNG_PROCESS_ATTR_USER_ID:
239 return LTTNG_KERNEL_TRACKER_UID;
240 case LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID:
241 return LTTNG_KERNEL_TRACKER_VUID;
242 case LTTNG_PROCESS_ATTR_GROUP_ID:
243 return LTTNG_KERNEL_TRACKER_GID;
244 case LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID:
245 return LTTNG_KERNEL_TRACKER_VGID;
246 default:
247 return LTTNG_KERNEL_TRACKER_UNKNOWN;
248 }
249 }
250
251 int kernctl_track_id(int fd, enum lttng_process_attr process_attr, int id)
252 {
253 struct lttng_kernel_tracker_args args;
254
255 args.id = id;
256 args.type = get_kernel_tracker_type(process_attr);
257 if (args.type == LTTNG_KERNEL_TRACKER_UNKNOWN) {
258 errno = EINVAL;
259 return -1;
260 }
261 return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_SESSION_TRACK_ID, &args);
262 }
263
264 int kernctl_untrack_id(int fd, enum lttng_process_attr process_attr, int id)
265 {
266 struct lttng_kernel_tracker_args args;
267
268 args.id = id;
269 args.type = get_kernel_tracker_type(process_attr);
270 if (args.type == LTTNG_KERNEL_TRACKER_UNKNOWN) {
271 errno = EINVAL;
272 return -1;
273 }
274 return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_SESSION_UNTRACK_ID, &args);
275 }
276
277 int kernctl_list_tracker_ids(int fd, enum lttng_process_attr process_attr)
278 {
279 struct lttng_kernel_tracker_args args;
280
281 args.id = -1;
282 args.type = get_kernel_tracker_type(process_attr);
283 if (args.type == LTTNG_KERNEL_TRACKER_UNKNOWN) {
284 errno = EINVAL;
285 return -1;
286 }
287 return LTTNG_IOCTL_NO_CHECK(
288 fd, LTTNG_KERNEL_SESSION_LIST_TRACKER_IDS, &args);
289 }
290
291 int kernctl_session_regenerate_metadata(int fd)
292 {
293 return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_SESSION_METADATA_REGEN);
294 }
295
296 int kernctl_session_regenerate_statedump(int fd)
297 {
298 return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_SESSION_STATEDUMP);
299 }
300
301 int kernctl_session_set_name(int fd, const char *name)
302 {
303 int ret;
304 struct lttng_kernel_session_name session_name;
305
306 ret = lttng_strncpy(session_name.name, name, sizeof(session_name.name));
307 if (ret) {
308 goto end;
309 }
310
311 ret = LTTNG_IOCTL_CHECK(
312 fd, LTTNG_KERNEL_SESSION_SET_NAME, &session_name);
313 end:
314 return ret;
315 }
316
317 int kernctl_session_set_creation_time(int fd, time_t time)
318 {
319 int ret;
320 struct lttng_kernel_session_creation_time creation_time;
321
322 ret = time_to_iso8601_str(time, creation_time.iso8601,
323 sizeof(creation_time.iso8601));
324 if (ret) {
325 goto end;
326 }
327
328 ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_SESSION_SET_CREATION_TIME,
329 &creation_time);
330 end:
331 return ret;
332 }
333
334 int kernctl_create_stream(int fd)
335 {
336 return compat_ioctl_no_arg(fd, LTTNG_KERNEL_OLD_STREAM,
337 LTTNG_KERNEL_STREAM);
338 }
339
340 int kernctl_create_event(int fd, struct lttng_kernel_event *ev)
341 {
342 if (lttng_kernel_use_old_abi) {
343 struct lttng_kernel_old_event old_event;
344
345 memset(&old_event, 0, sizeof(old_event));
346 memcpy(old_event.name, ev->name, sizeof(old_event.name));
347 old_event.instrumentation = ev->instrumentation;
348 switch (ev->instrumentation) {
349 case LTTNG_KERNEL_KPROBE:
350 old_event.u.kprobe.addr = ev->u.kprobe.addr;
351 old_event.u.kprobe.offset = ev->u.kprobe.offset;
352 memcpy(old_event.u.kprobe.symbol_name,
353 ev->u.kprobe.symbol_name,
354 sizeof(old_event.u.kprobe.symbol_name));
355 break;
356 case LTTNG_KERNEL_KRETPROBE:
357 old_event.u.kretprobe.addr = ev->u.kretprobe.addr;
358 old_event.u.kretprobe.offset = ev->u.kretprobe.offset;
359 memcpy(old_event.u.kretprobe.symbol_name,
360 ev->u.kretprobe.symbol_name,
361 sizeof(old_event.u.kretprobe.symbol_name));
362 break;
363 case LTTNG_KERNEL_FUNCTION:
364 memcpy(old_event.u.ftrace.symbol_name,
365 ev->u.ftrace.symbol_name,
366 sizeof(old_event.u.ftrace.symbol_name));
367 break;
368 default:
369 break;
370 }
371
372 return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_OLD_EVENT,
373 &old_event);
374 }
375 return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_EVENT, ev);
376 }
377
378 int kernctl_add_context(int fd, struct lttng_kernel_context *ctx)
379 {
380 if (lttng_kernel_use_old_abi) {
381 struct lttng_kernel_old_context old_ctx;
382
383 memset(&old_ctx, 0, sizeof(old_ctx));
384 old_ctx.ctx = ctx->ctx;
385 /* only type that uses the union */
386 if (ctx->ctx == LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER) {
387 old_ctx.u.perf_counter.type =
388 ctx->u.perf_counter.type;
389 old_ctx.u.perf_counter.config =
390 ctx->u.perf_counter.config;
391 memcpy(old_ctx.u.perf_counter.name,
392 ctx->u.perf_counter.name,
393 sizeof(old_ctx.u.perf_counter.name));
394 }
395 return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_OLD_CONTEXT, &old_ctx);
396 }
397 return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_CONTEXT, ctx);
398 }
399
400
401 /* Enable event, channel and session LTTNG_IOCTL_CHECK */
402 int kernctl_enable(int fd)
403 {
404 return compat_ioctl_no_arg(fd, LTTNG_KERNEL_OLD_ENABLE,
405 LTTNG_KERNEL_ENABLE);
406 }
407
408 /* Disable event, channel and session LTTNG_IOCTL_CHECK */
409 int kernctl_disable(int fd)
410 {
411 return compat_ioctl_no_arg(fd, LTTNG_KERNEL_OLD_DISABLE,
412 LTTNG_KERNEL_DISABLE);
413 }
414
415 int kernctl_start_session(int fd)
416 {
417 return compat_ioctl_no_arg(fd, LTTNG_KERNEL_OLD_SESSION_START,
418 LTTNG_KERNEL_SESSION_START);
419 }
420
421 int kernctl_stop_session(int fd)
422 {
423 return compat_ioctl_no_arg(fd, LTTNG_KERNEL_OLD_SESSION_STOP,
424 LTTNG_KERNEL_SESSION_STOP);
425 }
426
427 int kernctl_create_event_notifier_group(int fd)
428 {
429 return LTTNG_IOCTL_NO_CHECK(fd,
430 LTTNG_KERNEL_EVENT_NOTIFIER_GROUP_CREATE);
431 }
432
433 int kernctl_create_counter_event(int fd, struct lttng_kernel_counter_event *ev)
434 {
435 return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_COUNTER_EVENT, ev);
436 }
437
438 int kernctl_create_event_notifier_group_notification_fd(int group_fd)
439 {
440 return LTTNG_IOCTL_NO_CHECK(group_fd,
441 LTTNG_KERNEL_EVENT_NOTIFIER_GROUP_NOTIFICATION_FD);
442 }
443
444 int kernctl_create_event_notifier_group_error_counter(int group_fd,
445 struct lttng_kernel_counter_conf *error_counter_conf)
446 {
447 return LTTNG_IOCTL_NO_CHECK(group_fd, LTTNG_KERNEL_COUNTER,
448 error_counter_conf);
449 }
450
451 int kernctl_counter_read_value(int counter_fd,
452 struct lttng_kernel_counter_read *value)
453 {
454 return LTTNG_IOCTL_NO_CHECK(counter_fd, LTTNG_KERNEL_COUNTER_READ,
455 value);
456 }
457
458 int kernctl_counter_get_aggregate_value(int counter_fd,
459 struct lttng_kernel_counter_aggregate *value)
460 {
461 return LTTNG_IOCTL_NO_CHECK(counter_fd, LTTNG_KERNEL_COUNTER_AGGREGATE,
462 value);
463 }
464
465 int kernctl_counter_clear(int counter_fd,
466 struct lttng_kernel_counter_clear *clear)
467 {
468 return LTTNG_IOCTL_NO_CHECK(counter_fd, LTTNG_KERNEL_COUNTER_CLEAR,
469 clear);
470 }
471
472 int kernctl_counter_map_descriptor_count(int counter_fd, uint64_t *count)
473 {
474 struct lttng_kernel_counter_map_nr_descriptors nr_desc;
475 int ret;
476
477 ret = LTTNG_IOCTL_NO_CHECK(counter_fd,
478 LTTNG_KERNEL_COUNTER_MAP_NR_DESCRIPTORS, &nr_desc);
479 *count = nr_desc.nr_descriptors;
480
481 return ret;
482 }
483
484 int kernctl_counter_map_descriptor(int counter_fd,
485 struct lttng_kernel_counter_map_descriptor *descriptor)
486 {
487 return LTTNG_IOCTL_NO_CHECK(counter_fd,
488 LTTNG_KERNEL_COUNTER_MAP_DESCRIPTOR, descriptor);
489 }
490
491 int kernctl_create_event_notifier(int group_fd,
492 const struct lttng_kernel_event_notifier *event_notifier)
493 {
494 return LTTNG_IOCTL_NO_CHECK(group_fd,
495 LTTNG_KERNEL_EVENT_NOTIFIER_CREATE, event_notifier);
496 }
497
498 int kernctl_capture(int fd, const struct lttng_bytecode *capture)
499 {
500 struct lttng_kernel_capture_bytecode *kb;
501 uint32_t len;
502 int ret;
503
504 /* Translate bytecode to kernel bytecode */
505 kb = zmalloc(sizeof(*kb) + capture->len);
506 if (!kb)
507 return -ENOMEM;
508 kb->len = len = capture->len;
509 kb->reloc_offset = capture->reloc_table_offset;
510 kb->seqnum = capture->seqnum;
511 memcpy(kb->data, capture->data, len);
512 ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_CAPTURE, kb);
513 free(kb);
514 return ret;
515 }
516
517 int kernctl_filter(int fd, const struct lttng_bytecode *filter)
518 {
519 struct lttng_kernel_filter_bytecode *kb;
520 uint32_t len;
521 int ret;
522
523 /* Translate bytecode to kernel bytecode */
524 kb = zmalloc(sizeof(*kb) + filter->len);
525 if (!kb)
526 return -ENOMEM;
527 kb->len = len = filter->len;
528 kb->reloc_offset = filter->reloc_table_offset;
529 kb->seqnum = filter->seqnum;
530 memcpy(kb->data, filter->data, len);
531 ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_FILTER, kb);
532 free(kb);
533 return ret;
534 }
535
536 int kernctl_add_callsite(int fd, struct lttng_kernel_event_callsite *callsite)
537 {
538 return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_ADD_CALLSITE, callsite);
539 }
540
541 int kernctl_tracepoint_list(int fd)
542 {
543 return compat_ioctl_no_arg(fd, LTTNG_KERNEL_OLD_TRACEPOINT_LIST,
544 LTTNG_KERNEL_TRACEPOINT_LIST);
545 }
546
547 int kernctl_syscall_list(int fd)
548 {
549 return LTTNG_IOCTL_NO_CHECK(fd, LTTNG_KERNEL_SYSCALL_LIST);
550 }
551
552 int kernctl_tracer_version(int fd, struct lttng_kernel_tracer_version *v)
553 {
554 int ret;
555
556 if (lttng_kernel_use_old_abi == -1) {
557 ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_TRACER_VERSION, v);
558 if (!ret) {
559 lttng_kernel_use_old_abi = 0;
560 goto end;
561 }
562 lttng_kernel_use_old_abi = 1;
563 }
564 if (lttng_kernel_use_old_abi) {
565 struct lttng_kernel_old_tracer_version old_v;
566
567 ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_OLD_TRACER_VERSION, &old_v);
568 if (ret) {
569 goto end;
570 }
571 v->major = old_v.major;
572 v->minor = old_v.minor;
573 v->patchlevel = old_v.patchlevel;
574 } else {
575 ret = LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_TRACER_VERSION, v);
576 }
577
578 end:
579 return ret;
580 }
581
582 int kernctl_tracer_abi_version(int fd,
583 struct lttng_kernel_tracer_abi_version *v)
584 {
585 return LTTNG_IOCTL_CHECK(fd, LTTNG_KERNEL_TRACER_ABI_VERSION, v);
586 }
587
588 int kernctl_wait_quiescent(int fd)
589 {
590 return compat_ioctl_no_arg(fd, LTTNG_KERNEL_OLD_WAIT_QUIESCENT,
591 LTTNG_KERNEL_WAIT_QUIESCENT);
592 }
593
594 int kernctl_buffer_flush(int fd)
595 {
596 return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_FLUSH);
597 }
598
599 int kernctl_buffer_flush_empty(int fd)
600 {
601 return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_FLUSH_EMPTY);
602 }
603
604 int kernctl_buffer_clear(int fd)
605 {
606 return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_CLEAR);
607 }
608
609 int kernctl_get_next_subbuf_metadata_check(int fd, bool *consistent)
610 {
611 return LTTNG_IOCTL_NO_CHECK(fd,
612 RING_RING_BUFFER_GET_NEXT_SUBBUF_METADATA_CHECK,
613 consistent);
614 }
615
616 /* returns the version of the metadata. */
617 int kernctl_get_metadata_version(int fd, uint64_t *version)
618 {
619 return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_GET_METADATA_VERSION, version);
620 }
621
622 int kernctl_metadata_cache_dump(int fd)
623 {
624 return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_METADATA_CACHE_DUMP);
625 }
626
627 /* Buffer operations */
628
629 /* For mmap mode, readable without "get" operation */
630
631 /* returns the length to mmap. */
632 int kernctl_get_mmap_len(int fd, unsigned long *len)
633 {
634 return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_GET_MMAP_LEN, len);
635 }
636
637 /* returns the maximum size for sub-buffers. */
638 int kernctl_get_max_subbuf_size(int fd, unsigned long *len)
639 {
640 return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_GET_MAX_SUBBUF_SIZE, len);
641 }
642
643 /*
644 * For mmap mode, operate on the current packet (between get/put or
645 * get_next/put_next).
646 */
647
648 /* returns the offset of the subbuffer belonging to the mmap reader. */
649 int kernctl_get_mmap_read_offset(int fd, unsigned long *off)
650 {
651 return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_GET_MMAP_READ_OFFSET, off);
652 }
653
654 /* returns the size of the current sub-buffer, without padding (for mmap). */
655 int kernctl_get_subbuf_size(int fd, unsigned long *len)
656 {
657 return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_GET_SUBBUF_SIZE, len);
658 }
659
660 /* returns the size of the current sub-buffer, without padding (for mmap). */
661 int kernctl_get_padded_subbuf_size(int fd, unsigned long *len)
662 {
663 return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_GET_PADDED_SUBBUF_SIZE, len);
664 }
665
666 /* Get exclusive read access to the next sub-buffer that can be read. */
667 int kernctl_get_next_subbuf(int fd)
668 {
669 return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_GET_NEXT_SUBBUF);
670 }
671
672
673 /* Release exclusive sub-buffer access, move consumer forward. */
674 int kernctl_put_next_subbuf(int fd)
675 {
676 return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_PUT_NEXT_SUBBUF);
677 }
678
679 /* snapshot */
680
681 /* Get a snapshot of the current ring buffer producer and consumer positions */
682 int kernctl_snapshot(int fd)
683 {
684 return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_SNAPSHOT);
685 }
686
687 /*
688 * Get a snapshot of the current ring buffer producer and consumer positions,
689 * regardless of whether or not the two positions are contained within the
690 * same sub-buffer.
691 */
692 int kernctl_snapshot_sample_positions(int fd)
693 {
694 return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_SNAPSHOT_SAMPLE_POSITIONS);
695 }
696
697 /* Get the consumer position (iteration start) */
698 int kernctl_snapshot_get_consumed(int fd, unsigned long *pos)
699 {
700 return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_SNAPSHOT_GET_CONSUMED, pos);
701 }
702
703 /* Get the producer position (iteration end) */
704 int kernctl_snapshot_get_produced(int fd, unsigned long *pos)
705 {
706 return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_SNAPSHOT_GET_PRODUCED, pos);
707 }
708
709 /* Get exclusive read access to the specified sub-buffer position */
710 int kernctl_get_subbuf(int fd, unsigned long *len)
711 {
712 return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_GET_SUBBUF, len);
713 }
714
715 /* Release exclusive sub-buffer access */
716 int kernctl_put_subbuf(int fd)
717 {
718 return LTTNG_IOCTL_CHECK(fd, RING_BUFFER_PUT_SUBBUF);
719 }
720
721 /* Returns the timestamp begin of the current sub-buffer. */
722 int kernctl_get_timestamp_begin(int fd, uint64_t *timestamp_begin)
723 {
724 return LTTNG_IOCTL_CHECK(fd, LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN,
725 timestamp_begin);
726 }
727
728 /* Returns the timestamp end of the current sub-buffer. */
729 int kernctl_get_timestamp_end(int fd, uint64_t *timestamp_end)
730 {
731 return LTTNG_IOCTL_CHECK(fd, LTTNG_RING_BUFFER_GET_TIMESTAMP_END,
732 timestamp_end);
733 }
734
735 /* Returns the number of discarded events in the current sub-buffer. */
736 int kernctl_get_events_discarded(int fd, uint64_t *events_discarded)
737 {
738 return LTTNG_IOCTL_CHECK(fd, LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED,
739 events_discarded);
740 }
741
742 /* Returns the content size in the current sub-buffer. */
743 int kernctl_get_content_size(int fd, uint64_t *content_size)
744 {
745 return LTTNG_IOCTL_CHECK(fd, LTTNG_RING_BUFFER_GET_CONTENT_SIZE,
746 content_size);
747 }
748
749 /* Returns the packet size in the current sub-buffer. */
750 int kernctl_get_packet_size(int fd, uint64_t *packet_size)
751 {
752 return LTTNG_IOCTL_CHECK(fd, LTTNG_RING_BUFFER_GET_PACKET_SIZE,
753 packet_size);
754 }
755
756 /* Returns the stream id of the current sub-buffer. */
757 int kernctl_get_stream_id(int fd, uint64_t *stream_id)
758 {
759 return LTTNG_IOCTL_CHECK(fd, LTTNG_RING_BUFFER_GET_STREAM_ID,
760 stream_id);
761 }
762
763 /* Returns the current timestamp. */
764 int kernctl_get_current_timestamp(int fd, uint64_t *ts)
765 {
766 return LTTNG_IOCTL_CHECK(fd, LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP,
767 ts);
768 }
769
770 /* Returns the packet sequence number of the current sub-buffer. */
771 int kernctl_get_sequence_number(int fd, uint64_t *seq)
772 {
773 return LTTNG_IOCTL_CHECK(fd, LTTNG_RING_BUFFER_GET_SEQ_NUM, seq);
774 }
775
776 /* Returns the stream instance id. */
777 int kernctl_get_instance_id(int fd, uint64_t *id)
778 {
779 return LTTNG_IOCTL_CHECK(fd, LTTNG_RING_BUFFER_INSTANCE_ID, id);
780 }
This page took 0.045784 seconds and 5 git commands to generate.