blob: 4a2bf381be0672db9efa5e57a78af64764e836e5 [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)) {
Bart Van Assche59af6802022-01-24 21:08:57 +0000209 if (errno == ENOENT) {
210 if (optional_) {
211 return true;
212 } else {
213 LOG(ERROR) << "No such cgroup attribute: " << path;
214 return false;
215 }
216 }
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800217 PLOG(ERROR) << "Failed to write '" << value_ << "' to " << path;
218 return false;
219 }
220
221 return true;
222}
223
Rick Yiud4c53512021-11-21 15:57:36 +0800224SetCgroupAction::SetCgroupAction(const CgroupController& c, const std::string& p)
225 : controller_(c), path_(p) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800226 FdCacheHelper::Init(controller_.GetTasksFilePath(path_), fd_[ProfileAction::RCT_TASK]);
227 // uid and pid don't matter because IsAppDependentPath ensures the path doesn't use them
228 FdCacheHelper::Init(controller_.GetProcsFilePath(path_, 0, 0), fd_[ProfileAction::RCT_PROCESS]);
Rick Yiud4c53512021-11-21 15:57:36 +0800229}
230
Suren Baghdasaryanec885562021-09-02 19:47:12 -0700231bool SetCgroupAction::AddTidToCgroup(int tid, int fd, const char* controller_name) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800232 if (tid <= 0) {
233 return true;
234 }
235
236 std::string value = std::to_string(tid);
237
Suren Baghdasaryanec885562021-09-02 19:47:12 -0700238 if (TEMP_FAILURE_RETRY(write(fd, value.c_str(), value.length())) == value.length()) {
239 return true;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800240 }
241
Suren Baghdasaryanec885562021-09-02 19:47:12 -0700242 // If the thread is in the process of exiting, don't flag an error
243 if (errno == ESRCH) {
244 return true;
245 }
246
247 // ENOSPC is returned when cpuset cgroup that we are joining has no online cpus
248 if (errno == ENOSPC && !strcmp(controller_name, "cpuset")) {
249 // This is an abnormal case happening only in testing, so report it only once
250 static bool empty_cpuset_reported = false;
251
252 if (empty_cpuset_reported) {
253 return true;
254 }
255
256 LOG(ERROR) << "Failed to add task '" << value
257 << "' into cpuset because all cpus in that cpuset are offline";
258 empty_cpuset_reported = true;
259 } else {
260 PLOG(ERROR) << "AddTidToCgroup failed to write '" << value << "'; fd=" << fd;
261 }
262
263 return false;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800264}
265
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800266ProfileAction::CacheUseResult SetCgroupAction::UseCachedFd(ResourceCacheType cache_type,
267 int id) const {
268 std::lock_guard<std::mutex> lock(fd_mutex_);
269 if (FdCacheHelper::IsCached(fd_[cache_type])) {
270 // fd is cached, reuse it
271 if (!AddTidToCgroup(id, fd_[cache_type], controller()->name())) {
272 LOG(ERROR) << "Failed to add task into cgroup";
273 return ProfileAction::FAIL;
274 }
275 return ProfileAction::SUCCESS;
276 }
277
278 if (fd_[cache_type] == FdCacheHelper::FDS_INACCESSIBLE) {
279 // no permissions to access the file, ignore
280 return ProfileAction::SUCCESS;
281 }
282
283 if (cache_type == ResourceCacheType::RCT_TASK &&
284 fd_[cache_type] == FdCacheHelper::FDS_APP_DEPENDENT) {
285 // application-dependent path can't be used with tid
286 PLOG(ERROR) << "Application profile can't be applied to a thread";
287 return ProfileAction::FAIL;
288 }
289
290 return ProfileAction::UNUSED;
291}
292
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800293bool SetCgroupAction::ExecuteForProcess(uid_t uid, pid_t pid) const {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800294 CacheUseResult result = UseCachedFd(ProfileAction::RCT_PROCESS, pid);
295 if (result != ProfileAction::UNUSED) {
296 return result == ProfileAction::SUCCESS;
297 }
298
299 // fd was not cached or cached fd can't be used
Yifan Hong53e0deb2019-03-22 17:01:08 -0700300 std::string procs_path = controller()->GetProcsFilePath(path_, uid, pid);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800301 unique_fd tmp_fd(TEMP_FAILURE_RETRY(open(procs_path.c_str(), O_WRONLY | O_CLOEXEC)));
302 if (tmp_fd < 0) {
Elliott Hughes08b4d322019-03-14 20:06:36 -0700303 PLOG(WARNING) << "Failed to open " << procs_path;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800304 return false;
305 }
Suren Baghdasaryanec885562021-09-02 19:47:12 -0700306 if (!AddTidToCgroup(pid, tmp_fd, controller()->name())) {
Wei Wangd71d3012019-03-07 11:59:12 -0800307 LOG(ERROR) << "Failed to add task into cgroup";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800308 return false;
309 }
310
311 return true;
312}
313
314bool SetCgroupAction::ExecuteForTask(int tid) const {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800315 CacheUseResult result = UseCachedFd(ProfileAction::RCT_TASK, tid);
316 if (result != ProfileAction::UNUSED) {
317 return result == ProfileAction::SUCCESS;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800318 }
319
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800320 // fd was not cached or cached fd can't be used
Yifan Hong53e0deb2019-03-22 17:01:08 -0700321 std::string tasks_path = controller()->GetTasksFilePath(path_);
Suren Baghdasaryanbee9f572019-02-05 16:44:22 -0800322 unique_fd tmp_fd(TEMP_FAILURE_RETRY(open(tasks_path.c_str(), O_WRONLY | O_CLOEXEC)));
323 if (tmp_fd < 0) {
Rick Yiud4c53512021-11-21 15:57:36 +0800324 PLOG(WARNING) << "Failed to open " << tasks_path;
Suren Baghdasaryan8a315d22019-02-14 14:40:41 -0800325 return false;
Suren Baghdasaryanbee9f572019-02-05 16:44:22 -0800326 }
Suren Baghdasaryanec885562021-09-02 19:47:12 -0700327 if (!AddTidToCgroup(tid, tmp_fd, controller()->name())) {
Wei Wangd71d3012019-03-07 11:59:12 -0800328 LOG(ERROR) << "Failed to add task into cgroup";
Suren Baghdasaryanbee9f572019-02-05 16:44:22 -0800329 return false;
330 }
331
332 return true;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800333}
334
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800335void SetCgroupAction::EnableResourceCaching(ResourceCacheType cache_type) {
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800336 std::lock_guard<std::mutex> lock(fd_mutex_);
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800337 // Return early to prevent unnecessary calls to controller_.Get{Tasks|Procs}FilePath() which
338 // include regex evaluations
339 if (fd_[cache_type] != FdCacheHelper::FDS_NOT_CACHED) {
340 return;
341 }
342 switch (cache_type) {
343 case (ProfileAction::RCT_TASK):
344 FdCacheHelper::Cache(controller_.GetTasksFilePath(path_), fd_[cache_type]);
345 break;
346 case (ProfileAction::RCT_PROCESS):
347 // uid and pid don't matter because IsAppDependentPath ensures the path doesn't use them
348 FdCacheHelper::Cache(controller_.GetProcsFilePath(path_, 0, 0), fd_[cache_type]);
349 break;
350 default:
351 LOG(ERROR) << "Invalid cache type is specified!";
352 break;
353 }
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800354}
355
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800356void SetCgroupAction::DropResourceCaching(ResourceCacheType cache_type) {
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800357 std::lock_guard<std::mutex> lock(fd_mutex_);
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800358 FdCacheHelper::Drop(fd_[cache_type]);
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800359}
360
Rick Yiu9221b1e2022-02-10 16:44:43 +0800361WriteFileAction::WriteFileAction(const std::string& task_path, const std::string& proc_path,
362 const std::string& value, bool logfailures)
363 : task_path_(task_path), proc_path_(proc_path), value_(value), logfailures_(logfailures) {
364 FdCacheHelper::Init(task_path_, fd_[ProfileAction::RCT_TASK]);
365 if (!proc_path_.empty()) FdCacheHelper::Init(proc_path_, fd_[ProfileAction::RCT_PROCESS]);
Rick Yiud4c53512021-11-21 15:57:36 +0800366}
Rick Yiubc1ad962020-10-26 20:32:52 +0800367
Rick Yiu9221b1e2022-02-10 16:44:43 +0800368bool WriteFileAction::WriteValueToFile(const std::string& value_, ResourceCacheType cache_type,
369 int uid, int pid, bool logfailures) const {
370 std::string value(value_);
371
372 value = StringReplace(value, "<uid>", std::to_string(uid), true);
373 value = StringReplace(value, "<pid>", std::to_string(pid), true);
374
375 CacheUseResult result = UseCachedFd(cache_type, value);
376
377 if (result != ProfileAction::UNUSED) {
378 return result == ProfileAction::SUCCESS;
379 }
380
381 std::string path;
382 if (cache_type == ProfileAction::RCT_TASK || proc_path_.empty()) {
383 path = task_path_;
384 } else {
385 path = proc_path_;
386 }
387
Rick Yiud4c53512021-11-21 15:57:36 +0800388 // Use WriteStringToFd instead of WriteStringToFile because the latter will open file with
389 // O_TRUNC which causes kernfs_mutex contention
390 unique_fd tmp_fd(TEMP_FAILURE_RETRY(open(path.c_str(), O_WRONLY | O_CLOEXEC)));
Rick Yiubc1ad962020-10-26 20:32:52 +0800391
Rick Yiud4c53512021-11-21 15:57:36 +0800392 if (tmp_fd < 0) {
393 if (logfailures) PLOG(WARNING) << "Failed to open " << path;
394 return false;
395 }
396
397 if (!WriteStringToFd(value, tmp_fd)) {
398 if (logfailures) PLOG(ERROR) << "Failed to write '" << value << "' to " << path;
Rick Yiubc1ad962020-10-26 20:32:52 +0800399 return false;
400 }
401
402 return true;
403}
404
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800405ProfileAction::CacheUseResult WriteFileAction::UseCachedFd(ResourceCacheType cache_type,
406 const std::string& value) const {
Rick Yiud4c53512021-11-21 15:57:36 +0800407 std::lock_guard<std::mutex> lock(fd_mutex_);
Rick Yiu9221b1e2022-02-10 16:44:43 +0800408 if (FdCacheHelper::IsCached(fd_[cache_type])) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800409 // fd is cached, reuse it
Rick Yiu9221b1e2022-02-10 16:44:43 +0800410 bool ret = WriteStringToFd(value, fd_[cache_type]);
411
412 if (!ret && logfailures_) {
413 if (cache_type == ProfileAction::RCT_TASK || proc_path_.empty()) {
414 PLOG(ERROR) << "Failed to write '" << value << "' to " << task_path_;
415 } else {
416 PLOG(ERROR) << "Failed to write '" << value << "' to " << proc_path_;
417 }
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800418 }
Rick Yiu9221b1e2022-02-10 16:44:43 +0800419 return ret ? ProfileAction::SUCCESS : ProfileAction::FAIL;
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800420 }
421
Rick Yiu9221b1e2022-02-10 16:44:43 +0800422 if (fd_[cache_type] == FdCacheHelper::FDS_INACCESSIBLE) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800423 // no permissions to access the file, ignore
424 return ProfileAction::SUCCESS;
425 }
426
Rick Yiu9221b1e2022-02-10 16:44:43 +0800427 if (cache_type == ResourceCacheType::RCT_TASK &&
428 fd_[cache_type] == FdCacheHelper::FDS_APP_DEPENDENT) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800429 // application-dependent path can't be used with tid
430 PLOG(ERROR) << "Application profile can't be applied to a thread";
431 return ProfileAction::FAIL;
432 }
433 return ProfileAction::UNUSED;
434}
435
436bool WriteFileAction::ExecuteForProcess(uid_t uid, pid_t pid) const {
Rick Yiu9221b1e2022-02-10 16:44:43 +0800437 if (!proc_path_.empty()) {
438 return WriteValueToFile(value_, ProfileAction::RCT_PROCESS, uid, pid, logfailures_);
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800439 }
440
Rick Yiu9221b1e2022-02-10 16:44:43 +0800441 DIR* d;
442 struct dirent* de;
443 char proc_path[255];
444 int t_pid;
Rick Yiud4c53512021-11-21 15:57:36 +0800445
Rick Yiu9221b1e2022-02-10 16:44:43 +0800446 sprintf(proc_path, "/proc/%d/task", pid);
447 if (!(d = opendir(proc_path))) {
448 return false;
449 }
450
451 while ((de = readdir(d))) {
452 if (de->d_name[0] == '.') {
453 continue;
454 }
455
456 t_pid = atoi(de->d_name);
457
458 if (!t_pid) {
459 continue;
460 }
461
462 WriteValueToFile(value_, ProfileAction::RCT_TASK, uid, t_pid, logfailures_);
463 }
464
465 closedir(d);
466
467 return true;
Rick Yiud4c53512021-11-21 15:57:36 +0800468}
469
Rick Yiubc1ad962020-10-26 20:32:52 +0800470bool WriteFileAction::ExecuteForTask(int tid) const {
Rick Yiu9221b1e2022-02-10 16:44:43 +0800471 return WriteValueToFile(value_, ProfileAction::RCT_TASK, getuid(), tid, logfailures_);
472}
Rick Yiubc1ad962020-10-26 20:32:52 +0800473
Rick Yiu9221b1e2022-02-10 16:44:43 +0800474void WriteFileAction::EnableResourceCaching(ResourceCacheType cache_type) {
475 std::lock_guard<std::mutex> lock(fd_mutex_);
476 if (fd_[cache_type] != FdCacheHelper::FDS_NOT_CACHED) {
477 return;
Rick Yiubc1ad962020-10-26 20:32:52 +0800478 }
Rick Yiu9221b1e2022-02-10 16:44:43 +0800479 switch (cache_type) {
480 case (ProfileAction::RCT_TASK):
481 FdCacheHelper::Cache(task_path_, fd_[cache_type]);
482 break;
483 case (ProfileAction::RCT_PROCESS):
484 if (!proc_path_.empty()) FdCacheHelper::Cache(proc_path_, fd_[cache_type]);
485 break;
486 default:
487 LOG(ERROR) << "Invalid cache type is specified!";
488 break;
489 }
Rick Yiubc1ad962020-10-26 20:32:52 +0800490}
491
Rick Yiu9221b1e2022-02-10 16:44:43 +0800492void WriteFileAction::DropResourceCaching(ResourceCacheType cache_type) {
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800493 std::lock_guard<std::mutex> lock(fd_mutex_);
Rick Yiu9221b1e2022-02-10 16:44:43 +0800494 FdCacheHelper::Drop(fd_[cache_type]);
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800495}
496
Rick Yiu0b211fa2019-09-16 19:07:17 +0800497bool ApplyProfileAction::ExecuteForProcess(uid_t uid, pid_t pid) const {
498 for (const auto& profile : profiles_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800499 profile->ExecuteForProcess(uid, pid);
Rick Yiu0b211fa2019-09-16 19:07:17 +0800500 }
501 return true;
502}
503
504bool ApplyProfileAction::ExecuteForTask(int tid) const {
505 for (const auto& profile : profiles_) {
Wei Wang8722e4d2021-05-14 12:34:54 -0700506 profile->ExecuteForTask(tid);
Rick Yiu0b211fa2019-09-16 19:07:17 +0800507 }
508 return true;
509}
510
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800511void ApplyProfileAction::EnableResourceCaching(ResourceCacheType cache_type) {
Suren Baghdasaryan911109c2020-02-13 17:28:00 -0800512 for (const auto& profile : profiles_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800513 profile->EnableResourceCaching(cache_type);
Suren Baghdasaryan911109c2020-02-13 17:28:00 -0800514 }
515}
516
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800517void ApplyProfileAction::DropResourceCaching(ResourceCacheType cache_type) {
Suren Baghdasaryan911109c2020-02-13 17:28:00 -0800518 for (const auto& profile : profiles_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800519 profile->DropResourceCaching(cache_type);
Suren Baghdasaryan911109c2020-02-13 17:28:00 -0800520 }
521}
522
Suren Baghdasaryan84385952020-01-24 16:36:10 -0800523void TaskProfile::MoveTo(TaskProfile* profile) {
524 profile->elements_ = std::move(elements_);
525 profile->res_cached_ = res_cached_;
526}
527
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800528bool TaskProfile::ExecuteForProcess(uid_t uid, pid_t pid) const {
529 for (const auto& element : elements_) {
530 if (!element->ExecuteForProcess(uid, pid)) {
Bart Van Asschef096bd22022-01-24 19:59:13 +0000531 LOG(VERBOSE) << "Applying profile action " << element->Name() << " failed";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800532 return false;
533 }
534 }
535 return true;
536}
537
538bool TaskProfile::ExecuteForTask(int tid) const {
539 if (tid == 0) {
540 tid = GetThreadId();
541 }
542 for (const auto& element : elements_) {
543 if (!element->ExecuteForTask(tid)) {
Bart Van Asschef096bd22022-01-24 19:59:13 +0000544 LOG(VERBOSE) << "Applying profile action " << element->Name() << " failed";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800545 return false;
546 }
547 }
548 return true;
549}
550
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800551void TaskProfile::EnableResourceCaching(ProfileAction::ResourceCacheType cache_type) {
Suren Baghdasaryan8a315d22019-02-14 14:40:41 -0800552 if (res_cached_) {
553 return;
554 }
555
556 for (auto& element : elements_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800557 element->EnableResourceCaching(cache_type);
Suren Baghdasaryan8a315d22019-02-14 14:40:41 -0800558 }
559
560 res_cached_ = true;
561}
562
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800563void TaskProfile::DropResourceCaching(ProfileAction::ResourceCacheType cache_type) {
Riddle Hsua6abd822019-06-18 15:53:53 -0600564 if (!res_cached_) {
565 return;
566 }
567
568 for (auto& element : elements_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800569 element->DropResourceCaching(cache_type);
Riddle Hsua6abd822019-06-18 15:53:53 -0600570 }
571
572 res_cached_ = false;
573}
574
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800575void TaskProfiles::DropResourceCaching(ProfileAction::ResourceCacheType cache_type) const {
Riddle Hsua6abd822019-06-18 15:53:53 -0600576 for (auto& iter : profiles_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800577 iter.second->DropResourceCaching(cache_type);
Riddle Hsua6abd822019-06-18 15:53:53 -0600578 }
579}
580
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800581TaskProfiles& TaskProfiles::GetInstance() {
Peter Collingbournedba6d442019-03-20 21:09:46 -0700582 // Deliberately leak this object to avoid a race between destruction on
583 // process exit and concurrent access from another thread.
584 static auto* instance = new TaskProfiles;
585 return *instance;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800586}
587
588TaskProfiles::TaskProfiles() {
Suren Baghdasaryan756a6042020-12-03 11:38:42 -0800589 // load system task profiles
590 if (!Load(CgroupMap::GetInstance(), TASK_PROFILE_DB_FILE)) {
591 LOG(ERROR) << "Loading " << TASK_PROFILE_DB_FILE << " for [" << getpid() << "] failed";
592 }
Suren Baghdasaryan35221b52020-11-20 17:08:51 -0800593
594 // load API-level specific system task profiles if available
Suren Baghdasaryan756a6042020-12-03 11:38:42 -0800595 unsigned int api_level = GetUintProperty<unsigned int>("ro.product.first_api_level", 0);
Suren Baghdasaryan35221b52020-11-20 17:08:51 -0800596 if (api_level > 0) {
597 std::string api_profiles_path =
598 android::base::StringPrintf(TEMPLATE_TASK_PROFILE_API_FILE, api_level);
599 if (!access(api_profiles_path.c_str(), F_OK) || errno != ENOENT) {
Suren Baghdasaryan756a6042020-12-03 11:38:42 -0800600 if (!Load(CgroupMap::GetInstance(), api_profiles_path)) {
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800601 LOG(ERROR) << "Loading " << api_profiles_path << " for [" << getpid() << "] failed";
Suren Baghdasaryan756a6042020-12-03 11:38:42 -0800602 }
Suren Baghdasaryan35221b52020-11-20 17:08:51 -0800603 }
604 }
605
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800606 // load vendor task profiles if the file exists
607 if (!access(TASK_PROFILE_DB_VENDOR_FILE, F_OK) &&
608 !Load(CgroupMap::GetInstance(), TASK_PROFILE_DB_VENDOR_FILE)) {
609 LOG(ERROR) << "Loading " << TASK_PROFILE_DB_VENDOR_FILE << " for [" << getpid()
610 << "] failed";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800611 }
612}
613
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800614bool TaskProfiles::Load(const CgroupMap& cg_map, const std::string& file_name) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800615 std::string json_doc;
616
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800617 if (!android::base::ReadFileToString(file_name, &json_doc)) {
618 LOG(ERROR) << "Failed to read task profiles from " << file_name;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800619 return false;
620 }
621
Haibo Huangd9ac92a2021-02-24 17:34:50 -0800622 Json::CharReaderBuilder builder;
623 std::unique_ptr<Json::CharReader> reader(builder.newCharReader());
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800624 Json::Value root;
Haibo Huangd9ac92a2021-02-24 17:34:50 -0800625 std::string errorMessage;
626 if (!reader->parse(&*json_doc.begin(), &*json_doc.end(), &root, &errorMessage)) {
627 LOG(ERROR) << "Failed to parse task profiles: " << errorMessage;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800628 return false;
629 }
630
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800631 const Json::Value& attr = root["Attributes"];
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800632 for (Json::Value::ArrayIndex i = 0; i < attr.size(); ++i) {
633 std::string name = attr[i]["Name"].asString();
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800634 std::string controller_name = attr[i]["Controller"].asString();
635 std::string file_attr = attr[i]["File"].asString();
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800636
Suren Baghdasaryan81b9f0b2020-07-01 12:34:17 -0700637 auto controller = cg_map.FindController(controller_name);
638 if (controller.HasValue()) {
639 auto iter = attributes_.find(name);
640 if (iter == attributes_.end()) {
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800641 attributes_[name] = std::make_unique<ProfileAttribute>(controller, file_attr);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800642 } else {
Suren Baghdasaryan81b9f0b2020-07-01 12:34:17 -0700643 iter->second->Reset(controller, file_attr);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800644 }
645 } else {
Suren Baghdasaryan81b9f0b2020-07-01 12:34:17 -0700646 LOG(WARNING) << "Controller " << controller_name << " is not found";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800647 }
648 }
649
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800650 const Json::Value& profiles_val = root["Profiles"];
651 for (Json::Value::ArrayIndex i = 0; i < profiles_val.size(); ++i) {
652 const Json::Value& profile_val = profiles_val[i];
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800653
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800654 std::string profile_name = profile_val["Name"].asString();
655 const Json::Value& actions = profile_val["Actions"];
Bart Van Asschef096bd22022-01-24 19:59:13 +0000656 auto profile = std::make_shared<TaskProfile>(profile_name);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800657
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800658 for (Json::Value::ArrayIndex act_idx = 0; act_idx < actions.size(); ++act_idx) {
659 const Json::Value& action_val = actions[act_idx];
660 std::string action_name = action_val["Name"].asString();
661 const Json::Value& params_val = action_val["Params"];
662 if (action_name == "JoinCgroup") {
663 std::string controller_name = params_val["Controller"].asString();
664 std::string path = params_val["Path"].asString();
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800665
Yifan Hong53e0deb2019-03-22 17:01:08 -0700666 auto controller = cg_map.FindController(controller_name);
667 if (controller.HasValue()) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800668 profile->Add(std::make_unique<SetCgroupAction>(controller, path));
669 } else {
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800670 LOG(WARNING) << "JoinCgroup: controller " << controller_name << " is not found";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800671 }
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800672 } else if (action_name == "SetTimerSlack") {
673 std::string slack_value = params_val["Slack"].asString();
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800674 char* end;
675 unsigned long slack;
676
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800677 slack = strtoul(slack_value.c_str(), &end, 10);
678 if (end > slack_value.c_str()) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800679 profile->Add(std::make_unique<SetTimerSlackAction>(slack));
680 } else {
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800681 LOG(WARNING) << "SetTimerSlack: invalid parameter: " << slack_value;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800682 }
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800683 } else if (action_name == "SetAttribute") {
684 std::string attr_name = params_val["Name"].asString();
685 std::string attr_value = params_val["Value"].asString();
Bart Van Assche59af6802022-01-24 21:08:57 +0000686 bool optional = strcmp(params_val["Optional"].asString().c_str(), "true") == 0;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800687
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800688 auto iter = attributes_.find(attr_name);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800689 if (iter != attributes_.end()) {
Bart Van Assche59af6802022-01-24 21:08:57 +0000690 profile->Add(std::make_unique<SetAttributeAction>(iter->second.get(),
691 attr_value, optional));
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800692 } else {
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800693 LOG(WARNING) << "SetAttribute: unknown attribute: " << attr_name;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800694 }
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800695 } else if (action_name == "SetClamps") {
696 std::string boost_value = params_val["Boost"].asString();
697 std::string clamp_value = params_val["Clamp"].asString();
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800698 char* end;
699 unsigned long boost;
700
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800701 boost = strtoul(boost_value.c_str(), &end, 10);
702 if (end > boost_value.c_str()) {
703 unsigned long clamp = strtoul(clamp_value.c_str(), &end, 10);
704 if (end > clamp_value.c_str()) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800705 profile->Add(std::make_unique<SetClampsAction>(boost, clamp));
706 } else {
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800707 LOG(WARNING) << "SetClamps: invalid parameter " << clamp_value;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800708 }
709 } else {
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800710 LOG(WARNING) << "SetClamps: invalid parameter: " << boost_value;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800711 }
Rick Yiubc1ad962020-10-26 20:32:52 +0800712 } else if (action_name == "WriteFile") {
713 std::string attr_filepath = params_val["FilePath"].asString();
Rick Yiu9221b1e2022-02-10 16:44:43 +0800714 std::string attr_procfilepath = params_val["ProcFilePath"].asString();
Rick Yiubc1ad962020-10-26 20:32:52 +0800715 std::string attr_value = params_val["Value"].asString();
Rick Yiu9221b1e2022-02-10 16:44:43 +0800716 // FilePath and Value are mandatory
Rick Yiubc1ad962020-10-26 20:32:52 +0800717 if (!attr_filepath.empty() && !attr_value.empty()) {
Rick Yiu49fce952021-04-08 22:10:06 +0800718 std::string attr_logfailures = params_val["LogFailures"].asString();
719 bool logfailures = attr_logfailures.empty() || attr_logfailures == "true";
Rick Yiu9221b1e2022-02-10 16:44:43 +0800720 profile->Add(std::make_unique<WriteFileAction>(attr_filepath, attr_procfilepath,
721 attr_value, logfailures));
Rick Yiubc1ad962020-10-26 20:32:52 +0800722 } else if (attr_filepath.empty()) {
723 LOG(WARNING) << "WriteFile: invalid parameter: "
724 << "empty filepath";
725 } else if (attr_value.empty()) {
726 LOG(WARNING) << "WriteFile: invalid parameter: "
727 << "empty value";
728 }
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800729 } else {
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800730 LOG(WARNING) << "Unknown profile action: " << action_name;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800731 }
732 }
Suren Baghdasaryan84385952020-01-24 16:36:10 -0800733 auto iter = profiles_.find(profile_name);
734 if (iter == profiles_.end()) {
735 profiles_[profile_name] = profile;
736 } else {
737 // Move the content rather that replace the profile because old profile might be
738 // referenced from an aggregate profile if vendor overrides task profiles
739 profile->MoveTo(iter->second.get());
740 profile.reset();
741 }
Rick Yiu0b211fa2019-09-16 19:07:17 +0800742 }
743
744 const Json::Value& aggregateprofiles_val = root["AggregateProfiles"];
745 for (Json::Value::ArrayIndex i = 0; i < aggregateprofiles_val.size(); ++i) {
746 const Json::Value& aggregateprofile_val = aggregateprofiles_val[i];
747
748 std::string aggregateprofile_name = aggregateprofile_val["Name"].asString();
749 const Json::Value& aggregateprofiles = aggregateprofile_val["Profiles"];
750 std::vector<std::shared_ptr<TaskProfile>> profiles;
751 bool ret = true;
752
753 for (Json::Value::ArrayIndex pf_idx = 0; pf_idx < aggregateprofiles.size(); ++pf_idx) {
754 std::string profile_name = aggregateprofiles[pf_idx].asString();
755
756 if (profile_name == aggregateprofile_name) {
757 LOG(WARNING) << "AggregateProfiles: recursive profile name: " << profile_name;
758 ret = false;
759 break;
760 } else if (profiles_.find(profile_name) == profiles_.end()) {
761 LOG(WARNING) << "AggregateProfiles: undefined profile name: " << profile_name;
762 ret = false;
763 break;
764 } else {
765 profiles.push_back(profiles_[profile_name]);
766 }
767 }
768 if (ret) {
Bart Van Asschef096bd22022-01-24 19:59:13 +0000769 auto profile = std::make_shared<TaskProfile>(aggregateprofile_name);
Rick Yiu0b211fa2019-09-16 19:07:17 +0800770 profile->Add(std::make_unique<ApplyProfileAction>(profiles));
771 profiles_[aggregateprofile_name] = profile;
772 }
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800773 }
774
775 return true;
776}
777
Suren Baghdasaryan8a315d22019-02-14 14:40:41 -0800778TaskProfile* TaskProfiles::GetProfile(const std::string& name) const {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800779 auto iter = profiles_.find(name);
780
781 if (iter != profiles_.end()) {
782 return iter->second.get();
783 }
784 return nullptr;
785}
786
Bart Van Assche4c99e962022-02-03 19:50:16 +0000787const IProfileAttribute* TaskProfiles::GetAttribute(const std::string& name) const {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800788 auto iter = attributes_.find(name);
789
790 if (iter != attributes_.end()) {
791 return iter->second.get();
792 }
793 return nullptr;
794}
Rick Yiu0b211fa2019-09-16 19:07:17 +0800795
796bool TaskProfiles::SetProcessProfiles(uid_t uid, pid_t pid,
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800797 const std::vector<std::string>& profiles, bool use_fd_cache) {
Rick Yiu0b211fa2019-09-16 19:07:17 +0800798 for (const auto& name : profiles) {
799 TaskProfile* profile = GetProfile(name);
800 if (profile != nullptr) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800801 if (use_fd_cache) {
802 profile->EnableResourceCaching(ProfileAction::RCT_PROCESS);
803 }
Rick Yiu0b211fa2019-09-16 19:07:17 +0800804 if (!profile->ExecuteForProcess(uid, pid)) {
805 PLOG(WARNING) << "Failed to apply " << name << " process profile";
806 }
807 } else {
808 PLOG(WARNING) << "Failed to find " << name << "process profile";
809 }
810 }
811 return true;
812}
813
814bool TaskProfiles::SetTaskProfiles(int tid, const std::vector<std::string>& profiles,
815 bool use_fd_cache) {
816 for (const auto& name : profiles) {
817 TaskProfile* profile = GetProfile(name);
818 if (profile != nullptr) {
819 if (use_fd_cache) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800820 profile->EnableResourceCaching(ProfileAction::RCT_TASK);
Rick Yiu0b211fa2019-09-16 19:07:17 +0800821 }
822 if (!profile->ExecuteForTask(tid)) {
823 PLOG(WARNING) << "Failed to apply " << name << " task profile";
824 }
825 } else {
826 PLOG(WARNING) << "Failed to find " << name << "task profile";
827 }
828 }
829 return true;
830}