Arcane  v3.16.0.0
Documentation développeur
Chargement...
Recherche...
Aucune correspondance
Référence de la classe Arcane::IMemoryAllocatorabstract

Interface d'un allocateur pour la mémoire. 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 Arcane::IMemoryAllocator:
+ Graphe de collaboration de Arcane::IMemoryAllocator:

Fonctions membres publiques

virtual ~IMemoryAllocator ()=default
 Détruit l'allocateur.
 
virtual bool hasRealloc (MemoryAllocationArgs) const
 Indique si l'allocateur supporte la sémantique de realloc.
 
virtual AllocatedMemoryInfo allocate (MemoryAllocationArgs args, Int64 new_size)=0
 Alloue de la mémoire pour new_size octets et retourne le pointeur.
 
virtual AllocatedMemoryInfo reallocate (MemoryAllocationArgs args, AllocatedMemoryInfo current_ptr, Int64 new_size)=0
 Réalloue de la mémoire pour new_size octets et retourne le pointeur.
 
virtual void deallocate (MemoryAllocationArgs args, AllocatedMemoryInfo ptr)=0
 Libère la mémoire dont l'adresse de base est ptr.
 
virtual Int64 adjustedCapacity (MemoryAllocationArgs args, Int64 wanted_capacity, Int64 element_size) const =0
 Ajuste la capacité suivant la taille d'élément.
 
virtual size_t guaranteedAlignment (MemoryAllocationArgs args) const =0
 Valeur de l'alignement garanti par l'allocateur.
 
virtual size_t guarantedAlignment (MemoryAllocationArgs args) const
 Valeur de l'alignement garanti par 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.
 
virtual eMemoryResource memoryResource () const
 Ressource mémoire fournie par l'allocateur.
 

Description détaillée

Interface d'un allocateur pour la mémoire.

Cette classe définit une interface pour l'allocation mémoire utilisée par les classes tableaux de Arccore (Array, UniqueArray).

Une instance de cette classe doit rester valide tant qu'il existe des tableaux l'utilisant. Comme l'allocateur est transféré lors des copies, il est préférable que les allocateurs soient des objets statiques qui dont la durée de vie est celle du programme.

Les allocateurs n'ont pas d'état modifiables spécifiques et doivent fonctionner en multi-threading.

Depuis la version 2.3 de Arccore, les méthodes sans MemoryAllocationArgs sont obsolètes.

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

Documentation des constructeurs et destructeur

◆ ~IMemoryAllocator()

virtual Arcane::IMemoryAllocator::~IMemoryAllocator ( )
virtualdefault

Détruit l'allocateur.

Les objets alloués par l'allocateur doivent tous avoir été désalloués.

Documentation des fonctions membres

◆ adjustedCapacity()

virtual Int64 Arcane::IMemoryAllocator::adjustedCapacity ( MemoryAllocationArgs args,
Int64 wanted_capacity,
Int64 element_size ) const
pure virtual

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émenté dans Arcane::AlignedMemoryAllocator, Arcane::DefaultMemoryAllocator, Arcane::impl::StackMemoryAllocator, Arccore::AlignedMemoryAllocator, et Arccore::DefaultMemoryAllocator.

◆ allocate()

virtual AllocatedMemoryInfo Arcane::IMemoryAllocator::allocate ( MemoryAllocationArgs args,
Int64 new_size )
pure 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 spécifique
  • le pointeur retourné peut être nul si la mémoire n'a pas pu être allouée.

Implémenté dans Arcane::AlignedMemoryAllocator, Arcane::DefaultMemoryAllocator, Arcane::impl::StackMemoryAllocator, Arcane::PrintableMemoryAllocator, Arccore::AlignedMemoryAllocator, Arccore::DefaultMemoryAllocator, et Arccore::PrintableMemoryAllocator.

◆ copyMemory()

void Arcane::IMemoryAllocator::copyMemory ( MemoryAllocationArgs args,
AllocatedMemoryInfo destination,
AllocatedMemoryInfo source )
virtual

Copie la mémoire entre deux zones.

L'implémentation par défaut utilise std::memcpy().

Paramètres
argsarguments de la zone mémoire
destinationdestination de la copie
destinationsource de la copie

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

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

Référencé par guaranteedAlignment().

+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ deallocate()

virtual void Arcane::IMemoryAllocator::deallocate ( MemoryAllocationArgs args,
AllocatedMemoryInfo ptr )
pure 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émenté dans Arcane::AlignedMemoryAllocator, Arcane::DefaultMemoryAllocator, Arcane::impl::StackMemoryAllocator, Arcane::PrintableMemoryAllocator, Arccore::AlignedMemoryAllocator, Arccore::DefaultMemoryAllocator, et Arccore::PrintableMemoryAllocator.

◆ guarantedAlignment()

size_t Arcane::IMemoryAllocator::guarantedAlignment ( MemoryAllocationArgs args) const
virtual

Valeur de l'alignement garanti par l'allocateur.

Voir également
guaranteedAlignment()

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

Références guaranteedAlignment().

Référencé par guaranteedAlignment().

+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ guaranteedAlignment()

virtual size_t Arcane::IMemoryAllocator::guaranteedAlignment ( MemoryAllocationArgs args) const
pure 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émenté dans Arcane::AlignedMemoryAllocator, Arcane::DefaultMemoryAllocator, Arcane::impl::StackMemoryAllocator, Arccore::AlignedMemoryAllocator, et Arccore::DefaultMemoryAllocator.

Références copyMemory(), guarantedAlignment(), et notifyMemoryArgsChanged().

Référencé par guarantedAlignment().

+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ hasRealloc()

virtual bool Arcane::IMemoryAllocator::hasRealloc ( MemoryAllocationArgs ) const
inlinevirtual

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 dans Arcane::AlignedMemoryAllocator, Arcane::DefaultMemoryAllocator, Arcane::impl::StackMemoryAllocator, Arccore::AlignedMemoryAllocator, et Arccore::DefaultMemoryAllocator.

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

◆ memoryResource()

virtual eMemoryResource Arcane::IMemoryAllocator::memoryResource ( ) const
inlinevirtual

◆ notifyMemoryArgsChanged()

void Arcane::IMemoryAllocator::notifyMemoryArgsChanged ( MemoryAllocationArgs old_args,
MemoryAllocationArgs new_args,
AllocatedMemoryInfo ptr )
virtual

Notifie du changement des arguments spécifiques à l'instance.

Paramètres
ptrzone mémoire allouée
old_argsancienne valeur des arguments
new_argsnouvelle valeur des arguments

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

Référencé par guaranteedAlignment().

+ Voici le graphe des appelants de cette fonction :

◆ reallocate()

virtual AllocatedMemoryInfo Arcane::IMemoryAllocator::reallocate ( MemoryAllocationArgs args,
AllocatedMemoryInfo current_ptr,
Int64 new_size )
pure 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émenté dans Arcane::AlignedMemoryAllocator, Arcane::DefaultMemoryAllocator, Arcane::impl::StackMemoryAllocator, Arcane::PrintableMemoryAllocator, Arccore::AlignedMemoryAllocator, Arccore::DefaultMemoryAllocator, et Arccore::PrintableMemoryAllocator.


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