BPF List
 help / color / mirror / Atom feed
From: Marcelo Juchem <juchem@gmail.com>
To: bpf@vger.kernel.org
Cc: Marcelo Juchem <mj@hunetr.com>
Subject: [PATCH] bpftool: output map/prog indices on `gen skeleton`
Date: Thu,  8 Sep 2022 13:39:52 -0500	[thread overview]
Message-ID: <20220908183952.3438815-1-mj@hunetr.com> (raw)

The skeleton generated by `bpftool` makes it easy to attach and load bpf
objects as a whole. Some BPF programs are not directly portable across kernel
versions, though, and require some cherry-picking on which programs to
load/attach. The skeleton makes this cherry-picking possible, but not entirely
friendly in some cases.

For example, an useful feature is `attach_with_fallback` so that one
program can be attempted, and fallback programs tried subsequently until
one works (think `tcp_recvmsg` interface changing on kernel 5.19).

Being able to represent a set of probes programatically in a way that is both
descriptive, compile-time validated, runtime efficient and custom library
friendly is quite desirable for application developers. A very simple way to
represent a set of probes is with an array of indices.

This patch creates a couple of enums under the `__cplusplus` section to
represent the program and map indices inside the skeleton object, that can be
used to refer to the proper program/map object.

This is the code generated for the `__cplusplus` section of `profiler.skel.h`:
```
  enum map_idxs: size_t {
    events = 0,
    fentry_readings = 1,
    accum_readings = 2,
    counts = 3,
    rodata = 4
  };
  enum prog_idxs: size_t {
    fentry_XXX = 0,
    fexit_XXX = 1
  };
  static inline struct profiler_bpf *open(const struct bpf_object_open_opts *opts = nullptr);
  static inline struct profiler_bpf *open_and_load();
  static inline int load(struct profiler_bpf *skel);
  static inline int attach(struct profiler_bpf *skel);
  static inline void detach(struct profiler_bpf *skel);
  static inline void destroy(struct profiler_bpf *skel);
  static inline const void *elf_bytes(size_t *sz);
```
---
 src/gen.c | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/src/gen.c b/src/gen.c
index 7070dcf..7e28dc7 100644
--- a/src/gen.c
+++ b/src/gen.c
@@ -1086,6 +1086,38 @@ static int do_skeleton(int argc, char **argv)
 		\n\
 									    \n\
 		#ifdef __cplusplus					    \n\
+		"
+	);
+
+	{
+		size_t i = 0;
+		printf("\tenum map_index: size_t {");
+		bpf_object__for_each_map(map, obj) {
+			if (!get_map_ident(map, ident, sizeof(ident)))
+				continue;
+			if (i) {
+				printf(",");
+			}
+			printf("\n\t\t%s = %lu", ident, i);
+			++i;
+		}
+		printf("\n\t};\n");
+	}
+	{
+		size_t i = 0;
+		printf("\tenum prog_index: size_t {");
+		bpf_object__for_each_program(prog, obj) {
+			if (i) {
+				printf(",");
+			}
+			printf("\n\t\t%s = %lu", bpf_program__name(prog), i);
+			++i;
+		}
+		printf("\n\t};\n");
+	}
+
+	codegen("\
+		\n\
 			static inline struct %1$s *open(const struct bpf_object_open_opts *opts = nullptr);\n\
 			static inline struct %1$s *open_and_load();	    \n\
 			static inline int load(struct %1$s *skel);	    \n\
-- 
2.37.2


             reply	other threads:[~2022-09-08 18:40 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-08 18:39 Marcelo Juchem [this message]
2022-09-08 22:03 ` [PATCH] bpftool: output map/prog indices on `gen skeleton` sdf
2022-09-09  1:48   ` Marcelo Juchem
2022-09-09  2:39     ` sdf
     [not found]       ` <CAK0nC2VSBn3onXW2LfHdH4c+T6qCfcWHPE99QAV5pjqFj_pMUg@mail.gmail.com>
2022-09-09 16:25         ` Stanislav Fomichev
2022-09-09 16:40           ` Marcelo Juchem
2022-09-09 18:16             ` Stanislav Fomichev

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=20220908183952.3438815-1-mj@hunetr.com \
    --to=juchem@gmail.com \
    --cc=bpf@vger.kernel.org \
    --cc=mj@hunetr.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