o b_A@s\dZddlmZmZddlmZddlZddlmZmZddlm Z m Z m Z m Z m Z mZmZeejdZGdd d eZGd d d eZGd d d eZeej_e e e eee eee gej_dej_e egej_eeej_ee e gej_dej_eeeegej_dej_eeeeegej_dej_eeeegej_dej_eeeeegej_dej _eeee e gej _dej!_ee e egej!_dej"_ee e gej"_dej#_ee e egej#_dej$_ee e e egej$_dej%_ee e e gej%_eeej&_eeee e gej&_dej'_eeegej'_dej(_ee e e e gej(_Gddde)Z*dS)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@s,eZdZdZdefdeefgZddZdS) mmv_instancezX Maps internal to external instance identifiers, within an instance domain. internalexternalcCs.t|t|ts|d}||_||_dSNutf-8)r__init__ isinstancebytesencoderr)selfinstnamer)/usr/lib/python3/dist-packages/pcp/mmv.pyrcs    zmmv_instance.__init__N) __name__ __module__ __qualname____doc__rr r_fields_rrrrrr\s   rc@sHeZdZdZdefdefdeefdefdefgZd dd Z d d Z d S) 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 shorttexthelptextcCsXt||durt|ts|d}|dur!t|ts!|d}||_||_||_dSr)rrrrrr&r'r#)rr#r&r'rrrrus    zmmv_indom.__init__cCsPt||_t|j}t|jD]}||j||_||j||_q||_dS)z7 Update the instances and counts fields for this indom N)lenr$rrangerrr%)rr%instance_arrayirrr set_instancess   zmmv_indom.set_instancesN)r(r() rrrr rrrr r!rr-rrrrr"js   r"c @sReZdZdZdeefdefdefdefdefdefde fd e fgZ dd d Z dS) 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'rr(c Cs~t|t|ts|d}|durt|ts|d}|dur+t|ts+|d}||_||_||_||_||_ ||_ dSr) rrrrrr&r'r0r3r/r) rrr/r0r1r2r3r&r'rrrrs      zmmv_metric.__init__N)rr(r() rrrr r rrrrr r!rrrrrr.s  r.c@seZdZdZd3ddZddZdd Zd d Zd d ZddZ ddZ ddZ ddZ ddZ ddZddZddZddZd d!Zd"d#Zd$d%Zd&d'Zd(d)Zd*d+Zd,d-Zd.d/Zd0d1Zd2S)4MemoryMappedValuesz 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) r*cCs<t|ts |d}||_||_||_g|_g|_d|_dSr) rrr_name_cluster_flags_metrics_indoms_handle)rrflagsclusterrrrrs   zMemoryMappedValues.__init__c Cst|j}t|}t|D] }|j|||<qt|j}t|}t|D] }|j|||<q&t|j|j |j |||||_ dS)z Initialise the underlying library with metrics/instances. On completion of this call, we're all visible to pmdammv. N) r)r9r.r*r:r" LIBPCP_MMVmmv_stats_initr6r7r8r;)r count_metricsmetricsr, count_indomsindomsrrrstarts        zMemoryMappedValues.startcCs$|jdur t|j|jd|_dS)z Shut down the underlying library with metrics/instances. This closes the mmap file preventing any further updates. N)r;r>mmv_stats_stopr6rrrrstops  zMemoryMappedValues.stopcCs||dS)z: Cleanly stop-if-running and restart MMV export services. N)rGrDrFrrrrestarts zMemoryMappedValues.restartcCs|jdurdSdS)z, Property flagging an active memory mapping Nr)r;rFrrrstarteds zMemoryMappedValues.startedcC||_|r |dSdS)z; Make a list of instance domains visible to the MMV export N)r:rJrH)rrCrrr add_indoms zMemoryMappedValues.add_indomscC|j|||jdS)z> Make an additional instance domain visible to the MMV export N)r:appendrL)rr3rrr add_indom  zMemoryMappedValues.add_indomcCrK)z2 Make a list of metrics visible to the MMV export N)r9rJrH)rrArrr add_metrics%rMzMemoryMappedValues.add_metricscCrN)z5 Make an additional metric visible to the MMV export N)r9rOrR)rmetricrrr add_metric+rQzMemoryMappedValues.add_metriccCsH|durt|ts|d}|durt|ts|d}t|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. Nr)rrrr>mmv_lookup_value_descr;rrrrrrlookup_mapping1s   z!MemoryMappedValues.lookup_mappingcCt|j||dS)z. Increment the mapped metric by a given value Nr> mmv_inc_valuer;rmappingvaluerrraddAzMemoryMappedValues.addcCst|j|ddS)z$ Increment the mapped metric by one rINrYrr\rrrincEr_zMemoryMappedValues.inccCrX)z( Set the mapped metric to a given value N)r> mmv_set_valuer;r[rrrsetIr_zMemoryMappedValues.setcCs6|durt|ts|d}t|j||t|dS)z/ Set the string mapped metric to a given value Nr)rrrr>mmv_set_stringr;r)r[rrr set_stringMs zMemoryMappedValues.set_stringcCst|j|ddS)z Start a timed interval for the mapped metric The opaque handle (mapping) returned is passed to interval_end(). r)r>mmv_stats_interval_startr;r`rrrinterval_startSsz!MemoryMappedValues.interval_startcCst|j|S)zA End a timed interval, the metrics time is increased by interval )r>mmv_stats_interval_endr;r`rrr interval_endYszMemoryMappedValues.interval_endcCN|durt|ts|d}|durt|ts|d}t|j|||dS)z9 Lookup the named metric[instance] and add a value to it Nr)rrrr> mmv_stats_addr;rrrr]rrr lookup_add^   zMemoryMappedValues.lookup_addcCsL|durt|ts|d}|durt|ts|d}t|j||dS)z5 Lookup the named metric[instance] and add one to it Nr)rrrr> mmv_stats_incr;rVrrr lookup_incfs   zMemoryMappedValues.lookup_inccCrj)z5 Lookup the named metric[instance] and set its value Nr)rrrr> mmv_stats_setr;rlrrr lookup_setnrnzMemoryMappedValues.lookup_setcCsJ|durt|ts|d}|durt|ts|d}t|jd||S)z Lookup the named metric[instance] and start an interval The opaque handle returned is passed to interval_end(). Nr)rrrr>rfr;rVrrrlookup_interval_startvs  z(MemoryMappedValues.lookup_interval_startcCsh|durt|ts|d}|durt|ts|d}t|ts&|d}t|j|||t|dS)z< Lookup the named metric[instance] and set its string value Nr)rrrr>mmv_stats_set_strlenr;r))rrrsrrrlookup_set_strings    z$MemoryMappedValues.lookup_set_stringcCsP|durt|ts|d}|durt|ts|d}t|j||||dS)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)rrrr>mmv_stats_add_fallbackr;)rrrfallr]rrrlookup_add_fallbacks   z&MemoryMappedValues.lookup_add_fallbackcCrj)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)rrrr>mmv_stats_inc_fallbackr;)rrrfallbackrrrlookup_inc_fallbacks   z&MemoryMappedValues.lookup_inc_fallbackN)rr5)rrrr rrDrGrHrJrLrPrRrTrWr^rarcrergrirmrprrrsrvryr|rrrrr4s2    r4)+r pcp.pmapirrcmmvrctypesrrrrr r r r r CDLLutil find_libraryr>rr"r.r?restypeargtypesrErUrZmmv_inc_atomvaluerbmmv_set_atomvaluerdrkrorqrwrzrfrhrtobjectr4rrrrsdG $