[PATCH v2 12/15] drm/panthor: Add the driver frontend block
Boris Brezillon
boris.brezillon at collabora.com
Tue Aug 29 17:46:25 UTC 2023
On Mon, 21 Aug 2023 12:31:29 +0100
Steven Price <steven.price at arm.com> wrote:
> On 09/08/2023 17:53, Boris Brezillon wrote:
> > This is the last piece missing to expose the driver to the outside
> > world.
> >
> > This is basically a wrapper between the ioctls and the other logical
> > blocks.
> >
> > v2:
> > - Rename the driver (pancsf -> panthor)
> > - Change the license (GPL2 -> MIT + GPL2)
> > - Split the driver addition commit
> > - Document the code
> > - Use drm_dev_{unplug,enter,exit}() to provide safe device removal
> > - Fix various bugs
> > - Refactored the code to make job submission re-usable for VM_BIND
> > jobs
> > - Add user object copy helpers
> >
> > Signed-off-by: Boris Brezillon <boris.brezillon at collabora.com>
> > ---
> > drivers/gpu/drm/panthor/panthor_drv.c | 1540 +++++++++++++++++++++++++
> > 1 file changed, 1540 insertions(+)
> > create mode 100644 drivers/gpu/drm/panthor/panthor_drv.c
> >
> > diff --git a/drivers/gpu/drm/panthor/panthor_drv.c b/drivers/gpu/drm/panthor/panthor_drv.c
> > new file mode 100644
> > index 000000000000..377ebea4c0e8
> > --- /dev/null
> > +++ b/drivers/gpu/drm/panthor/panthor_drv.c
> > @@ -0,0 +1,1540 @@
> > +// SPDX-License-Identifier: GPL-2.0 or MIT
> > +/* Copyright 2018 Marty E. Plummer <hanetzer at startmail.com> */
> > +/* Copyright 2019 Linaro, Ltd., Rob Herring <robh at kernel.org> */
> > +/* Copyright 2019 Collabora ltd. */
> > +
> > +#include <linux/module.h>
> > +#include <linux/of_platform.h>
> > +#include <linux/pagemap.h>
> > +#include <linux/pm_runtime.h>
> > +#include <linux/xarray.h>
> > +
> > +#include <drm/drm_drv.h>
> > +#include <drm/drm_exec.h>
> > +#include <drm/drm_ioctl.h>
> > +#include <drm/drm_syncobj.h>
> > +#include <drm/drm_utils.h>
> > +#include <drm/drm_debugfs.h>
> > +#include <drm/gpu_scheduler.h>
> > +#include <drm/panthor_drm.h>
> > +
> > +#include "panthor_sched.h"
> > +#include "panthor_device.h"
> > +#include "panthor_gem.h"
> > +#include "panthor_heap.h"
> > +#include "panthor_fw.h"
> > +#include "panthor_mmu.h"
> > +#include "panthor_gpu.h"
> > +#include "panthor_regs.h"
> > +
> > +/**
> > + * DOC: user <-> kernel object copy helpers.
> > + */
> > +
> > +/**
> > + * panthor_set_uobj() - Copy kernel object to user object.
> > + * @usr_ptr: Users pointer.
> > + * @usr_size: Size of the user object.
> > + * @min_size: Minimum size for this object.
> > + * @kern_size: Size of the kernel object.
> > + * @in: Address of the kernel object to copy.
> > + *
> > + * Helper automating kernel -> user object copies.
> > + *
> > + * Don't use this function directly, use PANTHOR_UOBJ_SET() instead.
> > + *
> > + * Return: 0 on success, a negative error code otherwise.
> > + */
> > +static int
> > +panthor_set_uobj(u64 usr_ptr, u32 usr_size, u32 min_size, u32 kern_size, const void *in)
> > +{
> > + /* User size shouldn't be smaller than the minimal object size. */
> > + if (usr_size < min_size)
> > + return -EINVAL;
> > +
> > + if (copy_to_user(u64_to_user_ptr(usr_ptr), in, min_t(u32, usr_size, kern_size)))
> > + return -EFAULT;
> > +
> > + /* When the kernel object is smaller than the user object, we fill the gap with
> > + * zeros.
> > + */
> > + if (usr_size > kern_size &&
> > + clear_user(u64_to_user_ptr(usr_ptr + kern_size), usr_size - kern_size)) {
> > + return -EFAULT;
> > + }
> > +
> > + return 0;
> > +}
> > +
> > +/**
> > + * panthor_get_uobj_array() - Copy a user object array into a kernel accessible object array.
> > + * @in: The object array to copy.
> > + * @min_stride: Minimum array stride.
> > + * @obj_kernel: Kernel object size.
> > + * @out: Pointer to a variable that will hold the newly allocated object array.
> > + *
> > + * Helper automating user -> kernel object copies.
> > + *
> > + * Don't use this function directly, use PANTHOR_UOBJ_ARRAY_GET() instead.
> > + *
> > + * Return: 0 on success, a negative error code otherwise.
> > + */
> > +static int
> > +panthor_get_uobj_array(const struct drm_panthor_obj_array *in, u32 min_stride,
> > + u32 obj_size, void **out)
>
> Instead of having 'out' as a return parameter you could use ERR_PTR()s
> for the error cases. I know why you haven't, but see below.
>
> > +{
> > + int ret = 0;
> > + void *out_alloc;
> > +
> > + /* User stride must be at least the minimum object size, otherwise it might
> > + * lack useful information.
> > + */
> > + if (in->stride < min_stride)
> > + return -EINVAL;
> > +
> > + if (!in->count)
> > + return 0;
> > +
> > + out_alloc = kvmalloc_array(in->count, obj_size, GFP_KERNEL);
> > + if (!out_alloc)
> > + return -ENOMEM;
> > +
> > + if (obj_size == in->stride) {
> > + /* Fast path when user/kernel have the same uAPI header version. */
> > + if (copy_from_user(out_alloc, u64_to_user_ptr(in->array),
> > + (unsigned long)obj_size * in->count))
> > + ret = -EFAULT;
> > + } else {
> > + void __user *in_ptr = u64_to_user_ptr(in->array);
> > + void *out_ptr = out_alloc;
> > +
> > + /* If the sizes differ, we need to copy elements one by one. */
> > + for (u32 i = 0; i < in->count; i++) {
> > + ret = copy_struct_from_user(out_ptr, obj_size, in_ptr, in->stride);
> > + if (ret)
> > + break;
> > +
> > + out_ptr += obj_size;
> > + in_ptr += in->stride;
> > + }
> > + }
> > +
> > + if (ret) {
> > + kvfree(out_alloc);
> > + return ret;
> > + }
> > +
> > + *out = out_alloc;
> > + return 0;
> > +}
> > +
> > +/**
> > + * PANTHOR_UOBJ_MIN_SIZE_INTERNAL() - Get the minimum user object size
> > + * @_typename: Object type.
> > + * @_last_mandatory_field: Last mandatory field.
> > + *
> > + * Get the minimum user object size based on the last mandatory field name,
> > + * A.K.A, the name of the last field of the structure at the time this
> > + * structure was added to the uAPI.
> > + *
> > + * Don't use directly, use PANTHOR_UOBJ_DECL() instead.
> > + */
> > +#define PANTHOR_UOBJ_MIN_SIZE_INTERNAL(_typename, _last_mandatory_field) \
> > + (offsetof(_typename, _last_mandatory_field) + \
> > + sizeof(((_typename *)NULL)->_last_mandatory_field))
> > +
> > +/**
> > + * PANTHOR_UOBJ_DECL() - Declare a new uAPI object whose subject to
> > + * evolutions.
> > + * @_typename: Object type.
> > + * @_last_mandatory_field: Last mandatory field.
> > + *
> > + * Should be used to extend the PANTHOR_UOBJ_MIN_SIZE() list.
> > + */
> > +#define PANTHOR_UOBJ_DECL(_typename, _last_mandatory_field) \
> > + _typename : PANTHOR_UOBJ_MIN_SIZE_INTERNAL(_typename, _last_mandatory_field)
> > +
> > +/**
> > + * PANTHOR_UOBJ_MIN_SIZE() - Get the minimum size of a given uAPI object
> > + * @_obj_name: Object to get the minimum size of.
> > + *
> > + * Don't use this macro directly, it's automatically called by
> > + * PANTHOR_UOBJ_{SET,GET_ARRAY}().
> > + */
> > +#define PANTHOR_UOBJ_MIN_SIZE(_obj_name) \
> > + _Generic(_obj_name, \
> > + PANTHOR_UOBJ_DECL(struct drm_panthor_gpu_info, tiler_present), \
> > + PANTHOR_UOBJ_DECL(struct drm_panthor_csif_info, pad), \
> > + PANTHOR_UOBJ_DECL(struct drm_panthor_sync_op, timeline_value), \
> > + PANTHOR_UOBJ_DECL(struct drm_panthor_queue_submit, syncs), \
> > + PANTHOR_UOBJ_DECL(struct drm_panthor_queue_create, ringbuf_size), \
> > + PANTHOR_UOBJ_DECL(struct drm_panthor_vm_bind_op, syncs))
> > +
> > +/**
> > + * PANTHOR_UOBJ_SET() - Copy a kernel object to a user object.
> > + * @_dest_usr_ptr: User pointer to copy to.
> > + * @_usr_size: Size of the user object.
> > + * @_src_obj: Kernel object to copy (not a pointer).
> > + *
> > + * Return: 0 on success, a negative error code otherwise.
> > + */
> > +#define PANTHOR_UOBJ_SET(_dest_usr_ptr, _usr_size, _src_obj) \
> > + panthor_set_uobj(_dest_usr_ptr, _usr_size, \
> > + PANTHOR_UOBJ_MIN_SIZE(_src_obj), \
> > + sizeof(_src_obj), &(_src_obj))
> > +
> > +/**
> > + * PANTHOR_UOBJ_GET_ARRAY() - Copy a user object array to a kernel accessible
> > + * object array.
> > + * @_dest_array: Local variable that will hold the newly allocated kernel
> > + * object array.
> > + * @_uobj_array: The drm_panthor_obj_array object describing the user object
> > + * array.
> > + *
> > + * Return: 0 on success, a negative error code otherwise.
> > + */
> > +#define PANTHOR_UOBJ_GET_ARRAY(_dest_array, _uobj_array) \
> > + panthor_get_uobj_array(_uobj_array, \
> > + PANTHOR_UOBJ_MIN_SIZE((_dest_array)[0]), \
> > + sizeof((_dest_array)[0]), (void **)&(_dest_array))
>
> Here you have an ugly cast to make the output pointer work. The below
> patch avoids this by changing panthor_get_uobj_array() to return an
> ERR_PTR:
>
> ----8<----
> diff --git a/drivers/gpu/drm/panthor/panthor_drv.c b/drivers/gpu/drm/panthor/panthor_drv.c
> index 377ebea4c0e8..ff749832f344 100644
> --- a/drivers/gpu/drm/panthor/panthor_drv.c
> +++ b/drivers/gpu/drm/panthor/panthor_drv.c
> @@ -79,9 +79,9 @@ panthor_set_uobj(u64 usr_ptr, u32 usr_size, u32 min_size, u32 kern_size, const v
> *
> * Return: 0 on success, a negative error code otherwise.
> */
> -static int
> +static void *
> panthor_get_uobj_array(const struct drm_panthor_obj_array *in, u32 min_stride,
> - u32 obj_size, void **out)
> + u32 obj_size)
> {
> int ret = 0;
> void *out_alloc;
> @@ -90,14 +90,14 @@ panthor_get_uobj_array(const struct drm_panthor_obj_array *in, u32 min_stride,
> * lack useful information.
> */
> if (in->stride < min_stride)
> - return -EINVAL;
> + return ERR_PTR(-EINVAL);
>
> if (!in->count)
> - return 0;
> + return NULL;
>
> out_alloc = kvmalloc_array(in->count, obj_size, GFP_KERNEL);
> if (!out_alloc)
> - return -ENOMEM;
> + return ERR_PTR(-ENOMEM);
>
> if (obj_size == in->stride) {
> /* Fast path when user/kernel have the same uAPI header version. */
> @@ -121,11 +121,10 @@ panthor_get_uobj_array(const struct drm_panthor_obj_array *in, u32 min_stride,
>
> if (ret) {
> kvfree(out_alloc);
> - return ret;
> + return ERR_PTR(ret);
> }
>
> - *out = out_alloc;
> - return 0;
> + return out_alloc;
> }
>
> /**
> @@ -193,10 +192,12 @@ panthor_get_uobj_array(const struct drm_panthor_obj_array *in, u32 min_stride,
> *
> * Return: 0 on success, a negative error code otherwise.
> */
> -#define PANTHOR_UOBJ_GET_ARRAY(_dest_array, _uobj_array) \
> - panthor_get_uobj_array(_uobj_array, \
> +#define PANTHOR_UOBJ_GET_ARRAY(_dest_array, _uobj_array) ({\
> + _dest_array = panthor_get_uobj_array(_uobj_array, \
> PANTHOR_UOBJ_MIN_SIZE((_dest_array)[0]), \
> - sizeof((_dest_array)[0]), (void **)&(_dest_array))
> + sizeof((_dest_array)[0])); \
> + IS_ERR(_dest_array) ? PTR_ERR(_dest_array) : 0; \
> + })
>
> /**
> * DOC: Job submission helpers.
> ---8<----
>
> TBH, I'd also be tempted to make PANTHOR_UOBJ_GET_ARRAY simply return
> the ERR_PTR and change the call sites appropriately. That way you avoid
> the 'magic' of passing an lvalue.
Yep, I've considered doing that too actually, it's just that you get
if (IS_ERR(out))
out = NULL;
if you want to call kfree(out) without testing in the error path. Maybe
that's a small price to pay if it helps cleaning up the helpers a bit.
>
> > +
> > +/**
> > + * DOC: Job submission helpers.
> > + *
> > + * Here is the workflow for atomic submission of multiple jobs. By atomic,
> > + * we mean that we either submit the whole batch, or nothing. This requires
> > + * doing things in multiple steps, each step operating on all jobs belonging
> > + * to a batch.
> > + *
> > + * int xxx_submit_ioctl(...)
> > + * {
> > + * ...
> > + *
> > + * // Initialize the submission context.
> > + * ret = panthor_submit_ctx_init(&ctx, file, job_count);
> > + * if (ret)
> > + * return ret;
> > + *
> > + * // Create jobs and attach sync operations.
> > + * for (u32 i = 0; i < job_count; i++) {
> > + * ...
> > + *
> > + * // Create job
> > + * job = job_create(pfile, ...);
> > + * if (IS_ERR(job)) {
> > + * ret = PTR_ERR(job);
> > + * goto out_cleanup_submit_ctx;
> > + * }
> > + *
> > + * // Add job to the submit context
> > + * ret = panthor_submit_ctx_add_job(&ctx, i, job, sync_ops);
> > + * if (ret)
> > + * goto out_cleanup_submit_ctx;
> > + * }
> > + *
> > + * // Collect signal operations on all jobs, such that each job can pick
> > + * // from it for its dependencies and update the fence to signal when
> > + * // the job is submitted.
>
> I can't figure out here how we avoid depedency loops within a batch.
> What stops two jobs from each depending on each other?
>
> Or do we "allow" this but rely on the loop in panthor_submit_ctx_add_deps_and_arm_jobs()
> to effectively enforce that a job cannot actually depend on a job
> which is later in the batch.
You can't have circular dependencies because the job fence is created
after its dependencies have been registered, so a job at the beginning
of the array can't depend on a job that's coming after. It might be
passed the same syncobj, but since a syncobj is just a container, the
fence attached to the syncobj at the time the first job adds it as a
dependency will point to a different dma_fence.
> In which case why bother with this
> complexity rather than just performing all the steps on each job
> in order?
Because, before submitting a set of jobs, we want to make sure all jobs
that are passed to a submit request are valid and enough resources are
available for their execution to proceed. We could allow partial
execution (and that's actually the approach I had taken in one of the
patch I proposed to allow submitting multiple jobs in one call to
panfrost), but then you potentially have to figure out where things
failed, not to mention that the syncobjs might point to intermediate
dma_fence objects instead of the final one.
>
> Being able to submit a forward dependency, but then having it
> ignored seems like an odd design. So I feel like I must be
> missing something.
It's not about allowing forward dependencies (that would be mess), but
allowing one job to take a dependency on a job that was appearing
earlier in the job array of the same submit call.
>
> > + * ret = panthor_submit_ctx_collect_jobs_signal_ops(&ctx);
Here panthor_submit_ctx_collect_jobs_signal_ops() is not registering
job out_fences to the syncobjs, it's just collecting all signal
operations from all jobs in an array. Each entry in this array contains
the syncobj handle, the syncobj object, and the fence that was attached
to it at the time the collection happens, and that's it.
Now, when a job are populated, and after we made sure it had
everything it needs to be submitted, for each signal operation passed
to this specific job, we update the corresponding entry in the signal
array with the job finished fence, but the syncobj is not updated at
that point, because we want to make sure all jobs belonging to a submit
can be submitted before exposing their fences to the outside world.
For jobs happening later in the array, when we see a WAIT operation,
we will first check the signal array to see if there's a
corresponding entry cached there for the given syncobj handle, if there
is, we take the dma_fence from here (this dma_fence might come from a
job submitted earlier in this submit context, or it might be the fence
that was there initially), if not, we call drm_syncobj_find_fence() to
get the dependency.
Once all jobs have been parsed/checked/populated, we start the
non-failing step => job submission. And after that point, we can start
exposing the job fences to the outside world. This is what happens in
panthor_submit_ctx_push_fences(): we iterate over the signal
operations, and update each syncobj with the fence that was last
attached to it (the last job in the submit array having a SIGNAL
operation on that syncobj).
> > + * if (ret)
> > + * goto out_cleanup_submit_ctx;
> > + *
> > + * // We acquire/prepare revs on all jobs before proceeding with the
> > + * // dependency registration.
> > + * //
> > + * // This is solving two problems:
> > + * // 1. drm_sched_job_arm() and drm_sched_entity_push_job() must be protected
> > + * // by a lock to make sure no concurrent access to the same entity get
> > + * // interleaved, which would mess up with the fence seqno ordering.
> > + * // Luckily, one of the resv being acquired is the VM resv, and a scheduling
> > + * // entity is only bound to a single VM. As soon as we acquire the VM resv,
> > + * // we should be safe.
> > + * // 2. Jobs might depend on fences that were issued by previous jobs in the
> > + * // same batch, so we can't add dependencies on all jobs before arming
> > + * // previous jobs and registering the fence to the signal array, otherwise
> > + * // we might miss dependencies, or point to an outdated fence.
> > + * ret = panthor_submit_ctx_prepare_resvs(&ctx, panthor_job_prepare_resvs);
> > + * if (ret)
> > + * goto out_cleanup_submit_ctx;
> > + *
> > + * // Now that resvs are locked/prepared, we can iterate over each job to add
> > + * // the dependencies, arm the job fence, register the job fence to the signal
> > + * // array.
> > + * ret = panthor_submit_ctx_add_deps_and_arm_jobs(&ctx, panthor_job_add_resvs_deps);
> > + * if (ret)
> > + * goto out_cleanup_submit_ctx;
> > + *
> > + * // Nothing can fail after that point, so we can make our job fences visible to the
> > + * // outside world. Push jobs and set the job fences to the resv slots we reserved.
> > + * // This also pushes the fences to the syncobjs that are part of the signal array.
> > + * panthor_submit_ctx_push_jobs(&ctx, panthor_job_update_resvs);
> > + *
> > + * out_cleanup_submit_ctx:
> > + * // Cleanup the context.
> > + * panthor_submit_ctx_cleanup(&ctx, panthor_job_put);
> > + * ...
> > + * return ret;
> > + *}
>
> I'm not sure it's beneficial to have this 'pseudo-code' version of the
> submit function here. Can we not have the relevant comments in the
> panthor_ioctl_group_submit() function instead. My main concern is that
> this is going to get out of sync with the code over time - the function
> names are already not a complete match.
Given the same logic is used for GPU and VM_BIND jobs, I thought it'd
be good to have the workflow documented in a central place, but I get
your point.
>
> > + */
> > +
> > +/**
> > + * struct panthor_sync_signal - Represent a synchronization object point to attach
> > + * our job fence to.
> > + *
> > + * This structure is here to keep track of fences that are currently bound to
> > + * a specific syncobj point.
> > + *
> > + * At the beginning of a job submission, the fence
> > + * is retrieved from the syncobj itself, and can be NULL if no fence was attached
> > + * to this point.
> > + *
> > + * At the end, it points to the fence of the last job that had a
> > + * %DRM_PANTHOR_SYNC_OP_SIGNAL on this syncobj.
> > + *
> > + * With jobs being submitted in batches, the fence might change several times during
> > + * the process, allowing one job to wait on a job that's part of the same submission
> > + * be appears earlier in the drm_panthor_group_submit::queue_submits array.
>
> s/be/but/
>
> > + */
> > +struct panthor_sync_signal {
> > + /** @handle: The syncobj handle. */
> > + u32 handle;
> > +
> > + /**
> > + * @point: The syncobj point.
> > + *
> > + * Zero for regular syncobjs, and non-zero for timeline syncobjs.
> > + */
> > + u64 point;
> > +
> > + /**
> > + * @syncobj: The sync object pointed by @handle.
> > + */
> > + struct drm_syncobj *syncobj;
> > +
> > + /**
> > + * @chain: Chain object used to link the new fence to an existing
> > + * timeline syncobj.
> > + *
> > + * NULL for regular syncobj, non-NULL for timeline syncobjs.
> > + */
> > + struct dma_fence_chain *chain;
> > +
> > + /**
> > + * @fence: The fence to assign to the syncobj or syncobj-point.
> > + */
> > + struct dma_fence *fence;
> > +};
> > +
> > +/**
> > + * struct panthor_job_ctx - Job context
> > + */
> > +struct panthor_job_ctx {
> > + /** @job: The job that is about to be submitted to drm_sched. */
> > + struct drm_sched_job *job;
> > +
> > + /** @syncobjs: Array of sync operations. */
> > + struct drm_panthor_sync_op *syncops;
> > +
> > + /** @syncop_count: Number of sync operations. */
> > + u32 syncop_count;
> > +};
> > +
> > +/**
> > + * struct panthor_submit_ctx - Submission context
> > + *
> > + * Anything that's related to a submission (%DRM_IOCTL_PANTHOR_VM_BIND or
> > + * %DRM_IOCTL_PANTHOR_GROUP_SUBMIT) is kept here, so we can automate the
> > + * initialization and cleanup steps.
> > + */
> > +struct panthor_submit_ctx {
> > + /** @file: DRM file this submission happens on. */
> > + struct drm_file *file;
> > +
> > + /**
> > + * @signal: Array of panthor_sync_signal objects.
> > + *
> > + * %DRM_PANTHOR_SYNC_OP_SIGNAL operations will be recorded here,
> > + * and %DRM_PANTHOR_SYNC_OP_WAIT will first check if an entry
> > + * matching the syncobj+point exists before calling
> > + * drm_syncobj_find_fence(). This allows us to describe dependencies
> > + * existing between jobs that are part of the same batch.
> > + */
> > + struct xarray signal;
>
> This feels like the wrong data structure - it's simply used as a list. I
> suspect it would be better to simple add a list_head to struct
> panthor_sync_signal.
I think I initially planned to use a raw array to make things
cache-friendly, and diverged to an xarray to not have to bother
calculating the number of entries needed, but because of the
indirection (array contains pointer to signal objects not signal
objects themselves), it kinda defeat the original goal... :-/
So yeah, moving to a list is probably a good thing. We'll see if we
ever end up spending a lot of time iterating the signal list (happens
when searching for dependencies and updating signal entries, as
explained above).
>
> > +
> > + /** @jobs: Array of jobs. */
> > + struct panthor_job_ctx *jobs;
> > +
> > + /** @job_count: Number of entries in the @jobs array. */
> > + u32 job_count;
> > +
> > + /** @exec: drm_exec context used to acquire and prepare resv objects. */
> > + struct drm_exec exec;
> > +};
> > +
> > +#define PANTHOR_SYNC_OP_FLAGS_MASK \
> > + (DRM_PANTHOR_SYNC_OP_HANDLE_TYPE_MASK | DRM_PANTHOR_SYNC_OP_SIGNAL)
> > +
> > +/**
> > + * panthor_check_sync_op() - Check drm_panthor_sync_op fields
> > + * @sync_op: The sync operation to check.
> > + *
> > + * Return: 0 on success, -EINVAL otherwise.
> > + */
> > +static int
> > +panthor_check_sync_op(const struct drm_panthor_sync_op *sync_op)
> > +{
> > + u8 handle_type;
> > +
> > + if (sync_op->flags & ~PANTHOR_SYNC_OP_FLAGS_MASK)
> > + return -EINVAL;
> > +
> > + handle_type = sync_op->flags & DRM_PANTHOR_SYNC_OP_HANDLE_TYPE_MASK;
> > + if (handle_type != DRM_PANTHOR_SYNC_OP_HANDLE_TYPE_SYNCOBJ &&
> > + handle_type != DRM_PANTHOR_SYNC_OP_HANDLE_TYPE_TIMELINE_SYNCOBJ)
> > + return -EINVAL;
> > +
> > + if (handle_type == DRM_PANTHOR_SYNC_OP_HANDLE_TYPE_SYNCOBJ &&
> > + sync_op->timeline_value != 0)
> > + return -EINVAL;
> > +
> > + return 0;
> > +}
> > +
> > +/**
> > + * panthor_sync_signal_free() - Release resources and free a panthor_sync_signal object
> > + * @sig_sync: Signal object to free.
> > + */
> > +static void
> > +panthor_sync_signal_free(struct panthor_sync_signal *sig_sync)
> > +{
> > + if (!sig_sync)
> > + return;
> > +
> > + drm_syncobj_put(sig_sync->syncobj);
> > + dma_fence_chain_free(sig_sync->chain);
> > + dma_fence_put(sig_sync->fence);
> > + kfree(sig_sync);
> > +}
> > +
> > +/**
> > + * panthor_submit_ctx_add_sync_signal() - Add a signal operation to a submit context
> > + * @ctx: Context to add the signal operation to.
> > + * @handle: Syncobj handle.
> > + * @point: Syncobj point.
> > + *
> > + * Return: A valid panthor_sync_signal object on success, an ERR_PTR() otherwise.
>
> The only part of the return used is the ERR_PTR() part, so make this a simple int.
I see.
>
> > + */
> > +static struct panthor_sync_signal *
> > +panthor_submit_ctx_add_sync_signal(struct panthor_submit_ctx *ctx, u32 handle, u64 point)
> > +{
> > + struct panthor_sync_signal *sig_sync;
> > + struct dma_fence *cur_fence;
> > + int ret;
> > + u32 id;
> > +
> > + sig_sync = kzalloc(sizeof(*sig_sync), GFP_KERNEL);
> > + if (!sig_sync)
> > + return ERR_PTR(-ENOMEM);
> > +
> > + sig_sync->handle = handle;
> > + sig_sync->point = point;
> > +
> > + if (point > 0) {
> > + sig_sync->chain = dma_fence_chain_alloc();
> > + if (!sig_sync->chain) {
> > + ret = -ENOMEM;
> > + goto err_free_sig_sync;
> > + }
> > + }
> > +
> > + sig_sync->syncobj = drm_syncobj_find(ctx->file, handle);
> > + if (!sig_sync->syncobj) {
> > + ret = -EINVAL;
> > + goto err_free_sig_sync;
> > + }
> > +
> > + /* Retrieve the current fence attached to that point. It's
> > + * perfectly fine to get a NULL fence here, it just means there's
> > + * no fence attached to that point yet.
> > + */
> > + if (!drm_syncobj_find_fence(ctx->file, handle, point, 0, &cur_fence))
> > + sig_sync->fence = cur_fence;
> > +
> > + ret = xa_alloc(&ctx->signal, &id, sig_sync, xa_limit_32b, GFP_KERNEL);
> > + if (ret)
> > + goto err_free_sig_sync;
> > +
> > + return sig_sync;
> > +
> > +err_free_sig_sync:
> > + panthor_sync_signal_free(sig_sync);
> > + return ERR_PTR(ret);
> > +}
> > +
> > +/**
> > + * panthor_submit_ctx_search_sync_signal() - Search an existing signal operation in a
> > + * submit context.
> > + * @ctx: Context to search the signal operation in.
> > + * @handle: Syncobj handle.
> > + * @point: Syncobj point.
> > + *
> > + * Return: A valid panthor_sync_signal object if found, NULL otherwise.
> > + */
> > +static struct panthor_sync_signal *
> > +panthor_submit_ctx_search_sync_signal(struct panthor_submit_ctx *ctx, u32 handle, u64 point)
> > +{
> > + struct panthor_sync_signal *sig_sync;
> > + unsigned long i;
> > +
> > + xa_for_each(&ctx->signal, i, sig_sync) {
> > + if (handle == sig_sync->handle && point == sig_sync->point)
> > + return sig_sync;
> > + }
> > +
> > + return NULL;
> > +}
> > +
> > +/**
> > + * panthor_submit_ctx_add_job() - Add a job to a submit context
> > + * @ctx: Context to search the signal operation in.
> > + * @idx: Index of the job in the context.
> > + * @job: Job to add.
> > + * @syncs: Sync operations provided by userspace.
> > + *
> > + * Return: 0 on success, a negative error code otherwise.
> > + */
> > +static int
> > +panthor_submit_ctx_add_job(struct panthor_submit_ctx *ctx, u32 idx,
> > + struct drm_sched_job *job,
> > + const struct drm_panthor_obj_array *syncs)
> > +{
> > + struct panthor_device *ptdev = container_of(ctx->file->minor->dev,
> > + struct panthor_device,
> > + base);
> > + int ret;
> > +
> > + if (drm_WARN_ON(&ptdev->base,
> > + idx >= ctx->job_count ||
> > + ctx->jobs[idx].job ||
> > + ctx->jobs[idx].syncops ||
> > + ctx->jobs[idx].syncop_count))
> > + return -EINVAL;
> > +
> > + ctx->jobs[idx].job = job;
>
> While the WARN_ON obviously shouldn't happen, this positioning of the
> ctx->jobs[].job assignment means the caller has no idea if the
> assignment has happened. AFAICT in the case of the WARN_ON the job isn't
> cleaned up properly.
It's not really about cleanup not happening, more about being passed an
index that was already populated.
>
> The options I can see are to move this line further down (and make the
> caller clean up that one job if this function fails), or to clean up the
> job in the case where the WARN_ON fails.
Maybe I should drop this WARN_ON() and assume the caller passed a valid
index...
>
> > +
> > + ret = PANTHOR_UOBJ_GET_ARRAY(ctx->jobs[idx].syncops, syncs);
> > + if (ret)
> > + return ret;
> > +
> > + ctx->jobs[idx].syncop_count = syncs->count;
> > + return 0;
> > +}
> > +
> > +/**
> > + * panthor_submit_ctx_get_sync_signal() - Search signal operation and add one if none was found.
> > + * @ctx: Context to search the signal operation in.
> > + * @handle: Syncobj handle.
> > + * @point: Syncobj point.
> > + *
> > + * Return: A valid panthor_sync_signal object on success, an ERR_PTR() otherwise.
>
> As above, no need to return the object just an int error code.
>
> > + */
> > +static struct panthor_sync_signal *
> > +panthor_submit_ctx_get_sync_signal(struct panthor_submit_ctx *ctx, u32 handle, u64 point)
> > +{
> > + struct panthor_sync_signal *sig_sync;
> > +
> > + sig_sync = panthor_submit_ctx_search_sync_signal(ctx, handle, point);
> > + if (sig_sync)
> > + return sig_sync;
> > +
> > + return panthor_submit_ctx_add_sync_signal(ctx, handle, point);
> > +}
> > +
> > +/**
> > + * panthor_submit_ctx_update_job_sync_signal_fences() - Update fences
> > + * on the signal operations specified by a job.
> > + * @ctx: Context to search the signal operation in.
> > + * @job_idx: Index of the job to operate on.
> > + *
> > + * Return: 0 on success, a negative error code otherwise.
> > + */
> > +static int
> > +panthor_submit_ctx_update_job_sync_signal_fences(struct panthor_submit_ctx *ctx,
> > + u32 job_idx)
> > +{
> > + struct panthor_device *ptdev = container_of(ctx->file->minor->dev,
> > + struct panthor_device,
> > + base);
> > + struct dma_fence *done_fence = &ctx->jobs[job_idx].job->s_fence->finished;
> > + const struct drm_panthor_sync_op *sync_ops = ctx->jobs[job_idx].syncops;
> > + u32 sync_op_count = ctx->jobs[job_idx].syncop_count;
> > +
> > + for (u32 i = 0; i < sync_op_count; i++) {
> > + struct dma_fence *old_fence;
> > + struct panthor_sync_signal *sig_sync;
> > +
> > + if (!(sync_ops[i].flags & DRM_PANTHOR_SYNC_OP_SIGNAL))
> > + continue;
> > +
> > + sig_sync = panthor_submit_ctx_search_sync_signal(ctx, sync_ops[i].handle,
> > + sync_ops[i].timeline_value);
> > + if (drm_WARN_ON(&ptdev->base, !sig_sync))
> > + return -EINVAL;
> > +
> > + old_fence = sig_sync->fence;
> > + sig_sync->fence = dma_fence_get(done_fence);
> > + dma_fence_put(old_fence);
> > +
> > + if (drm_WARN_ON(&ptdev->base, !sig_sync->fence))
> > + return -EINVAL;
> > + }
> > +
> > + return 0;
> > +}
> > +
> > +/**
> > + * panthor_submit_ctx_collect_job_signal_ops() - Iterate over all job signal operations
> > + * and add them to the context.
> > + * @ctx: Context to search the signal operation in.
> > + * @job_idx: Index of the job to operate on.
> > + *
> > + * Return: 0 on success, a negative error code otherwise.
> > + */
> > +static int
> > +panthor_submit_ctx_collect_job_signal_ops(struct panthor_submit_ctx *ctx,
> > + u32 job_idx)
> > +{
> > + const struct drm_panthor_sync_op *sync_ops = ctx->jobs[job_idx].syncops;
> > + u32 sync_op_count = ctx->jobs[job_idx].syncop_count;
> > +
> > + for (u32 i = 0; i < sync_op_count; i++) {
> > + struct panthor_sync_signal *sig_sync;
> > + int ret;
> > +
> > + if (!(sync_ops[i].flags & DRM_PANTHOR_SYNC_OP_SIGNAL))
> > + continue;
> > +
> > + ret = panthor_check_sync_op(&sync_ops[i]);
> > + if (ret)
> > + return ret;
> > +
> > + sig_sync = panthor_submit_ctx_get_sync_signal(ctx,
> > + sync_ops[i].handle,
> > + sync_ops[i].timeline_value);
> > + if (IS_ERR(sig_sync))
> > + return PTR_ERR(sig_sync);
> > + }
> > +
> > + return 0;
> > +}
> > +
> > +/**
> > + * panthor_submit_ctx_push_fences() - Iterate over the signal array, and for each entry, push
> > + * the currently assigned fence to the associated syncobj.
> > + * @ctx: Context to push fences on.
> > + *
> > + * This is the last step of a submission procedure, and is done once we know the submission
> > + * is effective and job fences are guaranteed to be signaled in finite time.
> > + */
> > +static void
> > +panthor_submit_ctx_push_fences(struct panthor_submit_ctx *ctx)
> > +{
> > + struct panthor_sync_signal *sig_sync;
> > + unsigned long i;
> > +
> > + xa_for_each(&ctx->signal, i, sig_sync) {
> > + if (sig_sync->chain) {
> > + drm_syncobj_add_point(sig_sync->syncobj, sig_sync->chain,
> > + sig_sync->fence, sig_sync->point);
> > + sig_sync->chain = NULL;
> > + } else {
> > + drm_syncobj_replace_fence(sig_sync->syncobj, sig_sync->fence);
> > + }
> > + }
> > +}
> > +
> > +/**
> > + * panthor_submit_ctx_add_sync_deps_to_job() - Add sync wait operations as
> > + * job dependencies.
> > + * @ctx: Submit context.
> > + * @job_idx: Index of the job to operate on.
> > + *
> > + * Return: 0 on success, a negative error code otherwise.
> > + */
> > +static int
> > +panthor_submit_ctx_add_sync_deps_to_job(struct panthor_submit_ctx *ctx,
> > + u32 job_idx)
> > +{
> > + struct panthor_device *ptdev = container_of(ctx->file->minor->dev,
> > + struct panthor_device,
> > + base);
> > + const struct drm_panthor_sync_op *sync_ops = ctx->jobs[job_idx].syncops;
> > + struct drm_sched_job *job = ctx->jobs[job_idx].job;
> > + u32 sync_op_count = ctx->jobs[job_idx].syncop_count;
> > + int ret = 0;
> > +
> > + if (!sync_op_count)
> > + return 0;
>
> Not needed - the for loop will be skipped in this case anyway.
>
> > +
> > + for (u32 i = 0; i < sync_op_count; i++) {
> > + struct panthor_sync_signal *sig_sync;
> > + struct dma_fence *fence;
> > +
> > + if (sync_ops[i].flags & DRM_PANTHOR_SYNC_OP_SIGNAL)
> > + continue;
>
> NIT: It might be worth having a helper for the operation type. It's a
> little confusing that we have !(flags & SIGNAL) and (flags & SIGNAL) but
> not (flags & WAIT) - obviously looking at the definition shows why. Also
> there'll be a lot of careful refactoring needed if a third operation is
> ever added.
I had the operation as a separate field initially, but I couldn't think
of any other operations we could do on a syncobj, so I decided to make
it a flag, and mimic what Xe does.
>
> > +
> > + ret = panthor_check_sync_op(&sync_ops[i]);
> > + if (ret)
> > + return ret;
> > +
> > + sig_sync = panthor_submit_ctx_search_sync_signal(ctx, sync_ops[i].handle,
> > + sync_ops[i].timeline_value);
> > + if (sig_sync) {
> > + if (drm_WARN_ON(&ptdev->base, !sig_sync->fence))
> > + return -EINVAL;
> > +
> > + fence = dma_fence_get(sig_sync->fence);
> > + } else {
> > + ret = drm_syncobj_find_fence(ctx->file, sync_ops[i].handle,
> > + sync_ops[i].timeline_value,
> > + 0, &fence);
> > + if (ret)
> > + return ret;
> > + }
> > +
> > + ret = drm_sched_job_add_dependency(job, fence);
> > + if (ret)
> > + return ret;
> > + }
> > +
> > + return 0;
> > +}
> > +
> > +/**
> > + * panthor_submit_ctx_collect_jobs_signal_ops() - Collect all signal operations
> > + * and add them to the submit context.
> > + * @ctx: Submit context.
> > + *
> > + * Return: 0 on success, a negative error code otherwise.
> > + */
> > +static int
> > +panthor_submit_ctx_collect_jobs_signal_ops(struct panthor_submit_ctx *ctx)
> > +{
> > + for (u32 i = 0; i < ctx->job_count; i++) {
> > + int ret;
> > +
> > + ret = panthor_submit_ctx_collect_job_signal_ops(ctx, i);
> > + if (ret)
> > + return ret;
> > + }
> > +
> > + return 0;
> > +}
> > +
> > +/**
> > + * panthor_submit_ctx_add_deps_and_arm_jobs() - Add jobs dependencies and arm jobs
> > + * @ctx: Submit context.
> > + * @add_resvs_deps: Callback used to add implicit job dependencies.
> > + *
> > + * Must be called after panthor_submit_ctx_prepare_resvs().
> > + *
> > + * Return: 0 on success, a negative error code otherwise.
> > + */
> > +static int
> > +panthor_submit_ctx_add_deps_and_arm_jobs(struct panthor_submit_ctx *ctx,
> > + int (*add_resvs_deps)(struct drm_sched_job *))
> > +{
> > + for (u32 i = 0; i < ctx->job_count; i++) {
> > + int ret;
> > +
> > + ret = add_resvs_deps(ctx->jobs[i].job);
> > + if (ret)
> > + return ret;
> > +
> > + ret = panthor_submit_ctx_add_sync_deps_to_job(ctx, i);
> > + if (ret)
> > + return ret;
> > +
> > + drm_sched_job_arm(ctx->jobs[i].job);
> > +
> > + ret = panthor_submit_ctx_update_job_sync_signal_fences(ctx, i);
> > + if (ret)
> > + return ret;
> > + }
> > +
> > + return 0;
> > +}
> > +
> > +/**
> > + * panthor_submit_ctx_prepare_resvs() - Lock/prepare reservation objects for all jobs.
> > + * @ctx: Submit context.
> > + * @prep_resvs: Callback used to prepare reservation objects associated to a job.
> > + *
> > + * Return: 0 on success, a negative error code otherwise.
> > + */
> > +static int
> > +panthor_submit_ctx_prepare_resvs(struct panthor_submit_ctx *ctx,
> > + int (*prep_resvs)(struct drm_exec *, struct drm_sched_job *))
> > +{
> > + drm_exec_until_all_locked(&ctx->exec) {
> > + for (u32 i = 0; i < ctx->job_count; i++) {
> > + int ret = prep_resvs(&ctx->exec, ctx->jobs[i].job);
> > +
> > + drm_exec_retry_on_contention(&ctx->exec);
> > + if (ret)
> > + return ret;
> > + }
> > + }
> > +
> > + return 0;
> > +}
> > +
> > +/**
> > + * panthor_submit_ctx_push_jobs() - Push jobs to their scheduling entities.
> > + * @ctx: Submit context.
> > + * @upd_resvs: Callback used to update reservation objects that were prepared in
> > + * panthor_submit_ctx_prepare_resvs().
> > + */
> > +static void
> > +panthor_submit_ctx_push_jobs(struct panthor_submit_ctx *ctx,
> > + void (*upd_resvs)(struct drm_sched_job *))
> > +{
> > + for (u32 i = 0; i < ctx->job_count; i++) {
> > + upd_resvs(ctx->jobs[i].job);
> > + drm_sched_entity_push_job(ctx->jobs[i].job);
> > +
> > + /* Job is owned by the scheduler now. */
> > + ctx->jobs[i].job = NULL;
> > + }
> > +
> > + panthor_submit_ctx_push_fences(ctx);
> > +}
> > +
> > +/**
> > + * panthor_submit_ctx_init() - Initializes a submission context
> > + * @ctx: Submit context to initialize.
> > + * @file: drm_file this submission happens on.
> > + * @job_count: Number of jobs that will be submitted.
> > + *
> > + * Return: 0 on success, a negative error code otherwise.
> > + */
> > +static int panthor_submit_ctx_init(struct panthor_submit_ctx *ctx,
> > + struct drm_file *file, u32 job_count)
> > +{
> > + ctx->jobs = kvmalloc_array(job_count, sizeof(*ctx->jobs),
> > + GFP_KERNEL | __GFP_ZERO);
> > + if (!ctx->jobs)
> > + return -ENOMEM;
> > +
> > + ctx->file = file;
> > + ctx->job_count = job_count;
> > + xa_init_flags(&ctx->signal, XA_FLAGS_ALLOC);
> > + drm_exec_init(&ctx->exec, DRM_EXEC_INTERRUPTIBLE_WAIT | DRM_EXEC_IGNORE_DUPLICATES);
> > + return 0;
> > +}
> > +
> > +/**
> > + * panthor_submit_ctx_cleanup() - Cleanup a submission context
> > + * @ctx: Submit context to cleanup.
> > + */
> > +static void panthor_submit_ctx_cleanup(struct panthor_submit_ctx *ctx,
> > + void (*job_put)(struct drm_sched_job *))
> > +{
> > + struct panthor_sync_signal *sig_sync;
> > + unsigned long i;
> > +
> > + drm_exec_fini(&ctx->exec);
> > +
> > + xa_for_each(&ctx->signal, i, sig_sync)
> > + panthor_sync_signal_free(sig_sync);
> > +
> > + xa_destroy(&ctx->signal);
> > +
> > + for (i = 0; i < ctx->job_count; i++) {
> > + job_put(ctx->jobs[i].job);
> > + kvfree(ctx->jobs[i].syncops);
> > + }
> > +
> > + kvfree(ctx->jobs);
> > +}
> > +
> > +static int panthor_ioctl_dev_query(struct drm_device *ddev, void *data, struct drm_file *file)
> > +{
> > + struct panthor_device *ptdev = container_of(ddev, struct panthor_device, base);
> > + struct drm_panthor_dev_query *args = data;
> > +
> > + if (!args->pointer) {
> > + switch (args->type) {
> > + case DRM_PANTHOR_DEV_QUERY_GPU_INFO:
> > + args->size = sizeof(ptdev->gpu_info);
> > + return 0;
> > +
> > + case DRM_PANTHOR_DEV_QUERY_CSIF_INFO:
> > + args->size = sizeof(ptdev->csif_info);
> > + return 0;
> > +
> > + default:
> > + return -EINVAL;
> > + }
> > + }
> > +
> > + switch (args->type) {
> > + case DRM_PANTHOR_DEV_QUERY_GPU_INFO:
> > + return PANTHOR_UOBJ_SET(args->pointer, args->size, ptdev->gpu_info);
> > +
> > + case DRM_PANTHOR_DEV_QUERY_CSIF_INFO:
> > + return PANTHOR_UOBJ_SET(args->pointer, args->size, ptdev->csif_info);
> > +
> > + default:
> > + return -EINVAL;
> > + }
> > +}
> > +
> > +#define PANTHOR_VM_CREATE_FLAGS 0
> > +
> > +static int panthor_ioctl_vm_create(struct drm_device *ddev, void *data,
> > + struct drm_file *file)
> > +{
> > + struct panthor_device *ptdev = container_of(ddev, struct panthor_device, base);
> > + u32 va_bits = GPU_MMU_FEATURES_VA_BITS(ptdev->gpu_info.mmu_features);
> > + struct panthor_file *pfile = file->driver_priv;
> > + struct drm_panthor_vm_create *args = data;
> > + u64 kernel_va_start = 0;
> > + int cookie, ret;
> > +
> > + if (!drm_dev_enter(ddev, &cookie))
> > + return -ENODEV;
> > +
> > + if (args->flags & ~PANTHOR_VM_CREATE_FLAGS) {
> > + ret = -EINVAL;
> > + goto out_dev_exit;
> > + }
> > +
> > + if (drm_WARN_ON(ddev, !va_bits) || args->kernel_va_range > (1ull << (va_bits - 1))) {
>
> The check for !va_bits would be better done at probe time. I'd also be
> tempted to move the change for kernel_va_range down to
> panthor_vm_create() as that has to repeat the va_bits calculation.
>
> > + ret = -EINVAL;
> > + goto out_dev_exit;
> > + }
> > +
> > + if (args->kernel_va_range)
> > + kernel_va_start = (1 << (va_bits - 1)) - args->kernel_va_range;
>
> And also push the calculation of va_start down to
> panthor_vm_create() as well.
panthor_vm_create() is used internally, for the MCU VM creation, and
I'd prefer to keep it uAPI agnostic. I don't mind moving it to
panthor_vm_pool_create_vm() but we'd still have to do the va_bits
calculation twice.
>
> > +
> > + ret = panthor_vm_pool_create_vm(ptdev, pfile->vms,
> > + kernel_va_start, args->kernel_va_range);
> > + if (ret >= 0) {
> > + args->id = ret;
> > + ret = 0;
> > + }
> > +
> > +out_dev_exit:
> > + drm_dev_exit(cookie);
> > + return ret;
> > +}
> > +
> > +static int panthor_ioctl_vm_destroy(struct drm_device *ddev, void *data,
> > + struct drm_file *file)
> > +{
> > + struct panthor_file *pfile = file->driver_priv;
> > + struct drm_panthor_vm_destroy *args = data;
> > +
> > + if (args->pad)
> > + return -EINVAL;
> > +
> > + return panthor_vm_pool_destroy_vm(pfile->vms, args->id);
> > +}
> > +
> > +#define PANTHOR_BO_FLAGS DRM_PANTHOR_BO_NO_MMAP
> > +
> > +static int panthor_ioctl_bo_create(struct drm_device *ddev, void *data,
> > + struct drm_file *file)
> > +{
> > + struct panthor_file *pfile = file->driver_priv;
> > + struct panthor_gem_object *bo;
> > + struct drm_panthor_bo_create *args = data;
> > + struct panthor_vm *vm = NULL;
> > + int cookie, ret;
> > +
> > + if (!drm_dev_enter(ddev, &cookie))
> > + return -ENODEV;
> > +
> > + if (!args->size || args->pad ||
> > + (args->flags & ~PANTHOR_BO_FLAGS)) {
> > + ret = -EINVAL;
> > + goto out_dev_exit;
> > + }
> > +
> > + if (args->exclusive_vm_id) {
> > + vm = panthor_vm_pool_get_vm(pfile->vms, args->exclusive_vm_id);
> > + if (!vm) {
> > + ret = -EINVAL;
> > + goto out_dev_exit;
> > + }
> > + }
> > +
> > + bo = panthor_gem_create_with_handle(file, ddev, vm, args->size, args->flags,
> > + &args->handle);
>
> As mentioned before, we should have a function which just returns the
> handle, we don't need/want the BO here.
Sure, will do that.
>
> > +
> > + panthor_vm_put(vm);
> > +
> > + if (IS_ERR(bo))
> > + ret = PTR_ERR(bo);
> > + else
> > + ret = 0;
> > +
> > +out_dev_exit:
> > + drm_dev_exit(cookie);
> > + return ret;
> > +}
> > +
> > +static int panthor_ioctl_bo_mmap_offset(struct drm_device *ddev, void *data,
> > + struct drm_file *file)
> > +{
> > + struct drm_panthor_bo_mmap_offset *args = data;
> > + struct drm_gem_object *obj;
> > + int ret;
> > +
> > + if (args->pad)
> > + return -EINVAL;
> > +
> > + obj = drm_gem_object_lookup(file, args->handle);
> > + if (!obj)
> > + return -ENOENT;
> > +
> > + ret = drm_gem_create_mmap_offset(obj);
> > + if (ret)
> > + goto out;
> > +
> > + args->offset = drm_vma_node_offset_addr(&obj->vma_node);
> > +
> > +out:
> > + drm_gem_object_put(obj);
> > + return ret;
> > +}
> > +
> > +static int panthor_ioctl_group_submit(struct drm_device *ddev, void *data,
> > + struct drm_file *file)
> > +{
> > + struct panthor_file *pfile = file->driver_priv;
> > + struct drm_panthor_group_submit *args = data;
> > + struct drm_panthor_queue_submit *jobs_args;
> > + struct panthor_submit_ctx ctx;
> > + int ret = 0, cookie;
> > +
> > + if (args->pad)
> > + return -EINVAL;
> > +
> > + if (!drm_dev_enter(ddev, &cookie))
> > + return -ENODEV;
> > +
> > + ret = PANTHOR_UOBJ_GET_ARRAY(jobs_args, &args->queue_submits);
> > + if (ret)
> > + goto out_dev_exit;
> > +
> > + ret = panthor_submit_ctx_init(&ctx, file, args->queue_submits.count);
> > + if (ret)
> > + goto out_free_jobs_args;
> > +
> > + for (u32 i = 0; i < args->queue_submits.count; i++) {
> > + const struct drm_panthor_queue_submit *qsubmit = &jobs_args[i];
> > + struct drm_sched_job *job;
> > +
> > + job = panthor_job_create(pfile, args->group_handle, qsubmit);
> > + if (IS_ERR(job)) {
> > + ret = PTR_ERR(job);
> > + goto out_cleanup_submit_ctx;
> > + }
> > +
> > + ret = panthor_submit_ctx_add_job(&ctx, i, job, &qsubmit->syncs);
> > + if (ret)
> > + goto out_cleanup_submit_ctx;
> > + }
> > +
> > + ret = panthor_submit_ctx_collect_jobs_signal_ops(&ctx);
> > + if (ret)
> > + goto out_cleanup_submit_ctx;
> > +
> > + ret = panthor_submit_ctx_prepare_resvs(&ctx, panthor_job_prepare_resvs);
> > + if (ret)
> > + goto out_cleanup_submit_ctx;
> > +
> > + ret = panthor_submit_ctx_add_deps_and_arm_jobs(&ctx, panthor_job_add_resvs_deps);
> > + if (ret)
> > + goto out_cleanup_submit_ctx;
> > +
> > + /* Nothing can fail after that point. */
> > + panthor_submit_ctx_push_jobs(&ctx, panthor_job_update_resvs);
> > +
> > +out_cleanup_submit_ctx:
> > + panthor_submit_ctx_cleanup(&ctx, panthor_job_put);
> > +
> > +out_free_jobs_args:
> > + kvfree(jobs_args);
> > +
> > +out_dev_exit:
> > + drm_dev_exit(cookie);
> > + return ret;
> > +}
> > +
> > +static int panthor_ioctl_group_destroy(struct drm_device *ddev, void *data,
> > + struct drm_file *file)
> > +{
> > + struct panthor_file *pfile = file->driver_priv;
> > + struct drm_panthor_group_destroy *args = data;
> > +
> > + if (args->pad)
> > + return -EINVAL;
> > +
> > + return panthor_group_destroy(pfile, args->group_handle);
> > +}
> > +
> > +static int panthor_ioctl_group_create(struct drm_device *ddev, void *data,
> > + struct drm_file *file)
> > +{
> > + struct panthor_file *pfile = file->driver_priv;
> > + struct drm_panthor_group_create *args = data;
> > + struct drm_panthor_queue_create *queue_args;
> > + int ret;
> > +
> > + if (!args->queues.count)
> > + return -EINVAL;
> > +
> > + ret = PANTHOR_UOBJ_GET_ARRAY(queue_args, &args->queues);
> > + if (ret)
> > + return ret;
> > +
> > + ret = panthor_group_create(pfile, args, queue_args);
> > + if (ret >= 0) {
> > + args->group_handle = ret;
> > + ret = 0;
> > + }
> > +
> > + kvfree(queue_args);
> > + return ret;
> > +}
> > +
> > +static int panthor_ioctl_group_get_state(struct drm_device *ddev, void *data,
> > + struct drm_file *file)
> > +{
> > + struct panthor_file *pfile = file->driver_priv;
> > + struct drm_panthor_group_get_state *args = data;
> > +
> > + return panthor_group_get_state(pfile, args);
> > +}
> > +
> > +static int panthor_ioctl_tiler_heap_create(struct drm_device *ddev, void *data,
> > + struct drm_file *file)
> > +{
> > + struct panthor_file *pfile = file->driver_priv;
> > + struct drm_panthor_tiler_heap_create *args = data;
> > + struct panthor_heap_pool *pool;
> > + struct panthor_vm *vm;
> > + int ret;
> > +
> > + vm = panthor_vm_pool_get_vm(pfile->vms, args->vm_id);
> > + if (!vm)
> > + return -EINVAL;
> > +
> > + pool = panthor_vm_get_heap_pool(vm, true);
> > + if (IS_ERR(pool)) {
> > + ret = PTR_ERR(pool);
> > + goto out_put_vm;
> > + }
> > +
> > + ret = panthor_heap_create(pool,
> > + args->initial_chunk_count,
> > + args->chunk_size,
> > + args->max_chunks,
> > + args->target_in_flight,
> > + &args->tiler_heap_ctx_gpu_va,
> > + &args->first_heap_chunk_gpu_va);
> > + if (ret < 0)
> > + goto out_put_heap_pool;
> > +
> > + /* Heap pools are per-VM. We combine the VM and HEAP id to make
> > + * a unique heap handle.
> > + */
> > + args->handle = (args->vm_id << 16) | ret;
> > + ret = 0;
> > +
> > +out_put_heap_pool:
> > + panthor_heap_pool_put(pool);
> > +
> > +out_put_vm:
> > + panthor_vm_put(vm);
> > + return ret;
> > +}
> > +
> > +static int panthor_ioctl_tiler_heap_destroy(struct drm_device *ddev, void *data,
> > + struct drm_file *file)
> > +{
> > + struct panthor_file *pfile = file->driver_priv;
> > + struct drm_panthor_tiler_heap_destroy *args = data;
> > + struct panthor_heap_pool *pool;
> > + struct panthor_vm *vm;
> > + int ret;
> > +
> > + if (args->pad)
> > + return -EINVAL;
> > +
> > + vm = panthor_vm_pool_get_vm(pfile->vms, args->handle >> 16);
> > + if (!vm)
> > + return -EINVAL;
> > +
> > + pool = panthor_vm_get_heap_pool(vm, false);
> > + if (!pool) {
> > + ret = -EINVAL;
> > + goto out_put_vm;
> > + }
> > +
> > + ret = panthor_heap_destroy(pool, args->handle & GENMASK(15, 0));
> > + panthor_heap_pool_put(pool);
> > +
> > +out_put_vm:
> > + panthor_vm_put(vm);
> > + return ret;
> > +}
> > +
> > +static int panthor_ioctl_vm_bind_async(struct drm_device *ddev,
> > + struct drm_panthor_vm_bind *args,
> > + struct drm_file *file)
> > +{
> > + struct panthor_file *pfile = file->driver_priv;
> > + struct drm_panthor_vm_bind_op *jobs_args;
> > + struct panthor_submit_ctx ctx;
> > + struct panthor_vm *vm;
> > + int ret = 0;
> > +
> > + vm = panthor_vm_pool_get_vm(pfile->vms, args->vm_id);
> > + if (!vm)
> > + return -EINVAL;
> > +
> > + ret = PANTHOR_UOBJ_GET_ARRAY(jobs_args, &args->ops);
> > + if (ret)
> > + goto out_put_vm;
> > +
> > + ret = panthor_submit_ctx_init(&ctx, file, args->ops.count);
> > + if (ret)
> > + goto out_free_jobs_args;
> > +
> > + for (u32 i = 0; i < args->ops.count; i++) {
> > + struct drm_panthor_vm_bind_op *op = &jobs_args[i];
> > + struct drm_sched_job *job;
> > +
> > + job = panthor_vm_bind_job_create(file, vm, op);
> > + if (IS_ERR(job)) {
> > + ret = PTR_ERR(job);
> > + goto out_cleanup_submit_ctx;
> > + }
> > +
> > + ret = panthor_submit_ctx_add_job(&ctx, i, job, &op->syncs);
> > + if (ret)
> > + goto out_cleanup_submit_ctx;
> > + }
> > +
> > + ret = panthor_submit_ctx_collect_jobs_signal_ops(&ctx);
> > + if (ret)
> > + goto out_cleanup_submit_ctx;
> > +
> > + ret = panthor_submit_ctx_prepare_resvs(&ctx, panthor_vm_bind_job_prepare_resvs);
> > + if (ret)
> > + goto out_cleanup_submit_ctx;
> > +
> > + ret = panthor_submit_ctx_add_deps_and_arm_jobs(&ctx, panthor_vm_bind_job_add_resvs_deps);
> > + if (ret)
> > + goto out_cleanup_submit_ctx;
> > +
> > + /* Nothing can fail after that point. */
> > + panthor_submit_ctx_push_jobs(&ctx, panthor_vm_bind_job_update_resvs);
> > +
> > +out_cleanup_submit_ctx:
> > + panthor_submit_ctx_cleanup(&ctx, panthor_vm_bind_job_put);
> > +
> > +out_free_jobs_args:
> > + kvfree(jobs_args);
> > +
> > +out_put_vm:
> > + panthor_vm_put(vm);
> > + return ret;
> > +}
> > +
> > +static int panthor_ioctl_vm_bind_sync(struct drm_device *ddev,
> > + struct drm_panthor_vm_bind *args,
> > + struct drm_file *file)
> > +{
> > + struct panthor_file *pfile = file->driver_priv;
> > + struct drm_panthor_vm_bind_op *jobs_args;
> > + struct panthor_vm *vm;
> > + int ret;
> > +
> > + vm = panthor_vm_pool_get_vm(pfile->vms, args->vm_id);
> > + if (!vm)
> > + return -EINVAL;
> > +
> > + ret = PANTHOR_UOBJ_GET_ARRAY(jobs_args, &args->ops);
> > + if (ret)
> > + goto out_put_vm;
> > +
> > + for (u32 i = 0; i < args->ops.count; i++) {
> > + ret = panthor_vm_bind_exec_sync_op(file, vm, &jobs_args[i]);
> > + if (ret) {
> > + /* Update ops.count so the user knows where things failed. */
>
> It might be worth mentioning this in the UAPI header as the array count
> wouldn't usually be modified.
Will do. Note that it's only the case for synchronous operations.
>
> > + args->ops.count = i;
> > + break;
> > + }
> > + }
> > +
> > + kvfree(jobs_args);
> > +
> > +out_put_vm:
> > + panthor_vm_put(vm);
> > + return ret;
> > +}
> > +
> > +#define PANTHOR_VM_BIND_FLAGS DRM_PANTHOR_VM_BIND_ASYNC
> > +
> > +static int panthor_ioctl_vm_bind(struct drm_device *ddev, void *data,
> > + struct drm_file *file)
> > +{
> > + struct drm_panthor_vm_bind *args = data;
> > + int cookie, ret;
> > +
> > + if (!drm_dev_enter(ddev, &cookie))
> > + return -ENODEV;
> > +
> > + if (args->flags & DRM_PANTHOR_VM_BIND_ASYNC)
> > + ret = panthor_ioctl_vm_bind_async(ddev, args, file);
> > + else
> > + ret = panthor_ioctl_vm_bind_sync(ddev, args, file);
> > +
> > + drm_dev_exit(cookie);
> > + return ret;
> > +}
> > +
> > +static int
> > +panthor_open(struct drm_device *ddev, struct drm_file *file)
> > +{
> > + struct panthor_device *ptdev = container_of(ddev, struct panthor_device, base);
> > + struct panthor_file *pfile;
> > + int ret;
> > +
> > + if (!try_module_get(THIS_MODULE))
> > + return -EINVAL;
> > +
> > + pfile = kzalloc(sizeof(*pfile), GFP_KERNEL);
> > + if (!pfile) {
> > + ret = -ENOMEM;
> > + goto err_put_mod;
> > + }
> > +
> > + pfile->ptdev = ptdev;
> > +
> > + ret = panthor_vm_pool_create(pfile);
> > + if (ret)
> > + goto err_free_file;
> > +
> > + ret = panthor_group_pool_create(pfile);
> > + if (ret)
> > + goto err_destroy_vm_pool;
> > +
> > + file->driver_priv = pfile;
> > + return 0;
> > +
> > +err_destroy_vm_pool:
> > + panthor_vm_pool_destroy(pfile);
> > +
> > +err_free_file:
> > + kfree(pfile);
> > +
> > +err_put_mod:
> > + module_put(THIS_MODULE);
> > + return ret;
> > +}
> > +
> > +static void
> > +panthor_postclose(struct drm_device *ddev, struct drm_file *file)
> > +{
> > + struct panthor_file *pfile = file->driver_priv;
> > +
> > + panthor_group_pool_destroy(pfile);
> > + panthor_vm_pool_destroy(pfile);
> > +
> > + kfree(pfile);
> > + module_put(THIS_MODULE);
> > +}
> > +
> > +static const struct drm_ioctl_desc panthor_drm_driver_ioctls[] = {
> > +#define PANTHOR_IOCTL(n, func, flags) \
> > + DRM_IOCTL_DEF_DRV(PANTHOR_##n, panthor_ioctl_##func, flags)
> > +
> > + PANTHOR_IOCTL(DEV_QUERY, dev_query, DRM_RENDER_ALLOW),
> > + PANTHOR_IOCTL(VM_CREATE, vm_create, DRM_RENDER_ALLOW),
> > + PANTHOR_IOCTL(VM_DESTROY, vm_destroy, DRM_RENDER_ALLOW),
> > + PANTHOR_IOCTL(VM_BIND, vm_bind, DRM_RENDER_ALLOW),
> > + PANTHOR_IOCTL(BO_CREATE, bo_create, DRM_RENDER_ALLOW),
> > + PANTHOR_IOCTL(BO_MMAP_OFFSET, bo_mmap_offset, DRM_RENDER_ALLOW),
> > + PANTHOR_IOCTL(GROUP_CREATE, group_create, DRM_RENDER_ALLOW),
> > + PANTHOR_IOCTL(GROUP_DESTROY, group_destroy, DRM_RENDER_ALLOW),
> > + PANTHOR_IOCTL(GROUP_GET_STATE, group_get_state, DRM_RENDER_ALLOW),
> > + PANTHOR_IOCTL(TILER_HEAP_CREATE, tiler_heap_create, DRM_RENDER_ALLOW),
> > + PANTHOR_IOCTL(TILER_HEAP_DESTROY, tiler_heap_destroy, DRM_RENDER_ALLOW),
> > + PANTHOR_IOCTL(GROUP_SUBMIT, group_submit, DRM_RENDER_ALLOW),
> > +};
> > +
> > +static int panthor_mmap(struct file *filp, struct vm_area_struct *vma)
> > +{
> > + struct drm_file *file = filp->private_data;
> > + struct panthor_file *pfile = file->driver_priv;
> > + struct panthor_device *ptdev = pfile->ptdev;
> > + int ret, cookie;
> > +
> > + if (!drm_dev_enter(file->minor->dev, &cookie))
> > + return -ENODEV;
> > +
> > + if (vma->vm_pgoff >= (DRM_PANTHOR_USER_MMIO_OFFSET >> PAGE_SHIFT))
> > + ret = panthor_device_mmap_io(ptdev, vma);
> > + else
> > + ret = drm_gem_mmap(filp, vma);
> > +
> > + drm_dev_exit(cookie);
> > + return ret;
> > +}
> > +
> > +static const struct file_operations panthor_drm_driver_fops = {
> > + .open = drm_open,
> > + .release = drm_release,
> > + .unlocked_ioctl = drm_ioctl,
> > + .compat_ioctl = drm_compat_ioctl,
> > + .poll = drm_poll,
> > + .read = drm_read,
> > + .llseek = noop_llseek,
> > + .mmap = panthor_mmap,
> > +};
> > +
> > +#ifdef CONFIG_DEBUG_FS
> > +void panthor_debugfs_init(struct drm_minor *minor)
> > +{
> > + panthor_mmu_debugfs_init(minor);
> > +}
> > +#endif
> > +
> > +/*
> > + * PanCSF driver version:
> > + * - 1.0 - initial interface
> > + */
> > +static const struct drm_driver panthor_drm_driver = {
> > + .driver_features = DRIVER_RENDER | DRIVER_GEM | DRIVER_SYNCOBJ |
> > + DRIVER_SYNCOBJ_TIMELINE | DRIVER_GEM_GPUVA,
> > + .open = panthor_open,
> > + .postclose = panthor_postclose,
> > + .ioctls = panthor_drm_driver_ioctls,
> > + .num_ioctls = ARRAY_SIZE(panthor_drm_driver_ioctls),
> > + .fops = &panthor_drm_driver_fops,
> > + .name = "panthor",
> > + .desc = "Panthor DRM driver",
> > + .date = "20230801",
> > + .major = 1,
> > + .minor = 0,
> > +
> > + .gem_create_object = panthor_gem_create_object,
> > + .gem_prime_import_sg_table = drm_gem_shmem_prime_import_sg_table,
> > +#ifdef CONFIG_DEBUG_FS
> > + .debugfs_init = panthor_debugfs_init,
> > +#endif
> > +};
> > +
> > +static int panthor_probe(struct platform_device *pdev)
> > +{
> > + struct panthor_device *ptdev;
> > + int ret;
> > +
> > + ptdev = devm_drm_dev_alloc(&pdev->dev, &panthor_drm_driver,
> > + struct panthor_device, base);
> > + if (!ptdev)
> > + return -ENOMEM;
> > +
> > + platform_set_drvdata(pdev, ptdev);
> > +
> > + ret = panthor_device_init(ptdev);
> > + if (ret)
> > + return ret;
> > +
> > + return drm_dev_register(&ptdev->base, 0);
> > +}
> > +
> > +static void panthor_remove(struct platform_device *pdev)
> > +{
> > + struct panthor_device *ptdev = platform_get_drvdata(pdev);
> > +
> > + panthor_device_unplug(ptdev);
> > +}
> > +
> > +static const struct of_device_id dt_match[] = {
> > + { .compatible = "rockchip,rk3588-mali" },
> > + { .compatible = "arm,mali-valhall-csf" },
> > + {}
> > +};
> > +MODULE_DEVICE_TABLE(of, dt_match);
> > +
> > +static DEFINE_RUNTIME_DEV_PM_OPS(panthor_pm_ops,
> > + panthor_device_suspend,
> > + panthor_device_resume,
> > + NULL);
> > +
> > +static struct platform_driver panthor_driver = {
> > + .probe = panthor_probe,
> > + .remove_new = panthor_remove,
> > + .driver = {
> > + .name = "panthor",
> > + .pm = &panthor_pm_ops,
> > + .of_match_table = dt_match,
> > + },
> > +};
> > +
> > +/**
> > + * @cleanup_wq: Workqueue used to cleanup stuff.
> > + *
> > + * We create a dedicated workqueue so we can drain on unplug and
> > + * make sure all resources are freed before the module is unloaded.
> > + */
> > +struct workqueue_struct *panthor_cleanup_wq;
> > +
> > +static int __init panthor_init(void)
> > +{
> > + int ret;
> > +
> > + ret = panthor_mmu_pt_cache_init();
> > + if (ret)
> > + return ret;
> > +
> > + panthor_cleanup_wq = alloc_workqueue("panthor-cleanup", WQ_UNBOUND, 0);
> > + if (!panthor_cleanup_wq) {
> > + pr_err("panthor: Failed to allocate the workqueues");
> > + ret = -ENOMEM;
> > + goto err_mmu_pt_cache_fini;
> > + }
> > +
> > + ret = platform_driver_register(&panthor_driver);
> > + if (ret)
> > + goto err_destroy_cleanup_wq;
> > +
> > + return ret;
> > +
> > +err_mmu_pt_cache_fini:
> > + panthor_mmu_pt_cache_fini();
> > +
> > +err_destroy_cleanup_wq:
> > + destroy_workqueue(panthor_cleanup_wq);
>
> This cleanup looks backwards.
Oops, will fix that.
More information about the dri-devel
mailing list