update kineto to v2.7.0 (#7)

Author: fmo-mt

libkineto/include/AbstractConfig.h

@@ -14,7 +14,7 @@
 #include <string>
 #include <vector>
 
-namespace KINETO_NAMESPACE {
+namespace libkineto {
 
 class AbstractConfig {
  public:
@@ -80,11 +80,15 @@ class AbstractConfig {
   // multiple options.
   // Throw std::invalid_argument if automatic correction can not be made.
   //
-  // @param fallbackProfileStartTime Specify a fallback profile start timestamp in case it was never specified by the client
-  virtual void validate(const std::chrono::time_point<std::chrono::system_clock>& fallbackProfileStartTime) = 0;
+  // @param fallbackProfileStartTime Specify a fallback profile start timestamp
+  // in case it was never specified by the client
+  virtual void validate(
+      const std::chrono::time_point<std::chrono::system_clock>&
+          fallbackProfileStartTime) = 0;
 
   // TODO: Separate out each profiler type into features?
   virtual void printActivityProfilerConfig(std::ostream& s) const;
+  virtual void setActivityDependentConfig();
 
   // Helpers for use in handleOption
   // Split a string by delimiter and remove external white space
@@ -116,4 +120,4 @@ class AbstractConfig {
   std::map<std::string, AbstractConfig*> featureConfigs_{};
 };
 
-} // namespace KINETO_NAMESPACE
+} // namespace libkineto

libkineto/include/ActivityProfilerInterface.h

@@ -13,8 +13,8 @@
 #include <thread>
 #include <vector>
 
-#include "ActivityType.h"
 #include "ActivityTraceInterface.h"
+#include "ActivityType.h"
 #include "IActivityProfiler.h"
 
 namespace libkineto {
@@ -24,15 +24,14 @@ struct CpuTraceBuffer;
 class Config;
 
 class ActivityProfilerInterface {
-
  public:
-  virtual ~ActivityProfilerInterface() {};
+  virtual ~ActivityProfilerInterface() {}
 
   virtual void init() {}
   virtual bool isInitialized() {
     return false;
   }
-  virtual bool isActive(){
+  virtual bool isActive() {
     return false;
   }
 
@@ -41,10 +40,6 @@ class ActivityProfilerInterface {
   // and duration and / or iteration stop criterion.
   // Tracing terminates when either condition is met.
   virtual void scheduleTrace(const std::string& configStr) {}
-  virtual bool isSyncProfilingRunning() {
-    return false;
-  }
-  virtual void setSyncProfilingRunning(bool b) {}
 
   // *** Synchronous API ***
   // These must be called in order:
@@ -78,22 +73,23 @@ class ActivityProfilerInterface {
 
   // *** TraceActivity API ***
   // FIXME: Pass activityProfiler interface into clientInterface?
-  virtual void pushCorrelationId(uint64_t id){}
-  virtual void popCorrelationId(){}
-  virtual void transferCpuTrace(
-      std::unique_ptr<CpuTraceBuffer> traceBuffer){}
+  virtual void pushCorrelationId(uint64_t id) {}
+  virtual void popCorrelationId() {}
+  virtual void transferCpuTrace(std::unique_ptr<CpuTraceBuffer> traceBuffer) {}
 
   // Correlation ids for user defined spans
-  virtual void pushUserCorrelationId(uint64_t){}
-  virtual void popUserCorrelationId(){}
+  virtual void pushUserCorrelationId(uint64_t) {}
+  virtual void popUserCorrelationId() {}
 
   // Saves information for the current thread to be used in profiler output
   // Client must record any new kernel thread where the activity has occured.
   virtual void recordThreadInfo() {}
 
   // Record trace metadata, currently supporting only string key and values,
   // values with the same key are overwritten
-  virtual void addMetadata(const std::string& key, const std::string& value) = 0;
+  virtual void addMetadata(
+      const std::string& key,
+      const std::string& value) = 0;
 
   // Add a child activity profiler, this enables frameworks in the application
   // to enable custom framework events.

libkineto/include/Config.h

@@ -18,9 +18,7 @@
 #include <string>
 #include <vector>
 
-namespace KINETO_NAMESPACE {
-
-using namespace libkineto;
+namespace libkineto {
 
 class Config : public AbstractConfig {
  public:
@@ -47,7 +45,7 @@ class Config : public AbstractConfig {
 
   bool activityProfilerEnabled() const {
     return activityProfilerEnabled_ ||
-      activitiesOnDemandTimestamp_.time_since_epoch().count() > 0;
+        activitiesOnDemandTimestamp_.time_since_epoch().count() > 0;
   }
 
   // Log activitiy trace to this file
@@ -176,6 +174,11 @@ class Config : public AbstractConfig {
     return selectedActivityTypes_;
   }
 
+  // Set the types of activities to be traced
+  bool perThreadBufferEnabled() const {
+    return perThreadBufferEnabled_;
+  }
+
   void setSelectedActivityTypes(const std::set<ActivityType>& types) {
     selectedActivityTypes_ = types;
   }
@@ -352,9 +355,9 @@ class Config : public AbstractConfig {
   }
 
   void updateActivityProfilerRequestReceivedTime();
-  void updateActivityProfilerStartTime();
 
   void printActivityProfilerConfig(std::ostream& s) const override;
+  void setActivityDependentConfig() override;
 
   void validate(const std::chrono::time_point<std::chrono::system_clock>&
                     fallbackProfileStartTime) override;
@@ -371,6 +374,14 @@ class Config : public AbstractConfig {
   // correct destruction order can be ensured.
   static std::shared_ptr<void> getStaticObjectsLifetimeHandle();
 
+  bool getTSCTimestampFlag() const {
+    return useTSCTimestamp_;
+  }
+
+  void setTSCTimestampFlag(bool flag) {
+    useTSCTimestamp_ = flag;
+  }
+
  private:
   explicit Config(const Config& other) = default;
 
@@ -425,6 +436,9 @@ class Config : public AbstractConfig {
 
   // Activity profiler
   bool activityProfilerEnabled_;
+
+  // Enable per-thread buffer
+  bool perThreadBufferEnabled_;
   std::set<ActivityType> selectedActivityTypes_;
 
   // The activity profiler settings are all on-demand
@@ -489,12 +503,13 @@ class Config : public AbstractConfig {
   // MUPTI Device Buffer
   size_t muptiDeviceBufferSize_;
   size_t muptiDeviceBufferPoolLimit_;
+
+  // MUPTI Timestamp Format
+  bool useTSCTimestamp_{true};
 };
 
 constexpr char kUseDaemonEnvVar[] = "KINETO_USE_DAEMON";
 
-#if __linux__
 bool isDaemonEnvVarSet();
-#endif
 
 } // namespace libkineto

libkineto/include/GenericTraceActivity.h

@@ -9,11 +9,11 @@
 #pragma once
 
 #include <fmt/format.h>
+#include <sstream>
 #include <string>
 #include <thread>
 #include <unordered_map>
 #include <vector>
-#include <sstream>
 
 #include "ITraceActivity.h"
 #include "ThreadUtil.h"
@@ -25,15 +25,18 @@ namespace libkineto {
 constexpr unsigned int kLinkFwdBwd = 1;
 constexpr unsigned int kLinkAsyncCpuGpu = 2;
 
-// @lint-ignore-every CLANGTIDY cppcoreguidelines-non-private-member-variables-in-classes
+// @lint-ignore-every CLANGTIDY
+// cppcoreguidelines-non-private-member-variables-in-classes
 // @lint-ignore-every CLANGTIDY cppcoreguidelines-pro-type-member-init
 class GenericTraceActivity : public ITraceActivity {
  public:
   GenericTraceActivity()
       : activityType(ActivityType::ENUM_COUNT), traceSpan_(nullptr) {}
 
   GenericTraceActivity(
-      const TraceSpan& trace, ActivityType type, const std::string& name)
+      const TraceSpan& trace,
+      ActivityType type,
+      const std::string& name)
       : activityType(type), activityName(name), traceSpan_(&trace) {}
 
   int64_t deviceId() const override {
@@ -72,7 +75,7 @@ class GenericTraceActivity : public ITraceActivity {
     return flow.type;
   }
 
-  int flowId() const override {
+  int64_t flowId() const override {
     return flow.id;
   }
 
@@ -121,7 +124,7 @@ class GenericTraceActivity : public ITraceActivity {
     return json.str();
   }
 
-  virtual ~GenericTraceActivity() override {};
+  virtual ~GenericTraceActivity() override {}
 
   int64_t startTime{0};
   int64_t endTime{0};
@@ -132,7 +135,7 @@ class GenericTraceActivity : public ITraceActivity {
   ActivityType activityType;
   std::string activityName;
   struct Flow {
-    Flow(): id(0), type(0), start(0) {}
+    Flow() : id(0), type(0), start(0) {}
     // Ids must be unique within each type
     uint32_t id : 27;
     // Type will be used to connect flows between profilers, as

libkineto/include/IActivityProfiler.h

@@ -23,7 +23,6 @@
 
 namespace libkineto {
 
-using namespace KINETO_NAMESPACE;
 struct CpuTraceBuffer;
 
 #ifdef _MSC_VER
@@ -52,10 +51,10 @@ struct DeviceInfo {
       const std::string& name,
       const std::string& label)
       : id(id), sortIndex(sortIndex), name(name), label(label) {}
-  int64_t id;               // process id
-  int64_t sortIndex;        // position in trace view
-  const std::string name;   // process name
-  const std::string label;  // device label
+  int64_t id; // process id
+  int64_t sortIndex; // position in trace view
+  const std::string name; // process name
+  const std::string label; // device label
 };
 
 /* ResourceInfo:
@@ -68,21 +67,20 @@ struct ResourceInfo {
       int64_t sortIndex,
       const std::string& name)
       : id(id), sortIndex(sortIndex), deviceId(deviceId), name(name) {}
-  int64_t id;             // resource id
-  int64_t sortIndex;      // position in trace view
-  int64_t deviceId;       // id of device which owns this resource (specified in DeviceInfo.id)
+  int64_t id; // resource id
+  int64_t sortIndex; // position in trace view
+  int64_t deviceId; // id of device which owns this resource (specified in
+                    // DeviceInfo.id)
   const std::string name; // resource name
 };
 
-using getLinkedActivityCallback =
-  std::function<const ITraceActivity*(int32_t)>;
+using getLinkedActivityCallback = std::function<const ITraceActivity*(int32_t)>;
 
 /* IActivityProfilerSession:
  *   an opaque object that can be used by a high level profiler to
  *   start/stop and return trace events.
  */
 class IActivityProfilerSession {
-
  public:
   virtual ~IActivityProfilerSession() {}
 
@@ -102,9 +100,11 @@ class IActivityProfilerSession {
   // processes trace activities using logger
   virtual void processTrace(ActivityLogger& logger) = 0;
 
-  virtual void processTrace(ActivityLogger& logger,
-    getLinkedActivityCallback /*getLinkedActivity*/,
-    int64_t /*startTime*/, int64_t /*endTime*/) {
+  virtual void processTrace(
+      ActivityLogger& logger,
+      getLinkedActivityCallback /*getLinkedActivity*/,
+      int64_t /*startTime*/,
+      int64_t /*endTime*/) {
     processTrace(logger);
   }
 
@@ -126,21 +126,22 @@ class IActivityProfilerSession {
   virtual void pushUserCorrelationId(uint64_t /*id*/) {}
   virtual void popUserCorrelationId() {}
 
+  virtual std::string getDeviceProperties() {
+    return "";
+  }
+
  protected:
   TraceStatus status_ = TraceStatus::READY;
 };
 
-
 /* Activity Profiler Plugins:
  *   These allow other frameworks to integrate into Kineto's primariy
  *   activity profiler. While the primary activity profiler handles
  *   timing the trace collections and correlating events the plugins
  *   can become source of new trace activity types.
  */
 class IActivityProfiler {
-
  public:
-
   virtual ~IActivityProfiler() {}
 
   // name of profiler

libkineto/include/ILoggerObserver.h

@@ -15,32 +15,39 @@ constexpr char kWarmUpStage[] = "Warm Up";
 constexpr char kCollectionStage[] = "Collection";
 constexpr char kPostProcessingStage[] = "Post Processing";
 
+// Special string in UST for determining if traces are empty
+constexpr char kEmptyTrace[] =
+    "No Valid Trace Events (CPU/GPU) found. Outputting empty trace.";
+
 #if !USE_GOOGLE_LOG
 
 #include <map>
 #include <vector>
 
+#include <stdint.h>
+
 namespace libkineto {
 
 enum LoggerOutputType {
   VERBOSE = 0,
   INFO = 1,
   WARNING = 2,
-  ERROR = 3,
-  STAGE = 4,
+  STAGE = 3,
+  ERROR = 4,
   ENUM_COUNT = 5
 };
 
 const char* toString(LoggerOutputType t);
 LoggerOutputType toLoggerOutputType(const std::string& str);
 
-constexpr int LoggerTypeCount = (int) LoggerOutputType::ENUM_COUNT;
+constexpr int LoggerTypeCount = (int)LoggerOutputType::ENUM_COUNT;
 
 class ILoggerObserver {
  public:
   virtual ~ILoggerObserver() = default;
   virtual void write(const std::string& message, LoggerOutputType ot) = 0;
-  virtual const std::map<LoggerOutputType, std::vector<std::string>> extractCollectorMetadata() = 0;
+  virtual const std::map<LoggerOutputType, std::vector<std::string>>
+  extractCollectorMetadata() = 0;
   virtual void reset() = 0;
   virtual void addDevice(const int64_t device) = 0;
   virtual void setTraceDurationMS(const int64_t duration) = 0;
@@ -49,8 +56,9 @@ class ILoggerObserver {
   virtual void setGroupTraceID(const std::string&) {}
   virtual void addDestination(const std::string& dest) = 0;
   virtual void setTriggerOnDemand() {}
-  virtual void addMetadata(const std::string& key, const std::string& value) = 0;
-
+  virtual void addMetadata(
+      const std::string& key,
+      const std::string& value) = 0;
 };
 
 } // namespace libkineto