ruby/probes.d
Nobuyoshi Nakada 23f02835e8 Fix argument types
Follow-up of GH-17190.
2026-07-07 20:59:49 +09:00

341 lines
11 KiB
C

/* -*- c -*- */
#include "vm_opts.h"
provider ruby {
/*
ruby:::method-entry(classname, methodname, filename, lineno);
This probe is fired just before a method is entered.
* `classname` name of the class (a string)
* `methodname` name of the method about to be executed (a string)
* `filename` the file name where the method is _being called_ (a string)
* `lineno` the line number where the method is _being called_ (an int)
*/
probe method__entry(const char *classname, const char *methodname, const char *filename, int lineno);
/*
ruby:::method-return(classname, methodname, filename, lineno);
This probe is fired just after a method has returned. The arguments are
the same as "ruby:::method-entry".
*/
probe method__return(const char *classname, const char *methodname, const char *filename, int lineno);
/*
ruby:::cmethod-entry(classname, methodname, filename, lineno);
This probe is fired just before a C method is entered. The arguments are
the same as "ruby:::method-entry".
*/
probe cmethod__entry(const char *classname, const char *methodname, const char *filename, int lineno);
/*
ruby:::cmethod-return(classname, methodname, filename, lineno);
This probe is fired just before a C method returns. The arguments are
the same as "ruby:::method-entry".
*/
probe cmethod__return(const char *classname, const char *methodname, const char *filename, int lineno);
/*
ruby:::require-entry(requiredfile, filename, lineno);
This probe is fired on calls to `rb_require_safe` (when a file is
required).
* `requiredfile` is the name of the file to be required (string).
* `filename` is the file that called "require" (string).
* `lineno` is the line number where the call to require was made (int).
*/
probe require__entry(const char *rquiredfile, const char *filename, int lineno);
/*
ruby:::require-return(requiredfile, filename, lineno);
This probe is fired just before `rb_require_safe` (when a file is required)
returns. The arguments are the same as "ruby:::require-entry". This
probe will not fire if there was an exception during file require.
*/
probe require__return(const char *requiredfile, const char *filename, int lineno);
/*
ruby:::find-require-entry(requiredfile, filename, lineno);
This probe is fired right before `search_required` is called.
`search_required` determines whether the file has already been required by
searching loaded features ($"), and if not, figures out which file must be
loaded.
* `requiredfile` is the file to be required (string).
* `filename` is the file that called "require" (string).
* `lineno` is the line number where the call to require was made (int).
*/
probe find__require__entry(const char *requiredfile, const char *filename, int lineno);
/*
ruby:::find-require-return(requiredfile, filename, lineno);
This probe is fired right after `search_required` returns. See the
documentation for "ruby:::find-require-entry" for more details. Arguments
for this probe are the same as "ruby:::find-require-entry".
*/
probe find__require__return(const char *requiredfile, const char *filename, int lineno);
/*
ruby:::load-entry(loadedfile, filename, lineno);
This probe is fired when calls to "load" are made. The arguments are the
same as "ruby:::require-entry".
*/
probe load__entry(const char *loadedfile, const char *filename, int lineno);
/*
ruby:::load-return(loadedfile, filename, lineno);
This probe is fired when "load" returns. The arguments are the same as
"ruby:::load-entry".
*/
probe load__return(const char *loadedfile, const char *filename, int lineno);
/*
ruby:::raise(classname, filename, lineno);
This probe is fired when an exception is raised.
* `classname` is the class name of the raised exception (string)
* `filename` the name of the file where the exception was raised (string)
* `lineno` the line number in the file where the exception was raised (int)
*/
probe raise(const char *classname, const char *filename, int lineno);
/*
ruby:::object-create(classname, filename, lineno);
This probe is fired when an object is about to be allocated.
* `classname` the class of the allocated object (string)
* `filename` the name of the file where the object is allocated (string)
* `lineno` the line number in the file where the object is allocated (int)
*/
probe object__create(const char *classname, const char *filename, int lineno);
/*
ruby:::array-create(length, filename, lineno);
This probe is fired when an Array is about to be allocated.
* `length` the size of the array (long)
* `filename` the name of the file where the array is allocated (string)
* `lineno` the line number in the file where the array is allocated (int)
*/
probe array__create(long length, const char *filename, int lineno);
/*
ruby:::hash-create(length, filename, lineno);
This probe is fired when a Hash is about to be allocated.
* `length` the size of the hash (long)
* `filename` the name of the file where the hash is allocated (string)
* `lineno` the line number in the file where the hash is allocated (int)
*/
probe hash__create(long length, const char *filename, int lineno);
/*
ruby:::string-create(length, filename, lineno);
This probe is fired when a String is about to be allocated.
* `length` the size of the string (long)
* `filename` the name of the file where the string is allocated (string)
* `lineno` the line number in the file where the string is allocated (int)
*/
probe string__create(long length, const char *filename, int lineno);
/*
ruby:::symbol-create(str, filename, lineno);
This probe is fired when a Symbol is about to be allocated.
* `str` the contents of the symbol (string)
* `filename` the name of the file where the string is allocated (string)
* `lineno` the line number in the file where the string is allocated (int)
*/
probe symbol__create(const char *str, const char *filename, int lineno);
/*
ruby:::parse-begin(sourcefile, lineno);
Fired just before parsing and compiling a source file.
* `sourcefile` the file being parsed (string)
* `lineno` the line number where the source starts (int)
*/
probe parse__begin(const char *sourcefile, int lineno);
/*
ruby:::parse-end(sourcefile, lineno);
Fired just after parsing and compiling a source file.
* `sourcefile` the file being parsed (string)
* `lineno` the line number where the source ended (int)
*/
probe parse__end(const char *sourcefile, int lineno);
#if VM_COLLECT_USAGE_DETAILS
probe insn(const char *insns_name);
probe insn__operand(const char *val, const char *insns_name);
#endif
/*
ruby:::gc-mark-begin();
Fired at the beginning of a mark phase.
*/
probe gc__mark__begin();
/*
ruby:::gc-mark-end();
Fired at the end of a mark phase.
*/
probe gc__mark__end();
/*
ruby:::gc-sweep-begin();
Fired at the beginning of a sweep phase.
*/
probe gc__sweep__begin();
/*
ruby:::gc-sweep-end();
Fired at the end of a sweep phase.
*/
probe gc__sweep__end();
/*
ruby:::gc-enter(event);
Fired when the `gc_enter` function in default.c is called.
* `event` the `event` argument passed to gc_enter
*/
probe gc__enter(int event);
/*
ruby:::gc-exit(event);
Fired when the `gc_exit` function in default.c is called.
* `event` the `event` argument passed to gc_exit
*/
probe gc__exit(int event);
/*
ruby:::gc-mark-stacked-objects(popped_count);
Fired for every invocation of `gc_mark_stacked_objects` in default.c.
* `popped_count` the number of objects popped from the mark stack in that invocation
*/
probe gc__mark_stacked_objects(size_t popped_count);
/*
ruby:::gc-sweep_page(slot_size, final_slots, freed_slots, empty_slots);
Fired for every page swept in `gc_sweep_step` in default.c.
* `slot_size` is the slot size of the page.
* Other arguments are from the `gc_sweep_context` struct.
*/
probe gc__sweep_page(int slot_size, int final_slots, int freed_slots, int empty_slots);
/*
ruby:::gc-obj_new();
Fired when an object is allocated
* `obj` the pointer to the allocated object
* `flags` the initial flags of the object
*/
probe gc__obj_new(void *obj, uintptr_t flags);
/*
ruby:::gc-obj_free();
Fired when finalizing an object with `rb_gc_obj_free`.
* `obj` the pointer to the finalized object
* `flags` the flags of the object when it is finalized
*/
probe gc__obj_free(void *obj, uintptr_t flags);
/*
ruby:::gc-xmalloc(n, size);
Fired when allocating memory with `ruby_xmalloc` or `ruby_xmalloc2`.
* `n` the number of elements. For `ruby_xmalloc` it is 1.
* `size` the size of each element
*/
probe gc__xmalloc(size_t n, size_t size);
/*
ruby:::gc-xcalloc();
Fired when allocating memory with `ruby_xcalloc`.
* `n` the number of elements. For `ruby_xmalloc` it is 1.
* `size` the size of each element
*/
probe gc__xcalloc(size_t n, size_t size);
/*
ruby:::gc-xfree(ptr, size);
Fired when de-allocating memory with `ruby_xfree` or `ruby_xfree_sized`.
* `ptr` the pointer to the object
* `size` the size of the object. 0 if called with `xfree`
*/
probe gc__xfree(void *obj, size_t size);
/*
ruby:::gvl-acquire();
Fired the global VM lock is acquired
*/
probe gvl__acquire();
/*
ruby:::gvl-release();
Fired the global VM lock is release
*/
probe gvl__release();
/*
ruby:::rts-set_running();
Fired when setting the running thread of a Ractor (`rb_thread_sched::running`).
This probe is mainly used to identify the duration in which a thread occupies a Ractor. If the
`old_thread` is NULL and the `new_thread` is not NULL, it means the `new_thread` is scheduled
onto a Ractor. If the `old_thread` is not NULL but the `new_thread` is NULL, it means the
`old_thread` is de-scheduled form a Ractor.
* `sched` the `rb_thread_sched` instance
* `old_thread` the old thread running on the ractor
* `new_thread` the new thread running on the ractor
*/
probe rts__set_running(void *sched, void *old_thread, void *new_thread);
};
#pragma D attributes Stable/Evolving/Common provider ruby provider
#pragma D attributes Stable/Evolving/Common provider ruby module
#pragma D attributes Stable/Evolving/Common provider ruby function
#pragma D attributes Evolving/Evolving/Common provider ruby name
#pragma D attributes Evolving/Evolving/Common provider ruby args