File size: 3,776 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 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 |
/*
* 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 <chrono>
#include <map>
#include <memory>
#include <string>
#include <vector>
namespace libkineto {
class AbstractConfig {
public:
AbstractConfig& operator=(const AbstractConfig&) = delete;
AbstractConfig(AbstractConfig&&) = delete;
AbstractConfig& operator=(AbstractConfig&&) = delete;
virtual ~AbstractConfig() {
for (const auto& p : featureConfigs_) {
delete p.second;
}
}
// Return a copy of the full derived class
virtual AbstractConfig* cloneDerived(AbstractConfig& parent) const = 0;
// Returns true if successfully parsed the config string
bool parse(const std::string& conf);
// Default setup for signal-triggered profiling
virtual void setSignalDefaults() {
for (auto& p : featureConfigs_) {
p.second->setSignalDefaults();
}
}
// Default setup for client-triggered profiling
virtual void setClientDefaults() {
for (auto& p : featureConfigs_) {
p.second->setClientDefaults();
}
}
// Time config was created / updated
std::chrono::time_point<std::chrono::system_clock> timestamp() const {
return timestamp_;
}
// Source config string that this was parsed from
const std::string& source() const {
return source_;
}
AbstractConfig& feature(std::string name) const {
const auto& pos = featureConfigs_.find(name);
return *pos->second;
}
// Transfers ownership of cfg arg
void addFeature(const std::string& name, AbstractConfig* cfg) {
featureConfigs_[name] = cfg;
}
protected:
AbstractConfig() {}
AbstractConfig(const AbstractConfig& other) = default;
// Return true if the option was recognized and successfully parsed.
// Throw std::invalid_argument if val is invalid.
virtual bool handleOption(const std::string& name, std::string& val);
// Perform post-validation checks, typically conditons involving
// 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;
// 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
std::vector<std::string> splitAndTrim(const std::string& s, char delim) const;
// Lowercase for case-insensitive comparisons
std::string toLower(std::string& s) const;
// Does string end with suffix
bool endsWith(const std::string& s, const std::string& suffix) const;
// Conversions
int64_t toIntRange(const std::string& val, int64_t min, int64_t max) const;
int32_t toInt32(const std::string& val) const;
int64_t toInt64(const std::string& val) const;
bool toBool(std::string& val) const;
void cloneFeaturesInto(AbstractConfig& cfg) const {
for (const auto& feature : featureConfigs_) {
cfg.featureConfigs_[feature.first] = feature.second->cloneDerived(cfg);
}
}
private:
// Time config was created / updated
std::chrono::time_point<std::chrono::system_clock> timestamp_{};
// Original configuration string, used for comparison
std::string source_{""};
// Configuration objects for optional features
std::map<std::string, AbstractConfig*> featureConfigs_{};
};
} // namespace libkineto
|