FD.io VPP  v19.01.1-17-ge106252
Vector Packet Processing
perfmon.h
Go to the documentation of this file.
1 /*
2  * perfmon.h - performance monitor
3  *
4  * Copyright (c) 2018 Cisco Systems and/or its affiliates
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at:
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 #ifndef __included_perfmon_h__
18 #define __included_perfmon_h__
19 
20 #include <vnet/vnet.h>
21 #include <vnet/ip/ip.h>
22 #include <vnet/ethernet/ethernet.h>
23 #include <vlib/log.h>
24 
25 #include <vppinfra/hash.h>
26 #include <vppinfra/error.h>
27 
28 #include <linux/perf_event.h>
29 
30 #define foreach_perfmon_event \
31 _(PERF_TYPE_HARDWARE, PERF_COUNT_HW_CPU_CYCLES, "cpu-cycles") \
32 _(PERF_TYPE_HARDWARE, PERF_COUNT_HW_INSTRUCTIONS, "instructions") \
33 _(PERF_TYPE_HARDWARE, PERF_COUNT_HW_CACHE_REFERENCES, \
34  "cache-references") \
35 _(PERF_TYPE_HARDWARE, PERF_COUNT_HW_CACHE_MISSES, "cache-misses") \
36 _(PERF_TYPE_HARDWARE, PERF_COUNT_HW_BRANCH_INSTRUCTIONS, "branches") \
37  _(PERF_TYPE_HARDWARE, PERF_COUNT_HW_BRANCH_MISSES, "branch-misses") \
38 _(PERF_TYPE_HARDWARE, PERF_COUNT_HW_BUS_CYCLES, "bus-cycles") \
39 _(PERF_TYPE_HARDWARE, PERF_COUNT_HW_STALLED_CYCLES_FRONTEND, \
40  "stall-frontend") \
41 _(PERF_TYPE_HARDWARE, PERF_COUNT_HW_STALLED_CYCLES_BACKEND, \
42  "stall-backend") \
43 _(PERF_TYPE_HARDWARE, PERF_COUNT_HW_REF_CPU_CYCLES, "ref-cpu-cycles") \
44 _(PERF_TYPE_SOFTWARE, PERF_COUNT_SW_PAGE_FAULTS, "page-faults") \
45 _(PERF_TYPE_SOFTWARE, PERF_COUNT_SW_CONTEXT_SWITCHES, "context-switches") \
46 _(PERF_TYPE_SOFTWARE, PERF_COUNT_SW_CPU_MIGRATIONS, "cpu-migrations") \
47 _(PERF_TYPE_SOFTWARE, PERF_COUNT_SW_PAGE_FAULTS_MIN, "minor-pagefaults") \
48 _(PERF_TYPE_SOFTWARE, PERF_COUNT_SW_PAGE_FAULTS_MAJ, "major-pagefaults") \
49 _(PERF_TYPE_SOFTWARE, PERF_COUNT_SW_EMULATION_FAULTS, "emulation-faults")
50 
51 typedef struct
52 {
53  char *name;
54  int pe_type;
55  int pe_config;
57 
58 typedef enum
59 {
63 
64 typedef struct
65 {
71 
72 typedef struct
73 {
75  const char **table;
77 
78 typedef struct
79 {
80  u8 *name;
83 
84 typedef struct
85 {
86  /* API message ID base */
88 
89  /* on/off switch for the periodic function */
90  volatile u8 state;
91 
92  /* capture pool, hash table */
95 
96  /* CPU-specific event tables, hash table of selected table (if any) */
99 
100  /* vector of events to collect */
102 
103  /* Base indices of synthetic event tuples */
106 
107  /* Length of time to capture a single event */
109 
110  /* Current event (index) being collected */
113  /* mmap base / size of (mapped) struct perf_event_mmap_page */
116 
117  /* Current perf_event file descriptors, per thread */
118  int *pm_fds;
119 
120  /* Logging */
122 
123  /* convenience */
128 
130 
132 uword *perfmon_parse_table (perfmon_main_t * pm, char *path, char *filename);
133 
134 /* Periodic function events */
135 #define PERFMON_START 1
136 
137 #endif /* __included_perfmon_h__ */
138 
139 /*
140  * fd.io coding-style-patch-verification: ON
141  *
142  * Local Variables:
143  * eval: (c-set-style "gnu")
144  * End:
145  */
perfmon_capture_t * capture_pool
Definition: perfmon.h:93
volatile u8 state
Definition: perfmon.h:90
u32 current_event
Definition: perfmon.h:111
f64 timeout_interval
Definition: perfmon.h:108
u32 vlib_log_class_t
Definition: log.h:21
u64 * vectors_this_counter
Definition: perfmon.h:69
ethernet_main_t * ethernet_main
Definition: perfmon.h:126
perfmon_event_config_t * events_to_collect
Definition: perfmon.h:101
unsigned long u64
Definition: types.h:89
vlib_node_registration_t perfmon_periodic_node
(constructor) VLIB_REGISTER_NODE (perfmon_periodic_node)
u32 mispredict_event_index
Definition: perfmon.h:105
vlib_main_t * vlib_main
Definition: perfmon.h:124
u16 msg_id_base
Definition: perfmon.h:87
u32 * rdpmc_indices
Definition: perfmon.h:112
uword * perfmon_parse_table(perfmon_main_t *pm, char *path, char *filename)
Definition: parse_util.c:46
unsigned char u8
Definition: types.h:56
double f64
Definition: types.h:142
uword * perfmon_table
Definition: perfmon.h:98
perfmon_main_t perfmon_main
Definition: perfmon.c:27
u8 * thread_and_node_name
Definition: perfmon.h:66
unsigned int u32
Definition: types.h:88
vnet_main_t * vnet_main
Definition: perfmon.h:125
u8 ** counter_names
Definition: perfmon.h:67
unsigned short u16
Definition: types.h:57
const char ** table
Definition: perfmon.h:75
perfmon_state_t
Definition: perfmon.h:58
vlib_log_class_t log_class
Definition: perfmon.h:121
int * pm_fds
Definition: perfmon.h:118
u8 ** perf_event_pages
Definition: perfmon.h:114
perfmon_cpuid_and_table_t * perfmon_tables
Definition: perfmon.h:97
u32 ipc_event_index
Definition: perfmon.h:104
uword * capture_by_thread_and_node_name
Definition: perfmon.h:94
struct _vlib_node_registration vlib_node_registration_t
u64 * counter_values
Definition: perfmon.h:68
u64 uword
Definition: types.h:112