functiontrace 0.4.2__tar.gz → 0.4.3__tar.gz

{functiontrace-0.4.2 → functiontrace-0.4.3}/Cargo.toml

@@ -7,12 +7,13 @@ edition = "2021"
 color-eyre = { version = "0.6", default-features = false }
 functiontrace-server = { version = "0.8.4", default-features = false, features = ["serialize"] }
 libc = "0.2"
-pyo3 = { version = "0.24", features = ["eyre"] }
+pyo3 = { version = "0.25", features = ["eyre"] }
 rmp-serde = "1.3"
 serde = "1"
 
 [build-dependencies]
 toml = { version = "0.8", default-features = false, features = ["parse"] }
+pyo3-build-config = { version = "0.25", features = ["resolve-config"] }
 
 [lib]
 # See https://github.com/PyO3/pyo3 for details

functiontrace-0.4.3/LICENSE.md

@@ -0,0 +1,57 @@
+# The Prosperity Public License 3.0.0
+
+Contributor: Matt Bryant, Alistair Dobke
+
+Source Code: https://gitlab.com/mbryant/functiontrace (https://functiontrace.com)
+
+## Purpose
+
+This license allows you to use and share this software for noncommercial purposes for free and to try this software for commercial purposes for thirty days.
+
+## Agreement
+
+In order to receive this license, you have to agree to its rules.  Those rules are both obligations under that agreement and conditions to your license.  Don't do anything with this software that triggers a rule you can't or won't follow.
+
+## Notices
+
+Make sure everyone who gets a copy of any part of this software from you, with or without changes, also gets the text of this license and the contributor and source code lines above.
+
+## Commercial Trial
+
+Limit your use of this software for commercial purposes to a thirty-day trial period.  If you use this software for work, your company gets one trial period for all personnel, not one trial per person.
+
+## Contributions Back
+
+Developing feedback, changes, or additions that you contribute back to the contributor on the terms of a standardized public software license such as [the Blue Oak Model License 1.0.0](https://blueoakcouncil.org/license/1.0.0), [the Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html), [the MIT license](https://spdx.org/licenses/MIT.html), or [the two-clause BSD license](https://spdx.org/licenses/BSD-2-Clause.html) doesn't count as use for a commercial purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, doesn't count as use for a commercial purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution doesn't count as use for a commercial purpose regardless of the source of funding or obligations resulting from the funding.
+
+## Defense
+
+Don't make any legal claim against anyone accusing this software, with or without changes, alone or with other technology, of infringing any patent.
+
+## Copyright
+
+The contributor licenses you to do everything with this software that would otherwise infringe their copyright in it.
+
+## Patent
+
+The contributor licenses you to do everything with this software that would otherwise infringe any patents they can license or become able to license.
+
+## Reliability
+
+The contributor can't revoke this license.
+
+## Excuse
+
+You're excused for unknowingly breaking [Notices](#notices) if you take all practical steps to comply within thirty days of learning you broke the rule.
+
+## No Liability
+
+***As far as the law allows, this software comes as is, without any warranty or condition, and the contributor won't be liable to anyone for any damages related to this software or this license, under any kind of legal claim.***

{functiontrace-0.4.2/functiontrace.egg-info → functiontrace-0.4.3}/PKG-INFO

@@ -1,23 +1,24 @@
 Metadata-Version: 2.4
 Name: functiontrace
-Version: 0.4.2
+Version: 0.4.3
 Summary: A profiling tool that traces your application's execution
 Author: Alistair Dobke
 Author-email: Matt Bryant <functiontrace@programsareproofs.com>
-License: The Prosperity Public License 3.0.0
+License-Expression: LicenseRef-Prosperity-Public-License-3.0.0
 Project-URL: homepage, https://functiontrace.com
 Project-URL: repository, https://gitlab.com/mbryant/functiontrace
 Keywords: profiler,debugger
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Debuggers
-Classifier: License :: Free for non-commercial use
 Classifier: Operating System :: Unix
 Classifier: Environment :: Console
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: Implementation :: CPython
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/x-rst
+License-File: LICENSE.md
+Dynamic: license-file
 
 Py-Functiontrace
 ================

functiontrace-0.4.3/_functiontrace.c

@@ -0,0 +1,160 @@
+#include <Python.h>
+#include <frameobject.h>
+#include <sys/types.h>
+#include <pthread.h>
+#include <stdio.h>
+#include <stdbool.h>
+#include <unistd.h>
+
+#include "mpack/mpack.h"
+
+////////////////////////////////////////////////////////////////////////////////
+// Prototypes
+////////////////////////////////////////////////////////////////////////////////
+static int     Fprofile_FunctionTrace(PyObject* obj, PyFrameObject* frame, int what, PyObject* arg);
+
+////////////////////////////////////////////////////////////////////////////////
+// Globals
+////////////////////////////////////////////////////////////////////////////////
+// This key is used to fetch the thread local instance of the `Writer`
+// structure.
+static pthread_key_t Tss_Key = 0;
+
+// The exposed apis of the Rust extension.
+static struct {
+    pthread_key_t (*set_config)(int (*functiontrace)(PyObject*, PyFrameObject*, int, PyObject*));
+}* rust;
+
+////////////////////////////////////////////////////////////////////////////////
+// Misc
+////////////////////////////////////////////////////////////////////////////////
+
+// Given a PyObject (likely `co_name` or similar), return a UTF-8
+// representation.
+static inline const char* Fprofile_UnicodeToUtf8(PyObject* obj) {
+    if (obj == NULL) {
+        return "<NULL>";
+    }
+
+    if (PyUnicode_Check(obj)) {
+        const char* utf8 = PyUnicode_AsUTF8(obj);
+
+        return utf8 != NULL ? utf8 : "<DECODE ERROR>";
+    } else if (obj == Py_None) {
+        return "<NONE>";
+    } else {
+        return "<UNKNOWN>";
+    }
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// Callbacks
+////////////////////////////////////////////////////////////////////////////////
+static int Fprofile_FunctionTrace(PyObject* obj, PyFrameObject* frame, int what, PyObject* arg) {
+    struct timespec    tsc = { 0 };
+
+    // This is called from the Rust code, which has already checked that
+    // everything is configured to send messages.
+    mpack_writer_t* writer = pthread_getspecific(Tss_Key);
+
+    clock_gettime(CLOCK_MONOTONIC, &tsc);
+
+    switch (what) {
+        case PyTrace_CALL:
+            mpack_start_array(writer, 5);
+            mpack_write_cstr(writer, "Call");
+
+            mpack_start_array(writer, 2);
+            mpack_write_u32(writer, tsc.tv_sec);
+            mpack_write_u32(writer, tsc.tv_nsec);
+            mpack_finish_array(writer);
+
+            {
+                PyCodeObject* code = PyFrame_GetCode(frame);
+                int lineno = PyFrame_GetLineNumber(frame);
+
+#if PY_VERSION_HEX >= 0x030b00a0
+                mpack_write_cstr(writer, Fprofile_UnicodeToUtf8(code->co_qualname));
+#else
+                mpack_write_cstr(writer, Fprofile_UnicodeToUtf8(code->co_name));
+#endif
+                mpack_write_cstr(writer, Fprofile_UnicodeToUtf8(code->co_filename));
+                mpack_write_u32(writer, lineno);
+
+                Py_DECREF(code);
+            }
+            mpack_finish_array(writer);
+            break;
+        case PyTrace_RETURN:
+            mpack_start_array(writer, 3);
+            mpack_write_cstr(writer, "Return");
+
+            mpack_start_array(writer, 2);
+            mpack_write_u32(writer, tsc.tv_sec);
+            mpack_write_u32(writer, tsc.tv_nsec);
+            mpack_finish_array(writer);
+
+            {
+                PyCodeObject* code = PyFrame_GetCode(frame);
+
+#if PY_VERSION_HEX >= 0x030b00a0
+                mpack_write_cstr(writer, Fprofile_UnicodeToUtf8(code->co_qualname));
+#else
+                mpack_write_cstr(writer, Fprofile_UnicodeToUtf8(code->co_name));
+#endif
+
+                Py_DECREF(code);
+            }
+            mpack_finish_array(writer);
+            break;
+        default:
+            perror("Impossible C case");
+            break;
+    }
+
+    return 0;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// Module Initialization
+////////////////////////////////////////////////////////////////////////////////
+
+// The set of methods exposed by this module to Python.
+static PyMethodDef methods[] = {
+    [0] = {NULL, NULL, 0, NULL}
+};
+
+static PyModuleDef module = {
+    PyModuleDef_HEAD_INIT,
+    "_functiontrace",
+    "",
+    -1,
+    methods
+};
+
+PyMODINIT_FUNC PyInit__functiontrace(void) {
+    // Setup our janky Rust dlopen alternative so we can use Rust code.
+    PyObject* rust_mod = PyImport_ImportModule("_functiontrace_rs");
+
+    // Verify that the rust extension loads if we're using it.
+    if (rust_mod == NULL) {
+        perror("Failed to load internal Rust extension");
+        exit(-1);
+    }
+
+    // This returns a pointer to the C API exposed by the Rust module.
+    PyObject* py_c_api = PyObject_GetAttrString(rust_mod, "c_api");
+    if (py_c_api == NULL) {
+        perror("Failed to initialize FunctionTrace Rust<->C interface");
+        exit(-1);
+    }
+    PyObject* c_api = PyObject_CallFunctionObjArgs(py_c_api, NULL);
+
+    // Save the Rust vtable so everyone can access it
+    rust = PyLong_AsVoidPtr(c_api);
+
+    // Share our globals with Rust
+    Tss_Key = rust->set_config(Fprofile_FunctionTrace);
+
+    return PyModule_Create(&module);
+}

{functiontrace-0.4.2 → functiontrace-0.4.3}/build.rs

@@ -13,5 +13,8 @@ fn main() -> std::io::Result<()> {
         .expect("version field is present in pyproject.toml");
     println!("cargo::rustc-env=PACKAGE_VERSION={}", version);
 
+    // Figure out which Python version we're building for
+    pyo3_build_config::use_pyo3_cfgs();
+
     Ok(())
 }

{functiontrace-0.4.2 → functiontrace-0.4.3/functiontrace.egg-info}/PKG-INFO

@@ -1,23 +1,24 @@
 Metadata-Version: 2.4
 Name: functiontrace
-Version: 0.4.2
+Version: 0.4.3
 Summary: A profiling tool that traces your application's execution
 Author: Alistair Dobke
 Author-email: Matt Bryant <functiontrace@programsareproofs.com>
-License: The Prosperity Public License 3.0.0
+License-Expression: LicenseRef-Prosperity-Public-License-3.0.0
 Project-URL: homepage, https://functiontrace.com
 Project-URL: repository, https://gitlab.com/mbryant/functiontrace
 Keywords: profiler,debugger
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Debuggers
-Classifier: License :: Free for non-commercial use
 Classifier: Operating System :: Unix
 Classifier: Environment :: Console
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: Implementation :: CPython
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/x-rst
+License-File: LICENSE.md
+Dynamic: license-file
 
 Py-Functiontrace
 ================

{functiontrace-0.4.2 → functiontrace-0.4.3}/functiontrace.egg-info/SOURCES.txt

@@ -1,4 +1,5 @@
 Cargo.toml
+LICENSE.md
 MANIFEST.in
 README.rst
 _functiontrace.c

{functiontrace-0.4.2 → functiontrace-0.4.3}/pyproject.toml

@@ -1,20 +1,21 @@
 [project]
 name = "functiontrace"
-version = "0.4.2"
+version = "0.4.3"
 description = "A profiling tool that traces your application's execution"
 authors = [
     { name = "Matt Bryant", email = "functiontrace@programsareproofs.com"},
     { name = "Alistair Dobke" }
 ]
-license = { text = "The Prosperity Public License 3.0.0" }
+license = "LicenseRef-Prosperity-Public-License-3.0.0"
+license-files = ["LICENSE.md"]
 readme = "README.rst"
-# NOTE: Actively tested on Python 3.8 - 3.13 and may plausibly break on greater
+# NOTE: Actively tested on Python 3.9 - 3.13 and may plausibly break on greater
 # versions due to C extension hacks.  However, setting a maximum version causes
 # new Python versions to simply install very old versions of Functiontrace that
 # didn't have the `requires-python` annotation on them and are also unlikely to
 # work.  Best to only set the minimum and let bug reports notify us of issues
 # with new Python releases.
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 keywords = [
     "profiler",
     "debugger"
@@ -22,7 +23,6 @@ keywords = [
 classifiers = [
 	"Intended Audience :: Developers",
 	"Topic :: Software Development :: Debuggers",
-	"License :: Free for non-commercial use",
 	"Operating System :: Unix",
 	"Environment :: Console",
     "Programming Language :: Python :: 3",

{functiontrace-0.4.2 → functiontrace-0.4.3}/rust/lib.rs

@@ -4,7 +4,8 @@ mod _functiontrace_rs {
     use functiontrace_server::function_trace;
     use pyo3::prelude::*; // TODO: What's in here?
     use serde::Serialize;
-    use std::ffi::{c_void, OsString};
+    use std::borrow::Cow;
+    use std::ffi::{c_void, CStr, OsString};
     use std::io::Write;
     use std::os::unix::net::UnixStream;
     use std::sync::atomic::{AtomicBool, AtomicU32, Ordering};
@@ -46,11 +47,7 @@ mod _functiontrace_rs {
         /// A small [`Write`] implementation that allows us to write to an
         /// `mpack_writer_t`'s interior buffer while keeping its state consistent.
         fn write(&mut self, src: &[u8]) -> std::io::Result<usize> {
-            if !STARTED
-                .get()
-                .expect("Set in `set_config`")
-                .load(Ordering::Relaxed)
-            {
+            if !STARTED.load(Ordering::Relaxed) {
                 // We haven't started yet, so we shouldn't write anything out.  This avoids logging
                 // various internal setup things before we're ready.
                 return Ok(src.len());
@@ -140,18 +137,11 @@ mod _functiontrace_rs {
 
     /// True iff we've started tracing and haven't been marked as terminated.  When this is
     /// set, we're allowed to send messages to the profile generation server.
-    static STARTED: OnceLock<&'static AtomicBool> = OnceLock::new();
+    static STARTED: AtomicBool = AtomicBool::new(false);
 
     /// The `Fprofile_FunctionTrace` function defined in the C extension.  This is needed to finish
     /// moving setup to the Rust code.
-    static TRACEFUNC: OnceLock<
-        unsafe extern "C" fn(
-            *mut pyo3::ffi::PyObject,
-            *mut pyo3::ffi::PyFrameObject,
-            i32,
-            *mut pyo3::ffi::PyObject,
-        ) -> i32,
-    > = OnceLock::new();
+    static TRACEFUNC: OnceLock<pyo3::ffi::Py_tracefunc> = OnceLock::new();
 
     ////////////////////////////////////////////////////////////////////////////////////////////////
     // Rust <-> C Communication
@@ -176,16 +166,9 @@ mod _functiontrace_rs {
         Box::into_raw(api) as usize
     }
 
+    /// Called by the C module to pass the `c_functiontrace` handler to us.
     #[unsafe(no_mangle)]
-    extern "C" fn set_config(
-        started: *const AtomicBool,
-        functiontrace: unsafe extern "C" fn(
-            *mut pyo3::ffi::PyObject,
-            *mut pyo3::ffi::PyFrameObject,
-            i32,
-            *mut pyo3::ffi::PyObject,
-        ) -> i32,
-    ) -> libc::pthread_key_t {
+    extern "C" fn set_config(c_functiontrace: pyo3::ffi::Py_tracefunc) -> libc::pthread_key_t {
         // Allocate a Tss_Key for storing thread state
         let mut tss_key = 0;
         if unsafe {
@@ -196,16 +179,8 @@ mod _functiontrace_rs {
             panic!("Failed to create Tss_Key");
         }
 
-        STARTED
-            .set(unsafe {
-                started
-                    .as_ref()
-                    .expect("started is non-null and has a static lifetime")
-            })
-            .expect("set_config can only be called once");
-
         TRACEFUNC
-            .set(functiontrace)
+            .set(c_functiontrace)
             .expect("set_config can only be called once");
 
         TSS_KEY.store(tss_key, Ordering::Relaxed);
@@ -339,7 +314,6 @@ mod _functiontrace_rs {
         module: &Bound<'_, PyModule>,
         output_directory: OsString,
     ) -> Result<()> {
-        //fn trace_initialization(args: *mut pyo3::ffi::PyObject) -> Result<()> {
         // The name of the env var we use to notify subprocesses that there's a trace in progress.
         const BREADCRUMB: &str = "FUNCTIONTRACE_LIVE";
 
@@ -544,11 +518,8 @@ mod _functiontrace_rs {
         // Register our tracing functions with Python - both the normal one and the multithreaded
         // setup trampoline.
         unsafe {
-            // SAFETY: tracefunc is a valid function pointer to `Fprofile_FunctionTrace`.
-            pyo3::ffi::PyEval_SetProfile(
-                Some(*TRACEFUNC.get().expect("tracefunc is set in set_config")),
-                std::ptr::null_mut(),
-            )
+            // SAFETY: both parameters are of the proper type.
+            pyo3::ffi::PyEval_SetProfile(Some(functiontrace), std::ptr::null_mut())
         };
 
         Python::with_gil(|py| -> Result<()> {
@@ -568,10 +539,7 @@ mod _functiontrace_rs {
         crate::hooks::install().wrap_err("Failed to install Python hooks")?;
 
         // We're now fully setup and allowed to send messages.
-        STARTED
-            .get()
-            .expect("Set in `set_config`")
-            .store(true, Ordering::Relaxed);
+        STARTED.store(true, Ordering::Relaxed);
 
         Ok(())
     }
@@ -585,10 +553,7 @@ mod _functiontrace_rs {
         _kwargs: Option<&Bound<'_, pyo3::types::PyDict>>,
     ) -> Result<()> {
         // Stop profiling and don't allow further logging, then flush any remaining messages.
-        STARTED
-            .get()
-            .expect("module_configuration was set by `set_config`")
-            .store(false, Ordering::Relaxed);
+        STARTED.store(false, Ordering::Relaxed);
 
         unsafe {
             // PyEval_SetProfile(NULL, NULL) is the proper way to deregister a profiler.
@@ -723,11 +688,7 @@ mod _functiontrace_rs {
     fn thread_reset() -> Result<()> {
         let tss_key = TSS_KEY.load(Ordering::Relaxed);
 
-        if !STARTED
-            .get()
-            .expect("STARTED was set by `set_config`")
-            .load(Ordering::Relaxed)
-        {
+        if !STARTED.load(Ordering::Relaxed) {
             // We haven't actually started yet, but are for some reason being asked
             // to fork.  This appears to be OS dependent.
             return Ok(());
@@ -782,11 +743,8 @@ mod _functiontrace_rs {
 
         // Replace our setprofile() handler with the real one.
         unsafe {
-            // SAFETY: tracefunc is a valid function pointer to `Fprofile_FunctionTrace`.
-            pyo3::ffi::PyEval_SetProfile(
-                Some(*TRACEFUNC.get().expect("tracefunc is set in set_config")),
-                std::ptr::null_mut(),
-            )
+            // SAFETY: both parameters are of the proper type.
+            pyo3::ffi::PyEval_SetProfile(Some(functiontrace), std::ptr::null_mut())
         };
 
         // We previously called into `Fprofile_FunctionTrace` here to manually record this call,
@@ -854,6 +812,167 @@ mod _functiontrace_rs {
 
         Ok(())
     }
+
+    /// The core logging function for FunctionTrace.  Configured by `PyEval_SetProfile`, and used
+    /// to record all function calls/returns.
+    extern "C" fn functiontrace(
+        obj: *mut pyo3::ffi::PyObject,
+        frame: *mut pyo3::ffi::PyFrameObject,
+        what: i32,
+        arg: *mut pyo3::ffi::PyObject,
+    ) -> i32 {
+        let Some(mut writer) = thread_state() else {
+            // No reason to look at the event since we can't log it yet.
+            return 0;
+        };
+
+        if !STARTED.load(Ordering::Relaxed) {
+            // We aren't running (either starting up or shutting down), so shouldn't write
+            // anything.
+            return 0;
+        }
+
+        let time = trace_time();
+        let c_functiontrace = *TRACEFUNC.get().expect("tracefunc is set in set_config");
+
+        // Return the function name when we're in a C_* context.
+        let c_func_name = || {
+            let func = arg as *mut pyo3::ffi::PyCFunctionObject;
+
+            unsafe {
+                // SAFETY: In the `C_*` cases, `arg` is a non-NULL `*PyCFunctionObject`, which
+                // always contains a valid method.
+                let method = (*func).m_ml;
+                (*method).ml_name
+            }
+        };
+        // Given a C string sourced from Python, convert it to a Cow that can be serialized.
+        let cstr_to_cow = |ptr: *const i8| {
+            if !ptr.is_null() {
+                unsafe {
+                    // SAFETY: `ptr` is non-NULL and contains a valid C string.
+                    // TODO: Can this change underneath us?
+                    CStr::from_ptr(ptr)
+                }
+                .to_str()
+                .unwrap_or("<invalid string>")
+                .into()
+            } else {
+                Cow::Borrowed("<null>")
+            }
+        };
+
+        match what {
+            pyo3::ffi::PyTrace_CALL | pyo3::ffi::PyTrace_RETURN => {
+                // For now we delegate these to the C implementation, since we can't access the
+                // `PyCodeObject` fields that we require via Rust.
+                unsafe {
+                    // SAFETY: tracefunc is a valid function pointer to `Fprofile_FunctionTrace`.
+                    return c_functiontrace(obj, frame, what, arg);
+                }
+            }
+            pyo3::ffi::PyTrace_C_CALL => {
+                let func = unsafe {
+                    // SAFETY: In the `C_CALL` case, `arg` is guaranteed to be a non-NULL pointer
+                    // to a `PyCFunctionObject`.
+                    &*(arg as *mut pyo3::ffi::PyCFunctionObject)
+                };
+
+                let func_name = cstr_to_cow(c_func_name());
+
+                // We either belong to a module or are a method on a class.
+                if !func.m_module.is_null() {
+                    // NOTE: _Typically_ `m_module` is a PyModule, but there are no requirements on
+                    // what type it needs to be!  In practice, we only see PyModules and PyStrings.
+                    Python::with_gil(|py| {
+                        let m_module = unsafe {
+                            // SAFETY: m_module is a non-NULL pointer to a valid Python object.
+                            Bound::from_borrowed_ptr(py, func.m_module)
+                        };
+
+                        if let Ok(module) = m_module.downcast::<pyo3::types::PyModule>() {
+                            // This is a PyModule, so get its name if possible.
+                            let name = module.name();
+                            let module_name = if let Ok(name) = &name {
+                                name.to_cow().unwrap_or(Cow::Borrowed("<invalid string>"))
+                            } else {
+                                Cow::Borrowed("<unnamed module>")
+                            };
+
+                            function_trace::FunctionTrace::NativeCall {
+                                module_name,
+                                func_name,
+                                time,
+                            }
+                            .serialize(&mut rmp_serde::encode::Serializer::new(&mut writer))
+                        } else {
+                            let module_name =
+                                if let Ok(module) = m_module.downcast::<pyo3::types::PyString>() {
+                                    module.to_cow().unwrap_or(Cow::Borrowed("<invalid string>"))
+                                } else {
+                                    // TODO: tracing log this
+                                    Cow::Borrowed("<unknown module>")
+                                };
+                            function_trace::FunctionTrace::NativeCall {
+                                module_name,
+                                func_name,
+                                time,
+                            }
+                            .serialize(&mut rmp_serde::encode::Serializer::new(&mut writer))
+                        }
+                    })
+                } else {
+                    // We don't belong to a module, so must be a class method.
+                    let module_name = if !func.m_self.is_null() {
+                        cstr_to_cow(unsafe {
+                            // SAFETY: Since `m_self` is non-NULL, it must point to a valid
+                            // PyObject, which is required to have a live and fully initialized
+                            // `ob_type` member.
+                            (*(*func.m_self).ob_type).tp_name
+                        })
+                    } else {
+                        Cow::Borrowed("<unknown module>")
+                    };
+
+                    function_trace::FunctionTrace::NativeCall {
+                        module_name,
+                        func_name,
+                        time,
+                    }
+                    .serialize(&mut rmp_serde::encode::Serializer::new(&mut writer))
+                }
+                .expect("Failed to emit NativeCall message");
+            }
+            pyo3::ffi::PyTrace_C_RETURN | pyo3::ffi::PyTrace_C_EXCEPTION => {
+                if what == pyo3::ffi::PyTrace_C_EXCEPTION {
+                    // C exceptions aren't exposed in a particularly interesting fashion, since they're
+                    // done using the `PyErr_*` functions plus a NULL return value.
+                    // However, if a `C_EXCEPTION` event is sent, we won't receive the corresponding
+                    // `C_RETURN` event, so in practice we treat both of these events the same.
+                    //
+                    // TODO: Should we try exposing information about them?  We'd probably need to
+                    // change the `Exception` format in `functiontrace-server`.
+                }
+
+                function_trace::FunctionTrace::NativeReturn {
+                    func_name: cstr_to_cow(c_func_name()),
+                    time,
+                }
+                .serialize(&mut rmp_serde::encode::Serializer::new(&mut writer))
+                .expect("Failed to emit NativeReturn message");
+            }
+            pyo3::ffi::PyTrace_EXCEPTION => {
+                // TODO: Actually handle exceptions and do something interesting.
+                // We unfortunately can't get these from `PyEval_SetProfile`, so we'd need to use a
+                // different method to capture them.
+            }
+            _ => {
+                // TODO: this shouldn't be possible - tracing log it so we can handle later.
+            }
+        };
+
+        0
+    }
 }
 
 /// Allocation hooks and helpers for tracing Python memory allocator operations.
@@ -865,14 +984,12 @@ mod allocation_wrappers {
     /// Log the given allocation details.
     fn allocation_log<F: FnOnce() -> function_trace::AllocationDetails>(msg: F) {
         if let Some(mut writer) = crate::_functiontrace_rs::thread_state() {
-            let allocation = function_trace::FunctionTrace::Allocation {
+            function_trace::FunctionTrace::Allocation {
                 time: crate::_functiontrace_rs::trace_time(),
                 details: msg(),
-            };
-
-            allocation
-                .serialize(&mut rmp_serde::encode::Serializer::new(&mut writer))
-                .expect("Failed to emit Allocation message");
+            }
+            .serialize(&mut rmp_serde::encode::Serializer::new(&mut writer))
+            .expect("Failed to emit Allocation message");
         }
     }
 

functiontrace-0.4.2/_functiontrace.c

@@ -1,277 +0,0 @@
-#include <Python.h>
-#include <frameobject.h>
-#include <sys/types.h>
-#include <pthread.h>
-#include <stdio.h>
-#include <stdbool.h>
-#include <unistd.h>
-
-#include "mpack/mpack.h"
-
-//#include <assert.h>
-// By default, python c extensions compile with asserts disable and it is not
-// super easy to disable this behavior (AFAIK). Use this custom assert for now.
-void assert_helper(int lineno, char* expr) {
-    printf("Assertion failed on line %d: %s\n", lineno, expr);
-    exit(-1);
-}
-#undef assert
-#define assert(expr) \
-    if (!(expr)) \
-        assert_helper(__LINE__, #expr)
-
-////////////////////////////////////////////////////////////////////////////////
-// Types
-////////////////////////////////////////////////////////////////////////////////
-
-// The messagepack writer for the current thread.
-typedef mpack_writer_t Writer;
-
-////////////////////////////////////////////////////////////////////////////////
-// Prototypes
-////////////////////////////////////////////////////////////////////////////////
-static Writer* Fprofile_Writer(void);
-
-static int     Fprofile_FunctionTrace(PyObject* obj, PyFrameObject* frame, int what, PyObject* arg);
-
-////////////////////////////////////////////////////////////////////////////////
-// Globals
-////////////////////////////////////////////////////////////////////////////////
-// This key is used to fetch the thread local instance of the `Writer`
-// structure.
-static pthread_key_t Tss_Key = 0;
-
-// True iff we've started tracing and haven't been marked as terminated.  When
-// this is set, we're allowed to send messages to the profile generation
-// server.
-static bool started;
-
-// The exposed apis of the Rust extension.
-static struct {
-    pthread_key_t (*set_config)(bool* config, int (*functiontrace)(PyObject*, PyFrameObject*, int, PyObject*));
-}* rust;
-
-////////////////////////////////////////////////////////////////////////////////
-// Server Communication
-////////////////////////////////////////////////////////////////////////////////
-
-static Writer* Fprofile_Writer(void) {
-    assert(Tss_Key != 0);
-
-    if (!started) {
-        // We aren't running (either starting up or shutting down), so
-        // shouldn't write anything.
-        return NULL;
-    }
-
-    // Fetch the Writerr for the current thread.  It's created as late as
-    // the first function call for the thread, so we can plausibly get messages
-    // before having anywhere to store/send them to.  Drop them if so - they
-    // weren't too important if we aren't running code yet.
-    Writer* state = pthread_getspecific(Tss_Key);
-    if (state == NULL) {
-        // The thread hasn't officially started yet, so drop this message.
-        return NULL;
-    }
-
-    return state;
-}
-
-////////////////////////////////////////////////////////////////////////////////
-// Misc
-////////////////////////////////////////////////////////////////////////////////
-
-// Given a PyObject (likely `co_name` or similar), return a UTF-8
-// representation.
-static inline const char* Fprofile_UnicodeToUtf8(PyObject* obj) {
-    if (obj == NULL) {
-        return "<NULL>";
-    }
-
-    if (PyUnicode_Check(obj)) {
-        const char* utf8 = PyUnicode_AsUTF8(obj);
-
-        return utf8 != NULL ? utf8 : "<DECODE ERROR>";
-    } else if (obj == Py_None) {
-        return "<NONE>";
-    } else {
-        return "<UNKNOWN>";
-    }
-}
-
-////////////////////////////////////////////////////////////////////////////////
-// Callbacks
-////////////////////////////////////////////////////////////////////////////////
-static int Fprofile_FunctionTrace(PyObject* obj, PyFrameObject* frame, int what, PyObject* arg) {
-    PyCFunctionObject* fn  = (PyCFunctionObject*) arg;
-    struct timespec    tsc = { 0 };
-
-    Writer* writer = Fprofile_Writer();
-    if (writer == NULL) {
-        return 0;
-    }
-
-    clock_gettime(CLOCK_MONOTONIC, &tsc);
-
-    switch (what) {
-        case PyTrace_CALL:
-            mpack_start_array(writer, 5);
-            mpack_write_cstr(writer, "Call");
-
-            mpack_start_array(writer, 2);
-            mpack_write_u32(writer, tsc.tv_sec);
-            mpack_write_u32(writer, tsc.tv_nsec);
-            mpack_finish_array(writer);
-
-            {
-                // TODO: Check if frame is none or similar
-#if PY_VERSION_HEX >= 0x030a00a0
-                // Python >= 3.10 should use the standard accessors
-                PyCodeObject* code = PyFrame_GetCode(frame);
-                int lineno = PyFrame_GetLineNumber(frame);
-#else
-                PyCodeObject* code = frame->f_code;
-                int lineno = frame->f_lineno;
-#endif
-
-#if PY_VERSION_HEX >= 0x030b00a0
-                mpack_write_cstr(writer, Fprofile_UnicodeToUtf8(code->co_qualname));
-#else
-                mpack_write_cstr(writer, Fprofile_UnicodeToUtf8(code->co_name));
-#endif
-                mpack_write_cstr(writer, Fprofile_UnicodeToUtf8(code->co_filename));
-                mpack_write_u32(writer, lineno);
-
-#if PY_VERSION_HEX >= 0x030a00a0
-                Py_DECREF(code);
-#endif
-            }
-            mpack_finish_array(writer);
-            break;
-        case PyTrace_RETURN:
-            mpack_start_array(writer, 3);
-            mpack_write_cstr(writer, "Return");
-
-            mpack_start_array(writer, 2);
-            mpack_write_u32(writer, tsc.tv_sec);
-            mpack_write_u32(writer, tsc.tv_nsec);
-            mpack_finish_array(writer);
-
-            {
-#if PY_VERSION_HEX >= 0x030a00a0
-                PyCodeObject* code = PyFrame_GetCode(frame);
-#else
-                PyCodeObject* code = frame->f_code;
-#endif
-#if PY_VERSION_HEX >= 0x030b00a0
-                mpack_write_cstr(writer, Fprofile_UnicodeToUtf8(code->co_qualname));
-#else
-                mpack_write_cstr(writer, Fprofile_UnicodeToUtf8(code->co_name));
-#endif
-
-#if PY_VERSION_HEX >= 0x030a00a0
-                Py_DECREF(code);
-#endif
-            }
-            mpack_finish_array(writer);
-            break;
-        case PyTrace_C_CALL: {
-            mpack_start_array(writer, 4);
-            mpack_write_cstr(writer, "NativeCall");
-
-            mpack_start_array(writer, 2);
-            mpack_write_u32(writer, tsc.tv_sec);
-            mpack_write_u32(writer, tsc.tv_nsec);
-            mpack_finish_array(writer);
-
-            {
-                // Attempt to determine what module/class this function belongs
-                // to.
-                PyObject*   self        = fn->m_self;
-                PyObject*   module      = fn->m_module;
-                const char* name        = fn->m_ml->ml_name;
-                const char* module_name = NULL;
-
-                // Check if we belong to a module, and if not we must be a
-                // method.  We do this order to avoid finding that the object
-                // we belong to is of type module.
-                if (module != NULL) {
-                    if (PyModule_Check(module)) {
-                        module_name = PyModule_GetName(module);
-                    } else if (PyUnicode_Check(module)) {
-                        module_name = PyUnicode_AsUTF8(module);
-                    }
-                } else if (self != NULL) {
-                    // This is a method call on a class.
-                    module_name = self->ob_type->tp_name;
-                }
-
-                mpack_write_cstr(writer, name != NULL ? name : "NULL");
-                mpack_write_cstr(writer, module_name != NULL ? module_name : "NULL");
-            }
-            mpack_finish_array(writer);
-            break;
-        }
-        case PyTrace_C_RETURN:
-            mpack_start_array(writer, 3);
-            mpack_write_cstr(writer, "NativeReturn");
-
-            mpack_start_array(writer, 2);
-            mpack_write_u32(writer, tsc.tv_sec);
-            mpack_write_u32(writer, tsc.tv_nsec);
-            mpack_finish_array(writer);
-
-            {
-                const char* name = fn->m_ml->ml_name;
-                mpack_write_cstr(writer, name != NULL ? name : "NULL");
-            }
-            mpack_finish_array(writer);
-            break;
-        default:
-            // TODO: We should handle exceptions here (or somewhere similar).
-            break;
-    }
-
-    return 0;
-}
-
-////////////////////////////////////////////////////////////////////////////////
-// Module Initialization
-////////////////////////////////////////////////////////////////////////////////
-
-// The set of methods exposed by this module to Python.
-static PyMethodDef methods[] = {
-    [0] = {NULL, NULL, 0, NULL}
-};
-
-static PyModuleDef module = {
-    PyModuleDef_HEAD_INIT,
-    "_functiontrace",
-    "",
-    -1,
-    methods
-};
-
-PyMODINIT_FUNC PyInit__functiontrace(void) {
-    // Setup our janky Rust dlopen alternative so we can use Rust code.
-    PyObject* rust_mod = PyImport_ImportModule("_functiontrace_rs");
-
-    // Verify that the rust extension loads if we're using it.
-    if (rust_mod == NULL) {
-        perror("Failed to load internal Rust extension");
-        exit(-1);
-    }
-
-    // This returns a pointer to the C API exposed by the Rust module.
-    PyObject* py_c_api = PyObject_GetAttrString(rust_mod, "c_api");
-    assert(py_c_api != NULL);
-    PyObject* c_api = PyObject_CallFunctionObjArgs(py_c_api, NULL);
-
-    // Save the Rust vtable so everyone can access it
-    rust = PyLong_AsVoidPtr(c_api);
-
-    // Share our globals with Rust
-    Tss_Key = rust->set_config(&started, Fprofile_FunctionTrace);
-
-    return PyModule_Create(&module);
-}