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