src/common/kernel-ctl/kernel-ctl.h

   1 /*
   2  * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
   3  *                      Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License, version 2 only,
   7  * as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  */
  18
  19 #ifndef _LTTNG_KERNEL_CTL_H
  20 #define _LTTNG_KERNEL_CTL_H
  21
  22 #include <lttng/lttng.h>
  23 #include <common/lttng-kernel.h>
  24 #include <common/lttng-kernel-old.h>
  25 #include <common/sessiond-comm/sessiond-comm.h> /* for struct lttng_filter_bytecode */
  26
  27 int kernctl_create_session(int fd);
  28 int kernctl_open_metadata(int fd, struct lttng_channel_attr *chops);
  29 int kernctl_create_channel(int fd, struct lttng_channel_attr *chops);
  30 int kernctl_create_stream(int fd);
  31 int kernctl_create_event(int fd, struct lttng_kernel_event *ev);
  32 int kernctl_add_context(int fd, struct lttng_kernel_context *ctx);
  33
  34 int kernctl_enable(int fd);
  35 int kernctl_disable(int fd);
  36 int kernctl_start_session(int fd);
  37 int kernctl_stop_session(int fd);
  38
  39 /* Apply on event FD */
  40 int kernctl_filter(int fd, struct lttng_filter_bytecode *filter);
  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 FD.
  50  *
  51  * The parameter @syscall_mask should initially be either NULL or point
  52  * to memory allocated with malloc(3) or realloc(3). When the function
  53  * returns, it will point to a memory area of the size required for the
  54  * bitmask (using realloc(3) to resize the memory).
  55  *
  56  * It returns 0 if OK, -1 on error. In all cases (error and OK),
  57  * @syscall_mask should be freed by the caller with free(3).
  58  */
  59 int kernctl_syscall_mask(int fd, char **syscall_mask,
  60                 uint32_t *nr_bits);
  61
  62 /* Process ID tracking can be applied to session FD */
  63 int kernctl_track_pid(int fd, int pid);
  64 int kernctl_untrack_pid(int fd, int pid);
  65 int kernctl_list_tracker_pids(int fd);
  66
  67 int kernctl_session_regenerate_metadata(int fd);
  68 int kernctl_session_regenerate_statedump(int fd);
  69
  70 /* Buffer operations */
  71
  72 /* For mmap mode, readable without "get" operation */
  73 int kernctl_get_mmap_len(int fd, unsigned long *len);
  74 int kernctl_get_max_subbuf_size(int fd, unsigned long *len);
  75
  76 /*
  77  * For mmap mode, operate on the current packet (between get/put or
  78  * get_next/put_next).
  79  */
  80 int kernctl_get_mmap_read_offset(int fd, unsigned long *len);
  81 int kernctl_get_subbuf_size(int fd, unsigned long *len);
  82 int kernctl_get_padded_subbuf_size(int fd, unsigned long *len);
  83
  84 int kernctl_get_next_subbuf(int fd);
  85 int kernctl_put_next_subbuf(int fd);
  86
  87 /* snapshot */
  88 int kernctl_snapshot(int fd);
  89 int kernctl_snapshot_sample_positions(int fd);
  90 int kernctl_snapshot_get_consumed(int fd, unsigned long *pos);
  91 int kernctl_snapshot_get_produced(int fd, unsigned long *pos);
  92 int kernctl_get_subbuf(int fd, unsigned long *pos);
  93 int kernctl_put_subbuf(int fd);
  94
  95 int kernctl_buffer_flush(int fd);
  96 int kernctl_buffer_flush_empty(int fd);
  97 int kernctl_get_metadata_version(int fd, uint64_t *version);
  98
  99 /* index */
 100 int kernctl_get_timestamp_begin(int fd, uint64_t *timestamp_begin);
 101 int kernctl_get_timestamp_end(int fd, uint64_t *timestamp_end);
 102 int kernctl_get_events_discarded(int fd, uint64_t *events_discarded);
 103 int kernctl_get_content_size(int fd, uint64_t *content_size);
 104 int kernctl_get_packet_size(int fd, uint64_t *packet_size);
 105 int kernctl_get_stream_id(int fd, uint64_t *stream_id);
 106 int kernctl_get_current_timestamp(int fd, uint64_t *ts);
 107 int kernctl_get_sequence_number(int fd, uint64_t *seq);
 108 int kernctl_get_instance_id(int fd, uint64_t *seq);
 109
 110 #endif /* _LTTNG_KERNEL_CTL_H */