chrome/browser/bad_message.h

   1 // Copyright 2015 The Chromium 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
   5 #ifndef CHROME_BROWSER_BAD_MESSAGE_H_
   6 #define CHROME_BROWSER_BAD_MESSAGE_H_
   7
   8 namespace content {
   9 class BrowserMessageFilter;
  10 class RenderProcessHost;
  11 }
  12
  13 namespace bad_message {
  14
  15 // The browser process often chooses to terminate a renderer if it receives
  16 // a bad IPC message. The reasons are tracked for metrics.
  17 //
  18 // See also content/browser/bad_message.h.
  19 //
  20 // NOTE: Do not remove or reorder elements in this list. Add new entries at the
  21 // end. Items may be renamed but do not change the values. We rely on the enum
  22 // values in histograms.
  23 enum BadMessageReason {
  24   WRLHH_LOGGING_STOPPED_BAD_STATE = 0,
  25
  26   // Please add new elements here. The naming convention is abbreviated class
  27   // name (e.g. RenderFrameHost becomes RFH) plus a unique description of the
  28   // reason. After making changes, you MUST update histograms.xml by running:
  29   // "python tools/metrics/histograms/update_bad_message_reasons.py"
  30   BAD_MESSAGE_MAX
  31 };
  32
  33 // Called when the browser receives a bad IPC message from a renderer process on
  34 // the UI thread. Logs the event, records a histogram metric for the |reason|,
  35 // and terminates the process for |host|.
  36 void ReceivedBadMessage(content::RenderProcessHost* host,
  37                         BadMessageReason reason);
  38
  39 // Called when a browser message filter receives a bad IPC message from a
  40 // renderer or other child process. Logs the event, records a histogram metric
  41 // for the |reason|, and terminates the process for |filter|.
  42 void ReceivedBadMessage(content::BrowserMessageFilter* filter,
  43                         BadMessageReason reason);
  44
  45 }  // namespace bad_message
  46
  47 #endif  // CHROME_BROWSER_BAD_MESSAGE_H_