From: Nick Alcock <nick.alcock@oracle.com>
To: binutils@sourceware.org
Subject: [PATCH 1/2] libctf: add a comment explaining how to use ctf_*open
Date: Wed, 27 Apr 2022 16:51:29 +0100 [thread overview]
Message-ID: <20220427155130.238504-1-nick.alcock@oracle.com> (raw)
Specifically, tell users what to pass to those functions that accept raw
section content, since it's fairly involved and easy to get wrong.
(.dynsym / .dynstr when CTF_F_DYNSTR is set, otherwise .symtab / .strtab).
include/ChangeLog:
* ctf-api.h (ctf_*open): Improve comment.
---
include/ctf-api.h | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/include/ctf-api.h b/include/ctf-api.h
index a3f45283b3c..153e012b5a0 100644
--- a/include/ctf-api.h
+++ b/include/ctf-api.h
@@ -314,7 +314,13 @@ extern ctf_next_t *ctf_next_copy (ctf_next_t *);
archives: so they can be used to open both. CTF files will appear to be an
archive with one member named '.ctf'. The low-level functions
ctf_simple_open and ctf_bufopen return ctf_dict_t's directly, and cannot
- be used on CTF archives. */
+ be used on CTF archives.
+
+ Some of these functions take raw symtab and strtab section content in the
+ form of ctf_sect_t structures. For CTF in ELF files, these should be
+ extracted from .dynsym and its associated string table (usually .dynsym)
+ whenever the CTF_F_DYNSTR flag is set in the CTF preamble (which it almost
+ always will be for linked objects, but not for .o files). */
extern ctf_archive_t *ctf_bfdopen (struct bfd *, int *);
extern ctf_archive_t *ctf_bfdopen_ctfsect (struct bfd *, const ctf_sect_t *,
base-commit: 531c82a1c724079f98a4b069584681bc66da4dae
prerequisite-patch-id: 40f3e06181aa2cd54d4058e4b944a0d824f34f5f
prerequisite-patch-id: ef340a27f17470fb0544c063de87f3ae7de4dc2f
prerequisite-patch-id: a12de7cf51d1cfd6e9a1c61e851faa359cd3982b
prerequisite-patch-id: 2d39fffbdcc72a054184df623f9114f94b88cb64
prerequisite-patch-id: d55d8059be2d51962acc2e23a39a3921a3801199
prerequisite-patch-id: 3e0eea8043e3cd045779e30c375fe394c804c48f
prerequisite-patch-id: 4cb4bb30adb35d6ac591905c68c68c58fda191df
prerequisite-patch-id: 67d77176340cb47cc336c747a800d5748377136e
prerequisite-patch-id: c7fb48d926d5923680ecaa4e96c0d59891a751d3
prerequisite-patch-id: c097df29724255c0fcb3cbb4e33a1dd642684b5d
prerequisite-patch-id: fd1a706540f1780c1255b67784022e6268df3e9c
prerequisite-patch-id: 75b6b1d5cc24d11fb29cb0aa49a68e0fa9c402d6
prerequisite-patch-id: 644c13ece37062694e37224fb16d00947e3524c5
prerequisite-patch-id: 3900eda69a5ff8250d3372782e44de3053b3ba38
prerequisite-patch-id: 41947744e6c79fc3cc26e8dc3eb51812de7cd37c
prerequisite-patch-id: 4a566d02b8eb6d2fd01b305351e36b3b2fe300e0
prerequisite-patch-id: 47209dc4f1399290516ac8b96025f1984f887064
prerequisite-patch-id: 222cb080fcac03241c54f8ed254be5a441a1027d
prerequisite-patch-id: 8c2928f8cbff1d26e720b29a00ae824b26eb117d
prerequisite-patch-id: 026fe4a5b3a6e9e6824e68c3d6087bd560eaf404
prerequisite-patch-id: 0d678e933f28036e84cee8821c14db5d3a8c45f4
prerequisite-patch-id: d6c6a72b62a8b5e1a077f0578f592db9661e6271
prerequisite-patch-id: d318154951de43543c99211c5f518f478d68cebb
prerequisite-patch-id: 2c07a379863a0ea6d9b2a0a8158bb8920284241c
prerequisite-patch-id: 616d6d785dfaf8825cc55a3aeb8519e8e58569c3
prerequisite-patch-id: e8487d714c5a4b2a318b982913280255175b7698
prerequisite-patch-id: b3b209d80b57ab95d259834502f897f4636ee16a
prerequisite-patch-id: 1ce23787a13f7bdf114bc78b4cc220335af4fab2
prerequisite-patch-id: 3e20d1754c62887e0d4097a3f5dd094d15884206
prerequisite-patch-id: fbacee4a6adf081d67aa4b7c0106dc9b135b815f
prerequisite-patch-id: 4b5ce20b8eb1d5be0f9e4350099788ae8e86640d
prerequisite-patch-id: 9a1e4134e43425877a1d895d618496fff2f1cf3f
prerequisite-patch-id: 865cb1e5d11a00ab80aa4d8e4d1d33a887604982
prerequisite-patch-id: 4a80fbe279c2876b89cf795a032ad5f15d1a85cb
prerequisite-patch-id: cb2824b2c24303c0ba461c0dd9d82f7d618aeacc
prerequisite-patch-id: c490a4c4622b5229db11ebbc92d2bb4be6059290
prerequisite-patch-id: d49351257b621ee89ecb9253e375d87d452dd2ee
prerequisite-patch-id: d14e527f602406060dfe3c7bec7bc398b79d6b52
prerequisite-patch-id: d72cfacadcb022988856538304efbf233762a209
prerequisite-patch-id: 4b42cc9effa21721b820c472f3aa96a526d183d8
prerequisite-patch-id: 8e3a539b1c19cc66f0517ffdda2faf5483e0cadf
prerequisite-patch-id: d6b6641d5d50578518a5e66af864c28d6f5e135b
prerequisite-patch-id: bd49be55da65d3c0834589edcc968a2a3c69ac8a
prerequisite-patch-id: 9ed22b370da901499115758ec10e74d273bb944c
prerequisite-patch-id: e7c4f1809a3f293d479d2bb0721d5afcbbd2fc8f
prerequisite-patch-id: 07f52003a2ca2835cc1c48ab0523407027f737e4
prerequisite-patch-id: 5c6fcade90b1d7162810dd0b443363cb95ebe8ad
prerequisite-patch-id: f8c92965ab50137dce4da03f254791bd1e99ca7f
prerequisite-patch-id: 4952d7a2b2c9c999a29b7a0a977a8eaadbfd9c02
prerequisite-patch-id: 8ed93cc1f7e353cbf163f80ca6215dedf07524f8
prerequisite-patch-id: 0895d195998daf64e76003c8d8ca5f9657224829
prerequisite-patch-id: 49f2256590c40b9dd5b95053ff8e4b1ef63aab67
prerequisite-patch-id: 7638b29752342802329fe57895cb1960c5e63d8d
prerequisite-patch-id: a57258c269449415ff3373ce7e945d828ed2f70f
prerequisite-patch-id: 9dde5b4ca08a773e6d06aeffecde66ec7fc929b0
prerequisite-patch-id: 6616cb7d3be8b5d9777c0466f66671ab8809aa11
prerequisite-patch-id: 2098f5adc7e1a8e9700792796199f05864959594
prerequisite-patch-id: 058d42109d27390e1b71cc9561912a9ae3cc3ab6
prerequisite-patch-id: 84815b17d444e7e56dbff36e001392f9a79820a2
prerequisite-patch-id: 137d760d9dc554d7de70f1539a921dfe78843f61
prerequisite-patch-id: dfab5bd8525ebe14c776b582e5ea068ab133b249
prerequisite-patch-id: 205325a14cbc4fb3a87c48a486d263f02a80dd1f
prerequisite-patch-id: dcd841b94b3e691a4fb73a2d6ca8699efb704906
prerequisite-patch-id: 43231ba369f10d25b371699a174cbde625ce1dd8
prerequisite-patch-id: 02008197837e16c30f60ac8f29816e4f34402736
prerequisite-patch-id: 8b9ab351f553f84cdd31ea5cad0c2965943a4f56
--
2.36.0.262.gb007c8117e.dirty
next reply other threads:[~2022-04-27 15:51 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-27 15:51 Nick Alcock [this message]
2022-04-27 15:51 ` [PATCH 2/2] libctf: impose an ordering on conflicting types Nick Alcock
2022-04-28 11:08 ` Nick Alcock
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=20220427155130.238504-1-nick.alcock@oracle.com \
--to=nick.alcock@oracle.com \
--cc=binutils@sourceware.org \
/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).