Classe d'encapsulation des fonctions de la librairie OTF2. Plus de détails...

#include <arcane/std/Otf2LibWrapper.h>

Graphe de collaboration de Arcane::Otf2LibWrapper:

Classes
struct	EntryPointId

struct	InternalIds

Fonctions membres publiques
	Otf2LibWrapper (ISubDomain *sub_domain)
	Constructeur.

	~Otf2LibWrapper ()
	Destructeur.

void	init (const String &archive_name)
	Methode d'initialisation. Permet de definir le chemin ou va se trouver l'archive ainsi que son nom.

void	finalize ()
	Methode a appeler pour finaliser la creation de l'archive (i.e. on ne veut plus enregistrer plus d'evenements)

OTF2_EvtWriter *	getEventWriter ()

uint32_t	getEntryPointId (const String &ep_name) const
	Helper pour l'id d'un point d'entree via son nom.

uint32_t	getApplicationNameId () const
	Helper sur le nom de l'application.

uint32_t	getSynchronizeId () const
	Helper sur la chaine de charactere "syncrhonize".

int	getMpiRank () const
	Helper sur le numero de rank MPI.

int	getMpiNbRank () const
	Helper sur le nombre de rank MPI.

Fonctions membres publiques statiques
static OTF2_TimeStamp	getTime ()
	Méthode interne statique pour recuperer le timestamp.

Fonctions membres privées
void	_createOtf2Ids ()

void	_buildOtf2ClockAndStringDefinition (uint64_t global_start_time, uint64_t global_end_time)

void	_buildOtf2ParadigmAndSystemDefinition ()

void	_buildOtf2LocationDefinition ()
	Methode interne pour ecrire la definition du systeme associee a l'archive otf2.

void	_buildOtf2RegionDefinition ()

void	_buildOtf2GroupAndCommDefinition ()

Fonctions membres privées statiques
static OTF2_FlushType	_preFlush (void user_data, OTF2_FileType file_type, OTF2_LocationRef location, void caller_data, bool final)
	Méthode interne statique pour positionner la callback a appeler avant l'evenement a enregistrer.

static OTF2_TimeStamp	_postFlush (void *user_data, OTF2_FileType file_type, OTF2_LocationRef location)
	Méthode interne statique pour positionner la callback a appeler apres l'evenement a enregistrer.

Attributs privés
ISubDomain *	m_sub_domain = nullptr

OTF2_Archive *	m_archive = nullptr

OTF2_FlushCallbacks	m_flush_callbacks

OTF2_EvtWriter *	m_evt_writer = nullptr

uint64_t	m_evt_nb = 0

OTF2_GlobalDefWriter *	m_global_def_writer = nullptr

InternalIds	m_id

std::vector< uint64_t >	m_comm_members

Attributs privés statiques
static uint64_t	s_epoch_start = 0
	Static member.

Description détaillée

Classe d'encapsulation des fonctions de la librairie OTF2.

Définition à la ligne 35 du fichier Otf2LibWrapper.h.

Documentation des constructeurs et destructeur

◆ Otf2LibWrapper()

Arcane::Otf2LibWrapper::Otf2LibWrapper ( ISubDomain * sub_domain )

Constructeur.

Définition à la ligne 50 du fichier Otf2LibWrapper.cc.

Références _postFlush(), et _preFlush().

◆ ~Otf2LibWrapper()

Arcane::Otf2LibWrapper::~Otf2LibWrapper ( )

Destructeur.

Définition à la ligne 61 du fichier Otf2LibWrapper.cc.

Documentation des fonctions membres

◆ _buildOtf2ClockAndStringDefinition()

void Arcane::Otf2LibWrapper::_buildOtf2ClockAndStringDefinition	(	uint64_t	global_start_time,
		uint64_t	global_end_time
	)

private

Methode interne de creation de l'ensemble des chaines de caractres utilisees dans les definitions necessaires pour l'archive OTF2. Doit etre appelee au debut de l'archivage

Définition à la ligne 336 du fichier Otf2LibWrapper.cc.

Références Arcane::ISubDomain::application(), Arccore::Platform::getHostName(), Arcane::ISubDomain::nbSubDomain(), Arcane::ISubDomain::parallelMng(), et Arcane::ISubDomain::timeLoopMng().

Référencé par finalize().

◆ _buildOtf2GroupAndCommDefinition()

void Arcane::Otf2LibWrapper::_buildOtf2GroupAndCommDefinition ( )

private

Methode interne pour definir les regions a associer aux events otf2 Doit etre appelee en fin d'archivage C'est cette methode qui ecrit effectivement les infos dans le fichier de def

Définition à la ligne 795 du fichier Otf2LibWrapper.cc.

Références Arcane::ISubDomain::nbSubDomain(), et Arcane::ISubDomain::parallelMng().

Référencé par finalize().

◆ _buildOtf2LocationDefinition()

void Arcane::Otf2LibWrapper::_buildOtf2LocationDefinition ( )

private

Methode interne pour ecrire la definition du systeme associee a l'archive otf2.

Définition à la ligne 537 du fichier Otf2LibWrapper.cc.

Références Arcane::ISubDomain::nbSubDomain(), et Arcane::ISubDomain::parallelMng().

Référencé par finalize().

◆ _buildOtf2ParadigmAndSystemDefinition()

void Arcane::Otf2LibWrapper::_buildOtf2ParadigmAndSystemDefinition ( )

private

Methode interne pour definir les regions a associer aux events otf2 Doit etre appelee en fin d'archivage

Définition à la ligne 512 du fichier Otf2LibWrapper.cc.

Références Arcane::ISubDomain::parallelMng().

Référencé par finalize().

◆ _buildOtf2RegionDefinition()

void Arcane::Otf2LibWrapper::_buildOtf2RegionDefinition ( )

private

Methode interne pour definir les regions a associer aux events otf2 Doit etre appelee en fin d'archivage

Définition à la ligne 571 du fichier Otf2LibWrapper.cc.

Références Arcane::ISubDomain::parallelMng().

Référencé par finalize().

◆ _createOtf2Ids()

void Arcane::Otf2LibWrapper::_createOtf2Ids ( )

private

Methode interne de creation des identifiants de nommage pour les definitions necessaires a l'archive OTF2. Doit etre appelee a l'init

Définition à la ligne 281 du fichier Otf2LibWrapper.cc.

Références Arcane::ISubDomain::nbSubDomain(), et Arcane::ISubDomain::timeLoopMng().

Référencé par init().

◆ _postFlush()

OTF2_TimeStamp Arcane::Otf2LibWrapper::_postFlush	(	void *	user_data,
		OTF2_FileType	file_type,
		OTF2_LocationRef	location
	)

staticprivate

Méthode interne statique pour positionner la callback a appeler apres l'evenement a enregistrer.

Définition à la ligne 267 du fichier Otf2LibWrapper.cc.

Références getTime().

Référencé par Otf2LibWrapper().

◆ _preFlush()

OTF2_FlushType Arcane::Otf2LibWrapper::_preFlush	(	void *	user_data,
		OTF2_FileType	file_type,
		OTF2_LocationRef	location,
		void *	caller_data,
		bool	final
	)

staticprivate

Méthode interne statique pour positionner la callback a appeler avant l'evenement a enregistrer.

Définition à la ligne 252 du fichier Otf2LibWrapper.cc.

Référencé par Otf2LibWrapper().

◆ finalize()

void Arcane::Otf2LibWrapper::finalize ( )

Methode a appeler pour finaliser la creation de l'archive (i.e. on ne veut plus enregistrer plus d'evenements)

Définition à la ligne 133 du fichier Otf2LibWrapper.cc.

Références _buildOtf2ClockAndStringDefinition(), _buildOtf2GroupAndCommDefinition(), _buildOtf2LocationDefinition(), _buildOtf2ParadigmAndSystemDefinition(), _buildOtf2RegionDefinition(), getTime(), et Arcane::ISubDomain::parallelMng().

◆ getApplicationNameId()

uint32_t Arcane::Otf2LibWrapper::getApplicationNameId ( ) const

Helper sur le nom de l'application.

Définition à la ligne 221 du fichier Otf2LibWrapper.cc.

◆ getEntryPointId()

uint32_t Arcane::Otf2LibWrapper::getEntryPointId ( const String & ep_name ) const

Helper pour l'id d'un point d'entree via son nom.

Définition à la ligne 191 du fichier Otf2LibWrapper.cc.

Références ARCANE_FATAL.

◆ getEventWriter()

OTF2_EvtWriter * Arcane::Otf2LibWrapper::getEventWriter ( )

Accesseur sur le otf2 event writer interne. Incremente un compteur d'evenement interne a chaque appel.

Définition à la ligne 181 du fichier Otf2LibWrapper.cc.

◆ getMpiNbRank()

int Arcane::Otf2LibWrapper::getMpiNbRank ( ) const

Helper sur le nombre de rank MPI.

Définition à la ligne 212 du fichier Otf2LibWrapper.cc.

Références Arcane::ISubDomain::nbSubDomain().

Référencé par Arcane::Otf2MpiProfiling::allGather(), Arcane::Otf2MpiProfiling::allGatherVariable(), Arcane::Otf2MpiProfiling::gatherVariable(), et Arcane::Otf2MpiProfiling::scatterVariable().

◆ getMpiRank()

int Arcane::Otf2LibWrapper::getMpiRank ( ) const

Helper sur le numero de rank MPI.

Définition à la ligne 203 du fichier Otf2LibWrapper.cc.

Références Arcane::ISubDomain::subDomainId().

Référencé par Arcane::Otf2MpiProfiling::broadcast(), Arcane::Otf2MpiProfiling::gather(), Arcane::Otf2MpiProfiling::gatherVariable(), et Arcane::Otf2MpiProfiling::scatterVariable().

◆ getSynchronizeId()

uint32_t Arcane::Otf2LibWrapper::getSynchronizeId ( ) const

Helper sur la chaine de charactere "syncrhonize".

Définition à la ligne 230 du fichier Otf2LibWrapper.cc.

◆ getTime()

OTF2_TimeStamp Arcane::Otf2LibWrapper::getTime ( )

static

Méthode interne statique pour recuperer le timestamp.

Définition à la ligne 239 du fichier Otf2LibWrapper.cc.

Références s_epoch_start.

◆ init()

void Arcane::Otf2LibWrapper::init ( const String & archive_name )

Methode d'initialisation. Permet de definir le chemin ou va se trouver l'archive ainsi que son nom.

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

Références _createOtf2Ids(), ARCANE_FATAL, getTime(), Arcane::ISubDomain::listingDirectory(), Arcane::ISubDomain::nbSubDomain(), Arcane::ISubDomain::parallelMng(), s_epoch_start, et Arcane::ISubDomain::subDomainId().

Documentation des données membres

◆ m_archive

OTF2_Archive* Arcane::Otf2LibWrapper::m_archive = nullptr

private

Définition à la ligne 110 du fichier Otf2LibWrapper.h.

◆ m_comm_members

std::vector<uint64_t> Arcane::Otf2LibWrapper::m_comm_members

private

Définition à la ligne 117 du fichier Otf2LibWrapper.h.

◆ m_evt_nb

uint64_t Arcane::Otf2LibWrapper::m_evt_nb = 0

private

Définition à la ligne 113 du fichier Otf2LibWrapper.h.

◆ m_evt_writer

OTF2_EvtWriter* Arcane::Otf2LibWrapper::m_evt_writer = nullptr

private

Définition à la ligne 112 du fichier Otf2LibWrapper.h.

◆ m_flush_callbacks

OTF2_FlushCallbacks Arcane::Otf2LibWrapper::m_flush_callbacks

private

Définition à la ligne 111 du fichier Otf2LibWrapper.h.

◆ m_global_def_writer

OTF2_GlobalDefWriter* Arcane::Otf2LibWrapper::m_global_def_writer = nullptr

private

Définition à la ligne 114 du fichier Otf2LibWrapper.h.

◆ m_id

InternalIds Arcane::Otf2LibWrapper::m_id

private

Définition à la ligne 116 du fichier Otf2LibWrapper.h.

◆ m_sub_domain

ISubDomain* Arcane::Otf2LibWrapper::m_sub_domain = nullptr

private

Définition à la ligne 109 du fichier Otf2LibWrapper.h.

◆ s_epoch_start

uint64_t Arcane::Otf2LibWrapper::s_epoch_start = 0

staticprivate

Static member.

Définition à la ligne 115 du fichier Otf2LibWrapper.h.

Référencé par getTime(), et init().

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

Classes

Fonctions membres publiques

Fonctions membres publiques statiques

Fonctions membres privées

Fonctions membres privées statiques

Attributs privés

Attributs privés statiques

Description détaillée

Documentation des constructeurs et destructeur

◆ Otf2LibWrapper()

◆ ~Otf2LibWrapper()

Documentation des fonctions membres

◆ _buildOtf2ClockAndStringDefinition()

◆ _buildOtf2GroupAndCommDefinition()

◆ _buildOtf2LocationDefinition()

◆ _buildOtf2ParadigmAndSystemDefinition()

◆ _buildOtf2RegionDefinition()

◆ _createOtf2Ids()

◆ _postFlush()

◆ _preFlush()

◆ finalize()

◆ getApplicationNameId()

◆ getEntryPointId()

◆ getEventWriter()

◆ getMpiNbRank()

◆ getMpiRank()

◆ getSynchronizeId()

◆ getTime()

◆ init()

Documentation des données membres

◆ m_archive

◆ m_comm_members

◆ m_evt_nb

◆ m_evt_writer

◆ m_flush_callbacks

◆ m_global_def_writer

◆ m_id

◆ m_sub_domain

◆ s_epoch_start