February 16th, 2023

What does it mean when my cross-thread COM call fails with RPC_E_SYS_CALL_FAILED?

COM generates the error RPC_E_SYS_CALL_FAILED under a few circumstances.

The first category is “a system call failed because something got corrupted”. These code paths are used if the calling thread is an MTA.

  • Wait­For­Single­Object failed.
  • Duplicate­Handle failed.

If these calls fail, it means that the handle is invalid. The reason might be that COM’s internal bookkeeping is corrupted. Or it could be that the handle was once valid but no longer is: Maybe somebody else in the process closed COM’s handle by mistake, perhaps due to a handle double-close bug or an uninitialized variable. Or maybe the handle was closed by an outside force, perhaps the result of an inadvised attempt to force-close a handle.

Generally, if something is corrupted, things are already in a bad state, and you may as well just fail fast rather than try to muddle through and possibly corrupt things even worse.

Another category is “a system call failed because we couldn’t contact the recipient.” If the destination thread is a single-threaded apartment, the request to do work is performed by posting a message to the thread, but if the thread has stopped processing messages, it’s possible that the thread’s posted message queue is full and won’t accept any new messages. In that case, the failed system call is Post­Message.

To diagnose this problem in the case of a single-threaded apartment, check the thread that is the destination of the cross-thread COM call and ensure that it is pumping messages. It’s possible that it got stuck on a mutex or blocked on a Wait­For­Single­Object that is not completing. That would prevent the thread from pumping messages, and if it stays in that state for a long time, its inbound message queue can fill up, preventing new work from being posted, and resulting in the RPC_E_SYS_CALL_FAILED error.

Just some things to look for when you’re trying to diagnose a RPC_E_SYS_CALL_FAILED failure.

Topics
Code

Author

Raymond has been involved in the evolution of Windows for more than 30 years. In 2003, he began a Web site known as The Old New Thing which has grown in popularity far beyond his wildest imagination, a development which still gives him the heebie-jeebies. The Web site spawned a book, coincidentally also titled The Old New Thing (Addison Wesley 2007). He occasionally appears on the Windows Dev Docs Twitter account to tell stories which convey no useful information.

0 comments

Discussion are closed.