include/linux/xarray.h

178  * The normal API will return NULL as the contents of a slot containing
192  * If an XArray operation cannot complete an operation, it will return
209  * If an XArray operation cannot complete an operation, it will return
427  * During the iteration, @entry will have the value of the entry stored
430  * during the iteration.  At the end of the iteration, @entry will be set
431  * to NULL and @index will have a value less than or equal to max.
435  * after each iteration, it will also end up being O(n.log(n)).
436  * xa_for_each_range() will spin if it hits a retry entry; if you intend to
438  * The xas_for_each() iterator will expand into more inline code than
456  * During the iteration, @entry will have the value of the entry stored
459  * during the iteration.  At the end of the iteration, @entry will be set
460  * to NULL and @index will have a value less than or equal to max.
464  * after each iteration, it will also end up being O(n.log(n)).
465  * xa_for_each_start() will spin if it hits a retry entry; if you intend to
467  * The xas_for_each() iterator will expand into more inline code than
481  * During the iteration, @entry will have the value of the entry stored
484  * iteration.  At the end of the iteration, @entry will be set to NULL and
485  * @index will have a value less than or equal to max.
489  * after each iteration, it will also end up being O(n.log(n)).  xa_for_each()
490  * will spin if it hits a retry entry; if you intend to see retry entries,
492  * iterator will expand into more inline code than xa_for_each().
506  * During the iteration, @entry will have the value of the entry stored
507  * in @xa at @index.  The iteration will skip all entries in the array
510  * during the iteration.  At the end of the iteration, @entry will be set to
511  * NULL and @index will have a value less than or equal to max.
515  * to unlock after each iteration, it will also end up being O(n.log(n)).
516  * xa_for_each_marked() will spin if it hits a retry entry; if you intend to
518  * instead.  The xas_for_each_marked() iterator will expand into more inline
549  * xa_lock.  If the GFP flags allow it, they will drop the lock to
624  * After this function returns, loading from @index will return %NULL.
625  * If the index is part of a multi-index entry, all indices will be erased
626  * and none of the entries will be part of a multi-index entry.
648  * After this function returns, loading from @index will return %NULL.
649  * If the index is part of a multi-index entry, all indices will be erased
650  * and none of the entries will be part of a multi-index entry.
756  * Inserting a NULL entry will store a reserved entry (like xa_reserve())
757  * if no entry is present.  Inserting will fail if a reserved entry is
758  * present, even though loading from this index will return NULL.
785  * Inserting a NULL entry will store a reserved entry (like xa_reserve())
786  * if no entry is present.  Inserting will fail if a reserved entry is
787  * present, even though loading from this index will return NULL.
814  * Inserting a NULL entry will store a reserved entry (like xa_reserve())
815  * if no entry is present.  Inserting will fail if a reserved entry is
816  * present, even though loading from this index will return NULL.
845  * that index.  A concurrent lookup will not see an uninitialised @id.
874  * that index.  A concurrent lookup will not see an uninitialised @id.
903  * that index.  A concurrent lookup will not see an uninitialised @id.
933  * that index.  A concurrent lookup will not see an uninitialised @id.
934  * The search for an empty entry will start at @next and will wrap
966  * that index.  A concurrent lookup will not see an uninitialised @id.
967  * The search for an empty entry will start at @next and will wrap
999  * that index.  A concurrent lookup will not see an uninitialised @id.
1000  * The search for an empty entry will start at @next and will wrap
1088  * will do nothing.
1398  * will probably not behave the way you think they should.  If you want
1462  * array will start from the root.  Use this if you have dropped the
1571  * Move the operation state to refer to a different index.  This will
1620  * speed.  It is equivalent to calling xas_find(), and will call xas_find()
1677  * speed.  It is equivalent to calling xas_find_marked(), and will call
1718  * The loop body will be executed for each entry present in the xarray
1719  * between the current xas position and @max.  @entry will be set to
1736  * The loop body will be executed for each marked entry in the xarray
1737  * between the current xas position and @max.  @entry will be set to
1752  * The loop body will be executed for each entry in the XArray that
1754  * normally, @entry will be %NULL.  The user may break out of the loop,
1755  * which will leave @entry set to the conflicting entry.  The caller
1769  * If the @xas was in an error state, it will remain in an error state
1770  * and this function will return %NULL.  If the @xas has never been walked,
1771  * it will have the effect of calling xas_load().  Otherwise one will be
1772  * subtracted from the index and the state will be walked to the correct
1798  * If the @xas was in an error state, it will remain in an error state
1799  * and this function will return %NULL.  If the @xas has never been walked,
1800  * it will have the effect of calling xas_load().  Otherwise one will be
1801  * added to the index and the state will be walked to the correct