header.h 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. #ifndef __PERF_HEADER_H
  3. #define __PERF_HEADER_H
  4. #include <linux/stddef.h>
  5. #include <linux/perf_event.h>
  6. #include <sys/types.h>
  7. #include <stdio.h> // FILE
  8. #include <stdbool.h>
  9. #include <linux/bitmap.h>
  10. #include <linux/types.h>
  11. #include "env.h"
  12. #include "pmu.h"
  13. enum {
  14. HEADER_RESERVED = 0, /* always cleared */
  15. HEADER_FIRST_FEATURE = 1,
  16. HEADER_TRACING_DATA = 1,
  17. HEADER_BUILD_ID,
  18. HEADER_HOSTNAME,
  19. HEADER_OSRELEASE,
  20. HEADER_VERSION,
  21. HEADER_ARCH,
  22. HEADER_NRCPUS,
  23. HEADER_CPUDESC,
  24. HEADER_CPUID,
  25. HEADER_TOTAL_MEM,
  26. HEADER_CMDLINE,
  27. HEADER_EVENT_DESC,
  28. HEADER_CPU_TOPOLOGY,
  29. HEADER_NUMA_TOPOLOGY,
  30. HEADER_BRANCH_STACK,
  31. HEADER_PMU_MAPPINGS,
  32. HEADER_GROUP_DESC,
  33. HEADER_AUXTRACE,
  34. HEADER_STAT,
  35. HEADER_CACHE,
  36. HEADER_SAMPLE_TIME,
  37. HEADER_MEM_TOPOLOGY,
  38. HEADER_CLOCKID,
  39. HEADER_DIR_FORMAT,
  40. HEADER_BPF_PROG_INFO,
  41. HEADER_BPF_BTF,
  42. HEADER_COMPRESSED,
  43. HEADER_CPU_PMU_CAPS,
  44. HEADER_CLOCK_DATA,
  45. HEADER_LAST_FEATURE,
  46. HEADER_FEAT_BITS = 256,
  47. };
  48. enum perf_header_version {
  49. PERF_HEADER_VERSION_1,
  50. PERF_HEADER_VERSION_2,
  51. };
  52. struct perf_file_section {
  53. u64 offset;
  54. u64 size;
  55. };
  56. struct perf_file_header {
  57. u64 magic;
  58. u64 size;
  59. u64 attr_size;
  60. struct perf_file_section attrs;
  61. struct perf_file_section data;
  62. /* event_types is ignored */
  63. struct perf_file_section event_types;
  64. DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
  65. };
  66. struct perf_pipe_file_header {
  67. u64 magic;
  68. u64 size;
  69. };
  70. struct perf_header;
  71. int perf_file_header__read(struct perf_file_header *header,
  72. struct perf_header *ph, int fd);
  73. struct perf_header {
  74. enum perf_header_version version;
  75. bool needs_swap;
  76. u64 data_offset;
  77. u64 data_size;
  78. u64 feat_offset;
  79. DECLARE_BITMAP(adds_features, HEADER_FEAT_BITS);
  80. struct perf_env env;
  81. };
  82. struct feat_fd {
  83. struct perf_header *ph;
  84. int fd;
  85. void *buf; /* Either buf != NULL or fd >= 0 */
  86. ssize_t offset;
  87. size_t size;
  88. struct evsel *events;
  89. };
  90. struct perf_header_feature_ops {
  91. int (*write)(struct feat_fd *ff, struct evlist *evlist);
  92. void (*print)(struct feat_fd *ff, FILE *fp);
  93. int (*process)(struct feat_fd *ff, void *data);
  94. const char *name;
  95. bool full_only;
  96. bool synthesize;
  97. };
  98. struct evlist;
  99. struct perf_session;
  100. struct perf_tool;
  101. union perf_event;
  102. int perf_session__read_header(struct perf_session *session);
  103. int perf_session__write_header(struct perf_session *session,
  104. struct evlist *evlist,
  105. int fd, bool at_exit);
  106. int perf_header__write_pipe(int fd);
  107. void perf_header__set_feat(struct perf_header *header, int feat);
  108. void perf_header__clear_feat(struct perf_header *header, int feat);
  109. bool perf_header__has_feat(const struct perf_header *header, int feat);
  110. int perf_header__set_cmdline(int argc, const char **argv);
  111. int perf_header__process_sections(struct perf_header *header, int fd,
  112. void *data,
  113. int (*process)(struct perf_file_section *section,
  114. struct perf_header *ph,
  115. int feat, int fd, void *data));
  116. int perf_header__fprintf_info(struct perf_session *s, FILE *fp, bool full);
  117. int perf_event__process_feature(struct perf_session *session,
  118. union perf_event *event);
  119. int perf_event__process_attr(struct perf_tool *tool, union perf_event *event,
  120. struct evlist **pevlist);
  121. int perf_event__process_event_update(struct perf_tool *tool,
  122. union perf_event *event,
  123. struct evlist **pevlist);
  124. size_t perf_event__fprintf_event_update(union perf_event *event, FILE *fp);
  125. int perf_event__process_tracing_data(struct perf_session *session,
  126. union perf_event *event);
  127. int perf_event__process_build_id(struct perf_session *session,
  128. union perf_event *event);
  129. bool is_perf_magic(u64 magic);
  130. #define NAME_ALIGN 64
  131. struct feat_fd;
  132. int do_write(struct feat_fd *fd, const void *buf, size_t size);
  133. int write_padded(struct feat_fd *fd, const void *bf,
  134. size_t count, size_t count_aligned);
  135. /*
  136. * arch specific callback
  137. */
  138. int get_cpuid(char *buffer, size_t sz);
  139. char *get_cpuid_str(struct perf_pmu *pmu __maybe_unused);
  140. int strcmp_cpuid_str(const char *s1, const char *s2);
  141. #endif /* __PERF_HEADER_H */