folly/experimental/symbolizer/SignalHandler.h

   1 /*
   2  * Copyright 2014 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef FOLLY_SYMBOLIZER_SIGNALHANDLER_H_
  18 #define FOLLY_SYMBOLIZER_SIGNALHANDLER_H_
  19
  20 #include <functional>
  21
  22 namespace folly { namespace symbolizer {
  23
  24 /**
  25  * Install handler for fatal signals. The list of signals being handled is in
  26  * SignalHandler.cpp.
  27  *
  28  * The handler will dump signal and time information followed by a stack trace
  29  * to stderr, and then call the callbacks registered below.
  30  */
  31 void installFatalSignalHandler();
  32
  33 /**
  34  * Add a callback to be run when receiving a fatal signal. They will also
  35  * be called by LOG(FATAL) and abort() (as those raise SIGABRT internally).
  36  *
  37  * These callbacks must be async-signal-safe, so don't even think of using
  38  * LOG(...) or printf or malloc / new or doing anything even remotely fun.
  39  *
  40  * All these fatal callback must be added before calling
  41  * installFatalSignalCallbacks(), below.
  42  */
  43 typedef void (*SignalCallback)(void);
  44 void addFatalSignalCallback(SignalCallback callback);
  45
  46 /**
  47  * Install the fatal signal callbacks; fatal signals will call these
  48  * callbacks in the order in which they were added.
  49  */
  50 void installFatalSignalCallbacks();
  51
  52
  53 }}  // namespaces
  54
  55 #endif /* FOLLY_SYMBOLIZER_SIGNALHANDLER_H_ */