o bP@s8dZddlZddlZddlZddlmZddlmZmZm Z m Z m Z ddl m Z ddlmZmZmZmZmZddlmZmZmZmZee dZeej_eeeegej_eej_eeeeegej_eej_eeeeeegej_eej_eeeeeegej_eej_eeeeeeeeeegej_eej _eegej _eej!_eegej!_eej"_eee egej"_eej#_ee egej#_eej$_eee egej$_eej%_gej%_d d Z"d d Z#d dZ$ddZ%GdddeZ&GdddeZ'GdddeZ(Gddde Z)Gddde*Z+Gddde+Z,dS)aWrapper module for libpcp_pmda - Performace Co-Pilot Domain Agent API # # Copyright (C) 2013-2015,2017-2021 Red Hat. # # This file is part of the "pcp" module, the python interfaces for the # Performance Co-Pilot toolkit. # # 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 2 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. # # See pmdasimple.py for an example use of this module. N) pmContext)pmInDompmDescpmUnitspmErr pmLabelSet) find_library)CDLLc_intc_longc_char_pc_void_p) addressofbyrefPOINTER Structurepcp_pmdacC.tt}tt||}|dkrt||SNr)rr LIBPCP_PMDA pmdaAddLabelsrrlabelresult_pstatusr*/usr/lib/python3/dist-packages/pcp/pmda.pyrF rcCs t||}|dkrt||Sr)rpmdaAddLabelFlagsr)labelsflagsrrrrrMs rcCrr)rrr pmdaAddNotesrrrrrrr!Srr!cCst}|dkr t||Sr)rpmdaGetContextr)rrrrr"Zsr"c@0eZdZdZdefdefgZddZddZdS) pmdaMetricz5 Structure describing a metric definition for a PMDA m_userm_desccCs<t|d|_||j_||j_||j_||j_||j_dSN) r__init__r%r&pmidtypeindomsemunits)selfr)typeofr+r,r-rrrr(is  zpmdaMetric.__init__cCsdt||jj|jjfS)Nz!pmdaMetric@%#lx pmid=%#lx type=%d)rr&r)r*r.rrr__str__rzpmdaMetric.__str__N) __name__ __module__ __qualname____doc__r r_fields_r(r1rrrrr$ds r$c@r#) pmdaInstidz6 Structure describing an instance (index/name) a PMDA i_insti_namecCs t|||_|d|_dS)Nutf-8)rr(r9encoder:)r.instidnamerrrr(zs zpmdaInstid.__init__cCdt||j|jfS)Nz pmdaInstid@%#lx index=%d name=%s)rr9r:r0rrrr1zpmdaInstid.__str__N) r3r4r5r6r r r7r(r1rrrrr8us r8c@seZdZdZdefdefdeefgZddZ ddZ d d Z d d Z d dZ ddZddZddZddZddZddZddZddZdS) pmdaIndomz7 Structure describing an instance domain within a PMDA it_indom it_numinstit_setcCs8t|d|_d|_||_||||||dSr)rr(rCrDrB load_indom set_instancesr.r+instsrrrr(s  zpmdaIndom.__init__ccs|jdkr*t|jtj t|jtj}|dkrdS||}|r)||fVqt|jD]}|j |j }||}|rC||fVq/dSr) rCr pmdaCacheOprBcpmdaPMDA_CACHE_WALK_REWINDPMDA_CACHE_WALK_NEXTinst_name_lookuprangerDr9)r.instr>irrr__iter__s,      zpmdaIndom.__iter__cCsx|jdkr!t}t|j|t|d}|tjkrt|j SdS|jdkr:|j D]}|j |kr9t|j Sq)dSr)rCr rpmdaCacheLookuprBrrJPMDA_CACHE_ACTIVEstrvaluedecoderDr9r:)r.instancer>stsrOrrrrMs     zpmdaIndom.inst_name_lookupcCs t|trt|tjdSdSr') isinstancedictrrIrJPMDA_CACHE_LOADrGrrrrEs zpmdaIndom.load_indomcCs"|jdkrt|jtjdSdS)N)rCrrIrBrJr[r0rrrloads zpmdaIndom.loadcCsXt|}t|}t|D]}||j||_||j||_q ||_||_tdSr') lenr8rNr9r:rDrCrJset_need_refresh)r.rHinstance_countinstance_arrayrPrrrset_list_instancess   zpmdaIndom.set_list_instancesc CsXt|tj|D]}|d}t|tj|t||q t|tj d|_ dS)Nr;r\) rrIrJPMDA_CACHE_INACTIVEkeysr<pmdaCacheStorePMDA_CACHE_ADDrPMDA_CACHE_SAVErC)r.r+rHkeykey8rrrset_dict_instancess    zpmdaIndom.set_dict_instancescCsJ|dur d|_dSt|trd|_|||dSt||_||dS)Nrr\)rCrYrZrjr^rbrGrrrrFs   zpmdaIndom.set_instancescCr?)Nz pmdaIndom@%#lx indom=%#lx num=%d)rrBrCr0rrrr1r@zpmdaIndom.__str__cCs8|jdkrt|jtj}|dkrt|dSttjr) rCrrIrBrJr[rcpmapi PM_ERR_NYI)r.rXrrr cache_loads  zpmdaIndom.cache_loadcC(|jdkrt|jtjdSttjr) rCrrIrBrJrSrrkrlr0rrrcache_mark_active  zpmdaIndom.cache_mark_activecCrnr) rCrrIrBrJrcrrkrlr0rrrcache_mark_inactiverpzpmdaIndom.cache_mark_inactivecCs6|jdkrt|j|}|dkrt|dSttjr)rCrpmdaCacheResizerBrrkrl)r.maximumrXrrr cache_resizes  zpmdaIndom.cache_resizeN)r3r4r5r6rr rr8r7r(rQrMrEr]rbrjrFr1rmrorqrtrrrrrAs&     rAc@seZdZdZddZdS) pmdaUnitszF Wrapper class for PMDAs defining their metrics (avoids pmapi import) c Cst|||||||dSr')rr()r.dimSdimTdimCscaleSscaleTscaleCrrrr(r2zpmdaUnits.__init__N)r3r4r5r6r(rrrrrus ruc@s|eZdZdZddZddZddZdd Zd d Zd d Z dddZ ddZ dddZ ddZ ddZddZddZdS)MetricDispatcha Helper for PMDA class which manages metric dispatch table, metric namespace, descriptors and help text. Overall strategy is to interface to the C code in python/pmda.c here, using a void* handle to the PMDA dispatch structure (allocated and managed in C code). In addition, several dictionaries for metric related strings are managed here (names, help text) - cached for quick lookups in callback routines. cCsPg|_i|_i|_i|_g|_i|_i|_i|_i|_i|_ t ||||dSr') _indomtable_indoms_indom_oneline_indom_helptext _metrictable_metrics _metric_names_metric_names_map_metric_oneline_metric_helptextrJ init_dispatch)r.domainr>logfilehelpfilerrrr(szMetricDispatch.__init__cCs.|jdd=|j|j|jdSr')r}r~clearrrr0rrr clear_indomss   zMetricDispatch.clear_indomscCsB|jdd=|j|j|j|j|jdSr')rrrrrrrr0rrr clear_metrics0s     zMetricDispatch.clear_metricscCs|tdSr')rrJr_r0rrr reset_metrics:s zMetricDispatch.reset_metricscCst|jdSr')rJ pmns_refreshrr0rrrrAszMetricDispatch.pmns_refreshcC tdSr')rJ connect_pmcdr0rrrrDs zMetricDispatch.connect_pmcdcCsz|jj}||jvrtd|||jvrtd|j|||j|<||j|<||j|<||j|<||j |<t dS)Nz.attempt to add_metric with an existing name=%sz+attempt to add_metric with an existing PMID) r&r)rKeyErrorrrappendrrrrJr_)r.r>metriconelinetextr)rrr add_metricGs          zMetricDispatch.add_metriccCs|jj}||jvrtd|||jvrtd|j||j||j||j||j ||j |t dS)Nz-attempt to remove non-existant metric name=%sz/attempt to remove_metric with non-existant PMID) r&r)rrrrremovepoprrrrJr_)r.r>rr)rrr remove_metricVs          zMetricDispatch.remove_metriccCsR|j}|jD] }|j|krtdq|j|||j|<||j|<||j|<dS)Nz(attempt to add_indom with an existing ID)rBr}rrr~rr)r.r+rrindomidentryrrr add_indomes     zMetricDispatch.add_indomcCsht|tr |j}|}n|}t||}t|tr-t|jD]\}}|j|kr,||j|<nq||j|<dSr')rYrArBlist enumerater}r~)r.r+rHrB replacementrPrrrr replace_indomos     zMetricDispatch.replace_indomcCs@|j|}|jdkrt}t||dt|}|tjkr|SdS)z Lookup the value associated with an (internal) instance ID within a specific instance domain (only valid with indoms of cache type - array indom will always return None). rN)r~rCr rrRrrJrS)r.r+rWrrUrXrrr inst_lookups   zMetricDispatch.inst_lookupcCs|j|}||S)zv Lookup the name associated with an (internal) instance ID within a specific instance domain. )r~rM)r.r+rWrrrrrMs  zMetricDispatch.inst_name_lookupcCs2z |jt||}W|Styd}Y|Sw)zR Lookup the name associated with a performance metric identifier. N)rrJ pmda_pmidr)r.clusteritemr>rrrpmid_name_lookups zMetricDispatch.pmid_name_lookupN)rr)r3r4r5r6r(rrrrrrrrrrrMrrrrrr|s      r|c@seZdZdZddZddZeedddZeedddZdGddZ d d Z d d Z d dZ ddZ ddZeddZeddZeddZeddZeddZeddZedd Zed!d"Zed#d$Zed%d&Zed'd(Zed)d*Zed+d,Zed-d.Zed/d0Zed1d2Zed3d4Z ed5d6Z!ed7d8Z"ed9d:Z#ed;d<Z$ed=d>Z%ed?d@Z&edAdBZ'edCdDZ(edEdFZ)dS)HPMDAzj Defines a PCP performance metrics domain agent Used to add new metrics into the PCP toolkit. cC|jS)z Property for name of this PMDA )_namer0rrr read_namezPMDA.read_namecCr)z0 Property for unique domain number of this PMDA )_domainr0rrr read_domainrzPMDA.read_domainNcCsL||_||_|s |d}d|}|sdtd|f}t|||||dS)Nz.logpmdaz %s/%s/help PCP_PMDAS_DIR)rrPCP pmGetConfigr|r()r.r>rrrpmdanamerrrr(sz PMDA.__init__cCstd|j|jfdS)zH Write out the domain.h file (used during installation) z #define %s %dN)printrupperrr0rrr domain_writeszPMDA.domain_writecsf|jfddD}|dk}d}|rd}td|D] }td|||jfq|r1tdd Sd S) zI Write out the namespace file (used during installation) csh|] }|ddqS).r)split).0rhpmnsrr sz"PMDA.pmns_write..rootr zroot {z %s%s %d:*:*}N)rrr)r.rprefixesindentleadprefixrrr pmns_writes zPMDA.pmns_writecC tdS)zF Tell PMCD the PMDA is not ready to process requests. N)rJ pmda_notreadyr0rrrr zPMDA.pmda_notreadycCr)zB Tell PMCD the PMDA is ready to process requests. N)rJ pmda_readyr0rrrrrzPMDA.pmda_readycCsdtjvr |dSdtjvr|tjddS|t|jt|j t |j t |j t|j|jdS)a All the real work happens herein; we can be called in one of three situations, determined by environment variables. First couple are during the agent Install process, where the domain.h and namespace files need to be created. The third case is the real mccoy, where an agent is actually being started by pmcd/dbpmda and makes use of libpcp_pmda to talk PCP protocol. PCP_PYTHON_DOMAINPCP_PYTHON_PMNSN)osenvironrrrrJpmid_oneline_refreshrpmid_longtext_refreshrindom_oneline_refreshrindom_longtext_refreshr pmda_dispatchr}rr0rrrruns      zPMDA.runcC t|Sr')rJ set_fetch)fetchrrrr zPMDA.set_fetchcCrr')rJ set_label)rrrrrrzPMDA.set_labelcCrr')rJ set_notes)notesrrrr rzPMDA.set_notescCrr')rJ set_refresh)refreshrrrr rzPMDA.set_refreshcCrr')rJ set_instance)rWrrrrrzPMDA.set_instancecCrr')rJset_fetch_callback)fetch_callbackrrrrrzPMDA.set_fetch_callbackcCrr')rJset_label_callback)label_callbackrrrrrzPMDA.set_label_callbackcCrr')rJset_notes_callback)notes_callbackrrrrrzPMDA.set_notes_callbackcCrr')rJset_attribute_callback)attribute_callbackrrrr!rzPMDA.set_attribute_callbackcCrr')rJset_store_callback)store_callbackrrrr%rzPMDA.set_store_callbackcCrr')rJset_endcontext_callback)endcontext_callbackrrrr)rzPMDA.set_endcontext_callbackcCrr')rJset_refresh_all) refresh_allrrrr-rzPMDA.set_refresh_allcCrr')rJset_refresh_metrics)refresh_metricsrrrr1rzPMDA.set_refresh_metricscCrr')rJset_notify_changerrrrr5 zPMDA.set_notify_changecCrr')rkpmSetProcessIdentity)usernamerrrset_user9rz PMDA.set_usercC t||Sr')rJr)rrrrrr)=rz PMDA.pmidcCst|||Sr')rJ pmid_build)rrrrrrrAszPMDA.pmid_buildcCrr')rJ pmid_cluster)rrrrrErzPMDA.pmid_clustercCrr')rJ pmda_indom)serialrrrr+Irz PMDA.indomcCrr')rJ indom_build)rrrrrrMrzPMDA.indom_buildcCst||||||Sr')rJ pmda_units) dim_spacedim_time dim_count scale_space scale_time scale_countrrrr-Qsz PMDA.unitscCrr')rJ pmda_uptime)nowrrruptimeUrz PMDA.uptimecCrr')rJpmda_set_comm_flags)r rrrset_comm_flagsYrzPMDA.set_comm_flagscCrr')rJpmda_logmessagerrrlog]rzPMDA.logcCrr')rJpmda_dbgrrrrdbgarzPMDA.dbgcCrr')rJpmda_errrrrrerrerzPMDA.err)NN)*r3r4r5r6rrpropertyr>rr(rrrrr staticmethodrrrrrrrrrrrrrrrr)rrr+rr-rrrr r rrrrrs                          r)-r6rrkrJ pcp.pmapirrrrrrr ctypes.utilrctypesr r r r r rrrrrrerestypeargtypespmdaCacheStoreKeyrRpmdaCacheLookupNamepmdaCacheLookupKeyrIrrrrr!r"r$r8rAruobjectr|rrrrrs`         r %