legacy-libs/grpc/deps/grpc/third_party/abseil-cpp/absl/debugging/internal/stack_consumption.h

   1 //
   2 // Copyright 2018 The Abseil Authors.
   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 //      https://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 // Helper function for measuring stack consumption of signal handlers.
  17
  18 #ifndef ABSL_DEBUGGING_INTERNAL_STACK_CONSUMPTION_H_
  19 #define ABSL_DEBUGGING_INTERNAL_STACK_CONSUMPTION_H_
  20
  21 // The code in this module is not portable.
  22 // Use this feature test macro to detect its availability.
  23 #ifdef ABSL_INTERNAL_HAVE_DEBUGGING_STACK_CONSUMPTION
  24 #error ABSL_INTERNAL_HAVE_DEBUGGING_STACK_CONSUMPTION cannot be set directly
  25 #elif !defined(__APPLE__) && !defined(_WIN32) && \
  26     (defined(__i386__) || defined(__x86_64__) || defined(__ppc__))
  27 #define ABSL_INTERNAL_HAVE_DEBUGGING_STACK_CONSUMPTION 1
  28
  29 namespace absl {
  30 namespace debugging_internal {
  31
  32 // Returns the stack consumption in bytes for the code exercised by
  33 // signal_handler.  To measure stack consumption, signal_handler is registered
  34 // as a signal handler, so the code that it exercises must be async-signal
  35 // safe.  The argument of signal_handler is an implementation detail of signal
  36 // handlers and should ignored by the code for signal_handler.  Use global
  37 // variables to pass information between your test code and signal_handler.
  38 int GetSignalHandlerStackConsumption(void (*signal_handler)(int));
  39
  40 }  // namespace debugging_internal
  41 }  // namespace absl
  42
  43 #endif  // ABSL_INTERNAL_HAVE_DEBUGGING_STACK_CONSUMPTION
  44
  45 #endif  // ABSL_DEBUGGING_INTERNAL_STACK_CONSUMPTION_H_