]> git.lizzy.rs Git - rust.git/blob - src/libstd/panicking.rs
Fix checking for missing stability annotations
[rust.git] / src / libstd / panicking.rs
1 // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
4 //
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
10
11 //! Implementation of various bits and pieces of the `panic!` macro and
12 //! associated runtime pieces.
13 //!
14 //! Specifically, this module contains the implementation of:
15 //!
16 //! * Panic hooks
17 //! * Executing a panic up to doing the actual implementation
18 //! * Shims around "try"
19
20 use io::prelude::*;
21
22 use any::Any;
23 use cell::RefCell;
24 use fmt;
25 use intrinsics;
26 use mem;
27 use ptr;
28 use raw;
29 use sys::stdio::Stderr;
30 use sys_common::rwlock::RWLock;
31 use sys_common::thread_info;
32 use sys_common::util;
33 use thread;
34
35 thread_local! {
36     pub static LOCAL_STDERR: RefCell<Option<Box<Write + Send>>> = {
37         RefCell::new(None)
38     }
39 }
40
41 // Binary interface to the panic runtime that the standard library depends on.
42 //
43 // The standard library is tagged with `#![needs_panic_runtime]` (introduced in
44 // RFC 1513) to indicate that it requires some other crate tagged with
45 // `#![panic_runtime]` to exist somewhere. Each panic runtime is intended to
46 // implement these symbols (with the same signatures) so we can get matched up
47 // to them.
48 //
49 // One day this may look a little less ad-hoc with the compiler helping out to
50 // hook up these functions, but it is not this day!
51 #[allow(improper_ctypes)]
52 extern {
53     fn __rust_maybe_catch_panic(f: fn(*mut u8),
54                                 data: *mut u8,
55                                 data_ptr: *mut usize,
56                                 vtable_ptr: *mut usize) -> u32;
57     #[unwind]
58     fn __rust_start_panic(data: usize, vtable: usize) -> u32;
59 }
60
61 #[derive(Copy, Clone)]
62 enum Hook {
63     Default,
64     Custom(*mut (Fn(&PanicInfo) + 'static + Sync + Send)),
65 }
66
67 static HOOK_LOCK: RWLock = RWLock::new();
68 static mut HOOK: Hook = Hook::Default;
69
70 /// Registers a custom panic hook, replacing any that was previously registered.
71 ///
72 /// The panic hook is invoked when a thread panics, but before the panic runtime
73 /// is invoked. As such, the hook will run with both the aborting and unwinding
74 /// runtimes. The default hook prints a message to standard error and generates
75 /// a backtrace if requested, but this behavior can be customized with the
76 /// `set_hook` and `take_hook` functions.
77 ///
78 /// The hook is provided with a `PanicInfo` struct which contains information
79 /// about the origin of the panic, including the payload passed to `panic!` and
80 /// the source code location from which the panic originated.
81 ///
82 /// The panic hook is a global resource.
83 ///
84 /// # Panics
85 ///
86 /// Panics if called from a panicking thread.
87 ///
88 /// # Examples
89 ///
90 /// The following will print "Custom panic hook":
91 ///
92 /// ```should_panic
93 /// use std::panic;
94 ///
95 /// panic::set_hook(Box::new(|_| {
96 ///     println!("Custom panic hook");
97 /// }));
98 ///
99 /// panic!("Normal panic");
100 /// ```
101 #[stable(feature = "panic_hooks", since = "1.10.0")]
102 pub fn set_hook(hook: Box<Fn(&PanicInfo) + 'static + Sync + Send>) {
103     if thread::panicking() {
104         panic!("cannot modify the panic hook from a panicking thread");
105     }
106
107     unsafe {
108         HOOK_LOCK.write();
109         let old_hook = HOOK;
110         HOOK = Hook::Custom(Box::into_raw(hook));
111         HOOK_LOCK.write_unlock();
112
113         if let Hook::Custom(ptr) = old_hook {
114             Box::from_raw(ptr);
115         }
116     }
117 }
118
119 /// Unregisters the current panic hook, returning it.
120 ///
121 /// If no custom hook is registered, the default hook will be returned.
122 ///
123 /// # Panics
124 ///
125 /// Panics if called from a panicking thread.
126 ///
127 /// # Examples
128 ///
129 /// The following will print "Normal panic":
130 ///
131 /// ```should_panic
132 /// use std::panic;
133 ///
134 /// panic::set_hook(Box::new(|_| {
135 ///     println!("Custom panic hook");
136 /// }));
137 ///
138 /// let _ = panic::take_hook();
139 ///
140 /// panic!("Normal panic");
141 /// ```
142 #[stable(feature = "panic_hooks", since = "1.10.0")]
143 pub fn take_hook() -> Box<Fn(&PanicInfo) + 'static + Sync + Send> {
144     if thread::panicking() {
145         panic!("cannot modify the panic hook from a panicking thread");
146     }
147
148     unsafe {
149         HOOK_LOCK.write();
150         let hook = HOOK;
151         HOOK = Hook::Default;
152         HOOK_LOCK.write_unlock();
153
154         match hook {
155             Hook::Default => Box::new(default_hook),
156             Hook::Custom(ptr) => Box::from_raw(ptr),
157         }
158     }
159 }
160
161 /// A struct providing information about a panic.
162 ///
163 /// `PanicInfo` structure is passed to a panic hook set by the [`set_hook`]
164 /// function.
165 ///
166 /// [`set_hook`]: ../../std/panic/fn.set_hook.html
167 ///
168 /// # Examples
169 ///
170 /// ```should_panic
171 /// use std::panic;
172 ///
173 /// panic::set_hook(Box::new(|panic_info| {
174 ///     println!("panic occured: {:?}", panic_info.payload().downcast_ref::<&str>().unwrap());
175 /// }));
176 ///
177 /// panic!("Normal panic");
178 /// ```
179 #[stable(feature = "panic_hooks", since = "1.10.0")]
180 #[derive(Debug)]
181 pub struct PanicInfo<'a> {
182     payload: &'a (Any + Send),
183     location: Location<'a>,
184 }
185
186 impl<'a> PanicInfo<'a> {
187     /// Returns the payload associated with the panic.
188     ///
189     /// This will commonly, but not always, be a `&'static str` or [`String`].
190     ///
191     /// [`String`]: ../../std/string/struct.String.html
192     ///
193     /// # Examples
194     ///
195     /// ```should_panic
196     /// use std::panic;
197     ///
198     /// panic::set_hook(Box::new(|panic_info| {
199     ///     println!("panic occured: {:?}", panic_info.payload().downcast_ref::<&str>().unwrap());
200     /// }));
201     ///
202     /// panic!("Normal panic");
203     /// ```
204     #[stable(feature = "panic_hooks", since = "1.10.0")]
205     pub fn payload(&self) -> &(Any + Send) {
206         self.payload
207     }
208
209     /// Returns information about the location from which the panic originated,
210     /// if available.
211     ///
212     /// This method will currently always return [`Some`], but this may change
213     /// in future versions.
214     ///
215     /// [`Some`]: ../../std/option/enum.Option.html#variant.Some
216     ///
217     /// # Examples
218     ///
219     /// ```should_panic
220     /// use std::panic;
221     ///
222     /// panic::set_hook(Box::new(|panic_info| {
223     ///     if let Some(location) = panic_info.location() {
224     ///         println!("panic occured in file '{}' at line {}", location.file(), location.line());
225     ///     } else {
226     ///         println!("panic occured but can't get location information...");
227     ///     }
228     /// }));
229     ///
230     /// panic!("Normal panic");
231     /// ```
232     #[stable(feature = "panic_hooks", since = "1.10.0")]
233     pub fn location(&self) -> Option<&Location> {
234         Some(&self.location)
235     }
236 }
237
238 /// A struct containing information about the location of a panic.
239 ///
240 /// This structure is created by the [`location`] method of [`PanicInfo`].
241 ///
242 /// [`location`]: ../../std/panic/struct.PanicInfo.html#method.location
243 /// [`PanicInfo`]: ../../std/panic/struct.PanicInfo.html
244 ///
245 /// # Examples
246 ///
247 /// ```should_panic
248 /// use std::panic;
249 ///
250 /// panic::set_hook(Box::new(|panic_info| {
251 ///     if let Some(location) = panic_info.location() {
252 ///         println!("panic occured in file '{}' at line {}", location.file(), location.line());
253 ///     } else {
254 ///         println!("panic occured but can't get location information...");
255 ///     }
256 /// }));
257 ///
258 /// panic!("Normal panic");
259 /// ```
260 #[derive(Debug)]
261 #[stable(feature = "panic_hooks", since = "1.10.0")]
262 pub struct Location<'a> {
263     file: &'a str,
264     line: u32,
265     col: u32,
266 }
267
268 impl<'a> Location<'a> {
269     /// Returns the name of the source file from which the panic originated.
270     ///
271     /// # Examples
272     ///
273     /// ```should_panic
274     /// use std::panic;
275     ///
276     /// panic::set_hook(Box::new(|panic_info| {
277     ///     if let Some(location) = panic_info.location() {
278     ///         println!("panic occured in file '{}'", location.file());
279     ///     } else {
280     ///         println!("panic occured but can't get location information...");
281     ///     }
282     /// }));
283     ///
284     /// panic!("Normal panic");
285     /// ```
286     #[stable(feature = "panic_hooks", since = "1.10.0")]
287     pub fn file(&self) -> &str {
288         self.file
289     }
290
291     /// Returns the line number from which the panic originated.
292     ///
293     /// # Examples
294     ///
295     /// ```should_panic
296     /// use std::panic;
297     ///
298     /// panic::set_hook(Box::new(|panic_info| {
299     ///     if let Some(location) = panic_info.location() {
300     ///         println!("panic occured at line {}", location.line());
301     ///     } else {
302     ///         println!("panic occured but can't get location information...");
303     ///     }
304     /// }));
305     ///
306     /// panic!("Normal panic");
307     /// ```
308     #[stable(feature = "panic_hooks", since = "1.10.0")]
309     pub fn line(&self) -> u32 {
310         self.line
311     }
312
313     /// Returns the column from which the panic originated.
314     ///
315     /// # Examples
316     ///
317     /// ```should_panic
318     /// #![feature(panic_col)]
319     /// use std::panic;
320     ///
321     /// panic::set_hook(Box::new(|panic_info| {
322     ///     if let Some(location) = panic_info.location() {
323     ///         println!("panic occured at column {}", location.column());
324     ///     } else {
325     ///         println!("panic occured but can't get location information...");
326     ///     }
327     /// }));
328     ///
329     /// panic!("Normal panic");
330     /// ```
331     #[unstable(feature = "panic_col", reason = "recently added", issue = "42939")]
332     pub fn column(&self) -> u32 {
333         self.col
334     }
335 }
336
337 fn default_hook(info: &PanicInfo) {
338     #[cfg(feature = "backtrace")]
339     use sys_common::backtrace;
340
341     // If this is a double panic, make sure that we print a backtrace
342     // for this panic. Otherwise only print it if logging is enabled.
343     #[cfg(feature = "backtrace")]
344     let log_backtrace = {
345         let panics = update_panic_count(0);
346
347         if panics >= 2 {
348             Some(backtrace::PrintFormat::Full)
349         } else {
350             backtrace::log_enabled()
351         }
352     };
353
354     let file = info.location.file;
355     let line = info.location.line;
356     let col = info.location.col;
357
358     let msg = match info.payload.downcast_ref::<&'static str>() {
359         Some(s) => *s,
360         None => match info.payload.downcast_ref::<String>() {
361             Some(s) => &s[..],
362             None => "Box<Any>",
363         }
364     };
365     let mut err = Stderr::new().ok();
366     let thread = thread_info::current_thread();
367     let name = thread.as_ref().and_then(|t| t.name()).unwrap_or("<unnamed>");
368
369     let write = |err: &mut ::io::Write| {
370         let _ = writeln!(err, "thread '{}' panicked at '{}', {}:{}:{}",
371                          name, msg, file, line, col);
372
373         #[cfg(feature = "backtrace")]
374         {
375             use sync::atomic::{AtomicBool, Ordering};
376
377             static FIRST_PANIC: AtomicBool = AtomicBool::new(true);
378
379             if let Some(format) = log_backtrace {
380                 let _ = backtrace::print(err, format);
381             } else if FIRST_PANIC.compare_and_swap(true, false, Ordering::SeqCst) {
382                 let _ = writeln!(err, "note: Run with `RUST_BACKTRACE=1` for a backtrace.");
383             }
384         }
385     };
386
387     let prev = LOCAL_STDERR.with(|s| s.borrow_mut().take());
388     match (prev, err.as_mut()) {
389         (Some(mut stderr), _) => {
390             write(&mut *stderr);
391             let mut s = Some(stderr);
392             LOCAL_STDERR.with(|slot| {
393                 *slot.borrow_mut() = s.take();
394             });
395         }
396         (None, Some(ref mut err)) => { write(err) }
397         _ => {}
398     }
399 }
400
401
402 #[cfg(not(test))]
403 #[doc(hidden)]
404 #[unstable(feature = "update_panic_count", issue = "0")]
405 pub fn update_panic_count(amt: isize) -> usize {
406     use cell::Cell;
407     thread_local! { static PANIC_COUNT: Cell<usize> = Cell::new(0) }
408
409     PANIC_COUNT.with(|c| {
410         let next = (c.get() as isize + amt) as usize;
411         c.set(next);
412         return next
413     })
414 }
415
416 #[cfg(test)]
417 pub use realstd::rt::update_panic_count;
418
419 /// Invoke a closure, capturing the cause of an unwinding panic if one occurs.
420 pub unsafe fn try<R, F: FnOnce() -> R>(f: F) -> Result<R, Box<Any + Send>> {
421     #[allow(unions_with_drop_fields)]
422     union Data<F, R> {
423         f: F,
424         r: R,
425     }
426
427     // We do some sketchy operations with ownership here for the sake of
428     // performance. We can only  pass pointers down to
429     // `__rust_maybe_catch_panic` (can't pass objects by value), so we do all
430     // the ownership tracking here manually using a union.
431     //
432     // We go through a transition where:
433     //
434     // * First, we set the data to be the closure that we're going to call.
435     // * When we make the function call, the `do_call` function below, we take
436     //   ownership of the function pointer. At this point the `Data` union is
437     //   entirely uninitialized.
438     // * If the closure successfully returns, we write the return value into the
439     //   data's return slot. Note that `ptr::write` is used as it's overwriting
440     //   uninitialized data.
441     // * Finally, when we come back out of the `__rust_maybe_catch_panic` we're
442     //   in one of two states:
443     //
444     //      1. The closure didn't panic, in which case the return value was
445     //         filled in. We move it out of `data` and return it.
446     //      2. The closure panicked, in which case the return value wasn't
447     //         filled in. In this case the entire `data` union is invalid, so
448     //         there is no need to drop anything.
449     //
450     // Once we stack all that together we should have the "most efficient'
451     // method of calling a catch panic whilst juggling ownership.
452     let mut any_data = 0;
453     let mut any_vtable = 0;
454     let mut data = Data {
455         f: f,
456     };
457
458     let r = __rust_maybe_catch_panic(do_call::<F, R>,
459                                      &mut data as *mut _ as *mut u8,
460                                      &mut any_data,
461                                      &mut any_vtable);
462
463     return if r == 0 {
464         debug_assert!(update_panic_count(0) == 0);
465         Ok(data.r)
466     } else {
467         update_panic_count(-1);
468         debug_assert!(update_panic_count(0) == 0);
469         Err(mem::transmute(raw::TraitObject {
470             data: any_data as *mut _,
471             vtable: any_vtable as *mut _,
472         }))
473     };
474
475     fn do_call<F: FnOnce() -> R, R>(data: *mut u8) {
476         unsafe {
477             let data = data as *mut Data<F, R>;
478             let f = ptr::read(&mut (*data).f);
479             ptr::write(&mut (*data).r, f());
480         }
481     }
482 }
483
484 /// Determines whether the current thread is unwinding because of panic.
485 pub fn panicking() -> bool {
486     update_panic_count(0) != 0
487 }
488
489 /// Entry point of panic from the libcore crate.
490 #[cfg(not(test))]
491 #[lang = "panic_fmt"]
492 #[unwind]
493 pub extern fn rust_begin_panic(msg: fmt::Arguments,
494                                file: &'static str,
495                                line: u32,
496                                col: u32) -> ! {
497     begin_panic_fmt(&msg, &(file, line, col))
498 }
499
500 /// The entry point for panicking with a formatted message.
501 ///
502 /// This is designed to reduce the amount of code required at the call
503 /// site as much as possible (so that `panic!()` has as low an impact
504 /// on (e.g.) the inlining of other functions as possible), by moving
505 /// the actual formatting into this shared place.
506 #[unstable(feature = "libstd_sys_internals",
507            reason = "used by the panic! macro",
508            issue = "0")]
509 #[inline(never)] #[cold]
510 pub fn begin_panic_fmt(msg: &fmt::Arguments,
511                        file_line_col: &(&'static str, u32, u32)) -> ! {
512     use fmt::Write;
513
514     // We do two allocations here, unfortunately. But (a) they're
515     // required with the current scheme, and (b) we don't handle
516     // panic + OOM properly anyway (see comment in begin_panic
517     // below).
518
519     let mut s = String::new();
520     let _ = s.write_fmt(*msg);
521     begin_panic_new(s, file_line_col)
522 }
523
524 // FIXME: In PR #42938, we have added the column as info passed to the panic
525 // handling code. For this, we want to break the ABI of begin_panic.
526 // This is not possible to do directly, as the stage0 compiler is hardcoded
527 // to emit a call to begin_panic in src/libsyntax/ext/build.rs, only
528 // with the file and line number being passed, but not the colum number.
529 // By changing the compiler source, we can only affect behaviour of higher
530 // stages. We need to perform the switch over two stage0 replacements, using
531 // a temporary function begin_panic_new while performing the switch:
532 // 0. Right now, we tell stage1 onward to emit a call to begin_panic_new.
533 // 1. In the first SNAP, stage0 calls begin_panic_new with the new ABI,
534 //    begin_panic stops being used. Now we can change begin_panic to
535 //    the new ABI, and start emitting calls to begin_panic in higher
536 //    stages again, this time with the new ABI.
537 // 2. After the second SNAP, stage0 calls begin_panic with the new ABI,
538 //    and we can remove the temporary begin_panic_new function.
539
540 /// This is the entry point of panicking for panic!() and assert!().
541 #[unstable(feature = "libstd_sys_internals",
542            reason = "used by the panic! macro",
543            issue = "0")]
544 #[inline(never)] #[cold] // avoid code bloat at the call sites as much as possible
545 pub fn begin_panic_new<M: Any + Send>(msg: M, file_line_col: &(&'static str, u32, u32)) -> ! {
546     // Note that this should be the only allocation performed in this code path.
547     // Currently this means that panic!() on OOM will invoke this code path,
548     // but then again we're not really ready for panic on OOM anyway. If
549     // we do start doing this, then we should propagate this allocation to
550     // be performed in the parent of this thread instead of the thread that's
551     // panicking.
552
553     rust_panic_with_hook(Box::new(msg), file_line_col)
554 }
555
556 /// This is the entry point of panicking for panic!() and assert!().
557 #[unstable(feature = "libstd_sys_internals",
558            reason = "used by the panic! macro",
559            issue = "0")]
560 #[inline(never)] #[cold] // avoid code bloat at the call sites as much as possible
561 pub fn begin_panic<M: Any + Send>(msg: M, file_line: &(&'static str, u32)) -> ! {
562     // Note that this should be the only allocation performed in this code path.
563     // Currently this means that panic!() on OOM will invoke this code path,
564     // but then again we're not really ready for panic on OOM anyway. If
565     // we do start doing this, then we should propagate this allocation to
566     // be performed in the parent of this thread instead of the thread that's
567     // panicking.
568
569     let (file, line) = *file_line;
570     let file_line_col = (file, line, 0);
571
572     rust_panic_with_hook(Box::new(msg), &file_line_col)
573 }
574
575 /// Executes the primary logic for a panic, including checking for recursive
576 /// panics and panic hooks.
577 ///
578 /// This is the entry point or panics from libcore, formatted panics, and
579 /// `Box<Any>` panics. Here we'll verify that we're not panicking recursively,
580 /// run panic hooks, and then delegate to the actual implementation of panics.
581 #[inline(never)]
582 #[cold]
583 fn rust_panic_with_hook(msg: Box<Any + Send>,
584                         file_line_col: &(&'static str, u32, u32)) -> ! {
585     let (file, line, col) = *file_line_col;
586
587     let panics = update_panic_count(1);
588
589     // If this is the third nested call (e.g. panics == 2, this is 0-indexed),
590     // the panic hook probably triggered the last panic, otherwise the
591     // double-panic check would have aborted the process. In this case abort the
592     // process real quickly as we don't want to try calling it again as it'll
593     // probably just panic again.
594     if panics > 2 {
595         util::dumb_print(format_args!("thread panicked while processing \
596                                        panic. aborting.\n"));
597         unsafe { intrinsics::abort() }
598     }
599
600     unsafe {
601         let info = PanicInfo {
602             payload: &*msg,
603             location: Location {
604                 file,
605                 line,
606                 col,
607             },
608         };
609         HOOK_LOCK.read();
610         match HOOK {
611             Hook::Default => default_hook(&info),
612             Hook::Custom(ptr) => (*ptr)(&info),
613         }
614         HOOK_LOCK.read_unlock();
615     }
616
617     if panics > 1 {
618         // If a thread panics while it's already unwinding then we
619         // have limited options. Currently our preference is to
620         // just abort. In the future we may consider resuming
621         // unwinding or otherwise exiting the thread cleanly.
622         util::dumb_print(format_args!("thread panicked while panicking. \
623                                        aborting.\n"));
624         unsafe { intrinsics::abort() }
625     }
626
627     rust_panic(msg)
628 }
629
630 /// Shim around rust_panic. Called by resume_unwind.
631 pub fn update_count_then_panic(msg: Box<Any + Send>) -> ! {
632     update_panic_count(1);
633     rust_panic(msg)
634 }
635
636 /// A private no-mangle function on which to slap yer breakpoints.
637 #[no_mangle]
638 #[allow(private_no_mangle_fns)] // yes we get it, but we like breakpoints
639 pub fn rust_panic(msg: Box<Any + Send>) -> ! {
640     let code = unsafe {
641         let obj = mem::transmute::<_, raw::TraitObject>(msg);
642         __rust_start_panic(obj.data as usize, obj.vtable as usize)
643     };
644     rtabort!("failed to initiate panic, error {}", code)
645 }