crashpad/util/linux/ptracer.h
Joshua Peraza 59c5d848e5 linux: Refactor ptrace usage.
1) Add PtraceConnection which serves as the base class for specific
types of connections Crashpad uses to trace processes.
2) Add DirectPtraceConnection which is used when the handler process
has `ptrace` capabilities for the target process.
3) Move `ptrace` logic into Ptracer. This class isolates `ptrace` call
logic for use by various PtraceConnection implementations.

Bug: crashpad:30
Change-Id: I98083134a9f7d9f085e4cc816d2b85ffd6d73162
Reviewed-on: https://chromium-review.googlesource.com/671659
Commit-Queue: Joshua Peraza <jperaza@chromium.org>
Reviewed-by: Mark Mentovai <mark@chromium.org>
Reviewed-by: Leonard Mosescu <mosescu@chromium.org>
2017-09-22 16:25:32 +00:00

79 lines
2.6 KiB
C++

// 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_LINUX_PTRACER_H_
#define CRASHPAD_UTIL_LINUX_PTRACER_H_
#include <sys/types.h>
#include "base/macros.h"
#include "util/linux/address_types.h"
#include "util/linux/thread_info.h"
#include "util/misc/initialization_state_dcheck.h"
namespace crashpad {
//! \brief Provides an architecturally agnostic interface for collecting
//! information with `ptrace`.
//!
//! A ptracer is configured for a particular bitness. It is an error to make any
//! calls via this object against a thread whose bitness does not match the
//! bitness this object was initialized with.
class Ptracer {
public:
//! \brief Constructs this object with a pre-determined bitness.
//!
//! \param[in] is_64_bit `true` if this object is to be configured for 64-bit.
explicit Ptracer(bool is_64_bit);
//! \brief Constructs this object without a pre-determined bitness.
//!
//! Initialize() must be successfully called before making any other calls on
//! this object.
Ptracer();
~Ptracer();
//! \brief Initializes this object to the bitness of the process whose process
//! ID is \a pid.
//!
//! \param[in] pid The process ID of the process to initialize with.
//! \return `true` on success. `false` on failure with a message logged.
bool Initialize(pid_t pid);
//! \brief Return `true` if this object is configured for 64-bit.
bool Is64Bit();
//! \brief Uses `ptrace` to collect information about the thread with thread
//! ID \a tid.
//!
//! The target thread should be attached before calling this method.
//! \see ScopedPtraceAttach
//!
//! \param[in] tid The thread ID of the thread to collect information for.
//! \param[out] info A ThreadInfo for the thread.
//! \return `true` on success. `false` on failure with a message logged.
bool GetThreadInfo(pid_t tid, ThreadInfo* info);
private:
bool is_64_bit_;
InitializationStateDcheck initialized_;
DISALLOW_COPY_AND_ASSIGN(Ptracer);
};
} // namespace crashpad
#endif // CRASHPAD_UTIL_LINUX_PTRACER_H_