/*
 * Copyright (C) 2024 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_TRACE_PROCESSOR_IMPORTERS_COMMON_SCHED_EVENT_TRACKER_H_
#define SRC_TRACE_PROCESSOR_IMPORTERS_COMMON_SCHED_EVENT_TRACKER_H_

#include <cstdint>

#include "perfetto/base/logging.h"
#include "perfetto/public/compiler.h"
#include "src/trace_processor/importers/common/cpu_tracker.h"
#include "src/trace_processor/importers/common/event_tracker.h"
#include "src/trace_processor/storage/trace_storage.h"
#include "src/trace_processor/types/destructible.h"
#include "src/trace_processor/types/trace_processor_context.h"

namespace perfetto::trace_processor {

// Tracks per-cpu scheduling events, storing them as slices in the |sched|
// table.
class SchedEventTracker : public Destructible {
 public:
  PERFETTO_ALWAYS_INLINE
  explicit SchedEventTracker(TraceProcessorContext* context)
      : context_(context) {}
  SchedEventTracker(const SchedEventTracker&) = delete;
  ~SchedEventTracker() override;

  PERFETTO_ALWAYS_INLINE
  uint32_t AddStartSlice(uint32_t cpu,
                         int64_t ts,
                         UniqueTid next_utid,
                         int32_t next_prio) {
    // Open a new scheduling slice, corresponding to the task that was
    // just switched to. Set the duration to -1, to indicate that the event is
    // not finished. Duration will be updated later after event finish.
    auto* sched = context_->storage->mutable_sched_slice_table();
    // Get the unique CPU Id over all machines from the CPU table.
    auto ucpu = context_->cpu_tracker->GetOrCreateCpu(cpu);
    auto row_and_id = sched->Insert(
        {ts, /* duration */ -1, next_utid, kNullStringId, next_prio, ucpu});
    SchedId sched_id = row_and_id.id;
    return sched->FindById(sched_id)->ToRowNumber().row_number();
  }

  PERFETTO_ALWAYS_INLINE
  bool UpdateEventTrackerTimestamp(int64_t ts,
                                   const char* event_name,
                                   size_t stats) {
    // Post sorter stage, all events should be globally timestamp ordered.
    int64_t max_ts = context_->event_tracker->max_timestamp();
    if (ts < max_ts) {
      PERFETTO_ELOG("%s event out of order by %.4f ms, skipping", event_name,
                    static_cast<double>(max_ts - ts) / 1e6);
      context_->storage->IncrementStats(stats);
      return false;
    }
    context_->event_tracker->UpdateMaxTimestamp(ts);
    return true;
  }

  PERFETTO_ALWAYS_INLINE
  void ClosePendingSlice(uint32_t pending_slice_idx,
                         int64_t ts,
                         StringId prev_state) {
    auto* slices = context_->storage->mutable_sched_slice_table();
    auto r = (*slices)[pending_slice_idx];
    r.set_dur(ts - r.ts());
    r.set_end_state(prev_state);
  }

 private:
  TraceProcessorContext* const context_;
};

}  // namespace perfetto::trace_processor

#endif  // SRC_TRACE_PROCESSOR_IMPORTERS_COMMON_SCHED_EVENT_TRACKER_H_