home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _9e4d508f1f07a269553d5ad22b8c3d27 < prev    next >
Text File  |  2000-03-23  |  16KB  |  422 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Devel::Peek - A data debugging tool for the XS programmer</TITLE>
  5. <LINK REL="stylesheet" HREF="../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> Devel::Peek - A data debugging tool for the XS programmer</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#examples">EXAMPLES</A></LI>
  26.     <UL>
  27.  
  28.         <LI><A HREF="#a simple scalar string">A simple scalar string</A></LI>
  29.         <LI><A HREF="#a simple scalar number">A simple scalar number</A></LI>
  30.         <LI><A HREF="#a simple scalar with an extra reference">A simple scalar with an extra reference</A></LI>
  31.         <LI><A HREF="#a reference to a simple scalar">A reference to a simple scalar</A></LI>
  32.         <LI><A HREF="#a reference to an array">A reference to an array</A></LI>
  33.         <LI><A HREF="#a reference to a hash">A reference to a hash</A></LI>
  34.         <LI><A HREF="#dumping a large array or hash">Dumping a large array or hash</A></LI>
  35.         <LI><A HREF="#a reference to an sv which holds a c pointer">A reference to an SV which holds a C pointer</A></LI>
  36.         <LI><A HREF="#a reference to a subroutine">A reference to a subroutine</A></LI>
  37.     </UL>
  38.  
  39.     <LI><A HREF="#exports">EXPORTS</A></LI>
  40.     <LI><A HREF="#bugs">BUGS</A></LI>
  41.     <LI><A HREF="#author">AUTHOR</A></LI>
  42.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  43. </UL>
  44. <!-- INDEX END -->
  45.  
  46. <HR>
  47. <P>
  48. <H1><A NAME="name">NAME</A></H1>
  49. <P>Devel::Peek - A data debugging tool for the XS programmer</P>
  50. <P>
  51. <HR>
  52. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  53. <UL>
  54. <LI>Linux</LI>
  55. <LI>Solaris</LI>
  56. <LI>Windows</LI>
  57. </UL>
  58. <HR>
  59. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  60. <PRE>
  61.         use Devel::Peek;
  62.         Dump( $a );
  63.         Dump( $a, 5 );
  64.         DumpArray( 5, $a, $b, ... );
  65.         mstat "Point 5";</PRE>
  66. <P>
  67. <HR>
  68. <H1><A NAME="description">DESCRIPTION</A></H1>
  69. <P>Devel::Peek contains functions which allows raw Perl datatypes to be
  70. manipulated from a Perl script.  This is used by those who do XS programming
  71. to check that the data they are sending from C to Perl looks as they think
  72. it should look.  The trick, then, is to know what the raw datatype is
  73. supposed to look like when it gets to Perl.  This document offers some tips
  74. and hints to describe good and bad raw data.</P>
  75. <P>It is very possible that this document will fall far short of being useful
  76. to the casual reader.  The reader is expected to understand the material in
  77. the first few sections of <A HREF="../../lib/Pod/perlguts.html">the perlguts manpage</A>.</P>
  78. <P>Devel::Peek supplies a <CODE>Dump()</CODE> function which can dump a raw Perl
  79. datatype, and <CODE>mstat("marker")</CODE> function to report on memory usage
  80. (if perl is compiled with corresponding option).  The function
  81. <CODE>DeadCode()</CODE> provides statistics on the data ``frozen'' into inactive
  82. <CODE>CV</CODE>.  Devel::Peek also supplies <CODE>SvREFCNT()</CODE>, <CODE>SvREFCNT_inc()</CODE>, and
  83. <CODE>SvREFCNT_dec()</CODE> which can query, increment, and decrement reference
  84. counts on SVs.  This document will take a passive, and safe, approach
  85. to data debugging and for that it will describe only the <CODE>Dump()</CODE>
  86. function.  For format of output of <CODE>mstats()</CODE> see
  87. <A HREF="../../lib/Pod/perldebug.html#using c<$env{perl_debug_mstats}>">Using <CODE>$ENV{PERL_DEBUG_MSTATS}</CODE> in the perldebug manpage</A>.</P>
  88. <P>Function <CODE>DumpArray()</CODE> allows dumping of multiple values (useful when you
  89. need to analize returns of functions).</P>
  90. <P>The global variable $Devel::Peek::pv_limit can be set to limit the
  91. number of character printed in various string values.  Setting it to 0
  92. means no limit.</P>
  93. <P>
  94. <HR>
  95. <H1><A NAME="examples">EXAMPLES</A></H1>
  96. <P>The following examples don't attempt to show everything as that would be a
  97. monumental task, and, frankly, we don't want this manpage to be an internals
  98. document for Perl.  The examples do demonstrate some basics of the raw Perl
  99. datatypes, and should suffice to get most determined people on their way.
  100. There are no guidewires or safety nets, nor blazed trails, so be prepared to
  101. travel alone from this point and on and, if at all possible, don't fall into
  102. the quicksand (it's bad for business).</P>
  103. <P>Oh, one final bit of advice: take <A HREF="../../lib/Pod/perlguts.html">the perlguts manpage</A> with you.  When you return we
  104. expect to see it well-thumbed.</P>
  105. <P>
  106. <H2><A NAME="a simple scalar string">A simple scalar string</A></H2>
  107. <P>Let's begin by looking a simple scalar which is holding a string.</P>
  108. <PRE>
  109.         use Devel::Peek;
  110.         $a = "hello";
  111.         Dump $a;</PRE>
  112. <P>The output:</P>
  113. <PRE>
  114.         SV = PVIV(0xbc288)
  115.           REFCNT = 1
  116.           FLAGS = (POK,pPOK)
  117.           IV = 0
  118.           PV = 0xb2048 "hello"\0
  119.           CUR = 5
  120.           LEN = 6</PRE>
  121. <P>This says <CODE>$a</CODE> is an SV, a scalar.  The scalar is a PVIV, a string.
  122. Its reference count is 1.  It has the <CODE>POK</CODE> flag set, meaning its
  123. current PV field is valid.  Because POK is set we look at the PV item
  124. to see what is in the scalar.  The \0 at the end indicate that this
  125. PV is properly NUL-terminated.
  126. If the FLAGS had been IOK we would look
  127. at the IV item.  CUR indicates the number of characters in the PV.
  128. LEN indicates the number of bytes requested for the PV (one more than
  129. CUR, in this case, because LEN includes an extra byte for the
  130. end-of-string marker).</P>
  131. <P>
  132. <H2><A NAME="a simple scalar number">A simple scalar number</A></H2>
  133. <P>If the scalar contains a number the raw SV will be leaner.</P>
  134. <PRE>
  135.         use Devel::Peek;
  136.         $a = 42;
  137.         Dump $a;</PRE>
  138. <P>The output:</P>
  139. <PRE>
  140.         SV = IV(0xbc818)
  141.           REFCNT = 1
  142.           FLAGS = (IOK,pIOK)
  143.           IV = 42</PRE>
  144. <P>This says <CODE>$a</CODE> is an SV, a scalar.  The scalar is an IV, a number.  Its
  145. reference count is 1.  It has the <CODE>IOK</CODE> flag set, meaning it is currently
  146. being evaluated as a number.  Because IOK is set we look at the IV item to
  147. see what is in the scalar.</P>
  148. <P>
  149. <H2><A NAME="a simple scalar with an extra reference">A simple scalar with an extra reference</A></H2>
  150. <P>If the scalar from the previous example had an extra reference:</P>
  151. <PRE>
  152.         use Devel::Peek;
  153.         $a = 42;
  154.         $b = \$a;
  155.         Dump $a;</PRE>
  156. <P>The output:</P>
  157. <PRE>
  158.         SV = IV(0xbe860)
  159.           REFCNT = 2
  160.           FLAGS = (IOK,pIOK)
  161.           IV = 42</PRE>
  162. <P>Notice that this example differs from the previous example only in its
  163. reference count.  Compare this to the next example, where we dump <CODE>$b</CODE>
  164. instead of <CODE>$a</CODE>.</P>
  165. <P>
  166. <H2><A NAME="a reference to a simple scalar">A reference to a simple scalar</A></H2>
  167. <P>This shows what a reference looks like when it references a simple scalar.</P>
  168. <PRE>
  169.         use Devel::Peek;
  170.         $a = 42;
  171.         $b = \$a;
  172.         Dump $b;</PRE>
  173. <P>The output:</P>
  174. <PRE>
  175.         SV = RV(0xf041c)
  176.           REFCNT = 1
  177.           FLAGS = (ROK)
  178.           RV = 0xbab08
  179.         SV = IV(0xbe860)
  180.           REFCNT = 2
  181.           FLAGS = (IOK,pIOK)
  182.           IV = 42</PRE>
  183. <P>Starting from the top, this says <CODE>$b</CODE> is an SV.  The scalar is an RV, a
  184. reference.  It has the <CODE>ROK</CODE> flag set, meaning it is a reference.  Because
  185. ROK is set we have an RV item rather than an IV or PV.  Notice that Dump
  186. follows the reference and shows us what <CODE>$b</CODE> was referencing.  We see the
  187. same <CODE>$a</CODE> that we found in the previous example.</P>
  188. <P>Note that the value of <CODE>RV</CODE> coincides with the numbers we see when we
  189. stringify $b. The addresses inside <CODE>RV()</CODE> and <CODE>IV()</CODE> are addresses of
  190. <CODE>X***</CODE> structure which holds the current state of an <A HREF="../../lib/Pod/perlguts.html#item_SV"><CODE>SV</CODE></A>. This
  191. address may change during lifetime of an SV.</P>
  192. <P>
  193. <H2><A NAME="a reference to an array">A reference to an array</A></H2>
  194. <P>This shows what a reference to an array looks like.</P>
  195. <PRE>
  196.         use Devel::Peek;
  197.         $a = [42];
  198.         Dump $a;</PRE>
  199. <P>The output:</P>
  200. <PRE>
  201.         SV = RV(0xf041c)
  202.           REFCNT = 1
  203.           FLAGS = (ROK)
  204.           RV = 0xb2850
  205.         SV = PVAV(0xbd448)
  206.           REFCNT = 1
  207.           FLAGS = ()
  208.           IV = 0
  209.           NV = 0
  210.           ARRAY = 0xb2048
  211.           ALLOC = 0xb2048
  212.           FILL = 0
  213.           MAX = 0
  214.           ARYLEN = 0x0
  215.           FLAGS = (REAL)
  216.         Elt No. 0 0xb5658
  217.         SV = IV(0xbe860)
  218.           REFCNT = 1
  219.           FLAGS = (IOK,pIOK)
  220.           IV = 42</PRE>
  221. <P>This says <CODE>$a</CODE> is an SV and that it is an RV.  That RV points to
  222. another SV which is a PVAV, an array.  The array has one element,
  223. element zero, which is another SV. The field <CODE>FILL</CODE> above indicates
  224. the last element in the array, similar to <CODE>$#$a</CODE>.</P>
  225. <P>If <CODE>$a</CODE> pointed to an array of two elements then we would see the
  226. following.</P>
  227. <PRE>
  228.         use Devel::Peek 'Dump';
  229.         $a = [42,24];
  230.         Dump $a;</PRE>
  231. <P>The output:</P>
  232. <PRE>
  233.         SV = RV(0xf041c)
  234.           REFCNT = 1
  235.           FLAGS = (ROK)
  236.           RV = 0xb2850
  237.         SV = PVAV(0xbd448)
  238.           REFCNT = 1
  239.           FLAGS = ()
  240.           IV = 0
  241.           NV = 0
  242.           ARRAY = 0xb2048
  243.           ALLOC = 0xb2048
  244.           FILL = 0
  245.           MAX = 0
  246.           ARYLEN = 0x0
  247.           FLAGS = (REAL)
  248.         Elt No. 0  0xb5658
  249.         SV = IV(0xbe860)
  250.           REFCNT = 1
  251.           FLAGS = (IOK,pIOK)
  252.           IV = 42
  253.         Elt No. 1  0xb5680
  254.         SV = IV(0xbe818)
  255.           REFCNT = 1
  256.           FLAGS = (IOK,pIOK)
  257.           IV = 24</PRE>
  258. <P>Note that <CODE>Dump</CODE> will not report <EM>all</EM> the elements in the array,
  259. only several first (depending on how deep it already went into the
  260. report tree).</P>
  261. <P>
  262. <H2><A NAME="a reference to a hash">A reference to a hash</A></H2>
  263. <P>The following shows the raw form of a reference to a hash.</P>
  264. <PRE>
  265.         use Devel::Peek;
  266.         $a = {hello=>42};
  267.         Dump $a;</PRE>
  268. <P>The output:</P>
  269. <PRE>
  270.         SV = RV(0xf041c)
  271.           REFCNT = 1
  272.           FLAGS = (ROK)
  273.           RV = 0xb2850
  274.         SV = PVHV(0xbd448)
  275.           REFCNT = 1
  276.           FLAGS = ()
  277.           NV = 0
  278.           ARRAY = 0xbd748
  279.           KEYS = 1
  280.           FILL = 1
  281.           MAX = 7
  282.           RITER = -1
  283.           EITER = 0x0
  284.         Elt "hello" => 0xbaaf0
  285.         SV = IV(0xbe860)
  286.           REFCNT = 1
  287.           FLAGS = (IOK,pIOK)
  288.           IV = 42</PRE>
  289. <P>This shows <CODE>$a</CODE> is a reference pointing to an SV.  That SV is a PVHV, a
  290. hash. Fields RITER and EITER are used by <A HREF="../../lib/Pod/perlfunc.html#item_each"><CODE>each</CODE></A>.</P>
  291. <P>
  292. <H2><A NAME="dumping a large array or hash">Dumping a large array or hash</A></H2>
  293. <P>The <CODE>Dump()</CODE> function, by default, dumps up to 4 elements from a
  294. toplevel array or hash.  This number can be increased by supplying a
  295. second argument to the function.</P>
  296. <PRE>
  297.         use Devel::Peek;
  298.         $a = [10,11,12,13,14];
  299.         Dump $a;</PRE>
  300. <P>Notice that <CODE>Dump()</CODE> prints only elements 10 through 13 in the above code.
  301. The following code will print all of the elements.</P>
  302. <PRE>
  303.         use Devel::Peek 'Dump';
  304.         $a = [10,11,12,13,14];
  305.         Dump $a, 5;</PRE>
  306. <P>
  307. <H2><A NAME="a reference to an sv which holds a c pointer">A reference to an SV which holds a C pointer</A></H2>
  308. <P>This is what you really need to know as an XS programmer, of course.  When
  309. an XSUB returns a pointer to a C structure that pointer is stored in an SV
  310. and a reference to that SV is placed on the XSUB stack.  So the output from
  311. an XSUB which uses something like the T_PTROBJ map might look something like
  312. this:</P>
  313. <PRE>
  314.         SV = RV(0xf381c)
  315.           REFCNT = 1
  316.           FLAGS = (ROK)
  317.           RV = 0xb8ad8
  318.         SV = PVMG(0xbb3c8)
  319.           REFCNT = 1
  320.           FLAGS = (OBJECT,IOK,pIOK)
  321.           IV = 729160
  322.           NV = 0
  323.           PV = 0
  324.           STASH = 0xc1d10       "CookBookB::Opaque"</PRE>
  325. <P>This shows that we have an SV which is an RV.  That RV points at another
  326. SV.  In this case that second SV is a PVMG, a blessed scalar.  Because it is
  327. blessed it has the <CODE>OBJECT</CODE> flag set.  Note that an SV which holds a C
  328. pointer also has the <CODE>IOK</CODE> flag set.  The <CODE>STASH</CODE> is set to the package
  329. name which this SV was blessed into.</P>
  330. <P>The output from an XSUB which uses something like the T_PTRREF map, which
  331. doesn't bless the object, might look something like this:</P>
  332. <PRE>
  333.         SV = RV(0xf381c)
  334.           REFCNT = 1
  335.           FLAGS = (ROK)
  336.           RV = 0xb8ad8
  337.         SV = PVMG(0xbb3c8)
  338.           REFCNT = 1
  339.           FLAGS = (IOK,pIOK)
  340.           IV = 729160
  341.           NV = 0
  342.           PV = 0</PRE>
  343. <P>
  344. <H2><A NAME="a reference to a subroutine">A reference to a subroutine</A></H2>
  345. <P>Looks like this:</P>
  346. <PRE>
  347.         SV = RV(0x798ec)
  348.           REFCNT = 1
  349.           FLAGS = (TEMP,ROK)
  350.           RV = 0x1d453c
  351.         SV = PVCV(0x1c768c)
  352.           REFCNT = 2
  353.           FLAGS = ()
  354.           IV = 0
  355.           NV = 0
  356.           COMP_STASH = 0x31068  "main"
  357.           START = 0xb20e0
  358.           ROOT = 0xbece0
  359.           XSUB = 0x0
  360.           XSUBANY = 0
  361.           GVGV::GV = 0x1d44e8   "MY" :: "top_targets"
  362.           FILE = "(eval 5)"
  363.           DEPTH = 0
  364.           PADLIST = 0x1c9338</PRE>
  365. <P>This shows that</P>
  366. <UL>
  367. <LI>
  368. the subroutine is not an XSUB (since <CODE>START</CODE> and <CODE>ROOT</CODE> are
  369. non-zero, and <CODE>XSUB</CODE> is zero);
  370. <P></P>
  371. <LI>
  372. that it was compiled in the package <CODE>main</CODE>;
  373. <P></P>
  374. <LI>
  375. under the name <CODE>MY::top_targets</CODE>;
  376. <P></P>
  377. <LI>
  378. inside a 5th eval in the program;
  379. <P></P>
  380. <LI>
  381. it is not currently executed (see <CODE>DEPTH</CODE>);
  382. <P></P>
  383. <LI>
  384. it has no prototype (<CODE>PROTOTYPE</CODE> field is missing).
  385. <P></P></UL>
  386. <P>
  387. <HR>
  388. <H1><A NAME="exports">EXPORTS</A></H1>
  389. <P><CODE>Dump</CODE>, <CODE>mstat</CODE>, <CODE>DeadCode</CODE>, <CODE>DumpArray</CODE>, <CODE>DumpWithOP</CODE> and
  390. <CODE>DumpProg</CODE> by default. Additionally available <CODE>SvREFCNT</CODE>,
  391. <CODE>SvREFCNT_inc</CODE> and <CODE>SvREFCNT_dec</CODE>.</P>
  392. <P>
  393. <HR>
  394. <H1><A NAME="bugs">BUGS</A></H1>
  395. <P>Readers have been known to skip important parts of <A HREF="../../lib/Pod/perlguts.html">the perlguts manpage</A>, causing much
  396. frustration for all.</P>
  397. <P>
  398. <HR>
  399. <H1><A NAME="author">AUTHOR</A></H1>
  400. <P>Ilya Zakharevich    <A HREF="mailto:ilya@math.ohio-state.edu">ilya@math.ohio-state.edu</A></P>
  401. <P>Copyright (c) 1995-98 Ilya Zakharevich. All rights reserved.
  402. This program is free software; you can redistribute it and/or
  403. modify it under the same terms as Perl itself.</P>
  404. <P>Author of this software makes no claim whatsoever about suitability,
  405. reliability, edability, editability or usability of this product, and
  406. should not be kept liable for any damage resulting from the use of
  407. it. If you can use it, you are in luck, if not, I should not be kept
  408. responsible. Keep a handy copy of your backup tape at hand.</P>
  409. <P>
  410. <HR>
  411. <H1><A NAME="see also">SEE ALSO</A></H1>
  412. <P><A HREF="../../lib/Pod/perlguts.html">the perlguts manpage</A>, and <A HREF="../../lib/Pod/perlguts.html">the perlguts manpage</A>, again.</P>
  413. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  414. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  415. <STRONG><P CLASS=block> Devel::Peek - A data debugging tool for the XS programmer</P></STRONG>
  416. </TD></TR>
  417. </TABLE>
  418.  
  419. </BODY>
  420.  
  421. </HTML>
  422.