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 #if defined(USE_OZONE)
  72   IPC_STRUCT_TRAITS_MEMBER(native_pixmap_handle)
  73 #endif
  74 IPC_STRUCT_TRAITS_END()
  75
  76 IPC_STRUCT_TRAITS_BEGIN(gfx::GpuMemoryBufferId)
  77   IPC_STRUCT_TRAITS_MEMBER(id)
  78 IPC_STRUCT_TRAITS_END()
  79
  80 #undef IPC_MESSAGE_EXPORT
  81 #define IPC_MESSAGE_EXPORT CONTENT_EXPORT
  82
  83 #define IPC_MESSAGE_START ChildProcessMsgStart
  84
  85 // Messages sent from the browser to the child process.
  86
  87 // Sent in response to ChildProcessHostMsg_ShutdownRequest to tell the child
  88 // process that it's safe to shutdown.
  89 IPC_MESSAGE_CONTROL0(ChildProcessMsg_Shutdown)
  90
  91 #if defined(IPC_MESSAGE_LOG_ENABLED)
  92 // Tell the child process to begin or end IPC message logging.
  93 IPC_MESSAGE_CONTROL1(ChildProcessMsg_SetIPCLoggingEnabled,
  94                      bool /* on or off */)
  95 #endif
  96
  97 // Tell the child process to enable or disable the profiler status.
  98 IPC_MESSAGE_CONTROL1(ChildProcessMsg_SetProfilerStatus,
  99                      tracked_objects::ThreadData::Status /* profiler status */)
 100
 101 // Send to all the child processes to send back profiler data (ThreadData in
 102 // tracked_objects).
 103 IPC_MESSAGE_CONTROL2(ChildProcessMsg_GetChildProfilerData,
 104                      int /* sequence_number */,
 105                      int /* current_profiling_phase */)
 106
 107 // Send to all the child processes to mark the current profiling phase as
 108 // finished and start a new phase.
 109 IPC_MESSAGE_CONTROL1(ChildProcessMsg_ProfilingPhaseCompleted,
 110                      int /* profiling_phase */)
 111
 112 // Send to all the child processes to send back histogram data.
 113 IPC_MESSAGE_CONTROL1(ChildProcessMsg_GetChildHistogramData,
 114                      int /* sequence_number */)
 115
 116 // Sent to child processes to tell them to enter or leave background mode.
 117 IPC_MESSAGE_CONTROL1(ChildProcessMsg_SetProcessBackgrounded,
 118                      bool /* background */)
 119
 120 #if defined(USE_TCMALLOC)
 121 // Sent to child process to request tcmalloc stats.
 122 IPC_MESSAGE_CONTROL0(ChildProcessMsg_GetTcmallocStats)
 123 #endif
 124
 125 #if defined(OS_MACOSX)
 126 // Sent to child processes to tell them what token to use when registering
 127 // and/or acquiring IOSurfaces.
 128 IPC_MESSAGE_CONTROL1(ChildProcessMsg_SetIOSurfaceManagerToken,
 129                      content::IOSurfaceManagerToken /* token */)
 130 #endif
 131
 132 ////////////////////////////////////////////////////////////////////////////////
 133 // Messages sent from the child process to the browser.
 134
 135 IPC_MESSAGE_CONTROL0(ChildProcessHostMsg_ShutdownRequest)
 136
 137 // Send back profiler data (ThreadData in tracked_objects).
 138 IPC_MESSAGE_CONTROL2(
 139     ChildProcessHostMsg_ChildProfilerData,
 140     int, /* sequence_number */
 141     tracked_objects::ProcessDataSnapshot /* process_data_snapshot */)
 142
 143 // Send back histograms as vector of pickled-histogram strings.
 144 IPC_MESSAGE_CONTROL2(ChildProcessHostMsg_ChildHistogramData,
 145                      int, /* sequence_number */
 146                      std::vector<std::string> /* histogram_data */)
 147
 148 // Request a histogram from the browser. The browser will send the histogram
 149 // data only if it has been passed the command line flag
 150 // switches::kDomAutomationController.
 151 IPC_SYNC_MESSAGE_CONTROL1_1(ChildProcessHostMsg_GetBrowserHistogram,
 152                             std::string, /* histogram_name */
 153                             std::string /* histogram_json */)
 154
 155 #if defined(OS_WIN)
 156 // Request that the given font be loaded by the host so it's cached by the
 157 // OS. Please see ChildProcessHost::PreCacheFont for details.
 158 IPC_SYNC_MESSAGE_CONTROL1_0(ChildProcessHostMsg_PreCacheFont,
 159                             LOGFONT /* font data */)
 160
 161 // Release the cached font
 162 IPC_MESSAGE_CONTROL0(ChildProcessHostMsg_ReleaseCachedFonts)
 163 #endif  // defined(OS_WIN)
 164
 165 // Asks the browser to create a block of shared memory for the child process to
 166 // fill in and pass back to the browser.
 167 IPC_SYNC_MESSAGE_CONTROL1_1(ChildProcessHostMsg_SyncAllocateSharedMemory,
 168                             uint32 /* buffer size */,
 169                             base::SharedMemoryHandle)
 170
 171 // Asks the browser to create a block of shared memory for the child process to
 172 // fill in and pass back to the browser.
 173 IPC_SYNC_MESSAGE_CONTROL2_1(ChildProcessHostMsg_SyncAllocateSharedBitmap,
 174                             uint32 /* buffer size */,
 175                             cc::SharedBitmapId,
 176                             base::SharedMemoryHandle)
 177
 178 // Informs the browser that the child allocated a shared bitmap.
 179 IPC_MESSAGE_CONTROL3(ChildProcessHostMsg_AllocatedSharedBitmap,
 180                      uint32 /* buffer size */,
 181                      base::SharedMemoryHandle,
 182                      cc::SharedBitmapId)
 183
 184 // Informs the browser that the child deleted a shared bitmap.
 185 IPC_MESSAGE_CONTROL1(ChildProcessHostMsg_DeletedSharedBitmap,
 186                      cc::SharedBitmapId)
 187
 188 #if defined(USE_TCMALLOC)
 189 // Reply to ChildProcessMsg_GetTcmallocStats.
 190 IPC_MESSAGE_CONTROL1(ChildProcessHostMsg_TcmallocStats,
 191                      std::string /* output */)
 192 #endif
 193
 194 // Asks the browser to create a gpu memory buffer.
 195 IPC_SYNC_MESSAGE_CONTROL5_1(ChildProcessHostMsg_SyncAllocateGpuMemoryBuffer,
 196                             gfx::GpuMemoryBufferId /* new_id */,
 197                             uint32 /* width */,
 198                             uint32 /* height */,
 199                             gfx::BufferFormat,
 200                             gfx::BufferUsage,
 201                             gfx::GpuMemoryBufferHandle)
 202
 203 // Informs the browser that the child deleted a gpu memory buffer.
 204 IPC_MESSAGE_CONTROL2(ChildProcessHostMsg_DeletedGpuMemoryBuffer,
 205                      gfx::GpuMemoryBufferId,
 206                      uint32 /* sync_point */)
 207
 208 // Asks the browser to create a block of discardable shared memory for the
 209 // child process.
 210 IPC_SYNC_MESSAGE_CONTROL2_1(
 211     ChildProcessHostMsg_SyncAllocateLockedDiscardableSharedMemory,
 212     uint32 /* size */,
 213     content::DiscardableSharedMemoryId,
 214     base::SharedMemoryHandle)
 215
 216 // Informs the browser that the child deleted a block of discardable shared
 217 // memory.
 218 IPC_MESSAGE_CONTROL1(ChildProcessHostMsg_DeletedDiscardableSharedMemory,
 219                      content::DiscardableSharedMemoryId)