Yet Another eXchange Tool: src/xt/xt

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

#include <xt/xt_xmap_dist_dir_bucket_gen.h>

Include dependency graph for xt_config.h:

This graph shows which files directly or indirectly include 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 , xt_exchanger_irecv_isend_ddt_packed }

enum	Xt_mthread_mode { XT_MT_NONE = 0 , XT_MT_OPENMP = 1 }

enum	Xt_sort_algorithm { XT_QUICKSORT , XT_MERGESORT }

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)

int	xt_config_get_idxvec_autoconvert_size (Xt_config config)

void	xt_config_set_idxvec_autoconvert_size (Xt_config config, int cnvsize)

int	xt_config_get_redist_mthread_mode (Xt_config config)

void	xt_config_set_redist_mthread_mode (Xt_config config, int mode)

int	xt_config_get_sort_algorithm_id (Xt_config config)

void	xt_config_set_sort_algorithm_by_id (Xt_config config, int algo)

void	xt_config_set_mem_saving (Xt_config config, int memconserve)

int	xt_config_get_mem_saving (Xt_config config)

Xt_xmdd_bucket_gen	xt_config_get_xmdd_bucket_gen (Xt_config config)

void	xt_config_set_xmdd_bucket_gen (Xt_config config, Xt_xmdd_bucket_gen bucket_gen_iface)

void	xt_config_set_xmap_stripe_align (Xt_config config, int use_stripe_align)

int	xt_config_get_xmap_stripe_align (Xt_config config)

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 58 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
xt_exchanger_irecv_isend_ddt_packed

Definition at line 75 of file xt_config.h.

◆ Xt_mthread_mode

enum Xt_mthread_mode

Enumerator
XT_MT_NONE
XT_MT_OPENMP

Definition at line 138 of file xt_config.h.

◆ Xt_sort_algorithm

enum Xt_sort_algorithm

Enumerator
XT_QUICKSORT	use default, in-place algorithm
XT_MERGESORT	use merge sort with allocation to trade space for better worst-case behaviour

Definition at line 163 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_exchanger_parallel.c, 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 85 of file xt_config.c.

Here is the caller graph for this function:

◆ 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 query

Returns: an entry from Xt_exchangers representing the method of data transfer used

Definition at line 144 of file xt_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ xt_config_get_idxvec_autoconvert_size()

int xt_config_get_idxvec_autoconvert_size ( Xt_config config )

query size above which index lists of vector type will be converted

For many operations it makes sense to first compress large index vectors to stripes before continuing further computations.

Parameters

[in] config configuration object to query

Returns: size of vectors at which conversion happens

Definition at line 327 of file xt_config.c.

Here is the caller graph for this function:

◆ xt_config_get_mem_saving()

int xt_config_get_mem_saving ( Xt_config config )

Get memory conservation parameter.

Parameters

[in] config configuration object to query

Definition at line 269 of file xt_config.c.

Here is the caller graph for this function:

◆ xt_config_get_redist_mthread_mode()

int xt_config_get_redist_mthread_mode ( Xt_config config )

query multi-thread mode of message passing

Parameters

[in] config configuration object to query

Returns: a value matching one of the enum Xt_mthread_mode members above

Definition at line 340 of file xt_config.c.

Here is the caller graph for this function:

◆ xt_config_get_sort_algorithm_id()

int xt_config_get_sort_algorithm_id ( Xt_config config )

query sorting algorithm suite

Parameters

[in] config configuration object to query

Returns: a value matching one of the enum Xt_sort_algorithm members above

Definition at line 232 of file xt_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ xt_config_get_xmap_stripe_align()

int xt_config_get_xmap_stripe_align ( Xt_config config )

Get xmap stripe alignment parameter.

Parameters

[in] config configuration object to query

Definition at line 399 of file xt_config.c.

Here is the caller graph for this function:

◆ xt_config_get_xmdd_bucket_gen()

Xt_xmdd_bucket_gen xt_config_get_xmdd_bucket_gen ( Xt_config config )

Query configured bucket generator

Definition at line 276 of file xt_config.c.

Here is the caller graph for this function:

◆ 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_exchanger_parallel.c, and test_redist_common.c.

Definition at line 78 of file xt_config.c.

Here is the caller graph for this function:

◆ 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 297 of file xt_config.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ xt_config_set_idxvec_autoconvert_size()

void xt_config_set_idxvec_autoconvert_size	(	Xt_config	config,
		int	cnvsize )

set size above which index lists of vector type will be converted

For many operations it makes sense to first compress large index vectors to stripes before continuing further computations. This function sets the size of vectors at which this conversion happens for operations that are called with the configuration object as parameter.

Parameters

[in,out]	config	configuration object to modify
[in]	cnvsize	size of vectors at which conversion happens

Definition at line 333 of file xt_config.c.

Here is the caller graph for this function:

◆ xt_config_set_mem_saving()

void xt_config_set_mem_saving	(	Xt_config	config,
		int	memconserve )

Set memory conservation parameter.

Parameters

[in,out]	config	configuration object to modify
	memconserve	switch on methods of memory saving currently supported values: 0 and 1

When set to 1, operations parameterized by config will aggressively try to trade memory savings for higher computational cost.

Currently, by not sorting index lists used in xmap construction.

When set to 0, use default trade-offs for space vs. time complexity.

Definition at line 263 of file xt_config.c.

Here is the caller graph for this function:

◆ xt_config_set_redist_mthread_mode()

void xt_config_set_redist_mthread_mode	(	Xt_config	config,
		int	mode )

set multi-thread mode of message passing

Parameters

[in,out]	config	configuration object to modify
[in]	mode	one of the enum Xt_mthread_mode members above

Examples: test_exchanger_parallel.c.

Definition at line 347 of file xt_config.c.

Here is the caller graph for this function:

◆ xt_config_set_sort_algorithm_by_id()

void xt_config_set_sort_algorithm_by_id	(	Xt_config	config,
		int	algo )

set sorting algorithm suite

Parameters

[in,out]	config	configuration object to modify
[in]	algo	one of the enum Xt_sort_algorithm members above

Definition at line 245 of file xt_config.c.

Here is the caller graph for this function:

◆ xt_config_set_xmap_stripe_align()

void xt_config_set_xmap_stripe_align	(	Xt_config	config,
		int	use_stripe_align )

Set xmap stripe alignment parameter.

Parameters

[in,out]	config	configuration object to modify
	use_stripe_align	0: detect element positions one by one, 1: align full stripes to form position extents 2: automatically choose element of stripe alignment

When set to 1, the computations in the xmap constructor can be much more expensive if stripes are very short. When set to 0, use very simple algorithm that positions each element individually but will use memory proportional to the local index list sizes.

By default the xmap constructor switches automatically to stripe alignment if it appears profitable, which might be untrue if the number of resulting stripes/extents is rather high.

Definition at line 389 of file xt_config.c.

Here is the caller graph for this function:

◆ xt_config_set_xmdd_bucket_gen()

void xt_config_set_xmdd_bucket_gen	(	Xt_config	config,
		Xt_xmdd_bucket_gen	bucket_gen_iface )

Change generator for buckets in distributed directory The default is a generator that tiles the range of indices of all index lists involved in xmap creation in 1D fashion with stripes.

Definition at line 282 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 126 of file xt_config.c.

Here is the caller graph for this function:

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ Xt_config

Enumeration Type Documentation

◆ Xt_exchangers

◆ Xt_mthread_mode

◆ Xt_sort_algorithm

Function Documentation

◆ xt_config_delete()

◆ xt_config_get_exchange_method()

◆ xt_config_get_idxvec_autoconvert_size()

◆ xt_config_get_mem_saving()

◆ xt_config_get_redist_mthread_mode()

◆ xt_config_get_sort_algorithm_id()

◆ xt_config_get_xmap_stripe_align()

◆ xt_config_get_xmdd_bucket_gen()

◆ xt_config_new()

◆ xt_config_set_exchange_method()

◆ xt_config_set_idxvec_autoconvert_size()

◆ xt_config_set_mem_saving()

◆ xt_config_set_redist_mthread_mode()

◆ xt_config_set_sort_algorithm_by_id()

◆ xt_config_set_xmap_stripe_align()

◆ xt_config_set_xmdd_bucket_gen()

◆ xt_exchanger_id_by_name()