OLD | NEW |
(Empty) | |
| 1 // Copyright 2014 The Crashpad Authors. All rights reserved. |
| 2 // |
| 3 // Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 // you may not use this file except in compliance with the License. |
| 5 // You may obtain a copy of the License at |
| 6 // |
| 7 // http://www.apache.org/licenses/LICENSE-2.0 |
| 8 // |
| 9 // Unless required by applicable law or agreed to in writing, software |
| 10 // distributed under the License is distributed on an "AS IS" BASIS, |
| 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 // See the License for the specific language governing permissions and |
| 13 // limitations under the License. |
| 14 |
| 15 #ifndef CRASHPAD_UTIL_TEST_MAC_MACH_ERRORS_H_ |
| 16 #define CRASHPAD_UTIL_TEST_MAC_MACH_ERRORS_H_ |
| 17 |
| 18 #include <mach/mach.h> |
| 19 |
| 20 #include <string> |
| 21 |
| 22 namespace crashpad { |
| 23 namespace test { |
| 24 |
| 25 // These functions format messages in a similar way to the logging macros in |
| 26 // base/mac/mach_logging.h. They exist to interoperate with gtest assertions, |
| 27 // which don’t interoperate with logging but can be streamed to. |
| 28 // |
| 29 // Where non-test code could do: |
| 30 // MACH_CHECK(kr == KERN_SUCCESS, kr) << "vm_deallocate"; |
| 31 // gtest-based test code can do: |
| 32 // EXPECT_EQ(KERN_SUCCESS, kr) << MachErrorMessage(kr, "vm_deallocate"); |
| 33 |
| 34 //! \brief Formats a Mach error message. |
| 35 //! |
| 36 //! The returned string will combine the \a base string, if supplied, with a |
| 37 //! a textual and numeric description of the error. |
| 38 //! |
| 39 //! \param[in] mach_err The Mach error code, which may be a `kern_return_t` or |
| 40 //! related type. |
| 41 //! \param[in] base A string to prepend to the error description. |
| 42 //! |
| 43 //! \return A string of the format `"(os/kern) invalid address (1)"` if \a |
| 44 //! mach_err has the value `KERN_INVALID_ADDRESS` on a system where this is |
| 45 //! defined to be 1. If \a base is not empty, it will be prepended to this |
| 46 //! string, separated by a colon. |
| 47 std::string MachErrorMessage(mach_error_t mach_err, |
| 48 const std::string& base = std::string()); |
| 49 |
| 50 //! \brief Formats a bootstrap error message. |
| 51 //! |
| 52 //! The returned string will combine the \a base string, if supplied, with a |
| 53 //! a textual and numeric description of the error. |
| 54 //! |
| 55 //! \param[in] bootstrap_err The bootstrap error code. |
| 56 //! \param[in] base A string to prepend to the error description. |
| 57 //! |
| 58 //! \return A string of the format `"Permission denied (1100)"` if \a |
| 59 //! bootstrap_err has the value `BOOTSTRAP_NOT_PRIVILEGED` on a system where |
| 60 //! this is defined to be 1100. If \a base is not empty, it will be |
| 61 //! prepended to this string, separated by a colon. If \a bootstrap_err is |
| 62 //! not a valid bootstrap error code, it will be interpreted as a Mach error |
| 63 //! code in the manner of MachErrorMessage(). |
| 64 std::string BootstrapErrorMessage(kern_return_t bootstrap_err, |
| 65 const std::string& base = std::string()); |
| 66 |
| 67 } // namespace test |
| 68 } // namespace crashpad |
| 69 |
| 70 #endif // CRASHPAD_UTIL_TEST_MAC_MACH_ERRORS_H_ |
OLD | NEW |