Drop과 자원 정리

스마트 포인터 패턴에서 중요한 두 번째 트레이트는 Drop인데, 이는 어떤 값이 스코프 밖으로 벗어나려고 할 때 무슨 일을 할지 커스터마이징하게끔 해줍니다.

어떠한 타입이든 Drop 트레이트를 구현할 수 있고, 이 코드가 파일이나 네트워크 연결 같은 자원 해제에 사용되게 할 수 있습니다.

스마트 포인터에 대한 맥락에서 Drop을 소개하는 이유는 Drop 트레이트의 기능이 스마트 포인터를 구현할 때 거의 항상 이용되기 때문입니다.

예를 들어 Box<T>가 버려질 때는 이 박스가 가리키고 있는 힙 공간의 할당을 해제할 것입니다.

몇몇 언어들에서는 어떤 타입의 인스턴스 사용을 끝낼 때마다 프로그래머가 직접 메모리 혹은 자원을 해제하는 코드를 호출해 줘야 합니다.

그 예에는 파일 핸들, 소켓, 또는 락이 포함됩니다.

해제를 잊어버리면 시스템은 과부하에 걸리고 멈출 수도 있습니다.

러스트에서는 값이 스코프 밖으로 벗어날 때마다 실행되는 특정 코드를 지정할 수 있고, 컴파일러가 이 코드를 자동으로 삽입해 줄 것입니다.

결과적으로, 프로그램 내에서 특정 타입의 인스턴스 사용이 끝나는 지점마다 메모리 정리 코드를 집어넣는 것을 걱정하지 않아도 됩니다.

정상 drop 경로의 자원 정리를 자동화할 수 있습니다. 다만 Rc 순환, mem::forget, 비정상 프로세스 종료 등에서는 누수나 정리 생략이 가능하며 Drop이 모든 누수를 막지는 않습니다.

Drop 트레이트를 구현하여 어떤 값이 스코프 밖으로 벗어났을 때 실행되는 코드를 지정합니다.

Drop 트레이트를 구현하려면 drop이라는 이름의 메서드 하나를 구현해야 하는데 이 메서드는 self에 대한 가변 참조자를 매개변수로 갖습니다.

러스트가 언제 drop을 호출하는지 알아보기 위해서, 지금은 println! 구문을 써서 drop을 구현해봅시다.

예제 14-14는 러스트가 drop 함수를 호출하는 시점을 보여주기 위해서, 인스턴스가 스코프 밖으로 벗어났을 때 Dropping CustomSmartPointer!를 출력하는 커스텀 기능만을 갖춘 CustomSmartPointer 구조체를 보여줍니다.

struct CustomSmartPointer {
    data: String,
}

impl Drop for CustomSmartPointer {
    fn drop(&mut self) {
        println!("Dropping CustomSmartPointer with data `{}`!", self.data);
    }
}

fn main() {
    let c = CustomSmartPointer {
        data: String::from("my stuff"),
    };
    let d = CustomSmartPointer {
        data: String::from("other stuff"),
    };
    println!("CustomSmartPointers created.");
}

Drop 트레이트는 프렐루드에 포함되어 있으므로, 이를 스코프로 가져올 필요는 없습니다.

CustomSmartPointer에는 Drop 트레이트가 구현되어 여기에 println!을 호출하는 drop 메서드 구현체를 제공하였습니다.

drop 함수의 본문 부분에는 해당 타입의 인스턴스가 스코프 밖으로 벗어났을 때 실행시키고 싶은 어떠한 로직이라도 집어넣을 수 있습니다.

여기서는 러스트가 drop을 호출하게 될 때를 보여주기 위해서 어떤 텍스트를 출력하는 중입니다.

main에서는 두 개의 CustomSmartPointer 인스턴스를 만든 다음 CustomSmartPointers created.를 출력합니다.

main의 끝부분에서, CustomSmartPointer 인스턴스들은 스코프 밖으로 벗어날 것이고, 러스트는 drop 메서드에 집어넣은 코드를 호출할 것이고, 이는 마지막 메시지를 출력합니다.

drop 메서드를 명시적으로 호출할 필요가 없다는 점을 주목하세요.

이 프로그램을 실행시키면 다음과 같은 출력을 보게 될 것입니다.

$ cargo run
   Compiling drop-example v0.1.0 (file:///projects/drop-example)
    Finished dev [unoptimized + debuginfo] target(s) in 0.60s
     Running `target/debug/drop-example`
CustomSmartPointers created.
Dropping CustomSmartPointer with data `other stuff`!
Dropping CustomSmartPointer with data `my stuff`!

러스트는 인스턴스가 스코프 밖으로 벗어났을 때 drop을 호출했고, 이것이 지정해 두었던 코드를 실행시켰습니다.

변수들은 만들어진 순서의 역순으로 버려지므로, d가 c보다 먼저 버려집니다.

이 예제의 Drop::drop은 정리 시점을 보여 주는 메시지만 출력합니다. 메서드가 끝나면 러스트가 data: String 필드도 자동으로 버려 문자열의 자원을 정리합니다. 필드의 정리를 직접 다시 호출할 필요는 없습니다. 실제 타입의 Drop 구현에는 그 타입이 별도로 맡고 있는 자원을 해제하는 동작을 넣습니다.

std::mem::drop으로 값을 일찍 버리기

대부분의 값은 스코프가 끝날 때 자동으로 정리되도록 두면 됩니다. 하지만 가끔은 스코프의 나머지 코드를 실행하기 전에 어떤 값을 일찍 정리하고 싶을 때도 있습니다.

한 가지 예는 락을 관리하는 스마트 포인터를 이용할 때입니다.

예를 들어 락을 잡고 있는 가드 값을 먼저 버리면, 같은 스코프의 다른 코드에서 그 락을 다시 얻을 수 있습니다. 여기서 가드는 살아 있는 동안 자원을 붙잡고 정리될 때 이를 해제하는 값이며, 가드를 버리는 것이 락 자체를 삭제한다는 뜻은 아닙니다.

러스트는 수동으로 Drop 트레이트의 drop 메서드를 호출하게 해주지는 않는 대신, 표준 라이브러리가 제공하는 std::mem::drop 함수를 호출하여 스코프가 끝나기 전에 강제로 값을 버리도록 할 수 있습니다.

예제 14-14의 main 함수를 예제 14-15처럼 수정하여 Drop 트레이트의 drop 메서드를 수동으로 호출하려고 하면 컴파일 에러가 납니다.

fn main() {
    let c = CustomSmartPointer {
        data: String::from("some data"),
    };
    println!("CustomSmartPointer created.");
    c.drop();
    println!("CustomSmartPointer dropped before the end of main.");
}

이 코드의 컴파일을 시도하면 다음과 같은 에러를 얻게 됩니다.

$ cargo run
   Compiling drop-example v0.1.0 (file:///projects/drop-example)
error[E0040]: explicit use of destructor method
  --> src/main.rs:16:7
   |
16 |     c.drop();
   |     --^^^^--
   |     | |
   |     | explicit destructor calls not allowed
   |     help: consider using `drop` function: `drop(c)`

For more information about this error, try `rustc --explain E0040`.
error: could not compile `drop-example` due to previous error

이 에러 메시지는 c.drop()처럼 Drop::drop 메서드를 직접 호출하는 것이 허용되지 않음을 기술하고 있습니다. 뒤에서 사용할 일반 함수 drop(c)까지 금지한다는 뜻은 아닙니다.

에러 메시지에서 소멸자(destructor)라는 용어가 사용되었는데, 이는 인스턴스를 정리하는 함수에 대한 일반적인 프로그래밍 용어입니다.

소멸자는 인스턴스를 생성하는 생성자(constructor)와 유사한 용어입니다.

러스트에서는 Drop::drop 메서드가 타입이 정리될 때 실행할 소멸자 동작을 정의합니다.

Drop::drop은 &mut self로 값을 잠깐 빌리므로, 직접 호출을 허용하더라도 호출자에게서 값의 소유권이 이동하지는 않을 것입니다. 그러면 값이 스코프를 벗어날 때 컴파일러가 삽입한 정리 과정도 다시 실행될 수 있습니다.

이는 러스트가 동일한 값에 대해 두 번 메모리 정리를 시도할 것이므로 중복 해제(double free) 에러가 될 수 있습니다.

보통의 사용에서는 스코프 종료 시 drop이 자동 실행되며 Drop::drop 메서드를 직접 호출할 수 없습니다. mem::forget이나 ManuallyDrop 같은 정리 생략 API는 별도 계약입니다.

따라서, 어떤 값에 대한 메모리 정리를 강제로 일찍 하고 싶을 때는 std::mem::drop 함수를 이용합니다.

std::mem::drop 함수는 Drop 트레이트에 있는 drop 메서드와는 다릅니다.

이 함수에 일찍 버리려고 하는 값을 인수로 넘겨 호출합니다.

std::mem::drop의 형태는 fn drop<T>(_x: T) {}입니다. 함수 본문에서 특별한 해제 명령을 실행하는 대신 값을 인수로 받아, 함수가 끝나며 그 인수가 정상적으로 정리되게 합니다. 따라서 CustomSmartPointer처럼 Copy가 아닌 값의 소유권을 넘기면 호출 뒤에는 원래 변수를 다시 사용할 수 없습니다. 공유 참조 &T나 정수처럼 Copy인 값을 넘기는 경우에는 복사본만 전달되므로 원래 소유 값을 일찍 정리하는 효과가 없습니다. 값을 인수로 받는 drop의 계약을 확인하세요.

이 함수는 프렐루드에 포함되어 있어서, 예제 14-14의 main을 예제 14-16처럼 수정할 수 있습니다.

아래 다이어그램은 값이 만들어진 뒤 자동 정리되거나, std::mem::drop으로 조금 더 이른 시점에 정리되는 흐름을 한 번에 보여줍니다.

println!("created");
drop(c);
println!("dropped before main end");

println!("created");
drop(c);
println!("dropped before main end");

fn main() {
    let c = CustomSmartPointer {
        data: String::from("some data"),
    };
    println!("CustomSmartPointer created.");
    drop(c);
    println!("CustomSmartPointer dropped before the end of main.");
}

이 코드를 실행하면 아래와 같이 출력할 것입니다.

$ cargo run
   Compiling drop-example v0.1.0 (file:///projects/drop-example)
    Finished dev [unoptimized + debuginfo] target(s) in 0.73s
     Running `target/debug/drop-example`
CustomSmartPointer created.
Dropping CustomSmartPointer with data `some data`!
CustomSmartPointer dropped before the end of main.

Dropping CustomSmartPointer with data `some data`!라는 텍스트가 CustomSmartPointer created.와 CustomSmartPointer dropped before the end of main. 사이에 출력되는데, 이는 c를 버리는 drop 메서드가 그 지점에서 호출되었음을 보여줍니다.

Drop 트레이트 구현체에 지정되는 코드를 다양한 방식으로 사용하여 메모리 정리를 편리하고 안전하게 할 수 있습니다.

예를 들면, 이것을 사용하여 여러분만의 고유한 메모리 할당자를 만들 수 있습니다!

Drop 트레이트와 러스트의 소유권 시스템을 이용하면 러스트가 메모리 정리를 자동으로 수행하기 때문에 메모리 정리를 기억해 두지 않아도 됩니다.

또한 아직 사용 중인 값이 뜻하지 않게 정리되면서 발생하는 문제도 걱정할 필요 없습니다.

이 예제의 정상 정리 경로에서는 관련 drop 스코프가 끝나거나 값이 drop(c)로 소비될 때 한 번 정리됩니다. 마지막 사용 지점과 drop 스코프 종료는 같지 않을 수 있습니다.

예시

이미 정의한 CustomSmartPointer를 유지하고 main을 다음으로 바꾸어 참조와 소유 값을 구별해 봅시다.

fn main() {
    let p = CustomSmartPointer { data: String::from("kept") };
    drop(&p);
    println!("after reference");
    drop(p);
    println!("after owner");
}

예상 표준 출력의 순서는 after reference, Dropping CustomSmartPointer with data `kept`!, after owner입니다. drop(&p)는 참조를 인수로 받으므로 p의 소유 값을 소비하지 않으며, 컴파일러도 참조를 버리는 호출에 경고할 수 있습니다. 그 경고와 실행 실패를 혼동하지 마세요.

스스로 정리 순서 설명하기

위 main에서 drop(p) 한 줄만 제거하면 소멸자 출력은 어느 두 출력의 사이 또는 뒤에 오나요? 또 drop(p)를 그대로 둔 채 그 뒤에 println!("{}", p.data)를 더하면 정상 출력이 한 줄 추가되는지, 그 전에 컴파일이 거부되는지 설명하세요. panic·forget·프로세스 강제 종료는 이 문제에서 제외합니다.

mem::drop의 값 소비와 drop 스코프·필드 정리 순서를 나누어 확인하세요.

지금까지 Box<T>와 스마트 포인터의 몇 가지 특성을 시험해 보았으니, 표준 라이브러리에 정의되어 있는 몇 가지 다른 스마트 포인터를 살펴봅시다.