Skip to contentSkip to conversation

drm/sched: memset() 'job' in drm_sched_job_init()

PATCH Superseded Philipp Stanner 1 participant 3 messages Aug 6, 2024 – Aug 20, 2024

Subsystems (3)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/2 drm/sched: memset() 'job' in drm_sched_job_init()

drm_sched_job_init() has no control over how users allocate struct drm_sched_job. Unfortunately, the function can also not set some struct members such as job->sched.

This could theoretically lead to UB by users dereferencing the struct's pointer members too early.

It is easier to debug such issues if these pointers are initialized to NULL, so dereferencing them causes a NULL pointer exception. Accordingly, drm_sched_entity_init() does precisely that and initializes its struct with memset().

Initialize parameter "job" to 0 in drm_sched_job_init().

---
Hi all,
I did some experiments with the scheduler recently and am trying to make the documentation and bits of the code more bullet proof.

I tested the performance of v6.11-rc2 with and without this memset() by creating 1e6 jobs and found no performance regression.

Cheers,
P.

---
 drivers/gpu/drm/scheduler/sched_main.c | 8 ++++++++
 1 file changed, 8 insertions(+)
drivers/gpu/drm/scheduler/sched_main.c +8 -0
index 76969f9c59c2..1498ee3cbf39 100644
@@ -936,6 +936,14 @@ int drm_sched_job_init(struct drm_sched_job *job,
 		return -EINVAL;
 	}
 
+	/*
+	 * We don't know for sure how the user has allocated. Thus, zero the
+	 * struct so that unallowed (i.e., too early) usage of pointers that
+	 * this function does not set is guaranteed to lead to a NULL pointer
+	 * exception instead of UB.
+	 */
+	memset(job, 0, sizeof(*job));
+
 	job->entity = entity;
 	job->credits = credits;
 	job->s_fence = drm_sched_fence_alloc(entity, owner);
Signature · 1 line
2.45.2
#1 lore raw

PATCH 2/2 drm/sched: warn about drm_sched_job_init()'s partial init

drm_sched_job_init()'s name suggests that after the function succeeded, parameter "job" will be fully initialized. This is not the case; some members are only later set, notably "job->sched" by drm_sched_job_arm().

Document that drm_sched_job_init() does not set all struct members.

Document that job->sched in particular is uninitialized before drm_sched_job_arm().

---
 drivers/gpu/drm/scheduler/sched_main.c | 4 ++++
 include/drm/gpu_scheduler.h            | 7 +++++++
 2 files changed, 11 insertions(+)
drivers/gpu/drm/scheduler/sched_main.c +4 -0
index 1498ee3cbf39..2adb13745500 100644
@@ -911,6 +911,10 @@ EXPORT_SYMBOL(drm_sched_resubmit_jobs);
  * Drivers must make sure drm_sched_job_cleanup() if this function returns
  * successfully, even when @job is aborted before drm_sched_job_arm() is called.
  *
+ * Note that this function does not assign a valid value to each struct member
+ * of struct drm_sched_job. Take a look at that struct's documentation to see
+ * who sets which struct member with what lifetime.
+ *
  * WARNING: amdgpu abuses &drm_sched.ready to signal when the hardware
  * has died, which can mean that there's no valid runqueue for a @entity.
  * This function returns -ENOENT in this case (which probably should be -EIO as
include/drm/gpu_scheduler.h +7 -0
index ce15c50d8a10..7df81a07f1f9 100644
@@ -337,6 +337,13 @@ struct drm_sched_fence *to_drm_sched_fence(struct dma_fence *f);
 struct drm_sched_job {
 	struct spsc_node		queue_node;
 	struct list_head		list;
+
+	/*
+	 * The scheduler this job is or will be scheduled on.
+	 *
+	 * Gets set by drm_sched_arm(). Valid until the scheduler's backend_ops
+	 * callback "free_job()" is  called.
+	 */
 	struct drm_gpu_scheduler	*sched;
 	struct drm_sched_fence		*s_fence;
 
Signature · 1 line
2.45.2
#2 lore raw
In reply to Philipp Stanner

*PING*

Quoted 59 lines · Philipp Stanner

drm_sched_job_init() has no control over how users allocate struct drm_sched_job. Unfortunately, the function can also not set some struct
members such as job->sched.

This could theoretically lead to UB by users dereferencing the struct's
pointer members too early.

It is easier to debug such issues if these pointers are initialized to
NULL, so dereferencing them causes a NULL pointer exception. Accordingly, drm_sched_entity_init() does precisely that and initializes
its struct with memset().

Initialize parameter "job" to 0 in drm_sched_job_init().

---
Hi all,
I did some experiments with the scheduler recently and am trying to make
the documentation and bits of the code more bullet proof.

I tested the performance of v6.11-rc2 with and without this memset() by
creating 1e6 jobs and found no performance regression.

Cheers,
P.
---
 drivers/gpu/drm/scheduler/sched_main.c | 8 ++++++++

 1 file changed, 8 insertions(+)
drivers/gpu/drm/scheduler/sched_main.c +0 -0
index 76969f9c59c2..1498ee3cbf39 100644
@@ -936,6 +936,14 @@ int drm_sched_job_init(struct drm_sched_job
 *job,
  		return -EINVAL;
  	}

drivers/gpu/drm/scheduler/sched_main.c +2 -0
+	/*
+	 * We don't know for sure how the user has allocated. Thus,

zero the

drivers/gpu/drm/scheduler/sched_main.c +1 -0
+	 * struct so that unallowed (i.e., too early) usage of

pointers that

drivers/gpu/drm/scheduler/sched_main.c +1 -0
+	 * this function does not set is guaranteed to lead to a

NULL pointer

drivers/gpu/drm/scheduler/sched_main.c +4 -0
+	 * exception instead of UB.
+	 */
+	memset(job, 0, sizeof(*job));
+

  job->entity = entity;
  job->credits = credits;
  job->s_fence = drm_sched_fence_alloc(entity, owner);