a )$a{@sdZddlZddlZddlZddlZddlZddlZddlmZddl m Z m Z dZ ddgZ ejdd ejd krzejnejZejd krejnejZGd d d ejZz ejZWneyejZYn0d d dddddddddddddddZeeddeDZ ddeDZ!ddeDZ"ddeDZ#eeddZ$d d!Z%e%ee e!d"d#dZ&e%d$'d%de Dd$'e#d$'e$d&Gd'ddZ(e%d$'d(de"Dd$'d)de Dd$'e#d$'e$d*Gd+d,d,Z)e%d$'d-de Dd$'d.de!Dd"Gd/d0d0e Z*Gd1d2d2e*Z+Gd3d4d4e*Z,Gd5d6d6e*Z-Gd7dde*Z.d8d9Z/e0d:kre/dS);zthreadpoolctl This module provides utilities to introspect native libraries that relies on thread pools (notably BLAS and OpenMP implementations) and dynamically set the maximal number of threads they can use. N) find_library)ABCabstractmethodz2.2.0threadpool_limitsthreadpool_infoZKMP_DUPLICATE_LIB_OKTruelc@s,eZdZdefdejfdejfdefgZdS) _dl_phdr_infoZ dlpi_addr dlpi_nameZ dlpi_phdrZ dlpi_phnumN) __name__ __module__ __qualname__ _SYSTEM_UINTctypesc_char_pZc_void_p_SYSTEM_UINT_HALFZ_fields_rr,lib/python3.9/site-packages/threadpoolctl.pyr-s ropenmp)libiompZlibgomplibompZvcomp)user_api internal_apifilename_prefixesblasZopenblas)Z libopenblasZmkl)Z libmkl_rtZmkl_rtZblis)Zlibblis) _OpenMPModule_OpenBLASModule _MKLModule _BLISModuleccs|]}|dVqdS)rNr.0mrrr Yr!cCsg|] }|dqS)rrrrrr Zr"r#cCsg|]}|dD]}|qqS)rr)rr prefixrrrr#[s cCs g|]}|ddkr|dqS)rrrrrrrrr#]s rrcsfdd}|S)Ncs|jji|_|SN)__doc__format)oargskwargsrr decoratordsz$_format_docstring..decoratorr)r*r+r,rr)r_format_docstringcsr-) USER_APISZ INTERNAL_APIScCsttdS)aReturn the maximal number of threads for each detected library. Return a list with all the supported modules that have been found. Each module is represented by a dict with the following information: - "user_api" : user API. Possible values are {USER_APIS}. - "internal_api": internal API. Possible values are {INTERNAL_APIS}. - "prefix" : filename prefix of the specific implementation. - "filepath": path to the loaded module. - "version": version of the library (if available). - "num_threads": the current thread limit. In addition, each module may contain internal_api specific entries. r)_ThreadpoolInfo_ALL_USER_APIStodictsrrrrrks, ccs|]}d|VqdSz"{}"Nr'rZapirrrr!r")r. BLAS_LIBS OPENMP_LIBSc@sJeZdZdZdddZddZddZd d Zd d Zd dZ ddZ dS)raChange the maximal number of threads that can be used in thread pools. This class can be used either as a function (the construction of this object limits the number of threads) or as a context manager, in a `with` block. Set the maximal number of threads that can be used in thread pools used in the supported libraries to `limit`. This function works for libraries that are already loaded in the interpreter and can be changed dynamically. Parameters ---------- limits : int, dict or None (default=None) The maximal number of threads that can be used in thread pools - If int, sets the maximum number of threads to `limits` for each library selected by `user_api`. - If it is a dictionary `{{key: max_threads}}`, this function sets a custom maximum number of threads for each `key` which can be either a `user_api` or a `prefix` for a specific library. - If None, this function does not do anything. user_api : {USER_APIS} or None (default=None) APIs of libraries to limit. Used only if `limits` is an int. - If "blas", it will only limit BLAS supported libraries ({BLAS_LIBS}). - If "openmp", it will only limit OpenMP supported libraries ({OPENMP_LIBS}). Note that it can affect the number of threads used by the BLAS libraries if they rely on OpenMP. - If None, this function will apply to all supported libraries. NcCs&|||\|_|_|_||_dSr%) _check_params_limits _user_api _prefixes_set_threadpool_limits_original_info)selflimitsrrrr__init__s zthreadpool_limits.__init__cCs|Sr%rr?rrr __enter__szthreadpool_limits.__enter__cCs |dSr%) unregister)r?typevalue tracebackrrr__exit__szthreadpool_limits.__exit__cCs&|jdur"|jD]}||jqdSr%)r>set_num_threads num_threads)r?modulerrrrDs  zthreadpool_limits.unregistercCs|jdur|j}n t|jd}i}g}|jD]d}dd|d|D}t|}t|}|dkrh|}n |dkrvd}nt|}|||||<q,|rt dd |d |S) zuOriginal num_threads from before calling threadpool_limits Return a dict `{user_api: num_threads}`. Nr/cSsg|] }|jqSrrJrrKrrrr#r"z>threadpool_limits.get_original_num_threads..rrz1Multiple value possible for following user apis: r3z. Returning the minimum.) r>r0r; get_modulessetlenpopminappendwarningswarnjoin)r?Zoriginal_limitsrJZ warning_apisrr@Zn_limitslimitrrrget_original_num_threadss6       z*threadpool_limits.get_original_num_threadscsdusttr`|dur t}n |tvr0|g}ntdt|durZfdd|Dg}njttrzddDnttrddDttstdt dd D}d d D}||fS) zLSuitable values for the _limits, _user_api and _prefixes attributes Nz6user_api must be either in {} or None. Got {} instead.csi|] }|qSrrr6r@rr r"z3threadpool_limits._check_params..cSsi|]}|d|dqSr$rJrrMrrrr[scSsi|]}|j|jqSrr\rMrrrr[sz>limits must either be an int, a list or a dict. Got {} insteadcSsg|]}|tvr|qSr) _ALL_PREFIXESrr$rrrr#r"z3threadpool_limits._check_params..cSsg|]}|tvr|qSr)r1r6rrrr#r") isinstanceintr1 ValueErrorr'listr0dict TypeErrorrE)r?r@rprefixesrrZrr9s8   zthreadpool_limits._check_paramscCsd|jdurdSt|j|jd}|D]<}|j|jvr@|j|j}n |j|j}|dur"||q"|S)zChange the maximal number of threads in selected thread pools. Return a list with all the supported modules that have been found matching `self._prefixes` and `self._user_api`. N)rer)r:r0r<r;r$rrI)r?modulesrKrJrrrr=s    z(threadpool_limits._set_threadpool_limits)NN) r r r r&rArCrHrDrYr9r=rrrrrs# $'ccs|]}d|VqdSr4r5r^rrrr! r"ccs|]}d|VqdSr4r5r6rrrr!!r")PREFIXESr.r7r8c@seZdZdZeZeZd$ddZddZddZ d d Z d d Z d dZ ddZ ddZddZddZddZddZddZeddZedd Zed%d"d#ZdS)&r0aCollection of all supported modules that have been found Parameters ---------- user_api : list of user APIs or None (default=None) Select libraries matching the requested API. Ignored if `modules` is not None. Supported user APIs are {USER_APIS}. - "blas" selects all BLAS supported libraries ({BLAS_LIBS}) - "openmp" selects all OpenMP supported libraries ({OPENMP_LIBS}) If None, libraries are not selected by their `user_api`. prefixes : list of prefixes or None (default=None) Select libraries matching the requested prefixes. Supported prefixes are {PREFIXES}. If None, libraries are not selected by their prefix. Ignored if `modules` is not None. modules : list of _Module objects or None (default=None) Wraps a list of _Module objects into a _ThreapoolInfo object. Does not load or reload any shared library. If it is not None, `prefixes` and `user_api` are ignored. Note ---- Is is possible to select libraries both by prefixes and by user_api. All libraries matching one or the other will be selected. NcCsN|durD|durgn||_|dur&gn||_g|_||n||_dSr%)rerrf _load_modules_warn_if_incompatible_openmp)r?rrerfrrrrANs z_ThreadpoolInfo.__init__csHdkrdurtttts(gfdd|jD}t|dS)z8Return all modules such that values contains module[key]rNcsg|]}t|vr|qSr)getattrrMkeyvaluesrrr#_sz/_ThreadpoolInfo.get_modules..rf)rbr1r_rfr0)r?rlrmrfrrkrrOYs  z_ThreadpoolInfo.get_modulescCsdd|jDS)zReturn info as a list of dictscSsg|] }|qSrtodictrMrrrr#er"z+_ThreadpoolInfo.todicts..rnrBrrrr2csz_ThreadpoolInfo.todictscCs t|jSr%)rQrfrBrrr__len__gsz_ThreadpoolInfo.__len__ccs|jEdHdSr%rnrBrrr__iter__jsz_ThreadpoolInfo.__iter__cCs |j|jkSr%rnr?otherrrr__eq__msz_ThreadpoolInfo.__eq__cCs4tjdkr|ntjdkr(|n|dS)z6Loop through loaded libraries and store supported onesdarwinwin32N)sysplatform_find_modules_with_dyld)_find_modules_with_enum_process_module_ex"_find_modules_with_dl_iterate_phdrrBrrrrhps     z_ThreadpoolInfo._load_modulescs`}t|dsgSfdd}ttjtttjtj}||}td}| ||dS)aoLoop through loaded libraries and return binders on supported ones This function is expected to work on POSIX system only. This code is adapted from code by Intel developper @anton-malakhov available at https://github.com/IntelPython/smp Copyright (c) 2017, Intel Corporation published under the BSD 3-Clause license dl_iterate_phdrcs$|jj}|r |d}|dS)Nutf-8r)contentsr decode_make_module_from_path)infosizedatafilepathrBrrmatch_module_callbacks   zQ_ThreadpoolInfo._find_modules_with_dl_iterate_phdr..match_module_callbackr"N) _get_libchasattrrZ CFUNCTYPEc_intZPOINTERrZc_size_trr})r?libcrZc_func_signatureZc_match_module_callbackrrrBrr|ys    z2_ThreadpoolInfo._find_modules_with_dl_iterate_phdrcCs^|}t|dsgS|}tj|j_t|D](}t||}| d}| |q0dS)zLoop through loaded libraries and return binders on supported ones This function is expected to work on OSX system only _dyld_image_countr~N) rrrrrZ_dyld_get_image_namerestyperangeZ string_atrr)r?rZn_dyldirrrrrzs    z'_ThreadpoolInfo._find_modules_with_dyldc CsNddlm}m}m}d}d}d}|d}|d}|||Bdt} | s^td tzd } |} || } t | } | | t | | t | |std | | j krq| j | | } qj| j | | }t|| d |}t |} |}|D]:}|| |t | t |std | j }||qW|| n || 0d S)aLoop through loaded libraries and return binders on supported ones This function is expected to work on windows system only. This code is adapted from code by Philipp Hagemeister @phihag available at https://stackoverflow.com/questions/17474574 r)DWORDHMODULEMAX_PATHiZPsapiZkernel32FzCould not open PID %szEnumProcessModulesEx failedNzGetModuleFileNameEx failed)Zctypes.wintypesrrr _get_windllZ OpenProcessosgetpidOSErrorrZsizeofZEnumProcessModulesExZbyrefrFmapZcreate_unicode_bufferZGetModuleFileNameExWrZ CloseHandle)r?rrrZPROCESS_QUERY_INFORMATIONZPROCESS_VM_READZLIST_MODULES_ALLZps_apiZ kernel_32Z h_processZ buf_countZneededbufZbuf_sizecountZ h_modulesZn_sizeZh_modulerrrrr{sL         z9_ThreadpoolInfo._find_modules_with_enum_process_module_exc Cs||}tj|}tD]j\}}|||d}|durDq"|d}|d}||jvsh||j vr"t |}|||||}|j |q"dS)z.Store a module if it is supported and selectedrNrr) _realpathrpathbasenamelower_SUPPORTED_MODULESitems _check_prefixrerglobalsrfrT) r?rfilenameZ module_classZcandidate_moduler$rrrKrrrrs  z&_ThreadpoolInfo._make_module_from_pathcCs |D]}||r|SqdS)z]Return the prefix library_basename starts with Return None if none matches. N startswith)r?Zlibrary_basenamerr$rrrrs  z_ThreadpoolInfo._check_prefixcCsHtjdkrdSdd|jD}td}d|vrDd|vrDt|tdS)z?Raise a warning if llvm-OpenMP and intel-OpenMP are both loadedZlinuxNcSsg|] }|jqSr)r$rMrrrr#r"z@_ThreadpoolInfo._warn_if_incompatible_openmp..a Found Intel OpenMP ('libiomp') and LLVM OpenMP ('libomp') loaded at the same time. Both libraries are known to be incompatible and this can cause random crashes or deadlocks on Linux when loaded in the same Python program. Using threadpoolctl may cause crashes or deadlocks. For more information and possible workarounds, please see https://github.com/joblib/threadpoolctl/blob/master/multiple_openmp.md rr)rxryrftextwrapdedentrUrVRuntimeWarning)r?remsgrrrris  z,_ThreadpoolInfo._warn_if_incompatible_openmpcCsD|jd}|dur@td}|dur(dStj|td}||jd<|S)z Load the lib-C for unix systems.rNcmode)_system_librariesgetrrCDLL _RTLD_NOLOAD)clsrZ libc_namerrrr$s  z_ThreadpoolInfo._get_libccCs2|j|}|dur.td|}||j|<|S)zLoad a windows DLLNz{}.dll)rrrZWinDLLr')rZdll_nameZdllrrrr0s   z_ThreadpoolInfo._get_windll'cCs<|j|}|dur8tj|}t|j|kr8||j|<|S)zLSmall caching wrapper around os.path.realpath to limit system calls N) _realpathsrrrrealpathrQ)rrZ cache_limitZrpathrrrr9s    z_ThreadpoolInfo._realpath)NNN)r)r r r r&rcrrrArOr2rqrrrurhr|rzr{rrri classmethodrrrrrrrr0s,!   ";   r0ccs|]}d|VqdSr4r5r6rrrr!Hr"ccs|]}d|VqdSr4r5r6rrrr!Ir"c@sZeZdZdZdddZddZddZed d Zed d Z ed dZ eddZ dS)_Modulea Abstract base class for the modules A module is represented by the following information: - "user_api" : user API. Possible values are {USER_APIS}. - "internal_api" : internal API. Possible values are {INTERNAL_APIS}. - "prefix" : prefix of the shared library's name. - "filepath" : path to the loaded module. - "version" : version of the library (if available). - "num_threads" : the current thread limit. In addition, each module may contain internal_api specific entries. NcCsH||_||_||_||_tj|td|_||_ | |_ | dS)Nr) rr$rrrrr_dynlib get_versionversionget_num_threadsrJ_get_extra_info)r?rr$rrrrrrAWs  z_Module.__init__cCs||kSr%rorsrrrrubsz_Module.__eq__cCsddt|DS)z&Return relevant info wrapped in a dictcSs i|]\}}|ds||qS)_r)rkvrrrr[gr"z"_Module.todict..)varsrrBrrrrpesz_Module.todictcCsdS)z(Return the version of the shared libraryNrrBrrrrisz_Module.get_versioncCsdS)z5Return the maximum number of threads available to useNrrBrrrrnsz_Module.get_num_threadscCsdS)z(Set the maximum number of threads to useNr)r?rJrrrrIssz_Module.set_num_threadscCsdS)z*Add additional module specific informationNrrBrrrrxsz_Module._get_extra_info)NNNN) r r r r&rArurprrrrIrrrrrrGs     rc@s@eZdZdZddZddZddZdd Zd d Zd d Z dS)rzModule class for OpenBLAScCsBt|jddd}tj|_|}|ddkr>|ddSdS)NZopenblas_get_configcSsdSr%rrrrrr"z-_OpenBLASModule.get_version..rsOpenBLASrNr~)rjrrrrsplitr)r?Z get_configZconfigrrrrs  z_OpenBLASModule.get_versioncCst|jddd}|S)NZopenblas_get_num_threadscSsdSr%rrrrrrr"z1_OpenBLASModule.get_num_threads..rjrr?get_funcrrrrsz_OpenBLASModule.get_num_threadscCst|jddd}||S)NZopenblas_set_num_threadscSsdSr%rrLrrrrr"z1_OpenBLASModule.set_num_threads..rr?rJZset_funcrrrrIsz_OpenBLASModule.set_num_threadscCs||_||_dSr%get_threading_layerthreading_layerget_architectureZ architecturerBrrrrs z_OpenBLASModule._get_extra_infocCs&|j}|dkrdS|dkr"dSdS)z&Return the threading layer of OpenBLASrrNpthreadsdisabled)rZopenblas_get_parallel)r?rrrrrs  z#_OpenBLASModule.get_threading_layercCs.t|jdd}|durdStj|_|dS)NZopenblas_get_corenamer~rjrrrrr)r?Z get_corenamerrrrs z _OpenBLASModule.get_architectureN r r r r&rrrIrrrrrrrr~s  rc@s@eZdZdZddZddZddZdd Zd d Zd d Z dS)rzModule class for BLIScCs&t|jddd}tj|_|dS)NZbli_info_get_version_strcSsdSr%rrrrrrr"z)_BLISModule.get_version..r~r)r?Z get_version_rrrrs z_BLISModule.get_versioncCs(t|jddd}|}|dkr$dS|S)NZbli_thread_get_num_threadscSsdSr%rrrrrrr"z-_BLISModule.get_num_threads..rNr)r?rrJrrrrs z_BLISModule.get_num_threadscCst|jddd}||S)NZbli_thread_set_num_threadscSsdSr%rrLrrrrr"z-_BLISModule.set_num_threads..rrrrrrIsz_BLISModule.set_num_threadscCs||_||_dSr%rrBrrrrs z_BLISModule._get_extra_infocCs |jrdS|jrdSdS)z"Return the threading layer of BLISrrr)rZbli_info_get_enable_openmpZbli_info_get_enable_pthreadsrBrrrrs   z_BLISModule.get_threading_layercCsPt|jdd}t|jdd}|dus,|dur0dStj|_tj|_||dS)Nbli_arch_query_idbli_arch_stringr~)rjrrrrrr)r?rrrrrrsz_BLISModule.get_architectureNrrrrrrsrc@s8eZdZdZddZddZddZdd Zd d Zd S) rzModule class for MKLcCs\t|jdsdStd}|j|d|jd}td|}|durT| d}| S)NMKL_Get_Version_Stringr~zVersion ([^ ]+) r) rrrZcreate_string_bufferrrFrresearchgroupsstrip)r?resrgrouprrrrs     z_MKLModule.get_versioncCst|jddd}|S)NZMKL_Get_Max_ThreadscSsdSr%rrrrrrr"z,_MKLModule.get_num_threads..rrrrrrsz_MKLModule.get_num_threadscCst|jddd}||S)NZMKL_Set_Num_ThreadscSsdSr%rrLrrrrr"z,_MKLModule.set_num_threads..rrrrrrIsz_MKLModule.set_num_threadscCs||_dSr%)rrrBrrrrsz_MKLModule._get_extra_infocCs0t|jddd}dddddd d }||d S) z!Return the threading layer of MKLZMKL_Set_Threading_LayercSsdS)Nrr)Zlayerrrrrr"z0_MKLModule.get_threading_layer..ZintelZ sequentialZpgiZgnuZtbbz not specified)rrNrrrrr)r?Zset_threading_layerZ layer_maprrrrsz_MKLModule.get_threading_layerN) r r r r&rrrIrrrrrrrs  rc@s0eZdZdZddZddZddZdd Zd S) rzModule class for OpenMPcCsdSr%rrBrrrrsz_OpenMPModule.get_versioncCst|jddd}|S)NZomp_get_max_threadscSsdSr%rrrrrrr"z/_OpenMPModule.get_num_threads..rrrrrrsz_OpenMPModule.get_num_threadscCst|jddd}||S)NZomp_set_num_threadscSsdSr%rrLrrrr r"z/_OpenMPModule.set_num_threads..rrrrrrI sz_OpenMPModule.set_num_threadscCsdSr%rrBrrrrsz_OpenMPModule._get_extra_infoN)r r r r&rrrIrrrrrrs c Csddl}ddl}ddl}ddl}|jddd}|jdddd d d d |jd ddd||jdd}|jD]:}z|j |ddWqnt yt d||j dYqn0qn|j rt|j t |jtdddS)zBCommandline interface to display thread-pool information and exit.rNz5python -m threadpoolctl -i numpy scipy.linalg xgboostz)Display thread-pool information and exit.)usage descriptionz-iz--importrf*rz;Python modules to import before introspecting thread-pools.)destnargsdefaulthelpz-cz --commandz@a Python statement to execute before introspecting thread-pools.)rrN)packagezWARNING: could not import)filer)indent)argparse importlibjsonrxArgumentParser add_argument parse_argsargvrf import_module ImportErrorprintstderrZcommandexecdumpsr)rrrrxparseroptionsrKrrr_mains2    r__main__)1r&rrrxrrrUZ ctypes.utilrabcrr __version____all__environ setdefaultmaxsizeZc_uint64Zc_uint32r Zc_uint16rZ Structurer RTLD_NOLOADrAttributeErrorZ DEFAULT_MODErrbrPrmr1Z_ALL_INTERNAL_APISr]Z_ALL_BLAS_LIBRARIESZ_ALL_OPENMP_LIBRARIESr-rrWrr0rrrrrrr rrrrs        %4-.'!