xt_config.h

Go to the documentation of this file.

/*
 * Maintainer: Jörg Behrens <behrens@dkrz.de>
 *             Moritz Hanke <hanke@dkrz.de>
 *             Thomas Jahns <jahns@dkrz.de>
 *
 * URL: https://dkrz-sw.gitlab-pages.dkrz.de/yaxt/
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are  permitted provided that the following conditions are
 * met:
 *
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * Neither the name of the DKRZ GmbH nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef XT_CONFIG_H
#define XT_CONFIG_H
 
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
 
#include <xt/xt_xmap_dist_dir_bucket_gen.h>
 
typedef struct Xt_config_ *Xt_config;

Xt_config xt_config_new(void);

void xt_config_delete(Xt_config config);
 
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,
};

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);
 
enum Xt_mthread_mode {
  /* xt_redist_[as]_exchange calls will be single-threaded */
  XT_MT_NONE = 0,
  /* xt_redist_[as]_exchange calls will open an OpenMP parallel region */
  XT_MT_OPENMP = 1,
};

int
xt_config_get_redist_mthread_mode(Xt_config config);

void
xt_config_set_redist_mthread_mode(Xt_config config, int mode);
 
enum Xt_sort_algorithm {
  XT_QUICKSORT,
  XT_MERGESORT,
};

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);
 
 
#endif
 
/*
 * Local Variables:
 * c-basic-offset: 2
 * coding: utf-8
 * indent-tabs-mode: nil
 * show-trailing-whitespace: t
 * require-trailing-newline: t
 * End:
 */