py-spy 0.3.3

Sampling profiler for Python programs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

pub mod v2_7_15;
pub mod v3_3_7;
pub mod v3_5_5;
pub mod v3_6_6;
pub mod v3_7_0;
pub mod v3_8_0;

// currently the PyRuntime struct used from Python 3.7 on really can't be
// exposed in a cross platform way using bindgen. PyRuntime has several mutex's
// as member variables, and these have different sizes depending on the operating
// system and system architecture.
// Instead we will define some constants here that define valid offsets for the
// member variables we care about here
// (note 'generate_bindings.py' has code to figure out these offsets)
pub mod pyruntime {
    use crate::version::Version;

    // There aren't any OS specific members of PyRuntime before pyinterpreters.head,
    // so these offsets should be valid for all OS'es
    #[cfg(target_pointer_width = "32")]
    pub fn get_interp_head_offset(version: &Version) -> usize {
        match version {
            Version{major: 3, minor: 8, patch: 0, ..} => {
                match version.release_flags.as_ref() {
                    "a1" | "a2" => 16,
                    _ => 20
                }
            },
            Version{major: 3, minor: 8..=9, ..} => 20,
            _ => 16
        }
    }

    #[cfg(target_pointer_width = "64")]
    pub fn get_interp_head_offset(version: &Version) -> usize {
        match version {
            Version{major: 3, minor: 8, patch: 0, ..} => {
                 match version.release_flags.as_ref() {
                    "a1" | "a2" => 24,
                    _ => 32
                }
            },
            Version{major: 3, minor: 8..=9, ..} => 32,
            _ => 24
        }
    }

    // getting gilstate.tstate_current is different for all OS
    // and is also different for each python version, and even
    // between v3.8.0a1 and v3.8.0a2 =(
    #[cfg(target_os="macos")]
    pub fn get_tstate_current_offset(version: &Version) -> Option<usize> {
        match version {
             Version{major: 3, minor: 7, patch: 0..=3, ..} => Some(1440),
             Version{major: 3, minor: 7, patch: 4..=6, ..} => Some(1528),
             Version{major: 3, minor: 8, patch: 0, ..} => {
                 match version.release_flags.as_ref() {
                    "a1" => Some(1432),
                    "a2" => Some(888),
                    "a3" | "a4" => Some(1448),
                    _ => Some(1416),
                }
             },
             Version{major: 3, minor: 8, patch: 1, ..} => { Some(1416) },
             _ => None
        }
    }

    #[cfg(all(target_os="linux", target_pointer_width = "32"))]
    pub fn get_tstate_current_offset(version: &Version) -> Option<usize> {
        match version {
            Version{major: 3, minor: 7, patch: 0..=6, ..} => Some(796),
             Version{major: 3, minor: 8, patch: 0, ..} => {
                 match version.release_flags.as_ref() {
                    "a1" => Some(792),
                    "a2" => Some(512),
                    "a3" | "a4" => Some(800),
                    _  => Some(788)
                }
            },
            Version{major: 3, minor: 8, patch: 1, ..} => Some(788),
            _ => None
        }
    }

    #[cfg(all(target_os="linux", target_pointer_width = "64"))]
    pub fn get_tstate_current_offset(version: &Version) -> Option<usize> {
        match version {
            Version{major: 3, minor: 7, patch: 0..=3, ..} => Some(1392),
            Version{major: 3, minor: 7, patch: 4..=6, ..} => Some(1480),
            Version{major: 3, minor: 8, patch: 0, ..} => {
                match version.release_flags.as_ref() {
                    "a1" => Some(1384),
                    "a2" => Some(840),
                    "a3" | "a4" => Some(1400),
                    _  => Some(1368)
                }
             },
            Version{major: 3, minor: 8, patch: 1, ..} => Some(1368),
            _ => None
        }
    }

    #[cfg(windows)]
    pub fn get_tstate_current_offset(version: &Version) -> Option<usize> {
        match version {
            Version{major: 3, minor: 7, patch: 0..=3, ..} => Some(1320),
            Version{major: 3, minor: 8, patch: 0, ..} => {
                match version.release_flags.as_ref() {
                    "a1" => Some(1312),
                    "a2" => Some(768),
                    "a3" | "a4" => Some(1328),
                    _ => Some(1296)
                }
            },
            Version{major: 3, minor: 8, patch: 1, ..} => Some(1296),
            _ => None
        }
    }

    #[cfg(target_os="freebsd")]
    pub fn get_tstate_current_offset(version: &Version) -> Option<usize> {
        match version {
            Version{major: 3, minor: 7, patch: 0..=3, ..} => Some(1248),
            Version{major: 3, minor: 7, patch: 4..=6, ..} => Some(1336),
            Version{major: 3, minor: 8, patch: 0, ..} => {
                match version.release_flags.as_ref() {
                    "a1" => Some(1240),
                    "a2" => Some(696),
                    "a3" | "a4" => Some(1256),
                    _ => Some(1224)
                }
            },
            Version{major: 3, minor: 8, patch: 1, ..} => Some(1224),
            _ => None
        }
    }
}