yro | 947fbce | 2017-11-15 22:50:23 -0800 | [diff] [blame] | 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 | |
| 17 | #ifndef STORAGE_MANAGER_H |
| 18 | #define STORAGE_MANAGER_H |
| 19 | |
| 20 | #include <android/util/ProtoOutputStream.h> |
| 21 | #include <utils/Log.h> |
| 22 | #include <utils/RefBase.h> |
| 23 | |
| 24 | #include "packages/UidMap.h" |
| 25 | |
| 26 | namespace android { |
| 27 | namespace os { |
| 28 | namespace statsd { |
| 29 | |
| 30 | using android::util::ProtoOutputStream; |
| 31 | |
| 32 | class StorageManager : public virtual RefBase { |
| 33 | public: |
Yao Chen | 9a43b4f | 2019-04-10 10:43:20 -0700 | [diff] [blame] | 34 | struct FileInfo { |
| 35 | FileInfo(std::string name, bool isHistory, int fileSize, long fileAge) |
| 36 | : mFileName(name), |
| 37 | mIsHistory(isHistory), |
| 38 | mFileSizeBytes(fileSize), |
| 39 | mFileAgeSec(fileAge) { |
| 40 | } |
| 41 | std::string mFileName; |
| 42 | bool mIsHistory; |
| 43 | int mFileSizeBytes; |
| 44 | long mFileAgeSec; |
| 45 | }; |
| 46 | |
yro | 947fbce | 2017-11-15 22:50:23 -0800 | [diff] [blame] | 47 | /** |
| 48 | * Writes a given byte array as a file to the specified file path. |
| 49 | */ |
| 50 | static void writeFile(const char* file, const void* buffer, int numBytes); |
| 51 | |
| 52 | /** |
Chenjie Yu | 6b1667c | 2019-01-18 10:09:33 -0800 | [diff] [blame] | 53 | * Writes train info. |
| 54 | */ |
Muhammad Qureshi | f4ca824 | 2019-03-01 09:20:15 -0800 | [diff] [blame] | 55 | static bool writeTrainInfo(int64_t trainVersionCode, const std::string& trainName, |
Jeff Hamilton | fa2f91c | 2019-03-22 00:25:02 -0400 | [diff] [blame] | 56 | int32_t status, const std::vector<int64_t>& experimentIds); |
Chenjie Yu | 6b1667c | 2019-01-18 10:09:33 -0800 | [diff] [blame] | 57 | |
| 58 | /** |
| 59 | * Reads train info. |
| 60 | */ |
Chenjie Yu | 97dbb20 | 2019-02-13 16:42:04 -0800 | [diff] [blame] | 61 | static bool readTrainInfo(InstallTrainInfo& trainInfo); |
Chenjie Yu | 6b1667c | 2019-01-18 10:09:33 -0800 | [diff] [blame] | 62 | |
| 63 | /** |
Yangster-mac | 932ecec | 2018-02-01 10:23:52 -0800 | [diff] [blame] | 64 | * Reads the file content to the buffer. |
| 65 | */ |
| 66 | static bool readFileToString(const char* file, string* content); |
| 67 | |
| 68 | /** |
yro | 947fbce | 2017-11-15 22:50:23 -0800 | [diff] [blame] | 69 | * Deletes a single file given a file name. |
| 70 | */ |
| 71 | static void deleteFile(const char* file); |
| 72 | |
| 73 | /** |
| 74 | * Deletes all files in a given directory. |
| 75 | */ |
| 76 | static void deleteAllFiles(const char* path); |
| 77 | |
| 78 | /** |
yro | e5f8292 | 2018-01-22 18:37:27 -0800 | [diff] [blame] | 79 | * Deletes all files whose name matches with a provided suffix. |
yro | 947fbce | 2017-11-15 22:50:23 -0800 | [diff] [blame] | 80 | */ |
yro | e5f8292 | 2018-01-22 18:37:27 -0800 | [diff] [blame] | 81 | static void deleteSuffixedFiles(const char* path, const char* suffix); |
yro | 947fbce | 2017-11-15 22:50:23 -0800 | [diff] [blame] | 82 | |
| 83 | /** |
| 84 | * Send broadcasts to relevant receiver for each data stored on disk. |
| 85 | */ |
| 86 | static void sendBroadcast(const char* path, |
| 87 | const std::function<void(const ConfigKey&)>& sendBroadcast); |
| 88 | |
| 89 | /** |
David Chen | 4894490 | 2018-05-03 10:29:11 -0700 | [diff] [blame] | 90 | * Returns true if there's at least one report on disk. |
| 91 | */ |
| 92 | static bool hasConfigMetricsReport(const ConfigKey& key); |
| 93 | |
| 94 | /** |
Bookatz | c71d901 | 2018-12-19 12:28:38 -0800 | [diff] [blame] | 95 | * Appends the ConfigMetricsReport found on disk to the specifid proto |
| 96 | * and, if erase_data, deletes it from disk. |
Yao Chen | 9a43b4f | 2019-04-10 10:43:20 -0700 | [diff] [blame] | 97 | * |
| 98 | * [isAdb]: if the caller is adb dump. This includes local adb dump or dumpsys by |
| 99 | * bugreport or incidentd. When true, we will append any local history data too. |
| 100 | * |
| 101 | * When |
| 102 | * erase_data=true, isAdb=true: append history data to output, remove all data after read |
| 103 | * erase_data=false, isAdb=true: append history data to output, keep data after read |
| 104 | * erase_data=true, isAdb=false: do not append history data, and remove data after read |
| 105 | * erase_data=false, isAdb=false: do not append history data and *rename* all data files to |
| 106 | * history files. |
yro | 947fbce | 2017-11-15 22:50:23 -0800 | [diff] [blame] | 107 | */ |
Yao Chen | 9a43b4f | 2019-04-10 10:43:20 -0700 | [diff] [blame] | 108 | static void appendConfigMetricsReport(const ConfigKey& key, ProtoOutputStream* proto, |
| 109 | bool erase_data, bool isAdb); |
yro | 947fbce | 2017-11-15 22:50:23 -0800 | [diff] [blame] | 110 | |
| 111 | /** |
| 112 | * Call to load the saved configs from disk. |
| 113 | */ |
Yao Chen | f09569f | 2017-12-13 17:00:51 -0800 | [diff] [blame] | 114 | static void readConfigFromDisk(std::map<ConfigKey, StatsdConfig>& configsMap); |
yro | 98a2850 | 2018-01-18 17:00:14 -0800 | [diff] [blame] | 115 | |
| 116 | /** |
Yangster-mac | b142cc8 | 2018-03-30 15:22:08 -0700 | [diff] [blame] | 117 | * Call to load the specified config from disk. Returns false if the config file does not |
| 118 | * exist or error occurs when reading the file. |
| 119 | */ |
| 120 | static bool readConfigFromDisk(const ConfigKey& key, StatsdConfig* config); |
| 121 | static bool readConfigFromDisk(const ConfigKey& key, string* config); |
| 122 | |
| 123 | /** |
yro | 98a2850 | 2018-01-18 17:00:14 -0800 | [diff] [blame] | 124 | * Trims files in the provided directory to limit the total size, number of |
| 125 | * files, accumulation of outdated files. |
| 126 | */ |
| 127 | static void trimToFit(const char* dir); |
yro | 4490765 | 2018-03-12 20:44:05 -0700 | [diff] [blame] | 128 | |
| 129 | /** |
| 130 | * Returns true if there already exists identical configuration on device. |
| 131 | */ |
| 132 | static bool hasIdenticalConfig(const ConfigKey& key, |
| 133 | const vector<uint8_t>& config); |
yro | 665208d | 2018-03-13 18:08:09 -0700 | [diff] [blame] | 134 | |
| 135 | /** |
| 136 | * Prints disk usage statistics related to statsd. |
| 137 | */ |
Yao Chen | a80e5c0 | 2018-09-04 13:55:29 -0700 | [diff] [blame] | 138 | static void printStats(int out); |
yro | 665208d | 2018-03-13 18:08:09 -0700 | [diff] [blame] | 139 | |
Yao Chen | 9a43b4f | 2019-04-10 10:43:20 -0700 | [diff] [blame] | 140 | static string getDataFileName(long wallClockSec, int uid, int64_t id); |
| 141 | |
| 142 | static string getDataHistoryFileName(long wallClockSec, int uid, int64_t id); |
| 143 | |
| 144 | static void sortFiles(vector<FileInfo>* fileNames); |
| 145 | |
yro | 665208d | 2018-03-13 18:08:09 -0700 | [diff] [blame] | 146 | private: |
| 147 | /** |
| 148 | * Prints disk usage statistics about a directory related to statsd. |
| 149 | */ |
Yao Chen | a80e5c0 | 2018-09-04 13:55:29 -0700 | [diff] [blame] | 150 | static void printDirStats(int out, const char* path); |
Chenjie Yu | 6b1667c | 2019-01-18 10:09:33 -0800 | [diff] [blame] | 151 | |
| 152 | static std::mutex sTrainInfoMutex; |
yro | 947fbce | 2017-11-15 22:50:23 -0800 | [diff] [blame] | 153 | }; |
| 154 | |
| 155 | } // namespace statsd |
| 156 | } // namespace os |
| 157 | } // namespace android |
| 158 | |
| 159 | #endif // STORAGE_MANAGER_H |