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 <stdio.h> // FILE
   9 #include <stdbool.h>
  10 #include <linux/bitmap.h>
  11 #include <linux/types.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_COMPRESSED,
  46         HEADER_CPU_PMU_CAPS,
  47         HEADER_LAST_FEATURE,
  48         HEADER_FEAT_BITS        = 256,
  49 };
  50
  51 enum perf_header_version {
  52         PERF_HEADER_VERSION_1,
  53         PERF_HEADER_VERSION_2,
  54 };
  55
  56 struct perf_file_section {
  57         u64 offset;
  58         u64 size;
  59 };
  60
  61 struct perf_file_header {
  62         u64                             magic;
  63         u64                             size;
  64         u64                             attr_size;
  65         struct perf_file_section        attrs;
  66         struct perf_file_section        data;
  67         /* event_types is ignored */
  68         struct perf_file_section        event_types;
  69         DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
  70 };
  71
  72 struct perf_pipe_file_header {
  73         u64                             magic;
  74         u64                             size;
  75 };
  76
  77 struct perf_header;
  78
  79 int perf_file_header__read(struct perf_file_header *header,
  80                            struct perf_header *ph, int fd);
  81
  82 struct perf_header {
  83         enum perf_header_version        version;
  84         bool                            needs_swap;
  85         u64                             data_offset;
  86         u64                             data_size;
  87         u64                             feat_offset;
  88         DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
  89         struct perf_env         env;
  90 };
  91
  92 struct feat_fd {
  93         struct perf_header *ph;
  94         int                fd;
  95         void               *buf;        /* Either buf != NULL or fd >= 0 */
  96         ssize_t            offset;
  97         size_t             size;
  98         struct evsel       *events;
  99 };
 100
 101 struct perf_header_feature_ops {
 102         int        (*write)(struct feat_fd *ff, struct evlist *evlist);
 103         void       (*print)(struct feat_fd *ff, FILE *fp);
 104         int        (*process)(struct feat_fd *ff, void *data);
 105         const char *name;
 106         bool       full_only;
 107         bool       synthesize;
 108 };
 109
 110 struct evlist;
 111 struct perf_session;
 112 struct perf_tool;
 113 union perf_event;
 114
 115 int perf_session__read_header(struct perf_session *session);
 116 int perf_session__write_header(struct perf_session *session,
 117                                struct evlist *evlist,
 118                                int fd, bool at_exit);
 119 int perf_header__write_pipe(int fd);
 120
 121 void perf_header__set_feat(struct perf_header *header, int feat);
 122 void perf_header__clear_feat(struct perf_header *header, int feat);
 123 bool perf_header__has_feat(const struct perf_header *header, int feat);
 124
 125 int perf_header__set_cmdline(int argc, const char **argv);
 126
 127 int perf_header__process_sections(struct perf_header *header, int fd,
 128                                   void *data,
 129                                   int (*process)(struct perf_file_section *section,
 130                                   struct perf_header *ph,
 131                                   int feat, int fd, void *data));
 132
 133 int perf_header__fprintf_info(struct perf_session *s, FILE *fp, bool full);
 134
 135 int perf_event__process_feature(struct perf_session *session,
 136                                 union perf_event *event);
 137 int perf_event__process_attr(struct perf_tool *tool, union perf_event *event,
 138                              struct evlist **pevlist);
 139 int perf_event__process_event_update(struct perf_tool *tool,
 140                                      union perf_event *event,
 141                                      struct evlist **pevlist);
 142 size_t perf_event__fprintf_event_update(union perf_event *event, FILE *fp);
 143 int perf_event__process_tracing_data(struct perf_session *session,
 144                                      union perf_event *event);
 145 int perf_event__process_build_id(struct perf_session *session,
 146                                  union perf_event *event);
 147 bool is_perf_magic(u64 magic);
 148
 149 #define NAME_ALIGN 64
 150
 151 struct feat_fd;
 152
 153 int do_write(struct feat_fd *fd, const void *buf, size_t size);
 154
 155 int write_padded(struct feat_fd *fd, const void *bf,
 156                  size_t count, size_t count_aligned);
 157
 158 /*
 159  * arch specific callback
 160  */
 161 int get_cpuid(char *buffer, size_t sz);
 162
 163 char *get_cpuid_str(struct perf_pmu *pmu __maybe_unused);
 164 int strcmp_cpuid_str(const char *s1, const char *s2);
 165 #endif /* __PERF_HEADER_H */