Skip to contentSkip to conversation

bpf: Remove trace_printk_lock lock

PATCH Superseded Jiri Olsa 4 participants 5 messages Dec 13, 2022 – Dec 14, 2022

Subsystems (4)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Jiri Olsa

author reviewer
#0 lore raw

PATCH 1/1 bpf: Remove trace_printk_lock lock

Both bpf_trace_printk and bpf_trace_vprintk helpers use static buffer guarded with trace_printk_lock spin lock.

The spin lock contention causes issues with bpf programs attached to contention_begin tracepoint [1] [2].

Andrii suggested we could get rid of the contention by using trylock, but we could actually get rid of the spinlock completely by using percpu buffers the same way as for bin_args in bpf_bprintf_prepare function.

Adding 4 per cpu buffers (1k each) which should be enough for all possible nesting contexts (normal, softirq, irq, nmi) or possible (yet unlikely) probe within the printk helpers.

In very unlikely case we'd run out of the nesting levels the printk will be omitted.

[1] https://lore.kernel.org/bpf/CACkBjsakT_yWxnSWr4r-0TpPvbKm9-OBmVUhJb7hV3hY8fdCkw@mail.gmail.com/
[2] https://lore.kernel.org/bpf/CACkBjsaCsTovQHFfkqJKto6S4Z8d02ud1D7MPESrHa1cVNNTrw@mail.gmail.com/

---
 kernel/trace/bpf_trace.c | 61 +++++++++++++++++++++++++++++++---------
 1 file changed, 47 insertions(+), 14 deletions(-)
kernel/trace/bpf_trace.c +47 -14
index 3bbd3f0c810c..b9287b3a5540 100644
@@ -369,33 +369,62 @@ static const struct bpf_func_proto *bpf_get_probe_write_proto(void)
 	return &bpf_probe_write_user_proto;
 }
 
-static DEFINE_RAW_SPINLOCK(trace_printk_lock);
-
 #define MAX_TRACE_PRINTK_VARARGS	3
 #define BPF_TRACE_PRINTK_SIZE		1024
+#define BPF_TRACE_PRINTK_LEVELS		4
+
+struct trace_printk_buf {
+	char data[BPF_TRACE_PRINTK_LEVELS][BPF_TRACE_PRINTK_SIZE];
+	int level;
+};
+static DEFINE_PER_CPU(struct trace_printk_buf, printk_buf);
+
+static void put_printk_buf(struct trace_printk_buf __percpu *buf)
+{
+	if (WARN_ON_ONCE(this_cpu_read(buf->level) == 0))
+		return;
+	this_cpu_dec(buf->level);
+	preempt_enable();
+}
+
+static bool get_printk_buf(struct trace_printk_buf __percpu *buf, char **data)
+{
+	int level;
+
+	preempt_disable();
+	level = this_cpu_inc_return(buf->level);
+	if (level > BPF_TRACE_PRINTK_LEVELS) {
+		put_printk_buf(buf);
+		return false;
+	}
+	*data = (char *) this_cpu_ptr(&buf->data[level - 1]);
+	return true;
+}
 
 BPF_CALL_5(bpf_trace_printk, char *, fmt, u32, fmt_size, u64, arg1,
 	   u64, arg2, u64, arg3)
 {
 	u64 args[MAX_TRACE_PRINTK_VARARGS] = { arg1, arg2, arg3 };
 	u32 *bin_args;
-	static char buf[BPF_TRACE_PRINTK_SIZE];
-	unsigned long flags;
+	char *buf;
 	int ret;
 
+	if (!get_printk_buf(&printk_buf, &buf))
+		return -EBUSY;
+
 	ret = bpf_bprintf_prepare(fmt, fmt_size, args, &bin_args,
 				  MAX_TRACE_PRINTK_VARARGS);
 	if (ret < 0)
-		return ret;
+		goto out;
 
-	raw_spin_lock_irqsave(&trace_printk_lock, flags);
-	ret = bstr_printf(buf, sizeof(buf), fmt, bin_args);
+	ret = bstr_printf(buf, BPF_TRACE_PRINTK_SIZE, fmt, bin_args);
 
 	trace_bpf_trace_printk(buf);
-	raw_spin_unlock_irqrestore(&trace_printk_lock, flags);
 
 	bpf_bprintf_cleanup();
 
+out:
+	put_printk_buf(&printk_buf);
 	return ret;
 }
 
@@ -427,31 +456,35 @@ const struct bpf_func_proto *bpf_get_trace_printk_proto(void)
 	return &bpf_trace_printk_proto;
 }
 
+static DEFINE_PER_CPU(struct trace_printk_buf, vprintk_buf);
+
 BPF_CALL_4(bpf_trace_vprintk, char *, fmt, u32, fmt_size, const void *, data,
 	   u32, data_len)
 {
-	static char buf[BPF_TRACE_PRINTK_SIZE];
-	unsigned long flags;
 	int ret, num_args;
 	u32 *bin_args;
+	char *buf;
 
 	if (data_len & 7 || data_len > MAX_BPRINTF_VARARGS * 8 ||
 	    (data_len && !data))
 		return -EINVAL;
 	num_args = data_len / 8;
 
+	if (!get_printk_buf(&vprintk_buf, &buf))
+		return -EBUSY;
+
 	ret = bpf_bprintf_prepare(fmt, fmt_size, data, &bin_args, num_args);
 	if (ret < 0)
-		return ret;
+		goto out;
 
-	raw_spin_lock_irqsave(&trace_printk_lock, flags);
-	ret = bstr_printf(buf, sizeof(buf), fmt, bin_args);
+	ret = bstr_printf(buf, BPF_TRACE_PRINTK_SIZE, fmt, bin_args);
 
 	trace_bpf_trace_printk(buf);
-	raw_spin_unlock_irqrestore(&trace_printk_lock, flags);
 
 	bpf_bprintf_cleanup();
 
+out:
+	put_printk_buf(&vprintk_buf);
 	return ret;
 }
 
Signature · 1 line
2.38.1
maintainer
#1 lore raw
Quoted 52 lines · Jiri Olsa

Both bpf_trace_printk and bpf_trace_vprintk helpers use static buffer guarded with trace_printk_lock spin lock.

The spin lock contention causes issues with bpf programs attached to contention_begin tracepoint [1] [2].

Andrii suggested we could get rid of the contention by using trylock, but we could actually get rid of the spinlock completely by using percpu buffers the same way as for bin_args in bpf_bprintf_prepare function.

Adding 4 per cpu buffers (1k each) which should be enough for all possible nesting contexts (normal, softirq, irq, nmi) or possible (yet unlikely) probe within the printk helpers.

In very unlikely case we'd run out of the nesting levels the printk will be omitted.

[1] https://lore.kernel.org/bpf/CACkBjsakT_yWxnSWr4r-0TpPvbKm9-OBmVUhJb7hV3hY8fdCkw@mail.gmail.com/
[2] https://lore.kernel.org/bpf/CACkBjsaCsTovQHFfkqJKto6S4Z8d02ud1D7MPESrHa1cVNNTrw@mail.gmail.com/

---
 kernel/trace/bpf_trace.c | 61 +++++++++++++++++++++++++++++++---------
 1 file changed, 47 insertions(+), 14 deletions(-)
kernel/trace/bpf_trace.c +11 -2
index 3bbd3f0c810c..b9287b3a5540 100644
@@ -369,33 +369,62 @@ static const struct bpf_func_proto *bpf_get_probe_write_proto(void)
        return &bpf_probe_write_user_proto;
 }
 
-static DEFINE_RAW_SPINLOCK(trace_printk_lock);
-
 #define MAX_TRACE_PRINTK_VARARGS       3
 #define BPF_TRACE_PRINTK_SIZE          1024
+#define BPF_TRACE_PRINTK_LEVELS                4
+
+struct trace_printk_buf {
+       char data[BPF_TRACE_PRINTK_LEVELS][BPF_TRACE_PRINTK_SIZE];
+       int level;
+};
+static DEFINE_PER_CPU(struct trace_printk_buf, printk_buf);
+
+static void put_printk_buf(struct trace_printk_buf __percpu *buf)
+{
+       if (WARN_ON_ONCE(this_cpu_read(buf->level) == 0))

kernel/trace/bpf_trace.c static const struct bpf_func_proto *bpf_get_probe_write_proto(void) · line 394

Quoted 10 lines
kernel/trace/bpf_trace.c +10 -0
+               return;
+       this_cpu_dec(buf->level);
+       preempt_enable();
+}
+
+static bool get_printk_buf(struct trace_printk_buf __percpu *buf, char **data)
+{
+       int level;
+
+       preempt_disable();

Can we use migrate_disable() instead?

kernel/trace/bpf_trace.c static const struct bpf_func_proto *bpf_get_probe_write_proto(void) · line 396

Quoted 2 lines
kernel/trace/bpf_trace.c +2 -0
+       level = this_cpu_inc_return(buf->level);
+       if (level > BPF_TRACE_PRINTK_LEVELS) {

Maybe add WARN_ON_ONCE() here?

Thanks,
Song

[...]

#2 lore raw
Quoted 57 lines · Song Liu
Quoted 56 lines · Jiri Olsa

Both bpf_trace_printk and bpf_trace_vprintk helpers use static buffer guarded with trace_printk_lock spin lock.

The spin lock contention causes issues with bpf programs attached to contention_begin tracepoint [1] [2].

Andrii suggested we could get rid of the contention by using trylock, but we could actually get rid of the spinlock completely by using percpu buffers the same way as for bin_args in bpf_bprintf_prepare function.

Adding 4 per cpu buffers (1k each) which should be enough for all possible nesting contexts (normal, softirq, irq, nmi) or possible (yet unlikely) probe within the printk helpers.

In very unlikely case we'd run out of the nesting levels the printk will be omitted.

[1] https://lore.kernel.org/bpf/CACkBjsakT_yWxnSWr4r-0TpPvbKm9-OBmVUhJb7hV3hY8fdCkw@mail.gmail.com/
[2] https://lore.kernel.org/bpf/CACkBjsaCsTovQHFfkqJKto6S4Z8d02ud1D7MPESrHa1cVNNTrw@mail.gmail.com/

---
 kernel/trace/bpf_trace.c | 61 +++++++++++++++++++++++++++++++---------
 1 file changed, 47 insertions(+), 14 deletions(-)
kernel/trace/bpf_trace.c +15 -2
index 3bbd3f0c810c..b9287b3a5540 100644
@@ -369,33 +369,62 @@ static const struct bpf_func_proto *bpf_get_probe_write_proto(void)
        return &bpf_probe_write_user_proto;
 }
 
-static DEFINE_RAW_SPINLOCK(trace_printk_lock);
-
 #define MAX_TRACE_PRINTK_VARARGS       3
 #define BPF_TRACE_PRINTK_SIZE          1024
+#define BPF_TRACE_PRINTK_LEVELS                4
+
+struct trace_printk_buf {
+       char data[BPF_TRACE_PRINTK_LEVELS][BPF_TRACE_PRINTK_SIZE];
+       int level;
+};
+static DEFINE_PER_CPU(struct trace_printk_buf, printk_buf);
+
+static void put_printk_buf(struct trace_printk_buf __percpu *buf)
+{
+       if (WARN_ON_ONCE(this_cpu_read(buf->level) == 0))
+               return;
+       this_cpu_dec(buf->level);
+       preempt_enable();
+}
Quoted 8 lines

kernel/trace/bpf_trace.c static const struct bpf_func_proto *bpf_get_probe_write_proto(void) · line 394

Quoted 6 lines
kernel/trace/bpf_trace.c +6 -0
+
+static bool get_printk_buf(struct trace_printk_buf __percpu *buf, char **data)
+{
+       int level;
+
+       preempt_disable();

Can we use migrate_disable() instead?

I think that should work.. while checking on that I found comment in in include/linux/preempt.h (though dated):

The end goal must be to get rid of migrate_disable

but looks like both should work here and there are trade offs for using each of them

Quoted 5 lines

kernel/trace/bpf_trace.c static const struct bpf_func_proto *bpf_get_probe_write_proto(void) · line 396

Quoted 3 lines
kernel/trace/bpf_trace.c +2 -0
+       level = this_cpu_inc_return(buf->level);
+       if (level > BPF_TRACE_PRINTK_LEVELS) {

Maybe add WARN_ON_ONCE() here?

ok, will add

thanks,
jirka

#3 lore raw
Quoted 21 lines · Jiri Olsa
Quoted 20 lines · Song Liu
Quoted 19 lines · Jiri Olsa

Both bpf_trace_printk and bpf_trace_vprintk helpers use static buffer guarded with trace_printk_lock spin lock.

The spin lock contention causes issues with bpf programs attached to contention_begin tracepoint [1] [2].

Andrii suggested we could get rid of the contention by using trylock, but we could actually get rid of the spinlock completely by using percpu buffers the same way as for bin_args in bpf_bprintf_prepare function.

Adding 4 per cpu buffers (1k each) which should be enough for all possible nesting contexts (normal, softirq, irq, nmi) or possible (yet unlikely) probe within the printk helpers.

In very unlikely case we'd run out of the nesting levels the printk will be omitted.

Quoted 6 lines
Quoted 6 lines
Quoted 6 lines

[1] https://lore.kernel.org/bpf/CACkBjsakT_yWxnSWr4r-0TpPvbKm9-OBmVUhJb7hV3hY8fdCkw@mail.gmail.com/
[2] https://lore.kernel.org/bpf/CACkBjsaCsTovQHFfkqJKto6S4Z8d02ud1D7MPESrHa1cVNNTrw@mail.gmail.com/

Maybe change to subject to 'Remove trace_printk_lock' instead of 'Remove trace_printk_lock lock'? The 'trace_printk_lock' should already imply 'lock'?

Quoted 40 lines
Quoted 31 lines
Quoted 31 lines
---
  kernel/trace/bpf_trace.c | 61 +++++++++++++++++++++++++++++++---------
  1 file changed, 47 insertions(+), 14 deletions(-)
kernel/trace/bpf_trace.c +15 -2
index 3bbd3f0c810c..b9287b3a5540 100644
@@ -369,33 +369,62 @@ static const struct bpf_func_proto *bpf_get_probe_write_proto(void)
         return &bpf_probe_write_user_proto;
  }
 
-static DEFINE_RAW_SPINLOCK(trace_printk_lock);
-
  #define MAX_TRACE_PRINTK_VARARGS       3
  #define BPF_TRACE_PRINTK_SIZE          1024
+#define BPF_TRACE_PRINTK_LEVELS                4
+
+struct trace_printk_buf {
+       char data[BPF_TRACE_PRINTK_LEVELS][BPF_TRACE_PRINTK_SIZE];
+       int level;
+};
+static DEFINE_PER_CPU(struct trace_printk_buf, printk_buf);
+
+static void put_printk_buf(struct trace_printk_buf __percpu *buf)
+{
+       if (WARN_ON_ONCE(this_cpu_read(buf->level) == 0))
+               return;
+       this_cpu_dec(buf->level);
+       preempt_enable();
+}
Quoted 8 lines

kernel/trace/bpf_trace.c static const struct bpf_func_proto *bpf_get_probe_write_proto(void) · line 394

Quoted 6 lines
kernel/trace/bpf_trace.c +6 -0
+
+static bool get_printk_buf(struct trace_printk_buf __percpu *buf, char **data)
+{
+       int level;
+
+       preempt_disable();

Can we use migrate_disable() instead?

Quoted 2 lines

I think that should work.. while checking on that I found comment in in include/linux/preempt.h (though dated):

I am not sure about whether migrate_disable() will work. For example,
. task1 takes over level=0 buffer, level = 1
. task1 yields to task2 with preemption in the same cpu . task2 takes over level=1 buffer, level = 2
. task2 yields to task1 in the same cpu
. task1 releases the buffer, level = 1
. task1 yields to task3 in the same cpu
. task3 takes over level=1 buffer, level = 2

    <=== we have an issue here, both task2 and task3 use level=1 buffer.
Quoted 16 lines

The end goal must be to get rid of migrate_disable

but looks like both should work here and there are trade offs for using each of them

Quoted 5 lines

kernel/trace/bpf_trace.c static const struct bpf_func_proto *bpf_get_probe_write_proto(void) · line 396

Quoted 3 lines
kernel/trace/bpf_trace.c +2 -0
+       level = this_cpu_inc_return(buf->level);
+       if (level > BPF_TRACE_PRINTK_LEVELS) {

Maybe add WARN_ON_ONCE() here?

ok, will add

thanks,
jirka

#4 lore raw
Quoted 27 lines · Yonghong Song
Quoted 24 lines · Jiri Olsa
Quoted 23 lines · Song Liu
Quoted 22 lines · Jiri Olsa

Both bpf_trace_printk and bpf_trace_vprintk helpers use static buffer guarded with trace_printk_lock spin lock.

The spin lock contention causes issues with bpf programs attached to contention_begin tracepoint [1] [2].

Andrii suggested we could get rid of the contention by using trylock, but we could actually get rid of the spinlock completely by using percpu buffers the same way as for bin_args in bpf_bprintf_prepare function.

Adding 4 per cpu buffers (1k each) which should be enough for all possible nesting contexts (normal, softirq, irq, nmi) or possible (yet unlikely) probe within the printk helpers.

In very unlikely case we'd run out of the nesting levels the printk will be omitted.

[1] https://lore.kernel.org/bpf/CACkBjsakT_yWxnSWr4r-0TpPvbKm9-OBmVUhJb7hV3hY8fdCkw@mail.gmail.com/
[2] https://lore.kernel.org/bpf/CACkBjsaCsTovQHFfkqJKto6S4Z8d02ud1D7MPESrHa1cVNNTrw@mail.gmail.com/

Quoted 7 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines

Maybe change to subject to 'Remove trace_printk_lock' instead of 'Remove trace_printk_lock lock'? The 'trace_printk_lock' should already imply 'lock'?

ok

Quoted 52 lines
Quoted 41 lines
Quoted 32 lines
Quoted 32 lines
---
  kernel/trace/bpf_trace.c | 61 +++++++++++++++++++++++++++++++---------
  1 file changed, 47 insertions(+), 14 deletions(-)
kernel/trace/bpf_trace.c +15 -2
index 3bbd3f0c810c..b9287b3a5540 100644
@@ -369,33 +369,62 @@ static const struct bpf_func_proto *bpf_get_probe_write_proto(void)
         return &bpf_probe_write_user_proto;
  }
 
-static DEFINE_RAW_SPINLOCK(trace_printk_lock);
-
  #define MAX_TRACE_PRINTK_VARARGS       3
  #define BPF_TRACE_PRINTK_SIZE          1024
+#define BPF_TRACE_PRINTK_LEVELS                4
+
+struct trace_printk_buf {
+       char data[BPF_TRACE_PRINTK_LEVELS][BPF_TRACE_PRINTK_SIZE];
+       int level;
+};
+static DEFINE_PER_CPU(struct trace_printk_buf, printk_buf);
+
+static void put_printk_buf(struct trace_printk_buf __percpu *buf)
+{
+       if (WARN_ON_ONCE(this_cpu_read(buf->level) == 0))
+               return;
+       this_cpu_dec(buf->level);
+       preempt_enable();
+}
Quoted 8 lines

kernel/trace/bpf_trace.c static const struct bpf_func_proto *bpf_get_probe_write_proto(void) · line 394

Quoted 6 lines
kernel/trace/bpf_trace.c +6 -0
+
+static bool get_printk_buf(struct trace_printk_buf __percpu *buf, char **data)
+{
+       int level;
+
+       preempt_disable();

Can we use migrate_disable() instead?

Quoted 2 lines

I think that should work.. while checking on that I found comment in in include/linux/preempt.h (though dated):

I am not sure about whether migrate_disable() will work. For example,
. task1 takes over level=0 buffer, level = 1
. task1 yields to task2 with preemption in the same cpu . task2 takes over level=1 buffer, level = 2
. task2 yields to task1 in the same cpu
. task1 releases the buffer, level = 1
. task1 yields to task3 in the same cpu
. task3 takes over level=1 buffer, level = 2

Quoted 1 line
    <=== we have an issue here, both task2 and task3 use level=1 buffer.

hum, did not think of that.. will keep the preempt_disable then

thanks,
jirka

Quoted 17 lines
Quoted 17 lines

The end goal must be to get rid of migrate_disable

but looks like both should work here and there are trade offs for using each of them

Quoted 5 lines

kernel/trace/bpf_trace.c static const struct bpf_func_proto *bpf_get_probe_write_proto(void) · line 396

Quoted 3 lines
kernel/trace/bpf_trace.c +2 -0
+       level = this_cpu_inc_return(buf->level);
+       if (level > BPF_TRACE_PRINTK_LEVELS) {

Maybe add WARN_ON_ONCE() here?

ok, will add

thanks,
jirka