blob: 4b49d09af474c10fc18709b26da5a45d878f361b [file] [log] [blame]
Colin Crosscf8d1c22014-06-03 13:24:21 -07001/*
2 * Copyright 2014 Google, Inc
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17//#define LOG_NDEBUG 0
18#define LOG_TAG "libprocessgroup"
19
20#include <assert.h>
21#include <dirent.h>
Elliott Hughes0badbd62014-12-29 12:24:25 -080022#include <errno.h>
Colin Crosscf8d1c22014-06-03 13:24:21 -070023#include <fcntl.h>
Chih-Hung Hsiehfcc81152014-11-20 17:05:15 -080024#include <inttypes.h>
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +000025#include <poll.h>
Tom Cherry574a0812018-02-23 13:04:40 -080026#include <signal.h>
Colin Crosscf8d1c22014-06-03 13:24:21 -070027#include <stdio.h>
28#include <stdlib.h>
Colin Crosscf8d1c22014-06-03 13:24:21 -070029#include <sys/stat.h>
30#include <sys/types.h>
Tom Cherry70a5ed42017-06-05 19:20:17 -070031#include <unistd.h>
Collin Mullinerf7e79b92016-06-01 21:03:55 +000032
33#include <chrono>
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +000034#include <cstring>
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -080035#include <map>
James Hawkins588a2ca2016-02-18 14:52:46 -080036#include <memory>
Elliott Hughes8d532e42016-06-06 21:19:55 -070037#include <mutex>
Tom Cherry70a5ed42017-06-05 19:20:17 -070038#include <set>
Tom Cherry574a0812018-02-23 13:04:40 -080039#include <string>
Elliott Hughes290a2282016-11-14 17:08:47 -080040#include <thread>
Colin Crosscf8d1c22014-06-03 13:24:21 -070041
Robert Benead4852262017-07-16 19:38:11 -070042#include <android-base/file.h>
Elliott Hughes171df0a2016-08-02 13:30:30 -070043#include <android-base/logging.h>
Suren Baghdasaryanbc131c32018-05-23 12:30:44 -070044#include <android-base/properties.h>
Tom Cherry574a0812018-02-23 13:04:40 -080045#include <android-base/stringprintf.h>
46#include <android-base/strings.h>
Suren Baghdasaryan7bf43812019-01-25 05:29:55 +000047#include <cutils/android_filesystem_config.h>
Colin Crosscf8d1c22014-06-03 13:24:21 -070048#include <processgroup/processgroup.h>
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -080049#include <task_profiles.h>
Martijn Coenenb82bab62016-01-20 16:39:16 -080050
Suren Baghdasaryanbc131c32018-05-23 12:30:44 -070051using android::base::GetBoolProperty;
Tom Cherry574a0812018-02-23 13:04:40 -080052using android::base::StartsWith;
53using android::base::StringPrintf;
Robert Benead4852262017-07-16 19:38:11 -070054using android::base::WriteStringToFile;
55
Elliott Hughes290a2282016-11-14 17:08:47 -080056using namespace std::chrono_literals;
57
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +000058#define PROCESSGROUP_CGROUP_PROCS_FILE "cgroup.procs"
T.J. Mercier38b8bb12023-11-07 14:36:46 +000059#define PROCESSGROUP_CGROUP_KILL_FILE "cgroup.kill"
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +000060#define PROCESSGROUP_CGROUP_EVENTS_FILE "cgroup.events"
Martijn Coenenb82bab62016-01-20 16:39:16 -080061
Nikita Ioffec2b16542022-10-20 14:14:39 +010062bool CgroupsAvailable() {
63 static bool cgroups_available = access("/proc/cgroups", F_OK) == 0;
64 return cgroups_available;
65}
66
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -080067bool CgroupGetControllerPath(const std::string& cgroup_name, std::string* path) {
Yifan Hong53e0deb2019-03-22 17:01:08 -070068 auto controller = CgroupMap::GetInstance().FindController(cgroup_name);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -080069
Yifan Hong53e0deb2019-03-22 17:01:08 -070070 if (!controller.HasValue()) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -080071 return false;
72 }
73
74 if (path) {
Yifan Hong53e0deb2019-03-22 17:01:08 -070075 *path = controller.path();
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -080076 }
77
78 return true;
79}
80
T.J. Mercier38b8bb12023-11-07 14:36:46 +000081static std::string ConvertUidToPath(const char* cgroup, uid_t uid) {
82 return StringPrintf("%s/uid_%u", cgroup, uid);
83}
84
85static std::string ConvertUidPidToPath(const char* cgroup, uid_t uid, int pid) {
86 return StringPrintf("%s/uid_%u/pid_%d", cgroup, uid, pid);
87}
88
89static bool CgroupKillAvailable() {
90 static std::once_flag f;
91 static bool cgroup_kill_available = false;
92 std::call_once(f, []() {
93 std::string cg_kill;
94 CgroupGetControllerPath(CGROUPV2_HIERARCHY_NAME, &cg_kill);
95 // cgroup.kill is not on the root cgroup, so check a non-root cgroup that should always
96 // exist
97 cg_kill = ConvertUidToPath(cg_kill.c_str(), AID_ROOT) + '/' + PROCESSGROUP_CGROUP_KILL_FILE;
98 cgroup_kill_available = access(cg_kill.c_str(), F_OK) == 0;
99 });
100
101 return cgroup_kill_available;
102}
103
Bart Van Assche4c957122022-02-04 18:19:45 +0000104static bool CgroupGetMemcgAppsPath(std::string* path) {
105 CgroupController controller = CgroupMap::GetInstance().FindController("memory");
106
107 if (!controller.HasValue()) {
108 return false;
109 }
110
111 if (path) {
112 *path = controller.path();
113 if (controller.version() == 1) {
114 *path += "/apps";
115 }
116 }
117
118 return true;
119}
120
Suren Baghdasaryan9e3ace52021-06-16 17:01:19 -0700121bool CgroupGetControllerFromPath(const std::string& path, std::string* cgroup_name) {
122 auto controller = CgroupMap::GetInstance().FindControllerByPath(path);
123
124 if (!controller.HasValue()) {
125 return false;
126 }
127
128 if (cgroup_name) {
129 *cgroup_name = controller.name();
130 }
131
132 return true;
133}
134
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800135bool CgroupGetAttributePath(const std::string& attr_name, std::string* path) {
136 const TaskProfiles& tp = TaskProfiles::GetInstance();
Bart Van Assche4c99e962022-02-03 19:50:16 +0000137 const IProfileAttribute* attr = tp.GetAttribute(attr_name);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800138
139 if (attr == nullptr) {
140 return false;
141 }
142
143 if (path) {
144 *path = StringPrintf("%s/%s", attr->controller()->path(), attr->file_name().c_str());
145 }
146
147 return true;
148}
149
150bool CgroupGetAttributePathForTask(const std::string& attr_name, int tid, std::string* path) {
151 const TaskProfiles& tp = TaskProfiles::GetInstance();
Bart Van Assche4c99e962022-02-03 19:50:16 +0000152 const IProfileAttribute* attr = tp.GetAttribute(attr_name);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800153
154 if (attr == nullptr) {
155 return false;
156 }
157
158 if (!attr->GetPathForTask(tid, path)) {
T.J. Mercier4d0d2852023-10-27 23:44:03 +0000159 LOG(ERROR) << "Failed to find cgroup for tid " << tid;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800160 return false;
161 }
162
163 return true;
164}
165
166bool UsePerAppMemcg() {
167 bool low_ram_device = GetBoolProperty("ro.config.low_ram", false);
168 return GetBoolProperty("ro.config.per_app_memcg", low_ram_device);
169}
170
Peter Collingbourned7157c22018-10-30 15:49:33 -0700171static bool isMemoryCgroupSupported() {
Suren Baghdasaryanfa7a05f2019-05-08 17:59:55 -0700172 static bool memcg_supported = CgroupMap::GetInstance().FindController("memory").IsUsable();
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800173
Peter Collingbourned7157c22018-10-30 15:49:33 -0700174 return memcg_supported;
Martijn Coenenb82bab62016-01-20 16:39:16 -0800175}
176
Riddle Hsua6abd822019-06-18 15:53:53 -0600177void DropTaskProfilesResourceCaching() {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800178 TaskProfiles::GetInstance().DropResourceCaching(ProfileAction::RCT_TASK);
179 TaskProfiles::GetInstance().DropResourceCaching(ProfileAction::RCT_PROCESS);
Riddle Hsua6abd822019-06-18 15:53:53 -0600180}
181
Suren Baghdasaryan911109c2020-02-13 17:28:00 -0800182bool SetProcessProfiles(uid_t uid, pid_t pid, const std::vector<std::string>& profiles) {
Bart Van Asschef32c4ec2022-08-02 13:18:12 -0700183 return TaskProfiles::GetInstance().SetProcessProfiles(
184 uid, pid, std::span<const std::string>(profiles), false);
185}
186
187bool SetProcessProfiles(uid_t uid, pid_t pid, std::initializer_list<std::string_view> profiles) {
188 return TaskProfiles::GetInstance().SetProcessProfiles(
189 uid, pid, std::span<const std::string_view>(profiles), false);
190}
191
192bool SetProcessProfiles(uid_t uid, pid_t pid, std::span<const std::string_view> profiles) {
Suren Baghdasaryanf3bdac72022-01-20 15:41:28 -0800193 return TaskProfiles::GetInstance().SetProcessProfiles(uid, pid, profiles, false);
194}
195
196bool SetProcessProfilesCached(uid_t uid, pid_t pid, const std::vector<std::string>& profiles) {
Bart Van Asschef32c4ec2022-08-02 13:18:12 -0700197 return TaskProfiles::GetInstance().SetProcessProfiles(
198 uid, pid, std::span<const std::string>(profiles), true);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800199}
200
Suren Baghdasaryan8a315d22019-02-14 14:40:41 -0800201bool SetTaskProfiles(int tid, const std::vector<std::string>& profiles, bool use_fd_cache) {
Bart Van Asschef32c4ec2022-08-02 13:18:12 -0700202 return TaskProfiles::GetInstance().SetTaskProfiles(tid, std::span<const std::string>(profiles),
203 use_fd_cache);
204}
205
206bool SetTaskProfiles(int tid, std::initializer_list<std::string_view> profiles, bool use_fd_cache) {
207 return TaskProfiles::GetInstance().SetTaskProfiles(
208 tid, std::span<const std::string_view>(profiles), use_fd_cache);
209}
210
211bool SetTaskProfiles(int tid, std::span<const std::string_view> profiles, bool use_fd_cache) {
Rick Yiu0b211fa2019-09-16 19:07:17 +0800212 return TaskProfiles::GetInstance().SetTaskProfiles(tid, profiles, use_fd_cache);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800213}
214
Jiyong Park8bf59402022-04-01 12:24:22 +0900215// C wrapper for SetProcessProfiles.
216// No need to have this in the header file because this function is specifically for crosvm. Crosvm
217// which is written in Rust has its own declaration of this foreign function and doesn't rely on the
218// header. See
219// https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3574427/5/src/linux/android.rs#12
220extern "C" bool android_set_process_profiles(uid_t uid, pid_t pid, size_t num_profiles,
221 const char* profiles[]) {
Bart Van Asschef32c4ec2022-08-02 13:18:12 -0700222 std::vector<std::string_view> profiles_;
Jiyong Parkcc9932b2022-04-20 17:11:42 +0900223 profiles_.reserve(num_profiles);
Jiyong Park8bf59402022-04-01 12:24:22 +0900224 for (size_t i = 0; i < num_profiles; i++) {
225 profiles_.emplace_back(profiles[i]);
226 }
Bart Van Asschef32c4ec2022-08-02 13:18:12 -0700227 return SetProcessProfiles(uid, pid, std::span<const std::string_view>(profiles_));
Jiyong Park8bf59402022-04-01 12:24:22 +0900228}
229
T.J. Mercier5ed5e1b2022-08-22 21:25:09 +0000230bool SetUserProfiles(uid_t uid, const std::vector<std::string>& profiles) {
231 return TaskProfiles::GetInstance().SetUserProfiles(uid, std::span<const std::string>(profiles),
232 false);
233}
234
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000235static int RemoveCgroup(const char* cgroup, uid_t uid, int pid) {
236 auto path = ConvertUidPidToPath(cgroup, uid, pid);
237 int ret = TEMP_FAILURE_RETRY(rmdir(path.c_str()));
Marco Ballesio4dac8162021-02-10 16:35:44 -0800238
T.J. Mercier9c8c7482023-07-12 18:18:42 +0000239 if (!ret && uid >= AID_ISOLATED_START && uid <= AID_ISOLATED_END) {
240 // Isolated UIDs are unlikely to be reused soon after removal,
241 // so free up the kernel resources for the UID level cgroup.
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000242 path = ConvertUidToPath(cgroup, uid);
243 ret = TEMP_FAILURE_RETRY(rmdir(path.c_str()));
244 }
245
246 if (ret < 0 && errno == ENOENT) {
247 // This function is idempoetent, but still warn here.
248 LOG(WARNING) << "RemoveCgroup: " << path << " does not exist.";
249 ret = 0;
T.J. Mercier9c8c7482023-07-12 18:18:42 +0000250 }
251
Colin Crosscf8d1c22014-06-03 13:24:21 -0700252 return ret;
253}
254
Bart Van Assche30488122023-11-15 09:11:20 -0800255static bool RemoveEmptyUidCgroups(const std::string& uid_path) {
Tom Cherry574a0812018-02-23 13:04:40 -0800256 std::unique_ptr<DIR, decltype(&closedir)> uid(opendir(uid_path.c_str()), closedir);
Wei Wang858f3e52019-02-21 11:25:16 -0800257 bool empty = true;
Colin Crosscf8d1c22014-06-03 13:24:21 -0700258 if (uid != NULL) {
Elliott Hughes9f206932016-09-28 13:29:54 -0700259 dirent* dir;
260 while ((dir = readdir(uid.get())) != nullptr) {
Colin Crosscf8d1c22014-06-03 13:24:21 -0700261 if (dir->d_type != DT_DIR) {
262 continue;
263 }
264
Tom Cherry574a0812018-02-23 13:04:40 -0800265 if (!StartsWith(dir->d_name, "pid_")) {
Colin Crosscf8d1c22014-06-03 13:24:21 -0700266 continue;
267 }
268
Tom Cherry574a0812018-02-23 13:04:40 -0800269 auto path = StringPrintf("%s/%s", uid_path.c_str(), dir->d_name);
Tom Cherry20514c42017-04-21 13:48:49 -0700270 LOG(VERBOSE) << "Removing " << path;
Wei Wang858f3e52019-02-21 11:25:16 -0800271 if (rmdir(path.c_str()) == -1) {
272 if (errno != EBUSY) {
273 PLOG(WARNING) << "Failed to remove " << path;
274 }
275 empty = false;
276 }
Colin Crosscf8d1c22014-06-03 13:24:21 -0700277 }
278 }
Wei Wang858f3e52019-02-21 11:25:16 -0800279 return empty;
Colin Crosscf8d1c22014-06-03 13:24:21 -0700280}
281
Bart Van Assche30488122023-11-15 09:11:20 -0800282void removeAllEmptyProcessGroups() {
283 LOG(VERBOSE) << "removeAllEmptyProcessGroups()";
284
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800285 std::vector<std::string> cgroups;
Bart Van Assche4c957122022-02-04 18:19:45 +0000286 std::string path, memcg_apps_path;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800287
T.J. Merciera99e7d82023-10-27 17:29:01 +0000288 if (CgroupGetControllerPath(CGROUPV2_HIERARCHY_NAME, &path)) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800289 cgroups.push_back(path);
290 }
Bart Van Assche4c957122022-02-04 18:19:45 +0000291 if (CgroupGetMemcgAppsPath(&memcg_apps_path) && memcg_apps_path != path) {
292 cgroups.push_back(memcg_apps_path);
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800293 }
294
295 for (std::string cgroup_root_path : cgroups) {
296 std::unique_ptr<DIR, decltype(&closedir)> root(opendir(cgroup_root_path.c_str()), closedir);
Peter Collingbourned7157c22018-10-30 15:49:33 -0700297 if (root == NULL) {
Bart Van Assche6e814b02022-02-03 19:24:42 +0000298 PLOG(ERROR) << __func__ << " failed to open " << cgroup_root_path;
Peter Collingbourned7157c22018-10-30 15:49:33 -0700299 } else {
300 dirent* dir;
301 while ((dir = readdir(root.get())) != nullptr) {
302 if (dir->d_type != DT_DIR) {
303 continue;
304 }
Tom Cherry574a0812018-02-23 13:04:40 -0800305
Peter Collingbourned7157c22018-10-30 15:49:33 -0700306 if (!StartsWith(dir->d_name, "uid_")) {
307 continue;
308 }
Colin Crosscf8d1c22014-06-03 13:24:21 -0700309
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800310 auto path = StringPrintf("%s/%s", cgroup_root_path.c_str(), dir->d_name);
Bart Van Assche30488122023-11-15 09:11:20 -0800311 if (!RemoveEmptyUidCgroups(path)) {
Wei Wang858f3e52019-02-21 11:25:16 -0800312 LOG(VERBOSE) << "Skip removing " << path;
313 continue;
314 }
Peter Collingbourned7157c22018-10-30 15:49:33 -0700315 LOG(VERBOSE) << "Removing " << path;
Wei Wang858f3e52019-02-21 11:25:16 -0800316 if (rmdir(path.c_str()) == -1 && errno != EBUSY) {
317 PLOG(WARNING) << "Failed to remove " << path;
318 }
Peter Collingbourned7157c22018-10-30 15:49:33 -0700319 }
Colin Crosscf8d1c22014-06-03 13:24:21 -0700320 }
Colin Crosscf8d1c22014-06-03 13:24:21 -0700321 }
322}
323
Marco Ballesio4dac8162021-02-10 16:35:44 -0800324/**
325 * Process groups are primarily created by the Zygote, meaning that uid/pid groups are created by
326 * the user root. Ownership for the newly created cgroup and all of its files must thus be
327 * transferred for the user/group passed as uid/gid before system_server can properly access them.
328 */
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800329static bool MkdirAndChown(const std::string& path, mode_t mode, uid_t uid, gid_t gid) {
Suren Baghdasaryan29c9e262021-07-07 10:59:59 -0700330 if (mkdir(path.c_str(), mode) == -1) {
331 if (errno == EEXIST) {
332 // Directory already exists and permissions have been set at the time it was created
333 return true;
334 }
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800335 return false;
336 }
337
Marco Ballesio4dac8162021-02-10 16:35:44 -0800338 auto dir = std::unique_ptr<DIR, decltype(&closedir)>(opendir(path.c_str()), closedir);
339
340 if (dir == NULL) {
341 PLOG(ERROR) << "opendir failed for " << path;
342 goto err;
343 }
344
345 struct dirent* dir_entry;
346 while ((dir_entry = readdir(dir.get()))) {
347 if (!strcmp("..", dir_entry->d_name)) {
348 continue;
349 }
350
351 std::string file_path = path + "/" + dir_entry->d_name;
352
353 if (lchown(file_path.c_str(), uid, gid) < 0) {
354 PLOG(ERROR) << "lchown failed for " << file_path;
355 goto err;
356 }
357
358 if (fchmodat(AT_FDCWD, file_path.c_str(), mode, AT_SYMLINK_NOFOLLOW) != 0) {
359 PLOG(ERROR) << "fchmodat failed for " << file_path;
360 goto err;
361 }
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800362 }
363
364 return true;
Marco Ballesio4dac8162021-02-10 16:35:44 -0800365err:
366 int saved_errno = errno;
367 rmdir(path.c_str());
368 errno = saved_errno;
369
370 return false;
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800371}
372
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000373bool sendSignalToProcessGroup(uid_t uid, int initialPid, int signal) {
374 std::set<pid_t> pgids, pids;
Inseob Kima049a992022-11-17 23:42:12 +0900375
376 if (CgroupsAvailable()) {
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000377 std::string hierarchy_root_path, cgroup_v2_path;
378 CgroupGetControllerPath(CGROUPV2_HIERARCHY_NAME, &hierarchy_root_path);
379 cgroup_v2_path = ConvertUidPidToPath(hierarchy_root_path.c_str(), uid, initialPid);
380
T.J. Mercier38b8bb12023-11-07 14:36:46 +0000381 if (signal == SIGKILL && CgroupKillAvailable()) {
382 LOG(VERBOSE) << "Using " << PROCESSGROUP_CGROUP_KILL_FILE << " to SIGKILL "
383 << cgroup_v2_path;
384 const std::string killfilepath = cgroup_v2_path + '/' + PROCESSGROUP_CGROUP_KILL_FILE;
385 if (WriteStringToFile("1", killfilepath)) {
386 return true;
387 } else {
388 PLOG(ERROR) << "Failed to write 1 to " << killfilepath;
389 // Fallback to cgroup.procs below
390 }
391 }
392
393 // Since cgroup.kill only sends SIGKILLs, we read cgroup.procs to find each process to
394 // signal individually. This is more costly than using cgroup.kill for SIGKILLs.
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000395 LOG(VERBOSE) << "Using " << PROCESSGROUP_CGROUP_PROCS_FILE << " to signal (" << signal
396 << ") " << cgroup_v2_path;
397
398 // We separate all of the pids in the cgroup into those pids that are also the leaders of
399 // process groups (stored in the pgids set) and those that are not (stored in the pids set).
400 const auto procsfilepath = cgroup_v2_path + '/' + PROCESSGROUP_CGROUP_PROCS_FILE;
401 std::unique_ptr<FILE, decltype(&fclose)> fp(fopen(procsfilepath.c_str(), "re"), fclose);
402 if (!fp) {
403 // This should only happen if the cgroup has already been removed with a successful call
404 // to killProcessGroup. Callers should only retry sendSignalToProcessGroup or
405 // killProcessGroup calls if they fail without ENOENT.
406 PLOG(ERROR) << "Failed to open " << procsfilepath;
407 kill(-initialPid, signal);
408 return false;
Inseob Kima049a992022-11-17 23:42:12 +0900409 }
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000410
Inseob Kima049a992022-11-17 23:42:12 +0900411 pid_t pid;
412 bool file_is_empty = true;
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000413 while (fscanf(fp.get(), "%d\n", &pid) == 1 && pid >= 0) {
Inseob Kima049a992022-11-17 23:42:12 +0900414 file_is_empty = false;
415 if (pid == 0) {
416 // Should never happen... but if it does, trying to kill this
417 // will boomerang right back and kill us! Let's not let that happen.
418 LOG(WARNING)
419 << "Yikes, we've been told to kill pid 0! How about we don't do that?";
420 continue;
421 }
422 pid_t pgid = getpgid(pid);
423 if (pgid == -1) PLOG(ERROR) << "getpgid(" << pid << ") failed";
424 if (pgid == pid) {
425 pgids.emplace(pid);
426 } else {
427 pids.emplace(pid);
428 }
429 }
Jing Ji304c0f12023-02-27 21:58:19 -0800430 if (!file_is_empty) {
431 // Erase all pids that will be killed when we kill the process groups.
432 for (auto it = pids.begin(); it != pids.end();) {
433 pid_t pgid = getpgid(*it);
434 if (pgids.count(pgid) == 1) {
435 it = pids.erase(it);
436 } else {
437 ++it;
438 }
Inseob Kima049a992022-11-17 23:42:12 +0900439 }
440 }
441 }
442
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000443 pgids.emplace(initialPid);
444
Tom Cherry70a5ed42017-06-05 19:20:17 -0700445 // Kill all process groups.
446 for (const auto pgid : pgids) {
447 LOG(VERBOSE) << "Killing process group " << -pgid << " in uid " << uid
448 << " as part of process cgroup " << initialPid;
449
Suren Baghdasaryan4f7cc8c2023-03-02 14:12:49 -0800450 if (kill(-pgid, signal) == -1 && errno != ESRCH) {
Tom Cherry70a5ed42017-06-05 19:20:17 -0700451 PLOG(WARNING) << "kill(" << -pgid << ", " << signal << ") failed";
452 }
453 }
454
455 // Kill remaining pids.
456 for (const auto pid : pids) {
Tom Cherry20514c42017-04-21 13:48:49 -0700457 LOG(VERBOSE) << "Killing pid " << pid << " in uid " << uid << " as part of process cgroup "
458 << initialPid;
Tom Cherry70a5ed42017-06-05 19:20:17 -0700459
Suren Baghdasaryan4f7cc8c2023-03-02 14:12:49 -0800460 if (kill(pid, signal) == -1 && errno != ESRCH) {
Elliott Hughes171df0a2016-08-02 13:30:30 -0700461 PLOG(WARNING) << "kill(" << pid << ", " << signal << ") failed";
Colin Crosscf8d1c22014-06-03 13:24:21 -0700462 }
463 }
464
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000465 return true;
Colin Crosscf8d1c22014-06-03 13:24:21 -0700466}
467
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000468template <typename T>
469static std::chrono::milliseconds toMillisec(T&& duration) {
470 return std::chrono::duration_cast<std::chrono::milliseconds>(duration);
471}
472
473enum class populated_status
474{
475 populated,
476 not_populated,
477 error
478};
479
480static populated_status cgroupIsPopulated(int events_fd) {
481 const std::string POPULATED_KEY("populated ");
482 const std::string::size_type MAX_EVENTS_FILE_SIZE = 32;
483
484 std::string buf;
485 buf.resize(MAX_EVENTS_FILE_SIZE);
486 ssize_t len = TEMP_FAILURE_RETRY(pread(events_fd, buf.data(), buf.size(), 0));
487 if (len == -1) {
488 PLOG(ERROR) << "Could not read cgroup.events: ";
489 // Potentially ENODEV if the cgroup has been removed since we opened this file, but that
490 // shouldn't have happened yet.
491 return populated_status::error;
492 }
493
494 if (len == 0) {
495 LOG(ERROR) << "cgroup.events EOF";
496 return populated_status::error;
497 }
498
499 buf.resize(len);
500
501 const std::string::size_type pos = buf.find(POPULATED_KEY);
502 if (pos == std::string::npos) {
503 LOG(ERROR) << "Could not find populated key in cgroup.events";
504 return populated_status::error;
505 }
506
507 if (pos + POPULATED_KEY.size() + 1 > len) {
508 LOG(ERROR) << "Partial read of cgroup.events";
509 return populated_status::error;
510 }
511
512 return buf[pos + POPULATED_KEY.size()] == '1' ?
513 populated_status::populated : populated_status::not_populated;
514}
515
516// The default timeout of 2200ms comes from the default number of retries in a previous
517// implementation of this function. The default retry value was 40 for killing and 400 for cgroup
518// removal with 5ms sleeps between each retry.
519static int KillProcessGroup(
520 uid_t uid, int initialPid, int signal, bool once = false,
521 std::chrono::steady_clock::time_point until = std::chrono::steady_clock::now() + 2200ms) {
Bart Van Assche5a3c3f72023-03-22 13:21:03 -0700522 CHECK_GE(uid, 0);
523 CHECK_GT(initialPid, 0);
524
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000525 // Always attempt to send a kill signal to at least the initialPid, at least once, regardless of
526 // whether its cgroup exists or not. This should only be necessary if a bug results in the
527 // migration of the targeted process out of its cgroup, which we will also attempt to kill.
528 const bool signal_ret = sendSignalToProcessGroup(uid, initialPid, signal);
529
530 if (!CgroupsAvailable() || !signal_ret) return signal_ret ? 0 : -1;
531
Marco Ballesio4dac8162021-02-10 16:35:44 -0800532 std::string hierarchy_root_path;
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000533 CgroupGetControllerPath(CGROUPV2_HIERARCHY_NAME, &hierarchy_root_path);
Peter Collingbourned7157c22018-10-30 15:49:33 -0700534
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000535 const std::string cgroup_v2_path =
536 ConvertUidPidToPath(hierarchy_root_path.c_str(), uid, initialPid);
Colin Crosscf8d1c22014-06-03 13:24:21 -0700537
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000538 const std::string eventsfile = cgroup_v2_path + '/' + PROCESSGROUP_CGROUP_EVENTS_FILE;
539 android::base::unique_fd events_fd(open(eventsfile.c_str(), O_RDONLY));
540 if (events_fd.get() == -1) {
541 PLOG(WARNING) << "Error opening " << eventsfile << " for KillProcessGroup";
Tom Cherry20514c42017-04-21 13:48:49 -0700542 return -1;
543 }
Collin Mullinerf7e79b92016-06-01 21:03:55 +0000544
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000545 struct pollfd fds = {
546 .fd = events_fd,
547 .events = POLLPRI,
548 };
Tom Cherry20514c42017-04-21 13:48:49 -0700549
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000550 const std::chrono::steady_clock::time_point start = std::chrono::steady_clock::now();
Dianne Hackborn2c5e7e12014-10-13 17:45:22 -0700551
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000552 // The primary reason to loop here is to capture any new forks or migrations that could occur
553 // after we send signals to the original set of processes, but before all of those processes
554 // exit and the cgroup becomes unpopulated, or before we remove the cgroup. We try hard to
555 // ensure this completes successfully to avoid permanent memory leaks, but we still place a
556 // large default upper bound on the amount of time we spend in this loop. The amount of CPU
557 // contention, and the amount of work that needs to be done in do_exit for each process
558 // determines how long this will take.
559 int ret;
560 do {
561 populated_status populated;
562 while ((populated = cgroupIsPopulated(events_fd.get())) == populated_status::populated &&
563 std::chrono::steady_clock::now() < until) {
564
565 sendSignalToProcessGroup(uid, initialPid, signal);
566 if (once) {
567 populated = cgroupIsPopulated(events_fd.get());
568 break;
569 }
570
571 const std::chrono::steady_clock::time_point poll_start =
572 std::chrono::steady_clock::now();
573
574 if (poll_start < until)
575 ret = TEMP_FAILURE_RETRY(poll(&fds, 1, toMillisec(until - poll_start).count()));
576
577 if (ret == -1) {
578 // Fallback to 5ms sleeps if poll fails
579 PLOG(ERROR) << "Poll on " << eventsfile << "failed";
580 const std::chrono::steady_clock::time_point now = std::chrono::steady_clock::now();
581 if (now < until)
582 std::this_thread::sleep_for(std::min(5ms, toMillisec(until - now)));
583 }
584
585 LOG(VERBOSE) << "Waited "
586 << toMillisec(std::chrono::steady_clock::now() - poll_start).count()
587 << " ms for " << eventsfile << " poll";
Tom Cherry20514c42017-04-21 13:48:49 -0700588 }
Marco Ballesio4dac8162021-02-10 16:35:44 -0800589
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000590 const std::chrono::milliseconds kill_duration =
591 toMillisec(std::chrono::steady_clock::now() - start);
592
593 if (populated == populated_status::populated) {
594 LOG(WARNING) << "Still waiting on process(es) to exit for cgroup " << cgroup_v2_path
595 << " after " << kill_duration.count() << " ms";
596 // We'll still try the cgroup removal below which we expect to log an error.
597 } else if (populated == populated_status::not_populated) {
598 LOG(VERBOSE) << "Killed all processes under cgroup " << cgroup_v2_path
599 << " after " << kill_duration.count() << " ms";
Inseob Kima049a992022-11-17 23:42:12 +0900600 }
601
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000602 ret = RemoveCgroup(hierarchy_root_path.c_str(), uid, initialPid);
603 if (ret)
604 PLOG(ERROR) << "Unable to remove cgroup " << cgroup_v2_path;
605 else
606 LOG(INFO) << "Removed cgroup " << cgroup_v2_path;
Marco Ballesio4dac8162021-02-10 16:35:44 -0800607
608 if (isMemoryCgroupSupported() && UsePerAppMemcg()) {
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000609 // This per-application memcg v1 case should eventually be removed after migration to
610 // memcg v2.
Bart Van Assche4c957122022-02-04 18:19:45 +0000611 std::string memcg_apps_path;
612 if (CgroupGetMemcgAppsPath(&memcg_apps_path) &&
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000613 (ret = RemoveCgroup(memcg_apps_path.c_str(), uid, initialPid)) < 0) {
614 const auto memcg_v1_cgroup_path =
615 ConvertUidPidToPath(memcg_apps_path.c_str(), uid, initialPid);
616 PLOG(ERROR) << "Unable to remove memcg v1 cgroup " << memcg_v1_cgroup_path;
Bart Van Assche4c957122022-02-04 18:19:45 +0000617 }
Marco Ballesio4dac8162021-02-10 16:35:44 -0800618 }
619
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000620 if (once) break;
621 if (std::chrono::steady_clock::now() >= until) break;
622 } while (ret && errno == EBUSY);
623
624 return ret;
Colin Crosscf8d1c22014-06-03 13:24:21 -0700625}
626
T.J. Mercier599d9792023-10-26 20:46:21 +0000627int killProcessGroup(uid_t uid, int initialPid, int signal) {
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000628 return KillProcessGroup(uid, initialPid, signal);
Keun-young Parkfac4b632017-03-28 17:25:24 -0700629}
630
T.J. Mercier599d9792023-10-26 20:46:21 +0000631int killProcessGroupOnce(uid_t uid, int initialPid, int signal) {
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000632 return KillProcessGroup(uid, initialPid, signal, true);
T.J. Mercier22006bf2023-04-13 21:48:55 +0000633}
634
Suren Baghdasaryan25ad3f92021-07-30 13:42:39 -0700635static int createProcessGroupInternal(uid_t uid, int initialPid, std::string cgroup,
636 bool activate_controllers) {
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800637 auto uid_path = ConvertUidToPath(cgroup.c_str(), uid);
Colin Crosscf8d1c22014-06-03 13:24:21 -0700638
Marco Ballesio9e628a62021-02-11 14:44:53 -0800639 struct stat cgroup_stat;
640 mode_t cgroup_mode = 0750;
Bart Van Assche8eb7a6e2022-03-29 23:47:08 +0000641 uid_t cgroup_uid = AID_SYSTEM;
Bart Van Assche32a9b1c2022-03-10 21:42:40 +0000642 gid_t cgroup_gid = AID_SYSTEM;
Suren Baghdasaryan25ad3f92021-07-30 13:42:39 -0700643 int ret = 0;
Marco Ballesio9e628a62021-02-11 14:44:53 -0800644
Bart Van Assche55a9b1e2022-03-23 10:13:18 -0700645 if (stat(cgroup.c_str(), &cgroup_stat) < 0) {
Marco Ballesio9e628a62021-02-11 14:44:53 -0800646 PLOG(ERROR) << "Failed to get stats for " << cgroup;
647 } else {
648 cgroup_mode = cgroup_stat.st_mode;
Bart Van Assche8eb7a6e2022-03-29 23:47:08 +0000649 cgroup_uid = cgroup_stat.st_uid;
Marco Ballesio9e628a62021-02-11 14:44:53 -0800650 cgroup_gid = cgroup_stat.st_gid;
651 }
652
Bart Van Assche8eb7a6e2022-03-29 23:47:08 +0000653 if (!MkdirAndChown(uid_path, cgroup_mode, cgroup_uid, cgroup_gid)) {
Tom Cherry574a0812018-02-23 13:04:40 -0800654 PLOG(ERROR) << "Failed to make and chown " << uid_path;
Elliott Hughes171df0a2016-08-02 13:30:30 -0700655 return -errno;
Colin Crosscf8d1c22014-06-03 13:24:21 -0700656 }
Suren Baghdasaryan25ad3f92021-07-30 13:42:39 -0700657 if (activate_controllers) {
658 ret = CgroupMap::GetInstance().ActivateControllers(uid_path);
659 if (ret) {
660 LOG(ERROR) << "Failed to activate controllers in " << uid_path;
661 return ret;
662 }
663 }
Colin Crosscf8d1c22014-06-03 13:24:21 -0700664
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800665 auto uid_pid_path = ConvertUidPidToPath(cgroup.c_str(), uid, initialPid);
Colin Crosscf8d1c22014-06-03 13:24:21 -0700666
Bart Van Assche8eb7a6e2022-03-29 23:47:08 +0000667 if (!MkdirAndChown(uid_pid_path, cgroup_mode, cgroup_uid, cgroup_gid)) {
Tom Cherry574a0812018-02-23 13:04:40 -0800668 PLOG(ERROR) << "Failed to make and chown " << uid_pid_path;
Elliott Hughes171df0a2016-08-02 13:30:30 -0700669 return -errno;
Colin Crosscf8d1c22014-06-03 13:24:21 -0700670 }
671
T.J. Mercier3b5bb3a2023-10-31 16:14:20 +0000672 auto uid_pid_procs_file = uid_pid_path + '/' + PROCESSGROUP_CGROUP_PROCS_FILE;
Colin Crosscf8d1c22014-06-03 13:24:21 -0700673
Tom Cherry574a0812018-02-23 13:04:40 -0800674 if (!WriteStringToFile(std::to_string(initialPid), uid_pid_procs_file)) {
Colin Crosscf8d1c22014-06-03 13:24:21 -0700675 ret = -errno;
Tom Cherry574a0812018-02-23 13:04:40 -0800676 PLOG(ERROR) << "Failed to write '" << initialPid << "' to " << uid_pid_procs_file;
Colin Crosscf8d1c22014-06-03 13:24:21 -0700677 }
678
Colin Crosscf8d1c22014-06-03 13:24:21 -0700679 return ret;
680}
Robert Benead4852262017-07-16 19:38:11 -0700681
Marco Ballesio4dac8162021-02-10 16:35:44 -0800682int createProcessGroup(uid_t uid, int initialPid, bool memControl) {
Bart Van Assche5a3c3f72023-03-22 13:21:03 -0700683 CHECK_GE(uid, 0);
684 CHECK_GT(initialPid, 0);
Marco Ballesio4dac8162021-02-10 16:35:44 -0800685
686 if (memControl && !UsePerAppMemcg()) {
T.J. Mercier4d0d2852023-10-27 23:44:03 +0000687 LOG(ERROR) << "service memory controls are used without per-process memory cgroup support";
Marco Ballesio4dac8162021-02-10 16:35:44 -0800688 return -EINVAL;
689 }
690
Bart Van Assche4c957122022-02-04 18:19:45 +0000691 if (std::string memcg_apps_path;
692 isMemoryCgroupSupported() && UsePerAppMemcg() && CgroupGetMemcgAppsPath(&memcg_apps_path)) {
693 // Note by bvanassche: passing 'false' as fourth argument below implies that the v1
694 // hierarchy is used. It is not clear to me whether the above conditions guarantee that the
695 // v1 hierarchy is used.
696 int ret = createProcessGroupInternal(uid, initialPid, memcg_apps_path, false);
Marco Ballesio4dac8162021-02-10 16:35:44 -0800697 if (ret != 0) {
698 return ret;
699 }
700 }
701
Bart Van Assche5a3c3f72023-03-22 13:21:03 -0700702 std::string cgroup;
T.J. Merciera99e7d82023-10-27 17:29:01 +0000703 CgroupGetControllerPath(CGROUPV2_HIERARCHY_NAME, &cgroup);
Suren Baghdasaryan25ad3f92021-07-30 13:42:39 -0700704 return createProcessGroupInternal(uid, initialPid, cgroup, true);
Marco Ballesio4dac8162021-02-10 16:35:44 -0800705}
706
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800707static bool SetProcessGroupValue(int tid, const std::string& attr_name, int64_t value) {
Peter Collingbourned7157c22018-10-30 15:49:33 -0700708 if (!isMemoryCgroupSupported()) {
T.J. Mercier4d0d2852023-10-27 23:44:03 +0000709 LOG(ERROR) << "Memcg is not mounted.";
Robert Benead4852262017-07-16 19:38:11 -0700710 return false;
711 }
712
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800713 std::string path;
714 if (!CgroupGetAttributePathForTask(attr_name, tid, &path)) {
T.J. Mercier4d0d2852023-10-27 23:44:03 +0000715 LOG(ERROR) << "Failed to find attribute '" << attr_name << "'";
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800716 return false;
717 }
Robert Benead4852262017-07-16 19:38:11 -0700718
719 if (!WriteStringToFile(std::to_string(value), path)) {
720 PLOG(ERROR) << "Failed to write '" << value << "' to " << path;
721 return false;
722 }
723 return true;
724}
725
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800726bool setProcessGroupSwappiness(uid_t, int pid, int swappiness) {
727 return SetProcessGroupValue(pid, "MemSwappiness", swappiness);
Robert Benead4852262017-07-16 19:38:11 -0700728}
729
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800730bool setProcessGroupSoftLimit(uid_t, int pid, int64_t soft_limit_in_bytes) {
731 return SetProcessGroupValue(pid, "MemSoftLimit", soft_limit_in_bytes);
Robert Benead4852262017-07-16 19:38:11 -0700732}
733
Suren Baghdasaryan82b72a52018-12-21 11:41:50 -0800734bool setProcessGroupLimit(uid_t, int pid, int64_t limit_in_bytes) {
735 return SetProcessGroupValue(pid, "MemLimit", limit_in_bytes);
Robert Benead4852262017-07-16 19:38:11 -0700736}
Marco Ballesio4e644c42021-02-24 16:30:50 -0800737
738bool getAttributePathForTask(const std::string& attr_name, int tid, std::string* path) {
739 return CgroupGetAttributePathForTask(attr_name, tid, path);
740}
Suren Baghdasaryan8cacb612023-04-12 01:24:23 +0000741
742bool isProfileValidForProcess(const std::string& profile_name, int uid, int pid) {
743 const TaskProfile* tp = TaskProfiles::GetInstance().GetProfile(profile_name);
744
745 if (tp == nullptr) {
746 return false;
747 }
748
749 return tp->IsValidForProcess(uid, pid);
T.J. Merciera99e7d82023-10-27 17:29:01 +0000750}