Add ARM support

kernel_collector.cc

 // Copyright (c) 2010 The Chromium OS Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "crash-reporter/kernel_collector.h"
 
 #include "base/file_util.h"
 #include "base/logging.h"
 #include "base/string_util.h"
 
 const char KernelCollector::kClearingSequence[] = " ";
 static const char kDefaultKernelStackSignature[] =
     "kernel-UnspecifiedStackSignature";
 static const char kKernelExecName[] = "kernel";
 const pid_t kKernelPid = 0;
 static const char kKernelSignatureKey[] = "sig";
 // Byte length of maximum human readable portion of a kernel crash signature.
 static const int kMaxHumanStringLength = 40;
 static const char kPreservedDumpPath[] = "/sys/kernel/debug/preserved/kcrash";
 const uid_t kRootUid = 0;
 // Time in seconds from the final kernel log message for a call stack
-// to count towards the signature of the kcrash.
+// to count towards the not be gesignature of the kcrash.

[Michael Krebs, 2011/03/29 02:20:18]

Was this an intentional comment change?

[sjg, 2011/04/01 20:04:15]

Nope. It seems to be gone now so must have been a typo.

 static const int kSignatureTimestampWindow = 2;
 // Kernel log timestamp regular expression.
 static const std::string kTimestampRegex("^<.*>\\[\\s*(\\d+\\.\\d+)\\]");
 
+/*
+ * For ARM we see:
+ *   "<5>[   39.458982] PC is at write_breakme+0xd0/0x1b4"
+ * For x86:
+ *   "<0>[   37.474699] EIP: [<790ed488>] write_breakme+0x80/0x108 \
+ *    SS:ESP 0068:e9dd3efc
+ */
+static const std::string pcRegex[KernelCollector::archCount] = {

[Michael Krebs, 2011/03/29 02:20:18]

I believe using std::string is not normally allowed for globals (according to
"http://www.corp.google.com/eng/doc/cppguide.xml#Static_and_Global_Variables"),
but considering kTimestampRegex is already one, I guess this is okay since it's
consistent.

+  " PC is at ([^\\+ ]+).*",
+  " EIP: \\[<.*>\\] ([^\\+ ]+).*",  // X86 uses EIP for the program counter
+  " Unsupported architecture"

[Michael Krebs, 2011/03/29 02:20:18]

If it's an unknown architecture, it might be better to give some sort of
error/warning instead of trying to match on "Unsupported architecture" as a
regex (see my comment below).

[sjg, 2011/04/01 20:04:15]

Have added a warning in the constructor and a test to catch it.

+};
+
 KernelCollector::KernelCollector()
     : is_enabled_(false),
       preserved_dump_path_(kPreservedDumpPath) {
 }
 
 KernelCollector::~KernelCollector() {
 }
 
 void KernelCollector::OverridePreservedDumpPath(const FilePath &file_path) {
   preserved_dump_path_ = file_path;
@@ skipping 46 matching lines @@
     hash = hash * 16127 + input[i];
   return hash;
 }
 
 void KernelCollector::ProcessStackTrace(
     pcrecpp::StringPiece kernel_dump,
     bool print_diagnostics,
     unsigned *hash,
     float *last_stack_timestamp) {
   pcrecpp::RE line_re("(.+)", pcrecpp::MULTILINE());
-  pcrecpp::RE stack_trace_start_re(kTimestampRegex + " Call Trace:$");
+  pcrecpp::RE stack_trace_start_re(kTimestampRegex +
+        " (Call Trace|Backtrace):$");
   // Match lines such as the following and grab out "error_code".
-  // <4>[ 6066.849504]  [<7937bcee>] error_code+0x66/0x6c
+  // <4>[ 6066.849504]  [<7937bcee>] ? error_code+0x66/0x6c
+  // The ? may or may not be present
+
+  // For ARM:
+  // <4>[ 3498.731164] [<c0057220>] (__bug+0x20/0x2c) from [<c018062c>]
+  // (write_breakme+0xdc/0x1bc)
   pcrecpp::RE stack_entry_re(kTimestampRegex +
-                             "  \\[<.*>\\]([\\s\\?]+)([^\\+ ]+)");
+    "\\s+\\[<[[:xdigit:]]+>\\]"      // Matches "  [<7937bcee>]"
+    "([\\s\\?(]+)"                   // Matches " ? ("
+    "([^\\+ )]+)");                  // Matches until \ + space )
   std::string line;
   std::string hashable;
 
   *hash = 0;
   *last_stack_timestamp = 0;
 
   while (line_re.FindAndConsume(&kernel_dump, &line)) {
     std::string certainty;
     std::string function_name;
     if (stack_trace_start_re.PartialMatch(line, last_stack_timestamp)) {
@@ skipping 22 matching lines @@
   }
 
   *hash = HashString(hashable);
 
   if (print_diagnostics) {
     printf("Hash based on stack trace: \"%s\" at %f.\n",
            hashable.c_str(), *last_stack_timestamp);
   }
 }
 
+enum KernelCollector::ArchKind KernelCollector::GetArch(void)
+{
+#if defined(COMPILER_GCC) && defined(ARCH_CPU_ARM_FAMILY)
+  return archArm;
+#elif defined(COMPILER_GCC) && defined(ARCH_CPU_X86_FAMILY)
+  return archX86;
+#else
+  return archUnknown;
+#endif
+}
+
 bool KernelCollector::FindCrashingFunction(
-    pcrecpp::StringPiece kernel_dump,
-    bool print_diagnostics,
-    float stack_trace_timestamp,
-    std::string *crashing_function) {
-  pcrecpp::RE eip_re(kTimestampRegex + " EIP: \\[<.*>\\] ([^\\+ ]+).*",
+  pcrecpp::StringPiece kernel_dump,
+  bool print_diagnostics,
+  float stack_trace_timestamp,
+  std::string *crashing_function) {
+  float timestamp = 0;
+
+  // Use the correct regex for this architecture.
+  pcrecpp::RE eip_re(kTimestampRegex + pcRegex[GetArch()],

[Michael Krebs, 2011/03/29 02:20:18]

This very well may be okay (I'm new to what the standards are here), but
personally I'm inclined to say that a check should be put before pcRegex[] is
indexed.  For example, if an architecture is added but someone forgets to update
pcRegex[], then this will [probably] get undesired results.

[sjg, 2011/04/01 20:04:15]

I would hope that the compiler will complain if you forget since pcRegex[] has a
fixed number of members.

[Michael Krebs, 2011/04/05 00:43:56]

My concern was more like what Ken just mentioned.. that you would get an empty
string out of pcRegex[] if an architecture was added but pcRegex[] was not
updated.

Your pcRegex[] will always have archCount number of entries.  Therefore, if an
architecture is added to enum ArchKind the size of pcRegex[] will automatically
increase -- so you at least won't get an out-of-bounds access at run-time -- but
you could get the undesired results.

For example, if someone were to add "archPowerPC" after archX86, but forgot to
update pcRegex[], then this code would return a regex of " Unsupported
architecture" for it, and the compiler would not complain.  If "archSH" was then
added after that, pcRegex[archSH] would return an empty string.

                      pcrecpp::MULTILINE());
-  float timestamp = 0;
+
   while (eip_re.FindAndConsume(&kernel_dump, &timestamp, crashing_function)) {
     if (print_diagnostics) {
       printf("@%f: found crashing function %s\n",
              timestamp,
              crashing_function->c_str());
     }
   }
   if (timestamp == 0) {
     if (print_diagnostics) {
       printf("Found no crashing function.\n");
@@ skipping 136 matching lines @@
         kernel_crash_path.value());
 
     LOG(INFO) << "Stored kcrash to " << kernel_crash_path.value();
   }
   if (!ClearPreservedDump()) {
     return false;
   }
 
   return true;
 }