Skip to contentSkip to conversation

Remove symbol_name_rb_node

PATCH Applied Ian Rogers 2 participants 6 messages Jun 23, 2023 – Jun 24, 2023 perf events

lore
Share & tools
lore

Ian Rogers

author reviewer
#0 lore raw

v3 cover Remove symbol_name_rb_node

Use a sorted array of symbol pointers to avoid the potentially unnecessary 3 pointers (rb_node) for the name sorted symbols. Saves been 24 and 16 bytes per symbol.

v3. Move sort by name dso lock into its own patch.
v2. map__find_symbol_by_name_idx so that map__find_symbol_by_name
doesn't need an optional parameter. Separate out symbol_conf.sort_by_name removal.

Ian Rogers (3):
perf dso: Sort symbols under lock
perf symbol: Remove symbol_name_rb_node perf symbol_conf: Remove now unused sort_by_name

 tools/perf/builtin-kallsyms.c    |   1 -
 tools/perf/builtin-lock.c        |   2 -
 tools/perf/builtin-report.c      |   1 -
 tools/perf/tests/builtin-test.c  |   1 -
 tools/perf/util/dso.c            |   7 +-
 tools/perf/util/dso.h            |   3 +-
 tools/perf/util/map.c            |  14 +++-
 tools/perf/util/map.h            |  12 +--
 tools/perf/util/probe-event.c    |  16 ++--
 tools/perf/util/symbol.c         | 131 ++++++++++++++++---------------
 tools/perf/util/symbol.h         |  12 +--
 tools/perf/util/symbol_conf.h    |   1 -
 tools/perf/util/symbol_fprintf.c |  10 +--
 13 files changed, 106 insertions(+), 105 deletions(-)
Signature · 1 line
2.41.0.162.gfafddb0af9-goog
author reviewer
#1 lore raw

PATCH v3 1/3 perf dso: Sort symbols under lock

Determine if symbols are sorted, set the sorted flag and sort under the dso lock. Done in the interest of thread safety.

---
 tools/perf/util/map.c    | 3 +--
 tools/perf/util/symbol.c | 8 ++++++--
 2 files changed, 7 insertions(+), 4 deletions(-)
tools/perf/util/map.c +1 -2
index f30d34903aa4..a45708289cc6 100644
@@ -398,8 +398,7 @@ struct symbol *map__find_symbol_by_name(struct map *map, const char *name)
 		return NULL;
 
 	dso = map__dso(map);
-	if (!dso__sorted_by_name(dso))
-		dso__sort_by_name(dso);
+	dso__sort_by_name(dso);
 
 	return dso__find_symbol_by_name(dso, name);
 }
tools/perf/util/symbol.c +6 -2
index d275d3bef7d5..bb02047e1c59 100644
@@ -613,8 +613,12 @@ struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name)
 
 void dso__sort_by_name(struct dso *dso)
 {
-	dso__set_sorted_by_name(dso);
-	return symbols__sort_by_name(&dso->symbol_names, &dso->symbols);
+	mutex_lock(&dso->lock);
+	if (!dso__sorted_by_name(dso)) {
+		symbols__sort_by_name(&dso->symbol_names, &dso->symbols);
+		dso__set_sorted_by_name(dso);
+	}
+	mutex_unlock(&dso->lock);
 }
 
 /*
Signature · 1 line
2.41.0.162.gfafddb0af9-goog
author reviewer
#2 lore raw

PATCH v3 2/3 perf symbol: Remove symbol_name_rb_node

In reply to Ian Rogers

Most perf commands want to sort symbols by name and this is done via an invasive rbtree that on 64-bit systems costs 24 bytes. Sorting the symbols in a DSO by name is optional and not done by default, however, if sorting is requested the 24 bytes is allocated for every symbol.

This change removes the rbtree and uses a sorted array of symbol pointers instead (costing 8 bytes per symbol). As the array is created on demand then there are further memory savings. The complexity of sorting the array and using the rbtree are the same.

To support going to the next symbol, the index of the current symbol needs to be passed around as a pair with the current symbol. This requires some API changes.

---
 tools/perf/util/dso.c            |   7 +-
 tools/perf/util/dso.h            |   3 +-
 tools/perf/util/map.c            |  11 ++-
 tools/perf/util/map.h            |  12 +--
 tools/perf/util/probe-event.c    |  15 ++--
 tools/perf/util/symbol.c         | 127 ++++++++++++++++---------------
 tools/perf/util/symbol.h         |  12 +--
 tools/perf/util/symbol_fprintf.c |  10 +--
 8 files changed, 101 insertions(+), 96 deletions(-)
tools/perf/util/dso.c +5 -2
index 046fbfcfdaab..bdfead36b83a 100644
@@ -1320,7 +1320,9 @@ struct dso *dso__new_id(const char *name, struct dso_id *id)
 			dso->id = *id;
 		dso__set_long_name_id(dso, dso->name, id, false);
 		dso__set_short_name(dso, dso->name, false);
-		dso->symbols = dso->symbol_names = RB_ROOT_CACHED;
+		dso->symbols = RB_ROOT_CACHED;
+		dso->symbol_names = NULL;
+		dso->symbol_names_len = 0;
 		dso->data.cache = RB_ROOT;
 		dso->inlined_nodes = RB_ROOT_CACHED;
 		dso->srclines = RB_ROOT_CACHED;
@@ -1364,7 +1366,8 @@ void dso__delete(struct dso *dso)
 	inlines__tree_delete(&dso->inlined_nodes);
 	srcline__tree_delete(&dso->srclines);
 	symbols__delete(&dso->symbols);
-
+	dso->symbol_names_len = 0;
+	zfree(&dso->symbol_names);
 	if (dso->short_name_allocated) {
 		zfree((char **)&dso->short_name);
 		dso->short_name_allocated = false;
tools/perf/util/dso.h +2 -1
index b23a157c914d..b41c9782c754 100644
@@ -150,7 +150,8 @@ struct dso {
 	struct rb_node	 rb_node;	/* rbtree node sorted by long name */
 	struct rb_root	 *root;		/* root of rbtree that rb_node is in */
 	struct rb_root_cached symbols;
-	struct rb_root_cached symbol_names;
+	struct symbol	 **symbol_names;
+	size_t		 symbol_names_len;
 	struct rb_root_cached inlined_nodes;
 	struct rb_root_cached srclines;
 	struct {
tools/perf/util/map.c +9 -2
index a45708289cc6..f64b83004421 100644
@@ -390,7 +390,7 @@ struct symbol *map__find_symbol(struct map *map, u64 addr)
 	return dso__find_symbol(map__dso(map), addr);
 }
 
-struct symbol *map__find_symbol_by_name(struct map *map, const char *name)
+struct symbol *map__find_symbol_by_name_idx(struct map *map, const char *name, size_t *idx)
 {
 	struct dso *dso;
 
@@ -400,7 +400,14 @@ struct symbol *map__find_symbol_by_name(struct map *map, const char *name)
 	dso = map__dso(map);
 	dso__sort_by_name(dso);
 
-	return dso__find_symbol_by_name(dso, name);
+	return dso__find_symbol_by_name(dso, name, idx);
+}
+
+struct symbol *map__find_symbol_by_name(struct map *map, const char *name)
+{
+	size_t idx;
+
+	return map__find_symbol_by_name_idx(map, name, &idx);
 }
 
 struct map *map__clone(struct map *from)
tools/perf/util/map.h +7 -5
index 66a87b3d9965..1b53d53adc86 100644
@@ -148,16 +148,17 @@ struct thread;
  * @map: the 'struct map *' in which symbols are iterated
  * @sym_name: the symbol name
  * @pos: the 'struct symbol *' to use as a loop cursor
+ * @idx: the cursor index in the symbol names array
  */
-#define __map__for_each_symbol_by_name(map, sym_name, pos)	\
-	for (pos = map__find_symbol_by_name(map, sym_name);	\
+#define __map__for_each_symbol_by_name(map, sym_name, pos, idx)		\
+	for (pos = map__find_symbol_by_name_idx(map, sym_name, &idx);	\
 	     pos &&						\
 	     !symbol__match_symbol_name(pos->name, sym_name,	\
 					SYMBOL_TAG_INCLUDE__DEFAULT_ONLY); \
-	     pos = symbol__next_by_name(pos))
+	     pos = dso__next_symbol_by_name(map__dso(map), &idx))
 
-#define map__for_each_symbol_by_name(map, sym_name, pos)		\
-	__map__for_each_symbol_by_name(map, sym_name, (pos))
+#define map__for_each_symbol_by_name(map, sym_name, pos, idx)	\
+	__map__for_each_symbol_by_name(map, sym_name, (pos), idx)
 
 void map__init(struct map *map,
 	       u64 start, u64 end, u64 pgoff, struct dso *dso);
@@ -202,6 +203,7 @@ int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
 int map__load(struct map *map);
 struct symbol *map__find_symbol(struct map *map, u64 addr);
 struct symbol *map__find_symbol_by_name(struct map *map, const char *name);
+struct symbol *map__find_symbol_by_name_idx(struct map *map, const char *name, size_t *idx);
 void map__fixup_start(struct map *map);
 void map__fixup_end(struct map *map);
 
tools/perf/util/probe-event.c +7 -8
index 6e2110d605fb..277cb8f84cbc 100644
@@ -382,6 +382,7 @@ static int find_alternative_probe_point(struct debuginfo *dinfo,
 	struct symbol *sym;
 	u64 address = 0;
 	int ret = -ENOENT;
+	size_t idx;
 
 	/* This can work only for function-name based one */
 	if (!pp->function || pp->file)
@@ -392,7 +393,7 @@ static int find_alternative_probe_point(struct debuginfo *dinfo,
 		return -EINVAL;
 
 	/* Find the address of given function */
-	map__for_each_symbol_by_name(map, pp->function, sym) {
+	map__for_each_symbol_by_name(map, pp->function, sym, idx) {
 		if (uprobes) {
 			address = sym->start;
 			if (sym->type == STT_GNU_IFUNC)
@@ -3738,7 +3739,6 @@ int del_perf_probe_events(struct strfilter *filter)
 int show_available_funcs(const char *target, struct nsinfo *nsi,
 			 struct strfilter *_filter, bool user)
 {
-        struct rb_node *nd;
 	struct map *map;
 	struct dso *dso;
 	int ret;
@@ -3767,17 +3767,16 @@ int show_available_funcs(const char *target, struct nsinfo *nsi,
 		goto end;
 	}
 	dso = map__dso(map);
-	if (!dso__sorted_by_name(dso))
-		dso__sort_by_name(dso);
+	dso__sort_by_name(dso);
 
 	/* Show all (filtered) symbols */
 	setup_pager();
 
-	for (nd = rb_first_cached(&dso->symbol_names); nd; nd = rb_next(nd)) {
-		struct symbol_name_rb_node *pos = rb_entry(nd, struct symbol_name_rb_node, rb_node);
+	for (size_t i = 0; i < dso->symbol_names_len; i++) {
+		struct symbol *pos = dso->symbol_names[i];
 
-		if (strfilter__compare(_filter, pos->sym.name))
-			printf("%s\n", pos->sym.name);
+		if (strfilter__compare(_filter, pos->name))
+			printf("%s\n", pos->name);
 	}
 end:
 	map__put(map);
tools/perf/util/symbol.c +64 -63

192 lines not on this page · raw message

tools/perf/util/symbol.h +3 -9
index 5ca8665dd2c1..af87c46b3f89 100644
@@ -43,8 +43,7 @@ Elf_Scn *elf_section_by_name(Elf *elf, GElf_Ehdr *ep,
 
 /**
  * A symtab entry. When allocated this may be preceded by an annotation (see
- * symbol__annotation), a browser_index (see symbol__browser_index) and rb_node
- * to sort by name (see struct symbol_name_rb_node).
+ * symbol__annotation) and/or a browser_index (see symbol__browser_index).
  */
 struct symbol {
 	struct rb_node	rb_node;
@@ -95,11 +94,6 @@ static inline size_t symbol__size(const struct symbol *sym)
 struct strlist;
 struct intlist;
 
-struct symbol_name_rb_node {
-	struct rb_node	rb_node;
-	struct symbol	sym;
-};
-
 static inline int __symbol__join_symfs(char *bf, size_t size, const char *path)
 {
 	return path__join(bf, size, symbol_conf.symfs, path);
@@ -136,9 +130,9 @@ void dso__delete_symbol(struct dso *dso,
 
 struct symbol *dso__find_symbol(struct dso *dso, u64 addr);
 struct symbol *dso__find_symbol_nocache(struct dso *dso, u64 addr);
-struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name);
 
-struct symbol *symbol__next_by_name(struct symbol *sym);
+struct symbol *dso__next_symbol_by_name(struct dso *dso, size_t *idx);
+struct symbol *dso__find_symbol_by_name(struct dso *dso, const char *name, size_t *idx);
 
 struct symbol *dso__first_symbol(struct dso *dso);
 struct symbol *dso__last_symbol(struct dso *dso);
tools/perf/util/symbol_fprintf.c +4 -6
index d9e5ad040b6a..088f4abf230f 100644
@@ -63,13 +63,11 @@ size_t dso__fprintf_symbols_by_name(struct dso *dso,
 				    FILE *fp)
 {
 	size_t ret = 0;
-	struct rb_node *nd;
-	struct symbol_name_rb_node *pos;
 
-	for (nd = rb_first_cached(&dso->symbol_names); nd; nd = rb_next(nd)) {
-		pos = rb_entry(nd, struct symbol_name_rb_node, rb_node);
-		ret += fprintf(fp, "%s\n", pos->sym.name);
-	}
+	for (size_t i = 0; i < dso->symbol_names_len; i++) {
+		struct symbol *pos = dso->symbol_names[i];
 
+		ret += fprintf(fp, "%s\n", pos->name);
+	}
 	return ret;
 }
Signature · 1 line
2.41.0.162.gfafddb0af9-goog
author reviewer
#3 lore raw

PATCH v3 3/3 perf symbol_conf: Remove now unused sort_by_name

In reply to Ian Rogers

Previously used to specify symbol_name_rb_node was in use.

---
 tools/perf/builtin-kallsyms.c   | 1 -
 tools/perf/builtin-lock.c       | 2 --
 tools/perf/builtin-report.c     | 1 -
 tools/perf/tests/builtin-test.c | 1 -
 tools/perf/util/probe-event.c   | 1 -
 tools/perf/util/symbol_conf.h   | 1 -
 6 files changed, 7 deletions(-)
tools/perf/builtin-kallsyms.c +0 -1
index 3751df744577..7f75c5b73f26 100644
@@ -62,7 +62,6 @@ int cmd_kallsyms(int argc, const char **argv)
 	if (argc < 1)
 		usage_with_options(kallsyms_usage, options);
 
-	symbol_conf.sort_by_name = true;
 	symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
 	if (symbol__init(NULL) < 0)
 		return -1;
tools/perf/builtin-lock.c +0 -2
index 8b505e1e5002..da36ace66d68 100644
@@ -1774,7 +1774,6 @@ static int __cmd_report(bool display_info)
 	}
 
 	/* for lock function check */
-	symbol_conf.sort_by_name = true;
 	symbol_conf.allow_aliases = true;
 	symbol__init(&session->header.env);
 
@@ -1904,7 +1903,6 @@ static int __cmd_contention(int argc, const char **argv)
 		con.save_callstack = true;
 
 	/* for lock function check */
-	symbol_conf.sort_by_name = true;
 	symbol_conf.allow_aliases = true;
 	symbol__init(&session->header.env);
 
tools/perf/builtin-report.c +0 -1
index a31a23af5547..dcedfe00f04d 100644
@@ -1676,7 +1676,6 @@ int cmd_report(int argc, const char **argv)
 			 * See symbol__browser_index.
 			 */
 			symbol_conf.priv_size += sizeof(u32);
-			symbol_conf.sort_by_name = true;
 		}
 		annotation_config__init(&report.annotation_opts);
 	}
tools/perf/tests/builtin-test.c +0 -1
index aa44fdc84763..1f6557ce3b0a 100644
@@ -542,7 +542,6 @@ int cmd_test(int argc, const char **argv)
 		return run_workload(workload, argc, argv);
 
 	symbol_conf.priv_size = sizeof(int);
-	symbol_conf.sort_by_name = true;
 	symbol_conf.try_vmlinux_path = true;
 
 	if (symbol__init(NULL) < 0)
tools/perf/util/probe-event.c +0 -1
index 277cb8f84cbc..16822a8a540f 100644
@@ -74,7 +74,6 @@ int init_probe_symbol_maps(bool user_only)
 {
 	int ret;
 
-	symbol_conf.sort_by_name = true;
 	symbol_conf.allow_aliases = true;
 	ret = symbol__init(NULL);
 	if (ret < 0) {
tools/perf/util/symbol_conf.h +0 -1
index f26f81eb8252..0b589570d1d0 100644
@@ -18,7 +18,6 @@ struct symbol_conf {
 			show_kernel_path,
 			use_modules,
 			allow_aliases,
-			sort_by_name,
 			show_nr_samples,
 			show_total_period,
 			use_callchain,
Signature · 1 line
2.41.0.162.gfafddb0af9-goog
maintainer Acked-by on the v3 series
#4 lore raw
In reply to Ian Rogers
Quoted 10 lines · Ian Rogers

Use a sorted array of symbol pointers to avoid the potentially unnecessary 3 pointers (rb_node) for the name sorted symbols. Saves been 24 and 16 bytes per symbol.

v3. Move sort by name dso lock into its own patch.
v2. map__find_symbol_by_name_idx so that map__find_symbol_by_name
doesn't need an optional parameter. Separate out symbol_conf.sort_by_name removal.

Quoted 4 lines

Ian Rogers (3):
perf dso: Sort symbols under lock
perf symbol: Remove symbol_name_rb_node perf symbol_conf: Remove now unused sort_by_name

Thanks,
Namhyung

Quoted 19 lines
 tools/perf/builtin-kallsyms.c    |   1 -
 tools/perf/builtin-lock.c        |   2 -
 tools/perf/builtin-report.c      |   1 -
 tools/perf/tests/builtin-test.c  |   1 -
 tools/perf/util/dso.c            |   7 +-
 tools/perf/util/dso.h            |   3 +-
 tools/perf/util/map.c            |  14 +++-
 tools/perf/util/map.h            |  12 +--
 tools/perf/util/probe-event.c    |  16 ++--
 tools/perf/util/symbol.c         | 131 ++++++++++++++++---------------
 tools/perf/util/symbol.h         |  12 +--
 tools/perf/util/symbol_conf.h    |   1 -
 tools/perf/util/symbol_fprintf.c |  10 +--
 13 files changed, 106 insertions(+), 105 deletions(-)

--
2.41.0.162.gfafddb0af9-goog

maintainer Applied
#5 lore raw
Quoted 12 lines · Namhyung Kim
Quoted 10 lines · Ian Rogers

Use a sorted array of symbol pointers to avoid the potentially unnecessary 3 pointers (rb_node) for the name sorted symbols. Saves been 24 and 16 bytes per symbol.

v3. Move sort by name dso lock into its own patch.
v2. map__find_symbol_by_name_idx so that map__find_symbol_by_name
doesn't need an optional parameter. Separate out symbol_conf.sort_by_name removal.

Quoted 6 lines
Quoted 4 lines

Ian Rogers (3):
perf dso: Sort symbols under lock
perf symbol: Remove symbol_name_rb_node perf symbol_conf: Remove now unused sort_by_name

Applied to perf-tools-next, thanks!