terminate.H

Go to the documentation of this file.
00001 /*!@file Util/terminate.H fancy termination routine */
00002 
00003 // //////////////////////////////////////////////////////////////////// //
00004 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2005   //
00005 // by the University of Southern California (USC) and the iLab at USC.  //
00006 // See http://iLab.usc.edu for information about this project.          //
00007 // //////////////////////////////////////////////////////////////////// //
00008 // Major portions of the iLab Neuromorphic Vision Toolkit are protected //
00009 // under the U.S. patent ``Computation of Intrinsic Perceptual Saliency //
00010 // in Visual Environments, and Applications'' by Christof Koch and      //
00011 // Laurent Itti, California Institute of Technology, 2001 (patent       //
00012 // pending; application number 09/912,225 filed July 23, 2001; see      //
00013 // http://pair.uspto.gov/cgi-bin/final/home.pl for current status).     //
00014 // //////////////////////////////////////////////////////////////////// //
00015 // This file is part of the iLab Neuromorphic Vision C++ Toolkit.       //
00016 //                                                                      //
00017 // The iLab Neuromorphic Vision C++ Toolkit is free software; you can   //
00018 // redistribute it and/or modify it under the terms of the GNU General  //
00019 // Public License as published by the Free Software Foundation; either  //
00020 // version 2 of the License, or (at your option) any later version.     //
00021 //                                                                      //
00022 // The iLab Neuromorphic Vision C++ Toolkit is distributed in the hope  //
00023 // that it will be useful, but WITHOUT ANY WARRANTY; without even the   //
00024 // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR      //
00025 // PURPOSE.  See the GNU General Public License for more details.       //
00026 //                                                                      //
00027 // You should have received a copy of the GNU General Public License    //
00028 // along with the iLab Neuromorphic Vision C++ Toolkit; if not, write   //
00029 // to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,   //
00030 // Boston, MA 02111-1307 USA.                                           //
00031 // //////////////////////////////////////////////////////////////////// //
00032 //
00033 // Primary maintainer for this file: Rob Peters <rjpeters at usc dot edu>
00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Util/terminate.H $
00035 // $Id: terminate.H 9412 2008-03-10 23:10:15Z farhan $
00036 //
00037 
00038 #ifndef UTIL_TERMINATE_H_DEFINED
00039 #define UTIL_TERMINATE_H_DEFINED
00040 
00041 //! Installs a fancy termination handler which prints a backtrace before aborting
00042 /*! This function needs to be called just once per program run, to
00043     install our termination handler; thereafter, if std::terminate()
00044     is called (e.g. due to an uncaught exception) it will call our
00045     fancy termination handler.
00046 
00047     The backtrace (from /usr/include/execinfo.h) will be in a fairly
00048     raw format, e.g. with lines like the following:
00049 
00050     /path/to/saliency/build/obj/nub/refdetail.so(_ZN3nub6detail22throw_soft_ref_invalidERKSt9type_infoRKN4rutz8file_posE+0xc3)[0xb79301f3]
00051     /path/to/saliency/build/obj/Neuro/ShapeEstimator.so(_ZN14ShapeEstimator7computeERK7Point2D+0x60b)[0xb7a556bb]
00052     /path/to/saliency/build/obj/Neuro/Brain.so(_ZN5Brain6evolveER7SimTimeR7Point2DRiRf+0x9ed)[0xb7afb0ad]
00053     /path/to/saliency/build/obj/Neuro/getSaliency.so(_ZN11GetSaliency7computeERK5ImageI6PixRGBIhEERK7SimTime+0x1ef)[0xb79e8cef]
00054 
00055     That is, each line gives the name of the object file, followed by
00056     the symbol name of the function that was executing in that file,
00057     plus a code offset relative to the start of the function, plus a
00058     global address:
00059 
00060     file.so(symbolname+offset)[address]
00061 
00062     You can get somewhat prettier looking output if you pipe the
00063     backtrace through the c++filt program, which will demangle the
00064     function names and give you something like this:
00065 
00066     /path/to/saliency/build/obj/nub/refdetail.so(nub::detail::throw_soft_ref_invalid(std::type_info const&, rutz::file_pos const&)+0xc3)[0xb79301f3]
00067     /path/to/saliency/build/obj/Neuro/ShapeEstimator.so(ShapeEstimator::compute(Point2D<int> const&)+0x60b)[0xb7a556bb]
00068     /path/to/saliency/build/obj/Neuro/Brain.so(Brain::evolve(SimTime&, Point2D<int>&, int&, float&)+0x9ed)[0xb7afb0ad]
00069     /path/to/saliency/build/obj/Neuro/getSaliency.so(GetSaliency::compute(Image<PixRGB<unsigned char> > const&, SimTime const&)+0x1ef)[0xb79e8cef]
00070 */
00071 void invt_install_fancy_terminate();
00072 
00073 // ######################################################################
00074 /* So things look consistent in everyone's emacs... */
00075 /* Local Variables: */
00076 /* indent-tabs-mode: nil */
00077 /* End: */
00078 
00079 #endif // UTIL_TERMINATE_H_DEFINED
Generated on Sun May 8 08:06:59 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3