xref: /aosp_15_r20/system/logging/logcat/process_names.cpp (revision 598139dc91b21518d67c408eaea2644226490971)
1*598139dcSAndroid Build Coastguard Worker /*
2*598139dcSAndroid Build Coastguard Worker  * Copyright (C) 2023 The Android Open Source Project
3*598139dcSAndroid Build Coastguard Worker  *
4*598139dcSAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*598139dcSAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*598139dcSAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*598139dcSAndroid Build Coastguard Worker  *
8*598139dcSAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*598139dcSAndroid Build Coastguard Worker  *
10*598139dcSAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*598139dcSAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*598139dcSAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*598139dcSAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*598139dcSAndroid Build Coastguard Worker  * limitations under the License.
15*598139dcSAndroid Build Coastguard Worker  */
16*598139dcSAndroid Build Coastguard Worker 
17*598139dcSAndroid Build Coastguard Worker #include "process_names.h"
18*598139dcSAndroid Build Coastguard Worker 
19*598139dcSAndroid Build Coastguard Worker #include "android-base/file.h"
20*598139dcSAndroid Build Coastguard Worker 
ReadCmdline(uint64_t pid)21*598139dcSAndroid Build Coastguard Worker const std::string ProcessNames::ReadCmdline(uint64_t pid) {
22*598139dcSAndroid Build Coastguard Worker     const std::string path = std::string("/proc/") + std::to_string(pid) + "/cmdline";
23*598139dcSAndroid Build Coastguard Worker 
24*598139dcSAndroid Build Coastguard Worker     std::string cmdline;
25*598139dcSAndroid Build Coastguard Worker     if (!android::base::ReadFileToString(path, &cmdline)) {
26*598139dcSAndroid Build Coastguard Worker         return "";
27*598139dcSAndroid Build Coastguard Worker     }
28*598139dcSAndroid Build Coastguard Worker 
29*598139dcSAndroid Build Coastguard Worker     // We need to remove anything that would be part of an absolute path for the executable
30*598139dcSAndroid Build Coastguard Worker     // but also the parameters. e.g.:
31*598139dcSAndroid Build Coastguard Worker     // Input : /path/to/myProgram -D --ooo
32*598139dcSAndroid Build Coastguard Worker     // Output: myProgram
33*598139dcSAndroid Build Coastguard Worker     return android::base::Basename(cmdline.c_str());
34*598139dcSAndroid Build Coastguard Worker }
35*598139dcSAndroid Build Coastguard Worker 
ReadComm(uint64_t pid)36*598139dcSAndroid Build Coastguard Worker const std::string ProcessNames::ReadComm(uint64_t pid) {
37*598139dcSAndroid Build Coastguard Worker     const std::string path = std::string("/proc/") + std::to_string(pid) + "/comm";
38*598139dcSAndroid Build Coastguard Worker     std::string cmdline;
39*598139dcSAndroid Build Coastguard Worker     bool success = android::base::ReadFileToString(path, &cmdline);
40*598139dcSAndroid Build Coastguard Worker     if (!success) {
41*598139dcSAndroid Build Coastguard Worker         return "";
42*598139dcSAndroid Build Coastguard Worker     }
43*598139dcSAndroid Build Coastguard Worker     return cmdline;
44*598139dcSAndroid Build Coastguard Worker }
45*598139dcSAndroid Build Coastguard Worker 
Resolve(uint64_t pid)46*598139dcSAndroid Build Coastguard Worker const std::string ProcessNames::Resolve(uint64_t pid) {
47*598139dcSAndroid Build Coastguard Worker     std::string name = ReadCmdline(pid);
48*598139dcSAndroid Build Coastguard Worker     if (!name.empty()) {
49*598139dcSAndroid Build Coastguard Worker         return name;
50*598139dcSAndroid Build Coastguard Worker     }
51*598139dcSAndroid Build Coastguard Worker 
52*598139dcSAndroid Build Coastguard Worker     // Kernel threads do not have anything in /proc/PID/cmdline. e.g.:
53*598139dcSAndroid Build Coastguard Worker     // migration/0
54*598139dcSAndroid Build Coastguard Worker     // cpuhp/0
55*598139dcSAndroid Build Coastguard Worker     // kworker/7:1-events
56*598139dcSAndroid Build Coastguard Worker     //
57*598139dcSAndroid Build Coastguard Worker     // To still have a somewhat relevant name, we check /proc/PID/comm, even though
58*598139dcSAndroid Build Coastguard Worker     // the max length is 16 characters.
59*598139dcSAndroid Build Coastguard Worker     name = ReadComm(pid);
60*598139dcSAndroid Build Coastguard Worker     if (!name.empty()) {
61*598139dcSAndroid Build Coastguard Worker         return name;
62*598139dcSAndroid Build Coastguard Worker     }
63*598139dcSAndroid Build Coastguard Worker 
64*598139dcSAndroid Build Coastguard Worker     return "";
65*598139dcSAndroid Build Coastguard Worker }
66*598139dcSAndroid Build Coastguard Worker 
Get(uint64_t pid)67*598139dcSAndroid Build Coastguard Worker std::string ProcessNames::Get(uint64_t pid) {
68*598139dcSAndroid Build Coastguard Worker     // Cache hit!
69*598139dcSAndroid Build Coastguard Worker     const std::string& cached = cache.get(pid);
70*598139dcSAndroid Build Coastguard Worker     if (!cached.empty()) {
71*598139dcSAndroid Build Coastguard Worker         return cached;
72*598139dcSAndroid Build Coastguard Worker     }
73*598139dcSAndroid Build Coastguard Worker 
74*598139dcSAndroid Build Coastguard Worker     // Cache miss!
75*598139dcSAndroid Build Coastguard Worker     std::string name = Resolve(pid);
76*598139dcSAndroid Build Coastguard Worker     // When an app starts, after it forks from zygote process, the process name remains
77*598139dcSAndroid Build Coastguard Worker     // zygote/zygote64, then <pre-initialized>, then the package/process name is set.
78*598139dcSAndroid Build Coastguard Worker     // We don't cache until we know the final value.
79*598139dcSAndroid Build Coastguard Worker     if (name != "<pre-initialized>" && !name.starts_with("zygote")) {
80*598139dcSAndroid Build Coastguard Worker         cache.put(pid, name);
81*598139dcSAndroid Build Coastguard Worker     }
82*598139dcSAndroid Build Coastguard Worker     return name;
83*598139dcSAndroid Build Coastguard Worker }
84