Add MinidumpCrashpadInfo::simple_annotations

snapshot/process_snapshot.h

 // Copyright 2014 The Crashpad Authors. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
 //     http://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
 #ifndef CRASHPAD_SNAPSHOT_PROCESS_SNAPSHOT_H_
 #define CRASHPAD_SNAPSHOT_PROCESS_SNAPSHOT_H_
 
 #include <sys/time.h>
 #include <sys/types.h>
 
+#include <map>
+#include <string>
 #include <vector>
 
 namespace crashpad {
 
 class ExceptionSnapshot;
 class ModuleSnapshot;
 class SystemSnapshot;
 class ThreadSnapshot;
 
 //! \brief An abstract interface to a snapshot representing the state of a
@@ skipping 37 matching lines @@
   //! \brief Returns the snapshot process’ CPU usage times in \a user_time and
   //!     \a system_time.
   //!
   //! \param[out] user_time The time that the process has spent executing in
   //!     user mode.
   //! \param[out] system_time The time that the process has spent executing in
   //!     system (kernel) mode.
   virtual void ProcessCPUTimes(timeval* user_time,
                                timeval* system_time) const = 0;
 
+  //! \brief Returns key-value string annotations recorded for the process,
+  //!     system, or snapshot producer.
+  //!
+  //! This method retrieves annotations recorded for a process. These
+  //! annotations are intended for diagnostic use, including crash analysis.
+  //! “Simple annotations” are structured as a sequence of key-value pairs,
+  //! where all keys and values are strings. These are referred to in Chrome as
+  //! “crash keys.”
+  //!
+  //! Annotations stored here may reflect the process, system, or snapshot
+  //! producer. Most annotations not under the client’s direct control will be
+  //! retrievable by this method. For clients such as Chrome, this includes the
+  //! product name and version.
+  //!
+  //! Additional per-module annotations may be obtained by calling
+  //! ModuleSnapshot::AnnotationsSimpleMap().
+  virtual std::map<std::string, std::string> AnnotationsSimpleMap() const = 0;

[Robert Sesek, 2015/02/17 22:20:35]

This could be a const& instead, since the objects returned by the other methods
here are guaranteed to be owned by the snapshot.

[Mark Mentovai, 2015/02/17 22:22:01]

Robert Sesek wrote:
Is it fair to impose that at the interface level, though? Or just let it stand
for now and drop it if it becomes a problem in the future?

[Robert Sesek, 2015/02/17 22:23:14]

I don't feel strongly, but the copy seems like it could be heavy, and it's
unnecessary with the current implementations. All the other objects returned off
this interface are const*, though.

+
   //! \brief Returns a SystemSnapshot reflecting the characteristics of the
   //!     system that ran the snapshot process at the time of the snapshot.
   //!
   //! \return A SystemSnapshot object. The caller does not take ownership of
   //!     this object, it is scoped to the lifetime of the ProcessSnapshot
   //!     object that it was obtained from.
   virtual const SystemSnapshot* System() const = 0;
 
   //! \brief Returns ModuleSnapshot objects reflecting the code modules (binary
   //!     images) loaded into the snapshot process at the time of the snapshot.
@@ skipping 18 matching lines @@
   //! \return An ExceptionSnapshot object. The caller does not take ownership of
   //!     this object, it is scoped to the lifetime of the ProcessSnapshot
   //!     object that it was obtained from. If the snapshot is not a result of
   //!     an exception, returns `nullptr`.
   virtual const ExceptionSnapshot* Exception() const = 0;
 };
 
 }  // namespace crashpad
 
 #endif  // CRASHPAD_SNAPSHOT_PROCESS_SNAPSHOT_H_