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
  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_LAST_FEATURE,
  35         HEADER_FEAT_BITS        = 256,
  36 };
  37
  38 enum perf_header_version {
  39         PERF_HEADER_VERSION_1,
  40         PERF_HEADER_VERSION_2,
  41 };
  42
  43 struct perf_file_section {
  44         u64 offset;
  45         u64 size;
  46 };
  47
  48 struct perf_file_header {
  49         u64                             magic;
  50         u64                             size;
  51         u64                             attr_size;
  52         struct perf_file_section        attrs;
  53         struct perf_file_section        data;
  54         /* event_types is ignored */
  55         struct perf_file_section        event_types;
  56         DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
  57 };
  58
  59 struct perf_pipe_file_header {
  60         u64                             magic;
  61         u64                             size;
  62 };
  63
  64 struct perf_header;
  65
  66 int perf_file_header__read(struct perf_file_header *header,
  67                            struct perf_header *ph, int fd);
  68
  69 struct perf_session_env {
  70         char                    *hostname;
  71         char                    *os_release;
  72         char                    *version;
  73         char                    *arch;
  74         int                     nr_cpus_online;
  75         int                     nr_cpus_avail;
  76         char                    *cpu_desc;
  77         char                    *cpuid;
  78         unsigned long long      total_mem;
  79
  80         int                     nr_cmdline;
  81         int                     nr_sibling_cores;
  82         int                     nr_sibling_threads;
  83         int                     nr_numa_nodes;
  84         int                     nr_pmu_mappings;
  85         int                     nr_groups;
  86         char                    *cmdline;
  87         const char              **cmdline_argv;
  88         char                    *sibling_cores;
  89         char                    *sibling_threads;
  90         char                    *numa_nodes;
  91         char                    *pmu_mappings;
  92 };
  93
  94 struct perf_header {
  95         enum perf_header_version        version;
  96         bool                            needs_swap;
  97         u64                             data_offset;
  98         u64                             data_size;
  99         u64                             feat_offset;
 100         DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
 101         struct perf_session_env         env;
 102 };
 103
 104 struct perf_evlist;
 105 struct perf_session;
 106
 107 int perf_session__read_header(struct perf_session *session);
 108 int perf_session__write_header(struct perf_session *session,
 109                                struct perf_evlist *evlist,
 110                                int fd, bool at_exit);
 111 int perf_header__write_pipe(int fd);
 112
 113 void perf_header__set_feat(struct perf_header *header, int feat);
 114 void perf_header__clear_feat(struct perf_header *header, int feat);
 115 bool perf_header__has_feat(const struct perf_header *header, int feat);
 116
 117 int perf_header__set_cmdline(int argc, const char **argv);
 118
 119 int perf_header__process_sections(struct perf_header *header, int fd,
 120                                   void *data,
 121                                   int (*process)(struct perf_file_section *section,
 122                                   struct perf_header *ph,
 123                                   int feat, int fd, void *data));
 124
 125 int perf_header__fprintf_info(struct perf_session *s, FILE *fp, bool full);
 126
 127 int perf_event__synthesize_attr(struct perf_tool *tool,
 128                                 struct perf_event_attr *attr, u32 ids, u64 *id,
 129                                 perf_event__handler_t process);
 130 int perf_event__synthesize_attrs(struct perf_tool *tool,
 131                                  struct perf_session *session,
 132                                  perf_event__handler_t process);
 133 int perf_event__process_attr(struct perf_tool *tool, union perf_event *event,
 134                              struct perf_evlist **pevlist);
 135
 136 int perf_event__synthesize_tracing_data(struct perf_tool *tool,
 137                                         int fd, struct perf_evlist *evlist,
 138                                         perf_event__handler_t process);
 139 int perf_event__process_tracing_data(struct perf_tool *tool,
 140                                      union perf_event *event,
 141                                      struct perf_session *session);
 142
 143 int perf_event__synthesize_build_id(struct perf_tool *tool,
 144                                     struct dso *pos, u16 misc,
 145                                     perf_event__handler_t process,
 146                                     struct machine *machine);
 147 int perf_event__process_build_id(struct perf_tool *tool,
 148                                  union perf_event *event,
 149                                  struct perf_session *session);
 150 bool is_perf_magic(u64 magic);
 151
 152 #define NAME_ALIGN 64
 153
 154 int write_padded(int fd, const void *bf, size_t count, size_t count_aligned);
 155
 156 /*
 157  * arch specific callback
 158  */
 159 int get_cpuid(char *buffer, size_t sz);
 160
 161 #endif /* __PERF_HEADER_H */