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