third_party/perfetto/src/traced/probes/power/android_power_data_source.h

/*
 * Copyright (C) 2018 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef SRC_TRACED_PROBES_POWER_ANDROID_POWER_DATA_SOURCE_H_
#define SRC_TRACED_PROBES_POWER_ANDROID_POWER_DATA_SOURCE_H_

#include <bitset>
#include <memory>

#include "perfetto/ext/base/scoped_file.h"
#include "perfetto/ext/base/weak_ptr.h"
#include "perfetto/tracing/core/data_source_config.h"
#include "src/traced/probes/probes_data_source.h"

namespace perfetto {

class TraceWriter;
namespace base {
class TaskRunner;
}

class AndroidPowerDataSource : public ProbesDataSource {
 public:
  static const ProbesDataSource::Descriptor descriptor;

  AndroidPowerDataSource(DataSourceConfig,
                         base::TaskRunner*,
                         TracingSessionID,
                         std::unique_ptr<TraceWriter> writer);

  ~AndroidPowerDataSource() override;

  base::WeakPtr<AndroidPowerDataSource> GetWeakPtr() const;

  // ProbesDataSource implementation.
  void Start() override;
  void Flush(FlushRequestID, std::function<void()> callback) override;
  void ClearIncrementalState() override;

 private:
  struct DynamicLibLoader;

  void Tick();
  void WriteBatteryCounters();
  void WritePowerRailsData();
  void WriteEnergyEstimationBreakdown();
  void WriteEntityStateResidency();

  // Battery counters.
  std::bitset<8> counters_enabled_;

  // Power rails.
  bool rails_collection_enabled_ = false;

  // Energy estimation.
  bool energy_breakdown_collection_enabled_ = false;

  // Entity state residency
  bool entity_state_residency_collection_enabled_ = false;

  uint32_t poll_interval_ms_ = 0;
  bool should_emit_descriptors_ = true;

  base::TaskRunner* const task_runner_;
  std::unique_ptr<TraceWriter> writer_;
  std::unique_ptr<DynamicLibLoader> lib_;
  base::WeakPtrFactory<AndroidPowerDataSource> weak_factory_;  // Keep last.
};

}  // namespace perfetto

#endif  // SRC_TRACED_PROBES_POWER_ANDROID_POWER_DATA_SOURCE_H_