Helper.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2015 - 2024 Intel Corporation
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef HELPER_HPP_INCLUDE
#define HELPER_HPP_INCLUDE
 
#include <sched.h>
#include <stdint.h>
 
#include <functional>
#include <memory>
#include <set>
#include <string>
#include <utility>
#include <vector>
 
#include "geopm_public.h"
 
namespace geopm
{
    class PlatformIO;
    template <class Type, class ...Args>
    std::unique_ptr<Type> make_unique(Args &&...args)
    {
        return std::unique_ptr<Type>(new Type(std::forward<Args>(args)...));
    }
 
    std::string GEOPM_PUBLIC
        read_file(const std::string &path);
 
    double GEOPM_PUBLIC
        read_double_from_file(const std::string &path, const std::string &expected_units);
 
    void GEOPM_PUBLIC
        write_file(const std::string &path, const std::string &contents);
 
    std::vector<std::string> GEOPM_PUBLIC
        string_split(const std::string &str, const std::string &delim);
 
    std::string GEOPM_PUBLIC
        string_join(const std::vector<std::string> &string_list, const std::string &delim);
 
    std::string GEOPM_PUBLIC
        hostname(void);
 
    std::vector<std::string> GEOPM_PUBLIC
        list_directory_files(const std::string &path);
 
    bool GEOPM_PUBLIC
        string_begins_with(const std::string &str, const std::string &key);
 
    bool GEOPM_PUBLIC
        string_ends_with(std::string str, std::string key);
 
    enum string_format_e {
        STRING_FORMAT_DOUBLE,
        STRING_FORMAT_INTEGER,
        STRING_FORMAT_HEX,
        STRING_FORMAT_RAW64,
    };
    std::function<std::string(double)> GEOPM_PUBLIC
        string_format_type_to_function(int format_type);
    std::function<std::string(double)> GEOPM_PUBLIC
        string_format_name_to_function(const std::string &format_name);
    int GEOPM_PUBLIC
        string_format_function_to_type(std::function<std::string(double)> format_function);
    std::string GEOPM_PUBLIC
        string_format_double(double signal);
 
    std::string GEOPM_PUBLIC
        string_format_float(double signal);
 
    std::string GEOPM_PUBLIC
        string_format_integer(double signal);
 
    std::string GEOPM_PUBLIC
        string_format_hex(double signal);
 
    std::string GEOPM_PUBLIC
        string_format_raw64(double signal);
 
    static constexpr int hardware_destructive_interference_size = 64;
 
    std::string GEOPM_PUBLIC
        get_env(const std::string &name);
 
    int GEOPM_PUBLIC
        verbosity_level(void);
 
    unsigned int GEOPM_PUBLIC
        pid_to_uid(const int pid);
 
    unsigned int GEOPM_PUBLIC
        pid_to_gid(const int pid);
 
    std::unique_ptr<cpu_set_t, std::function<void(cpu_set_t *)> > GEOPM_PUBLIC
        make_cpu_set(int num_cpu, const std::set<int> &cpu_enabled);
 
    bool GEOPM_PUBLIC
        has_cap_sys_admin(void);
 
    bool GEOPM_PUBLIC
        has_cap_sys_admin(int pid);
 
    class GEOPM_PUBLIC DeprecationWarning
    {
        public:
            DeprecationWarning() = delete;
            DeprecationWarning(const std::string &function, const std::string &message);
            virtual ~DeprecationWarning() = default;
    };
 
    std::string GEOPM_PUBLIC
        read_symlink_target(const std::string &symlink_path);
 
    void GEOPM_PUBLIC
        enable_fixed_counters(PlatformIO &pio);
 
}
 
#endif