blob: bbb12db0f59e5ccba20c6d26b834d9e3ad57e770 [file] [log] [blame]
Elly Jones03cd6d72012-06-11 13:04:28 -04001// Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
Alex Vakulenko262be3f2014-07-30 15:25:50 -07005#include "debugd/src/log_tool.h"
Elly Jones03cd6d72012-06-11 13:04:28 -04006
Ben Chana0011d82014-05-13 00:19:29 -07007#include <vector>
8
Ben Chanf6cd93a2012-10-14 19:37:00 -07009#include <glib.h>
10
Ben Chancd8fda42014-09-05 08:21:06 -070011#include <base/files/file_util.h>
Ahmed Fakhry21140cf2016-03-04 17:15:19 -080012#include <base/json/json_writer.h>
Elly Jones03cd6d72012-06-11 13:04:28 -040013#include <base/logging.h>
Ben Chan9953a592014-02-05 23:32:00 -080014#include <base/strings/string_split.h>
15#include <base/strings/string_util.h>
Ahmed Fakhry21140cf2016-03-04 17:15:19 -080016#include <base/values.h>
Elly Jones03cd6d72012-06-11 13:04:28 -040017
Rebecca Silbersteine78af402014-10-02 10:55:04 -070018#include <chromeos/dbus/service_constants.h>
Peter Qiued45fda2015-09-09 16:52:50 -070019#include <shill/dbus_proxies/org.chromium.flimflam.Manager.h>
Rebecca Silbersteine78af402014-10-02 10:55:04 -070020
Alex Vakulenko262be3f2014-07-30 15:25:50 -070021#include "debugd/src/process_with_output.h"
Elly Jones03cd6d72012-06-11 13:04:28 -040022
23namespace debugd {
24
Elly Jones03cd6d72012-06-11 13:04:28 -040025using std::string;
26using std::vector;
27
28typedef vector<string> Strings;
29
Ahmed Fakhry21140cf2016-03-04 17:15:19 -080030const char *kDebugfsGroup = "debugfs-access";
Ben Chanf6cd93a2012-10-14 19:37:00 -070031
Ahmed Fakhry21140cf2016-03-04 17:15:19 -080032namespace {
33
34const char *kShell = "/bin/sh";
35
36// Minimum time in seconds needed to allow shill to test active connections.
37const int kConnectionTesterTimeoutSeconds = 5;
Ben Chanf6cd93a2012-10-14 19:37:00 -070038
Elly Fong-Jonesd9a16cd2012-11-12 16:09:49 -050039struct Log {
40 const char *name;
41 const char *command;
42 const char *user;
43 const char *group;
44};
45
Ahmed Fakhry21140cf2016-03-04 17:15:19 -080046const Log common_logs[] = {
Elly Jones03cd6d72012-06-11 13:04:28 -040047 { "CLIENT_ID", "/bin/cat '/home/chronos/Consent To Send Stats'" },
48 { "LOGDATE", "/bin/date" },
49 { "Xorg.0.log", "/bin/cat /var/log/Xorg.0.log" },
Elly Jones03cd6d72012-06-11 13:04:28 -040050 { "bios_info", "/bin/cat /var/log/bios_info.txt" },
Vadim Bendebury64aeeed2013-09-16 13:16:49 -070051 { "bios_log",
52 "/bin/cat /sys/firmware/log "
53 "/proc/device-tree/chosen/ap-console-buffer 2> /dev/null" },
Stefan Reinauer4393fa72012-10-18 11:08:09 -070054 { "bios_times", "/bin/cat /var/log/bios_times.txt" },
Elly Jones03cd6d72012-06-11 13:04:28 -040055 { "board-specific",
Thiemo Nagela269ad22014-11-27 17:13:01 +010056 "/usr/share/userfeedback/scripts/get_board_specific_info" },
Olof Johanssone5d0fd32016-01-29 14:40:34 -080057 { "cheets_log", "/usr/bin/collect-cheets-logs 2>&1" },
Thiemo Nagela269ad22014-11-27 17:13:01 +010058 { "clobber.log", "/bin/cat /var/log/clobber.log 2> /dev/null" },
59 { "clobber-state.log", "/bin/cat /var/log/clobber-state.log 2> /dev/null" },
Elly Jones03cd6d72012-06-11 13:04:28 -040060 { "chrome_system_log", "/bin/cat /var/log/chrome/chrome" },
Stefan Reinauer48f883d2014-08-22 14:31:58 -070061 { "console-ramoops", "/bin/cat /dev/pstore/console-ramoops 2> /dev/null" },
Elly Jones03cd6d72012-06-11 13:04:28 -040062 { "cpu", "/usr/bin/uname -p" },
63 { "cpuinfo", "/bin/cat /proc/cpuinfo" },
Elly Jones03cd6d72012-06-11 13:04:28 -040064 { "dmesg", "/bin/dmesg" },
65 { "ec_info", "/bin/cat /var/log/ec_info.txt" },
Stefan Reinauer4393fa72012-10-18 11:08:09 -070066 { "eventlog", "/bin/cat /var/log/eventlog.txt" },
Elly Fong-Jones215b5622013-03-20 14:32:18 -040067 {
68 "exynos_gem_objects",
Yuly Novikov13ece852013-07-11 17:19:10 -040069 "/bin/cat /sys/kernel/debug/dri/0/exynos_gem_objects 2> /dev/null",
Elly Fong-Jones215b5622013-03-20 14:32:18 -040070 SandboxedProcess::kDefaultUser,
71 kDebugfsGroup
72 },
Elly Jones03cd6d72012-06-11 13:04:28 -040073 { "font_info", "/usr/share/userfeedback/scripts/font_info" },
74 { "hardware_class", "/usr/bin/crossystem hwid" },
75 { "hostname", "/bin/hostname" },
76 { "hw_platform", "/usr/bin/uname -i" },
Elly Fong-Jones215b5622013-03-20 14:32:18 -040077 {
78 "i915_gem_gtt",
Yuly Novikov13ece852013-07-11 17:19:10 -040079 "/bin/cat /sys/kernel/debug/dri/0/i915_gem_gtt 2> /dev/null",
Elly Fong-Jones215b5622013-03-20 14:32:18 -040080 SandboxedProcess::kDefaultUser,
81 kDebugfsGroup
82 },
83 {
84 "i915_gem_objects",
Yuly Novikov13ece852013-07-11 17:19:10 -040085 "/bin/cat /sys/kernel/debug/dri/0/i915_gem_objects 2> /dev/null",
Elly Fong-Jones215b5622013-03-20 14:32:18 -040086 SandboxedProcess::kDefaultUser,
87 kDebugfsGroup
88 },
89 {
90 "i915_error_state",
Yuly Novikov4ac12fb2013-07-18 20:08:44 -040091 "/usr/bin/xz -c /sys/kernel/debug/dri/0/i915_error_state 2> /dev/null",
Elly Fong-Jones215b5622013-03-20 14:32:18 -040092 SandboxedProcess::kDefaultUser,
93 kDebugfsGroup,
94 },
Daniel Erat982ab4b2014-04-09 07:32:38 -070095 { "ifconfig", "/bin/ifconfig -a" },
Stefan Reinauer48f883d2014-08-22 14:31:58 -070096 { "kernel-crashes",
97 "/bin/cat /var/spool/crash/kernel.*.kcrash 2> /dev/null" },
Elly Jones03cd6d72012-06-11 13:04:28 -040098 { "lsmod", "lsmod" },
99 { "lspci", "/usr/sbin/lspci" },
100 { "lsusb", "lsusb" },
Yuly Novikov13ece852013-07-11 17:19:10 -0400101 {
Thiemo Nagela269ad22014-11-27 17:13:01 +0100102 "mali_memory",
103 "/bin/cat /sys/class/misc/mali0/device/memory 2> /dev/null"
Yuly Novikov13ece852013-07-11 17:19:10 -0400104 },
Elly Jones03cd6d72012-06-11 13:04:28 -0400105 { "meminfo", "cat /proc/meminfo" },
106 { "memory_spd_info", "/bin/cat /var/log/memory_spd_info.txt" },
Kees Cooka8f3e7e2012-11-19 14:16:01 -0800107 { "mount-encrypted", "/bin/cat /var/log/mount-encrypted.log" },
Darin Petkov54743582012-12-10 14:18:32 +0100108 { "net-diags.net.log", "/bin/cat /var/log/net-diags.net.log" },
Wade Guthrie67b672e2012-11-14 13:14:31 -0800109 { "netlog", "/usr/share/userfeedback/scripts/getmsgs --last '2 hours'"
110 " /var/log/net.log" },
henryhsufa6daa12014-09-24 13:26:30 +0800111 {
112 "nvmap_iovmm",
113 "/bin/cat /sys/kernel/debug/nvmap/iovmm/allocations 2> /dev/null",
114 SandboxedProcess::kDefaultUser,
115 kDebugfsGroup,
116 },
Vincent Palatinc64af9d2013-08-05 16:34:10 -0700117 { "platform_info", "/bin/cat /var/log/platform_info.txt" },
Daniel Erat9b58b6d2013-04-30 14:58:56 -0700118 { "power_supply_info", "/usr/bin/power_supply_info" },
Elly Jones03cd6d72012-06-11 13:04:28 -0400119 { "powerd.LATEST", "/bin/cat /var/log/power_manager/powerd.LATEST" },
Daniel Erat546c3882013-11-22 12:46:01 -0800120 { "powerd.PREVIOUS", "/bin/cat /var/log/power_manager/powerd.PREVIOUS" },
Daniel Erat93da9a12012-12-06 14:14:17 -0800121 { "powerd.out", "/bin/cat /var/log/powerd.out" },
Thiemo Nagela269ad22014-11-27 17:13:01 +0100122 { "powerwash_count", "/bin/cat /var/log/powerwash_count 2> /dev/null" },
Elly Jones03cd6d72012-06-11 13:04:28 -0400123 // Changed from 'ps ux' to 'ps aux' since we're running as debugd, not chronos
124 { "ps", "/bin/ps aux" },
Puthikorn Voravootivat6de5e122013-12-06 11:43:13 -0800125 { "storage_info", "/bin/cat /var/log/storage_info.txt" },
Elly Jones03cd6d72012-06-11 13:04:28 -0400126 { "syslog", "/usr/share/userfeedback/scripts/getmsgs --last '2 hours'"
Elly Jonesf8a67ee2012-06-19 13:48:38 -0400127 " /var/log/messages" },
Elly Fong-Jonesb4f49c42013-02-28 13:45:26 -0500128 { "tlsdate", "/bin/cat /var/log/tlsdate.log" },
Michael Spang387567d2015-03-11 17:16:04 -0400129 { "input_devices", "/bin/cat /proc/bus/input/devices" },
Elly Jones03cd6d72012-06-11 13:04:28 -0400130 { "touchpad", "/opt/google/touchpad/tpcontrol status" },
Chung-yih Wang4b876142014-04-30 17:01:49 +0800131 { "touchpad_activity", "/opt/google/input/cmt_feedback alt" },
Andrew de los Reyesc060c342013-04-10 13:46:30 -0700132 { "touch_fw_version", "grep -E"
Charlie Mooneybb08f982016-02-04 15:35:56 -0800133 " -e 'synaptics: Touchpad model'"
134 " -e 'chromeos-[a-z]*-touch-[a-z]*-update'"
Andrew de los Reyesc060c342013-04-10 13:46:30 -0700135 " /var/log/messages | tail -n 20" },
Elly Jones03cd6d72012-06-11 13:04:28 -0400136 { "ui_log", "/usr/share/userfeedback/scripts/get_log /var/log/ui/ui.LATEST" },
137 { "uname", "/bin/uname -a" },
138 { "update_engine.log", "cat $(ls -1tr /var/log/update_engine | tail -5 | sed"
Thiemo Nagela269ad22014-11-27 17:13:01 +0100139 " s.^./var/log/update_engine/.)" },
Elly Jones03cd6d72012-06-11 13:04:28 -0400140 { "verified boot", "/bin/cat /var/log/debug_vboot_noisy.log" },
141 { "vpd_2.0", "/bin/cat /var/log/vpd_2.0.txt" },
Samuel Tan107b6c82014-07-10 15:33:44 -0700142 { "wifi_status", "/usr/bin/network_diag --wifi-internal --no-log" },
Sonny Raoab5f9952013-07-17 14:13:53 -0700143 { "zram compressed data size",
144 "/bin/cat /sys/block/zram0/compr_data_size 2> /dev/null" },
145 { "zram original data size",
146 "/bin/cat /sys/block/zram0/orig_data_size 2> /dev/null" },
147 { "zram total memory used",
148 "/bin/cat /sys/block/zram0/mem_used_total 2> /dev/null" },
149 { "zram total reads",
150 "/bin/cat /sys/block/zram0/num_reads 2> /dev/null" },
151 { "zram total writes",
152 "/bin/cat /sys/block/zram0/num_writes 2> /dev/null" },
Gaurav Shah6e8fd892012-10-01 11:51:08 -0700153
Elly Jones03cd6d72012-06-11 13:04:28 -0400154 // Stuff pulled out of the original list. These need access to the running X
155 // session, which we'd rather not give to debugd, or return info specific to
156 // the current session (in the setsid(2) sense), which is not useful for
157 // debugd
158 // { "env", "set" },
159 // { "setxkbmap", "/usr/bin/setxkbmap -print -query" },
160 // { "xrandr", "/usr/bin/xrandr --verbose" }
Elly Jones533c7c42012-08-10 15:07:05 -0400161 { NULL, NULL }
162};
163
Ahmed Fakhry21140cf2016-03-04 17:15:19 -0800164const Log extra_logs[] = {
Ben Chan36e42282014-02-12 22:32:34 -0800165#if USE_CELLULAR
Elly Jones533c7c42012-08-10 15:07:05 -0400166 { "mm-status", "/usr/bin/modem status" },
Ben Chan36e42282014-02-12 22:32:34 -0800167#endif // USE_CELLULAR
Elly Jones533c7c42012-08-10 15:07:05 -0400168 { "network-devices", "/usr/bin/connectivity show devices" },
169 { "network-services", "/usr/bin/connectivity show services" },
170 { NULL, NULL }
171};
172
Ahmed Fakhry21140cf2016-03-04 17:15:19 -0800173const Log feedback_logs[] = {
Ben Chan36e42282014-02-12 22:32:34 -0800174#if USE_CELLULAR
Elly Jones533c7c42012-08-10 15:07:05 -0400175 { "mm-status", "/usr/bin/modem status-feedback" },
Ben Chan36e42282014-02-12 22:32:34 -0800176#endif // USE_CELLULAR
Elly Jones533c7c42012-08-10 15:07:05 -0400177 { "network-devices", "/usr/bin/connectivity show-feedback devices" },
178 { "network-services", "/usr/bin/connectivity show-feedback services" },
179 { NULL, NULL }
Elly Jones03cd6d72012-06-11 13:04:28 -0400180};
181
Gaurav Shahf6c8f2a2012-10-11 17:22:43 -0700182// List of log files that must directly be collected by Chrome. This is because
183// debugd is running under a VFS namespace and does not have access to later
184// cryptohome mounts.
Ahmed Fakhry21140cf2016-03-04 17:15:19 -0800185const Log user_logs[] = {
Elly Fong-Jones6456ce52013-04-17 13:31:13 -0400186 {"chrome_user_log", "log/chrome"},
187 {"login-times", "login-times"},
188 {"logout-times", "logout-times"},
Gaurav Shahf6c8f2a2012-10-11 17:22:43 -0700189 { NULL, NULL}
190};
191
Ahmed Fakhry21140cf2016-03-04 17:15:19 -0800192class ManagerProxy : public org::chromium::flimflam::Manager_proxy,
193 public DBus::ObjectProxy {
194 public:
195 ManagerProxy(DBus::Connection* connection,
196 const char* path,
197 const char* service)
198 : DBus::ObjectProxy(*connection, path, service) {}
199 ~ManagerProxy() override = default;
200 void PropertyChanged(const std::string&, const DBus::Variant&) override {}
201 void StateChanged(const std::string&) override {}
202};
203
204// Returns |value| if |value| is a valid UTF-8 string or a base64-encoded
205// string of |value| otherwise.
206string EnsureUTF8String(const string& value) {
207 if (base::IsStringUTF8(value))
208 return value;
209
210 gchar* base64_value = g_base64_encode(
211 reinterpret_cast<const guchar*>(value.c_str()), value.length());
212 if (base64_value) {
213 string encoded_value = "<base64>: ";
214 encoded_value += base64_value;
215 g_free(base64_value);
216 return encoded_value;
217 }
218 return "<invalid>";
219}
220
221// TODO(ellyjones): sandbox. crosbug.com/35122
222string Run(const Log& log) {
223 string output;
224 ProcessWithOutput p;
225 string tailed_cmdline = std::string(log.command) + " | tail -c 256K";
226 if (log.user && log.group)
227 p.SandboxAs(log.user, log.group);
228 if (!p.Init())
229 return "<not available>";
230 p.AddArg(kShell);
231 p.AddStringOption("-c", tailed_cmdline);
232 if (p.Run())
233 return "<not available>";
234 p.GetOutput(&output);
235 if (!output.size())
236 return "<empty>";
237 return EnsureUTF8String(output);
238}
239
240// Fills |dictionary| with the anonymized contents of the logs in |logs|.
241void GetLogsInDictionary(const struct Log* logs,
242 AnonymizerTool* anonymizer,
243 base::DictionaryValue* dictionary) {
244 for (size_t i = 0; logs[i].name; ++i) {
245 dictionary->SetStringWithoutPathExpansion(
246 logs[i].name, anonymizer->Anonymize(Run(logs[i])));
247 }
248}
249
250// Serializes the |dictionary| into the file with the given |fd| in a JSON
251// format.
252void SerializeLogsAsJSON(const base::DictionaryValue& dictionary,
253 const DBus::FileDescriptor& fd) {
254 std::string logs_json;
255 base::JSONWriter::WriteWithOptions(dictionary,
256 base::JSONWriter::OPTIONS_PRETTY_PRINT,
257 &logs_json);
258 base::WriteFileDescriptor(fd.get(), logs_json.c_str(), logs_json.size());
259}
260
Elly Jones533c7c42012-08-10 15:07:05 -0400261bool GetNamedLogFrom(const string& name, const struct Log* logs,
262 string* result) {
263 for (size_t i = 0; logs[i].name; i++) {
264 if (name == logs[i].name) {
Elly Fong-Jonesd9a16cd2012-11-12 16:09:49 -0500265 *result = Run(logs[i]);
Elly Jones533c7c42012-08-10 15:07:05 -0400266 return true;
267 }
268 }
269 *result = "<invalid log name>";
270 return false;
Elly Jones03cd6d72012-06-11 13:04:28 -0400271}
272
Ahmed Fakhry21140cf2016-03-04 17:15:19 -0800273void GetLogsFrom(const struct Log* logs, LogTool::LogMap* map) {
274 for (size_t i = 0; logs[i].name; i++)
275 (*map)[logs[i].name] = Run(logs[i]);
276}
277
278} // namespace
279
Rebecca Silbersteine78af402014-10-02 10:55:04 -0700280void LogTool::CreateConnectivityReport(DBus::Connection* connection) {
281 // Perform ConnectivityTrial to report connection state in feedback log.
282 ManagerProxy shill(connection,
283 shill::kFlimflamServicePath,
284 shill::kFlimflamServiceName);
285 shill.CreateConnectivityReport();
286 // Give the connection trial time to test the connection and log the results
287 // before collecting the logs for feedback.
288 // TODO(silberst): Replace the simple approach of a single timeout with a more
289 // coordinated effort.
290 sleep(kConnectionTesterTimeoutSeconds);
291}
292
Ben Chana0011d82014-05-13 00:19:29 -0700293string LogTool::GetLog(const string& name, DBus::Error* error) {
Elly Jones533c7c42012-08-10 15:07:05 -0400294 string result;
295 GetNamedLogFrom(name, common_logs, &result)
296 || GetNamedLogFrom(name, extra_logs, &result)
297 || GetNamedLogFrom(name, feedback_logs, &result);
298 return result;
299}
300
Rebecca Silbersteine78af402014-10-02 10:55:04 -0700301LogTool::LogMap LogTool::GetAllLogs(DBus::Connection* connection,
302 DBus::Error* error) {
303 CreateConnectivityReport(connection);
Elly Jones533c7c42012-08-10 15:07:05 -0400304 LogMap result;
305 GetLogsFrom(common_logs, &result);
306 GetLogsFrom(extra_logs, &result);
307 return result;
308}
309
Rebecca Silbersteine78af402014-10-02 10:55:04 -0700310LogTool::LogMap LogTool::GetFeedbackLogs(DBus::Connection* connection,
311 DBus::Error* error) {
312 CreateConnectivityReport(connection);
Elly Jones533c7c42012-08-10 15:07:05 -0400313 LogMap result;
314 GetLogsFrom(common_logs, &result);
315 GetLogsFrom(feedback_logs, &result);
Darin Petkovce9b3a12013-01-10 16:38:54 +0100316 AnonymizeLogMap(&result);
Elly Jones03cd6d72012-06-11 13:04:28 -0400317 return result;
318}
319
Ahmed Fakhry21140cf2016-03-04 17:15:19 -0800320void LogTool::GetBigFeedbackLogs(DBus::Connection* connection,
321 const DBus::FileDescriptor& fd,
322 DBus::Error* error) {
323 CreateConnectivityReport(connection);
324 base::DictionaryValue dictionary;
325 GetLogsInDictionary(common_logs, &anonymizer_, &dictionary);
326 GetLogsInDictionary(feedback_logs, &anonymizer_, &dictionary);
327 SerializeLogsAsJSON(dictionary, fd);
328}
329
Ben Chana0011d82014-05-13 00:19:29 -0700330LogTool::LogMap LogTool::GetUserLogFiles(DBus::Error* error) {
Gaurav Shahf6c8f2a2012-10-11 17:22:43 -0700331 LogMap result;
332 for (size_t i = 0; user_logs[i].name; ++i)
333 result[user_logs[i].name] = user_logs[i].command;
334 return result;
335}
336
Darin Petkovce9b3a12013-01-10 16:38:54 +0100337void LogTool::AnonymizeLogMap(LogMap* log_map) {
Darin Petkovce9b3a12013-01-10 16:38:54 +0100338 for (LogMap::iterator it = log_map->begin();
339 it != log_map->end(); ++it) {
Ahmed Fakhry21140cf2016-03-04 17:15:19 -0800340 it->second = anonymizer_.Anonymize(it->second);
Darin Petkovce9b3a12013-01-10 16:38:54 +0100341 }
342}
343
Ben Chana0011d82014-05-13 00:19:29 -0700344} // namespace debugd