blob: 73aa2af0174a5113dca94fad92864640a5960059 [file] [log] [blame]
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -08001/*
2 * Copyright (C) 2019 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//#define LOG_NDEBUG 0
18#define LOG_TAG "libprocessgroup"
19
20#include <fcntl.h>
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -080021#include <task_profiles.h>
22#include <string>
23
24#include <android-base/file.h>
25#include <android-base/logging.h>
Suren Baghdasaryan35221b52020-11-20 17:08:51 -080026#include <android-base/properties.h>
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -080027#include <android-base/stringprintf.h>
Rick Yiubc1ad962020-10-26 20:32:52 +080028#include <android-base/strings.h>
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -080029#include <android-base/threads.h>
30
31#include <cutils/android_filesystem_config.h>
32
33#include <json/reader.h>
34#include <json/value.h>
35
Suren Baghdasaryaneca87cb2019-02-02 14:19:41 -080036// To avoid issues in sdk_mac build
37#if defined(__ANDROID__)
38#include <sys/prctl.h>
39#endif
40
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -080041using android::base::GetThreadId;
Suren Baghdasaryan35221b52020-11-20 17:08:51 -080042using android::base::GetUintProperty;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -080043using android::base::StringPrintf;
Rick Yiubc1ad962020-10-26 20:32:52 +080044using android::base::StringReplace;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -080045using android::base::unique_fd;
46using android::base::WriteStringToFile;
47
Suren Baghdasaryan35221b52020-11-20 17:08:51 -080048static constexpr const char* TASK_PROFILE_DB_FILE = "/etc/task_profiles.json";
49static constexpr const char* TASK_PROFILE_DB_VENDOR_FILE = "/vendor/etc/task_profiles.json";
50
51static constexpr const char* TEMPLATE_TASK_PROFILE_API_FILE =
52 "/etc/task_profiles/task_profiles_%u.json";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -080053
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -080054class FdCacheHelper {
55 public:
56 enum FdState {
57 FDS_INACCESSIBLE = -1,
58 FDS_APP_DEPENDENT = -2,
59 FDS_NOT_CACHED = -3,
60 };
61
62 static void Cache(const std::string& path, android::base::unique_fd& fd);
63 static void Drop(android::base::unique_fd& fd);
64 static void Init(const std::string& path, android::base::unique_fd& fd);
65 static bool IsCached(const android::base::unique_fd& fd) { return fd > FDS_INACCESSIBLE; }
66
67 private:
68 static bool IsAppDependentPath(const std::string& path);
69};
70
71void FdCacheHelper::Init(const std::string& path, android::base::unique_fd& fd) {
72 // file descriptors for app-dependent paths can't be cached
73 if (IsAppDependentPath(path)) {
74 // file descriptor is not cached
75 fd.reset(FDS_APP_DEPENDENT);
76 return;
77 }
78 // file descriptor can be cached later on request
79 fd.reset(FDS_NOT_CACHED);
80}
81
82void FdCacheHelper::Cache(const std::string& path, android::base::unique_fd& fd) {
83 if (fd != FDS_NOT_CACHED) {
84 return;
85 }
86
87 if (access(path.c_str(), W_OK) != 0) {
88 // file is not accessible
89 fd.reset(FDS_INACCESSIBLE);
90 return;
91 }
92
93 unique_fd tmp_fd(TEMP_FAILURE_RETRY(open(path.c_str(), O_WRONLY | O_CLOEXEC)));
94 if (tmp_fd < 0) {
95 PLOG(ERROR) << "Failed to cache fd '" << path << "'";
96 fd.reset(FDS_INACCESSIBLE);
97 return;
98 }
99
100 fd = std::move(tmp_fd);
101}
102
103void FdCacheHelper::Drop(android::base::unique_fd& fd) {
104 if (fd == FDS_NOT_CACHED) {
105 return;
106 }
107
108 fd.reset(FDS_NOT_CACHED);
109}
110
111bool FdCacheHelper::IsAppDependentPath(const std::string& path) {
112 return path.find("<uid>", 0) != std::string::npos || path.find("<pid>", 0) != std::string::npos;
113}
114
Bart Van Assche4c99e962022-02-03 19:50:16 +0000115IProfileAttribute::~IProfileAttribute() = default;
116
Suren Baghdasaryan81b9f0b2020-07-01 12:34:17 -0700117void ProfileAttribute::Reset(const CgroupController& controller, const std::string& file_name) {
118 controller_ = controller;
119 file_name_ = file_name;
120}
121
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800122bool ProfileAttribute::GetPathForTask(int tid, std::string* path) const {
123 std::string subgroup;
Yifan Hong53e0deb2019-03-22 17:01:08 -0700124 if (!controller()->GetTaskGroup(tid, &subgroup)) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800125 return false;
126 }
127
128 if (path == nullptr) {
129 return true;
130 }
131
132 if (subgroup.empty()) {
Yifan Hong53e0deb2019-03-22 17:01:08 -0700133 *path = StringPrintf("%s/%s", controller()->path(), file_name_.c_str());
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800134 } else {
Yifan Hong53e0deb2019-03-22 17:01:08 -0700135 *path = StringPrintf("%s/%s/%s", controller()->path(), subgroup.c_str(),
136 file_name_.c_str());
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800137 }
138 return true;
139}
140
141bool SetClampsAction::ExecuteForProcess(uid_t, pid_t) const {
142 // TODO: add support when kernel supports util_clamp
143 LOG(WARNING) << "SetClampsAction::ExecuteForProcess is not supported";
144 return false;
145}
146
147bool SetClampsAction::ExecuteForTask(int) const {
148 // TODO: add support when kernel supports util_clamp
149 LOG(WARNING) << "SetClampsAction::ExecuteForTask is not supported";
150 return false;
151}
152
Suren Baghdasaryaneca87cb2019-02-02 14:19:41 -0800153// To avoid issues in sdk_mac build
154#if defined(__ANDROID__)
155
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800156bool SetTimerSlackAction::IsTimerSlackSupported(int tid) {
157 auto file = StringPrintf("/proc/%d/timerslack_ns", tid);
158
159 return (access(file.c_str(), W_OK) == 0);
160}
161
162bool SetTimerSlackAction::ExecuteForTask(int tid) const {
163 static bool sys_supports_timerslack = IsTimerSlackSupported(tid);
164
165 // v4.6+ kernels support the /proc/<tid>/timerslack_ns interface.
166 // TODO: once we've backported this, log if the open(2) fails.
167 if (sys_supports_timerslack) {
168 auto file = StringPrintf("/proc/%d/timerslack_ns", tid);
169 if (!WriteStringToFile(std::to_string(slack_), file)) {
Suren Baghdasaryan2bc52282019-02-12 17:30:26 -0800170 if (errno == ENOENT) {
171 // This happens when process is already dead
172 return true;
173 }
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800174 PLOG(ERROR) << "set_timerslack_ns write failed";
175 }
176 }
177
178 // TODO: Remove when /proc/<tid>/timerslack_ns interface is backported.
179 if (tid == 0 || tid == GetThreadId()) {
180 if (prctl(PR_SET_TIMERSLACK, slack_) == -1) {
181 PLOG(ERROR) << "set_timerslack_ns prctl failed";
182 }
183 }
184
185 return true;
186}
187
Bart Van Assche20d59bd2022-01-24 19:45:59 +0000188#else
189
190bool SetTimerSlackAction::ExecuteForTask(int) const {
191 return true;
192};
193
Suren Baghdasaryaneca87cb2019-02-02 14:19:41 -0800194#endif
195
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800196bool SetAttributeAction::ExecuteForProcess(uid_t, pid_t pid) const {
197 return ExecuteForTask(pid);
198}
199
200bool SetAttributeAction::ExecuteForTask(int tid) const {
201 std::string path;
202
203 if (!attribute_->GetPathForTask(tid, &path)) {
Wei Wangd71d3012019-03-07 11:59:12 -0800204 LOG(ERROR) << "Failed to find cgroup for tid " << tid;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800205 return false;
206 }
207
208 if (!WriteStringToFile(value_, path)) {
209 PLOG(ERROR) << "Failed to write '" << value_ << "' to " << path;
210 return false;
211 }
212
213 return true;
214}
215
Rick Yiud4c53512021-11-21 15:57:36 +0800216SetCgroupAction::SetCgroupAction(const CgroupController& c, const std::string& p)
217 : controller_(c), path_(p) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800218 FdCacheHelper::Init(controller_.GetTasksFilePath(path_), fd_[ProfileAction::RCT_TASK]);
219 // uid and pid don't matter because IsAppDependentPath ensures the path doesn't use them
220 FdCacheHelper::Init(controller_.GetProcsFilePath(path_, 0, 0), fd_[ProfileAction::RCT_PROCESS]);
Rick Yiud4c53512021-11-21 15:57:36 +0800221}
222
Suren Baghdasaryanec885562021-09-02 19:47:12 -0700223bool SetCgroupAction::AddTidToCgroup(int tid, int fd, const char* controller_name) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800224 if (tid <= 0) {
225 return true;
226 }
227
228 std::string value = std::to_string(tid);
229
Suren Baghdasaryanec885562021-09-02 19:47:12 -0700230 if (TEMP_FAILURE_RETRY(write(fd, value.c_str(), value.length())) == value.length()) {
231 return true;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800232 }
233
Suren Baghdasaryanec885562021-09-02 19:47:12 -0700234 // If the thread is in the process of exiting, don't flag an error
235 if (errno == ESRCH) {
236 return true;
237 }
238
239 // ENOSPC is returned when cpuset cgroup that we are joining has no online cpus
240 if (errno == ENOSPC && !strcmp(controller_name, "cpuset")) {
241 // This is an abnormal case happening only in testing, so report it only once
242 static bool empty_cpuset_reported = false;
243
244 if (empty_cpuset_reported) {
245 return true;
246 }
247
248 LOG(ERROR) << "Failed to add task '" << value
249 << "' into cpuset because all cpus in that cpuset are offline";
250 empty_cpuset_reported = true;
251 } else {
252 PLOG(ERROR) << "AddTidToCgroup failed to write '" << value << "'; fd=" << fd;
253 }
254
255 return false;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800256}
257
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800258ProfileAction::CacheUseResult SetCgroupAction::UseCachedFd(ResourceCacheType cache_type,
259 int id) const {
260 std::lock_guard<std::mutex> lock(fd_mutex_);
261 if (FdCacheHelper::IsCached(fd_[cache_type])) {
262 // fd is cached, reuse it
263 if (!AddTidToCgroup(id, fd_[cache_type], controller()->name())) {
264 LOG(ERROR) << "Failed to add task into cgroup";
265 return ProfileAction::FAIL;
266 }
267 return ProfileAction::SUCCESS;
268 }
269
270 if (fd_[cache_type] == FdCacheHelper::FDS_INACCESSIBLE) {
271 // no permissions to access the file, ignore
272 return ProfileAction::SUCCESS;
273 }
274
275 if (cache_type == ResourceCacheType::RCT_TASK &&
276 fd_[cache_type] == FdCacheHelper::FDS_APP_DEPENDENT) {
277 // application-dependent path can't be used with tid
278 PLOG(ERROR) << "Application profile can't be applied to a thread";
279 return ProfileAction::FAIL;
280 }
281
282 return ProfileAction::UNUSED;
283}
284
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800285bool SetCgroupAction::ExecuteForProcess(uid_t uid, pid_t pid) const {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800286 CacheUseResult result = UseCachedFd(ProfileAction::RCT_PROCESS, pid);
287 if (result != ProfileAction::UNUSED) {
288 return result == ProfileAction::SUCCESS;
289 }
290
291 // fd was not cached or cached fd can't be used
Yifan Hong53e0deb2019-03-22 17:01:08 -0700292 std::string procs_path = controller()->GetProcsFilePath(path_, uid, pid);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800293 unique_fd tmp_fd(TEMP_FAILURE_RETRY(open(procs_path.c_str(), O_WRONLY | O_CLOEXEC)));
294 if (tmp_fd < 0) {
Elliott Hughes08b4d322019-03-14 20:06:36 -0700295 PLOG(WARNING) << "Failed to open " << procs_path;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800296 return false;
297 }
Suren Baghdasaryanec885562021-09-02 19:47:12 -0700298 if (!AddTidToCgroup(pid, tmp_fd, controller()->name())) {
Wei Wangd71d3012019-03-07 11:59:12 -0800299 LOG(ERROR) << "Failed to add task into cgroup";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800300 return false;
301 }
302
303 return true;
304}
305
306bool SetCgroupAction::ExecuteForTask(int tid) const {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800307 CacheUseResult result = UseCachedFd(ProfileAction::RCT_TASK, tid);
308 if (result != ProfileAction::UNUSED) {
309 return result == ProfileAction::SUCCESS;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800310 }
311
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800312 // fd was not cached or cached fd can't be used
Yifan Hong53e0deb2019-03-22 17:01:08 -0700313 std::string tasks_path = controller()->GetTasksFilePath(path_);
Suren Baghdasaryanbee9f572019-02-05 16:44:22 -0800314 unique_fd tmp_fd(TEMP_FAILURE_RETRY(open(tasks_path.c_str(), O_WRONLY | O_CLOEXEC)));
315 if (tmp_fd < 0) {
Rick Yiud4c53512021-11-21 15:57:36 +0800316 PLOG(WARNING) << "Failed to open " << tasks_path;
Suren Baghdasaryan8a315d22019-02-14 14:40:41 -0800317 return false;
Suren Baghdasaryanbee9f572019-02-05 16:44:22 -0800318 }
Suren Baghdasaryanec885562021-09-02 19:47:12 -0700319 if (!AddTidToCgroup(tid, tmp_fd, controller()->name())) {
Wei Wangd71d3012019-03-07 11:59:12 -0800320 LOG(ERROR) << "Failed to add task into cgroup";
Suren Baghdasaryanbee9f572019-02-05 16:44:22 -0800321 return false;
322 }
323
324 return true;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800325}
326
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800327void SetCgroupAction::EnableResourceCaching(ResourceCacheType cache_type) {
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800328 std::lock_guard<std::mutex> lock(fd_mutex_);
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800329 // Return early to prevent unnecessary calls to controller_.Get{Tasks|Procs}FilePath() which
330 // include regex evaluations
331 if (fd_[cache_type] != FdCacheHelper::FDS_NOT_CACHED) {
332 return;
333 }
334 switch (cache_type) {
335 case (ProfileAction::RCT_TASK):
336 FdCacheHelper::Cache(controller_.GetTasksFilePath(path_), fd_[cache_type]);
337 break;
338 case (ProfileAction::RCT_PROCESS):
339 // uid and pid don't matter because IsAppDependentPath ensures the path doesn't use them
340 FdCacheHelper::Cache(controller_.GetProcsFilePath(path_, 0, 0), fd_[cache_type]);
341 break;
342 default:
343 LOG(ERROR) << "Invalid cache type is specified!";
344 break;
345 }
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800346}
347
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800348void SetCgroupAction::DropResourceCaching(ResourceCacheType cache_type) {
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800349 std::lock_guard<std::mutex> lock(fd_mutex_);
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800350 FdCacheHelper::Drop(fd_[cache_type]);
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800351}
352
Rick Yiud4c53512021-11-21 15:57:36 +0800353WriteFileAction::WriteFileAction(const std::string& path, const std::string& value,
354 bool logfailures)
355 : path_(path), value_(value), logfailures_(logfailures) {
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800356 FdCacheHelper::Init(path_, fd_);
Rick Yiud4c53512021-11-21 15:57:36 +0800357}
Rick Yiubc1ad962020-10-26 20:32:52 +0800358
Rick Yiud4c53512021-11-21 15:57:36 +0800359bool WriteFileAction::WriteValueToFile(const std::string& value, const std::string& path,
360 bool logfailures) {
361 // Use WriteStringToFd instead of WriteStringToFile because the latter will open file with
362 // O_TRUNC which causes kernfs_mutex contention
363 unique_fd tmp_fd(TEMP_FAILURE_RETRY(open(path.c_str(), O_WRONLY | O_CLOEXEC)));
Rick Yiubc1ad962020-10-26 20:32:52 +0800364
Rick Yiud4c53512021-11-21 15:57:36 +0800365 if (tmp_fd < 0) {
366 if (logfailures) PLOG(WARNING) << "Failed to open " << path;
367 return false;
368 }
369
370 if (!WriteStringToFd(value, tmp_fd)) {
371 if (logfailures) PLOG(ERROR) << "Failed to write '" << value << "' to " << path;
Rick Yiubc1ad962020-10-26 20:32:52 +0800372 return false;
373 }
374
375 return true;
376}
377
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800378ProfileAction::CacheUseResult WriteFileAction::UseCachedFd(ResourceCacheType cache_type,
379 const std::string& value) const {
Rick Yiud4c53512021-11-21 15:57:36 +0800380 std::lock_guard<std::mutex> lock(fd_mutex_);
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800381 if (FdCacheHelper::IsCached(fd_)) {
382 // fd is cached, reuse it
383 if (!WriteStringToFd(value, fd_)) {
384 if (logfailures_) PLOG(ERROR) << "Failed to write '" << value << "' to " << path_;
385 return ProfileAction::FAIL;
386 }
387 return ProfileAction::SUCCESS;
388 }
389
390 if (fd_ == FdCacheHelper::FDS_INACCESSIBLE) {
391 // no permissions to access the file, ignore
392 return ProfileAction::SUCCESS;
393 }
394
395 if (cache_type == ResourceCacheType::RCT_TASK && fd_ == FdCacheHelper::FDS_APP_DEPENDENT) {
396 // application-dependent path can't be used with tid
397 PLOG(ERROR) << "Application profile can't be applied to a thread";
398 return ProfileAction::FAIL;
399 }
400 return ProfileAction::UNUSED;
401}
402
403bool WriteFileAction::ExecuteForProcess(uid_t uid, pid_t pid) const {
Rick Yiud4c53512021-11-21 15:57:36 +0800404 std::string value(value_);
Rick Yiud4c53512021-11-21 15:57:36 +0800405
406 value = StringReplace(value, "<uid>", std::to_string(uid), true);
407 value = StringReplace(value, "<pid>", std::to_string(pid), true);
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800408
409 CacheUseResult result = UseCachedFd(ProfileAction::RCT_PROCESS, value);
410 if (result != ProfileAction::UNUSED) {
411 return result == ProfileAction::SUCCESS;
412 }
413
414 std::string path(path_);
Rick Yiud4c53512021-11-21 15:57:36 +0800415 path = StringReplace(path, "<uid>", std::to_string(uid), true);
416 path = StringReplace(path, "<pid>", std::to_string(pid), true);
417
418 return WriteValueToFile(value, path, logfailures_);
419}
420
Rick Yiubc1ad962020-10-26 20:32:52 +0800421bool WriteFileAction::ExecuteForTask(int tid) const {
Rick Yiud4c53512021-11-21 15:57:36 +0800422 std::string value(value_);
Rick Yiubc1ad962020-10-26 20:32:52 +0800423 int uid = getuid();
424
Rick Yiubc1ad962020-10-26 20:32:52 +0800425 value = StringReplace(value, "<uid>", std::to_string(uid), true);
426 value = StringReplace(value, "<pid>", std::to_string(tid), true);
427
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800428 CacheUseResult result = UseCachedFd(ProfileAction::RCT_TASK, value);
429 if (result != ProfileAction::UNUSED) {
430 return result == ProfileAction::SUCCESS;
Rick Yiubc1ad962020-10-26 20:32:52 +0800431 }
432
Rick Yiud4c53512021-11-21 15:57:36 +0800433 return WriteValueToFile(value, path_, logfailures_);
Rick Yiubc1ad962020-10-26 20:32:52 +0800434}
435
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800436void WriteFileAction::EnableResourceCaching(ResourceCacheType) {
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800437 std::lock_guard<std::mutex> lock(fd_mutex_);
438 FdCacheHelper::Cache(path_, fd_);
439}
440
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800441void WriteFileAction::DropResourceCaching(ResourceCacheType) {
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800442 std::lock_guard<std::mutex> lock(fd_mutex_);
443 FdCacheHelper::Drop(fd_);
444}
445
Rick Yiu0b211fa2019-09-16 19:07:17 +0800446bool ApplyProfileAction::ExecuteForProcess(uid_t uid, pid_t pid) const {
447 for (const auto& profile : profiles_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800448 profile->ExecuteForProcess(uid, pid);
Rick Yiu0b211fa2019-09-16 19:07:17 +0800449 }
450 return true;
451}
452
453bool ApplyProfileAction::ExecuteForTask(int tid) const {
454 for (const auto& profile : profiles_) {
Wei Wang8722e4d2021-05-14 12:34:54 -0700455 profile->ExecuteForTask(tid);
Rick Yiu0b211fa2019-09-16 19:07:17 +0800456 }
457 return true;
458}
459
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800460void ApplyProfileAction::EnableResourceCaching(ResourceCacheType cache_type) {
Suren Baghdasaryan911109c2020-02-13 17:28:00 -0800461 for (const auto& profile : profiles_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800462 profile->EnableResourceCaching(cache_type);
Suren Baghdasaryan911109c2020-02-13 17:28:00 -0800463 }
464}
465
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800466void ApplyProfileAction::DropResourceCaching(ResourceCacheType cache_type) {
Suren Baghdasaryan911109c2020-02-13 17:28:00 -0800467 for (const auto& profile : profiles_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800468 profile->DropResourceCaching(cache_type);
Suren Baghdasaryan911109c2020-02-13 17:28:00 -0800469 }
470}
471
Suren Baghdasaryan84385952020-01-24 16:36:10 -0800472void TaskProfile::MoveTo(TaskProfile* profile) {
473 profile->elements_ = std::move(elements_);
474 profile->res_cached_ = res_cached_;
475}
476
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800477bool TaskProfile::ExecuteForProcess(uid_t uid, pid_t pid) const {
478 for (const auto& element : elements_) {
479 if (!element->ExecuteForProcess(uid, pid)) {
Bart Van Asschef096bd22022-01-24 19:59:13 +0000480 LOG(VERBOSE) << "Applying profile action " << element->Name() << " failed";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800481 return false;
482 }
483 }
484 return true;
485}
486
487bool TaskProfile::ExecuteForTask(int tid) const {
488 if (tid == 0) {
489 tid = GetThreadId();
490 }
491 for (const auto& element : elements_) {
492 if (!element->ExecuteForTask(tid)) {
Bart Van Asschef096bd22022-01-24 19:59:13 +0000493 LOG(VERBOSE) << "Applying profile action " << element->Name() << " failed";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800494 return false;
495 }
496 }
497 return true;
498}
499
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800500void TaskProfile::EnableResourceCaching(ProfileAction::ResourceCacheType cache_type) {
Suren Baghdasaryan8a315d22019-02-14 14:40:41 -0800501 if (res_cached_) {
502 return;
503 }
504
505 for (auto& element : elements_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800506 element->EnableResourceCaching(cache_type);
Suren Baghdasaryan8a315d22019-02-14 14:40:41 -0800507 }
508
509 res_cached_ = true;
510}
511
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800512void TaskProfile::DropResourceCaching(ProfileAction::ResourceCacheType cache_type) {
Riddle Hsua6abd822019-06-18 15:53:53 -0600513 if (!res_cached_) {
514 return;
515 }
516
517 for (auto& element : elements_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800518 element->DropResourceCaching(cache_type);
Riddle Hsua6abd822019-06-18 15:53:53 -0600519 }
520
521 res_cached_ = false;
522}
523
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800524void TaskProfiles::DropResourceCaching(ProfileAction::ResourceCacheType cache_type) const {
Riddle Hsua6abd822019-06-18 15:53:53 -0600525 for (auto& iter : profiles_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800526 iter.second->DropResourceCaching(cache_type);
Riddle Hsua6abd822019-06-18 15:53:53 -0600527 }
528}
529
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800530TaskProfiles& TaskProfiles::GetInstance() {
Peter Collingbournedba6d442019-03-20 21:09:46 -0700531 // Deliberately leak this object to avoid a race between destruction on
532 // process exit and concurrent access from another thread.
533 static auto* instance = new TaskProfiles;
534 return *instance;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800535}
536
537TaskProfiles::TaskProfiles() {
Suren Baghdasaryan756a6042020-12-03 11:38:42 -0800538 // load system task profiles
539 if (!Load(CgroupMap::GetInstance(), TASK_PROFILE_DB_FILE)) {
540 LOG(ERROR) << "Loading " << TASK_PROFILE_DB_FILE << " for [" << getpid() << "] failed";
541 }
Suren Baghdasaryan35221b52020-11-20 17:08:51 -0800542
543 // load API-level specific system task profiles if available
Suren Baghdasaryan756a6042020-12-03 11:38:42 -0800544 unsigned int api_level = GetUintProperty<unsigned int>("ro.product.first_api_level", 0);
Suren Baghdasaryan35221b52020-11-20 17:08:51 -0800545 if (api_level > 0) {
546 std::string api_profiles_path =
547 android::base::StringPrintf(TEMPLATE_TASK_PROFILE_API_FILE, api_level);
548 if (!access(api_profiles_path.c_str(), F_OK) || errno != ENOENT) {
Suren Baghdasaryan756a6042020-12-03 11:38:42 -0800549 if (!Load(CgroupMap::GetInstance(), api_profiles_path)) {
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800550 LOG(ERROR) << "Loading " << api_profiles_path << " for [" << getpid() << "] failed";
Suren Baghdasaryan756a6042020-12-03 11:38:42 -0800551 }
Suren Baghdasaryan35221b52020-11-20 17:08:51 -0800552 }
553 }
554
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800555 // load vendor task profiles if the file exists
556 if (!access(TASK_PROFILE_DB_VENDOR_FILE, F_OK) &&
557 !Load(CgroupMap::GetInstance(), TASK_PROFILE_DB_VENDOR_FILE)) {
558 LOG(ERROR) << "Loading " << TASK_PROFILE_DB_VENDOR_FILE << " for [" << getpid()
559 << "] failed";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800560 }
561}
562
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800563bool TaskProfiles::Load(const CgroupMap& cg_map, const std::string& file_name) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800564 std::string json_doc;
565
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800566 if (!android::base::ReadFileToString(file_name, &json_doc)) {
567 LOG(ERROR) << "Failed to read task profiles from " << file_name;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800568 return false;
569 }
570
Haibo Huangd9ac92a2021-02-24 17:34:50 -0800571 Json::CharReaderBuilder builder;
572 std::unique_ptr<Json::CharReader> reader(builder.newCharReader());
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800573 Json::Value root;
Haibo Huangd9ac92a2021-02-24 17:34:50 -0800574 std::string errorMessage;
575 if (!reader->parse(&*json_doc.begin(), &*json_doc.end(), &root, &errorMessage)) {
576 LOG(ERROR) << "Failed to parse task profiles: " << errorMessage;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800577 return false;
578 }
579
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800580 const Json::Value& attr = root["Attributes"];
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800581 for (Json::Value::ArrayIndex i = 0; i < attr.size(); ++i) {
582 std::string name = attr[i]["Name"].asString();
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800583 std::string controller_name = attr[i]["Controller"].asString();
584 std::string file_attr = attr[i]["File"].asString();
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800585
Suren Baghdasaryan81b9f0b2020-07-01 12:34:17 -0700586 auto controller = cg_map.FindController(controller_name);
587 if (controller.HasValue()) {
588 auto iter = attributes_.find(name);
589 if (iter == attributes_.end()) {
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800590 attributes_[name] = std::make_unique<ProfileAttribute>(controller, file_attr);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800591 } else {
Suren Baghdasaryan81b9f0b2020-07-01 12:34:17 -0700592 iter->second->Reset(controller, file_attr);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800593 }
594 } else {
Suren Baghdasaryan81b9f0b2020-07-01 12:34:17 -0700595 LOG(WARNING) << "Controller " << controller_name << " is not found";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800596 }
597 }
598
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800599 const Json::Value& profiles_val = root["Profiles"];
600 for (Json::Value::ArrayIndex i = 0; i < profiles_val.size(); ++i) {
601 const Json::Value& profile_val = profiles_val[i];
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800602
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800603 std::string profile_name = profile_val["Name"].asString();
604 const Json::Value& actions = profile_val["Actions"];
Bart Van Asschef096bd22022-01-24 19:59:13 +0000605 auto profile = std::make_shared<TaskProfile>(profile_name);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800606
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800607 for (Json::Value::ArrayIndex act_idx = 0; act_idx < actions.size(); ++act_idx) {
608 const Json::Value& action_val = actions[act_idx];
609 std::string action_name = action_val["Name"].asString();
610 const Json::Value& params_val = action_val["Params"];
611 if (action_name == "JoinCgroup") {
612 std::string controller_name = params_val["Controller"].asString();
613 std::string path = params_val["Path"].asString();
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800614
Yifan Hong53e0deb2019-03-22 17:01:08 -0700615 auto controller = cg_map.FindController(controller_name);
616 if (controller.HasValue()) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800617 profile->Add(std::make_unique<SetCgroupAction>(controller, path));
618 } else {
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800619 LOG(WARNING) << "JoinCgroup: controller " << controller_name << " is not found";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800620 }
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800621 } else if (action_name == "SetTimerSlack") {
622 std::string slack_value = params_val["Slack"].asString();
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800623 char* end;
624 unsigned long slack;
625
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800626 slack = strtoul(slack_value.c_str(), &end, 10);
627 if (end > slack_value.c_str()) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800628 profile->Add(std::make_unique<SetTimerSlackAction>(slack));
629 } else {
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800630 LOG(WARNING) << "SetTimerSlack: invalid parameter: " << slack_value;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800631 }
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800632 } else if (action_name == "SetAttribute") {
633 std::string attr_name = params_val["Name"].asString();
634 std::string attr_value = params_val["Value"].asString();
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800635
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800636 auto iter = attributes_.find(attr_name);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800637 if (iter != attributes_.end()) {
638 profile->Add(
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800639 std::make_unique<SetAttributeAction>(iter->second.get(), attr_value));
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800640 } else {
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800641 LOG(WARNING) << "SetAttribute: unknown attribute: " << attr_name;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800642 }
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800643 } else if (action_name == "SetClamps") {
644 std::string boost_value = params_val["Boost"].asString();
645 std::string clamp_value = params_val["Clamp"].asString();
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800646 char* end;
647 unsigned long boost;
648
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800649 boost = strtoul(boost_value.c_str(), &end, 10);
650 if (end > boost_value.c_str()) {
651 unsigned long clamp = strtoul(clamp_value.c_str(), &end, 10);
652 if (end > clamp_value.c_str()) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800653 profile->Add(std::make_unique<SetClampsAction>(boost, clamp));
654 } else {
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800655 LOG(WARNING) << "SetClamps: invalid parameter " << clamp_value;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800656 }
657 } else {
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800658 LOG(WARNING) << "SetClamps: invalid parameter: " << boost_value;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800659 }
Rick Yiubc1ad962020-10-26 20:32:52 +0800660 } else if (action_name == "WriteFile") {
661 std::string attr_filepath = params_val["FilePath"].asString();
662 std::string attr_value = params_val["Value"].asString();
663 if (!attr_filepath.empty() && !attr_value.empty()) {
Rick Yiu49fce952021-04-08 22:10:06 +0800664 std::string attr_logfailures = params_val["LogFailures"].asString();
665 bool logfailures = attr_logfailures.empty() || attr_logfailures == "true";
Rick Yiud76053a2021-01-25 12:44:45 +0800666 profile->Add(std::make_unique<WriteFileAction>(attr_filepath, attr_value,
Rick Yiu49fce952021-04-08 22:10:06 +0800667 logfailures));
Rick Yiubc1ad962020-10-26 20:32:52 +0800668 } else if (attr_filepath.empty()) {
669 LOG(WARNING) << "WriteFile: invalid parameter: "
670 << "empty filepath";
671 } else if (attr_value.empty()) {
672 LOG(WARNING) << "WriteFile: invalid parameter: "
673 << "empty value";
674 }
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800675 } else {
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800676 LOG(WARNING) << "Unknown profile action: " << action_name;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800677 }
678 }
Suren Baghdasaryan84385952020-01-24 16:36:10 -0800679 auto iter = profiles_.find(profile_name);
680 if (iter == profiles_.end()) {
681 profiles_[profile_name] = profile;
682 } else {
683 // Move the content rather that replace the profile because old profile might be
684 // referenced from an aggregate profile if vendor overrides task profiles
685 profile->MoveTo(iter->second.get());
686 profile.reset();
687 }
Rick Yiu0b211fa2019-09-16 19:07:17 +0800688 }
689
690 const Json::Value& aggregateprofiles_val = root["AggregateProfiles"];
691 for (Json::Value::ArrayIndex i = 0; i < aggregateprofiles_val.size(); ++i) {
692 const Json::Value& aggregateprofile_val = aggregateprofiles_val[i];
693
694 std::string aggregateprofile_name = aggregateprofile_val["Name"].asString();
695 const Json::Value& aggregateprofiles = aggregateprofile_val["Profiles"];
696 std::vector<std::shared_ptr<TaskProfile>> profiles;
697 bool ret = true;
698
699 for (Json::Value::ArrayIndex pf_idx = 0; pf_idx < aggregateprofiles.size(); ++pf_idx) {
700 std::string profile_name = aggregateprofiles[pf_idx].asString();
701
702 if (profile_name == aggregateprofile_name) {
703 LOG(WARNING) << "AggregateProfiles: recursive profile name: " << profile_name;
704 ret = false;
705 break;
706 } else if (profiles_.find(profile_name) == profiles_.end()) {
707 LOG(WARNING) << "AggregateProfiles: undefined profile name: " << profile_name;
708 ret = false;
709 break;
710 } else {
711 profiles.push_back(profiles_[profile_name]);
712 }
713 }
714 if (ret) {
Bart Van Asschef096bd22022-01-24 19:59:13 +0000715 auto profile = std::make_shared<TaskProfile>(aggregateprofile_name);
Rick Yiu0b211fa2019-09-16 19:07:17 +0800716 profile->Add(std::make_unique<ApplyProfileAction>(profiles));
717 profiles_[aggregateprofile_name] = profile;
718 }
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800719 }
720
721 return true;
722}
723
Suren Baghdasaryan8a315d22019-02-14 14:40:41 -0800724TaskProfile* TaskProfiles::GetProfile(const std::string& name) const {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800725 auto iter = profiles_.find(name);
726
727 if (iter != profiles_.end()) {
728 return iter->second.get();
729 }
730 return nullptr;
731}
732
Bart Van Assche4c99e962022-02-03 19:50:16 +0000733const IProfileAttribute* TaskProfiles::GetAttribute(const std::string& name) const {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800734 auto iter = attributes_.find(name);
735
736 if (iter != attributes_.end()) {
737 return iter->second.get();
738 }
739 return nullptr;
740}
Rick Yiu0b211fa2019-09-16 19:07:17 +0800741
742bool TaskProfiles::SetProcessProfiles(uid_t uid, pid_t pid,
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800743 const std::vector<std::string>& profiles, bool use_fd_cache) {
Rick Yiu0b211fa2019-09-16 19:07:17 +0800744 for (const auto& name : profiles) {
745 TaskProfile* profile = GetProfile(name);
746 if (profile != nullptr) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800747 if (use_fd_cache) {
748 profile->EnableResourceCaching(ProfileAction::RCT_PROCESS);
749 }
Rick Yiu0b211fa2019-09-16 19:07:17 +0800750 if (!profile->ExecuteForProcess(uid, pid)) {
751 PLOG(WARNING) << "Failed to apply " << name << " process profile";
752 }
753 } else {
754 PLOG(WARNING) << "Failed to find " << name << "process profile";
755 }
756 }
757 return true;
758}
759
760bool TaskProfiles::SetTaskProfiles(int tid, const std::vector<std::string>& profiles,
761 bool use_fd_cache) {
762 for (const auto& name : profiles) {
763 TaskProfile* profile = GetProfile(name);
764 if (profile != nullptr) {
765 if (use_fd_cache) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800766 profile->EnableResourceCaching(ProfileAction::RCT_TASK);
Rick Yiu0b211fa2019-09-16 19:07:17 +0800767 }
768 if (!profile->ExecuteForTask(tid)) {
769 PLOG(WARNING) << "Failed to apply " << name << " task profile";
770 }
771 } else {
772 PLOG(WARNING) << "Failed to find " << name << "task profile";
773 }
774 }
775 return true;
776}