interval-tree: Add a utility to iterate over spans in an interval tree
authorJason Gunthorpe <jgg@nvidia.com>
Tue, 29 Nov 2022 20:29:26 +0000 (16:29 -0400)
committerJason Gunthorpe <jgg@nvidia.com>
Tue, 29 Nov 2022 20:34:15 +0000 (16:34 -0400)
commit5fe937862c8426f24cd1dcbf7c22fb1a31069b4f
tree54442fd2ca7b79db8d3f4a72fbe28432b1ad9be4
parent89395ccedbc153fecbc29342fbb94a6dfadf24cd
interval-tree: Add a utility to iterate over spans in an interval tree

The span iterator travels over the indexes of the interval_tree, not the
nodes, and classifies spans of indexes as either 'used' or 'hole'.

'used' spans are fully covered by nodes in the tree and 'hole' spans have
no node intersecting the span.

This is done greedily such that spans are maximally sized and every
iteration step switches between used/hole.

As an example a trivial allocator can be written as:

for (interval_tree_span_iter_first(&span, itree, 0, ULONG_MAX);
     !interval_tree_span_iter_done(&span);
     interval_tree_span_iter_next(&span))
if (span.is_hole &&
    span.last_hole - span.start_hole >= allocation_size - 1)
return span.start_hole;

With all the tricky boundary conditions handled by the library code.

The following iommufd patches have several algorithms for its overlapping
node interval trees that are significantly simplified with this kind of
iteration primitive. As it seems generally useful, put it into lib/.

Link: https://lore.kernel.org/r/3-v6-a196d26f289e+11787-iommufd_jgg@nvidia.com
Reviewed-by: Kevin Tian <kevin.tian@intel.com>
Reviewed-by: Eric Auger <eric.auger@redhat.com>
Tested-by: Nicolin Chen <nicolinc@nvidia.com>
Tested-by: Yi Liu <yi.l.liu@intel.com>
Tested-by: Lixiao Yang <lixiao.yang@intel.com>
Tested-by: Matthew Rosato <mjrosato@linux.ibm.com>
Signed-off-by: Jason Gunthorpe <jgg@nvidia.com>
.clang-format
include/linux/interval_tree.h
lib/Kconfig
lib/interval_tree.c