tools/perf/util/header.h

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