OLD | NEW |
1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef BASE_SAFE_STRERROR_POSIX_H_ | 5 #ifndef BASE_POSIX_SAFE_STRERROR_H_ |
6 #define BASE_SAFE_STRERROR_POSIX_H_ | 6 #define BASE_POSIX_SAFE_STRERROR_H_ |
7 | 7 |
8 #include <string> | 8 #include <string> |
9 | 9 |
10 #include "base/base_export.h" | 10 #include "base/base_export.h" |
11 | 11 |
| 12 namespace base { |
| 13 |
12 // BEFORE using anything from this file, first look at PLOG and friends in | 14 // BEFORE using anything from this file, first look at PLOG and friends in |
13 // logging.h and use them instead if applicable. | 15 // logging.h and use them instead if applicable. |
14 // | 16 // |
15 // This file declares safe, portable alternatives to the POSIX strerror() | 17 // This file declares safe, portable alternatives to the POSIX strerror() |
16 // function. strerror() is inherently unsafe in multi-threaded apps and should | 18 // function. strerror() is inherently unsafe in multi-threaded apps and should |
17 // never be used. Doing so can cause crashes. Additionally, the thread-safe | 19 // never be used. Doing so can cause crashes. Additionally, the thread-safe |
18 // alternative strerror_r varies in semantics across platforms. Use these | 20 // alternative strerror_r varies in semantics across platforms. Use these |
19 // functions instead. | 21 // functions instead. |
20 | 22 |
21 // Thread-safe strerror function with dependable semantics that never fails. | 23 // Thread-safe strerror function with dependable semantics that never fails. |
22 // It will write the string form of error "err" to buffer buf of length len. | 24 // It will write the string form of error "err" to buffer buf of length len. |
23 // If there is an error calling the OS's strerror_r() function then a message to | 25 // If there is an error calling the OS's strerror_r() function then a message to |
24 // that effect will be printed into buf, truncating if necessary. The final | 26 // that effect will be printed into buf, truncating if necessary. The final |
25 // result is always null-terminated. The value of errno is never changed. | 27 // result is always null-terminated. The value of errno is never changed. |
26 // | 28 // |
27 // Use this instead of strerror_r(). | 29 // Use this instead of strerror_r(). |
28 BASE_EXPORT void safe_strerror_r(int err, char *buf, size_t len); | 30 BASE_EXPORT void safe_strerror_r(int err, char *buf, size_t len); |
29 | 31 |
30 // Calls safe_strerror_r with a buffer of suitable size and returns the result | 32 // Calls safe_strerror_r with a buffer of suitable size and returns the result |
31 // in a C++ string. | 33 // in a C++ string. |
32 // | 34 // |
33 // Use this instead of strerror(). Note though that safe_strerror_r will be | 35 // Use this instead of strerror(). Note though that safe_strerror_r will be |
34 // more robust in the case of heap corruption errors, since it doesn't need to | 36 // more robust in the case of heap corruption errors, since it doesn't need to |
35 // allocate a string. | 37 // allocate a string. |
36 BASE_EXPORT std::string safe_strerror(int err); | 38 BASE_EXPORT std::string safe_strerror(int err); |
37 | 39 |
38 #endif // BASE_SAFE_STRERROR_POSIX_H_ | 40 } // namespace base |
| 41 |
| 42 #endif // BASE_POSIX_SAFE_STRERROR_H_ |
OLD | NEW |