blob: 5ea595ef3b262f74299cec698604564c448980c0 [file] [log] [blame]
// Copyright 2017 The Crashpad Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef CRASHPAD_UTIL_PROCESS_PROCESS_MEMORY_H_
#define CRASHPAD_UTIL_PROCESS_PROCESS_MEMORY_H_
#include <sys/types.h>
#include <string>
#include "build/build_config.h"
#include "util/misc/address_types.h"
#if defined(OS_WIN)
#include <basetsd.h>
typedef SSIZE_T ssize_t;
#endif // defined(OS_WIN)
namespace crashpad {
//! \brief Abstract base class for accessing the memory of another process.
//!
//! Implementations are platform-specific.
class ProcessMemory {
public:
//! \brief Copies memory from the target process into a caller-provided buffer
//! in the current process.
//!
//! \param[in] address The address, in the target process' address space, of
//! the memory region to copy.
//! \param[in] size The size, in bytes, of the memory region to copy.
//! \a buffer must be at least this size.
//! \param[out] buffer The buffer into which the contents of the other
//! process' memory will be copied.
//!
//! \return `true` on success, with \a buffer filled appropriately. `false` on
//! failure, with a message logged.
bool Read(VMAddress address, size_t size, void* buffer) const;
//! \brief Reads a `NUL`-terminated C string from the target process into a
//! string in the current process.
//!
//! The length of the string need not be known ahead of time. This method will
//! read contiguous memory until a `NUL` terminator is found.
//!
//! \param[in] address The address, in the target process’s address space, of
//! the string to copy.
//! \param[out] string The string read from the other process.
//!
//! \return `true` on success, with \a string set appropriately. `false` on
//! failure, with a message logged. Failures can occur, for example, when
//! encountering unmapped or unreadable pages.
bool ReadCString(VMAddress address, std::string* string) const {
return ReadCStringInternal(address, false, 0, string);
}
//! \brief Reads a `NUL`-terminated C string from the target process into a
//! string in the current process.
//!
//! \param[in] address The address, in the target process’s address space, of
//! the string to copy.
//! \param[in] size The maximum number of bytes to read. The string is
//! required to be `NUL`-terminated within this many bytes.
//! \param[out] string The string read from the other process.
//!
//! \return `true` on success, with \a string set appropriately. `false` on
//! failure, with a message logged. Failures can occur, for example, when
//! a `NUL` terminator is not found within \a size bytes, or when
//! encountering unmapped or unreadable pages.
bool ReadCStringSizeLimited(VMAddress address,
size_t size,
std::string* string) const {
return ReadCStringInternal(address, true, size, string);
}
virtual ~ProcessMemory() = default;
protected:
ProcessMemory() = default;
private:
//! \brief Copies memory from the target process into a caller-provided buffer
//! in the current process, up to a maximum number of bytes.
//!
//! \param[in] address The address, in the target process' address space, of
//! the memory region to copy.
//! \param[in] size The maximum size, in bytes, of the memory region to copy.
//! \a buffer must be at least this size.
//! \param[out] buffer The buffer into which the contents of the other
//! process' memory will be copied.
//!
//! \return the number of bytes copied, 0 if there is no more data to read, or
//! -1 on failure with a message logged.
virtual ssize_t ReadUpTo(VMAddress address,
size_t size,
void* buffer) const = 0;
//! \brief Reads a `NUL`-terminated C string from the target process into a
//! string in the current process.
//!
//! \param[in] address The address, in the target process’s address space, of
//! the string to copy.
//! \param[in] has_size If true, this method will read \a size bytes. If
//! false, this method will ignore \a size and instead read contiguous
//! memory until a `NUL` terminator is found.
//! \param[in] size If \a has_size is true, the maximum number of bytes to
//! read. The string is required to be `NUL`-terminated within this many
//! bytes. Ignored if \a has_size is false.
//! \param[out] string The string read from the other process.
//!
//! \return `true` on success, with \a string set appropriately. `false` on
//! failure, with a message logged. Failures can occur, for example, when
//! encountering unmapped or unreadable pages.
virtual bool ReadCStringInternal(VMAddress address,
bool has_size,
size_t size,
std::string* string) const;
};
} // namespace crashpad
#endif // CRASHPAD_UTIL_PROCESS_PROCESS_MEMORY_H_