xt_config.h File Reference

opaque configuration object for settings where the default needs to be overridden More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef struct Xt_config_ *	Xt_config

Enumerations
enum	Xt_exchangers {   xt_exchanger_irecv_send , xt_exchanger_irecv_isend , xt_exchanger_irecv_isend_packed , xt_exchanger_mix_isend_irecv ,   xt_exchanger_neigh_alltoall }

Functions
Xt_config	xt_config_new (void)
void	xt_config_delete (Xt_config config)
void	xt_config_set_exchange_method (Xt_config config, int method)
int	xt_config_get_exchange_method (Xt_config config)
int	xt_exchanger_id_by_name (const char *name)

Detailed Description

opaque configuration object for settings where the default needs to be overridden

Copyright

Copyright (C) 2020 Jörg Behrens behre.nosp@m.ns@d.nosp@m.krz.d.nosp@m.e Moritz Hanke hanke.nosp@m.@dkr.nosp@m.z.de Thomas Jahns jahns.nosp@m.@dkr.nosp@m.z.de

Author

Jörg Behrens behre.nosp@m.ns@d.nosp@m.krz.d.nosp@m.e Moritz Hanke hanke.nosp@m.@dkr.nosp@m.z.de Thomas Jahns jahns.nosp@m.@dkr.nosp@m.z.de

Definition in file xt_config.h.

Typedef Documentation

Xt_config

typedef struct Xt_config_* Xt_config

Definition at line 56 of file xt_config.h.

Enumeration Type Documentation

Xt_exchangers

enum Xt_exchangers

Enumerator
xt_exchanger_irecv_send
xt_exchanger_irecv_isend
xt_exchanger_irecv_isend_packed
xt_exchanger_mix_isend_irecv
xt_exchanger_neigh_alltoall

Definition at line 73 of file xt_config.h.

Function Documentation

xt_config_delete()

void xt_config_delete

(

Xt_config

config

)

destructor of configuration objects

Parameters

[in,out]

config

configuration object to destroy

Examples

test_redist_collection.c, test_redist_collection_parallel.c, test_redist_collection_static.c, test_redist_collection_static_parallel.c, test_redist_common.c, test_redist_p2p.c, test_redist_p2p_parallel.c, test_redist_repeat.c, test_redist_repeat_parallel.c, test_redist_single_array_base.c, and test_redist_single_array_base_parallel.c.

Definition at line 76 of file xt_config.c.

xt_config_get_exchange_method()

int xt_config_get_exchange_method

(

Xt_config

config

)

get exchanger used when the config object is passed to constructors

Parameters

[in]

config

configuration object to modify

Returns

an entry from Xt_exchangers representing the method of data transfer used

Definition at line 111 of file xt_config.c.

xt_config_new()

Xt_config xt_config_new

(

void

)

constructor for configuration object

Returns

returns a configuration object where every setting is set to the corresponding default.

Examples

test_redist_common.c.

Definition at line 69 of file xt_config.c.

xt_config_set_exchange_method()

void xt_config_set_exchange_method	(	Xt_config	config,
		int	method
	)

set exchanger to use when the config object is passed to constructors

Parameters

[in,out]	config	configuration object to modify
	method	an entry from enum Xt_exchangers to signify the desired exchanger for data transfers

Examples

test_redist_common.c.

Definition at line 125 of file xt_config.c.

Here is the caller graph for this function:

xt_exchanger_id_by_name()

int xt_exchanger_id_by_name

(

const char *

name

)

map exchanger name string to method id from Xt_exchangers

Parameters

[in]

name

string that is supposed to match the part of the corresponding enum after xt_exchanger_

Returns

for the string "irecv_send", the value of xt_exchanger_irecv_send will be returned, for strings matching no known exchanger, -1 will be returned

Examples

test_exchanger_parallel.c, and test_redist_common.c.

Definition at line 103 of file xt_config.c.

Here is the caller graph for this function: