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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
// Copyright (C) 2019 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 = "proto3";
package android.snapshot;
option optimize_for = LITE_RUNTIME;
// Next: 4
enum SnapshotState {
// No snapshot is found.
NONE = 0;
// The snapshot has been created and possibly written to. Rollbacks are
// possible by destroying the snapshot.
CREATED = 1;
// Changes are being merged. No rollbacks are possible beyond this point.
MERGING = 2;
// Changes have been merged, Future reboots may map the base device
// directly.
MERGE_COMPLETED = 3;
}
// Next: 9
message SnapshotStatus {
// Name of the snapshot. This is usually the name of the snapshotted
// logical partition; for example, "system_b".
string name = 1;
SnapshotState state = 2;
// Size of the full (base) device.
uint64 device_size = 3;
// Size of the snapshot. This is the sum of lengths of ranges in the base
// device that needs to be snapshotted during the update.
// This must be less than or equal to |device_size|.
// This value is 0 if no snapshot is needed for this device because
// no changes
uint64 snapshot_size = 4;
// Size of the "COW partition". A COW partition is a special logical
// partition represented in the super partition metadata. This partition and
// the "COW image" form the "COW device" that supports the snapshot device.
//
// When SnapshotManager creates a COW device, it first searches for unused
// blocks in the super partition, and use those before creating the COW
// image if the COW partition is not big enough.
//
// This value is 0 if no space in super is left for the COW partition.
// |cow_partition_size + cow_file_size| must not be zero if |snapshot_size|
// is non-zero.
uint64 cow_partition_size = 5;
// Size of the "COW file", or "COW image". A COW file / image is created
// when the "COW partition" is not big enough to store changes to the
// snapshot device.
//
// This value is 0 if |cow_partition_size| is big enough to hold all changes
// to the snapshot device.
uint64 cow_file_size = 6;
// Sectors allocated for the COW device. Recording this value right after
// the update and before the merge allows us to infer the progress of the
// merge process.
// This is non-zero when |state| == MERGING or MERGE_COMPLETED.
uint64 sectors_allocated = 7;
// Metadata sectors allocated for the COW device. Recording this value right
// before the update and before the merge allows us to infer the progress of
// the merge process.
// This is non-zero when |state| == MERGING or MERGE_COMPLETED.
uint64 metadata_sectors = 8;
}
// Next: 8
enum UpdateState {
// No update or merge is in progress.
None = 0;
// An update is applying; snapshots may already exist.
Initiated = 1;
// An update is pending, but has not been successfully booted yet.
Unverified = 2;
// The kernel is merging in the background.
Merging = 3;
// Post-merge cleanup steps could not be completed due to a transient
// error, but the next reboot will finish any pending operations.
MergeNeedsReboot = 4;
// Merging is complete, and needs to be acknowledged.
MergeCompleted = 5;
// Merging failed due to an unrecoverable error.
MergeFailed = 6;
// The update was implicitly cancelled, either by a rollback or a flash
// operation via fastboot. This state can only be returned by WaitForMerge.
Cancelled = 7;
};
// Next: 5
message SnapshotUpdateStatus {
UpdateState state = 1;
// Total number of sectors allocated in the COW files before performing the
// merge operation. This field is used to keep track of the total number
// of sectors modified to monitor and show the progress of the merge during
// an update.
uint64 sectors_allocated = 2;
// Total number of sectors of all the snapshot devices.
uint64 total_sectors = 3;
// Sectors allocated for metadata in all the snapshot devices.
uint64 metadata_sectors = 4;
}
// Next: 4
message SnapshotMergeReport {
// Status of the update after the merge attempts.
UpdateState state = 1;
// Number of reboots that occurred after issuing and before completeing the
// merge of all the snapshot devices.
int32 resume_count = 2;
// Total size of all the COW images before the update.
uint64 cow_file_size = 3;
}
|
