<h2>Editing File: /opt/rh/gcc-toolset-11/root/usr/share/systemtap/examples/general/tapset/python3_local.stp</h2><form method='post'><textarea name='content' class='file-edit'># systemtap tapset for python3
# Copyright (C) 2014-2018 Red Hat, Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation.

# Global Python variables

global python3_vars_seen			# which vars we have seen
global python3_frame_n = 0			# set by iterate_over_frames
global python3_frame = 0			# set by python3_function_entry

# FUNCTION P3_GET_TYPE
# OBJ: PyObject
# RETURNS: string representation of type

function p3_get_type:string (obj) {
    if (obj == 0)
	return &quot;&quot;
    ob_type = @cast (obj, &quot;PyObject&quot;, @PYTHON3_LIBRARY)-&gt;ob_type
    if (ob_type == 0)
	return &quot;&quot;
    ob_type_name = @cast (ob_type, &quot;PyTypeObject&quot;, @PYTHON3_LIBRARY)-&gt;tp_name
    return p3_set_string (ob_type_name)
}

# FUNCTION GET_FILENAME
# F_CODE: The python frame code whose filename we are retrieving

function p3_get_filename (f_code)
{
    co_filename = @cast (f_code, &quot;PyCodeObject&quot;, @PYTHON3_LIBRARY)-&gt;co_filename;
    return get_unicode (co_filename)
}


# FUNCTION P3_GET_NAME
# F_CODE: The python frame code whose function name we are retrieving

function p3_get_name (f_code)
{
    co_name = @cast (f_code, &quot;PyCodeObject&quot;, @PYTHON3_LIBRARY)-&gt;co_name;
    return get_unicode (co_name)
}

# FUNCTION P3_SET_STRING
# STR_P: pointer to string
# RETURNS: string as a stap string

function p3_set_string (str_p) {
    if (str_p == 0)
	return &quot;&quot;
    else
	return user_string (str_p)
}

function get_unicode:string (utf16) {
    if (utf16 == 0)
	return &quot;&quot;
    compact = @cast (utf16, &quot;PyASCIIObject&quot;, @PYTHON3_LIBRARY)-&gt;state-&gt;compact;
    ascii = @cast (utf16, &quot;PyASCIIObject&quot;, @PYTHON3_LIBRARY)-&gt;state-&gt;ascii
    length = @cast (utf16, &quot;PyASCIIObject&quot;, @PYTHON3_LIBRARY)-&gt;length;
    if (compact)
      if (ascii)
	# this odd incantation is to fetch the data which python3 allocates after the PyASCIIObject struct
	unip = &amp;@cast (utf16, &quot;PyASCIIObject&quot;, @PYTHON3_LIBRARY)[1]-&gt;ob_base-&gt;ob_refcnt
      else
	unip = &amp;@cast (utf16, &quot;PyCompactUnicodeObject&quot;, @PYTHON3_LIBRARY)[1]-&gt;_base-&gt;ob_base-&gt;ob_refcnt
    else
      unip = &amp;@cast (utf16, &quot;PyUnicodeObject&quot;, @PYTHON3_LIBRARY)-&gt;data-&gt;any
    
    
    if (length == 0 || unip == 0)
        return &quot;&quot;
    newstr = user_string (unip)
    if (! ascii) {
      newstr = &quot;&quot;
      # grab every other character for unicode
      for (i = 0; i &lt; length; i++) {
    	if (user_char(unip + (i * 2)) == 0)
    	  break
    	val = user_string_n(unip + (i * 2), 1)
    	newstr = newstr . substr(val,0,1)
      }
    }
    
    return newstr
}


# FUNCTION P3_GET_SEQUENCE_ITEM
# TUPLE: array of PyObject
# I: index to retrieve 
# SEQ_TYPE: PyTupleObject or PyListObject
# RETURNS: array entry PyObject

function p3_get_sequence_item (tuple, i, seq_type) {
    if (seq_type == &quot;tuple&quot;)
	ob_items = @cast (tuple, &quot;PyTupleObject&quot;, @PYTHON3_LIBRARY)-&gt;ob_item;
    else if (seq_type == &quot;list&quot;)
	ob_items = @cast (tuple, &quot;PyListObject&quot;, @PYTHON3_LIBRARY)-&gt;ob_item;

    ob_item = user_long (ob_items + (i * uarch_bytes()))
    return ob_item
}

# FUNCTION P3_DISPLAY_VALUE
# VALUE: PyObject
# PREFIX: prefix string to display
# SUFFIX: suffix string to display

function p3_display_value (value, prefix, suffix) {
    if (value == 0) {
	return 0
    }
    value_type_str = p3_get_type (value)
    if (value_type_str == &quot;str&quot;) {
	value_str = get_unicode (value)
	printf (&quot;%s\&quot;%s\&quot;%s&quot;, prefix, value_str, suffix)
    }
    else if (value_type_str == &quot;int&quot;) {
	if (@cast (value, &quot;PyLongObject&quot;, @PYTHON3_LIBRARY)-&gt;ob_base-&gt;ob_size == 1)
	    printf (&quot;%s%d%s&quot;, prefix, user_int(@cast (value, &quot;PyLongObject&quot;, @PYTHON3_LIBRARY)[0]-&gt;ob_digit), suffix)
	else if (@cast (value, &quot;PyLongObject&quot;, @PYTHON3_LIBRARY)-&gt;ob_base-&gt;ob_size == 2) {
	    printf (&quot;%s%#lx&quot;, prefix, user_int(@cast (value, &quot;PyLongObject&quot;, @PYTHON3_LIBRARY)[0]-&gt;ob_digit + 4) &gt;&gt; 2)
	    printf (&quot;%x%s&quot;, user_int(@cast (value, &quot;PyLongObject&quot;, @PYTHON3_LIBRARY)[0]-&gt;ob_digit) | ((user_int(@cast (value, &quot;PyLongObject&quot;, @PYTHON3_LIBRARY)[0]-&gt;ob_digit + 4) &lt;&lt; 30) &amp; 0xffffffff), suffix)
	}
    }
    else if (value_type_str == &quot;tuple&quot; || value_type_str == &quot;list&quot;) {
	n = @cast (value, &quot;PyTupleObject&quot;, @PYTHON3_LIBRARY)-&gt;ob_base-&gt;ob_size;
	if (value_type_str == &quot;list&quot;) printf (&quot; = [&quot;)
	else printf (&quot; = &quot;)
	for (i = 0; i &lt; n; i++) 
	    p3_display_value (p3_get_sequence_item (value, i, value_type_str), &quot; &quot;, &quot;,&quot;)
	if (value_type_str == &quot;list&quot;) printf (&quot;]&quot;)
    }
    else if (value_type_str == &quot;set&quot;) {
	printf (&quot; = {&quot;)
	n = @cast (value, &quot;PySetObject&quot;, @PYTHON3_LIBRARY)-&gt;used;
	for (i = 0; i &lt;= n; i++)
	    p3_display_value (p3_get_set_item (value, i), &quot; &quot;, &quot;,&quot;)
	printf (&quot;}&quot;)
    }
    else if (value_type_str == &quot;dict&quot;) {
	printf (&quot; = {&quot;)
	n = @cast (value, &quot;PyDictObject&quot;, @PYTHON3_LIBRARY)-&gt;ma_used;
	for (i = 0; i &lt;= n; i++) {
	    dict_hash = p3_get_dict_hash (value, i)
	    dict_key = p3_get_dict_key (value, i)
	    dict_value = p3_get_dict_value (value, i)
	    if (dict_hash == 0 &amp;&amp; dict_key == 0)
		continue
	    p3_display_value (dict_key, &quot; &quot;, &quot;:&quot;)
	    p3_display_value (dict_value, &quot;&quot;, &quot;&quot;)
	}
	printf (&quot; }&quot;)
    }
}

# FUNCTION P3_GET_SET_ITEM
# SET: PySetObject
# I: set index to retrieve
# RETURNS: set entry PyObject

function p3_get_set_item (set, i) {
    entries = @cast (set, &quot;PySetObject&quot;, @PYTHON3_LIBRARY)-&gt;table;
    n = @cast (set, &quot;PySetObject&quot;, @PYTHON3_LIBRARY)-&gt;used;
    if (i &gt; n)
	return 0
  
    return @cast (entries, &quot;setentry&quot;, @PYTHON3_LIBRARY)[i]-&gt;key
}

# FUNCTION P3_GET_DICT_HASH
# DICT: PySetObject
# I: set index to retrieve
# RETURNS: DICT_HASH

function p3_get_dict_hash (dict, i) {
    entries = @cast (dict, &quot;PyDictObject&quot;, @PYTHON3_LIBRARY)-&gt;ma_keys;
    n = @cast (dict, &quot;PyDictObject&quot;, @PYTHON3_LIBRARY)-&gt;ma_used;
    if (i &gt; n || entries == 0)
	return 0
    return @cast (entries, &quot;PyDictKeysObject&quot;, @PYTHON3_LIBRARY)-&gt;dk_entries[i]-&gt;me_hash
}

# FUNCTION P3_GET_DICT_KEY
# DICT: PySetObject
# I: set index to retrieve
# RETURNS: DICT_KEY

function p3_get_dict_key (dict, i) {
    entries = @cast (dict, &quot;PyDictObject&quot;, @PYTHON3_LIBRARY)-&gt;ma_keys;
    n = @cast (dict, &quot;PyDictObject&quot;, @PYTHON3_LIBRARY)-&gt;ma_used;
    if (i &gt; n || entries == 0)
	return 0
    return @cast (entries, &quot;PyDictKeysObject&quot;, @PYTHON3_LIBRARY)-&gt;dk_entries[i]-&gt;me_key
}

# FUNCTION P3_GET_DICT_VALUE
# DICT: PySetObject
# I: set index to retrieve
# RETURNS: DICT_VALUE

function p3_get_dict_value (dict, i) {
  if (@cast (dict, &quot;PyDictObject&quot;, @PYTHON3_LIBRARY)-&gt;ma_values) {
    # ?? is this correct for split keys and values table
    return @cast (entries, &quot;PyDictObject&quot;, @PYTHON3_LIBRARY)-&gt;ma_values[i];
  }
  else {
    # combined keys and values table
    entries = @cast (dict, &quot;PyDictObject&quot;, @PYTHON3_LIBRARY)-&gt;ma_keys;
    n = @cast (dict, &quot;PyDictObject&quot;, @PYTHON3_LIBRARY)-&gt;ma_used;
    if (i &gt; n || entries == 0)
	return 0
    return @cast (entries, &quot;PyDictKeysObject&quot;, @PYTHON3_LIBRARY)-&gt;dk_entries[i]-&gt;me_value
  }
}

# FUNCTION P3_DISPLAY_DICT_VARIABLE
# DICT: local or global variable name dictionary
# VARIABLE: variable to retrieve
# NAMESPACE: local or global

function p3_display_dict_variable (dict, variable, namespace, co_name_str, co_filename_str) {
    n = @cast (dict, &quot;PyDictObject&quot;, @PYTHON3_LIBRARY)-&gt;ma_used;
    for (i = 0; i &lt; n; i++) {
	dict_key = p3_get_dict_key (dict, i)
	dict_value = p3_get_dict_value (dict, i)
	dict_hash = p3_get_dict_hash (dict, i)
	if (dict_hash == 0 || dict_value == 0)
	    continue
#	key_str = p3_set_string (@cast (dict_key, &quot;PyUnicodeObject&quot;, @PYTHON3_LIBRARY)-&gt;str)
	key_str = get_unicode (dict_key)
	key_type_str = p3_get_type (dict_key)

	if (wildcard_match (key_str, variable)) {
	    foreach ([var, file] in python3_vars_seen) {
		if (var == key_str
		    &amp;&amp; file == co_filename_str)
		    return 0
	    }
	    printf (&quot;%s %s %s&quot;, namespace, key_type_str, key_str)
	    printf (&quot; in %s at %s&quot;, co_name_str, co_filename_str)
	    p3_display_value (dict_value, &quot; = &quot;, &quot; &quot;)
	    printf (&quot;\n&quot;)
	    python3_vars_seen[key_str, co_filename_str] = co_name_str
	}
    }
}


# FUNCTION ITERATE_OVER_FRAMES
# FRAME: Pointer to a stack frame
# FRAME_N: The frame number of this stack frame

function python3_iterate_over_frames (frame, frame_n)
{
    if (frame_n != 0) {
	python3_frame_n += 1
	frame =  @cast (frame, &quot;PyFrameObject&quot;, @PYTHON3_LIBRARY)-&gt;f_back
    }
    else
	python3_frame_n = 0
    return frame
}

    
# FUNCTION BACKTRACE_ONE_FRAME
# FRAME: Pointer to first stack frame
# MATCH_FILENAME: Pathnames containing this string are ignored.  Default is &quot;/lib/&quot; to
#     ignore system python libraries

function python3_backtrace_one_frame (frame, match_filename)
{
    f_code = @cast (frame, &quot;PyFrameObject&quot;, @PYTHON3_LIBRARY)-&gt;f_code;
    co_filename_str = p3_get_filename (f_code)
    if (isinstr (co_filename_str, &quot;importlib&quot;) == 1 || isinstr (co_filename_str, &quot;&lt;string&gt;&quot;) == 1 || isinstr (co_filename_str, &quot;/lib64/&quot;) == 1)
	return 0
    if (match_filename != &quot;&quot; &amp;&amp; isinstr (co_filename_str, match_filename) == 1)
	return 0
    co_name_str = p3_get_name (f_code)
    co_firstlineno = @cast (f_code, &quot;PyCodeObject&quot;, @PYTHON3_LIBRARY)-&gt;co_firstlineno;

    printf (&quot;#%d %s &quot;, python3_frame_n, co_name_str)

    co_varnames = @cast (f_code, &quot;PyCodeObject&quot;, @PYTHON3_LIBRARY)-&gt;co_varnames;
    co_argcount = @cast (f_code, &quot;PyCodeObject&quot;, @PYTHON3_LIBRARY)-&gt;co_argcount;
    f_localsplus = @cast (frame, &quot;PyFrameObject&quot;, @PYTHON3_LIBRARY)-&gt;f_localsplus;
    for (i = 0; i &lt; co_argcount; i++) {
	if (i == 0) print (&quot;(&quot;);
	arg_name_str = get_unicode (p3_get_sequence_item (co_varnames, i, &quot;tuple&quot;))
	arg_value = user_long (f_localsplus + (i * uarch_bytes()))
	arg_type_name_str = p3_get_type (arg_value)
	printf (&quot;%s:%s &quot;, arg_name_str, arg_type_name_str)
    }

    if (co_argcount) printf (&quot;)&quot;);

    printf (&quot; at %s:%d\n&quot;, co_filename_str, co_firstlineno)
}
    
# FUNCTION GETVAR_ONE_FRAME
# FRAME: Pointer to first stack frame
# MATCH_ARGS: Match function arguments
# VARIABLE: Variable wildcard to be matched.  Default is &quot;*&quot; to match all variables.
# MATCH_FILENAME: Pathnames containing this string are ignored.  Default is &quot;/lib/&quot; to
#     ignore system python libraries

function python3_getvar_one_frame (frame, match_args, variable, match_filename)
{
    f_code = @cast (frame, &quot;PyFrameObject&quot;, @PYTHON3_LIBRARY)-&gt;f_code;
    co_filename_str = p3_get_filename (f_code)
    if (isinstr (co_filename_str, &quot;importlib&quot;) == 1 || isinstr (co_filename_str, &quot;&lt;string&gt;&quot;) == 1 || isinstr (co_filename_str, &quot;/lib64/&quot;) == 1)
	return 0
    if (match_filename != &quot;&quot; &amp;&amp; isinstr (co_filename_str, match_filename) == 0)
	return 0
    co_name_str = p3_get_name (f_code)
    
    f_globals = @cast (frame, &quot;PyFrameObject&quot;, @PYTHON3_LIBRARY)-&gt;f_globals;
    if (f_globals != 0) {
	p3_display_dict_variable (f_globals, variable, &quot;global&quot;, co_name_str, co_filename_str)
    }
    f_locals = @cast (frame, &quot;PyFrameObject&quot;, @PYTHON3_LIBRARY)-&gt;f_locals;
    if (f_locals != 0) {
	p3_display_dict_variable (f_locals, variable, &quot;local&quot;, co_name_str, co_filename_str)
    }

    co_varnames = @cast (f_code, &quot;PyCodeObject&quot;, @PYTHON3_LIBRARY)-&gt;co_varnames;
    co_argcount = @cast (f_code, &quot;PyCodeObject&quot;, @PYTHON3_LIBRARY)-&gt;co_argcount;
    f_localsplus = @cast (frame, &quot;PyFrameObject&quot;, @PYTHON3_LIBRARY)-&gt;f_localsplus;
    ob_size = @cast (co_varnames, &quot;PyTypeObject&quot;, @PYTHON3_LIBRARY)-&gt;ob_base-&gt;ob_size;
    # iterate through the local variable list
    for (i = 0; i &lt; ob_size; i++) {
	arg_name_str = get_unicode (p3_get_sequence_item (co_varnames, i, &quot;tuple&quot;))
	if (! wildcard_match (arg_name_str, variable))
	    continue
	arg_value = user_long (f_localsplus + (i * uarch_bytes()))
	arg_type_name_str = p3_get_type (arg_value)
	next_var = 0
	foreach ([var, file] in python3_vars_seen)
	if (var == arg_name_str &amp;&amp; file == co_filename_str)
	    next_var = 1
	if (next_var || arg_type_name_str == &quot;&quot;)
	    continue
	if (i &lt; co_argcount &amp;&amp; match_args)
	    printf (&quot;arg%d &quot;, i + 1)
	python3_vars_seen[arg_name_str, co_filename_str] = co_name_str
	printf (&quot;%s %s&quot;, arg_type_name_str, arg_name_str)
	printf (&quot; in %s at %s&quot;, co_name_str, co_filename_str)
	p3_display_value (arg_value, &quot; = &quot;, &quot; &quot;)
	printf (&quot;\n&quot;)
    }
}

# FUNCTION PYTHON3_BACKTRACE
# SKIP_NAME: Pathnames containing this string are ignored.

function python3_backtrace (skip_name)
{
    frame = python3_frame
    for (i = 0; frame != 0; i++) {
       python3_backtrace_one_frame (frame, skip_name)
       frame = python3_iterate_over_frames (frame, i)
    }
}

# FUNCTION PYTHON3_GET_VARIABLE
# SKIP_NAME: Pathnames containing this string are ignored.

function python3_get_variable (variable, skip_name)
{
    frame = python3_frame
    for (i = 0; frame != 0; i++) {
	python3_getvar_one_frame (frame, 1, variable, skip_name)
	frame = python3_iterate_over_frames (frame, i)
    }
}

probe python3.function_entry = process(@PYTHON3_LIBRARY).mark (&quot;function__entry&quot;)
{
  # fedora and rhel python pass function name and line number, not frame pointer
  # so grab the frame pointer using debuginfo
  #  python3_frame = $arg1
     python3_frame = $f
}

probe python3.function_return = process(@PYTHON3_LIBRARY).mark (&quot;function__return&quot;)
{
  # fedora and rhel python pass function name and line number, not frame pointer
  # unfortunately the frame pointer is not always available in debuginfo
  # python3_frame = $arg1
}

probe python.function_entry = python3.function_entry {}
probe python.function_return = python3.function_return {}
</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Fopt%2Frh%2Fgcc-toolset-11%2Froot%2Fusr%2Fshare%2Fsystemtap%2Fexamples%2Fgeneral%2Ftapset'>Back to Directory</a>