toolkit/crashreporter/google-breakpad/src/common/linux/safe_readlink.h@6474c204b198 (annotated)
toolkit/crashreporter/google-breakpad/src/common/linux/safe_readlink.h
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | // Copyright (c) 2011, Google Inc. |
| michael@0 | 2 | // All rights reserved. |
| michael@0 | 3 | // |
| michael@0 | 4 | // Redistribution and use in source and binary forms, with or without |
| michael@0 | 5 | // modification, are permitted provided that the following conditions are |
| michael@0 | 6 | // met: |
| michael@0 | 7 | // |
| michael@0 | 8 | // * Redistributions of source code must retain the above copyright |
| michael@0 | 9 | // notice, this list of conditions and the following disclaimer. |
| michael@0 | 10 | // * Redistributions in binary form must reproduce the above |
| michael@0 | 11 | // copyright notice, this list of conditions and the following disclaimer |
| michael@0 | 12 | // in the documentation and/or other materials provided with the |
| michael@0 | 13 | // distribution. |
| michael@0 | 14 | // * Neither the name of Google Inc. nor the names of its |
| michael@0 | 15 | // contributors may be used to endorse or promote products derived from |
| michael@0 | 16 | // this software without specific prior written permission. |
| michael@0 | 17 | // |
| michael@0 | 18 | // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| michael@0 | 19 | // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| michael@0 | 20 | // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| michael@0 | 21 | // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| michael@0 | 22 | // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| michael@0 | 23 | // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| michael@0 | 24 | // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| michael@0 | 25 | // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| michael@0 | 26 | // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| michael@0 | 27 | // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| michael@0 | 28 | // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| michael@0 | 29 | |
| michael@0 | 30 | // safe_readlink.h: Define the google_breakpad::SafeReadLink function, |
| michael@0 | 31 | // which wraps sys_readlink and gurantees the result is NULL-terminated. |
| michael@0 | 32 | |
| michael@0 | 33 | #ifndef COMMON_LINUX_SAFE_READLINK_H_ |
| michael@0 | 34 | #define COMMON_LINUX_SAFE_READLINK_H_ |
| michael@0 | 35 | |
| michael@0 | 36 | #include <stddef.h> |
| michael@0 | 37 | |
| michael@0 | 38 | namespace google_breakpad { |
| michael@0 | 39 | |
| michael@0 | 40 | // This function wraps sys_readlink() and performs the same functionalty, |
| michael@0 | 41 | // but guarantees |buffer| is NULL-terminated if sys_readlink() returns |
| michael@0 | 42 | // no error. It takes the same arguments as sys_readlink(), but unlike |
| michael@0 | 43 | // sys_readlink(), it returns true on success. |
| michael@0 | 44 | // |
| michael@0 | 45 | // |buffer_size| specifies the size of |buffer| in bytes. As this function |
| michael@0 | 46 | // always NULL-terminates |buffer| on success, |buffer_size| should be |
| michael@0 | 47 | // at least one byte longer than the expected path length (e.g. PATH_MAX, |
| michael@0 | 48 | // which is typically defined as the maximum length of a path name |
| michael@0 | 49 | // including the NULL byte). |
| michael@0 | 50 | // |
| michael@0 | 51 | // The implementation of this function calls sys_readlink() instead of |
| michael@0 | 52 | // readlink(), it can thus be used in the context where calling to libc |
| michael@0 | 53 | // functions is discouraged. |
| michael@0 | 54 | bool SafeReadLink(const char* path, char* buffer, size_t buffer_size); |
| michael@0 | 55 | |
| michael@0 | 56 | // Same as the three-argument version of SafeReadLink() but deduces the |
| michael@0 | 57 | // size of |buffer| if it is a char array of known size. |
| michael@0 | 58 | template <size_t N> |
| michael@0 | 59 | bool SafeReadLink(const char* path, char (&buffer)[N]) { |
| michael@0 | 60 | return SafeReadLink(path, buffer, sizeof(buffer)); |
| michael@0 | 61 | } |
| michael@0 | 62 | |
| michael@0 | 63 | } // namespace google_breakpad |
| michael@0 | 64 | |
| michael@0 | 65 | #endif // COMMON_LINUX_SAFE_READLINK_H_ |
