2 * Copyright (c) 2020 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #ifndef __perfmon_perfmon_h
17 #define __perfmon_perfmon_h
19 #include <linux/perf_event.h>
20 #include <vppinfra/clib.h>
21 #include <vppinfra/format.h>
22 #include <vppinfra/error.h>
23 #include <vppinfra/cpu.h>
24 #include <vlib/vlib.h>
26 #define PERF_MAX_EVENTS 8 /* 4 fixed and 8 programmable on ICX */
30 PERFMON_BUNDLE_TYPE_UNKNOWN,
31 PERFMON_BUNDLE_TYPE_NODE,
32 PERFMON_BUNDLE_TYPE_THREAD,
33 PERFMON_BUNDLE_TYPE_SYSTEM,
34 PERFMON_BUNDLE_TYPE_MAX,
35 } perfmon_bundle_type_t;
39 PERFMON_OFFSET_TYPE_MMAP,
40 PERFMON_OFFSET_TYPE_METRICS,
41 PERFMON_OFFSET_TYPE_MAX,
42 } perfmon_offset_type_t;
46 u32 type_from_instance : 1;
47 u32 exclude_kernel : 1;
69 perfmon_instance_t *instances;
70 } perfmon_instance_type_t;
72 struct perfmon_source;
73 vlib_node_function_t perfmon_dispatch_wrapper_mmap;
74 vlib_node_function_t perfmon_dispatch_wrapper_metrics;
76 #define foreach_permon_offset_type \
77 _ (PERFMON_OFFSET_TYPE_MMAP, perfmon_dispatch_wrapper_mmap) \
78 _ (PERFMON_OFFSET_TYPE_METRICS, perfmon_dispatch_wrapper_metrics)
80 typedef clib_error_t *(perfmon_source_init_fn_t) (vlib_main_t *vm,
81 struct perfmon_source *);
82 typedef struct perfmon_source
86 struct perfmon_source *next;
87 perfmon_event_t *events;
89 perfmon_instance_type_t *instances_by_type;
90 format_function_t *format_config;
91 perfmon_source_init_fn_t *init_fn;
94 struct perfmon_bundle;
96 typedef clib_error_t *(perfmon_bundle_init_fn_t) (vlib_main_t *vm,
97 struct perfmon_bundle *);
101 clib_cpu_supports_func_t cpu_supports;
102 perfmon_bundle_type_t bundle_type;
103 } perfmon_cpu_supports_t;
105 typedef struct perfmon_bundle
111 perfmon_bundle_type_t type;
112 perfmon_offset_type_t offset_type;
113 u32 events[PERF_MAX_EVENTS];
116 u32 metrics[PERF_MAX_EVENTS];
119 perfmon_cpu_supports_t *cpu_supports;
122 perfmon_bundle_init_fn_t *init_fn;
124 char **column_headers;
125 format_function_t *format_fn;
127 /* do not set manually */
128 perfmon_source_t *src;
129 struct perfmon_bundle *next;
137 u64 value[PERF_MAX_EVENTS];
142 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
149 u64 value[PERF_MAX_EVENTS];
151 u64 value[PERF_MAX_EVENTS * 2];
153 } perfmon_node_stats_t;
159 perfmon_node_stats_t *node_stats;
160 perfmon_bundle_t *bundle;
161 struct perf_event_mmap_page *mmap_pages[PERF_MAX_EVENTS];
162 } perfmon_thread_runtime_t;
166 perfmon_thread_runtime_t *thread_runtimes;
167 perfmon_bundle_t *bundles;
168 uword *bundle_by_name;
169 perfmon_source_t *sources;
170 uword *source_by_name;
171 perfmon_bundle_t *active_bundle;
176 perfmon_instance_type_t *default_instance_type;
177 perfmon_instance_type_t *active_instance_type;
180 extern perfmon_main_t perfmon_main;
183 perfmon_cpu_supported_bundle_type (perfmon_bundle_t *b)
185 perfmon_cpu_supports_t *supports = b->cpu_supports;
188 /* if nothing specific for this bundle, go with the default */
192 /* the last specified type, will always win */
193 for (int i = 0; i < b->n_cpu_supports; ++i)
194 if (supports[i].cpu_supports ())
195 type = supports[i].bundle_type;
200 #define PERFMON_REGISTER_SOURCE(x) \
201 perfmon_source_t __perfmon_source_##x; \
202 static void __clib_constructor __perfmon_source_registration_##x (void) \
204 perfmon_main_t *pm = &perfmon_main; \
205 __perfmon_source_##x.next = pm->sources; \
206 pm->sources = &__perfmon_source_##x; \
208 perfmon_source_t __perfmon_source_##x
210 #define PERFMON_REGISTER_BUNDLE(x) \
211 perfmon_bundle_t __perfmon_bundle_##x; \
212 static void __clib_constructor __perfmon_bundle_registration_##x (void) \
214 perfmon_main_t *pm = &perfmon_main; \
215 __perfmon_bundle_##x.next = pm->bundles; \
216 __perfmon_bundle_##x.type = \
217 perfmon_cpu_supported_bundle_type (&__perfmon_bundle_##x); \
218 pm->bundles = &__perfmon_bundle_##x; \
220 perfmon_bundle_t __perfmon_bundle_##x
222 void perfmon_reset (vlib_main_t *vm);
223 clib_error_t *perfmon_start (vlib_main_t *vm, perfmon_bundle_t *);
224 clib_error_t *perfmon_stop (vlib_main_t *vm);
226 #define PERFMON_STRINGS(...) \
227 (char *[]) { __VA_ARGS__, 0 }