blob: bdee9ae75231bf2f97b2e57614fadd1fda8f4ac1 [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
T.J. Mercier54bfde02024-06-04 23:25:29 +000020#include <dirent.h>
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -080021#include <fcntl.h>
T.J. Mercier54bfde02024-06-04 23:25:29 +000022#include <unistd.h>
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -080023#include <task_profiles.h>
24#include <string>
25
26#include <android-base/file.h>
27#include <android-base/logging.h>
Suren Baghdasaryan35221b52020-11-20 17:08:51 -080028#include <android-base/properties.h>
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -080029#include <android-base/stringprintf.h>
Rick Yiubc1ad962020-10-26 20:32:52 +080030#include <android-base/strings.h>
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -080031#include <android-base/threads.h>
32
33#include <cutils/android_filesystem_config.h>
34
35#include <json/reader.h>
36#include <json/value.h>
37
T.J. Mercier1cfa2c42024-04-08 21:14:32 +000038#include <build_flags.h>
39
Suren Baghdasaryaneca87cb2019-02-02 14:19:41 -080040// To avoid issues in sdk_mac build
41#if defined(__ANDROID__)
42#include <sys/prctl.h>
43#endif
44
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -080045using android::base::GetThreadId;
Suren Baghdasaryan35221b52020-11-20 17:08:51 -080046using android::base::GetUintProperty;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -080047using android::base::StringPrintf;
Rick Yiubc1ad962020-10-26 20:32:52 +080048using android::base::StringReplace;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -080049using android::base::unique_fd;
50using android::base::WriteStringToFile;
51
Suren Baghdasaryan35221b52020-11-20 17:08:51 -080052static constexpr const char* TASK_PROFILE_DB_FILE = "/etc/task_profiles.json";
53static constexpr const char* TASK_PROFILE_DB_VENDOR_FILE = "/vendor/etc/task_profiles.json";
54
55static constexpr const char* TEMPLATE_TASK_PROFILE_API_FILE =
56 "/etc/task_profiles/task_profiles_%u.json";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -080057
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -080058class FdCacheHelper {
59 public:
60 enum FdState {
61 FDS_INACCESSIBLE = -1,
62 FDS_APP_DEPENDENT = -2,
63 FDS_NOT_CACHED = -3,
64 };
65
66 static void Cache(const std::string& path, android::base::unique_fd& fd);
67 static void Drop(android::base::unique_fd& fd);
68 static void Init(const std::string& path, android::base::unique_fd& fd);
69 static bool IsCached(const android::base::unique_fd& fd) { return fd > FDS_INACCESSIBLE; }
70
71 private:
72 static bool IsAppDependentPath(const std::string& path);
73};
74
75void FdCacheHelper::Init(const std::string& path, android::base::unique_fd& fd) {
76 // file descriptors for app-dependent paths can't be cached
77 if (IsAppDependentPath(path)) {
78 // file descriptor is not cached
79 fd.reset(FDS_APP_DEPENDENT);
80 return;
81 }
82 // file descriptor can be cached later on request
83 fd.reset(FDS_NOT_CACHED);
84}
85
86void FdCacheHelper::Cache(const std::string& path, android::base::unique_fd& fd) {
87 if (fd != FDS_NOT_CACHED) {
88 return;
89 }
90
91 if (access(path.c_str(), W_OK) != 0) {
92 // file is not accessible
93 fd.reset(FDS_INACCESSIBLE);
94 return;
95 }
96
97 unique_fd tmp_fd(TEMP_FAILURE_RETRY(open(path.c_str(), O_WRONLY | O_CLOEXEC)));
98 if (tmp_fd < 0) {
99 PLOG(ERROR) << "Failed to cache fd '" << path << "'";
100 fd.reset(FDS_INACCESSIBLE);
101 return;
102 }
103
104 fd = std::move(tmp_fd);
105}
106
107void FdCacheHelper::Drop(android::base::unique_fd& fd) {
108 if (fd == FDS_NOT_CACHED) {
109 return;
110 }
111
112 fd.reset(FDS_NOT_CACHED);
113}
114
115bool FdCacheHelper::IsAppDependentPath(const std::string& path) {
116 return path.find("<uid>", 0) != std::string::npos || path.find("<pid>", 0) != std::string::npos;
117}
118
Bart Van Assche4c99e962022-02-03 19:50:16 +0000119IProfileAttribute::~IProfileAttribute() = default;
120
Suren Baghdasaryan35078462023-07-25 14:50:18 -0700121const std::string& ProfileAttribute::file_name() const {
122 if (controller()->version() == 2 && !file_v2_name_.empty()) return file_v2_name_;
123 return file_name_;
124}
125
T.J. Mercierfcb86662024-08-01 20:52:30 +0000126void ProfileAttribute::Reset(const CgroupControllerWrapper& controller,
127 const std::string& file_name, const std::string& file_v2_name) {
Suren Baghdasaryan81b9f0b2020-07-01 12:34:17 -0700128 controller_ = controller;
129 file_name_ = file_name;
Suren Baghdasaryan35078462023-07-25 14:50:18 -0700130 file_v2_name_ = file_v2_name;
Suren Baghdasaryan81b9f0b2020-07-01 12:34:17 -0700131}
132
T.J. Mercier1cfa2c42024-04-08 21:14:32 +0000133static bool isSystemApp(uid_t uid) {
134 return uid < AID_APP_START;
135}
136
T.J. Mercierd1e048f2024-03-28 00:33:44 +0000137std::string ConvertUidToPath(const char* root_cgroup_path, uid_t uid) {
T.J. Mercier1cfa2c42024-04-08 21:14:32 +0000138 if (android::libprocessgroup_flags::cgroup_v2_sys_app_isolation()) {
139 if (isSystemApp(uid))
140 return StringPrintf("%s/system/uid_%u", root_cgroup_path, uid);
141 else
142 return StringPrintf("%s/apps/uid_%u", root_cgroup_path, uid);
143 }
T.J. Mercierd1e048f2024-03-28 00:33:44 +0000144 return StringPrintf("%s/uid_%u", root_cgroup_path, uid);
145}
146
147std::string ConvertUidPidToPath(const char* root_cgroup_path, uid_t uid, pid_t pid) {
148 const std::string uid_path = ConvertUidToPath(root_cgroup_path, uid);
149 return StringPrintf("%s/pid_%d", uid_path.c_str(), pid);
150}
151
Suren Baghdasaryan34837982023-07-25 15:45:45 -0700152bool ProfileAttribute::GetPathForProcess(uid_t uid, pid_t pid, std::string* path) const {
153 if (controller()->version() == 2) {
T.J. Mercierd1e048f2024-03-28 00:33:44 +0000154 const std::string cgroup_path = ConvertUidPidToPath(controller()->path(), uid, pid);
155 *path = cgroup_path + "/" + file_name();
Suren Baghdasaryan34837982023-07-25 15:45:45 -0700156 return true;
157 }
158 return GetPathForTask(pid, path);
159}
160
T.J. Mercier1c007992024-01-25 16:29:54 +0000161bool ProfileAttribute::GetPathForTask(pid_t tid, std::string* path) const {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800162 std::string subgroup;
Yifan Hong53e0deb2019-03-22 17:01:08 -0700163 if (!controller()->GetTaskGroup(tid, &subgroup)) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800164 return false;
165 }
166
167 if (path == nullptr) {
168 return true;
169 }
170
171 if (subgroup.empty()) {
Suren Baghdasaryan35078462023-07-25 14:50:18 -0700172 *path = StringPrintf("%s/%s", controller()->path(), file_name().c_str());
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800173 } else {
Suren Baghdasaryan35078462023-07-25 14:50:18 -0700174 *path = StringPrintf("%s/%s/%s", controller()->path(), subgroup.c_str(),
175 file_name().c_str());
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800176 }
177 return true;
178}
179
T.J. Mercierd1e048f2024-03-28 00:33:44 +0000180// NOTE: This function is for cgroup v2 only
T.J. Mercier5ed5e1b2022-08-22 21:25:09 +0000181bool ProfileAttribute::GetPathForUID(uid_t uid, std::string* path) const {
182 if (path == nullptr) {
183 return true;
184 }
185
T.J. Mercierd1e048f2024-03-28 00:33:44 +0000186 const std::string cgroup_path = ConvertUidToPath(controller()->path(), uid);
187 *path = cgroup_path + "/" + file_name();
T.J. Mercier5ed5e1b2022-08-22 21:25:09 +0000188 return true;
189}
190
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800191bool SetClampsAction::ExecuteForProcess(uid_t, pid_t) const {
192 // TODO: add support when kernel supports util_clamp
193 LOG(WARNING) << "SetClampsAction::ExecuteForProcess is not supported";
194 return false;
195}
196
197bool SetClampsAction::ExecuteForTask(int) const {
198 // TODO: add support when kernel supports util_clamp
199 LOG(WARNING) << "SetClampsAction::ExecuteForTask is not supported";
200 return false;
201}
202
Suren Baghdasaryaneca87cb2019-02-02 14:19:41 -0800203// To avoid issues in sdk_mac build
204#if defined(__ANDROID__)
205
T.J. Mercier1c007992024-01-25 16:29:54 +0000206bool SetTimerSlackAction::ExecuteForTask(pid_t tid) const {
T.J. Mercier07500812024-10-09 17:41:32 +0000207 const auto file = StringPrintf("/proc/%d/timerslack_ns", tid);
208 if (!WriteStringToFile(std::to_string(slack_), file)) {
209 if (errno == ENOENT) {
210 // This happens when process is already dead
211 return true;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800212 }
T.J. Mercier07500812024-10-09 17:41:32 +0000213 PLOG(ERROR) << "set_timerslack_ns write failed";
214 return false;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800215 }
216
217 return true;
218}
219
Bart Van Assche20d59bd2022-01-24 19:45:59 +0000220#else
221
222bool SetTimerSlackAction::ExecuteForTask(int) const {
223 return true;
224};
225
Suren Baghdasaryaneca87cb2019-02-02 14:19:41 -0800226#endif
227
Suren Baghdasaryan34837982023-07-25 15:45:45 -0700228bool SetAttributeAction::WriteValueToFile(const std::string& path) const {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800229 if (!WriteStringToFile(value_, path)) {
Bart Van Assche9b5a2322022-03-22 16:15:00 -0700230 if (access(path.c_str(), F_OK) < 0) {
Bart Van Assche59af6802022-01-24 21:08:57 +0000231 if (optional_) {
232 return true;
233 } else {
234 LOG(ERROR) << "No such cgroup attribute: " << path;
235 return false;
236 }
237 }
Bart Van Assche54136f82022-03-31 11:26:42 -0700238 // The PLOG() statement below uses the error code stored in `errno` by
239 // WriteStringToFile() because access() only overwrites `errno` if it fails
240 // and because this code is only reached if the access() function returns 0.
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800241 PLOG(ERROR) << "Failed to write '" << value_ << "' to " << path;
242 return false;
243 }
244
245 return true;
246}
247
Suren Baghdasaryan34837982023-07-25 15:45:45 -0700248bool SetAttributeAction::ExecuteForProcess(uid_t uid, pid_t pid) const {
249 std::string path;
250
251 if (!attribute_->GetPathForProcess(uid, pid, &path)) {
252 LOG(ERROR) << "Failed to find cgroup for uid " << uid << " pid " << pid;
253 return false;
254 }
255
256 return WriteValueToFile(path);
257}
258
T.J. Mercier1c007992024-01-25 16:29:54 +0000259bool SetAttributeAction::ExecuteForTask(pid_t tid) const {
Suren Baghdasaryan34837982023-07-25 15:45:45 -0700260 std::string path;
261
262 if (!attribute_->GetPathForTask(tid, &path)) {
263 LOG(ERROR) << "Failed to find cgroup for tid " << tid;
264 return false;
265 }
266
267 return WriteValueToFile(path);
268}
269
T.J. Mercier5ed5e1b2022-08-22 21:25:09 +0000270bool SetAttributeAction::ExecuteForUID(uid_t uid) const {
271 std::string path;
272
273 if (!attribute_->GetPathForUID(uid, &path)) {
274 LOG(ERROR) << "Failed to find cgroup for uid " << uid;
275 return false;
276 }
277
278 if (!WriteStringToFile(value_, path)) {
279 if (access(path.c_str(), F_OK) < 0) {
280 if (optional_) {
281 return true;
282 } else {
283 LOG(ERROR) << "No such cgroup attribute: " << path;
284 return false;
285 }
286 }
287 PLOG(ERROR) << "Failed to write '" << value_ << "' to " << path;
288 return false;
289 }
290 return true;
291}
292
Suren Baghdasaryan8cacb612023-04-12 01:24:23 +0000293bool SetAttributeAction::IsValidForProcess(uid_t, pid_t pid) const {
294 return IsValidForTask(pid);
295}
296
T.J. Mercier1c007992024-01-25 16:29:54 +0000297bool SetAttributeAction::IsValidForTask(pid_t tid) const {
Suren Baghdasaryan8cacb612023-04-12 01:24:23 +0000298 std::string path;
299
300 if (!attribute_->GetPathForTask(tid, &path)) {
301 return false;
302 }
303
304 if (!access(path.c_str(), W_OK)) {
305 // operation will succeed
306 return true;
307 }
308
309 if (!access(path.c_str(), F_OK)) {
310 // file exists but not writable
311 return false;
312 }
313
314 // file does not exist, ignore if optional
315 return optional_;
316}
317
T.J. Mercierfcb86662024-08-01 20:52:30 +0000318SetCgroupAction::SetCgroupAction(const CgroupControllerWrapper& c, const std::string& p)
Rick Yiud4c53512021-11-21 15:57:36 +0800319 : controller_(c), path_(p) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800320 FdCacheHelper::Init(controller_.GetTasksFilePath(path_), fd_[ProfileAction::RCT_TASK]);
321 // uid and pid don't matter because IsAppDependentPath ensures the path doesn't use them
322 FdCacheHelper::Init(controller_.GetProcsFilePath(path_, 0, 0), fd_[ProfileAction::RCT_PROCESS]);
Rick Yiud4c53512021-11-21 15:57:36 +0800323}
324
T.J. Mercier1c007992024-01-25 16:29:54 +0000325bool SetCgroupAction::AddTidToCgroup(pid_t tid, int fd, ResourceCacheType cache_type) const {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800326 if (tid <= 0) {
327 return true;
328 }
329
330 std::string value = std::to_string(tid);
331
Suren Baghdasaryanec885562021-09-02 19:47:12 -0700332 if (TEMP_FAILURE_RETRY(write(fd, value.c_str(), value.length())) == value.length()) {
333 return true;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800334 }
335
Suren Baghdasaryanec885562021-09-02 19:47:12 -0700336 // If the thread is in the process of exiting, don't flag an error
337 if (errno == ESRCH) {
338 return true;
339 }
340
Bart Van Asschedf985342023-11-13 15:19:43 -0800341 const char* controller_name = controller()->name();
Suren Baghdasaryanec885562021-09-02 19:47:12 -0700342 // ENOSPC is returned when cpuset cgroup that we are joining has no online cpus
343 if (errno == ENOSPC && !strcmp(controller_name, "cpuset")) {
344 // This is an abnormal case happening only in testing, so report it only once
345 static bool empty_cpuset_reported = false;
346
347 if (empty_cpuset_reported) {
348 return true;
349 }
350
351 LOG(ERROR) << "Failed to add task '" << value
352 << "' into cpuset because all cpus in that cpuset are offline";
353 empty_cpuset_reported = true;
354 } else {
Bart Van Asschedf985342023-11-13 15:19:43 -0800355 PLOG(ERROR) << "AddTidToCgroup failed to write '" << value << "'; path=" << path_ << "; "
356 << (cache_type == RCT_TASK ? "task" : "process");
Suren Baghdasaryanec885562021-09-02 19:47:12 -0700357 }
358
359 return false;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800360}
361
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800362ProfileAction::CacheUseResult SetCgroupAction::UseCachedFd(ResourceCacheType cache_type,
363 int id) const {
364 std::lock_guard<std::mutex> lock(fd_mutex_);
365 if (FdCacheHelper::IsCached(fd_[cache_type])) {
366 // fd is cached, reuse it
Bart Van Asschedf985342023-11-13 15:19:43 -0800367 if (!AddTidToCgroup(id, fd_[cache_type], cache_type)) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800368 LOG(ERROR) << "Failed to add task into cgroup";
369 return ProfileAction::FAIL;
370 }
371 return ProfileAction::SUCCESS;
372 }
373
374 if (fd_[cache_type] == FdCacheHelper::FDS_INACCESSIBLE) {
375 // no permissions to access the file, ignore
376 return ProfileAction::SUCCESS;
377 }
378
379 if (cache_type == ResourceCacheType::RCT_TASK &&
380 fd_[cache_type] == FdCacheHelper::FDS_APP_DEPENDENT) {
381 // application-dependent path can't be used with tid
Bart Van Assche7a952612022-10-12 13:27:28 -0700382 LOG(ERROR) << Name() << ": application profile can't be applied to a thread";
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800383 return ProfileAction::FAIL;
384 }
385
386 return ProfileAction::UNUSED;
387}
388
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800389bool SetCgroupAction::ExecuteForProcess(uid_t uid, pid_t pid) const {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800390 CacheUseResult result = UseCachedFd(ProfileAction::RCT_PROCESS, pid);
391 if (result != ProfileAction::UNUSED) {
392 return result == ProfileAction::SUCCESS;
393 }
394
395 // fd was not cached or cached fd can't be used
Yifan Hong53e0deb2019-03-22 17:01:08 -0700396 std::string procs_path = controller()->GetProcsFilePath(path_, uid, pid);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800397 unique_fd tmp_fd(TEMP_FAILURE_RETRY(open(procs_path.c_str(), O_WRONLY | O_CLOEXEC)));
398 if (tmp_fd < 0) {
Bart Van Assche7a952612022-10-12 13:27:28 -0700399 PLOG(WARNING) << Name() << "::" << __func__ << ": failed to open " << procs_path;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800400 return false;
401 }
Bart Van Asschedf985342023-11-13 15:19:43 -0800402 if (!AddTidToCgroup(pid, tmp_fd, RCT_PROCESS)) {
Wei Wangd71d3012019-03-07 11:59:12 -0800403 LOG(ERROR) << "Failed to add task into cgroup";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800404 return false;
405 }
406
407 return true;
408}
409
T.J. Mercier1c007992024-01-25 16:29:54 +0000410bool SetCgroupAction::ExecuteForTask(pid_t tid) const {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800411 CacheUseResult result = UseCachedFd(ProfileAction::RCT_TASK, tid);
412 if (result != ProfileAction::UNUSED) {
413 return result == ProfileAction::SUCCESS;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800414 }
415
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800416 // fd was not cached or cached fd can't be used
Yifan Hong53e0deb2019-03-22 17:01:08 -0700417 std::string tasks_path = controller()->GetTasksFilePath(path_);
Suren Baghdasaryanbee9f572019-02-05 16:44:22 -0800418 unique_fd tmp_fd(TEMP_FAILURE_RETRY(open(tasks_path.c_str(), O_WRONLY | O_CLOEXEC)));
419 if (tmp_fd < 0) {
Bart Van Assche7a952612022-10-12 13:27:28 -0700420 PLOG(WARNING) << Name() << "::" << __func__ << ": failed to open " << tasks_path;
Suren Baghdasaryan8a315d22019-02-14 14:40:41 -0800421 return false;
Suren Baghdasaryanbee9f572019-02-05 16:44:22 -0800422 }
Bart Van Asschedf985342023-11-13 15:19:43 -0800423 if (!AddTidToCgroup(tid, tmp_fd, RCT_TASK)) {
Wei Wangd71d3012019-03-07 11:59:12 -0800424 LOG(ERROR) << "Failed to add task into cgroup";
Suren Baghdasaryanbee9f572019-02-05 16:44:22 -0800425 return false;
426 }
427
428 return true;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800429}
430
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800431void SetCgroupAction::EnableResourceCaching(ResourceCacheType cache_type) {
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800432 std::lock_guard<std::mutex> lock(fd_mutex_);
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800433 // Return early to prevent unnecessary calls to controller_.Get{Tasks|Procs}FilePath() which
434 // include regex evaluations
435 if (fd_[cache_type] != FdCacheHelper::FDS_NOT_CACHED) {
436 return;
437 }
438 switch (cache_type) {
439 case (ProfileAction::RCT_TASK):
440 FdCacheHelper::Cache(controller_.GetTasksFilePath(path_), fd_[cache_type]);
441 break;
442 case (ProfileAction::RCT_PROCESS):
443 // uid and pid don't matter because IsAppDependentPath ensures the path doesn't use them
444 FdCacheHelper::Cache(controller_.GetProcsFilePath(path_, 0, 0), fd_[cache_type]);
445 break;
446 default:
447 LOG(ERROR) << "Invalid cache type is specified!";
448 break;
449 }
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800450}
451
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800452void SetCgroupAction::DropResourceCaching(ResourceCacheType cache_type) {
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800453 std::lock_guard<std::mutex> lock(fd_mutex_);
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800454 FdCacheHelper::Drop(fd_[cache_type]);
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800455}
456
Suren Baghdasaryan8cacb612023-04-12 01:24:23 +0000457bool SetCgroupAction::IsValidForProcess(uid_t uid, pid_t pid) const {
458 std::lock_guard<std::mutex> lock(fd_mutex_);
459 if (FdCacheHelper::IsCached(fd_[ProfileAction::RCT_PROCESS])) {
460 return true;
461 }
462
463 if (fd_[ProfileAction::RCT_PROCESS] == FdCacheHelper::FDS_INACCESSIBLE) {
464 return false;
465 }
466
467 std::string procs_path = controller()->GetProcsFilePath(path_, uid, pid);
468 return access(procs_path.c_str(), W_OK) == 0;
469}
470
471bool SetCgroupAction::IsValidForTask(int) const {
472 std::lock_guard<std::mutex> lock(fd_mutex_);
473 if (FdCacheHelper::IsCached(fd_[ProfileAction::RCT_TASK])) {
474 return true;
475 }
476
477 if (fd_[ProfileAction::RCT_TASK] == FdCacheHelper::FDS_INACCESSIBLE) {
478 return false;
479 }
480
481 if (fd_[ProfileAction::RCT_TASK] == FdCacheHelper::FDS_APP_DEPENDENT) {
482 // application-dependent path can't be used with tid
483 return false;
484 }
485
486 std::string tasks_path = controller()->GetTasksFilePath(path_);
487 return access(tasks_path.c_str(), W_OK) == 0;
488}
489
Rick Yiu9221b1e2022-02-10 16:44:43 +0800490WriteFileAction::WriteFileAction(const std::string& task_path, const std::string& proc_path,
491 const std::string& value, bool logfailures)
492 : task_path_(task_path), proc_path_(proc_path), value_(value), logfailures_(logfailures) {
493 FdCacheHelper::Init(task_path_, fd_[ProfileAction::RCT_TASK]);
494 if (!proc_path_.empty()) FdCacheHelper::Init(proc_path_, fd_[ProfileAction::RCT_PROCESS]);
Rick Yiud4c53512021-11-21 15:57:36 +0800495}
Rick Yiubc1ad962020-10-26 20:32:52 +0800496
Rick Yiu9221b1e2022-02-10 16:44:43 +0800497bool WriteFileAction::WriteValueToFile(const std::string& value_, ResourceCacheType cache_type,
T.J. Mercierd6fb2252024-01-24 23:42:39 +0000498 uid_t uid, pid_t pid, bool logfailures) const {
Rick Yiu9221b1e2022-02-10 16:44:43 +0800499 std::string value(value_);
500
501 value = StringReplace(value, "<uid>", std::to_string(uid), true);
502 value = StringReplace(value, "<pid>", std::to_string(pid), true);
503
504 CacheUseResult result = UseCachedFd(cache_type, value);
505
506 if (result != ProfileAction::UNUSED) {
507 return result == ProfileAction::SUCCESS;
508 }
509
510 std::string path;
511 if (cache_type == ProfileAction::RCT_TASK || proc_path_.empty()) {
512 path = task_path_;
513 } else {
514 path = proc_path_;
515 }
516
Rick Yiud4c53512021-11-21 15:57:36 +0800517 // Use WriteStringToFd instead of WriteStringToFile because the latter will open file with
518 // O_TRUNC which causes kernfs_mutex contention
519 unique_fd tmp_fd(TEMP_FAILURE_RETRY(open(path.c_str(), O_WRONLY | O_CLOEXEC)));
Rick Yiubc1ad962020-10-26 20:32:52 +0800520
Rick Yiud4c53512021-11-21 15:57:36 +0800521 if (tmp_fd < 0) {
Bart Van Assche7a952612022-10-12 13:27:28 -0700522 if (logfailures) PLOG(WARNING) << Name() << "::" << __func__ << ": failed to open " << path;
Rick Yiud4c53512021-11-21 15:57:36 +0800523 return false;
524 }
525
526 if (!WriteStringToFd(value, tmp_fd)) {
527 if (logfailures) PLOG(ERROR) << "Failed to write '" << value << "' to " << path;
Rick Yiubc1ad962020-10-26 20:32:52 +0800528 return false;
529 }
530
531 return true;
532}
533
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800534ProfileAction::CacheUseResult WriteFileAction::UseCachedFd(ResourceCacheType cache_type,
535 const std::string& value) const {
Rick Yiud4c53512021-11-21 15:57:36 +0800536 std::lock_guard<std::mutex> lock(fd_mutex_);
Rick Yiu9221b1e2022-02-10 16:44:43 +0800537 if (FdCacheHelper::IsCached(fd_[cache_type])) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800538 // fd is cached, reuse it
Rick Yiu9221b1e2022-02-10 16:44:43 +0800539 bool ret = WriteStringToFd(value, fd_[cache_type]);
540
541 if (!ret && logfailures_) {
542 if (cache_type == ProfileAction::RCT_TASK || proc_path_.empty()) {
543 PLOG(ERROR) << "Failed to write '" << value << "' to " << task_path_;
544 } else {
545 PLOG(ERROR) << "Failed to write '" << value << "' to " << proc_path_;
546 }
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800547 }
Rick Yiu9221b1e2022-02-10 16:44:43 +0800548 return ret ? ProfileAction::SUCCESS : ProfileAction::FAIL;
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800549 }
550
Rick Yiu9221b1e2022-02-10 16:44:43 +0800551 if (fd_[cache_type] == FdCacheHelper::FDS_INACCESSIBLE) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800552 // no permissions to access the file, ignore
553 return ProfileAction::SUCCESS;
554 }
555
Rick Yiu9221b1e2022-02-10 16:44:43 +0800556 if (cache_type == ResourceCacheType::RCT_TASK &&
557 fd_[cache_type] == FdCacheHelper::FDS_APP_DEPENDENT) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800558 // application-dependent path can't be used with tid
Bart Van Assche7a952612022-10-12 13:27:28 -0700559 LOG(ERROR) << Name() << ": application profile can't be applied to a thread";
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800560 return ProfileAction::FAIL;
561 }
562 return ProfileAction::UNUSED;
563}
564
565bool WriteFileAction::ExecuteForProcess(uid_t uid, pid_t pid) const {
Rick Yiu9221b1e2022-02-10 16:44:43 +0800566 if (!proc_path_.empty()) {
567 return WriteValueToFile(value_, ProfileAction::RCT_PROCESS, uid, pid, logfailures_);
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800568 }
569
Rick Yiu9221b1e2022-02-10 16:44:43 +0800570 DIR* d;
571 struct dirent* de;
572 char proc_path[255];
T.J. Mercierd6fb2252024-01-24 23:42:39 +0000573 pid_t t_pid;
Rick Yiud4c53512021-11-21 15:57:36 +0800574
Rick Yiu9221b1e2022-02-10 16:44:43 +0800575 sprintf(proc_path, "/proc/%d/task", pid);
576 if (!(d = opendir(proc_path))) {
577 return false;
578 }
579
580 while ((de = readdir(d))) {
581 if (de->d_name[0] == '.') {
582 continue;
583 }
584
585 t_pid = atoi(de->d_name);
586
587 if (!t_pid) {
588 continue;
589 }
590
591 WriteValueToFile(value_, ProfileAction::RCT_TASK, uid, t_pid, logfailures_);
592 }
593
594 closedir(d);
595
596 return true;
Rick Yiud4c53512021-11-21 15:57:36 +0800597}
598
T.J. Mercier1c007992024-01-25 16:29:54 +0000599bool WriteFileAction::ExecuteForTask(pid_t tid) const {
Rick Yiu9221b1e2022-02-10 16:44:43 +0800600 return WriteValueToFile(value_, ProfileAction::RCT_TASK, getuid(), tid, logfailures_);
601}
Rick Yiubc1ad962020-10-26 20:32:52 +0800602
Rick Yiu9221b1e2022-02-10 16:44:43 +0800603void WriteFileAction::EnableResourceCaching(ResourceCacheType cache_type) {
604 std::lock_guard<std::mutex> lock(fd_mutex_);
605 if (fd_[cache_type] != FdCacheHelper::FDS_NOT_CACHED) {
606 return;
Rick Yiubc1ad962020-10-26 20:32:52 +0800607 }
Rick Yiu9221b1e2022-02-10 16:44:43 +0800608 switch (cache_type) {
609 case (ProfileAction::RCT_TASK):
610 FdCacheHelper::Cache(task_path_, fd_[cache_type]);
611 break;
612 case (ProfileAction::RCT_PROCESS):
613 if (!proc_path_.empty()) FdCacheHelper::Cache(proc_path_, fd_[cache_type]);
614 break;
615 default:
616 LOG(ERROR) << "Invalid cache type is specified!";
617 break;
618 }
Rick Yiubc1ad962020-10-26 20:32:52 +0800619}
620
Rick Yiu9221b1e2022-02-10 16:44:43 +0800621void WriteFileAction::DropResourceCaching(ResourceCacheType cache_type) {
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800622 std::lock_guard<std::mutex> lock(fd_mutex_);
Rick Yiu9221b1e2022-02-10 16:44:43 +0800623 FdCacheHelper::Drop(fd_[cache_type]);
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800624}
625
Suren Baghdasaryan8cacb612023-04-12 01:24:23 +0000626bool WriteFileAction::IsValidForProcess(uid_t, pid_t) const {
627 std::lock_guard<std::mutex> lock(fd_mutex_);
628 if (FdCacheHelper::IsCached(fd_[ProfileAction::RCT_PROCESS])) {
629 return true;
630 }
631
632 if (fd_[ProfileAction::RCT_PROCESS] == FdCacheHelper::FDS_INACCESSIBLE) {
633 return false;
634 }
635
636 return access(proc_path_.empty() ? task_path_.c_str() : proc_path_.c_str(), W_OK) == 0;
637}
638
639bool WriteFileAction::IsValidForTask(int) const {
640 std::lock_guard<std::mutex> lock(fd_mutex_);
641 if (FdCacheHelper::IsCached(fd_[ProfileAction::RCT_TASK])) {
642 return true;
643 }
644
645 if (fd_[ProfileAction::RCT_TASK] == FdCacheHelper::FDS_INACCESSIBLE) {
646 return false;
647 }
648
649 if (fd_[ProfileAction::RCT_TASK] == FdCacheHelper::FDS_APP_DEPENDENT) {
650 // application-dependent path can't be used with tid
651 return false;
652 }
653
654 return access(task_path_.c_str(), W_OK) == 0;
655}
656
Rick Yiu0b211fa2019-09-16 19:07:17 +0800657bool ApplyProfileAction::ExecuteForProcess(uid_t uid, pid_t pid) const {
658 for (const auto& profile : profiles_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800659 profile->ExecuteForProcess(uid, pid);
Rick Yiu0b211fa2019-09-16 19:07:17 +0800660 }
661 return true;
662}
663
T.J. Mercier1c007992024-01-25 16:29:54 +0000664bool ApplyProfileAction::ExecuteForTask(pid_t tid) const {
Rick Yiu0b211fa2019-09-16 19:07:17 +0800665 for (const auto& profile : profiles_) {
Wei Wang8722e4d2021-05-14 12:34:54 -0700666 profile->ExecuteForTask(tid);
Rick Yiu0b211fa2019-09-16 19:07:17 +0800667 }
668 return true;
669}
670
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800671void ApplyProfileAction::EnableResourceCaching(ResourceCacheType cache_type) {
Suren Baghdasaryan911109c2020-02-13 17:28:00 -0800672 for (const auto& profile : profiles_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800673 profile->EnableResourceCaching(cache_type);
Suren Baghdasaryan911109c2020-02-13 17:28:00 -0800674 }
675}
676
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800677void ApplyProfileAction::DropResourceCaching(ResourceCacheType cache_type) {
Suren Baghdasaryan911109c2020-02-13 17:28:00 -0800678 for (const auto& profile : profiles_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800679 profile->DropResourceCaching(cache_type);
Suren Baghdasaryan911109c2020-02-13 17:28:00 -0800680 }
681}
682
Suren Baghdasaryan8cacb612023-04-12 01:24:23 +0000683bool ApplyProfileAction::IsValidForProcess(uid_t uid, pid_t pid) const {
684 for (const auto& profile : profiles_) {
685 if (!profile->IsValidForProcess(uid, pid)) {
686 return false;
687 }
688 }
689 return true;
690}
691
T.J. Mercier1c007992024-01-25 16:29:54 +0000692bool ApplyProfileAction::IsValidForTask(pid_t tid) const {
Suren Baghdasaryan8cacb612023-04-12 01:24:23 +0000693 for (const auto& profile : profiles_) {
694 if (!profile->IsValidForTask(tid)) {
695 return false;
696 }
697 }
698 return true;
699}
700
Suren Baghdasaryan84385952020-01-24 16:36:10 -0800701void TaskProfile::MoveTo(TaskProfile* profile) {
702 profile->elements_ = std::move(elements_);
703 profile->res_cached_ = res_cached_;
704}
705
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800706bool TaskProfile::ExecuteForProcess(uid_t uid, pid_t pid) const {
707 for (const auto& element : elements_) {
708 if (!element->ExecuteForProcess(uid, pid)) {
Bart Van Asschef096bd22022-01-24 19:59:13 +0000709 LOG(VERBOSE) << "Applying profile action " << element->Name() << " failed";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800710 return false;
711 }
712 }
713 return true;
714}
715
T.J. Mercier1c007992024-01-25 16:29:54 +0000716bool TaskProfile::ExecuteForTask(pid_t tid) const {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800717 if (tid == 0) {
718 tid = GetThreadId();
719 }
720 for (const auto& element : elements_) {
721 if (!element->ExecuteForTask(tid)) {
Bart Van Asschef096bd22022-01-24 19:59:13 +0000722 LOG(VERBOSE) << "Applying profile action " << element->Name() << " failed";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800723 return false;
724 }
725 }
726 return true;
727}
728
T.J. Mercier5ed5e1b2022-08-22 21:25:09 +0000729bool TaskProfile::ExecuteForUID(uid_t uid) const {
730 for (const auto& element : elements_) {
731 if (!element->ExecuteForUID(uid)) {
732 LOG(VERBOSE) << "Applying profile action " << element->Name() << " failed";
733 return false;
734 }
735 }
736 return true;
737}
738
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800739void TaskProfile::EnableResourceCaching(ProfileAction::ResourceCacheType cache_type) {
Suren Baghdasaryan8a315d22019-02-14 14:40:41 -0800740 if (res_cached_) {
741 return;
742 }
743
744 for (auto& element : elements_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800745 element->EnableResourceCaching(cache_type);
Suren Baghdasaryan8a315d22019-02-14 14:40:41 -0800746 }
747
748 res_cached_ = true;
749}
750
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800751void TaskProfile::DropResourceCaching(ProfileAction::ResourceCacheType cache_type) {
Riddle Hsua6abd822019-06-18 15:53:53 -0600752 if (!res_cached_) {
753 return;
754 }
755
756 for (auto& element : elements_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800757 element->DropResourceCaching(cache_type);
Riddle Hsua6abd822019-06-18 15:53:53 -0600758 }
759
760 res_cached_ = false;
761}
762
Suren Baghdasaryan8cacb612023-04-12 01:24:23 +0000763bool TaskProfile::IsValidForProcess(uid_t uid, pid_t pid) const {
764 for (const auto& element : elements_) {
765 if (!element->IsValidForProcess(uid, pid)) return false;
766 }
767 return true;
768}
769
T.J. Mercier1c007992024-01-25 16:29:54 +0000770bool TaskProfile::IsValidForTask(pid_t tid) const {
Suren Baghdasaryan8cacb612023-04-12 01:24:23 +0000771 for (const auto& element : elements_) {
772 if (!element->IsValidForTask(tid)) return false;
773 }
774 return true;
775}
776
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800777void TaskProfiles::DropResourceCaching(ProfileAction::ResourceCacheType cache_type) const {
Riddle Hsua6abd822019-06-18 15:53:53 -0600778 for (auto& iter : profiles_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800779 iter.second->DropResourceCaching(cache_type);
Riddle Hsua6abd822019-06-18 15:53:53 -0600780 }
781}
782
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800783TaskProfiles& TaskProfiles::GetInstance() {
Peter Collingbournedba6d442019-03-20 21:09:46 -0700784 // Deliberately leak this object to avoid a race between destruction on
785 // process exit and concurrent access from another thread.
786 static auto* instance = new TaskProfiles;
787 return *instance;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800788}
789
790TaskProfiles::TaskProfiles() {
Suren Baghdasaryan756a6042020-12-03 11:38:42 -0800791 // load system task profiles
792 if (!Load(CgroupMap::GetInstance(), TASK_PROFILE_DB_FILE)) {
793 LOG(ERROR) << "Loading " << TASK_PROFILE_DB_FILE << " for [" << getpid() << "] failed";
794 }
Suren Baghdasaryan35221b52020-11-20 17:08:51 -0800795
796 // load API-level specific system task profiles if available
Suren Baghdasaryan756a6042020-12-03 11:38:42 -0800797 unsigned int api_level = GetUintProperty<unsigned int>("ro.product.first_api_level", 0);
Suren Baghdasaryan35221b52020-11-20 17:08:51 -0800798 if (api_level > 0) {
799 std::string api_profiles_path =
800 android::base::StringPrintf(TEMPLATE_TASK_PROFILE_API_FILE, api_level);
801 if (!access(api_profiles_path.c_str(), F_OK) || errno != ENOENT) {
Suren Baghdasaryan756a6042020-12-03 11:38:42 -0800802 if (!Load(CgroupMap::GetInstance(), api_profiles_path)) {
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800803 LOG(ERROR) << "Loading " << api_profiles_path << " for [" << getpid() << "] failed";
Suren Baghdasaryan756a6042020-12-03 11:38:42 -0800804 }
Suren Baghdasaryan35221b52020-11-20 17:08:51 -0800805 }
806 }
807
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800808 // load vendor task profiles if the file exists
809 if (!access(TASK_PROFILE_DB_VENDOR_FILE, F_OK) &&
810 !Load(CgroupMap::GetInstance(), TASK_PROFILE_DB_VENDOR_FILE)) {
811 LOG(ERROR) << "Loading " << TASK_PROFILE_DB_VENDOR_FILE << " for [" << getpid()
812 << "] failed";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800813 }
814}
815
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800816bool TaskProfiles::Load(const CgroupMap& cg_map, const std::string& file_name) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800817 std::string json_doc;
818
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800819 if (!android::base::ReadFileToString(file_name, &json_doc)) {
820 LOG(ERROR) << "Failed to read task profiles from " << file_name;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800821 return false;
822 }
823
Haibo Huangd9ac92a2021-02-24 17:34:50 -0800824 Json::CharReaderBuilder builder;
825 std::unique_ptr<Json::CharReader> reader(builder.newCharReader());
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800826 Json::Value root;
Haibo Huangd9ac92a2021-02-24 17:34:50 -0800827 std::string errorMessage;
828 if (!reader->parse(&*json_doc.begin(), &*json_doc.end(), &root, &errorMessage)) {
829 LOG(ERROR) << "Failed to parse task profiles: " << errorMessage;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800830 return false;
831 }
832
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800833 const Json::Value& attr = root["Attributes"];
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800834 for (Json::Value::ArrayIndex i = 0; i < attr.size(); ++i) {
835 std::string name = attr[i]["Name"].asString();
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800836 std::string controller_name = attr[i]["Controller"].asString();
837 std::string file_attr = attr[i]["File"].asString();
Bart Van Asschebc077ff2022-02-17 01:26:44 +0000838 std::string file_v2_attr = attr[i]["FileV2"].asString();
839
840 if (!file_v2_attr.empty() && file_attr.empty()) {
841 LOG(ERROR) << "Attribute " << name << " has FileV2 but no File property";
842 return false;
843 }
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800844
Suren Baghdasaryan81b9f0b2020-07-01 12:34:17 -0700845 auto controller = cg_map.FindController(controller_name);
846 if (controller.HasValue()) {
847 auto iter = attributes_.find(name);
848 if (iter == attributes_.end()) {
Bart Van Asschebc077ff2022-02-17 01:26:44 +0000849 attributes_[name] =
850 std::make_unique<ProfileAttribute>(controller, file_attr, file_v2_attr);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800851 } else {
Suren Baghdasaryan35078462023-07-25 14:50:18 -0700852 iter->second->Reset(controller, file_attr, file_v2_attr);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800853 }
854 } else {
Suren Baghdasaryan81b9f0b2020-07-01 12:34:17 -0700855 LOG(WARNING) << "Controller " << controller_name << " is not found";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800856 }
857 }
858
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800859 const Json::Value& profiles_val = root["Profiles"];
860 for (Json::Value::ArrayIndex i = 0; i < profiles_val.size(); ++i) {
861 const Json::Value& profile_val = profiles_val[i];
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800862
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800863 std::string profile_name = profile_val["Name"].asString();
864 const Json::Value& actions = profile_val["Actions"];
Bart Van Asschef096bd22022-01-24 19:59:13 +0000865 auto profile = std::make_shared<TaskProfile>(profile_name);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800866
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800867 for (Json::Value::ArrayIndex act_idx = 0; act_idx < actions.size(); ++act_idx) {
868 const Json::Value& action_val = actions[act_idx];
869 std::string action_name = action_val["Name"].asString();
870 const Json::Value& params_val = action_val["Params"];
871 if (action_name == "JoinCgroup") {
872 std::string controller_name = params_val["Controller"].asString();
873 std::string path = params_val["Path"].asString();
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800874
Yifan Hong53e0deb2019-03-22 17:01:08 -0700875 auto controller = cg_map.FindController(controller_name);
876 if (controller.HasValue()) {
Bart Van Assche2953a922023-11-14 07:33:00 -0800877 if (controller.version() == 1) {
878 profile->Add(std::make_unique<SetCgroupAction>(controller, path));
879 } else {
880 LOG(WARNING) << "A JoinCgroup action in the " << profile_name
881 << " profile is used for controller " << controller_name
882 << " in the cgroup v2 hierarchy and will be ignored";
883 }
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800884 } else {
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800885 LOG(WARNING) << "JoinCgroup: controller " << controller_name << " is not found";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800886 }
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800887 } else if (action_name == "SetTimerSlack") {
888 std::string slack_value = params_val["Slack"].asString();
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800889 char* end;
890 unsigned long slack;
891
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800892 slack = strtoul(slack_value.c_str(), &end, 10);
893 if (end > slack_value.c_str()) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800894 profile->Add(std::make_unique<SetTimerSlackAction>(slack));
895 } else {
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800896 LOG(WARNING) << "SetTimerSlack: invalid parameter: " << slack_value;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800897 }
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800898 } else if (action_name == "SetAttribute") {
899 std::string attr_name = params_val["Name"].asString();
900 std::string attr_value = params_val["Value"].asString();
Bart Van Assche59af6802022-01-24 21:08:57 +0000901 bool optional = strcmp(params_val["Optional"].asString().c_str(), "true") == 0;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800902
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800903 auto iter = attributes_.find(attr_name);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800904 if (iter != attributes_.end()) {
Bart Van Assche59af6802022-01-24 21:08:57 +0000905 profile->Add(std::make_unique<SetAttributeAction>(iter->second.get(),
906 attr_value, optional));
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800907 } else {
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800908 LOG(WARNING) << "SetAttribute: unknown attribute: " << attr_name;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800909 }
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800910 } else if (action_name == "SetClamps") {
911 std::string boost_value = params_val["Boost"].asString();
912 std::string clamp_value = params_val["Clamp"].asString();
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800913 char* end;
914 unsigned long boost;
915
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800916 boost = strtoul(boost_value.c_str(), &end, 10);
917 if (end > boost_value.c_str()) {
918 unsigned long clamp = strtoul(clamp_value.c_str(), &end, 10);
919 if (end > clamp_value.c_str()) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800920 profile->Add(std::make_unique<SetClampsAction>(boost, clamp));
921 } else {
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800922 LOG(WARNING) << "SetClamps: invalid parameter " << clamp_value;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800923 }
924 } else {
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800925 LOG(WARNING) << "SetClamps: invalid parameter: " << boost_value;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800926 }
Rick Yiubc1ad962020-10-26 20:32:52 +0800927 } else if (action_name == "WriteFile") {
928 std::string attr_filepath = params_val["FilePath"].asString();
Rick Yiu9221b1e2022-02-10 16:44:43 +0800929 std::string attr_procfilepath = params_val["ProcFilePath"].asString();
Rick Yiubc1ad962020-10-26 20:32:52 +0800930 std::string attr_value = params_val["Value"].asString();
Rick Yiu9221b1e2022-02-10 16:44:43 +0800931 // FilePath and Value are mandatory
Rick Yiubc1ad962020-10-26 20:32:52 +0800932 if (!attr_filepath.empty() && !attr_value.empty()) {
Rick Yiu49fce952021-04-08 22:10:06 +0800933 std::string attr_logfailures = params_val["LogFailures"].asString();
934 bool logfailures = attr_logfailures.empty() || attr_logfailures == "true";
Rick Yiu9221b1e2022-02-10 16:44:43 +0800935 profile->Add(std::make_unique<WriteFileAction>(attr_filepath, attr_procfilepath,
936 attr_value, logfailures));
Rick Yiubc1ad962020-10-26 20:32:52 +0800937 } else if (attr_filepath.empty()) {
938 LOG(WARNING) << "WriteFile: invalid parameter: "
939 << "empty filepath";
940 } else if (attr_value.empty()) {
941 LOG(WARNING) << "WriteFile: invalid parameter: "
942 << "empty value";
943 }
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800944 } else {
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800945 LOG(WARNING) << "Unknown profile action: " << action_name;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800946 }
947 }
Suren Baghdasaryan84385952020-01-24 16:36:10 -0800948 auto iter = profiles_.find(profile_name);
949 if (iter == profiles_.end()) {
950 profiles_[profile_name] = profile;
951 } else {
952 // Move the content rather that replace the profile because old profile might be
953 // referenced from an aggregate profile if vendor overrides task profiles
954 profile->MoveTo(iter->second.get());
955 profile.reset();
956 }
Rick Yiu0b211fa2019-09-16 19:07:17 +0800957 }
958
959 const Json::Value& aggregateprofiles_val = root["AggregateProfiles"];
960 for (Json::Value::ArrayIndex i = 0; i < aggregateprofiles_val.size(); ++i) {
961 const Json::Value& aggregateprofile_val = aggregateprofiles_val[i];
962
963 std::string aggregateprofile_name = aggregateprofile_val["Name"].asString();
964 const Json::Value& aggregateprofiles = aggregateprofile_val["Profiles"];
965 std::vector<std::shared_ptr<TaskProfile>> profiles;
966 bool ret = true;
967
968 for (Json::Value::ArrayIndex pf_idx = 0; pf_idx < aggregateprofiles.size(); ++pf_idx) {
969 std::string profile_name = aggregateprofiles[pf_idx].asString();
970
971 if (profile_name == aggregateprofile_name) {
972 LOG(WARNING) << "AggregateProfiles: recursive profile name: " << profile_name;
973 ret = false;
974 break;
975 } else if (profiles_.find(profile_name) == profiles_.end()) {
976 LOG(WARNING) << "AggregateProfiles: undefined profile name: " << profile_name;
977 ret = false;
978 break;
979 } else {
980 profiles.push_back(profiles_[profile_name]);
981 }
982 }
983 if (ret) {
Bart Van Asschef096bd22022-01-24 19:59:13 +0000984 auto profile = std::make_shared<TaskProfile>(aggregateprofile_name);
Rick Yiu0b211fa2019-09-16 19:07:17 +0800985 profile->Add(std::make_unique<ApplyProfileAction>(profiles));
986 profiles_[aggregateprofile_name] = profile;
987 }
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800988 }
989
990 return true;
991}
992
Bart Van Assched0b8ce22022-08-02 13:06:26 -0700993TaskProfile* TaskProfiles::GetProfile(std::string_view name) const {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800994 auto iter = profiles_.find(name);
995
996 if (iter != profiles_.end()) {
997 return iter->second.get();
998 }
999 return nullptr;
1000}
1001
Bart Van Assched0b8ce22022-08-02 13:06:26 -07001002const IProfileAttribute* TaskProfiles::GetAttribute(std::string_view name) const {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -08001003 auto iter = attributes_.find(name);
1004
1005 if (iter != attributes_.end()) {
1006 return iter->second.get();
1007 }
1008 return nullptr;
1009}
Rick Yiu0b211fa2019-09-16 19:07:17 +08001010
Bart Van Asschef32c4ec2022-08-02 13:18:12 -07001011template <typename T>
T.J. Mercier5ed5e1b2022-08-22 21:25:09 +00001012bool TaskProfiles::SetUserProfiles(uid_t uid, std::span<const T> profiles, bool use_fd_cache) {
1013 for (const auto& name : profiles) {
1014 TaskProfile* profile = GetProfile(name);
1015 if (profile != nullptr) {
1016 if (use_fd_cache) {
1017 profile->EnableResourceCaching(ProfileAction::RCT_PROCESS);
1018 }
1019 if (!profile->ExecuteForUID(uid)) {
1020 PLOG(WARNING) << "Failed to apply " << name << " process profile";
1021 }
1022 } else {
1023 PLOG(WARNING) << "Failed to find " << name << "process profile";
1024 }
1025 }
1026 return true;
1027}
1028
1029template <typename T>
Bart Van Asschef32c4ec2022-08-02 13:18:12 -07001030bool TaskProfiles::SetProcessProfiles(uid_t uid, pid_t pid, std::span<const T> profiles,
1031 bool use_fd_cache) {
Inseob Kim538fc1f2022-04-13 18:50:12 +00001032 bool success = true;
Rick Yiu0b211fa2019-09-16 19:07:17 +08001033 for (const auto& name : profiles) {
1034 TaskProfile* profile = GetProfile(name);
1035 if (profile != nullptr) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -08001036 if (use_fd_cache) {
1037 profile->EnableResourceCaching(ProfileAction::RCT_PROCESS);
1038 }
Rick Yiu0b211fa2019-09-16 19:07:17 +08001039 if (!profile->ExecuteForProcess(uid, pid)) {
Krzysztof Kosiński0310ec42023-03-01 04:17:57 +00001040 LOG(WARNING) << "Failed to apply " << name << " process profile";
Inseob Kim538fc1f2022-04-13 18:50:12 +00001041 success = false;
Rick Yiu0b211fa2019-09-16 19:07:17 +08001042 }
1043 } else {
Krzysztof Kosiński0310ec42023-03-01 04:17:57 +00001044 LOG(WARNING) << "Failed to find " << name << " process profile";
Inseob Kim538fc1f2022-04-13 18:50:12 +00001045 success = false;
Rick Yiu0b211fa2019-09-16 19:07:17 +08001046 }
1047 }
Inseob Kim538fc1f2022-04-13 18:50:12 +00001048 return success;
Rick Yiu0b211fa2019-09-16 19:07:17 +08001049}
1050
Bart Van Asschef32c4ec2022-08-02 13:18:12 -07001051template <typename T>
T.J. Mercier1c007992024-01-25 16:29:54 +00001052bool TaskProfiles::SetTaskProfiles(pid_t tid, std::span<const T> profiles, bool use_fd_cache) {
Inseob Kim538fc1f2022-04-13 18:50:12 +00001053 bool success = true;
Rick Yiu0b211fa2019-09-16 19:07:17 +08001054 for (const auto& name : profiles) {
1055 TaskProfile* profile = GetProfile(name);
1056 if (profile != nullptr) {
1057 if (use_fd_cache) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -08001058 profile->EnableResourceCaching(ProfileAction::RCT_TASK);
Rick Yiu0b211fa2019-09-16 19:07:17 +08001059 }
1060 if (!profile->ExecuteForTask(tid)) {
Krzysztof Kosiński0310ec42023-03-01 04:17:57 +00001061 LOG(WARNING) << "Failed to apply " << name << " task profile";
Inseob Kim538fc1f2022-04-13 18:50:12 +00001062 success = false;
Rick Yiu0b211fa2019-09-16 19:07:17 +08001063 }
1064 } else {
Krzysztof Kosiński0310ec42023-03-01 04:17:57 +00001065 LOG(WARNING) << "Failed to find " << name << " task profile";
Inseob Kim538fc1f2022-04-13 18:50:12 +00001066 success = false;
Rick Yiu0b211fa2019-09-16 19:07:17 +08001067 }
1068 }
Inseob Kim538fc1f2022-04-13 18:50:12 +00001069 return success;
Rick Yiu0b211fa2019-09-16 19:07:17 +08001070}
Bart Van Asschef32c4ec2022-08-02 13:18:12 -07001071
1072template bool TaskProfiles::SetProcessProfiles(uid_t uid, pid_t pid,
1073 std::span<const std::string> profiles,
1074 bool use_fd_cache);
1075template bool TaskProfiles::SetProcessProfiles(uid_t uid, pid_t pid,
1076 std::span<const std::string_view> profiles,
1077 bool use_fd_cache);
T.J. Mercier1c007992024-01-25 16:29:54 +00001078template bool TaskProfiles::SetTaskProfiles(pid_t tid, std::span<const std::string> profiles,
Bart Van Asschef32c4ec2022-08-02 13:18:12 -07001079 bool use_fd_cache);
T.J. Mercier1c007992024-01-25 16:29:54 +00001080template bool TaskProfiles::SetTaskProfiles(pid_t tid, std::span<const std::string_view> profiles,
Bart Van Asschef32c4ec2022-08-02 13:18:12 -07001081 bool use_fd_cache);
T.J. Mercier5ed5e1b2022-08-22 21:25:09 +00001082template bool TaskProfiles::SetUserProfiles(uid_t uid, std::span<const std::string> profiles,
1083 bool use_fd_cache);