1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/toolkit/crashreporter/google-breakpad/src/common/linux/safe_readlink.h Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,65 @@
1.4 +// Copyright (c) 2011, Google Inc.
1.5 +// All rights reserved.
1.6 +//
1.7 +// Redistribution and use in source and binary forms, with or without
1.8 +// modification, are permitted provided that the following conditions are
1.9 +// met:
1.10 +//
1.11 +// * Redistributions of source code must retain the above copyright
1.12 +// notice, this list of conditions and the following disclaimer.
1.13 +// * Redistributions in binary form must reproduce the above
1.14 +// copyright notice, this list of conditions and the following disclaimer
1.15 +// in the documentation and/or other materials provided with the
1.16 +// distribution.
1.17 +// * Neither the name of Google Inc. nor the names of its
1.18 +// contributors may be used to endorse or promote products derived from
1.19 +// this software without specific prior written permission.
1.20 +//
1.21 +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1.22 +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1.23 +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1.24 +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
1.25 +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
1.26 +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
1.27 +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
1.28 +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
1.29 +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
1.30 +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
1.31 +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.32 +
1.33 +// safe_readlink.h: Define the google_breakpad::SafeReadLink function,
1.34 +// which wraps sys_readlink and gurantees the result is NULL-terminated.
1.35 +
1.36 +#ifndef COMMON_LINUX_SAFE_READLINK_H_
1.37 +#define COMMON_LINUX_SAFE_READLINK_H_
1.38 +
1.39 +#include <stddef.h>
1.40 +
1.41 +namespace google_breakpad {
1.42 +
1.43 +// This function wraps sys_readlink() and performs the same functionalty,
1.44 +// but guarantees |buffer| is NULL-terminated if sys_readlink() returns
1.45 +// no error. It takes the same arguments as sys_readlink(), but unlike
1.46 +// sys_readlink(), it returns true on success.
1.47 +//
1.48 +// |buffer_size| specifies the size of |buffer| in bytes. As this function
1.49 +// always NULL-terminates |buffer| on success, |buffer_size| should be
1.50 +// at least one byte longer than the expected path length (e.g. PATH_MAX,
1.51 +// which is typically defined as the maximum length of a path name
1.52 +// including the NULL byte).
1.53 +//
1.54 +// The implementation of this function calls sys_readlink() instead of
1.55 +// readlink(), it can thus be used in the context where calling to libc
1.56 +// functions is discouraged.
1.57 +bool SafeReadLink(const char* path, char* buffer, size_t buffer_size);
1.58 +
1.59 +// Same as the three-argument version of SafeReadLink() but deduces the
1.60 +// size of |buffer| if it is a char array of known size.
1.61 +template <size_t N>
1.62 +bool SafeReadLink(const char* path, char (&buffer)[N]) {
1.63 + return SafeReadLink(path, buffer, sizeof(buffer));
1.64 +}
1.65 +
1.66 +} // namespace google_breakpad
1.67 +
1.68 +#endif // COMMON_LINUX_SAFE_READLINK_H_
