1 /*
2 * Copyright (C) 2015 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 #include "sysdeps.h"
18 #include "adb_trace.h"
19
20 #include <string>
21 #include <unordered_map>
22 #include <vector>
23
24 #include <android-base/logging.h>
25 #include <android-base/strings.h>
26
27 #include "adb.h"
28
29 #if !ADB_HOST
30 #include <android-base/properties.h>
31 #endif
32
33 #if !ADB_HOST
34 const char* adb_device_banner = "device";
35 #if defined(__ANDROID__)
36 static android::base::LogdLogger gLogdLogger;
37 #endif
38 #else
39 const char* adb_device_banner = "host";
40 #endif
41
AdbLogger(android::base::LogId id,android::base::LogSeverity severity,const char * tag,const char * file,unsigned int line,const char * message)42 void AdbLogger(android::base::LogId id, android::base::LogSeverity severity,
43 const char* tag, const char* file, unsigned int line,
44 const char* message) {
45 android::base::StderrLogger(id, severity, tag, file, line, message);
46 #if defined(_WIN32)
47 // stderr can be buffered on Windows (and setvbuf doesn't seem to work), so explicitly flush.
48 fflush(stderr);
49 #endif
50
51 #if !ADB_HOST && defined(__ANDROID__)
52 // Only print logs of INFO or higher to logcat, so that `adb logcat` with adbd tracing on
53 // doesn't result in exponential logging.
54 if (severity >= android::base::INFO) {
55 gLogdLogger(id, severity, tag, file, line, message);
56 }
57 #endif
58 }
59
60
61 #if !ADB_HOST
get_log_file_name()62 static std::string get_log_file_name() {
63 struct tm now;
64 time_t t;
65 tzset();
66 time(&t);
67 localtime_r(&t, &now);
68
69 char timestamp[PATH_MAX];
70 strftime(timestamp, sizeof(timestamp), "%Y-%m-%d-%H-%M-%S", &now);
71
72 return android::base::StringPrintf("/data/adb/adb-%s-%d", timestamp,
73 getpid());
74 }
75
start_device_log(void)76 void start_device_log(void) {
77 int fd = unix_open(get_log_file_name(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC, 0640);
78 if (fd == -1) {
79 return;
80 }
81
82 // Redirect stdout and stderr to the log file.
83 dup2(fd, STDOUT_FILENO);
84 dup2(fd, STDERR_FILENO);
85 fprintf(stderr, "--- adb starting (pid %d) ---\n", getpid());
86 unix_close(fd);
87 }
88 #endif
89
90 int adb_trace_mask;
91
get_trace_setting_from_env()92 std::string get_trace_setting_from_env() {
93 const char* setting = getenv("ADB_TRACE");
94 if (setting == nullptr) {
95 setting = "";
96 }
97
98 return std::string(setting);
99 }
100
get_trace_setting()101 std::string get_trace_setting() {
102 #if ADB_HOST
103 return get_trace_setting_from_env();
104 #else
105 return android::base::GetProperty("persist.adb.trace_mask", "");
106 #endif
107 }
108
109 // Split the space separated list of tags from the trace setting and build the
110 // trace mask from it. note that '1' and 'all' are special cases to enable all
111 // tracing.
112 //
113 // adb's trace setting comes from the ADB_TRACE environment variable, whereas
114 // adbd's comes from the system property persist.adb.trace_mask.
setup_trace_mask()115 static void setup_trace_mask() {
116 const std::string trace_setting = get_trace_setting();
117 if (trace_setting.empty()) {
118 return;
119 }
120
121 std::unordered_map<std::string, int> trace_flags = {
122 {"1", -1},
123 {"all", -1},
124 {"adb", ADB},
125 {"sockets", SOCKETS},
126 {"packets", PACKETS},
127 {"rwx", RWX},
128 {"usb", USB},
129 {"sync", SYNC},
130 {"sysdeps", SYSDEPS},
131 {"transport", TRANSPORT},
132 {"jdwp", JDWP},
133 {"services", SERVICES},
134 {"auth", AUTH},
135 {"fdevent", FDEVENT},
136 {"shell", SHELL}};
137
138 std::vector<std::string> elements = android::base::Split(trace_setting, " ");
139 for (const auto& elem : elements) {
140 const auto& flag = trace_flags.find(elem);
141 if (flag == trace_flags.end()) {
142 LOG(ERROR) << "Unknown trace flag: " << elem;
143 continue;
144 }
145
146 if (flag->second == -1) {
147 // -1 is used for the special values "1" and "all" that enable all
148 // tracing.
149 adb_trace_mask = ~0;
150 break;
151 } else {
152 adb_trace_mask |= 1 << flag->second;
153 }
154 }
155
156 if (adb_trace_mask != 0) {
157 android::base::SetMinimumLogSeverity(android::base::VERBOSE);
158 }
159 }
160
adb_trace_init(char ** argv)161 void adb_trace_init(char** argv) {
162 #if !ADB_HOST
163 // Don't open log file if no tracing, since this will block
164 // the crypto unmount of /data
165 if (!get_trace_setting().empty()) {
166 if (unix_isatty(STDOUT_FILENO) == 0) {
167 start_device_log();
168 }
169 }
170 #endif
171
172 #if ADB_HOST && !defined(_WIN32)
173 // adb historically ignored $ANDROID_LOG_TAGS but passed it through to logcat.
174 // If set, move it out of the way so that libbase logging doesn't try to parse it.
175 std::string log_tags;
176 char* ANDROID_LOG_TAGS = getenv("ANDROID_LOG_TAGS");
177 if (ANDROID_LOG_TAGS) {
178 log_tags = ANDROID_LOG_TAGS;
179 unsetenv("ANDROID_LOG_TAGS");
180 }
181 #endif
182
183 android::base::InitLogging(argv, &AdbLogger);
184
185 #if ADB_HOST && !defined(_WIN32)
186 // Put $ANDROID_LOG_TAGS back so we can pass it to logcat.
187 if (!log_tags.empty()) setenv("ANDROID_LOG_TAGS", log_tags.c_str(), 1);
188 #endif
189
190 setup_trace_mask();
191
192 VLOG(ADB) << adb_version();
193 }
194
adb_trace_enable(AdbTrace trace_tag)195 void adb_trace_enable(AdbTrace trace_tag) {
196 adb_trace_mask |= (1 << trace_tag);
197 }
198