functiontrace 0.4.0__tar.gz → 0.4.3__tar.gz

functiontrace-0.4.3/Cargo.toml

@@ -0,0 +1,22 @@
+[package]
+name = "_functiontrace_rs"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+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.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
+name = "_functiontrace_rs"  # private module to be nested into Python package
+crate-type = ["cdylib"]
+path = "rust/lib.rs"

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.0 → functiontrace-0.4.3}/MANIFEST.in

@@ -1,3 +1,4 @@
 graft mpack
 graft rust
 include Cargo.toml
+include build.rs

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

@@ -1,23 +1,24 @@
 Metadata-Version: 2.4
 Name: functiontrace
-Version: 0.4.0
+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.7
+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.3/build.rs

@@ -0,0 +1,20 @@
+fn main() -> std::io::Result<()> {
+    println!("cargo::rerun-if-changed=pyproject.toml");
+
+    // Read pyproject.toml to expose our version to the Rust extension
+    let pyproject = std::fs::read_to_string("pyproject.toml")?
+        .parse::<toml::Table>()
+        .expect("pyproject.toml is valid toml");
+    let version = pyproject
+        .get("project")
+        .and_then(|p| p.as_table())
+        .and_then(|p| p.get("version"))
+        .and_then(|v| v.as_str())
+        .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.0 → functiontrace-0.4.3/functiontrace.egg-info}/PKG-INFO

@@ -1,23 +1,24 @@
 Metadata-Version: 2.4
 Name: functiontrace
-Version: 0.4.0
+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.7
+Requires-Python: >=3.9
 Description-Content-Type: text/x-rst
+License-File: LICENSE.md
+Dynamic: license-file
 
 Py-Functiontrace
 ================

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

@@ -1,7 +1,9 @@
 Cargo.toml
+LICENSE.md
 MANIFEST.in
 README.rst
 _functiontrace.c
+build.rs
 functiontrace.py
 pyproject.toml
 setup.py

{functiontrace-0.4.0 → functiontrace-0.4.3}/functiontrace.py

@@ -5,7 +5,8 @@ import sys
 import tempfile
 from importlib import machinery, util
 
-import _functiontrace
+import _functiontrace  # noqa: F401 - this import is load bearing since we need to run code on import
+import _functiontrace_rs as rust
 
 PYTHON_TEMPLATE = """#!/bin/sh
 
@@ -70,9 +71,7 @@ def main():
         action="store_true",
         help="Disable compression of traces, which can be unnecessarily slow if filesize is not a concern.",
     )
-    parser.add_argument(
-        "-v", "--version", action="version", version=_functiontrace.__version__
-    )
+    parser.add_argument("-v", "--version", action="version", version=rust.__version__)
     parser.add_argument("script", nargs=argparse.REMAINDER)
     args = parser.parse_args()
 
@@ -114,8 +113,8 @@ def main():
     if args.no_compression:
         os.environ["FUNCTIONTRACE_COMPRESSION"] = "false"
     if args.trace_memory:
-        _functiontrace.config_tracememory()
-    _functiontrace.begin_tracing(args.output_dir)
+        rust.enable_tracememory()
+    rust.begin_tracing(args.output_dir)
 
     # Run their code now that we're tracing.  This must be done in the context
     # of the __main__ module we've created.
@@ -125,7 +124,7 @@ def main():
 def trace():
     # Make sure we're set up to work properly, then begin tracing.
     setup_dependencies()
-    _functiontrace.begin_tracing(os.getcwd())
+    rust.begin_tracing(os.getcwd())
 
 
 if __name__ == "__main__":

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

@@ -1,20 +1,21 @@
 [project]
 name = "functiontrace"
-version = "0.4.0"
+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.7 - 3.12 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.7"
+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",
@@ -41,9 +41,9 @@ functiontrace = "functiontrace:main"
 functiontrace = "functiontrace"
 
 [build-system]
-requires = ["setuptools", "toml", "setuptools-rust"]
+requires = ["setuptools", "setuptools-rust"]
 build-backend = "setuptools.build_meta"
 
 [[tool.setuptools-rust.ext-modules]]
-target = "_functiontrace_rs._lib" # Must match `lib.name` in Cargo.toml
+target = "_functiontrace_rs" # Must match `lib.name` in Cargo.toml
 binding = "PyO3"