xref: /aosp_15_r20/system/core/libprocessgroup/include/processgroup/processgroup.h (revision 00c7fec1bb09f3284aad6a6f96d2f63dfc3650ad)
1 /*
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 #pragma once
18 
19 #include <sys/types.h>
20 #include <initializer_list>
21 #include <span>
22 #include <string>
23 #include <string_view>
24 #include <vector>
25 
26 static constexpr std::string CGROUPV2_HIERARCHY_NAME = "cgroup2";
27 
28 bool CgroupsAvailable();
29 bool CgroupGetControllerPath(const std::string& cgroup_name, std::string* path);
30 bool CgroupGetControllerFromPath(const std::string& path, std::string* cgroup_name);
31 bool CgroupGetAttributePath(const std::string& attr_name, std::string* path);
32 bool CgroupGetAttributePathForTask(const std::string& attr_name, pid_t tid, std::string* path);
33 
34 bool SetTaskProfiles(pid_t tid, const std::vector<std::string>& profiles,
35                      bool use_fd_cache = false);
36 bool SetProcessProfiles(uid_t uid, pid_t pid, const std::vector<std::string>& profiles);
37 bool SetUserProfiles(uid_t uid, const std::vector<std::string>& profiles);
38 
39 bool SetTaskProfiles(pid_t tid, std::initializer_list<std::string_view> profiles,
40                      bool use_fd_cache = false);
41 bool SetProcessProfiles(uid_t uid, pid_t pid, std::initializer_list<std::string_view> profiles);
42 #if _LIBCPP_STD_VER > 17
43 bool SetTaskProfiles(pid_t tid, std::span<const std::string_view> profiles,
44                      bool use_fd_cache = false);
45 bool SetProcessProfiles(uid_t uid, pid_t pid, std::span<const std::string_view> profiles);
46 #endif
47 
48 
49 #ifndef __ANDROID_VNDK__
50 
51 bool SetProcessProfilesCached(uid_t uid, pid_t pid, const std::vector<std::string>& profiles);
52 
53 bool UsePerAppMemcg();
54 
55 // Drop the fd cache of cgroup path. It is used for when resource caching is enabled and a process
56 // loses the access to the path, the access checking (See SetCgroupAction::EnableResourceCaching)
57 // should be active again. E.g. Zygote specialization for child process.
58 void DropTaskProfilesResourceCaching();
59 
60 // Return 0 if all processes were killed and the cgroup was successfully removed.
61 // Returns -1 in the case of an error occurring or if there are processes still running.
62 int killProcessGroup(uid_t uid, pid_t initialPid, int signal);
63 
64 // Returns the same as killProcessGroup(), however it does not retry, which means
65 // that it only returns 0 in the case that the cgroup exists and it contains no processes.
66 int killProcessGroupOnce(uid_t uid, pid_t initialPid, int signal);
67 
68 // Sends the provided signal to all members of a process group, but does not wait for processes to
69 // exit, or for the cgroup to be removed. Callers should also ensure that killProcessGroup is called
70 // later to ensure the cgroup is fully removed, otherwise system resources will leak.
71 // Returns true if no errors are encountered sending signals, otherwise false.
72 bool sendSignalToProcessGroup(uid_t uid, pid_t initialPid, int signal);
73 
74 int createProcessGroup(uid_t uid, pid_t initialPid, bool memControl = false);
75 
76 // Set various properties of a process group. For these functions to work, the process group must
77 // have been created by passing memControl=true to createProcessGroup.
78 bool setProcessGroupSwappiness(uid_t uid, pid_t initialPid, int swappiness);
79 bool setProcessGroupSoftLimit(uid_t uid, pid_t initialPid, int64_t softLimitInBytes);
80 bool setProcessGroupLimit(uid_t uid, pid_t initialPid, int64_t limitInBytes);
81 
82 void removeAllEmptyProcessGroups(void);
83 
84 // Provides the path for an attribute in a specific process group
85 // Returns false in case of error, true in case of success
86 bool getAttributePathForTask(const std::string& attr_name, pid_t tid, std::string* path);
87 
88 // Check if a profile can be applied without failing.
89 // Returns true if it can be applied without failing, false otherwise
90 bool isProfileValidForProcess(const std::string& profile_name, uid_t uid, pid_t pid);
91 
92 #endif // __ANDROID_VNDK__
93