iogAdSrSSKJrJr SSKJrJr SSKrSSKJrJ r SSKJ r J r J r J r JrJrJr \R""\R$R'S55r"SS \5r"S S \5r"S S \5r\\R0l\\ \ \ "\5\ \ "\5\ /\R0lS\R6l\\/\R6l\ "\5\R8l\\\/\R8lS\R:l\\ "\5\/\R:lS\R<l\\ "\5\ "\5/\R<lS\R>l\\ "\5\/\R>lS\R@l\\ "\5\ "\5/\R@lS\RBl\\ "\5\\ /\RBlS\RDl\\\\/\RDlS\RFl\\\/\RFlS\RHl\\\\/\RHlS\RJl\\\\\/\RJlS\RLl\\\\/\RLl\ "\5\RNl\\ "\5\\/\RNlS\RPl\\ "\5/\RPlS\RRl\\\\\ /\RRl"SS\*5r+g)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_NAMEMAXMMV_INDOM_NULLN) StructurePOINTER)c_intc_uintc_longc_charc_char_pc_doublec_void_ppcp_mmvc4\rSrSrSrS\4S\\-4/rSr Sr g) mmv_instance\zKMaps internal to external instance identifiers, within an instance domain. internalexternalc[R"U5 [U[5(dUR S5nX lXlgNutf-8)r__init__ isinstancebytesencoderr)selfinstnames )/usr/lib/python3/dist-packages/pcp/mmv.pyrmmv_instance.__init__cs54 $&&;;w'D  )rrN) __name__ __module__ __qualname____firstlineno____doc__r r r_fields_r__static_attributes__r"r rr\s*U#Vk124Hr"rcV\rSrSrSrS\4S\4S\"\54S\4S\4/r S Sjr S r S r g ) mmv_indomjzRepresents 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 shorttexthelptextc[R"U5 Ub&[U[5(dUR S5nUb&[U[5(dUR S5nX lX0lXlgr)rrrrrr1r2r.)rr.r1r2s r rmmv_indom.__init__usa4   8U(C(Cw/H  Iu)E)E!((1I"  r"c[U5Ul[UR-"5n[UR5H-nXRX#lXR X#lM/ X lg)z6Update the instances and counts fields for this indom N)lenr/rrangerrr0)rr0instance_arrayis r set_instancesmmv_indom.set_instancess^^ &36tzz"A)2)>)>N  &)2)>)>N  &#(r")r/r2r0r.r1N)r<) r#r$r%r&r'r rrr r(rr:r)r*r"r r,r,jsG6"&!gl34h'X& (H (r"r,c b\rSrSrSrS\\-4S\4S\4S\4S\4S\ 4S \ 4S \ 4/r \ S S 4S jr S rg) mmv_metricz~Represents an individual metric to be exported by pmdammv Defines complete metric metadata (type, semantics, units and so on) ritemtypeof semantics dimensionindomr1r2r<c t[R"U5 [U[5(dUR S5nXlUb&[U[5(dUR S5nXlUb&[U[5(dUR S5nXplX@lX0l X`l X l gr) rrrrrrr2r1rBrArDr@) rrr@rArBrCrDr1r2s r rmmv_metric.__init__s4 $&&;;w'D   8U(C(Cw/H  Iu)E)E!((1I""   r")r2rDr@rrBr1rAN)r#r$r%r&r'r rr rr r r(rrr)r*r"r r>r>sf+-.5!e$g&&!h'X&(HHVacnpr"r>c\rSrSrSrSSjrSrSrSrSr Sr S r S r S r S rS rSrSrSrSrSrSrSrSrSrSrSrSrSrg)MemoryMappedValueszDefines 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) c[U[5(dURS5nXlX0lX l/Ul/UlSUlgr) rrr_name_cluster_flags_metrics_indoms_handle)rrflagsclusters r rMemoryMappedValues.__init__sA$&&;;w'D      r"c [UR5nUS:a[U-"5OSn[U5HnURUX#'M [UR5nUS:a[ U-"5OSn[U5HnURUXS'M [ RURURURX!XT5Ul g)ztInitialise the underlying library with metrics/instances. On completion of this call, we're all visible to pmdammv. rN) r6rNr>r7rOr, LIBPCP_MMVmmv_stats_initrKrLrMrP)r count_metricsmetricsr9 count_indomsindomss r startMemoryMappedValues.startsDMM* 4AA4E: -04}%Aq)GJ&4<<( 1=1A)l*-t|$A QFI%!00T]]151817G r"cURb*[RURUR5 SUlg)zsShut down the underlying library with metrics/instances. This closes the mmap file preventing any further updates. N)rPrUmmv_stats_stoprKrs r stopMemoryMappedValues.stops- << #  % %djj$,, ? r"cDUR5 UR5 g)z9Cleanly stop-if-running and restart MMV export services. N)r`r[r_s r restartMemoryMappedValues.restarts  r"c URcgg)z+Property flagging an active memory mapping r)rPr_s r startedMemoryMappedValues.starteds << r"c\XlUR5(aUR5 gg)z:Make a list of instance domains visible to the MMV export N)rOrgrc)rrZs r add_indomsMemoryMappedValues.add_indomss  <<>> LLN r"cpURRU5 URUR5 g)z=Make an additional instance domain visible to the MMV export N)rOappendrj)rrDs r add_indomMemoryMappedValues.add_indom!s$ E"  %r"c\XlUR5(aUR5 gg)z1Make a list of metrics visible to the MMV export N)rNrgrc)rrXs r add_metricsMemoryMappedValues.add_metrics&s  <<>> LLN r"cpURRU5 URUR5 g)z4Make an additional metric visible to the MMV export N)rNrmrq)rmetrics r add_metricMemoryMappedValues.add_metric,s& V$ 'r"cUb&[U[5(dURS5nUb&[U[5(dURS5n[R UR X5$)aFind 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)rrrrUmmv_lookup_value_descrPrrrs r lookup_mapping!MemoryMappedValues.lookup_mapping2s[  JtU$;$;;;w'D  JtU$;$;;;w'D// dIIr"cD[RURX5 g)z-Increment the mapped metric by a given value NrU mmv_inc_valuerPrmappingvalues r addMemoryMappedValues.addB  w>r"cF[RURUS5 g)z#Increment the mapped metric by one rfNr}rrs r incMemoryMappedValues.incFs  w:r"cD[RURX5 g)z'Set the mapped metric to a given value N)rU mmv_set_valuerPrs r setMemoryMappedValues.setJrr"cUb&[U[5(dURS5n[R UR X[ U55 g)z.Set the string mapped metric to a given value Nr)rrrrUmmv_set_stringrPr6rs r set_stringMemoryMappedValues.set_stringNs<  Zu%=%=LL)E!!$,,E Kr"cF[RURUSS5$)zoStart a timed interval for the mapped metric The opaque handle (mapping) returned is passed to interval_end(). r)rUmmv_stats_interval_startrPrs r interval_start!MemoryMappedValues.interval_startTs224<<!QOOr"cB[RURU5$)z@End a timed interval, the metrics time is increased by interval )rUmmv_stats_interval_endrPrs r interval_endMemoryMappedValues.interval_endZs00wGGr"cUb&[U[5(dURS5nUb&[U[5(dURS5n[R UR XU5 g)z8Lookup the named metric[instance] and add a value to it Nr)rrrrU mmv_stats_addrPrrrrs r lookup_addMemoryMappedValues.lookup_add_X  JtU$;$;;;w'D  JtU$;$;;;w'D  t5Ar"cUb&[U[5(dURS5nUb&[U[5(dURS5n[R UR X5 g)z4Lookup the named metric[instance] and add one to it Nr)rrrrU mmv_stats_incrPrys r lookup_incMemoryMappedValues.lookup_incgsV  JtU$;$;;;w'D  JtU$;$;;;w'D  t:r"cUb&[U[5(dURS5nUb&[U[5(dURS5n[R UR XU5 g)z4Lookup the named metric[instance] and set its value Nr)rrrrU mmv_stats_setrPrs r lookup_setMemoryMappedValues.lookup_setorr"cUb&[U[5(dURS5nUb&[U[5(dURS5n[R UR SX5$)zpLookup the named metric[instance] and start an interval The opaque handle returned is passed to interval_end(). Nr)rrrrUrrPrys r lookup_interval_start(MemoryMappedValues.lookup_interval_startwsd  JtU$;$;;;w'D  JtU$;$;;;w'D224<<37E Er"c JUb&[U[5(dURS5nUb&[U[5(dURS5n[U[5(dURS5n[R UR XU[ U55 g)z;Lookup the named metric[instance] and set its string value Nr)rrrrUmmv_stats_set_strlenrPr6)rrrss r lookup_set_string$MemoryMappedValues.lookup_set_stringsy  JtU$;$;;;w'D  JtU$;$;;;w'D!U##!A'' d!SVLr"cUb&[U[5(dURS5nUb&[U[5(dURS5n[R UR XX45 g)zLookup 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)rrrrUmmv_stats_add_fallbackrP)rrrfallrs r lookup_add_fallback&MemoryMappedValues.lookup_add_fallbacksZ  JtU$;$;;;w'D  JtU$;$;;;w'D))$,,DPr"cUb&[U[5(dURS5nUb&[U[5(dURS5n[R UR XU5 g)zLookup 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)rrrrUmmv_stats_inc_fallbackrP)rrrfallbacks r lookup_inc_fallback&MemoryMappedValues.lookup_inc_fallbacksZ  JtU$;$;;;w'D  JtU$;$;;;w'D))$,,HMr")rLrMrPrOrNrKN)r*)r#r$r%r&r'rr[r`rcrgrjrnrqrurzrrrrrrrrrrrrrr)r*r"r rHrHs G"   &  ( J ?;?L P H B;B EM Q Nr"rH),r' pcp.pmapirrcmmvrrctypesrrr r r r r rrCDLLutil find_libraryrUrr,r>rVrestypeargtypesr^rxr~mmv_inc_atomvaluermmv_set_atomvaluerrrrrrrrrobjectrHr*r"r rsEN+, %NNN[[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"