libbpf: Support symbol versioning for uprobe
Subsystems (4)
v2 cover libbpf: Support symbol versioning for uprobe
Dynamic symbols in shared library may have the same name, for example:
$ nm -D /lib/x86_64-linux-gnu/libc.so.6 | grep rwlock_wrlock
000000000009b1a0 T __pthread_rwlock_wrlock@GLIBC_2.2.5
000000000009b1a0 T pthread_rwlock_wrlock@@GLIBC_2.34
000000000009b1a0 T pthread_rwlock_wrlock@GLIBC_2.2.5 $ readelf -W --dyn-syms /lib/x86_64-linux-gnu/libc.so.6 | grep rwlock_wrlock
706: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 __pthread_rwlock_wrlock@GLIBC_2.2.5
2568: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 pthread_rwlock_wrlock@@GLIBC_2.34
2571: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 pthread_rwlock_wrlock@GLIBC_2.2.5There are two pthread_rwlock_wrlock symbols in libc.so .dynsym section. The one with @@ is the default version, the other is hidden. Note that the version info is stored in .gnu.version and .gnu.version_d sections of libc and the two symbols are at the _same_ offset.
Currently, specify pthread_rwlock_wrlock, pthread_rwlock_wrlock@@GLIBC_2.34 or pthread_rwlock_wrlock@GLIBC_2.2.5 in bpf_uprobe_opts::func_name won't work. Because there are two pthread_rwlock_wrlock in .dynsym sections without the version suffix and both are global bind.
We could solve this by introducing symbol versioning ([0]). So that users can specify func, func@LIB_VERSION or func@@LIB_VERSION to attach a uprobe.
This patchset resolves symbol conflicts and add symbol versioning for uprobe.
- Patch 1 resolves symbol conflicts at the same offset
- Patch 2 adds symbol versioning for dynsym
- Patch 3 adds selftests for the above changes
Changes from v1:
- Address comments from Alan and Jiri
- Add selftests (Someone reminds me that there is an attempt at [1] and part of the selftest code from Andrii is taken from there)
[0]: https://refspecs.linuxfoundation.org/LSB_5.0.0/LSB-Core-generic/LSB-Core-generic/symversion.html
[1]: https://lore.kernel.org/lkml/CAEf4BzZTrjjyyOm3ak9JsssPSh6T_ZmGd677a2rt5e5rBLUrpQ@mail.gmail.com/
Hengqi Chen (3):
libbpf: Resolve symbol conflicts at the same offset for uprobe
libbpf: Support symbol versioning for uprobe selftests/bpf: Add tests for symbol versioning for uprobe
tools/lib/bpf/elf.c | 150 ++++++++++++++++-- tools/lib/bpf/libbpf.c | 2 +- tools/testing/selftests/bpf/Makefile | 5 +- .../testing/selftests/bpf/liburandom_read.map | 15 ++ .../testing/selftests/bpf/prog_tests/uprobe.c | 95 +++++++++++ .../testing/selftests/bpf/progs/test_uprobe.c | 61 +++++++ tools/testing/selftests/bpf/urandom_read.c | 9 ++ .../testing/selftests/bpf/urandom_read_lib1.c | 41 +++++ 8 files changed, 361 insertions(+), 17 deletions(-) create mode 100644 tools/testing/selftests/bpf/liburandom_read.map create mode 100644 tools/testing/selftests/bpf/prog_tests/uprobe.c create mode 100644 tools/testing/selftests/bpf/progs/test_uprobe.c
--
2.34.1
PATCH v2 1/3 libbpf: Resolve symbol conflicts at the same offset for uprobe
Dynamic symbols in shared library may have the same name, for example:
$ nm -D /lib/x86_64-linux-gnu/libc.so.6 | grep rwlock_wrlock
000000000009b1a0 T __pthread_rwlock_wrlock@GLIBC_2.2.5
000000000009b1a0 T pthread_rwlock_wrlock@@GLIBC_2.34
000000000009b1a0 T pthread_rwlock_wrlock@GLIBC_2.2.5 $ readelf -W --dyn-syms /lib/x86_64-linux-gnu/libc.so.6 | grep rwlock_wrlock
706: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 __pthread_rwlock_wrlock@GLIBC_2.2.5
2568: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 pthread_rwlock_wrlock@@GLIBC_2.34
2571: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 pthread_rwlock_wrlock@GLIBC_2.2.5Currently, users can't attach a uprobe to pthread_rwlock_wrlock because there are two symbols named pthread_rwlock_wrlock and both are global bind. And libbpf considers it as a conflict.
Since both of them are at the same offset we could accept one of them harmlessly. Note that we already does this in elf_resolve_syms_offsets.
--- tools/lib/bpf/elf.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)
tools/lib/bpf/elf.c +4 -1
@@ -214,7 +214,10 @@ long elf_find_func_offset(Elf *elf, const char *binary_path, const char *name)if (ret >0 ) {/* handle multiple matches */ -if (last_bind !=STB_WEAK && cur_bind !=STB_WEAK ) { +if (elf_sym_offset (sym) == ret) { +/* same offset, no problem */ +continue ; + }else if (last_bind !=STB_WEAK && cur_bind !=STB_WEAK ) {/* Only accept one non-weak bind. */ pr_warn ("elf: ambiguous match for '%s', '%s' in '%s'\n" , sym->name, name, binary_path);
--
2.34.1
Re: [PATCH bpf-next v2 1/3] libbpf: Resolve symbol conflicts at the same offset for uprobe
Quoted 12 lines · Hengqi Chen
Dynamic symbols in shared library may have the same name, for example:
$ nm -D /lib/x86_64-linux-gnu/libc.so.6 | grep rwlock_wrlock 000000000009b1a0 T __pthread_rwlock_wrlock@GLIBC_2.2.5 000000000009b1a0 T pthread_rwlock_wrlock@@GLIBC_2.34 000000000009b1a0 T pthread_rwlock_wrlock@GLIBC_2.2.5$ readelf -W --dyn-syms /lib/x86_64-linux-gnu/libc.so.6 | grep rwlock_wrlock 706: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 __pthread_rwlock_wrlock@GLIBC_2.2.5 2568: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 pthread_rwlock_wrlock@@GLIBC_2.34 2571: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 pthread_rwlock_wrlock@GLIBC_2.2.5
Quoted 8 lines
Currently, users can't attach a uprobe to
pthread_rwlock_wrlockbecause there are two symbols namedpthread_rwlock_wrlockand both are global bind. And libbpf considers it as a conflict.Since both of them are at the same offset we could accept one of them harmlessly. Note that we already does this in
elf_resolve_syms_offsets.Signed-off-by Hengqi Chen <[email protected]>
Quoted 22 lines
--- tools/lib/bpf/elf.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)tools/lib/bpf/elf.c +4
-2@@ -214,7 +214,10 @@ long elf_find_func_offset(Elf *elf, const char *binary_path, const char *name)if (ret >0 ) {/* handle multiple matches */ -if (last_bind !=STB_WEAK && cur_bind !=STB_WEAK ) { +if (elf_sym_offset (sym) == ret) { +/* same offset, no problem */ +continue ; + }else if (last_bind !=STB_WEAK && cur_bind !=STB_WEAK ) {/* Only accept one non-weak bind. */ pr_warn ("elf: ambiguous match for '%s', '%s' in '%s'\n" , sym->name, name, binary_path); --2.34.1
Re: [PATCH bpf-next v2 1/3] libbpf: Resolve symbol conflicts at the same offset for uprobe
In reply to Hengqi ChenQuoted 12 lines · Hengqi Chen
Dynamic symbols in shared library may have the same name, for example:
$ nm -D /lib/x86_64-linux-gnu/libc.so.6 | grep rwlock_wrlock 000000000009b1a0 T __pthread_rwlock_wrlock@GLIBC_2.2.5 000000000009b1a0 T pthread_rwlock_wrlock@@GLIBC_2.34 000000000009b1a0 T pthread_rwlock_wrlock@GLIBC_2.2.5$ readelf -W --dyn-syms /lib/x86_64-linux-gnu/libc.so.6 | grep rwlock_wrlock 706: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 __pthread_rwlock_wrlock@GLIBC_2.2.5 2568: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 pthread_rwlock_wrlock@@GLIBC_2.34 2571: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 pthread_rwlock_wrlock@GLIBC_2.2.5
Quoted 8 lines
Currently, users can't attach a uprobe to
pthread_rwlock_wrlockbecause there are two symbols namedpthread_rwlock_wrlockand both are global bind. And libbpf considers it as a conflict.Since both of them are at the same offset we could accept one of them harmlessly. Note that we already does this in
elf_resolve_syms_offsets.Signed-off-by Hengqi Chen <[email protected]>
jirka
Quoted 22 lines
--- tools/lib/bpf/elf.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)tools/lib/bpf/elf.c +4
-2@@ -214,7 +214,10 @@ long elf_find_func_offset(Elf *elf, const char *binary_path, const char *name)if (ret >0 ) {/* handle multiple matches */ -if (last_bind !=STB_WEAK && cur_bind !=STB_WEAK ) { +if (elf_sym_offset (sym) == ret) { +/* same offset, no problem */ +continue ; + }else if (last_bind !=STB_WEAK && cur_bind !=STB_WEAK ) {/* Only accept one non-weak bind. */ pr_warn ("elf: ambiguous match for '%s', '%s' in '%s'\n" , sym->name, name, binary_path); --2.34.1
PATCH v2 2/3 libbpf: Support symbol versioning for uprobe
In reply to Hengqi ChenIn current implementation, we assume that symbol found in .dynsym section would have a version suffix and use it to compare with symbol user supplied. According to the spec ([0]), this assumption is incorrect, the version info of dynamic symbols are stored in .gnu.version and .gnu.version_d sections of ELF objects. For example:
$ nm -D /lib/x86_64-linux-gnu/libc.so.6 | grep rwlock_wrlock
000000000009b1a0 T __pthread_rwlock_wrlock@GLIBC_2.2.5
000000000009b1a0 T pthread_rwlock_wrlock@@GLIBC_2.34
000000000009b1a0 T pthread_rwlock_wrlock@GLIBC_2.2.5 $ readelf -W --dyn-syms /lib/x86_64-linux-gnu/libc.so.6 | grep rwlock_wrlock
706: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 __pthread_rwlock_wrlock@GLIBC_2.2.5
2568: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 pthread_rwlock_wrlock@@GLIBC_2.34
2571: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 pthread_rwlock_wrlock@GLIBC_2.2.5In this case, specify pthread_rwlock_wrlock@@GLIBC_2.34 or pthread_rwlock_wrlock@GLIBC_2.2.5 in bpf_uprobe_opts::func_name won't work. Because the qualified name does NOT match pthread_rwlock_wrlock (without version suffix) in .dynsym sections.
This commit implements the symbol versioning for dynsym and allows user to specify symbol in the following forms:
- func
- func@LIB_VERSION
- func@@LIB_VERSION
In case of symbol conflicts, error out and users should resolve it by specifying a qualified name.
[0]: https://refspecs.linuxfoundation.org/LSB_5.0.0/LSB-Core-generic/LSB-Core-generic/symversion.html
--- tools/lib/bpf/elf.c | 145 +++++++++++++++++++++++++++++++++++++---- tools/lib/bpf/libbpf.c | 2 +- 2 files changed, 133 insertions(+), 14 deletions(-)
tools/lib/bpf/elf.c +132 -13
@@ -1,5 +1,8 @@// SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) +#ifndef _GNU_SOURCE +#define _GNU_SOURCE +#endif #include <libelf.h> #include <gelf.h> #include <fcntl.h>
@@ -10,6 +13,17 @@#define STRERR_BUFSIZE 128 +/* A SHT_GNU_versym section holds 16-bit words. This bit is set if +* the symbol is hidden and can only be seen when referenced using an +* explicit version number. This is a GNU extension. +*/ +#define VERSYM_HIDDEN 0x8000 + +/* This is the mask for the rest of the data in a word read from a +* SHT_GNU_versym section. +*/ +#define VERSYM_VERSION 0x7fff +int elf_open (const char *binary_path,struct elf_fd *elf_fd) {char errmsg[STRERR_BUFSIZE ];
@@ -64,11 +78,14 @@ struct elf_sym {const char *name;GElf_Sym sym;GElf_Shdr sh; +int ver; +bool hidden; };struct elf_sym_iter {Elf *elf;Elf_Data *syms; +Elf_Data *versyms;size_t nr_syms;size_t strtabidx;size_t next_sym_idx;
@@ -111,6 +128,18 @@ static int elf_sym_iter_new(struct elf_sym_iter *iter, iter->nr_syms = iter->syms->d_size / sh.sh_entsize; iter->elf = elf; iter->st_type = st_type; + +/* Version symbol table is meaningful to dynsym only */ +if (sh_type !=SHT_DYNSYM ) +return 0 ; + + scn =elf_find_next_scn_by_type (elf, SHT_GNU_versym,NULL ); +if (!scn) +return 0 ; +if (!gelf_getshdr (scn, &sh)) +return -EINVAL ; + iter->versyms =elf_getdata (scn,0 ); +return 0 ; }
@@ -119,6 +148,7 @@ static struct elf_sym *elf_sym_iter_next(struct elf_sym_iter *iter)struct elf_sym *ret = &iter->sym;GElf_Sym *sym = &ret->sym;const char *name =NULL ; +GElf_Versym versym;Elf_Scn *sym_scn;size_t idx;
@@ -138,12 +168,112 @@ static struct elf_sym *elf_sym_iter_next(struct elf_sym_iter *iter) iter->next_sym_idx = idx +1 ; ret->name = name; + ret->ver =0 ; + ret->hidden = false; + +if (iter->versyms) { +if (!gelf_getversym (iter->versyms, idx, &versym)) +continue ; + ret->ver = versym &VERSYM_VERSION ; + ret->hidden = versym &VERSYM_HIDDEN ; + }return ret; }return NULL ; } +static const char *elf_get_vername (Elf *elf,int ver) +{ +GElf_Verdaux verdaux; +GElf_Verdef verdef; +Elf_Data *verdefs; +size_t strtabidx; +GElf_Shdr sh; +Elf_Scn *scn; +int offset; + + scn =elf_find_next_scn_by_type (elf, SHT_GNU_verdef,NULL ); +if (!scn) +return NULL ; +if (!gelf_getshdr (scn, &sh)) +return NULL ; + strtabidx = sh.sh_link; + verdefs =elf_getdata (scn,0 ); + + offset =0 ; +while (gelf_getverdef (verdefs, offset, &verdef)) { +if (verdef.vd_ndx != ver) { +if (!verdef.vd_next) +break ; + + offset += verdef.vd_next; +continue ; + } + +if (!gelf_getverdaux (verdefs, offset + verdef.vd_aux, &verdaux)) +break ; + +return elf_strptr (elf, strtabidx, verdaux.vda_name); + + } +return NULL ; +} + +static bool symbol_match (Elf *elf,int sh_type,struct elf_sym *sym,const char *name) +{ +size_t name_len, sname_len; +bool is_name_qualified; +const char *ver; +char *sname; +int ret; + + name_len =strlen (name); +/* Does name specify "@LIB" or "@@LIB" ? */ + is_name_qualified =strstr (name,"@" ) !=NULL ; + +/* If user specify a qualified name, for dynamic symbol, +* it is in form of func, NOT func@LIB_VER or func@@LIB_VER. +* So construct a full quailified symbol name using versym info +* for comparison. +*/ +if (is_name_qualified && sh_type ==SHT_DYNSYM ) { +/* Make sure func match func@LIB_VER */ + sname_len =strlen (sym->name); +if (strncmp (sym->name, name, sname_len) !=0 ) +return false; + +/* But not func2@LIB_VER */ +if (name[sname_len] !='@' ) +return false; + + ver =elf_get_vername (elf, sym->ver); +if (!ver) +return false; + + ret =asprintf (&sname,"%s%s%s" , sym->name, + sym->hidden ?"@" :"@@" , ver); +if (ret ==-1 ) +return false; + + ret =strncmp (sname, name, name_len); +free (sname); +return ret ==0 ; + } + +/* Otherwise, for normal symbols or non-qualified names +* User can specify func, func@@LIB or func@@LIB_VERSION. +*/ +if (strncmp (sym->name, name, name_len) !=0 ) +return false; +/* ...but we don't want a search for "foo" to match 'foo2" also, so any +* additional characters in sname should be of the form "@LIB" or "@@LIB". +*/ +if (!is_name_qualified && sym->name[name_len] !='\0' && sym->name[name_len] !='@' ) +return false; + +return true; +}/* Transform symbol's virtual address (absolute for binaries and relative * for shared libs) into file offset, which is what kernel is expecting
@@ -166,9 +296,8 @@ static unsigned long elf_sym_offset(struct elf_sym *sym)long elf_find_func_offset (Elf *elf,const char *binary_path,const char *name) {int i, sh_types[2 ] = {SHT_DYNSYM ,SHT_SYMTAB }; -bool is_shared_lib, is_name_qualified; +bool is_shared_lib;long ret = -ENOENT ; -size_t name_len;GElf_Ehdr ehdr;if (!gelf_getehdr (elf, &ehdr)) {
@@ -179,10 +308,6 @@ long elf_find_func_offset(Elf *elf, const char *binary_path, const char *name)/* for shared lib case, we do not need to calculate relative offset */ is_shared_lib = ehdr.e_type ==ET_DYN ; - name_len =strlen (name); -/* Does name specify "@@LIB"? */ - is_name_qualified =strstr (name,"@@" ) !=NULL ; -/* Search SHT_DYNSYM, SHT_SYMTAB for symbol. This search order is used because if * a binary is stripped, it may only have SHT_DYNSYM, and a fully-statically * linked binary may not have SHT_DYMSYM, so absence of a section should not be
@@ -201,13 +326,7 @@ long elf_find_func_offset(Elf *elf, const char *binary_path, const char *name) goto out;while ((sym =elf_sym_iter_next (&iter))) { -/* User can specify func, func@@LIB or func@@LIB_VERSION. */ -if (strncmp (sym->name, name, name_len) !=0 ) -continue ; -/* ...but we don't want a search for "foo" to match 'foo2" also, so any -* additional characters in sname should be of the form "@@LIB". -*/ -if (!is_name_qualified && sym->name[name_len] !='\0' && sym->name[name_len] !='@' ) +if (!symbol_match (elf, sh_types[i], sym, name))continue ; cur_bind =GELF_ST_BIND (sym->sym.st_info);
tools/lib/bpf/libbpf.c +1 -1
@@ -11512,7 +11512,7 @@ static int attach_uprobe(const struct bpf_program *prog, long cookie, struct bpf *link =NULL ; - n =sscanf (prog->sec_name,"%m[^/]/%m[^:]:%m[a-zA-Z0-9_.]+%li" , + n =sscanf (prog->sec_name,"%m[^/]/%m[^:]:%m[a-zA-Z0-9_.@]+%li" , &probe_type, &binary_path, &func_name, &offset);switch (n) {case 1 :
--
2.34.1
Quoted 27 lines · Hengqi Chen
In current implementation, we assume that symbol found in .dynsym section would have a version suffix and use it to compare with symbol user supplied. According to the spec ([0]), this assumption is incorrect, the version info of dynamic symbols are stored in .gnu.version and .gnu.version_d sections of ELF objects. For example:
$ nm -D /lib/x86_64-linux-gnu/libc.so.6 | grep rwlock_wrlock 000000000009b1a0 T __pthread_rwlock_wrlock@GLIBC_2.2.5 000000000009b1a0 T pthread_rwlock_wrlock@@GLIBC_2.34 000000000009b1a0 T pthread_rwlock_wrlock@GLIBC_2.2.5$ readelf -W --dyn-syms /lib/x86_64-linux-gnu/libc.so.6 | grep rwlock_wrlock 706: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 __pthread_rwlock_wrlock@GLIBC_2.2.5 2568: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 pthread_rwlock_wrlock@@GLIBC_2.34 2571: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 pthread_rwlock_wrlock@GLIBC_2.2.5In this case, specify pthread_rwlock_wrlock@@GLIBC_2.34 or pthread_rwlock_wrlock@GLIBC_2.2.5 in
bpf_uprobe_opts::func_namewon't work. Because the qualified name does NOT matchpthread_rwlock_wrlock(without version suffix) in .dynsym sections.This commit implements the symbol versioning for dynsym and allows user to specify symbol in the following forms:
- func
- func@LIB_VERSION
- func@@LIB_VERSION
Quoted 6 lines
In case of symbol conflicts, error out and users should resolve it by specifying a qualified name.
[0]: https://refspecs.linuxfoundation.org/LSB_5.0.0/LSB-Core-generic/LSB-Core-generic/symversion.html
Signed-off-by Hengqi Chen <[email protected]>
One question below, but
Quoted 161 lines
--- tools/lib/bpf/elf.c | 145 +++++++++++++++++++++++++++++++++++++---- tools/lib/bpf/libbpf.c | 2 +- 2 files changed, 133 insertions(+), 14 deletions(-)tools/lib/bpf/elf.c +103
-0@@ -1,5 +1,8 @@// SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) +#ifndef _GNU_SOURCE +#define _GNU_SOURCE +#endif #include <libelf.h> #include <gelf.h> #include <fcntl.h> @@ -10,6 +13,17 @@#define STRERR_BUFSIZE 128 +/* A SHT_GNU_versym section holds 16-bit words. This bit is set if +* the symbol is hidden and can only be seen when referenced using an +* explicit version number. This is a GNU extension. +*/ +#define VERSYM_HIDDEN 0x8000 + +/* This is the mask for the rest of the data in a word read from a +* SHT_GNU_versym section. +*/ +#define VERSYM_VERSION 0x7fff +int elf_open (const char *binary_path,struct elf_fd *elf_fd) {char errmsg[STRERR_BUFSIZE ];@@ -64,11 +78,14 @@ struct elf_sym {const char *name;GElf_Sym sym;GElf_Shdr sh; +int ver; +bool hidden; };struct elf_sym_iter {Elf *elf;Elf_Data *syms; +Elf_Data *versyms;size_t nr_syms;size_t strtabidx;size_t next_sym_idx;@@ -111,6 +128,18 @@ static int elf_sym_iter_new(struct elf_sym_iter *iter, iter->nr_syms = iter->syms->d_size / sh.sh_entsize; iter->elf = elf; iter->st_type = st_type; + +/* Version symbol table is meaningful to dynsym only */ +if (sh_type !=SHT_DYNSYM ) +return 0 ; + + scn =elf_find_next_scn_by_type (elf, SHT_GNU_versym,NULL ); +if (!scn) +return 0 ; +if (!gelf_getshdr (scn, &sh)) +return -EINVAL ; + iter->versyms =elf_getdata (scn,0 ); +return 0 ; }@@ -119,6 +148,7 @@ static struct elf_sym *elf_sym_iter_next(struct elf_sym_iter *iter)struct elf_sym *ret = &iter->sym;GElf_Sym *sym = &ret->sym;const char *name =NULL ; +GElf_Versym versym;Elf_Scn *sym_scn;size_t idx;@@ -138,12 +168,112 @@ static struct elf_sym *elf_sym_iter_next(struct elf_sym_iter *iter) iter->next_sym_idx = idx +1 ; ret->name = name; + ret->ver =0 ; + ret->hidden = false; + +if (iter->versyms) { +if (!gelf_getversym (iter->versyms, idx, &versym)) +continue ; + ret->ver = versym &VERSYM_VERSION ; + ret->hidden = versym &VERSYM_HIDDEN ; + }return ret; }return NULL ; } +static const char *elf_get_vername (Elf *elf,int ver) +{ +GElf_Verdaux verdaux; +GElf_Verdef verdef; +Elf_Data *verdefs; +size_t strtabidx; +GElf_Shdr sh; +Elf_Scn *scn; +int offset; + + scn =elf_find_next_scn_by_type (elf, SHT_GNU_verdef,NULL ); +if (!scn) +return NULL ; +if (!gelf_getshdr (scn, &sh)) +return NULL ; + strtabidx = sh.sh_link; + verdefs =elf_getdata (scn,0 ); + + offset =0 ; +while (gelf_getverdef (verdefs, offset, &verdef)) { +if (verdef.vd_ndx != ver) { +if (!verdef.vd_next) +break ; + + offset += verdef.vd_next; +continue ; + } + +if (!gelf_getverdaux (verdefs, offset + verdef.vd_aux, &verdaux)) +break ; + +return elf_strptr (elf, strtabidx, verdaux.vda_name); + + } +return NULL ; +} + +static bool symbol_match (Elf *elf,int sh_type,struct elf_sym *sym,const char *name) +{ +size_t name_len, sname_len; +bool is_name_qualified; +const char *ver; +char *sname; +int ret; + + name_len =strlen (name); +/* Does name specify "@LIB" or "@@LIB" ? */ + is_name_qualified =strstr (name,"@" ) !=NULL ; + +/* If user specify a qualified name, for dynamic symbol, +* it is in form of func, NOT func@LIB_VER or func@@LIB_VER. +* So construct a full quailified symbol name using versym info +* for comparison. +*/ +if (is_name_qualified && sh_type ==SHT_DYNSYM ) { +/* Make sure func match func@LIB_VER */ + sname_len =strlen (sym->name); +if (strncmp (sym->name, name, sname_len) !=0 ) +return false; + +/* But not func2@LIB_VER */ +if (name[sname_len] !='@' ) +return false; +
tools/lib/bpf/elf.c static struct elf_sym *elf_sym_iter_next(struct elf_sym_iter *iter) · line 259
Quoted 10 lines
tools/lib/bpf/elf.c +10
-0+ ver =elf_get_vername (elf, sym->ver); +if (!ver) +return false; + + ret =asprintf (&sname,"%s%s%s" , sym->name, + sym->hidden ?"@" :"@@" , ver); +if (ret ==-1 ) +return false; + + ret =strncmp (sname, name, name_len);
I _think_ because we're using the length of the name we're searching for we'd end up matching pthread_rwlock_wrlock@@G and pthread_rwlock_wrlock@@GLIBC_2.34 ; should we use strlen(sname) to do an exact match here?
Quoted 72 lines
tools/lib/bpf/elf.c +19
-13+free (sname); +return ret ==0 ; + } + +/* Otherwise, for normal symbols or non-qualified names +* User can specify func, func@@LIB or func@@LIB_VERSION. +*/ +if (strncmp (sym->name, name, name_len) !=0 ) +return false; +/* ...but we don't want a search for "foo" to match 'foo2" also, so any +* additional characters in sname should be of the form "@LIB" or "@@LIB". +*/ +if (!is_name_qualified && sym->name[name_len] !='\0' && sym->name[name_len] !='@' ) +return false; + +return true; +}/* Transform symbol's virtual address (absolute for binaries and relative * for shared libs) into file offset, which is what kernel is expecting @@ -166,9 +296,8 @@ static unsigned long elf_sym_offset(struct elf_sym *sym)long elf_find_func_offset (Elf *elf,const char *binary_path,const char *name) {int i, sh_types[2 ] = {SHT_DYNSYM ,SHT_SYMTAB }; -bool is_shared_lib, is_name_qualified; +bool is_shared_lib;long ret = -ENOENT ; -size_t name_len;GElf_Ehdr ehdr;if (!gelf_getehdr (elf, &ehdr)) {@@ -179,10 +308,6 @@ long elf_find_func_offset(Elf *elf, const char *binary_path, const char *name)/* for shared lib case, we do not need to calculate relative offset */ is_shared_lib = ehdr.e_type ==ET_DYN ; - name_len =strlen (name); -/* Does name specify "@@LIB"? */ - is_name_qualified =strstr (name,"@@" ) !=NULL ; -/* Search SHT_DYNSYM, SHT_SYMTAB for symbol. This search order is used because if * a binary is stripped, it may only have SHT_DYNSYM, and a fully-statically * linked binary may not have SHT_DYMSYM, so absence of a section should not be @@ -201,13 +326,7 @@ long elf_find_func_offset(Elf *elf, const char *binary_path, const char *name) goto out;while ((sym =elf_sym_iter_next (&iter))) { -/* User can specify func, func@@LIB or func@@LIB_VERSION. */ -if (strncmp (sym->name, name, name_len) !=0 ) -continue ; -/* ...but we don't want a search for "foo" to match 'foo2" also, so any -* additional characters in sname should be of the form "@@LIB". -*/ -if (!is_name_qualified && sym->name[name_len] !='\0' && sym->name[name_len] !='@' ) +if (!symbol_match (elf, sh_types[i], sym, name))continue ; cur_bind =GELF_ST_BIND (sym->sym.st_info);tools/lib/bpf/libbpf.c +1
-2@@ -11512,7 +11512,7 @@ static int attach_uprobe(const struct bpf_program *prog, long cookie, struct bpf *link =NULL ; - n =sscanf (prog->sec_name,"%m[^/]/%m[^:]:%m[a-zA-Z0-9_.]+%li" , + n =sscanf (prog->sec_name,"%m[^/]/%m[^:]:%m[a-zA-Z0-9_.@]+%li" , &probe_type, &binary_path, &func_name, &offset);switch (n) {case 1 : --2.34.1
Quoted 32 lines · Alan Maguire
Quoted 30 lines · Hengqi Chen
In current implementation, we assume that symbol found in .dynsym section would have a version suffix and use it to compare with symbol user supplied. According to the spec ([0]), this assumption is incorrect, the version info of dynamic symbols are stored in .gnu.version and .gnu.version_d sections of ELF objects. For example:
$ nm -D /lib/x86_64-linux-gnu/libc.so.6 | grep rwlock_wrlock 000000000009b1a0 T __pthread_rwlock_wrlock@GLIBC_2.2.5 000000000009b1a0 T pthread_rwlock_wrlock@@GLIBC_2.34 000000000009b1a0 T pthread_rwlock_wrlock@GLIBC_2.2.5$ readelf -W --dyn-syms /lib/x86_64-linux-gnu/libc.so.6 | grep rwlock_wrlock 706: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 __pthread_rwlock_wrlock@GLIBC_2.2.5 2568: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 pthread_rwlock_wrlock@@GLIBC_2.34 2571: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 pthread_rwlock_wrlock@GLIBC_2.2.5In this case, specify pthread_rwlock_wrlock@@GLIBC_2.34 or pthread_rwlock_wrlock@GLIBC_2.2.5 in
bpf_uprobe_opts::func_namewon't work. Because the qualified name does NOT matchpthread_rwlock_wrlock(without version suffix) in .dynsym sections.This commit implements the symbol versioning for dynsym and allows user to specify symbol in the following forms:
- func
- func@LIB_VERSION
- func@@LIB_VERSIONIn case of symbol conflicts, error out and users should resolve it by specifying a qualified name.
Quoted 8 lines
Quoted 3 lines
[0]: https://refspecs.linuxfoundation.org/LSB_5.0.0/LSB-Core-generic/LSB-Core-generic/symversion.html
Signed-off-by Hengqi Chen <[email protected]>One question below, but
Reviewed-by Alan Maguire <[email protected]>
Thanks.
Quoted 38 lines
Quoted 38 lines
--- tools/lib/bpf/elf.c | 145 +++++++++++++++++++++++++++++++++++++----tools/lib/bpf/elf.c +35
-0+ +static bool symbol_match (Elf *elf,int sh_type,struct elf_sym *sym,const char *name) +{ +size_t name_len, sname_len; +bool is_name_qualified; +const char *ver; +char *sname; +int ret; + + name_len =strlen (name); +/* Does name specify "@LIB" or "@@LIB" ? */ + is_name_qualified =strstr (name,"@" ) !=NULL ; + +/* If user specify a qualified name, for dynamic symbol, +* it is in form of func, NOT func@LIB_VER or func@@LIB_VER. +* So construct a full quailified symbol name using versym info +* for comparison. +*/ +if (is_name_qualified && sh_type ==SHT_DYNSYM ) { +/* Make sure func match func@LIB_VER */ + sname_len =strlen (sym->name); +if (strncmp (sym->name, name, sname_len) !=0 ) +return false; + +/* But not func2@LIB_VER */ +if (name[sname_len] !='@' ) +return false; + + ver =elf_get_vername (elf, sym->ver); +if (!ver) +return false; + + ret =asprintf (&sname,"%s%s%s" , sym->name, + sym->hidden ?"@" :"@@" , ver); +if (ret ==-1 )
Quoted 9 lines
tools/lib/bpf/elf.c static struct elf_sym *elf_sym_iter_next(struct elf_sym_iter *iter) · line 259
Quoted 3 lines
tools/lib/bpf/elf.c +3
-0+return false; + + ret =strncmp (sname, name, name_len);I _think_ because we're using the length of the name we're searching for we'd end up matching pthread_rwlock_wrlock@@G and pthread_rwlock_wrlock@@GLIBC_2.34 ; should we use strlen(sname) to do an exact match here?
Good point, will do.
Quoted 73 lines
Quoted 73 lines
tools/lib/bpf/elf.c +19
-13+free (sname); +return ret ==0 ; + } + +/* Otherwise, for normal symbols or non-qualified names +* User can specify func, func@@LIB or func@@LIB_VERSION. +*/ +if (strncmp (sym->name, name, name_len) !=0 ) +return false; +/* ...but we don't want a search for "foo" to match 'foo2" also, so any +* additional characters in sname should be of the form "@LIB" or "@@LIB". +*/ +if (!is_name_qualified && sym->name[name_len] !='\0' && sym->name[name_len] !='@' ) +return false; + +return true; +}/* Transform symbol's virtual address (absolute for binaries and relative * for shared libs) into file offset, which is what kernel is expecting @@ -166,9 +296,8 @@ static unsigned long elf_sym_offset(struct elf_sym *sym)long elf_find_func_offset (Elf *elf,const char *binary_path,const char *name) {int i, sh_types[2 ] = {SHT_DYNSYM ,SHT_SYMTAB }; -bool is_shared_lib, is_name_qualified; +bool is_shared_lib;long ret = -ENOENT ; -size_t name_len;GElf_Ehdr ehdr;if (!gelf_getehdr (elf, &ehdr)) {@@ -179,10 +308,6 @@ long elf_find_func_offset(Elf *elf, const char *binary_path, const char *name)/* for shared lib case, we do not need to calculate relative offset */ is_shared_lib = ehdr.e_type ==ET_DYN ; - name_len =strlen (name); -/* Does name specify "@@LIB"? */ - is_name_qualified =strstr (name,"@@" ) !=NULL ; -/* Search SHT_DYNSYM, SHT_SYMTAB for symbol. This search order is used because if * a binary is stripped, it may only have SHT_DYNSYM, and a fully-statically * linked binary may not have SHT_DYMSYM, so absence of a section should not be @@ -201,13 +326,7 @@ long elf_find_func_offset(Elf *elf, const char *binary_path, const char *name) goto out;while ((sym =elf_sym_iter_next (&iter))) { -/* User can specify func, func@@LIB or func@@LIB_VERSION. */ -if (strncmp (sym->name, name, name_len) !=0 ) -continue ; -/* ...but we don't want a search for "foo" to match 'foo2" also, so any -* additional characters in sname should be of the form "@@LIB". -*/ -if (!is_name_qualified && sym->name[name_len] !='\0' && sym->name[name_len] !='@' ) +if (!symbol_match (elf, sh_types[i], sym, name))continue ; cur_bind =GELF_ST_BIND (sym->sym.st_info);tools/lib/bpf/libbpf.c +1
-2@@ -11512,7 +11512,7 @@ static int attach_uprobe(const struct bpf_program *prog, long cookie, struct bpf *link =NULL ; - n =sscanf (prog->sec_name,"%m[^/]/%m[^:]:%m[a-zA-Z0-9_.]+%li" , + n =sscanf (prog->sec_name,"%m[^/]/%m[^:]:%m[a-zA-Z0-9_.@]+%li" , &probe_type, &binary_path, &func_name, &offset);switch (n) {case 1 : --2.34.1
Quoted 27 lines · Hengqi Chen
In current implementation, we assume that symbol found in .dynsym section would have a version suffix and use it to compare with symbol user supplied. According to the spec ([0]), this assumption is incorrect, the version info of dynamic symbols are stored in .gnu.version and .gnu.version_d sections of ELF objects. For example:
$ nm -D /lib/x86_64-linux-gnu/libc.so.6 | grep rwlock_wrlock 000000000009b1a0 T __pthread_rwlock_wrlock@GLIBC_2.2.5 000000000009b1a0 T pthread_rwlock_wrlock@@GLIBC_2.34 000000000009b1a0 T pthread_rwlock_wrlock@GLIBC_2.2.5$ readelf -W --dyn-syms /lib/x86_64-linux-gnu/libc.so.6 | grep rwlock_wrlock 706: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 __pthread_rwlock_wrlock@GLIBC_2.2.5 2568: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 pthread_rwlock_wrlock@@GLIBC_2.34 2571: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 pthread_rwlock_wrlock@GLIBC_2.2.5In this case, specify pthread_rwlock_wrlock@@GLIBC_2.34 or pthread_rwlock_wrlock@GLIBC_2.2.5 in
bpf_uprobe_opts::func_namewon't work. Because the qualified name does NOT matchpthread_rwlock_wrlock(without version suffix) in .dynsym sections.This commit implements the symbol versioning for dynsym and allows user to specify symbol in the following forms:
- func
- func@LIB_VERSION
- func@@LIB_VERSION
Quoted 6 lines
In case of symbol conflicts, error out and users should resolve it by specifying a qualified name.
[0]: https://refspecs.linuxfoundation.org/LSB_5.0.0/LSB-Core-generic/LSB-Core-generic/symversion.html
Signed-off-by Hengqi Chen <[email protected]>
I have a question below, but other than that
thanks,
jirka
SNIP
Quoted 10 lines
tools/lib/bpf/elf.c +1
-0@@ -119,6 +148,7 @@ static struct elf_sym *elf_sym_iter_next(struct elf_sym_iter *iter)struct elf_sym *ret = &iter->sym;GElf_Sym *sym = &ret->sym;const char *name =NULL ; +GElf_Versym versym;Elf_Scn *sym_scn;size_t idx;@@ -138,12 +168,112 @@ static struct elf_sym *elf_sym_iter_next(struct elf_sym_iter *iter)
tools/lib/bpf/elf.c static struct elf_sym *elf_sym_iter_next(struct elf_sym_iter *iter) · line 178
Quoted 10 lines
tools/lib/bpf/elf.c +8
-0iter->next_sym_idx = idx +1 ; ret->name = name; + ret->ver =0 ; + ret->hidden = false; + +if (iter->versyms) { +if (!gelf_getversym (iter->versyms, idx, &versym)) +continue ; + ret->ver = versym &VERSYM_VERSION ; + ret->hidden = versym &VERSYM_HIDDEN ;
the doc mentions value 1 being special, also I can see readelf code checking on that.. is that taken into account?
Quoted 7 lines
tools/lib/bpf/elf.c +1
-0+ }return ret; }return NULL ; }
SNIP
Quoted 56 lines · Jiri Olsa
Quoted 27 lines · Hengqi Chen
In current implementation, we assume that symbol found in .dynsym section would have a version suffix and use it to compare with symbol user supplied. According to the spec ([0]), this assumption is incorrect, the version info of dynamic symbols are stored in .gnu.version and .gnu.version_d sections of ELF objects. For example:
$ nm -D /lib/x86_64-linux-gnu/libc.so.6 | grep rwlock_wrlock 000000000009b1a0 T __pthread_rwlock_wrlock@GLIBC_2.2.5 000000000009b1a0 T pthread_rwlock_wrlock@@GLIBC_2.34 000000000009b1a0 T pthread_rwlock_wrlock@GLIBC_2.2.5$ readelf -W --dyn-syms /lib/x86_64-linux-gnu/libc.so.6 | grep rwlock_wrlock 706: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 __pthread_rwlock_wrlock@GLIBC_2.2.5 2568: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 pthread_rwlock_wrlock@@GLIBC_2.34 2571: 000000000009b1a0 878 FUNC GLOBAL DEFAULT 15 pthread_rwlock_wrlock@GLIBC_2.2.5In this case, specify pthread_rwlock_wrlock@@GLIBC_2.34 or pthread_rwlock_wrlock@GLIBC_2.2.5 in
bpf_uprobe_opts::func_namewon't work. Because the qualified name does NOT matchpthread_rwlock_wrlock(without version suffix) in .dynsym sections.This commit implements the symbol versioning for dynsym and allows user to specify symbol in the following forms:
- func
- func@LIB_VERSION
- func@@LIB_VERSIONQuoted 6 lines
In case of symbol conflicts, error out and users should resolve it by specifying a qualified name.
[0]: https://refspecs.linuxfoundation.org/LSB_5.0.0/LSB-Core-generic/LSB-Core-generic/symversion.html
Signed-off-by Hengqi Chen <[email protected]>I have a question below, but other than that
Acked-by Jiri Olsa <[email protected]>thanks,
jirkaSNIP
Quoted 10 lines
tools/lib/bpf/elf.c +1
-0@@ -119,6 +148,7 @@ static struct elf_sym *elf_sym_iter_next(struct elf_sym_iter *iter)struct elf_sym *ret = &iter->sym;GElf_Sym *sym = &ret->sym;const char *name =NULL ; +GElf_Versym versym;Elf_Scn *sym_scn;size_t idx;@@ -138,12 +168,112 @@ static struct elf_sym *elf_sym_iter_next(struct elf_sym_iter *iter)
Quoted 14 lines
tools/lib/bpf/elf.c static struct elf_sym *elf_sym_iter_next(struct elf_sym_iter *iter) · line 178
Quoted 10 lines
tools/lib/bpf/elf.c +8
-0iter->next_sym_idx = idx +1 ; ret->name = name; + ret->ver =0 ; + ret->hidden = false; + +if (iter->versyms) { +if (!gelf_getversym (iter->versyms, idx, &versym)) +continue ; + ret->ver = versym &VERSYM_VERSION ; + ret->hidden = versym &VERSYM_HIDDEN ;the doc mentions value 1 being special, also I can see readelf code checking on that.. is that taken into account?
Yes. For value 1, there is a corresponding version def, so no difference.
Quoted 9 lines
Quoted 7 lines
tools/lib/bpf/elf.c +1
-0+ }return ret; }return NULL ; }SNIP
PATCH v2 3/3 selftests/bpf: Add tests for symbol versioning for uprobe
In reply to Hengqi ChenThis exercises the newly added dynsym symbol versioning logics. Now we accept symbols in form of func, func@LIB_VERSION or func@@LIB_VERSION.
The test rely on liburandom_read.so. For liburandom_read.so, we have:
$ nm -D liburandom_read.so
w __cxa_finalize@GLIBC_2.17
w __gmon_start__
w _ITM_deregisterTMCloneTable
w _ITM_registerTMCloneTable
0000000000000000 A LIBURANDOM_READ_1.0.0
0000000000000000 A LIBURANDOM_READ_2.0.0
000000000000081c T urandlib_api@@LIBURANDOM_READ_2.0.0
0000000000000814 T urandlib_api@LIBURANDOM_READ_1.0.0
0000000000000824 T urandlib_api_sameoffset@LIBURANDOM_READ_1.0.0
0000000000000824 T urandlib_api_sameoffset@@LIBURANDOM_READ_2.0.0
000000000000082c T urandlib_read_without_sema@@LIBURANDOM_READ_1.0.0
00000000000007c4 T urandlib_read_with_sema@@LIBURANDOM_READ_1.0.0
0000000000011018 D urandlib_read_with_sema_semaphore@@LIBURANDOM_READ_1.0.0For urandlib_api, specifying urandlib_api will cause a conflict because there are two symbols named urandlib_api and both are global bind. For urandlib_api_sameoffset, there are also two symbols in the .so, but both are at the same offset and essentially they refer to the same function so no conflict.
--- tools/testing/selftests/bpf/Makefile | 5 +- .../testing/selftests/bpf/liburandom_read.map | 15 +++ .../testing/selftests/bpf/prog_tests/uprobe.c | 95 +++++++++++++++++++ .../testing/selftests/bpf/progs/test_uprobe.c | 61 ++++++++++++ tools/testing/selftests/bpf/urandom_read.c | 9 ++ .../testing/selftests/bpf/urandom_read_lib1.c | 41 ++++++++ 6 files changed, 224 insertions(+), 2 deletions(-) create mode 100644 tools/testing/selftests/bpf/liburandom_read.map create mode 100644 tools/testing/selftests/bpf/prog_tests/uprobe.c create mode 100644 tools/testing/selftests/bpf/progs/test_uprobe.c
tools/testing/selftests/bpf/Makefile +3 -2
@@ -193,11 +193,12 @@ endif # Filter out -static for liburandom_read.so and its dependent targets so that static builds # do not fail. Static builds leave urandom_read relying on system-wide shared libraries. -$(OUTPUT)/liburandom_read.so: urandom_read_lib1.c urandom_read_lib2.c +$(OUTPUT)/liburandom_read.so: urandom_read_lib1.c urandom_read_lib2.c liburandom_read.map $(call msg,LIB,,$@) $(Q)$(CLANG) $(filter-out -static,$(CFLAGS) $(LDFLAGS)) \ - $^ $(filter-out -static,$(LDLIBS)) \ + $(filter %.c,$^) $(filter-out -static,$(LDLIBS)) \ -fuse-ld=$(LLD) -Wl,-znoseparate-code -Wl,--build-id=sha1 \ + -Wl,--version-script=liburandom_read.map \ -fPIC -shared -o $@ $(OUTPUT)/urandom_read: urandom_read.c urandom_read_aux.c $(OUTPUT)/liburandom_read.so
tools/testing/selftests/bpf/liburandom_read.map new file +15 -0
@@ -0,0 +1,15 @@ +LIBURANDOM_READ_1.0.0 { + global: + urandlib_api; + urandlib_api_sameoffset; + urandlib_read_without_sema; + urandlib_read_with_sema; + urandlib_read_with_sema_semaphore; + local: + *; +}; + +LIBURANDOM_READ_2.0.0 { + global: + urandlib_api; +} LIBURANDOM_READ_1.0.0;
tools/testing/selftests/bpf/prog_tests/uprobe.c new file +95 -0
95 lines not on this page · raw message
tools/testing/selftests/bpf/progs/test_uprobe.c new file +61 -0
61 lines not on this page · raw message
tools/testing/selftests/bpf/urandom_read.c +9 -0
@@ -21,6 +21,11 @@ void urand_read_without_sema(int iter_num, int iter_cnt, int read_sz);void urandlib_read_with_sema (int iter_num,int iter_cnt,int read_sz);void urandlib_read_without_sema (int iter_num,int iter_cnt,int read_sz); +int urandlib_api (void ); +__asm__(".symver urandlib_api_old,urandlib_api@LIBURANDOM_READ_1.0.0" ); +int urandlib_api_old (void ); +int urandlib_api_sameoffset (void ); + unsigned short urand_read_with_sema_semaphore SEC(".probes"); static __attribute__((noinline))
@@ -83,6 +88,10 @@ int main(int argc, char *argv[])urandom_read (fd, count); +urandlib_api (); +urandlib_api_old (); +urandlib_api_sameoffset (); +close (fd);return 0 ; }
tools/testing/selftests/bpf/urandom_read_lib1.c +41 -0
44 lines not on this page · raw message
--
2.34.1
Re: [PATCH bpf-next v2 3/3] selftests/bpf: Add tests for symbol versioning for uprobe
Quoted 21 lines · Hengqi Chen
This exercises the newly added dynsym symbol versioning logics. Now we accept symbols in form of func, func@LIB_VERSION or func@@LIB_VERSION.
The test rely on liburandom_read.so. For liburandom_read.so, we have:
$ nm -D liburandom_read.so w __cxa_finalize@GLIBC_2.17 w __gmon_start__ w _ITM_deregisterTMCloneTable w _ITM_registerTMCloneTable 0000000000000000 A LIBURANDOM_READ_1.0.0 0000000000000000 A LIBURANDOM_READ_2.0.0 000000000000081c T urandlib_api@@LIBURANDOM_READ_2.0.0 0000000000000814 T urandlib_api@LIBURANDOM_READ_1.0.0 0000000000000824 T urandlib_api_sameoffset@LIBURANDOM_READ_1.0.0 0000000000000824 T urandlib_api_sameoffset@@LIBURANDOM_READ_2.0.0 000000000000082c T urandlib_read_without_sema@@LIBURANDOM_READ_1.0.0 00000000000007c4 T urandlib_read_with_sema@@LIBURANDOM_READ_1.0.0 0000000000011018 D urandlib_read_with_sema_semaphore@@LIBURANDOM_READ_1.0.0
Quoted 7 lines
For
urandlib_api, specifyingurandlib_apiwill cause a conflict because there are two symbols namedurandlib_apiand both are global bind. Forurandlib_api_sameoffset, there are also two symbols in the .so, but both are at the same offset and essentially they refer to the same function so no conflict.Signed-off-by Hengqi Chen <[email protected]>
Great work putting tests together for this! One small suggestion if there's a v3; would it be worth having a uretprobe test that uses library version specification too?
Quoted 298 lines
--- tools/testing/selftests/bpf/Makefile | 5 +- .../testing/selftests/bpf/liburandom_read.map | 15 +++ .../testing/selftests/bpf/prog_tests/uprobe.c | 95 +++++++++++++++++++ .../testing/selftests/bpf/progs/test_uprobe.c | 61 ++++++++++++ tools/testing/selftests/bpf/urandom_read.c | 9 ++ .../testing/selftests/bpf/urandom_read_lib1.c | 41 ++++++++ 6 files changed, 224 insertions(+), 2 deletions(-) create mode 100644 tools/testing/selftests/bpf/liburandom_read.map create mode 100644 tools/testing/selftests/bpf/prog_tests/uprobe.c create mode 100644 tools/testing/selftests/bpf/progs/test_uprobe.ctools/testing/selftests/bpf/Makefile +3
-2@@ -193,11 +193,12 @@ endif # Filter out -static for liburandom_read.so and its dependent targets so that static builds # do not fail. Static builds leave urandom_read relying on system-wide shared libraries. -$(OUTPUT)/liburandom_read.so: urandom_read_lib1.c urandom_read_lib2.c +$(OUTPUT)/liburandom_read.so: urandom_read_lib1.c urandom_read_lib2.c liburandom_read.map $(call msg,LIB,,$@) $(Q)$(CLANG) $(filter-out -static,$(CFLAGS) $(LDFLAGS)) \ - $^ $(filter-out -static,$(LDLIBS)) \ + $(filter %.c,$^) $(filter-out -static,$(LDLIBS)) \ -fuse-ld=$(LLD) -Wl,-znoseparate-code -Wl,--build-id=sha1 \ + -Wl,--version-script=liburandom_read.map \ -fPIC -shared -o $@ $(OUTPUT)/urandom_read: urandom_read.c urandom_read_aux.c $(OUTPUT)/liburandom_read.sotools/testing/selftests/bpf/liburandom_read.map new file +15
-0@@ -0,0 +1,15 @@ +LIBURANDOM_READ_1.0.0 { + global: + urandlib_api; + urandlib_api_sameoffset; + urandlib_read_without_sema; + urandlib_read_with_sema; + urandlib_read_with_sema_semaphore; + local: + *; +}; + +LIBURANDOM_READ_2.0.0 { + global: + urandlib_api; +} LIBURANDOM_READ_1.0.0;tools/testing/selftests/bpf/prog_tests/uprobe.c new file +95
-0@@ -0,0 +1,95 @@ +// SPDX-License-Identifier: GPL-2.0 +/* Copyright (c) 2021 Hengqi Chen */ + +#include <test_progs.h> +#include "test_uprobe.skel.h" + +static FILE *urand_spawn (int *pid) +{ +FILE *f; + +/* urandom_read's stdout is wired into f */ + f =popen ("./urandom_read 1 report-pid" ,"r" ); +if (!f) +return NULL ; + +if (fscanf (f,"%d" , pid) !=1 ) { +pclose (f); + errno =EINVAL ; +return NULL ; + } + +return f; +} + +static int urand_trigger (FILE **urand_pipe) +{ +int exit_code; + +/* pclose() waits for child process to exit and returns their exit code */ + exit_code =pclose (*urand_pipe); + *urand_pipe =NULL ; + +return exit_code; +} + +void test_uprobe (void ) +{ +LIBBPF_OPTS (bpf_uprobe_opts, uprobe_opts); +struct test_uprobe *skel; +FILE *urand_pipe =NULL ; +int urand_pid =0 , err; + + skel =test_uprobe__open_and_load (); +if (!ASSERT_OK_PTR (skel,"skel_open" )) +return ; + + urand_pipe =urand_spawn (&urand_pid); +if (!ASSERT_OK_PTR (urand_pipe,"urand_spawn" )) + goto cleanup; + + skel->bss->my_pid = urand_pid; + +/* Manual attach uprobe to urandlib_api +* There are two `urandlib_api` symbols in .dynsym section: +* - urandlib_api@LIBURANDOM_READ_1.0.0 +* - urandlib_api@LIBURANDOM_READ_1.0.0 +* Both are global bind and would cause a conflict if user +* specify the symbol name without a version suffix +*/ + uprobe_opts.func_name ="urandlib_api" ; + skel->links.test4 =bpf_program__attach_uprobe_opts (skel->progs.test4, + urand_pid, +"./liburandom_read.so" , +0 /* offset */ , + &uprobe_opts); +if (!ASSERT_ERR_PTR (skel->links.test4,"urandlib_api_attach_conflict" )) + goto cleanup; + + uprobe_opts.func_name ="urandlib_api@LIBURANDOM_READ_1.0.0" ; + skel->links.test4 =bpf_program__attach_uprobe_opts (skel->progs.test4, + urand_pid, +"./liburandom_read.so" , +0 /* offset */ , + &uprobe_opts); +if (!ASSERT_OK_PTR (skel->links.test4,"urandlib_api_attach_ok" )) + goto cleanup; + +/* Auto attach 3 uprobes to urandlib_api_sameoffset */ + err =test_uprobe__attach (skel); +if (!ASSERT_OK (err,"skel_attach" )) + goto cleanup; + +/* trigger urandom_read */ +ASSERT_OK (urand_trigger (&urand_pipe),"urand_exit_code" ); + +ASSERT_EQ (skel->bss->test1_result,1 ,"urandlib_api_sameoffset" ); +ASSERT_EQ (skel->bss->test2_result,1 ,"urandlib_api_sameoffset@v1" ); +ASSERT_EQ (skel->bss->test3_result,1 ,"urandlib_api_sameoffset@@v2" ); +ASSERT_EQ (skel->bss->test4_result,1 ,"urandlib_api" ); + +cleanup: +if (urand_pipe) +pclose (urand_pipe); +test_uprobe__destroy (skel); +}tools/testing/selftests/bpf/progs/test_uprobe.c new file +61
-0@@ -0,0 +1,61 @@ +// SPDX-License-Identifier: GPL-2.0 +/* Copyright (c) 2023 Hengqi Chen */ + +#include "vmlinux.h" +#include <bpf/bpf_helpers.h> +#include <bpf/bpf_tracing.h> + +pid_t my_pid =0 ; + +int test1_result =0 ; +int test2_result =0 ; +int test3_result =0 ; +int test4_result =0 ; + +SEC("uprobe/./liburandom_read.so:urandlib_api_sameoffset") +int BPF_UPROBE (test1 ) +{ +pid_t pid =bpf_get_current_pid_tgid () >>32 ; + +if (pid != my_pid) +return 0 ; + + test1_result =1 ; +return 0 ; +} + +SEC("uprobe/./liburandom_read.so:urandlib_api_sameoffset@LIBURANDOM_READ_1.0.0") +int BPF_UPROBE (test2 ) +{ +pid_t pid =bpf_get_current_pid_tgid () >>32 ; + +if (pid != my_pid) +return 0 ; + + test2_result =1 ; +return 0 ; +} + +SEC("uprobe/./liburandom_read.so:urandlib_api_sameoffset@@LIBURANDOM_READ_2.0.0") +int BPF_UPROBE (test3 ) +{ +pid_t pid =bpf_get_current_pid_tgid () >>32 ; + +if (pid != my_pid) +return 0 ; + + test3_result =1 ; +return 0 ; +} + +SEC("uprobe") +int BPF_UPROBE (test4 ) +{ +pid_t pid =bpf_get_current_pid_tgid () >>32 ; + +if (pid != my_pid) +return 0 ; + + test4_result =1 ; +return 0 ; +}tools/testing/selftests/bpf/urandom_read.c +9
-0@@ -21,6 +21,11 @@ void urand_read_without_sema(int iter_num, int iter_cnt, int read_sz);void urandlib_read_with_sema (int iter_num,int iter_cnt,int read_sz);void urandlib_read_without_sema (int iter_num,int iter_cnt,int read_sz); +int urandlib_api (void ); +__asm__(".symver urandlib_api_old,urandlib_api@LIBURANDOM_READ_1.0.0" ); +int urandlib_api_old (void ); +int urandlib_api_sameoffset (void ); + unsigned short urand_read_with_sema_semaphore SEC(".probes"); static __attribute__((noinline))@@ -83,6 +88,10 @@ int main(int argc, char *argv[])urandom_read (fd, count); +urandlib_api (); +urandlib_api_old (); +urandlib_api_sameoffset (); +close (fd);return 0 ; }tools/testing/selftests/bpf/urandom_read_lib1.c +41
-1@@ -11,3 +11,44 @@ void urandlib_read_with_sema(int iter_num, int iter_cnt, int read_sz) {STAP_PROBE3 (urandlib, read_with_sema, iter_num, iter_cnt, read_sz); } + +/* Symbol versioning is different between static and shared library. +* Properly versioned symbols are needed for shared library, but +* only the symbol of the new version is needed for static library. +* Starting with GNU C 10, use symver attribute instead of .symver assembler +* directive, which works better with GCC LTO builds. +*/ +#if defined(__GNUC__) && __GNUC__ >=10 + +#define DEFAULT_VERSION (internal_name, api_name, version) \ + __attribute__((symver(#api_name "@@" #version))) +#define COMPAT_VERSION (internal_name, api_name, version) \ + __attribute__((symver(#api_name "@" #version))) + +#else + +#define COMPAT_VERSION (internal_name, api_name, version) \ + asm(".symver " #internal_name "," #api_name "@" #version); +#define DEFAULT_VERSION (internal_name, api_name, version) \ + asm(".symver " #internal_name "," #api_name "@@" #version); + +#endif + +COMPAT_VERSION(urandlib_api_v1, urandlib_api, LIBURANDOM_READ_1.0.0) +int urandlib_api_v1(void) +{ + return 1; +} + +DEFAULT_VERSION(urandlib_api_v2, urandlib_api, LIBURANDOM_READ_2.0.0) +int urandlib_api_v2(void) +{ + return 2; +} + +COMPAT_VERSION(urandlib_api_sameoffset, urandlib_api_sameoffset, LIBURANDOM_READ_1.0.0) +DEFAULT_VERSION(urandlib_api_sameoffset, urandlib_api_sameoffset, LIBURANDOM_READ_2.0.0) +int urandlib_api_sameoffset(void) +{ + return 3; +} --2.34.1
Re: [PATCH bpf-next v2 3/3] selftests/bpf: Add tests for symbol versioning for uprobe
In reply to Hengqi ChenQuoted 21 lines · Hengqi Chen
This exercises the newly added dynsym symbol versioning logics. Now we accept symbols in form of func, func@LIB_VERSION or func@@LIB_VERSION.
The test rely on liburandom_read.so. For liburandom_read.so, we have:
$ nm -D liburandom_read.so w __cxa_finalize@GLIBC_2.17 w __gmon_start__ w _ITM_deregisterTMCloneTable w _ITM_registerTMCloneTable 0000000000000000 A LIBURANDOM_READ_1.0.0 0000000000000000 A LIBURANDOM_READ_2.0.0 000000000000081c T urandlib_api@@LIBURANDOM_READ_2.0.0 0000000000000814 T urandlib_api@LIBURANDOM_READ_1.0.0 0000000000000824 T urandlib_api_sameoffset@LIBURANDOM_READ_1.0.0 0000000000000824 T urandlib_api_sameoffset@@LIBURANDOM_READ_2.0.0 000000000000082c T urandlib_read_without_sema@@LIBURANDOM_READ_1.0.0 00000000000007c4 T urandlib_read_with_sema@@LIBURANDOM_READ_1.0.0 0000000000011018 D urandlib_read_with_sema_semaphore@@LIBURANDOM_READ_1.0.0
Quoted 7 lines
For
urandlib_api, specifyingurandlib_apiwill cause a conflict because there are two symbols namedurandlib_apiand both are global bind. Forurandlib_api_sameoffset, there are also two symbols in the .so, but both are at the same offset and essentially they refer to the same function so no conflict.Signed-off-by Hengqi Chen <[email protected]>
one nit below, but looks good
thanks,
jirka
Quoted 12 lines
--- tools/testing/selftests/bpf/Makefile | 5 +- .../testing/selftests/bpf/liburandom_read.map | 15 +++ .../testing/selftests/bpf/prog_tests/uprobe.c | 95 +++++++++++++++++++ .../testing/selftests/bpf/progs/test_uprobe.c | 61 ++++++++++++ tools/testing/selftests/bpf/urandom_read.c | 9 ++ .../testing/selftests/bpf/urandom_read_lib1.c | 41 ++++++++ 6 files changed, 224 insertions(+), 2 deletions(-) create mode 100644 tools/testing/selftests/bpf/liburandom_read.map create mode 100644 tools/testing/selftests/bpf/prog_tests/uprobe.c create mode 100644 tools/testing/selftests/bpf/progs/test_uprobe.c
SNIP
Quoted 11 lines
tools/testing/selftests/bpf/prog_tests/uprobe.c new file +11
-0+void test_uprobe (void ) +{ +LIBBPF_OPTS (bpf_uprobe_opts, uprobe_opts); +struct test_uprobe *skel; +FILE *urand_pipe =NULL ; +int urand_pid =0 , err; + + skel =test_uprobe__open_and_load (); +if (!ASSERT_OK_PTR (skel,"skel_open" )) +return ; +
tools/testing/selftests/bpf/prog_tests/uprobe.c line 56
Quoted 10 lines
tools/testing/selftests/bpf/prog_tests/uprobe.c new file +10
-0+ urand_pipe =urand_spawn (&urand_pid); +if (!ASSERT_OK_PTR (urand_pipe,"urand_spawn" )) + goto cleanup; + + skel->bss->my_pid = urand_pid; + +/* Manual attach uprobe to urandlib_api +* There are two `urandlib_api` symbols in .dynsym section: +* - urandlib_api@LIBURANDOM_READ_1.0.0 +* - urandlib_api@LIBURANDOM_READ_1.0.0
nit, should that be version 2.0.0? ^
Quoted 39 lines
tools/testing/selftests/bpf/prog_tests/uprobe.c new file +39
-0+* Both are global bind and would cause a conflict if user +* specify the symbol name without a version suffix +*/ + uprobe_opts.func_name ="urandlib_api" ; + skel->links.test4 =bpf_program__attach_uprobe_opts (skel->progs.test4, + urand_pid, +"./liburandom_read.so" , +0 /* offset */ , + &uprobe_opts); +if (!ASSERT_ERR_PTR (skel->links.test4,"urandlib_api_attach_conflict" )) + goto cleanup; + + uprobe_opts.func_name ="urandlib_api@LIBURANDOM_READ_1.0.0" ; + skel->links.test4 =bpf_program__attach_uprobe_opts (skel->progs.test4, + urand_pid, +"./liburandom_read.so" , +0 /* offset */ , + &uprobe_opts); +if (!ASSERT_OK_PTR (skel->links.test4,"urandlib_api_attach_ok" )) + goto cleanup; + +/* Auto attach 3 uprobes to urandlib_api_sameoffset */ + err =test_uprobe__attach (skel); +if (!ASSERT_OK (err,"skel_attach" )) + goto cleanup; + +/* trigger urandom_read */ +ASSERT_OK (urand_trigger (&urand_pipe),"urand_exit_code" ); + +ASSERT_EQ (skel->bss->test1_result,1 ,"urandlib_api_sameoffset" ); +ASSERT_EQ (skel->bss->test2_result,1 ,"urandlib_api_sameoffset@v1" ); +ASSERT_EQ (skel->bss->test3_result,1 ,"urandlib_api_sameoffset@@v2" ); +ASSERT_EQ (skel->bss->test4_result,1 ,"urandlib_api" ); + +cleanup: +if (urand_pipe) +pclose (urand_pipe); +test_uprobe__destroy (skel); +}
SNIP