blob: dabbba6f89d1a3b86a122f1edea0817944b7a55c [file] [log] [blame]
//===-- llvm/Support/Signposts.h - Interval debug annotations ---*- 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
/// \file Some OS's provide profilers that allow applications to provide custom
/// annotations to the profiler. For example, on Xcode 10 and later 'signposts'
/// can be emitted by the application and these will be rendered to the Points
/// of Interest track on the instruments timeline.
#include "llvm/ADT/StringRef.h"
#include <memory>
namespace llvm {
class SignpostEmitterImpl;
/// Manages the emission of signposts into the recording method supported by
/// the OS.
class SignpostEmitter {
std::unique_ptr<SignpostEmitterImpl> Impl;
bool isEnabled() const;
/// Begin a signposted interval for a given object.
void startInterval(const void *O, StringRef Name);
/// End a signposted interval for a given object.
void endInterval(const void *O, StringRef Name);
} // end namespace llvm