1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
/*
* 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.
*/
syntax = "proto2";
package android.os.statsd;
option java_package = "com.android.os";
option java_multiple_files = true;
option java_outer_classname = "AtomFieldOptions";
import "google/protobuf/descriptor.proto";
// Used to annotate an atom that represents a state change. A state change atom must have exactly
// ONE exclusive state field, and any number of primary key fields. For example, message
// UidProcessStateChanged {
// optional int32 uid = 1 [(state_field_option).primary_field = true];
// optional android.app.ProcessStateEnum state =
// 2 [(state_field_option).exclusive_state = true];
// }
// Each UidProcessStateChanged atom event represents a state change for a specific uid.
// A new state automatically overrides the previous state.
//
// If the atom has 2 or more primary fields, it means the combination of the
// primary fields are the primary key.
// For example:
// message ThreadStateChanged {
// optional int32 pid = 1 [(state_field_option).primary_field = true];
// optional int32 tid = 2 [(state_field_option).primary_field = true];
// optional int32 state = 3 [(state_field_option).exclusive_state = true];
// }
//
// Sometimes, there is no primary key field, when the state is GLOBAL.
// For example,
// message ScreenStateChanged {
// optional android.view.DisplayStateEnum state =
// 1 [(state_field_option).exclusive_state = true];
// }
//
// For state atoms with attribution chain, sometimes the primary key is the first uid in the chain.
// For example:
// message AudioStateChanged {
// repeated AttributionNode attribution_node = 1
// [(stateFieldOption).primary_field_first_uid = true];
//
// enum State {
// OFF = 0;
// ON = 1;
// // RESET indicates all audio stopped. Used when it (re)starts (e.g. after it crashes).
// RESET = 2;
// }
// optional State state = 2 [(stateFieldOption).exclusive_state = true];
// }
message StateAtomFieldOption {
// Fields that represent the key that the state belongs to.
// Used on simple proto fields. Do not use on attribution chains.
optional bool primary_field = 1 [default = false];
// The field that represents the state. It's an exclusive state.
optional bool exclusive_state = 2 [default = false];
// Used on an attribution chain field to indicate that the first uid is the
// primary field.
optional bool primary_field_first_uid = 3 [default = false];
// Note: We cannot annotate directly on the enums because many enums are imported from other
// proto files in the platform. proto-lite cc library does not support annotations unfortunately
// Knowing the default state value allows state trackers to remove entries that become the
// default state. If there is no default value specified, the default value is unknown, and all
// states will be tracked in memory.
optional int32 default_state_value = 4;
// A reset state signals all states go to default value. For example, BLE reset means all active
// BLE scans are to be turned off.
optional int32 trigger_state_reset_value = 5;
// If the state change needs to count nesting.
optional bool nested = 6 [default = true];
}
// Used to generate StatsLog.write APIs.
enum LogMode {
MODE_UNSET = 0;
// Log fields as their actual types e.g., all primary data types.
// Or fields that are hardcoded in stats_log_api_gen tool e.g., AttributionNode
MODE_AUTOMATIC = 1;
// Log fields in their proto binary format. These fields will not be parsed in statsd
MODE_BYTES = 2;
}
extend google.protobuf.FieldOptions {
// Flags to decorate an atom that presents a state change.
optional StateAtomFieldOption state_field_option = 50000;
// Flags to decorate the uid fields in an atom.
optional bool is_uid = 50001 [default = false];
optional LogMode log_mode = 50002 [default = MODE_AUTOMATIC];
repeated string module = 50004;
optional bool truncate_timestamp = 50005 [default = false];
}
|
