1 // 2 // Copyright (C) 2013 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 17 #ifndef UPDATE_ENGINE_COMMON_CONSTANTS_H_ 18 #define UPDATE_ENGINE_COMMON_CONSTANTS_H_ 19 20 #include <cstdint> 21 22 namespace chromeos_update_engine { 23 // The root path of all exclusion prefs. 24 static constexpr const auto& kExclusionPrefsSubDir = "exclusion"; 25 26 // The root path of all DLC metadata. 27 static constexpr const auto& kDlcPrefsSubDir = "dlc"; 28 29 // Directory for AU prefs that are preserved across powerwash. 30 static constexpr const auto& kPowerwashSafePrefsSubDirectory = 31 "update_engine/prefs"; 32 33 // The location where we store the AU preferences (state etc). 34 static constexpr const auto& kPrefsSubDirectory = "prefs"; 35 36 // Path to the stateful partition on the root filesystem. 37 static constexpr const auto& kStatefulPartition = "/mnt/stateful_partition"; 38 39 // Path to the post install command, relative to the partition. 40 static constexpr const auto& kPostinstallDefaultScript = "postinst"; 41 42 // Constants related to preferences. 43 // Constants defining keys for the persisted state of update engine. 44 static constexpr const auto& kPrefsAttemptInProgress = "attempt-in-progress"; 45 static constexpr const auto& kPrefsBackoffExpiryTime = "backoff-expiry-time"; 46 static constexpr const auto& kPrefsBootId = "boot-id"; 47 static constexpr const auto& kPrefsCurrentBytesDownloaded = 48 "current-bytes-downloaded"; 49 static constexpr const auto& kPrefsCurrentResponseSignature = 50 "current-response-signature"; 51 static constexpr const auto& kPrefsCurrentUrlFailureCount = 52 "current-url-failure-count"; 53 static constexpr const auto& kPrefsCurrentUrlIndex = "current-url-index"; 54 static constexpr const auto& kPrefsDailyMetricsLastReportedAt = 55 "daily-metrics-last-reported-at"; 56 static constexpr const auto& kPrefsDeltaUpdateFailures = 57 "delta-update-failures"; 58 static constexpr const auto& kPrefsDynamicPartitionMetadataUpdated = 59 "dynamic-partition-metadata-updated"; 60 static constexpr const auto& kPrefsFullPayloadAttemptNumber = 61 "full-payload-attempt-number"; 62 static constexpr const auto& kPrefsInstallDateDays = "install-date-days"; 63 static constexpr const auto& kPrefsLastActivePingDay = "last-active-ping-day"; 64 static constexpr const auto& kPrefsLastRollCallPingDay = 65 "last-roll-call-ping-day"; 66 static constexpr const auto& kPrefsManifestMetadataSize = 67 "manifest-metadata-size"; 68 static constexpr const auto& kPrefsManifestSignatureSize = 69 "manifest-signature-size"; 70 static constexpr const auto& kPrefsMetricsAttemptLastReportingTime = 71 "metrics-attempt-last-reporting-time"; 72 static constexpr const auto& kPrefsMetricsCheckLastReportingTime = 73 "metrics-check-last-reporting-time"; 74 static constexpr const auto& kPrefsNoIgnoreBackoff = "no-ignore-backoff"; 75 static constexpr const auto& kPrefsNumReboots = "num-reboots"; 76 static constexpr const auto& kPrefsNumResponsesSeen = "num-responses-seen"; 77 static constexpr const auto& kPrefsOmahaCohort = "omaha-cohort"; 78 static constexpr const auto& kPrefsOmahaCohortHint = "omaha-cohort-hint"; 79 static constexpr const auto& kPrefsOmahaCohortName = "omaha-cohort-name"; 80 static constexpr const auto& kPrefsOmahaEolDate = "omaha-eol-date"; 81 static constexpr const auto& kPrefsP2PEnabled = "p2p-enabled"; 82 static constexpr const auto& kPrefsP2PFirstAttemptTimestamp = 83 "p2p-first-attempt-timestamp"; 84 static constexpr const auto& kPrefsP2PNumAttempts = "p2p-num-attempts"; 85 static constexpr const auto& kPrefsPayloadAttemptNumber = 86 "payload-attempt-number"; 87 static constexpr const auto& kPrefsTestUpdateCheckIntervalTimeout = 88 "test-update-check-interval-timeout"; 89 // Keep |kPrefsPingActive| in sync with |kDlcMetadataFilePingActive| in 90 // dlcservice. 91 static constexpr const auto& kPrefsPingActive = "active"; 92 static constexpr const auto& kPrefsPingLastActive = "date_last_active"; 93 static constexpr const auto& kPrefsPingLastRollcall = "date_last_rollcall"; 94 static constexpr const auto& kPrefsLastFp = "last-fp"; 95 static constexpr const auto& kPrefsPostInstallSucceeded = 96 "post-install-succeeded"; 97 static constexpr const auto& kPrefsPreviousVersion = "previous-version"; 98 static constexpr const auto& kPrefsResumedUpdateFailures = 99 "resumed-update-failures"; 100 static constexpr const auto& kPrefsRollbackHappened = "rollback-happened"; 101 static constexpr const auto& kPrefsRollbackVersion = "rollback-version"; 102 static constexpr const auto& kPrefsChannelOnSlotPrefix = "channel-on-slot-"; 103 static constexpr const auto& kPrefsSystemUpdatedMarker = 104 "system-updated-marker"; 105 static constexpr const auto& kPrefsTargetVersionAttempt = 106 "target-version-attempt"; 107 static constexpr const auto& kPrefsTargetVersionInstalledFrom = 108 "target-version-installed-from"; 109 static constexpr const auto& kPrefsTargetVersionUniqueId = 110 "target-version-unique-id"; 111 static constexpr const auto& kPrefsTotalBytesDownloaded = 112 "total-bytes-downloaded"; 113 static constexpr const auto& kPrefsUpdateCheckCount = "update-check-count"; 114 static constexpr const auto& kPrefsUpdateCheckResponseHash = 115 "update-check-response-hash"; 116 static constexpr const auto& kPrefsUpdateCompletedBootTime = 117 "update-completed-boot-time"; 118 static constexpr const auto& kPrefsUpdateCompletedOnBootId = 119 "update-completed-on-boot-id"; 120 static constexpr const auto& kPrefsUpdateDurationUptime = 121 "update-duration-uptime"; 122 static constexpr const auto& kPrefsUpdateFirstSeenAt = "update-first-seen-at"; 123 static constexpr const auto& kPrefsUpdateOverCellularPermission = 124 "update-over-cellular-permission"; 125 static constexpr const auto& kPrefsUpdateOverCellularTargetVersion = 126 "update-over-cellular-target-version"; 127 static constexpr const auto& kPrefsUpdateOverCellularTargetSize = 128 "update-over-cellular-target-size"; 129 static constexpr const auto& kPrefsUpdateServerCertificate = 130 "update-server-cert"; 131 static constexpr const auto& kPrefsUpdateStateNextDataLength = 132 "update-state-next-data-length"; 133 static constexpr const auto& kPrefsUpdateStateNextDataOffset = 134 "update-state-next-data-offset"; 135 static constexpr const auto& kPrefsUpdateStateNextOperation = 136 "update-state-next-operation"; 137 static constexpr const auto& kPrefsUpdateStatePayloadIndex = 138 "update-state-payload-index"; 139 static constexpr const auto& kPrefsUpdateStateSHA256Context = 140 "update-state-sha-256-context"; 141 static constexpr const auto& kPrefsUpdateStateSignatureBlob = 142 "update-state-signature-blob"; 143 static constexpr const auto& kPrefsUpdateStateSignedSHA256Context = 144 "update-state-signed-sha-256-context"; 145 static constexpr const auto& kPrefsUpdateBootTimestampStart = 146 "update-boot-timestamp-start"; 147 static constexpr const auto& kPrefsUpdateTimestampStart = 148 "update-timestamp-start"; 149 static constexpr const auto& kPrefsUrlSwitchCount = "url-switch-count"; 150 static constexpr const auto& kPrefsVerityWritten = "verity-written"; 151 static constexpr const auto& kPrefsWallClockScatteringWaitPeriod = 152 "wall-clock-wait-period"; 153 static constexpr const auto& kPrefsWallClockStagingWaitPeriod = 154 "wall-clock-staging-wait-period"; 155 static constexpr const auto& kPrefsManifestBytes = "manifest-bytes"; 156 static constexpr const auto& kPrefsPreviousSlot = "previous-slot"; 157 158 // Keys used when storing and loading payload properties. 159 // These four fields are generated by scripts/brillo_update_payload. 160 static constexpr const auto& kPayloadPropertyFileSize = "FILE_SIZE"; 161 static constexpr const auto& kPayloadPropertyFileHash = "FILE_HASH"; 162 static constexpr const auto& kPayloadPropertyMetadataSize = "METADATA_SIZE"; 163 static constexpr const auto& kPayloadPropertyMetadataHash = "METADATA_HASH"; 164 // The Authorization: HTTP header to be sent when downloading the payload. 165 static constexpr const auto& kPayloadPropertyAuthorization = "AUTHORIZATION"; 166 // HTTP headers extra entries in the format of key1;val1 key2;val2 key3;val3 167 static constexpr const auto& kPayloadPropertyHTTPExtras = "HTTP_EXTRAS"; 168 // The User-Agent HTTP header to be sent when downloading the payload. 169 static constexpr const auto& kPayloadPropertyUserAgent = "USER_AGENT"; 170 // Set "POWERWASH=1" to powerwash (factory data reset) the device after 171 // applying the update. 172 static constexpr const auto& kPayloadPropertyPowerwash = "POWERWASH"; 173 static constexpr const auto& kPayloadPropertySplDowngrade = "SPL_DOWNGRADE"; 174 // The network id to pass to android_setprocnetwork before downloading. 175 // This can be used to zero-rate OTA traffic by sending it over the correct 176 // network. 177 static constexpr const auto& kPayloadPropertyNetworkId = "NETWORK_ID"; 178 179 // Proxy URL to use for downloading OTA. This will be forwarded to libcurl 180 static constexpr const auto& kPayloadPropertyNetworkProxy = "NETWORK_PROXY"; 181 182 // Set Virtual AB Compression's compression algorithm to "none", but still use 183 // userspace snapshots and snapuserd for update installation. 184 static constexpr const auto& kPayloadVABCNone = "VABC_NONE"; 185 // Enable/Disable VABC, falls back on plain VAB 186 static constexpr const auto& kPayloadDisableVABC = "DISABLE_VABC"; 187 // Enable multi-threaded compression for VABC 188 static constexpr const auto& kPayloadEnableThreading = "ENABLE_THREADING"; 189 // Enable batched writes for VABC 190 static constexpr const auto& kPayloadBatchedWrites = "BATCHED_WRITES"; 191 192 // Max retry count for download 193 static constexpr const auto& kPayloadDownloadRetry = "DOWNLOAD_RETRY"; 194 195 // Set "SWITCH_SLOT_ON_REBOOT=0" to skip marking the updated partitions active. 196 // The default is 1 (always switch slot if update succeeded). 197 static constexpr const auto& kPayloadPropertySwitchSlotOnReboot = 198 "SWITCH_SLOT_ON_REBOOT"; 199 // Set "RUN_POST_INSTALL=0" to skip running optional post install. 200 // The default is 1 (always run post install). 201 static constexpr const auto& kPayloadPropertyRunPostInstall = 202 "RUN_POST_INSTALL"; 203 204 static constexpr const auto& kOmahaUpdaterVersion = "0.1.0.0"; 205 206 // X-Goog-Update headers. 207 // X-Goog-Update headers. 208 static constexpr const auto& kXGoogleUpdateInteractivity = 209 "X-Goog-Update-Interactivity"; 210 static constexpr const auto& kXGoogleUpdateAppId = "X-Goog-Update-AppId"; 211 static constexpr const auto& kXGoogleUpdateUpdater = "X-Goog-Update-Updater"; 212 static constexpr const auto& kXGoogleUpdateSessionId = "X-Goog-SessionId"; 213 214 // Proxy URL for direction connection 215 static constexpr const auto& kNoProxy = "direct://"; 216 217 // A download source is any combination of protocol and server (that's of 218 // interest to us when looking at UMA metrics) using which we may download 219 // the payload. 220 typedef enum { 221 kDownloadSourceHttpsServer, // UMA Binary representation: 0001 222 kDownloadSourceHttpServer, // UMA Binary representation: 0010 223 kDownloadSourceHttpPeer, // UMA Binary representation: 0100 224 225 // Note: Add new sources only above this line. 226 kNumDownloadSources 227 } DownloadSource; 228 229 // A payload can be a Full or Delta payload. In some cases, a Full payload is 230 // used even when a Delta payload was available for the update, called here 231 // ForcedFull. The PayloadType enum is only used to send UMA metrics about the 232 // successfully applied payload. 233 typedef enum { 234 kPayloadTypeFull, 235 kPayloadTypeDelta, 236 kPayloadTypeForcedFull, 237 238 // Note: Add new payload types only above this line. 239 kNumPayloadTypes 240 } PayloadType; 241 242 // Maximum number of times we'll allow using p2p for the same update payload. 243 constexpr int kMaxP2PAttempts = 10; 244 245 // Maximum wallclock time we allow attempting to update using p2p for 246 // the same update payload - five days. 247 constexpr int kMaxP2PAttemptTimeSeconds = 5 * 24 * 60 * 60; 248 249 // The maximum amount of time to spend waiting for p2p-client(1) to 250 // return while waiting in line to use the LAN - six hours. 251 constexpr int kMaxP2PNetworkWaitTimeSeconds = 6 * 60 * 60; 252 253 // The maximum number of payload files to keep in /var/cache/p2p. 254 constexpr int kMaxP2PFilesToKeep = 3; 255 256 // The maximum number of days to keep a p2p file; 257 constexpr int kMaxP2PFileAgeDays = 5; 258 259 // The default number of UMA buckets for metrics. 260 constexpr int kNumDefaultUmaBuckets = 50; 261 262 // General constexprants 263 constexpr int kNumBytesInOneMiB = 1024 * 1024; 264 265 // Number of redirects allowed when downloading. 266 constexpr int kDownloadMaxRedirects = 10; 267 268 // The minimum average speed that downloads must sustain... 269 // 270 // This is set low because some devices may have very poor 271 // connectivity and we want to make as much forward progress as 272 // possible. For p2p this is high (25 kB/second) since we can assume 273 // high bandwidth (same LAN) and we want to fail fast. 274 constexpr int kDownloadLowSpeedLimitBps = 1; 275 constexpr int kDownloadP2PLowSpeedLimitBps = 25 * 1000; 276 277 // ... measured over this period. 278 // 279 // For non-official builds (e.g. typically built on a developer's 280 // workstation and served via devserver) bump this since it takes time 281 // for the workstation to generate the payload. For normal operation 282 // and p2p, make this relatively low since we want to fail fast in 283 // those cases. 284 constexpr int kDownloadLowSpeedTimeSeconds = 30; 285 constexpr int kDownloadDevModeLowSpeedTimeSeconds = 180; 286 constexpr int kDownloadP2PLowSpeedTimeSeconds = 60; 287 288 // The maximum amount of HTTP server reconnect attempts. 289 // 290 // This is set high in order to maximize the attempt's chance of 291 // succeeding. When using p2p, this is low in order to fail fast. 292 constexpr int kDownloadMaxRetryCount = 20; 293 constexpr int kDownloadMaxRetryCountOobeNotComplete = 3; 294 constexpr int kDownloadMaxRetryCountInteractive = 3; 295 constexpr int kDownloadP2PMaxRetryCount = 5; 296 297 // The connect timeout, in seconds. 298 // 299 // This is set high because some devices may have very poor 300 // connectivity and we may be using HTTPS which involves complicated 301 // multi-roundtrip setup. For p2p, this is set low because we can 302 // the server is on the same LAN and we want to fail fast. 303 constexpr int kDownloadConnectTimeoutSeconds = 30; 304 constexpr int kDownloadP2PConnectTimeoutSeconds = 5; 305 306 // Size in bytes of SHA256 hash. 307 constexpr int kSHA256Size = 32; 308 309 // A hardcoded label to mark end of all InstallOps 310 // This number must be greater than number of install ops. 311 // Number of install ops is bounded by number of blocks on any partition. 312 // Currently, the block size is 4096. Using |kEndOfInstallLabel| of 2^48 will 313 // allow partitions with 2^48 * 4096 = 2^60 bytes. That's 1024PB? Partitions on 314 // android aren't getting that big any time soon. 315 constexpr uint64_t kEndOfInstallLabel = (1ULL << 48); 316 317 } // namespace chromeos_update_engine 318 319 #endif // UPDATE_ENGINE_COMMON_CONSTANTS_H_ 320