Allocateur mémoire avec alignement mémoire spécifique. Plus de détails...

#include </__w/arcaneframework.github.io/arcaneframework.github.io/framework/arccore/src/collections/arccore/collections/IMemoryAllocator.h>

Graphe d'héritage de Arccore::AlignedMemoryAllocator3:

Graphe de collaboration de Arccore::AlignedMemoryAllocator3:

Fonctions membres publiques
bool	hasRealloc (MemoryAllocationArgs) const override
	Indique si l'allocateur supporte la sémantique de realloc.

AllocatedMemoryInfo	allocate (MemoryAllocationArgs args, Int64 new_size) override
	Alloue de la mémoire pour new_size octets et retourne le pointeur.

AllocatedMemoryInfo	reallocate (MemoryAllocationArgs args, AllocatedMemoryInfo current_ptr, Int64 new_size) override
	Réalloue de la mémoire pour new_size octets et retourne le pointeur.

void	deallocate (MemoryAllocationArgs args, AllocatedMemoryInfo ptr) override
	Libère la mémoire dont l'adresse de base est ptr.

Int64	adjustedCapacity (MemoryAllocationArgs args, Int64 wanted_capacity, Int64 element_size) const override
	Ajuste la capacité suivant la taille d'élément.

size_t	guarantedAlignment (MemoryAllocationArgs) const override
	Valeur de l'alignement garanti par l'allocateur.

virtual size_t	adjustCapacity (size_t wanted_capacity, size_t element_size)=0

virtual AllocatedMemoryInfo	allocate (MemoryAllocationArgs args, Int64 new_size)
	Alloue de la mémoire pour new_size octets et retourne le pointeur.

virtual void *	allocate (size_t new_size)=0

virtual void	deallocate (MemoryAllocationArgs args, AllocatedMemoryInfo ptr)
	Libère la mémoire dont l'adresse de base est ptr.

virtual void	deallocate (void *ptr)=0

virtual size_t	guarantedAlignment (MemoryAllocationArgs args) const
	Valeur de l'alignement garanti par l'allocateur.

virtual size_t	guarantedAlignment ()=0

virtual bool	hasRealloc (MemoryAllocationArgs args) const
	Indique si l'allocateur supporte la sémantique de realloc.

virtual bool	hasRealloc () const=0

virtual AllocatedMemoryInfo	reallocate (MemoryAllocationArgs args, AllocatedMemoryInfo current_ptr, Int64 new_size)
	Réalloue de la mémoire pour new_size octets et retourne le pointeur.

virtual void *	reallocate (void *current_ptr, size_t new_size)=0

Fonctions membres publiques hérités de Arccore::IMemoryAllocator
virtual	~IMemoryAllocator ()=default
	Détruit l'allocateur.

virtual void	notifyMemoryArgsChanged (MemoryAllocationArgs old_args, MemoryAllocationArgs new_args, AllocatedMemoryInfo ptr)
	Notifie du changement des arguments spécifiques à l'instance.

virtual void	copyMemory (MemoryAllocationArgs args, AllocatedMemoryInfo destination, AllocatedMemoryInfo source)
	Copie la mémoire entre deux zones.

Fonctions membres publiques statiques
static constexpr Integer	simdAlignment ()
	Alignement pour les structures utilisant la vectorisation.

static constexpr Integer	cacheLineAlignment ()
	Alignement pour une ligne de cache.

static AlignedMemoryAllocator3 *	Simd ()
	Allocateur garantissant l'alignement pour utiliser la vectorisation sur la plateforme cible.

static AlignedMemoryAllocator3 *	CacheLine ()
	Allocateur garantissant l'alignement sur une ligne de cache.

Fonctions membres protégées
	AlignedMemoryAllocator3 (Integer alignment)

Attributs privés
size_t	m_alignment

Attributs privés statiques
static AlignedMemoryAllocator3	SimdAllocator

static AlignedMemoryAllocator3	CacheLineAllocator

Description détaillée

Allocateur mémoire avec alignement mémoire spécifique.

Cette classe s'utilise via les deux méthodes publiques Simd() et CacheLine() qui retournent respectivement un allocateur avec un alignement adéquat pour autoriser la vectorisation et un allocateur aligné sur une ligne de cache.

Définition à la ligne 423 du fichier arccore/src/collections/arccore/collections/IMemoryAllocator.h.

Documentation des constructeurs et destructeur

◆ AlignedMemoryAllocator3()

Arccore::AlignedMemoryAllocator3::AlignedMemoryAllocator3 ( Integer alignment )

inlineexplicitprotected

Définition à la ligne 482 du fichier arccore/src/collections/arccore/collections/IMemoryAllocator.h.

Documentation des fonctions membres

◆ adjustCapacity()

virtual size_t Arccore::IMemoryAllocator::adjustCapacity	(	size_t	wanted_capacity,
		size_t	element_size
	)

virtual

Implémente Arccore::IMemoryAllocator.

◆ adjustedCapacity()

Int64 Arccore::AlignedMemoryAllocator3::adjustedCapacity	(	MemoryAllocationArgs	args,
		Int64	wanted_capacity,
		Int64	element_size
	)		const

overridevirtual

Ajuste la capacité suivant la taille d'élément.

Cette méthode est utilisée pour éventuellement modifié le nombre d'éléments alloués suivant leur taille. Cela permet par exemple pour les allocateurs alignés de garantir que le nombre d'éléments alloués est un multiple de cet alignement.

Implémente Arccore::IMemoryAllocator3.

Réimplémentée dans Arcane::Accelerator::Cuda::CudaMemoryAllocatorBase.

Définition à la ligne 357 du fichier MemoryAllocator.cc.

Référencé par Arcane::Accelerator::Cuda::CudaMemoryAllocatorBase::adjustedCapacity().

◆ allocate() [1/3]

AllocatedMemoryInfo Arccore::IMemoryAllocator::allocate	(	MemoryAllocationArgs	args,
		Int64	new_size
	)

virtual

Alloue de la mémoire pour new_size octets et retourne le pointeur.

La sémantique est équivalent à malloc():

new_size peut valoir zéro et dans ce cas le pointeur retourné est soit nul, soit une valeur non spécifiée.
le pointeur retourné peut être nul si la mémoire n'a pas pu être allouée.

Implémente Arccore::IMemoryAllocator3.

Réimplémentée dans Arcane::Accelerator::Cuda::CudaMemoryAllocatorBase, Arcane::Accelerator::Hip::HipMemoryAllocatorBase, et Arcane::Accelerator::Sycl::SyclMemoryAllocatorBase.

Définition à la ligne 75 du fichier MemoryAllocator.cc.

◆ allocate() [2/3]

AllocatedMemoryInfo Arccore::AlignedMemoryAllocator3::allocate	(	MemoryAllocationArgs	args,
		Int64	new_size
	)

overridevirtual

Alloue de la mémoire pour new_size octets et retourne le pointeur.

La sémantique est équivalent à malloc():

new_size peut valoir zéro et dans ce cas le pointeur retourné est soit nul, soit une valeur spécifique
le pointeur retourné peut être nul si la mémoire n'a pas pu être allouée.

Implémente Arccore::IMemoryAllocator3.

Réimplémentée dans Arcane::Accelerator::Cuda::CudaMemoryAllocatorBase, Arcane::Accelerator::Hip::HipMemoryAllocatorBase, et Arcane::Accelerator::Sycl::SyclMemoryAllocatorBase.

Définition à la ligne 219 du fichier MemoryAllocator.cc.

◆ allocate() [3/3]

virtual void * Arccore::IMemoryAllocator::allocate ( size_t new_size )

virtual

Implémente Arccore::IMemoryAllocator.

◆ CacheLine()

static AlignedMemoryAllocator3 * Arccore::AlignedMemoryAllocator3::CacheLine ( )

inlinestatic

Allocateur garantissant l'alignement sur une ligne de cache.

Définition à la ligne 475 du fichier arccore/src/collections/arccore/collections/IMemoryAllocator.h.

◆ cacheLineAlignment()

static constexpr Integer Arccore::AlignedMemoryAllocator3::cacheLineAlignment ( )

inlinestaticconstexpr

Alignement pour une ligne de cache.

Définition à la ligne 458 du fichier arccore/src/collections/arccore/collections/IMemoryAllocator.h.

◆ deallocate() [1/3]

void Arccore::IMemoryAllocator::deallocate	(	MemoryAllocationArgs	args,
		AllocatedMemoryInfo	ptr
	)

virtual

Libère la mémoire dont l'adresse de base est ptr.

Le pointeur ptr doit avoir été alloué via l'appel à allocate() ou reallocate() de cette instance.

La sémantique de cette méthode équivalente à free() et donc ptr peut être nul auquel cas aucune opération n'est effectuée.

Implémente Arccore::IMemoryAllocator3.

Réimplémentée dans Arcane::Accelerator::Cuda::CudaMemoryAllocatorBase, Arcane::Accelerator::Hip::HipMemoryAllocatorBase, et Arcane::Accelerator::Sycl::SyclMemoryAllocatorBase.

Définition à la ligne 99 du fichier MemoryAllocator.cc.

◆ deallocate() [2/3]

void Arccore::AlignedMemoryAllocator3::deallocate	(	MemoryAllocationArgs	args,
		AllocatedMemoryInfo	ptr
	)

overridevirtual

Libère la mémoire dont l'adresse de base est ptr.

Le pointeur ptr doit avoir été alloué via l'appel à allocate() ou reallocate() de cette instance.

La sémantique de cette méthode équivalente à free() et donc ptr peut être nul auquel cas aucune opération n'est effectuée.

Implémente Arccore::IMemoryAllocator3.

Réimplémentée dans Arcane::Accelerator::Cuda::CudaMemoryAllocatorBase, Arcane::Accelerator::Hip::HipMemoryAllocatorBase, et Arcane::Accelerator::Sycl::SyclMemoryAllocatorBase.

Définition à la ligne 289 du fichier MemoryAllocator.cc.

Références Arccore::AllocatedMemoryInfo::baseAddress().

◆ deallocate() [3/3]

virtual void Arccore::IMemoryAllocator::deallocate ( void * ptr )

virtual

Implémente Arccore::IMemoryAllocator.

◆ guarantedAlignment() [1/3]

virtual size_t Arccore::IMemoryAllocator::guarantedAlignment ( )

virtual

Implémente Arccore::IMemoryAllocator.

◆ guarantedAlignment() [2/3]

size_t Arccore::IMemoryAllocator::guarantedAlignment ( MemoryAllocationArgs args ) const

virtual

Valeur de l'alignement garanti par l'allocateur.

Cette méthode permet de s'assurer qu'un allocateur a un alignement suffisant pour certaines opérations comme la vectorisation par exemple.

S'il n'y a aucune garantie, retourne 0.

Implémente Arccore::IMemoryAllocator3.

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

◆ guarantedAlignment() [3/3]

size_t Arccore::AlignedMemoryAllocator3::guarantedAlignment ( MemoryAllocationArgs args ) const

inlineoverridevirtual

Valeur de l'alignement garanti par l'allocateur.

Cette méthode permet de s'assurer qu'un allocateur a un alignement suffisant pour certaines opérations comme la vectorisation par exemple.

S'il n'y a aucune garantie, retourne 0.

Implémente Arccore::IMemoryAllocator3.

Définition à la ligne 493 du fichier arccore/src/collections/arccore/collections/IMemoryAllocator.h.

◆ hasRealloc() [1/3]

virtual bool Arccore::IMemoryAllocator::hasRealloc ( ) const

virtual

Implémente Arccore::IMemoryAllocator.

◆ hasRealloc() [2/3]

bool Arccore::IMemoryAllocator::hasRealloc ( MemoryAllocationArgs args ) const

virtual

Indique si l'allocateur supporte la sémantique de realloc.

Les allocateurs par défaut du C (malloc/realloc/free) supportent évidemment le realloc mais ce n'est pas forcément le cas des allocateurs spécifiques avec alignement mémoire (comme par exemple posix_memalign).

Réimplémentée à partir de Arccore::IMemoryAllocator3.

Réimplémentée dans Arcane::Accelerator::Cuda::CudaMemoryAllocatorBase, Arcane::Accelerator::Hip::HipMemoryAllocatorBase, et Arcane::Accelerator::Sycl::SyclMemoryAllocatorBase.

Définition à la ligne 65 du fichier MemoryAllocator.cc.

◆ hasRealloc() [3/3]

bool Arccore::AlignedMemoryAllocator3::hasRealloc ( MemoryAllocationArgs ) const

inlineoverridevirtual

Indique si l'allocateur supporte la sémantique de realloc.

Les allocateurs par défaut du C (malloc/realloc/free) supportent évidemment le realloc mais ce n'est pas forcément le cas des allocateurs spécifiques avec alignement mémoire (comme par exemple posix_memalign).

Réimplémentée à partir de Arccore::IMemoryAllocator3.

Réimplémentée dans Arcane::Accelerator::Cuda::CudaMemoryAllocatorBase, Arcane::Accelerator::Hip::HipMemoryAllocatorBase, et Arcane::Accelerator::Sycl::SyclMemoryAllocatorBase.

Définition à la ligne 488 du fichier arccore/src/collections/arccore/collections/IMemoryAllocator.h.

◆ reallocate() [1/3]

AllocatedMemoryInfo Arccore::IMemoryAllocator::reallocate	(	MemoryAllocationArgs	args,
		AllocatedMemoryInfo	current_ptr,
		Int64	new_size
	)

virtual

Réalloue de la mémoire pour new_size octets et retourne le pointeur.

Le pointeur current_ptr doit avoir été alloué via l'appel à allocate() ou reallocate() de cette instance.

La sémantique de cette méthode est équivalente à realloc():

current_ptr peut-être nul auquel cas cet appel est équivalent à allocate().
le pointeur retourné peut être nul si la mémoire n'a pas pu être allouée.

Implémente Arccore::IMemoryAllocator3.

Réimplémentée dans Arcane::Accelerator::Cuda::CudaMemoryAllocatorBase, Arcane::Accelerator::Hip::HipMemoryAllocatorBase, et Arcane::Accelerator::Sycl::SyclMemoryAllocatorBase.

Définition à la ligne 88 du fichier MemoryAllocator.cc.

◆ reallocate() [2/3]

AllocatedMemoryInfo Arccore::AlignedMemoryAllocator3::reallocate	(	MemoryAllocationArgs	args,
		AllocatedMemoryInfo	current_ptr,
		Int64	new_size
	)

overridevirtual

Réalloue de la mémoire pour new_size octets et retourne le pointeur.

Le pointeur current_ptr doit avoir été alloué via l'appel à allocate() ou reallocate() de cette instance.

La sémantique de cette méthode est équivalente à realloc():

current_ptr peut-être nul auquel cas cet appel est équivalent à allocate().
le pointeur retourné peut être nul si la mémoire n'a pas pu être allouée.

Implémente Arccore::IMemoryAllocator3.

Réimplémentée dans Arcane::Accelerator::Cuda::CudaMemoryAllocatorBase, Arcane::Accelerator::Hip::HipMemoryAllocatorBase, et Arcane::Accelerator::Sycl::SyclMemoryAllocatorBase.

Définition à la ligne 257 du fichier MemoryAllocator.cc.

Références Arccore::AllocatedMemoryInfo::baseAddress().

◆ reallocate() [3/3]

virtual void * Arccore::IMemoryAllocator::reallocate	(	void *	current_ptr,
		size_t	new_size
	)

virtual

Implémente Arccore::IMemoryAllocator.

◆ Simd()

static AlignedMemoryAllocator3 * Arccore::AlignedMemoryAllocator3::Simd ( )

inlinestatic

Allocateur garantissant l'alignement pour utiliser la vectorisation sur la plateforme cible.

Il s'agit de l'alignement pour le type plus restrictif et donc il est possible d'utiliser cet allocateur pour toutes les structures vectorielles.

Définition à la ligne 467 du fichier arccore/src/collections/arccore/collections/IMemoryAllocator.h.

◆ simdAlignment()

static constexpr Integer Arccore::AlignedMemoryAllocator3::simdAlignment ( )

inlinestaticconstexpr

Alignement pour les structures utilisant la vectorisation.

Définition à la ligne 456 du fichier arccore/src/collections/arccore/collections/IMemoryAllocator.h.

Documentation des données membres

◆ CacheLineAllocator

AlignedMemoryAllocator3 Arccore::AlignedMemoryAllocator3::CacheLineAllocator

staticprivate

Définition à la ligne 438 du fichier arccore/src/collections/arccore/collections/IMemoryAllocator.h.

◆ m_alignment

size_t Arccore::AlignedMemoryAllocator3::m_alignment

private

Définition à la ligne 497 du fichier arccore/src/collections/arccore/collections/IMemoryAllocator.h.

◆ SimdAllocator

AlignedMemoryAllocator3 Arccore::AlignedMemoryAllocator3::SimdAllocator

staticprivate

Définition à la ligne 437 du fichier arccore/src/collections/arccore/collections/IMemoryAllocator.h.

La documentation de cette classe a été générée à partir des fichiers suivants :

Fonctions membres publiques

Fonctions membres publiques statiques

Fonctions membres protégées

Attributs privés

Attributs privés statiques

Description détaillée

Documentation des constructeurs et destructeur

◆ AlignedMemoryAllocator3()

Documentation des fonctions membres

◆ adjustCapacity()

◆ adjustedCapacity()

◆ allocate() [1/3]

◆ allocate() [2/3]

◆ allocate() [3/3]

◆ CacheLine()

◆ cacheLineAlignment()

◆ deallocate() [1/3]

◆ deallocate() [2/3]

◆ deallocate() [3/3]

◆ guarantedAlignment() [1/3]

◆ guarantedAlignment() [2/3]

◆ guarantedAlignment() [3/3]

◆ hasRealloc() [1/3]

◆ hasRealloc() [2/3]

◆ hasRealloc() [3/3]

◆ reallocate() [1/3]

◆ reallocate() [2/3]

◆ reallocate() [3/3]

◆ Simd()

◆ simdAlignment()

Documentation des données membres

◆ CacheLineAllocator

◆ m_alignment

◆ SimdAllocator