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