نام (NAME)

gprof - نمایش داده‌های پروفایل گراف فراخوانی

خلاصه دستور (SYNOPSIS)

gprof [ -[abcDhilLrsTvwxyz] ] [ -[ABCeEfFJnNOpPqQRStZ][name] ]
[ -I dirs ] [ -d[num] ] [ -k from/to ]
[ -m min-count ] [ -R map_file ] [ -t table-length ]
[ --[no-]annotated-source[=name] ]
[ --[no-]exec-counts[=name] ]
[ --[no-]flat-profile[=name] ] [ --[no-]graph[=name] ]
[ --[no-]time=name] [ --all-lines ] [ --brief ]
[ --debug[=level] ] [ --function-ordering ]
[ --file-ordering map_file ] [ --directory-path=dirs ]
[ --display-unused-functions ] [ --file-format=name ]
[ --file-info ] [ --help ] [ --line ] [ --inline-file-names ]
[ --min-count=n ] [ --no-static ] [ --print-path ]
[ --separate-files ] [ --static-call-graph ] [ --sum ]
[ --table-length=len ] [ --traditional ] [ --version ]
[ --width=n ] [ --ignore-non-functions ]
[ --demangle[=STYLE] ] [ --no-demangle ]
[--external-symbol-table=name]
[ image-file ] [ profile-file ... ].SH "توضیحات (DESCRIPTION)" دستور "gprof" یک نمایهٔ اجرایی از برنامه‌های C، Pascal یا Fortran77 تولید می‌کند. اثر روتین‌های فراخوانی‌شده در نمایهٔ هر فراخواننده لحاظ می‌شود. داده‌های نمایه از فایل نمایهٔ نمودار فراخوانی (gmon.out به‌طور پیش‌فرض) که توسط برنامه‌های کامپایل‌شده با گزینهٔ -pg در "cc"، "pc" و "f77" ایجاد می‌شود، گرفته می‌شود. گزینهٔ -pg همچنین نسخه‌هایی از روتین‌های کتابخانه را که برای نمایه‌سازی کامپایل شده‌اند پیوند می‌دهد. ابزار "Gprof" فایل شیء داده‌شده (پیش‌فرض "a.out" است) را می‌خواند و رابطهٔ میان جدول نمادهای آن و نمایهٔ نمودار فراخوانی را از gmon.out برقرار می‌سازد. اگر بیش از یک فایل نمایه مشخص شده باشد، خروجی "gprof" مجموع اطلاعات نمایه در فایل‌های نمایهٔ ارائه‌شده را نشان می‌دهد.

ابزار "Gprof" مقدار زمان صرف‌شده در هر روتین را محاسبه می‌کند. سپس، این زمان‌ها در امتداد یال‌های نمودار فراخوانی منتشر می‌شوند. چرخه‌ها شناسایی شده و فراخوانی‌ها به درون یک چرخه، در زمان آن چرخه سهیم می‌شوند.

چندین حالت خروجی از این تحلیل در دسترس است.

بخش flat profile (نمایهٔ مسطح) نشان می‌دهد که برنامهٔ شما چه مقدار زمان در هر تابع صرف کرده است و آن تابع چند بار فراخوانی شده است. اگر صرفاً می‌خواهید بدانید کدام توابع بیشترین چرخه‌های پردازشی را مصرف می‌کنند، در اینجا به‌طور خلاصه بیان شده است.

بخش call graph (نمودار فراخوانی) برای هر تابع نشان می‌دهد که کدام توابع آن را فراخوانی کرده‌اند، چه توابع دیگری توسط آن فراخوانی شده‌اند، و چند بار. همچنین تخمینی از میزان زمان صرف‌شده در زیرروال‌های هر تابع ارائه می‌دهد. این امر می‌تواند مکان‌هایی را پیشنهاد دهد که شاید بخواهید فراخوانی‌های تابعی را که زمان زیادی می‌برند حذف کنید.

فهرست annotated source (منبع حاشیه‌نویسی‌شده) رونوشتی از کد منبع برنامه است که با تعداد دفعات اجرای هر خط از برنامه برچسب‌گذاری شده است.

گزینه‌ها (OPTIONS)

این گزینه‌ها مشخص می‌کنند که "gprof" کدام‌یک از چندین قالب خروجی را باید تولید کند.

بسیاری از این گزینه‌ها یک symspec اختیاری دریافت می‌کنند تا توابعی را که باید گنجانده یا مستثنی شوند مشخص کنند. این گزینه‌ها را می‌توان چندین بار، با symspecهای متفاوت، برای گنجاندن یا حذف کردن مجموعه‌هایی از نمادها مشخص کرد.

مشخص کردن هر یک از این گزینه‌ها، حالت پیش‌فرض (-p -q) را که یک نمایهٔ مسطح و تحلیل نمودار فراخوانی برای تمام توابع چاپ می‌کند، لغو می‌نماید.

"-A[symspec]"

"--annotated-source[=symspec]"

گزینهٔ -A باعث می‌شود "gprof" کد منبع حاشیه‌نویسی‌شده را چاپ کند. اگر symspec مشخص شده باشد، خروجی فقط برای نمادهای منطبق چاپ می‌شود.

"-b"

"--brief"

اگر گزینهٔ -b داده شود، "gprof" توضیحات مفصلی را که سعی در تشریح معنای تمام فیلدهای جدول‌ها دارند چاپ نمی‌کند. این گزینه برای زمانی که قصد چاپ فیزیکی خروجی را دارید یا از دیدن این توضیحات خسته شده‌اید، مفید است.

"-B"

گزینهٔ -B باعث می‌شود "gprof" تحلیل نمودار فراخوانی را چاپ کند.

"-C[symspec]"

"--exec-counts[=symspec]"

گزینهٔ -C باعث می‌شود "gprof" شمارش توابع و تعداد دفعاتی را که هر یک فراخوانی شده‌اند چاپ کند. اگر symspec مشخص شده باشد، شمارش تنها برای نمادهای منطبق چاپ می‌شود.

اگر فایل داده‌های نمایه حاوی رکوردهای شمارش بلوک پایه‌ای (basic-block) باشد، مشخص کردن گزینهٔ -l در کنار -C، باعث می‌شود دفعات اجرای بلوک‌های پایه‌ای شمارش شده و به نمایش درآید.

"-i"

"--file-info"

گزینهٔ -i باعث می‌شود "gprof" اطلاعات خلاصه‌ای را دربارهٔ فایل(های) داده‌های نمایه نمایش داده و سپس خارج شود. تعداد رکوردهای هیستوگرام، نمودار فراخوانی و شمارش بلوک پایه‌ای نمایش داده می‌شود.

"-I dirs"

"--directory-path=dirs"

گزینهٔ -I فهرستی از دایرکتوری‌های جستجو را برای یافتن فایل‌های منبع مشخص می‌کند. از متغیر محیطی GPROF_PATH نیز می‌توان برای انتقال این اطلاعات استفاده کرد. کاربرد اصلی آن برای خروجی منبع حاشیه‌نویسی‌شده است.

"-J[symspec]"

"--no-annotated-source[=symspec]"

گزینهٔ -J باعث می‌شود "gprof" کد منبع حاشیه‌نویسی‌شده را چاپ نکند. اگر symspec مشخص شده باشد، "gprof" کد منبع حاشیه‌نویسی‌شده را چاپ می‌کند، اما نمادهای منطبق را مستثنی می‌سازد.

"-L"

"--print-path"

به‌طور معمول، نام فایل‌های منبع با حذف بخش مسیر چاپ می‌شوند. گزینهٔ -L باعث می‌شود "gprof" نام مسیر کامل فایل‌های منبع را چاپ کند؛ این مسیر از اطلاعات اشکال‌زدایی نمادین در فایل تصویر اجرایی تعیین می‌شود و نسبت به دایرکتوری‌ای است که کامپایلر در آن فراخوانی شده است.

"-p[symspec]"

"--flat-profile[=symspec]"

گزینهٔ -p باعث می‌شود "gprof" نمایهٔ مسطح را چاپ کند. اگر symspec مشخص شده باشد، نمایهٔ مسطح فقط برای نمادهای منطبق چاپ می‌شود.

"-P[symspec]"

"--no-flat-profile[=symspec]"

گزینهٔ -P باعث می‌شود "gprof" از چاپ نمایهٔ مسطح صرف‌نظر کند. اگر symspec مشخص شده باشد، "gprof" نمایهٔ مسطح را چاپ می‌کند، اما نمادهای منطبق را مستثنی می‌سازد.

"-q[symspec]"

"--graph[=symspec]"

گزینهٔ -q باعث می‌شود "gprof" تحلیل نمودار فراخوانی را چاپ کند. اگر symspec مشخص شده باشد، نمودار فراخوانی فقط برای نمادهای منطبق و فرزندان آن‌ها چاپ می‌شود.

"-Q[symspec]"

"--no-graph[=symspec]"

گزینهٔ -Q باعث می‌شود "gprof" از چاپ نمودار فراخوانی صرف‌نظر کند. اگر symspec مشخص شده باشد، "gprof" نمودار فراخوانی را چاپ می‌کند، اما نمادهای منطبق را مستثنی می‌سازد.

"-t"

"--table-length=num"

گزینهٔ -t باعث می‌شود در صورت فعال بودن حاشیه‌نویسی منبع، num خط از پرکاربردترین خطوط منبع در هر فایل منبع فهرست شوند. مقدار پیش‌فرض 10 است.

"-y"

"--separate-files"

این گزینه تنها بر خروجی منبع حاشیه‌نویسی‌شده تأثیر می‌گذارد. به‌طور معمول، "gprof" فایل‌های منبع حاشیه‌نویسی‌شده را در خروجی استاندارد چاپ می‌کند. اگر این گزینه مشخص شود، منبع حاشیه‌نویسی‌شده برای فایلی با نام path/filename در فایل filename-ann تولید می‌شود. اگر فایل‌سیستم زیربنایی filename-ann را کوتاه کند به‌طوری که بر روی filename اصلی بازنویسی شود، "gprof" به جای آن منبع حاشیه‌نویسی‌شده را در فایل filename.ann تولید می‌کند (اگر نام فایل اصلی دارای پسوند باشد، آن پسوند با .ann جایگزین می‌شود).

"-Z[symspec]"

"--no-exec-counts[=symspec]"

گزینهٔ -Z باعث می‌شود "gprof" آمار شمارش توابع و تعداد دفعاتی که هر یک فراخوانی شده‌اند را چاپ نکند. اگر symspec مشخص شود، آمار چاپ می‌شود ولی نمادهای منطبق مستثنی می‌شوند.

"-r"

"--function-ordering"

گزینهٔ --function-ordering باعث می‌شود "gprof" یک ترتیب پیشنهادی برای توابع برنامه بر اساس داده‌های پروفایل‌سازی چاپ کند. این گزینه ترتیبی را پیشنهاد می‌دهد که ممکن است رفتار صفحه‌بندی (paging)، tlb و حافظهٔ پنهان (cache) برنامه را در سیستم‌هایی که از ترتیب دلخواه توابع در یک فایل اجرایی پشتیبانی می‌کنند، بهبود بخشد.

جزئیات دقیق نحوهٔ وادار کردن پیونددهنده (linker) به قرار دادن توابع در یک ترتیب خاص، وابسته به سیستم بوده و خارج از محدودهٔ این راهنما است.

"-R map_file"

"--file-ordering map_file"

گزینهٔ --file-ordering باعث می‌شود "gprof" یک ترتیب پیشنهادی برای خط پیوند پرونده‌های .o بر اساس داده‌های پروفایل‌سازی برنامه چاپ کند. این گزینه ترتیبی را پیشنهاد می‌دهد که ممکن است رفتار صفحه‌بندی، tlb و حافظهٔ پنهان برنامه را در سیستم‌هایی که از ترتیب دلخواه توابع در یک فایل اجرایی پشتیبانی نمی‌کنند، بهبود بخشد.

استفاده از آرگومان -a همراه با این گزینه به‌شدت توصیه می‌شود.

آرگومان map_file نام مسیری به یک فایل است که نگاشت نام تابع به فایل‌های شیء را فراهم می‌کند. قالب این فایل شبیه به خروجی برنامهٔ "nm" است.

c-parse.o:00000000 T yyparse
c-parse.o:00000004 C yyerrflag
c-lang.o:00000000 T maybe_objc_method_name
c-lang.o:00000000 T print_lang_statistics
c-lang.o:00000000 T recognize_objc_keyword
c-decl.o:00000000 T print_lang_identifier
c-decl.o:00000000 T print_lang_type
...

برای ایجاد یک map_file با GNU "nm"، دستوری مانند این وارد کنید: "nm --extern-only --defined-only -v --print-file-name program-name".

"-T"

"--traditional"

گزینهٔ -T باعث می‌شود "gprof" خروجی خود را در سبک «سنتی» BSD چاپ کند.

"-w width"

"--width=width"

عرض خطوط خروجی را روی width تنظیم می‌کند. در حال حاضر تنها هنگام چاپ نمایهٔ توابع در انتهای نمودار فراخوانی استفاده می‌شود.

"-x"

"--all-lines"

این گزینه تنها بر خروجی منبع حاشیه‌نویسی‌شده تأثیر می‌گذارد. به‌طور پیش‌فرض، تنها خطوط موجود در ابتدای یک بلوک پایه (basic-block) حاشیه‌نویسی می‌شوند. اگر این گزینه مشخص شود، هر خط در یک بلوک پایه با تکرار حاشیه‌نویسی خط نخست، حاشیه‌نویسی خواهد شد. این رفتار شبیه به گزینهٔ -a در "tcov" است.

"--demangle[=style]"

"--no-demangle"

این گزینه‌ها کنترل می‌کنند که آیا نام نمادهای ++C هنگام چاپ خروجی باید بازگردانی (demangle) شوند یا خیر. حالت پیش‌فرض، بازگردانی نمادها است. گزینهٔ "--no-demangle" می‌تواند برای غیرفعال کردن بازگردانی استفاده شود. کامپایلرهای گوناگون سبک‌های درهم‌سازی متفاوتی دارند. آرگومان اختیاری سبک بازگردانی می‌تواند برای انتخاب سبک بازگردانی مناسب برای کامپایلر شما به کار رود..SS "گزینه‌های تحلیل (Analysis Options)"

"-a"

"--no-static"

گزینهٔ -a باعث می‌شود که "gprof" از چاپ توابع تعریف‌شده به‌صورت ایستا (خصوصی) صرف‌نظر کند. (این‌ها توابعی هستند که نامشان به‌صورت سراسری فهرست نشده است و در خارج از فایل/تابع/بلوکی که در آن تعریف شده‌اند، قابل مشاهده نیستند.) زمان صرف‌شده در این توابع، فراخوانی‌ها به/از آن‌ها و موارد مشابه، همگی به تابعی نسبت داده می‌شوند که در فایل اجرایی دقیقاً پیش از آن بارگذاری شده است. این گزینه هم بر نمایهٔ مسطح و هم بر گراف فراخوانی تأثیر می‌گذارد.

"-c"

"--static-call-graph"

گزینهٔ -c باعث می‌شود که گراف فراخوانی برنامه به کمک یک روش اکتشافی (heuristic) تقویت شود؛ روشی که فضای متنی (text space) فایل شیء را بررسی کرده و فراخوانی‌های توابع را در کد ماشین دودویی شناسایی می‌کند. از آنجا که رکوردهای معمول گراف فراخوانی تنها هنگام ورود به توابع تولید می‌شوند، این گزینه فرزندانی را شناسایی می‌کند که ممکن بود فراخوانی شوند، اما هرگز فراخوانی نشده‌اند. فراخوانی‌های توابعی که بدون فعال‌سازی قابلیت نمایه‌سازی (profiling) کامپایل شده‌اند نیز شناسایی می‌شوند، اما فقط در صورتی که مدخل‌های جدول نمادها برای آن‌ها موجود باشد. فراخوانی توابع روتین کتابخانه‌های پویا معمولاً توسط این گزینه پیدا نمی‌شوند. والدین یا فرزندانی که از طریق این روش اکتشافی شناسایی می‌شوند، در گراف فراخوانی با تعداد فراخوانی 0 نشان داده می‌شوند.

"-D"

"--ignore-non-functions"

گزینهٔ -D باعث می‌شود "gprof" نمادهایی را که به‌عنوان تابع شناخته نمی‌شوند نادیده بگیرد. این گزینه در سیستم‌هایی که از آن پشتیبانی می‌کنند (برای مثال Solaris و HPUX) داده‌های نمایه‌سازی دقیق‌تری ارائه می‌دهد.

"-k from/to"

گزینهٔ -k به شما اجازه می‌دهد تا هر یالی را در گراف فراخوانی از نمادهای منطبق با مشخصهٔ نماد from به نمادهای منطبق با مشخصهٔ نماد to حذف کنید.

"-l"

"--line"

گزینهٔ -l نمایه‌سازی خط به خط را فعال می‌کند، که باعث می‌شود رخدادهای هیستوگرام به‌جای توابع، به خطوط مجزای کد منبع نسبت داده شوند. این ویژگی تنها با برنامه‌هایی کار می‌کند که توسط نسخه‌های قدیمی‌تر کامپایلر "gcc" کامپایل شده باشند. نسخه‌های جدیدتر "gcc" به‌گونه‌ای طراحی شده‌اند که در عوض با ابزار "gcov" کار کنند.

اگر برنامه با فعال بودن شمارش بلوک‌های پایه (basic-block counting) کامپایل شده باشد، این گزینه همچنین مشخص می‌کند که هر خط از کد چند بار اجرا شده است. اگرچه نمایه‌سازی خط به خط می‌تواند به جداسازی و مشخص کردن بخش‌هایی از یک تابع بزرگ که برنامه زمان خود را در آن صرف می‌کند کمک کند، اما زمان اجرای "gprof" را نیز به‌طور قابل‌توجهی افزایش داده و خطاهای آماری را بزرگ‌نمایی می‌کند.

"--inline-file-names"

این گزینه باعث می‌شود "gprof" نام فایل منبع را پس از هر نماد، هم در نمایهٔ مسطح و هم در گراف فراخوانی چاپ کند. در صورت استفاده همراه با گزینهٔ -L، مسیر کامل فایل چاپ خواهد شد.

"-m num"

"--min-count=num"

این گزینه تنها بر خروجی تعداد دفعات اجرا تأثیر می‌گذارد. نمادهایی که کمتر از num بار اجرا شده باشند نادیده گرفته می‌شوند.

"-nsymspec"

"--time=symspec"

گزینهٔ -n باعث می‌شود "gprof" در تحلیل گراف فراخوانی خود، زمان‌ها را تنها برای نمادهای منطبق با symspec انتشار دهد.

"-Nsymspec"

"--no-time=symspec"

گزینهٔ -N باعث می‌شود "gprof" در تحلیل گراف فراخوانی خود، زمان‌ها را برای نمادهای منطبق با symspec انتشار ندهد.

"-Sfilename"

"--external-symbol-table=filename"

گزینهٔ -S باعث می‌شود "gprof" به‌جای خواندن جدول نمادها از فایل شیء داده‌شده (پیش‌فرض "a.out" است)، یک فایل جدول نمادهای خارجی مانند /proc/kallsyms را بخواند. این ویژگی برای نمایه‌سازی ماژول‌های هسته مفید است.

"-z"

"--display-unused-functions"

اگر گزینهٔ -z را مشخص کنید، "gprof" تمام توابع را در نمایهٔ مسطح ذکر می‌کند؛ حتی آن‌هایی که هرگز فراخوانی نشده‌اند و هیچ زمانی در آن‌ها صرف نشده است. این ویژگی در ترکیب با گزینهٔ -c برای یافتن روتین‌هایی که هرگز فراخوانی نشده‌اند مفید است..SS "گزینه‌های متفرقه (Miscellaneous Options)"

"-d[num]"

"--debug[=num]"

گزینهٔ -d num گزینه‌های اشکال‌زدایی را مشخص می‌کند. اگر num تعیین نشود، همهٔ حالت‌های اشکال‌زدایی فعال می‌شوند.

"-h"

"--help"

گزینهٔ -h راهنمای استفاده در خط فرمان را چاپ می‌کند.

"-Oname"

"--file-format=name"

قالب فایل‌های داده‌های پروفایل را انتخاب می‌کند. قالب‌های شناخته‌شده عبارت‌اند از auto (پیش‌فرض)، bsd، 4.4bsd، magic و prof (هنوز پشتیبانی نمی‌شود).

"-s"

"--sum"

گزینهٔ -s باعث می‌شود "gprof" اطلاعات فایل‌های داده‌های پروفایل خوانده‌شده را خلاصه کرده و یک فایل داده‌های پروفایل به نام gmon.sum بنویسد که شامل تمام اطلاعات فایل‌های داده‌های پروفایل خوانده‌شده توسط "gprof" است. فایل gmon.sum می‌تواند یکی از فایل‌های ورودی مشخص‌شده باشد؛ اثر این کار، ادغام داده‌های سایر فایل‌های ورودی در gmon.sum خواهد بود.

در نهایت می‌توانید "gprof" را دوباره بدون -s اجرا کنید تا داده‌های تجمیعی درون فایل gmon.sum را تحلیل کند.

"-v"

"--version"

پرچم -v باعث می‌شود "gprof" شمارهٔ نسخهٔ فعلی را چاپ کرده و سپس خارج شود.

گزارش باگ‌ها (BUGS)

ریزبینایی (granularity) نمونه‌برداری نشان داده می‌شود، اما در بهترین حالت ماهیتی آماری دارد. فرض بر این است که زمان هر بار اجرای یک تابع را می‌توان از طریق تقسیم زمان کل تابع بر تعداد دفعات فراخوانی آن به دست آورد. بنابراین، زمانی که در امتداد یال‌های گراف فراخوانی به والدهای تابع منتقل می‌شود، مستقیماً متناسب با تعداد دفعات پیمایش آن یال است.

والدهایی که خودشان پروفایل‌سازی نشده‌اند، زمان فرزندان پروفایل‌شدهٔ آن‌ها به ایشان منتقل خواهد شد، اما در فهرست گراف فراخوانی به‌نظر می‌رسد که به طور خودبه‌خودی فراخوانی شده‌اند و زمان آن‌ها فراتر از این منتقل نخواهد شد. به همین ترتیب، گیرنده‌های سیگنال (signal catchers)، حتی با وجود پروفایل‌سازی، خودبه‌خودی به‌نظر خواهند رسید (اگرچه به دلایلی مبهم‌تر). زمان هر فرزند پروفایل‌شدهٔ گیرنده‌های سیگنال باید به‌درستی منتقل شود، مگر این‌که گیرندهٔ سیگنال در حین اجرای روال پروفایل‌سازی فراخوانی شده باشد، که در این حالت همه‌چیز از دست می‌رود.

برنامهٔ پروفایل‌شده باید "exit"(2) را فراخوانی کند یا به طور عادی خاتمه یابد تا اطلاعات پروفایل‌سازی در فایل gmon.out ذخیره شوند.

همچنین ببینید (SEE ALSO)

monitor(3)، profil(2)، cc(1)، prof(1) و مدخل Info برای gprof.

"An Execution Profiler for Modular Programs", نوشتهٔ S. Graham, P. Kessler, M. McKusick; Software - Practice and Experience, Vol. 13, pp. 671-685, 1983.

"gprof: A Call Graph Execution Profiler", نوشتهٔ S. Graham, P. Kessler, M. McKusick; Proceedings of the SIGPLAN '82 Symposium on Compiler Construction, SIGPLAN Notices, Vol. 17, No 6, pp. 120-126, June 1982.

کپی‌رایت و تکثیر (COPYRIGHT)

Copyright (c) 1988-2025 Free Software Foundation, Inc.

اجازهٔ نسخه‌برداری، توزیع و/یا تغییر این سند تحت شرایط مجوز مستندات آزاد گنو (GNU Free Documentation License)، نسخهٔ ۱.۳ یا هر نسخهٔ متأخر دیگری که توسط بنیاد نرم‌افزارهای آزاد منتشر شده است اعطا می‌شود؛ بدون بخش‌های تغییرناپذیر، بدون متون روی جلد و بدون متون پشت جلد. یک نسخه از این مجوز در بخشی با عنوان «GNU Free Documentation License» قرار داده شده است.