เหตุการณ์การติดตามที่กำหนดเองในโค้ดแบบเนทีฟ

Android 6.0 (API ระดับ 23) ขึ้นไปรองรับ API การติดตามแบบเนทีฟ trace.h เพื่อเขียนเหตุการณ์การติดตามลงในบัฟเฟอร์ของระบบ ซึ่งคุณสามารถวิเคราะห์ได้โดยใช้ Perfetto หรือ systrace กรณีการใช้งานทั่วไปสำหรับ API นี้รวมถึงการสังเกตเวลาที่บล็อกโค้ดหนึ่งๆ ใช้ในการดำเนินการ และการเชื่อมโยงบล็อกโค้ดกับลักษณะการทำงานของระบบที่ไม่พึงประสงค์

หมายเหตุ: ในอุปกรณ์และโปรแกรมจำลองที่ใช้ระดับ API 27 และต่ำกว่า หากมีหน่วยความจำไม่เพียงพอหรือหน่วยความจำมีการกระจาย Fragment มากเกินไป คุณจะได้รับข้อความต่อไปนี้ Atrace could not allocate enough memory to record a trace หากเกิดกรณีนี้ขึ้นและการบันทึกของคุณมีชุดข้อมูลที่ไม่สมบูรณ์ คุณควรปิดกระบวนการเบื้องหลังหรือรีสตาร์ทอุปกรณ์หรือโปรแกรมจำลอง

หากต้องการกำหนดเหตุการณ์ที่กำหนดเองซึ่งเกิดขึ้นในโค้ดแบบเนทีฟภายในแอปหรือเกม ให้ทำตามขั้นตอนต่อไปนี้

  1. กำหนดตัวชี้ฟังก์ชันสำหรับฟังก์ชัน ATrace ที่คุณใช้เพื่อบันทึกเหตุการณ์ที่กำหนดเองภายในแอปหรือเกม ดังที่แสดงในข้อมูลโค้ดต่อไปนี้

    #include <android/trace.h>
    #include <dlfcn.h>
    
    void *(*ATrace_beginSection) (const char* sectionName);
    void *(*ATrace_endSection) (void);
    
    typedef void *(*fp_ATrace_beginSection) (const char* sectionName);
    typedef void *(*fp_ATrace_endSection) (void);
  2. โหลดสัญลักษณ์ ATrace ขณะรันไทม์ ดังที่แสดงในข้อมูลโค้ดต่อไปนี้ โดยปกติแล้ว คุณจะดำเนินการตามขั้นตอนนี้ในตัวสร้างออบเจ็กต์

    // Retrieve a handle to libandroid.
    void *lib = dlopen("libandroid.so", RTLD_NOW | RTLD_LOCAL);
    
    // Access the native tracing functions.
    if (lib != NULL) {
        // Use dlsym() to prevent crashes on devices running Android 5.1
        // (API level 22) or lower.
        ATrace_beginSection = reinterpret_cast<fp_ATrace_beginSection>(
            dlsym(lib, "ATrace_beginSection"));
        ATrace_endSection = reinterpret_cast<fp_ATrace_endSection>(
            dlsym(lib, "ATrace_endSection"));
    }

    ข้อควรระวัง: เพื่อความปลอดภัย ให้รวมการเรียกไปยัง dlopen() ไว้ในแอปหรือเกมเวอร์ชันแก้ไขข้อบกพร่องเท่านั้น

    หมายเหตุ: หากต้องการให้การสนับสนุนการติดตามย้อนกลับไปถึง Android 4.3 (ระดับ API 18) คุณสามารถใช้ Java Native Interface เพื่อเรียก Trace.beginSection และ Trace.endSection รอบโค้ดที่ติดตาม หรือติดตามการเรียกจากโค้ดที่มีการจัดการตามที่แสดงในกำหนดเหตุการณ์ที่กำหนดเอง

  3. เรียกใช้ ATrace_beginSection() และ ATrace_endSection() ที่จุดเริ่มต้นและจุดสิ้นสุดของเหตุการณ์ที่กำหนดเองตามลำดับ ดังนี้

    #include <android/trace.h>
    
    char *customEventName = new char[32];
    sprintf(customEventName, "User tapped %s button", buttonName);
    
    ATrace_beginSection(customEventName);
    // Your app or game's response to the button being pressed.
    ATrace_endSection();

    หมายเหตุ: เมื่อคุณเรียกใช้ ATrace_beginSection() หลายครั้ง การเรียกใช้ ATrace_endSection() จะสิ้นสุดเฉพาะเมธอด ATrace_beginSection() ที่เรียกใช้ล่าสุดเท่านั้น ดังนั้นสำหรับการเรียกที่ซ้อนกัน โปรดตรวจสอบว่าคุณจับคู่การเรียกแต่ละรายการกับ ATrace_beginSection() ด้วยการเรียก ATrace_endSection() อย่างถูกต้อง

    นอกจากนี้ คุณไม่สามารถเรียกใช้ ATrace_beginSection() ในชุดข้อความหนึ่งและสิ้นสุดจากอีกชุดข้อความหนึ่งได้ คุณต้องเรียกใช้ทั้ง 2 ฟังก์ชันจากชุดข้อความเดียวกัน

เคล็ดลับเพื่อความสะดวกสบาย

เคล็ดลับต่อไปนี้เป็นแบบไม่บังคับ แต่อาจช่วยให้วิเคราะห์โค้ดแบบเนทีฟได้ง่ายขึ้น

ติดตามทั้งฟังก์ชัน

เมื่อใช้เครื่องมือวัดสแต็กการเรียกใช้หรือเวลาของฟังก์ชัน คุณอาจพบว่าการติดตามทั้งฟังก์ชันมีประโยชน์ คุณสามารถใช้มาโคร ATRACE_CALL() เพื่อให้การติดตามประเภทนี้ตั้งค่าได้ง่ายขึ้น นอกจากนี้ มาโครดังกล่าวยังช่วยให้คุณข้ามการสร้างบล็อก try และ catch สำหรับกรณีที่ฟังก์ชันที่ติดตามอาจแสดงข้อยกเว้นหรือเรียกใช้ return ก่อนกำหนดได้

หากต้องการสร้างมาโครเพื่อติดตามทั้งฟังก์ชัน ให้ทำตามขั้นตอนต่อไปนี้

  1. กำหนดมาโคร:

    #define ATRACE_NAME(name) ScopedTrace ___tracer(name)
    
    // ATRACE_CALL is an ATRACE_NAME that uses the current function name.
    #define ATRACE_CALL() ATRACE_NAME(__FUNCTION__)
    
    class ScopedTrace {
      public:
        inline ScopedTrace(const char *name) {
          ATrace_beginSection(name);
        }
    
        inline ~ScopedTrace() {
          ATrace_endSection();
        }
    };
  2. เรียกใช้มาโครภายในฟังก์ชันที่ต้องการติดตาม ดังนี้

    void myExpensiveFunction() {
      ATRACE_CALL();
      // Code that you want to trace.
    }

ตั้งชื่อชุดข้อความ

คุณตั้งชื่อให้แต่ละชุดข้อความที่เกิดเหตุการณ์ได้ ดังที่แสดงในข้อมูลโค้ดต่อไปนี้ ขั้นตอนนี้ช่วยให้ระบุชุดข้อความที่เกี่ยวข้องกับการดำเนินการที่เฉพาะเจาะจงภายในเกมได้ง่ายขึ้น

#include <pthread.h>

static void *render_scene(void *parm) {
    // Code for preparing your app or game's visual components.
}

static void *load_main_menu(void *parm) {
    // Code that executes your app or game's main logic.
}

void init_threads() {
    pthread_t render_thread, main_thread;

    pthread_create(&render_thread, NULL, render_scene, NULL);
    pthread_create(&main_thread, NULL, load_main_menu, NULL);

    pthread_setname_np(render_thread, "MyRenderer");
    pthread_setname_np(main_thread, "MyMainMenu");
}