U:RDoc::TopLevel[ i I"dtrace_probes.rdoc:EFcRDoc::Parser::Simpleo:RDoc::Markup::Document: @parts[ S:RDoc::Markup::Heading:
leveli: textI"DTrace Probes;To: RDoc::Markup::BlankLine o: RDoc::Markup::Paragraph;[I"UA list of DTrace probes and their functionality. "Module" and "Function" cannot ;TI"Lbe defined in user defined probes (known as USDT), so they will not be ;TI"7specified. Probe definitions are in the format of:;T@
o:RDoc::Markup::Verbatim;[I".provider:module:function:name(arguments)
;T: @format0o;
;[I"SSince module and function cannot be specified, they will be blank. An example ;TI"-probe definition for Ruby would then be:;T@
o;;[I"Jruby:::method-entry(class name, method name, file name, line number)
;T;0o;
;[I"QWhere "ruby" is the provider name, module and function names are blank, the ;TI"Fprobe name is "method-entry", and the probe takes four arguments:;T@
o:RDoc::Markup::List:
@type: BULLET: @items[ o:RDoc::Markup::ListItem: @label0;[o;
;[I"class name;To;;0;[o;
;[I"method name;To;;0;[o;
;[I"file name;To;;0;[o;
;[I"line number;T@
S; ;
i; I"Probes List;T@
S; ;
i; I"Stability;T@
o;
;[I"UBefore we list the specific probes, let's talk about stability. Probe stability ;TI"Pis declared in the probes.d file at the bottom on the #pragma D attributes ;TI"Hlines. Here is a description of each of the stability declarations.;T@
o;;:
LABEL;[ o;;[I" Provider name stability;T;[o;
;[I"RThe provider name of "ruby" has been declared as stable. It is unlikely that ;TI"Dwe will change the provider name from "ruby" to something else.;T@
o;;[I""Module and Function stability;T;[o;
;[I"RSince we are not allowed to provide values for the module and function name, ;TI"Bthe values we have provided (no value) is declared as stable.;T@
o;;[I"Probe name stability;T;[o;
;[I"OThe probe names are likely to change in the future, so they are marked as ;TI"I"Evolving". Consumers should not depend on these names to be stable.;T@
o;;[I" Probe argument stability;T;[o;
;[I"PThe parameters passed to the probes are likely to change in the future, so ;TI"Othey are marked as "Evolving". Consumers should not depend on these to be ;TI" stable.;T@
S; ;
i; I"Declared probes;T@
o;
;[I"QProbes are defined in the probes.d file. Here are the declared probes along ;TI":with when they are fired and the arguments they take:;T@
o;;;;[ o;;[I"Bruby:::method-entry(classname, methodname, filename, lineno);;T;[o;
;[I"9This probe is fired just before a method is entered.;T@
o;;[ I",classname name of the class (a string)
;TI"Cmethodname name of the method about to be executed (a string)
;TI"Jfilename the file name where the method is _being called_ (a string)
;TI"Hlineno the line number where the method is _being called_ (an int)
;T;0o;;[I"Cruby:::method-return(classname, methodname, filename, lineno);;T;[o;
;[I"QThis probe is fired just after a method has returned. The arguments are the ;TI"#same as "ruby:::method-entry".;T@
o;;[I"Cruby:::cmethod-entry(classname, methodname, filename, lineno);;T;[o;
;[I"RThis probe is fired just before a C method is entered. The arguments are the ;TI"#same as "ruby:::method-entry".;T@
o;;[I"Druby:::cmethod-return(classname, methodname, filename, lineno);;T;[o;
;[I"OThis probe is fired just before a C method returns. The arguments are the ;TI"#same as "ruby:::method-entry".;T@
o;;[I":ruby:::require-entry(requiredfile, filename, lineno);;T;[o;
;[I"OThis probe is fired on calls to rb_require_safe (when a file is required).;T@
o;;[I"Crequiredfile is the name of the file to be required (string).
;TI":filename is the file that called "require" (string).
;TI"Ilineno is the line number where the call to require was made (int).
;T;0o;;[I";ruby:::require-return(requiredfile, filename, lineno);;T;[o;
;[I"OThis probe is fired just before rb_require_safe (when a file is required) ;TI"Oreturns. The arguments are the same as "ruby:::require-entry". This probe ;TI"Awill not fire if there was an exception during file require.;T@
o;;[I"?ruby:::find-require-entry(requiredfile, filename, lineno);;T;[o;
;[I"QThis probe is fired right before search_required is called. search_required ;TI"Odetermines whether the file has already been required by searching loaded ;TI"Ffeatures ($"), and if not, figures out which file must be loaded.;T@
o;;[I"7requiredfile is the file to be required (string).
;TI":filename is the file that called "require" (string).
;TI"Ilineno is the line number where the call to require was made (int).
;T;0o;;[I"@ruby:::find-require-return(requiredfile, filename, lineno);;T;[o;
;[I"FThis probe is fired right after search_required returns. See the ;TI"Sdocumentation for "ruby:::find-require-entry" for more details. Arguments for ;TI"<this probe are the same as "ruby:::find-require-entry".;T@
o;;[I"5ruby:::load-entry(loadedfile, filename, lineno);;T;[o;
;[I"SThis probe is fired when calls to "load" are made. The arguments are the same ;TI" as "ruby:::require-entry".;T@
o;;[I"6ruby:::load-return(loadedfile, filename, lineno);;T;[o;
;[I"LThis probe is fired when "load" returns. The arguments are the same as ;TI""ruby:::load-entry".;T@
o;;[I"/ruby:::raise(classname, filename, lineno);;T;[o;
;[I"5This probe is fired when an exception is raised.;T@
o;;[I"Bclassname is the class name of the raised exception (string)
;TI"Kfilename the name of the file where the exception was raised (string)
;TI"Mlineno the line number in the file where the exception was raised (int)
;T;0o;;[I"7ruby:::object-create(classname, filename, lineno);;T;[o;
;[I"AThis probe is fired when an object is about to be allocated.;T@
o;;[I":classname the class of the allocated object (string)
;TI"Jfilename the name of the file where the object is allocated (string)
;TI"Llineno the line number in the file where the object is allocated (int)
;T;0o;;[I"3ruby:::array-create(length, filename, lineno);;T;[o;
;[I"@This probe is fired when an Array is about to be allocated.;T@
o;;[I")length the size of the array (long)
;TI"Ifilename the name of the file where the array is allocated (string)
;TI"Klineno the line number in the file where the array is allocated (int)
;T;0o;;[I"2ruby:::hash-create(length, filename, lineno);;T;[o;
;[I">This probe is fired when a Hash is about to be allocated.;T@
o;;[I"(length the size of the hash (long)
;TI"Hfilename the name of the file where the hash is allocated (string)
;TI"Jlineno the line number in the file where the hash is allocated (int)
;T;0o;;[I"4ruby:::string-create(length, filename, lineno);;T;[o;
;[I"@This probe is fired when a String is about to be allocated.;T@
o;;[I"*length the size of the string (long)
;TI"Jfilename the name of the file where the string is allocated (string)
;TI"Llineno the line number in the file where the string is allocated (int)
;T;0o;;[I"1ruby:::symbol-create(str, filename, lineno);;T;[o;
;[I"@This probe is fired when a Symbol is about to be allocated.;T@
o;;[I"-str the contents of the symbol (string)
;TI"Jfilename the name of the file where the string is allocated (string)
;TI"Llineno the line number in the file where the string is allocated (int)
;T;0o;;[I",ruby:::parse-begin(sourcefile, lineno);;T;[o;
;[I";Fired just before parsing and compiling a source file.;T@
o;;[I"/sourcefile the file being parsed (string)
;TI":lineno the line number where the source starts (int)
;T;0o;;[I"*ruby:::parse-end(sourcefile, lineno);;T;[o;
;[I":Fired just after parsing and compiling a source file.;T@
o;;[I"/sourcefile the file being parsed (string)
;TI"9lineno the line number where the source ended (int)
;T;0o;;[I" ruby:::gc-mark-begin();;T;[o;
;[I",Fired at the beginning of a mark phase.;T@
o;;[I"ruby:::gc-mark-end();;T;[o;
;[I"&Fired at the end of a mark phase.;T@
o;;[I" ruby:::gc-sweep-begin();;T;[o;
;[I"-Fired at the beginning of a sweep phase.;T@
o;;[I"ruby:::gc-sweep-end();;T;[o;
;[I"'Fired at the end of a sweep phase.;T@
o;;[I":ruby:::method-cache-clear(class, sourcefile, lineno);;T;[o;
;[I",Fired when the method cache is cleared.;T@
o;;[I"@class is the classname being cleared, or "global" (string)
;TI"/sourcefile the file being parsed (string)
;TI"8lineno the line number where the source ended (int);T;0:
@file@:0@omit_headings_from_table_of_contents_below0