* [PATCH] libdwfl: Update docs and nonnull attributes for dwfl_module_addrinfo
@ 2022-05-15 20:00 Mark Wielaard
2022-05-27 15:10 ` Mark Wielaard
0 siblings, 1 reply; 2+ messages in thread
From: Mark Wielaard @ 2022-05-15 20:00 UTC (permalink / raw)
To: elfutils-devel; +Cc: William Cohen, Mark Wielaard
Make clear that both the offset and sym arguments cannot be NULL.
https://bugzilla.redhat.com/show_bug.cgi?id=1986555
Signed-off-by: Mark Wielaard <mark@klomp.org>
---
libdwfl/ChangeLog | 5 +++++
libdwfl/libdwfl.h | 32 ++++++++++++++++----------------
2 files changed, 21 insertions(+), 16 deletions(-)
diff --git a/libdwfl/ChangeLog b/libdwfl/ChangeLog
index 76053039..b3ca56cb 100644
--- a/libdwfl/ChangeLog
+++ b/libdwfl/ChangeLog
@@ -1,3 +1,8 @@
+2022-05-15 Mark Wielaard <mark@klomp.org>
+
+ * libdwfl.h (dwfl_module_addrinfo): Update docs and nonnull
+ attribute to make clear offset and sym cannot be NULL.
+
2022-04-22 Mark Wielaard <mark@klomp.org>
* debuginfod-client.c (init_control): New static pthread_once_t.
diff --git a/libdwfl/libdwfl.h b/libdwfl/libdwfl.h
index f98f1d52..c55a8eaa 100644
--- a/libdwfl/libdwfl.h
+++ b/libdwfl/libdwfl.h
@@ -473,26 +473,26 @@ extern const char *dwfl_module_addrname (Dwfl_Module *mod, GElf_Addr address);
when nothing was found. If the architecture uses function
descriptors, and symbol st_value points to one, ADDRESS will be
matched against either the adjusted st_value or the associated
- function entry value as described in dwfl_module_getsym_info. If
- OFFSET is not NULL it will be filled in with the difference from
- the start of the symbol (or function entry). If SYM is not NULL it
- is filled in with the symbol associated with the matched ADDRESS.
- The SYM->ST_VALUE itself isn't adjusted in any way. Fills in ELFP,
- if not NULL, with the ELF file the symbol originally came from.
- Note that symbols can come from either the main, debug or auxiliary
- ELF symbol file (either dynsym or symtab). If SHNDXP is non-null,
- it's set with the section index (whether from st_shndx or extended
- index table). Fills in BIAS, if not NULL, with the difference
- between addresses within the loaded module and those in symbol
- table of the ELF file. Note that the address matched against the
- symbol might be in a different section than the returned symbol.
- The section in the main elf file in ADDRESS falls can be found with
- dwfl_module_address_section. */
+ function entry value as described in dwfl_module_getsym_info.
+ OFFSET will be filled in with the difference from the start of the
+ symbol (or function entry), OFFSET cannot be NULL. SYM is filled
+ in with the symbol associated with the matched ADDRESS, SYM cannot
+ be NULL. The SYM->ST_VALUE itself isn't adjusted in any way.
+ Fills in ELFP, if not NULL, with the ELF file the symbol originally
+ came from. Note that symbols can come from either the main, debug
+ or auxiliary ELF symbol file (either dynsym or symtab). If SHNDXP
+ is non-null, it's set with the section index (whether from st_shndx
+ or extended index table). Fills in BIAS, if not NULL, with the
+ difference between addresses within the loaded module and those in
+ symbol table of the ELF file. Note that the address matched
+ against the symbol might be in a different section than the
+ returned symbol. The section in the main elf file in ADDRESS falls
+ can be found with dwfl_module_address_section. */
extern const char *dwfl_module_addrinfo (Dwfl_Module *mod, GElf_Addr address,
GElf_Off *offset, GElf_Sym *sym,
GElf_Word *shndxp, Elf **elfp,
Dwarf_Addr *bias)
- __nonnull_attribute__ (3);
+ __nonnull_attribute__ (3, 4);
/* Find the symbol that ADDRESS lies inside, and return detailed
information as for dwfl_module_getsym (above). Note that like
--
2.30.2
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [PATCH] libdwfl: Update docs and nonnull attributes for dwfl_module_addrinfo
2022-05-15 20:00 [PATCH] libdwfl: Update docs and nonnull attributes for dwfl_module_addrinfo Mark Wielaard
@ 2022-05-27 15:10 ` Mark Wielaard
0 siblings, 0 replies; 2+ messages in thread
From: Mark Wielaard @ 2022-05-27 15:10 UTC (permalink / raw)
To: elfutils-devel; +Cc: William Cohen
Hi,
On Sun, 2022-05-15 at 22:00 +0200, Mark Wielaard wrote:
> Make clear that both the offset and sym arguments cannot be NULL.
>
> https://bugzilla.redhat.com/show_bug.cgi?id=1986555
I didn't get feedback on the actual wording, but I think this is better
than we had. So pushed.
Cheers,
Mark
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2022-05-27 15:10 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-05-15 20:00 [PATCH] libdwfl: Update docs and nonnull attributes for dwfl_module_addrinfo Mark Wielaard
2022-05-27 15:10 ` Mark Wielaard
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).