LXR linux/tools/lib/bpf/bpf.h

   1/* SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) */
   2
   3/*
   4 * common eBPF ELF operations.
   5 *
   6 * Copyright (C) 2013-2015 Alexei Starovoitov <ast@kernel.org>
   7 * Copyright (C) 2015 Wang Nan <wangnan0@huawei.com>
   8 * Copyright (C) 2015 Huawei Inc.
   9 *
  10 * This program is free software; you can redistribute it and/or
  11 * modify it under the terms of the GNU Lesser General Public
  12 * License as published by the Free Software Foundation;
  13 * version 2.1 of the License (not later!)
  14 *
  15 * This program is distributed in the hope that it will be useful,
  16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 * GNU Lesser General Public License for more details.
  19 *
  20 * You should have received a copy of the GNU Lesser General Public
  21 * License along with this program; if not,  see <http://www.gnu.org/licenses>
  22 */
  23#ifndef __LIBBPF_BPF_H
  24#define __LIBBPF_BPF_H
  25
  26#include <linux/bpf.h>
  27#include <stdbool.h>
  28#include <stddef.h>
  29#include <stdint.h>
  30
  31#ifdef __cplusplus
  32extern "C" {
  33#endif
  34
  35#ifndef LIBBPF_API
  36#define LIBBPF_API __attribute__((visibility("default")))
  37#endif
  38
  39struct bpf_create_map_attr {
  40        const char *name;
  41        enum bpf_map_type map_type;
  42        __u32 map_flags;
  43        __u32 key_size;
  44        __u32 value_size;
  45        __u32 max_entries;
  46        __u32 numa_node;
  47        __u32 btf_fd;
  48        __u32 btf_key_type_id;
  49        __u32 btf_value_type_id;
  50        __u32 map_ifindex;
  51        __u32 inner_map_fd;
  52};
  53
  54LIBBPF_API int
  55bpf_create_map_xattr(const struct bpf_create_map_attr *create_attr);
  56LIBBPF_API int bpf_create_map_node(enum bpf_map_type map_type, const char *name,
  57                                   int key_size, int value_size,
  58                                   int max_entries, __u32 map_flags, int node);
  59LIBBPF_API int bpf_create_map_name(enum bpf_map_type map_type, const char *name,
  60                                   int key_size, int value_size,
  61                                   int max_entries, __u32 map_flags);
  62LIBBPF_API int bpf_create_map(enum bpf_map_type map_type, int key_size,
  63                              int value_size, int max_entries, __u32 map_flags);
  64LIBBPF_API int bpf_create_map_in_map_node(enum bpf_map_type map_type,
  65                                          const char *name, int key_size,
  66                                          int inner_map_fd, int max_entries,
  67                                          __u32 map_flags, int node);
  68LIBBPF_API int bpf_create_map_in_map(enum bpf_map_type map_type,
  69                                     const char *name, int key_size,
  70                                     int inner_map_fd, int max_entries,
  71                                     __u32 map_flags);
  72
  73struct bpf_load_program_attr {
  74        enum bpf_prog_type prog_type;
  75        enum bpf_attach_type expected_attach_type;
  76        const char *name;
  77        const struct bpf_insn *insns;
  78        size_t insns_cnt;
  79        const char *license;
  80        __u32 kern_version;
  81        __u32 prog_ifindex;
  82        __u32 prog_btf_fd;
  83        __u32 func_info_rec_size;
  84        const void *func_info;
  85        __u32 func_info_cnt;
  86        __u32 line_info_rec_size;
  87        const void *line_info;
  88        __u32 line_info_cnt;
  89        __u32 log_level;
  90        __u32 prog_flags;
  91};
  92
  93/* Flags to direct loading requirements */
  94#define MAPS_RELAX_COMPAT       0x01
  95
  96/* Recommend log buffer size */
  97#define BPF_LOG_BUF_SIZE (UINT32_MAX >> 8) /* verifier maximum in kernels <= 5.1 */
  98LIBBPF_API int
  99bpf_load_program_xattr(const struct bpf_load_program_attr *load_attr,
 100                       char *log_buf, size_t log_buf_sz);
 101LIBBPF_API int bpf_load_program(enum bpf_prog_type type,
 102                                const struct bpf_insn *insns, size_t insns_cnt,
 103                                const char *license, __u32 kern_version,
 104                                char *log_buf, size_t log_buf_sz);
 105LIBBPF_API int bpf_verify_program(enum bpf_prog_type type,
 106                                  const struct bpf_insn *insns,
 107                                  size_t insns_cnt, __u32 prog_flags,
 108                                  const char *license, __u32 kern_version,
 109                                  char *log_buf, size_t log_buf_sz,
 110                                  int log_level);
 111
 112LIBBPF_API int bpf_map_update_elem(int fd, const void *key, const void *value,
 113                                   __u64 flags);
 114
 115LIBBPF_API int bpf_map_lookup_elem(int fd, const void *key, void *value);
 116LIBBPF_API int bpf_map_lookup_elem_flags(int fd, const void *key, void *value,
 117                                         __u64 flags);
 118LIBBPF_API int bpf_map_lookup_and_delete_elem(int fd, const void *key,
 119                                              void *value);
 120LIBBPF_API int bpf_map_delete_elem(int fd, const void *key);
 121LIBBPF_API int bpf_map_get_next_key(int fd, const void *key, void *next_key);
 122LIBBPF_API int bpf_map_freeze(int fd);
 123LIBBPF_API int bpf_obj_pin(int fd, const char *pathname);
 124LIBBPF_API int bpf_obj_get(const char *pathname);
 125LIBBPF_API int bpf_prog_attach(int prog_fd, int attachable_fd,
 126                               enum bpf_attach_type type, unsigned int flags);
 127LIBBPF_API int bpf_prog_detach(int attachable_fd, enum bpf_attach_type type);
 128LIBBPF_API int bpf_prog_detach2(int prog_fd, int attachable_fd,
 129                                enum bpf_attach_type type);
 130
 131struct bpf_prog_test_run_attr {
 132        int prog_fd;
 133        int repeat;
 134        const void *data_in;
 135        __u32 data_size_in;
 136        void *data_out;      /* optional */
 137        __u32 data_size_out; /* in: max length of data_out
 138                              * out: length of data_out */
 139        __u32 retval;        /* out: return code of the BPF program */
 140        __u32 duration;      /* out: average per repetition in ns */
 141        const void *ctx_in; /* optional */
 142        __u32 ctx_size_in;
 143        void *ctx_out;      /* optional */
 144        __u32 ctx_size_out; /* in: max length of ctx_out
 145                             * out: length of cxt_out */
 146};
 147
 148LIBBPF_API int bpf_prog_test_run_xattr(struct bpf_prog_test_run_attr *test_attr);
 149
 150/*
 151 * bpf_prog_test_run does not check that data_out is large enough. Consider
 152 * using bpf_prog_test_run_xattr instead.
 153 */
 154LIBBPF_API int bpf_prog_test_run(int prog_fd, int repeat, void *data,
 155                                 __u32 size, void *data_out, __u32 *size_out,
 156                                 __u32 *retval, __u32 *duration);
 157LIBBPF_API int bpf_prog_get_next_id(__u32 start_id, __u32 *next_id);
 158LIBBPF_API int bpf_map_get_next_id(__u32 start_id, __u32 *next_id);
 159LIBBPF_API int bpf_prog_get_fd_by_id(__u32 id);
 160LIBBPF_API int bpf_map_get_fd_by_id(__u32 id);
 161LIBBPF_API int bpf_btf_get_fd_by_id(__u32 id);
 162LIBBPF_API int bpf_obj_get_info_by_fd(int prog_fd, void *info, __u32 *info_len);
 163LIBBPF_API int bpf_prog_query(int target_fd, enum bpf_attach_type type,
 164                              __u32 query_flags, __u32 *attach_flags,
 165                              __u32 *prog_ids, __u32 *prog_cnt);
 166LIBBPF_API int bpf_raw_tracepoint_open(const char *name, int prog_fd);
 167LIBBPF_API int bpf_load_btf(void *btf, __u32 btf_size, char *log_buf,
 168                            __u32 log_buf_size, bool do_log);
 169LIBBPF_API int bpf_task_fd_query(int pid, int fd, __u32 flags, char *buf,
 170                                 __u32 *buf_len, __u32 *prog_id, __u32 *fd_type,
 171                                 __u64 *probe_offset, __u64 *probe_addr);
 172
 173#ifdef __cplusplus
 174} /* extern "C" */
 175#endif
 176
 177#endif /* __LIBBPF_BPF_H */
 178