event-parse.h

Go to the documentation of this file.

/*
 * Copyright (C) 2009, 2010 Red Hat Inc, Steven Rostedt <[email protected]>
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License (not later!)
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */
#ifndef _PARSE_EVENTS_H
#define _PARSE_EVENTS_H

#include <stdarg.h>
#include <regex.h>

#ifndef __maybe_unused
#define __maybe_unused __attribute__((unused))
#endif

/* ----------------------- trace_seq ----------------------- */


#ifndef TRACE_SEQ_BUF_SIZE
#define TRACE_SEQ_BUF_SIZE 4096
#endif

#ifndef DEBUG_RECORD
#define DEBUG_RECORD 0
#endif

struct pevent_record {
    unsigned long long  ts;
    unsigned long long  offset;
    long long       missed_events;  /* buffer dropped events before */
    int         record_size;    /* size of binary record */
    int         size;       /* size of data */
    void            *data;
    int         cpu;
    int         ref_count;
    int         locked;     /* Do not free, even if ref_count is zero */
    void            *priv;
#if DEBUG_RECORD
    struct pevent_record    *prev;
    struct pevent_record    *next;
    long            alloc_addr;
#endif
};

/*
 * Trace sequences are used to allow a function to call several other functions
 * to create a string of data to use (up to a max of PAGE_SIZE).
 */

struct trace_seq {
    char            *buffer;
    unsigned int        buffer_size;
    unsigned int        len;
    unsigned int        readpos;
};

void trace_seq_init(struct trace_seq *s);
void trace_seq_destroy(struct trace_seq *s);

extern int trace_seq_printf(struct trace_seq *s, const char *fmt, ...)
    __attribute__ ((format (printf, 2, 3)));
extern int trace_seq_vprintf(struct trace_seq *s, const char *fmt, va_list args)
    __attribute__ ((format (printf, 2, 0)));

extern int trace_seq_puts(struct trace_seq *s, const char *str);
extern int trace_seq_putc(struct trace_seq *s, unsigned char c);

extern void trace_seq_terminate(struct trace_seq *s);

extern int trace_seq_do_printf(struct trace_seq *s);


/* ----------------------- pevent ----------------------- */

struct pevent;
struct event_format;

typedef int (*pevent_event_handler_func)(struct trace_seq *s,
                     struct pevent_record *record,
                     struct event_format *event,
                     void *context);

typedef int (*pevent_plugin_load_func)(struct pevent *pevent);
typedef int (*pevent_plugin_unload_func)(void);

struct plugin_option {
    struct plugin_option        *next;
    void                *handle;
    char                *file;
    char                *name;
    char                *plugin_alias;
    char                *description;
    char                *value;
    void                *priv;
    int             set;
};

/*
 * Plugin hooks that can be called:
 *
 * PEVENT_PLUGIN_LOADER:  (required)
 *   The function name to initialized the plugin.
 *
 *   int PEVENT_PLUGIN_LOADER(struct pevent *pevent)
 *
 * PEVENT_PLUGIN_UNLOADER:  (optional)
 *   The function called just before unloading
 *
 *   int PEVENT_PLUGIN_UNLOADER(void)
 *
 * PEVENT_PLUGIN_OPTIONS:  (optional)
 *   Plugin options that can be set before loading
 *
 *   struct plugin_option PEVENT_PLUGIN_OPTIONS[] = {
 *  {
 *      .name = "option-name",
 *      .plugin_alias = "overide-file-name", (optional)
 *      .description = "description of option to show users",
 *  },
 *  {
 *      .name = NULL,
 *  },
 *   };
 *
 *   Array must end with .name = NULL;
 *
 *
 *   .plugin_alias is used to give a shorter name to access
 *   the vairable. Useful if a plugin handles more than one event.
 *
 * PEVENT_PLUGIN_ALIAS: (optional)
 *   The name to use for finding options (uses filename if not defined)
 */
#define PEVENT_PLUGIN_LOADER pevent_plugin_loader
#define PEVENT_PLUGIN_UNLOADER pevent_plugin_unloader
#define PEVENT_PLUGIN_OPTIONS pevent_plugin_options
#define PEVENT_PLUGIN_ALIAS pevent_plugin_alias
#define _MAKE_STR(x)    #x
#define MAKE_STR(x) _MAKE_STR(x)
#define PEVENT_PLUGIN_LOADER_NAME MAKE_STR(PEVENT_PLUGIN_LOADER)
#define PEVENT_PLUGIN_UNLOADER_NAME MAKE_STR(PEVENT_PLUGIN_UNLOADER)
#define PEVENT_PLUGIN_OPTIONS_NAME MAKE_STR(PEVENT_PLUGIN_OPTIONS)
#define PEVENT_PLUGIN_ALIAS_NAME MAKE_STR(PEVENT_PLUGIN_ALIAS)

#define NSECS_PER_SEC       1000000000ULL
#define NSECS_PER_USEC      1000ULL

enum format_flags {
    FIELD_IS_ARRAY      = 1,
    FIELD_IS_POINTER    = 2,
    FIELD_IS_SIGNED     = 4,
    FIELD_IS_STRING     = 8,
    FIELD_IS_DYNAMIC    = 16,
    FIELD_IS_LONG       = 32,
    FIELD_IS_FLAG       = 64,
    FIELD_IS_SYMBOLIC   = 128,
};

struct format_field {
    struct format_field *next;
    struct event_format *event;
    char            *type;
    char            *name;
    int         offset;
    int         size;
    unsigned int        arraylen;
    unsigned int        elementsize;
    unsigned long       flags;
};

struct format {
    int         nr_common;
    int         nr_fields;
    struct format_field *common_fields;
    struct format_field *fields;
};

struct print_arg_atom {
    char            *atom;
};

struct print_arg_string {
    char            *string;
    int         offset;
};

struct print_arg_field {
    char            *name;
    struct format_field *field;
};

struct print_flag_sym {
    struct print_flag_sym   *next;
    char            *value;
    char            *str;
};

struct print_arg_typecast {
    char            *type;
    struct print_arg    *item;
};

struct print_arg_flags {
    struct print_arg    *field;
    char            *delim;
    struct print_flag_sym   *flags;
};

struct print_arg_symbol {
    struct print_arg    *field;
    struct print_flag_sym   *symbols;
};

struct print_arg_hex {
    struct print_arg    *field;
    struct print_arg    *size;
};

struct print_arg_dynarray {
    struct format_field *field;
    struct print_arg    *index;
};

struct print_arg;

struct print_arg_op {
    char            *op;
    int         prio;
    struct print_arg    *left;
    struct print_arg    *right;
};

struct pevent_function_handler;

struct print_arg_func {
    struct pevent_function_handler  *func;
    struct print_arg        *args;
};

enum print_arg_type {
    PRINT_NULL,
    PRINT_ATOM,
    PRINT_FIELD,
    PRINT_FLAGS,
    PRINT_SYMBOL,
    PRINT_HEX,
    PRINT_TYPE,
    PRINT_STRING,
    PRINT_BSTRING,
    PRINT_DYNAMIC_ARRAY,
    PRINT_OP,
    PRINT_FUNC,
};

struct print_arg {
    struct print_arg        *next;
    enum print_arg_type     type;
    union {
        struct print_arg_atom       atom;
        struct print_arg_field      field;
        struct print_arg_typecast   typecast;
        struct print_arg_flags      flags;
        struct print_arg_symbol     symbol;
        struct print_arg_hex        hex;
        struct print_arg_func       func;
        struct print_arg_string     string;
        struct print_arg_op     op;
        struct print_arg_dynarray   dynarray;
    };
};

struct print_fmt {
    char            *format;
    struct print_arg    *args;
};

struct event_format {
    struct pevent       *pevent;
    char            *name;
    int         id;
    int         flags;
    struct format       format;
    struct print_fmt    print_fmt;
    char            *system;
    pevent_event_handler_func handler;
    void            *context;
};

enum {
    EVENT_FL_ISFTRACE   = 0x01,
    EVENT_FL_ISPRINT    = 0x02,
    EVENT_FL_ISBPRINT   = 0x04,
    EVENT_FL_ISFUNCENT  = 0x10,
    EVENT_FL_ISFUNCRET  = 0x20,

    EVENT_FL_FAILED     = 0x80000000
};

enum event_sort_type {
    EVENT_SORT_ID,
    EVENT_SORT_NAME,
    EVENT_SORT_SYSTEM,
};

enum event_type {
    EVENT_ERROR,
    EVENT_NONE,
    EVENT_SPACE,
    EVENT_NEWLINE,
    EVENT_OP,
    EVENT_DELIM,
    EVENT_ITEM,
    EVENT_DQUOTE,
    EVENT_SQUOTE,
};

typedef unsigned long long (*pevent_func_handler)(struct trace_seq *s,
                         unsigned long long *args);

enum pevent_func_arg_type {
    PEVENT_FUNC_ARG_VOID,
    PEVENT_FUNC_ARG_INT,
    PEVENT_FUNC_ARG_LONG,
    PEVENT_FUNC_ARG_STRING,
    PEVENT_FUNC_ARG_PTR,
    PEVENT_FUNC_ARG_MAX_TYPES
};

enum pevent_flag {
    PEVENT_NSEC_OUTPUT      = 1,    /* output in NSECS */
};

#define PEVENT_ERRORS                                 \
    _PE(MEM_ALLOC_FAILED,   "failed to allocate memory"),             \
    _PE(PARSE_EVENT_FAILED, "failed to parse event"),             \
    _PE(READ_ID_FAILED, "failed to read event id"),           \
    _PE(READ_FORMAT_FAILED, "failed to read event format"),           \
    _PE(READ_PRINT_FAILED,  "failed to read event print fmt"),        \
    _PE(OLD_FTRACE_ARG_FAILED,"failed to allocate field name for ftrace"),\
    _PE(INVALID_ARG_TYPE,   "invalid argument type")

#undef _PE
#define _PE(__code, __str) PEVENT_ERRNO__ ## __code
enum pevent_errno {
    PEVENT_ERRNO__SUCCESS           = 0,

    /*
     * Choose an arbitrary negative big number not to clash with standard
     * errno since SUS requires the errno has distinct positive values.
     * See 'Issue 6' in the link below.
     *
     * http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/errno.h.html
     */
    __PEVENT_ERRNO__START           = -100000,

    PEVENT_ERRORS,

    __PEVENT_ERRNO__END,
};
#undef _PE

struct cmdline;
struct cmdline_list;
struct func_map;
struct func_list;
struct event_handler;

struct pevent {
    int ref_count;

    int header_page_ts_offset;
    int header_page_ts_size;
    int header_page_size_offset;
    int header_page_size_size;
    int header_page_data_offset;
    int header_page_data_size;
    int header_page_overwrite;

    int file_bigendian;
    int host_bigendian;

    int latency_format;

    int old_format;

    int cpus;
    int long_size;

    struct cmdline *cmdlines;
    struct cmdline_list *cmdlist;
    int cmdline_count;

    struct func_map *func_map;
    struct func_list *funclist;
    unsigned int func_count;

    struct printk_map *printk_map;
    struct printk_list *printklist;
    unsigned int printk_count;


    struct event_format **events;
    int nr_events;
    struct event_format **sort_events;
    enum event_sort_type last_type;

    int type_offset;
    int type_size;

    int pid_offset;
    int pid_size;

    int pc_offset;
    int pc_size;

    int flags_offset;
    int flags_size;

    int ld_offset;
    int ld_size;

    int print_raw;

    int test_filters;

    int flags;

    struct format_field *bprint_ip_field;
    struct format_field *bprint_fmt_field;
    struct format_field *bprint_buf_field;

    struct event_handler *handlers;
    struct pevent_function_handler *func_handlers;

    /* cache */
    struct event_format *last_event;
};

static inline void pevent_set_flag(struct pevent *pevent, int flag)
{
    pevent->flags |= flag;
}

static inline unsigned short
__data2host2(struct pevent *pevent, unsigned short data)
{
    unsigned short swap;

    if (pevent->host_bigendian == pevent->file_bigendian)
        return data;

    swap = ((data & 0xffULL) << 8) |
        ((data & (0xffULL << 8)) >> 8);

    return swap;
}

static inline unsigned int
__data2host4(struct pevent *pevent, unsigned int data)
{
    unsigned int swap;

    if (pevent->host_bigendian == pevent->file_bigendian)
        return data;

    swap = ((data & 0xffULL) << 24) |
        ((data & (0xffULL << 8)) << 8) |
        ((data & (0xffULL << 16)) >> 8) |
        ((data & (0xffULL << 24)) >> 24);

    return swap;
}

static inline unsigned long long
__data2host8(struct pevent *pevent, unsigned long long data)
{
    unsigned long long swap;

    if (pevent->host_bigendian == pevent->file_bigendian)
        return data;

    swap = ((data & 0xffULL) << 56) |
        ((data & (0xffULL << 8)) << 40) |
        ((data & (0xffULL << 16)) << 24) |
        ((data & (0xffULL << 24)) << 8) |
        ((data & (0xffULL << 32)) >> 8) |
        ((data & (0xffULL << 40)) >> 24) |
        ((data & (0xffULL << 48)) >> 40) |
        ((data & (0xffULL << 56)) >> 56);

    return swap;
}

#define data2host2(pevent, ptr)     __data2host2(pevent, *(unsigned short *)(ptr))
#define data2host4(pevent, ptr)     __data2host4(pevent, *(unsigned int *)(ptr))
#define data2host8(pevent, ptr)                 \
({                              \
    unsigned long long __val;               \
                                \
    memcpy(&__val, (ptr), sizeof(unsigned long long));  \
    __data2host8(pevent, __val);                \
})

/* taken from kernel/trace/trace.h */
enum trace_flag_type {
    TRACE_FLAG_IRQS_OFF     = 0x01,
    TRACE_FLAG_IRQS_NOSUPPORT   = 0x02,
    TRACE_FLAG_NEED_RESCHED     = 0x04,
    TRACE_FLAG_HARDIRQ      = 0x08,
    TRACE_FLAG_SOFTIRQ      = 0x10,
};

int pevent_register_comm(struct pevent *pevent, const char *comm, int pid);
int pevent_register_function(struct pevent *pevent, char *name,
                 unsigned long long addr, char *mod);
int pevent_register_print_string(struct pevent *pevent, char *fmt,
                 unsigned long long addr);
int pevent_pid_is_registered(struct pevent *pevent, int pid);

void pevent_print_event(struct pevent *pevent, struct trace_seq *s,
            struct pevent_record *record);

int pevent_parse_header_page(struct pevent *pevent, char *buf, unsigned long size,
                 int long_size);

enum pevent_errno pevent_parse_event(struct pevent *pevent, const char *buf,
                     unsigned long size, const char *sys);
enum pevent_errno pevent_parse_format(struct event_format **eventp, const char *buf,
                      unsigned long size, const char *sys);
void pevent_free_format(struct event_format *event);

void *pevent_get_field_raw(struct trace_seq *s, struct event_format *event,
               const char *name, struct pevent_record *record,
               int *len, int err);

int pevent_get_field_val(struct trace_seq *s, struct event_format *event,
             const char *name, struct pevent_record *record,
             unsigned long long *val, int err);
int pevent_get_common_field_val(struct trace_seq *s, struct event_format *event,
                const char *name, struct pevent_record *record,
                unsigned long long *val, int err);
int pevent_get_any_field_val(struct trace_seq *s, struct event_format *event,
                 const char *name, struct pevent_record *record,
                 unsigned long long *val, int err);

int pevent_print_num_field(struct trace_seq *s, const char *fmt,
               struct event_format *event, const char *name,
               struct pevent_record *record, int err);

int pevent_register_event_handler(struct pevent *pevent, int id, char *sys_name, char *event_name,
                  pevent_event_handler_func func, void *context);
int pevent_register_print_function(struct pevent *pevent,
                   pevent_func_handler func,
                   enum pevent_func_arg_type ret_type,
                   char *name, ...);

struct format_field *pevent_find_common_field(struct event_format *event, const char *name);
struct format_field *pevent_find_field(struct event_format *event, const char *name);
struct format_field *pevent_find_any_field(struct event_format *event, const char *name);

const char *pevent_find_function(struct pevent *pevent, unsigned long long addr);
unsigned long long
pevent_find_function_address(struct pevent *pevent, unsigned long long addr);
unsigned long long pevent_read_number(struct pevent *pevent, const void *ptr, int size);
int pevent_read_number_field(struct format_field *field, const void *data,
                 unsigned long long *value);

struct event_format *pevent_find_event(struct pevent *pevent, int id);

struct event_format *
pevent_find_event_by_name(struct pevent *pevent, const char *sys, const char *name);

void pevent_data_lat_fmt(struct pevent *pevent,
             struct trace_seq *s, struct pevent_record *record);
int pevent_data_type(struct pevent *pevent, struct pevent_record *rec);
struct event_format *pevent_data_event_from_type(struct pevent *pevent, int type);
int pevent_data_pid(struct pevent *pevent, struct pevent_record *rec);
const char *pevent_data_comm_from_pid(struct pevent *pevent, int pid);
void pevent_event_info(struct trace_seq *s, struct event_format *event,
               struct pevent_record *record);
int pevent_strerror(struct pevent *pevent, enum pevent_errno errnum,
            char *buf, size_t buflen);

struct event_format **pevent_list_events(struct pevent *pevent, enum event_sort_type);
struct format_field **pevent_event_common_fields(struct event_format *event);
struct format_field **pevent_event_fields(struct event_format *event);

static inline int pevent_get_cpus(struct pevent *pevent)
{
    return pevent->cpus;
}

static inline void pevent_set_cpus(struct pevent *pevent, int cpus)
{
    pevent->cpus = cpus;
}

static inline int pevent_get_long_size(struct pevent *pevent)
{
    return pevent->long_size;
}

static inline void pevent_set_long_size(struct pevent *pevent, int long_size)
{
    pevent->long_size = long_size;
}

static inline int pevent_is_file_bigendian(struct pevent *pevent)
{
    return pevent->file_bigendian;
}

static inline void pevent_set_file_bigendian(struct pevent *pevent, int endian)
{
    pevent->file_bigendian = endian;
}

static inline int pevent_is_host_bigendian(struct pevent *pevent)
{
    return pevent->host_bigendian;
}

static inline void pevent_set_host_bigendian(struct pevent *pevent, int endian)
{
    pevent->host_bigendian = endian;
}

static inline int pevent_is_latency_format(struct pevent *pevent)
{
    return pevent->latency_format;
}

static inline void pevent_set_latency_format(struct pevent *pevent, int lat)
{
    pevent->latency_format = lat;
}

struct pevent *pevent_alloc(void);
void pevent_free(struct pevent *pevent);
void pevent_ref(struct pevent *pevent);
void pevent_unref(struct pevent *pevent);

/* access to the internal parser */
void pevent_buffer_init(const char *buf, unsigned long long size);
enum event_type pevent_read_token(char **tok);
void pevent_free_token(char *token);
int pevent_peek_char(void);
const char *pevent_get_input_buf(void);
unsigned long long pevent_get_input_buf_ptr(void);

/* for debugging */
void pevent_print_funcs(struct pevent *pevent);
void pevent_print_printk(struct pevent *pevent);

/* ----------------------- filtering ----------------------- */

enum filter_boolean_type {
    FILTER_FALSE,
    FILTER_TRUE,
};

enum filter_op_type {
    FILTER_OP_AND = 1,
    FILTER_OP_OR,
    FILTER_OP_NOT,
};

enum filter_cmp_type {
    FILTER_CMP_NONE,
    FILTER_CMP_EQ,
    FILTER_CMP_NE,
    FILTER_CMP_GT,
    FILTER_CMP_LT,
    FILTER_CMP_GE,
    FILTER_CMP_LE,
    FILTER_CMP_MATCH,
    FILTER_CMP_NOT_MATCH,
    FILTER_CMP_REGEX,
    FILTER_CMP_NOT_REGEX,
};

enum filter_exp_type {
    FILTER_EXP_NONE,
    FILTER_EXP_ADD,
    FILTER_EXP_SUB,
    FILTER_EXP_MUL,
    FILTER_EXP_DIV,
    FILTER_EXP_MOD,
    FILTER_EXP_RSHIFT,
    FILTER_EXP_LSHIFT,
    FILTER_EXP_AND,
    FILTER_EXP_OR,
    FILTER_EXP_XOR,
    FILTER_EXP_NOT,
};

enum filter_arg_type {
    FILTER_ARG_NONE,
    FILTER_ARG_BOOLEAN,
    FILTER_ARG_VALUE,
    FILTER_ARG_FIELD,
    FILTER_ARG_EXP,
    FILTER_ARG_OP,
    FILTER_ARG_NUM,
    FILTER_ARG_STR,
};

enum filter_value_type {
    FILTER_NUMBER,
    FILTER_STRING,
    FILTER_CHAR
};

struct fliter_arg;

struct filter_arg_boolean {
    enum filter_boolean_type    value;
};

struct filter_arg_field {
    struct format_field *field;
};

struct filter_arg_value {
    enum filter_value_type  type;
    union {
        char            *str;
        unsigned long long  val;
    };
};

struct filter_arg_op {
    enum filter_op_type type;
    struct filter_arg   *left;
    struct filter_arg   *right;
};

struct filter_arg_exp {
    enum filter_exp_type    type;
    struct filter_arg   *left;
    struct filter_arg   *right;
};

struct filter_arg_num {
    enum filter_cmp_type    type;
    struct filter_arg   *left;
    struct filter_arg   *right;
};

struct filter_arg_str {
    enum filter_cmp_type    type;
    struct format_field *field;
    char            *val;
    char            *buffer;
    regex_t         reg;
};

struct filter_arg {
    enum filter_arg_type    type;
    union {
        struct filter_arg_boolean   boolean;
        struct filter_arg_field     field;
        struct filter_arg_value     value;
        struct filter_arg_op        op;
        struct filter_arg_exp       exp;
        struct filter_arg_num       num;
        struct filter_arg_str       str;
    };
};

struct filter_type {
    int         event_id;
    struct event_format *event;
    struct filter_arg   *filter;
};

struct event_filter {
    struct pevent       *pevent;
    int         filters;
    struct filter_type  *event_filters;
};

struct event_filter *pevent_filter_alloc(struct pevent *pevent);

#define FILTER_NONE     -2
#define FILTER_NOEXIST      -1
#define FILTER_MISS     0
#define FILTER_MATCH        1

enum filter_trivial_type {
    FILTER_TRIVIAL_FALSE,
    FILTER_TRIVIAL_TRUE,
    FILTER_TRIVIAL_BOTH,
};

int pevent_filter_add_filter_str(struct event_filter *filter,
                 const char *filter_str,
                 char **error_str);


int pevent_filter_match(struct event_filter *filter,
            struct pevent_record *record);

int pevent_event_filtered(struct event_filter *filter,
              int event_id);

void pevent_filter_reset(struct event_filter *filter);

void pevent_filter_clear_trivial(struct event_filter *filter,
                 enum filter_trivial_type type);

void pevent_filter_free(struct event_filter *filter);

char *pevent_filter_make_string(struct event_filter *filter, int event_id);

int pevent_filter_remove_event(struct event_filter *filter,
                   int event_id);

int pevent_filter_event_has_trivial(struct event_filter *filter,
                    int event_id,
                    enum filter_trivial_type type);

int pevent_filter_copy(struct event_filter *dest, struct event_filter *source);

int pevent_update_trivial(struct event_filter *dest, struct event_filter *source,
              enum filter_trivial_type type);

int pevent_filter_compare(struct event_filter *filter1, struct event_filter *filter2);

#endif /* _PARSE_EVENTS_H */