* [PATCH v9 0/7] Improve the copy of task comm
@ 2024-10-07 14:49 Yafang Shao
2024-10-07 14:49 ` [PATCH v9 1/7] Get rid of __get_task_comm() Yafang Shao
` (6 more replies)
0 siblings, 7 replies; 8+ messages in thread
From: Yafang Shao @ 2024-10-07 14:49 UTC (permalink / raw)
To: akpm
Cc: torvalds, keescook, alx, justinstitt, ebiederm,
alexei.starovoitov, rostedt, catalin.marinas, penguin-kernel,
linux-mm, linux-fsdevel, linux-trace-kernel, audit,
linux-security-module, selinux, bpf, netdev, dri-devel,
Yafang Shao
Using {memcpy,strncpy,strcpy,kstrdup} to copy the task comm relies on the
length of task comm. Changes in the task comm could result in a destination
string that is overflow. Therefore, we should explicitly ensure the
destination string is always NUL-terminated, regardless of the task comm.
This approach will facilitate future extensions to the task comm.
As suggested by Linus [0], we can identify all relevant code with the
following git grep command:
git grep 'memcpy.*->comm\>'
git grep 'kstrdup.*->comm\>'
git grep 'strncpy.*->comm\>'
git grep 'strcpy.*->comm\>'
PATCH #2~#4: memcpy
PATCH #5~#6: kstrdup
PATCH #7: strcpy
Please note that strncpy() is not included in this series as it is being
tracked by another effort. [1]
task_lock() is removed from get_task_comm() as it is unnecessary.
Suggested-by: Linus Torvalds <torvalds@linux-foundation.org>
Link: https://lore.kernel.org/all/CAHk-=wjAmmHUg6vho1KjzQi2=psR30+CogFd4aXrThr2gsiS4g@mail.gmail.com/ [0]
Changes:
v8->v9:
- Keep the BUILD_BUG_ON() in get_task_comm() (Kees)
- Keep strscpy_pad() in get_task_comm() (Kees)
- Replace more strcpy() with strscpy() in
drivers/gpu/drm/i915/i915_gpu_error.c (Justin)
- Fix typos and commit improvement in patch #5 (Andy)
- Drop the change in net as it was fixed by
b19f69a95830 ("net/ipv6: replace deprecated strcpy with strscpy")
v7->v8: https://lore.kernel.org/all/20240828030321.20688-1-laoar.shao@gmail.com/
- Avoid '+1' and '-1' in string copy. (Alejandro)
v6->v7: https://lore.kernel.org/all/20240817025624.13157-1-laoar.shao@gmail.com/
- Improve the comment (Alejandro)
- Drop strncpy as it is being tracked by another effort (Justin)
https://github.com/KSPP/linux/issues/90 [1]
v5->v6: https://lore.kernel.org/linux-mm/20240812022933.69850-1-laoar.shao@gmail.com/
- Get rid of __get_task_comm() (Linus)
- Use ARRAY_SIZE() in get_task_comm() (Alejandro)
v4->v5: https://lore.kernel.org/all/20240804075619.20804-1-laoar.shao@gmail.com/
- Drop changes in the mm/kmemleak.c as it was fixed by
commit 0b84780134fb ("mm/kmemleak: replace strncpy() with strscpy()")
- Drop changes in kernel/tsacct.c as it was fixed by
commit 0fe2356434e ("tsacct: replace strncpy() with strscpy()")
v3->v4: https://lore.kernel.org/linux-mm/20240729023719.1933-1-laoar.shao@gmail.com/
- Rename __kstrndup() to __kmemdup_nul() and define it inside mm/util.c
(Matthew)
- Remove unused local variable (Simon)
v2->v3: https://lore.kernel.org/all/20240621022959.9124-1-laoar.shao@gmail.com/
- Deduplicate code around kstrdup (Andrew)
- Add commit log for dropping task_lock (Catalin)
v1->v2: https://lore.kernel.org/bpf/20240613023044.45873-1-laoar.shao@gmail.com/
- Add comment for dropping task_lock() in __get_task_comm() (Alexei)
- Drop changes in trace event (Steven)
- Fix comment on task comm (Matus)
v1: https://lore.kernel.org/all/20240602023754.25443-1-laoar.shao@gmail.com/
Yafang Shao (7):
Get rid of __get_task_comm()
auditsc: Replace memcpy() with strscpy()
security: Replace memcpy() with get_task_comm()
bpftool: Ensure task comm is always NUL-terminated
mm/util: Fix possible race condition in kstrdup()
mm/util: Deduplicate code in {kstrdup,kstrndup,kmemdup_nul}
drm: Replace strcpy() with strscpy()
drivers/gpu/drm/drm_framebuffer.c | 2 +-
drivers/gpu/drm/i915/i915_gpu_error.c | 6 +--
fs/exec.c | 10 -----
fs/proc/array.c | 2 +-
include/linux/sched.h | 28 +++++++++---
kernel/auditsc.c | 6 +--
kernel/kthread.c | 2 +-
mm/util.c | 62 ++++++++++++---------------
security/lsm_audit.c | 4 +-
security/selinux/selinuxfs.c | 2 +-
tools/bpf/bpftool/pids.c | 2 +
11 files changed, 63 insertions(+), 63 deletions(-)
--
2.43.5
^ permalink raw reply [flat|nested] 8+ messages in thread
* [PATCH v9 1/7] Get rid of __get_task_comm()
2024-10-07 14:49 [PATCH v9 0/7] Improve the copy of task comm Yafang Shao
@ 2024-10-07 14:49 ` Yafang Shao
2024-10-07 14:49 ` [PATCH v9 2/7] auditsc: Replace memcpy() with strscpy() Yafang Shao
` (5 subsequent siblings)
6 siblings, 0 replies; 8+ messages in thread
From: Yafang Shao @ 2024-10-07 14:49 UTC (permalink / raw)
To: akpm
Cc: torvalds, keescook, alx, justinstitt, ebiederm,
alexei.starovoitov, rostedt, catalin.marinas, penguin-kernel,
linux-mm, linux-fsdevel, linux-trace-kernel, audit,
linux-security-module, selinux, bpf, netdev, dri-devel,
Yafang Shao, Alexander Viro, Christian Brauner, Jan Kara,
Matus Jokay, Serge E. Hallyn
We want to eliminate the use of __get_task_comm() for the following
reasons:
- The task_lock() is unnecessary
Quoted from Linus [0]:
: Since user space can randomly change their names anyway, using locking
: was always wrong for readers (for writers it probably does make sense
: to have some lock - although practically speaking nobody cares there
: either, but at least for a writer some kind of race could have
: long-term mixed results
Suggested-by: Linus Torvalds <torvalds@linux-foundation.org>
Link: https://lore.kernel.org/all/CAHk-=wivfrF0_zvf+oj6==Sh=-npJooP8chLPEfaFV0oNYTTBA@mail.gmail.com [0]
Link: https://lore.kernel.org/all/CAHk-=whWtUC-AjmGJveAETKOMeMFSTwKwu99v7+b6AyHMmaDFA@mail.gmail.com/
Signed-off-by: Yafang Shao <laoar.shao@gmail.com>
Cc: Alexander Viro <viro@zeniv.linux.org.uk>
Cc: Christian Brauner <brauner@kernel.org>
Cc: Jan Kara <jack@suse.cz>
Cc: Eric Biederman <ebiederm@xmission.com>
Cc: Kees Cook <keescook@chromium.org>
Cc: Alexei Starovoitov <alexei.starovoitov@gmail.com>
Cc: Matus Jokay <matus.jokay@stuba.sk>
Cc: Alejandro Colomar <alx@kernel.org>
Cc: "Serge E. Hallyn" <serge@hallyn.com>
---
fs/exec.c | 10 ----------
fs/proc/array.c | 2 +-
include/linux/sched.h | 28 ++++++++++++++++++++++------
kernel/kthread.c | 2 +-
4 files changed, 24 insertions(+), 18 deletions(-)
diff --git a/fs/exec.c b/fs/exec.c
index 6c53920795c2..77364806b48d 100644
--- a/fs/exec.c
+++ b/fs/exec.c
@@ -1189,16 +1189,6 @@ static int unshare_sighand(struct task_struct *me)
return 0;
}
-char *__get_task_comm(char *buf, size_t buf_size, struct task_struct *tsk)
-{
- task_lock(tsk);
- /* Always NUL terminated and zero-padded */
- strscpy_pad(buf, tsk->comm, buf_size);
- task_unlock(tsk);
- return buf;
-}
-EXPORT_SYMBOL_GPL(__get_task_comm);
-
/*
* These functions flushes out all traces of the currently running executable
* so that a new one can be started
diff --git a/fs/proc/array.c b/fs/proc/array.c
index 34a47fb0c57f..55ed3510d2bb 100644
--- a/fs/proc/array.c
+++ b/fs/proc/array.c
@@ -109,7 +109,7 @@ void proc_task_name(struct seq_file *m, struct task_struct *p, bool escape)
else if (p->flags & PF_KTHREAD)
get_kthread_comm(tcomm, sizeof(tcomm), p);
else
- __get_task_comm(tcomm, sizeof(tcomm), p);
+ get_task_comm(tcomm, p);
if (escape)
seq_escape_str(m, tcomm, ESCAPE_SPACE | ESCAPE_SPECIAL, "\n\\");
diff --git a/include/linux/sched.h b/include/linux/sched.h
index e6ee4258169a..28f92c637abf 100644
--- a/include/linux/sched.h
+++ b/include/linux/sched.h
@@ -1121,9 +1121,12 @@ struct task_struct {
/*
* executable name, excluding path.
*
- * - normally initialized setup_new_exec()
- * - access it with [gs]et_task_comm()
- * - lock it with task_lock()
+ * - normally initialized begin_new_exec()
+ * - set it with set_task_comm()
+ * - strscpy_pad() to ensure it is always NUL-terminated and
+ * zero-padded
+ * - task_lock() to ensure the operation is atomic and the name is
+ * fully updated.
*/
char comm[TASK_COMM_LEN];
@@ -1938,10 +1941,23 @@ static inline void set_task_comm(struct task_struct *tsk, const char *from)
__set_task_comm(tsk, from, false);
}
-extern char *__get_task_comm(char *to, size_t len, struct task_struct *tsk);
+/*
+ * - Why not use task_lock()?
+ * User space can randomly change their names anyway, so locking for readers
+ * doesn't make sense. For writers, locking is probably necessary, as a race
+ * condition could lead to long-term mixed results.
+ * The strscpy_pad() in __set_task_comm() can ensure that the task comm is
+ * always NUL-terminated and zero-padded. Therefore the race condition between
+ * reader and writer is not an issue.
+ *
+ * - BUILD_BUG_ON() can help prevent the buf from being truncated.
+ * Since the callers don't perform any return value checks, this safeguard is
+ * necessary.
+ */
#define get_task_comm(buf, tsk) ({ \
- BUILD_BUG_ON(sizeof(buf) != TASK_COMM_LEN); \
- __get_task_comm(buf, sizeof(buf), tsk); \
+ BUILD_BUG_ON(sizeof(buf) < TASK_COMM_LEN); \
+ strscpy_pad(buf, (tsk)->comm); \
+ buf; \
})
#ifdef CONFIG_SMP
diff --git a/kernel/kthread.c b/kernel/kthread.c
index db4ceb0f503c..74d20f46fa30 100644
--- a/kernel/kthread.c
+++ b/kernel/kthread.c
@@ -101,7 +101,7 @@ void get_kthread_comm(char *buf, size_t buf_size, struct task_struct *tsk)
struct kthread *kthread = to_kthread(tsk);
if (!kthread || !kthread->full_name) {
- __get_task_comm(buf, buf_size, tsk);
+ strscpy(buf, tsk->comm, buf_size);
return;
}
--
2.43.5
^ permalink raw reply related [flat|nested] 8+ messages in thread
* [PATCH v9 2/7] auditsc: Replace memcpy() with strscpy()
2024-10-07 14:49 [PATCH v9 0/7] Improve the copy of task comm Yafang Shao
2024-10-07 14:49 ` [PATCH v9 1/7] Get rid of __get_task_comm() Yafang Shao
@ 2024-10-07 14:49 ` Yafang Shao
2024-10-07 14:49 ` [PATCH v9 3/7] security: Replace memcpy() with get_task_comm() Yafang Shao
` (4 subsequent siblings)
6 siblings, 0 replies; 8+ messages in thread
From: Yafang Shao @ 2024-10-07 14:49 UTC (permalink / raw)
To: akpm
Cc: torvalds, keescook, alx, justinstitt, ebiederm,
alexei.starovoitov, rostedt, catalin.marinas, penguin-kernel,
linux-mm, linux-fsdevel, linux-trace-kernel, audit,
linux-security-module, selinux, bpf, netdev, dri-devel,
Yafang Shao, Paul Moore, Eric Paris
Using strscpy() to read the task comm ensures that the name is
always NUL-terminated, regardless of the source string. This approach also
facilitates future extensions to the task comm.
Signed-off-by: Yafang Shao <laoar.shao@gmail.com>
Acked-by: Paul Moore <paul@paul-moore.com>
Reviewed-by: Justin Stitt <justinstitt@google.com>
Cc: Eric Paris <eparis@redhat.com>
---
kernel/auditsc.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/kernel/auditsc.c b/kernel/auditsc.c
index cd57053b4a69..7adc67d5aafb 100644
--- a/kernel/auditsc.c
+++ b/kernel/auditsc.c
@@ -2730,7 +2730,7 @@ void __audit_ptrace(struct task_struct *t)
context->target_uid = task_uid(t);
context->target_sessionid = audit_get_sessionid(t);
security_task_getsecid_obj(t, &context->target_sid);
- memcpy(context->target_comm, t->comm, TASK_COMM_LEN);
+ strscpy(context->target_comm, t->comm);
}
/**
@@ -2757,7 +2757,7 @@ int audit_signal_info_syscall(struct task_struct *t)
ctx->target_uid = t_uid;
ctx->target_sessionid = audit_get_sessionid(t);
security_task_getsecid_obj(t, &ctx->target_sid);
- memcpy(ctx->target_comm, t->comm, TASK_COMM_LEN);
+ strscpy(ctx->target_comm, t->comm);
return 0;
}
@@ -2778,7 +2778,7 @@ int audit_signal_info_syscall(struct task_struct *t)
axp->target_uid[axp->pid_count] = t_uid;
axp->target_sessionid[axp->pid_count] = audit_get_sessionid(t);
security_task_getsecid_obj(t, &axp->target_sid[axp->pid_count]);
- memcpy(axp->target_comm[axp->pid_count], t->comm, TASK_COMM_LEN);
+ strscpy(axp->target_comm[axp->pid_count], t->comm);
axp->pid_count++;
return 0;
--
2.43.5
^ permalink raw reply related [flat|nested] 8+ messages in thread
* [PATCH v9 3/7] security: Replace memcpy() with get_task_comm()
2024-10-07 14:49 [PATCH v9 0/7] Improve the copy of task comm Yafang Shao
2024-10-07 14:49 ` [PATCH v9 1/7] Get rid of __get_task_comm() Yafang Shao
2024-10-07 14:49 ` [PATCH v9 2/7] auditsc: Replace memcpy() with strscpy() Yafang Shao
@ 2024-10-07 14:49 ` Yafang Shao
2024-10-07 14:49 ` [PATCH v9 4/7] bpftool: Ensure task comm is always NUL-terminated Yafang Shao
` (3 subsequent siblings)
6 siblings, 0 replies; 8+ messages in thread
From: Yafang Shao @ 2024-10-07 14:49 UTC (permalink / raw)
To: akpm
Cc: torvalds, keescook, alx, justinstitt, ebiederm,
alexei.starovoitov, rostedt, catalin.marinas, penguin-kernel,
linux-mm, linux-fsdevel, linux-trace-kernel, audit,
linux-security-module, selinux, bpf, netdev, dri-devel,
Yafang Shao, Paul Moore, James Morris, Serge E. Hallyn,
Stephen Smalley, Ondrej Mosnacek
Quoted from Linus [0]:
selinux never wanted a lock, and never wanted any kind of *consistent*
result, it just wanted a *stable* result.
Using get_task_comm() to read the task comm ensures that the name is
always NUL-terminated, regardless of the source string. This approach also
facilitates future extensions to the task comm.
Signed-off-by: Yafang Shao <laoar.shao@gmail.com>
LINK: https://lore.kernel.org/all/CAHk-=wivfrF0_zvf+oj6==Sh=-npJooP8chLPEfaFV0oNYTTBA@mail.gmail.com/ [0]
Acked-by: Paul Moore <paul@paul-moore.com>
Cc: James Morris <jmorris@namei.org>
Cc: "Serge E. Hallyn" <serge@hallyn.com>
Cc: Stephen Smalley <stephen.smalley.work@gmail.com>
Cc: Ondrej Mosnacek <omosnace@redhat.com>
---
security/lsm_audit.c | 4 ++--
security/selinux/selinuxfs.c | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/security/lsm_audit.c b/security/lsm_audit.c
index 849e832719e2..9a8352972086 100644
--- a/security/lsm_audit.c
+++ b/security/lsm_audit.c
@@ -207,7 +207,7 @@ static void dump_common_audit_data(struct audit_buffer *ab,
BUILD_BUG_ON(sizeof(a->u) > sizeof(void *)*2);
audit_log_format(ab, " pid=%d comm=", task_tgid_nr(current));
- audit_log_untrustedstring(ab, memcpy(comm, current->comm, sizeof(comm)));
+ audit_log_untrustedstring(ab, get_task_comm(comm, current));
switch (a->type) {
case LSM_AUDIT_DATA_NONE:
@@ -302,7 +302,7 @@ static void dump_common_audit_data(struct audit_buffer *ab,
char comm[sizeof(tsk->comm)];
audit_log_format(ab, " opid=%d ocomm=", pid);
audit_log_untrustedstring(ab,
- memcpy(comm, tsk->comm, sizeof(comm)));
+ get_task_comm(comm, tsk));
}
}
break;
diff --git a/security/selinux/selinuxfs.c b/security/selinux/selinuxfs.c
index e172f182b65c..c9b05be27ddb 100644
--- a/security/selinux/selinuxfs.c
+++ b/security/selinux/selinuxfs.c
@@ -708,7 +708,7 @@ static ssize_t sel_write_checkreqprot(struct file *file, const char __user *buf,
if (new_value) {
char comm[sizeof(current->comm)];
- memcpy(comm, current->comm, sizeof(comm));
+ strscpy(comm, current->comm);
pr_err("SELinux: %s (%d) set checkreqprot to 1. This is no longer supported.\n",
comm, current->pid);
}
--
2.43.5
^ permalink raw reply related [flat|nested] 8+ messages in thread
* [PATCH v9 4/7] bpftool: Ensure task comm is always NUL-terminated
2024-10-07 14:49 [PATCH v9 0/7] Improve the copy of task comm Yafang Shao
` (2 preceding siblings ...)
2024-10-07 14:49 ` [PATCH v9 3/7] security: Replace memcpy() with get_task_comm() Yafang Shao
@ 2024-10-07 14:49 ` Yafang Shao
2024-10-07 14:49 ` [PATCH v9 5/7] mm/util: Fix possible race condition in kstrdup() Yafang Shao
` (2 subsequent siblings)
6 siblings, 0 replies; 8+ messages in thread
From: Yafang Shao @ 2024-10-07 14:49 UTC (permalink / raw)
To: akpm
Cc: torvalds, keescook, alx, justinstitt, ebiederm,
alexei.starovoitov, rostedt, catalin.marinas, penguin-kernel,
linux-mm, linux-fsdevel, linux-trace-kernel, audit,
linux-security-module, selinux, bpf, netdev, dri-devel,
Yafang Shao, Quentin Monnet
Let's explicitly ensure the destination string is NUL-terminated. This way,
it won't be affected by changes to the source string.
Signed-off-by: Yafang Shao <laoar.shao@gmail.com>
Reviewed-by: Quentin Monnet <qmo@kernel.org>
---
tools/bpf/bpftool/pids.c | 2 ++
1 file changed, 2 insertions(+)
diff --git a/tools/bpf/bpftool/pids.c b/tools/bpf/bpftool/pids.c
index 9b898571b49e..23f488cf1740 100644
--- a/tools/bpf/bpftool/pids.c
+++ b/tools/bpf/bpftool/pids.c
@@ -54,6 +54,7 @@ static void add_ref(struct hashmap *map, struct pid_iter_entry *e)
ref = &refs->refs[refs->ref_cnt];
ref->pid = e->pid;
memcpy(ref->comm, e->comm, sizeof(ref->comm));
+ ref->comm[sizeof(ref->comm) - 1] = '\0';
refs->ref_cnt++;
return;
@@ -77,6 +78,7 @@ static void add_ref(struct hashmap *map, struct pid_iter_entry *e)
ref = &refs->refs[0];
ref->pid = e->pid;
memcpy(ref->comm, e->comm, sizeof(ref->comm));
+ ref->comm[sizeof(ref->comm) - 1] = '\0';
refs->ref_cnt = 1;
refs->has_bpf_cookie = e->has_bpf_cookie;
refs->bpf_cookie = e->bpf_cookie;
--
2.43.5
^ permalink raw reply related [flat|nested] 8+ messages in thread
* [PATCH v9 5/7] mm/util: Fix possible race condition in kstrdup()
2024-10-07 14:49 [PATCH v9 0/7] Improve the copy of task comm Yafang Shao
` (3 preceding siblings ...)
2024-10-07 14:49 ` [PATCH v9 4/7] bpftool: Ensure task comm is always NUL-terminated Yafang Shao
@ 2024-10-07 14:49 ` Yafang Shao
2024-10-07 14:49 ` [PATCH v9 6/7] mm/util: Deduplicate code in {kstrdup,kstrndup,kmemdup_nul} Yafang Shao
2024-10-07 14:49 ` [PATCH v9 7/7] drm: Replace strcpy() with strscpy() Yafang Shao
6 siblings, 0 replies; 8+ messages in thread
From: Yafang Shao @ 2024-10-07 14:49 UTC (permalink / raw)
To: akpm
Cc: torvalds, keescook, alx, justinstitt, ebiederm,
alexei.starovoitov, rostedt, catalin.marinas, penguin-kernel,
linux-mm, linux-fsdevel, linux-trace-kernel, audit,
linux-security-module, selinux, bpf, netdev, dri-devel,
Yafang Shao, Andy Shevchenko
In kstrdup(), it is critical to ensure that the dest string is always
NUL-terminated. However, potential race condition can occur between a
writer and a reader.
Consider the following scenario involving task->comm:
reader writer
len = strlen(s) + 1;
strlcpy(tsk->comm, buf, sizeof(tsk->comm));
memcpy(buf, s, len);
In this case, there is a race condition between the reader and the
writer. The reader calculates the length of the string `s` based on the
old value of task->comm. However, during the memcpy(), the string `s`
might be updated by the writer to a new value of task->comm.
If the new task->comm is larger than the old one, the `buf` might not be
NUL-terminated. This can lead to undefined behavior and potential
security vulnerabilities.
Let's fix it by explicitly adding a NUL terminator after the memcpy. It
is worth noting that memcpy() is not atomic, so the new string can be
shorter when memcpy() already copied past the new NUL.
Signed-off-by: Yafang Shao <laoar.shao@gmail.com>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Alejandro Colomar <alx@kernel.org>
Cc: Andy Shevchenko <andy.shevchenko@gmail.com>
---
mm/util.c | 9 ++++++++-
1 file changed, 8 insertions(+), 1 deletion(-)
diff --git a/mm/util.c b/mm/util.c
index 4f1275023eb7..858a9a2f57e7 100644
--- a/mm/util.c
+++ b/mm/util.c
@@ -62,8 +62,15 @@ char *kstrdup(const char *s, gfp_t gfp)
len = strlen(s) + 1;
buf = kmalloc_track_caller(len, gfp);
- if (buf)
+ if (buf) {
memcpy(buf, s, len);
+ /*
+ * During memcpy(), the string might be updated to a new value,
+ * which could be longer than the string when strlen() is
+ * called. Therefore, we need to add a NUL terminator.
+ */
+ buf[len - 1] = '\0';
+ }
return buf;
}
EXPORT_SYMBOL(kstrdup);
--
2.43.5
^ permalink raw reply related [flat|nested] 8+ messages in thread
* [PATCH v9 6/7] mm/util: Deduplicate code in {kstrdup,kstrndup,kmemdup_nul}
2024-10-07 14:49 [PATCH v9 0/7] Improve the copy of task comm Yafang Shao
` (4 preceding siblings ...)
2024-10-07 14:49 ` [PATCH v9 5/7] mm/util: Fix possible race condition in kstrdup() Yafang Shao
@ 2024-10-07 14:49 ` Yafang Shao
2024-10-07 14:49 ` [PATCH v9 7/7] drm: Replace strcpy() with strscpy() Yafang Shao
6 siblings, 0 replies; 8+ messages in thread
From: Yafang Shao @ 2024-10-07 14:49 UTC (permalink / raw)
To: akpm
Cc: torvalds, keescook, alx, justinstitt, ebiederm,
alexei.starovoitov, rostedt, catalin.marinas, penguin-kernel,
linux-mm, linux-fsdevel, linux-trace-kernel, audit,
linux-security-module, selinux, bpf, netdev, dri-devel,
Yafang Shao, Simon Horman, Matthew Wilcox
These three functions follow the same pattern. To deduplicate the code,
let's introduce a common helper __kmemdup_nul().
Suggested-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Yafang Shao <laoar.shao@gmail.com>
Cc: Simon Horman <horms@kernel.org>
Cc: Matthew Wilcox <willy@infradead.org>
Cc: Alejandro Colomar <alx@kernel.org>
---
mm/util.c | 69 ++++++++++++++++++++++---------------------------------
1 file changed, 27 insertions(+), 42 deletions(-)
diff --git a/mm/util.c b/mm/util.c
index 858a9a2f57e7..c7d851c40843 100644
--- a/mm/util.c
+++ b/mm/util.c
@@ -45,34 +45,41 @@ void kfree_const(const void *x)
EXPORT_SYMBOL(kfree_const);
/**
- * kstrdup - allocate space for and copy an existing string
- * @s: the string to duplicate
+ * __kmemdup_nul - Create a NUL-terminated string from @s, which might be unterminated.
+ * @s: The data to copy
+ * @len: The size of the data, not including the NUL terminator
* @gfp: the GFP mask used in the kmalloc() call when allocating memory
*
- * Return: newly allocated copy of @s or %NULL in case of error
+ * Return: newly allocated copy of @s with NUL-termination or %NULL in
+ * case of error
*/
-noinline
-char *kstrdup(const char *s, gfp_t gfp)
+static __always_inline char *__kmemdup_nul(const char *s, size_t len, gfp_t gfp)
{
- size_t len;
char *buf;
- if (!s)
+ /* '+1' for the NUL terminator */
+ buf = kmalloc_track_caller(len + 1, gfp);
+ if (!buf)
return NULL;
- len = strlen(s) + 1;
- buf = kmalloc_track_caller(len, gfp);
- if (buf) {
- memcpy(buf, s, len);
- /*
- * During memcpy(), the string might be updated to a new value,
- * which could be longer than the string when strlen() is
- * called. Therefore, we need to add a NUL terminator.
- */
- buf[len - 1] = '\0';
- }
+ memcpy(buf, s, len);
+ /* Ensure the buf is always NUL-terminated, regardless of @s. */
+ buf[len] = '\0';
return buf;
}
+
+/**
+ * kstrdup - allocate space for and copy an existing string
+ * @s: the string to duplicate
+ * @gfp: the GFP mask used in the kmalloc() call when allocating memory
+ *
+ * Return: newly allocated copy of @s or %NULL in case of error
+ */
+noinline
+char *kstrdup(const char *s, gfp_t gfp)
+{
+ return s ? __kmemdup_nul(s, strlen(s), gfp) : NULL;
+}
EXPORT_SYMBOL(kstrdup);
/**
@@ -107,19 +114,7 @@ EXPORT_SYMBOL(kstrdup_const);
*/
char *kstrndup(const char *s, size_t max, gfp_t gfp)
{
- size_t len;
- char *buf;
-
- if (!s)
- return NULL;
-
- len = strnlen(s, max);
- buf = kmalloc_track_caller(len+1, gfp);
- if (buf) {
- memcpy(buf, s, len);
- buf[len] = '\0';
- }
- return buf;
+ return s ? __kmemdup_nul(s, strnlen(s, max), gfp) : NULL;
}
EXPORT_SYMBOL(kstrndup);
@@ -193,17 +188,7 @@ EXPORT_SYMBOL(kvmemdup);
*/
char *kmemdup_nul(const char *s, size_t len, gfp_t gfp)
{
- char *buf;
-
- if (!s)
- return NULL;
-
- buf = kmalloc_track_caller(len + 1, gfp);
- if (buf) {
- memcpy(buf, s, len);
- buf[len] = '\0';
- }
- return buf;
+ return s ? __kmemdup_nul(s, len, gfp) : NULL;
}
EXPORT_SYMBOL(kmemdup_nul);
--
2.43.5
^ permalink raw reply related [flat|nested] 8+ messages in thread
* [PATCH v9 7/7] drm: Replace strcpy() with strscpy()
2024-10-07 14:49 [PATCH v9 0/7] Improve the copy of task comm Yafang Shao
` (5 preceding siblings ...)
2024-10-07 14:49 ` [PATCH v9 6/7] mm/util: Deduplicate code in {kstrdup,kstrndup,kmemdup_nul} Yafang Shao
@ 2024-10-07 14:49 ` Yafang Shao
6 siblings, 0 replies; 8+ messages in thread
From: Yafang Shao @ 2024-10-07 14:49 UTC (permalink / raw)
To: akpm
Cc: torvalds, keescook, alx, justinstitt, ebiederm,
alexei.starovoitov, rostedt, catalin.marinas, penguin-kernel,
linux-mm, linux-fsdevel, linux-trace-kernel, audit,
linux-security-module, selinux, bpf, netdev, dri-devel,
Yafang Shao, Daniel Vetter, Maarten Lankhorst, Maxime Ripard,
Thomas Zimmermann, David Airlie
To prevent errors from occurring when the src string is longer than the
dst string in strcpy(), we should use strscpy() instead. This
approach also facilitates future extensions to the task comm.
Suggested-by: Justin Stitt <justinstitt@google.com>
Signed-off-by: Yafang Shao <laoar.shao@gmail.com>
Acked-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Reviewed-by: Justin Stitt <justinstitt@google.com>
Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
Cc: Maxime Ripard <mripard@kernel.org>
Cc: Thomas Zimmermann <tzimmermann@suse.de>
Cc: David Airlie <airlied@gmail.com>
---
drivers/gpu/drm/drm_framebuffer.c | 2 +-
drivers/gpu/drm/i915/i915_gpu_error.c | 6 +++---
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/drivers/gpu/drm/drm_framebuffer.c b/drivers/gpu/drm/drm_framebuffer.c
index 888aadb6a4ac..2d6993539474 100644
--- a/drivers/gpu/drm/drm_framebuffer.c
+++ b/drivers/gpu/drm/drm_framebuffer.c
@@ -868,7 +868,7 @@ int drm_framebuffer_init(struct drm_device *dev, struct drm_framebuffer *fb,
INIT_LIST_HEAD(&fb->filp_head);
fb->funcs = funcs;
- strcpy(fb->comm, current->comm);
+ strscpy(fb->comm, current->comm);
ret = __drm_mode_object_add(dev, &fb->base, DRM_MODE_OBJECT_FB,
false, drm_framebuffer_free);
diff --git a/drivers/gpu/drm/i915/i915_gpu_error.c b/drivers/gpu/drm/i915/i915_gpu_error.c
index 6469b9bcf2ec..9d4b25b2cd39 100644
--- a/drivers/gpu/drm/i915/i915_gpu_error.c
+++ b/drivers/gpu/drm/i915/i915_gpu_error.c
@@ -1113,7 +1113,7 @@ i915_vma_coredump_create(const struct intel_gt *gt,
}
INIT_LIST_HEAD(&dst->page_list);
- strcpy(dst->name, name);
+ strscpy(dst->name, name);
dst->next = NULL;
dst->gtt_offset = vma_res->start;
@@ -1413,7 +1413,7 @@ static bool record_context(struct i915_gem_context_coredump *e,
rcu_read_lock();
task = pid_task(ctx->pid, PIDTYPE_PID);
if (task) {
- strcpy(e->comm, task->comm);
+ strscpy(e->comm, task->comm);
e->pid = task->pid;
}
rcu_read_unlock();
@@ -1459,7 +1459,7 @@ capture_vma_snapshot(struct intel_engine_capture_vma *next,
return next;
}
- strcpy(c->name, name);
+ strscpy(c->name, name);
c->vma_res = i915_vma_resource_get(vma_res);
c->next = next;
--
2.43.5
^ permalink raw reply related [flat|nested] 8+ messages in thread
end of thread, other threads:[~2024-10-07 14:50 UTC | newest]
Thread overview: 8+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-10-07 14:49 [PATCH v9 0/7] Improve the copy of task comm Yafang Shao
2024-10-07 14:49 ` [PATCH v9 1/7] Get rid of __get_task_comm() Yafang Shao
2024-10-07 14:49 ` [PATCH v9 2/7] auditsc: Replace memcpy() with strscpy() Yafang Shao
2024-10-07 14:49 ` [PATCH v9 3/7] security: Replace memcpy() with get_task_comm() Yafang Shao
2024-10-07 14:49 ` [PATCH v9 4/7] bpftool: Ensure task comm is always NUL-terminated Yafang Shao
2024-10-07 14:49 ` [PATCH v9 5/7] mm/util: Fix possible race condition in kstrdup() Yafang Shao
2024-10-07 14:49 ` [PATCH v9 6/7] mm/util: Deduplicate code in {kstrdup,kstrndup,kmemdup_nul} Yafang Shao
2024-10-07 14:49 ` [PATCH v9 7/7] drm: Replace strcpy() with strscpy() Yafang Shao
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 NNTP newsgroup(s).