ipc/ipdl/sync-messages.ini

   1 #############################################################
   2 #                                                           #
   3 #          AVOID ADDING NEW MESSAGES TO THIS FILE           #
   4 #                                                           #
   5 # New sync IPC messages will only be approved in            #
   6 # exceptional circumstances, and must be reviewed by an IPC #
   7 # peer. Please be prepared with a detailed justification    #
   8 # before requesting IPC peer review.                        #
   9 #                                                           #
  10 #############################################################
  11
  12 # gtests
  13 [PQuotaTest::Try_Success_CustomErr_QmIpcFail]
  14 description = Only used by gtests
  15 [PQuotaTest::Try_Success_CustomErr_IpcFail]
  16 description = Only used by gtests
  17 [PQuotaTest::TryInspect_Success_CustomErr_QmIpcFail]
  18 description = Only used by gtests
  19 [PQuotaTest::TryInspect_Success_CustomErr_IpcFail]
  20 description = Only used by gtests
  21
  22 # The rest
  23 [PHeapSnapshotTempFileHelper::OpenHeapSnapshotTempFile]
  24 description = legacy sync IPC - please add detailed description
  25 [PBackgroundMutableFile::GetFileId]
  26 description = legacy sync IPC - please add detailed description
  27 [PBackgroundIndexedDBUtils::GetFileReferences]
  28 description = legacy sync IPC - please add detailed description
  29 [PBrowser::SyncMessage]
  30 description = JS MessageManager implementation
  31 [PBrowser::NotifyIMEMouseButtonEvent]
  32 description = legacy sync IPC - please add detailed description
  33 [PBrowser::RequestIMEToCommitComposition]
  34 description = legacy sync IPC - please add detailed description
  35 [PBrowser::GetInputContext]
  36 description = legacy sync IPC - please add detailed description
  37 [PBrowser::RequestNativeKeyBindings]
  38 description = legacy sync IPC - please add detailed description
  39 [PBrowser::DispatchWheelEvent]
  40 description = Only used by automation tests
  41 [PBrowser::DispatchMouseEvent]
  42 description = Only used by automation tests
  43 [PBrowser::DispatchKeyboardEvent]
  44 description = Only used by automation tests
  45 [PBrowser::DispatchTouchEvent]
  46 description = Only used by automation tests
  47 [PBrowser::EnsureLayersConnected]
  48 description = legacy sync IPC - please add detailed description
  49 [PBrowser::SetSystemFont]
  50 description = test only
  51 [PBrowser::GetSystemFont]
  52 description = test only
  53 [PContent::SyncMessage]
  54 description = JS MessageManager implementation
  55 [PContent::IsSecureURI]
  56 description = legacy sync IPC - please add detailed description
  57 [PContent::PURLClassifier]
  58 description = legacy sync IPC - please add detailed description
  59 [PContent::GetGfxVars]
  60 description = legacy sync IPC - please add detailed description
  61 [PContent::GetClipboard]
  62 description = Legacy synchronous clipboard API
  63 [PContent::ClipboardHasType]
  64 description = Legacy synchronous clipboard API
  65 [PContent::GetExternalClipboardFormats]
  66 description = Retrieve supported clipboard formats synchronously
  67 [PContent::GetIconForExtension]
  68 description = legacy sync IPC - please add detailed description
  69 [PContent::BeginDriverCrashGuard]
  70 description = legacy sync IPC - please add detailed description
  71 [PContent::EndDriverCrashGuard]
  72 description = legacy sync IPC - please add detailed description
  73 [PContent::GetGraphicsDeviceInitData]
  74 description = Retrieve information needed to initialize the graphics device in the content process
  75 [PContent::GetOutputColorProfileData]
  76 description = Retrieve the contents of the output color profile file
  77 [PContent::GetFontListShmBlock]
  78 description = for bug 1514869 - layout code needs synchronous access to font list, but this is used only once per block, after which content directly reads the shared memory
  79 [PContent::InitializeFamily]
  80 description = for bug 1514869 - layout is blocked on needing sync access to a specific font family - used once per family, then the data is cached in shared memory
  81 [PContent::InitOtherFamilyNames]
  82 description = for bug 1514869 - layout is blocked on font lookup, needs complete family-name information - not used after loading is complete
  83 [PContent::GetHyphDict]
  84 description = for bug 1487212 - layout requires hyphenation data from a given omnijar resource - only called once per locale by a given content process
  85 [PGMP::StartPlugin]
  86 description = legacy sync IPC - please add detailed description
  87 [PGMPVideoDecoder::NeedShmem]
  88 description = legacy sync IPC - please add detailed description
  89 [PGMPVideoEncoder::NeedShmem]
  90 description = legacy sync IPC - please add detailed description
  91 [PRemoteDecoderManager::Readback]
  92 description = legacy sync IPC - please add detailed description
  93 [PBackgroundStorage::Preload]
  94 description = legacy sync IPC - please add detailed description
  95 [PBackgroundLSDatabase::PBackgroundLSSnapshot]
  96 description = See corresponding comment in PBackgroundLSDatabase.ipdl
  97 [PBackgroundLSSnapshot::SyncCheckpoint]
  98 description = See corresponding comment in PBackgroundLSSnapshot.ipdl
  99 [PBackgroundLSSnapshot::SyncCheckpointAndNotify]
 100 description = See corresponding comment in PBackgroundLSSnapshot.ipdl
 101 [PBackgroundLSSnapshot::SyncFinish]
 102 description = See corresponding comment in PBackgroundLSSnapshot.ipdl
 103 [PBackgroundLSSnapshot::LoadValueAndMoreItems]
 104 description = See corresponding comment in PBackgroundLSSnapshot.ipdl
 105 [PBackgroundLSSnapshot::LoadKeys]
 106 description = See corresponding comment in PBackgroundLSSnapshot.ipdl
 107 [PBackgroundLSSnapshot::IncreasePeakUsage]
 108 description = See corresponding comment in PBackgroundLSSnapshot.ipdl
 109 [PBackgroundSessionStorageCache::Load]
 110 description = See corresponding comment in PBackgroundSessionStorageCache.ipdl
 111 [PRemoteSpellcheckEngine::SetDictionary]
 112 description = legacy sync IPC - please add detailed description
 113 [PGPU::AddLayerTreeIdMapping]
 114 description = legacy sync IPC - please add detailed description
 115 [PGPU::GetDeviceStatus]
 116 description = legacy sync IPC - please add detailed description
 117 [PAPZInputBridge::ReceiveMultiTouchInputEvent]
 118 description = legacy sync IPC - please add detailed description
 119 [PAPZInputBridge::ReceiveMouseInputEvent]
 120 description = legacy sync IPC - please add detailed description
 121 [PAPZInputBridge::ReceivePanGestureInputEvent]
 122 description = legacy sync IPC - please add detailed description
 123 [PAPZInputBridge::ReceivePinchGestureInputEvent]
 124 description = legacy sync IPC - please add detailed description
 125 [PAPZInputBridge::ReceiveTapGestureInputEvent]
 126 description = legacy sync IPC - please add detailed description
 127 [PAPZInputBridge::ReceiveScrollWheelInputEvent]
 128 description = legacy sync IPC - please add detailed description
 129 [PAPZInputBridge::ProcessUnhandledEvent]
 130 description = legacy sync IPC - please add detailed description
 131 [PAPZInputBridge::ReceiveKeyboardInputEvent]
 132 description = legacy sync IPC - please add detailed description
 133 [PCanvasManager::GetSnapshot]
 134 description = Retrieving canvas contents is synchronous (see also, PWebGL::GetFrontBufferSnapshot).
 135 [PCompositorBridge::Initialize]
 136 description = legacy sync IPC - please add detailed description
 137 [PCompositorBridge::WillClose]
 138 description = legacy sync IPC - please add detailed description
 139 [PCompositorBridge::Pause]
 140 description = legacy sync IPC - please add detailed description
 141 [PCompositorBridge::Resume]
 142 description = legacy sync IPC - please add detailed description
 143 [PCompositorBridge::NotifyChildCreated]
 144 description = legacy sync IPC - please add detailed description
 145 [PCompositorBridge::MapAndNotifyChildCreated]
 146 description = bug 1350660
 147 [PCompositorBridge::NotifyChildRecreated]
 148 description = legacy sync IPC - please add detailed description
 149 [PCompositorBridge::FlushRendering]
 150 description = legacy sync IPC - please add detailed description
 151 [PCompositorBridge::WaitOnTransactionProcessed]
 152 description = bug 1364626
 153 [PCompositorBridge::StartFrameTimeRecording]
 154 description = legacy sync IPC - please add detailed description
 155 [PCompositorBridge::StopFrameTimeRecording]
 156 description = legacy sync IPC - please add detailed description
 157 [PCompositorBridge::SyncWithCompositor]
 158 description = legacy sync IPC - please add detailed description
 159 [PCompositorBridge::CheckContentOnlyTDR]
 160 description = legacy sync IPC - please add detailed description
 161 [PCompositorWidget::Initialize]
 162 description = Fallable initialization for the widget. Must be called right after construction before any other messages are sent
 163 platform = win
 164 [PCompositorWidget::EnterPresentLock]
 165 description = Obtain exclusive access to the widget surface. Used to ensure events don't change the surface while it's being used as a render target
 166 platform = win
 167 [PCompositorWidget::LeavePresentLock]
 168 description = Release the exclusive lock that EnterPresentLock obtained
 169 platform = win
 170 [PCompositorWidget::ClearTransparentWindow]
 171 description = Synchronously clear the widget surface. Does not rely on (Enter|Leave)PresentLock. When call returns, window surface has been fully updated with cleared pixel values.
 172 platform = win
 173 [PImageBridge::NewCompositable]
 174 description = legacy sync IPC - please add detailed description
 175 [PUiCompositorController::Pause]
 176 description = legacy sync IPC - please add detailed description
 177 [PUiCompositorController::Resume]
 178 description = legacy sync IPC - please add detailed description
 179 [PUiCompositorController::ResumeAndResize]
 180 description = legacy sync IPC - please add detailed description
 181 [PWebRenderBridge::EnsureConnected]
 182 description = legacy sync IPC - please add detailed description
 183 [PWebRenderBridge::GetSnapshot]
 184 description = legacy sync IPC - please add detailed description
 185 [PWebRenderBridge::SetTestSampleTime]
 186 description = test only
 187 [PWebRenderBridge::LeaveTestMode]
 188 description = test only
 189 [PWebRenderBridge::GetAnimationValue]
 190 description = test only
 191 [PWebRenderBridge::SetAsyncScrollOffset]
 192 description = test only
 193 [PWebRenderBridge::SetAsyncZoom]
 194 description = test only
 195 [PWebRenderBridge::GetAPZTestData]
 196 description = test only
 197 [PWebRenderBridge::GetFrameUniformity]
 198 description = test only
 199 [PWebRenderBridge::ShutdownSync]
 200 description = bug 1377024
 201 [PWebRenderBridge::SyncWithCompositor]
 202 description = WebRender equivalent for PCompositorBridge::SyncWithCompositor
 203 [PHal::GetCurrentBatteryInformation]
 204 description = legacy sync IPC - please add detailed description
 205 [PHal::GetCurrentNetworkInformation]
 206 description = legacy sync IPC - please add detailed description
 207 [PHal::GetWakeLockInfo]
 208 description = legacy sync IPC - please add detailed description
 209 [PHandlerService::FillHandlerInfo]
 210 description = legacy sync IPC - please add detailed description
 211 [PHandlerService::GetMIMEInfoFromOS]
 212 description = Lets unprivileged child processes synchronously get MIME type/handler information from the OS
 213 [PHandlerService::ExistsForProtocolOS]
 214 description = bug 1382323
 215 [PHandlerService::ExistsForProtocol]
 216 description = legacy sync IPC - please add detailed description
 217 [PHandlerService::Exists]
 218 description = legacy sync IPC - please add detailed description
 219 [PHandlerService::GetTypeFromExtension]
 220 description = legacy sync IPC - please add detailed description
 221 [PHandlerService::GetApplicationDescription]
 222 description = Lets unprivileged child processes synchronously get a description of the app that handles a given protocol scheme
 223 [PClientSource::WorkerSyncPing]
 224 description = Synchronous ping allowing worker thread to confirm actor is created. Necessary to avoid racing with ClientHandle actors on main thread.
 225 [PRemoteSandboxBroker::LaunchApp]
 226 description = Synchronous launch of a child process that in turn launches and sandboxes another process. Called on a dedicated thread and targets a dedicated process, so this shouldn't block anything.
 227 [PSandboxTesting::GetSpecialDirectory]
 228 description = Testing only - get a special directory path.
 229 # WebGL internals
 230 [PWebGL::Initialize]
 231 description = Initialization of WebGL contexts is synchronous by spec.
 232 [PWebGL::GetFrontBuffer]
 233 description = Publishing a WebGL frame for compositing is synchronous for now to ensure DOM transaction atomicity.
 234 [PWebGL::OnMemoryPressure]
 235 description = Synchronous to ensure immediate memory pressure relief.
 236 # WebGL spec-synchronous functions
 237 [PWebGL::CheckFramebufferStatus]
 238 description = Checking framebuffer completenss must ask the driver.
 239 [PWebGL::ClientWaitSync]
 240 description = Checking fence-sync completenss must ask the driver.
 241 [PWebGL::CreateOpaqueFramebuffer]
 242 description = Must synchronously check for allocation success.
 243 [PWebGL::DrawingBufferSize]
 244 description = The returned size might be smaller than requested due to allocation failure.
 245 [PWebGL::Finish]
 246 description = Synchronous by spec, but not generally used.
 247 [PWebGL::GetBufferSubData]
 248 description = Retrieving buffer contents is synchronous in the worst case.
 249 [PWebGL::GetFrontBufferSnapshot]
 250 description = Retrieving canvas contents is synchronous.
 251 [PWebGL::ReadPixels]
 252 description = Retrieving WebGL framebuffer contents is synchronous.
 253 # WebGL reflection functions
 254 [PWebGL::GetBufferParameter]
 255 description = Reflection is cold code, but synchronous by spec.
 256 [PWebGL::GetCompileResult]
 257 description = Reflection is cold code, but synchronous by spec.
 258 [PWebGL::GetError]
 259 description = Reflection is cold code, but synchronous by spec.
 260 [PWebGL::GetFragDataLocation]
 261 description = Reflection is cold code, but synchronous by spec.
 262 [PWebGL::GetFramebufferAttachmentParameter]
 263 description = Reflection is cold code, but synchronous by spec.
 264 [PWebGL::GetIndexedParameter]
 265 description = Reflection is cold code, but synchronous by spec.
 266 [PWebGL::GetInternalformatParameter]
 267 description = Reflection is cold code, but synchronous by spec.
 268 [PWebGL::GetLinkResult]
 269 description = Reflection is cold code, but synchronous by spec.
 270 [PWebGL::GetNumber]
 271 description = Reflection is cold code, but synchronous by spec.
 272 [PWebGL::GetQueryParameter]
 273 description = Reflection is cold code, but synchronous by spec.
 274 [PWebGL::GetRenderbufferParameter]
 275 description = Reflection is cold code, but synchronous by spec.
 276 [PWebGL::GetSamplerParameter]
 277 description = Reflection is cold code, but synchronous by spec.
 278 [PWebGL::GetShaderPrecisionFormat]
 279 description = Reflection is cold code, but synchronous by spec.
 280 [PWebGL::GetString]
 281 description = Reflection is cold code, but synchronous by spec.
 282 [PWebGL::GetTexParameter]
 283 description = Reflection is cold code, but synchronous by spec.
 284 [PWebGL::GetUniform]
 285 description = Reflection is cold code, but synchronous by spec.
 286 [PWebGL::GetVertexAttrib]
 287 description = Reflection is cold code, but synchronous by spec.
 288 [PWebGL::IsEnabled]
 289 description = Reflection is cold code, but synchronous by spec.
 290 [PWebGL::ValidateProgram]
 291 description = Reflection is cold code, but synchronous by spec.
 292 [PWebGL::SyncPing]
 293 description = Used to throttle a lot of async WebGL command messages.
 294 # -
 295 [PIPCClientCerts::FindObjects]
 296 description = Finds certificates and private keys in the parent process. As this is called from PKCS#11, there is no way to make this asynchronous.
 297 [PIPCClientCerts::Sign]
 298 description = Performs a signature on given data with a key corresponding to the given identifier. This is called from PKCS#11, so there is no way to make this asynchronous.
 299 # -
 300 [PRemoteQuotaObject::MaybeUpdateSize]
 301 description = This must be synchronous until quota file streams become non-blocking. The synchronous message is never used on the main thread or the PBackground thread or a DOM worker threed.
 302
 303 #############################################################
 304 #          AVOID ADDING NEW MESSAGES TO THIS FILE           #
 305 #                see comment at top of file                 #
 306 #############################################################