255db3ba80
iova_tree_find_address, and iova_tree_foreach have never been
used since the code was originally added by:
eecf5eedbd ("util: implement simple iova tree")
Remove them.
Signed-off-by: Dr. David Alan Gilbert <dave@treblig.org>
Reviewed-by: Peter Xu <peterx@redhat.com>
Reviewed-by: Thomas Huth <thuth@redhat.com>
Link: https://lore.kernel.org/r/20240918142515.153074-1-dave@treblig.org
Signed-off-by: Peter Xu <peterx@redhat.com>
143 lines
4.2 KiB
C
143 lines
4.2 KiB
C
/*
|
|
* An very simplified iova tree implementation based on GTree.
|
|
*
|
|
* Copyright 2018 Red Hat, Inc.
|
|
*
|
|
* Authors:
|
|
* Peter Xu <peterx@redhat.com>
|
|
*
|
|
* This work is licensed under the terms of the GNU GPL, version 2 or later.
|
|
*/
|
|
#ifndef IOVA_TREE_H
|
|
#define IOVA_TREE_H
|
|
|
|
/*
|
|
* Currently the iova tree will only allow to keep ranges
|
|
* information, and no extra user data is allowed for each element. A
|
|
* benefit is that we can merge adjacent ranges internally within the
|
|
* tree. It can save a lot of memory when the ranges are split but
|
|
* mostly continuous.
|
|
*
|
|
* Note that current implementation does not provide any thread
|
|
* protections. Callers of the iova tree should be responsible
|
|
* for the thread safety issue.
|
|
*/
|
|
|
|
#include "exec/memory.h"
|
|
#include "exec/hwaddr.h"
|
|
|
|
#define IOVA_OK (0)
|
|
#define IOVA_ERR_INVALID (-1) /* Invalid parameters */
|
|
#define IOVA_ERR_OVERLAP (-2) /* IOVA range overlapped */
|
|
#define IOVA_ERR_NOMEM (-3) /* Cannot allocate */
|
|
|
|
typedef struct IOVATree IOVATree;
|
|
typedef struct DMAMap {
|
|
hwaddr iova;
|
|
hwaddr translated_addr;
|
|
hwaddr size; /* Inclusive */
|
|
IOMMUAccessFlags perm;
|
|
} QEMU_PACKED DMAMap;
|
|
typedef gboolean (*iova_tree_iterator)(DMAMap *map);
|
|
|
|
/**
|
|
* iova_tree_new:
|
|
*
|
|
* Create a new iova tree.
|
|
*
|
|
* Returns: the tree pointer when succeeded, or NULL if error.
|
|
*/
|
|
IOVATree *iova_tree_new(void);
|
|
|
|
/**
|
|
* iova_tree_insert:
|
|
*
|
|
* @tree: the iova tree to insert
|
|
* @map: the mapping to insert
|
|
*
|
|
* Insert an iova range to the tree. If there is overlapped
|
|
* ranges, IOVA_ERR_OVERLAP will be returned.
|
|
*
|
|
* Return: 0 if succeeded, or <0 if error.
|
|
*/
|
|
int iova_tree_insert(IOVATree *tree, const DMAMap *map);
|
|
|
|
/**
|
|
* iova_tree_remove:
|
|
*
|
|
* @tree: the iova tree to remove range from
|
|
* @map: the map range to remove
|
|
*
|
|
* Remove mappings from the tree that are covered by the map range
|
|
* provided. The range does not need to be exactly what has inserted,
|
|
* all the mappings that are included in the provided range will be
|
|
* removed from the tree. Here map->translated_addr is meaningless.
|
|
*/
|
|
void iova_tree_remove(IOVATree *tree, DMAMap map);
|
|
|
|
/**
|
|
* iova_tree_find:
|
|
*
|
|
* @tree: the iova tree to search from
|
|
* @map: the mapping to search
|
|
*
|
|
* Search for a mapping in the iova tree that iova overlaps with the
|
|
* mapping range specified. Only the first found mapping will be
|
|
* returned.
|
|
*
|
|
* Return: DMAMap pointer if found, or NULL if not found. Note that
|
|
* the returned DMAMap pointer is maintained internally. User should
|
|
* only read the content but never modify or free the content. Also,
|
|
* user is responsible to make sure the pointer is valid (say, no
|
|
* concurrent deletion in progress).
|
|
*/
|
|
const DMAMap *iova_tree_find(const IOVATree *tree, const DMAMap *map);
|
|
|
|
/**
|
|
* iova_tree_find_iova:
|
|
*
|
|
* @tree: the iova tree to search from
|
|
* @map: the mapping to search
|
|
*
|
|
* Search for a mapping in the iova tree that translated_addr overlaps with the
|
|
* mapping range specified. Only the first found mapping will be
|
|
* returned.
|
|
*
|
|
* Return: DMAMap pointer if found, or NULL if not found. Note that
|
|
* the returned DMAMap pointer is maintained internally. User should
|
|
* only read the content but never modify or free the content. Also,
|
|
* user is responsible to make sure the pointer is valid (say, no
|
|
* concurrent deletion in progress).
|
|
*/
|
|
const DMAMap *iova_tree_find_iova(const IOVATree *tree, const DMAMap *map);
|
|
|
|
/**
|
|
* iova_tree_alloc_map:
|
|
*
|
|
* @tree: the iova tree to allocate from
|
|
* @map: the new map (as translated addr & size) to allocate in the iova region
|
|
* @iova_begin: the minimum address of the allocation
|
|
* @iova_end: the maximum addressable direction of the allocation
|
|
*
|
|
* Allocates a new region of a given size, between iova_min and iova_max.
|
|
*
|
|
* Return: Same as iova_tree_insert, but cannot overlap and can return error if
|
|
* iova tree is out of free contiguous range. The caller gets the assigned iova
|
|
* in map->iova.
|
|
*/
|
|
int iova_tree_alloc_map(IOVATree *tree, DMAMap *map, hwaddr iova_begin,
|
|
hwaddr iova_end);
|
|
|
|
/**
|
|
* iova_tree_destroy:
|
|
*
|
|
* @tree: the iova tree to destroy
|
|
*
|
|
* Destroy an existing iova tree.
|
|
*
|
|
* Return: None.
|
|
*/
|
|
void iova_tree_destroy(IOVATree *tree);
|
|
|
|
#endif
|