Skip to contentSkip to conversation

dwarves,libbpf: Add support to use optional extended section index table

PATCH Applied Jiri Olsa 4 participants 18 messages Jan 21, 2021 – Jan 24, 2021

Subsystems (4)

v2 of 4 Applied Latest is v4 →

lore
Share & tools
lore
author reviewer
#1 lore raw

PATCH v2 1/3 elf_symtab: Add support for SHN_XINDEX index to elf_section_by_name

In reply to Jiri Olsa

In case the elf's header e_shstrndx contains SHN_XINDEX, we need to call elf_getshdrstrndx to get the proper string table index.

---
 dutil.c | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
dutil.c +6 -2
index 7b667647420f..9e0fdca3ae04 100644
@@ -179,13 +179,17 @@ Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep,
 {
 	Elf_Scn *sec = NULL;
 	size_t cnt = 1;
+	size_t str_idx;
+
+	if (elf_getshdrstrndx(elf, &str_idx))
+		return NULL;
 
 	while ((sec = elf_nextscn(elf, sec)) != NULL) {
 		char *str;
 
 		gelf_getshdr(sec, shp);
-		str = elf_strptr(elf, ep->e_shstrndx, shp->sh_name);
-		if (!strcmp(name, str)) {
+		str = elf_strptr(elf, str_idx, shp->sh_name);
+		if (str && !strcmp(name, str)) {
 			if (index)
 				*index = cnt;
 			break;
Signature · 1 line
2.27.0
author reviewer
#4 lore raw

PATCH v2 2/3 bpf_encoder: Translate SHN_XINDEX in symbol's st_shndx values

In reply to Jiri Olsa

For very large ELF objects (with many sections), we could get special value SHN_XINDEX (65535) for symbol's st_shndx.

This patch is adding code to detect the optional extended section index table and use it to resolve symbol's section index.

Adding elf_symtab__for_each_symbol_index macro that returns symbol's section index and usign it in collect_symbols function.

---
 btf_encoder.c | 36 ++++++++++++++++++++++++++++++++----
 elf_symtab.c  | 39 ++++++++++++++++++++++++++++++++++++++-
 elf_symtab.h  |  2 ++
 3 files changed, 72 insertions(+), 5 deletions(-)
btf_encoder.c +32 -4
index 5557c9efd365..6e6f22c438ce 100644
@@ -585,12 +585,13 @@ static int collect_percpu_var(struct btf_elf *btfe, GElf_Sym *sym)
 	return 0;
 }
 
-static void collect_symbol(GElf_Sym *sym, struct funcs_layout *fl)
+static void collect_symbol(GElf_Sym *sym, struct funcs_layout *fl,
+			   Elf32_Word sym_sec_idx)
 {
 	if (!fl->mcount_start &&
 	    !strcmp("__start_mcount_loc", elf_sym__name(sym, btfe->symtab))) {
 		fl->mcount_start = sym->st_value;
-		fl->mcount_sec_idx = sym->st_shndx;
+		fl->mcount_sec_idx = sym_sec_idx;
 	}
 
 	if (!fl->mcount_stop &&
@@ -598,9 +599,36 @@ static void collect_symbol(GElf_Sym *sym, struct funcs_layout *fl)
 		fl->mcount_stop = sym->st_value;
 }
 
+static bool elf_sym__get(Elf_Data *syms, Elf_Data *syms_sec_idx_table,
+			 int id, GElf_Sym *sym, Elf32_Word *sym_sec_idx)
+{
+	if (!gelf_getsym(syms, id, sym))
+		return false;
+
+	*sym_sec_idx = sym->st_shndx;
+
+	if (sym->st_shndx == SHN_XINDEX) {
+		if (!syms_sec_idx_table)
+			return false;
+		if (!gelf_getsymshndx(syms, syms_sec_idx_table,
+				      id, sym, sym_sec_idx))
+			return false;
+	}
+
+	return true;
+}
+
+#define elf_symtab__for_each_symbol_index(symtab, id, sym, sym_sec_idx)		\
+	for (id = 0, elf_sym__get(symtab->syms, symtab->syms_sec_idx_table,	\
+				  id, &sym, &sym_sec_idx);			\
+	     id < symtab->nr_syms;						\
+	     id++, elf_sym__get(symtab->syms, symtab->syms_sec_idx_table,	\
+				id, &sym, &sym_sec_idx))
+
 static int collect_symbols(struct btf_elf *btfe, bool collect_percpu_vars)
 {
 	struct funcs_layout fl = { };
+	Elf32_Word sym_sec_idx;
 	uint32_t core_id;
 	GElf_Sym sym;
 
@@ -608,12 +636,12 @@ static int collect_symbols(struct btf_elf *btfe, bool collect_percpu_vars)
 	percpu_var_cnt = 0;
 
 	/* search within symtab for percpu variables */
-	elf_symtab__for_each_symbol(btfe->symtab, core_id, sym) {
+	elf_symtab__for_each_symbol_index(btfe->symtab, core_id, sym, sym_sec_idx) {
 		if (collect_percpu_vars && collect_percpu_var(btfe, &sym))
 			return -1;
 		if (collect_function(btfe, &sym))
 			return -1;
-		collect_symbol(&sym, &fl);
+		collect_symbol(&sym, &fl, sym_sec_idx);
 	}
 
 	if (collect_percpu_vars) {
elf_symtab.c +38 -1
index 741990ea3ed9..fad5e0c0ba3c 100644
@@ -17,11 +17,13 @@
 
 struct elf_symtab *elf_symtab__new(const char *name, Elf *elf, GElf_Ehdr *ehdr)
 {
+	size_t symtab_index;
+
 	if (name == NULL)
 		name = ".symtab";
 
 	GElf_Shdr shdr;
-	Elf_Scn *sec = elf_section_by_name(elf, ehdr, &shdr, name, NULL);
+	Elf_Scn *sec = elf_section_by_name(elf, ehdr, &shdr, name, &symtab_index);
 
 	if (sec == NULL)
 		return NULL;
@@ -41,6 +43,12 @@ struct elf_symtab *elf_symtab__new(const char *name, Elf *elf, GElf_Ehdr *ehdr)
 	if (symtab->syms == NULL)
 		goto out_free_name;
 
+	/*
+	 * This returns extended section index table's
+	 * section index, if it exists.
+	 */
+	int symtab_xindex = elf_scnshndx(sec);
+
 	sec = elf_getscn(elf, shdr.sh_link);
 	if (sec == NULL)
 		goto out_free_name;
@@ -49,6 +57,35 @@ struct elf_symtab *elf_symtab__new(const char *name, Elf *elf, GElf_Ehdr *ehdr)
 	if (symtab->symstrs == NULL)
 		goto out_free_name;
 
+	/*
+	 * The .symtab section has optional extended section index
+	 * table, load its data so it can be used to resolve symbol's
+	 * section index.
+	 **/
+	if (symtab_xindex > 0) {
+		GElf_Shdr shdr_xindex;
+		Elf_Scn *sec_xindex;
+
+		sec_xindex = elf_getscn(elf, symtab_xindex);
+		if (sec_xindex == NULL)
+			goto out_free_name;
+
+		if (gelf_getshdr(sec_xindex, &shdr_xindex) == NULL)
+			goto out_free_name;
+
+		/* Extra check to verify it's correct type */
+		if (shdr_xindex.sh_type != SHT_SYMTAB_SHNDX)
+			goto out_free_name;
+
+		/* Extra check to verify it belongs to the .symtab */
+		if (symtab_index != shdr_xindex.sh_link)
+			goto out_free_name;
+
+		symtab->syms_sec_idx_table = elf_getdata(elf_getscn(elf, symtab_xindex), NULL);
+		if (symtab->syms_sec_idx_table == NULL)
+			goto out_free_name;
+	}
+
 	symtab->nr_syms = shdr.sh_size / shdr.sh_entsize;
 
 	return symtab;
elf_symtab.h +2 -0
index 359add69c8ab..2e05ca98158b 100644
@@ -16,6 +16,8 @@ struct elf_symtab {
 	uint32_t  nr_syms;
 	Elf_Data  *syms;
 	Elf_Data  *symstrs;
+	/* Data of SHT_SYMTAB_SHNDX section. */
+	Elf_Data  *syms_sec_idx_table;
 	char	  *name;
 };
 
Signature · 1 line
2.27.0
author reviewer
#16 lore raw

PATCH v2 3/3 libbpf: Use string table index from index table if needed

In reply to Jiri Olsa

For very large ELF objects (with many sections), we could get special value SHN_XINDEX (65535) for elf object's string table index - e_shstrndx.

Call elf_getshdrstrndx to get the proper string table index, instead of reading it directly from ELF header.

---
 tools/lib/bpf/btf.c | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)
tools/lib/bpf/btf.c +10 -2
index 9970a288dda5..d9c10830d749 100644
@@ -858,6 +858,7 @@ static struct btf *btf_parse_elf(const char *path, struct btf *base_btf,
 	Elf_Scn *scn = NULL;
 	Elf *elf = NULL;
 	GElf_Ehdr ehdr;
+	size_t shstrndx;
 
 	if (elf_version(EV_CURRENT) == EV_NONE) {
 		pr_warn("failed to init libelf for %s\n", path);
@@ -882,7 +883,14 @@ static struct btf *btf_parse_elf(const char *path, struct btf *base_btf,
 		pr_warn("failed to get EHDR from %s\n", path);
 		goto done;
 	}
-	if (!elf_rawdata(elf_getscn(elf, ehdr.e_shstrndx), NULL)) {
+
+	if (elf_getshdrstrndx(elf, &shstrndx)) {
+		pr_warn("failed to get section names section index for %s\n",
+			path);
+		goto done;
+	}
+
+	if (!elf_rawdata(elf_getscn(elf, shstrndx), NULL)) {
 		pr_warn("failed to get e_shstrndx from %s\n", path);
 		goto done;
 	}
@@ -897,7 +905,7 @@ static struct btf *btf_parse_elf(const char *path, struct btf *base_btf,
 				idx, path);
 			goto done;
 		}
-		name = elf_strptr(elf, ehdr.e_shstrndx, sh.sh_name);
+		name = elf_strptr(elf, shstrndx, sh.sh_name);
 		if (!name) {
 			pr_warn("failed to get section(%d) name from %s\n",
 				idx, path);
Signature · 1 line
2.27.0

Jiri Olsa

author reviewer
#0 lore raw

v2 cover dwarves,libbpf: Add support to use optional extended section index table

hi,
kpatch guys hit an issue with pahole over their vmlinux, which contains many (over 100000) sections, pahole crashes.

With so many sections, ELF is using extended section index table, which is used to hold values for some of the indexes and extra code is needed to retrieve them.

This patchset adds the support for pahole to properly read string table index and symbol's section index, which are used in btf_encoder.

This patchset also adds support for libbpf to properly parse .BTF section on such object.

This patchset is based on previously posted fix [1].

v2 changes:
- many variables renames [Andrii]
- use elf_getshdrstrndx() unconditionally [Andrii]
- add elf_symtab__for_each_symbol_index macro [Andrii]
- add more comments [Andrii]
- verify that extended symtab section type is SHT_SYMTAB_SHNDX [Andrii]
- fix Joe's crash in dwarves build, wrong sym.st_shndx assignment

thanks,
jirka

[1] https://lore.kernel.org/bpf/[email protected]/
---
dwarves:

Jiri Olsa (2):
elf_symtab: Add support for SHN_XINDEX index to elf_section_by_name
bpf_encoder: Translate SHN_XINDEX in symbol's st_shndx values

 btf_encoder.c | 36 ++++++++++++++++++++++++++++++++----
 dutil.c       |  8 ++++++--
 elf_symtab.c  | 39 ++++++++++++++++++++++++++++++++++++++-
 elf_symtab.h  |  2 ++
 4 files changed, 78 insertions(+), 7 deletions(-)

libbpf:

Jiri Olsa (1):
libbpf: Use string table index from index table if needed

 tools/lib/bpf/btf.c | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)
#2 lore raw

Re: [PATCH 1/3] elf_symtab: Add support for SHN_XINDEX index to elf_section_by_name

In reply to Jiri Olsa
Quoted 21 lines · Jiri Olsa

In case the elf's header e_shstrndx contains SHN_XINDEX, we need to call elf_getshdrstrndx to get the proper string table index.

---
 dutil.c | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
dutil.c +3 -0
index 7b667647420f..9e0fdca3ae04 100644
@@ -179,13 +179,17 @@ Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep,
 {
        Elf_Scn *sec = NULL;
        size_t cnt = 1;
+       size_t str_idx;
+
+       if (elf_getshdrstrndx(elf, &str_idx))

dutil.c Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep, · line 192

Quoted 10 lines
dutil.c +3 -2
+               return NULL;
 
        while ((sec = elf_nextscn(elf, sec)) != NULL) {
                char *str;
 
                gelf_getshdr(sec, shp);
-               str = elf_strptr(elf, ep->e_shstrndx, shp->sh_name);
-               if (!strcmp(name, str)) {
+               str = elf_strptr(elf, str_idx, shp->sh_name);
+               if (str && !strcmp(name, str)) {

if (!str) would be an error? should we bail out here?

Quoted 6 lines
dutil.c +0 -1
                        if (index)
                                *index = cnt;
                        break;
--

2.27.0

#5 lore raw

Re: [PATCH 2/3] bpf_encoder: Translate SHN_XINDEX in symbol's st_shndx values

In reply to Jiri Olsa
Quoted 8 lines · Jiri Olsa

For very large ELF objects (with many sections), we could get special value SHN_XINDEX (65535) for symbol's st_shndx.

This patch is adding code to detect the optional extended section index table and use it to resolve symbol's section index.

Quoted 5 lines

Adding elf_symtab__for_each_symbol_index macro that returns symbol's section index and usign it in collect_symbols function.

---

You missed fixing up collect_function() as well, which is using elf_sym__section(), which doesn't know about extended numbering.

Quoted 32 lines
 btf_encoder.c | 36 ++++++++++++++++++++++++++++++++----
 elf_symtab.c  | 39 ++++++++++++++++++++++++++++++++++++++-
 elf_symtab.h  |  2 ++
 3 files changed, 72 insertions(+), 5 deletions(-)
btf_encoder.c +6 -2
index 5557c9efd365..6e6f22c438ce 100644
@@ -585,12 +585,13 @@ static int collect_percpu_var(struct btf_elf *btfe, GElf_Sym *sym)
        return 0;
 }
 
-static void collect_symbol(GElf_Sym *sym, struct funcs_layout *fl)
+static void collect_symbol(GElf_Sym *sym, struct funcs_layout *fl,
+                          Elf32_Word sym_sec_idx)
 {
        if (!fl->mcount_start &&
            !strcmp("__start_mcount_loc", elf_sym__name(sym, btfe->symtab))) {
                fl->mcount_start = sym->st_value;
-               fl->mcount_sec_idx = sym->st_shndx;
+               fl->mcount_sec_idx = sym_sec_idx;
        }
 
        if (!fl->mcount_stop &&
@@ -598,9 +599,36 @@ static void collect_symbol(GElf_Sym *sym, struct funcs_layout *fl)
                fl->mcount_stop = sym->st_value;
 }
 
+static bool elf_sym__get(Elf_Data *syms, Elf_Data *syms_sec_idx_table,
+                        int id, GElf_Sym *sym, Elf32_Word *sym_sec_idx)
+{

btf_encoder.c static void collect_symbol(GElf_Sym *sym, struct funcs_layout *fl) · line 614

Quoted 10 lines
btf_encoder.c +10 -0
+       if (!gelf_getsym(syms, id, sym))
+               return false;
+
+       *sym_sec_idx = sym->st_shndx;
+
+       if (sym->st_shndx == SHN_XINDEX) {
+               if (!syms_sec_idx_table)
+                       return false;
+               if (!gelf_getsymshndx(syms, syms_sec_idx_table,
+                                     id, sym, sym_sec_idx))

gelf_getsymshndx() is supposed to work even for cases that don't use extended numbering, so this should work, right?

if (!gelf_getsymshndx(syms, syms_sec_idx_table, id, sym, sym_sec_idx))

    return false;

if (sym->st_shndx == SHN_XINDEX)
*sym_sec_idx = sym->st_shndx;

return true;

?

btf_encoder.c static void collect_symbol(GElf_Sym *sym, struct funcs_layout *fl) · line 626

Quoted 12 lines
btf_encoder.c +12 -0
+                       return false;
+       }
+
+       return true;
+}
+
+#define elf_symtab__for_each_symbol_index(symtab, id, sym, sym_sec_idx)                \
+       for (id = 0, elf_sym__get(symtab->syms, symtab->syms_sec_idx_table,     \
+                                 id, &sym, &sym_sec_idx);                      \
+            id < symtab->nr_syms;                                              \
+            id++, elf_sym__get(symtab->syms, symtab->syms_sec_idx_table,       \
+                               id, &sym, &sym_sec_idx))

what do we want to do if elf_sym__get() returns error (false)? We can either stop or ignore that symbol, right? But currently you are returning invalid symbol data.

so either

for (id = 0; id < symtab->nr_syms && elf_sym__get(symtab->syms, symtab->syms_sec_idx_table, d, &sym, &sym_sec_idx); id++)

or

for (id = 0; id < symtab->nr_syms; id++)
if (elf_sym__get(symtab->syms, symtab->syms_sec_idx_table, d, &sym,
&sym_sec_idx))

But the current variant looks broken. Oh, and elf_symtab__for_each_symbol() is similarly broken, can you please fix that as well?

And this new macro should probably be in elf_symtab.h, along the elf_symtab__for_each_symbol.

Quoted 8 lines
btf_encoder.c +2 -0
+
 static int collect_symbols(struct btf_elf *btfe, bool collect_percpu_vars)
 {
        struct funcs_layout fl = { };
+       Elf32_Word sym_sec_idx;
        uint32_t core_id;
        GElf_Sym sym;
 

[...]

#3 lore raw

Re: [PATCH 1/3] elf_symtab: Add support for SHN_XINDEX index to elf_section_by_name

In reply to Andrii Nakryiko
Quoted 27 lines · Andrii Nakryiko
Quoted 26 lines · Jiri Olsa

In case the elf's header e_shstrndx contains SHN_XINDEX, we need to call elf_getshdrstrndx to get the proper string table index.

---
 dutil.c | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
dutil.c +4 -0
index 7b667647420f..9e0fdca3ae04 100644
@@ -179,13 +179,17 @@ Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep,
 {
        Elf_Scn *sec = NULL;
        size_t cnt = 1;
+       size_t str_idx;
+
+       if (elf_getshdrstrndx(elf, &str_idx))
+               return NULL;
 
        while ((sec = elf_nextscn(elf, sec)) != NULL) {
                char *str;
 
Quoted 7 lines

dutil.c Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep, · line 192

Quoted 5 lines
dutil.c +2 -2
                gelf_getshdr(sec, shp);
-               str = elf_strptr(elf, ep->e_shstrndx, shp->sh_name);
-               if (!strcmp(name, str)) {
+               str = elf_strptr(elf, str_idx, shp->sh_name);
+               if (str && !strcmp(name, str)) {

if (!str) would be an error? should we bail out here?

seems like if elf_nextscn returns NULL, it will be the case for all the sections in here.. but bailing out on (!str) is more direct and safer

I'll send an update

thanks,
jirka

Quoted 8 lines
Quoted 7 lines
dutil.c +0 -1
                        if (index)
                                *index = cnt;
                        break;
--

2.27.0

#17 lore raw

Re: [PATCH bpf-next 3/3] libbpf: Use string table index from index table if needed

In reply to Jiri Olsa
Quoted 10 lines · Jiri Olsa

For very large ELF objects (with many sections), we could get special value SHN_XINDEX (65535) for elf object's string table index - e_shstrndx.

Call elf_getshdrstrndx to get the proper string table index, instead of reading it directly from ELF header.

---

I've applied this patch to bpf-next, you don't need to re-send it in the next version of this patch set.

Quoted 43 lines
 tools/lib/bpf/btf.c | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)
tools/lib/bpf/btf.c +10 -3
index 9970a288dda5..d9c10830d749 100644
@@ -858,6 +858,7 @@ static struct btf *btf_parse_elf(const char *path, struct btf *base_btf,
        Elf_Scn *scn = NULL;
        Elf *elf = NULL;
        GElf_Ehdr ehdr;
+       size_t shstrndx;
 
        if (elf_version(EV_CURRENT) == EV_NONE) {
                pr_warn("failed to init libelf for %s\n", path);
@@ -882,7 +883,14 @@ static struct btf *btf_parse_elf(const char *path, struct btf *base_btf,
                pr_warn("failed to get EHDR from %s\n", path);
                goto done;
        }
-       if (!elf_rawdata(elf_getscn(elf, ehdr.e_shstrndx), NULL)) {
+
+       if (elf_getshdrstrndx(elf, &shstrndx)) {
+               pr_warn("failed to get section names section index for %s\n",
+                       path);
+               goto done;
+       }
+
+       if (!elf_rawdata(elf_getscn(elf, shstrndx), NULL)) {
                pr_warn("failed to get e_shstrndx from %s\n", path);
                goto done;
        }
@@ -897,7 +905,7 @@ static struct btf *btf_parse_elf(const char *path, struct btf *base_btf,
                                idx, path);
                        goto done;
                }
-               name = elf_strptr(elf, ehdr.e_shstrndx, sh.sh_name);
+               name = elf_strptr(elf, shstrndx, sh.sh_name);
                if (!name) {
                        pr_warn("failed to get section(%d) name from %s\n",
                                idx, path);
--

2.27.0

#6 lore raw

Re: [PATCH 2/3] bpf_encoder: Translate SHN_XINDEX in symbol's st_shndx values

In reply to Andrii Nakryiko
Quoted 9 lines · Andrii Nakryiko
Quoted 8 lines · Jiri Olsa

For very large ELF objects (with many sections), we could get special value SHN_XINDEX (65535) for symbol's st_shndx.

This patch is adding code to detect the optional extended section index table and use it to resolve symbol's section index.

Quoted 8 lines
Quoted 5 lines

Adding elf_symtab__for_each_symbol_index macro that returns symbol's section index and usign it in collect_symbols function.

---

You missed fixing up collect_function() as well, which is using elf_sym__section(), which doesn't know about extended numbering.

ah right, it's for modules, I guess it's why it did not show up

thanks,
jirka

#7 lore raw

Re: [PATCH 2/3] bpf_encoder: Translate SHN_XINDEX in symbol's st_shndx values

In reply to Andrii Nakryiko

On Thu, Jan 21, 2021 at 03:32:40PM -0800, Andrii Nakryiko wrote:

SNIP

Quoted 22 lines
Quoted 7 lines
btf_encoder.c +3 -0
@@ -598,9 +599,36 @@ static void collect_symbol(GElf_Sym *sym, struct funcs_layout *fl)
                fl->mcount_stop = sym->st_value;
 }
 
+static bool elf_sym__get(Elf_Data *syms, Elf_Data *syms_sec_idx_table,
+                        int id, GElf_Sym *sym, Elf32_Word *sym_sec_idx)
+{

btf_encoder.c static void collect_symbol(GElf_Sym *sym, struct funcs_layout *fl) · line 614

Quoted 10 lines
btf_encoder.c +10 -0
+       if (!gelf_getsym(syms, id, sym))
+               return false;
+
+       *sym_sec_idx = sym->st_shndx;
+
+       if (sym->st_shndx == SHN_XINDEX) {
+               if (!syms_sec_idx_table)
+                       return false;
+               if (!gelf_getsymshndx(syms, syms_sec_idx_table,
+                                     id, sym, sym_sec_idx))

gelf_getsymshndx() is supposed to work even for cases that don't use extended numbering, so this should work, right?

Quoted 3 lines

if (!gelf_getsymshndx(syms, syms_sec_idx_table, id, sym, sym_sec_idx))

    return false;

it seems you're right, gelf_getsymshndx seem to work for both cases, I'll check

Quoted 2 lines

if (sym->st_shndx == SHN_XINDEX)
*sym_sec_idx = sym->st_shndx;

I don't understand this.. gelf_getsymshndx will return both symbol and proper index, no? also sym_sec_idx is already assigned from previou call

Quoted 24 lines

return true;

?

btf_encoder.c static void collect_symbol(GElf_Sym *sym, struct funcs_layout *fl) · line 626

Quoted 12 lines
btf_encoder.c +12 -0
+                       return false;
+       }
+
+       return true;
+}
+
+#define elf_symtab__for_each_symbol_index(symtab, id, sym, sym_sec_idx)                \
+       for (id = 0, elf_sym__get(symtab->syms, symtab->syms_sec_idx_table,     \
+                                 id, &sym, &sym_sec_idx);                      \
+            id < symtab->nr_syms;                                              \
+            id++, elf_sym__get(symtab->syms, symtab->syms_sec_idx_table,       \
+                               id, &sym, &sym_sec_idx))

what do we want to do if elf_sym__get() returns error (false)? We can either stop or ignore that symbol, right? But currently you are returning invalid symbol data.

so either

Quoted 8 lines

for (id = 0; id < symtab->nr_syms && elf_sym__get(symtab->syms, symtab->syms_sec_idx_table, d, &sym, &sym_sec_idx); id++)

or

for (id = 0; id < symtab->nr_syms; id++)
if (elf_sym__get(symtab->syms, symtab->syms_sec_idx_table, d, &sym,
&sym_sec_idx))

if we go ahead with skipping symbols, this one seems good

Quoted 8 lines

But the current variant looks broken. Oh, and elf_symtab__for_each_symbol() is similarly broken, can you please fix that as well?

And this new macro should probably be in elf_symtab.h, along the elf_symtab__for_each_symbol.

thanks,
jirka

#8 lore raw

Re: [PATCH 2/3] bpf_encoder: Translate SHN_XINDEX in symbol's st_shndx values

Quoted 35 lines · Jiri Olsa

On Thu, Jan 21, 2021 at 03:32:40PM -0800, Andrii Nakryiko wrote:

SNIP

Quoted 22 lines
Quoted 7 lines
btf_encoder.c +3 -0
@@ -598,9 +599,36 @@ static void collect_symbol(GElf_Sym *sym, struct funcs_layout *fl)
                fl->mcount_stop = sym->st_value;
 }
 
+static bool elf_sym__get(Elf_Data *syms, Elf_Data *syms_sec_idx_table,
+                        int id, GElf_Sym *sym, Elf32_Word *sym_sec_idx)
+{

btf_encoder.c static void collect_symbol(GElf_Sym *sym, struct funcs_layout *fl) · line 614

Quoted 10 lines
btf_encoder.c +10 -0
+       if (!gelf_getsym(syms, id, sym))
+               return false;
+
+       *sym_sec_idx = sym->st_shndx;
+
+       if (sym->st_shndx == SHN_XINDEX) {
+               if (!syms_sec_idx_table)
+                       return false;
+               if (!gelf_getsymshndx(syms, syms_sec_idx_table,
+                                     id, sym, sym_sec_idx))

gelf_getsymshndx() is supposed to work even for cases that don't use extended numbering, so this should work, right?

Quoted 3 lines

if (!gelf_getsymshndx(syms, syms_sec_idx_table, id, sym, sym_sec_idx))

    return false;

it seems you're right, gelf_getsymshndx seem to work for both cases, I'll check

Quoted 6 lines
Quoted 2 lines

if (sym->st_shndx == SHN_XINDEX)
*sym_sec_idx = sym->st_shndx;

I don't understand this.. gelf_getsymshndx will return both symbol and proper index, no? also sym_sec_idx is already assigned from previou call

Reading (some) implementation of gelf_getsymshndx() that I found online, it won't set sym_sec_idx, if the symbol *doesn't* use extended numbering. But it will still return symbol data. So to return the section index in all cases, we need to check again *after* we got symbol, and if it's not extended, then set index manually.

Quoted 28 lines
Quoted 28 lines

return true;

?

btf_encoder.c static void collect_symbol(GElf_Sym *sym, struct funcs_layout *fl) · line 626

Quoted 12 lines
btf_encoder.c +12 -0
+                       return false;
+       }
+
+       return true;
+}
+
+#define elf_symtab__for_each_symbol_index(symtab, id, sym, sym_sec_idx)                \
+       for (id = 0, elf_sym__get(symtab->syms, symtab->syms_sec_idx_table,     \
+                                 id, &sym, &sym_sec_idx);                      \
+            id < symtab->nr_syms;                                              \
+            id++, elf_sym__get(symtab->syms, symtab->syms_sec_idx_table,       \
+                               id, &sym, &sym_sec_idx))

what do we want to do if elf_sym__get() returns error (false)? We can either stop or ignore that symbol, right? But currently you are returning invalid symbol data.

so either

for (id = 0; id < symtab->nr_syms && elf_sym__get(symtab->syms, symtab->syms_sec_idx_table, d, &sym, &sym_sec_idx); id++)

Quoted 7 lines
Quoted 5 lines

or

for (id = 0; id < symtab->nr_syms; id++)
if (elf_sym__get(symtab->syms, symtab->syms_sec_idx_table, d, &sym,
&sym_sec_idx))

if we go ahead with skipping symbols, this one seems good

I think skipping symbols is nicer. If ELF is totally broken, then all symbols are going to be ignored anyway. If it's some one-off issue for a specific symbol, we'll just ignore it (unfortunately, silently).

Quoted 13 lines
Quoted 9 lines

But the current variant looks broken. Oh, and elf_symtab__for_each_symbol() is similarly broken, can you please fix that as well?

And this new macro should probably be in elf_symtab.h, along the elf_symtab__for_each_symbol.

thanks,
jirka

#9 lore raw

Re: [PATCH 2/3] bpf_encoder: Translate SHN_XINDEX in symbol's st_shndx values

Quoted 39 lines · Andrii Nakryiko
Quoted 38 lines · Jiri Olsa

On Thu, Jan 21, 2021 at 03:32:40PM -0800, Andrii Nakryiko wrote:

SNIP

Quoted 22 lines
Quoted 7 lines
btf_encoder.c +3 -0
@@ -598,9 +599,36 @@ static void collect_symbol(GElf_Sym *sym, struct funcs_layout *fl)
                fl->mcount_stop = sym->st_value;
 }
 
+static bool elf_sym__get(Elf_Data *syms, Elf_Data *syms_sec_idx_table,
+                        int id, GElf_Sym *sym, Elf32_Word *sym_sec_idx)
+{

btf_encoder.c static void collect_symbol(GElf_Sym *sym, struct funcs_layout *fl) · line 614

Quoted 10 lines
btf_encoder.c +10 -0
+       if (!gelf_getsym(syms, id, sym))
+               return false;
+
+       *sym_sec_idx = sym->st_shndx;
+
+       if (sym->st_shndx == SHN_XINDEX) {
+               if (!syms_sec_idx_table)
+                       return false;
+               if (!gelf_getsymshndx(syms, syms_sec_idx_table,
+                                     id, sym, sym_sec_idx))

gelf_getsymshndx() is supposed to work even for cases that don't use extended numbering, so this should work, right?

Quoted 3 lines

if (!gelf_getsymshndx(syms, syms_sec_idx_table, id, sym, sym_sec_idx))

    return false;

it seems you're right, gelf_getsymshndx seem to work for both cases, I'll check

Quoted 2 lines

if (sym->st_shndx == SHN_XINDEX)
*sym_sec_idx = sym->st_shndx;

Quoted 7 lines
Quoted 3 lines

I don't understand this.. gelf_getsymshndx will return both symbol and proper index, no? also sym_sec_idx is already assigned from previou call

Reading (some) implementation of gelf_getsymshndx() that I found online, it won't set sym_sec_idx, if the symbol *doesn't* use extended numbering. But it will still return symbol data. So to return the

the latest upstream code seems to set it always,
but I agree we should be careful

Mark, any insight in here? thanks

Quoted 2 lines

section index in all cases, we need to check again *after* we got symbol, and if it's not extended, then set index manually.

hum, then we should use '!=', right?

  if (sym->st_shndx != SHN_XINDEX)
    *sym_sec_idx = sym->st_shndx;

SNIP

Quoted 11 lines
Quoted 11 lines
Quoted 10 lines

so either

for (id = 0; id < symtab->nr_syms && elf_sym__get(symtab->syms, symtab->syms_sec_idx_table, d, &sym, &sym_sec_idx); id++)

or

for (id = 0; id < symtab->nr_syms; id++)
if (elf_sym__get(symtab->syms, symtab->syms_sec_idx_table, d, &sym,
&sym_sec_idx))

Quoted 5 lines
Quoted 1 line

if we go ahead with skipping symbols, this one seems good

I think skipping symbols is nicer. If ELF is totally broken, then all symbols are going to be ignored anyway. If it's some one-off issue for a specific symbol, we'll just ignore it (unfortunately, silently).

agreed, I'll use this

thanks,
jirka

#10 lore raw

Re: [PATCH 2/3] bpf_encoder: Translate SHN_XINDEX in symbol's st_shndx values

Quoted 45 lines · Jiri Olsa
Quoted 43 lines · Andrii Nakryiko
Quoted 41 lines · Jiri Olsa

On Thu, Jan 21, 2021 at 03:32:40PM -0800, Andrii Nakryiko wrote:

SNIP

Quoted 22 lines
Quoted 7 lines
btf_encoder.c +3 -0
@@ -598,9 +599,36 @@ static void collect_symbol(GElf_Sym *sym, struct funcs_layout *fl)
                fl->mcount_stop = sym->st_value;
 }
 
+static bool elf_sym__get(Elf_Data *syms, Elf_Data *syms_sec_idx_table,
+                        int id, GElf_Sym *sym, Elf32_Word *sym_sec_idx)
+{

btf_encoder.c static void collect_symbol(GElf_Sym *sym, struct funcs_layout *fl) · line 614

Quoted 10 lines
btf_encoder.c +10 -0
+       if (!gelf_getsym(syms, id, sym))
+               return false;
+
+       *sym_sec_idx = sym->st_shndx;
+
+       if (sym->st_shndx == SHN_XINDEX) {
+               if (!syms_sec_idx_table)
+                       return false;
+               if (!gelf_getsymshndx(syms, syms_sec_idx_table,
+                                     id, sym, sym_sec_idx))

gelf_getsymshndx() is supposed to work even for cases that don't use extended numbering, so this should work, right?

Quoted 3 lines

if (!gelf_getsymshndx(syms, syms_sec_idx_table, id, sym, sym_sec_idx))

    return false;

it seems you're right, gelf_getsymshndx seem to work for both cases, I'll check

Quoted 2 lines

if (sym->st_shndx == SHN_XINDEX)
*sym_sec_idx = sym->st_shndx;

I don't understand this.. gelf_getsymshndx will return both symbol and proper index, no? also sym_sec_idx is already assigned from previou call

Quoted 6 lines
Quoted 3 lines

Reading (some) implementation of gelf_getsymshndx() that I found online, it won't set sym_sec_idx, if the symbol *doesn't* use extended numbering. But it will still return symbol data. So to return the

the latest upstream code seems to set it always,
but I agree we should be careful

oh, then maybe it's not necessary. I honestly don't even know where the authoritative source code of libelf is, so I just found some random source code with Google.

Quoted 10 lines

Mark, any insight in here? thanks

Quoted 2 lines

section index in all cases, we need to check again *after* we got symbol, and if it's not extended, then set index manually.

hum, then we should use '!=', right?

  if (sym->st_shndx != SHN_XINDEX)
    *sym_sec_idx = sym->st_shndx;

yeah, sorry, that was a typo

Quoted 14 lines

SNIP

Quoted 11 lines
Quoted 11 lines
Quoted 10 lines

so either

for (id = 0; id < symtab->nr_syms && elf_sym__get(symtab->syms, symtab->syms_sec_idx_table, d, &sym, &sym_sec_idx); id++)

or

for (id = 0; id < symtab->nr_syms; id++)
if (elf_sym__get(symtab->syms, symtab->syms_sec_idx_table, d, &sym,
&sym_sec_idx))

Quoted 7 lines
Quoted 5 lines
Quoted 1 line

if we go ahead with skipping symbols, this one seems good

I think skipping symbols is nicer. If ELF is totally broken, then all symbols are going to be ignored anyway. If it's some one-off issue for a specific symbol, we'll just ignore it (unfortunately, silently).

agreed, I'll use this

sounds good

Quoted 4 lines

thanks,
jirka

#12 lore raw

Re: [PATCH 2/3] bpf_encoder: Translate SHN_XINDEX in symbol's st_shndx values

In reply to Jiri Olsa

Hi Jiri,

Quoted 11 lines · Jiri Olsa
Quoted 9 lines · Andrii Nakryiko
Quoted 4 lines

I don't understand this.. gelf_getsymshndx will return both symbol and proper index, no? also sym_sec_idx is already assigned from previou call

Reading (some) implementation of gelf_getsymshndx() that I found online, it won't set sym_sec_idx, if the symbol *doesn't* use extended
numbering. But it will still return symbol data. So to return the

Quoted 4 lines

the latest upstream code seems to set it always,
but I agree we should be careful

Mark, any insight in here? thanks

GElf_Sym *
gelf_getsymshndx (Elf_Data *symdata, Elf_Data *shndxdata, int ndx,
GElf_Sym *dst, Elf32_Word *dstshndx)

Will always set *dst, but only set *dstshndx if both it and shndxdata are not NULL and no error occurred (the function returns NULL and set libelf_error in case of error).

So as long as shndxdata != NULL you can rely on *dstshndx being set. Otherwise you get the section index from dst->st_shndx.

Cheers,

Mark

#13 lore raw

Re: [PATCH 2/3] bpf_encoder: Translate SHN_XINDEX in symbol's st_shndx values

Quoted 23 lines · Mark Wielaard

Hi Jiri,

Quoted 11 lines · Jiri Olsa
Quoted 9 lines · Andrii Nakryiko
Quoted 4 lines

I don't understand this.. gelf_getsymshndx will return both symbol and proper index, no? also sym_sec_idx is already assigned from previou call

Reading (some) implementation of gelf_getsymshndx() that I found online, it won't set sym_sec_idx, if the symbol *doesn't* use extended
numbering. But it will still return symbol data. So to return the

Quoted 4 lines

the latest upstream code seems to set it always,
but I agree we should be careful

Mark, any insight in here? thanks

GElf_Sym *
gelf_getsymshndx (Elf_Data *symdata, Elf_Data *shndxdata, int ndx,
GElf_Sym *dst, Elf32_Word *dstshndx)

Quoted 6 lines

Will always set *dst, but only set *dstshndx if both it and shndxdata are not NULL and no error occurred (the function returns NULL and set libelf_error in case of error).

So as long as shndxdata != NULL you can rely on *dstshndx being set. Otherwise you get the section index from dst->st_shndx.

ok, so it's as Andrii said, I'll make the extra check then

thanks,
jirka

#11 lore raw

Re: [PATCH 2/3] bpf_encoder: Translate SHN_XINDEX in symbol's st_shndx values

In reply to Andrii Nakryiko

Hi,

Quoted 6 lines · Andrii Nakryiko
Quoted 2 lines

the latest upstream code seems to set it always,
but I agree we should be careful

oh, then maybe it's not necessary. I honestly don't even know where the authoritative source code of libelf is, so I just found some random source code with Google.

The elfutils.org libelf implementation can be found here:
https://sourceware.org/git/?p=elfutils.git;a=tree;f=libelf;hb=HEAD

There are some other implementations, but some aren't maintained and others aren't packaged for any distro (anymore). libelf is a semi- standard "SVR4 Unix" library, so you might also find it for some none GNU/Linux OSes like Solaris. The ELF specification itself is contained in the System V Application Binary Interface (gABI). The libelf library itself isn't actually officially part of the specification. But we still do try to keep the implementations (source) compatible through the generic-abi mailinglist.

Cheers,

Mark

#14 lore raw

Re: [PATCH 2/3] bpf_encoder: Translate SHN_XINDEX in symbol's st_shndx values

In reply to Andrii Nakryiko

On Thu, Jan 21, 2021 at 03:32:40PM -0800, Andrii Nakryiko wrote:

SNIP

Quoted 3 lines

But the current variant looks broken. Oh, and elf_symtab__for_each_symbol() is similarly broken, can you please fix that as well?

we'll have to change its callers a bit, because of hanging 'else' I'll send this separately if that's ok, when I figure out how to test ctf code

jirka

---

elf_symtab.h +3 -4
index 489e2b1a3505..6823a8c37ecf 100644
@@ -99,10 +99,9 @@ elf_sym__get(Elf_Data *syms, Elf_Data *syms_sec_idx_table,
  * @index: uint32_t index
  * @sym: GElf_Sym iterator
  */
-#define elf_symtab__for_each_symbol(symtab, index, sym) \
-	for (index = 0, gelf_getsym(symtab->syms, index, &sym);\
-	     index < symtab->nr_syms; \
-	     index++, gelf_getsym(symtab->syms, index, &sym))
+#define elf_symtab__for_each_symbol(symtab, index, sym)		\
+	for (index = 0; index < symtab->nr_syms; index++)	\
+		if (gelf_getsym(symtab->syms, index, &sym))
 
 /**
  * elf_symtab__for_each_symbol_index - iterate through all the symbols,
libctf.h +2 -6
index 749be8955c52..ee5412bec77e 100644
@@ -90,11 +90,9 @@ char *ctf__string(struct ctf *ctf, uint32_t ref);
  */
 #define ctf__for_each_symtab_function(ctf, index, sym)			      \
 	elf_symtab__for_each_symbol(ctf->symtab, index, sym)		      \
-		if (ctf__ignore_symtab_function(&sym,			      \
+		if (!ctf__ignore_symtab_function(&sym,			      \
 						elf_sym__name(&sym,	      \
 							      ctf->symtab)))  \
-			continue;					      \
-		else
 
 /**
  * ctf__for_each_symtab_object - iterate thru all the symtab objects
@@ -105,11 +103,9 @@ char *ctf__string(struct ctf *ctf, uint32_t ref);
  */
 #define ctf__for_each_symtab_object(ctf, index, sym)			      \
 	elf_symtab__for_each_symbol(ctf->symtab, index, sym)		      \
-		if (ctf__ignore_symtab_object(&sym,			      \
+		if (!ctf__ignore_symtab_object(&sym,			      \
 					      elf_sym__name(&sym,	      \
 							    ctf->symtab)))    \
-			continue;					      \
-		else
 
 
 #endif /* _LIBCTF_H */
#15 lore raw

Re: [PATCH 2/3] bpf_encoder: Translate SHN_XINDEX in symbol's st_shndx values

Quoted 5 lines · Jiri Olsa

On Thu, Jan 21, 2021 at 03:32:40PM -0800, Andrii Nakryiko wrote:

SNIP

Quoted 8 lines
Quoted 3 lines

But the current variant looks broken. Oh, and elf_symtab__for_each_symbol() is similarly broken, can you please fix that as well?

we'll have to change its callers a bit, because of hanging 'else' I'll send this separately if that's ok, when I figure out how to test ctf code

oh, else sucks. Sure, no problem doing it separately.

Quoted 53 lines

jirka

---

elf_symtab.h +3 -4
index 489e2b1a3505..6823a8c37ecf 100644
@@ -99,10 +99,9 @@ elf_sym__get(Elf_Data *syms, Elf_Data *syms_sec_idx_table,
  * @index: uint32_t index
  * @sym: GElf_Sym iterator
  */
-#define elf_symtab__for_each_symbol(symtab, index, sym) \
-       for (index = 0, gelf_getsym(symtab->syms, index, &sym);\
-            index < symtab->nr_syms; \
-            index++, gelf_getsym(symtab->syms, index, &sym))
+#define elf_symtab__for_each_symbol(symtab, index, sym)                \
+       for (index = 0; index < symtab->nr_syms; index++)       \
+               if (gelf_getsym(symtab->syms, index, &sym))
 
 /**
  * elf_symtab__for_each_symbol_index - iterate through all the symbols,
libctf.h +2 -6
index 749be8955c52..ee5412bec77e 100644
@@ -90,11 +90,9 @@ char *ctf__string(struct ctf *ctf, uint32_t ref);
  */
 #define ctf__for_each_symtab_function(ctf, index, sym)                       \
        elf_symtab__for_each_symbol(ctf->symtab, index, sym)                  \
-               if (ctf__ignore_symtab_function(&sym,                         \
+               if (!ctf__ignore_symtab_function(&sym,                        \
                                                elf_sym__name(&sym,           \
                                                              ctf->symtab)))  \
-                       continue;                                             \
-               else
 
 /**
  * ctf__for_each_symtab_object - iterate thru all the symtab objects
@@ -105,11 +103,9 @@ char *ctf__string(struct ctf *ctf, uint32_t ref);
  */
 #define ctf__for_each_symtab_object(ctf, index, sym)                         \
        elf_symtab__for_each_symbol(ctf->symtab, index, sym)                  \
-               if (ctf__ignore_symtab_object(&sym,                           \
+               if (!ctf__ignore_symtab_object(&sym,                          \
                                              elf_sym__name(&sym,             \
                                                            ctf->symtab)))    \
-                       continue;                                             \
-               else
 
 
 #endif /* _LIBCTF_H */