Import lib ring buffer into LTTng modules
[lttng-modules.git] / ltt-tracer.h
index ac90ee73c953cbe7965b7250782af6ca4524972e..f4d1ef847a1adb13f86520e9dec2e607ed95f883 100644 (file)
@@ -9,56 +9,48 @@
 #ifndef _LTT_TRACER_H
 #define _LTT_TRACER_H
 
-#ifndef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
-/* Align data on its natural alignment */
-#define RING_BUFFER_ALIGN
-#endif
-
-#include <linux/ringbuffer/config.h>
-
 #include <stdarg.h>
 #include <linux/types.h>
 #include <linux/limits.h>
 #include <linux/list.h>
 #include <linux/cache.h>
-#include <linux/kernel.h>
 #include <linux/timex.h>
 #include <linux/wait.h>
-#include <linux/marker.h>
-#include <linux/trace-clock.h>
 #include <asm/atomic.h>
 #include <asm/local.h>
 
+#include "wrapper/trace-clock.h"
 #include "ltt-tracer-core.h"
-#include "ltt-channels.h"
+#include "ltt-events.h"
 
 /* Number of bytes to log with a read/write event */
 #define LTT_LOG_RW_SIZE                        32L
 
-struct ltt_active_marker;
-
 /* Maximum number of callbacks per marker */
 #define LTT_NR_CALLBACKS       10
 
+struct ltt_serialize_closure;
+
+/* Serialization callback */
+typedef size_t (*ltt_serialize_cb)(struct lib_ring_buffer *buf,
+                                  size_t buf_offset,
+                                  struct ltt_serialize_closure *closure,
+                                  void *serialize_private,
+                                  unsigned int stack_pos_ctx,
+                                  int *largest_align,
+                                  const char *fmt, va_list *args);
+
 struct ltt_serialize_closure {
        ltt_serialize_cb *callbacks;
        long cb_args[LTT_NR_CALLBACKS];
        unsigned int cb_idx;
 };
 
-size_t ltt_serialize_data(struct ltt_chanbuf *buf, size_t buf_offset,
+size_t ltt_serialize_data(struct lib_ring_buffer *buf, size_t buf_offset,
                          struct ltt_serialize_closure *closure,
                          void *serialize_private, unsigned int stack_pos_ctx,
                          int *largest_align, const char *fmt, va_list *args);
 
-struct ltt_available_probe {
-       const char *name;               /* probe name */
-       const char *format;
-       marker_probe_func *probe_func;
-       ltt_serialize_cb callbacks[LTT_NR_CALLBACKS];
-       struct list_head node;          /* registered probes list */
-};
-
 enum ltt_channels {
        LTT_CHANNEL_METADATA,
        LTT_CHANNEL_FD_STATE,
@@ -80,92 +72,6 @@ enum ltt_channels {
        LTT_CHANNEL_DEFAULT,
 };
 
-struct ltt_active_marker {
-       struct list_head node;          /* active markers list */
-       const char *channel;
-       const char *name;
-       const char *format;
-       struct ltt_available_probe *probe;
-};
-
-extern void ltt_vtrace(const struct marker *mdata, void *probe_data,
-                      void *call_data, const char *fmt, va_list *args);
-extern void ltt_trace(const struct marker *mdata, void *probe_data,
-                     void *call_data, const char *fmt, ...);
-
-size_t ltt_serialize_printf(struct ltt_chanbuf *buf, unsigned long buf_offset,
-                           size_t *msg_size, char *output, size_t outlen,
-                           const char *fmt);
-
-/*
- * Unique ID assigned to each registered probe.
- */
-enum marker_id {
-       MARKER_ID_SET_MARKER_ID = 0,    /* Static IDs available (range 0-7) */
-       MARKER_ID_SET_MARKER_FORMAT,
-       MARKER_ID_COMPACT,              /* Compact IDs (range: 8-127)       */
-       MARKER_ID_DYNAMIC,              /* Dynamic IDs (range: 128-65535)   */
-};
-
-/* static ids 0-1 reserved for internal use. */
-#define MARKER_CORE_IDS                2
-static __inline__ enum marker_id marker_id_type(uint16_t id)
-{
-       if (id < MARKER_CORE_IDS)
-               return (enum marker_id)id;
-       else
-               return MARKER_ID_DYNAMIC;
-}
-
-struct user_dbg_data {
-       unsigned long avail_size;
-       unsigned long write;
-       unsigned long read;
-};
-
-struct ltt_trace_ops {
-       int (*create_dirs) (struct ltt_trace *new_trace);
-       void (*remove_dirs) (struct ltt_trace *new_trace);
-};
-
-struct ltt_transport {
-       char *name;
-       struct module *owner;
-       struct list_head node;
-       struct ltt_trace_ops ops;
-};
-
-enum trace_mode { LTT_TRACE_NORMAL, LTT_TRACE_FLIGHT, LTT_TRACE_HYBRID };
-
-#define CHANNEL_FLAG_ENABLE    (1U<<0)
-#define CHANNEL_FLAG_OVERWRITE (1U<<1)
-
-/* Per-trace information - each trace/flight recorder represented by one */
-struct ltt_trace {
-       /* First 32 bytes cache-hot cacheline */
-       struct list_head list;
-       struct ltt_chan **channels;
-       unsigned int nr_channels;
-       int active;
-       /* Second 32 bytes cache-hot cacheline */
-       struct ltt_trace_ops *ops;
-       u32 freq_scale;
-       u64 start_freq;
-       u64 start_tsc;
-       unsigned long long start_monotonic;
-       struct timeval          start_time;
-       struct ltt_channel_setting *settings;
-       struct {
-               struct dentry                   *trace_root;
-               struct dentry                   *ascii_root;
-       } dentry;
-       struct kref kref; /* Each channel has a kref of the trace struct */
-       struct ltt_transport *transport;
-       struct kref ltt_transport_kref;
-       wait_queue_head_t kref_wq; /* Place for ltt_trace_destroy to sleep */
-       char trace_name[NAME_MAX];
-} ____cacheline_aligned;
-
 /*
  * Hardcoded event headers
  *
@@ -215,13 +121,24 @@ struct event_header {
  * because gcc generates poor code on at least powerpc and mips. Don't ever
  * let gcc add padding between the structure elements.
  */
-struct subbuffer_header {
-       uint64_t cycle_count_begin;     /* Cycle count at subbuffer start */
-       uint64_t cycle_count_end;       /* Cycle count at subbuffer end */
-       uint32_t magic_number;          /*
+struct packet_header {
+       uint32_t magic;                 /*
                                         * Trace magic number.
                                         * contains endianness information.
                                         */
+       uint8_t trace_uuid[16];
+       uint32_t stream_id;
+       uint64_t timestamp_begin;       /* Cycle count at subbuffer start */
+       uint64_t timestamp_end; /* Cycle count at subbuffer end */
+       uint32_t content_size;          /* Size of data in subbuffer */
+       uint32_t packet_size;           /* Subbuffer size (include padding) */
+       uint32_t events_lost;           /*
+                                        * Events lost in this subbuffer since
+                                        * the beginning of the trace.
+                                        * (may overflow)
+                                        */
+       /* TODO: move to metadata */
+#if 0
        uint8_t major_version;
        uint8_t minor_version;
        uint8_t arch_size;              /* Architecture pointer size */
@@ -233,18 +150,7 @@ struct subbuffer_header {
                                         * used all along the trace.
                                         */
        uint32_t freq_scale;            /* Frequency scaling (divisor) */
-       uint32_t data_size;             /* Size of data in subbuffer */
-       uint32_t sb_size;               /* Subbuffer size (include padding) */
-       uint32_t events_lost;           /*
-                                        * Events lost in this subbuffer since
-                                        * the beginning of the trace.
-                                        * (may overflow)
-                                        */
-       uint32_t subbuf_corrupt;        /*
-                                        * Corrupted (lost) subbuffers since
-                                        * the begginig of the trace.
-                                        * (may overflow)
-                                        */
+#endif //0
        uint8_t header_end[0];          /* End of header */
 };
 
@@ -291,7 +197,7 @@ unsigned char record_header_size(const struct lib_ring_buffer_config *config,
 
        BUILD_BUG_ON(sizeof(struct event_header) != sizeof(u32));
 
-       padding = lib_ring_buffer_align(config, offset,
+       padding = lib_ring_buffer_align(offset,
                                        sizeof(struct event_header));
        offset += padding;
        offset += sizeof(struct event_header);
@@ -302,7 +208,7 @@ unsigned char record_header_size(const struct lib_ring_buffer_config *config,
                        offset += sizeof(u16) + sizeof(u16);
                        if (data_size >= LTT_MAX_SMALL_SIZE)
                                offset += sizeof(u32);
-                       offset += ltt_align(offset, sizeof(u64));
+                       offset += lib_ring_buffer_align(offset, sizeof(u64));
                        offset += sizeof(u64);
                        break;
                case LTT_RFLAG_ID_SIZE:
@@ -320,13 +226,12 @@ unsigned char record_header_size(const struct lib_ring_buffer_config *config,
        return offset - orig_offset;
 }
 
-#include <linux/ringbuffer/api.h>
+#include "wrapper/ringbuffer/api.h"
 
 extern
-size_t ltt_write_event_header_slow(struct ltt_chanbuf_alloc *bufa,
-                                  struct ltt_chan_alloc *chana,
-                                  long buf_offset, u16 eID, u32 event_size,
-                                  u64 tsc, unsigned int rflags);
+void ltt_write_event_header_slow(const struct lib_ring_buffer_config *config,
+                                struct lib_ring_buffer_ctx *ctx,
+                                u16 eID, u32 event_size);
 
 /*
  * ltt_write_event_header
@@ -356,113 +261,10 @@ slow_path:
        ltt_write_event_header_slow(config, ctx, eID, event_size);
 }
 
-#if 0
-/*
- * ltt_read_event_header
- * buf_offset must aligned on 32 bits
- */
-static __inline__
-size_t ltt_read_event_header(struct ltt_chanbuf_alloc *bufa, long buf_offset,
-                            u64 *tsc, u32 *event_size, u16 *eID,
-                            unsigned int *rflags)
-{
-       struct ltt_event_header header;
-       u16 small_size;
-
-       ltt_relay_read(bufa, buf_offset, &header, sizeof(header));
-       buf_offset += sizeof(header);
-
-       *event_size = INT_MAX;
-       *eID = header.id_time >> LTT_TSC_BITS;
-       *tsc = header.id_time & LTT_TSC_MASK;
-
-       switch (*eID) {
-       case 29:
-               *rflags = LTT_RFLAG_ID_SIZE_TSC;
-               ltt_relay_read(bufa, buf_offset, eID, sizeof(u16));
-               buf_offset += sizeof(u16);
-               ltt_relay_read(bufa, buf_offset, &small_size, sizeof(u16));
-               buf_offset += sizeof(u16);
-               if (small_size == LTT_MAX_SMALL_SIZE) {
-                       ltt_relay_read(bufa, buf_offset, event_size,
-                                       sizeof(u32));
-                       buf_offset += sizeof(u32);
-               } else
-                       *event_size = small_size;
-               buf_offset += ltt_align(buf_offset, sizeof(u64));
-               ltt_relay_read(bufa, buf_offset, tsc, sizeof(u64));
-               buf_offset += sizeof(u64);
-               break;
-       case 30:
-               *rflags = LTT_RFLAG_ID_SIZE;
-               ltt_relay_read(bufa, buf_offset, eID, sizeof(u16));
-               buf_offset += sizeof(u16);
-               ltt_relay_read(bufa, buf_offset, &small_size, sizeof(u16));
-               buf_offset += sizeof(u16);
-               if (small_size == LTT_MAX_SMALL_SIZE) {
-                       ltt_relay_read(bufa, buf_offset, event_size,
-                                       sizeof(u32));
-                       buf_offset += sizeof(u32);
-               } else
-                       *event_size = small_size;
-               break;
-       case 31:
-               *rflags = LTT_RFLAG_ID;
-               ltt_relay_read(bufa, buf_offset, eID, sizeof(u16));
-               buf_offset += sizeof(u16);
-               break;
-       default:
-               *rflags = 0;
-               break;
-       }
-
-       return buf_offset;
-}
-#endif //0
-
-/*
- * Control channels :
- * control/metadata
- * control/interrupts
- * control/...
- *
- * cpu channel :
- * cpu
- */
-#define LTT_RELAY_ROOT                 "ltt"
-
-#define LTT_METADATA_CHANNEL           "metadata_state"
-#define LTT_FD_STATE_CHANNEL           "fd_state"
-#define LTT_GLOBAL_STATE_CHANNEL       "global_state"
-#define LTT_IRQ_STATE_CHANNEL          "irq_state"
-#define LTT_MODULE_STATE_CHANNEL       "module_state"
-#define LTT_NETIF_STATE_CHANNEL                "netif_state"
-#define LTT_SOFTIRQ_STATE_CHANNEL      "softirq_state"
-#define LTT_SWAP_STATE_CHANNEL         "swap_state"
-#define LTT_SYSCALL_STATE_CHANNEL      "syscall_state"
-#define LTT_TASK_STATE_CHANNEL         "task_state"
-#define LTT_VM_STATE_CHANNEL           "vm_state"
-#define LTT_FS_CHANNEL                 "fs"
-#define LTT_INPUT_CHANNEL              "input"
-#define LTT_IPC_CHANNEL                        "ipc"
-#define LTT_KERNEL_CHANNEL             "kernel"
-#define LTT_MM_CHANNEL                 "mm"
-#define LTT_RCU_CHANNEL                        "rcu"
-
-#define LTT_FLIGHT_PREFIX              "flight-"
-
-#define LTT_ASCII                      "ascii"
-
 /* Tracer properties */
-#define LTT_DEFAULT_SUBBUF_SIZE_LOW    65536
-#define LTT_DEFAULT_N_SUBBUFS_LOW      2
-#define LTT_DEFAULT_SUBBUF_SIZE_MED    262144
-#define LTT_DEFAULT_N_SUBBUFS_MED      2
-#define LTT_DEFAULT_SUBBUF_SIZE_HIGH   1048576
-#define LTT_DEFAULT_N_SUBBUFS_HIGH     2
-#define LTT_TRACER_MAGIC_NUMBER                0x00D6B7ED
-#define LTT_TRACER_VERSION_MAJOR       2
-#define LTT_TRACER_VERSION_MINOR       6
+#define CTF_MAGIC_NUMBER               0xC1FC1FC1
+#define LTT_TRACER_VERSION_MAJOR       3
+#define LTT_TRACER_VERSION_MINOR       0
 
 /**
  * ltt_write_trace_header - Write trace header
@@ -470,20 +272,21 @@ size_t ltt_read_event_header(struct ltt_chanbuf_alloc *bufa, long buf_offset,
  * @header: Memory address where the information must be written to
  */
 static __inline__
-void ltt_write_trace_header(void *priv,
-                           struct subbuffer_header *header)
+void write_trace_header(const struct lib_ring_buffer_config *config,
+                       struct packet_header *header)
 {
-       struct ltt_trace *trace = priv;
-
-       header->magic_number = LTT_TRACER_MAGIC_NUMBER;
+       header->magic = CTF_MAGIC_NUMBER;
+#if 0
+       /* TODO: move start time to metadata */
        header->major_version = LTT_TRACER_VERSION_MAJOR;
        header->minor_version = LTT_TRACER_VERSION_MINOR;
        header->arch_size = sizeof(void *);
-       header->alignment = lib_ring_buffer_get_alignment();
-       header->start_time_sec = trace->start_time.tv_sec;
-       header->start_time_usec = trace->start_time.tv_usec;
-       header->start_freq = trace->start_freq;
-       header->freq_scale = trace->freq_scale;
+       header->alignment = lib_ring_buffer_get_alignment(config);
+       header->start_time_sec = ltt_chan->session->start_time.tv_sec;
+       header->start_time_usec = ltt_chan->session->start_time.tv_usec;
+       header->start_freq = ltt_chan->session->start_freq;
+       header->freq_scale = ltt_chan->session->freq_scale;
+#endif //0
 }
 
 /*
@@ -506,87 +309,12 @@ extern int ltt_module_register(enum ltt_module_function name, void *function,
                               struct module *owner);
 extern void ltt_module_unregister(enum ltt_module_function name);
 
-void ltt_transport_register(struct ltt_transport *transport);
-void ltt_transport_unregister(struct ltt_transport *transport);
-
 /* Exported control function */
 
-enum ltt_control_msg {
-       LTT_CONTROL_START,
-       LTT_CONTROL_STOP,
-       LTT_CONTROL_CREATE_TRACE,
-       LTT_CONTROL_DESTROY_TRACE
-};
-
-union ltt_control_args {
-       struct {
-               enum trace_mode mode;
-               unsigned int subbuf_size_low;
-               unsigned int n_subbufs_low;
-               unsigned int subbuf_size_med;
-               unsigned int n_subbufs_med;
-               unsigned int subbuf_size_high;
-               unsigned int n_subbufs_high;
-       } new_trace;
-};
-
-int _ltt_trace_setup(const char *trace_name);
-int ltt_trace_setup(const char *trace_name);
-struct ltt_trace *_ltt_trace_find_setup(const char *trace_name);
-int ltt_trace_set_type(const char *trace_name, const char *trace_type);
-int ltt_trace_set_channel_subbufsize(const char *trace_name,
-                                    const char *channel_name,
-                                    unsigned int size);
-int ltt_trace_set_channel_subbufcount(const char *trace_name,
-                                     const char *channel_name,
-                                     unsigned int cnt);
-int ltt_trace_set_channel_switch_timer(const char *trace_name,
-                                      const char *channel_name,
-                                      unsigned long interval);
-int ltt_trace_set_channel_overwrite(const char *trace_name,
-                                   const char *channel_name,
-                                   unsigned int overwrite);
-int ltt_trace_alloc(const char *trace_name);
-int ltt_trace_destroy(const char *trace_name);
-int ltt_trace_start(const char *trace_name);
-int ltt_trace_stop(const char *trace_name);
-
-extern int ltt_control(enum ltt_control_msg msg, const char *trace_name,
-                      const char *trace_type, union ltt_control_args args);
-
-enum ltt_filter_control_msg {
-       LTT_FILTER_DEFAULT_ACCEPT,
-       LTT_FILTER_DEFAULT_REJECT
-};
-
-extern int ltt_filter_control(enum ltt_filter_control_msg msg,
-                             const char *trace_name);
-
-extern struct dentry *get_filter_root(void);
-
 void ltt_core_register(int (*function)(u8, void *));
 
 void ltt_core_unregister(void);
 
-void ltt_release_trace(struct kref *kref);
-void ltt_release_transport(struct kref *kref);
-
-extern int ltt_probe_register(struct ltt_available_probe *pdata);
-extern int ltt_probe_unregister(struct ltt_available_probe *pdata);
-extern int ltt_marker_connect(const char *channel, const char *mname,
-                             const char *pname);
-extern int ltt_marker_disconnect(const char *channel, const char *mname,
-                                const char *pname);
-extern void ltt_dump_marker_state(struct ltt_trace *trace);
-
-void ltt_lock_traces(void);
-void ltt_unlock_traces(void);
-
-extern int ltt_ascii_create_dir(struct ltt_trace *new_trace);
-extern void ltt_ascii_remove_dir(struct ltt_trace *trace);
-extern int ltt_ascii_create(struct ltt_chan *chan);
-extern void ltt_ascii_remove(struct ltt_chan *chan);
-
 extern
 void ltt_statedump_register_kprobes_dump(void (*callback)(void *call_data));
 extern
This page took 0.028064 seconds and 4 git commands to generate.