2 * Common eBPF ELF object loading operations.
4 * Copyright (C) 2013-2015 Alexei Starovoitov <ast@kernel.org>
5 * Copyright (C) 2015 Wang Nan <wangnan0@huawei.com>
6 * Copyright (C) 2015 Huawei Inc.
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation;
11 * version 2.1 of the License (not later!)
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this program; if not, see <http://www.gnu.org/licenses>
30 #include <asm/unistd.h>
31 #include <linux/kernel.h>
32 #include <linux/bpf.h>
33 #include <linux/list.h>
44 #define __printf(a, b) __attribute__((format(printf, a, b)))
47 static int __base_pr(const char *format, ...)
52 va_start(args, format);
53 err = vfprintf(stderr, format, args);
58 static __printf(1, 2) libbpf_print_fn_t __pr_warning = __base_pr;
59 static __printf(1, 2) libbpf_print_fn_t __pr_info = __base_pr;
60 static __printf(1, 2) libbpf_print_fn_t __pr_debug;
62 #define __pr(func, fmt, ...) \
65 (func)("libbpf: " fmt, ##__VA_ARGS__); \
68 #define pr_warning(fmt, ...) __pr(__pr_warning, fmt, ##__VA_ARGS__)
69 #define pr_info(fmt, ...) __pr(__pr_info, fmt, ##__VA_ARGS__)
70 #define pr_debug(fmt, ...) __pr(__pr_debug, fmt, ##__VA_ARGS__)
72 void libbpf_set_print(libbpf_print_fn_t warn,
73 libbpf_print_fn_t info,
74 libbpf_print_fn_t debug)
81 #define STRERR_BUFSIZE 128
83 #define ERRNO_OFFSET(e) ((e) - __LIBBPF_ERRNO__START)
84 #define ERRCODE_OFFSET(c) ERRNO_OFFSET(LIBBPF_ERRNO__##c)
85 #define NR_ERRNO (__LIBBPF_ERRNO__END - __LIBBPF_ERRNO__START)
87 static const char *libbpf_strerror_table[NR_ERRNO] = {
88 [ERRCODE_OFFSET(LIBELF)] = "Something wrong in libelf",
89 [ERRCODE_OFFSET(FORMAT)] = "BPF object format invalid",
90 [ERRCODE_OFFSET(KVERSION)] = "'version' section incorrect or lost",
91 [ERRCODE_OFFSET(ENDIAN)] = "Endian mismatch",
92 [ERRCODE_OFFSET(INTERNAL)] = "Internal error in libbpf",
93 [ERRCODE_OFFSET(RELOC)] = "Relocation failed",
94 [ERRCODE_OFFSET(VERIFY)] = "Kernel verifier blocks program loading",
95 [ERRCODE_OFFSET(PROG2BIG)] = "Program too big",
96 [ERRCODE_OFFSET(KVER)] = "Incorrect kernel version",
97 [ERRCODE_OFFSET(PROGTYPE)] = "Kernel doesn't support this program type",
100 int libbpf_strerror(int err, char *buf, size_t size)
105 err = err > 0 ? err : -err;
107 if (err < __LIBBPF_ERRNO__START) {
110 ret = strerror_r(err, buf, size);
111 buf[size - 1] = '\0';
115 if (err < __LIBBPF_ERRNO__END) {
118 msg = libbpf_strerror_table[ERRNO_OFFSET(err)];
119 snprintf(buf, size, "%s", msg);
120 buf[size - 1] = '\0';
124 snprintf(buf, size, "Unknown libbpf error %d", err);
125 buf[size - 1] = '\0';
129 #define CHECK_ERR(action, err, out) do { \
136 /* Copied from tools/perf/util/util.h */
138 # define zfree(ptr) ({ free(*ptr); *ptr = NULL; })
142 # define zclose(fd) ({ \
145 ___err = close((fd)); \
150 #ifdef HAVE_LIBELF_MMAP_SUPPORT
151 # define LIBBPF_ELF_C_READ_MMAP ELF_C_READ_MMAP
153 # define LIBBPF_ELF_C_READ_MMAP ELF_C_READ
157 * bpf_prog should be a better name but it has been used in
161 /* Index in elf obj file, for relocation use. */
164 struct bpf_insn *insns;
166 enum bpf_prog_type type;
178 bpf_program_prep_t preprocessor;
180 struct bpf_object *obj;
182 bpf_program_clear_priv_t clear_priv;
189 struct bpf_map_def def;
191 bpf_map_clear_priv_t clear_priv;
194 static LIST_HEAD(bpf_objects_list);
200 struct bpf_program *programs;
202 struct bpf_map *maps;
208 * Information when doing elf related work. Only valid if fd
227 * All loaded bpf_object is linked in a list, which is
228 * hidden to caller. bpf_objects__<func> handlers deal with
231 struct list_head list;
234 bpf_object_clear_priv_t clear_priv;
238 #define obj_elf_valid(o) ((o)->efile.elf)
240 static void bpf_program__unload(struct bpf_program *prog)
248 * If the object is opened but the program was never loaded,
249 * it is possible that prog->instances.nr == -1.
251 if (prog->instances.nr > 0) {
252 for (i = 0; i < prog->instances.nr; i++)
253 zclose(prog->instances.fds[i]);
254 } else if (prog->instances.nr != -1) {
255 pr_warning("Internal error: instances.nr is %d\n",
259 prog->instances.nr = -1;
260 zfree(&prog->instances.fds);
263 static void bpf_program__exit(struct bpf_program *prog)
268 if (prog->clear_priv)
269 prog->clear_priv(prog, prog->priv);
272 prog->clear_priv = NULL;
274 bpf_program__unload(prog);
275 zfree(&prog->section_name);
277 zfree(&prog->reloc_desc);
285 bpf_program__init(void *data, size_t size, char *name, int idx,
286 struct bpf_program *prog)
288 if (size < sizeof(struct bpf_insn)) {
289 pr_warning("corrupted section '%s'\n", name);
293 bzero(prog, sizeof(*prog));
295 prog->section_name = strdup(name);
296 if (!prog->section_name) {
297 pr_warning("failed to alloc name for prog %s\n",
302 prog->insns = malloc(size);
304 pr_warning("failed to alloc insns for %s\n", name);
307 prog->insns_cnt = size / sizeof(struct bpf_insn);
308 memcpy(prog->insns, data,
309 prog->insns_cnt * sizeof(struct bpf_insn));
311 prog->instances.fds = NULL;
312 prog->instances.nr = -1;
313 prog->type = BPF_PROG_TYPE_KPROBE;
317 bpf_program__exit(prog);
322 bpf_object__add_program(struct bpf_object *obj, void *data, size_t size,
325 struct bpf_program prog, *progs;
328 err = bpf_program__init(data, size, name, idx, &prog);
332 progs = obj->programs;
333 nr_progs = obj->nr_programs;
335 progs = realloc(progs, sizeof(progs[0]) * (nr_progs + 1));
338 * In this case the original obj->programs
339 * is still valid, so don't need special treat for
340 * bpf_close_object().
342 pr_warning("failed to alloc a new program '%s'\n",
344 bpf_program__exit(&prog);
348 pr_debug("found program %s\n", prog.section_name);
349 obj->programs = progs;
350 obj->nr_programs = nr_progs + 1;
352 progs[nr_progs] = prog;
356 static struct bpf_object *bpf_object__new(const char *path,
360 struct bpf_object *obj;
362 obj = calloc(1, sizeof(struct bpf_object) + strlen(path) + 1);
364 pr_warning("alloc memory failed for %s\n", path);
365 return ERR_PTR(-ENOMEM);
368 strcpy(obj->path, path);
372 * Caller of this function should also calls
373 * bpf_object__elf_finish() after data collection to return
374 * obj_buf to user. If not, we should duplicate the buffer to
375 * avoid user freeing them before elf finish.
377 obj->efile.obj_buf = obj_buf;
378 obj->efile.obj_buf_sz = obj_buf_sz;
379 obj->efile.maps_shndx = -1;
383 INIT_LIST_HEAD(&obj->list);
384 list_add(&obj->list, &bpf_objects_list);
388 static void bpf_object__elf_finish(struct bpf_object *obj)
390 if (!obj_elf_valid(obj))
393 if (obj->efile.elf) {
394 elf_end(obj->efile.elf);
395 obj->efile.elf = NULL;
397 obj->efile.symbols = NULL;
399 zfree(&obj->efile.reloc);
400 obj->efile.nr_reloc = 0;
401 zclose(obj->efile.fd);
402 obj->efile.obj_buf = NULL;
403 obj->efile.obj_buf_sz = 0;
406 static int bpf_object__elf_init(struct bpf_object *obj)
411 if (obj_elf_valid(obj)) {
412 pr_warning("elf init: internal error\n");
413 return -LIBBPF_ERRNO__LIBELF;
416 if (obj->efile.obj_buf_sz > 0) {
418 * obj_buf should have been validated by
419 * bpf_object__open_buffer().
421 obj->efile.elf = elf_memory(obj->efile.obj_buf,
422 obj->efile.obj_buf_sz);
424 obj->efile.fd = open(obj->path, O_RDONLY);
425 if (obj->efile.fd < 0) {
426 pr_warning("failed to open %s: %s\n", obj->path,
431 obj->efile.elf = elf_begin(obj->efile.fd,
432 LIBBPF_ELF_C_READ_MMAP,
436 if (!obj->efile.elf) {
437 pr_warning("failed to open %s as ELF file\n",
439 err = -LIBBPF_ERRNO__LIBELF;
443 if (!gelf_getehdr(obj->efile.elf, &obj->efile.ehdr)) {
444 pr_warning("failed to get EHDR from %s\n",
446 err = -LIBBPF_ERRNO__FORMAT;
449 ep = &obj->efile.ehdr;
451 /* Old LLVM set e_machine to EM_NONE */
452 if ((ep->e_type != ET_REL) || (ep->e_machine && (ep->e_machine != EM_BPF))) {
453 pr_warning("%s is not an eBPF object file\n",
455 err = -LIBBPF_ERRNO__FORMAT;
461 bpf_object__elf_finish(obj);
466 bpf_object__check_endianness(struct bpf_object *obj)
468 static unsigned int const endian = 1;
470 switch (obj->efile.ehdr.e_ident[EI_DATA]) {
472 /* We are big endian, BPF obj is little endian. */
473 if (*(unsigned char const *)&endian != 1)
478 /* We are little endian, BPF obj is big endian. */
479 if (*(unsigned char const *)&endian != 0)
483 return -LIBBPF_ERRNO__ENDIAN;
489 pr_warning("Error: endianness mismatch.\n");
490 return -LIBBPF_ERRNO__ENDIAN;
494 bpf_object__init_license(struct bpf_object *obj,
495 void *data, size_t size)
497 memcpy(obj->license, data,
498 min(size, sizeof(obj->license) - 1));
499 pr_debug("license of %s is %s\n", obj->path, obj->license);
504 bpf_object__init_kversion(struct bpf_object *obj,
505 void *data, size_t size)
509 if (size != sizeof(kver)) {
510 pr_warning("invalid kver section in %s\n", obj->path);
511 return -LIBBPF_ERRNO__FORMAT;
513 memcpy(&kver, data, sizeof(kver));
514 obj->kern_version = kver;
515 pr_debug("kernel version of %s is %x\n", obj->path,
521 bpf_object__validate_maps(struct bpf_object *obj)
526 * If there's only 1 map, the only error case should have been
527 * catched in bpf_object__init_maps().
529 if (!obj->maps || !obj->nr_maps || (obj->nr_maps == 1))
532 for (i = 1; i < obj->nr_maps; i++) {
533 const struct bpf_map *a = &obj->maps[i - 1];
534 const struct bpf_map *b = &obj->maps[i];
536 if (b->offset - a->offset < sizeof(struct bpf_map_def)) {
537 pr_warning("corrupted map section in %s: map \"%s\" too small\n",
545 static int compare_bpf_map(const void *_a, const void *_b)
547 const struct bpf_map *a = _a;
548 const struct bpf_map *b = _b;
550 return a->offset - b->offset;
554 bpf_object__init_maps(struct bpf_object *obj)
556 int i, map_idx, nr_maps = 0;
559 Elf_Data *symbols = obj->efile.symbols;
561 if (obj->efile.maps_shndx < 0)
566 scn = elf_getscn(obj->efile.elf, obj->efile.maps_shndx);
568 data = elf_getdata(scn, NULL);
570 pr_warning("failed to get Elf_Data from map section %d\n",
571 obj->efile.maps_shndx);
576 * Count number of maps. Each map has a name.
577 * Array of maps is not supported: only the first element is
580 * TODO: Detect array of map and report error.
582 for (i = 0; i < symbols->d_size / sizeof(GElf_Sym); i++) {
585 if (!gelf_getsym(symbols, i, &sym))
587 if (sym.st_shndx != obj->efile.maps_shndx)
592 /* Alloc obj->maps and fill nr_maps. */
593 pr_debug("maps in %s: %d maps in %zd bytes\n", obj->path,
594 nr_maps, data->d_size);
599 obj->maps = calloc(nr_maps, sizeof(obj->maps[0]));
601 pr_warning("alloc maps for object failed\n");
604 obj->nr_maps = nr_maps;
607 * fill all fd with -1 so won't close incorrect
608 * fd (fd=0 is stdin) when failure (zclose won't close
611 for (i = 0; i < nr_maps; i++)
612 obj->maps[i].fd = -1;
615 * Fill obj->maps using data in "maps" section.
617 for (i = 0, map_idx = 0; i < symbols->d_size / sizeof(GElf_Sym); i++) {
619 const char *map_name;
620 struct bpf_map_def *def;
622 if (!gelf_getsym(symbols, i, &sym))
624 if (sym.st_shndx != obj->efile.maps_shndx)
627 map_name = elf_strptr(obj->efile.elf,
628 obj->efile.strtabidx,
630 obj->maps[map_idx].offset = sym.st_value;
631 if (sym.st_value + sizeof(struct bpf_map_def) > data->d_size) {
632 pr_warning("corrupted maps section in %s: last map \"%s\" too small\n",
633 obj->path, map_name);
637 obj->maps[map_idx].name = strdup(map_name);
638 if (!obj->maps[map_idx].name) {
639 pr_warning("failed to alloc map name\n");
642 pr_debug("map %d is \"%s\"\n", map_idx,
643 obj->maps[map_idx].name);
644 def = (struct bpf_map_def *)(data->d_buf + sym.st_value);
645 obj->maps[map_idx].def = *def;
649 qsort(obj->maps, obj->nr_maps, sizeof(obj->maps[0]), compare_bpf_map);
650 return bpf_object__validate_maps(obj);
653 static int bpf_object__elf_collect(struct bpf_object *obj)
655 Elf *elf = obj->efile.elf;
656 GElf_Ehdr *ep = &obj->efile.ehdr;
658 int idx = 0, err = 0;
660 /* Elf is corrupted/truncated, avoid calling elf_strptr. */
661 if (!elf_rawdata(elf_getscn(elf, ep->e_shstrndx), NULL)) {
662 pr_warning("failed to get e_shstrndx from %s\n",
664 return -LIBBPF_ERRNO__FORMAT;
667 while ((scn = elf_nextscn(elf, scn)) != NULL) {
673 if (gelf_getshdr(scn, &sh) != &sh) {
674 pr_warning("failed to get section header from %s\n",
676 err = -LIBBPF_ERRNO__FORMAT;
680 name = elf_strptr(elf, ep->e_shstrndx, sh.sh_name);
682 pr_warning("failed to get section name from %s\n",
684 err = -LIBBPF_ERRNO__FORMAT;
688 data = elf_getdata(scn, 0);
690 pr_warning("failed to get section data from %s(%s)\n",
692 err = -LIBBPF_ERRNO__FORMAT;
695 pr_debug("section %s, size %ld, link %d, flags %lx, type=%d\n",
696 name, (unsigned long)data->d_size,
697 (int)sh.sh_link, (unsigned long)sh.sh_flags,
700 if (strcmp(name, "license") == 0)
701 err = bpf_object__init_license(obj,
704 else if (strcmp(name, "version") == 0)
705 err = bpf_object__init_kversion(obj,
708 else if (strcmp(name, "maps") == 0)
709 obj->efile.maps_shndx = idx;
710 else if (sh.sh_type == SHT_SYMTAB) {
711 if (obj->efile.symbols) {
712 pr_warning("bpf: multiple SYMTAB in %s\n",
714 err = -LIBBPF_ERRNO__FORMAT;
716 obj->efile.symbols = data;
717 obj->efile.strtabidx = sh.sh_link;
719 } else if ((sh.sh_type == SHT_PROGBITS) &&
720 (sh.sh_flags & SHF_EXECINSTR) &&
721 (data->d_size > 0)) {
722 err = bpf_object__add_program(obj, data->d_buf,
723 data->d_size, name, idx);
725 char errmsg[STRERR_BUFSIZE];
727 strerror_r(-err, errmsg, sizeof(errmsg));
728 pr_warning("failed to alloc program %s (%s): %s",
729 name, obj->path, errmsg);
731 } else if (sh.sh_type == SHT_REL) {
732 void *reloc = obj->efile.reloc;
733 int nr_reloc = obj->efile.nr_reloc + 1;
735 reloc = realloc(reloc,
736 sizeof(*obj->efile.reloc) * nr_reloc);
738 pr_warning("realloc failed\n");
741 int n = nr_reloc - 1;
743 obj->efile.reloc = reloc;
744 obj->efile.nr_reloc = nr_reloc;
746 obj->efile.reloc[n].shdr = sh;
747 obj->efile.reloc[n].data = data;
754 if (!obj->efile.strtabidx || obj->efile.strtabidx >= idx) {
755 pr_warning("Corrupted ELF file: index of strtab invalid\n");
756 return LIBBPF_ERRNO__FORMAT;
758 if (obj->efile.maps_shndx >= 0)
759 err = bpf_object__init_maps(obj);
764 static struct bpf_program *
765 bpf_object__find_prog_by_idx(struct bpf_object *obj, int idx)
767 struct bpf_program *prog;
770 for (i = 0; i < obj->nr_programs; i++) {
771 prog = &obj->programs[i];
772 if (prog->idx == idx)
779 bpf_program__collect_reloc(struct bpf_program *prog,
780 size_t nr_maps, GElf_Shdr *shdr,
781 Elf_Data *data, Elf_Data *symbols,
782 int maps_shndx, struct bpf_map *maps)
786 pr_debug("collecting relocating info for: '%s'\n",
788 nrels = shdr->sh_size / shdr->sh_entsize;
790 prog->reloc_desc = malloc(sizeof(*prog->reloc_desc) * nrels);
791 if (!prog->reloc_desc) {
792 pr_warning("failed to alloc memory in relocation\n");
795 prog->nr_reloc = nrels;
797 for (i = 0; i < nrels; i++) {
800 unsigned int insn_idx;
801 struct bpf_insn *insns = prog->insns;
804 if (!gelf_getrel(data, i, &rel)) {
805 pr_warning("relocation: failed to get %d reloc\n", i);
806 return -LIBBPF_ERRNO__FORMAT;
809 if (!gelf_getsym(symbols,
810 GELF_R_SYM(rel.r_info),
812 pr_warning("relocation: symbol %"PRIx64" not found\n",
813 GELF_R_SYM(rel.r_info));
814 return -LIBBPF_ERRNO__FORMAT;
817 if (sym.st_shndx != maps_shndx) {
818 pr_warning("Program '%s' contains non-map related relo data pointing to section %u\n",
819 prog->section_name, sym.st_shndx);
820 return -LIBBPF_ERRNO__RELOC;
823 insn_idx = rel.r_offset / sizeof(struct bpf_insn);
824 pr_debug("relocation: insn_idx=%u\n", insn_idx);
826 if (insns[insn_idx].code != (BPF_LD | BPF_IMM | BPF_DW)) {
827 pr_warning("bpf: relocation: invalid relo for insns[%d].code 0x%x\n",
828 insn_idx, insns[insn_idx].code);
829 return -LIBBPF_ERRNO__RELOC;
832 /* TODO: 'maps' is sorted. We can use bsearch to make it faster. */
833 for (map_idx = 0; map_idx < nr_maps; map_idx++) {
834 if (maps[map_idx].offset == sym.st_value) {
835 pr_debug("relocation: find map %zd (%s) for insn %u\n",
836 map_idx, maps[map_idx].name, insn_idx);
841 if (map_idx >= nr_maps) {
842 pr_warning("bpf relocation: map_idx %d large than %d\n",
843 (int)map_idx, (int)nr_maps - 1);
844 return -LIBBPF_ERRNO__RELOC;
847 prog->reloc_desc[i].insn_idx = insn_idx;
848 prog->reloc_desc[i].map_idx = map_idx;
854 bpf_object__create_maps(struct bpf_object *obj)
858 for (i = 0; i < obj->nr_maps; i++) {
859 struct bpf_map_def *def = &obj->maps[i].def;
860 int *pfd = &obj->maps[i].fd;
862 *pfd = bpf_create_map(def->type,
871 pr_warning("failed to create map: %s\n",
873 for (j = 0; j < i; j++)
874 zclose(obj->maps[j].fd);
877 pr_debug("create map %s: fd=%d\n", obj->maps[i].name, *pfd);
884 bpf_program__relocate(struct bpf_program *prog, struct bpf_object *obj)
888 if (!prog || !prog->reloc_desc)
891 for (i = 0; i < prog->nr_reloc; i++) {
892 int insn_idx, map_idx;
893 struct bpf_insn *insns = prog->insns;
895 insn_idx = prog->reloc_desc[i].insn_idx;
896 map_idx = prog->reloc_desc[i].map_idx;
898 if (insn_idx >= (int)prog->insns_cnt) {
899 pr_warning("relocation out of range: '%s'\n",
901 return -LIBBPF_ERRNO__RELOC;
903 insns[insn_idx].src_reg = BPF_PSEUDO_MAP_FD;
904 insns[insn_idx].imm = obj->maps[map_idx].fd;
907 zfree(&prog->reloc_desc);
914 bpf_object__relocate(struct bpf_object *obj)
916 struct bpf_program *prog;
920 for (i = 0; i < obj->nr_programs; i++) {
921 prog = &obj->programs[i];
923 err = bpf_program__relocate(prog, obj);
925 pr_warning("failed to relocate '%s'\n",
933 static int bpf_object__collect_reloc(struct bpf_object *obj)
937 if (!obj_elf_valid(obj)) {
938 pr_warning("Internal error: elf object is closed\n");
939 return -LIBBPF_ERRNO__INTERNAL;
942 for (i = 0; i < obj->efile.nr_reloc; i++) {
943 GElf_Shdr *shdr = &obj->efile.reloc[i].shdr;
944 Elf_Data *data = obj->efile.reloc[i].data;
945 int idx = shdr->sh_info;
946 struct bpf_program *prog;
947 size_t nr_maps = obj->nr_maps;
949 if (shdr->sh_type != SHT_REL) {
950 pr_warning("internal error at %d\n", __LINE__);
951 return -LIBBPF_ERRNO__INTERNAL;
954 prog = bpf_object__find_prog_by_idx(obj, idx);
956 pr_warning("relocation failed: no %d section\n",
958 return -LIBBPF_ERRNO__RELOC;
961 err = bpf_program__collect_reloc(prog, nr_maps,
964 obj->efile.maps_shndx,
973 load_program(enum bpf_prog_type type, struct bpf_insn *insns,
974 int insns_cnt, char *license, u32 kern_version, int *pfd)
979 if (!insns || !insns_cnt)
982 log_buf = malloc(BPF_LOG_BUF_SIZE);
984 pr_warning("Alloc log buffer for bpf loader error, continue without log\n");
986 ret = bpf_load_program(type, insns, insns_cnt, license,
987 kern_version, log_buf, BPF_LOG_BUF_SIZE);
995 ret = -LIBBPF_ERRNO__LOAD;
996 pr_warning("load bpf program failed: %s\n", strerror(errno));
998 if (log_buf && log_buf[0] != '\0') {
999 ret = -LIBBPF_ERRNO__VERIFY;
1000 pr_warning("-- BEGIN DUMP LOG ---\n");
1001 pr_warning("\n%s\n", log_buf);
1002 pr_warning("-- END LOG --\n");
1003 } else if (insns_cnt >= BPF_MAXINSNS) {
1004 pr_warning("Program too large (%d insns), at most %d insns\n",
1005 insns_cnt, BPF_MAXINSNS);
1006 ret = -LIBBPF_ERRNO__PROG2BIG;
1008 /* Wrong program type? */
1009 if (type != BPF_PROG_TYPE_KPROBE) {
1012 fd = bpf_load_program(BPF_PROG_TYPE_KPROBE, insns,
1013 insns_cnt, license, kern_version,
1017 ret = -LIBBPF_ERRNO__PROGTYPE;
1023 ret = -LIBBPF_ERRNO__KVER;
1032 bpf_program__load(struct bpf_program *prog,
1033 char *license, u32 kern_version)
1037 if (prog->instances.nr < 0 || !prog->instances.fds) {
1038 if (prog->preprocessor) {
1039 pr_warning("Internal error: can't load program '%s'\n",
1040 prog->section_name);
1041 return -LIBBPF_ERRNO__INTERNAL;
1044 prog->instances.fds = malloc(sizeof(int));
1045 if (!prog->instances.fds) {
1046 pr_warning("Not enough memory for BPF fds\n");
1049 prog->instances.nr = 1;
1050 prog->instances.fds[0] = -1;
1053 if (!prog->preprocessor) {
1054 if (prog->instances.nr != 1) {
1055 pr_warning("Program '%s' is inconsistent: nr(%d) != 1\n",
1056 prog->section_name, prog->instances.nr);
1058 err = load_program(prog->type, prog->insns, prog->insns_cnt,
1059 license, kern_version, &fd);
1061 prog->instances.fds[0] = fd;
1065 for (i = 0; i < prog->instances.nr; i++) {
1066 struct bpf_prog_prep_result result;
1067 bpf_program_prep_t preprocessor = prog->preprocessor;
1069 bzero(&result, sizeof(result));
1070 err = preprocessor(prog, i, prog->insns,
1071 prog->insns_cnt, &result);
1073 pr_warning("Preprocessing the %dth instance of program '%s' failed\n",
1074 i, prog->section_name);
1078 if (!result.new_insn_ptr || !result.new_insn_cnt) {
1079 pr_debug("Skip loading the %dth instance of program '%s'\n",
1080 i, prog->section_name);
1081 prog->instances.fds[i] = -1;
1087 err = load_program(prog->type, result.new_insn_ptr,
1088 result.new_insn_cnt,
1089 license, kern_version, &fd);
1092 pr_warning("Loading the %dth instance of program '%s' failed\n",
1093 i, prog->section_name);
1099 prog->instances.fds[i] = fd;
1103 pr_warning("failed to load program '%s'\n",
1104 prog->section_name);
1105 zfree(&prog->insns);
1106 prog->insns_cnt = 0;
1111 bpf_object__load_progs(struct bpf_object *obj)
1116 for (i = 0; i < obj->nr_programs; i++) {
1117 err = bpf_program__load(&obj->programs[i],
1126 static int bpf_object__validate(struct bpf_object *obj)
1128 if (obj->kern_version == 0) {
1129 pr_warning("%s doesn't provide kernel version\n",
1131 return -LIBBPF_ERRNO__KVERSION;
1136 static struct bpf_object *
1137 __bpf_object__open(const char *path, void *obj_buf, size_t obj_buf_sz)
1139 struct bpf_object *obj;
1142 if (elf_version(EV_CURRENT) == EV_NONE) {
1143 pr_warning("failed to init libelf for %s\n", path);
1144 return ERR_PTR(-LIBBPF_ERRNO__LIBELF);
1147 obj = bpf_object__new(path, obj_buf, obj_buf_sz);
1151 CHECK_ERR(bpf_object__elf_init(obj), err, out);
1152 CHECK_ERR(bpf_object__check_endianness(obj), err, out);
1153 CHECK_ERR(bpf_object__elf_collect(obj), err, out);
1154 CHECK_ERR(bpf_object__collect_reloc(obj), err, out);
1155 CHECK_ERR(bpf_object__validate(obj), err, out);
1157 bpf_object__elf_finish(obj);
1160 bpf_object__close(obj);
1161 return ERR_PTR(err);
1164 struct bpf_object *bpf_object__open(const char *path)
1166 /* param validation */
1170 pr_debug("loading %s\n", path);
1172 return __bpf_object__open(path, NULL, 0);
1175 struct bpf_object *bpf_object__open_buffer(void *obj_buf,
1181 /* param validation */
1182 if (!obj_buf || obj_buf_sz <= 0)
1186 snprintf(tmp_name, sizeof(tmp_name), "%lx-%lx",
1187 (unsigned long)obj_buf,
1188 (unsigned long)obj_buf_sz);
1189 tmp_name[sizeof(tmp_name) - 1] = '\0';
1192 pr_debug("loading object '%s' from buffer\n",
1195 return __bpf_object__open(name, obj_buf, obj_buf_sz);
1198 int bpf_object__unload(struct bpf_object *obj)
1205 for (i = 0; i < obj->nr_maps; i++)
1206 zclose(obj->maps[i].fd);
1208 for (i = 0; i < obj->nr_programs; i++)
1209 bpf_program__unload(&obj->programs[i]);
1214 int bpf_object__load(struct bpf_object *obj)
1222 pr_warning("object should not be loaded twice\n");
1228 CHECK_ERR(bpf_object__create_maps(obj), err, out);
1229 CHECK_ERR(bpf_object__relocate(obj), err, out);
1230 CHECK_ERR(bpf_object__load_progs(obj), err, out);
1234 bpf_object__unload(obj);
1235 pr_warning("failed to load object '%s'\n", obj->path);
1239 void bpf_object__close(struct bpf_object *obj)
1246 if (obj->clear_priv)
1247 obj->clear_priv(obj, obj->priv);
1249 bpf_object__elf_finish(obj);
1250 bpf_object__unload(obj);
1252 for (i = 0; i < obj->nr_maps; i++) {
1253 zfree(&obj->maps[i].name);
1254 if (obj->maps[i].clear_priv)
1255 obj->maps[i].clear_priv(&obj->maps[i],
1257 obj->maps[i].priv = NULL;
1258 obj->maps[i].clear_priv = NULL;
1263 if (obj->programs && obj->nr_programs) {
1264 for (i = 0; i < obj->nr_programs; i++)
1265 bpf_program__exit(&obj->programs[i]);
1267 zfree(&obj->programs);
1269 list_del(&obj->list);
1274 bpf_object__next(struct bpf_object *prev)
1276 struct bpf_object *next;
1279 next = list_first_entry(&bpf_objects_list,
1283 next = list_next_entry(prev, list);
1285 /* Empty list is noticed here so don't need checking on entry. */
1286 if (&next->list == &bpf_objects_list)
1292 const char *bpf_object__name(struct bpf_object *obj)
1294 return obj ? obj->path : ERR_PTR(-EINVAL);
1297 unsigned int bpf_object__kversion(struct bpf_object *obj)
1299 return obj ? obj->kern_version : 0;
1302 int bpf_object__set_priv(struct bpf_object *obj, void *priv,
1303 bpf_object_clear_priv_t clear_priv)
1305 if (obj->priv && obj->clear_priv)
1306 obj->clear_priv(obj, obj->priv);
1309 obj->clear_priv = clear_priv;
1313 void *bpf_object__priv(struct bpf_object *obj)
1315 return obj ? obj->priv : ERR_PTR(-EINVAL);
1318 struct bpf_program *
1319 bpf_program__next(struct bpf_program *prev, struct bpf_object *obj)
1327 return &obj->programs[0];
1329 if (prev->obj != obj) {
1330 pr_warning("error: program handler doesn't match object\n");
1334 idx = (prev - obj->programs) + 1;
1335 if (idx >= obj->nr_programs)
1337 return &obj->programs[idx];
1340 int bpf_program__set_priv(struct bpf_program *prog, void *priv,
1341 bpf_program_clear_priv_t clear_priv)
1343 if (prog->priv && prog->clear_priv)
1344 prog->clear_priv(prog, prog->priv);
1347 prog->clear_priv = clear_priv;
1351 void *bpf_program__priv(struct bpf_program *prog)
1353 return prog ? prog->priv : ERR_PTR(-EINVAL);
1356 const char *bpf_program__title(struct bpf_program *prog, bool needs_copy)
1360 title = prog->section_name;
1362 title = strdup(title);
1364 pr_warning("failed to strdup program title\n");
1365 return ERR_PTR(-ENOMEM);
1372 int bpf_program__fd(struct bpf_program *prog)
1374 return bpf_program__nth_fd(prog, 0);
1377 int bpf_program__set_prep(struct bpf_program *prog, int nr_instances,
1378 bpf_program_prep_t prep)
1382 if (nr_instances <= 0 || !prep)
1385 if (prog->instances.nr > 0 || prog->instances.fds) {
1386 pr_warning("Can't set pre-processor after loading\n");
1390 instances_fds = malloc(sizeof(int) * nr_instances);
1391 if (!instances_fds) {
1392 pr_warning("alloc memory failed for fds\n");
1396 /* fill all fd with -1 */
1397 memset(instances_fds, -1, sizeof(int) * nr_instances);
1399 prog->instances.nr = nr_instances;
1400 prog->instances.fds = instances_fds;
1401 prog->preprocessor = prep;
1405 int bpf_program__nth_fd(struct bpf_program *prog, int n)
1409 if (n >= prog->instances.nr || n < 0) {
1410 pr_warning("Can't get the %dth fd from program %s: only %d instances\n",
1411 n, prog->section_name, prog->instances.nr);
1415 fd = prog->instances.fds[n];
1417 pr_warning("%dth instance of program '%s' is invalid\n",
1418 n, prog->section_name);
1425 static void bpf_program__set_type(struct bpf_program *prog,
1426 enum bpf_prog_type type)
1431 static bool bpf_program__is_type(struct bpf_program *prog,
1432 enum bpf_prog_type type)
1434 return prog ? (prog->type == type) : false;
1437 #define BPF_PROG_TYPE_FNS(NAME, TYPE) \
1438 int bpf_program__set_##NAME(struct bpf_program *prog) \
1442 bpf_program__set_type(prog, TYPE); \
1446 bool bpf_program__is_##NAME(struct bpf_program *prog) \
1448 return bpf_program__is_type(prog, TYPE); \
1451 BPF_PROG_TYPE_FNS(socket_filter, BPF_PROG_TYPE_SOCKET_FILTER);
1452 BPF_PROG_TYPE_FNS(kprobe, BPF_PROG_TYPE_KPROBE);
1453 BPF_PROG_TYPE_FNS(sched_cls, BPF_PROG_TYPE_SCHED_CLS);
1454 BPF_PROG_TYPE_FNS(sched_act, BPF_PROG_TYPE_SCHED_ACT);
1455 BPF_PROG_TYPE_FNS(tracepoint, BPF_PROG_TYPE_TRACEPOINT);
1456 BPF_PROG_TYPE_FNS(xdp, BPF_PROG_TYPE_XDP);
1457 BPF_PROG_TYPE_FNS(perf_event, BPF_PROG_TYPE_PERF_EVENT);
1459 int bpf_map__fd(struct bpf_map *map)
1461 return map ? map->fd : -EINVAL;
1464 const struct bpf_map_def *bpf_map__def(struct bpf_map *map)
1466 return map ? &map->def : ERR_PTR(-EINVAL);
1469 const char *bpf_map__name(struct bpf_map *map)
1471 return map ? map->name : NULL;
1474 int bpf_map__set_priv(struct bpf_map *map, void *priv,
1475 bpf_map_clear_priv_t clear_priv)
1481 if (map->clear_priv)
1482 map->clear_priv(map, map->priv);
1486 map->clear_priv = clear_priv;
1490 void *bpf_map__priv(struct bpf_map *map)
1492 return map ? map->priv : ERR_PTR(-EINVAL);
1496 bpf_map__next(struct bpf_map *prev, struct bpf_object *obj)
1499 struct bpf_map *s, *e;
1501 if (!obj || !obj->maps)
1505 e = obj->maps + obj->nr_maps;
1510 if ((prev < s) || (prev >= e)) {
1511 pr_warning("error in %s: map handler doesn't belong to object\n",
1516 idx = (prev - obj->maps) + 1;
1517 if (idx >= obj->nr_maps)
1519 return &obj->maps[idx];
1523 bpf_object__find_map_by_name(struct bpf_object *obj, const char *name)
1525 struct bpf_map *pos;
1527 bpf_map__for_each(pos, obj) {
1528 if (pos->name && !strcmp(pos->name, name))
1535 bpf_object__find_map_by_offset(struct bpf_object *obj, size_t offset)
1539 for (i = 0; i < obj->nr_maps; i++) {
1540 if (obj->maps[i].offset == offset)
1541 return &obj->maps[i];
1543 return ERR_PTR(-ENOENT);