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