content/common/child_process_messages.h

   1 // Copyright (c) 2012 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 // Common IPC messages used for child processes.
   6 // Multiply-included message file, hence no include guard.
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/memory/shared_memory.h"
  12 #include "base/tracked_objects.h"
  13 #include "base/values.h"
  14 #include "cc/resources/shared_bitmap_manager.h"
  15 #include "content/common/content_export.h"
  16 #include "content/common/host_discardable_shared_memory_manager.h"
  17 #include "ipc/ipc_message_macros.h"
  18 #include "ui/gfx/gpu_memory_buffer.h"
  19 #include "ui/gfx/ipc/gfx_param_traits.h"
  20
  21 #if defined(OS_MACOSX)
  22 #include "content/common/mac/io_surface_manager_token.h"
  23 #endif
  24
  25 IPC_ENUM_TRAITS_MAX_VALUE(tracked_objects::ThreadData::Status,
  26                           tracked_objects::ThreadData::STATUS_LAST)
  27
  28 IPC_STRUCT_TRAITS_BEGIN(tracked_objects::LocationSnapshot)
  29   IPC_STRUCT_TRAITS_MEMBER(file_name)
  30   IPC_STRUCT_TRAITS_MEMBER(function_name)
  31   IPC_STRUCT_TRAITS_MEMBER(line_number)
  32 IPC_STRUCT_TRAITS_END()
  33
  34 IPC_STRUCT_TRAITS_BEGIN(tracked_objects::BirthOnThreadSnapshot)
  35   IPC_STRUCT_TRAITS_MEMBER(location)
  36   IPC_STRUCT_TRAITS_MEMBER(thread_name)
  37 IPC_STRUCT_TRAITS_END()
  38
  39 IPC_STRUCT_TRAITS_BEGIN(tracked_objects::DeathDataSnapshot)
  40   IPC_STRUCT_TRAITS_MEMBER(count)
  41   IPC_STRUCT_TRAITS_MEMBER(run_duration_sum)
  42   IPC_STRUCT_TRAITS_MEMBER(run_duration_max)
  43   IPC_STRUCT_TRAITS_MEMBER(run_duration_sample)
  44   IPC_STRUCT_TRAITS_MEMBER(queue_duration_sum)
  45   IPC_STRUCT_TRAITS_MEMBER(queue_duration_max)
  46   IPC_STRUCT_TRAITS_MEMBER(queue_duration_sample)
  47 IPC_STRUCT_TRAITS_END()
  48
  49 IPC_STRUCT_TRAITS_BEGIN(tracked_objects::TaskSnapshot)
  50   IPC_STRUCT_TRAITS_MEMBER(birth)
  51   IPC_STRUCT_TRAITS_MEMBER(death_data)
  52   IPC_STRUCT_TRAITS_MEMBER(death_thread_name)
  53 IPC_STRUCT_TRAITS_END()
  54
  55 IPC_STRUCT_TRAITS_BEGIN(tracked_objects::ProcessDataPhaseSnapshot)
  56   IPC_STRUCT_TRAITS_MEMBER(tasks)
  57 IPC_STRUCT_TRAITS_END()
  58
  59 IPC_STRUCT_TRAITS_BEGIN(tracked_objects::ProcessDataSnapshot)
  60   IPC_STRUCT_TRAITS_MEMBER(phased_snapshots)
  61   IPC_STRUCT_TRAITS_MEMBER(process_id)
  62 IPC_STRUCT_TRAITS_END()
  63
  64 IPC_ENUM_TRAITS_MAX_VALUE(gfx::GpuMemoryBufferType,
  65                           gfx::GPU_MEMORY_BUFFER_TYPE_LAST)
  66
  67 IPC_STRUCT_TRAITS_BEGIN(gfx::GpuMemoryBufferHandle)
  68   IPC_STRUCT_TRAITS_MEMBER(id)
  69   IPC_STRUCT_TRAITS_MEMBER(type)
  70   IPC_STRUCT_TRAITS_MEMBER(handle)
  71 IPC_STRUCT_TRAITS_END()
  72
  73 #undef IPC_MESSAGE_EXPORT
  74 #define IPC_MESSAGE_EXPORT CONTENT_EXPORT
  75
  76 #define IPC_MESSAGE_START ChildProcessMsgStart
  77
  78 // Messages sent from the browser to the child process.
  79
  80 // Sent in response to ChildProcessHostMsg_ShutdownRequest to tell the child
  81 // process that it's safe to shutdown.
  82 IPC_MESSAGE_CONTROL0(ChildProcessMsg_Shutdown)
  83
  84 #if defined(IPC_MESSAGE_LOG_ENABLED)
  85 // Tell the child process to begin or end IPC message logging.
  86 IPC_MESSAGE_CONTROL1(ChildProcessMsg_SetIPCLoggingEnabled,
  87                      bool /* on or off */)
  88 #endif
  89
  90 // Tell the child process to enable or disable the profiler status.
  91 IPC_MESSAGE_CONTROL1(ChildProcessMsg_SetProfilerStatus,
  92                      tracked_objects::ThreadData::Status /* profiler status */)
  93
  94 // Send to all the child processes to send back profiler data (ThreadData in
  95 // tracked_objects).
  96 IPC_MESSAGE_CONTROL2(ChildProcessMsg_GetChildProfilerData,
  97                      int /* sequence_number */,
  98                      int /* current_profiling_phase */)
  99
 100 // Send to all the child processes to mark the current profiling phase as
 101 // finished and start a new phase.
 102 IPC_MESSAGE_CONTROL1(ChildProcessMsg_ProfilingPhaseCompleted,
 103                      int /* profiling_phase */)
 104
 105 // Send to all the child processes to send back histogram data.
 106 IPC_MESSAGE_CONTROL1(ChildProcessMsg_GetChildHistogramData,
 107                      int /* sequence_number */)
 108
 109 // Sent to child processes to tell them to enter or leave background mode.
 110 IPC_MESSAGE_CONTROL1(ChildProcessMsg_SetProcessBackgrounded,
 111                      bool /* background */)
 112
 113 #if defined(USE_TCMALLOC)
 114 // Sent to child process to request tcmalloc stats.
 115 IPC_MESSAGE_CONTROL0(ChildProcessMsg_GetTcmallocStats)
 116 #endif
 117
 118 #if defined(OS_MACOSX)
 119 // Sent to child processes to tell them what token to use when registering
 120 // and/or acquiring IOSurfaces.
 121 IPC_MESSAGE_CONTROL1(ChildProcessMsg_SetIOSurfaceManagerToken,
 122                      content::IOSurfaceManagerToken /* token */)
 123 #endif
 124
 125 ////////////////////////////////////////////////////////////////////////////////
 126 // Messages sent from the child process to the browser.
 127
 128 IPC_MESSAGE_CONTROL0(ChildProcessHostMsg_ShutdownRequest)
 129
 130 // Send back profiler data (ThreadData in tracked_objects).
 131 IPC_MESSAGE_CONTROL2(
 132     ChildProcessHostMsg_ChildProfilerData,
 133     int, /* sequence_number */
 134     tracked_objects::ProcessDataSnapshot /* process_data_snapshot */)
 135
 136 // Send back histograms as vector of pickled-histogram strings.
 137 IPC_MESSAGE_CONTROL2(ChildProcessHostMsg_ChildHistogramData,
 138                      int, /* sequence_number */
 139                      std::vector<std::string> /* histogram_data */)
 140
 141 // Request a histogram from the browser. The browser will send the histogram
 142 // data only if it has been passed the command line flag
 143 // switches::kDomAutomationController.
 144 IPC_SYNC_MESSAGE_CONTROL1_1(ChildProcessHostMsg_GetBrowserHistogram,
 145                             std::string, /* histogram_name */
 146                             std::string /* histogram_json */)
 147
 148 #if defined(OS_WIN)
 149 // Request that the given font be loaded by the host so it's cached by the
 150 // OS. Please see ChildProcessHost::PreCacheFont for details.
 151 IPC_SYNC_MESSAGE_CONTROL1_0(ChildProcessHostMsg_PreCacheFont,
 152                             LOGFONT /* font data */)
 153
 154 // Release the cached font
 155 IPC_MESSAGE_CONTROL0(ChildProcessHostMsg_ReleaseCachedFonts)
 156 #endif  // defined(OS_WIN)
 157
 158 // Asks the browser to create a block of shared memory for the child process to
 159 // fill in and pass back to the browser.
 160 IPC_SYNC_MESSAGE_CONTROL1_1(ChildProcessHostMsg_SyncAllocateSharedMemory,
 161                             uint32 /* buffer size */,
 162                             base::SharedMemoryHandle)
 163
 164 // Asks the browser to create a block of shared memory for the child process to
 165 // fill in and pass back to the browser.
 166 IPC_SYNC_MESSAGE_CONTROL2_1(ChildProcessHostMsg_SyncAllocateSharedBitmap,
 167                             uint32 /* buffer size */,
 168                             cc::SharedBitmapId,
 169                             base::SharedMemoryHandle)
 170
 171 // Informs the browser that the child allocated a shared bitmap.
 172 IPC_MESSAGE_CONTROL3(ChildProcessHostMsg_AllocatedSharedBitmap,
 173                      uint32 /* buffer size */,
 174                      base::SharedMemoryHandle,
 175                      cc::SharedBitmapId)
 176
 177 // Informs the browser that the child deleted a shared bitmap.
 178 IPC_MESSAGE_CONTROL1(ChildProcessHostMsg_DeletedSharedBitmap,
 179                      cc::SharedBitmapId)
 180
 181 #if defined(USE_TCMALLOC)
 182 // Reply to ChildProcessMsg_GetTcmallocStats.
 183 IPC_MESSAGE_CONTROL1(ChildProcessHostMsg_TcmallocStats,
 184                      std::string /* output */)
 185 #endif
 186
 187 // Asks the browser to create a gpu memory buffer.
 188 IPC_SYNC_MESSAGE_CONTROL4_1(ChildProcessHostMsg_SyncAllocateGpuMemoryBuffer,
 189                             uint32 /* width */,
 190                             uint32 /* height */,
 191                             gfx::BufferFormat,
 192                             gfx::BufferUsage,
 193                             gfx::GpuMemoryBufferHandle)
 194
 195 // Informs the browser that the child deleted a gpu memory buffer.
 196 IPC_MESSAGE_CONTROL2(ChildProcessHostMsg_DeletedGpuMemoryBuffer,
 197                      gfx::GpuMemoryBufferId,
 198                      uint32 /* sync_point */)
 199
 200 // Asks the browser to create a block of discardable shared memory for the
 201 // child process.
 202 IPC_SYNC_MESSAGE_CONTROL2_1(
 203     ChildProcessHostMsg_SyncAllocateLockedDiscardableSharedMemory,
 204     uint32 /* size */,
 205     content::DiscardableSharedMemoryId,
 206     base::SharedMemoryHandle)
 207
 208 // Informs the browser that the child deleted a block of discardable shared
 209 // memory.
 210 IPC_MESSAGE_CONTROL1(ChildProcessHostMsg_DeletedDiscardableSharedMemory,
 211                      content::DiscardableSharedMemoryId)