[llvm] Make llvm::telemetry::Manager::preDispatch protected. (PR #127114)

Vy Nguyen via llvm-commits llvm-commits at lists.llvm.org
Fri Feb 14 19:11:11 PST 2025


https://github.com/oontvoo updated https://github.com/llvm/llvm-project/pull/127114

>From cabc961038d19eb19536248872f799ce7bc70a33 Mon Sep 17 00:00:00 2001
From: Vy Nguyen <vyng at google.com>
Date: Thu, 13 Feb 2025 14:31:45 -0500
Subject: [PATCH 1/2] make llvm::telemetry::Manager::preDispatch protected. It
 should not be called directly by users

---
 llvm/include/llvm/Telemetry/Telemetry.h | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/llvm/include/llvm/Telemetry/Telemetry.h b/llvm/include/llvm/Telemetry/Telemetry.h
index 344a49df5cbf0..fc9169caacb4f 100644
--- a/llvm/include/llvm/Telemetry/Telemetry.h
+++ b/llvm/include/llvm/Telemetry/Telemetry.h
@@ -138,10 +138,6 @@ class Manager {
 public:
   virtual ~Manager() = default;
 
-  // Optional callback for subclasses to perform additional tasks before
-  // dispatching to Destinations.
-  virtual Error preDispatch(TelemetryInfo *Entry) = 0;
-
   // Dispatch Telemetry data to the Destination(s).
   // The argument is non-const because the Manager may add or remove
   // data from the entry.
@@ -150,6 +146,11 @@ class Manager {
   // Register a Destination.
   void addDestination(std::unique_ptr<Destination> Destination);
 
+protected:
+  // Optional callback for subclasses to perform additional tasks before
+  // dispatching to Destinations.
+  virtual Error preDispatch(TelemetryInfo *Entry) = 0;
+
 private:
   std::vector<std::unique_ptr<Destination>> Destinations;
 };

>From e1d87dc1fefa219f7cf342faab52c89d1b6514d6 Mon Sep 17 00:00:00 2001
From: Vy Nguyen <vyng at google.com>
Date: Fri, 14 Feb 2025 21:30:18 -0500
Subject: [PATCH 2/2] added header and provide empty impl for preDispatch

---
 llvm/include/llvm/Telemetry/Telemetry.h |  2 +-
 llvm/lib/Telemetry/Telemetry.cpp        | 13 +++++++++++++
 2 files changed, 14 insertions(+), 1 deletion(-)

diff --git a/llvm/include/llvm/Telemetry/Telemetry.h b/llvm/include/llvm/Telemetry/Telemetry.h
index fc9169caacb4f..8efea645ab51c 100644
--- a/llvm/include/llvm/Telemetry/Telemetry.h
+++ b/llvm/include/llvm/Telemetry/Telemetry.h
@@ -149,7 +149,7 @@ class Manager {
 protected:
   // Optional callback for subclasses to perform additional tasks before
   // dispatching to Destinations.
-  virtual Error preDispatch(TelemetryInfo *Entry) = 0;
+  virtual Error preDispatch(TelemetryInfo *Entry) {}
 
 private:
   std::vector<std::unique_ptr<Destination>> Destinations;
diff --git a/llvm/lib/Telemetry/Telemetry.cpp b/llvm/lib/Telemetry/Telemetry.cpp
index 9e13d08334e3b..badb07bff5477 100644
--- a/llvm/lib/Telemetry/Telemetry.cpp
+++ b/llvm/lib/Telemetry/Telemetry.cpp
@@ -1,3 +1,16 @@
+//===----------------------------------------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+///
+/// \file
+/// This file provides the basic framework for Telemetry.
+/// Refer to its documentation at llvm/docs/Telemetry.rst for more details.
+//===---------------------------------------------------------------------===//
+
 #include "llvm/Telemetry/Telemetry.h"
 
 namespace llvm {



More information about the llvm-commits mailing list