Add statistics about free space to microdump format.

src/client/linux/microdump_writer/microdump_writer.cc

 // Copyright (c) 2014, Google Inc.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms, with or without
 // modification, are permitted provided that the following conditions are
 // met:
 //
 //     * Redistributions of source code must retain the above copyright
 // notice, this list of conditions and the following disclaimer.
 //     * Redistributions in binary form must reproduce the above
@@ skipping 13 matching lines @@
 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 // This translation unit generates microdumps into the console (logcat on
 // Android). See crbug.com/410294 for more info and design docs.
 
 #include "client/linux/microdump_writer/microdump_writer.h"
 

[Primiano Tucci (use gerrit), 2016/04/07 18:07:39]

in general in breakpad client we don't allow anything that might call into libc,
as we cannot trust libc itself (see explanation below)

[Tobias Sargeant, 2016/05/03 13:43:19]

Acknowledged.

+#include <algorithm>
 #include <sys/utsname.h>
 
 #include "client/linux/dump_writer_common/thread_info.h"
 #include "client/linux/dump_writer_common/ucontext_reader.h"
 #include "client/linux/handler/exception_handler.h"
 #include "client/linux/handler/microdump_extra_info.h"
 #include "client/linux/log/log.h"
 #include "client/linux/minidump_writer/linux_ptrace_dumper.h"
 #include "common/linux/linux_libc_support.h"
+#include "common/memory.h"
 
 namespace {
 
 using google_breakpad::ExceptionHandler;
 using google_breakpad::LinuxDumper;
 using google_breakpad::LinuxPtraceDumper;
 using google_breakpad::MappingInfo;
 using google_breakpad::MappingList;
 using google_breakpad::MicrodumpExtraInfo;
 using google_breakpad::RawContextCPU;
@@ skipping 32 matching lines @@
       return false;
     return dumper_->ThreadsSuspend() && dumper_->LateInit();
   }
 
   bool Dump() {
     bool success;
     LogLine("-----BEGIN BREAKPAD MICRODUMP-----");
     DumpProductInformation();
     DumpOSInformation();
     DumpGPUInformation();
+    DumpFreeSpace();
     success = DumpCrashingThread();
     if (success)
       success = DumpMappings();
     LogLine("-----END BREAKPAD MICRODUMP-----");
     dumper_->ThreadsResume();
     return success;
   }
 
  private:
   // Writes one line to the system log.
@@ skipping 263 matching lines @@
     LogAppend(module_identifier.data4[3]);
     LogAppend(module_identifier.data4[4]);
     LogAppend(module_identifier.data4[5]);
     LogAppend(module_identifier.data4[6]);
     LogAppend(module_identifier.data4[7]);
     LogAppend("0 ");  // Age is always 0 on Linux.
     LogAppend(file_name);
     LogCommitLine();
   }
 
+  static bool MappingsAreAdjacent(const MappingInfo *a, const MappingInfo *b) {

[Primiano Tucci (use gerrit), 2016/04/07 18:07:39]

should these static functions just be anonymous namespace functions?

[Primiano Tucci (use gerrit), 2016/04/07 18:07:39]

nit: * should be close to the type, i.e. MappingInfo* . same below.

+    // Because of load biasing, we can end up with a situation where two
+    // mappings actually overlap. So we will define adjacency to also include a
+    // b start address that lies within a's address range (including starting
+    // immediately after a).
+    // Because load biasing only ever moves the start address backwards, the end
+    // address should still increase.
+    return a->start_addr <= b->start_addr &&
+           a->start_addr + a->size >= b->start_addr;
+  }
+
+  static bool StartAddrLessThan(const MappingInfo *a, const MappingInfo *b) {
+    return a->start_addr < b->start_addr;
+  }
+
+  static size_t NextOrderedMapping(
+      const google_breakpad::wasteful_vector<MappingInfo*>& mappings,
+      size_t curr) {
+    size_t best = mappings.size();
+    for (size_t next = 0; next < mappings.size(); ++next) {
+      if (StartAddrLessThan(mappings[curr], mappings[next])) {
+        if (best == mappings.size() ||
+            StartAddrLessThan(mappings[next], mappings[best]))
+          best = next;
+      }
+    }
+    return best;
+  }
+
+  bool DumpFreeSpace() {
+    const google_breakpad::wasteful_vector<MappingInfo*>& mappings =
+        dumper_->mappings();
+    if (mappings.size() == 0) return false;
+
+    // This is complicated by the fact that mappings is not in order. It should
+    // be mostly in order, however the mapping that contains the entry point for
+    // the process is always at the front of the vector.
+
+    static const int HBITS = sizeof(size_t)*8;

[Primiano Tucci (use gerrit), 2016/04/07 18:07:39]

nit: space between ) * 8

[Tobias Sargeant, 2016/05/03 13:43:19]

Done.

+    int hole_hist[HBITS];
+    std::fill(hole_hist, hole_hist + HBITS, 0);

[Primiano Tucci (use gerrit), 2016/04/07 18:07:39]

nope, in breakpad we cannot rely on any std lib function, as they migh call libc
function that we cannot trust (because they might take locks which are held when
in a crash state).

my_memset if what you have to live with :)

[Tobias Sargeant, 2016/05/03 13:43:19]

Done.

+
+    // Find the lowest address mapping.
+    size_t curr =
+        std::min_element(mappings.begin(), mappings.end(), StartAddrLessThan) -
+        mappings.begin();
+
+    uintptr_t lo_addr = mappings[curr]->start_addr;
+
+    int hole_cnt = 0;
+    size_t hole_max = 0;
+    size_t hole_tot = 0;
+
+    while (true) {
+      // Skip to the end of an adjacent run of mappings. This is an optimization
+      // for the fact that mappings is mostly sorted.
+      while (curr != mappings.size() - 1 &&
+             MappingsAreAdjacent(mappings[curr], mappings[curr + 1]))
+        ++curr;
+
+      size_t next = NextOrderedMapping(mappings, curr);
+      if (next == mappings.size())
+        break;
+
+      uintptr_t hole_lo = mappings[curr]->start_addr + mappings[curr]->size;
+      uintptr_t hole_hi = mappings[next]->start_addr;
+
+      if (hole_hi > hole_lo) {
+        size_t hole_sz = hole_hi - hole_lo;
+        hole_tot += hole_sz;
+        hole_max = std::max(hole_sz, hole_max);
+        ++hole_cnt;
+        size_t h = 0;
+        while (hole_sz) {
+          ++h;
+          hole_sz >>= 1;
+        }
+        ++hole_hist[h];
+      }
+      curr = next;
+    }
+
+    uintptr_t hi_addr = mappings[curr]->start_addr + mappings[curr]->size;
+
+    LogAppend("H ");
+    LogAppend(lo_addr);
+    LogAppend(" ");
+    LogAppend(hi_addr);
+
+    char buf[32];
+    snprintf(buf, 32, " %d %0zX %0zX", hole_cnt, hole_max, hole_tot);

[Primiano Tucci (use gerrit), 2016/04/07 18:07:39]

no snprintf for same reason. Please use the LogAppend() facilities to dump hex.

[Tobias Sargeant, 2016/05/03 13:43:19]

Done.

+    LogAppend(buf);
+    for (int i = 0; i < HBITS; ++i) {
+      if (!hole_hist[i]) continue;
+      snprintf(buf, 32, " %d:%d", i, hole_hist[i]);
+      LogAppend(buf);
+    }
+    LogCommitLine();
+    return true;
+  }
+
   // Write information about the mappings in effect.
   bool DumpMappings() {
     // First write all the mappings from the dumper
     for (unsigned i = 0; i < dumper_->mappings().size(); ++i) {
       const MappingInfo& mapping = *dumper_->mappings()[i];
       if (mapping.name[0] == 0 ||  // only want modules with filenames.
           !mapping.exec ||  // only want executable mappings.
           mapping.size < 4096 || // too small to get a signature for.
           HaveMappingInfo(mapping)) {
         continue;
@@ skipping 41 matching lines @@
     dumper.set_crash_signal(context->siginfo.si_signo);
     dumper.set_crash_thread(context->tid);
   }
   MicrodumpWriter writer(context, mappings, microdump_extra_info, &dumper);
   if (!writer.Init())
     return false;
   return writer.Dump();
 }
 
 }  // namespace google_breakpad