File size: 2,048 Bytes
9c6594c |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 |
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree.
*/
#pragma once
#include <string>
#include "ActivityType.h"
namespace libkineto {
class ActivityLogger;
struct TraceSpan;
// Generic activity interface is borrowed from tensorboard protobuf format.
struct ITraceActivity {
virtual ~ITraceActivity() {}
// Device is a physical or logical entity, e.g. CPU, GPU or process
virtual int64_t deviceId() const = 0;
// A resource is something on the device, h/w thread,
// functional units etc.
virtual int64_t resourceId() const = 0;
// s/w thread
virtual int32_t getThreadId() const = 0;
// Start timestamp in nanoseconds
virtual int64_t timestamp() const = 0;
// Duration in nanoseconds
virtual int64_t duration() const = 0;
// Used to link up async activities
virtual int64_t correlationId() const = 0;
// Part of a flow, identified by flow id and type
virtual int flowType() const = 0;
virtual int64_t flowId() const = 0;
virtual bool flowStart() const = 0;
virtual ActivityType type() const = 0;
virtual const std::string name() const = 0;
// Optional linked activity
virtual const ITraceActivity* linkedActivity() const = 0;
// Optional containing trace object
virtual const TraceSpan* traceSpan() const = 0;
// Log activity
virtual void log(ActivityLogger& logger) const = 0;
// Return json formatted metadata
// FIXME: Return iterator to dynamic type map here instead
virtual const std::string metadataJson() const = 0;
// Return the metadata value in string format with key
// @lint-ignore CLANGTIDY: clang-diagnostic-unused-parameter
virtual const std::string getMetadataValue(const std::string& key) const {
return "";
}
static int64_t nsToUs(int64_t ns) {
// It's important that this conversion is the same everywhere.
// No rounding!
return ns / 1000;
}
};
} // namespace libkineto
|