summaryrefslogtreecommitdiffstats
path: root/third_party/rust/tracy-rs
diff options
context:
space:
mode:
Diffstat (limited to 'third_party/rust/tracy-rs')
-rw-r--r--third_party/rust/tracy-rs/.cargo-checksum.json1
-rw-r--r--third_party/rust/tracy-rs/Cargo.toml26
-rw-r--r--third_party/rust/tracy-rs/LICENSE375
-rw-r--r--third_party/rust/tracy-rs/README.md15
-rw-r--r--third_party/rust/tracy-rs/src/disabled.rs40
-rw-r--r--third_party/rust/tracy-rs/src/lib.rs15
-rw-r--r--third_party/rust/tracy-rs/src/profiler.rs189
7 files changed, 661 insertions, 0 deletions
diff --git a/third_party/rust/tracy-rs/.cargo-checksum.json b/third_party/rust/tracy-rs/.cargo-checksum.json
new file mode 100644
index 0000000000..214126d879
--- /dev/null
+++ b/third_party/rust/tracy-rs/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"Cargo.toml":"1686a2618c647f5bb165ed124df392f10ff3e0f42e7266aa23039cd09dc4b248","LICENSE":"d82f358a1e02cb205b9a29ada979df5c7a315a29cc73e58f557ae4f33bfd1777","README.md":"c694e1a34230f1b965713ca41df396314025b103cde1acbfc9c168932b59e548","src/disabled.rs":"22a64e44ce27656217951a6306e312c4e1288daff8871a426ac07aa13f1408ec","src/lib.rs":"f6caf42bdb534baa29996e384c79f28b6f462b68cd7ab2bd0f968c28f5612b7a","src/profiler.rs":"b6ccc42448aef9110a4ed453d341b8f498c53841e537031078ea27449023e6f5"},"package":"ce607aae8ab0ab3abf3a2723a9ab6f09bb8639ed83fdd888d857b8e556c868d8"} \ No newline at end of file
diff --git a/third_party/rust/tracy-rs/Cargo.toml b/third_party/rust/tracy-rs/Cargo.toml
new file mode 100644
index 0000000000..0532f2cf3d
--- /dev/null
+++ b/third_party/rust/tracy-rs/Cargo.toml
@@ -0,0 +1,26 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies
+#
+# If you believe there's an error in this file please file an
+# issue against the rust-lang/cargo repository. If you're
+# editing this file be aware that the upstream Cargo.toml
+# will likely look very different (and much more reasonable)
+
+[package]
+edition = "2018"
+name = "tracy-rs"
+version = "0.1.2"
+authors = ["Glenn Watson <git@intuitionlibrary.com>"]
+description = "Rust bindings for the tracy realtime profiler"
+license = "MPL-2.0"
+[dependencies.minidl]
+version = "0.1"
+optional = true
+
+[features]
+default = []
+enable_profiler = ["minidl"]
diff --git a/third_party/rust/tracy-rs/LICENSE b/third_party/rust/tracy-rs/LICENSE
new file mode 100644
index 0000000000..a60db2c9e4
--- /dev/null
+++ b/third_party/rust/tracy-rs/LICENSE
@@ -0,0 +1,375 @@
+ Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+means each individual or legal entity that creates, contributes to
+the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+means the combination of the Contributions of others (if any) used
+by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+means Source Code Form to which the initial Contributor has attached
+the notice in Exhibit A, the Executable Form of such Source Code
+Form, and Modifications of such Source Code Form, in each case
+including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+means
+
+(a) that the initial Contributor has attached the notice described
+in Exhibit B to the Covered Software; or
+
+(b) that the Covered Software was made available under the terms of
+version 1.1 or earlier of the License, but not also under the
+terms of a Secondary License.
+
+1.6. "Executable Form"
+means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+means a work that combines Covered Software with other material, in
+a separate file or files, that is not Covered Software.
+
+1.8. "License"
+means this document.
+
+1.9. "Licensable"
+means having the right to grant, to the maximum extent possible,
+whether at the time of the initial grant or subsequently, any and
+all of the rights conveyed by this License.
+
+1.10. "Modifications"
+means any of the following:
+
+(a) any file in Source Code Form that results from an addition to,
+deletion from, or modification of the contents of Covered
+Software; or
+
+(b) any new file in Source Code Form that contains any Covered
+Software.
+
+1.11. "Patent Claims" of a Contributor
+means any patent claim(s), including without limitation, method,
+process, and apparatus claims, in any patent Licensable by such
+Contributor that would be infringed, but for the grant of the
+License, by the making, using, selling, offering for sale, having
+made, import, or transfer of either its Contributions or its
+Contributor Version.
+
+1.12. "Secondary License"
+means either the GNU General Public License, Version 2.0, the GNU
+Lesser General Public License, Version 2.1, the GNU Affero General
+Public License, Version 3.0, or any later versions of those
+licenses.
+
+1.13. "Source Code Form"
+means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+means an individual or a legal entity exercising rights under this
+License. For legal entities, "You" includes any entity that
+controls, is controlled by, or is under common control with You. For
+purposes of this definition, "control" means (a) the power, direct
+or indirect, to cause the direction or management of such entity,
+whether by contract or otherwise, or (b) ownership of more than
+fifty percent (50%) of the outstanding shares or beneficial
+ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+Licensable by such Contributor to use, reproduce, make available,
+modify, display, perform, distribute, and otherwise exploit its
+Contributions, either on an unmodified basis, with Modifications, or
+as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+for sale, have made, import, and otherwise transfer either its
+Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+or
+
+(b) for infringements caused by: (i) Your and any other third party's
+modifications of Covered Software, or (ii) the combination of its
+Contributions with other software (except as part of its Contributor
+Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+Form, as described in Section 3.1, and You must inform recipients of
+the Executable Form how they can obtain a copy of such Source Code
+Form by reasonable means in a timely manner, at a charge no more
+than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+License, or sublicense it under different terms, provided that the
+license for the Executable Form does not attempt to limit or alter
+the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+* *
+* 6. Disclaimer of Warranty *
+* ------------------------- *
+* *
+* Covered Software is provided under this License on an "as is" *
+* basis, without warranty of any kind, either expressed, implied, or *
+* statutory, including, without limitation, warranties that the *
+* Covered Software is free of defects, merchantable, fit for a *
+* particular purpose or non-infringing. The entire risk as to the *
+* quality and performance of the Covered Software is with You. *
+* Should any Covered Software prove defective in any respect, You *
+* (not any Contributor) assume the cost of any necessary servicing, *
+* repair, or correction. This disclaimer of warranty constitutes an *
+* essential part of this License. No use of any Covered Software is *
+* authorized under this License except under this disclaimer. *
+* *
+************************************************************************
+
+************************************************************************
+* *
+* 7. Limitation of Liability *
+* -------------------------- *
+* *
+* Under no circumstances and under no legal theory, whether tort *
+* (including negligence), contract, or otherwise, shall any *
+* Contributor, or anyone who distributes Covered Software as *
+* permitted above, be liable to You for any direct, indirect, *
+* special, incidental, or consequential damages of any character *
+* including, without limitation, damages for lost profits, loss of *
+* goodwill, work stoppage, computer failure or malfunction, or any *
+* and all other commercial damages or losses, even if such party *
+* shall have been informed of the possibility of such damages. This *
+* limitation of liability shall not apply to liability for death or *
+* personal injury resulting from such party's negligence to the *
+* extent applicable law prohibits such limitation. Some *
+* jurisdictions do not allow the exclusion or limitation of *
+* incidental or consequential damages, so this exclusion and *
+* limitation may not apply to You. *
+* *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+This Source Code Form is subject to the terms of the Mozilla Public
+License, v. 2.0. If a copy of the MPL was not distributed with this
+file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+This Source Code Form is "Incompatible With Secondary Licenses", as
+defined by the Mozilla Public License, v. 2.0.
+
+
diff --git a/third_party/rust/tracy-rs/README.md b/third_party/rust/tracy-rs/README.md
new file mode 100644
index 0000000000..abdcb51f5f
--- /dev/null
+++ b/third_party/rust/tracy-rs/README.md
@@ -0,0 +1,15 @@
+# tracy-rs
+
+This provides a Rust integration for the Tracy profiling library (https://bitbucket.org/wolfpld/tracy).
+
+## Usage
+
+1) Clone the Tracy library from the above URL.
+2) Follow the steps to build the profiler GUI (e.g. in tracy/profiler/build/unix/).
+3) Follow the steps to build the profiler shared library (e.g. in tracy/library/unix).
+4) Add this crate to your project dependencies, with the 'enable_profiler' cargo feature.
+5) Call `tracy_rs::load` at the start of your application, providing path to library from (3).
+6) Insert the main frame marker `tracy_frame_marker!();` at the end of your frame.
+7) Optionally, add sub-frame markers with `tracy_begin_frame!()` and `tracy_end_frame!()`.
+8) Annotate functions to be profiled with `profile_scope!()`.
+9) Run the application and profiler GUI.
diff --git a/third_party/rust/tracy-rs/src/disabled.rs b/third_party/rust/tracy-rs/src/disabled.rs
new file mode 100644
index 0000000000..14f88b930b
--- /dev/null
+++ b/third_party/rust/tracy-rs/src/disabled.rs
@@ -0,0 +1,40 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+// A set of empty stub macros that are defined when the enable_profiler feature
+// is not enabled. This ensures that we don't include callsite definitions in
+// the resulting binary.
+
+#[macro_export]
+macro_rules! profile_scope {
+ ($string:expr) => {}
+}
+
+#[macro_export]
+macro_rules! tracy_frame_marker {
+ () => {}
+}
+
+#[macro_export]
+macro_rules! tracy_begin_frame {
+ ($name:expr) => {}
+}
+
+#[macro_export]
+macro_rules! tracy_end_frame {
+ ($name:expr) => {}
+}
+
+#[macro_export]
+macro_rules! tracy_plot {
+ ($name:expr, $value:expr) => {}
+}
+
+pub unsafe fn load(_: &str) -> bool {
+ println!("Can't load the tracy profiler unless enable_profiler feature is enabled!");
+ false
+}
+
+pub fn register_thread_with_profiler(_: String) {
+}
diff --git a/third_party/rust/tracy-rs/src/lib.rs b/third_party/rust/tracy-rs/src/lib.rs
new file mode 100644
index 0000000000..e444d10da5
--- /dev/null
+++ b/third_party/rust/tracy-rs/src/lib.rs
@@ -0,0 +1,15 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#[cfg(feature = "enable_profiler")]
+pub mod profiler;
+
+#[cfg(feature = "enable_profiler")]
+pub use profiler::{load, register_thread_with_profiler};
+
+#[cfg(not(feature = "enable_profiler"))]
+mod disabled;
+
+#[cfg(not(feature = "enable_profiler"))]
+pub use disabled::{load, register_thread_with_profiler};
diff --git a/third_party/rust/tracy-rs/src/profiler.rs b/third_party/rust/tracy-rs/src/profiler.rs
new file mode 100644
index 0000000000..220aa955e8
--- /dev/null
+++ b/third_party/rust/tracy-rs/src/profiler.rs
@@ -0,0 +1,189 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+use minidl::Library;
+
+// Must match `___tracy_source_location_data` struct in TracyC.h
+#[repr(C)]
+pub struct SourceLocation {
+ pub name: *const u8,
+ pub function: *const u8,
+ pub file: *const u8,
+ pub line: u32,
+ pub color: u32,
+}
+
+// Must match `___tracy_c_zone_context` in TracyC.h
+#[repr(C)]
+#[derive(Copy, Clone)]
+pub struct ZoneContext {
+ id: u32,
+ active: i32,
+}
+
+// Define a set of no-op implementation functions that are called if the tracy
+// shared library is not loaded.
+extern "C" fn unimpl_mark_frame(_: *const u8) {}
+extern "C" fn unimpl_mark_frame_start(_: *const u8) {}
+extern "C" fn unimpl_mark_frame_end(_: *const u8) {}
+extern "C" fn unimpl_zone_begin(_: *const SourceLocation, _: i32) -> ZoneContext {
+ ZoneContext {
+ id: 0,
+ active: 0,
+ }
+}
+extern "C" fn unimpl_zone_end(_: ZoneContext) {}
+extern "C" fn unimpl_zone_text(_: ZoneContext, _: *const u8, _: usize) {}
+
+extern "C" fn unimpl_plot(_: *const u8, _: f64) {}
+
+// Function pointers to the tracy API functions (if loaded), or the no-op functions above.
+pub static mut MARK_FRAME: extern "C" fn(name: *const u8) = unimpl_mark_frame;
+pub static mut MARK_FRAME_START: extern "C" fn(name: *const u8) = unimpl_mark_frame_start;
+pub static mut MARK_FRAME_END: extern "C" fn(name: *const u8) = unimpl_mark_frame_end;
+pub static mut EMIT_ZONE_BEGIN: extern "C" fn(srcloc: *const SourceLocation, active: i32) -> ZoneContext = unimpl_zone_begin;
+pub static mut EMIT_ZONE_END: extern "C" fn(ctx: ZoneContext) = unimpl_zone_end;
+pub static mut EMIT_ZONE_TEXT: extern "C" fn(ctx: ZoneContext, txt: *const u8, size: usize) = unimpl_zone_text;
+pub static mut EMIT_PLOT: extern "C" fn(name: *const u8, val: f64) = unimpl_plot;
+
+// Load the tracy library, and get function pointers. This is unsafe since:
+// - It must not be called while other threads are calling the functions.
+// - It doesn't ensure that the library is not unloaded during use.
+pub unsafe fn load(path: &str) -> bool {
+ match Library::load(path) {
+ Ok(lib) => {
+ // If lib loading succeeds, assume we can find all the symbols required.
+ MARK_FRAME = lib.sym("___tracy_emit_frame_mark\0").unwrap();
+ MARK_FRAME_START = lib.sym("___tracy_emit_frame_mark_start\0").unwrap();
+ MARK_FRAME_END = lib.sym("___tracy_emit_frame_mark_end\0").unwrap();
+ EMIT_ZONE_BEGIN = lib.sym("___tracy_emit_zone_begin\0").unwrap();
+ EMIT_ZONE_END = lib.sym("___tracy_emit_zone_end\0").unwrap();
+ EMIT_ZONE_TEXT = lib.sym("___tracy_emit_zone_text\0").unwrap();
+ EMIT_PLOT = lib.sym("___tracy_emit_plot\0").unwrap();
+
+ true
+ }
+ Err(..) => {
+ println!("Failed to load the tracy profiling library!");
+
+ false
+ }
+ }
+}
+
+/// A simple stack scope for tracing function execution time
+pub struct ProfileScope {
+ ctx: ZoneContext,
+}
+
+impl ProfileScope {
+ pub fn new(callsite: &'static SourceLocation) -> Self {
+ let ctx = unsafe { EMIT_ZONE_BEGIN(callsite, 1) };
+
+ ProfileScope {
+ ctx,
+ }
+ }
+
+ pub fn text(&self, text: &[u8]) {
+ unsafe { EMIT_ZONE_TEXT(self.ctx, text.as_ptr(), text.len()) };
+ }
+}
+
+impl Drop for ProfileScope {
+ fn drop(&mut self) {
+ unsafe {
+ EMIT_ZONE_END(self.ctx)
+ }
+ }
+}
+
+/// Define a profiling scope.
+///
+/// This macro records a Tracy 'zone' starting at the point at which the macro
+/// occurs, and extending to the end of the block. More precisely, the zone ends
+/// when a variable declared by this macro would be dropped, so early returns
+/// exit the zone.
+///
+/// For example:
+///
+/// fn an_operation_that_may_well_take_a_long_time() {
+/// profile_scope!("an_operation_that_may_well_take_a_long_time");
+/// ...
+/// }
+///
+/// The first argument to `profile_scope!` is the name of the zone, and must be
+/// a string literal.
+///
+/// Tracy zones can also have associated 'text' values that vary from one
+/// execution to the next - for example, a zone's text might record the name of
+/// the file being processed. The text must be a `CStr` value. You can provide
+/// zone text like this:
+///
+/// fn run_reftest(test_name: &str) {
+/// profile_scope!("run_reftest", text: test_name);
+/// ...
+/// }
+#[macro_export]
+macro_rules! profile_scope {
+ ($string:literal $(, text: $text:expr )? ) => {
+ const CALLSITE: $crate::profiler::SourceLocation = $crate::profiler::SourceLocation {
+ name: concat!($string, "\0").as_ptr(),
+ function: concat!(module_path!(), "\0").as_ptr(),
+ file: concat!(file!(), "\0").as_ptr(),
+ line: line!(),
+ color: 0xff0000ff,
+ };
+
+ let _profile_scope = $crate::profiler::ProfileScope::new(&CALLSITE);
+
+ $(
+ _profile_scope.text(str::as_bytes($text));
+ )?
+ }
+}
+
+/// Define the main frame marker, typically placed after swap_buffers or similar.
+#[macro_export]
+macro_rules! tracy_frame_marker {
+ () => {
+ unsafe {
+ $crate::profiler::MARK_FRAME(std::ptr::null())
+ }
+ }
+}
+
+/// Define start of an explicit frame marker, typically used for sub-frames.
+#[macro_export]
+macro_rules! tracy_begin_frame {
+ ($name:expr) => {
+ unsafe {
+ $crate::profiler::MARK_FRAME_START(concat!($name, "\0").as_ptr())
+ }
+ }
+}
+
+/// Define end of an explicit frame marker, typically used for sub-frames.
+#[macro_export]
+macro_rules! tracy_end_frame {
+ ($name:expr) => {
+ unsafe {
+ $crate::profiler::MARK_FRAME_END(concat!($name, "\0").as_ptr())
+ }
+ }
+}
+
+#[macro_export]
+macro_rules! tracy_plot {
+ ($name:expr, $value:expr) => {
+ unsafe {
+ $crate::profiler::EMIT_PLOT(concat!($name, "\0").as_ptr(), $value)
+ }
+ }
+}
+
+// Provide a name for this thread to the profiler
+pub fn register_thread_with_profiler(_: String) {
+ // TODO(gw): Add support for passing this to the tracy api
+}