5.13. Отладка компилятора

5.13.1. Вывод промежуточных структур компилятора

-ddump-to-file

Приводит к выводу из каждого флага, начинающегося с «-ddump», в файл или файлы. Если вы хотите сохранить весь вывод одного флага в один файл, используйте -ddump-file-prefix=⟨str⟩ (см. описания ниже). В противном случае вывод будет направлен в несколько файлов, включая один для немодульных и несколько для модульных случаев. Суффикс файла вывода зависит от включенного флага, например, вывод из -ddump-simpl окажется в prefix.dump-simpl.

-ddump-file-prefix=⟨str⟩

Устанавливает префикс имён файлов, используемых для вывода отладки. Например, -ddump-file-prefix=Foo приведет к выводу из -ddump-simpl в Foo.dump-simpl.

-fdump-with-ways

По умолчанию:

включено

При компиляции Main.hs с профилированием и без этого флага теперь будут созданы Main.p.dump-simpl и Main.dump-simpl вместо перезаписи вывода одного способа выводом другого.

-ddump-json

Этот флаг ранее использовался для генерации вывода диагностики GHC в формате JSON, но устарел. Используйте вместо него -fdiagnostics-as-json.

-dshow-passes

Выводит имя каждого этапа, время его выполнения и выделенную память по мере его выполнения. Обратите внимание, что это может немного снизить производительность, так как компилятор будет более активно принуждать к результатам этапов, чтобы более точно учитывать их затраты.

Производятся два типа сообщений: те, которые начинаются с ***, обозначают начало фазы компиляции, в то время как те, которые начинаются с !!!, обозначают завершение этапа и сопровождаются статистикой выделения памяти и времени выполнения.

-dipe-stats

Для каждого модуля показываются некоторые простые статистические данные о том, какие таблицы информации содержат информацию IPE, и сколько таблиц информации с информацией IPE имеет каждый тип замыкания. Это полезно, например, для проверки того, что STACK таблицы информации опускаются или включаются в карту таблицы информации.

-dfaststring-stats

Показать статистику использования быстрых строк компилятором.

-ddump-faststrings

Вывести всю таблицу быстрых строк по окончании. Подумайте об использовании -ddump-file-prefix=⟨str⟩ для вывода её в файл.

-dppr-debug

Вывод отладки представлен в нескольких «стилях». Например, рассмотрим вывод типов. В стиле «пользователь» (по умолчанию) внутренние представления компилятора о типах представляются в синтаксисе языка Haskell на уровне исходного кода, насколько это возможно. В стиле «отладки» (который является по умолчанию для вывода отладки) типы печатаются с явными forall, а переменные имеют прикреплённый уникальный идентификатор (чтобы вы могли проверить вещи, которые выглядят одинаково, но таковыми не являются). Этот флаг заставляет вывод отладки отображаться в более подробном стиле отладки.

-ddump-timings

Показать статистику выделения памяти и времени выполнения для различных стадий компиляции. Память измеряется в байтах. Время выполнения измеряется в миллисекундах.

GHC — большая программа, состоящая из множества этапов. Вы можете сообщить GHC о выводе информации с различных этапов компиляции, используя флаги -ddump-⟨pass⟩ ниже. Обратите внимание, что некоторые из них склонны генерировать большой объём вывода. Вы можете предотвратить их заполнение стандартного вывода, передавая -ddump-to-file.

5.13.2. Форматирование дампов

-dppr-user-length

В сообщениях об ошибках выражения печатаются на определенной «глубине», при этом подвыражения за пределами глубины заменяются многоточием. Этот флаг задает глубину. Его значение по умолчанию равно 5.

-dppr-cols=⟨n⟩

Устанавливает ширину отладочного вывода. Используйте этот флаг, если ваш код слишком много «заворачивает». Например: -dppr-cols=200.

-dppr-case-as-let

Печатает выражения отдельного варианта case так, как если бы они были строгими выражениями let. Это полезно, когда ваш код много выполняет распаковку.

-dhex-word-literals

Печатает значения типа Word# и Word64# (но не значения типа Int# и Int64#) в шестнадцатеричном формате вместо десятичного. Шестнадцатеричное представление дополняется нулями до длины, являющейся степенью двойки. Например: 0x0A0A##, 0x000FFFFF##, 0xC##. Этот флаг может быть полезен, когда вы генерируете битовую структуру, которую ожидается правильно использовать в 32-битной или 64-битной архитектуре. Вывод шестнадцатеричных литералов после оптимизаций и сворачивания констант облегчает подтверждение правильности сгенерированной битовой структуры.

-dno-debug-output

Запрещает ненужный отладочный вывод. Когда GHC был скомпилирован с опцией DEBUG, он время от времени выводит отладочную информацию, представляющую интерес для разработчиков. Этот дополнительный вывод может сбивать с толку фреймворк тестирования и приводить к ложным сбоям тестов, поэтому этот флаг предоставлен для его отключения.

5.13.3. Запрещение нежелательной информации

Дампы ядра содержат большое количество информации. В зависимости от вашей задачи, не вся она будет полезна. Используйте эти флаги для подавления тех частей, которые вас не интересуют.

-dsuppress-all

Запрещает все, что можно запретить, за исключением уникальных идентификаторов, так как это часто делает вывод неоднозначным. Если вам нужно просто увидеть общую структуру кода, начните с этого.

-dsuppress-ticks

Запрещает «ти́ки» в выводе pretty-printer.

-dsuppress-uniques

Запрещает вывод уникальных идентификаторов. Это может сделать вывод неоднозначным (например, неясно, где определён «x»), но делает вывод двух компиляций существенно менее различающимся, поэтому можно реалистично применить diff. После того, как diff показал вам, где искать, вы можете попробовать снова без -dsuppress-uniques

-dsuppress-idinfo

Запрещает расширенную информацию об идентификаторах, где они связаны. Это включает информацию о строгости и шаблоны встраивания. Использование этого флага может сократить размер дампов ядра вдвое из-за отсутствия шаблонов встраивания.

-dsuppress-unfoldings

Запрещает вывод устойчивого разворачивания переменной в месте её объявления.

-dsuppress-module-prefixes

Запрещает вывод префиксов квалификации модулей. Это Data.List в Data.List.length.

-dsuppress-timestamps

Запрещает вывод временных меток. Это упрощает сравнение дампов.

-dsuppress-type-signatures

Запрещает вывод сигнатур типов.

-dsuppress-type-applications

Запрещает вывод приложений типов.

-dsuppress-coercions

Запрещает вывод преобразований типов.

-dsuppress-coercion-types

-dsuppress-var-kinds

Запрещает вывод видов переменных

-dsuppress-stg-free-vars

Запрещает вывод списков свободных переменных замыканий в выводе STG.

-dsuppress-core-sizes

Since:

9.4.1

Запрещает вывод статистики размера ядра на привязку.

-dsuppress-stg-reps

Since:

9.6.1

По умолчанию включено

Отключение этого флага добавит аннотации определённым аргументам stg с их представлением prim.

5.13.4. Проверка согласованности

-dlint

Подразумевает:

-dcore-lint, -dstg-lint, -dcmm-lint, -dasm-lint, -fllvm-fill-undef-with-garbage, -fcatch-nonexhaustive-cases, -debug

С:

9.4.1

Включает различные меры проверки целостности внутри проходов GHC и его системы выполнения. Обратите внимание, что это не включает -falignment-sanitisation, так как это влечёт довольно значительные затраты во время выполнения.

-dcore-lint

Включает проверку целостности внутри проходов GHC на уровне ядра (Core). (Проверяется целостность GHC, а не ваша.)

-dlinear-core-lint

Включает проверку линейности в GHC. В настоящее время некоторые оптимизации в GHC могут не сохранять линейность, и существуют корректные программы, которые завершатся с ошибкой Linear Core Lint. В ближайшем будущем этот параметр будет удалён и включён в обычную Core Lint.

-dstg-lint

Аналогично для уровня STG.

-dcmm-lint

Аналогично для уровня C-.

-dasm-lint

Включает проверку целостности внутри проходов GHC на уровне генератора кода.

-fllvm-fill-undef-with-garbage

Указывает генератору кода LLVM на заполнение мёртвых регистров STG мусором вместо undef в вызовах. Это облегчает обнаружение скрытых ошибок генератора кода и системы выполнения (например, см. #11487).

-falignment-sanitisation

Компилировать с проверками выравнивания для всех обращений к таблице информации. Это может быть полезно при поиске проблем с тегами указателей.

-fproc-alignment

С:

8.6.1

Выравнивать функции по кратным заданному значению. Допустимы только степени двойки.

-fproc-alignment=64 можно использовать для ограничения влияния выравнивания на производительность, так как каждая функция будет начинаться с новой строки кэша. Однако принудительное использование более крупных выравниваний обычно снижает производительность.

-fcatch-nonexhaustive-cases

GHC генерирует выражения case без альтернативы по умолчанию в некоторых случаях:

• Когда анализ спроса считает, что выражение возвращает (т. е. выражение, приводящее к ошибке)
• Когда scrutinee — это GADT, и его правила типов исключают некоторые конструкторы, а другие конструкторы уже обрабатываются выражением case.

С этим флагом GHC генерирует альтернативу по умолчанию с error в этих случаях. Это полезно при отладке ошибок анализа спроса или проверки типов, которые иногда проявляются как сегментные нарушения.

-forig-thunk-info

При отладке циклических thunk может быть полезно знать исходную таблицу информации thunk, который оценивается. Этот флаг включает логику генерации кода для этого, создавая стек фрейм stg_orig_thunk_info наряду с обычным фреймом обновления; такие фреймы orig_thunk не оказывают операционного воздействия, но сохраняют исходную таблицу информации обновлённого thunk для проверки средствами отладки. Подробнее см. Note [Original thunk info table frames] в GHC.StgToCmm.Bind.

-fcheck-prim-bounds

Обычно операции primops, такие как writeArray#, демонстрируют небезопасное поведение, полагаясь на пользователя для выполнения проверки границ. Этот флаг инструктирует генератор кода на вставку логики проверки границ в такие операции, которая приводит к прерыванию программы при обнаружении доступа за пределы границ.

Обратите внимание, что это предназначено только для использования в качестве средства отладки, а не как основного метода обнаружения выходов за пределы границ.

-fcmm-thread-sanitizer

Это включает генерацию ThreadSanitizer <https://github.com/google/sanitizers/wiki/ThreadSanitizerCppManual> инструментирования обращений к памяти. Требуется использование -fsanitize=thread или аналогичного при компиляции и линковке.

5.13.5. Проверка детерминизма

-dinitial-unique=⟨s⟩

Начать выделение UniqSupply от ⟨s⟩.

-dunique-increment=⟨i⟩

Установить приращение для сгенерированных Unique в ⟨i⟩.

Это полезно в сочетании с -dinitial-unique=⟨s⟩, чтобы проверить, зависят ли сгенерированные файлы от порядка Unique.

Некоторые интересные значения:

• -dinitial-unique=0 -dunique-increment=1 - текущее последовательное UniqSupply
• -dinitial-unique=16777215 -dunique-increment=-1 - UniqSupply, генерируемые в порядке убывания
• -dinitial-unique=1 -dunique-increment=PRIME - где PRIME достаточно велико, чтобы часто переполнять — не последовательный порядок

5.13.6. Другие

-dno-typeable-binds

Это позволяет избежать генерации связей, связанных с Typeable, для модулей и типов. Это полезно при отладке, так как это даёт более компактные модули и дампы, но компилятор выдаст ошибку, если вы попытаетесь использовать экземпляры Typeable для вещей, созданных с этим флагом.

-dtag-inference-checks

Когда вывод тегов указывает, что определённое значение должно быть помечено, генерируется код для проверки этого во время выполнения. Если проверка завершится неудачно, программа будет завершена. Это помогает сузить область поиска, если проблема связана с выводом тегов, если что-то пойдёт не так, что в противном случае было бы довольно сложно.

-funoptimized-core-for-interpreter

С:

9.8.1

По умолчанию: включено

В настоящее время ghci отключает оптимизации, потому что не все проходы совместимы с интерпретатором. Этот параметр можно использовать для переопределения этой проверки, например, ghci -O2 -fno-unoptimized-core-for-interpreter. Не рекомендуется для обычного использования и может привести к ошибке компилятора.

Обратите внимание, что это влияет на интерфейс отладчика: При включённых оптимизациях свободные переменные в точках останова теперь могут быть заменены сложными выражениями. Те нельзя сохранить в точках останова, поэтому любая свободная переменная, которая ссылается на оптимизированный код, не будет доступна для проверки при включённом этом флаге.