From: Mark Wielaard <mark@klomp.org>
To: elfutils-devel@sourceware.org
Cc: William Cohen <wcohen@redhat.com>, Mark Wielaard <mark@klomp.org>
Subject: [PATCH] libdwfl: Update docs and nonnull attributes for dwfl_module_addrinfo
Date: Sun, 15 May 2022 22:00:30 +0200 [thread overview]
Message-ID: <20220515200030.343101-1-mark@klomp.org> (raw)
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
next reply other threads:[~2022-05-15 20:00 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-05-15 20:00 Mark Wielaard [this message]
2022-05-27 15:10 ` Mark Wielaard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220515200030.343101-1-mark@klomp.org \
--to=mark@klomp.org \
--cc=elfutils-devel@sourceware.org \
--cc=wcohen@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).