/*
 * Copyright (C) 2017 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.
 */

syntax = "proto2";

import "protos/perfetto/trace/android/server/windowmanagerservice.proto";

package perfetto.protos;

// Represents a file full of window manager trace entries.
// Encoded, it should start with 0x9 0x57 0x49 0x4e 0x54 0x52 0x41 0x43 0x45
// (.WINTRACE), such that they can be easily identified.
message WindowManagerTraceFileProto {
  // constant; MAGIC_NUMBER = (long) MAGIC_NUMBER_H << 32 |
  // MagicNumber.MAGIC_NUMBER_L (this is needed because enums have to be 32 bits
  // and there's no nice way to put 64bit constants into .proto files.
  enum MagicNumber {
    INVALID = 0;
    // WINT (little-endian ASCII)
    MAGIC_NUMBER_L = 0x544e4957;
    // RACE (little-endian ASCII)
    MAGIC_NUMBER_H = 0x45434152;
  }

  // Must be the first field, set to value in MagicNumber
  optional fixed64 magic_number = 1;
  repeated WindowManagerTraceEntry entry = 2;

  // offset between real-time clock and elapsed time clock in nanoseconds.
  // Calculated as: 1000000 * System.currentTimeMillis() -
  // SystemClock.elapsedRealtimeNanos()
  optional fixed64 real_to_elapsed_time_offset_nanos = 3;
}

// one window manager trace entry
message WindowManagerTraceEntry {
  // required: elapsed realtime in nanos since boot of when this entry was
  // logged
  optional fixed64 elapsed_realtime_nanos = 1;

  // where the trace originated
  optional string where = 2;

  optional WindowManagerServiceDumpProto window_manager_service = 3;
}
