├── .gitignore ├── Assets ├── Plugins │ └── Android │ │ └── libs │ │ ├── arm64-v8a │ │ └── libsystrace_unity.so │ │ ├── armeabi-v7a │ │ └── libsystrace_unity.so │ │ └── x86 │ │ └── libsystrace_unity.so └── Scripts │ └── SystracePlugin.cs ├── LICENSE ├── README.md ├── screenshot.png └── src ├── jni ├── Android.mk └── Application.mk └── src ├── IUnityInterface.h ├── IUnityProfilerCallbacks.h └── SystraceUnity.cpp /.gitignore: -------------------------------------------------------------------------------- 1 | /src/libs/ 2 | /src/obj/ 3 | -------------------------------------------------------------------------------- /Assets/Plugins/Android/libs/arm64-v8a/libsystrace_unity.so: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Over17/UnitySystracePlugin/613d2b3c70ca3f2ba3c372b2c57ab780195f0d7b/Assets/Plugins/Android/libs/arm64-v8a/libsystrace_unity.so -------------------------------------------------------------------------------- /Assets/Plugins/Android/libs/armeabi-v7a/libsystrace_unity.so: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Over17/UnitySystracePlugin/613d2b3c70ca3f2ba3c372b2c57ab780195f0d7b/Assets/Plugins/Android/libs/armeabi-v7a/libsystrace_unity.so -------------------------------------------------------------------------------- /Assets/Plugins/Android/libs/x86/libsystrace_unity.so: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Over17/UnitySystracePlugin/613d2b3c70ca3f2ba3c372b2c57ab780195f0d7b/Assets/Plugins/Android/libs/x86/libsystrace_unity.so -------------------------------------------------------------------------------- /Assets/Scripts/SystracePlugin.cs: -------------------------------------------------------------------------------- 1 | using UnityEngine; 2 | using System.Runtime.InteropServices; 3 | 4 | public class SystracePlugin : MonoBehaviour 5 | { 6 | #if UNITY_ANDROID && !UNITY_EDITOR 7 | [DllImport("systrace_unity")] 8 | private static extern void InitSystraceUnityPlugin(); 9 | 10 | void Start () 11 | { 12 | InitSystraceUnityPlugin(); 13 | } 14 | #endif 15 | } 16 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Unity Systrace Plugin for Android 2 | ![Systrace screenshot](screenshot.png) 3 | 4 | Unity profiler has a nice timeline view with named sections. It may be very helpful to have these sections displayed on a system-wide trace collected from an Android device using systrace tool, as it gives information about scheduling, CPU status, other processes running in the system etc. 5 | In version 2018.2, Unity introduced a profiler native plugin API; used together with Android tracing API, it allows to develop an integration plugin. 6 | 7 | **IMPORTANT NOTE**: In Unity 2019.1, native systrace support has been introduced (with same functionality as this plugin). It means that starting from 2019.1, there is no need to use this plugin - everything should just work out of the box. 8 | 9 | Few comments on the implementation: 10 | - Android tracing API works on Marshmallow and later; but since Unity supports older devices, I used dynamic linking. On older devices, a warning is printed, and the Unity profiler integration is disabled. 11 | - To load a native plugin in Android, Unity requires a P/Invoke call to an imported native method. Because of this a script was added; make sure to attach it to a game object in your scene! 12 | - Due to optimization (the plugin checks if systrace is connected every frame, and if it is - registers callbacks for profiler markers; if no systrace is connected - no callbacks are happening for every profiler marker) Unity markers can show up from the next frame after starting the systrace capture. 13 | 14 | ## System Requirements 15 | - Unity 2018.2 or later (NOTE: systrace support is integrated into Unity 2019.1, so starting from this version there is no need to use this plugin) 16 | - Android device with Android 6.0 Marshmallow or later 17 | 18 | ## Usage 19 | 1. Copy the contents of `Assets` directory to your project (it will be easier if you retain the path, then the plugin importer will set CPU architecture for the .so's correctly) 20 | 2. Attach the `Assets/Scripts/SystracePlugin.cs` script to a game object of your choice in your first scene to make sure the plugin is loaded as early as possible 21 | 3. Enjoy 22 | 23 | ## How to Build 24 | Run `ndk-build` in `src/` directory of the repo. Grab the libraries in `src/libs/` 25 | 26 | ## Useful Links 27 | - https://developer.android.com/studio/command-line/systrace 28 | - https://developer.android.com/ndk/reference/group/tracing 29 | 30 | ## License 31 | Licensed under Apache 2.0. 32 | 33 | Unity Native Plugin API headers licensed under Unity Companion License, please see the header contents for details. 34 | -------------------------------------------------------------------------------- /screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Over17/UnitySystracePlugin/613d2b3c70ca3f2ba3c372b2c57ab780195f0d7b/screenshot.png -------------------------------------------------------------------------------- /src/jni/Android.mk: -------------------------------------------------------------------------------- 1 | include $(CLEAR_VARS) 2 | LOCAL_PATH := $(NDK_PROJECT_PATH) 3 | LOCAL_MODULE := systrace_unity 4 | LOCAL_CFLAGS := -Wall -Werror 5 | 6 | LOCAL_SRC_FILES := src/SystraceUnity.cpp 7 | LOCAL_LDLIBS += -landroid -llog 8 | 9 | include $(BUILD_SHARED_LIBRARY) 10 | -------------------------------------------------------------------------------- /src/jni/Application.mk: -------------------------------------------------------------------------------- 1 | APP_ABI := armeabi-v7a arm64-v8a x86 2 | APP_PLATFORM := android-26 3 | APP_OPTIM := release 4 | -------------------------------------------------------------------------------- /src/src/IUnityInterface.h: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Over17/UnitySystracePlugin/613d2b3c70ca3f2ba3c372b2c57ab780195f0d7b/src/src/IUnityInterface.h -------------------------------------------------------------------------------- /src/src/IUnityProfilerCallbacks.h: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Over17/UnitySystracePlugin/613d2b3c70ca3f2ba3c372b2c57ab780195f0d7b/src/src/IUnityProfilerCallbacks.h -------------------------------------------------------------------------------- /src/src/SystraceUnity.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | 5 | #include "IUnityInterface.h" 6 | #include "IUnityProfilerCallbacks.h" 7 | 8 | static IUnityProfilerCallbacks* s_UnityProfilerCallbacks = NULL; 9 | 10 | typedef void (*fp_ATrace_beginSection) (const char* sectionName); 11 | typedef void (*fp_ATrace_endSection) (); 12 | typedef bool (*fp_ATrace_isEnabled) (); 13 | 14 | static fp_ATrace_beginSection ATrace_beginSection; 15 | static fp_ATrace_endSection ATrace_endSection; 16 | static fp_ATrace_isEnabled ATrace_isEnabled; 17 | 18 | static bool s_isCapturing = false; 19 | static void* s_libandroid; 20 | const UnityProfilerMarkerDesc* s_DefaultMarkerDesc = NULL; 21 | 22 | static void UNITY_INTERFACE_API SystraceEventCallback(const UnityProfilerMarkerDesc* eventDesc, UnityProfilerMarkerEventType eventType, unsigned short eventDataCount, const UnityProfilerMarkerData* eventData, void* userData) 23 | { 24 | if (!ATrace_isEnabled()) 25 | return; 26 | 27 | switch (eventType) 28 | { 29 | case kUnityProfilerMarkerEventTypeBegin: 30 | { 31 | if (eventDataCount > 1 && eventDesc == s_DefaultMarkerDesc) 32 | { 33 | // Profiler.Default marker emits UTF16 string as the second metadata parameter. 34 | // For simplicity we slice UTF16 data to char. 35 | uint32_t size = eventData[1].size; 36 | const uint16_t* first = static_cast(eventData[1].ptr); 37 | const uint16_t* last = reinterpret_cast(static_cast(eventData[1].ptr) + size); 38 | const int length = size / 2 + 1; 39 | char newName[length]; 40 | 41 | for (int i = 0; first < last && i < length; ++first) 42 | { 43 | newName[i++] = static_cast(*first); 44 | } 45 | newName[length - 1] = 0; 46 | ATrace_beginSection(newName); 47 | } 48 | else 49 | { 50 | ATrace_beginSection(eventDesc->name); 51 | } 52 | 53 | break; 54 | } 55 | case kUnityProfilerMarkerEventTypeEnd: 56 | { 57 | ATrace_endSection(); 58 | break; 59 | } 60 | } 61 | } 62 | 63 | static void UNITY_INTERFACE_API SystraceCreateEventCallback(const UnityProfilerMarkerDesc* eventDesc, void* userData) 64 | { 65 | // Special handling for Profiler.Default markers 66 | if (!s_DefaultMarkerDesc) 67 | { 68 | if (!strcmp(eventDesc->name, "Profiler.Default")) 69 | s_DefaultMarkerDesc = eventDesc; 70 | } 71 | 72 | s_UnityProfilerCallbacks->RegisterMarkerEventCallback(eventDesc, SystraceEventCallback, NULL); 73 | } 74 | 75 | // Every frame check if the status of systrace client has changed 76 | // If client was connected, register marker callback 77 | // If it was disconnecter, unregister the callbacks to reduce the overhead 78 | static void UNITY_INTERFACE_API SystraceFrameCallback(void* userData) 79 | { 80 | bool isCapturing = ATrace_isEnabled(); 81 | if (isCapturing != s_isCapturing) 82 | { 83 | s_isCapturing = isCapturing; 84 | if (isCapturing) 85 | { 86 | s_UnityProfilerCallbacks->RegisterCreateMarkerCallback(SystraceCreateEventCallback, NULL); 87 | } 88 | else 89 | { 90 | s_UnityProfilerCallbacks->UnregisterCreateMarkerCallback(SystraceCreateEventCallback, NULL); 91 | s_UnityProfilerCallbacks->UnregisterMarkerEventCallback(NULL, SystraceEventCallback, NULL); 92 | } 93 | } 94 | } 95 | 96 | extern "C" void UNITY_INTERFACE_API InitSystraceUnityPlugin() 97 | { 98 | //__android_log_print(ANDROID_LOG_DEBUG, "SystraceUnity", "Unity systrace integration plugin init finished"); 99 | } 100 | 101 | extern "C" void UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API UnityPluginLoad(IUnityInterfaces* unityInterfaces) 102 | { 103 | // Doing dynamic linking because native trace API is supported only in Android M+ 104 | s_libandroid = dlopen("libandroid.so", RTLD_NOW | RTLD_LOCAL); 105 | if (!s_libandroid) 106 | { 107 | __android_log_print(ANDROID_LOG_WARN, "SystraceUnity", "Unity systrace integration plugin disabled: failed to load libandroid.so"); 108 | return; 109 | } 110 | 111 | ATrace_isEnabled = reinterpret_cast(dlsym(s_libandroid, "ATrace_isEnabled")); 112 | ATrace_beginSection = reinterpret_cast(dlsym(s_libandroid, "ATrace_beginSection")); 113 | ATrace_endSection = reinterpret_cast(dlsym(s_libandroid, "ATrace_endSection")); 114 | 115 | if (ATrace_isEnabled && ATrace_beginSection && ATrace_endSection) 116 | { 117 | // Functions loaded correctly 118 | __android_log_print(ANDROID_LOG_INFO, "SystraceUnity", "Enabling Unity systrace integration plugin"); 119 | 120 | s_UnityProfilerCallbacks = unityInterfaces->Get(); 121 | s_UnityProfilerCallbacks->RegisterFrameCallback(SystraceFrameCallback, NULL); 122 | } 123 | else 124 | { 125 | __android_log_print(ANDROID_LOG_WARN, "SystraceUnity", "Unity systrace integration plugin disabled: failed to load native tracing API"); 126 | } 127 | } 128 | 129 | extern "C" void UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API UnityPluginUnload() 130 | { 131 | if (s_libandroid != NULL) 132 | { 133 | if (ATrace_isEnabled && ATrace_beginSection && ATrace_endSection) 134 | { 135 | s_UnityProfilerCallbacks->UnregisterFrameCallback(SystraceFrameCallback, NULL); 136 | s_UnityProfilerCallbacks->UnregisterCreateMarkerCallback(SystraceCreateEventCallback, NULL); 137 | s_UnityProfilerCallbacks->UnregisterMarkerEventCallback(NULL, SystraceEventCallback, NULL); 138 | } 139 | 140 | dlclose(s_libandroid); 141 | } 142 | } 143 | --------------------------------------------------------------------------------