ceph/src/seastar/include/seastar/core/on_internal_error.hh

   1 /*
   2  * This file is open source software, licensed to you under the terms
   3  * of the Apache License, Version 2.0 (the "License").  See the NOTICE file
   4  * distributed with this work for additional information regarding copyright
   5  * ownership.  You may not use this file except in compliance with the License.
   6  *
   7  * You may obtain a copy of the License at
   8  *
   9  *   http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing,
  12  * software distributed under the License is distributed on an
  13  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  14  * KIND, either express or implied.  See the License for the
  15  * specific language governing permissions and limitations
  16  * under the License.
  17  */
  18 /*
  19  * Copyright 2020 ScyllaDB
  20  */
  21
  22 #pragma once
  23
  24 #include <seastar/util/std-compat.hh>
  25
  26 namespace seastar {
  27
  28 class logger;
  29
  30 /// Controls whether on_internal_error() aborts or throws. The default
  31 /// is to throw.
  32 /// \returns the current abort_on_internal_error state.
  33 bool set_abort_on_internal_error(bool do_abort) noexcept;
  34
  35 /// Report an internal error
  36 ///
  37 /// Depending on the value passed to set_abort_on_internal_error, this
  38 /// will either log to \p logger and abort or throw a std::runtime_error.
  39 [[noreturn]] void on_internal_error(logger& logger, std::string_view reason);
  40
  41 /// Report an internal error
  42 ///
  43 /// Depending on the value passed to set_abort_on_internal_error, this
  44 /// will either log to \p logger and abort or throw the passed-in
  45 /// \p ex.
  46 /// This overload cannot attach a backtrace to the exception, so if the
  47 /// caller wishes to have one attached they have to do it themselves.
  48 [[noreturn]] void on_internal_error(logger& logger, std::exception_ptr ex);
  49
  50 /// Report an internal error in a noexcept context
  51 ///
  52 /// The error will be logged to \logger and if set_abort_on_internal_error,
  53 /// was set to true, the program will be aborted. This overload can be used
  54 /// in noexcept contexts like destructors or noexcept functions.
  55 void on_internal_error_noexcept(logger& logger, std::string_view reason) noexcept;
  56
  57 }