blob: 1c91c9fdd48957aadacfc87e3fada50e2295164a [file] [log] [blame]
//===-- UnixSignals.h -------------------------------------------*- C++ -*-===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#include <map>
#include <string>
#include <vector>
#include "lldb/Utility/ConstString.h"
#include "lldb/lldb-private.h"
#include "llvm/ADT/Optional.h"
#include "llvm/Support/JSON.h"
namespace lldb_private {
class UnixSignals {
static lldb::UnixSignalsSP Create(const ArchSpec &arch);
static lldb::UnixSignalsSP CreateForHost();
// Constructors and Destructors
virtual ~UnixSignals();
const char *GetSignalAsCString(int32_t signo) const;
bool SignalIsValid(int32_t signo) const;
int32_t GetSignalNumberFromName(const char *name) const;
const char *GetSignalInfo(int32_t signo, bool &should_suppress,
bool &should_stop, bool &should_notify) const;
bool GetShouldSuppress(int32_t signo) const;
bool SetShouldSuppress(int32_t signo, bool value);
bool SetShouldSuppress(const char *signal_name, bool value);
bool GetShouldStop(int32_t signo) const;
bool SetShouldStop(int32_t signo, bool value);
bool SetShouldStop(const char *signal_name, bool value);
bool GetShouldNotify(int32_t signo) const;
bool SetShouldNotify(int32_t signo, bool value);
bool SetShouldNotify(const char *signal_name, bool value);
// These provide an iterator through the signals available on this system.
// Call GetFirstSignalNumber to get the first entry, then iterate on
// GetNextSignalNumber till you get back LLDB_INVALID_SIGNAL_NUMBER.
int32_t GetFirstSignalNumber() const;
int32_t GetNextSignalNumber(int32_t current_signal) const;
int32_t GetNumSignals() const;
int32_t GetSignalAtIndex(int32_t index) const;
ConstString GetShortName(ConstString name) const;
// We assume that the elements of this object are constant once it is
// constructed, since a process should never need to add or remove symbols as
// it runs. So don't call these functions anywhere but the constructor of
// your subclass of UnixSignals or in your Process Plugin's GetUnixSignals
// method before you return the UnixSignal object.
void AddSignal(int signo, const char *name, bool default_suppress,
bool default_stop, bool default_notify,
const char *description, const char *alias = nullptr);
void RemoveSignal(int signo);
/// Track how many times signals are hit as stop reasons.
void IncrementSignalHitCount(int signo);
/// Get the hit count statistics for signals.
/// Gettings statistics on the hit counts of signals can help explain why some
/// debug sessions are slow since each stop takes a few hundred ms and some
/// software use signals a lot and can cause slow debugging performance if
/// they are used too often. Even if a signal is not stopped at, it will auto
/// continue the process and a delay will happen.
llvm::json::Value GetHitCountStatistics() const;
// Returns a current version of the data stored in this class. Version gets
// incremented each time Set... method is called.
uint64_t GetVersion() const;
// Returns a vector of signals that meet criteria provided in arguments. Each
// should_[suppress|stop|notify] flag can be None - no filtering by this
// flag true - only signals that have it set to true are returned false -
// only signals that have it set to true are returned
std::vector<int32_t> GetFilteredSignals(llvm::Optional<bool> should_suppress,
llvm::Optional<bool> should_stop,
llvm::Optional<bool> should_notify);
// Classes that inherit from UnixSignals can see and modify these
struct Signal {
ConstString m_name;
ConstString m_alias;
std::string m_description;
uint32_t m_hit_count = 0;
bool m_suppress : 1, m_stop : 1, m_notify : 1;
Signal(const char *name, bool default_suppress, bool default_stop,
bool default_notify, const char *description, const char *alias);
~Signal() = default;
virtual void Reset();
typedef std::map<int32_t, Signal> collection;
collection m_signals;
// This version gets incremented every time something is changing in this
// class, including when we call AddSignal from the constructor. So after the
// object is constructed m_version is going to be > 0 if it has at least one
// signal registered in it.
uint64_t m_version = 0;
// GDBRemote signals need to be copyable.
UnixSignals(const UnixSignals &rhs);
const UnixSignals &operator=(const UnixSignals &rhs) = delete;
} // Namespace lldb