tools/perf/util/header.h

   1 #ifndef __PERF_HEADER_H
   2 #define __PERF_HEADER_H
   3
   4 #include <linux/perf_event.h>
   5 #include <sys/types.h>
   6 #include <stdbool.h>
   7 #include <linux/bitmap.h>
   8 #include <linux/types.h>
   9 #include "event.h"
  10 #include "env.h"
  11
  12 enum {
  13         HEADER_RESERVED         = 0,    /* always cleared */
  14         HEADER_FIRST_FEATURE    = 1,
  15         HEADER_TRACING_DATA     = 1,
  16         HEADER_BUILD_ID,
  17
  18         HEADER_HOSTNAME,
  19         HEADER_OSRELEASE,
  20         HEADER_VERSION,
  21         HEADER_ARCH,
  22         HEADER_NRCPUS,
  23         HEADER_CPUDESC,
  24         HEADER_CPUID,
  25         HEADER_TOTAL_MEM,
  26         HEADER_CMDLINE,
  27         HEADER_EVENT_DESC,
  28         HEADER_CPU_TOPOLOGY,
  29         HEADER_NUMA_TOPOLOGY,
  30         HEADER_BRANCH_STACK,
  31         HEADER_PMU_MAPPINGS,
  32         HEADER_GROUP_DESC,
  33         HEADER_AUXTRACE,
  34         HEADER_STAT,
  35         HEADER_LAST_FEATURE,
  36         HEADER_FEAT_BITS        = 256,
  37 };
  38
  39 enum perf_header_version {
  40         PERF_HEADER_VERSION_1,
  41         PERF_HEADER_VERSION_2,
  42 };
  43
  44 struct perf_file_section {
  45         u64 offset;
  46         u64 size;
  47 };
  48
  49 struct perf_file_header {
  50         u64                             magic;
  51         u64                             size;
  52         u64                             attr_size;
  53         struct perf_file_section        attrs;
  54         struct perf_file_section        data;
  55         /* event_types is ignored */
  56         struct perf_file_section        event_types;
  57         DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
  58 };
  59
  60 struct perf_pipe_file_header {
  61         u64                             magic;
  62         u64                             size;
  63 };
  64
  65 struct perf_header;
  66
  67 int perf_file_header__read(struct perf_file_header *header,
  68                            struct perf_header *ph, int fd);
  69
  70 struct perf_header {
  71         enum perf_header_version        version;
  72         bool                            needs_swap;
  73         u64                             data_offset;
  74         u64                             data_size;
  75         u64                             feat_offset;
  76         DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
  77         struct perf_env         env;
  78 };
  79
  80 struct perf_evlist;
  81 struct perf_session;
  82
  83 int perf_session__read_header(struct perf_session *session);
  84 int perf_session__write_header(struct perf_session *session,
  85                                struct perf_evlist *evlist,
  86                                int fd, bool at_exit);
  87 int perf_header__write_pipe(int fd);
  88
  89 void perf_header__set_feat(struct perf_header *header, int feat);
  90 void perf_header__clear_feat(struct perf_header *header, int feat);
  91 bool perf_header__has_feat(const struct perf_header *header, int feat);
  92
  93 int perf_header__set_cmdline(int argc, const char **argv);
  94
  95 int perf_header__process_sections(struct perf_header *header, int fd,
  96                                   void *data,
  97                                   int (*process)(struct perf_file_section *section,
  98                                   struct perf_header *ph,
  99                                   int feat, int fd, void *data));
 100
 101 int perf_header__fprintf_info(struct perf_session *s, FILE *fp, bool full);
 102
 103 int perf_event__synthesize_attr(struct perf_tool *tool,
 104                                 struct perf_event_attr *attr, u32 ids, u64 *id,
 105                                 perf_event__handler_t process);
 106 int perf_event__synthesize_attrs(struct perf_tool *tool,
 107                                  struct perf_session *session,
 108                                  perf_event__handler_t process);
 109 int perf_event__synthesize_event_update_unit(struct perf_tool *tool,
 110                                              struct perf_evsel *evsel,
 111                                              perf_event__handler_t process);
 112 int perf_event__synthesize_event_update_scale(struct perf_tool *tool,
 113                                               struct perf_evsel *evsel,
 114                                               perf_event__handler_t process);
 115 int perf_event__synthesize_event_update_name(struct perf_tool *tool,
 116                                              struct perf_evsel *evsel,
 117                                              perf_event__handler_t process);
 118 int perf_event__synthesize_event_update_cpus(struct perf_tool *tool,
 119                                              struct perf_evsel *evsel,
 120                                              perf_event__handler_t process);
 121 int perf_event__process_attr(struct perf_tool *tool, union perf_event *event,
 122                              struct perf_evlist **pevlist);
 123 int perf_event__process_event_update(struct perf_tool *tool __maybe_unused,
 124                                      union perf_event *event,
 125                                      struct perf_evlist **pevlist);
 126 size_t perf_event__fprintf_event_update(union perf_event *event, FILE *fp);
 127
 128 int perf_event__synthesize_tracing_data(struct perf_tool *tool,
 129                                         int fd, struct perf_evlist *evlist,
 130                                         perf_event__handler_t process);
 131 int perf_event__process_tracing_data(struct perf_tool *tool,
 132                                      union perf_event *event,
 133                                      struct perf_session *session);
 134
 135 int perf_event__synthesize_build_id(struct perf_tool *tool,
 136                                     struct dso *pos, u16 misc,
 137                                     perf_event__handler_t process,
 138                                     struct machine *machine);
 139 int perf_event__process_build_id(struct perf_tool *tool,
 140                                  union perf_event *event,
 141                                  struct perf_session *session);
 142 bool is_perf_magic(u64 magic);
 143
 144 #define NAME_ALIGN 64
 145
 146 int write_padded(int fd, const void *bf, size_t count, size_t count_aligned);
 147
 148 /*
 149  * arch specific callback
 150  */
 151 int get_cpuid(char *buffer, size_t sz);
 152
 153 #endif /* __PERF_HEADER_H */