dso__data asan and test fixes
Ian Rogers
reviewerv2 cover dso__data asan and test fixes
The dso__data logic could deadlock with itself when build with asan or reference count checking due to trying to recurively take a non-recursive mutex. Use clang's thread safety analysis to find/fix the problem. Running the tests would fail with -F no-fork mode as a file descriptor wasn't cleaned up.
v2: Remove an unnecessary if as suggested by Namhyung.
Ian Rogers (3):
perf mutex: Add annotations for LOCKS_EXCLUDED and LOCKS_RETURNED perf dso: Use lock annotations to fix asan deadlock perf test dso-data: Correctly free test file in read test
tools/perf/tests/dso-data.c | 28 ++++----- tools/perf/util/dso.c | 74 +++++++++++++++--------- tools/perf/util/dso.h | 15 +++-- tools/perf/util/mutex.h | 8 +++ tools/perf/util/unwind-libunwind-local.c | 16 ++--- 5 files changed, 86 insertions(+), 55 deletions(-)
Signature · 1 line
2.49.0.rc1.451.g8f38331e32-goog
Ian Rogers
reviewerPATCH v2 1/3 perf mutex: Add annotations for LOCKS_EXCLUDED and LOCKS_RETURNED
Used to annotate when locks shouldn't be held for a function or if a function returns a lock that's used by later mutex lock unlock operations.
--- tools/perf/util/mutex.h | 8 ++++++++ 1 file changed, 8 insertions(+)
tools/perf/util/mutex.h +8 -0
@@ -33,6 +33,12 @@/* Documents if a type is a lockable type. */ #define LOCKABLE __attribute__((lockable)) +/* Documents a function that expects a lock not to be held prior to entry. */ +#define LOCKS_EXCLUDED (...) __attribute__((locks_excluded(__VA_ARGS__))) + +/* Documents a function that returns a lock. */ +#define LOCK_RETURNED (x) __attribute__((lock_returned(x))) +/* Documents functions that acquire a lock in the body of a function, and do not release it. */ #define EXCLUSIVE_LOCK_FUNCTION (...) __attribute__((exclusive_lock_function(__VA_ARGS__)))
@@ -57,6 +63,8 @@#define GUARDED_BY (x)#define PT_GUARDED_BY (x)#define LOCKABLE +#define LOCKS_EXCLUDED (...) +#define LOCK_RETURNED (x)#define EXCLUSIVE_LOCK_FUNCTION (...)#define UNLOCK_FUNCTION (...)#define EXCLUSIVE_TRYLOCK_FUNCTION (...)
Signature · 1 line
2.49.0.rc1.451.g8f38331e32-goog
Ian Rogers
reviewerPATCH v2 2/3 perf dso: Use lock annotations to fix asan deadlock
In reply to Ian Rogersdso__list_del with address sanitizer and/or reference count checking will call dso__put that can call dso__data_close reentrantly trying to lock the dso__data_open_lock and deadlocking. Switch from pthread mutexes to perf's mutex so that lock checking is performed in debug builds. Add lock annotations that diagnosed the problem. Release the dso__data_open_lock around the dso__put to avoid the deadlock.
Change the declaration of dso__data_get_fd to return a boolean, indicating the fd is valid and the lock is held, to make it compatible with the thread safety annotations as a try lock.
--- tools/perf/tests/dso-data.c | 4 +- tools/perf/util/dso.c | 74 +++++++++++++++--------- tools/perf/util/dso.h | 15 +++-- tools/perf/util/unwind-libunwind-local.c | 16 ++--- 4 files changed, 66 insertions(+), 43 deletions(-)
tools/perf/tests/dso-data.c +2 -2
@@ -106,9 +106,9 @@ struct test_data_offset offsets[] = {/* move it from util/dso.c for compatibility */ static int dso__data_fd (struct dso *dso,struct machine *machine) { -int fd =dso__data_get_fd (dso, machine); +int fd =-1 ; -if (fd >=0 ) +if (dso__data_get_fd (dso, machine, &fd))dso__data_put_fd (dso);return fd;
tools/perf/util/dso.c +47 -27
197 lines not on this page · raw message
tools/perf/util/dso.h +9 -6
@@ -232,6 +232,8 @@ DECLARE_RC_STRUCT(dso) {char name[]; }; +extern struct mutex _dso__data_open_lock; +/* dso__for_each_symbol - iterate over the symbols of given type * * @dso: the 'struct dso *' in which symbols are iterated
@@ -653,7 +655,7 @@ void __dso__inject_id(struct dso *dso, const struct dso_id *id);int dso__name_len (const struct dso *dso);struct dso *dso__get (struct dso *dso); -void dso__put (struct dso *dso); +void dso__put(struct dso *dso) LOCKS_EXCLUDED(_dso__data_open_lock);static inline void __dso__zput (struct dso **dso) {
@@ -733,8 +735,8 @@ void dso__set_module_info(struct dso *dso, struct kmod_path *m,* The current usage of the dso__data_* interface is as follows: * * Get DSO's fd: -* int fd = dso__data_get_fd(dso, machine); -* if (fd >= 0) { +* int fd; +* if (dso__data_get_fd(dso, machine, &fd)) { * USE 'fd' SOMEHOW * dso__data_put_fd(dso); * }
@@ -756,9 +758,10 @@ void dso__set_module_info(struct dso *dso, struct kmod_path *m,* * TODO */ -int dso__data_get_fd (struct dso *dso,struct machine *machine); -void dso__data_put_fd (struct dso *dso); -void dso__data_close (struct dso *dso); +bool dso__data_get_fd(struct dso *dso, struct machine *machine, int *fd) + EXCLUSIVE_TRYLOCK_FUNCTION(true, _dso__data_open_lock); +void dso__data_put_fd(struct dso *dso) UNLOCK_FUNCTION(_dso__data_open_lock); +void dso__data_close(struct dso *dso) LOCKS_EXCLUDED(_dso__data_open_lock);int dso__data_file_size (struct dso *dso,struct machine *machine);off_t dso__data_size (struct dso *dso,struct machine *machine);
tools/perf/util/unwind-libunwind-local.c +8 -8
@@ -330,8 +330,7 @@ static int read_unwind_spec_eh_frame(struct dso *dso, struct unwind_info *ui,int ret, fd;if (dso__data (dso)->eh_frame_hdr_offset ==0 ) { - fd =dso__data_get_fd (dso, ui->machine); -if (fd <0 ) +if (!dso__data_get_fd (dso, ui->machine, &fd))return -EINVAL ;/* Check the .eh_frame section for unwinding info */
@@ -372,8 +371,7 @@ static int read_unwind_spec_debug_frame(struct dso *dso,* has to be pointed by symsrc_filename */ if (ofs ==0 ) { - fd =dso__data_get_fd (dso, machine); -if (fd >=0 ) { + if (dso__data_get_fd(dso, machine, &fd) { ofs =elf_section_offset (fd,".debug_frame" );dso__data_put_fd (dso); }
@@ -485,14 +483,16 @@ find_proc_info(unw_addr_space_t as, unw_word_t ip, unw_proc_info_t *pi,/* Check the .debug_frame section for unwinding info */ if (ret <0 && !read_unwind_spec_debug_frame (dso, ui->machine, &segbase)) { -int fd =dso__data_get_fd (dso, ui->machine); -int is_exec =elf_is_exec (fd,dso__name (dso)); +int fd;u64 start =map__start (map); -unw_word_t base = is_exec ?0 : start; +unw_word_t base = start;const char *symfile; -if (fd >=0 ) +if (dso__data_get_fd (dso, ui->machine, &fd)) { +if (elf_is_exec (fd,dso__name (dso))) + base =0 ;dso__data_put_fd (dso); + } symfile =dso__symsrc_filename (dso) ?:dso__name (dso);
Signature · 1 line
2.49.0.rc1.451.g8f38331e32-goog
Ian Rogers
reviewerPATCH v2 3/3 perf test dso-data: Correctly free test file in read test
In reply to Ian RogersThe DSO data read test opens a file but as dsos__exit is used the test file isn't closed. This causes the subsequent subtests in don't fork (-F) mode to fail as one more than expected file descriptor is open.
--- tools/perf/tests/dso-data.c | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-)
tools/perf/tests/dso-data.c +12 -12
@@ -114,6 +114,17 @@ static int dso__data_fd(struct dso *dso, struct machine *machine)return fd; } +static void dsos__delete (struct dsos *dsos) +{ +for (unsigned int i =0 ; i < dsos->cnt; i++) { +struct dso *dso = dsos->dsos[i]; + +dso__data_close (dso); +unlink (dso__name (dso)); + } +dsos__exit (dsos); +} +static int test__dso_data (struct test_suite *test__maybe_unused ,int subtest__maybe_unused ) {struct machine machine;
@@ -172,7 +183,7 @@ static int test__dso_data(struct test_suite *test __maybe_unused, int subtest __ }dso__put (dso); -dsos__exit (&machine.dsos); +dsos__delete (&machine.dsos);unlink (file);return 0 ; }
@@ -222,17 +233,6 @@ static int dsos__create(int cnt, int size, struct dsos *dsos)return 0 ; } -static void dsos__delete (struct dsos *dsos) -{ -for (unsigned int i =0 ; i < dsos->cnt; i++) { -struct dso *dso = dsos->dsos[i]; - -dso__data_close (dso); -unlink (dso__name (dso)); - } -dsos__exit (dsos); -} -static int set_fd_limit (int n) {struct rlimit rlim;
Signature · 1 line
2.49.0.rc1.451.g8f38331e32-goog
Quoted 9 lines · Ian Rogers
The
dso__datalogic could deadlock with itself when build with asan or reference count checking due to trying to recurively take a non-recursive mutex. Use clang's thread safety analysis to find/fix the problem. Running the tests would fail with -F no-fork mode as a file descriptor wasn't cleaned up.v2: Remove an unnecessary if as suggested by Namhyung.
[...]
Applied to perf-tools-next, thanks!
Best regards,
Namhyung