Невосстановимые ошибки с panic!
Иногда в коде случаются плохие вещи, и с этим ничего нельзя сделать.
В таких случаях в Rust есть макрос panic!. На практике вызвать
панику можно двумя способами: выполнив действие, вызывающее панику в коде (например,
обращение к массиву за пределами его границ), или явно вызвав макрос panic!.
В обоих случаях в программе возникает паника. По умолчанию такие паники
выводят сообщение о сбое, разворачивают, очищают стек и завершают программу.
С помощью переменной окружения можно также заставить Rust отображать стек вызовов при
возникновении паники, чтобы было проще отследить источник паники.
Развёртывание стека или аварийное завершение в ответ на панику
По умолчанию при возникновении паники программа начинает развёртывание, что означает, что Rust идёт обратно вверх по стеку и очищает данные из каждой встреченной функции. Однако ходить обратно и очищать — это большая работа. Поэтому Rust позволяет выбрать альтернативу — немедленное аварийное завершение, которое завершает программу без очистки.
Память, которую использовала программа, затем должна быть очищена
операционной системой. Если в проекте нужно сделать результирующий бинарный файл как можно
меньше, можно переключиться с развёртывания на аварийное завершение при панике, добавив
panic = 'abort' в соответствующие секции [profile] файла
Cargo.toml. Например, если требуется аварийно завершаться при панике в режиме release,
добавьте:
[profile.release]
panic = 'abort'
Попробуем вызвать panic! в простой программе:
fn main() {
panic!("crash and burn");
}
При запуске программы будет выведено примерно следующее:
$ cargo run
Compiling panic v0.1.0 (file:///projects/panic)
Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.25s
Running `target/debug/panic`
thread 'main' (6018279) panicked at src/main.rs:2:5:
crash and burn
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
Вызов panic! вызывает сообщение об ошибке, содержащееся в последних двух строках.
Первая строка показывает сообщение паники и место в исходном коде, где
произошла паника: src/main.rs:2:5 указывает, что это вторая строка,
пятый символ файла src/main.rs.
В этом случае указанная строка является частью нашего кода, и если перейти к этой
строке, можно увидеть вызов макроса panic!. В других случаях вызов panic! может
находиться в коде, который вызывает наш код, и имя файла и номер строки, сообщаемые
в сообщении об ошибке, будут относиться к чужому коду, где вызывается
макрос panic!, а не к строке нашего кода, которая в конечном итоге привела к
вызову panic!.
Можно использовать трассировку функций, из которых пришёл вызов panic!, чтобы выяснить,
какая часть кода вызывает проблему. Чтобы понять, как использовать
трассировку паники panic!, рассмотрим другой пример и посмотрим, как это происходит, когда
вызов panic! приходит из библиотеки из-за ошибки в нашем коде, а не
из нашего кода, напрямую вызывающего макрос. В листинге 9-1 приведён код, который
пытается обратиться к индексу вектора за пределами диапазона допустимых индексов.
fn main() {
let v = vec![1, 2, 3];
v[99];
}
panic!Здесь выполняется попытка обратиться к 100-му элементу вектора (который находится по
индексу 99, поскольку индексация начинается с нуля), но вектор содержит только три
элемента. В этой ситуации Rust вызовет панику. Использование [] должно возвращать
элемент, но при передаче недопустимого индекса нет элемента, который Rust
мог бы здесь вернуть корректно.
В C попытка чтения за концом структуры данных — это неопределённое поведение. Можно получить то, что находится в памяти в том месте, которое соответствовало бы этому элементу в структуре данных, даже если эта память не принадлежит этой структуре. Это называется переполнением буфера при чтении и может привести к уязвимостям безопасности, если злоумышленник сможет манипулировать индексом таким образом, чтобы прочитать данные, которые ему не положено читать, хранящиеся после структуры данных.
Чтобы защитить программу от такого рода уязвимостей, при попытке прочитать элемент по индексу, которого не существует, Rust остановит выполнение и откажется продолжать. Попробуем и посмотрим:
$ cargo run
Compiling panic v0.1.0 (file:///projects/panic)
Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.27s
Running `target/debug/panic`
thread 'main' (6017887) panicked at src/main.rs:4:6:
index out of bounds: the len is 3 but the index is 99
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
Эта ошибка указывает на строку 4 файла main.rs, где выполняется попытка обратиться к индексу
99 вектора в v.
Строка note: сообщает, что можно установить переменную окружения RUST_BACKTRACE,
чтобы получить трассировку того, что именно произошло и вызвало ошибку. Трассировка — это
список всех функций, которые были вызваны, чтобы дойти до этой
точки. Трассировки в Rust работают так же, как в других языках: ключ к
чтению трассировки — начать сверху и читать до тех пор, пока не встретятся файлы,
написанные вами. Это и есть место, где возникла проблема. Строки выше этого места
— это код, который вызвал ваш код; строки ниже — это код, который вызвал
ваш код. Эти строки до и после могут включать код ядра Rust, код стандартной
библиотеки или крейты, которые используются. Попробуем получить трассировку, установив
переменную окружения RUST_BACKTRACE в любое значение, кроме 0.
В листинге 9-2 показан вывод, похожий на тот, который будет получен.
$ RUST_BACKTRACE=1 cargo run
thread 'main' panicked at src/main.rs:4:6:
index out of bounds: the len is 3 but the index is 99
stack backtrace:
0: rust_begin_unwind
at /rustc/4d91de4e48198da2e33413efdcd9cd2cc0c46688/library/std/src/panicking.rs:692:5
1: core::panicking::panic_fmt
at /rustc/4d91de4e48198da2e33413efdcd9cd2cc0c46688/library/core/src/panicking.rs:75:14
2: core::panicking::panic_bounds_check
at /rustc/4d91de4e48198da2e33413efdcd9cd2cc0c46688/library/core/src/panicking.rs:273:5
3: <usize as core::slice::index::SliceIndex<[T]>>::index
at file:///home/.rustup/toolchains/1.85/lib/rustlib/src/rust/library/core/src/slice/index.rs:274:10
4: core::slice::index::<impl core::ops::index::Index<I> for [T]>::index
at file:///home/.rustup/toolchains/1.85/lib/rustlib/src/rust/library/core/src/slice/index.rs:16:9
5: <alloc::vec::Vec<T,A> as core::ops::index::Index<I>>::index
at file:///home/.rustup/toolchains/1.85/lib/rustlib/src/rust/library/alloc/src/vec/mod.rs:3361:9
6: panic::main
at ./src/main.rs:4:6
7: core::ops::function::FnOnce::call_once
at file:///home/.rustup/toolchains/1.85/lib/rustlib/src/rust/library/core/src/ops/function.rs:250:5
note: Some details are omitted, run with `RUST_BACKTRACE=full` for a verbose backtrace.
panic!, отображаемая при установленной переменной окружения RUST_BACKTRACEЭто очень много вывода! Точный вывод может отличаться в зависимости
от операционной системы и версии Rust. Чтобы получить трассировки с этой
информацией, должны быть включены отладочные символы. Отладочные символы включены
по умолчанию при использовании cargo build или cargo run без флага --release,
как здесь.
В выводе листинга 9-2 строка 6 трассировки указывает на строку в проекте, которая вызывает проблему: строку 4 файла src/main.rs. Если не нужно, чтобы программа вызывала панику, следует начать расследование с места, на которое указывает первая строка, упоминающая написанный вами файл. В листинге 9-1, где код намеренно написан так, чтобы вызвать панику, способ исправить панику — не запрашивать элемент за пределами диапазона индексов вектора. Когда код вызовет панику в будущем, нужно будет выяснить, какое действие выполняет код с какими значениями, вызывая панику, и что код должен делать вместо этого.
Вернёмся к panic! и к тому, когда следует, а когда не следует использовать panic! для
обработки ошибочных условий, в разделе «Вызывать panic! или не вызывать panic!» далее в этой
главе. Далее рассмотрим, как восстановиться после ошибки с помощью Result.