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 и о количестве таких таблиц для каждого типа замыкания. Это полезно, например, для проверки того, что таблицы информации STACK должным образом исключаются из карты таблиц информации или включаются в неё.

-dfaststring-stats

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

-ddump-faststrings

По завершении выводит всю таблицу FastString. Чтобы записать её в файл, можно использовать -ddump-file-prefix=⟨str⟩.

-dppr-debug

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

-ddump-timings

Выводит статистику по объёму выделенной памяти и времени выполнения для различных этапов компиляции. Объём выделенной памяти измеряется в байтах, время — в миллисекундах.

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. Подавление ненужной информации

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

-dsuppress-all

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

-dsuppress-ticks

Подавить «тики» в выводе форматтера.

-dsuppress-uniques

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

-dsuppress-idinfo

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

-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

Начиная с:

9.4.1

Подавить вывод статистики размера Core для каждой привязки

-dsuppress-stg-reps

Начиная с:

9.6.1

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

Отключение этого параметра приводит к аннотированию некоторых аргументов STG их prim rep.

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 без альтернативы по умолчанию:

• Когда анализ спроса предполагает, что выражение, по которому выполняется сопоставление, не возвращает управление (то есть является завершающимся снизу выражением)
• Когда выражение, по которому выполняется сопоставление, имеет тип 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. Не рекомендуется использовать его в обычных условиях: он может привести к аварийному завершению компилятора.

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

-fadd-bco-name

Начиная с:

9.14.1

Добавлять перед каждым сгенерированным объектом байт-кода инструкцию BCO_NAME, содержащую имя привязки STG, из которой был получен BCO. Дизассемблер байт-кода выводит эти имена, что помогает сопоставлять байт-код с STG.