پشتیبانی پایتون از پروفایل‌گیر perf لینوکس

نویسنده:

پابلو گالیندو

پروفایل‌گیر perf لینوکس ابزاری بسیار قدرتمند است که به شما امکان می‌دهد برنامه‌ی خود را پروفایل کنید و اطلاعاتی درباره‌ی عملکرد آن به دست آورید. perf همچنین اکوسیستم بسیار پویایی از ابزارها دارد که به تحلیل داده‌هایی که تولید می‌کند کمک می‌کنند.

مشکل اصلی استفاده از پروفایل‌گیر (profiler) perf در برنامه‌های پایتونی این است که perf فقط اطلاعاتی درباره‌ی نمادهای بومی دریافت می‌کند، یعنی نام توابع و رویه‌هایی که به زبان C نوشته شده‌اند. این بدان معناست که نام توابع پایتونی و نام پرونده‌های آن‌ها در کد شما، در خروجی perf ظاهر نخواهند شد.

از پایتون 3.12، مفسر می‌تواند در حالت ویژه‌ای اجرا شود که به توابع پایتون اجازه می‌دهد در خروجی پروفایل‌گیر perf ظاهر شوند. هنگامی که این حالت فعال باشد، مفسر پیش از اجرای هر تابع پایتون، یک قطعه‌کد کوچک را که در لحظه کامپایل می‌شود، درج می‌کند و با استفاده از perf map files، رابطه بین این قطعه‌کد و تابع پایتون مرتبط را به perf می‌آموزد.

توجه

پشتیبانی از پروفایل‌گیر perf در حال حاضر فقط برای لینوکس در معماری‌های منتخب در دسترس است. برای اینکه ببینید آیا سیستم شما پشتیبانی می‌شود، خروجی مرحله‌ی ساخت configure یا خروجی python -m sysconfig | grep HAVE_PERF_TRAMPOLINE را بررسی کنید.

برای مثال، اسکریپت زیر را در نظر بگیرید:

def foo(n):
    result = 0
    for _ in range(n):
        result += 1
    return result

def bar(n):
    foo(n)

def baz(n):
    bar(n)

if __name__ == "__main__":
    baz(1000000)

می‌توانیم perf را برای نمونه‌برداری از ردگیری‌های پشته‌ی CPU با نرخ ۹۹۹۹ هرتز اجرا کنیم:

$ perf record -F 9999 -g -o perf.data python my_script.py

سپس می‌توانید از perf report برای تحلیل داده‌ها استفاده کنید:

$ perf report --stdio -n -g

# Children      Self       Samples  Command     Shared Object       Symbol
# ........  ........  ............  ..........  ..................  ..........................................
#
    91.08%     0.00%             0  python.exe  python.exe          [.] _start
            |
            ---_start
            |
                --90.71%--__libc_start_main
                        Py_BytesMain
                        |
                        |--56.88%--pymain_run_python.constprop.0
                        |          |
                        |          |--56.13%--_PyRun_AnyFileObject
                        |          |          _PyRun_SimpleFileObject
                        |          |          |
                        |          |          |--55.02%--run_mod
                        |          |          |          |
                        |          |          |           --54.65%--PyEval_EvalCode
                        |          |          |                     _PyEval_EvalFrameDefault
                        |          |          |                     PyObject_Vectorcall
                        |          |          |                     _PyEval_Vector
                        |          |          |                     _PyEval_EvalFrameDefault
                        |          |          |                     PyObject_Vectorcall
                        |          |          |                     _PyEval_Vector
                        |          |          |                     _PyEval_EvalFrameDefault
                        |          |          |                     PyObject_Vectorcall
                        |          |          |                     _PyEval_Vector
                        |          |          |                     |
                        |          |          |                     |--51.67%--_PyEval_EvalFrameDefault
                        |          |          |                     |          |
                        |          |          |                     |          |--11.52%--_PyLong_Add
                        |          |          |                     |          |          |
                        |          |          |                     |          |          |--2.97%--_PyObject_Malloc
...

همان‌طور که می‌بینید، توابع پایتون در خروجی نمایش داده نمی‌شوند و تنها _PyEval_EvalFrameDefault (تابعی که بایت‌کد پایتون را ارزیابی می‌کند) نمایش داده می‌شود. متأسفانه این موضوع چندان مفید نیست، زیرا تمام توابع پایتون برای ارزیابی بایت‌کد از یک تابع C یکسان استفاده می‌کنند؛ بنابراین نمی‌توانیم بدانیم کدام تابع پایتون با کدام تابع ارزیابی بایت‌کد متناظر است.

در عوض، اگر همان آزمایش را با فعال بودن پشتیبانی perf اجرا کنیم، به این نتیجه می‌رسیم:

$ perf report --stdio -n -g

# Children      Self       Samples  Command     Shared Object       Symbol
# ........  ........  ............  ..........  ..................  .....................................................................
#
    90.58%     0.36%             1  python.exe  python.exe          [.] _start
            |
            ---_start
            |
                --89.86%--__libc_start_main
                        Py_BytesMain
                        |
                        |--55.43%--pymain_run_python.constprop.0
                        |          |
                        |          |--54.71%--_PyRun_AnyFileObject
                        |          |          _PyRun_SimpleFileObject
                        |          |          |
                        |          |          |--53.62%--run_mod
                        |          |          |          |
                        |          |          |           --53.26%--PyEval_EvalCode
                        |          |          |                     py::<module>:/src/script.py
                        |          |          |                     _PyEval_EvalFrameDefault
                        |          |          |                     PyObject_Vectorcall
                        |          |          |                     _PyEval_Vector
                        |          |          |                     py::baz:/src/script.py
                        |          |          |                     _PyEval_EvalFrameDefault
                        |          |          |                     PyObject_Vectorcall
                        |          |          |                     _PyEval_Vector
                        |          |          |                     py::bar:/src/script.py
                        |          |          |                     _PyEval_EvalFrameDefault
                        |          |          |                     PyObject_Vectorcall
                        |          |          |                     _PyEval_Vector
                        |          |          |                     py::foo:/src/script.py
                        |          |          |                     |
                        |          |          |                     |--51.81%--_PyEval_EvalFrameDefault
                        |          |          |                     |          |
                        |          |          |                     |          |--13.77%--_PyLong_Add
                        |          |          |                     |          |          |
                        |          |          |                     |          |          |--3.26%--_PyObject_Malloc

چگونه پشتیبانی از پروفایل‌گیری perf را فعال کنیم

می‌توان پشتیبانی از پروفایل‌گیری perf را یا از ابتدا با استفاده از متغیر محیطی PYTHONPERFSUPPORT یا گزینه‌ی -X perf، یا به‌صورت پویا با استفاده از sys.activate_stack_trampoline() و sys.deactivate_stack_trampoline() فعال کرد.

توابع sys بر گزینه‌ی -X اولویت دارند، گزینه‌ی -X بر متغیر محیطی اولویت دارد.

مثال، با استفاده از متغیر محیطی:

$ PYTHONPERFSUPPORT=1 perf record -F 9999 -g -o perf.data python my_script.py
$ perf report -g -i perf.data

مثال، با استفاده از گزینه -X:

$ perf record -F 9999 -g -o perf.data python -X perf my_script.py
$ perf report -g -i perf.data

مثال، استفاده از APIهای sys در پرونده example.py:

import sys

sys.activate_stack_trampoline("perf")
do_profiled_stuff()
sys.deactivate_stack_trampoline()

non_profiled_stuff()

...سپس:

$ perf record -F 9999 -g -o perf.data python ./example.py
$ perf report -g -i perf.data

چگونه بهترین نتایج را به دست آوریم

برای رسیدن به بهترین نتایج، پایتون باید با CFLAGS="-fno-omit-frame-pointer -mno-omit-leaf-frame-pointer" کامپایل شود، زیرا این کار به ابزارهای پروفایل‌گیری اجازه می‌دهد تا فقط با استفاده از اشاره‌گر فریم (frame pointer) و بدون اتکا به اطلاعات اشکال‌زدایی DWARF، پشته را باز کنند (unwind). دلیل این امر آن است که چون کدی که برای امکان‌پذیر کردن پشتیبانی از perf میان‌گذاری می‌شود به‌صورت پویا تولید می‌شود، هیچ اطلاعات اشکال‌زدایی DWARF برای آن در دسترس نیست.

می‌توانید با اجرای دستور زیر بررسی کنید که آیا سیستم شما با این پرچم کامپایل شده است:

$ python -m sysconfig | grep 'no-omit-frame-pointer'

اگر هیچ خروجی نمی‌بینید، به این معناست که مفسر شما با اشاره‌گرهای فریم (frame pointers) کامپایل نشده است و بنابراین ممکن است نتواند توابع پایتون را در خروجی perf نمایش دهد.

چگونه بدون اشاره‌گرهای فریم کار کنیم

اگر با مفسر پایتونی کار می‌کنید که بدون اشاره‌گرهای فریم کامپایل شده است، همچنان می‌توانید از پروفایل‌گیر perf استفاده کنید، اما سربار آن کمی بیشتر خواهد بود، زیرا پایتون باید برای هر فراخوانی تابع پایتون، اطلاعات باز کردن پشته (unwinding) را در لحظه تولید کند. علاوه بر این، perf برای پردازش داده‌ها زمان بیشتری نیاز خواهد داشت، زیرا باید از اطلاعات اشکال‌زدایی DWARF برای باز کردن پشته استفاده کند و این فرآیندی کند است.

برای فعال کردن این حالت، می‌توانید از متغیر محیطی PYTHON_PERF_JIT_SUPPORT یا گزینه‌ی -X perf_jit استفاده کنید، که حالت JIT را برای پروفایل‌گیر perf فعال می‌کند.

توجه

به دلیل وجود یک اشکال در ابزار perf، فقط نسخه‌های perf بالاتر از v6.8 با حالت JIT کار می‌کنند. این اصلاحیه همچنین به نسخه v6.7.2 این ابزار نیز بک‌پورت شده است.

توجه داشته باشید که هنگام بررسی نسخه‌ی ابزار perf (که این کار را می‌توان با اجرای perf version انجام داد)، باید در نظر داشته باشید که برخی توزیع‌ها شماره‌های نسخه‌ی سفارشی شامل نویسه‌ی - را اضافه می‌کنند. این بدان معناست که perf 6.7-3 لزوماً perf 6.7.3 نیست.

هنگام استفاده از حالت JIT در perf، پیش از آنکه بتوانید perf report را اجرا کنید، به یک مرحله اضافی نیاز دارید. باید دستور perf inject را فراخوانی کنید تا اطلاعات JIT را به پرونده perf.data وارد کنید.:

$ perf record -F 9999 -g -k 1 --call-graph dwarf -o perf.data python -Xperf_jit my_script.py
$ perf inject -i perf.data --jit --output perf.jit.data
$ perf report -g -i perf.jit.data

یا با استفاده از متغیر محیطی:

$ PYTHON_PERF_JIT_SUPPORT=1 perf record -F 9999 -g --call-graph dwarf -o perf.data python my_script.py
$ perf inject -i perf.data --jit --output perf.jit.data
$ perf report -g -i perf.jit.data

فرمان perf inject --jit پرونده perf.data را می‌خواند، به‌طور خودکار پرونده برون‌ریزی perf را که پایتون ایجاد می‌کند (در /tmp/perf-$PID.dump) دریافت می‌کند و سپس perf.jit.data را ایجاد می‌کند که همه‌ی اطلاعات JIT را با یکدیگر ادغام می‌کند. همچنین باید تعداد زیادی پرونده jitted-XXXX-N.so در پوشه‌ی جاری ایجاد کند که تصویرهای ELF برای همه‌ی ترمپولین‌های JIT (JIT trampolines) ایجادشده توسط پایتون هستند.

هشدار

هنگام استفاده از --call-graph dwarf، ابزار perf تصویرهای فوری از پشته‌ی فرایندی که پروفایل‌گیری می‌شود می‌گیرد و اطلاعات را در پرونده perf.data ذخیره می‌کند. به‌طور پیش‌فرض، اندازه‌ی برون‌ریزی پشته (stack dump) ۸۱۹۲ بایت است، اما می‌توانید اندازه را با قرار دادن آن پس از یک ویرگول، مانند --call-graph dwarf,16384، تغییر دهید.

اندازه‌ی برون‌ریزی پشته مهم است، زیرا اگر اندازه بیش از حد کوچک باشد، perf نمی‌تواند پشته را باز کند و خروجی ناقص خواهد بود. از طرف دیگر، اگر اندازه بیش از حد بزرگ باشد، perf نمی‌تواند به دفعات دلخواه از فرایند نمونه‌برداری کند، زیرا سربار بیشتر خواهد بود.

اندازه‌ی پشته به‌ویژه هنگام پروفایل‌گیری کد پایتون کامپایل‌شده با سطح‌های بهینه‌سازی پایین (مانند -O0) اهمیت دارد، زیرا این ساخت‌ها معمولاً فریم‌های پشته بزرگ‌تری دارند. اگر پایتون را با -O0 کامپایل می‌کنید و توابع پایتون را در خروجی پروفایل‌گیری خود نمی‌بینید، سعی کنید اندازه‌ی برون‌ریزی پشته را به ۶۵۵۲۸ بایت (حداکثر) افزایش دهید:

$ perf record -F 9999 -g -k 1 --call-graph dwarf,65528 -o perf.data python -Xperf_jit my_script.py

پرچم‌های مختلف کامپایل می‌توانند به‌طور قابل‌توجهی بر اندازه‌های پشته تأثیر بگذارند:

• ساخت‌های با -O0 معمولاً فریم‌های پشته بسیار بزرگ‌تری نسبت به ساخت‌های با -O1 یا بالاتر دارند

• افزودن بهینه‌سازی‌ها (-O1، -O2 و غیره) معمولاً اندازه پشته را کاهش می‌دهد

• اشاره‌گرهای فریم (-fno-omit-frame-pointer) معمولاً باز شدن قابل‌اطمینان‌تر پشته را فراهم می‌کنند