src/plugins/perfmon/perfmon.h

   1 /*
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15
  16 #ifndef __perfmon_perfmon_h
  17 #define __perfmon_perfmon_h
  18
  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>
  25
  26 #define PERF_MAX_EVENTS 7 /* 3 fixed and 4 programmable */
  27
  28 typedef enum
  29 {
  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;
  35
  36 typedef enum
  37 {
  38   PERFMON_OFFSET_TYPE_MMAP,
  39   PERFMON_OFFSET_TYPE_METRICS,
  40   PERFMON_OFFSET_TYPE_MAX,
  41 } perfmon_offset_type_t;
  42
  43 typedef struct
  44 {
  45   u32 type_from_instance : 1;
  46   u32 exclude_kernel : 1;
  47   union
  48   {
  49     u32 type;
  50     u32 instance_type;
  51   };
  52   u64 config;
  53   char *name;
  54   char *description;
  55 } perfmon_event_t;
  56
  57 typedef struct
  58 {
  59   u32 type;
  60   int cpu;
  61   pid_t pid;
  62   char *name;
  63 } perfmon_instance_t;
  64
  65 typedef struct
  66 {
  67   char *name;
  68   perfmon_instance_t *instances;
  69 } perfmon_instance_type_t;
  70
  71 struct perfmon_source;
  72 vlib_node_function_t perfmon_dispatch_wrapper_mmap;
  73 vlib_node_function_t perfmon_dispatch_wrapper_metrics;
  74
  75 #define foreach_permon_offset_type                                            \
  76   _ (PERFMON_OFFSET_TYPE_MMAP, perfmon_dispatch_wrapper_mmap)                 \
  77   _ (PERFMON_OFFSET_TYPE_METRICS, perfmon_dispatch_wrapper_metrics)
  78
  79 typedef clib_error_t *(perfmon_source_init_fn_t) (vlib_main_t *vm,
  80                                                   struct perfmon_source *);
  81 typedef struct perfmon_source
  82 {
  83   char *name;
  84   char *description;
  85   struct perfmon_source *next;
  86   perfmon_event_t *events;
  87   u32 n_events;
  88   perfmon_instance_type_t *instances_by_type;
  89   format_function_t *format_config;
  90   perfmon_source_init_fn_t *init_fn;
  91 } perfmon_source_t;
  92
  93 struct perfmon_bundle;
  94
  95 typedef clib_error_t *(perfmon_bundle_init_fn_t) (vlib_main_t *vm,
  96                                                   struct perfmon_bundle *);
  97
  98 typedef struct perfmon_bundle
  99 {
 100   char *name;
 101   char *description;
 102   char *source;
 103   char *footer;
 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];
 108   u32 n_events;
 109
 110   perfmon_bundle_init_fn_t *init_fn;
 111
 112   char **column_headers;
 113   char **raw_column_headers;
 114   format_function_t *format_fn;
 115   clib_cpu_supports_func_t cpu_supports;
 116
 117   /* do not set manually */
 118   perfmon_source_t *src;
 119   struct perfmon_bundle *next;
 120 } perfmon_bundle_t;
 121
 122 typedef struct
 123 {
 124   u64 nr;
 125   u64 time_enabled;
 126   u64 time_running;
 127   u64 value[PERF_MAX_EVENTS];
 128 } perfmon_reading_t;
 129
 130 typedef struct
 131 {
 132   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 133   u64 n_calls;
 134   u64 n_packets;
 135   union
 136   {
 137     struct
 138     {
 139       u64 value[PERF_MAX_EVENTS];
 140     } t[2];
 141     u64 value[PERF_MAX_EVENTS * 2];
 142   };
 143 } perfmon_node_stats_t;
 144
 145 typedef struct
 146 {
 147   u8 n_events;
 148   u16 n_nodes;
 149   perfmon_node_stats_t *node_stats;
 150   perfmon_bundle_t *bundle;
 151   struct perf_event_mmap_page *mmap_pages[PERF_MAX_EVENTS];
 152 } perfmon_thread_runtime_t;
 153
 154 typedef struct
 155 {
 156   perfmon_thread_runtime_t *thread_runtimes;
 157   perfmon_bundle_t *bundles;
 158   uword *bundle_by_name;
 159   perfmon_source_t *sources;
 160   uword *source_by_name;
 161   perfmon_bundle_t *active_bundle;
 162   int is_running;
 163   f64 sample_time;
 164   int *group_fds;
 165   int *fds_to_close;
 166   perfmon_instance_type_t *default_instance_type;
 167   perfmon_instance_type_t *active_instance_type;
 168 } perfmon_main_t;
 169
 170 extern perfmon_main_t perfmon_main;
 171
 172 #define PERFMON_REGISTER_SOURCE(x)                                            \
 173   perfmon_source_t __perfmon_source_##x;                                      \
 174   static void __clib_constructor __perfmon_source_registration_##x (void)     \
 175   {                                                                           \
 176     perfmon_main_t *pm = &perfmon_main;                                       \
 177     __perfmon_source_##x.next = pm->sources;                                  \
 178     pm->sources = &__perfmon_source_##x;                                      \
 179   }                                                                           \
 180   perfmon_source_t __perfmon_source_##x
 181
 182 #define PERFMON_REGISTER_BUNDLE(x)                                            \
 183   perfmon_bundle_t __perfmon_bundle_##x;                                      \
 184   static void __clib_constructor __perfmon_bundle_registration_##x (void)     \
 185   {                                                                           \
 186     perfmon_main_t *pm = &perfmon_main;                                       \
 187     __perfmon_bundle_##x.next = pm->bundles;                                  \
 188     pm->bundles = &__perfmon_bundle_##x;                                      \
 189   }                                                                           \
 190   perfmon_bundle_t __perfmon_bundle_##x
 191
 192 void perfmon_reset (vlib_main_t *vm);
 193 clib_error_t *perfmon_start (vlib_main_t *vm, perfmon_bundle_t *);
 194 clib_error_t *perfmon_stop (vlib_main_t *vm);
 195
 196 #define PERFMON_STRINGS(...)                                                  \
 197   (char *[]) { __VA_ARGS__, 0 }
 198
 199 #endif