src/trace_processor/window_operator_table.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_TRACE_PROCESSOR_WINDOW_OPERATOR_TABLE_H_
#define SRC_TRACE_PROCESSOR_WINDOW_OPERATOR_TABLE_H_

#include <limits>
#include <memory>

#include "src/trace_processor/table.h"

namespace perfetto {
namespace trace_processor {

class TraceStorage;

class WindowOperatorTable : public Table {
 public:
  enum Column {
    kRowId = 0,
    kQuantum = 1,
    kWindowStart = 2,
    kWindowDur = 3,
    kTs = 4,
    kDuration = 5,
    kCpu = 6,
    kQuantumTs = 7
  };

  static void RegisterTable(sqlite3* db, const TraceStorage* storage);

  WindowOperatorTable(sqlite3*, const TraceStorage*);

  // Table implementation.
  std::string CreateTableStmt(int argc, const char* const* argv) override;
  std::unique_ptr<Table::Cursor> CreateCursor() override;
  int BestIndex(const QueryConstraints&, BestIndexInfo*) override;
  int Update(int, sqlite3_value**, sqlite3_int64*) override;

 private:
  class Cursor : public Table::Cursor {
   public:
    Cursor(const WindowOperatorTable*,
           uint64_t window_start,
           uint64_t window_end,
           uint64_t step_size);

    // Implementation of Table::Cursor.
    int Filter(const QueryConstraints&, sqlite3_value**) override;
    int Next() override;
    int Eof() override;
    int Column(sqlite3_context*, int N) override;

   private:
    // Defines the data to be generated by the table.
    enum FilterType {
      // Returns all the spans for all CPUs.
      kReturnAll = 0,
      // Only returns the first span of the table. Useful for UPDATE operations.
      kReturnFirst = 1,
      // Only returns all the spans for a chosen CPU.
      kReturnCpu = 2,
    };

    uint64_t const window_start_;
    uint64_t const window_end_;
    uint64_t const step_size_;
    const WindowOperatorTable* const table_;

    uint64_t current_ts_ = 0;
    uint32_t current_cpu_ = 0;
    uint64_t quantum_ts_ = 0;
    uint64_t row_id_ = 0;

    FilterType filter_type_ = FilterType::kReturnAll;
  };

  uint64_t quantum_ = 0;
  uint64_t window_start_ = 0;

  // max of int64_t because SQLite technically only supports int64s and not
  // uint64s.
  uint64_t window_dur_ = std::numeric_limits<int64_t>::max();
};
}  // namespace trace_processor
}  // namespace perfetto

#endif  // SRC_TRACE_PROCESSOR_WINDOW_OPERATOR_TABLE_H_