xref: /aosp_15_r20/frameworks/native/cmds/installd/CacheTracker.cpp (revision 38e8c45f13ce32b0dcecb25141ffecaf386fa17f)
1*38e8c45fSAndroid Build Coastguard Worker /*
2*38e8c45fSAndroid Build Coastguard Worker  * Copyright (C) 2017 The Android Open Source Project
3*38e8c45fSAndroid Build Coastguard Worker  *
4*38e8c45fSAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*38e8c45fSAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*38e8c45fSAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*38e8c45fSAndroid Build Coastguard Worker  *
8*38e8c45fSAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*38e8c45fSAndroid Build Coastguard Worker  *
10*38e8c45fSAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*38e8c45fSAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*38e8c45fSAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*38e8c45fSAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*38e8c45fSAndroid Build Coastguard Worker  * limitations under the License.
15*38e8c45fSAndroid Build Coastguard Worker  */
16*38e8c45fSAndroid Build Coastguard Worker 
17*38e8c45fSAndroid Build Coastguard Worker #define ATRACE_TAG ATRACE_TAG_PACKAGE_MANAGER
18*38e8c45fSAndroid Build Coastguard Worker 
19*38e8c45fSAndroid Build Coastguard Worker #include "CacheTracker.h"
20*38e8c45fSAndroid Build Coastguard Worker 
21*38e8c45fSAndroid Build Coastguard Worker #include <fts.h>
22*38e8c45fSAndroid Build Coastguard Worker #include <sys/xattr.h>
23*38e8c45fSAndroid Build Coastguard Worker #include <utils/Trace.h>
24*38e8c45fSAndroid Build Coastguard Worker 
25*38e8c45fSAndroid Build Coastguard Worker #include <android-base/logging.h>
26*38e8c45fSAndroid Build Coastguard Worker #include <android-base/stringprintf.h>
27*38e8c45fSAndroid Build Coastguard Worker 
28*38e8c45fSAndroid Build Coastguard Worker #include "QuotaUtils.h"
29*38e8c45fSAndroid Build Coastguard Worker #include "utils.h"
30*38e8c45fSAndroid Build Coastguard Worker 
31*38e8c45fSAndroid Build Coastguard Worker using android::base::StringPrintf;
32*38e8c45fSAndroid Build Coastguard Worker 
33*38e8c45fSAndroid Build Coastguard Worker namespace android {
34*38e8c45fSAndroid Build Coastguard Worker namespace installd {
35*38e8c45fSAndroid Build Coastguard Worker 
CacheTracker(userid_t userId,appid_t appId,const std::string & uuid)36*38e8c45fSAndroid Build Coastguard Worker CacheTracker::CacheTracker(userid_t userId, appid_t appId, const std::string& uuid)
37*38e8c45fSAndroid Build Coastguard Worker       : cacheUsed(0),
38*38e8c45fSAndroid Build Coastguard Worker         cacheQuota(0),
39*38e8c45fSAndroid Build Coastguard Worker         mUserId(userId),
40*38e8c45fSAndroid Build Coastguard Worker         mAppId(appId),
41*38e8c45fSAndroid Build Coastguard Worker         mItemsLoaded(false),
42*38e8c45fSAndroid Build Coastguard Worker         mUuid(uuid) {
43*38e8c45fSAndroid Build Coastguard Worker }
44*38e8c45fSAndroid Build Coastguard Worker 
~CacheTracker()45*38e8c45fSAndroid Build Coastguard Worker CacheTracker::~CacheTracker() {
46*38e8c45fSAndroid Build Coastguard Worker }
47*38e8c45fSAndroid Build Coastguard Worker 
toString()48*38e8c45fSAndroid Build Coastguard Worker std::string CacheTracker::toString() {
49*38e8c45fSAndroid Build Coastguard Worker     return StringPrintf("UID=%d used=%" PRId64 " quota=%" PRId64 " ratio=%d",
50*38e8c45fSAndroid Build Coastguard Worker             multiuser_get_uid(mUserId, mAppId), cacheUsed, cacheQuota, getCacheRatio());
51*38e8c45fSAndroid Build Coastguard Worker }
52*38e8c45fSAndroid Build Coastguard Worker 
addDataPath(const std::string & dataPath)53*38e8c45fSAndroid Build Coastguard Worker void CacheTracker::addDataPath(const std::string& dataPath) {
54*38e8c45fSAndroid Build Coastguard Worker     mDataPaths.push_back(dataPath);
55*38e8c45fSAndroid Build Coastguard Worker }
56*38e8c45fSAndroid Build Coastguard Worker 
loadStats()57*38e8c45fSAndroid Build Coastguard Worker void CacheTracker::loadStats() {
58*38e8c45fSAndroid Build Coastguard Worker     ATRACE_BEGIN("loadStats quota");
59*38e8c45fSAndroid Build Coastguard Worker     cacheUsed = 0;
60*38e8c45fSAndroid Build Coastguard Worker     if (loadQuotaStats()) {
61*38e8c45fSAndroid Build Coastguard Worker         return;
62*38e8c45fSAndroid Build Coastguard Worker     }
63*38e8c45fSAndroid Build Coastguard Worker     ATRACE_END();
64*38e8c45fSAndroid Build Coastguard Worker 
65*38e8c45fSAndroid Build Coastguard Worker     ATRACE_BEGIN("loadStats tree");
66*38e8c45fSAndroid Build Coastguard Worker     cacheUsed = 0;
67*38e8c45fSAndroid Build Coastguard Worker     for (const auto& path : mDataPaths) {
68*38e8c45fSAndroid Build Coastguard Worker         auto cachePath = read_path_inode(path, "cache", kXattrInodeCache);
69*38e8c45fSAndroid Build Coastguard Worker         auto codeCachePath = read_path_inode(path, "code_cache", kXattrInodeCodeCache);
70*38e8c45fSAndroid Build Coastguard Worker         calculate_tree_size(cachePath, &cacheUsed);
71*38e8c45fSAndroid Build Coastguard Worker         calculate_tree_size(codeCachePath, &cacheUsed);
72*38e8c45fSAndroid Build Coastguard Worker     }
73*38e8c45fSAndroid Build Coastguard Worker     ATRACE_END();
74*38e8c45fSAndroid Build Coastguard Worker }
75*38e8c45fSAndroid Build Coastguard Worker 
loadQuotaStats()76*38e8c45fSAndroid Build Coastguard Worker bool CacheTracker::loadQuotaStats() {
77*38e8c45fSAndroid Build Coastguard Worker     int cacheGid = multiuser_get_cache_gid(mUserId, mAppId);
78*38e8c45fSAndroid Build Coastguard Worker     if (IsQuotaSupported(mUuid) && cacheGid != -1) {
79*38e8c45fSAndroid Build Coastguard Worker         int64_t space;
80*38e8c45fSAndroid Build Coastguard Worker         if ((space = GetOccupiedSpaceForGid(mUuid, cacheGid)) != -1) {
81*38e8c45fSAndroid Build Coastguard Worker             cacheUsed += space;
82*38e8c45fSAndroid Build Coastguard Worker         } else {
83*38e8c45fSAndroid Build Coastguard Worker             return false;
84*38e8c45fSAndroid Build Coastguard Worker         }
85*38e8c45fSAndroid Build Coastguard Worker 
86*38e8c45fSAndroid Build Coastguard Worker         if ((space = get_occupied_app_cache_space_external(mUuid, mUserId, mAppId)) != -1) {
87*38e8c45fSAndroid Build Coastguard Worker             cacheUsed += space;
88*38e8c45fSAndroid Build Coastguard Worker         } else {
89*38e8c45fSAndroid Build Coastguard Worker             return false;
90*38e8c45fSAndroid Build Coastguard Worker         }
91*38e8c45fSAndroid Build Coastguard Worker         return true;
92*38e8c45fSAndroid Build Coastguard Worker     } else {
93*38e8c45fSAndroid Build Coastguard Worker         return false;
94*38e8c45fSAndroid Build Coastguard Worker     }
95*38e8c45fSAndroid Build Coastguard Worker }
96*38e8c45fSAndroid Build Coastguard Worker 
loadItemsFrom(const std::string & path)97*38e8c45fSAndroid Build Coastguard Worker void CacheTracker::loadItemsFrom(const std::string& path) {
98*38e8c45fSAndroid Build Coastguard Worker     FTS *fts;
99*38e8c45fSAndroid Build Coastguard Worker     FTSENT *p;
100*38e8c45fSAndroid Build Coastguard Worker     char *argv[] = { (char*) path.c_str(), nullptr };
101*38e8c45fSAndroid Build Coastguard Worker     if (!(fts = fts_open(argv, FTS_PHYSICAL | FTS_NOCHDIR | FTS_XDEV, nullptr))) {
102*38e8c45fSAndroid Build Coastguard Worker         PLOG(WARNING) << "Failed to fts_open " << path;
103*38e8c45fSAndroid Build Coastguard Worker         return;
104*38e8c45fSAndroid Build Coastguard Worker     }
105*38e8c45fSAndroid Build Coastguard Worker     while ((p = fts_read(fts)) != nullptr) {
106*38e8c45fSAndroid Build Coastguard Worker         if (p->fts_level == 0) continue;
107*38e8c45fSAndroid Build Coastguard Worker 
108*38e8c45fSAndroid Build Coastguard Worker         // Create tracking nodes for everything we encounter
109*38e8c45fSAndroid Build Coastguard Worker         switch (p->fts_info) {
110*38e8c45fSAndroid Build Coastguard Worker         case FTS_D:
111*38e8c45fSAndroid Build Coastguard Worker         case FTS_DEFAULT:
112*38e8c45fSAndroid Build Coastguard Worker         case FTS_F:
113*38e8c45fSAndroid Build Coastguard Worker         case FTS_SL:
114*38e8c45fSAndroid Build Coastguard Worker         case FTS_SLNONE: {
115*38e8c45fSAndroid Build Coastguard Worker             auto item = std::shared_ptr<CacheItem>(new CacheItem(p));
116*38e8c45fSAndroid Build Coastguard Worker             p->fts_pointer = static_cast<void*>(item.get());
117*38e8c45fSAndroid Build Coastguard Worker             items.push_back(item);
118*38e8c45fSAndroid Build Coastguard Worker         }
119*38e8c45fSAndroid Build Coastguard Worker         }
120*38e8c45fSAndroid Build Coastguard Worker 
121*38e8c45fSAndroid Build Coastguard Worker         switch (p->fts_info) {
122*38e8c45fSAndroid Build Coastguard Worker         case FTS_D: {
123*38e8c45fSAndroid Build Coastguard Worker             auto item = static_cast<CacheItem*>(p->fts_pointer);
124*38e8c45fSAndroid Build Coastguard Worker             item->group |= (getxattr(p->fts_path, kXattrCacheGroup, nullptr, 0) >= 0);
125*38e8c45fSAndroid Build Coastguard Worker             item->tombstone |= (getxattr(p->fts_path, kXattrCacheTombstone, nullptr, 0) >= 0);
126*38e8c45fSAndroid Build Coastguard Worker 
127*38e8c45fSAndroid Build Coastguard Worker             // When group, immediately collect all files under tree
128*38e8c45fSAndroid Build Coastguard Worker             if (item->group) {
129*38e8c45fSAndroid Build Coastguard Worker                 while ((p = fts_read(fts)) != nullptr) {
130*38e8c45fSAndroid Build Coastguard Worker                     if (p->fts_info == FTS_DP && p->fts_level == item->level) break;
131*38e8c45fSAndroid Build Coastguard Worker                     switch (p->fts_info) {
132*38e8c45fSAndroid Build Coastguard Worker                     case FTS_D:
133*38e8c45fSAndroid Build Coastguard Worker                     case FTS_DEFAULT:
134*38e8c45fSAndroid Build Coastguard Worker                     case FTS_F:
135*38e8c45fSAndroid Build Coastguard Worker                     case FTS_SL:
136*38e8c45fSAndroid Build Coastguard Worker                     case FTS_SLNONE:
137*38e8c45fSAndroid Build Coastguard Worker                         item->size += p->fts_statp->st_blocks * 512;
138*38e8c45fSAndroid Build Coastguard Worker                         item->modified = std::max(item->modified, p->fts_statp->st_mtime);
139*38e8c45fSAndroid Build Coastguard Worker                     }
140*38e8c45fSAndroid Build Coastguard Worker                 }
141*38e8c45fSAndroid Build Coastguard Worker             }
142*38e8c45fSAndroid Build Coastguard Worker         }
143*38e8c45fSAndroid Build Coastguard Worker         }
144*38e8c45fSAndroid Build Coastguard Worker 
145*38e8c45fSAndroid Build Coastguard Worker         // Bubble up modified time to parent
146*38e8c45fSAndroid Build Coastguard Worker         CHECK(p != nullptr);
147*38e8c45fSAndroid Build Coastguard Worker         switch (p->fts_info) {
148*38e8c45fSAndroid Build Coastguard Worker         case FTS_DP:
149*38e8c45fSAndroid Build Coastguard Worker         case FTS_DEFAULT:
150*38e8c45fSAndroid Build Coastguard Worker         case FTS_F:
151*38e8c45fSAndroid Build Coastguard Worker         case FTS_SL:
152*38e8c45fSAndroid Build Coastguard Worker         case FTS_SLNONE: {
153*38e8c45fSAndroid Build Coastguard Worker             auto item = static_cast<CacheItem*>(p->fts_pointer);
154*38e8c45fSAndroid Build Coastguard Worker             auto parent = static_cast<CacheItem*>(p->fts_parent->fts_pointer);
155*38e8c45fSAndroid Build Coastguard Worker             if (parent) {
156*38e8c45fSAndroid Build Coastguard Worker                 parent->modified = std::max(parent->modified, item->modified);
157*38e8c45fSAndroid Build Coastguard Worker             }
158*38e8c45fSAndroid Build Coastguard Worker         }
159*38e8c45fSAndroid Build Coastguard Worker         }
160*38e8c45fSAndroid Build Coastguard Worker     }
161*38e8c45fSAndroid Build Coastguard Worker     fts_close(fts);
162*38e8c45fSAndroid Build Coastguard Worker }
163*38e8c45fSAndroid Build Coastguard Worker 
loadItems()164*38e8c45fSAndroid Build Coastguard Worker void CacheTracker::loadItems() {
165*38e8c45fSAndroid Build Coastguard Worker     items.clear();
166*38e8c45fSAndroid Build Coastguard Worker 
167*38e8c45fSAndroid Build Coastguard Worker     ATRACE_BEGIN("loadItems");
168*38e8c45fSAndroid Build Coastguard Worker     for (const auto& path : mDataPaths) {
169*38e8c45fSAndroid Build Coastguard Worker         loadItemsFrom(read_path_inode(path, "cache", kXattrInodeCache));
170*38e8c45fSAndroid Build Coastguard Worker         loadItemsFrom(read_path_inode(path, "code_cache", kXattrInodeCodeCache));
171*38e8c45fSAndroid Build Coastguard Worker     }
172*38e8c45fSAndroid Build Coastguard Worker     ATRACE_END();
173*38e8c45fSAndroid Build Coastguard Worker 
174*38e8c45fSAndroid Build Coastguard Worker     ATRACE_BEGIN("sortItems");
175*38e8c45fSAndroid Build Coastguard Worker     auto cmp = [](std::shared_ptr<CacheItem> left, std::shared_ptr<CacheItem> right) {
176*38e8c45fSAndroid Build Coastguard Worker         // TODO: sort dotfiles last
177*38e8c45fSAndroid Build Coastguard Worker         // TODO: sort code_cache last
178*38e8c45fSAndroid Build Coastguard Worker         if (left->modified != right->modified) {
179*38e8c45fSAndroid Build Coastguard Worker             return (left->modified > right->modified);
180*38e8c45fSAndroid Build Coastguard Worker         }
181*38e8c45fSAndroid Build Coastguard Worker         if (left->level != right->level) {
182*38e8c45fSAndroid Build Coastguard Worker             return (left->level < right->level);
183*38e8c45fSAndroid Build Coastguard Worker         }
184*38e8c45fSAndroid Build Coastguard Worker         return left->directory;
185*38e8c45fSAndroid Build Coastguard Worker     };
186*38e8c45fSAndroid Build Coastguard Worker     std::stable_sort(items.begin(), items.end(), cmp);
187*38e8c45fSAndroid Build Coastguard Worker     ATRACE_END();
188*38e8c45fSAndroid Build Coastguard Worker }
189*38e8c45fSAndroid Build Coastguard Worker 
ensureItems()190*38e8c45fSAndroid Build Coastguard Worker void CacheTracker::ensureItems() {
191*38e8c45fSAndroid Build Coastguard Worker     if (mItemsLoaded) {
192*38e8c45fSAndroid Build Coastguard Worker         return;
193*38e8c45fSAndroid Build Coastguard Worker     } else {
194*38e8c45fSAndroid Build Coastguard Worker         loadItems();
195*38e8c45fSAndroid Build Coastguard Worker         mItemsLoaded = true;
196*38e8c45fSAndroid Build Coastguard Worker     }
197*38e8c45fSAndroid Build Coastguard Worker }
198*38e8c45fSAndroid Build Coastguard Worker 
getCacheRatio()199*38e8c45fSAndroid Build Coastguard Worker int CacheTracker::getCacheRatio() {
200*38e8c45fSAndroid Build Coastguard Worker     if (cacheQuota == 0) {
201*38e8c45fSAndroid Build Coastguard Worker         return 0;
202*38e8c45fSAndroid Build Coastguard Worker     } else {
203*38e8c45fSAndroid Build Coastguard Worker         return (cacheUsed * 10000) / cacheQuota;
204*38e8c45fSAndroid Build Coastguard Worker     }
205*38e8c45fSAndroid Build Coastguard Worker }
206*38e8c45fSAndroid Build Coastguard Worker 
207*38e8c45fSAndroid Build Coastguard Worker }  // namespace installd
208*38e8c45fSAndroid Build Coastguard Worker }  // namespace android
209