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: 34 struct FileInfo { FileInfoFileInfo35 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 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 /** 53 * Writes train info. 54 */ 55 static bool writeTrainInfo(const InstallTrainInfo& trainInfo); 56 57 /** 58 * Reads train info. 59 */ 60 static bool readTrainInfo(const std::string& trainName, InstallTrainInfo& trainInfo); 61 62 /** 63 * Reads train info assuming lock is obtained. 64 */ 65 static bool readTrainInfoLocked(const std::string& trainName, InstallTrainInfo& trainInfo); 66 67 /** 68 * Reads all train info and returns a vector of train info. 69 */ 70 static vector<InstallTrainInfo> readAllTrainInfo(); 71 72 /** 73 * Reads the file content to the buffer. 74 */ 75 static bool readFileToString(const char* file, string* content); 76 77 /** 78 * Deletes a single file given a file name. 79 */ 80 static void deleteFile(const char* file); 81 82 /** 83 * Deletes all files in a given directory. 84 */ 85 static void deleteAllFiles(const char* path); 86 87 /** 88 * Deletes all files whose name matches with a provided suffix. 89 */ 90 static void deleteSuffixedFiles(const char* path, const char* suffix); 91 92 /** 93 * Send broadcasts to relevant receiver for each data stored on disk. 94 */ 95 static void sendBroadcast(const char* path, 96 const std::function<void(const ConfigKey&)>& sendBroadcast); 97 98 /** 99 * Returns true if there's at least one report on disk. 100 */ 101 static bool hasConfigMetricsReport(const ConfigKey& key); 102 103 /** 104 * Appends the ConfigMetricsReport found on disk to the specifid proto 105 * and, if erase_data, deletes it from disk. 106 * 107 * [isAdb]: if the caller is adb dump. This includes local adb dump or dumpsys by 108 * bugreport or incidentd. When true, we will append any local history data too. 109 * 110 * When 111 * erase_data=true, isAdb=true: append history data to output, remove all data after read 112 * erase_data=false, isAdb=true: append history data to output, keep data after read 113 * erase_data=true, isAdb=false: do not append history data, and remove data after read 114 * erase_data=false, isAdb=false: do not append history data and *rename* all data files to 115 * history files. 116 */ 117 static void appendConfigMetricsReport(const ConfigKey& key, ProtoOutputStream* proto, 118 bool erase_data, bool isAdb); 119 120 /** 121 * Call to load the saved configs from disk. 122 */ 123 static void readConfigFromDisk(std::map<ConfigKey, StatsdConfig>& configsMap); 124 125 /** 126 * Call to load the specified config from disk. Returns false if the config file does not 127 * exist or error occurs when reading the file. 128 */ 129 static bool readConfigFromDisk(const ConfigKey& key, StatsdConfig* config); 130 static bool readConfigFromDisk(const ConfigKey& key, string* config); 131 132 /** 133 * Trims files in the provided directory to limit the total size, number of 134 * files, accumulation of outdated files. 135 */ 136 static void trimToFit(const char* dir, bool parseTimestampOnly = false); 137 138 /** 139 * Returns true if there already exists identical configuration on device. 140 */ 141 static bool hasIdenticalConfig(const ConfigKey& key, 142 const vector<uint8_t>& config); 143 144 /** 145 * Prints disk usage statistics related to statsd. 146 */ 147 static void printStats(int out); 148 149 static string getDataFileName(long wallClockSec, int uid, int64_t id); 150 151 static string getDataHistoryFileName(long wallClockSec, int uid, int64_t id); 152 153 static void sortFiles(vector<FileInfo>* fileNames); 154 155 private: 156 /** 157 * Prints disk usage statistics about a directory related to statsd. 158 */ 159 static void printDirStats(int out, const char* path); 160 161 static std::mutex sTrainInfoMutex; 162 }; 163 164 } // namespace statsd 165 } // namespace os 166 } // namespace android 167 168 #endif // STORAGE_MANAGER_H 169