blob: 67ecc1d500a57c2ba0da16627ca3b2a0008caa21 [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::IsTimerSlackSupported(pid_t tid) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800207 auto file = StringPrintf("/proc/%d/timerslack_ns", tid);
208
209 return (access(file.c_str(), W_OK) == 0);
210}
211
T.J. Mercier1c007992024-01-25 16:29:54 +0000212bool SetTimerSlackAction::ExecuteForTask(pid_t tid) const {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800213 static bool sys_supports_timerslack = IsTimerSlackSupported(tid);
214
215 // v4.6+ kernels support the /proc/<tid>/timerslack_ns interface.
216 // TODO: once we've backported this, log if the open(2) fails.
217 if (sys_supports_timerslack) {
218 auto file = StringPrintf("/proc/%d/timerslack_ns", tid);
219 if (!WriteStringToFile(std::to_string(slack_), file)) {
Suren Baghdasaryan2bc52282019-02-12 17:30:26 -0800220 if (errno == ENOENT) {
221 // This happens when process is already dead
222 return true;
223 }
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800224 PLOG(ERROR) << "set_timerslack_ns write failed";
225 }
226 }
227
228 // TODO: Remove when /proc/<tid>/timerslack_ns interface is backported.
229 if (tid == 0 || tid == GetThreadId()) {
230 if (prctl(PR_SET_TIMERSLACK, slack_) == -1) {
231 PLOG(ERROR) << "set_timerslack_ns prctl failed";
232 }
233 }
234
235 return true;
236}
237
Bart Van Assche20d59bd2022-01-24 19:45:59 +0000238#else
239
240bool SetTimerSlackAction::ExecuteForTask(int) const {
241 return true;
242};
243
Suren Baghdasaryaneca87cb2019-02-02 14:19:41 -0800244#endif
245
Suren Baghdasaryan34837982023-07-25 15:45:45 -0700246bool SetAttributeAction::WriteValueToFile(const std::string& path) const {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800247 if (!WriteStringToFile(value_, path)) {
Bart Van Assche9b5a2322022-03-22 16:15:00 -0700248 if (access(path.c_str(), F_OK) < 0) {
Bart Van Assche59af6802022-01-24 21:08:57 +0000249 if (optional_) {
250 return true;
251 } else {
252 LOG(ERROR) << "No such cgroup attribute: " << path;
253 return false;
254 }
255 }
Bart Van Assche54136f82022-03-31 11:26:42 -0700256 // The PLOG() statement below uses the error code stored in `errno` by
257 // WriteStringToFile() because access() only overwrites `errno` if it fails
258 // and because this code is only reached if the access() function returns 0.
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800259 PLOG(ERROR) << "Failed to write '" << value_ << "' to " << path;
260 return false;
261 }
262
263 return true;
264}
265
Suren Baghdasaryan34837982023-07-25 15:45:45 -0700266bool SetAttributeAction::ExecuteForProcess(uid_t uid, pid_t pid) const {
267 std::string path;
268
269 if (!attribute_->GetPathForProcess(uid, pid, &path)) {
270 LOG(ERROR) << "Failed to find cgroup for uid " << uid << " pid " << pid;
271 return false;
272 }
273
274 return WriteValueToFile(path);
275}
276
T.J. Mercier1c007992024-01-25 16:29:54 +0000277bool SetAttributeAction::ExecuteForTask(pid_t tid) const {
Suren Baghdasaryan34837982023-07-25 15:45:45 -0700278 std::string path;
279
280 if (!attribute_->GetPathForTask(tid, &path)) {
281 LOG(ERROR) << "Failed to find cgroup for tid " << tid;
282 return false;
283 }
284
285 return WriteValueToFile(path);
286}
287
T.J. Mercier5ed5e1b2022-08-22 21:25:09 +0000288bool SetAttributeAction::ExecuteForUID(uid_t uid) const {
289 std::string path;
290
291 if (!attribute_->GetPathForUID(uid, &path)) {
292 LOG(ERROR) << "Failed to find cgroup for uid " << uid;
293 return false;
294 }
295
296 if (!WriteStringToFile(value_, path)) {
297 if (access(path.c_str(), F_OK) < 0) {
298 if (optional_) {
299 return true;
300 } else {
301 LOG(ERROR) << "No such cgroup attribute: " << path;
302 return false;
303 }
304 }
305 PLOG(ERROR) << "Failed to write '" << value_ << "' to " << path;
306 return false;
307 }
308 return true;
309}
310
Suren Baghdasaryan8cacb612023-04-12 01:24:23 +0000311bool SetAttributeAction::IsValidForProcess(uid_t, pid_t pid) const {
312 return IsValidForTask(pid);
313}
314
T.J. Mercier1c007992024-01-25 16:29:54 +0000315bool SetAttributeAction::IsValidForTask(pid_t tid) const {
Suren Baghdasaryan8cacb612023-04-12 01:24:23 +0000316 std::string path;
317
318 if (!attribute_->GetPathForTask(tid, &path)) {
319 return false;
320 }
321
322 if (!access(path.c_str(), W_OK)) {
323 // operation will succeed
324 return true;
325 }
326
327 if (!access(path.c_str(), F_OK)) {
328 // file exists but not writable
329 return false;
330 }
331
332 // file does not exist, ignore if optional
333 return optional_;
334}
335
T.J. Mercierfcb86662024-08-01 20:52:30 +0000336SetCgroupAction::SetCgroupAction(const CgroupControllerWrapper& c, const std::string& p)
Rick Yiud4c53512021-11-21 15:57:36 +0800337 : controller_(c), path_(p) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800338 FdCacheHelper::Init(controller_.GetTasksFilePath(path_), fd_[ProfileAction::RCT_TASK]);
339 // uid and pid don't matter because IsAppDependentPath ensures the path doesn't use them
340 FdCacheHelper::Init(controller_.GetProcsFilePath(path_, 0, 0), fd_[ProfileAction::RCT_PROCESS]);
Rick Yiud4c53512021-11-21 15:57:36 +0800341}
342
T.J. Mercier1c007992024-01-25 16:29:54 +0000343bool SetCgroupAction::AddTidToCgroup(pid_t tid, int fd, ResourceCacheType cache_type) const {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800344 if (tid <= 0) {
345 return true;
346 }
347
348 std::string value = std::to_string(tid);
349
Suren Baghdasaryanec885562021-09-02 19:47:12 -0700350 if (TEMP_FAILURE_RETRY(write(fd, value.c_str(), value.length())) == value.length()) {
351 return true;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800352 }
353
Suren Baghdasaryanec885562021-09-02 19:47:12 -0700354 // If the thread is in the process of exiting, don't flag an error
355 if (errno == ESRCH) {
356 return true;
357 }
358
Bart Van Asschedf985342023-11-13 15:19:43 -0800359 const char* controller_name = controller()->name();
Suren Baghdasaryanec885562021-09-02 19:47:12 -0700360 // ENOSPC is returned when cpuset cgroup that we are joining has no online cpus
361 if (errno == ENOSPC && !strcmp(controller_name, "cpuset")) {
362 // This is an abnormal case happening only in testing, so report it only once
363 static bool empty_cpuset_reported = false;
364
365 if (empty_cpuset_reported) {
366 return true;
367 }
368
369 LOG(ERROR) << "Failed to add task '" << value
370 << "' into cpuset because all cpus in that cpuset are offline";
371 empty_cpuset_reported = true;
372 } else {
Bart Van Asschedf985342023-11-13 15:19:43 -0800373 PLOG(ERROR) << "AddTidToCgroup failed to write '" << value << "'; path=" << path_ << "; "
374 << (cache_type == RCT_TASK ? "task" : "process");
Suren Baghdasaryanec885562021-09-02 19:47:12 -0700375 }
376
377 return false;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800378}
379
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800380ProfileAction::CacheUseResult SetCgroupAction::UseCachedFd(ResourceCacheType cache_type,
381 int id) const {
382 std::lock_guard<std::mutex> lock(fd_mutex_);
383 if (FdCacheHelper::IsCached(fd_[cache_type])) {
384 // fd is cached, reuse it
Bart Van Asschedf985342023-11-13 15:19:43 -0800385 if (!AddTidToCgroup(id, fd_[cache_type], cache_type)) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800386 LOG(ERROR) << "Failed to add task into cgroup";
387 return ProfileAction::FAIL;
388 }
389 return ProfileAction::SUCCESS;
390 }
391
392 if (fd_[cache_type] == FdCacheHelper::FDS_INACCESSIBLE) {
393 // no permissions to access the file, ignore
394 return ProfileAction::SUCCESS;
395 }
396
397 if (cache_type == ResourceCacheType::RCT_TASK &&
398 fd_[cache_type] == FdCacheHelper::FDS_APP_DEPENDENT) {
399 // application-dependent path can't be used with tid
Bart Van Assche7a952612022-10-12 13:27:28 -0700400 LOG(ERROR) << Name() << ": application profile can't be applied to a thread";
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800401 return ProfileAction::FAIL;
402 }
403
404 return ProfileAction::UNUSED;
405}
406
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800407bool SetCgroupAction::ExecuteForProcess(uid_t uid, pid_t pid) const {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800408 CacheUseResult result = UseCachedFd(ProfileAction::RCT_PROCESS, pid);
409 if (result != ProfileAction::UNUSED) {
410 return result == ProfileAction::SUCCESS;
411 }
412
413 // fd was not cached or cached fd can't be used
Yifan Hong53e0deb2019-03-22 17:01:08 -0700414 std::string procs_path = controller()->GetProcsFilePath(path_, uid, pid);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800415 unique_fd tmp_fd(TEMP_FAILURE_RETRY(open(procs_path.c_str(), O_WRONLY | O_CLOEXEC)));
416 if (tmp_fd < 0) {
Bart Van Assche7a952612022-10-12 13:27:28 -0700417 PLOG(WARNING) << Name() << "::" << __func__ << ": failed to open " << procs_path;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800418 return false;
419 }
Bart Van Asschedf985342023-11-13 15:19:43 -0800420 if (!AddTidToCgroup(pid, tmp_fd, RCT_PROCESS)) {
Wei Wangd71d3012019-03-07 11:59:12 -0800421 LOG(ERROR) << "Failed to add task into cgroup";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800422 return false;
423 }
424
425 return true;
426}
427
T.J. Mercier1c007992024-01-25 16:29:54 +0000428bool SetCgroupAction::ExecuteForTask(pid_t tid) const {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800429 CacheUseResult result = UseCachedFd(ProfileAction::RCT_TASK, tid);
430 if (result != ProfileAction::UNUSED) {
431 return result == ProfileAction::SUCCESS;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800432 }
433
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800434 // fd was not cached or cached fd can't be used
Yifan Hong53e0deb2019-03-22 17:01:08 -0700435 std::string tasks_path = controller()->GetTasksFilePath(path_);
Suren Baghdasaryanbee9f572019-02-05 16:44:22 -0800436 unique_fd tmp_fd(TEMP_FAILURE_RETRY(open(tasks_path.c_str(), O_WRONLY | O_CLOEXEC)));
437 if (tmp_fd < 0) {
Bart Van Assche7a952612022-10-12 13:27:28 -0700438 PLOG(WARNING) << Name() << "::" << __func__ << ": failed to open " << tasks_path;
Suren Baghdasaryan8a315d22019-02-14 14:40:41 -0800439 return false;
Suren Baghdasaryanbee9f572019-02-05 16:44:22 -0800440 }
Bart Van Asschedf985342023-11-13 15:19:43 -0800441 if (!AddTidToCgroup(tid, tmp_fd, RCT_TASK)) {
Wei Wangd71d3012019-03-07 11:59:12 -0800442 LOG(ERROR) << "Failed to add task into cgroup";
Suren Baghdasaryanbee9f572019-02-05 16:44:22 -0800443 return false;
444 }
445
446 return true;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800447}
448
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800449void SetCgroupAction::EnableResourceCaching(ResourceCacheType cache_type) {
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800450 std::lock_guard<std::mutex> lock(fd_mutex_);
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800451 // Return early to prevent unnecessary calls to controller_.Get{Tasks|Procs}FilePath() which
452 // include regex evaluations
453 if (fd_[cache_type] != FdCacheHelper::FDS_NOT_CACHED) {
454 return;
455 }
456 switch (cache_type) {
457 case (ProfileAction::RCT_TASK):
458 FdCacheHelper::Cache(controller_.GetTasksFilePath(path_), fd_[cache_type]);
459 break;
460 case (ProfileAction::RCT_PROCESS):
461 // uid and pid don't matter because IsAppDependentPath ensures the path doesn't use them
462 FdCacheHelper::Cache(controller_.GetProcsFilePath(path_, 0, 0), fd_[cache_type]);
463 break;
464 default:
465 LOG(ERROR) << "Invalid cache type is specified!";
466 break;
467 }
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800468}
469
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800470void SetCgroupAction::DropResourceCaching(ResourceCacheType cache_type) {
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800471 std::lock_guard<std::mutex> lock(fd_mutex_);
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800472 FdCacheHelper::Drop(fd_[cache_type]);
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800473}
474
Suren Baghdasaryan8cacb612023-04-12 01:24:23 +0000475bool SetCgroupAction::IsValidForProcess(uid_t uid, pid_t pid) const {
476 std::lock_guard<std::mutex> lock(fd_mutex_);
477 if (FdCacheHelper::IsCached(fd_[ProfileAction::RCT_PROCESS])) {
478 return true;
479 }
480
481 if (fd_[ProfileAction::RCT_PROCESS] == FdCacheHelper::FDS_INACCESSIBLE) {
482 return false;
483 }
484
485 std::string procs_path = controller()->GetProcsFilePath(path_, uid, pid);
486 return access(procs_path.c_str(), W_OK) == 0;
487}
488
489bool SetCgroupAction::IsValidForTask(int) const {
490 std::lock_guard<std::mutex> lock(fd_mutex_);
491 if (FdCacheHelper::IsCached(fd_[ProfileAction::RCT_TASK])) {
492 return true;
493 }
494
495 if (fd_[ProfileAction::RCT_TASK] == FdCacheHelper::FDS_INACCESSIBLE) {
496 return false;
497 }
498
499 if (fd_[ProfileAction::RCT_TASK] == FdCacheHelper::FDS_APP_DEPENDENT) {
500 // application-dependent path can't be used with tid
501 return false;
502 }
503
504 std::string tasks_path = controller()->GetTasksFilePath(path_);
505 return access(tasks_path.c_str(), W_OK) == 0;
506}
507
Rick Yiu9221b1e2022-02-10 16:44:43 +0800508WriteFileAction::WriteFileAction(const std::string& task_path, const std::string& proc_path,
509 const std::string& value, bool logfailures)
510 : task_path_(task_path), proc_path_(proc_path), value_(value), logfailures_(logfailures) {
511 FdCacheHelper::Init(task_path_, fd_[ProfileAction::RCT_TASK]);
512 if (!proc_path_.empty()) FdCacheHelper::Init(proc_path_, fd_[ProfileAction::RCT_PROCESS]);
Rick Yiud4c53512021-11-21 15:57:36 +0800513}
Rick Yiubc1ad962020-10-26 20:32:52 +0800514
Rick Yiu9221b1e2022-02-10 16:44:43 +0800515bool WriteFileAction::WriteValueToFile(const std::string& value_, ResourceCacheType cache_type,
T.J. Mercierd6fb2252024-01-24 23:42:39 +0000516 uid_t uid, pid_t pid, bool logfailures) const {
Rick Yiu9221b1e2022-02-10 16:44:43 +0800517 std::string value(value_);
518
519 value = StringReplace(value, "<uid>", std::to_string(uid), true);
520 value = StringReplace(value, "<pid>", std::to_string(pid), true);
521
522 CacheUseResult result = UseCachedFd(cache_type, value);
523
524 if (result != ProfileAction::UNUSED) {
525 return result == ProfileAction::SUCCESS;
526 }
527
528 std::string path;
529 if (cache_type == ProfileAction::RCT_TASK || proc_path_.empty()) {
530 path = task_path_;
531 } else {
532 path = proc_path_;
533 }
534
Rick Yiud4c53512021-11-21 15:57:36 +0800535 // Use WriteStringToFd instead of WriteStringToFile because the latter will open file with
536 // O_TRUNC which causes kernfs_mutex contention
537 unique_fd tmp_fd(TEMP_FAILURE_RETRY(open(path.c_str(), O_WRONLY | O_CLOEXEC)));
Rick Yiubc1ad962020-10-26 20:32:52 +0800538
Rick Yiud4c53512021-11-21 15:57:36 +0800539 if (tmp_fd < 0) {
Bart Van Assche7a952612022-10-12 13:27:28 -0700540 if (logfailures) PLOG(WARNING) << Name() << "::" << __func__ << ": failed to open " << path;
Rick Yiud4c53512021-11-21 15:57:36 +0800541 return false;
542 }
543
544 if (!WriteStringToFd(value, tmp_fd)) {
545 if (logfailures) PLOG(ERROR) << "Failed to write '" << value << "' to " << path;
Rick Yiubc1ad962020-10-26 20:32:52 +0800546 return false;
547 }
548
549 return true;
550}
551
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800552ProfileAction::CacheUseResult WriteFileAction::UseCachedFd(ResourceCacheType cache_type,
553 const std::string& value) const {
Rick Yiud4c53512021-11-21 15:57:36 +0800554 std::lock_guard<std::mutex> lock(fd_mutex_);
Rick Yiu9221b1e2022-02-10 16:44:43 +0800555 if (FdCacheHelper::IsCached(fd_[cache_type])) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800556 // fd is cached, reuse it
Rick Yiu9221b1e2022-02-10 16:44:43 +0800557 bool ret = WriteStringToFd(value, fd_[cache_type]);
558
559 if (!ret && logfailures_) {
560 if (cache_type == ProfileAction::RCT_TASK || proc_path_.empty()) {
561 PLOG(ERROR) << "Failed to write '" << value << "' to " << task_path_;
562 } else {
563 PLOG(ERROR) << "Failed to write '" << value << "' to " << proc_path_;
564 }
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800565 }
Rick Yiu9221b1e2022-02-10 16:44:43 +0800566 return ret ? ProfileAction::SUCCESS : ProfileAction::FAIL;
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800567 }
568
Rick Yiu9221b1e2022-02-10 16:44:43 +0800569 if (fd_[cache_type] == FdCacheHelper::FDS_INACCESSIBLE) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800570 // no permissions to access the file, ignore
571 return ProfileAction::SUCCESS;
572 }
573
Rick Yiu9221b1e2022-02-10 16:44:43 +0800574 if (cache_type == ResourceCacheType::RCT_TASK &&
575 fd_[cache_type] == FdCacheHelper::FDS_APP_DEPENDENT) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800576 // application-dependent path can't be used with tid
Bart Van Assche7a952612022-10-12 13:27:28 -0700577 LOG(ERROR) << Name() << ": application profile can't be applied to a thread";
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800578 return ProfileAction::FAIL;
579 }
580 return ProfileAction::UNUSED;
581}
582
583bool WriteFileAction::ExecuteForProcess(uid_t uid, pid_t pid) const {
Rick Yiu9221b1e2022-02-10 16:44:43 +0800584 if (!proc_path_.empty()) {
585 return WriteValueToFile(value_, ProfileAction::RCT_PROCESS, uid, pid, logfailures_);
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800586 }
587
Rick Yiu9221b1e2022-02-10 16:44:43 +0800588 DIR* d;
589 struct dirent* de;
590 char proc_path[255];
T.J. Mercierd6fb2252024-01-24 23:42:39 +0000591 pid_t t_pid;
Rick Yiud4c53512021-11-21 15:57:36 +0800592
Rick Yiu9221b1e2022-02-10 16:44:43 +0800593 sprintf(proc_path, "/proc/%d/task", pid);
594 if (!(d = opendir(proc_path))) {
595 return false;
596 }
597
598 while ((de = readdir(d))) {
599 if (de->d_name[0] == '.') {
600 continue;
601 }
602
603 t_pid = atoi(de->d_name);
604
605 if (!t_pid) {
606 continue;
607 }
608
609 WriteValueToFile(value_, ProfileAction::RCT_TASK, uid, t_pid, logfailures_);
610 }
611
612 closedir(d);
613
614 return true;
Rick Yiud4c53512021-11-21 15:57:36 +0800615}
616
T.J. Mercier1c007992024-01-25 16:29:54 +0000617bool WriteFileAction::ExecuteForTask(pid_t tid) const {
Rick Yiu9221b1e2022-02-10 16:44:43 +0800618 return WriteValueToFile(value_, ProfileAction::RCT_TASK, getuid(), tid, logfailures_);
619}
Rick Yiubc1ad962020-10-26 20:32:52 +0800620
Rick Yiu9221b1e2022-02-10 16:44:43 +0800621void WriteFileAction::EnableResourceCaching(ResourceCacheType cache_type) {
622 std::lock_guard<std::mutex> lock(fd_mutex_);
623 if (fd_[cache_type] != FdCacheHelper::FDS_NOT_CACHED) {
624 return;
Rick Yiubc1ad962020-10-26 20:32:52 +0800625 }
Rick Yiu9221b1e2022-02-10 16:44:43 +0800626 switch (cache_type) {
627 case (ProfileAction::RCT_TASK):
628 FdCacheHelper::Cache(task_path_, fd_[cache_type]);
629 break;
630 case (ProfileAction::RCT_PROCESS):
631 if (!proc_path_.empty()) FdCacheHelper::Cache(proc_path_, fd_[cache_type]);
632 break;
633 default:
634 LOG(ERROR) << "Invalid cache type is specified!";
635 break;
636 }
Rick Yiubc1ad962020-10-26 20:32:52 +0800637}
638
Rick Yiu9221b1e2022-02-10 16:44:43 +0800639void WriteFileAction::DropResourceCaching(ResourceCacheType cache_type) {
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800640 std::lock_guard<std::mutex> lock(fd_mutex_);
Rick Yiu9221b1e2022-02-10 16:44:43 +0800641 FdCacheHelper::Drop(fd_[cache_type]);
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800642}
643
Suren Baghdasaryan8cacb612023-04-12 01:24:23 +0000644bool WriteFileAction::IsValidForProcess(uid_t, pid_t) const {
645 std::lock_guard<std::mutex> lock(fd_mutex_);
646 if (FdCacheHelper::IsCached(fd_[ProfileAction::RCT_PROCESS])) {
647 return true;
648 }
649
650 if (fd_[ProfileAction::RCT_PROCESS] == FdCacheHelper::FDS_INACCESSIBLE) {
651 return false;
652 }
653
654 return access(proc_path_.empty() ? task_path_.c_str() : proc_path_.c_str(), W_OK) == 0;
655}
656
657bool WriteFileAction::IsValidForTask(int) const {
658 std::lock_guard<std::mutex> lock(fd_mutex_);
659 if (FdCacheHelper::IsCached(fd_[ProfileAction::RCT_TASK])) {
660 return true;
661 }
662
663 if (fd_[ProfileAction::RCT_TASK] == FdCacheHelper::FDS_INACCESSIBLE) {
664 return false;
665 }
666
667 if (fd_[ProfileAction::RCT_TASK] == FdCacheHelper::FDS_APP_DEPENDENT) {
668 // application-dependent path can't be used with tid
669 return false;
670 }
671
672 return access(task_path_.c_str(), W_OK) == 0;
673}
674
Rick Yiu0b211fa2019-09-16 19:07:17 +0800675bool ApplyProfileAction::ExecuteForProcess(uid_t uid, pid_t pid) const {
676 for (const auto& profile : profiles_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800677 profile->ExecuteForProcess(uid, pid);
Rick Yiu0b211fa2019-09-16 19:07:17 +0800678 }
679 return true;
680}
681
T.J. Mercier1c007992024-01-25 16:29:54 +0000682bool ApplyProfileAction::ExecuteForTask(pid_t tid) const {
Rick Yiu0b211fa2019-09-16 19:07:17 +0800683 for (const auto& profile : profiles_) {
Wei Wang8722e4d2021-05-14 12:34:54 -0700684 profile->ExecuteForTask(tid);
Rick Yiu0b211fa2019-09-16 19:07:17 +0800685 }
686 return true;
687}
688
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800689void ApplyProfileAction::EnableResourceCaching(ResourceCacheType cache_type) {
Suren Baghdasaryan911109c2020-02-13 17:28:00 -0800690 for (const auto& profile : profiles_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800691 profile->EnableResourceCaching(cache_type);
Suren Baghdasaryan911109c2020-02-13 17:28:00 -0800692 }
693}
694
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800695void ApplyProfileAction::DropResourceCaching(ResourceCacheType cache_type) {
Suren Baghdasaryan911109c2020-02-13 17:28:00 -0800696 for (const auto& profile : profiles_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800697 profile->DropResourceCaching(cache_type);
Suren Baghdasaryan911109c2020-02-13 17:28:00 -0800698 }
699}
700
Suren Baghdasaryan8cacb612023-04-12 01:24:23 +0000701bool ApplyProfileAction::IsValidForProcess(uid_t uid, pid_t pid) const {
702 for (const auto& profile : profiles_) {
703 if (!profile->IsValidForProcess(uid, pid)) {
704 return false;
705 }
706 }
707 return true;
708}
709
T.J. Mercier1c007992024-01-25 16:29:54 +0000710bool ApplyProfileAction::IsValidForTask(pid_t tid) const {
Suren Baghdasaryan8cacb612023-04-12 01:24:23 +0000711 for (const auto& profile : profiles_) {
712 if (!profile->IsValidForTask(tid)) {
713 return false;
714 }
715 }
716 return true;
717}
718
Suren Baghdasaryan84385952020-01-24 16:36:10 -0800719void TaskProfile::MoveTo(TaskProfile* profile) {
720 profile->elements_ = std::move(elements_);
721 profile->res_cached_ = res_cached_;
722}
723
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800724bool TaskProfile::ExecuteForProcess(uid_t uid, pid_t pid) const {
725 for (const auto& element : elements_) {
726 if (!element->ExecuteForProcess(uid, pid)) {
Bart Van Asschef096bd22022-01-24 19:59:13 +0000727 LOG(VERBOSE) << "Applying profile action " << element->Name() << " failed";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800728 return false;
729 }
730 }
731 return true;
732}
733
T.J. Mercier1c007992024-01-25 16:29:54 +0000734bool TaskProfile::ExecuteForTask(pid_t tid) const {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800735 if (tid == 0) {
736 tid = GetThreadId();
737 }
738 for (const auto& element : elements_) {
739 if (!element->ExecuteForTask(tid)) {
Bart Van Asschef096bd22022-01-24 19:59:13 +0000740 LOG(VERBOSE) << "Applying profile action " << element->Name() << " failed";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800741 return false;
742 }
743 }
744 return true;
745}
746
T.J. Mercier5ed5e1b2022-08-22 21:25:09 +0000747bool TaskProfile::ExecuteForUID(uid_t uid) const {
748 for (const auto& element : elements_) {
749 if (!element->ExecuteForUID(uid)) {
750 LOG(VERBOSE) << "Applying profile action " << element->Name() << " failed";
751 return false;
752 }
753 }
754 return true;
755}
756
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800757void TaskProfile::EnableResourceCaching(ProfileAction::ResourceCacheType cache_type) {
Suren Baghdasaryan8a315d22019-02-14 14:40:41 -0800758 if (res_cached_) {
759 return;
760 }
761
762 for (auto& element : elements_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800763 element->EnableResourceCaching(cache_type);
Suren Baghdasaryan8a315d22019-02-14 14:40:41 -0800764 }
765
766 res_cached_ = true;
767}
768
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800769void TaskProfile::DropResourceCaching(ProfileAction::ResourceCacheType cache_type) {
Riddle Hsua6abd822019-06-18 15:53:53 -0600770 if (!res_cached_) {
771 return;
772 }
773
774 for (auto& element : elements_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800775 element->DropResourceCaching(cache_type);
Riddle Hsua6abd822019-06-18 15:53:53 -0600776 }
777
778 res_cached_ = false;
779}
780
Suren Baghdasaryan8cacb612023-04-12 01:24:23 +0000781bool TaskProfile::IsValidForProcess(uid_t uid, pid_t pid) const {
782 for (const auto& element : elements_) {
783 if (!element->IsValidForProcess(uid, pid)) return false;
784 }
785 return true;
786}
787
T.J. Mercier1c007992024-01-25 16:29:54 +0000788bool TaskProfile::IsValidForTask(pid_t tid) const {
Suren Baghdasaryan8cacb612023-04-12 01:24:23 +0000789 for (const auto& element : elements_) {
790 if (!element->IsValidForTask(tid)) return false;
791 }
792 return true;
793}
794
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800795void TaskProfiles::DropResourceCaching(ProfileAction::ResourceCacheType cache_type) const {
Riddle Hsua6abd822019-06-18 15:53:53 -0600796 for (auto& iter : profiles_) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800797 iter.second->DropResourceCaching(cache_type);
Riddle Hsua6abd822019-06-18 15:53:53 -0600798 }
799}
800
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800801TaskProfiles& TaskProfiles::GetInstance() {
Peter Collingbournedba6d442019-03-20 21:09:46 -0700802 // Deliberately leak this object to avoid a race between destruction on
803 // process exit and concurrent access from another thread.
804 static auto* instance = new TaskProfiles;
805 return *instance;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800806}
807
808TaskProfiles::TaskProfiles() {
Suren Baghdasaryan756a6042020-12-03 11:38:42 -0800809 // load system task profiles
810 if (!Load(CgroupMap::GetInstance(), TASK_PROFILE_DB_FILE)) {
811 LOG(ERROR) << "Loading " << TASK_PROFILE_DB_FILE << " for [" << getpid() << "] failed";
812 }
Suren Baghdasaryan35221b52020-11-20 17:08:51 -0800813
814 // load API-level specific system task profiles if available
Suren Baghdasaryan756a6042020-12-03 11:38:42 -0800815 unsigned int api_level = GetUintProperty<unsigned int>("ro.product.first_api_level", 0);
Suren Baghdasaryan35221b52020-11-20 17:08:51 -0800816 if (api_level > 0) {
817 std::string api_profiles_path =
818 android::base::StringPrintf(TEMPLATE_TASK_PROFILE_API_FILE, api_level);
819 if (!access(api_profiles_path.c_str(), F_OK) || errno != ENOENT) {
Suren Baghdasaryan756a6042020-12-03 11:38:42 -0800820 if (!Load(CgroupMap::GetInstance(), api_profiles_path)) {
Suren Baghdasaryanc2ee2e52022-01-20 10:58:43 -0800821 LOG(ERROR) << "Loading " << api_profiles_path << " for [" << getpid() << "] failed";
Suren Baghdasaryan756a6042020-12-03 11:38:42 -0800822 }
Suren Baghdasaryan35221b52020-11-20 17:08:51 -0800823 }
824 }
825
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800826 // load vendor task profiles if the file exists
827 if (!access(TASK_PROFILE_DB_VENDOR_FILE, F_OK) &&
828 !Load(CgroupMap::GetInstance(), TASK_PROFILE_DB_VENDOR_FILE)) {
829 LOG(ERROR) << "Loading " << TASK_PROFILE_DB_VENDOR_FILE << " for [" << getpid()
830 << "] failed";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800831 }
832}
833
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800834bool TaskProfiles::Load(const CgroupMap& cg_map, const std::string& file_name) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800835 std::string json_doc;
836
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800837 if (!android::base::ReadFileToString(file_name, &json_doc)) {
838 LOG(ERROR) << "Failed to read task profiles from " << file_name;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800839 return false;
840 }
841
Haibo Huangd9ac92a2021-02-24 17:34:50 -0800842 Json::CharReaderBuilder builder;
843 std::unique_ptr<Json::CharReader> reader(builder.newCharReader());
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800844 Json::Value root;
Haibo Huangd9ac92a2021-02-24 17:34:50 -0800845 std::string errorMessage;
846 if (!reader->parse(&*json_doc.begin(), &*json_doc.end(), &root, &errorMessage)) {
847 LOG(ERROR) << "Failed to parse task profiles: " << errorMessage;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800848 return false;
849 }
850
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800851 const Json::Value& attr = root["Attributes"];
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800852 for (Json::Value::ArrayIndex i = 0; i < attr.size(); ++i) {
853 std::string name = attr[i]["Name"].asString();
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800854 std::string controller_name = attr[i]["Controller"].asString();
855 std::string file_attr = attr[i]["File"].asString();
Bart Van Asschebc077ff2022-02-17 01:26:44 +0000856 std::string file_v2_attr = attr[i]["FileV2"].asString();
857
858 if (!file_v2_attr.empty() && file_attr.empty()) {
859 LOG(ERROR) << "Attribute " << name << " has FileV2 but no File property";
860 return false;
861 }
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800862
Suren Baghdasaryan81b9f0b2020-07-01 12:34:17 -0700863 auto controller = cg_map.FindController(controller_name);
864 if (controller.HasValue()) {
865 auto iter = attributes_.find(name);
866 if (iter == attributes_.end()) {
Bart Van Asschebc077ff2022-02-17 01:26:44 +0000867 attributes_[name] =
868 std::make_unique<ProfileAttribute>(controller, file_attr, file_v2_attr);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800869 } else {
Suren Baghdasaryan35078462023-07-25 14:50:18 -0700870 iter->second->Reset(controller, file_attr, file_v2_attr);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800871 }
872 } else {
Suren Baghdasaryan81b9f0b2020-07-01 12:34:17 -0700873 LOG(WARNING) << "Controller " << controller_name << " is not found";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800874 }
875 }
876
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800877 const Json::Value& profiles_val = root["Profiles"];
878 for (Json::Value::ArrayIndex i = 0; i < profiles_val.size(); ++i) {
879 const Json::Value& profile_val = profiles_val[i];
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800880
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800881 std::string profile_name = profile_val["Name"].asString();
882 const Json::Value& actions = profile_val["Actions"];
Bart Van Asschef096bd22022-01-24 19:59:13 +0000883 auto profile = std::make_shared<TaskProfile>(profile_name);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800884
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800885 for (Json::Value::ArrayIndex act_idx = 0; act_idx < actions.size(); ++act_idx) {
886 const Json::Value& action_val = actions[act_idx];
887 std::string action_name = action_val["Name"].asString();
888 const Json::Value& params_val = action_val["Params"];
889 if (action_name == "JoinCgroup") {
890 std::string controller_name = params_val["Controller"].asString();
891 std::string path = params_val["Path"].asString();
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800892
Yifan Hong53e0deb2019-03-22 17:01:08 -0700893 auto controller = cg_map.FindController(controller_name);
894 if (controller.HasValue()) {
Bart Van Assche2953a922023-11-14 07:33:00 -0800895 if (controller.version() == 1) {
896 profile->Add(std::make_unique<SetCgroupAction>(controller, path));
897 } else {
898 LOG(WARNING) << "A JoinCgroup action in the " << profile_name
899 << " profile is used for controller " << controller_name
900 << " in the cgroup v2 hierarchy and will be ignored";
901 }
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800902 } else {
Suren Baghdasaryan05da67c2019-02-19 15:01:28 -0800903 LOG(WARNING) << "JoinCgroup: controller " << controller_name << " is not found";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800904 }
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800905 } else if (action_name == "SetTimerSlack") {
906 std::string slack_value = params_val["Slack"].asString();
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800907 char* end;
908 unsigned long slack;
909
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800910 slack = strtoul(slack_value.c_str(), &end, 10);
911 if (end > slack_value.c_str()) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800912 profile->Add(std::make_unique<SetTimerSlackAction>(slack));
913 } else {
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800914 LOG(WARNING) << "SetTimerSlack: invalid parameter: " << slack_value;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800915 }
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800916 } else if (action_name == "SetAttribute") {
917 std::string attr_name = params_val["Name"].asString();
918 std::string attr_value = params_val["Value"].asString();
Bart Van Assche59af6802022-01-24 21:08:57 +0000919 bool optional = strcmp(params_val["Optional"].asString().c_str(), "true") == 0;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800920
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800921 auto iter = attributes_.find(attr_name);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800922 if (iter != attributes_.end()) {
Bart Van Assche59af6802022-01-24 21:08:57 +0000923 profile->Add(std::make_unique<SetAttributeAction>(iter->second.get(),
924 attr_value, optional));
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800925 } else {
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800926 LOG(WARNING) << "SetAttribute: unknown attribute: " << attr_name;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800927 }
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800928 } else if (action_name == "SetClamps") {
929 std::string boost_value = params_val["Boost"].asString();
930 std::string clamp_value = params_val["Clamp"].asString();
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800931 char* end;
932 unsigned long boost;
933
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800934 boost = strtoul(boost_value.c_str(), &end, 10);
935 if (end > boost_value.c_str()) {
936 unsigned long clamp = strtoul(clamp_value.c_str(), &end, 10);
937 if (end > clamp_value.c_str()) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800938 profile->Add(std::make_unique<SetClampsAction>(boost, clamp));
939 } else {
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800940 LOG(WARNING) << "SetClamps: invalid parameter " << clamp_value;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800941 }
942 } else {
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800943 LOG(WARNING) << "SetClamps: invalid parameter: " << boost_value;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800944 }
Rick Yiubc1ad962020-10-26 20:32:52 +0800945 } else if (action_name == "WriteFile") {
946 std::string attr_filepath = params_val["FilePath"].asString();
Rick Yiu9221b1e2022-02-10 16:44:43 +0800947 std::string attr_procfilepath = params_val["ProcFilePath"].asString();
Rick Yiubc1ad962020-10-26 20:32:52 +0800948 std::string attr_value = params_val["Value"].asString();
Rick Yiu9221b1e2022-02-10 16:44:43 +0800949 // FilePath and Value are mandatory
Rick Yiubc1ad962020-10-26 20:32:52 +0800950 if (!attr_filepath.empty() && !attr_value.empty()) {
Rick Yiu49fce952021-04-08 22:10:06 +0800951 std::string attr_logfailures = params_val["LogFailures"].asString();
952 bool logfailures = attr_logfailures.empty() || attr_logfailures == "true";
Rick Yiu9221b1e2022-02-10 16:44:43 +0800953 profile->Add(std::make_unique<WriteFileAction>(attr_filepath, attr_procfilepath,
954 attr_value, logfailures));
Rick Yiubc1ad962020-10-26 20:32:52 +0800955 } else if (attr_filepath.empty()) {
956 LOG(WARNING) << "WriteFile: invalid parameter: "
957 << "empty filepath";
958 } else if (attr_value.empty()) {
959 LOG(WARNING) << "WriteFile: invalid parameter: "
960 << "empty value";
961 }
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800962 } else {
Suren Baghdasaryane681df42019-02-20 16:17:22 -0800963 LOG(WARNING) << "Unknown profile action: " << action_name;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800964 }
965 }
Suren Baghdasaryan84385952020-01-24 16:36:10 -0800966 auto iter = profiles_.find(profile_name);
967 if (iter == profiles_.end()) {
968 profiles_[profile_name] = profile;
969 } else {
970 // Move the content rather that replace the profile because old profile might be
971 // referenced from an aggregate profile if vendor overrides task profiles
972 profile->MoveTo(iter->second.get());
973 profile.reset();
974 }
Rick Yiu0b211fa2019-09-16 19:07:17 +0800975 }
976
977 const Json::Value& aggregateprofiles_val = root["AggregateProfiles"];
978 for (Json::Value::ArrayIndex i = 0; i < aggregateprofiles_val.size(); ++i) {
979 const Json::Value& aggregateprofile_val = aggregateprofiles_val[i];
980
981 std::string aggregateprofile_name = aggregateprofile_val["Name"].asString();
982 const Json::Value& aggregateprofiles = aggregateprofile_val["Profiles"];
983 std::vector<std::shared_ptr<TaskProfile>> profiles;
984 bool ret = true;
985
986 for (Json::Value::ArrayIndex pf_idx = 0; pf_idx < aggregateprofiles.size(); ++pf_idx) {
987 std::string profile_name = aggregateprofiles[pf_idx].asString();
988
989 if (profile_name == aggregateprofile_name) {
990 LOG(WARNING) << "AggregateProfiles: recursive profile name: " << profile_name;
991 ret = false;
992 break;
993 } else if (profiles_.find(profile_name) == profiles_.end()) {
994 LOG(WARNING) << "AggregateProfiles: undefined profile name: " << profile_name;
995 ret = false;
996 break;
997 } else {
998 profiles.push_back(profiles_[profile_name]);
999 }
1000 }
1001 if (ret) {
Bart Van Asschef096bd22022-01-24 19:59:13 +00001002 auto profile = std::make_shared<TaskProfile>(aggregateprofile_name);
Rick Yiu0b211fa2019-09-16 19:07:17 +08001003 profile->Add(std::make_unique<ApplyProfileAction>(profiles));
1004 profiles_[aggregateprofile_name] = profile;
1005 }
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -08001006 }
1007
1008 return true;
1009}
1010
Bart Van Assched0b8ce22022-08-02 13:06:26 -07001011TaskProfile* TaskProfiles::GetProfile(std::string_view name) const {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -08001012 auto iter = profiles_.find(name);
1013
1014 if (iter != profiles_.end()) {
1015 return iter->second.get();
1016 }
1017 return nullptr;
1018}
1019
Bart Van Assched0b8ce22022-08-02 13:06:26 -07001020const IProfileAttribute* TaskProfiles::GetAttribute(std::string_view name) const {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -08001021 auto iter = attributes_.find(name);
1022
1023 if (iter != attributes_.end()) {
1024 return iter->second.get();
1025 }
1026 return nullptr;
1027}
Rick Yiu0b211fa2019-09-16 19:07:17 +08001028
Bart Van Asschef32c4ec2022-08-02 13:18:12 -07001029template <typename T>
T.J. Mercier5ed5e1b2022-08-22 21:25:09 +00001030bool TaskProfiles::SetUserProfiles(uid_t uid, std::span<const T> profiles, bool use_fd_cache) {
1031 for (const auto& name : profiles) {
1032 TaskProfile* profile = GetProfile(name);
1033 if (profile != nullptr) {
1034 if (use_fd_cache) {
1035 profile->EnableResourceCaching(ProfileAction::RCT_PROCESS);
1036 }
1037 if (!profile->ExecuteForUID(uid)) {
1038 PLOG(WARNING) << "Failed to apply " << name << " process profile";
1039 }
1040 } else {
1041 PLOG(WARNING) << "Failed to find " << name << "process profile";
1042 }
1043 }
1044 return true;
1045}
1046
1047template <typename T>
Bart Van Asschef32c4ec2022-08-02 13:18:12 -07001048bool TaskProfiles::SetProcessProfiles(uid_t uid, pid_t pid, std::span<const T> profiles,
1049 bool use_fd_cache) {
Inseob Kim538fc1f2022-04-13 18:50:12 +00001050 bool success = true;
Rick Yiu0b211fa2019-09-16 19:07:17 +08001051 for (const auto& name : profiles) {
1052 TaskProfile* profile = GetProfile(name);
1053 if (profile != nullptr) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -08001054 if (use_fd_cache) {
1055 profile->EnableResourceCaching(ProfileAction::RCT_PROCESS);
1056 }
Rick Yiu0b211fa2019-09-16 19:07:17 +08001057 if (!profile->ExecuteForProcess(uid, pid)) {
Krzysztof Kosiński0310ec42023-03-01 04:17:57 +00001058 LOG(WARNING) << "Failed to apply " << name << " process profile";
Inseob Kim538fc1f2022-04-13 18:50:12 +00001059 success = false;
Rick Yiu0b211fa2019-09-16 19:07:17 +08001060 }
1061 } else {
Krzysztof Kosiński0310ec42023-03-01 04:17:57 +00001062 LOG(WARNING) << "Failed to find " << name << " process profile";
Inseob Kim538fc1f2022-04-13 18:50:12 +00001063 success = false;
Rick Yiu0b211fa2019-09-16 19:07:17 +08001064 }
1065 }
Inseob Kim538fc1f2022-04-13 18:50:12 +00001066 return success;
Rick Yiu0b211fa2019-09-16 19:07:17 +08001067}
1068
Bart Van Asschef32c4ec2022-08-02 13:18:12 -07001069template <typename T>
T.J. Mercier1c007992024-01-25 16:29:54 +00001070bool TaskProfiles::SetTaskProfiles(pid_t tid, std::span<const T> profiles, bool use_fd_cache) {
Inseob Kim538fc1f2022-04-13 18:50:12 +00001071 bool success = true;
Rick Yiu0b211fa2019-09-16 19:07:17 +08001072 for (const auto& name : profiles) {
1073 TaskProfile* profile = GetProfile(name);
1074 if (profile != nullptr) {
1075 if (use_fd_cache) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -08001076 profile->EnableResourceCaching(ProfileAction::RCT_TASK);
Rick Yiu0b211fa2019-09-16 19:07:17 +08001077 }
1078 if (!profile->ExecuteForTask(tid)) {
Krzysztof Kosiński0310ec42023-03-01 04:17:57 +00001079 LOG(WARNING) << "Failed to apply " << name << " task profile";
Inseob Kim538fc1f2022-04-13 18:50:12 +00001080 success = false;
Rick Yiu0b211fa2019-09-16 19:07:17 +08001081 }
1082 } else {
Krzysztof Kosiński0310ec42023-03-01 04:17:57 +00001083 LOG(WARNING) << "Failed to find " << name << " task profile";
Inseob Kim538fc1f2022-04-13 18:50:12 +00001084 success = false;
Rick Yiu0b211fa2019-09-16 19:07:17 +08001085 }
1086 }
Inseob Kim538fc1f2022-04-13 18:50:12 +00001087 return success;
Rick Yiu0b211fa2019-09-16 19:07:17 +08001088}
Bart Van Asschef32c4ec2022-08-02 13:18:12 -07001089
1090template bool TaskProfiles::SetProcessProfiles(uid_t uid, pid_t pid,
1091 std::span<const std::string> profiles,
1092 bool use_fd_cache);
1093template bool TaskProfiles::SetProcessProfiles(uid_t uid, pid_t pid,
1094 std::span<const std::string_view> profiles,
1095 bool use_fd_cache);
T.J. Mercier1c007992024-01-25 16:29:54 +00001096template bool TaskProfiles::SetTaskProfiles(pid_t tid, std::span<const std::string> profiles,
Bart Van Asschef32c4ec2022-08-02 13:18:12 -07001097 bool use_fd_cache);
T.J. Mercier1c007992024-01-25 16:29:54 +00001098template bool TaskProfiles::SetTaskProfiles(pid_t tid, std::span<const std::string_view> profiles,
Bart Van Asschef32c4ec2022-08-02 13:18:12 -07001099 bool use_fd_cache);
T.J. Mercier5ed5e1b2022-08-22 21:25:09 +00001100template bool TaskProfiles::SetUserProfiles(uid_t uid, std::span<const std::string> profiles,
1101 bool use_fd_cache);