Что такое отладчик и как он может помочь мне диагностировать проблемы?

Это общий вопрос, предназначенный для помощи новым программистам, которые столкнулись с проблемой в программе, но не знают, как использовать отладчик для диагностики причины проблемы.

Этот вопрос охватывает три класса более специфических вопросов:

• Когда я запускаю свою программу, она не выдает ожидаемый результат для введенных данных.
• Когда я запускаю свою программу, она вылетает и выдает стек вызовов. Я изучил стек вызовов, но все еще не знаю причины проблемы, потому что стек вызовов не предоставляет мне достаточно информации.
• Когда я запускаю свою программу, она вылетает из-за ошибки сегментации (SEGV).

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

Использование отладчика — ожидаемое базовое умение

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

Как отладчик может помочь вам

Используя отладчик, вы можете выяснить, имеет ли переменная неправильное значение, и где в вашей программе ее значение изменилось на неправильное.

Используя поэтапный шаг, вы также можете выяснить, совпадает ли поток управления с вашими ожиданиями. Например, выполняется ли if ветвь, когда вы ожидаете, что это должно быть.

Общие замечания по использованию отладчика

Специфика использования отладчика зависит от самого отладчика и, в меньшей степени, от языка программирования, который вы используете.

• Вы можете присоединить отладчик к процессу, который уже запускает вашу программу. Вы можете сделать это, если ваша программа зависла.

• На практике часто проще запустить вашу программу под управлением отладчика с самого начала.

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

• Большинство современных отладчиков являются частью IDE и предоставляют вам удобный графический интерфейс для изучения исходного кода и переменных вашей программы, с интерфейсом «точка и клик» для установки точек остановки, запуска вашей программы и поэтапного шага.

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

Я хочу добавить, что отладчик не всегда является идеальным решением и не должен быть единственным решением для отладки. Вот несколько случаев, где отладчик может вам не подойти:

• Часть вашей программы, которая выходит из строя, действительно большая (возможно, плохая модульность?), и вы не знаете, с чего начать проходить код. Проходить через все это может занять слишком много времени.
• Ваша программа использует много обратных вызовов и других методов нелинейного управления потоком, что сбивает с толку отладчик, когда вы проходите через него.
• Ваша программа многопоточная. Или еще хуже, ваша проблема вызвана условием гонки.
• Код, в котором есть ошибка, выполняется много раз, прежде чем он вызывает ошибку. Это может быть особенно проблематично в главных циклах или еще хуже, в физических движках, где проблема может быть численной. Даже установка точки остановки в этом случае просто заставит вас неоднократно попадать на нее, не вызывая ошибку.
• Ваша программа должна работать в реальном времени. Это большая проблема для программ, которые подключаются к сети. Если вы установите точку остановки в своем сетевом коде, другая сторона не будет ждать, пока вы пройдете, она просто истечет по времени. Программы, которые зависят от системных часов, например, игры с пропуском кадров, также не намного лучше.
• Ваша программа выполняет некоторые разрушительные действия, такие как запись в файлы или отправка электронной почты, и вы хотите ограничить количество раз, когда вам нужно проходить через нее.
• Вы можете сказать, что ваша ошибка вызвана неправильными значениями, поступающими в функцию X, но вы не знаете, откуда эти значения пришли. Постоянно проходить через программу, снова и снова, устанавливая точки остановки все дальше и дальше, может быть огромной проблемой. Особенно если функция X вызывается из множества мест в программе.

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

Итак, какие альтернативы?

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

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

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

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

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