utils_core.c

Go to the documentation of this file.

// Copyright (c) 2024 The YAC Authors
//
// SPDX-License-Identifier: BSD-3-Clause
 
#include <stdlib.h>
#include <stdio.h>
#include <errno.h>
#include <limits.h>
#include <string.h>
 
#include "utils_core.h"
#include "yac_mpi_internal.h"
 
char const * yac_name_type_pair_get_name(
  struct yac_name_type_pair const * pairs, size_t count, int type) {
 
  char const * name = NULL;
  for (size_t i = 0; (i < count) && (name == NULL); ++i)
    if (pairs[i].type == type) name = pairs[i].name;
  return name;
}
 
int yac_name_type_pair_get_type(
  struct yac_name_type_pair const * pairs, size_t count, char const * name) {
 
  int type = INT_MAX;
  if (name != NULL)
    for (size_t i = 0; (i < count) && (type == INT_MAX); ++i)
      if (!strcmp(pairs[i].name, name)) type = pairs[i].type;
  return type;
}
 
char * yac_string_dup(char const * string) {
  return (string != NULL) ? xstrdup(string) : NULL;
}
 
DEF_NAME_TYPE_PAIRS(
  bool_table,
  DEF_NAME_TYPE_PAIR(false, 0),
  DEF_NAME_TYPE_PAIR(true, 1),
  DEF_NAME_TYPE_PAIR(FALSE, 0),
  DEF_NAME_TYPE_PAIR(TRUE, 1),
  DEF_NAME_TYPE_PAIR(no, 0),
  DEF_NAME_TYPE_PAIR(yes, 1),
  DEF_NAME_TYPE_PAIR(NO, 0),
  DEF_NAME_TYPE_PAIR(YES, 1),
  DEF_NAME_TYPE_PAIR(off, 0),
  DEF_NAME_TYPE_PAIR(on, 1),
  DEF_NAME_TYPE_PAIR(OFF, 0),
  DEF_NAME_TYPE_PAIR(ON, 1),
  DEF_NAME_TYPE_PAIR(0, 0),
  DEF_NAME_TYPE_PAIR(1, 1))
 
int yac_getenv_bool(const char * name, int default_value, MPI_Comm comm) {
 
  YAC_ASSERT(name != NULL, "Environment variable name must not be NULL");
  YAC_ASSERT((default_value == 0) || (default_value == 1),
             "Default value must be 0(false) or 1(true)");
  YAC_ASSERT(comm != MPI_COMM_NULL, "Communicator must not be MPI_COMM_NULL");
 
  int value = default_value;
  int rank;
  yac_mpi_call(MPI_Comm_rank(comm, &rank), comm);
 
  // determine value only on rank 0 to avoid potential issues with
  // inconsistent environment variables across ranks
  if (rank == 0) {
 
    char * str_value = getenv(name);
 
    if ((str_value != NULL) && (str_value[0] != '\0')) {
 
      value =
        yac_name_type_pair_get_type(
          bool_table, bool_table_size, str_value);
      YAC_ASSERT_F(
        value != INT_MAX,
        "\"%s\" is not a valid boolean value for environment variable %s",
        str_value,  name);
    }
  }
 
  // broadcast value to all ranks
  yac_mpi_call(MPI_Bcast(&value, 1, MPI_INT, 0, comm), comm);
 
  return value;
}
 
int yac_getenv_int(
  const char * name, int default_value, int threshold, MPI_Comm comm) {
 
  YAC_ASSERT(name != NULL, "Environment variable name must not be NULL");
  YAC_ASSERT(comm != MPI_COMM_NULL, "Communicator must not be MPI_COMM_NULL");
 
  int value = default_value;
  int rank;
  yac_mpi_call(MPI_Comm_rank(comm, &rank), comm);
 
  // determine value only on rank 0 to avoid potential issues with
  // inconsistent environment variables across ranks
  if (rank == 0) {
 
    char * str_value = getenv(name);
 
    if ((str_value != NULL) && (str_value[0] != '\0')) {
 
      errno = 0;
      char * end_ptr = NULL;
      long value_long = strtol(str_value, &end_ptr, 10);
 
      YAC_ASSERT_F(
        (value_long >= INT_MIN) && (value_long <= INT_MAX),
        "\"%s\" is not a valid integer value for environment variable %s",
        str_value, name);
 
      value = ((int)value_long < threshold) ? default_value : (int)value_long;
    }
  }
 
  yac_mpi_call(MPI_Bcast(&value, 1, MPI_INT, 0, comm), comm);
 
  return value;
}
 
char * yac_getenv_str(
  const char * name, const char * default_value, MPI_Comm comm) {
 
  YAC_ASSERT(name != NULL, "Environment variable name must not be NULL");
  YAC_ASSERT(comm != MPI_COMM_NULL, "Communicator must not be MPI_COMM_NULL");
 
  int rank;
  yac_mpi_call(MPI_Comm_rank(comm, &rank), comm);
 
  size_t str_value_len = SIZE_MAX; // SIZE_MAX means use default
  char * str_value = NULL;
 
  // determine value only on rank 0 to avoid potential issues with
  // inconsistent environment variables across ranks
  if (rank == 0) {
 
    str_value = yac_string_dup(getenv(name));
    if ((str_value != NULL) && (str_value[0] != '\0')) {
      str_value_len = strlen(str_value);
    }
  }
 
  // broadcast length of string to all ranks
  yac_mpi_call(MPI_Bcast(&str_value_len, 1, YAC_MPI_SIZE_T, 0, comm), comm);
 
  // if the environment variable is not set or is an empty string
  if (str_value_len == SIZE_MAX) {
 
    // use default value
    str_value = yac_string_dup(default_value);
  } else {
 
    if (rank != 0) str_value = xmalloc(str_value_len + 1);
 
    // broadcast string value to all ranks
    yac_mpi_call(
      MPI_Bcast(str_value, str_value_len + 1, MPI_CHAR, 0, comm), comm);
  }
 
  return str_value;
}