AMReX_Utility.H

Go to the documentation of this file.

#ifndef BL_UTILITY_H
#define BL_UTILITY_H
#include <AMReX_Config.H>
 
#include <AMReX_BLassert.H>
#include <AMReX_REAL.H>
#include <AMReX_INT.H>
#include <AMReX_Array.H>
#include <AMReX_Vector.H>
#include <AMReX_Box.H>
#include <AMReX_BoxArray.H>
#include <AMReX_Demangle.H>
#include <AMReX_DistributionMapping.H>
#include <AMReX_ParallelDescriptor.H>
#include <AMReX_Random.H>
#include <AMReX_GpuQualifiers.H>
#include <AMReX_FileSystem.H>
#include <AMReX_String.H>
#include <AMReX_TypeTraits.H>
 
#include <cfloat>
#include <chrono>
#include <climits>
#include <cstdlib>
#include <iostream>
#include <limits>
#include <map>
#include <ostream>
#include <sstream>
#include <string>
#include <string_view>
#include <tuple>
#include <typeinfo>
#include <type_traits>
#include <utility>
 
namespace amrex
{
    template <typename T> bool is_it (std::string const& s, T& v);
 
    const std::vector<std::string>& Tokenize (const std::string& instr,
                                              const std::string& separators);
 
    bool UtilCreateDirectory (const std::string& path,
                              mode_t             mode,
                              bool               verbose = false);
    void CreateDirectoryFailed (const std::string& dir);
    void FileOpenFailed (const std::string& file);
    bool FileExists(const std::string &filename);
    std::string UniqueString();
    void UtilCreateCleanDirectory (const std::string &path,
                                   bool callbarrier = true);
 
    void UtilCreateDirectoryDestructive(const std::string &path,
                                        bool callbarrier = true);
 
    void UtilRenameDirectoryToOld (const std::string &path,
                                   bool callbarrier = true);
    void OutOfMemory ();
    double InvNormDist (double p);
    double InvNormDistBest (double p);
 
    /* \brief cumulative refinement ratio between levels */
    int CRRBetweenLevels(int fromlevel, int tolevel,
                         const Vector<int> &refratios);
 
    class expect;
    std::istream& operator>>(std::istream&, const expect& exp);
 
    class expect
    {
        friend std::istream& operator>>(std::istream&, const expect& exp);
    public:
        explicit expect (std::string str_);
        explicit expect (const char* istr_);
        explicit expect (char c);
        [[nodiscard]] const std::string& the_string( ) const;
    private:
        std::string istr;
    };
 
    class StreamRetry
    {
      public:
        StreamRetry(std::ostream &os, std::string suffix, int maxtries);
        StreamRetry(std::string filename, bool abortonretryfailure, int maxtries);
        bool TryOutput();
        bool TryFileOutput();
        static int NStreamErrors()       { return nStreamErrors; }
        static void ClearStreamErrors()  { nStreamErrors = 0;    }
 
      private:
        int tries, maxTries;
        bool abortOnRetryFailure = true;
        std::string fileName;
        std::ostream *sros;
        std::ostream::pos_type spos;
        std::string suffix;
 
        static int nStreamErrors;
    };
 
    Vector<char> SerializeStringArray(const Vector<std::string> &stringArray);
    Vector<std::string> UnSerializeStringArray(const Vector<char> &charArray);
    void SyncStrings(const Vector<std::string> &localStrings,
                     Vector<std::string> &syncedStrings, bool &alreadySynced);
 
    //
    // Memory Usage Counting
    //
    // For gcc, there are extra 32 bytes for each map node.
    // For others, this number may be different.
    static const Long gcc_map_node_extra_bytes = 32L;
    template <typename T> amrex::Long bytesOf (const std::vector<T>& v);
    template <typename Key, typename T, class Compare> amrex::Long bytesOf (const std::map<Key,T,Compare>& m);
 
    void BroadcastBool(bool &bBool, int myLocalId, int rootId, const MPI_Comm &localComm);
 
    void BroadcastString(std::string &bStr, int myLocalId, int rootId, const MPI_Comm &localComm);
    void BroadcastStringArray(Vector<std::string> &bSA, int myLocalId, int rootId, const MPI_Comm &localComm);
 
    template<class T> void BroadcastArray(Vector<T> &aT, int myLocalId, int rootId, const MPI_Comm &localComm);
 
    void Sleep (double sleepsec);  // Sleep for sleepsec seconds
 
 
    using MaxResSteadyClock = std::conditional_t<std::chrono::high_resolution_clock::is_steady,
                                               std::chrono::high_resolution_clock,
                                               std::chrono::steady_clock>;
    double second () noexcept;
 
    template<typename T> void hash_combine (uint64_t & seed, const T & val) noexcept;
    template<typename T> uint64_t hash_vector (const Vector<T> & vec, uint64_t seed = 0xDEADBEEFDEADBEEF) noexcept;
 
    template <class T>
    std::ostream& ToString(std::ostream& os,
                           const T& t,
                           const char* symbol_begin = "[",
                           const char* symbol_delim = ", ",
                           const char* symbol_end = "]",
                           const char* symbol_str = "\"",
                           int limit = 100);
 
    template <class T>
    std::string ToString(const T& t,
                         const char* symbol_begin = "[",
                         const char* symbol_delim = ", ",
                         const char* symbol_end = "]",
                         const char* symbol_str = "\"",
                         int limit = 100,
                         std::ostringstream ss = std::ostringstream{});
 
    template <typename F, typename... T>
    AMREX_GPU_HOST_DEVICE AMREX_NO_INLINE
    auto callNoinline (F const& f, T&&... arg)
        -> decltype(std::declval<F>()(std::declval<T>()...)); // needed for nvcc
}
 
template <typename T>
bool amrex::is_it (std::string const& s, T& v)
{
    std::istringstream ss(s);
    if (ss >> v) {
        std::string left;
        std::getline(ss, left);
        return left.empty();
    } else {
        return false;
    }
}
 
template<class T> void amrex::BroadcastArray(Vector<T> &aT, int myLocalId, int rootId, const MPI_Comm &localComm)
{
  int aT_Size(-2);
  if(myLocalId == rootId) {
    aT_Size = aT.size();
  }
  ParallelDescriptor::Bcast(&aT_Size, 1, rootId, localComm);
  BL_ASSERT(aT_Size >= 0);
  if(myLocalId != rootId) {
    aT.resize(aT_Size);
  }
  if(aT_Size > 0) {
    ParallelDescriptor::Bcast(aT.dataPtr(), aT.size(), rootId, localComm);
  }
}
 
 
//
// I'm going to document right here all the BL macros that aren't documented
// anywhere else.  Note that all these #ifdef ... #endif blocks are necessary
// to get doc++ to properly document the macros.
//
 
#ifdef BL_LANG_FORT
#undef BL_LANG_FORT
/*
  The macro BL_LANG_FORT indicates that Fortran code is being compiled.
*/
#define BL_LANG_FORT 1
#endif /*BL_LANG_FORT*/
 
#ifdef BL_FORT_USE_UNDERSCORE
#undef BL_FORT_USE_UNDERSCORE
/*
  The macro BL_FORT_USE_UNDERSCORE indicates that C++ code should call
  Fortran routines by appending an underscore to the name of the Fortran
  routine.  This is set automatically by the make subsystem.
 
  For example, if the Fortran routine is named abcxyx, then it will
  be called in C++ code as abcxyz_.
*/
#define BL_FORT_USE_UNDERSCORE 1
#endif /*BL_FORT_USE_UNDERSCORE*/
 
#ifdef BL_FORT_USE_UPPERCASE
#undef BL_FORT_USE_UPPERCASE
/*
  The macro BL_FORT_USE_UPPERCASE indicates that C++ code should call
  Fortran routines using uppercase letters for all the letters in the
  routine.  This is set automatically by the make subsystem.
 
  For example, if the Fortran routine is named abcxyx, then it will
  be called in C++ code as ABCXYZ.
*/
#define BL_FORT_USE_UPPERCASE 1
#endif /*BL_FORT_USE_UPPERCASE*/
 
#ifdef BL_FORT_USE_LOWERCASE
#undef BL_FORT_USE_LOWERCASE
/*
  The macro BL_FORT_USE_LOWERCASE indicates that C++ code should call
  Fortran routines using lowercase letters for all the letters in the
  routine.  This is set automatically by the make subsystem.
 
  For example, if the Fortran routine is named abcxyx, then it will
  be called in C++ code as abcxyx.
*/
#define BL_FORT_USE_LOWERCASE 1
#endif /*BL_FORT_USE_LOWERCASE*/
 
/*
  BL_IGNORE_MAX is a macro that expands to the literal value 100000.  It is
  defined when compiling either Fortran or C++ code; i.e. when either
  BL_LANG_CC or BL_LANG_FORT is defined.  It is used in calls to
  istream::ignore() in the AMReX code when reading in characters from an
  istream.  We use this macro instead of the more proper INT_MAX from
  <limits> since at least one compiler didn't work properly when
  istream::ignore() was passed INT_MAX.
*/
#define BL_IGNORE_MAX 100000
 
template <typename T>
amrex::Long
amrex::bytesOf (const std::vector<T>& v)
{
    return sizeof(v) + v.capacity()*sizeof(T);
}
 
template <typename Key, typename T, class Compare>
amrex::Long
amrex::bytesOf (const std::map<Key,T,Compare>& m)
{
    return sizeof(m) + m.size()*(sizeof(Key)+sizeof(T)+gcc_map_node_extra_bytes);
}
 
extern "C" {
    void* amrex_malloc (std::size_t size);
    void amrex_free (void* p);
}
 
// hash combiner borrowed from Boost
/*
Boost Software License - Version 1.0 - August 17th, 2003
 
Permission is hereby granted, free of charge, to any person or organization
obtaining a copy of the software and accompanying documentation covered by
this license (the "Software") to use, reproduce, display, distribute,
execute, and transmit the Software, and to prepare derivative works of the
Software, and to permit third-parties to whom the Software is furnished to
do so, all subject to the following:
 
The copyright notices in the Software and this entire statement, including
the above license grant, this restriction and the following disclaimer,
must be included in all copies of the Software, in whole or in part, and
all derivative works of the Software, unless such copies or derivative
works are solely in the form of machine-executable object code generated by
a source language processor.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
*/
template<typename T>
void
amrex::hash_combine (uint64_t & seed, const T & val) noexcept
{
    seed ^= std::hash<T>()(val) + 0x9e3779b9 + (seed<<6) + (seed>>2);
}
 
template<typename T>
uint64_t
amrex::hash_vector (const Vector<T> & vec, uint64_t seed) noexcept
{
    for (const auto & x: vec) {
        hash_combine(seed, x);
    }
    return seed;
}
 
namespace amrex::detail {
 
    // Determine if type has .begin() and .end() member functions
    template <class T>
    constexpr decltype((std::declval<T>().begin(), std::declval<T>().end(), true)) HasBeginEnd() {
        return true;
    }
    template <class T, class... Args>
    constexpr bool HasBeginEnd(Args...) {
        return false;
    }
 
    // Determine if type has a specialization for std::tuple_size
    template <class T>
    constexpr decltype((std::tuple_size<T>::value, true)) HasTupleSize() { // NOLINT(modernize-type-traits)
        return true;
    }
    template <class T, class... Args>
    constexpr bool HasTupleSize(Args...) {
        return false;
    }
 
    // Helper for tuple unpacking
    template <class T, std::size_t... idx>
    void ToStringTupleImp(std::index_sequence<idx...>, std::ostream& os, const T& t,
                          const char* symbol_begin, const char* symbol_delim,
                          const char* symbol_end, const char* symbol_str, int limit) {
        os << symbol_begin;
        Long count = 0;
        auto op = [&](auto& value) {
            if (count > 0 && (count <= limit || limit < 0)) {
                os << symbol_delim;
            }
            if (count < limit || limit < 0) {
                ToString(os, value, symbol_begin, symbol_delim, symbol_end,
                        symbol_str, limit);
            } else if (count == limit) {
                os << "...";
            }
            ++count;
        };
        (op(std::get<idx>(t)), ...);
        os << symbol_end;
    }
}
 
template <class T>
std::ostream& amrex::ToString(std::ostream& os, const T& t, const char* symbol_begin,
                              const char* symbol_delim, const char* symbol_end,
                              const char* symbol_str, int limit)
{
    if constexpr (std::is_same_v<std::string, T> ||
                  std::is_same_v<std::string_view, T> ||
                  std::is_same_v<char*, std::decay_t<T>> ||
                  std::is_same_v<const char*, T>) {
        // String-like types
        os << symbol_str << t << symbol_str;
    } else if constexpr (std::is_same_v<signed char, T> ||
                         std::is_same_v<unsigned char, T>) {
        // Buffer-like types, don't print as char
        os << static_cast<int>(t);
    } else if constexpr (std::is_pointer_v<T>) {
        // Pointer types, don't print char* as string
        os << static_cast<const void*>(t);
    } else if constexpr (detail::HasBeginEnd<T>() || std::is_array_v<T>) {
        // Array-like types
        os << symbol_begin;
        Long count = 0;
        for (auto& value : t) {
            if (count > 0) {
                os << symbol_delim;
            }
            if (count < limit || limit < 0) {
                ToString(os, value, symbol_begin, symbol_delim, symbol_end,
                         symbol_str, limit);
            } else if (count == limit) {
                os << "...";
                break;
            }
            ++count;
        }
        os << symbol_end;
    } else if constexpr (detail::HasTupleSize<T>()) {
        // Tuple-like types
        detail::ToStringTupleImp(std::make_index_sequence<std::tuple_size_v<T>>{},
                                 os, t, symbol_begin, symbol_delim, symbol_end,
                                 symbol_str, limit);
    } else {
        // Scalar types
        os << t;
    }
    return os;
}
 
template <class T>
std::string amrex::ToString(const T& t, const char* symbol_begin, const char* symbol_delim,
                            const char* symbol_end, const char* symbol_str,
                            int limit, std::ostringstream ss)
{
    ToString(ss, t, symbol_begin, symbol_delim, symbol_end, symbol_str, limit);
    return ss.str();
}
 
template <typename F, typename... T>
AMREX_GPU_HOST_DEVICE AMREX_NO_INLINE
auto amrex::callNoinline (F const& f, T&&... arg)
    -> decltype(std::declval<F>()(std::declval<T>()...)) // needed for nvcc
{
    AMREX_IF_ON_HOST((
        if constexpr (!amrex::DefinitelyNotHostRunnable<F>::value) {
            return f(std::forward<T>(arg)...);
        }
    ))
    AMREX_IF_ON_DEVICE(( return f(std::forward<T>(arg)...); ))
}
 
#endif /*BL_UTILITY_H*/