1/*
2 * Copyright (C) 2017 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17syntax = "proto2";
18option optimize_for = LITE_RUNTIME;
19
20import "protos/surfaceflinger/udc/layers.proto";
21import "protos/surfaceflinger/udc/display.proto";
22
23package android.surfaceflinger;
24
25/* represents a file full of surface flinger trace entries.
26   Encoded, it should start with 0x4c 0x59 0x52 0x54 0x52 0x41 0x43 0x45 (.LYRTRACE), such
27   that they can be easily identified. */
28message LayersTraceFileProto {
29
30    /* constant; MAGIC_NUMBER = (long) MAGIC_NUMBER_H << 32 | MagicNumber.MAGIC_NUMBER_L
31       (this is needed because enums have to be 32 bits and there's no nice way to put 64bit
32        constants into .proto files. */
33    enum MagicNumber {
34        INVALID = 0;
35        MAGIC_NUMBER_L = 0x5452594c;  /* LYRT (little-endian ASCII) */
36        MAGIC_NUMBER_H = 0x45434152;  /* RACE (little-endian ASCII) */
37    }
38
39    optional fixed64 magic_number = 1;  /* Must be the first field, set to value in MagicNumber */
40    repeated LayersTraceProto entry = 2;
41
42    /* offset between real-time clock and elapsed time clock in nanoseconds.
43       Calculated as: systemTime(SYSTEM_TIME_REALTIME) - systemTime(SYSTEM_TIME_MONOTONIC) */
44    optional fixed64 real_to_elapsed_time_offset_nanos = 3;
45}
46
47/* one layers trace entry. */
48message LayersTraceProto {
49    /* required: elapsed realtime in nanos since boot of when this entry was logged */
50    optional sfixed64 elapsed_realtime_nanos = 1;
51
52    /* where the trace originated */
53    optional string where = 2;
54
55    optional LayersProto layers = 3;
56
57    // Blob for the current HWC information for all layers, reported by dumpsys.
58    optional string hwc_blob = 4;
59
60    /* Includes state sent during composition like visible region and composition type. */
61    optional bool excludes_composition_state = 5;
62
63    /* Number of missed entries since the last entry was recorded. */
64    optional uint32 missed_entries = 6;
65
66    repeated DisplayProto displays = 7;
67
68    optional int64 vsync_id = 8;
69}
70