perf/util/session.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 #ifndef __PERF_SESSION_H
0003 #define __PERF_SESSION_H
0004
0005 #include "trace-event.h"
0006 #include "event.h"
0007 #include "header.h"
0008 #include "machine.h"
0009 #include "data.h"
0010 #include "ordered-events.h"
0011 #include "util/compress.h"
0012 #include <linux/kernel.h>
0013 #include <linux/rbtree.h>
0014 #include <linux/perf_event.h>
0015
0016 struct ip_callchain;
0017 struct symbol;
0018 struct thread;
0019
0020 struct auxtrace;
0021 struct itrace_synth_opts;
0022
0023 struct decomp_data {
0024     struct decomp    *decomp;
0025     struct decomp    *decomp_last;
0026     struct zstd_data *zstd_decomp;
0027 };
0028
0029 struct perf_session {
0030     struct perf_header  header;
0031     struct machines     machines;
0032     struct evlist   *evlist;
0033     struct auxtrace     *auxtrace;
0034     struct itrace_synth_opts *itrace_synth_opts;
0035     struct list_head    auxtrace_index;
0036     struct trace_event  tevent;
0037     struct perf_record_time_conv    time_conv;
0038     bool            repipe;
0039     bool            one_mmap;
0040     void            *one_mmap_addr;
0041     u64         one_mmap_offset;
0042     struct ordered_events   ordered_events;
0043     struct perf_data    *data;
0044     struct perf_tool    *tool;
0045     u64         bytes_transferred;
0046     u64         bytes_compressed;
0047     struct zstd_data    zstd_data;
0048     struct decomp_data  decomp_data;
0049     struct decomp_data  *active_decomp;
0050 };
0051
0052 struct decomp {
0053     struct decomp *next;
0054     u64 file_pos;
0055     const char *file_path;
0056     size_t mmap_len;
0057     u64 head;
0058     size_t size;
0059     char data[];
0060 };
0061
0062 struct perf_tool;
0063
0064 struct perf_session *__perf_session__new(struct perf_data *data,
0065                      bool repipe, int repipe_fd,
0066                      struct perf_tool *tool);
0067
0068 static inline struct perf_session *perf_session__new(struct perf_data *data,
0069                              struct perf_tool *tool)
0070 {
0071     return __perf_session__new(data, false, -1, tool);
0072 }
0073
0074 void perf_session__delete(struct perf_session *session);
0075
0076 void perf_event_header__bswap(struct perf_event_header *hdr);
0077
0078 int perf_session__peek_event(struct perf_session *session, off_t file_offset,
0079                  void *buf, size_t buf_sz,
0080                  union perf_event **event_ptr,
0081                  struct perf_sample *sample);
0082 typedef int (*peek_events_cb_t)(struct perf_session *session,
0083                 union perf_event *event, u64 offset,
0084                 void *data);
0085 int perf_session__peek_events(struct perf_session *session, u64 offset,
0086                   u64 size, peek_events_cb_t cb, void *data);
0087
0088 int perf_session__process_events(struct perf_session *session);
0089
0090 int perf_session__queue_event(struct perf_session *s, union perf_event *event,
0091                   u64 timestamp, u64 file_offset, const char *file_path);
0092
0093 void perf_tool__fill_defaults(struct perf_tool *tool);
0094
0095 int perf_session__resolve_callchain(struct perf_session *session,
0096                     struct evsel *evsel,
0097                     struct thread *thread,
0098                     struct ip_callchain *chain,
0099                     struct symbol **parent);
0100
0101 bool perf_session__has_traces(struct perf_session *session, const char *msg);
0102
0103 void perf_event__attr_swap(struct perf_event_attr *attr);
0104
0105 int perf_session__create_kernel_maps(struct perf_session *session);
0106
0107 void perf_session__set_id_hdr_size(struct perf_session *session);
0108
0109 static inline
0110 struct machine *perf_session__find_machine(struct perf_session *session, pid_t pid)
0111 {
0112     return machines__find(&session->machines, pid);
0113 }
0114
0115 static inline
0116 struct machine *perf_session__findnew_machine(struct perf_session *session, pid_t pid)
0117 {
0118     return machines__findnew(&session->machines, pid);
0119 }
0120
0121 struct thread *perf_session__findnew(struct perf_session *session, pid_t pid);
0122 int perf_session__register_idle_thread(struct perf_session *session);
0123
0124 size_t perf_session__fprintf(struct perf_session *session, FILE *fp);
0125
0126 size_t perf_session__fprintf_dsos(struct perf_session *session, FILE *fp);
0127
0128 size_t perf_session__fprintf_dsos_buildid(struct perf_session *session, FILE *fp,
0129                       bool (fn)(struct dso *dso, int parm), int parm);
0130
0131 size_t perf_session__fprintf_nr_events(struct perf_session *session, FILE *fp,
0132                        bool skip_empty);
0133
0134 struct evsel *perf_session__find_first_evtype(struct perf_session *session,
0135                         unsigned int type);
0136
0137 int perf_session__cpu_bitmap(struct perf_session *session,
0138                  const char *cpu_list, unsigned long *cpu_bitmap);
0139
0140 void perf_session__fprintf_info(struct perf_session *s, FILE *fp, bool full);
0141
0142 struct evsel_str_handler;
0143
0144 #define perf_session__set_tracepoints_handlers(session, array) \
0145     __evlist__set_tracepoints_handlers(session->evlist, array, ARRAY_SIZE(array))
0146
0147 extern volatile int session_done;
0148
0149 #define session_done()  READ_ONCE(session_done)
0150
0151 int perf_session__deliver_synth_event(struct perf_session *session,
0152                       union perf_event *event,
0153                       struct perf_sample *sample);
0154
0155 int perf_event__process_id_index(struct perf_session *session,
0156                  union perf_event *event);
0157
0158 int perf_event__process_finished_round(struct perf_tool *tool,
0159                        union perf_event *event,
0160                        struct ordered_events *oe);
0161
0162 #endif /* __PERF_SESSION_H */