8b3af63b89
A lot of comments in LLDB are surrounded by an ASCII line to delimit the begging and end of the comment. Its use is not really consistent across the code base, sometimes the lines are longer, sometimes they are shorter and sometimes they are omitted. Furthermore, it looks kind of weird with the 80 column limit, where the comment actually extends past the line, but not by much. Furthermore, when /// is used for Doxygen comments, it looks particularly odd. And when // is used, it incorrectly gives the impression that it's actually a Doxygen comment. I assume these lines were added to improve distinguishing between comments and code. However, given that todays editors and IDEs do a great job at highlighting comments, I think it's worth to drop this for the sake of consistency. The alternative is fixing all the inconsistencies, which would create a lot more churn. Differential revision: https://reviews.llvm.org/D60508 llvm-svn: 358135
108 lines
3.3 KiB
C++
108 lines
3.3 KiB
C++
//===-- DarwinLogCollector.h ------------------------------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef DarwinLogCollector_h
|
|
#define DarwinLogCollector_h
|
|
|
|
#include <sys/types.h>
|
|
|
|
#include <memory>
|
|
#include <mutex>
|
|
#include <unordered_map>
|
|
|
|
#include "ActivityStore.h"
|
|
#include "ActivityStreamSPI.h"
|
|
#include "DNBDefs.h"
|
|
#include "DarwinLogEvent.h"
|
|
#include "DarwinLogInterfaces.h"
|
|
#include "JSON.h"
|
|
|
|
class DarwinLogCollector;
|
|
typedef std::shared_ptr<DarwinLogCollector> DarwinLogCollectorSP;
|
|
|
|
class DarwinLogCollector
|
|
: public std::enable_shared_from_this<DarwinLogCollector>,
|
|
public ActivityStore {
|
|
public:
|
|
/// Return whether the os_log and activity tracing SPI is available.
|
|
///
|
|
/// \return \b true if the activity stream support is available,
|
|
/// \b false otherwise.
|
|
static bool IsSupported();
|
|
|
|
/// Return a log function suitable for DNBLog to use as the internal
|
|
/// logging function.
|
|
///
|
|
/// \return a DNBLog-style logging function if IsSupported() returns
|
|
/// true; otherwise, returns nullptr.
|
|
static DNBCallbackLog GetLogFunction();
|
|
|
|
static bool StartCollectingForProcess(nub_process_t pid,
|
|
const JSONObject &config);
|
|
|
|
static bool CancelStreamForProcess(nub_process_t pid);
|
|
|
|
static DarwinLogEventVector GetEventsForProcess(nub_process_t pid);
|
|
|
|
~DarwinLogCollector();
|
|
|
|
pid_t GetProcessID() const { return m_pid; }
|
|
|
|
// ActivityStore API
|
|
const char *GetActivityForID(os_activity_id_t activity_id) const override;
|
|
|
|
std::string
|
|
GetActivityChainForID(os_activity_id_t activity_id) const override;
|
|
|
|
private:
|
|
DarwinLogCollector() = delete;
|
|
DarwinLogCollector(const DarwinLogCollector &) = delete;
|
|
DarwinLogCollector &operator=(const DarwinLogCollector &) = delete;
|
|
|
|
explicit DarwinLogCollector(nub_process_t pid,
|
|
const LogFilterChainSP &filter_chain_sp);
|
|
|
|
void SignalDataAvailable();
|
|
|
|
void SetActivityStream(os_activity_stream_t activity_stream);
|
|
|
|
bool HandleStreamEntry(os_activity_stream_entry_t entry, int error);
|
|
|
|
DarwinLogEventVector RemoveEvents();
|
|
|
|
void CancelActivityStream();
|
|
|
|
void GetActivityChainForID_internal(os_activity_id_t activity_id,
|
|
std::string &result, size_t depth) const;
|
|
|
|
struct ActivityInfo {
|
|
ActivityInfo(const char *name, os_activity_id_t activity_id,
|
|
os_activity_id_t parent_activity_id)
|
|
: m_name(name), m_id(activity_id), m_parent_id(parent_activity_id) {}
|
|
|
|
const std::string m_name;
|
|
const os_activity_id_t m_id;
|
|
const os_activity_id_t m_parent_id;
|
|
};
|
|
|
|
using ActivityMap = std::unordered_map<os_activity_id_t, ActivityInfo>;
|
|
|
|
const nub_process_t m_pid;
|
|
os_activity_stream_t m_activity_stream;
|
|
DarwinLogEventVector m_events;
|
|
std::mutex m_events_mutex;
|
|
LogFilterChainSP m_filter_chain_sp;
|
|
|
|
/// Mutex to protect activity info (activity name and parent structures)
|
|
mutable std::mutex m_activity_info_mutex;
|
|
/// Map of activity id to ActivityInfo
|
|
ActivityMap m_activity_map;
|
|
};
|
|
|
|
#endif /* LogStreamCollector_h */
|