* Danilo Krummrich <dakr@xxxxxxxxxx> [230222 13:13]:
> On 2/21/23 19:20, Liam R. Howlett wrote:
> > * Danilo Krummrich <dakr@xxxxxxxxxx> [230217 08:45]:
> > > Add infrastructure to keep track of GPU virtual address (VA) mappings
> > > with a decicated VA space manager implementation.
> > >
> > > New UAPIs, motivated by Vulkan sparse memory bindings graphics drivers
> > > start implementing, allow userspace applications to request multiple and
> > > arbitrary GPU VA mappings of buffer objects. The DRM GPU VA manager is
> > > intended to serve the following purposes in this context.
> > >
> > > 1) Provide infrastructure to track GPU VA allocations and mappings,
> > > making use of the maple_tree.
> > >
> > > 2) Generically connect GPU VA mappings to their backing buffers, in
> > > particular DRM GEM objects.
> > >
> > > 3) Provide a common implementation to perform more complex mapping
> > > operations on the GPU VA space. In particular splitting and merging
> > > of GPU VA mappings, e.g. for intersecting mapping requests or partial
> > > unmap requests.
> > >
> > > Suggested-by: Dave Airlie <airlied@xxxxxxxxxx>
> > > Signed-off-by: Danilo Krummrich <dakr@xxxxxxxxxx>
> > > ---
> > > Documentation/gpu/drm-mm.rst | 31 +
> > > drivers/gpu/drm/Makefile | 1 +
> > > drivers/gpu/drm/drm_gem.c | 3 +
> > > drivers/gpu/drm/drm_gpuva_mgr.c | 1704 +++++++++++++++++++++++++++++++
> > > include/drm/drm_drv.h | 6 +
> > > include/drm/drm_gem.h | 75 ++
> > > include/drm/drm_gpuva_mgr.h | 714 +++++++++++++
> > > 7 files changed, 2534 insertions(+)
> > > create mode 100644 drivers/gpu/drm/drm_gpuva_mgr.c
> > > create mode 100644 include/drm/drm_gpuva_mgr.h
> > >
> > > diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst
> > > index a52e6f4117d6..c9f120cfe730 100644
> > > --- a/Documentation/gpu/drm-mm.rst
> > > +++ b/Documentation/gpu/drm-mm.rst
> > > @@ -466,6 +466,37 @@ DRM MM Range Allocator Function References
> > > .. kernel-doc:: drivers/gpu/drm/drm_mm.c
> > > :export:
> > ...
> >
> > > +
> > > +/**
> > > + * drm_gpuva_remove_iter - removes the iterators current element
> > > + * @it: the &drm_gpuva_iterator
> > > + *
> > > + * This removes the element the iterator currently points to.
> > > + */
> > > +void
> > > +drm_gpuva_iter_remove(struct drm_gpuva_iterator *it)
> > > +{
> > > + mas_erase(&it->mas);
> > > +}
> > > +EXPORT_SYMBOL(drm_gpuva_iter_remove);
> > > +
> > > +/**
> > > + * drm_gpuva_insert - insert a &drm_gpuva
> > > + * @mgr: the &drm_gpuva_manager to insert the &drm_gpuva in
> > > + * @va: the &drm_gpuva to insert
> > > + * @addr: the start address of the GPU VA
> > > + * @range: the range of the GPU VA
> > > + *
> > > + * Insert a &drm_gpuva with a given address and range into a
> > > + * &drm_gpuva_manager.
> > > + *
> > > + * Returns: 0 on success, negative error code on failure.
> > > + */
> > > +int
> > > +drm_gpuva_insert(struct drm_gpuva_manager *mgr,
> > > + struct drm_gpuva *va)
> > > +{
> > > + u64 addr = va->va.addr;
> > > + u64 range = va->va.range;
> > > + MA_STATE(mas, &mgr->va_mt, addr, addr + range - 1);
> > > + struct drm_gpuva_region *reg = NULL;
> > > + int ret;
> > > +
> > > + if (unlikely(!drm_gpuva_in_mm_range(mgr, addr, range)))
> > > + return -EINVAL;
> > > +
> > > + if (unlikely(drm_gpuva_in_kernel_region(mgr, addr, range)))
> > > + return -EINVAL;
> > > +
> > > + if (mgr->flags & DRM_GPUVA_MANAGER_REGIONS) {
> > > + reg = drm_gpuva_in_region(mgr, addr, range);
> > > + if (unlikely(!reg))
> > > + return -EINVAL;
> > > + }
> > > +
> >
> > -----
> >
> > > + if (unlikely(drm_gpuva_find_first(mgr, addr, range)))
> > > + return -EEXIST;
> > > +
> > > + ret = mas_store_gfp(&mas, va, GFP_KERNEL);
> >
> > mas_walk() will set the internal maple state to the limits to what it
> > finds. So, instead of an iterator, you can use the walk function and
> > ensure there is a large enough area in the existing NULL:
> >
> > /*
> > * Nothing at addr, mas now points to the location where the store would
> > * happen
> > */
> > if (mas_walk(&mas))
> > return -EEXIST;
> >
> > /* The NULL entry ends at mas.last, make sure there is room */
> > if (mas.last < (addr + range - 1))
> > return -EEXIST;
> >
> > /* Limit the store size to the correct end address, and store */
> > mas.last = addr + range - 1;
> > ret = mas_store_gfp(&mas, va, GFP_KERNEL);
> >
>
> Would this variant be significantly more efficient?
Well, what you are doing is walking the tree to see if there's anything
there... then re-walking the tree to store it. So, yes, it's much more
efficient.. However, writing is heavier. How much of the time is spent
walking vs writing depends on the size of the tree, but it's rather easy
to do this in a single walk of the tree so why wouldn't you?
>
> Also, would this also work while already walking the tree?
Yes, to an extent. If you are at the correct location in the tree, you
can write to that location. If you are not in the correct location and
try to write to the tree then things will go poorly.. In this scenario,
we are very much walking the tree and writing to it in two steps.
>
> To remove an entry while walking the tree I have a separate function
> drm_gpuva_iter_remove(). Would I need something similar for inserting
> entries?
I saw that. Your remove function uses the erase operation which is
implemented as a walk to that location and a store of a null over the
range that is returned. You do not need a function to insert an entry
if the maple state is at the correct location, and that doesn't just
mean setting mas.index/mas.last to the correct value. There is a node &
offset saved in the maple state that needs to be in the correct
location. If you store to that node then the node may be replaced, so
other iterators that you have may become stale, but the one you used
execute the store operation will now point to the new node with the new
entry.
>
> I already provided this example in a separate mail thread, but it may makes
> sense to move this to the mailing list:
>
> In __drm_gpuva_sm_map() we're iterating a given range of the tree, where the
> given range is the size of the newly requested mapping. __drm_gpuva_sm_map()
> invokes a callback for each sub-operation that needs to be taken in order to
> fulfill this mapping request. In most cases such a callback just creates a
> drm_gpuva_op object and stores it in a list.
>
> However, drivers can also implement the callback, such that they directly
> execute this operation within the callback.
>
> Let's have a look at the following example:
>
> 0 a 2
> old: |-----------| (bo_offset=n)
>
> 1 b 3
> req: |-----------| (bo_offset=m)
>
> 0 a' 1 b 3
> new: |-----|-----------| (a.bo_offset=n,b.bo_offset=m)
>
> This would result in the following operations.
>
> __drm_gpuva_sm_map() finds entry "a" and calls back into the driver
> suggesting to re-map "a" with the new size. The driver removes entry "a"
> from the tree and adds "a'"
What you have here won't work. The driver will cause your iterators
maple state to point to memory that is freed. You will either need to
pass through your iterator so that the modifications can occur with that
maple state so it remains valid, or you will need to invalidate the
iterator on every modification by the driver.
I'm sure the first idea you have will be to invalidate the iterator, but
that is probably not the way to proceed. Even ignoring the unclear
locking of two maple states trying to modify the tree, this is rather
inefficient - each invalidation means a re-walk of the tree. You may as
well not use an iterator in this case.
Depending on how/when the lookups occur, you could still iterate over
the tree and let the driver modify the ending of "a", but leave the tree
alone and just store b over whatever - but the failure scenarios may
cause you grief.
If you pass the iterator through, then you can just use it to do your
writes and keep iterating as if nothing changed.
>
> __drm_gpuva_sm_map(), ideally, continues the loop searching for nodes
> starting from the end of "a" (which is 2) till the end of the requested
> mapping "b" (which is 3). Since it doesn't find any other mapping within
> this range it calls back into the driver suggesting to finally map "b".
>
> If there would have been another mapping between 2 and 3 it would have
> called back into the driver asking to unmap this mapping beforehand.
>
> So, it boils down to re-mapping as described at the beginning (and
> analogously at the end) of a new mapping range and removing of entries that
> are enclosed by the new mapping range.
I assume the unmapped area is no longer needed, and the 're-map' is
really a removal of information? Otherwise I'd suggest searching for a
gap which fits your request. What you have here is a lot like
"MAP_FIXED" vs top-down/bottom-up search in the VMA code, this seems to
be like your __drm_gpuva_sm_map() and the drm mm range allocator with
DRM_MM_INSERT_LOW, and DRM_MM_INSERT_HIGH.
Why can these split/unmappings fail? Is it because they are still
needed?
>
> > > + if (unlikely(ret))
> > > + return ret;
> > > +
> > > + va->mgr = mgr;
> > > + va->region = reg;
> > > +
> > > + return 0;
> > > +}
> > > +EXPORT_SYMBOL(drm_gpuva_insert);
> > > +
> > > +/**
> > > + * drm_gpuva_remove - remove a &drm_gpuva
> > > + * @va: the &drm_gpuva to remove
> > > + *
> > > + * This removes the given &va from the underlaying tree.
> > > + */
> > > +void
> > > +drm_gpuva_remove(struct drm_gpuva *va)
> > > +{
> > > + MA_STATE(mas, &va->mgr->va_mt, va->va.addr, 0);
> > > +
> > > + mas_erase(&mas);
> > > +}
> > > +EXPORT_SYMBOL(drm_gpuva_remove);
> > > +
> > ...
> >
> > > +/**
> > > + * drm_gpuva_find_first - find the first &drm_gpuva in the given range
> > > + * @mgr: the &drm_gpuva_manager to search in
> > > + * @addr: the &drm_gpuvas address
> > > + * @range: the &drm_gpuvas range
> > > + *
> > > + * Returns: the first &drm_gpuva within the given range
> > > + */
> > > +struct drm_gpuva *
> > > +drm_gpuva_find_first(struct drm_gpuva_manager *mgr,
> > > + u64 addr, u64 range)
> > > +{
> > > + MA_STATE(mas, &mgr->va_mt, addr, 0);
> > > +
> > > + return mas_find(&mas, addr + range - 1);
> > > +}
> > > +EXPORT_SYMBOL(drm_gpuva_find_first);
> > > +
> > > +/**
> > > + * drm_gpuva_find - find a &drm_gpuva
> > > + * @mgr: the &drm_gpuva_manager to search in
> > > + * @addr: the &drm_gpuvas address
> > > + * @range: the &drm_gpuvas range
> > > + *
> > > + * Returns: the &drm_gpuva at a given &addr and with a given &range
> >
> > Note that mas_find() will continue upwards in the address space if there
> > isn't anything at @addr. This means that &drm_gpuva may not be at
> > &addr. If you want to check just at &addr, use mas_walk().
>
> Good catch. drm_gpuva_find() should then either also check for 'va->va.addr
> == addr' as well or, alternatively, use mas_walk(). As above, any reason to
> prefer mas_walk()?
>
> >
> > > + */
> > > +struct drm_gpuva *
> > > +drm_gpuva_find(struct drm_gpuva_manager *mgr,
> > > + u64 addr, u64 range)
> > > +{
> > > + struct drm_gpuva *va;
> > > +
> > > + va = drm_gpuva_find_first(mgr, addr, range);
> > > + if (!va)
> > > + goto out;
> > > +
> > > + if (va->va.range != range)
> > > + goto out;
> > > +
> > > + return va;
> > > +
> > > +out:
> > > + return NULL;
> > > +}
> > > +EXPORT_SYMBOL(drm_gpuva_find);
> > > +
> > > +/**
> > > + * drm_gpuva_find_prev - find the &drm_gpuva before the given address
> > > + * @mgr: the &drm_gpuva_manager to search in
> > > + * @start: the given GPU VA's start address
> > > + *
> > > + * Find the adjacent &drm_gpuva before the GPU VA with given &start address.
> > > + *
> > > + * Note that if there is any free space between the GPU VA mappings no mapping
> > > + * is returned.
> > > + *
> > > + * Returns: a pointer to the found &drm_gpuva or NULL if none was found
> > > + */
> > > +struct drm_gpuva *
> > > +drm_gpuva_find_prev(struct drm_gpuva_manager *mgr, u64 start)
> >
> > find_prev() usually continues beyond 1 less than the address. I found
> > this name confusing.
>
> Don't really get that, mind explaining?
When I ask for the previous one in a list or tree, I think the one
before.. but since you are limiting your search from start to start - 1,
you may as well walk to start - 1 and see if one exists.
Is that what you meant to do here?
>
> > You may as well use mas_walk(), it would be faster.
>
> How would I use mas_walk() for that? If I understand it correctly,
> mas_walk() requires me to know that start address, which I don't know for
> the previous entry.
mas_walk() walks to the value you specify and returns the entry at that
address, not necessarily the start address, but any address in the
range.
If you have a tree and store A = [0x1000 - 0x2000] and set your maple
state to walk to 0x1500, mas_walk() will return A, and the maple state
will have mas.index = 0x1000 and mas.last = 0x2000.
You have set the maple state to start at "start" and called
mas_prev(&mas, start - 1). start - 1 is the lower limit, so the
internal implementation will walk to start then go to the previous entry
until start - 1.. it will stop at start - 1 and return NULL if there
isn't one there.
>
> However, mas_walk() seems to be a good alternative to use for
> drm_gpuva_find_next().
>
> > > +{
> > > + MA_STATE(mas, &mgr->va_mt, start, 0);
> > > +
> > > + if (start <= mgr->mm_start ||
> > > + start > (mgr->mm_start + mgr->mm_range))
> > > + return NULL;
> > > +
> > > + return mas_prev(&mas, start - 1);
> > > +}
> > > +EXPORT_SYMBOL(drm_gpuva_find_prev);
> > > +
> > > +/**
> > > + * drm_gpuva_find_next - find the &drm_gpuva after the given address
> > > + * @mgr: the &drm_gpuva_manager to search in
> > > + * @end: the given GPU VA's end address
> > > + *
> > > + * Find the adjacent &drm_gpuva after the GPU VA with given &end address.
> > > + *
> > > + * Note that if there is any free space between the GPU VA mappings no mapping
> > > + * is returned.
> > > + *
> > > + * Returns: a pointer to the found &drm_gpuva or NULL if none was found
> > > + */
> > > +struct drm_gpuva *
> > > +drm_gpuva_find_next(struct drm_gpuva_manager *mgr, u64 end)
> >
> > This name is also a bit confusing for the same reason. Again, it seems
> > worth just walking to end here.
> >
> > > +{
> > > + MA_STATE(mas, &mgr->va_mt, end - 1, 0);
> > > +
> > > + if (end < mgr->mm_start ||
> > > + end >= (mgr->mm_start + mgr->mm_range))
> > > + return NULL;
> > > +
> > > + return mas_next(&mas, end);
> > > +}
> > > +EXPORT_SYMBOL(drm_gpuva_find_next);
> > > +
> > > +static int
> > > +__drm_gpuva_region_insert(struct drm_gpuva_manager *mgr,
> > > + struct drm_gpuva_region *reg)
> > > +{
> > > + u64 addr = reg->va.addr;
> > > + u64 range = reg->va.range;
> > > + MA_STATE(mas, &mgr->region_mt, addr, addr + range - 1);
> > > + int ret;
> > > +
> > > + if (unlikely(!drm_gpuva_in_mm_range(mgr, addr, range)))
> > > + return -EINVAL;
> > > +
> > > + ret = mas_store_gfp(&mas, reg, GFP_KERNEL);
> > > + if (unlikely(ret))
> > > + return ret;
> > > +
> > > + reg->mgr = mgr;
> > > +
> > > + return 0;
> > > +}
> > > +
> > > +/**
> > > + * drm_gpuva_region_insert - insert a &drm_gpuva_region
> > > + * @mgr: the &drm_gpuva_manager to insert the &drm_gpuva in
> > > + * @reg: the &drm_gpuva_region to insert
> > > + * @addr: the start address of the GPU VA
> > > + * @range: the range of the GPU VA
> > > + *
> > > + * Insert a &drm_gpuva_region with a given address and range into a
> > > + * &drm_gpuva_manager.
> > > + *
> > > + * Returns: 0 on success, negative error code on failure.
> > > + */
> > > +int
> > > +drm_gpuva_region_insert(struct drm_gpuva_manager *mgr,
> > > + struct drm_gpuva_region *reg)
> > > +{
> > > + if (unlikely(!(mgr->flags & DRM_GPUVA_MANAGER_REGIONS)))
> > > + return -EINVAL;
> > > +
> > > + return __drm_gpuva_region_insert(mgr, reg);
> > > +}
> > > +EXPORT_SYMBOL(drm_gpuva_region_insert);
> > > +
> > > +static void
> > > +__drm_gpuva_region_remove(struct drm_gpuva_region *reg)
> > > +{
> > > + struct drm_gpuva_manager *mgr = reg->mgr;
> > > + MA_STATE(mas, &mgr->region_mt, reg->va.addr, 0);
> > > +
> > > + mas_erase(&mas);
> > > +}
> > > +
> > > +/**
> > > + * drm_gpuva_region_remove - remove a &drm_gpuva_region
> > > + * @reg: the &drm_gpuva to remove
> > > + *
> > > + * This removes the given ® from the underlaying tree.
> > > + */
> > > +void
> > > +drm_gpuva_region_remove(struct drm_gpuva_region *reg)
> > > +{
> > > + struct drm_gpuva_manager *mgr = reg->mgr;
> > > +
> > > + if (unlikely(!(mgr->flags & DRM_GPUVA_MANAGER_REGIONS)))
> > > + return;
> > > +
> > > + if (unlikely(reg == &mgr->kernel_alloc_region)) {
> > > + WARN(1, "Can't destroy kernel reserved region.\n");
> > > + return;
> > > + }
> > > +
> > > + if (unlikely(!drm_gpuva_region_empty(reg)))
> > > + WARN(1, "GPU VA region should be empty on destroy.\n");
> > > +
> > > + __drm_gpuva_region_remove(reg);
> > > +}
> > > +EXPORT_SYMBOL(drm_gpuva_region_remove);
> > > +
> > > +/**
> > > + * drm_gpuva_region_empty - indicate whether a &drm_gpuva_region is empty
> > > + * @reg: the &drm_gpuva to destroy
> > > + *
> > > + * Returns: true if the &drm_gpuva_region is empty, false otherwise
> > > + */
> > > +bool
> > > +drm_gpuva_region_empty(struct drm_gpuva_region *reg)
> > > +{
> > > + DRM_GPUVA_ITER(it, reg->mgr);
> > > +
> > > + drm_gpuva_iter_for_each_range(it, reg->va.addr,
> > > + reg->va.addr +
> > > + reg->va.range)
> > > + return false;
> > > +
> > > + return true;
> > > +}
> > > +EXPORT_SYMBOL(drm_gpuva_region_empty);
> > > +
> > > +/**
> > > + * drm_gpuva_region_find_first - find the first &drm_gpuva_region in the given
> > > + * range
> > > + * @mgr: the &drm_gpuva_manager to search in
> > > + * @addr: the &drm_gpuva_regions address
> > > + * @range: the &drm_gpuva_regions range
> > > + *
> > > + * Returns: the first &drm_gpuva_region within the given range
> > > + */
> > > +struct drm_gpuva_region *
> > > +drm_gpuva_region_find_first(struct drm_gpuva_manager *mgr,
> > > + u64 addr, u64 range)
> > > +{
> > > + MA_STATE(mas, &mgr->region_mt, addr, 0);
> > > +
> > > + return mas_find(&mas, addr + range - 1);
> > > +}
> > > +EXPORT_SYMBOL(drm_gpuva_region_find_first);
> > > +
> > > +/**
> > > + * drm_gpuva_region_find - find a &drm_gpuva_region
> > > + * @mgr: the &drm_gpuva_manager to search in
> > > + * @addr: the &drm_gpuva_regions address
> > > + * @range: the &drm_gpuva_regions range
> > > + *
> > > + * Returns: the &drm_gpuva_region at a given &addr and with a given &range
> >
> > again, I'm not sure you want to find first or walk here.. It sounds like
> > you want exactly addr to addr + range VMA?
>
> Exactly, same as above.
MA_STATE(mas, &mgr->region_mt, addr, addr);
reg = mas_walk(&mas);
if (!reg)
return reg;
if ((mas.index != addr) | (mas.last != range - 1))
return NULL;
return reg;
>
> >
> > > + */
> > > +struct drm_gpuva_region *
> > > +drm_gpuva_region_find(struct drm_gpuva_manager *mgr,
> > > + u64 addr, u64 range)
> > > +{
> > > + struct drm_gpuva_region *reg;
> > > +
> > > + reg = drm_gpuva_region_find_first(mgr, addr, range);
mas_find() will keep searching, so you may get a VMA that starts higher
than addr.
> > > + if (!reg)
> > > + goto out;
> > > +
> > > + if (reg->va.range != range)
> > > + goto out;
> > > +
> > > + return reg;
> > > +
> > > +out:
> > > + return NULL;
> > > +}
> > > +EXPORT_SYMBOL(drm_gpuva_region_find);
> > > +
> >
> > ...
> >
>
