include/llvm/System/Signals.h

   1 //===- llvm/System/Signals.h - Signal Handling support ----------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines some helpful functions for dealing with the possibility of
  11 // unix signals occuring while your program is running.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_SYSTEM_SIGNALS_H
  16 #define LLVM_SYSTEM_SIGNALS_H
  17
  18 #include "llvm/System/Path.h"
  19
  20 namespace llvm {
  21 namespace sys {
  22
  23   /// This function runs all the registered interrupt handlers, including the
  24   /// removal of files registered by RemoveFileOnSignal.
  25   void RunInterruptHandlers();
  26
  27   /// This function registers signal handlers to ensure that if a signal gets
  28   /// delivered that the named file is removed.
  29   /// @brief Remove a file if a fatal signal occurs.
  30   bool RemoveFileOnSignal(const Path &Filename, std::string* ErrMsg = 0);
  31
  32   /// When an error signal (such as SIBABRT or SIGSEGV) is delivered to the
  33   /// process, print a stack trace and then exit.
  34   /// @brief Print a stack trace if a fatal signal occurs.
  35   void PrintStackTraceOnErrorSignal();
  36
  37   /// AddSignalHandler - Add a function to be called when an abort/kill signal
  38   /// is delivered to the process.  The handler can have a cookie passed to it
  39   /// to identify what instance of the handler it is.
  40   void AddSignalHandler(void (*FnPtr)(void *), void *Cookie);
  41
  42   /// This function registers a function to be called when the user "interrupts"
  43   /// the program (typically by pressing ctrl-c).  When the user interrupts the
  44   /// program, the specified interrupt function is called instead of the program
  45   /// being killed, and the interrupt function automatically disabled.  Note
  46   /// that interrupt functions are not allowed to call any non-reentrant
  47   /// functions.  An null interrupt function pointer disables the current
  48   /// installed function.  Note also that the handler may be executed on a
  49   /// different thread on some platforms.
  50   /// @brief Register a function to be called when ctrl-c is pressed.
  51   void SetInterruptFunction(void (*IF)());
  52 } // End sys namespace
  53 } // End llvm namespace
  54
  55 #endif