Espace de noms pour les fonctions de gestion mémoire et des allocateurs. Plus de détails...

Fonctions
IMemoryRessourceMng *	setDataMemoryResourceMng (IMemoryRessourceMng *mng)
	Positionne le gestionnaire de ressource mémoire pour les données.

IMemoryRessourceMng *	getDataMemoryResourceMng ()
	Gestionnaire de ressource mémoire pour les données.

IMemoryAllocator *	setAcceleratorHostMemoryAllocator (IMemoryAllocator *a)
	Positionne l'allocateur spécifique pour les accélérateurs.

void	setDefaultDataMemoryResource (eMemoryResource mem_resource)
	Positionne la ressource mémoire utilisée pour l'allocateur mémoire des données.

eMemoryResource	getDefaultDataMemoryResource ()
	Ressource mémoire utilisée par l'allocateur par défaut pour les données.

eMemoryResource	getMemoryResourceFromName (const String &name)
	Retourne la ressource mémoire par son nom.

IMemoryAllocator *	getDefaultDataAllocator ()
	Allocateur par défaut pour les données.

MemoryAllocationOptions	getDefaultDataAllocator (eMemoryLocationHint hint)
	Allocateur par défaut pour les données avec informations sur la localisation attendue.

IMemoryAllocator *	getDeviceOrHostAllocator ()
	Retourne l'allocateur sur l'hôte ou sur le device.

MemoryAllocationOptions	getAllocatorForMostlyReadOnlyData ()
	Allocateur par défaut pour les données essentiellement en lecture.

	ARCANE_DEPRECATED_REASON ("Y2024: Use getDefaultDataAllocator() instead.") IMemoryAllocator *getAcceleratorHostMemoryAllocator()
	Allocateur spécifique pour les accélérateurs.

MemoryAllocationOptions	getAllocationOptions (eMemoryResource mem_resource)
	Allocation par défaut pour la ressource mem_resource.

IMemoryAllocator *	getAllocator (eMemoryResource mem_resource)
	Allocateur par défaut pour la ressource mem_resource.

template<typename DataType >
Int32	checkResizeArrayWithCapacity (Array< DataType > &array, Int64 new_size, bool force_resize)
	Redimensionne un tableau en ajoutant une réserve de mémoire.

template<typename DataType >
Int32	checkResizeArrayWithCapacity (Array< DataType > &array, Int64 new_size)
	Redimensionne un tableau en ajoutant une réserve de mémoire.

void	copy (MutableMemoryView destination, eMemoryResource destination_mem, ConstMemoryView source, eMemoryResource source_mem, const RunQueue *queue=nullptr)
	Copie de source vers destination en utilisant la file queue.

void	copy (MutableMemoryView destination, ConstMemoryView source, const RunQueue *queue=nullptr)
	Copie de source vers destination en utilisant la file queue.

template<typename DataType >
void	copy (Span< DataType > destination, Span< const DataType > source, const RunQueue *queue=nullptr)
	Copie de source vers destination en utilisant la file queue.

template<typename DataType >
void	copy (SmallSpan< DataType > destination, SmallSpan< const DataType > source, const RunQueue *queue=nullptr)
	Copie de source vers destination en utilisant la file queue.

Description détaillée

Espace de noms pour les fonctions de gestion mémoire et des allocateurs.

Documentation des fonctions

◆ ARCANE_DEPRECATED_REASON()

Arcane::MemoryUtils::ARCANE_DEPRECATED_REASON ( "Y2024: Use getDefaultDataAllocator() instead." )

Allocateur spécifique pour les accélérateurs.

Obsolète:: Use MemoryUtils::getDefaultDataAllocator() instead.

◆ checkResizeArrayWithCapacity() [1/2]

template<typename DataType >

Int32 Arcane::MemoryUtils::checkResizeArrayWithCapacity	(	Array< DataType > &	array,
		Int64	new_size
	)

inline

Redimensionne un tableau en ajoutant une réserve de mémoire.

Cet appel est équivalent à checkResizeArrayWithCapacity(array, new_size, false).

Définition à la ligne 197 du fichier MemoryUtils.h.

Références checkResizeArrayWithCapacity().

◆ checkResizeArrayWithCapacity() [2/2]

template<typename DataType >

Int32 Arcane::MemoryUtils::checkResizeArrayWithCapacity	(	Array< DataType > &	array,
		Int64	new_size,
		bool	force_resize
	)

inline

Redimensionne un tableau en ajoutant une réserve de mémoire.

Le tableau array est redimensionné uniquement si new_size est supérieure à la taille actuelle du tableau ou si force_resize est vrai.

Si le tableau est redimensionné, on réserve une capacité supplémentaire pour éviter de réallouer à chaque fois.

Valeurs retournées

2	si on a réalloué via reserve()
1	si on a re-dimensionné sans réallouer.
0	si aucune opération n'a eu lieu.

Définition à la ligne 174 du fichier MemoryUtils.h.

Référencé par Arcane::ItemGroupImpl::addItems(), Arcane::MeshUtils::checkResizeArray(), et checkResizeArrayWithCapacity().

◆ copy() [1/4]

void Arcane::MemoryUtils::copy	(	MutableMemoryView	destination,
		ConstMemoryView	source,
		const RunQueue *	queue = `nullptr`
	)

inline

Copie de source vers destination en utilisant la file queue.

Définition à la ligne 221 du fichier MemoryUtils.h.

Références copy().

◆ copy() [2/4]

void Arcane::MemoryUtils::copy	(	MutableMemoryView	destination,
		eMemoryResource	destination_mem,
		ConstMemoryView	source,
		eMemoryResource	source_mem,
		const RunQueue *	queue = `nullptr`
	)

Copie de source vers destination en utilisant la file queue.

Il est possible de spécifier la ressource mémoire où se trouve la source et la destination. Si on ne les connait pas, il est préférable d'utiliser la surcharge copy(MutableMemoryView destination, ConstMemoryView source, const RunQueue* queue).

Référencé par copy(), copy(), copy(), et Arcane::ItemVector::ItemVector().

◆ copy() [3/4]

template<typename DataType >

void Arcane::MemoryUtils::copy	(	SmallSpan< DataType >	destination,
		SmallSpan< const DataType >	source,
		const RunQueue *	queue = `nullptr`
	)

inline

Copie de source vers destination en utilisant la file queue.

Définition à la ligne 241 du fichier MemoryUtils.h.

Références copy().

◆ copy() [4/4]

template<typename DataType >

void Arcane::MemoryUtils::copy	(	Span< DataType >	destination,
		Span< const DataType >	source,
		const RunQueue *	queue = `nullptr`
	)

inline

Copie de source vers destination en utilisant la file queue.

Définition à la ligne 232 du fichier MemoryUtils.h.

Références copy().

◆ getAllocationOptions()

MemoryAllocationOptions Arcane::MemoryUtils::getAllocationOptions ( eMemoryResource mem_resource )

Allocation par défaut pour la ressource mem_resource.

Lève une exception si aucune allocateur n'est disponible pour la ressource (par exemple si on demande eMemoryResource::Device et qu'il n'y a pas de support pour les accélérateurs.

La ressource eMemoryResource::UnifiedMemory est toujours disponible. Si aucun runtime accélérateur n'est chargé, alors c'est équivalent à eMemoryResource::Host.

◆ getAllocator()

IMemoryAllocator * Arcane::MemoryUtils::getAllocator ( eMemoryResource mem_resource )

Allocateur par défaut pour la ressource mem_resource.

Voir également: getAllocationOptions().

◆ getAllocatorForMostlyReadOnlyData()

MemoryAllocationOptions Arcane::MemoryUtils::getAllocatorForMostlyReadOnlyData ( )

Allocateur par défaut pour les données essentiellement en lecture.

Cet appel est équivalent à getDefaultDataAllocator(eMemoryLocationHint::HostAndDeviceMostlyRead).

Définition à la ligne 169 du fichier MemoryUtils.cc.

Références getDefaultDataAllocator().

◆ getDataMemoryResourceMng()

IMemoryRessourceMng * Arcane::MemoryUtils::getDataMemoryResourceMng ( )

Gestionnaire de ressource mémoire pour les données.

Il est garanti que l'alignement est au moins celui retourné par AlignedMemoryAllocator::Simd().

Définition à la ligne 108 du fichier MemoryUtils.cc.

Référencé par Arcane::MemoryResourceMng::genericCopy(), getDefaultDataAllocator(), et getDeviceOrHostAllocator().

◆ getDefaultDataAllocator() [1/2]

IMemoryAllocator * Arcane::MemoryUtils::getDefaultDataAllocator ( )

Allocateur par défaut pour les données.

L'allocateur par défaut pour les données est un allocateur qui permet d'accéder à la zone mémoire à la fois par l'hôte et l'accélérateur.

Il est possible de récupérer la ressource mémoire associée via getDefaultDataMemoryResource();

Cet appel est équivalent à getAllocator(getDefaultDataMemoryResource()).

Il est garanti que l'alignement est au moins celui retourné par AlignedMemoryAllocator::Simd().

Définition à la ligne 120 du fichier MemoryUtils.cc.

Références Arcane::IMemoryResourceMng::getAllocator(), getDataMemoryResourceMng(), et getDefaultDataMemoryResource().

Référencé par Arcane::ItemGroupImpl::_initChildrenByTypeV2(), Arcane::MemoryResourceMng::getAllocator(), getAllocatorForMostlyReadOnlyData(), Arcane::platform::getDefaultDataAllocator(), et getDefaultDataAllocator().

◆ getDefaultDataAllocator() [2/2]

MemoryAllocationOptions Arcane::MemoryUtils::getDefaultDataAllocator ( eMemoryLocationHint hint )

Allocateur par défaut pour les données avec informations sur la localisation attendue.

Cette fonction retourne l'allocateur de getDefaulDataAllocator() mais ajoute les informations de gestion mémoire spécifiées par hint.

Définition à la ligne 142 du fichier MemoryUtils.cc.

Références getDefaultDataAllocator().

◆ getDefaultDataMemoryResource()

eMemoryResource Arcane::MemoryUtils::getDefaultDataMemoryResource ( )

Ressource mémoire utilisée par l'allocateur par défaut pour les données.

Par défaut, si un runtime accélérateur est initialisé, la ressource associé est eMemoryResource::UnifiedMemory. Sinon, il s'agit de eMemoryResource::Host.

Voir également: getDefaultDataAllocator();

Définition à la ligne 54 du fichier MemoryUtils.cc.

Référencé par Arcane::Accelerator::arcaneInitializeRunner(), et getDefaultDataAllocator().

◆ getDeviceOrHostAllocator()

IMemoryAllocator * Arcane::MemoryUtils::getDeviceOrHostAllocator ( )

Retourne l'allocateur sur l'hôte ou sur le device.

Si un runtime accélérateur est initialisé, l'allocateur retourné permet d'allouer en utilisant la mémoire de l'accélérateur par défaut (eMemoryResource::Device). Sinon, utilise l'allocateur de l'hôte (eMemoryResource::Host).

Définition à la ligne 129 du fichier MemoryUtils.cc.

Références getDataMemoryResourceMng().

◆ getMemoryResourceFromName()

eMemoryResource Arcane::MemoryUtils::getMemoryResourceFromName ( const String & name )

Retourne la ressource mémoire par son nom.

Le nom correspond au nom de la valeur de l'énumération (par exemple 'Device' pour eMemoryResource::Device.

Si name est nul, retourn eMemoryResource::Unknown. Si name ne correspondant pas à une valeur valide, lève une exception.

Définition à la ligne 72 du fichier MemoryUtils.cc.

Références ARCANE_FATAL.

Référencé par Arcane::ArcaneMain::_checkAutoDetectAccelerator().

◆ setAcceleratorHostMemoryAllocator()

IMemoryAllocator * Arcane::MemoryUtils::setAcceleratorHostMemoryAllocator ( IMemoryAllocator * a )

Positionne l'allocateur spécifique pour les accélérateurs.

Retourne l'ancien allocateur utilisé. L'allocateur spécifié doit rester valide durant toute la durée de vie de l'application.

Définition à la ligne 187 du fichier MemoryUtils.cc.

◆ setDataMemoryResourceMng()

IMemoryRessourceMng * Arcane::MemoryUtils::setDataMemoryResourceMng ( IMemoryRessourceMng * mng )

Positionne le gestionnaire de ressource mémoire pour les données.

Le gestionnaire doit rester valide durant toute l'exécution du programme.

Retourne l'ancien gestionnaire.

Définition à la ligne 96 du fichier MemoryUtils.cc.

Références ARCANE_CHECK_POINTER.

◆ setDefaultDataMemoryResource()

void Arcane::MemoryUtils::setDefaultDataMemoryResource ( eMemoryResource mem_resource )

Positionne la ressource mémoire utilisée pour l'allocateur mémoire des données.

Voir également: getDefaultDataMemoryResource();

Définition à la ligne 63 du fichier MemoryUtils.cc.

Référencé par Arcane::ArcaneMain::_checkAutoDetectAccelerator().

Fonctions

Description détaillée

Documentation des fonctions

◆ ARCANE_DEPRECATED_REASON()

◆ checkResizeArrayWithCapacity() [1/2]

◆ checkResizeArrayWithCapacity() [2/2]

◆ copy() [1/4]

◆ copy() [2/4]

◆ copy() [3/4]

◆ copy() [4/4]

◆ getAllocationOptions()

◆ getAllocator()

◆ getAllocatorForMostlyReadOnlyData()

◆ getDataMemoryResourceMng()

◆ getDefaultDataAllocator() [1/2]

◆ getDefaultDataAllocator() [2/2]

◆ getDefaultDataMemoryResource()

◆ getDeviceOrHostAllocator()

◆ getMemoryResourceFromName()

◆ setAcceleratorHostMemoryAllocator()

◆ setDataMemoryResourceMng()

◆ setDefaultDataMemoryResource()