at_exit_imp.rs.html -- source
Description: Source to the Rust file `libstd/sys_common/at_exit_imp.rs`.
Keywords: rust, rustlang, rust-lang

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86

    // Copyright 2013 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    //! Implementation of running at_exit routines
    //!
    //! Documentation can be found on the `rt::at_exit` function.

    use boxed::FnBox;
    use ptr;
    use mem;
    use sys_common::mutex::Mutex;

    type Queue = Vec<Box<dyn FnBox()>>;

    // NB these are specifically not types from `std::sync` as they currently rely
    // on poisoning and this module needs to operate at a lower level than requiring
    // the thread infrastructure to be in place (useful on the borders of
    // initialization/destruction).
    // We never call `LOCK.init()`, so it is UB to attempt to
    // acquire this mutex reentrantly!
    static LOCK: Mutex = Mutex::new();
    static mut QUEUE: *mut Queue = ptr::null_mut();

    const DONE: *mut Queue = 1_usize as *mut _;

    // The maximum number of times the cleanup routines will be run. While running
    // the at_exit closures new ones may be registered, and this count is the number
    // of times the new closures will be allowed to register successfully. After
    // this number of iterations all new registrations will return `false`.
    const ITERS: usize = 10;

    unsafe fn init() -> bool {
        if QUEUE.is_null() {
            let state: Box<Queue> = box Vec::new();
            QUEUE = Box::into_raw(state);
        } else if QUEUE == DONE {
            // can't re-init after a cleanup
            return false
        }

        true
    }

    pub fn cleanup() {
        for i in 1..=ITERS {
            unsafe {
                let queue = {
                    let _guard = LOCK.lock();
                    mem::replace(&mut QUEUE, if i == ITERS { DONE } else { ptr::null_mut() })
                };

                // make sure we're not recursively cleaning up
                assert!(queue != DONE);

                // If we never called init, not need to cleanup!
                if !queue.is_null() {
                    let queue: Box<Queue> = Box::from_raw(queue);
                    for to_run in *queue {
                        // We are not holding any lock, so reentrancy is fine.
                        to_run();
                    }
                }
            }
        }
    }

    pub fn push(f: Box<dyn FnBox()>) -> bool {
        unsafe {
            let _guard = LOCK.lock();
            if init() {
                // We are just moving `f` around, not calling it.
                // There is no possibility of reentrancy here.
                (*QUEUE).push(f);
                true
            } else {
                false
            }
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)