کتابخانه‌ی استاندارد · سیستم و ابزار

اشکال زدایی debug

ابزار پیدا کردن اشکال: ادعا، پشته‌ی فراخوانی دستی، ردیابی و زمان‌سنجی.

واردسازی اشکال زدایی

نام آرگومان‌ها شناسه‌ی خود کد است و معادل فارسی ندارد؛ گونه‌ها، کلیدواژه‌ها و نام بسته‌ها با معادل فارسی نوشته می‌شوند.

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

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

اشتباه‌های رایج:

  • ادعا یک تابع معمولی است: در ساخت نهایی (release) هم اجرا می‌شود و پیامش حتی وقتی شرط درست است ساخته می‌شود. کار سنگین را در پیام نگذارید.
  • پشته، کلید ردیابی و زمان‌سنج‌ها متغیرهای سراسری و بی‌قفل‌اند و میان همه‌ی نخ‌ها مشترک‌اند. در برنامه‌ی چندنخی، پشته قاب‌های همه‌ی نخ‌ها را با هم قاطی می‌کند.
  • پشته فقط به اندازه‌ی فراخوانی‌های ورود و خروج درست است. همیشه آن‌ها را با دیرکن اشکال زدایی.خروج() جفت کنید.
  • آمار حافظه فقط در ساختی که شمارش حافظه در آن روشن است عدد می‌دهد؛ در اجرای معمولی خطی برمی‌گرداند که همین را می‌گوید.

خط‌های ردیابی و ادعاهای شکست‌خورده در خروجی خطا (stderr) نوشته می‌شوند تا با خروجی معمول برنامه قاطی نشوند.

بگویید خطا کجا رخ داد

پیامی مثل «قیمت خالی است» در یک برنامه‌ی بزرگ کمکی نمی‌کند: کدام کالا، و چه کسی آن را خواسته بود؟ در آغاز تابع‌هایی که برایتان مهم‌اند ورود را صدا بزنید و درست بعد از آن دیرکن اشکال زدایی.خروج() را بنویسید تا قاب در هر مسیر برگشتی برداشته شود. آن‌وقت پشته مسیر را از بیرونی‌ترین قاب تا قاب فعلی، با > میانشان، برمی‌گرداند. قاب فقط یک متن است، پس می‌تواند نام کالایی را که روی آن کار می‌شود هم داشته باشد.

debug-stack-errors.salam
واردسازی اشکال زدایی

تابع شکست(پیام: رشته): منطقی:
    سرچاپ "خطا در"، اشکال زدایی.پشته() + ":"، پیام
    برگشت نادرست
پایان

تابع خواندن قیمت(متن: رشته): منطقی:
    اشکال زدایی.ورود("خواندن قیمت")
    دیرکن اشکال زدایی.خروج()
    اگر متن.طول() == ۰:
        برگشت شکست("قیمت خالی است")
    پایان
    برگشت درست
پایان

تابع بارگذاری کالا(نام: رشته، قیمت: رشته): منطقی:
    اشکال زدایی.ورود("بارگذاری کالا " + نام)
    دیرکن اشکال زدایی.خروج()
    برگشت خواندن قیمت(قیمت)
پایان

تابع بارگذاری فهرست(): صحیح:
    اشکال زدایی.ورود("بارگذاری فهرست")
    دیرکن اشکال زدایی.خروج()
    ناپایا شمار := ۰
    اگر بارگذاری کالا("چای"، "4.50"): شمار++ پایان
    اگر بارگذاری کالا("کیک"، ""): شمار++ پایان
    اگر بارگذاری کالا("شیر"، "1.20"): شمار++ پایان
    برگشت شمار
پایان

تابع ریشه:
    سرچاپ بارگذاری فهرست()، "کالا بارگذاری شد، عمق اکنون"، اشکال زدایی.عمق()
پایان
خروجیخطا در بارگذاری فهرست > بارگذاری کالا کیک > خواندن قیمت: قیمت خالی است 2 کالا بارگذاری شد، عمق اکنون 0

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

ردیابی فراخوانی‌های یک تابع بازگشتی

فعال‌سازی ردیابی(درست) ردیابی را روشن می‌کند: از آن به بعد ورود و خروج یک خط enter و یک خط exit چاپ می‌کنند و ردیابی پیامش را پس از پشته‌ی فعلی می‌نویسد. وقتی ردیابی خاموش است ردیابی چیزی چاپ نمی‌کند، پس فراخوانی‌هایش می‌توانند در کد بمانند و با یک پرچم، مثلاً از تنظیمات یا یک گزینه‌ی خط فرمان، روشن شوند.

debug-trace-calls.salam
واردسازی اشکال زدایی
واردسازی رشته

تابع فیبو(ن: صحیح): صحیح:
    اشکال زدایی.ورود("فیبو " + رشته.از عدد(ن برگردان صحیح۶۴))
    دیرکن اشکال زدایی.خروج()
    اگر ن < ۲:
        اشکال زدایی.ردیابی("حالت پایه")
        برگشت ن
    پایان
    برگشت فیبو(ن - ۱) + فیبو(ن - ۲)
پایان

تابع ریشه:
    اشکال زدایی.ردیابی("چاپ نمی‌شود، ردیابی خاموش است")
    اشکال زدایی.فعال‌سازی ردیابی(درست)
    حاصل := فیبو(۳)
    اشکال زدایی.فعال‌سازی ردیابی(نادرست)
    اشکال زدایی.ردیابی("این هم چاپ نمی‌شود")
    نادرست‌سرچاپ "فیبو(۳) ="، حاصل
پایان
خروجی[TRACE] فیبو 3: enter [TRACE] فیبو 3 > فیبو 2: enter [TRACE] فیبو 3 > فیبو 2 > فیبو 1: enter [TRACE] فیبو 3 > فیبو 2 > فیبو 1: حالت پایه [TRACE] فیبو 3 > فیبو 2 > فیبو 1: exit [TRACE] فیبو 3 > فیبو 2 > فیبو 0: enter [TRACE] فیبو 3 > فیبو 2 > فیبو 0: حالت پایه [TRACE] فیبو 3 > فیبو 2 > فیبو 0: exit [TRACE] فیبو 3 > فیبو 2: exit [TRACE] فیبو 3 > فیبو 1: enter [TRACE] فیبو 3 > فیبو 1: حالت پایه [TRACE] فیبو 3 > فیبو 1: exit [TRACE] فیبو 3: exit فیبو(۳) = 2

خواندن خط‌ها از بالا به پایین ترتیب فراخوانی‌ها را نشان می‌دهد و درازی هر پشته همان تورفتگی است که با دست می‌کشیدید. همه‌ی این‌ها، مثل خط آخر که این نمونه با نادرست‌سرچاپ چاپ می‌کند، به خروجی خطا می‌روند.

زمان‌سنجی بخش‌های برنامه

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

debug-timers.salam
واردسازی اشکال زدایی

تابع کار سنگین(ن: صحیح): صحیح:
    ناپایا جمع := ۰
    تکرار ن در ش:
        جمع = (جمع + ش * ش) % ۱۰۰۰۰۰۳
    پایان
    برگشت جمع
پایان

تابع ریشه:
    اشکال زدایی.شروع تایمر("همه")
    اشکال زدایی.شروع تایمر("گام")
    الف := کار سنگین(۲۰۰۰۰۰)
    اولی := اشکال زدایی.پایان تایمر("گام")
    اشکال زدایی.شروع تایمر("گام")
    ب := کار سنگین(۲۰۰۰۰۰)
    دومی := اشکال زدایی.پایان تایمر("گام")
    کل := اشکال زدایی.پایان تایمر("همه")
    بعدتر := اشکال زدایی.پایان تایمر("همه")
    سرچاپ الف == ب
    سرچاپ "هر دو گام در زمان کل جا می‌شوند:"، اولی + دومی <= کل
    سرچاپ "زمان‌سنج پس از پایان تایمر هم جلو می‌رود:"، بعدتر >= کل
    سرچاپ "زمان‌سنج ناشناخته:"، اشکال زدایی.پایان تایمر("هرگز شروع نشده")
پایان
خروجیtrue هر دو گام در زمان کل جا می‌شوند: true زمان‌سنج پس از پایان تایمر هم جلو می‌رود: true زمان‌سنج ناشناخته: 0

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

ادعا از قول‌های خود کد محافظت می‌کند

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

debug-assert.salam
واردسازی اشکال زدایی

ساختار حساب:
    همگانی صاحب: رشته = ""
    همگانی موجودی: صحیح = ۰
پایان

تابع برداشت(ح &: حساب، مبلغ: صحیح): منطقی:
    اشکال زدایی.ادعا(مبلغ > ۰، "مبلغ برداشت باید مثبت باشد")
    اگر مبلغ > ح.موجودی:
        برگشت نادرست
    پایان
    ح.موجودی -= مبلغ
    اشکال زدایی.ادعا(ح.موجودی >= ۰، "موجودی هیچ‌وقت منفی نمی‌شود")
    برگشت درست
پایان

تابع ریشه:
    ناپایا ح := حساب { صاحب = "سارا"، موجودی = ۱۰۰ }
    سرچاپ برداشت(ح، ۳۰)، ح.موجودی
    سرچاپ برداشت(ح، ۵۰۰)، ح.موجودی
    سرچاپ برداشت(ح، ۷۰)، ح.موجودی
پایان
خروجیtrue 70 false 70 true 0

وقتی ادعایی شکست بخورد، برنامه پیام را در خروجی خطا می‌نویسد و با abort بی‌درنگ می‌ایستد؛ پس کد خروج روی لینوکس ۱۳۴ است و هیچ کد دیرکنی اجرا نمی‌شود. اگر ادعای نخست شکسته شود، اجرا این‌طور تمام می‌شود:

assertion failed: مبلغ برداشت باید مثبت باشد
Aborted (core dumped)

زیر اشکال‌زدا (salam debug file.salam) این توقف درون همان تابع شکست‌خورده رخ می‌دهد و می‌توانید متغیرهایش را ببینید. شکست‌نقطه همان‌جا عمداً و بدون شرط شکست‌خورده می‌ایستد. آن را در کدی که بدون اشکال‌زدا اجرا می‌شود جا نگذارید: وقتی اشکال‌زدایی وصل نیست، این سیگنال برنامه را متوقف می‌کند.

پیدا کردن نشتی با آمار حافظه

آمار حافظه یک خط برمی‌گرداند با شمار تخصیص‌ها و آزادسازی‌ها، بایت‌هایی که هنوز در استفاده‌اند (live) و بیشترین مقداری که تا کنون در استفاده بوده (peak). شمارش فقط وقتی در برنامه گذاشته می‌شود که بخواهید، پس برنامه را با -DSALAM_MEM_DEBUG (یا --asan) بسازید یا اجرا کنید. این خط را پیش و پس از کاری چاپ کنید که نباید چیزی پشت سر بگذارد: اگر live با هر بار اجرای آن کار بزرگ‌تر می‌شود، آن کار نشتی دارد.

debug-memstats.salam
واردسازی اشکال زدایی

تابع میانگین نمره(ن: صحیح، آزاد شود: منطقی): صحیح:
    ناپایا نمره‌ها := وکتور {} برگردان وکتور<صحیح>
    تکرار ن در ش:
        نمره‌ها.بیفزا(۶۰ + ش % ۴۰)
    پایان
    ناپایا جمع := ۰
    هر نمره در نمره‌ها: جمع += نمره پایان
    اگر آزاد شود: نمره‌ها.آزادکن() پایان
    برگشت جمع / ن
پایان

تابع ریشه:
    سرچاپ "آغاز:   "، اشکال زدایی.آمار حافظه()
    تکرار ۱۰۰ در _:
        میانگین نمره(۵۰۰، درست)
    پایان
    سرچاپ "آزادشده:"، اشکال زدایی.آمار حافظه()
    تکرار ۱۰۰ در _:
        میانگین نمره(۵۰۰، نادرست)
    پایان
    سرچاپ "نشتی:   "، اشکال زدایی.آمار حافظه()
پایان

این نمونه در این صفحه اجرا نمی‌شود، چون به آن پرچم نیاز دارد. با salam run -DSALAM_MEM_DEBUG leak.salam این را چاپ می‌کند:

آغاز:    allocs=1 frees=0 live=64 peak=64
آزادشده: allocs=103 frees=101 live=97 peak=2081
نشتی:    allocs=205 frees=102 live=204936 peak=204936

پس از حلقه‌ی اول، live تقریباً به جای اولش برگشته است؛ پس از حلقه‌ی دوم با هر فراخوانی حدود ۲ کیلوبایت بزرگ‌تر شده، یعنی همان ۵۰۰ عددی که هر وکتور فراموش‌شده نگه می‌داشت. salam memcheck file.salam یک قدم جلوتر می‌رود و برنامه را زیر AddressSanitizer اجرا می‌کند که می‌گوید هر بلوک نشت‌کرده کجا تخصیص یافته است.

تابع‌ها

ادعا Assert

تابع ادعا(cond: منطقی، msg: رشته)
اگر شرط نادرست باشد، assertion failed: و پیام را در خروجی خطا چاپ می‌کند و برنامه را با abort متوقف می‌کند. در ساخت نهایی هم اجرا می‌شود.
debug-Enter.salam
واردسازی اشکال زدایی

تابع فرزند():
    اشکال زدایی.ورود("فرزند")
    سرچاپ اشکال زدایی.عمق()
    سرچاپ اشکال زدایی.پشته()
    اشکال زدایی.خروج()
پایان

تابع ریشه:
    اشکال زدایی.ورود("ریشه")
    فرزند()
    اشکال زدایی.خروج()
    سرچاپ اشکال زدایی.عمق()
    اشکال زدایی.ادعا(۱ + ۱ == ۲، "حساب درست است")
    اشکال زدایی.ادعای خالی نبودن(اشکال زدایی.آمار حافظه() برگردان تهی*، "آمار حافظه")
    اشکال زدایی.فعال‌سازی ردیابی(درست)
    سرچاپ اشکال زدایی.ردیابی فعال است()
    اشکال زدایی.ردیابی("یک پیام ردیابی")
    اشکال زدایی.شروع تایمر("حلقه")
    ناپایا ج := ۰
    تکرار ۱۰۰۰ در ای:
        ج += ای
    پایان
    سرچاپ ج، اشکال زدایی.پایان تایمر("حلقه") >= ۰.۰
    اگر ج < ۰:
        اشکال زدایی.شکست‌نقطه()
    پایان
پایان
خروجی2 ریشه > فرزند 0 true [TRACE] یک پیام ردیابی 499500 true

ادعای خالی نبودن AssertNotNil

تابع ادعای خالی نبودن(p: تهی*، msg: رشته)
اگر اشاره‌گر تهی باشد، برنامه را مثل یک ادعای شکست‌خورده متوقف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: debug-Enter.salam

ورود Enter

تابع ورود(frame: رشته)
قابی به پشته‌ی دستی می‌افزاید، معمولاً در آغاز یک تابع، و وقتی ردیابی روشن است خط enter چاپ می‌کند. آن را با دیرکن اشکال زدایی.خروج() جفت کنید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: debug-Enter.salam

خروج Exit

تابع خروج()
آخرین قاب را از پشته برمی‌دارد و وقتی ردیابی روشن است خط exit چاپ می‌کند. روی پشته‌ی خالی کاری نمی‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: debug-Enter.salam

پشته Stack

تابع پشته(): رشته
پشته‌ی فعلی از بیرونی‌ترین قاب به درون، به شکل root > child؛ اگر خالی باشد رشته‌ی خالی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: debug-Enter.salam

عمق Depth

تابع عمق(): صحیح
عمق پشته‌ی دستی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: debug-Enter.salam

فعال‌سازی ردیابی EnableTrace

تابع فعال‌سازی ردیابی(enabled: منطقی)
پیام‌های ردیابی را روشن یا خاموش می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: debug-Enter.salam

ردیابی فعال است TraceEnabled

تابع ردیابی فعال است(): منطقی
اگر ردیابی روشن باشد، درست برمی‌گرداند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: debug-Enter.salam

ردیابی Trace

تابع ردیابی(msg: رشته)
وقتی ردیابی روشن است، [TRACE]، پشته و پیام را در خروجی خطا چاپ می‌کند. وقتی خاموش است کاری نمی‌کند، هرچند پیام باز هم ساخته می‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: debug-Enter.salam

شروع تایمر StartTimer

تابع شروع تایمر(name: رشته)
زمان‌سنجی را با نام داده‌شده روی ساعت یکنوا شروع می‌کند؛ اگر این نام از قبل باشد، از صفر دوباره شروع می‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: debug-Enter.salam

پایان تایمر StopTimer

تابع پایان تایمر(name: رشته): اعشار۶۴
میلی‌ثانیه‌هایی که از شروع زمان‌سنج گذشته، با کسر. زمان‌سنج ادامه می‌دهد، پس فراخوانی بعدی عدد بزرگ‌تری می‌دهد؛ نام ناشناخته صفر می‌دهد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: debug-Enter.salam

شکست‌نقطه Break

تابع شکست‌نقطه()
در اشکال‌زدا روی همین خط می‌ایستد (سیگنال SIGTRAP می‌فرستد، یا در ویندوز DebugBreak را صدا می‌زند). اگر اشکال‌زدایی وصل نباشد، سیگنال برنامه را تمام می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: debug-Enter.salam

آمار حافظه MemStats

تابع آمار حافظه(): رشته
یک خط با allocs، frees و بایت‌های live و peak. فقط در ساختی با -DSALAM_MEM_DEBUG یا --asan؛ وگرنه خطی که می‌گوید آمار در دسترس نیست.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: debug-Enter.salam