tools/perf/util/bpf-loader.h

   1 /*
   2  * Copyright (C) 2015, Wang Nan <wangnan0@huawei.com>
   3  * Copyright (C) 2015, Huawei Inc.
   4  */
   5 #ifndef __BPF_LOADER_H
   6 #define __BPF_LOADER_H
   7
   8 #include <linux/compiler.h>
   9 #include <linux/err.h>
  10 #include <string.h>
  11 #include <bpf/libbpf.h>
  12 #include "probe-event.h"
  13 #include "evlist.h"
  14 #include "debug.h"
  15
  16 enum bpf_loader_errno {
  17         __BPF_LOADER_ERRNO__START = __LIBBPF_ERRNO__START - 100,
  18         /* Invalid config string */
  19         BPF_LOADER_ERRNO__CONFIG = __BPF_LOADER_ERRNO__START,
  20         BPF_LOADER_ERRNO__GROUP,        /* Invalid group name */
  21         BPF_LOADER_ERRNO__EVENTNAME,    /* Event name is missing */
  22         BPF_LOADER_ERRNO__INTERNAL,     /* BPF loader internal error */
  23         BPF_LOADER_ERRNO__COMPILE,      /* Error when compiling BPF scriptlet */
  24         BPF_LOADER_ERRNO__PROGCONF_TERM,/* Invalid program config term in config string */
  25         BPF_LOADER_ERRNO__PROLOGUE,     /* Failed to generate prologue */
  26         BPF_LOADER_ERRNO__PROLOGUE2BIG, /* Prologue too big for program */
  27         BPF_LOADER_ERRNO__PROLOGUEOOB,  /* Offset out of bound for prologue */
  28         BPF_LOADER_ERRNO__OBJCONF_OPT,  /* Invalid object config option */
  29         BPF_LOADER_ERRNO__OBJCONF_CONF, /* Config value not set (lost '=')) */
  30         BPF_LOADER_ERRNO__OBJCONF_MAP_OPT,      /* Invalid object map config option */
  31         BPF_LOADER_ERRNO__OBJCONF_MAP_NOTEXIST, /* Target map not exist */
  32         BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE,    /* Incorrect value type for map */
  33         BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE,     /* Incorrect map type */
  34         BPF_LOADER_ERRNO__OBJCONF_MAP_KEYSIZE,  /* Incorrect map key size */
  35         BPF_LOADER_ERRNO__OBJCONF_MAP_VALUESIZE,/* Incorrect map value size */
  36         __BPF_LOADER_ERRNO__END,
  37 };
  38
  39 struct bpf_object;
  40 struct parse_events_term;
  41 #define PERF_BPF_PROBE_GROUP "perf_bpf_probe"
  42
  43 typedef int (*bpf_prog_iter_callback_t)(struct probe_trace_event *tev,
  44                                         int fd, void *arg);
  45
  46 #ifdef HAVE_LIBBPF_SUPPORT
  47 struct bpf_object *bpf__prepare_load(const char *filename, bool source);
  48 int bpf__strerror_prepare_load(const char *filename, bool source,
  49                                int err, char *buf, size_t size);
  50
  51 struct bpf_object *bpf__prepare_load_buffer(void *obj_buf, size_t obj_buf_sz,
  52                                             const char *name);
  53
  54 void bpf__clear(void);
  55
  56 int bpf__probe(struct bpf_object *obj);
  57 int bpf__unprobe(struct bpf_object *obj);
  58 int bpf__strerror_probe(struct bpf_object *obj, int err,
  59                         char *buf, size_t size);
  60
  61 int bpf__load(struct bpf_object *obj);
  62 int bpf__strerror_load(struct bpf_object *obj, int err,
  63                        char *buf, size_t size);
  64 int bpf__foreach_tev(struct bpf_object *obj,
  65                      bpf_prog_iter_callback_t func, void *arg);
  66
  67 int bpf__config_obj(struct bpf_object *obj, struct parse_events_term *term,
  68                     struct perf_evlist *evlist, int *error_pos);
  69 int bpf__strerror_config_obj(struct bpf_object *obj,
  70                              struct parse_events_term *term,
  71                              struct perf_evlist *evlist,
  72                              int *error_pos, int err, char *buf,
  73                              size_t size);
  74 int bpf__apply_obj_config(void);
  75 int bpf__strerror_apply_obj_config(int err, char *buf, size_t size);
  76 #else
  77 static inline struct bpf_object *
  78 bpf__prepare_load(const char *filename __maybe_unused,
  79                   bool source __maybe_unused)
  80 {
  81         pr_debug("ERROR: eBPF object loading is disabled during compiling.\n");
  82         return ERR_PTR(-ENOTSUP);
  83 }
  84
  85 static inline struct bpf_object *
  86 bpf__prepare_load_buffer(void *obj_buf __maybe_unused,
  87                                            size_t obj_buf_sz __maybe_unused)
  88 {
  89         return ERR_PTR(-ENOTSUP);
  90 }
  91
  92 static inline void bpf__clear(void) { }
  93
  94 static inline int bpf__probe(struct bpf_object *obj __maybe_unused) { return 0;}
  95 static inline int bpf__unprobe(struct bpf_object *obj __maybe_unused) { return 0;}
  96 static inline int bpf__load(struct bpf_object *obj __maybe_unused) { return 0; }
  97
  98 static inline int
  99 bpf__foreach_tev(struct bpf_object *obj __maybe_unused,
 100                  bpf_prog_iter_callback_t func __maybe_unused,
 101                  void *arg __maybe_unused)
 102 {
 103         return 0;
 104 }
 105
 106 static inline int
 107 bpf__config_obj(struct bpf_object *obj __maybe_unused,
 108                 struct parse_events_term *term __maybe_unused,
 109                 struct perf_evlist *evlist __maybe_unused,
 110                 int *error_pos __maybe_unused)
 111 {
 112         return 0;
 113 }
 114
 115 static inline int
 116 bpf__apply_obj_config(void)
 117 {
 118         return 0;
 119 }
 120
 121 static inline int
 122 __bpf_strerror(char *buf, size_t size)
 123 {
 124         if (!size)
 125                 return 0;
 126         strncpy(buf,
 127                 "ERROR: eBPF object loading is disabled during compiling.\n",
 128                 size);
 129         buf[size - 1] = '\0';
 130         return 0;
 131 }
 132
 133 static inline
 134 int bpf__strerror_prepare_load(const char *filename __maybe_unused,
 135                                bool source __maybe_unused,
 136                                int err __maybe_unused,
 137                                char *buf, size_t size)
 138 {
 139         return __bpf_strerror(buf, size);
 140 }
 141
 142 static inline int
 143 bpf__strerror_probe(struct bpf_object *obj __maybe_unused,
 144                     int err __maybe_unused,
 145                     char *buf, size_t size)
 146 {
 147         return __bpf_strerror(buf, size);
 148 }
 149
 150 static inline int bpf__strerror_load(struct bpf_object *obj __maybe_unused,
 151                                      int err __maybe_unused,
 152                                      char *buf, size_t size)
 153 {
 154         return __bpf_strerror(buf, size);
 155 }
 156
 157 static inline int
 158 bpf__strerror_config_obj(struct bpf_object *obj __maybe_unused,
 159                          struct parse_events_term *term __maybe_unused,
 160                          struct perf_evlist *evlist __maybe_unused,
 161                          int *error_pos __maybe_unused,
 162                          int err __maybe_unused,
 163                          char *buf, size_t size)
 164 {
 165         return __bpf_strerror(buf, size);
 166 }
 167
 168 static inline int
 169 bpf__strerror_apply_obj_config(int err __maybe_unused,
 170                                char *buf, size_t size)
 171 {
 172         return __bpf_strerror(buf, size);
 173 }
 174 #endif
 175 #endif