Devel::MAT::SV - represent a single SV from a heap dump
Devel::MAT::SV
Objects in this class represent individual SV variables found in the arena during a heap dump. Actual types of SV are represented by subclasses, which are documented below.
$type = $sv->type
Returns the major type of the SV. This is the class name minus the Devel::MAT::SV:: prefix.
Devel::MAT::SV::
$type = $sv->basetype
Returns the inner perl API type of the SV. This is one of
SV AV HV CV GV LV PVIO PVFM REGEXP INVLIST
$desc = $sv->desc
Returns a string describing the type of the SV and giving a short detail of its contents. The exact details depends on the SV type.
$desc = $sv->desc_addr
Returns a string describing the SV as with desc and giving its address in hex. A useful way to uniquely identify the SV when printing.
desc
$addr = $sv->addr
Returns the address of the SV
$count = $sv->refcnt
Returns the SvREFCNT reference count of the SV
SvREFCNT
$count = $sv->refcount_adjusted
Returns the reference count of the SV, adjusted to take account of the fact that the SvREFCNT value of the backrefs list of a hash or weakly-referenced object is artificially high.
$stash = $sv->blessed
If the SV represents a blessed object, returns the stash SV. Otherwise returns undef.
undef
$name = $sv->symname
Called on an SV which is a member of the symbol table, this method returns the perl representation of the full symbol name, including sigil. Otherwise, returns undef.
A leading main:: prefix is removed for symbols in packages other than main.
main::
main
$size = $sv->size
Returns the (approximate) size in bytes of the SV
@magics = $sv->magic
Returns a list of magic applied to the SV; each giving the type and target SVs as struct fields:
$type = $magic->type $sv = $magic->obj $sv = $magic->ptr
@svs = $sv->magic_svs
A more efficient way to retrieve just the SVs associated with the applied magic.
$av_or_rv = $sv->backrefs
Returns backrefs SV, which may be an AV containing the back references, or if there is only one, the REF SV itself referring to this.
$rootname = $sv->rootname
If the SV is a well-known root, this method returns its name. Otherwise returns undef.
@refs = $sv->outrefs
Returns a list of Reference objects for each of the SVs that this one refers to, either directly by strong or weak reference, indirectly via RV, or inferred by Devel::MAT itself.
Devel::MAT
Each object is a structure of three fields:
A human-readable string for identification purposes.
Identifies what kind of reference it is. strong references contribute to the refcount of the referrant, others do not. strong and weak references are SV addresses found directly within the referring SV structure; indirect and inferred references are extra return values added here for convenience by examining the surrounding structure.
strong
refcount
weak
indirect
inferred
The referrant SV itself.
@refs = $sv->outrefs_strong
Returns the subset of outrefs that are direct strong references.
outrefs
@refs = $sv->outrefs_weak
Returns the subset of outrefs that are direct weak references.
@refs = $sv->outrefs_direct
Returns the subset of outrefs that are direct strong or weak references.
@refs = $sv->outrefs_indirect
Returns the subset of outrefs that are indirect references via RVs.
@refs = $sv->outrefs_inferred
Returns the subset of outrefs that are not directly stored in the SV structure, but instead inferred by Devel::MAT itself.
Three special SV objects exist outside of the heap, to represent undef and boolean true and false. They are
Devel::MAT::SV::UNDEF
Devel::MAT::SV::YES
Devel::MAT::SV::NO
Represents a glob; an SV of type SVt_PVGV.
SVt_PVGV
$file = $gv->file $line = $gv->line $location = $gv->location
Returns the filename, line number, or combined location (FILE line LINE) that the GV first appears at.
FILE line LINE
$name = $gv->name
Returns the value of the GvNAME field, for named globs.
GvNAME
$stash = $gv->stash
Returns the stash to which the GV belongs.
$sv = $gv->scalar $av = $gv->array $hv = $gv->hash $cv = $gv->code $gv = $gv->egv $io = $gv->io $form = $gv->form
Return the SV in the various glob slots.
Represents a non-referential scalar value; an SV of any of the types up to and including SVt_PVMV (that is, IV, NV, PV, PVIV, PVNV or PVMG). This includes all numbers, integers and floats, strings, and dualvars containing multiple parts.
SVt_PVMV
IV
NV
PV
PVIV
PVNV
PVMG
$uv = $sv->uv
Returns the integer numeric portion as an unsigned value, if valid, or undef.
$iv = $sv->iv
Returns the integer numeric portion as a signed value, if valid, or undef.
$nv = $sv->nv
Returns the floating numeric portion, if valid, or undef.
$pv = $sv->pv
Returns the string portion, if valid, or undef.
$pvlen = $sv->pvlen
Returns the length of the string portion, if valid, or undef.
$str = $sv->qq_pv( $maxlen )
Returns the PV string, if defined, suitably quoted. If $maxlen is defined and the PV is longer than this, it is truncated and ... is appended after the containing quote marks.
$maxlen
...
$stash = $sv->ourstash
Returns the stash of the SCALAR, if it is an 'our' variable.
our
After perl 5.20 this is no longer used, and will return undef.
Represents a referential scalar; any SCALAR-type SV with the SvROK flag set.
SvROK
$svrv = $sv->rv
Returns the SV referred to by the reference.
$weak = $sv->is_weak
Returns true if the SV is a weakened RV reference.
Represents an array; an SV of type SVt_PVAV.
SVt_PVAV
$unreal = $av->is_unreal
Returns true if the AvREAL() flag is not set on the array - i.e. that its SV pointers do not contribute to the SvREFCNT of the SVs it points at.
AvREAL()
$backrefs = $av->is_backrefs
Returns true if the array contains the backrefs list of a hash or weakly-referenced object.
@svs = $av->elems
Returns all of the element SVs in a list
$sv = $av->elem( $index )
Returns the SV at the given index
A subclass of ARRAY, this is used to represent the PADLIST of a CODE SV.
A subclass of ARRAY, this is used to represent the PADNAMES of a CODE SV.
$padname = $padnames->padname( $padix )
Returns the name of the lexical at the given index, or undef
$padix = $padnames->padix_from_padname( $padname )
Returns the index of the lexical with the given name, or undef
A subclass of ARRAY, this is used to represent a PAD of a CODE SV.
$cv = $pad->padcv
Returns the CODE SV for which this is a pad.
CODE
( $name, $sv, $name, $sv, ... ) = $pad->lexvars
Returns a name/value list of the lexical variables in the pad.
Represents a hash; an SV of type SVt_PVHV. The Devel::MAT::SV::STASH subclass is used to represent hashes that are used as stashes.
SVt_PVHV
Devel::MAT::SV::STASH
@keys = $hv->keys
Returns the set of keys present in the hash, as plain perl strings, in no particular order.
$sv = $hv->value( $key )
Returns the SV associated with the given key
@svs = $hv->values
Returns all of the SVs stored as values, in no particular order (though, in an order corresponding to the order returned by keys).
keys
Represents a hash used as a stash; an SV of type SVt_PVHV whose HvNAME() is non-NULL. This is a subclass of Devel::MAT::SV::HASH.
HvNAME()
Devel::MAT::SV::HASH
$hv = $stash->mro_linear_all $sv = $stash->mro_linearcurrent $sv = $stash->mro_nextmethod $av = $stash->mro_isa
Returns the fields from the MRO structure
$cv = $stash->value_code( $key )
Returns the CODE associated with the given symbol name, if it exists, or undef if not. This is roughly equivalent to
$cv = $stash->value( $key )->code
Except that it is aware of the direct reference to CVs that perl 5.22 will optimise for. This method should be used in preference to the above construct.
$name = $stash->stashname
Returns the name of the stash
Represents a function or closure; an SV of type SVt_PVCV.
SVt_PVCV
$stash = $cv->stash $gv = $cv->glob $filename = $cv->file $line = $cv->line $scope_cv = $cv->scope $av = $cv->padlist $sv = $cv->constval $addr = $cv->oproot $depth = $cv->depth
Returns the stash, glob, filename, line number, scope, padlist, constant value, oproot or depth of the code.
$location = $cv->location
Returns FILE line LINE if the line is defined, or FILE if not.
FILE
$clone = $cv->is_clone $cloned = $cv->is_cloned $xsub = $cv->is_xsub $weak = $cv->is_weakoutside $rc = $cv->is_cvgv_rc $lexical = $cv->is_lexical
Returns the CvCLONE(), CvCLONED(), CvISXSUB(), CvWEAKOUTSIDE(), CvCVGV_RC() and CvLEXICAL() flags.
CvCLONE()
CvCLONED()
CvISXSUB()
CvWEAKOUTSIDE()
CvCVGV_RC()
CvLEXICAL()
$protosub = $cv->protosub
Returns the protosub CV, if known, for a closure CV.
@svs = $cv->constants
Returns a list of the SVs used as constants or method names in the code. On ithreads perl the constants are part of the padlist structure so this list is constructed from parts of the padlist at loading time.
@svs = $cv->globrefs
Returns a list of the SVs used as GLOB references in the code. On ithreads perl the constants are part of the padlist structure so this list is constructed from parts of the padlist at loading time.
$padname = $cv->padname( $padix )
Returns the name of the $padix'th lexical variable, or undef if it doesn't have a name.
The returned padname is a structure of the following fields:
$name = $padname->name
$padix = $cv->padix_from_padname( $padname )
Returns the index of the first lexical variable with the given pad name, or undef if one does not exist.
$max_padix = $cv->max_padix
Returns the maximum valid pad index.
This is typically used to create a list of potential pad indexes, such as
0 .. $cv->max_padix
Note that since pad slots may contain things other than lexical variables, not every pad slot between 0 and this index will necessarily contain a lexical variable or have a pad name.
$padnames_av = $cv->padnames_av
Returns the AV reference directly which stores the pad names.
After perl version 5.20, this is no longer used directly and will return undef. The individual pad names themselves can still be found via the padname method.
padname
@pads = $cv->pads
Returns a list of the actual pad AVs.
$pad = $cv->pad( $depth )
Returns the PAD at the given depth (given by 1-based index).
Represents an IO handle; an SV type of SVt_PVIO.
SVt_PVIO
$ifileno = $io->ifileno $ofileno = $io->ofileno
Returns the input or output file numbers.
Paul Evans <leonerd@leonerd.org.uk>
To install Devel::MAT, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Devel::MAT
CPAN shell
perl -MCPAN -e shell install Devel::MAT
For more information on module installation, please visit the detailed CPAN module installation guide.