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 7 /* 3 fixed and 4 programmable */
30 PERFMON_BUNDLE_TYPE_UNKNOWN,
31 PERFMON_BUNDLE_TYPE_NODE,
32 PERFMON_BUNDLE_TYPE_THREAD,
33 PERFMON_BUNDLE_TYPE_SYSTEM,
34 } perfmon_bundle_type_t;
38 PERFMON_OFFSET_TYPE_MMAP,
39 PERFMON_OFFSET_TYPE_METRICS,
40 PERFMON_OFFSET_TYPE_MAX,
41 } perfmon_offset_type_t;
45 u32 type_from_instance : 1;
46 u32 exclude_kernel : 1;
68 perfmon_instance_t *instances;
69 } perfmon_instance_type_t;
71 struct perfmon_source;
72 vlib_node_function_t perfmon_dispatch_wrapper_mmap;
73 vlib_node_function_t perfmon_dispatch_wrapper_metrics;
75 #define foreach_permon_offset_type \
76 _ (PERFMON_OFFSET_TYPE_MMAP, perfmon_dispatch_wrapper_mmap) \
77 _ (PERFMON_OFFSET_TYPE_METRICS, perfmon_dispatch_wrapper_metrics)
79 typedef clib_error_t *(perfmon_source_init_fn_t) (vlib_main_t *vm,
80 struct perfmon_source *);
81 typedef struct perfmon_source
85 struct perfmon_source *next;
86 perfmon_event_t *events;
88 perfmon_instance_type_t *instances_by_type;
89 format_function_t *format_config;
90 perfmon_source_init_fn_t *init_fn;
93 struct perfmon_bundle;
95 typedef clib_error_t *(perfmon_bundle_init_fn_t) (vlib_main_t *vm,
96 struct perfmon_bundle *);
98 typedef struct perfmon_bundle
104 perfmon_bundle_type_t type;
105 perfmon_offset_type_t offset_type;
106 u32 events[PERF_MAX_EVENTS];
107 u32 metrics[PERF_MAX_EVENTS];
110 perfmon_bundle_init_fn_t *init_fn;
112 char **column_headers;
113 format_function_t *format_fn;
114 clib_cpu_supports_func_t cpu_supports;
116 /* do not set manually */
117 perfmon_source_t *src;
118 struct perfmon_bundle *next;
126 u64 value[PERF_MAX_EVENTS];
131 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
138 u64 value[PERF_MAX_EVENTS];
140 u64 value[PERF_MAX_EVENTS * 2];
142 } perfmon_node_stats_t;
148 perfmon_node_stats_t *node_stats;
149 perfmon_bundle_t *bundle;
150 struct perf_event_mmap_page *mmap_pages[PERF_MAX_EVENTS];
151 } perfmon_thread_runtime_t;
155 perfmon_thread_runtime_t *thread_runtimes;
156 perfmon_bundle_t *bundles;
157 uword *bundle_by_name;
158 perfmon_source_t *sources;
159 uword *source_by_name;
160 perfmon_bundle_t *active_bundle;
165 perfmon_instance_type_t *default_instance_type;
166 perfmon_instance_type_t *active_instance_type;
169 extern perfmon_main_t perfmon_main;
171 #define PERFMON_REGISTER_SOURCE(x) \
172 perfmon_source_t __perfmon_source_##x; \
173 static void __clib_constructor __perfmon_source_registration_##x (void) \
175 perfmon_main_t *pm = &perfmon_main; \
176 __perfmon_source_##x.next = pm->sources; \
177 pm->sources = &__perfmon_source_##x; \
179 perfmon_source_t __perfmon_source_##x
181 #define PERFMON_REGISTER_BUNDLE(x) \
182 perfmon_bundle_t __perfmon_bundle_##x; \
183 static void __clib_constructor __perfmon_bundle_registration_##x (void) \
185 perfmon_main_t *pm = &perfmon_main; \
186 __perfmon_bundle_##x.next = pm->bundles; \
187 pm->bundles = &__perfmon_bundle_##x; \
189 perfmon_bundle_t __perfmon_bundle_##x
191 void perfmon_reset (vlib_main_t *vm);
192 clib_error_t *perfmon_start (vlib_main_t *vm, perfmon_bundle_t *);
193 clib_error_t *perfmon_stop (vlib_main_t *vm);
195 #define PERFMON_STRINGS(...) \
196 (char *[]) { __VA_ARGS__, 0 }