ms_processors.hpp

/*
##############################################################################
# file: ms_processors.hpp                                                    #
# 'msparser' toolkit                                                         #
# Use this class to retrieve current CPU configuration                       #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2003 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
#    $Archive:: /Mowse/ms_mascotresfile/include/ms_processors.hpp          $ #
#     $Author: dcreasy@matrixscience.com $ #
#       $Date: 2019-10-15 16:50:41 +0100 $ #
#   $Revision: 35b34891b5eee100f767f95780f54a007d0db4b5 | MSPARSER_REL_2_8_1-0-gea32989045 $ #
# $NoKeywords::                                                            $ #
##############################################################################
*/

#ifndef MS_PROCESSORS_HPP
#define MS_PROCESSORS_HPP

#include <string>
#include <vector>

namespace msparser_internal {
    class ms_processors_impl;
}

namespace matrix_science {



    class MS_MASCOTRESFILE_API ms_processors: public ms_errors
    {
    public:

        enum HYPERTHREADING
        {
            HT_NOT_CAPABLE           = 0, 
            HT_ENABLED               = 1, 
            HT_DISABLED              = 2, 
            HT_SUPPORTED_NOT_ENABLED = 3, 
            HT_CANNOT_DETECT         = 4  
        };


        enum { 
            DEPRECATED_MAX_CORES_PER_LICENSE = 4 
        };

        ms_processors(bool checkLinuxHT, int unused);

        ms_processors(const ms_processors& src);

        ~ms_processors();

        void copyFrom(const ms_processors* right);

#ifndef SWIG

        ms_processors& operator=(const ms_processors& right);
#endif

        int getNumOnSystem() const;

        int getNumAvailableToProcess() const;

        bool isProcessAffinitySupported() const;

        bool isUseProcessesNotThreads() const;

        UINT64 getWhichAvailableForMascot() const;

        std::vector<int> getWhichAvailableForMascot2() const;

        bool isLogicalCPUAvailableForMascot(const int cpu) const;

        int getNumProcessorGroups() const;

        int getNumPhysicalOnSystem() const;

        HYPERTHREADING getHyperThreadingState() const;

        int getNumLogicalPerPhysical(const int packageID = 0) const;

        int getNumCores(const int packageID = -1) const;

        int getPhysicalFromLogical(const int cpu) const;

        std::string getProcessorName() const;

        std::string getMultithreadedName() const;

        UINT64 getHyperThreadedCPUsMask() const; 

        bool isPrimaryLogicalProcessor(const int cpu) const;

        bool isThreadedLogicalProcessor(const int cpu) const;

        int getCoreFromLogical(const int cpu) const;

        int getHT_IDFromLogical(const int cpu) const;

        int getAutoDetectNumThreads(const int numLicensed, const int numCoresPerCpuLicense) const;
       
        bool setProcessAffinity(const std::vector<unsigned int> & vecCpu) const;

        bool setProcessAffinity(const std::vector<int> & vecCpu) const;

        bool setThreadAffinity(const int logicalCpu) const;

    private:
        msparser_internal::ms_processors_impl * pImpl_;
    }; // class ms_processors // end of config_group
} // namespace matrix_science

#endif // MS_PROCESSORS_HPP

/*------------------------------- End of File -------------------------------*/