| lists.openwall.net | lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC | |
|
Open Source and information security mailing list archives
| ||
|
Message-Id: <20210528235250.2635167-15-memxor@gmail.com>
Date: Sat, 29 May 2021 05:22:49 +0530
From: Kumar Kartikeya Dwivedi <memxor@...il.com>
To: bpf@...r.kernel.org
Cc: Kumar Kartikeya Dwivedi <memxor@...il.com>,
Alexei Starovoitov <ast@...nel.org>,
Daniel Borkmann <daniel@...earbox.net>,
Andrii Nakryiko <andrii@...nel.org>,
Martin KaFai Lau <kafai@...com>,
Song Liu <songliubraving@...com>, Yonghong Song <yhs@...com>,
John Fastabend <john.fastabend@...il.com>,
KP Singh <kpsingh@...nel.org>,
"David S. Miller" <davem@...emloft.net>,
Jakub Kicinski <kuba@...nel.org>,
Jesper Dangaard Brouer <brouer@...hat.com>,
Toke Høiland-Jørgensen <toke@...hat.com>,
netdev@...r.kernel.org
Subject: [PATCH RFC bpf-next 14/15] samples: bpf: add documentation
This prints some help text meant to explain the output.
Signed-off-by: Kumar Kartikeya Dwivedi <memxor@...il.com>
---
samples/bpf/xdp_monitor_user.c | 10 ++++--
samples/bpf/xdp_redirect_cpu_user.c | 8 +++--
samples/bpf/xdp_redirect_map_user.c | 6 ++--
samples/bpf/xdp_sample_user.c | 52 +++++++++++++++++++++++++++++
samples/bpf/xdp_sample_user.h | 1 +
5 files changed, 69 insertions(+), 8 deletions(-)
diff --git a/samples/bpf/xdp_monitor_user.c b/samples/bpf/xdp_monitor_user.c
index b37d8f7379ec..71d59e714bae 100644
--- a/samples/bpf/xdp_monitor_user.c
+++ b/samples/bpf/xdp_monitor_user.c
@@ -35,6 +35,10 @@ static const char *__doc_err_only__=
static bool debug = false;
struct bpf_object *obj;
+static int mask = SAMPLE_REDIRECT_ERR_CNT | SAMPLE_CPUMAP_ENQUEUE_CNT |
+ SAMPLE_CPUMAP_KTHREAD_CNT | SAMPLE_EXCEPTION_CNT |
+ SAMPLE_DEVMAP_XMIT_CNT;
+
static const struct option long_options[] = {
{"help", no_argument, NULL, 'h' },
{"debug", no_argument, NULL, 'D' },
@@ -56,6 +60,9 @@ static void int_exit(int sig)
static void usage(char *argv[])
{
int i;
+
+ sample_print_help(mask);
+
printf("\nDOCUMENTATION:\n%s\n", __doc__);
printf("\n");
printf(" Usage: %s (options-see-below)\n",
@@ -110,9 +117,6 @@ static void print_bpf_prog_info(void)
int main(int argc, char **argv)
{
- int mask = SAMPLE_REDIRECT_ERR_CNT | SAMPLE_CPUMAP_ENQUEUE_CNT |
- SAMPLE_CPUMAP_KTHREAD_CNT | SAMPLE_EXCEPTION_CNT |
- SAMPLE_DEVMAP_XMIT_CNT;
int longindex = 0, opt;
int ret = EXIT_FAILURE;
char filename[256];
diff --git a/samples/bpf/xdp_redirect_cpu_user.c b/samples/bpf/xdp_redirect_cpu_user.c
index d56b89254cd1..9233b8a2bf2d 100644
--- a/samples/bpf/xdp_redirect_cpu_user.c
+++ b/samples/bpf/xdp_redirect_cpu_user.c
@@ -37,6 +37,9 @@ static int avail_fd;
static int count_fd;
static __u32 xdp_flags = XDP_FLAGS_UPDATE_IF_NOEXIST;
+static int mask = SAMPLE_RX_CNT | SAMPLE_REDIRECT_ERR_CNT |
+ SAMPLE_CPUMAP_ENQUEUE_CNT | SAMPLE_CPUMAP_KTHREAD_CNT |
+ SAMPLE_EXCEPTION_CNT;
static const struct option long_options[] = {
{"help", no_argument, NULL, 'h' },
@@ -96,6 +99,8 @@ static void usage(char *argv[], struct bpf_object *obj)
{
int i;
+ sample_print_help(mask);
+
printf("\nDOCUMENTATION:\n%s\n", __doc__);
printf("\n");
printf(" Usage: %s (options-see-below)\n", argv[0]);
@@ -201,9 +206,6 @@ static void __stats_poll(int interval, bool redir_suc, char *prog_name,
char *mprog_name, struct bpf_cpumap_val *value,
bool stress_mode)
{
- int mask = SAMPLE_RX_CNT | SAMPLE_REDIRECT_ERR_CNT |
- SAMPLE_CPUMAP_ENQUEUE_CNT | SAMPLE_CPUMAP_KTHREAD_CNT |
- SAMPLE_EXCEPTION_CNT;
struct stats_record *record, *prev;
record = alloc_stats_record();
diff --git a/samples/bpf/xdp_redirect_map_user.c b/samples/bpf/xdp_redirect_map_user.c
index eb4013fa58cb..f4bdefa83709 100644
--- a/samples/bpf/xdp_redirect_map_user.c
+++ b/samples/bpf/xdp_redirect_map_user.c
@@ -28,6 +28,8 @@ static __u32 prog_id;
static __u32 dummy_prog_id;
static __u32 xdp_flags = XDP_FLAGS_UPDATE_IF_NOEXIST;
+static int mask = SAMPLE_RX_CNT | SAMPLE_REDIRECT_ERR_MAP_CNT |
+ SAMPLE_EXCEPTION_CNT | SAMPLE_DEVMAP_XMIT_CNT;
static const struct option long_options[] = {
{"help", no_argument, NULL, 'h' },
@@ -78,6 +80,8 @@ static void usage(char *argv[])
{
int i;
+ sample_print_help(mask);
+
printf("\n");
printf(" Usage: %s (options-see-below)\n",
argv[0]);
@@ -97,8 +101,6 @@ static void usage(char *argv[])
int main(int argc, char **argv)
{
- int mask = SAMPLE_RX_CNT | SAMPLE_REDIRECT_ERR_MAP_CNT |
- SAMPLE_EXCEPTION_CNT | SAMPLE_DEVMAP_XMIT_CNT;
struct bpf_prog_load_attr prog_load_attr = {
.prog_type = BPF_PROG_TYPE_UNSPEC,
};
diff --git a/samples/bpf/xdp_sample_user.c b/samples/bpf/xdp_sample_user.c
index 96d36c708ee3..aa02d9bbea6c 100644
--- a/samples/bpf/xdp_sample_user.c
+++ b/samples/bpf/xdp_sample_user.c
@@ -77,6 +77,58 @@ static bool err_exp;
#define PASS(pass) pass, "pass/s"
#define REDIR(redir) redir, "redir/s"
+void sample_print_help(int mask)
+{
+ printf("Output format description\n\n"
+ "By default, redirect success statistics are disabled, use -s to enable.\n"
+ "The terse output mode is default, verbose mode can be activated using -v\n"
+ "Use SIGQUIT (Ctrl + \\) to switch the mode dynamically at runtime\n\n"
+ "Terse mode displays at most the following fields:\n"
+ " rx/s Number of packets received per second\n"
+ " redir/s Number of packets successfully redirected per second\n"
+ " error/s Aggregated count of errors per second (including dropped packets)\n"
+ " xmit/s Number of packets transmitted on the output device per second\n\n"
+ "Output description for verbose mode:\n"
+ " FIELD DESCRIPTION\n");
+ if (mask & SAMPLE_RX_CNT) {
+ printf(" receive\tDisplays the number of packets received & errors encountered\n"
+ " \t\tWhenever an error or packet drop occurs, details of per CPU error\n"
+ " \t\tand drop statistics will be expanded inline in terse mode.\n"
+ " \t\t\tpkt/s - Packets received per second\n"
+ " \t\t\tdrop/s - Packets dropped per second\n"
+ " \t\t\terror/s - Errors encountered per second\n\n");
+ }
+ if (mask & (SAMPLE_REDIRECT_CNT|SAMPLE_REDIRECT_ERR_CNT)) {
+ printf(" redirect\tDisplays the number of packets successfully redirected\n"
+ " \t\tErrors encountered are expanded under redirect_err field\n"
+ " \t\tNote that passing -s to enable it has a per packet overhead\n"
+ " \t\t\tredir/s - Packets redirected successfully per second\n\n"
+ " redirect_err\tDisplays the number of packets that failed redirection\n"
+ " \t\tThe errno is expanded under this field with per CPU count\n"
+ " \t\tThe recognized errors are EOPNOTSUPP, EINVAL, ENETDOWN and EMSGSIZE\n"
+ " \t\t\terror/s - Packets that failed redirection per second\n\n");
+ }
+
+ if (mask & SAMPLE_EXCEPTION_CNT) {
+ printf(" xdp_exception\tDisplays xdp_exception tracepoint events\n"
+ " \t\tThis can occur due to internal driver errors, unrecognized\n"
+ " \t\tXDP actions and due to explicit user trigger by use of XDP_ABORTED\n"
+ " \t\tEach action is expanded below this field with its count\n"
+ " \t\t\thit/s - Number of times the tracepoint was hit per second\n\n");
+ }
+
+ if (mask & SAMPLE_DEVMAP_XMIT_CNT) {
+ printf(" devmap_xmit\tDisplays devmap_xmit tracepoint events\n"
+ " \t\tThis tracepoint is invoked for successful transmissions on output\n"
+ " \t\tdevice but these statistics are not available for generic XDP mode,\n"
+ " \t\thence they will be omitted from the output when using SKB mode\n"
+ " \t\t\txmit/s - Number of packets that were transmitted per second\n"
+ " \t\t\tdrop/s - Number of packets that failed transmissions per second\n"
+ " \t\t\tdrv_err/s - Number of internal driver errors per second\n"
+ " \t\t\tbulk_avg - Average number of packets processed for each event\n\n");
+ }
+}
+
static const char *elixir_search[NUM_TP] = {
[TP_REDIRECT_CNT] = "_trace_xdp_redirect",
[TP_REDIRECT_MAP_CNT] = "_trace_xdp_redirect_map",
diff --git a/samples/bpf/xdp_sample_user.h b/samples/bpf/xdp_sample_user.h
index 588bd2f15352..41be57d7b663 100644
--- a/samples/bpf/xdp_sample_user.h
+++ b/samples/bpf/xdp_sample_user.h
@@ -169,6 +169,7 @@ void sample_stats_print_cpumap_remote(struct stats_record *stats_rec,
struct stats_record *stats_prev,
unsigned int nr_cpus, char *mprog_name);
void sample_reset_mode(void);
+void sample_print_help(int mask);
const char *get_driver_name(int ifindex);
int get_mac_addr(int ifindex, void *mac_addr);
--
2.31.1
Powered by blists - more mailing lists