نام (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" مقدار زمان صرف‌شده در هر روتین را محاسبه می‌کند. سپس این زمان‌ها در امتداد یال‌های گراف فراخوانی انتشار می‌یابند. چرخه‌ها (cycles) شناسایی می‌شوند و فراخوانی‌های درون یک چرخه به گونه‌ای تنظیم می‌گردند که در زمان آن چرخه سهیم باشند.

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

گزارش پروفایل مسطح (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 پیشنهادی را برای برنامه چاپ کند. این گزینه ترتیبی را پیشنهاد می‌کند که ممکن است رفتار صفحه‌بندی (paging)، tlb و حافظهٔ نهان (cache) را در سیستم‌هایی که از ترتیب دلخواه توابع در فایل اجرایی پشتیبانی نمی‌کنند، بهبود ببخشد.

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

آرگومان map_file مسیر فایلی است که نگاشت نام تابع به فایل‌های شیء (object 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 تنظیم می‌کند. در حال حاضر تنها هنگام چاپ نمایهٔ توابع در پایین نمودار فراخوانی (call graph) استفاده می‌شود.

"-x"

"--all-lines"

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

"--demangle[=style]"

"--no-demangle"

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

"-a"

"--no-static"

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

"-c"

"--static-call-graph"

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

"-D"

"--ignore-non-functions"

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

"-k from/to"

گزینهٔ -k به شما اجازه می‌دهد هر یالی را در گراف فراخوانی که از نمادهای منطبق با symspec from به نمادهای منطبق با symspec 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)

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

والدینی که خودشان پروفایل‌بندی نشده‌اند، زمان فرزندان پروفایل‌شده به آن‌ها منتقل می‌شود، اما در فهرست گراف فراخوانی به نظر می‌رسد که به‌طور خودبه‌خودی فراخوانی شده‌اند و زمان آن‌ها فراتر از آن منتقل نخواهد شد. به‌طور مشابه، گیرنده‌های سیگنال (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-2026 Free Software Foundation, Inc.

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