info.hpp

Go to the documentation of this file.

#ifndef GENESIS_UTILS_CORE_INFO_H_
#define GENESIS_UTILS_CORE_INFO_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2024 Lucas Czech
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
    Contact:
    Lucas Czech <lucas.czech@sund.ku.dk>
    University of Copenhagen, Globe Institute, Section for GeoGenetics
    Oster Voldgade 5-7, 1350 Copenhagen K, Denmark
*/
 
#include <cstdint>
#include <memory>
#include <string>
#include <unordered_map>
#include <utility>
#include <vector>
 
namespace genesis {
namespace utils {
 
// =================================================================================================
//     Compiler Info
// =================================================================================================
 
struct InfoCompiler
{
    std::string compile_date_time;
 
    bool is_debug;
 
    bool is_release;
 
    std::string build_type;
 
    std::string platform;
 
    std::string compiler_family;
 
    std::string compiler_version;
 
    std::string cpp_version;
 
    bool with_openmp;
 
    bool with_avx;
 
    bool with_avx2;
 
    bool with_avx512;
 
};
 
InfoCompiler const& info_get_compiler();
 
std::unordered_map<std::string,std::string> const& info_preprocessor_definitions();
 
std::string info_print_compiler();
 
// =================================================================================================
//     Hardware Info
// =================================================================================================
 
struct InfoHardware
{
    bool is_little_endian;
 
    size_t total_memory;
 
    // CPU
    bool vendor_AMD;
    bool vendor_Intel;
    std::string vendor_string;
    std::string cpu_model;
    size_t physical_core_count;
    bool with_hyperthreading;
 
    //  OS Features
    bool OS_x64;
    bool OS_AVX;
    bool OS_AVX512;
 
    //  Misc.
    bool HW_MMX;
    bool HW_x64;
    bool HW_ABM;
    bool HW_RDRAND;
    bool HW_RDSEED;
    bool HW_BMI1;
    bool HW_BMI2;
    bool HW_ADX;
    bool HW_MPX;
    bool HW_PREFETCHW;
    bool HW_PREFETCHWT1;
    bool HW_RDPID;
 
    //  SIMD: 128-bit
    bool HW_SSE;
    bool HW_SSE2;
    bool HW_SSE3;
    bool HW_SSSE3;
    bool HW_SSE41;
    bool HW_SSE42;
    bool HW_SSE4a;
    bool HW_AES;
    bool HW_SHA;
 
    //  SIMD: 256-bit
    bool HW_AVX;
    bool HW_XOP;
    bool HW_FMA3;
    bool HW_FMA4;
    bool HW_AVX2;
 
    //  SIMD: 512-bit
    bool HW_AVX512_F;
    bool HW_AVX512_CD;
 
    //  Knights Landing
    bool HW_AVX512_PF;
    bool HW_AVX512_ER;
 
    //  Skylake Purley
    bool HW_AVX512_VL;
    bool HW_AVX512_BW;
    bool HW_AVX512_DQ;
 
    //  Cannon Lake
    bool HW_AVX512_IFMA;
    bool HW_AVX512_VBMI;
 
    //  Knights Mill
    bool HW_AVX512_VPOPCNTDQ;
    bool HW_AVX512_4VNNIW;
    bool HW_AVX512_4FMAPS;
 
    //  Cascade Lake
    bool HW_AVX512_VNNI;
 
    //  Cooper Lake
    bool HW_AVX512_BF16;
 
    //  Ice Lake
    bool HW_AVX512_VBMI2;
    bool HW_GFNI;
    bool HW_VAES;
    bool HW_AVX512_VPCLMUL;
    bool HW_AVX512_BITALG;
 
};
 
InfoHardware const& info_get_hardware();
 
std::string info_print_hardware( bool full = false );
 
bool info_use_avx();
 
bool info_use_avx2();
 
bool info_use_avx512();
 
// =================================================================================================
//     Number of Threads
// =================================================================================================
 
size_t info_physical_core_count();
 
bool info_hyperthreads_enabled();
 
size_t info_number_of_threads_openmp();
 
size_t info_number_of_threads_slurm();
 
size_t guess_number_of_threads(
    bool use_openmp = true,
    bool use_slurm = true,
    bool physical_cores = true
);
 
// =================================================================================================
//     Run Time Environment
// =================================================================================================
 
size_t info_get_pid();
 
bool info_stdin_is_terminal();
 
bool info_stdout_is_terminal();
 
bool info_stderr_is_terminal();
 
std::pair<int, int> info_terminal_size();
 
// =================================================================================================
//     Current Resource Usage
// =================================================================================================
 
size_t info_process_max_file_count();
 
size_t info_process_current_file_count();
 
size_t info_process_current_memory_usage();
 
size_t info_system_current_memory_usage();
 
size_t info_system_current_memory_available();
 
double info_process_current_cpu_usage( bool all_cores = true, bool percent = true );
 
double info_system_current_cpu_usage( bool all_cores = true, bool percent = true );
 
// =================================================================================================
//     Total Resource Usage
// =================================================================================================
 
size_t info_process_peak_memory_usage();
 
std::pair<double, double> info_process_total_cpu_time();
 
double info_process_total_energy_consumption();
 
std::string info_process_print_total_usage();
 
} // namespace utils
} // namespace genesis
 
#endif // include guard