xref: /aosp_15_r20/system/logging/logd/LogReaderList.cpp (revision 598139dc91b21518d67c408eaea2644226490971)
1*598139dcSAndroid Build Coastguard Worker /*
2*598139dcSAndroid Build Coastguard Worker  * Copyright (C) 2020 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 "LogReaderList.h"
18*598139dcSAndroid Build Coastguard Worker 
19*598139dcSAndroid Build Coastguard Worker #include <android-base/logging.h>
20*598139dcSAndroid Build Coastguard Worker #include <android/os/logcat/ILogcatManagerService.h>
21*598139dcSAndroid Build Coastguard Worker #include <binder/IServiceManager.h>
22*598139dcSAndroid Build Coastguard Worker 
23*598139dcSAndroid Build Coastguard Worker using android::defaultServiceManager;
24*598139dcSAndroid Build Coastguard Worker using android::sp;
25*598139dcSAndroid Build Coastguard Worker using android::String16;
26*598139dcSAndroid Build Coastguard Worker using android::os::logcat::ILogcatManagerService;
27*598139dcSAndroid Build Coastguard Worker 
InitLogcatService()28*598139dcSAndroid Build Coastguard Worker static sp<ILogcatManagerService> InitLogcatService() {
29*598139dcSAndroid Build Coastguard Worker     return android::interface_cast<ILogcatManagerService>(
30*598139dcSAndroid Build Coastguard Worker             defaultServiceManager()->waitForService(String16("logcat")));
31*598139dcSAndroid Build Coastguard Worker }
32*598139dcSAndroid Build Coastguard Worker 
GetLogcatService()33*598139dcSAndroid Build Coastguard Worker static sp<ILogcatManagerService> GetLogcatService() {
34*598139dcSAndroid Build Coastguard Worker     static sp<ILogcatManagerService> logcat_service = InitLogcatService();
35*598139dcSAndroid Build Coastguard Worker 
36*598139dcSAndroid Build Coastguard Worker     if (logcat_service == nullptr) {
37*598139dcSAndroid Build Coastguard Worker         LOG(ERROR) << "Permission problem or fatal error occurs to get logcat service";
38*598139dcSAndroid Build Coastguard Worker     }
39*598139dcSAndroid Build Coastguard Worker     return logcat_service;
40*598139dcSAndroid Build Coastguard Worker }
41*598139dcSAndroid Build Coastguard Worker 
42*598139dcSAndroid Build Coastguard Worker // When we are notified a new log entry is available, inform
43*598139dcSAndroid Build Coastguard Worker // listening sockets who are watching this entry's log id.
NotifyNewLog(LogMask log_mask) const44*598139dcSAndroid Build Coastguard Worker void LogReaderList::NotifyNewLog(LogMask log_mask) const {
45*598139dcSAndroid Build Coastguard Worker     for (const auto& entry : running_reader_threads_) {
46*598139dcSAndroid Build Coastguard Worker         if (!entry->IsWatchingMultiple(log_mask)) {
47*598139dcSAndroid Build Coastguard Worker             continue;
48*598139dcSAndroid Build Coastguard Worker         }
49*598139dcSAndroid Build Coastguard Worker         if (entry->deadline().time_since_epoch().count() != 0) {
50*598139dcSAndroid Build Coastguard Worker             continue;
51*598139dcSAndroid Build Coastguard Worker         }
52*598139dcSAndroid Build Coastguard Worker         entry->TriggerReader();
53*598139dcSAndroid Build Coastguard Worker     }
54*598139dcSAndroid Build Coastguard Worker }
55*598139dcSAndroid Build Coastguard Worker 
HandlePendingThread(uid_t uid,gid_t gid,pid_t pid,int32_t fd,bool approve)56*598139dcSAndroid Build Coastguard Worker bool LogReaderList::HandlePendingThread(uid_t uid, gid_t gid, pid_t pid, int32_t fd, bool approve) {
57*598139dcSAndroid Build Coastguard Worker     auto lock = std::lock_guard{logd_lock};
58*598139dcSAndroid Build Coastguard Worker     PendingReaderThreadKey key = {
59*598139dcSAndroid Build Coastguard Worker             .uid = uid,
60*598139dcSAndroid Build Coastguard Worker             .gid = gid,
61*598139dcSAndroid Build Coastguard Worker             .pid = pid,
62*598139dcSAndroid Build Coastguard Worker             .fd = fd,
63*598139dcSAndroid Build Coastguard Worker     };
64*598139dcSAndroid Build Coastguard Worker     auto iter = std::find_if(pending_reader_threads_.begin(), pending_reader_threads_.end(),
65*598139dcSAndroid Build Coastguard Worker                              [&key](const auto& other) REQUIRES(logd_lock) {
66*598139dcSAndroid Build Coastguard Worker                                  return other->pending_reader_thread_key() == key;
67*598139dcSAndroid Build Coastguard Worker                              });
68*598139dcSAndroid Build Coastguard Worker     if (iter == pending_reader_threads_.end()) {
69*598139dcSAndroid Build Coastguard Worker         return false;
70*598139dcSAndroid Build Coastguard Worker     }
71*598139dcSAndroid Build Coastguard Worker 
72*598139dcSAndroid Build Coastguard Worker     auto entry = std::move(*iter);
73*598139dcSAndroid Build Coastguard Worker     pending_reader_threads_.erase(iter);
74*598139dcSAndroid Build Coastguard Worker     if (!approve) {
75*598139dcSAndroid Build Coastguard Worker         entry->Revoke();
76*598139dcSAndroid Build Coastguard Worker     } else {
77*598139dcSAndroid Build Coastguard Worker         entry->set_track_flag();
78*598139dcSAndroid Build Coastguard Worker     }
79*598139dcSAndroid Build Coastguard Worker     AddAndRunThread(std::move(entry));
80*598139dcSAndroid Build Coastguard Worker     return true;
81*598139dcSAndroid Build Coastguard Worker }
82*598139dcSAndroid Build Coastguard Worker 
AddAndRunThread(std::unique_ptr<LogReaderThread> thread)83*598139dcSAndroid Build Coastguard Worker void LogReaderList::AddAndRunThread(std::unique_ptr<LogReaderThread> thread) {
84*598139dcSAndroid Build Coastguard Worker     thread->Run();
85*598139dcSAndroid Build Coastguard Worker     running_reader_threads_.emplace_front(std::move(thread));
86*598139dcSAndroid Build Coastguard Worker }
87*598139dcSAndroid Build Coastguard Worker 
RemoveRunningThread(LogReaderThread * thread)88*598139dcSAndroid Build Coastguard Worker void LogReaderList::RemoveRunningThread(LogReaderThread* thread) {
89*598139dcSAndroid Build Coastguard Worker     auto iter = std::find_if(running_reader_threads_.begin(), running_reader_threads_.end(),
90*598139dcSAndroid Build Coastguard Worker                              [thread](const auto& other)
91*598139dcSAndroid Build Coastguard Worker                                      REQUIRES(logd_lock) { return other.get() == thread; });
92*598139dcSAndroid Build Coastguard Worker     if (iter == running_reader_threads_.end()) {
93*598139dcSAndroid Build Coastguard Worker         return;
94*598139dcSAndroid Build Coastguard Worker     }
95*598139dcSAndroid Build Coastguard Worker 
96*598139dcSAndroid Build Coastguard Worker     // If the track_flag is false, we don't need to notify LogcatManagerService.
97*598139dcSAndroid Build Coastguard Worker     // All the native processes are in this category, so we can remove the
98*598139dcSAndroid Build Coastguard Worker     // dependency on system_server for the native processes.
99*598139dcSAndroid Build Coastguard Worker     if (!thread->track_flag()) {
100*598139dcSAndroid Build Coastguard Worker         running_reader_threads_.erase(iter);
101*598139dcSAndroid Build Coastguard Worker         return;
102*598139dcSAndroid Build Coastguard Worker     }
103*598139dcSAndroid Build Coastguard Worker 
104*598139dcSAndroid Build Coastguard Worker     auto service = GetLogcatService();
105*598139dcSAndroid Build Coastguard Worker     if (service != nullptr) {
106*598139dcSAndroid Build Coastguard Worker         const PendingReaderThreadKey key = thread->pending_reader_thread_key();
107*598139dcSAndroid Build Coastguard Worker         service->finishThread(key.uid, key.gid, key.pid, key.fd);
108*598139dcSAndroid Build Coastguard Worker     }
109*598139dcSAndroid Build Coastguard Worker     running_reader_threads_.erase(iter);
110*598139dcSAndroid Build Coastguard Worker }
111*598139dcSAndroid Build Coastguard Worker 
AddPendingThread(std::unique_ptr<LogReaderThread> thread)112*598139dcSAndroid Build Coastguard Worker void LogReaderList::AddPendingThread(std::unique_ptr<LogReaderThread> thread) {
113*598139dcSAndroid Build Coastguard Worker     auto service = GetLogcatService();
114*598139dcSAndroid Build Coastguard Worker 
115*598139dcSAndroid Build Coastguard Worker     // If the logcat binder service is not available, we will be not able to
116*598139dcSAndroid Build Coastguard Worker     // check the user consent. So we revoke the privileges.
117*598139dcSAndroid Build Coastguard Worker     if (service == nullptr) {
118*598139dcSAndroid Build Coastguard Worker         thread->Revoke();
119*598139dcSAndroid Build Coastguard Worker         AddAndRunThread(std::move(thread));
120*598139dcSAndroid Build Coastguard Worker         return;
121*598139dcSAndroid Build Coastguard Worker     }
122*598139dcSAndroid Build Coastguard Worker 
123*598139dcSAndroid Build Coastguard Worker     const PendingReaderThreadKey key = thread->pending_reader_thread_key();
124*598139dcSAndroid Build Coastguard Worker     service->startThread(key.uid, key.gid, key.pid, key.fd);
125*598139dcSAndroid Build Coastguard Worker     pending_reader_threads_.emplace_back(std::move(thread));
126*598139dcSAndroid Build Coastguard Worker }
127*598139dcSAndroid Build Coastguard Worker 
ReleaseThreadByName(const std::string & cli_name)128*598139dcSAndroid Build Coastguard Worker bool LogReaderList::ReleaseThreadByName(const std::string& cli_name) REQUIRES(logd_lock) {
129*598139dcSAndroid Build Coastguard Worker     for (const auto& reader : running_reader_threads_) {
130*598139dcSAndroid Build Coastguard Worker         if (reader->name() == cli_name) {
131*598139dcSAndroid Build Coastguard Worker             reader->Release();
132*598139dcSAndroid Build Coastguard Worker             return true;
133*598139dcSAndroid Build Coastguard Worker         }
134*598139dcSAndroid Build Coastguard Worker     }
135*598139dcSAndroid Build Coastguard Worker 
136*598139dcSAndroid Build Coastguard Worker     for (const auto& reader : pending_reader_threads_) {
137*598139dcSAndroid Build Coastguard Worker         if (reader->name() == cli_name) {
138*598139dcSAndroid Build Coastguard Worker             reader->Release();
139*598139dcSAndroid Build Coastguard Worker             return true;
140*598139dcSAndroid Build Coastguard Worker         }
141*598139dcSAndroid Build Coastguard Worker     }
142*598139dcSAndroid Build Coastguard Worker     return false;
143*598139dcSAndroid Build Coastguard Worker }
144