rC f_A`dZddlmZmZddlmZddlZddlmZmZddlm Z m Z m Z m Z m Z mZmZej ej"j%dZGdd eZGd d eZGd d eZeej._e e e eee eee gej._dej4_e egej4_eeej6_ee e gej6_dej8_eeeegej8_dej:_eeeeegej:_dej<_eeeegej<_dej>_eeeeegej>_dej@_eeee e gej@_dejB_ee e egejB_dejD_ee e gejD_dejF_ee e egejF_dejH_ee e e egejH_dejJ_ee e e gejJ_eeejL_eeee e gejL_dejN_eeegejN_dejP_ee e e e gejP_Gdde)Z*y)a Wrapper module for libpcp_mmv - PCP Memory Mapped Values library # # Copyright (C) 2013-2016,2019 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. # # Example use of this module for instrumenting a python application: from pcp import mmv, pmapi import cpmapi as pcpapi import cmmv as mmvapi instances = [ mmv.mmv_instance(0, "Anvils"), mmv.mmv_instance(1, "Rockets"), mmv.mmv_instance(2, "Giant_Rubber_Bands") ] ACME_PRODUCTS_INDOM = 61 indoms = [ mmv.mmv_indom( serial = ACME_PRODUCTS_INDOM, shorttext = "Acme products", helptext = "Most popular products produced by the Acme Corporation") ] indoms[0].set_instances(instances) metrics = [ mmv.mmv_metric( name = "products.count", item = 7, typeof = mmvapi.MMV_TYPE_U64, semantics = mmvapi.MMV_SEM_COUNTER, dimension = pmapi.pmUnits(0,0,1,0,0,pcpapi.PM_COUNT_ONE), indom = ACME_PRODUCTS_INDOM, shorttext = "Acme factory product throughput", helptext = "Monotonic increasing counter of products produced in the Acme Corporation " + "factory since starting the Acme production application. Quality guaranteed."), mmv.mmv_metric( name = "products.time", item = 8, typeof = mmvapi.MMV_TYPE_U64, semantics = mmvapi.MMV_SEM_COUNTER, dimension = pmapi.pmUnits(0,1,0,0,pcpapi.PM_TIME_USEC,0), indom = ACME_PRODUCTS_INDOM, shorttext = "Machine time spent producing Acme products") ] values = mmv.MemoryMappedValues("acme") values.add_indoms(indoms) values.add_metrics(metrics) values.start() anvils = values.lookup_mapping("products.count", "Anvils") values.set(anvils, 41) values.inc(anvils) values.stop() )pmUnits pmAtomValue) MMV_NAMEMAXN) StructurePOINTER)c_intc_uintc_longc_charc_char_pc_doublec_void_ppcp_mmvc,eZdZdZdefdeezfgZdZy) mmv_instancezX Maps internal to external instance identifiers, within an instance domain. internalexternalctj|t|ts|j d}||_||_yNutf-8)r__init__ isinstancebytesencoderr)selfinstnames )/usr/lib/python3/dist-packages/pcp/mmv.pyrzmmv_instance.__init__cs64 $&;;w'D  N) __name__ __module__ __qualname____doc__rr r_fields_rrrrr\s*U#Vk124HrrcLeZdZdZdefdefdeefdefdefgZd dZ dZ y ) mmv_indomz Represents an instance domain (for set valued metrics) Instance domains have associated instances - integer/string pairs. Defines complete indom metadata (instances, count, text and so on) serialcount instances shorttexthelptextctj||!t|ts|j d}|!t|ts|j d}||_||_||_yr)rrrrrr+r,r()rr(r+r,s rrzmmv_indom.__init__usa4   8U(Cw/H  Iu)E!((1I"!  rct||_t|jz}t|jD]0}||j||_||j ||_2||_y)z7 Update the instances and counts fields for this indom N)lenr)rrangerrr*)rr*instance_arrayis r set_instanceszmmv_indom.set_instancessm^ &36tzz" ?A)21)>)>N1  &)21)>)>N1  & ?(rN)r4) r r!r"r#r rrr r$rr3r%rrr'r'jsG6"&!gl34h'X& (H (rr'c ReZdZdZdeezfdefdefdefdefdefde fd e fgZ d d Z y ) mmv_metricz Represents an individual metric to be exported by pmdammv Defines complete metric metadata (type, semantics, units and so on) ritemtypeof semantics dimensionindomr+r,c Ptj|t|ts|j d}|!t|ts|j d}|!t|ts|j d}||_||_||_||_||_ ||_ yr) rrrrrr+r,r8r;r7r) rrr7r8r9r:r;r+r,s rrzmmv_metric.__init__s4 $&;;w'D   8U(Cw/H  Iu)E!((1I"!     rN)rr4r4) r r!r"r#r rrrr r r$rr%rrr6r6sY+-.5!e$g&&!h'X&(H rr6ceZdZdZddZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZdZdZdZdZdZdZdZdZdZy)MemoryMappedValuesz Defines a set of PCP Memory Mapped Value (MMV) metrics Creates PCP metrics from an instrumented python script via pmdammv (Performance Metrics Domain Agent for MMV) ct|ts|jd}||_||_||_g|_g|_d|_yr) rrr_name_cluster_flags_metrics_indoms_handle)rrflagsclusters rrzMemoryMappedValues.__init__sD$&;;w'D      rc t|j}t|z}t|D]}|j|||<t|j}t |z}t|D]}|j|||<t j|j|j|j|||||_ y)z Initialise the underlying library with metrics/instances. On completion of this call, we're all visible to pmdammv. N) r/rCr6r0rDr' LIBPCP_MMVmmv_stats_initr@rArBrE)r count_metricsmetricsr2 count_indomsindomss rstartzMemoryMappedValues.startsDMM*  -0}% *Aq)GAJ *4<<( l*-|$ (A QF1I (!00T]]1518-17G rc~|j*tj|j|jd|_y)z Shut down the underlying library with metrics/instances. This closes the mmap file preventing any further updates. N)rErImmv_stats_stopr@rs rstopzMemoryMappedValues.stops- << #  % %djj$,, ? rcD|j|jy)z: Cleanly stop-if-running and restart MMV export services. N)rSrOrRs rrestartzMemoryMappedValues.restarts  rc|jyy)z, Property flagging an active memory mapping r)rErRs rstartedzMemoryMappedValues.starteds << rcT||_|jr|jyy)z; Make a list of instance domains visible to the MMV export N)rDrXrU)rrNs r add_indomszMemoryMappedValues.add_indomss  <<> LLN rcp|jj||j|jy)z> Make an additional instance domain visible to the MMV export N)rDappendrZ)rr;s r add_indomzMemoryMappedValues.add_indom s$ E"  %rcT||_|jr|jyy)z2 Make a list of metrics visible to the MMV export N)rCrXrU)rrLs r add_metricszMemoryMappedValues.add_metrics%s  <<> LLN rcp|jj||j|jy)z5 Make an additional metric visible to the MMV export N)rCr\r_)rmetrics r add_metriczMemoryMappedValues.add_metric+s& V$ 'rc|!t|ts|jd}|!t|ts|jd}tj |j ||S)a Find the memory mapping for a given metric name and instance This handle can be used to directly manipulate metric values by other interfaces in this module. This is the *preferred* technique for manipulating MMV values. It is more efficient and the alternative (name/inst lookups) is made available as a convenience only for situations where performance will not be affected by repeated (linear) name/inst lookups. r)rrrrImmv_lookup_value_descrErrrs rlookup_mappingz!MemoryMappedValues.lookup_mapping1sW  JtU$;;;w'D  JtU$;;;w'D// dDIIrcFtj|j||y)z. Increment the mapped metric by a given value NrI mmv_inc_valuerErmappingvalues raddzMemoryMappedValues.addA  w>rcFtj|j|dy)z$ Increment the mapped metric by one rWNrhrrks rinczMemoryMappedValues.incEs  w:rcFtj|j||y)z( Set the mapped metric to a given value N)rI mmv_set_valuerErjs rsetzMemoryMappedValues.setIrnrc|!t|ts|jd}tj |j ||t |y)z/ Set the string mapped metric to a given value Nr)rrrrImmv_set_stringrEr/rjs r set_stringzMemoryMappedValues.set_stringMs;  Zu%=LL)E!!$,,E KrcFtj|j|ddS)z Start a timed interval for the mapped metric The opaque handle (mapping) returned is passed to interval_end(). r)rImmv_stats_interval_startrErps rinterval_startz!MemoryMappedValues.interval_startSs224<<!QOOrcBtj|j|S)zA End a timed interval, the metrics time is increased by interval )rImmv_stats_interval_endrErps r interval_endzMemoryMappedValues.interval_endYs00wGGrc|!t|ts|jd}|!t|ts|jd}tj |j |||y)z9 Lookup the named metric[instance] and add a value to it Nr)rrrrI mmv_stats_addrErrrrls r lookup_addzMemoryMappedValues.lookup_add^T  JtU$;;;w'D  JtU$;;;w'D  tT5Arc|!t|ts|jd}|!t|ts|jd}tj |j ||y)z5 Lookup the named metric[instance] and add one to it Nr)rrrrI mmv_stats_incrEres r lookup_inczMemoryMappedValues.lookup_incfsR  JtU$;;;w'D  JtU$;;;w'D  tT:rc|!t|ts|jd}|!t|ts|jd}tj |j |||y)z5 Lookup the named metric[instance] and set its value Nr)rrrrI mmv_stats_setrErs r lookup_setzMemoryMappedValues.lookup_setnrrc|!t|ts|jd}|!t|ts|jd}tj |j d||S)z Lookup the named metric[instance] and start an interval The opaque handle returned is passed to interval_end(). Nr)rrrrIryrEres rlookup_interval_startz(MemoryMappedValues.lookup_interval_startvs`  JtU$;;;w'D  JtU$;;;w'D224<<37tE Erc *|!t|ts|jd}|!t|ts|jd}t|ts|jd}tj |j |||t |y)z< Lookup the named metric[instance] and set its string value Nr)rrrrImmv_stats_set_strlenrEr/)rrrss rlookup_set_stringz$MemoryMappedValues.lookup_set_stringsr  JtU$;;;w'D  JtU$;;;w'D!U#!A'' dD!SVLrc|!t|ts|jd}|!t|ts|jd}tj |j ||||y)a Lookup the named metric[instance] and set its value if found If instance is not found, fallback to using a second instance One example use is: add value to bucketN else use a catch-all bucket such as "other" Nr)rrrrImmv_stats_add_fallbackrE)rrrfallrls rlookup_add_fallbackz&MemoryMappedValues.lookup_add_fallbacksX  JtU$;;;w'D  JtU$;;;w'D))$,,dD%Prc|!t|ts|jd}|!t|ts|jd}tj |j |||y)z Lookup the named metric[instance] and increment its value if found If instance is not found, fallback to using a second instance One sample use is: inc value of BucketA, else inc a catch-all Nr)rrrrImmv_stats_inc_fallbackrE)rrrfallbacks rlookup_inc_fallbackz&MemoryMappedValues.lookup_inc_fallbacksV  JtU$;;;w'D  JtU$;;;w'D))$,,dHMrN)r*)r r!r"r#rrOrSrUrXrZr]r_rbrfrmrqrtrwrzr}rrrrrrrr%rrr>r>s G"   &  ( J ?;?L P H B;B EM Q Nrr>)+r# pcp.pmapirrcmmvrctypesrrrr r r r r rCDLLutil find_libraryrIrr'r6rJrestypeargtypesrQrdrimmv_inc_atomvaluersmmv_set_atomvaluervrrrrrryr|robjectr>r%rrrsEN+ %NNNV[[11)< =  9 ( (<>%- ! eU J 2E&; "%) !&.%9 "+2;+? (-5x,J )#'  %-w{/CX$N !'+ $)17;3GQ\I](^ %#'  %-w{/CX$N !'+ $)17;3GQ\I](^ %$( ! gk"He&5 "$(  %-x8$L !#'  %-x$B !#'  %-x8$L !,0 !!) h(H.6 !!*-1 !!) h(., !!*/6k.B ##+ gk"Hh08 ##,-1 !!).6 8L-M !!**. ' h(F,4 ({N{Nr